libZSservicesZSamazonka-route53-autonamingZSamazonka-route53-autonaming
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.Route53AutoNaming.Types.DnsConfig

Description

 
Synopsis

Documentation

data DnsConfig Source #

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.

See: newDnsConfig smart constructor.

Constructors

DnsConfig' 

Fields

  • 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.

  • namespaceId :: Maybe Text

    The ID of the namespace to use for DNS configuration.

  • 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

Instances details
Eq DnsConfig Source # 
Instance details

Defined in Amazonka.Route53AutoNaming.Types.DnsConfig

Read DnsConfig Source # 
Instance details

Defined in Amazonka.Route53AutoNaming.Types.DnsConfig

Show DnsConfig Source # 
Instance details

Defined in Amazonka.Route53AutoNaming.Types.DnsConfig

Generic DnsConfig Source # 
Instance details

Defined in Amazonka.Route53AutoNaming.Types.DnsConfig

Associated Types

type Rep DnsConfig :: Type -> Type #

NFData DnsConfig Source # 
Instance details

Defined in Amazonka.Route53AutoNaming.Types.DnsConfig

Methods

rnf :: DnsConfig -> () #

Hashable DnsConfig Source # 
Instance details

Defined in Amazonka.Route53AutoNaming.Types.DnsConfig

ToJSON DnsConfig Source # 
Instance details

Defined in Amazonka.Route53AutoNaming.Types.DnsConfig

FromJSON DnsConfig Source # 
Instance details

Defined in Amazonka.Route53AutoNaming.Types.DnsConfig

type Rep DnsConfig Source # 
Instance details

Defined in Amazonka.Route53AutoNaming.Types.DnsConfig

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

newDnsConfig :: DnsConfig Source #

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: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:namespaceId:DnsConfig', dnsConfig_namespaceId - The ID of the namespace to use for DNS configuration.

$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_routingPolicy :: Lens' DnsConfig (Maybe RoutingPolicy) Source #

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_namespaceId :: Lens' DnsConfig (Maybe Text) Source #

The ID of the namespace to use for DNS configuration.

dnsConfig_dnsRecords :: Lens' DnsConfig [DnsRecord] Source #

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.