Copyright | (c) 2013-2018 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
- Service Configuration
- Errors
- CustomHealthStatus
- FilterCondition
- HealthCheckType
- HealthStatus
- NamespaceFilterName
- NamespaceType
- OperationFilterName
- OperationStatus
- OperationTargetType
- OperationType
- RecordType
- RoutingPolicy
- ServiceFilterName
- DNSConfig
- DNSConfigChange
- DNSProperties
- DNSRecord
- HealthCheckConfig
- HealthCheckCustomConfig
- Instance
- InstanceSummary
- Namespace
- NamespaceFilter
- NamespaceProperties
- NamespaceSummary
- Operation
- OperationFilter
- OperationSummary
- ServiceChange
- ServiceFilter
- ServiceInfo
- ServiceSummary
Synopsis
- route53AutoNaming :: Service
- _ResourceLimitExceeded :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidInput :: AsError a => Getting (First ServiceError) a ServiceError
- _NamespaceAlreadyExists :: AsError a => Getting (First ServiceError) a ServiceError
- _NamespaceNotFound :: AsError a => Getting (First ServiceError) a ServiceError
- _ServiceAlreadyExists :: AsError a => Getting (First ServiceError) a ServiceError
- _ResourceInUse :: AsError a => Getting (First ServiceError) a ServiceError
- _CustomHealthNotFound :: AsError a => Getting (First ServiceError) a ServiceError
- _InstanceNotFound :: AsError a => Getting (First ServiceError) a ServiceError
- _DuplicateRequest :: AsError a => Getting (First ServiceError) a ServiceError
- _ServiceNotFound :: AsError a => Getting (First ServiceError) a ServiceError
- _OperationNotFound :: AsError a => Getting (First ServiceError) a ServiceError
- data CustomHealthStatus
- data FilterCondition
- data HealthCheckType
- data HealthStatus
- data NamespaceFilterName = Type
- data NamespaceType
- data OperationFilterName
- data OperationStatus
- data OperationTargetType
- data OperationType
- data RecordType
- data RoutingPolicy
- data ServiceFilterName = NamespaceId
- data DNSConfig
- dnsConfig :: Text -> DNSConfig
- dcRoutingPolicy :: Lens' DNSConfig (Maybe RoutingPolicy)
- dcNamespaceId :: Lens' DNSConfig Text
- dcDNSRecords :: Lens' DNSConfig [DNSRecord]
- data DNSConfigChange
- dnsConfigChange :: DNSConfigChange
- dccDNSRecords :: Lens' DNSConfigChange [DNSRecord]
- data DNSProperties
- dnsProperties :: DNSProperties
- dpHostedZoneId :: Lens' DNSProperties (Maybe Text)
- data DNSRecord
- dnsRecord :: RecordType -> Natural -> DNSRecord
- drType :: Lens' DNSRecord RecordType
- drTTL :: Lens' DNSRecord Natural
- data HealthCheckConfig
- healthCheckConfig :: HealthCheckConfig
- hccFailureThreshold :: Lens' HealthCheckConfig (Maybe Natural)
- hccResourcePath :: Lens' HealthCheckConfig (Maybe Text)
- hccType :: Lens' HealthCheckConfig (Maybe HealthCheckType)
- data HealthCheckCustomConfig
- healthCheckCustomConfig :: HealthCheckCustomConfig
- hcccFailureThreshold :: Lens' HealthCheckCustomConfig (Maybe Natural)
- data Instance
- instance' :: Text -> Instance
- iCreatorRequestId :: Lens' Instance (Maybe Text)
- iAttributes :: Lens' Instance (HashMap Text Text)
- iId :: Lens' Instance Text
- data InstanceSummary
- instanceSummary :: InstanceSummary
- isAttributes :: Lens' InstanceSummary (HashMap Text Text)
- isId :: Lens' InstanceSummary (Maybe Text)
- data Namespace
- namespace :: Namespace
- nARN :: Lens' Namespace (Maybe Text)
- nCreatorRequestId :: Lens' Namespace (Maybe Text)
- nCreateDate :: Lens' Namespace (Maybe UTCTime)
- nServiceCount :: Lens' Namespace (Maybe Int)
- nName :: Lens' Namespace (Maybe Text)
- nId :: Lens' Namespace (Maybe Text)
- nType :: Lens' Namespace (Maybe NamespaceType)
- nDescription :: Lens' Namespace (Maybe Text)
- nProperties :: Lens' Namespace (Maybe NamespaceProperties)
- data NamespaceFilter
- namespaceFilter :: NamespaceFilterName -> NamespaceFilter
- nfCondition :: Lens' NamespaceFilter (Maybe FilterCondition)
- nfName :: Lens' NamespaceFilter NamespaceFilterName
- nfValues :: Lens' NamespaceFilter [Text]
- data NamespaceProperties
- namespaceProperties :: NamespaceProperties
- npDNSProperties :: Lens' NamespaceProperties (Maybe DNSProperties)
- data NamespaceSummary
- namespaceSummary :: NamespaceSummary
- nsARN :: Lens' NamespaceSummary (Maybe Text)
- nsName :: Lens' NamespaceSummary (Maybe Text)
- nsId :: Lens' NamespaceSummary (Maybe Text)
- nsType :: Lens' NamespaceSummary (Maybe NamespaceType)
- data Operation
- operation :: Operation
- oStatus :: Lens' Operation (Maybe OperationStatus)
- oUpdateDate :: Lens' Operation (Maybe UTCTime)
- oCreateDate :: Lens' Operation (Maybe UTCTime)
- oTargets :: Lens' Operation (HashMap OperationTargetType Text)
- oErrorCode :: Lens' Operation (Maybe Text)
- oId :: Lens' Operation (Maybe Text)
- oType :: Lens' Operation (Maybe OperationType)
- oErrorMessage :: Lens' Operation (Maybe Text)
- data OperationFilter
- operationFilter :: OperationFilterName -> OperationFilter
- ofCondition :: Lens' OperationFilter (Maybe FilterCondition)
- ofName :: Lens' OperationFilter OperationFilterName
- ofValues :: Lens' OperationFilter [Text]
- data OperationSummary
- operationSummary :: OperationSummary
- osStatus :: Lens' OperationSummary (Maybe OperationStatus)
- osId :: Lens' OperationSummary (Maybe Text)
- data ServiceChange
- serviceChange :: DNSConfigChange -> ServiceChange
- scHealthCheckConfig :: Lens' ServiceChange (Maybe HealthCheckConfig)
- scDescription :: Lens' ServiceChange (Maybe Text)
- scDNSConfig :: Lens' ServiceChange DNSConfigChange
- data ServiceFilter
- serviceFilter :: ServiceFilterName -> ServiceFilter
- sfCondition :: Lens' ServiceFilter (Maybe FilterCondition)
- sfName :: Lens' ServiceFilter ServiceFilterName
- sfValues :: Lens' ServiceFilter [Text]
- data ServiceInfo
- serviceInfo :: ServiceInfo
- siInstanceCount :: Lens' ServiceInfo (Maybe Int)
- siARN :: Lens' ServiceInfo (Maybe Text)
- siHealthCheckConfig :: Lens' ServiceInfo (Maybe HealthCheckConfig)
- siCreatorRequestId :: Lens' ServiceInfo (Maybe Text)
- siCreateDate :: Lens' ServiceInfo (Maybe UTCTime)
- siHealthCheckCustomConfig :: Lens' ServiceInfo (Maybe HealthCheckCustomConfig)
- siName :: Lens' ServiceInfo (Maybe Text)
- siId :: Lens' ServiceInfo (Maybe Text)
- siDNSConfig :: Lens' ServiceInfo (Maybe DNSConfig)
- siDescription :: Lens' ServiceInfo (Maybe Text)
- data ServiceSummary
- serviceSummary :: ServiceSummary
- ssInstanceCount :: Lens' ServiceSummary (Maybe Int)
- ssARN :: Lens' ServiceSummary (Maybe Text)
- ssName :: Lens' ServiceSummary (Maybe Text)
- ssId :: Lens' ServiceSummary (Maybe Text)
- ssDescription :: Lens' ServiceSummary (Maybe Text)
Service Configuration
route53AutoNaming :: Service Source #
API version 2017-03-14
of the Amazon Route 53 Auto Naming SDK configuration.
Errors
_ResourceLimitExceeded :: AsError a => Getting (First ServiceError) a ServiceError Source #
The resource can't be created because you've reached the limit on the number of resources.
_InvalidInput :: AsError a => Getting (First ServiceError) a ServiceError Source #
One or more specified values aren't valid. For example, when you're creating a namespace, the value of Name
might not be a valid DNS name.
_NamespaceAlreadyExists :: AsError a => Getting (First ServiceError) a ServiceError Source #
The namespace that you're trying to create already exists.
_NamespaceNotFound :: AsError a => Getting (First ServiceError) a ServiceError Source #
No namespace exists with the specified ID.
_ServiceAlreadyExists :: AsError a => Getting (First ServiceError) a ServiceError Source #
The service can't be created because a service with the same name already exists.
_ResourceInUse :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified resource can't be deleted because it contains other resources. For example, you can't delete a service that contains any instances.
_CustomHealthNotFound :: AsError a => Getting (First ServiceError) a ServiceError Source #
Prism for CustomHealthNotFound' errors.
_InstanceNotFound :: AsError a => Getting (First ServiceError) a ServiceError Source #
No instance exists with the specified ID, or the instance was recently registered, and information about the instance hasn't propagated yet.
_DuplicateRequest :: AsError a => Getting (First ServiceError) a ServiceError Source #
The operation is already in progress.
_ServiceNotFound :: AsError a => Getting (First ServiceError) a ServiceError Source #
No service exists with the specified ID.
_OperationNotFound :: AsError a => Getting (First ServiceError) a ServiceError Source #
No operation exists with the specified ID.
CustomHealthStatus
data CustomHealthStatus Source #
Instances
FilterCondition
data FilterCondition Source #
Instances
HealthCheckType
data HealthCheckType Source #
Instances
HealthStatus
data HealthStatus Source #
Instances
NamespaceFilterName
data NamespaceFilterName Source #
Instances
NamespaceType
data NamespaceType Source #
Instances
OperationFilterName
data OperationFilterName Source #
Instances
OperationStatus
data OperationStatus Source #
Instances
OperationTargetType
data OperationTargetType Source #
Instances
OperationType
data OperationType Source #
Instances
RecordType
data RecordType Source #
Instances
RoutingPolicy
data RoutingPolicy Source #
Instances
ServiceFilterName
data ServiceFilterName Source #
Instances
DNSConfig
A complex type that contains information about the records that you want Amazon Route 53 to create when you register an instance.
See: dnsConfig
smart constructor.
Instances
Creates a value of DNSConfig
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
dcRoutingPolicy
- The routing policy that you want to apply to all records that Route 53 creates when you register an instance and specify this service. 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 the service includes configurations for one A record and a health check, and 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 the service includes configurations for one A record and a health check, and 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 .dcNamespaceId
- The ID of the namespace to use for DNS configuration.dcDNSRecords
- An array that contains oneDnsRecord
object for each record that you want Route 53 to create when you register an instance.
dcRoutingPolicy :: Lens' DNSConfig (Maybe RoutingPolicy) Source #
The routing policy that you want to apply to all records that Route 53 creates when you register an instance and specify this service. 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 the service includes configurations for one A record and a health check, and 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 the service includes configurations for one A record and a health check, and 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 .
dcDNSRecords :: Lens' DNSConfig [DNSRecord] Source #
An array that contains one DnsRecord
object for each record that you want Route 53 to create when you register an instance.
DNSConfigChange
data DNSConfigChange Source #
A complex type that contains information about changes to the records that Route 53 creates when you register an instance.
See: dnsConfigChange
smart constructor.
Instances
dnsConfigChange :: DNSConfigChange Source #
Creates a value of DNSConfigChange
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
dccDNSRecords
- An array that contains oneDnsRecord
object for each record that you want Route 53 to create when you register an instance.
dccDNSRecords :: Lens' DNSConfigChange [DNSRecord] Source #
An array that contains one DnsRecord
object for each record that you want Route 53 to create when you register an instance.
DNSProperties
data DNSProperties Source #
A complex type that contains the ID for the hosted zone that Route 53 creates when you create a namespace.
See: dnsProperties
smart constructor.
Instances
dnsProperties :: DNSProperties Source #
Creates a value of DNSProperties
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
dpHostedZoneId
- The ID for the hosted zone that Route 53 creates when you create a namespace.
dpHostedZoneId :: Lens' DNSProperties (Maybe Text) Source #
The ID for the hosted zone that Route 53 creates when you create a namespace.
DNSRecord
A complex type that contains information about the records that you want Route 53 to create when you register an instance.
See: dnsRecord
smart constructor.
Instances
Creates a value of DNSRecord
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
drType
- The type of the resource, which indicates the type of value that Route 53 returns in response to DNS queries. Note the following: * A, AAAA, and SRV records: You can specify settings for a maximum of one A, one AAAA, and one SRV record. You can specify them in any combination. * CNAME records: If you specifyCNAME
forType
, you can't define any other records. This is a limitation of DNS—you can't create a CNAME record and any other type of record that has the same name as a CNAME record. * Alias records: If you want Route 53 to create an alias record when you register an instance, specifyA
orAAAA
forType
. * All records: You specify settings other thanTTL
andType
when you register an instance. The following values are supported: A Route 53 returns the IP address of the resource in IPv4 format, such as 192.0.2.44. AAAA Route 53 returns the IP address of the resource in IPv6 format, such as 2001:0db8:85a3:0000:0000:abcd:0001:2345. CNAME Route 53 returns the domain name of the resource, such as www.example.com. Note the following: * You specify the domain name that you want to route traffic to when you register an instance. For more information, see 'RegisterInstanceRequest$Attributes' . * You must specifyWEIGHTED
for the value ofRoutingPolicy
. * You can't specify bothCNAME
forType
and settings forHealthCheckConfig
. If you do, the request will fail with anInvalidInput
error. SRV Route 53 returns the value for an SRV record. The value for an SRV record uses the following values:priority weight port service-hostname
Note the following about the values: * The values ofpriority
andweight
are both set to1
and can't be changed. * The value ofport
comes from the value that you specify for theAWS_INSTANCE_PORT
attribute when you submit aRegisterInstance
request. * The value ofservice-hostname
is a concatenation of the following values: * The value that you specify forInstanceId
when you register an instance. * The name of the service. * The name of the namespace. For example, if the value ofInstanceId
istest
, the name of the service isbackend
, and the name of the namespace isexample.com
, the value ofservice-hostname
is:test.backend.example.com
If you specify settings for an SRV record and if you specify values forAWS_INSTANCE_IPV4
,AWS_INSTANCE_IPV6
, or both in theRegisterInstance
request, Route 53 automatically createsA
and/orAAAA
records that have the same name as the value ofservice-hostname
in the SRV record. You can ignore these records.drTTL
- The amount of time, in seconds, that you want DNS resolvers to cache the settings for this record.
drType :: Lens' DNSRecord RecordType Source #
The type of the resource, which indicates the type of value that Route 53 returns in response to DNS queries. Note the following: * A, AAAA, and SRV records: You can specify settings for a maximum of one A, one AAAA, and one SRV record. You can specify them in any combination. * CNAME records: If you specify CNAME
for Type
, you can't define any other records. This is a limitation of DNS—you can't create a CNAME record and any other type of record that has the same name as a CNAME record. * Alias records: If you want Route 53 to create an alias record when you register an instance, specify A
or AAAA
for Type
. * All records: You specify settings other than TTL
and Type
when you register an instance. The following values are supported: A Route 53 returns the IP address of the resource in IPv4 format, such as 192.0.2.44. AAAA Route 53 returns the IP address of the resource in IPv6 format, such as 2001:0db8:85a3:0000:0000:abcd:0001:2345. CNAME Route 53 returns the domain name of the resource, such as www.example.com. Note the following: * You specify the domain name that you want to route traffic to when you register an instance. For more information, see 'RegisterInstanceRequest$Attributes' . * You must specify WEIGHTED
for the value of RoutingPolicy
. * You can't specify both CNAME
for Type
and settings for HealthCheckConfig
. If you do, the request will fail with an InvalidInput
error. SRV Route 53 returns the value for an SRV record. The value for an SRV record uses the following values: priority weight port service-hostname
Note the following about the values: * The values of priority
and weight
are both set to 1
and can't be changed. * The value of port
comes from the value that you specify for the AWS_INSTANCE_PORT
attribute when you submit a RegisterInstance
request. * The value of service-hostname
is a concatenation of the following values: * The value that you specify for InstanceId
when you register an instance. * The name of the service. * The name of the namespace. For example, if the value of InstanceId
is test
, the name of the service is backend
, and the name of the namespace is example.com
, the value of service-hostname
is: test.backend.example.com
If you specify settings for an SRV record and if you specify values for AWS_INSTANCE_IPV4
, AWS_INSTANCE_IPV6
, or both in the RegisterInstance
request, Route 53 automatically creates A
and/or AAAA
records that have the same name as the value of service-hostname
in the SRV record. You can ignore these records.
drTTL :: Lens' DNSRecord Natural Source #
The amount of time, in seconds, that you want DNS resolvers to cache the settings for this record.
HealthCheckConfig
data HealthCheckConfig Source #
Public DNS namespaces only. A complex type that contains settings for an optional health check. If you specify settings for a health check, Amazon Route 53 associates the health check with all the records that you specify in DnsConfig
.
A and AAAA records
If DnsConfig
includes configurations for both A and AAAA records, Route 53 creates a health check that uses the IPv4 address to check the health of the resource. If the endpoint that is specified by the IPv4 address is unhealthy, Route 53 considers both the A and AAAA records to be unhealthy.
CNAME records
You can't specify settings for HealthCheckConfig
when the DNSConfig
includes CNAME
for the value of Type
. If you do, the CreateService
request will fail with an InvalidInput
error.
Request interval
The health check uses 30 seconds as the request interval. This is the number of seconds between the time that each Route 53 health checker gets a response from your endpoint and the time that it sends the next health check request. A health checker in each data center around the world sends your endpoint a health check request every 30 seconds. On average, your endpoint receives a health check request about every two seconds. Health checkers in different data centers don't coordinate with one another, so you'll sometimes see several requests per second followed by a few seconds with no health checks at all.
Health checking regions
Health checkers perform checks from all Route 53 health-checking regions. For a list of the current regions, see Regions .
Alias records
When you register an instance, if you include the AWS_ALIAS_DNS_NAME
attribute, Route 53 creates an alias record. Note the following:
- Route 53 automatically sets
EvaluateTargetHealth
to true for alias records. WhenEvaluateTargetHealth
is true, the alias record inherits the health of the referenced AWS resource. such as an ELB load balancer. For more information, see EvaluateTargetHealth . - If you include
HealthCheckConfig
and then use the service to register an instance that creates an alias record, Route 53 doesn't create the health check.
For information about the charges for health checks, see Route 53 Pricing .
See: healthCheckConfig
smart constructor.
Instances
healthCheckConfig :: HealthCheckConfig Source #
Creates a value of HealthCheckConfig
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
hccFailureThreshold
- The number of consecutive health checks that an endpoint must pass or fail for Route 53 to change the current status of the endpoint from unhealthy to healthy or vice versa. For more information, see How Route 53 Determines Whether an Endpoint Is Healthy in the Route 53 Developer Guide .hccResourcePath
- The path that you want Route 53 to request when performing health checks. The path can be any value for which your endpoint will return an HTTP status code of 2xx or 3xx when the endpoint is healthy, such as the filedocsroute53-health-check.html
. Route 53 automatically adds the DNS name for the service and a leading forward slash (/
) character.hccType
- The type of health check that you want to create, which indicates how Route 53 determines whether an endpoint is healthy. Important: You can't change the value ofType
after you create a health check. You can create the following types of health checks: * HTTP : Route 53 tries to establish a TCP connection. If successful, Route 53 submits an HTTP request and waits for an HTTP status code of 200 or greater and less than 400. * HTTPS : Route 53 tries to establish a TCP connection. If successful, Route 53 submits an HTTPS request and waits for an HTTP status code of 200 or greater and less than 400. Important: If you specify HTTPS for the value ofType
, the endpoint must support TLS v1.0 or later. * TCP : Route 53 tries to establish a TCP connection. For more information, see How Route 53 Determines Whether an Endpoint Is Healthy in the Route 53 Developer Guide .
hccFailureThreshold :: Lens' HealthCheckConfig (Maybe Natural) Source #
The number of consecutive health checks that an endpoint must pass or fail for Route 53 to change the current status of the endpoint from unhealthy to healthy or vice versa. For more information, see How Route 53 Determines Whether an Endpoint Is Healthy in the Route 53 Developer Guide .
hccResourcePath :: Lens' HealthCheckConfig (Maybe Text) Source #
The path that you want Route 53 to request when performing health checks. The path can be any value for which your endpoint will return an HTTP status code of 2xx or 3xx when the endpoint is healthy, such as the file docsroute53-health-check.html
. Route 53 automatically adds the DNS name for the service and a leading forward slash (/
) character.
hccType :: Lens' HealthCheckConfig (Maybe HealthCheckType) Source #
The type of health check that you want to create, which indicates how Route 53 determines whether an endpoint is healthy. Important: You can't change the value of Type
after you create a health check. You can create the following types of health checks: * HTTP : Route 53 tries to establish a TCP connection. If successful, Route 53 submits an HTTP request and waits for an HTTP status code of 200 or greater and less than 400. * HTTPS : Route 53 tries to establish a TCP connection. If successful, Route 53 submits an HTTPS request and waits for an HTTP status code of 200 or greater and less than 400. Important: If you specify HTTPS for the value of Type
, the endpoint must support TLS v1.0 or later. * TCP : Route 53 tries to establish a TCP connection. For more information, see How Route 53 Determines Whether an Endpoint Is Healthy in the Route 53 Developer Guide .
HealthCheckCustomConfig
data HealthCheckCustomConfig Source #
See: healthCheckCustomConfig
smart constructor.
Instances
healthCheckCustomConfig :: HealthCheckCustomConfig Source #
Creates a value of HealthCheckCustomConfig
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
hcccFailureThreshold
- Undocumented member.
hcccFailureThreshold :: Lens' HealthCheckCustomConfig (Maybe Natural) Source #
Undocumented member.
Instance
A complex type that contains information about an instance that Amazon Route 53 creates when you submit a RegisterInstance
request.
See: instance'
smart constructor.
Instances
Creates a value of Instance
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
iCreatorRequestId
- A unique string that identifies the request and that allows failedRegisterInstance
requests to be retried without the risk of executing the operation twice. You must use a uniqueCreatorRequestId
string every time you submit aRegisterInstance
request if you're registering additional instances for the same namespace and service.CreatorRequestId
can be any unique string, for example, a date/time stamp.iAttributes
- A string map that contains the following information for the service that you specify inServiceId
: * The attributes that apply to the records that are defined in the service. * For each attribute, the applicable value. Supported attribute keys include the following: AWS_ALIAS_DNS_NAME __ If you want Route 53 to create an alias record that routes traffic to an Elastic Load Balancing load balancer, specify the DNS name that is associated with the load balancer. For information about how to get the DNS name, see DNSName in the topic AliasTarget . Note the following: * The configuration for the service that is specified byServiceId
must include settings for an A record, an AAAA record, or both. * In the service that is specified byServiceId
, the value ofRoutingPolicy
must beWEIGHTED
. * If the service that is specified byServiceId
includesHealthCheckConfig
settings, Route 53 will create the health check, but it won't associate the health check with the alias record. * Auto naming currently doesn't support creating alias records that route traffic to AWS resources other than ELB load balancers. * If you specify a value forAWS_ALIAS_DNS_NAME
, don't specify values for any of theAWS_INSTANCE
attributes. AWS_INSTANCE_CNAME If the service configuration includes a CNAME record, the domain name that you want Route 53 to return in response to DNS queries, for example,example.com
. This value is required if the service specified byServiceId
includes settings for an CNAME record. AWS_INSTANCE_IPV4 If the service configuration includes an A record, the IPv4 address that you want Route 53 to return in response to DNS queries, for example,192.0.2.44
. This value is required if the service specified byServiceId
includes settings for an A record. If the service includes settings for an SRV record, you must specify a value forAWS_INSTANCE_IPV4
,AWS_INSTANCE_IPV6
, or both. AWS_INSTANCE_IPV6 If the service configuration includes an AAAA record, the IPv6 address that you want Route 53 to return in response to DNS queries, for example,2001:0db8:85a3:0000:0000:abcd:0001:2345
. This value is required if the service specified byServiceId
includes settings for an AAAA record. If the service includes settings for an SRV record, you must specify a value forAWS_INSTANCE_IPV4
,AWS_INSTANCE_IPV6
, or both. AWS_INSTANCE_PORT__ If the service includes an SRV record, the value that you want Route 53 to return for the port. If the service includesHealthCheckConfig
, the port on the endpoint that you want Route 53 to send requests to. This value is required if you specified settings for an SRV record when you created the service.iId
- An identifier that you want to associate with the instance. Note the following: * If the service that is specified byServiceId
includes settings for an SRV record, the value ofInstanceId
is automatically included as part of the value for the SRV record. For more information, see 'DnsRecord$Type' . * You can use this value to update an existing instance. * To register a new instance, you must specify a value that is unique among instances that you register by using the same service. * If you specify an existingInstanceId
andServiceId
, Route 53 updates the existing records. If there's also an existing health check, Route 53 deletes the old health check and creates a new one.
iCreatorRequestId :: Lens' Instance (Maybe Text) Source #
A unique string that identifies the request and that allows failed RegisterInstance
requests to be retried without the risk of executing the operation twice. You must use a unique CreatorRequestId
string every time you submit a RegisterInstance
request if you're registering additional instances for the same namespace and service. CreatorRequestId
can be any unique string, for example, a date/time stamp.
iAttributes :: Lens' Instance (HashMap Text Text) Source #
A string map that contains the following information for the service that you specify in ServiceId
: * The attributes that apply to the records that are defined in the service. * For each attribute, the applicable value. Supported attribute keys include the following: AWS_ALIAS_DNS_NAME __ If you want Route 53 to create an alias record that routes traffic to an Elastic Load Balancing load balancer, specify the DNS name that is associated with the load balancer. For information about how to get the DNS name, see DNSName in the topic AliasTarget . Note the following: * The configuration for the service that is specified by ServiceId
must include settings for an A record, an AAAA record, or both. * In the service that is specified by ServiceId
, the value of RoutingPolicy
must be WEIGHTED
. * If the service that is specified by ServiceId
includes HealthCheckConfig
settings, Route 53 will create the health check, but it won't associate the health check with the alias record. * Auto naming currently doesn't support creating alias records that route traffic to AWS resources other than ELB load balancers. * If you specify a value for AWS_ALIAS_DNS_NAME
, don't specify values for any of the AWS_INSTANCE
attributes. AWS_INSTANCE_CNAME If the service configuration includes a CNAME record, the domain name that you want Route 53 to return in response to DNS queries, for example, example.com
. This value is required if the service specified by ServiceId
includes settings for an CNAME record. AWS_INSTANCE_IPV4 If the service configuration includes an A record, the IPv4 address that you want Route 53 to return in response to DNS queries, for example, 192.0.2.44
. This value is required if the service specified by ServiceId
includes settings for an A record. If the service includes settings for an SRV record, you must specify a value for AWS_INSTANCE_IPV4
, AWS_INSTANCE_IPV6
, or both. AWS_INSTANCE_IPV6 If the service configuration includes an AAAA record, the IPv6 address that you want Route 53 to return in response to DNS queries, for example, 2001:0db8:85a3:0000:0000:abcd:0001:2345
. This value is required if the service specified by ServiceId
includes settings for an AAAA record. If the service includes settings for an SRV record, you must specify a value for AWS_INSTANCE_IPV4
, AWS_INSTANCE_IPV6
, or both. AWS_INSTANCE_PORT__ If the service includes an SRV record, the value that you want Route 53 to return for the port. If the service includes HealthCheckConfig
, the port on the endpoint that you want Route 53 to send requests to. This value is required if you specified settings for an SRV record when you created the service.
iId :: Lens' Instance Text Source #
An identifier that you want to associate with the instance. Note the following: * If the service that is specified by ServiceId
includes settings for an SRV record, the value of InstanceId
is automatically included as part of the value for the SRV record. For more information, see 'DnsRecord$Type' . * You can use this value to update an existing instance. * To register a new instance, you must specify a value that is unique among instances that you register by using the same service. * If you specify an existing InstanceId
and ServiceId
, Route 53 updates the existing records. If there's also an existing health check, Route 53 deletes the old health check and creates a new one.
InstanceSummary
data InstanceSummary Source #
A complex type that contains information about the instances that you registered by using a specified service.
See: instanceSummary
smart constructor.
Instances
instanceSummary :: InstanceSummary Source #
Creates a value of InstanceSummary
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
isAttributes
- A string map that contains the following information: * The attributes that are associate with the instance. * For each attribute, the applicable value. Supported attribute keys include the following: *AWS_ALIAS_DNS_NAME
: For an alias record that routes traffic to an Elastic Load Balancing load balancer, the DNS name that is associated with the load balancer. *AWS_INSTANCE_CNAME
: For a CNAME record, the domain name that Route 53 returns in response to DNS queries, for example,example.com
. *AWS_INSTANCE_IPV4
: For an A record, the IPv4 address that Route 53 returns in response to DNS queries, for example,192.0.2.44
. *AWS_INSTANCE_IPV6
: For an AAAA record, the IPv6 address that Route 53 returns in response to DNS queries, for example,2001:0db8:85a3:0000:0000:abcd:0001:2345
. *AWS_INSTANCE_PORT
: For an SRV record, the value that Route 53 returns for the port. In addition, if the service includesHealthCheckConfig
, the port on the endpoint that Route 53 sends requests to.isId
- The ID for an instance that you created by using a specified service.
isAttributes :: Lens' InstanceSummary (HashMap Text Text) Source #
A string map that contains the following information: * The attributes that are associate with the instance. * For each attribute, the applicable value. Supported attribute keys include the following: * AWS_ALIAS_DNS_NAME
: For an alias record that routes traffic to an Elastic Load Balancing load balancer, the DNS name that is associated with the load balancer. * AWS_INSTANCE_CNAME
: For a CNAME record, the domain name that Route 53 returns in response to DNS queries, for example, example.com
. * AWS_INSTANCE_IPV4
: For an A record, the IPv4 address that Route 53 returns in response to DNS queries, for example, 192.0.2.44
. * AWS_INSTANCE_IPV6
: For an AAAA record, the IPv6 address that Route 53 returns in response to DNS queries, for example, 2001:0db8:85a3:0000:0000:abcd:0001:2345
. * AWS_INSTANCE_PORT
: For an SRV record, the value that Route 53 returns for the port. In addition, if the service includes HealthCheckConfig
, the port on the endpoint that Route 53 sends requests to.
isId :: Lens' InstanceSummary (Maybe Text) Source #
The ID for an instance that you created by using a specified service.
Namespace
A complex type that contains information about a specified namespace.
See: namespace
smart constructor.
Instances
namespace :: Namespace Source #
Creates a value of Namespace
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
nARN
- The Amazon Resource Name (ARN) that Route 53 assigns to the namespace when you create it.nCreatorRequestId
- A unique string that identifies the request and that allows failed requests to be retried without the risk of executing an operation twice.nCreateDate
- The date that the namespace was created, in Unix date/time format and Coordinated Universal Time (UTC). The value ofCreateDate
is accurate to milliseconds. For example, the value1516925490.087
represents Friday, January 26, 2018 12:11:30.087 AM.nServiceCount
- The number of services that are associated with the namespace.nName
- The name of the namespace, such asexample.com
.nId
- The ID of a namespace.nType
- The type of the namespace. Valid values areDNS_PUBLIC
andDNS_PRIVATE
.nDescription
- The description that you specify for the namespace when you create it.nProperties
- A complex type that contains information that's specific to the type of the namespace.
nARN :: Lens' Namespace (Maybe Text) Source #
The Amazon Resource Name (ARN) that Route 53 assigns to the namespace when you create it.
nCreatorRequestId :: Lens' Namespace (Maybe Text) Source #
A unique string that identifies the request and that allows failed requests to be retried without the risk of executing an operation twice.
nCreateDate :: Lens' Namespace (Maybe UTCTime) Source #
The date that the namespace was created, in Unix date/time format and Coordinated Universal Time (UTC). The value of CreateDate
is accurate to milliseconds. For example, the value 1516925490.087
represents Friday, January 26, 2018 12:11:30.087 AM.
nServiceCount :: Lens' Namespace (Maybe Int) Source #
The number of services that are associated with the namespace.
nType :: Lens' Namespace (Maybe NamespaceType) Source #
The type of the namespace. Valid values are DNS_PUBLIC
and DNS_PRIVATE
.
nDescription :: Lens' Namespace (Maybe Text) Source #
The description that you specify for the namespace when you create it.
nProperties :: Lens' Namespace (Maybe NamespaceProperties) Source #
A complex type that contains information that's specific to the type of the namespace.
NamespaceFilter
data NamespaceFilter Source #
A complex type that identifies the namespaces that you want to list. You can choose to list public or private namespaces.
See: namespaceFilter
smart constructor.
Instances
Creates a value of NamespaceFilter
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
nfCondition
- The operator that you want to use to determine whetherListNamespaces
returns a namespace. Valid values forcondition
include: *EQ
: When you specifyEQ
for the condition, you can choose to list only public namespaces or private namespaces, but not both.EQ
is the default condition and can be omitted. *IN
: When you specifyIN
for the condition, you can choose to list public namespaces, private namespaces, or both. *BETWEEN
: Not applicablenfName
- SpecifyTYPE
.nfValues
- If you specifyEQ
forCondition
, specify eitherDNS_PUBLIC
orDNS_PRIVATE
. If you specifyIN
forCondition
, you can specifyDNS_PUBLIC
,DNS_PRIVATE
, or both.
nfCondition :: Lens' NamespaceFilter (Maybe FilterCondition) Source #
The operator that you want to use to determine whether ListNamespaces
returns a namespace. Valid values for condition
include: * EQ
: When you specify EQ
for the condition, you can choose to list only public namespaces or private namespaces, but not both. EQ
is the default condition and can be omitted. * IN
: When you specify IN
for the condition, you can choose to list public namespaces, private namespaces, or both. * BETWEEN
: Not applicable
nfName :: Lens' NamespaceFilter NamespaceFilterName Source #
Specify TYPE
.
nfValues :: Lens' NamespaceFilter [Text] Source #
If you specify EQ
for Condition
, specify either DNS_PUBLIC
or DNS_PRIVATE
. If you specify IN
for Condition
, you can specify DNS_PUBLIC
, DNS_PRIVATE
, or both.
NamespaceProperties
data NamespaceProperties Source #
A complex type that contains information that is specific to the namespace type.
See: namespaceProperties
smart constructor.
Instances
namespaceProperties :: NamespaceProperties Source #
Creates a value of NamespaceProperties
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
npDNSProperties
- A complex type that contains the ID for the hosted zone that Route 53 creates when you create a namespace.
npDNSProperties :: Lens' NamespaceProperties (Maybe DNSProperties) Source #
A complex type that contains the ID for the hosted zone that Route 53 creates when you create a namespace.
NamespaceSummary
data NamespaceSummary Source #
A complex type that contains information about a namespace.
See: namespaceSummary
smart constructor.
Instances
namespaceSummary :: NamespaceSummary Source #
Creates a value of NamespaceSummary
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
nsARN
- The Amazon Resource Name (ARN) that Route 53 assigns to the namespace when you create it.nsName
- The name of the namespace. When you create a namespace, Route 53 automatically creates a hosted zone that has the same name as the namespace.nsId
- The ID of the namespace.nsType
- The type of the namespace, either public or private.
nsARN :: Lens' NamespaceSummary (Maybe Text) Source #
The Amazon Resource Name (ARN) that Route 53 assigns to the namespace when you create it.
nsName :: Lens' NamespaceSummary (Maybe Text) Source #
The name of the namespace. When you create a namespace, Route 53 automatically creates a hosted zone that has the same name as the namespace.
nsType :: Lens' NamespaceSummary (Maybe NamespaceType) Source #
The type of the namespace, either public or private.
Operation
A complex type that contains information about a specified operation.
See: operation
smart constructor.
Instances
operation :: Operation Source #
Creates a value of Operation
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
oStatus
- The status of the operation. Values include the following: * SUBMITTED : This is the initial state immediately after you submit a request. * PENDING : Route 53 is performing the operation. * SUCCESS : The operation succeeded. * FAIL : The operation failed. For the failure reason, seeErrorMessage
.oUpdateDate
- The date and time that the value ofStatus
changed to the current value, in Unix date/time format and Coordinated Universal Time (UTC). The value ofUpdateDate
is accurate to milliseconds. For example, the value1516925490.087
represents Friday, January 26, 2018 12:11:30.087 AM.oCreateDate
- The date and time that the request was submitted, in Unix date/time format and Coordinated Universal Time (UTC). The value ofCreateDate
is accurate to milliseconds. For example, the value1516925490.087
represents Friday, January 26, 2018 12:11:30.087 AM.oTargets
- The name of the target entity that is associated with the operation: * NAMESPACE : The namespace ID is returned in theResourceId
property. * SERVICE : The service ID is returned in theResourceId
property. * INSTANCE : The instance ID is returned in theResourceId
property.oErrorCode
- The code associated withErrorMessage
. Values forErrorCode
include the following: *ACCESS_DENIED
*CANNOT_CREATE_HOSTED_ZONE
*EXPIRED_TOKEN
*HOSTED_ZONE_NOT_FOUND
*INTERNAL_FAILURE
*INVALID_CHANGE_BATCH
*THROTTLED_REQUEST
oId
- The ID of the operation that you want to get information about.oType
- The name of the operation that is associated with the specified ID.oErrorMessage
- If the value ofStatus
isFAIL
, the reason that the operation failed.
oStatus :: Lens' Operation (Maybe OperationStatus) Source #
The status of the operation. Values include the following: * SUBMITTED : This is the initial state immediately after you submit a request. * PENDING : Route 53 is performing the operation. * SUCCESS : The operation succeeded. * FAIL : The operation failed. For the failure reason, see ErrorMessage
.
oUpdateDate :: Lens' Operation (Maybe UTCTime) Source #
The date and time that the value of Status
changed to the current value, in Unix date/time format and Coordinated Universal Time (UTC). The value of UpdateDate
is accurate to milliseconds. For example, the value 1516925490.087
represents Friday, January 26, 2018 12:11:30.087 AM.
oCreateDate :: Lens' Operation (Maybe UTCTime) Source #
The date and time that the request was submitted, in Unix date/time format and Coordinated Universal Time (UTC). The value of CreateDate
is accurate to milliseconds. For example, the value 1516925490.087
represents Friday, January 26, 2018 12:11:30.087 AM.
oTargets :: Lens' Operation (HashMap OperationTargetType Text) Source #
The name of the target entity that is associated with the operation: * NAMESPACE : The namespace ID is returned in the ResourceId
property. * SERVICE : The service ID is returned in the ResourceId
property. * INSTANCE : The instance ID is returned in the ResourceId
property.
oErrorCode :: Lens' Operation (Maybe Text) Source #
The code associated with ErrorMessage
. Values for ErrorCode
include the following: * ACCESS_DENIED
* CANNOT_CREATE_HOSTED_ZONE
* EXPIRED_TOKEN
* HOSTED_ZONE_NOT_FOUND
* INTERNAL_FAILURE
* INVALID_CHANGE_BATCH
* THROTTLED_REQUEST
oId :: Lens' Operation (Maybe Text) Source #
The ID of the operation that you want to get information about.
oType :: Lens' Operation (Maybe OperationType) Source #
The name of the operation that is associated with the specified ID.
oErrorMessage :: Lens' Operation (Maybe Text) Source #
If the value of Status
is FAIL
, the reason that the operation failed.
OperationFilter
data OperationFilter Source #
A complex type that lets you select the operations that you want to list.
See: operationFilter
smart constructor.
Instances
Creates a value of OperationFilter
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ofCondition
- The operator that you want to use to determine whether an operation matches the specified value. Valid values for condition include: *EQ
: When you specifyEQ
for the condition, you can specify only one value.EQ
is supported forNAMESPACE_ID
,SERVICE_ID
,STATUS
, andTYPE
.EQ
is the default condition and can be omitted. *IN
: When you specifyIN
for the condition, you can specify a list of one or more values.IN
is supported forSTATUS
andTYPE
. An operation must match one of the specified values to be returned in the response. *BETWEEN
: Specify a start date and an end date in Unix date/time format and Coordinated Universal Time (UTC). The start date must be the first value.BETWEEN
is supported forUPDATE_DATE
.ofName
- Specify the operations that you want to get: * NAMESPACE_ID : Gets operations related to specified namespaces. * SERVICE_ID : Gets operations related to specified services. * STATUS : Gets operations based on the status of the operations:SUBMITTED
,PENDING
,SUCCEED
, orFAIL
. * TYPE : Gets specified types of operation. * UPDATE_DATE : Gets operations that changed status during a specified date/time range.ofValues
- Specify values that are applicable to the value that you specify forName
: * NAMESPACE_ID : Specify one namespace ID. * SERVICE_ID : Specify one service ID. * STATUS : Specify one or more statuses:SUBMITTED
,PENDING
,SUCCEED
, orFAIL
. * TYPE : Specify one or more of the following types:CREATE_NAMESPACE
,DELETE_NAMESPACE
,UPDATE_SERVICE
,REGISTER_INSTANCE
, orDEREGISTER_INSTANCE
. * UPDATE_DATE : Specify a start date and an end date in Unix date/time format and Coordinated Universal Time (UTC). The start date must be the first value.
ofCondition :: Lens' OperationFilter (Maybe FilterCondition) Source #
The operator that you want to use to determine whether an operation matches the specified value. Valid values for condition include: * EQ
: When you specify EQ
for the condition, you can specify only one value. EQ
is supported for NAMESPACE_ID
, SERVICE_ID
, STATUS
, and TYPE
. EQ
is the default condition and can be omitted. * IN
: When you specify IN
for the condition, you can specify a list of one or more values. IN
is supported for STATUS
and TYPE
. An operation must match one of the specified values to be returned in the response. * BETWEEN
: Specify a start date and an end date in Unix date/time format and Coordinated Universal Time (UTC). The start date must be the first value. BETWEEN
is supported for UPDATE_DATE
.
ofName :: Lens' OperationFilter OperationFilterName Source #
Specify the operations that you want to get: * NAMESPACE_ID : Gets operations related to specified namespaces. * SERVICE_ID : Gets operations related to specified services. * STATUS : Gets operations based on the status of the operations: SUBMITTED
, PENDING
, SUCCEED
, or FAIL
. * TYPE : Gets specified types of operation. * UPDATE_DATE : Gets operations that changed status during a specified date/time range.
ofValues :: Lens' OperationFilter [Text] Source #
Specify values that are applicable to the value that you specify for Name
: * NAMESPACE_ID : Specify one namespace ID. * SERVICE_ID : Specify one service ID. * STATUS : Specify one or more statuses: SUBMITTED
, PENDING
, SUCCEED
, or FAIL
. * TYPE : Specify one or more of the following types: CREATE_NAMESPACE
, DELETE_NAMESPACE
, UPDATE_SERVICE
, REGISTER_INSTANCE
, or DEREGISTER_INSTANCE
. * UPDATE_DATE : Specify a start date and an end date in Unix date/time format and Coordinated Universal Time (UTC). The start date must be the first value.
OperationSummary
data OperationSummary Source #
A complex type that contains information about an operation that matches the criteria that you specified in a ListOperations
request.
See: operationSummary
smart constructor.
Instances
operationSummary :: OperationSummary Source #
Creates a value of OperationSummary
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
osStatus
- The status of the operation. Values include the following: * SUBMITTED : This is the initial state immediately after you submit a request. * PENDING : Route 53 is performing the operation. * SUCCESS : The operation succeeded. * FAIL : The operation failed. For the failure reason, seeErrorMessage
.osId
- The ID for an operation.
osStatus :: Lens' OperationSummary (Maybe OperationStatus) Source #
The status of the operation. Values include the following: * SUBMITTED : This is the initial state immediately after you submit a request. * PENDING : Route 53 is performing the operation. * SUCCESS : The operation succeeded. * FAIL : The operation failed. For the failure reason, see ErrorMessage
.
ServiceChange
data ServiceChange Source #
A complex type that contains changes to an existing service.
See: serviceChange
smart constructor.
Instances
Creates a value of ServiceChange
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
scHealthCheckConfig
- Undocumented member.scDescription
- A description for the service.scDNSConfig
- A complex type that contains information about the records that you want Route 53 to create when you register an instance.
scHealthCheckConfig :: Lens' ServiceChange (Maybe HealthCheckConfig) Source #
Undocumented member.
scDescription :: Lens' ServiceChange (Maybe Text) Source #
A description for the service.
scDNSConfig :: Lens' ServiceChange DNSConfigChange Source #
A complex type that contains information about the records that you want Route 53 to create when you register an instance.
ServiceFilter
data ServiceFilter Source #
A complex type that lets you specify the namespaces that you want to list services for.
See: serviceFilter
smart constructor.
Instances
Creates a value of ServiceFilter
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
sfCondition
- The operator that you want to use to determine whether a service is returned byListServices
. Valid values forCondition
include the following: *EQ
: When you specifyEQ
, specify one namespace ID forValues
.EQ
is the default condition and can be omitted. *IN
: When you specifyIN
, specify a list of the IDs for the namespaces that you wantListServices
to return a list of services for. *BETWEEN
: Not applicable.sfName
- SpecifyNAMESPACE_ID
.sfValues
- The values that are applicable to the value that you specify forCondition
to filter the list of services.
sfCondition :: Lens' ServiceFilter (Maybe FilterCondition) Source #
The operator that you want to use to determine whether a service is returned by ListServices
. Valid values for Condition
include the following: * EQ
: When you specify EQ
, specify one namespace ID for Values
. EQ
is the default condition and can be omitted. * IN
: When you specify IN
, specify a list of the IDs for the namespaces that you want ListServices
to return a list of services for. * BETWEEN
: Not applicable.
sfName :: Lens' ServiceFilter ServiceFilterName Source #
Specify NAMESPACE_ID
.
sfValues :: Lens' ServiceFilter [Text] Source #
The values that are applicable to the value that you specify for Condition
to filter the list of services.
ServiceInfo
data ServiceInfo Source #
A complex type that contains information about the specified service.
See: serviceInfo
smart constructor.
Instances
serviceInfo :: ServiceInfo Source #
Creates a value of ServiceInfo
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
siInstanceCount
- The number of instances that are currently associated with the service. Instances that were previously associated with the service but that have been deleted are not included in the count.siARN
- The Amazon Resource Name (ARN) that Route 53 assigns to the service when you create it.siHealthCheckConfig
- Public DNS namespaces only. A complex type that contains settings for an optional health check. If you specify settings for a health check, Route 53 associates the health check with all the records that you specify inDnsConfig
. For information about the charges for health checks, see Route 53 Pricing .siCreatorRequestId
- A unique string that identifies the request and that allows failed requests to be retried without the risk of executing the operation twice.CreatorRequestId
can be any unique string, for example, a date/time stamp.siCreateDate
- The date and time that the service was created, in Unix format and Coordinated Universal Time (UTC). The value ofCreateDate
is accurate to milliseconds. For example, the value1516925490.087
represents Friday, January 26, 2018 12:11:30.087 AM.siHealthCheckCustomConfig
- Undocumented member.siName
- The name of the service.siId
- The ID that Route 53 assigned to the service when you created it.siDNSConfig
- A complex type that contains information about the records that you want Route 53 to create when you register an instance.siDescription
- The description of the service.
siInstanceCount :: Lens' ServiceInfo (Maybe Int) Source #
The number of instances that are currently associated with the service. Instances that were previously associated with the service but that have been deleted are not included in the count.
siARN :: Lens' ServiceInfo (Maybe Text) Source #
The Amazon Resource Name (ARN) that Route 53 assigns to the service when you create it.
siHealthCheckConfig :: Lens' ServiceInfo (Maybe HealthCheckConfig) Source #
Public DNS namespaces only. A complex type that contains settings for an optional health check. If you specify settings for a health check, Route 53 associates the health check with all the records that you specify in DnsConfig
. For information about the charges for health checks, see Route 53 Pricing .
siCreatorRequestId :: Lens' ServiceInfo (Maybe Text) Source #
A unique string that identifies the request and that allows failed requests to be retried without the risk of executing the operation twice. CreatorRequestId
can be any unique string, for example, a date/time stamp.
siCreateDate :: Lens' ServiceInfo (Maybe UTCTime) Source #
The date and time that the service was created, in Unix format and Coordinated Universal Time (UTC). The value of CreateDate
is accurate to milliseconds. For example, the value 1516925490.087
represents Friday, January 26, 2018 12:11:30.087 AM.
siHealthCheckCustomConfig :: Lens' ServiceInfo (Maybe HealthCheckCustomConfig) Source #
Undocumented member.
siId :: Lens' ServiceInfo (Maybe Text) Source #
The ID that Route 53 assigned to the service when you created it.
siDNSConfig :: Lens' ServiceInfo (Maybe DNSConfig) Source #
A complex type that contains information about the records that you want Route 53 to create when you register an instance.
siDescription :: Lens' ServiceInfo (Maybe Text) Source #
The description of the service.
ServiceSummary
data ServiceSummary Source #
A complex type that contains information about a specified service.
See: serviceSummary
smart constructor.
Instances
serviceSummary :: ServiceSummary Source #
Creates a value of ServiceSummary
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ssInstanceCount
- The number of instances that are currently associated with the service. Instances that were previously associated with the service but that have been deleted are not included in the count.ssARN
- The Amazon Resource Name (ARN) that Route 53 assigns to the service when you create it.ssName
- The name of the service.ssId
- The ID that Route 53 assigned to the service when you created it.ssDescription
- The description that you specify when you create the service.
ssInstanceCount :: Lens' ServiceSummary (Maybe Int) Source #
The number of instances that are currently associated with the service. Instances that were previously associated with the service but that have been deleted are not included in the count.
ssARN :: Lens' ServiceSummary (Maybe Text) Source #
The Amazon Resource Name (ARN) that Route 53 assigns to the service when you create it.
ssId :: Lens' ServiceSummary (Maybe Text) Source #
The ID that Route 53 assigned to the service when you created it.
ssDescription :: Lens' ServiceSummary (Maybe Text) Source #
The description that you specify when you create the service.