lightsail

Documentation

Overview

Package lightsail implements a DNS provider for solving the DNS-01 challenge using AWS Lightsail DNS.

Index

• Constants
• type Config
  • func NewDefaultConfig() *Config
• type DNSProvider
  • func NewDNSProvider() (*DNSProvider, error)
  • func NewDNSProviderConfig(config *Config) (*DNSProvider, error)
  • func (d *DNSProvider) CleanUp(domain, _, keyAuth string) error
  • func (d *DNSProvider) Present(domain, _, keyAuth string) error
  • func (d *DNSProvider) Timeout() (timeout, interval time.Duration)

Constants

const (
	EnvRegion  = envNamespace + "REGION"
	EnvDNSZone = "DNS_ZONE"

	EnvPropagationTimeout = envNamespace + "PROPAGATION_TIMEOUT"
	EnvPollingInterval    = envNamespace + "POLLING_INTERVAL"
)

Environment variables names.

Types

type Config

type Config struct {
	DNSZone            string
	Region             string
	PropagationTimeout time.Duration
	PollingInterval    time.Duration
}

Config is used to configure the creation of the DNSProvider.

func NewDefaultConfig

func NewDefaultConfig() *Config

NewDefaultConfig returns a default configuration for the DNSProvider.

type DNSProvider

type DNSProvider struct {
	// contains filtered or unexported fields
}

DNSProvider implements the challenge.Provider interface.

func NewDNSProvider

func NewDNSProvider() (*DNSProvider, error)

NewDNSProvider returns a DNSProvider instance configured for the AWS Lightsail service.

AWS Credentials are automatically detected in the following locations and prioritized in the following order:

1. Environment variables: AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY, [AWS_SESSION_TOKEN], [DNS_ZONE], [LIGHTSAIL_REGION]
2. Shared credentials file (defaults to ~/.aws/credentials)
3. Amazon EC2 IAM role

public hosted zone via the FQDN.

See also: https://github.com/aws/aws-sdk-go/wiki/configuring-sdk

func NewDNSProviderConfig

func NewDNSProviderConfig(config *Config) (*DNSProvider, error)

NewDNSProviderConfig return a DNSProvider instance configured for AWS Lightsail.

func (*DNSProvider) CleanUp

func (d *DNSProvider) CleanUp(domain, _, keyAuth string) error

CleanUp removes the TXT record matching the specified parameters.

func (*DNSProvider) Present

func (d *DNSProvider) Present(domain, _, keyAuth string) error

Present creates a TXT record using the specified parameters.

func (*DNSProvider) Timeout

func (d *DNSProvider) Timeout() (timeout, interval time.Duration)

Timeout returns the timeout and interval to use when checking for DNS propagation. Adjusting here to cope with spikes in propagation times.