Amazonka.Route53AutoNaming.Types.DnsConfig

Documentation

data DnsConfig

A complex type that contains information about the Amazon Route 53 DNS records that you want Cloud Map to create when you register an instance.

The record types of a service can only be changed by deleting the service and recreating it with a new Dnsconfig.

See: newDnsConfig smart constructor.

Constructors

DnsConfig'

Fields

• namespaceId :: Maybe Text

  /Use NamespaceId in Service instead./

  The ID of the namespace to use for DNS configuration.

• routingPolicy :: Maybe RoutingPolicy

  The routing policy that you want to apply to all Route 53 DNS records that Cloud Map creates when you register an instance and specify this service.

  If you want to use this service to register instances that create alias records, specify WEIGHTED for the routing policy.

  You can specify the following values:

  MULTIVALUE

  If you define a health check for the service and the health check is healthy, Route 53 returns the applicable value for up to eight instances.

  For example, suppose that the service includes configurations for one A record and a health check. You use the service to register 10 instances. Route 53 responds to DNS queries with IP addresses for up to eight healthy instances. If fewer than eight instances are healthy, Route 53 responds to every DNS query with the IP addresses for all of the healthy instances.

  If you don't define a health check for the service, Route 53 assumes that all instances are healthy and returns the values for up to eight instances.

  For more information about the multivalue routing policy, see Multivalue Answer Routing in the Route 53 Developer Guide.

  WEIGHTED

  Route 53 returns the applicable value from one randomly selected instance from among the instances that you registered using the same service. Currently, all records have the same weight, so you can't route more or less traffic to any instances.

  For example, suppose that the service includes configurations for one A record and a health check. You use the service to register 10 instances. Route 53 responds to DNS queries with the IP address for one randomly selected instance from among the healthy instances. If no instances are healthy, Route 53 responds to DNS queries as if all of the instances were healthy.

  If you don't define a health check for the service, Route 53 assumes that all instances are healthy and returns the applicable value for one randomly selected instance.

  For more information about the weighted routing policy, see Weighted Routing in the Route 53 Developer Guide.

• dnsRecords :: [DnsRecord]

  An array that contains one DnsRecord object for each Route 53 DNS record that you want Cloud Map to create when you register an instance.

Instances

FromJSON DnsConfig

Defined in Amazonka.Route53AutoNaming.Types.DnsConfig

Methods

parseJSON :: Value -> Parser DnsConfig

parseJSONList :: Value -> Parser [DnsConfig]

ToJSON DnsConfig

Defined in Amazonka.Route53AutoNaming.Types.DnsConfig

Methods

toJSON :: DnsConfig -> Value

toEncoding :: DnsConfig -> Encoding

toJSONList :: [DnsConfig] -> Value

toEncodingList :: [DnsConfig] -> Encoding

Generic DnsConfig

Defined in Amazonka.Route53AutoNaming.Types.DnsConfig

Associated Types

type Rep DnsConfig :: Type -> Type

Methods

from :: DnsConfig -> Rep DnsConfig x

to :: Rep DnsConfig x -> DnsConfig

Read DnsConfig

Defined in Amazonka.Route53AutoNaming.Types.DnsConfig

Methods

readsPrec :: Int -> ReadS DnsConfig

readList :: ReadS [DnsConfig]

readPrec :: ReadPrec DnsConfig

readListPrec :: ReadPrec [DnsConfig]

Show DnsConfig

Defined in Amazonka.Route53AutoNaming.Types.DnsConfig

Methods

showsPrec :: Int -> DnsConfig -> ShowS

show :: DnsConfig -> String

showList :: [DnsConfig] -> ShowS

NFData DnsConfig

Defined in Amazonka.Route53AutoNaming.Types.DnsConfig

Methods

rnf :: DnsConfig -> ()

Eq DnsConfig

Defined in Amazonka.Route53AutoNaming.Types.DnsConfig

Methods

(==) :: DnsConfig -> DnsConfig -> Bool

(/=) :: DnsConfig -> DnsConfig -> Bool

Hashable DnsConfig

Defined in Amazonka.Route53AutoNaming.Types.DnsConfig

Methods

hashWithSalt :: Int -> DnsConfig -> Int

hash :: DnsConfig -> Int

type Rep DnsConfig

Defined in Amazonka.Route53AutoNaming.Types.DnsConfig

type Rep DnsConfig = D1 ('MetaData "DnsConfig" "Amazonka.Route53AutoNaming.Types.DnsConfig" "amazonka-route53-autonaming-2.0-98MlwjLW1enGruUXoTOCqp" 'False) (C1 ('MetaCons "DnsConfig'" 'PrefixI 'True) (S1 ('MetaSel ('Just "namespaceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "routingPolicy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RoutingPolicy)) :*: S1 ('MetaSel ('Just "dnsRecords") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [DnsRecord]))))

newDnsConfig :: DnsConfig

Create a value of DnsConfig with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:namespaceId:DnsConfig', dnsConfig_namespaceId - /Use NamespaceId in Service instead./

The ID of the namespace to use for DNS configuration.

$sel:routingPolicy:DnsConfig', dnsConfig_routingPolicy - The routing policy that you want to apply to all Route 53 DNS records that Cloud Map creates when you register an instance and specify this service.

If you want to use this service to register instances that create alias records, specify WEIGHTED for the routing policy.

You can specify the following values:

MULTIVALUE

If you define a health check for the service and the health check is healthy, Route 53 returns the applicable value for up to eight instances.

For example, suppose that the service includes configurations for one A record and a health check. You use the service to register 10 instances. Route 53 responds to DNS queries with IP addresses for up to eight healthy instances. If fewer than eight instances are healthy, Route 53 responds to every DNS query with the IP addresses for all of the healthy instances.

If you don't define a health check for the service, Route 53 assumes that all instances are healthy and returns the values for up to eight instances.

For more information about the multivalue routing policy, see Multivalue Answer Routing in the Route 53 Developer Guide.

WEIGHTED

Route 53 returns the applicable value from one randomly selected instance from among the instances that you registered using the same service. Currently, all records have the same weight, so you can't route more or less traffic to any instances.

For example, suppose that the service includes configurations for one A record and a health check. You use the service to register 10 instances. Route 53 responds to DNS queries with the IP address for one randomly selected instance from among the healthy instances. If no instances are healthy, Route 53 responds to DNS queries as if all of the instances were healthy.

If you don't define a health check for the service, Route 53 assumes that all instances are healthy and returns the applicable value for one randomly selected instance.

For more information about the weighted routing policy, see Weighted Routing in the Route 53 Developer Guide.

$sel:dnsRecords:DnsConfig', dnsConfig_dnsRecords - An array that contains one DnsRecord object for each Route 53 DNS record that you want Cloud Map to create when you register an instance.

dnsConfig_namespaceId :: Lens' DnsConfig (Maybe Text)

/Use NamespaceId in Service instead./

The ID of the namespace to use for DNS configuration.

dnsConfig_routingPolicy :: Lens' DnsConfig (Maybe RoutingPolicy)

The routing policy that you want to apply to all Route 53 DNS records that Cloud Map creates when you register an instance and specify this service.

If you want to use this service to register instances that create alias records, specify WEIGHTED for the routing policy.

You can specify the following values:

MULTIVALUE

If you define a health check for the service and the health check is healthy, Route 53 returns the applicable value for up to eight instances.

For example, suppose that the service includes configurations for one A record and a health check. You use the service to register 10 instances. Route 53 responds to DNS queries with IP addresses for up to eight healthy instances. If fewer than eight instances are healthy, Route 53 responds to every DNS query with the IP addresses for all of the healthy instances.

If you don't define a health check for the service, Route 53 assumes that all instances are healthy and returns the values for up to eight instances.

For more information about the multivalue routing policy, see Multivalue Answer Routing in the Route 53 Developer Guide.

WEIGHTED

Route 53 returns the applicable value from one randomly selected instance from among the instances that you registered using the same service. Currently, all records have the same weight, so you can't route more or less traffic to any instances.

For example, suppose that the service includes configurations for one A record and a health check. You use the service to register 10 instances. Route 53 responds to DNS queries with the IP address for one randomly selected instance from among the healthy instances. If no instances are healthy, Route 53 responds to DNS queries as if all of the instances were healthy.

If you don't define a health check for the service, Route 53 assumes that all instances are healthy and returns the applicable value for one randomly selected instance.

For more information about the weighted routing policy, see Weighted Routing in the Route 53 Developer Guide.

dnsConfig_dnsRecords :: Lens' DnsConfig [DnsRecord]

An array that contains one DnsRecord object for each Route 53 DNS record that you want Cloud Map to create when you register an instance.