libZSservicesZSamazonka-route53ZSamazonka-route53
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.Route53.Lens

Contents

Description

 
Synopsis

Operations

GetHostedZoneLimit

getHostedZoneLimit_type :: Lens' GetHostedZoneLimit HostedZoneLimitType Source #

The limit that you want to get. Valid values include the following:

  • MAX_RRSETS_BY_ZONE: The maximum number of records that you can create in the specified hosted zone.
  • MAX_VPCS_ASSOCIATED_BY_ZONE: The maximum number of Amazon VPCs that you can associate with the specified private hosted zone.

getHostedZoneLimit_hostedZoneId :: Lens' GetHostedZoneLimit ResourceId Source #

The ID of the hosted zone that you want to get a limit for.

getHostedZoneLimitResponse_limit :: Lens' GetHostedZoneLimitResponse HostedZoneLimit Source #

The current setting for the specified limit. For example, if you specified MAX_RRSETS_BY_ZONE for the value of Type in the request, the value of Limit is the maximum number of records that you can create in the specified hosted zone.

getHostedZoneLimitResponse_count :: Lens' GetHostedZoneLimitResponse Natural Source #

The current number of entities that you have created of the specified type. For example, if you specified MAX_RRSETS_BY_ZONE for the value of Type in the request, the value of Count is the current number of records that you have created in the specified hosted zone.

AssociateVPCWithHostedZone

associateVPCWithHostedZone_comment :: Lens' AssociateVPCWithHostedZone (Maybe Text) Source #

Optional: A comment about the association request.

associateVPCWithHostedZone_hostedZoneId :: Lens' AssociateVPCWithHostedZone ResourceId Source #

The ID of the private hosted zone that you want to associate an Amazon VPC with.

Note that you can't associate a VPC with a hosted zone that doesn't have an existing VPC association.

associateVPCWithHostedZone_vpc :: Lens' AssociateVPCWithHostedZone VPC Source #

A complex type that contains information about the VPC that you want to associate with a private hosted zone.

associateVPCWithHostedZoneResponse_changeInfo :: Lens' AssociateVPCWithHostedZoneResponse ChangeInfo Source #

A complex type that describes the changes made to your hosted zone.

DeleteTrafficPolicy

deleteTrafficPolicy_id :: Lens' DeleteTrafficPolicy Text Source #

The ID of the traffic policy that you want to delete.

deleteTrafficPolicy_version :: Lens' DeleteTrafficPolicy Natural Source #

The version number of the traffic policy that you want to delete.

DisableHostedZoneDNSSEC

disableHostedZoneDNSSEC_hostedZoneId :: Lens' DisableHostedZoneDNSSEC ResourceId Source #

A unique string used to identify a hosted zone.

CreateKeySigningKey

createKeySigningKey_callerReference :: Lens' CreateKeySigningKey Text Source #

A unique string that identifies the request.

createKeySigningKey_hostedZoneId :: Lens' CreateKeySigningKey ResourceId Source #

The unique string (ID) used to identify a hosted zone.

createKeySigningKey_keyManagementServiceArn :: Lens' CreateKeySigningKey Text Source #

The Amazon resource name (ARN) for a customer managed customer master key (CMK) in Key Management Service (KMS). The KeyManagementServiceArn must be unique for each key-signing key (KSK) in a single hosted zone. To see an example of KeyManagementServiceArn that grants the correct permissions for DNSSEC, scroll down to Example.

You must configure the customer managed CMK as follows:

Status
Enabled
Key spec
ECC_NIST_P256
Key usage
Sign and verify
Key policy
The key policy must give permission for the following actions:
  • DescribeKey
  • GetPublicKey
  • Sign

The key policy must also include the Amazon Route 53 service in the principal for your account. Specify the following:

  • "Service": "dnssec-route53.amazonaws.com"

For more information about working with a customer managed CMK in KMS, see Key Management Service concepts.

createKeySigningKey_name :: Lens' CreateKeySigningKey Text Source #

A string used to identify a key-signing key (KSK). Name can include numbers, letters, and underscores (_). Name must be unique for each key-signing key in the same hosted zone.

createKeySigningKey_status :: Lens' CreateKeySigningKey Text Source #

A string specifying the initial status of the key-signing key (KSK). You can set the value to ACTIVE or INACTIVE.

createKeySigningKeyResponse_location :: Lens' CreateKeySigningKeyResponse Text Source #

The unique URL representing the new key-signing key (KSK).

GetCheckerIpRanges

getCheckerIpRangesResponse_checkerIpRanges :: Lens' GetCheckerIpRangesResponse [Text] Source #

A complex type that contains sorted list of IP ranges in CIDR format for Amazon Route 53 health checkers.

GetTrafficPolicyInstance

getTrafficPolicyInstance_id :: Lens' GetTrafficPolicyInstance Text Source #

The ID of the traffic policy instance that you want to get information about.

GetHealthCheckLastFailureReason

getHealthCheckLastFailureReason_healthCheckId :: Lens' GetHealthCheckLastFailureReason Text Source #

The ID for the health check for which you want the last failure reason. When you created the health check, CreateHealthCheck returned the ID in the response, in the HealthCheckId element.

If you want to get the last failure reason for a calculated health check, you must use the Amazon Route 53 console or the CloudWatch console. You can't use GetHealthCheckLastFailureReason for a calculated health check.

getHealthCheckLastFailureReasonResponse_healthCheckObservations :: Lens' GetHealthCheckLastFailureReasonResponse [HealthCheckObservation] Source #

A list that contains one Observation element for each Amazon Route 53 health checker that is reporting a last failure reason.

DeleteReusableDelegationSet

deleteReusableDelegationSet_id :: Lens' DeleteReusableDelegationSet ResourceId Source #

The ID of the reusable delegation set that you want to delete.

ListHostedZonesByName

listHostedZonesByName_hostedZoneId :: Lens' ListHostedZonesByName (Maybe ResourceId) Source #

(Optional) For your first request to ListHostedZonesByName, do not include the hostedzoneid parameter.

If you have more hosted zones than the value of maxitems, ListHostedZonesByName returns only the first maxitems hosted zones. To get the next group of maxitems hosted zones, submit another request to ListHostedZonesByName and include both dnsname and hostedzoneid parameters. For the value of hostedzoneid, specify the value of the NextHostedZoneId element from the previous response.

listHostedZonesByName_maxItems :: Lens' ListHostedZonesByName (Maybe Text) Source #

The maximum number of hosted zones to be included in the response body for this request. If you have more than maxitems hosted zones, then the value of the IsTruncated element in the response is true, and the values of NextDNSName and NextHostedZoneId specify the first hosted zone in the next group of maxitems hosted zones.

listHostedZonesByName_dNSName :: Lens' ListHostedZonesByName (Maybe Text) Source #

(Optional) For your first request to ListHostedZonesByName, include the dnsname parameter only if you want to specify the name of the first hosted zone in the response. If you don't include the dnsname parameter, Amazon Route 53 returns all of the hosted zones that were created by the current Amazon Web Services account, in ASCII order. For subsequent requests, include both dnsname and hostedzoneid parameters. For dnsname, specify the value of NextDNSName from the previous response.

listHostedZonesByNameResponse_hostedZoneId :: Lens' ListHostedZonesByNameResponse (Maybe ResourceId) Source #

The ID that Amazon Route 53 assigned to the hosted zone when you created it.

listHostedZonesByNameResponse_nextHostedZoneId :: Lens' ListHostedZonesByNameResponse (Maybe ResourceId) Source #

If IsTruncated is true, the value of NextHostedZoneId identifies the first hosted zone in the next group of maxitems hosted zones. Call ListHostedZonesByName again and specify the value of NextDNSName and NextHostedZoneId in the dnsname and hostedzoneid parameters, respectively.

This element is present only if IsTruncated is true.

listHostedZonesByNameResponse_dNSName :: Lens' ListHostedZonesByNameResponse (Maybe Text) Source #

For the second and subsequent calls to ListHostedZonesByName, DNSName is the value that you specified for the dnsname parameter in the request that produced the current response.

listHostedZonesByNameResponse_nextDNSName :: Lens' ListHostedZonesByNameResponse (Maybe Text) Source #

If IsTruncated is true, the value of NextDNSName is the name of the first hosted zone in the next group of maxitems hosted zones. Call ListHostedZonesByName again and specify the value of NextDNSName and NextHostedZoneId in the dnsname and hostedzoneid parameters, respectively.

This element is present only if IsTruncated is true.

listHostedZonesByNameResponse_hostedZones :: Lens' ListHostedZonesByNameResponse [HostedZone] Source #

A complex type that contains general information about the hosted zone.

listHostedZonesByNameResponse_isTruncated :: Lens' ListHostedZonesByNameResponse Bool Source #

A flag that indicates whether there are more hosted zones to be listed. If the response was truncated, you can get the next group of maxitems hosted zones by calling ListHostedZonesByName again and specifying the values of NextDNSName and NextHostedZoneId elements in the dnsname and hostedzoneid parameters.

listHostedZonesByNameResponse_maxItems :: Lens' ListHostedZonesByNameResponse Text Source #

The value that you specified for the maxitems parameter in the call to ListHostedZonesByName that produced the current response.

ActivateKeySigningKey

activateKeySigningKey_hostedZoneId :: Lens' ActivateKeySigningKey ResourceId Source #

A unique string used to identify a hosted zone.

activateKeySigningKey_name :: Lens' ActivateKeySigningKey Text Source #

A string used to identify a key-signing key (KSK). Name can include numbers, letters, and underscores (_). Name must be unique for each key-signing key in the same hosted zone.

ListReusableDelegationSets

listReusableDelegationSets_marker :: Lens' ListReusableDelegationSets (Maybe Text) Source #

If the value of IsTruncated in the previous response was true, you have more reusable delegation sets. To get another group, submit another ListReusableDelegationSets request.

For the value of marker, specify the value of NextMarker from the previous response, which is the ID of the first reusable delegation set that Amazon Route 53 will return if you submit another request.

If the value of IsTruncated in the previous response was false, there are no more reusable delegation sets to get.

listReusableDelegationSets_maxItems :: Lens' ListReusableDelegationSets (Maybe Text) Source #

The number of reusable delegation sets that you want Amazon Route 53 to return in the response to this request. If you specify a value greater than 100, Route 53 returns only the first 100 reusable delegation sets.

listReusableDelegationSetsResponse_nextMarker :: Lens' ListReusableDelegationSetsResponse (Maybe Text) Source #

If IsTruncated is true, the value of NextMarker identifies the next reusable delegation set that Amazon Route 53 will return if you submit another ListReusableDelegationSets request and specify the value of NextMarker in the marker parameter.

listReusableDelegationSetsResponse_delegationSets :: Lens' ListReusableDelegationSetsResponse [DelegationSet] Source #

A complex type that contains one DelegationSet element for each reusable delegation set that was created by the current Amazon Web Services account.

listReusableDelegationSetsResponse_marker :: Lens' ListReusableDelegationSetsResponse Text Source #

For the second and subsequent calls to ListReusableDelegationSets, Marker is the value that you specified for the marker parameter in the request that produced the current response.

listReusableDelegationSetsResponse_isTruncated :: Lens' ListReusableDelegationSetsResponse Bool Source #

A flag that indicates whether there are more reusable delegation sets to be listed.

listReusableDelegationSetsResponse_maxItems :: Lens' ListReusableDelegationSetsResponse Text Source #

The value that you specified for the maxitems parameter in the call to ListReusableDelegationSets that produced the current response.

ListTagsForResource

listTagsForResource_resourceType :: Lens' ListTagsForResource TagResourceType Source #

The type of the resource.

  • The resource type for health checks is healthcheck.
  • The resource type for hosted zones is hostedzone.

listTagsForResource_resourceId :: Lens' ListTagsForResource Text Source #

The ID of the resource for which you want to retrieve tags.

listTagsForResourceResponse_resourceTagSet :: Lens' ListTagsForResourceResponse ResourceTagSet Source #

A ResourceTagSet containing tags associated with the specified resource.

ListQueryLoggingConfigs

listQueryLoggingConfigs_hostedZoneId :: Lens' ListQueryLoggingConfigs (Maybe ResourceId) Source #

(Optional) If you want to list the query logging configuration that is associated with a hosted zone, specify the ID in HostedZoneId.

If you don't specify a hosted zone ID, ListQueryLoggingConfigs returns all of the configurations that are associated with the current Amazon Web Services account.

listQueryLoggingConfigs_nextToken :: Lens' ListQueryLoggingConfigs (Maybe Text) Source #

(Optional) If the current Amazon Web Services account has more than MaxResults query logging configurations, use NextToken to get the second and subsequent pages of results.

For the first ListQueryLoggingConfigs request, omit this value.

For the second and subsequent requests, get the value of NextToken from the previous response and specify that value for NextToken in the request.

listQueryLoggingConfigs_maxResults :: Lens' ListQueryLoggingConfigs (Maybe Text) Source #

(Optional) The maximum number of query logging configurations that you want Amazon Route 53 to return in response to the current request. If the current Amazon Web Services account has more than MaxResults configurations, use the value of NextToken in the response to get the next page of results.

If you don't specify a value for MaxResults, Route 53 returns up to 100 configurations.

listQueryLoggingConfigsResponse_nextToken :: Lens' ListQueryLoggingConfigsResponse (Maybe Text) Source #

If a response includes the last of the query logging configurations that are associated with the current Amazon Web Services account, NextToken doesn't appear in the response.

If a response doesn't include the last of the configurations, you can get more configurations by submitting another ListQueryLoggingConfigs request. Get the value of NextToken that Amazon Route 53 returned in the previous response and include it in NextToken in the next request.

listQueryLoggingConfigsResponse_queryLoggingConfigs :: Lens' ListQueryLoggingConfigsResponse [QueryLoggingConfig] Source #

An array that contains one QueryLoggingConfig element for each configuration for DNS query logging that is associated with the current Amazon Web Services account.

ListTrafficPolicyInstances

listTrafficPolicyInstances_trafficPolicyInstanceTypeMarker :: Lens' ListTrafficPolicyInstances (Maybe RRType) Source #

If the value of IsTruncated in the previous response was true, you have more traffic policy instances. To get more traffic policy instances, submit another ListTrafficPolicyInstances request. For the value of trafficpolicyinstancetype, specify the value of TrafficPolicyInstanceTypeMarker from the previous response, which is the type of the first traffic policy instance in the next group of traffic policy instances.

If the value of IsTruncated in the previous response was false, there are no more traffic policy instances to get.

listTrafficPolicyInstances_maxItems :: Lens' ListTrafficPolicyInstances (Maybe Text) Source #

The maximum number of traffic policy instances that you want Amazon Route 53 to return in response to a ListTrafficPolicyInstances request. If you have more than MaxItems traffic policy instances, the value of the IsTruncated element in the response is true, and the values of HostedZoneIdMarker, TrafficPolicyInstanceNameMarker, and TrafficPolicyInstanceTypeMarker represent the first traffic policy instance in the next group of MaxItems traffic policy instances.

listTrafficPolicyInstances_hostedZoneIdMarker :: Lens' ListTrafficPolicyInstances (Maybe ResourceId) Source #

If the value of IsTruncated in the previous response was true, you have more traffic policy instances. To get more traffic policy instances, submit another ListTrafficPolicyInstances request. For the value of HostedZoneId, specify the value of HostedZoneIdMarker from the previous response, which is the hosted zone ID of the first traffic policy instance in the next group of traffic policy instances.

If the value of IsTruncated in the previous response was false, there are no more traffic policy instances to get.

listTrafficPolicyInstances_trafficPolicyInstanceNameMarker :: Lens' ListTrafficPolicyInstances (Maybe Text) Source #

If the value of IsTruncated in the previous response was true, you have more traffic policy instances. To get more traffic policy instances, submit another ListTrafficPolicyInstances request. For the value of trafficpolicyinstancename, specify the value of TrafficPolicyInstanceNameMarker from the previous response, which is the name of the first traffic policy instance in the next group of traffic policy instances.

If the value of IsTruncated in the previous response was false, there are no more traffic policy instances to get.

listTrafficPolicyInstancesResponse_trafficPolicyInstanceTypeMarker :: Lens' ListTrafficPolicyInstancesResponse (Maybe RRType) Source #

If IsTruncated is true, TrafficPolicyInstanceTypeMarker is the DNS type of the resource record sets that are associated with the first traffic policy instance that Amazon Route 53 will return if you submit another ListTrafficPolicyInstances request.

listTrafficPolicyInstancesResponse_hostedZoneIdMarker :: Lens' ListTrafficPolicyInstancesResponse (Maybe ResourceId) Source #

If IsTruncated is true, HostedZoneIdMarker is the ID of the hosted zone of the first traffic policy instance that Route 53 will return if you submit another ListTrafficPolicyInstances request.

listTrafficPolicyInstancesResponse_trafficPolicyInstanceNameMarker :: Lens' ListTrafficPolicyInstancesResponse (Maybe Text) Source #

If IsTruncated is true, TrafficPolicyInstanceNameMarker is the name of the first traffic policy instance that Route 53 will return if you submit another ListTrafficPolicyInstances request.

listTrafficPolicyInstancesResponse_trafficPolicyInstances :: Lens' ListTrafficPolicyInstancesResponse [TrafficPolicyInstance] Source #

A list that contains one TrafficPolicyInstance element for each traffic policy instance that matches the elements in the request.

listTrafficPolicyInstancesResponse_isTruncated :: Lens' ListTrafficPolicyInstancesResponse Bool Source #

A flag that indicates whether there are more traffic policy instances to be listed. If the response was truncated, you can get more traffic policy instances by calling ListTrafficPolicyInstances again and specifying the values of the HostedZoneIdMarker, TrafficPolicyInstanceNameMarker, and TrafficPolicyInstanceTypeMarker in the corresponding request parameters.

listTrafficPolicyInstancesResponse_maxItems :: Lens' ListTrafficPolicyInstancesResponse Text Source #

The value that you specified for the MaxItems parameter in the call to ListTrafficPolicyInstances that produced the current response.

CreateTrafficPolicyInstance

createTrafficPolicyInstance_hostedZoneId :: Lens' CreateTrafficPolicyInstance ResourceId Source #

The ID of the hosted zone that you want Amazon Route 53 to create resource record sets in by using the configuration in a traffic policy.

createTrafficPolicyInstance_name :: Lens' CreateTrafficPolicyInstance Text Source #

The domain name (such as example.com) or subdomain name (such as www.example.com) for which Amazon Route 53 responds to DNS queries by using the resource record sets that Route 53 creates for this traffic policy instance.

createTrafficPolicyInstance_ttl :: Lens' CreateTrafficPolicyInstance Natural Source #

(Optional) The TTL that you want Amazon Route 53 to assign to all of the resource record sets that it creates in the specified hosted zone.

createTrafficPolicyInstance_trafficPolicyId :: Lens' CreateTrafficPolicyInstance Text Source #

The ID of the traffic policy that you want to use to create resource record sets in the specified hosted zone.

createTrafficPolicyInstance_trafficPolicyVersion :: Lens' CreateTrafficPolicyInstance Natural Source #

The version of the traffic policy that you want to use to create resource record sets in the specified hosted zone.

createTrafficPolicyInstanceResponse_location :: Lens' CreateTrafficPolicyInstanceResponse Text Source #

A unique URL that represents a new traffic policy instance.

GetChange

getChange_id :: Lens' GetChange ResourceId Source #

The ID of the change batch request. The value that you specify here is the value that ChangeResourceRecordSets returned in the Id element when you submitted the request.

getChangeResponse_httpStatus :: Lens' GetChangeResponse Int Source #

The response's http status code.

getChangeResponse_changeInfo :: Lens' GetChangeResponse ChangeInfo Source #

A complex type that contains information about the specified change batch.

ChangeResourceRecordSets

changeResourceRecordSets_hostedZoneId :: Lens' ChangeResourceRecordSets ResourceId Source #

The ID of the hosted zone that contains the resource record sets that you want to change.

changeResourceRecordSets_changeBatch :: Lens' ChangeResourceRecordSets ChangeBatch Source #

A complex type that contains an optional comment and the Changes element.

changeResourceRecordSetsResponse_changeInfo :: Lens' ChangeResourceRecordSetsResponse ChangeInfo Source #

A complex type that contains information about changes made to your hosted zone.

This element contains an ID that you use when performing a GetChange action to get detailed information about the change.

DeleteHealthCheck

deleteHealthCheck_healthCheckId :: Lens' DeleteHealthCheck Text Source #

The ID of the health check that you want to delete.

UpdateHealthCheck

updateHealthCheck_failureThreshold :: Lens' UpdateHealthCheck (Maybe Natural) Source #

The number of consecutive health checks that an endpoint must pass or fail for Amazon Route 53 to change the current status of the endpoint from unhealthy to healthy or vice versa. For more information, see How Amazon Route 53 Determines Whether an Endpoint Is Healthy in the Amazon Route 53 Developer Guide.

If you don't specify a value for FailureThreshold, the default value is three health checks.

updateHealthCheck_iPAddress :: Lens' UpdateHealthCheck (Maybe Text) Source #

The IPv4 or IPv6 IP address for the endpoint that you want Amazon Route 53 to perform health checks on. If you don't specify a value for IPAddress, Route 53 sends a DNS request to resolve the domain name that you specify in FullyQualifiedDomainName at the interval that you specify in RequestInterval. Using an IP address that is returned by DNS, Route 53 then checks the health of the endpoint.

Use one of the following formats for the value of IPAddress:

  • IPv4 address: four values between 0 and 255, separated by periods (.), for example, 192.0.2.44.
  • IPv6 address: eight groups of four hexadecimal values, separated by colons (:), for example, 2001:0db8:85a3:0000:0000:abcd:0001:2345. You can also shorten IPv6 addresses as described in RFC 5952, for example, 2001:db8:85a3::abcd:1:2345.

If the endpoint is an EC2 instance, we recommend that you create an Elastic IP address, associate it with your EC2 instance, and specify the Elastic IP address for IPAddress. This ensures that the IP address of your instance never changes. For more information, see the applicable documentation:

If a health check already has a value for IPAddress, you can change the value. However, you can't update an existing health check to add or remove the value of IPAddress.

For more information, see FullyQualifiedDomainName.

Constraints: Route 53 can't check the health of endpoints for which the IP address is in local, private, non-routable, or multicast ranges. For more information about IP addresses for which you can't create health checks, see the following documents:

updateHealthCheck_enableSNI :: Lens' UpdateHealthCheck (Maybe Bool) Source #

Specify whether you want Amazon Route 53 to send the value of FullyQualifiedDomainName to the endpoint in the client_hello message during TLS negotiation. This allows the endpoint to respond to HTTPS health check requests with the applicable SSL/TLS certificate.

Some endpoints require that HTTPS requests include the host name in the client_hello message. If you don't enable SNI, the status of the health check will be SSL alert handshake_failure. A health check can also have that status for other reasons. If SNI is enabled and you're still getting the error, check the SSL/TLS configuration on your endpoint and confirm that your certificate is valid.

The SSL/TLS certificate on your endpoint includes a domain name in the Common Name field and possibly several more in the Subject Alternative Names field. One of the domain names in the certificate should match the value that you specify for FullyQualifiedDomainName. If the endpoint responds to the client_hello message with a certificate that does not include the domain name that you specified in FullyQualifiedDomainName, a health checker will retry the handshake. In the second attempt, the health checker will omit FullyQualifiedDomainName from the client_hello message.

updateHealthCheck_disabled :: Lens' UpdateHealthCheck (Maybe Bool) Source #

Stops Route 53 from performing health checks. When you disable a health check, here's what happens:

  • Health checks that check the health of endpoints: Route 53 stops submitting requests to your application, server, or other resource.
  • Calculated health checks: Route 53 stops aggregating the status of the referenced health checks.
  • Health checks that monitor CloudWatch alarms: Route 53 stops monitoring the corresponding CloudWatch metrics.

After you disable a health check, Route 53 considers the status of the health check to always be healthy. If you configured DNS failover, Route 53 continues to route traffic to the corresponding resources. If you want to stop routing traffic to a resource, change the value of Inverted.

Charges for a health check still apply when the health check is disabled. For more information, see Amazon Route 53 Pricing.

updateHealthCheck_resetElements :: Lens' UpdateHealthCheck (Maybe [ResettableElementName]) Source #

A complex type that contains one ResettableElementName element for each element that you want to reset to the default value. Valid values for ResettableElementName include the following:

updateHealthCheck_searchString :: Lens' UpdateHealthCheck (Maybe Text) Source #

If the value of Type is HTTP_STR_MATCH or HTTPS_STR_MATCH, the string that you want Amazon Route 53 to search for in the response body from the specified resource. If the string appears in the response body, Route 53 considers the resource healthy. (You can't change the value of Type when you update a health check.)

updateHealthCheck_healthThreshold :: Lens' UpdateHealthCheck (Maybe Natural) Source #

The number of child health checks that are associated with a CALCULATED health that Amazon Route 53 must consider healthy for the CALCULATED health check to be considered healthy. To specify the child health checks that you want to associate with a CALCULATED health check, use the ChildHealthChecks and ChildHealthCheck elements.

Note the following:

  • If you specify a number greater than the number of child health checks, Route 53 always considers this health check to be unhealthy.
  • If you specify 0, Route 53 always considers this health check to be healthy.

updateHealthCheck_regions :: Lens' UpdateHealthCheck (Maybe (NonEmpty HealthCheckRegion)) Source #

A complex type that contains one Region element for each region that you want Amazon Route 53 health checkers to check the specified endpoint from.

updateHealthCheck_resourcePath :: Lens' UpdateHealthCheck (Maybe Text) Source #

The path that you want Amazon 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, for example the file /docs/route53-health-check.html. You can also include query string parameters, for example, /welcome.html?language=jp&login=y.

Specify this value only if you want to change it.

updateHealthCheck_insufficientDataHealthStatus :: Lens' UpdateHealthCheck (Maybe InsufficientDataHealthStatus) Source #

When CloudWatch has insufficient data about the metric to determine the alarm state, the status that you want Amazon Route 53 to assign to the health check:

  • Healthy: Route 53 considers the health check to be healthy.
  • Unhealthy: Route 53 considers the health check to be unhealthy.
  • LastKnownStatus: Route 53 uses the status of the health check from the last time CloudWatch had sufficient data to determine the alarm state. For new health checks that have no last known status, the default status for the health check is healthy.

updateHealthCheck_healthCheckVersion :: Lens' UpdateHealthCheck (Maybe Natural) Source #

A sequential counter that Amazon Route 53 sets to 1 when you create a health check and increments by 1 each time you update settings for the health check.

We recommend that you use GetHealthCheck or ListHealthChecks to get the current value of HealthCheckVersion for the health check that you want to update, and that you include that value in your UpdateHealthCheck request. This prevents Route 53 from overwriting an intervening update:

  • If the value in the UpdateHealthCheck request matches the value of HealthCheckVersion in the health check, Route 53 updates the health check with the new settings.
  • If the value of HealthCheckVersion in the health check is greater, the health check was changed after you got the version number. Route 53 does not update the health check, and it returns a HealthCheckVersionMismatch error.

updateHealthCheck_alarmIdentifier :: Lens' UpdateHealthCheck (Maybe AlarmIdentifier) Source #

A complex type that identifies the CloudWatch alarm that you want Amazon Route 53 health checkers to use to determine whether the specified health check is healthy.

updateHealthCheck_inverted :: Lens' UpdateHealthCheck (Maybe Bool) Source #

Specify whether you want Amazon Route 53 to invert the status of a health check, for example, to consider a health check unhealthy when it otherwise would be considered healthy.

updateHealthCheck_fullyQualifiedDomainName :: Lens' UpdateHealthCheck (Maybe Text) Source #

Amazon Route 53 behavior depends on whether you specify a value for IPAddress.

If a health check already has a value for IPAddress, you can change the value. However, you can't update an existing health check to add or remove the value of IPAddress.

If you specify a value for IPAddress:

Route 53 sends health check requests to the specified IPv4 or IPv6 address and passes the value of FullyQualifiedDomainName in the Host header for all health checks except TCP health checks. This is typically the fully qualified DNS name of the endpoint on which you want Route 53 to perform health checks.

When Route 53 checks the health of an endpoint, here is how it constructs the Host header:

  • If you specify a value of 80 for Port and HTTP or HTTP_STR_MATCH for Type, Route 53 passes the value of FullyQualifiedDomainName to the endpoint in the Host header.
  • If you specify a value of 443 for Port and HTTPS or HTTPS_STR_MATCH for Type, Route 53 passes the value of FullyQualifiedDomainName to the endpoint in the Host header.
  • If you specify another value for Port and any value except TCP for Type, Route 53 passes FullyQualifiedDomainName:Port to the endpoint in the Host header.

If you don't specify a value for FullyQualifiedDomainName, Route 53 substitutes the value of IPAddress in the Host header in each of the above cases.

If you don't specify a value for IPAddress:

If you don't specify a value for IPAddress, Route 53 sends a DNS request to the domain that you specify in FullyQualifiedDomainName at the interval you specify in RequestInterval. Using an IPv4 address that is returned by DNS, Route 53 then checks the health of the endpoint.

If you don't specify a value for IPAddress, Route 53 uses only IPv4 to send health checks to the endpoint. If there's no resource record set with a type of A for the name that you specify for FullyQualifiedDomainName, the health check fails with a "DNS resolution failed" error.

If you want to check the health of weighted, latency, or failover resource record sets and you choose to specify the endpoint only by FullyQualifiedDomainName, we recommend that you create a separate health check for each endpoint. For example, create a health check for each HTTP server that is serving content for www.example.com. For the value of FullyQualifiedDomainName, specify the domain name of the server (such as us-east-2-www.example.com), not the name of the resource record sets (www.example.com).

In this configuration, if the value of FullyQualifiedDomainName matches the name of the resource record sets and you then associate the health check with those resource record sets, health check results will be unpredictable.

In addition, if the value of Type is HTTP, HTTPS, HTTP_STR_MATCH, or HTTPS_STR_MATCH, Route 53 passes the value of FullyQualifiedDomainName in the Host header, as it does when you specify a value for IPAddress. If the value of Type is TCP, Route 53 doesn't pass a Host header.

updateHealthCheck_childHealthChecks :: Lens' UpdateHealthCheck (Maybe [Text]) Source #

A complex type that contains one ChildHealthCheck element for each health check that you want to associate with a CALCULATED health check.

updateHealthCheck_port :: Lens' UpdateHealthCheck (Maybe Natural) Source #

The port on the endpoint that you want Amazon Route 53 to perform health checks on.

Don't specify a value for Port when you specify a value for Type of CLOUDWATCH_METRIC or CALCULATED.

updateHealthCheck_healthCheckId :: Lens' UpdateHealthCheck Text Source #

The ID for the health check for which you want detailed information. When you created the health check, CreateHealthCheck returned the ID in the response, in the HealthCheckId element.

updateHealthCheckResponse_healthCheck :: Lens' UpdateHealthCheckResponse HealthCheck Source #

A complex type that contains the response to an UpdateHealthCheck request.

CreateHostedZone

createHostedZone_delegationSetId :: Lens' CreateHostedZone (Maybe ResourceId) Source #

If you want to associate a reusable delegation set with this hosted zone, the ID that Amazon Route 53 assigned to the reusable delegation set when you created it. For more information about reusable delegation sets, see CreateReusableDelegationSet.

createHostedZone_vpc :: Lens' CreateHostedZone (Maybe VPC) Source #

(Private hosted zones only) A complex type that contains information about the Amazon VPC that you're associating with this hosted zone.

You can specify only one Amazon VPC when you create a private hosted zone. To associate additional Amazon VPCs with the hosted zone, use AssociateVPCWithHostedZone after you create a hosted zone.

createHostedZone_hostedZoneConfig :: Lens' CreateHostedZone (Maybe HostedZoneConfig) Source #

(Optional) A complex type that contains the following optional values:

  • For public and private hosted zones, an optional comment
  • For private hosted zones, an optional PrivateZone element

If you don't specify a comment or the PrivateZone element, omit HostedZoneConfig and the other elements.

createHostedZone_name :: Lens' CreateHostedZone Text Source #

The name of the domain. Specify a fully qualified domain name, for example, www.example.com. The trailing dot is optional; Amazon Route 53 assumes that the domain name is fully qualified. This means that Route 53 treats www.example.com (without a trailing dot) and www.example.com. (with a trailing dot) as identical.

If you're creating a public hosted zone, this is the name you have registered with your DNS registrar. If your domain name is registered with a registrar other than Route 53, change the name servers for your domain to the set of NameServers that CreateHostedZone returns in DelegationSet.

createHostedZone_callerReference :: Lens' CreateHostedZone Text Source #

A unique string that identifies the request and that allows failed CreateHostedZone requests to be retried without the risk of executing the operation twice. You must use a unique CallerReference string every time you submit a CreateHostedZone request. CallerReference can be any unique string, for example, a date/time stamp.

createHostedZoneResponse_vpc :: Lens' CreateHostedZoneResponse (Maybe VPC) Source #

A complex type that contains information about an Amazon VPC that you associated with this hosted zone.

createHostedZoneResponse_hostedZone :: Lens' CreateHostedZoneResponse HostedZone Source #

A complex type that contains general information about the hosted zone.

createHostedZoneResponse_changeInfo :: Lens' CreateHostedZoneResponse ChangeInfo Source #

A complex type that contains information about the CreateHostedZone request.

createHostedZoneResponse_delegationSet :: Lens' CreateHostedZoneResponse DelegationSet Source #

A complex type that describes the name servers for this hosted zone.

createHostedZoneResponse_location :: Lens' CreateHostedZoneResponse Text Source #

The unique URL representing the new hosted zone.

CreateVPCAssociationAuthorization

createVPCAssociationAuthorization_hostedZoneId :: Lens' CreateVPCAssociationAuthorization ResourceId Source #

The ID of the private hosted zone that you want to authorize associating a VPC with.

createVPCAssociationAuthorization_vpc :: Lens' CreateVPCAssociationAuthorization VPC Source #

A complex type that contains the VPC ID and region for the VPC that you want to authorize associating with your hosted zone.

ListVPCAssociationAuthorizations

listVPCAssociationAuthorizations_nextToken :: Lens' ListVPCAssociationAuthorizations (Maybe Text) Source #

Optional: If a response includes a NextToken element, there are more VPCs that can be associated with the specified hosted zone. To get the next page of results, submit another request, and include the value of NextToken from the response in the nexttoken parameter in another ListVPCAssociationAuthorizations request.

listVPCAssociationAuthorizations_maxResults :: Lens' ListVPCAssociationAuthorizations (Maybe Text) Source #

Optional: An integer that specifies the maximum number of VPCs that you want Amazon Route 53 to return. If you don't specify a value for MaxResults, Route 53 returns up to 50 VPCs per page.

listVPCAssociationAuthorizations_hostedZoneId :: Lens' ListVPCAssociationAuthorizations ResourceId Source #

The ID of the hosted zone for which you want a list of VPCs that can be associated with the hosted zone.

listVPCAssociationAuthorizationsResponse_nextToken :: Lens' ListVPCAssociationAuthorizationsResponse (Maybe Text) Source #

When the response includes a NextToken element, there are more VPCs that can be associated with the specified hosted zone. To get the next page of VPCs, submit another ListVPCAssociationAuthorizations request, and include the value of the NextToken element from the response in the nexttoken request parameter.

listVPCAssociationAuthorizationsResponse_hostedZoneId :: Lens' ListVPCAssociationAuthorizationsResponse ResourceId Source #

The ID of the hosted zone that you can associate the listed VPCs with.

listVPCAssociationAuthorizationsResponse_vPCs :: Lens' ListVPCAssociationAuthorizationsResponse (NonEmpty VPC) Source #

The list of VPCs that are authorized to be associated with the specified hosted zone.

ListTrafficPolicyInstancesByPolicy

listTrafficPolicyInstancesByPolicy_trafficPolicyInstanceTypeMarker :: Lens' ListTrafficPolicyInstancesByPolicy (Maybe RRType) Source #

If the value of IsTruncated in the previous response was true, you have more traffic policy instances. To get more traffic policy instances, submit another ListTrafficPolicyInstancesByPolicy request.

For the value of trafficpolicyinstancetype, specify the value of TrafficPolicyInstanceTypeMarker from the previous response, which is the name of the first traffic policy instance that Amazon Route 53 will return if you submit another request.

If the value of IsTruncated in the previous response was false, there are no more traffic policy instances to get.

listTrafficPolicyInstancesByPolicy_maxItems :: Lens' ListTrafficPolicyInstancesByPolicy (Maybe Text) Source #

The maximum number of traffic policy instances to be included in the response body for this request. If you have more than MaxItems traffic policy instances, the value of the IsTruncated element in the response is true, and the values of HostedZoneIdMarker, TrafficPolicyInstanceNameMarker, and TrafficPolicyInstanceTypeMarker represent the first traffic policy instance that Amazon Route 53 will return if you submit another request.

listTrafficPolicyInstancesByPolicy_hostedZoneIdMarker :: Lens' ListTrafficPolicyInstancesByPolicy (Maybe ResourceId) Source #

If the value of IsTruncated in the previous response was true, you have more traffic policy instances. To get more traffic policy instances, submit another ListTrafficPolicyInstancesByPolicy request.

For the value of hostedzoneid, specify the value of HostedZoneIdMarker from the previous response, which is the hosted zone ID of the first traffic policy instance that Amazon Route 53 will return if you submit another request.

If the value of IsTruncated in the previous response was false, there are no more traffic policy instances to get.

listTrafficPolicyInstancesByPolicy_trafficPolicyInstanceNameMarker :: Lens' ListTrafficPolicyInstancesByPolicy (Maybe Text) Source #

If the value of IsTruncated in the previous response was true, you have more traffic policy instances. To get more traffic policy instances, submit another ListTrafficPolicyInstancesByPolicy request.

For the value of trafficpolicyinstancename, specify the value of TrafficPolicyInstanceNameMarker from the previous response, which is the name of the first traffic policy instance that Amazon Route 53 will return if you submit another request.

If the value of IsTruncated in the previous response was false, there are no more traffic policy instances to get.

listTrafficPolicyInstancesByPolicy_trafficPolicyId :: Lens' ListTrafficPolicyInstancesByPolicy Text Source #

The ID of the traffic policy for which you want to list traffic policy instances.

listTrafficPolicyInstancesByPolicy_trafficPolicyVersion :: Lens' ListTrafficPolicyInstancesByPolicy Natural Source #

The version of the traffic policy for which you want to list traffic policy instances. The version must be associated with the traffic policy that is specified by TrafficPolicyId.

listTrafficPolicyInstancesByPolicyResponse_trafficPolicyInstanceTypeMarker :: Lens' ListTrafficPolicyInstancesByPolicyResponse (Maybe RRType) Source #

If IsTruncated is true, TrafficPolicyInstanceTypeMarker is the DNS type of the resource record sets that are associated with the first traffic policy instance in the next group of MaxItems traffic policy instances.

listTrafficPolicyInstancesByPolicyResponse_hostedZoneIdMarker :: Lens' ListTrafficPolicyInstancesByPolicyResponse (Maybe ResourceId) Source #

If IsTruncated is true, HostedZoneIdMarker is the ID of the hosted zone of the first traffic policy instance in the next group of traffic policy instances.

listTrafficPolicyInstancesByPolicyResponse_trafficPolicyInstanceNameMarker :: Lens' ListTrafficPolicyInstancesByPolicyResponse (Maybe Text) Source #

If IsTruncated is true, TrafficPolicyInstanceNameMarker is the name of the first traffic policy instance in the next group of MaxItems traffic policy instances.

listTrafficPolicyInstancesByPolicyResponse_trafficPolicyInstances :: Lens' ListTrafficPolicyInstancesByPolicyResponse [TrafficPolicyInstance] Source #

A list that contains one TrafficPolicyInstance element for each traffic policy instance that matches the elements in the request.

listTrafficPolicyInstancesByPolicyResponse_isTruncated :: Lens' ListTrafficPolicyInstancesByPolicyResponse Bool Source #

A flag that indicates whether there are more traffic policy instances to be listed. If the response was truncated, you can get the next group of traffic policy instances by calling ListTrafficPolicyInstancesByPolicy again and specifying the values of the HostedZoneIdMarker, TrafficPolicyInstanceNameMarker, and TrafficPolicyInstanceTypeMarker elements in the corresponding request parameters.

listTrafficPolicyInstancesByPolicyResponse_maxItems :: Lens' ListTrafficPolicyInstancesByPolicyResponse Text Source #

The value that you specified for the MaxItems parameter in the call to ListTrafficPolicyInstancesByPolicy that produced the current response.

DisassociateVPCFromHostedZone

disassociateVPCFromHostedZone_comment :: Lens' DisassociateVPCFromHostedZone (Maybe Text) Source #

Optional: A comment about the disassociation request.

disassociateVPCFromHostedZone_hostedZoneId :: Lens' DisassociateVPCFromHostedZone ResourceId Source #

The ID of the private hosted zone that you want to disassociate a VPC from.

disassociateVPCFromHostedZone_vpc :: Lens' DisassociateVPCFromHostedZone VPC Source #

A complex type that contains information about the VPC that you're disassociating from the specified hosted zone.

disassociateVPCFromHostedZoneResponse_changeInfo :: Lens' DisassociateVPCFromHostedZoneResponse ChangeInfo Source #

A complex type that describes the changes made to the specified private hosted zone.

CreateHealthCheck

createHealthCheck_callerReference :: Lens' CreateHealthCheck Text Source #

A unique string that identifies the request and that allows you to retry a failed CreateHealthCheck request without the risk of creating two identical health checks:

  • If you send a CreateHealthCheck request with the same CallerReference and settings as a previous request, and if the health check doesn't exist, Amazon Route 53 creates the health check. If the health check does exist, Route 53 returns the settings for the existing health check.
  • If you send a CreateHealthCheck request with the same CallerReference as a deleted health check, regardless of the settings, Route 53 returns a HealthCheckAlreadyExists error.
  • If you send a CreateHealthCheck request with the same CallerReference as an existing health check but with different settings, Route 53 returns a HealthCheckAlreadyExists error.
  • If you send a CreateHealthCheck request with a unique CallerReference but settings identical to an existing health check, Route 53 creates the health check.

createHealthCheck_healthCheckConfig :: Lens' CreateHealthCheck HealthCheckConfig Source #

A complex type that contains settings for a new health check.

createHealthCheckResponse_healthCheck :: Lens' CreateHealthCheckResponse HealthCheck Source #

A complex type that contains identifying information about the health check.

createHealthCheckResponse_location :: Lens' CreateHealthCheckResponse Text Source #

The unique URL representing the new health check.

DeleteVPCAssociationAuthorization

deleteVPCAssociationAuthorization_hostedZoneId :: Lens' DeleteVPCAssociationAuthorization ResourceId Source #

When removing authorization to associate a VPC that was created by one Amazon Web Services account with a hosted zone that was created with a different Amazon Web Services account, the ID of the hosted zone.

deleteVPCAssociationAuthorization_vpc :: Lens' DeleteVPCAssociationAuthorization VPC Source #

When removing authorization to associate a VPC that was created by one Amazon Web Services account with a hosted zone that was created with a different Amazon Web Services account, a complex type that includes the ID and region of the VPC.

ChangeTagsForResource

changeTagsForResource_removeTagKeys :: Lens' ChangeTagsForResource (Maybe (NonEmpty Text)) Source #

A complex type that contains a list of the tags that you want to delete from the specified health check or hosted zone. You can specify up to 10 keys.

changeTagsForResource_addTags :: Lens' ChangeTagsForResource (Maybe (NonEmpty Tag)) Source #

A complex type that contains a list of the tags that you want to add to the specified health check or hosted zone and/or the tags that you want to edit Value for.

You can add a maximum of 10 tags to a health check or a hosted zone.

changeTagsForResource_resourceType :: Lens' ChangeTagsForResource TagResourceType Source #

The type of the resource.

  • The resource type for health checks is healthcheck.
  • The resource type for hosted zones is hostedzone.

changeTagsForResource_resourceId :: Lens' ChangeTagsForResource Text Source #

The ID of the resource for which you want to add, change, or delete tags.

ListHostedZones

listHostedZones_delegationSetId :: Lens' ListHostedZones (Maybe ResourceId) Source #

If you're using reusable delegation sets and you want to list all of the hosted zones that are associated with a reusable delegation set, specify the ID of that reusable delegation set.

listHostedZones_marker :: Lens' ListHostedZones (Maybe Text) Source #

If the value of IsTruncated in the previous response was true, you have more hosted zones. To get more hosted zones, submit another ListHostedZones request.

For the value of marker, specify the value of NextMarker from the previous response, which is the ID of the first hosted zone that Amazon Route 53 will return if you submit another request.

If the value of IsTruncated in the previous response was false, there are no more hosted zones to get.

listHostedZones_maxItems :: Lens' ListHostedZones (Maybe Text) Source #

(Optional) The maximum number of hosted zones that you want Amazon Route 53 to return. If you have more than maxitems hosted zones, the value of IsTruncated in the response is true, and the value of NextMarker is the hosted zone ID of the first hosted zone that Route 53 will return if you submit another request.

listHostedZonesResponse_marker :: Lens' ListHostedZonesResponse (Maybe Text) Source #

For the second and subsequent calls to ListHostedZones, Marker is the value that you specified for the marker parameter in the request that produced the current response.

listHostedZonesResponse_nextMarker :: Lens' ListHostedZonesResponse (Maybe Text) Source #

If IsTruncated is true, the value of NextMarker identifies the first hosted zone in the next group of hosted zones. Submit another ListHostedZones request, and specify the value of NextMarker from the response in the marker parameter.

This element is present only if IsTruncated is true.

listHostedZonesResponse_hostedZones :: Lens' ListHostedZonesResponse [HostedZone] Source #

A complex type that contains general information about the hosted zone.

listHostedZonesResponse_isTruncated :: Lens' ListHostedZonesResponse Bool Source #

A flag indicating whether there are more hosted zones to be listed. If the response was truncated, you can get more hosted zones by submitting another ListHostedZones request and specifying the value of NextMarker in the marker parameter.

listHostedZonesResponse_maxItems :: Lens' ListHostedZonesResponse Text Source #

The value that you specified for the maxitems parameter in the call to ListHostedZones that produced the current response.

GetTrafficPolicyInstanceCount

getTrafficPolicyInstanceCountResponse_trafficPolicyInstanceCount :: Lens' GetTrafficPolicyInstanceCountResponse Int Source #

The number of traffic policy instances that are associated with the current Amazon Web Services account.

ListGeoLocations

listGeoLocations_startSubdivisionCode :: Lens' ListGeoLocations (Maybe Text) Source #

The code for the state of the United States with which you want to start listing locations that Amazon Route 53 supports for geolocation. If Route 53 has already returned a page or more of results, if IsTruncated is true, and if NextSubdivisionCode from the previous response has a value, enter that value in startsubdivisioncode to return the next page of results.

To list subdivisions (U.S. states), you must include both startcountrycode and startsubdivisioncode.

listGeoLocations_maxItems :: Lens' ListGeoLocations (Maybe Text) Source #

(Optional) The maximum number of geolocations to be included in the response body for this request. If more than maxitems geolocations remain to be listed, then the value of the IsTruncated element in the response is true.

listGeoLocations_startCountryCode :: Lens' ListGeoLocations (Maybe Text) Source #

The code for the country with which you want to start listing locations that Amazon Route 53 supports for geolocation. If Route 53 has already returned a page or more of results, if IsTruncated is true, and if NextCountryCode from the previous response has a value, enter that value in startcountrycode to return the next page of results.

listGeoLocations_startContinentCode :: Lens' ListGeoLocations (Maybe Text) Source #

The code for the continent with which you want to start listing locations that Amazon Route 53 supports for geolocation. If Route 53 has already returned a page or more of results, if IsTruncated is true, and if NextContinentCode from the previous response has a value, enter that value in startcontinentcode to return the next page of results.

Include startcontinentcode only if you want to list continents. Don't include startcontinentcode when you're listing countries or countries with their subdivisions.

listGeoLocationsResponse_nextContinentCode :: Lens' ListGeoLocationsResponse (Maybe Text) Source #

If IsTruncated is true, you can make a follow-up request to display more locations. Enter the value of NextContinentCode in the startcontinentcode parameter in another ListGeoLocations request.

listGeoLocationsResponse_nextCountryCode :: Lens' ListGeoLocationsResponse (Maybe Text) Source #

If IsTruncated is true, you can make a follow-up request to display more locations. Enter the value of NextCountryCode in the startcountrycode parameter in another ListGeoLocations request.

listGeoLocationsResponse_nextSubdivisionCode :: Lens' ListGeoLocationsResponse (Maybe Text) Source #

If IsTruncated is true, you can make a follow-up request to display more locations. Enter the value of NextSubdivisionCode in the startsubdivisioncode parameter in another ListGeoLocations request.

listGeoLocationsResponse_geoLocationDetailsList :: Lens' ListGeoLocationsResponse [GeoLocationDetails] Source #

A complex type that contains one GeoLocationDetails element for each location that Amazon Route 53 supports for geolocation.

listGeoLocationsResponse_isTruncated :: Lens' ListGeoLocationsResponse Bool Source #

A value that indicates whether more locations remain to be listed after the last location in this response. If so, the value of IsTruncated is true. To get more values, submit another request and include the values of NextContinentCode, NextCountryCode, and NextSubdivisionCode in the startcontinentcode, startcountrycode, and startsubdivisioncode, as applicable.

listGeoLocationsResponse_maxItems :: Lens' ListGeoLocationsResponse Text Source #

The value that you specified for MaxItems in the request.

GetHostedZone

getHostedZone_id :: Lens' GetHostedZone ResourceId Source #

The ID of the hosted zone that you want to get information about.

getHostedZoneResponse_vPCs :: Lens' GetHostedZoneResponse (Maybe (NonEmpty VPC)) Source #

A complex type that contains information about the VPCs that are associated with the specified hosted zone.

getHostedZoneResponse_delegationSet :: Lens' GetHostedZoneResponse (Maybe DelegationSet) Source #

A complex type that lists the Amazon Route 53 name servers for the specified hosted zone.

getHostedZoneResponse_hostedZone :: Lens' GetHostedZoneResponse HostedZone Source #

A complex type that contains general information about the specified hosted zone.

GetHealthCheck

getHealthCheck_healthCheckId :: Lens' GetHealthCheck Text Source #

The identifier that Amazon Route 53 assigned to the health check when you created it. When you add or update a resource record set, you use this value to specify which health check to use. The value can be up to 64 characters long.

getHealthCheckResponse_healthCheck :: Lens' GetHealthCheckResponse HealthCheck Source #

A complex type that contains information about one health check that is associated with the current Amazon Web Services account.

ListResourceRecordSets

listResourceRecordSets_startRecordName :: Lens' ListResourceRecordSets (Maybe Text) Source #

The first name in the lexicographic ordering of resource record sets that you want to list. If the specified record name doesn't exist, the results begin with the first resource record set that has a name greater than the value of name.

listResourceRecordSets_startRecordType :: Lens' ListResourceRecordSets (Maybe RRType) Source #

The type of resource record set to begin the record listing from.

Valid values for basic resource record sets: A | AAAA | CAA | CNAME | MX | NAPTR | NS | PTR | SOA | SPF | SRV | TXT

Values for weighted, latency, geolocation, and failover resource record sets: A | AAAA | CAA | CNAME | MX | NAPTR | PTR | SPF | SRV | TXT

Values for alias resource record sets:

  • API Gateway custom regional API or edge-optimized API: A
  • CloudFront distribution: A or AAAA
  • Elastic Beanstalk environment that has a regionalized subdomain: A
  • Elastic Load Balancing load balancer: A | AAAA
  • S3 bucket: A
  • VPC interface VPC endpoint: A
  • Another resource record set in this hosted zone: The type of the resource record set that the alias references.

Constraint: Specifying type without specifying name returns an InvalidInput error.

listResourceRecordSets_startRecordIdentifier :: Lens' ListResourceRecordSets (Maybe Text) Source #

Resource record sets that have a routing policy other than simple: If results were truncated for a given DNS name and type, specify the value of NextRecordIdentifier from the previous response to get the next resource record set that has the current DNS name and type.

listResourceRecordSets_maxItems :: Lens' ListResourceRecordSets (Maybe Text) Source #

(Optional) The maximum number of resource records sets to include in the response body for this request. If the response includes more than maxitems resource record sets, the value of the IsTruncated element in the response is true, and the values of the NextRecordName and NextRecordType elements in the response identify the first resource record set in the next group of maxitems resource record sets.

listResourceRecordSets_hostedZoneId :: Lens' ListResourceRecordSets ResourceId Source #

The ID of the hosted zone that contains the resource record sets that you want to list.

listResourceRecordSetsResponse_nextRecordType :: Lens' ListResourceRecordSetsResponse (Maybe RRType) Source #

If the results were truncated, the type of the next record in the list.

This element is present only if IsTruncated is true.

listResourceRecordSetsResponse_nextRecordName :: Lens' ListResourceRecordSetsResponse (Maybe Text) Source #

If the results were truncated, the name of the next record in the list.

This element is present only if IsTruncated is true.

listResourceRecordSetsResponse_nextRecordIdentifier :: Lens' ListResourceRecordSetsResponse (Maybe Text) Source #

Resource record sets that have a routing policy other than simple: If results were truncated for a given DNS name and type, the value of SetIdentifier for the next resource record set that has the current DNS name and type.

For information about routing policies, see Choosing a Routing Policy in the Amazon Route 53 Developer Guide.

listResourceRecordSetsResponse_isTruncated :: Lens' ListResourceRecordSetsResponse Bool Source #

A flag that indicates whether more resource record sets remain to be listed. If your results were truncated, you can make a follow-up pagination request by using the NextRecordName element.

CreateReusableDelegationSet

createReusableDelegationSet_hostedZoneId :: Lens' CreateReusableDelegationSet (Maybe ResourceId) Source #

If you want to mark the delegation set for an existing hosted zone as reusable, the ID for that hosted zone.

createReusableDelegationSet_callerReference :: Lens' CreateReusableDelegationSet Text Source #

A unique string that identifies the request, and that allows you to retry failed CreateReusableDelegationSet requests without the risk of executing the operation twice. You must use a unique CallerReference string every time you submit a CreateReusableDelegationSet request. CallerReference can be any unique string, for example a date/time stamp.

createReusableDelegationSetResponse_location :: Lens' CreateReusableDelegationSetResponse Text Source #

The unique URL representing the new reusable delegation set.

CreateQueryLoggingConfig

createQueryLoggingConfig_hostedZoneId :: Lens' CreateQueryLoggingConfig ResourceId Source #

The ID of the hosted zone that you want to log queries for. You can log queries only for public hosted zones.

createQueryLoggingConfig_cloudWatchLogsLogGroupArn :: Lens' CreateQueryLoggingConfig Text Source #

The Amazon Resource Name (ARN) for the log group that you want to Amazon Route 53 to send query logs to. This is the format of the ARN:

arn:aws:logs:region:account-id:log-group:log_group_name

To get the ARN for a log group, you can use the CloudWatch console, the DescribeLogGroups API action, the describe-log-groups command, or the applicable command in one of the Amazon Web Services SDKs.

createQueryLoggingConfigResponse_queryLoggingConfig :: Lens' CreateQueryLoggingConfigResponse QueryLoggingConfig Source #

A complex type that contains the ID for a query logging configuration, the ID of the hosted zone that you want to log queries for, and the ARN for the log group that you want Amazon Route 53 to send query logs to.

createQueryLoggingConfigResponse_location :: Lens' CreateQueryLoggingConfigResponse Text Source #

The unique URL representing the new query logging configuration.

GetHealthCheckCount

getHealthCheckCountResponse_healthCheckCount :: Lens' GetHealthCheckCountResponse Integer Source #

The number of health checks associated with the current Amazon Web Services account.

UpdateTrafficPolicyComment

updateTrafficPolicyComment_id :: Lens' UpdateTrafficPolicyComment Text Source #

The value of Id for the traffic policy that you want to update the comment for.

updateTrafficPolicyComment_version :: Lens' UpdateTrafficPolicyComment Natural Source #

The value of Version for the traffic policy that you want to update the comment for.

updateTrafficPolicyComment_comment :: Lens' UpdateTrafficPolicyComment Text Source #

The new comment for the specified traffic policy and version.

updateTrafficPolicyCommentResponse_trafficPolicy :: Lens' UpdateTrafficPolicyCommentResponse TrafficPolicy Source #

A complex type that contains settings for the specified traffic policy.

GetHostedZoneCount

getHostedZoneCountResponse_hostedZoneCount :: Lens' GetHostedZoneCountResponse Integer Source #

The total number of public and private hosted zones that are associated with the current Amazon Web Services account.

DeleteKeySigningKey

deleteKeySigningKey_hostedZoneId :: Lens' DeleteKeySigningKey ResourceId Source #

A unique string used to identify a hosted zone.

deleteKeySigningKey_name :: Lens' DeleteKeySigningKey Text Source #

A string used to identify a key-signing key (KSK).

GetDNSSEC

getDNSSEC_hostedZoneId :: Lens' GetDNSSEC ResourceId Source #

A unique string used to identify a hosted zone.

getDNSSECResponse_httpStatus :: Lens' GetDNSSECResponse Int Source #

The response's http status code.

getDNSSECResponse_status :: Lens' GetDNSSECResponse DNSSECStatus Source #

A string repesenting the status of DNSSEC.

getDNSSECResponse_keySigningKeys :: Lens' GetDNSSECResponse [KeySigningKey] Source #

The key-signing keys (KSKs) in your account.

GetAccountLimit

getAccountLimit_type :: Lens' GetAccountLimit AccountLimitType Source #

The limit that you want to get. Valid values include the following:

  • MAX_HEALTH_CHECKS_BY_OWNER: The maximum number of health checks that you can create using the current account.
  • MAX_HOSTED_ZONES_BY_OWNER: The maximum number of hosted zones that you can create using the current account.
  • MAX_REUSABLE_DELEGATION_SETS_BY_OWNER: The maximum number of reusable delegation sets that you can create using the current account.
  • MAX_TRAFFIC_POLICIES_BY_OWNER: The maximum number of traffic policies that you can create using the current account.
  • MAX_TRAFFIC_POLICY_INSTANCES_BY_OWNER: The maximum number of traffic policy instances that you can create using the current account. (Traffic policy instances are referred to as traffic flow policy records in the Amazon Route 53 console.)

getAccountLimitResponse_limit :: Lens' GetAccountLimitResponse AccountLimit Source #

The current setting for the specified limit. For example, if you specified MAX_HEALTH_CHECKS_BY_OWNER for the value of Type in the request, the value of Limit is the maximum number of health checks that you can create using the current account.

getAccountLimitResponse_count :: Lens' GetAccountLimitResponse Natural Source #

The current number of entities that you have created of the specified type. For example, if you specified MAX_HEALTH_CHECKS_BY_OWNER for the value of Type in the request, the value of Count is the current number of health checks that you have created using the current account.

EnableHostedZoneDNSSEC

enableHostedZoneDNSSEC_hostedZoneId :: Lens' EnableHostedZoneDNSSEC ResourceId Source #

A unique string used to identify a hosted zone.

DeleteQueryLoggingConfig

deleteQueryLoggingConfig_id :: Lens' DeleteQueryLoggingConfig Text Source #

The ID of the configuration that you want to delete.

GetQueryLoggingConfig

getQueryLoggingConfig_id :: Lens' GetQueryLoggingConfig Text Source #

The ID of the configuration for DNS query logging that you want to get information about.

getQueryLoggingConfigResponse_queryLoggingConfig :: Lens' GetQueryLoggingConfigResponse QueryLoggingConfig Source #

A complex type that contains information about the query logging configuration that you specified in a GetQueryLoggingConfig request.

GetReusableDelegationSet

getReusableDelegationSet_id :: Lens' GetReusableDelegationSet ResourceId Source #

The ID of the reusable delegation set that you want to get a list of name servers for.

getReusableDelegationSetResponse_delegationSet :: Lens' GetReusableDelegationSetResponse DelegationSet Source #

A complex type that contains information about the reusable delegation set.

DeleteTrafficPolicyInstance

deleteTrafficPolicyInstance_id :: Lens' DeleteTrafficPolicyInstance Text Source #

The ID of the traffic policy instance that you want to delete.

When you delete a traffic policy instance, Amazon Route 53 also deletes all of the resource record sets that were created when you created the traffic policy instance.

UpdateTrafficPolicyInstance

updateTrafficPolicyInstance_id :: Lens' UpdateTrafficPolicyInstance Text Source #

The ID of the traffic policy instance that you want to update.

updateTrafficPolicyInstance_ttl :: Lens' UpdateTrafficPolicyInstance Natural Source #

The TTL that you want Amazon Route 53 to assign to all of the updated resource record sets.

updateTrafficPolicyInstance_trafficPolicyId :: Lens' UpdateTrafficPolicyInstance Text Source #

The ID of the traffic policy that you want Amazon Route 53 to use to update resource record sets for the specified traffic policy instance.

updateTrafficPolicyInstance_trafficPolicyVersion :: Lens' UpdateTrafficPolicyInstance Natural Source #

The version of the traffic policy that you want Amazon Route 53 to use to update resource record sets for the specified traffic policy instance.

updateTrafficPolicyInstanceResponse_trafficPolicyInstance :: Lens' UpdateTrafficPolicyInstanceResponse TrafficPolicyInstance Source #

A complex type that contains settings for the updated traffic policy instance.

UpdateHostedZoneComment

updateHostedZoneComment_comment :: Lens' UpdateHostedZoneComment (Maybe Text) Source #

The new comment for the hosted zone. If you don't specify a value for Comment, Amazon Route 53 deletes the existing value of the Comment element, if any.

updateHostedZoneComment_id :: Lens' UpdateHostedZoneComment ResourceId Source #

The ID for the hosted zone that you want to update the comment for.

updateHostedZoneCommentResponse_hostedZone :: Lens' UpdateHostedZoneCommentResponse HostedZone Source #

A complex type that contains the response to the UpdateHostedZoneComment request.

GetHealthCheckStatus

getHealthCheckStatus_healthCheckId :: Lens' GetHealthCheckStatus Text Source #

The ID for the health check that you want the current status for. When you created the health check, CreateHealthCheck returned the ID in the response, in the HealthCheckId element.

If you want to check the status of a calculated health check, you must use the Amazon Route 53 console or the CloudWatch console. You can't use GetHealthCheckStatus to get the status of a calculated health check.

getHealthCheckStatusResponse_healthCheckObservations :: Lens' GetHealthCheckStatusResponse [HealthCheckObservation] Source #

A list that contains one HealthCheckObservation element for each Amazon Route 53 health checker that is reporting a status about the health check endpoint.

ListHostedZonesByVPC

listHostedZonesByVPC_nextToken :: Lens' ListHostedZonesByVPC (Maybe Text) Source #

If the previous response included a NextToken element, the specified VPC is associated with more hosted zones. To get more hosted zones, submit another ListHostedZonesByVPC request.

For the value of NextToken, specify the value of NextToken from the previous response.

If the previous response didn't include a NextToken element, there are no more hosted zones to get.

listHostedZonesByVPC_maxItems :: Lens' ListHostedZonesByVPC (Maybe Text) Source #

(Optional) The maximum number of hosted zones that you want Amazon Route 53 to return. If the specified VPC is associated with more than MaxItems hosted zones, the response includes a NextToken element. NextToken contains an encrypted token that identifies the first hosted zone that Route 53 will return if you submit another request.

listHostedZonesByVPC_vPCId :: Lens' ListHostedZonesByVPC Text Source #

The ID of the Amazon VPC that you want to list hosted zones for.

listHostedZonesByVPC_vPCRegion :: Lens' ListHostedZonesByVPC VPCRegion Source #

For the Amazon VPC that you specified for VPCId, the Amazon Web Services Region that you created the VPC in.

listHostedZonesByVPCResponse_nextToken :: Lens' ListHostedZonesByVPCResponse (Maybe Text) Source #

The value that you will use for NextToken in the next ListHostedZonesByVPC request.

listHostedZonesByVPCResponse_hostedZoneSummaries :: Lens' ListHostedZonesByVPCResponse [HostedZoneSummary] Source #

A list that contains one HostedZoneSummary element for each hosted zone that the specified Amazon VPC is associated with. Each HostedZoneSummary element contains the hosted zone name and ID, and information about who owns the hosted zone.

listHostedZonesByVPCResponse_maxItems :: Lens' ListHostedZonesByVPCResponse Text Source #

The value that you specified for MaxItems in the most recent ListHostedZonesByVPC request.

GetReusableDelegationSetLimit

getReusableDelegationSetLimit_type :: Lens' GetReusableDelegationSetLimit ReusableDelegationSetLimitType Source #

Specify MAX_ZONES_BY_REUSABLE_DELEGATION_SET to get the maximum number of hosted zones that you can associate with the specified reusable delegation set.

getReusableDelegationSetLimit_delegationSetId :: Lens' GetReusableDelegationSetLimit ResourceId Source #

The ID of the delegation set that you want to get the limit for.

getReusableDelegationSetLimitResponse_limit :: Lens' GetReusableDelegationSetLimitResponse ReusableDelegationSetLimit Source #

The current setting for the limit on hosted zones that you can associate with the specified reusable delegation set.

getReusableDelegationSetLimitResponse_count :: Lens' GetReusableDelegationSetLimitResponse Natural Source #

The current number of hosted zones that you can associate with the specified reusable delegation set.

CreateTrafficPolicyVersion

createTrafficPolicyVersion_comment :: Lens' CreateTrafficPolicyVersion (Maybe Text) Source #

The comment that you specified in the CreateTrafficPolicyVersion request, if any.

createTrafficPolicyVersion_id :: Lens' CreateTrafficPolicyVersion Text Source #

The ID of the traffic policy for which you want to create a new version.

createTrafficPolicyVersion_document :: Lens' CreateTrafficPolicyVersion Text Source #

The definition of this version of the traffic policy, in JSON format. You specified the JSON in the CreateTrafficPolicyVersion request. For more information about the JSON format, see CreateTrafficPolicy.

createTrafficPolicyVersionResponse_trafficPolicy :: Lens' CreateTrafficPolicyVersionResponse TrafficPolicy Source #

A complex type that contains settings for the new version of the traffic policy.

createTrafficPolicyVersionResponse_location :: Lens' CreateTrafficPolicyVersionResponse Text Source #

A unique URL that represents a new traffic policy version.

DeactivateKeySigningKey

deactivateKeySigningKey_hostedZoneId :: Lens' DeactivateKeySigningKey ResourceId Source #

A unique string used to identify a hosted zone.

deactivateKeySigningKey_name :: Lens' DeactivateKeySigningKey Text Source #

A string used to identify a key-signing key (KSK).

TestDNSAnswer

testDNSAnswer_resolverIP :: Lens' TestDNSAnswer (Maybe Text) Source #

If you want to simulate a request from a specific DNS resolver, specify the IP address for that resolver. If you omit this value, TestDnsAnswer uses the IP address of a DNS resolver in the Amazon Web Services US East (N. Virginia) Region (us-east-1).

testDNSAnswer_eDNS0ClientSubnetIP :: Lens' TestDNSAnswer (Maybe Text) Source #

If the resolver that you specified for resolverip supports EDNS0, specify the IPv4 or IPv6 address of a client in the applicable location, for example, 192.0.2.44 or 2001:db8:85a3::8a2e:370:7334.

testDNSAnswer_eDNS0ClientSubnetMask :: Lens' TestDNSAnswer (Maybe Text) Source #

If you specify an IP address for edns0clientsubnetip, you can optionally specify the number of bits of the IP address that you want the checking tool to include in the DNS query. For example, if you specify 192.0.2.44 for edns0clientsubnetip and 24 for edns0clientsubnetmask, the checking tool will simulate a request from 192.0.2.0/24. The default value is 24 bits for IPv4 addresses and 64 bits for IPv6 addresses.

The range of valid values depends on whether edns0clientsubnetip is an IPv4 or an IPv6 address:

  • IPv4: Specify a value between 0 and 32
  • IPv6: Specify a value between 0 and 128

testDNSAnswer_hostedZoneId :: Lens' TestDNSAnswer ResourceId Source #

The ID of the hosted zone that you want Amazon Route 53 to simulate a query for.

testDNSAnswer_recordName :: Lens' TestDNSAnswer Text Source #

The name of the resource record set that you want Amazon Route 53 to simulate a query for.

testDNSAnswer_recordType :: Lens' TestDNSAnswer RRType Source #

The type of the resource record set.

testDNSAnswerResponse_nameserver :: Lens' TestDNSAnswerResponse Text Source #

The Amazon Route 53 name server used to respond to the request.

testDNSAnswerResponse_recordName :: Lens' TestDNSAnswerResponse Text Source #

The name of the resource record set that you submitted a request for.

testDNSAnswerResponse_recordType :: Lens' TestDNSAnswerResponse RRType Source #

The type of the resource record set that you submitted a request for.

testDNSAnswerResponse_recordData :: Lens' TestDNSAnswerResponse [Text] Source #

A list that contains values that Amazon Route 53 returned for this resource record set.

testDNSAnswerResponse_responseCode :: Lens' TestDNSAnswerResponse Text Source #

A code that indicates whether the request is valid or not. The most common response code is NOERROR, meaning that the request is valid. If the response is not valid, Amazon Route 53 returns a response code that describes the error. For a list of possible response codes, see DNS RCODES on the IANA website.

testDNSAnswerResponse_protocol :: Lens' TestDNSAnswerResponse Text Source #

The protocol that Amazon Route 53 used to respond to the request, either UDP or TCP.

ListHealthChecks

listHealthChecks_marker :: Lens' ListHealthChecks (Maybe Text) Source #

If the value of IsTruncated in the previous response was true, you have more health checks. To get another group, submit another ListHealthChecks request.

For the value of marker, specify the value of NextMarker from the previous response, which is the ID of the first health check that Amazon Route 53 will return if you submit another request.

If the value of IsTruncated in the previous response was false, there are no more health checks to get.

listHealthChecks_maxItems :: Lens' ListHealthChecks (Maybe Text) Source #

The maximum number of health checks that you want ListHealthChecks to return in response to the current request. Amazon Route 53 returns a maximum of 100 items. If you set MaxItems to a value greater than 100, Route 53 returns only the first 100 health checks.

listHealthChecksResponse_nextMarker :: Lens' ListHealthChecksResponse (Maybe Text) Source #

If IsTruncated is true, the value of NextMarker identifies the first health check that Amazon Route 53 returns if you submit another ListHealthChecks request and specify the value of NextMarker in the marker parameter.

listHealthChecksResponse_healthChecks :: Lens' ListHealthChecksResponse [HealthCheck] Source #

A complex type that contains one HealthCheck element for each health check that is associated with the current Amazon Web Services account.

listHealthChecksResponse_marker :: Lens' ListHealthChecksResponse Text Source #

For the second and subsequent calls to ListHealthChecks, Marker is the value that you specified for the marker parameter in the previous request.

listHealthChecksResponse_isTruncated :: Lens' ListHealthChecksResponse Bool Source #

A flag that indicates whether there are more health checks to be listed. If the response was truncated, you can get the next group of health checks by submitting another ListHealthChecks request and specifying the value of NextMarker in the marker parameter.

listHealthChecksResponse_maxItems :: Lens' ListHealthChecksResponse Text Source #

The value that you specified for the maxitems parameter in the call to ListHealthChecks that produced the current response.

GetTrafficPolicy

getTrafficPolicy_id :: Lens' GetTrafficPolicy Text Source #

The ID of the traffic policy that you want to get information about.

getTrafficPolicy_version :: Lens' GetTrafficPolicy Natural Source #

The version number of the traffic policy that you want to get information about.

getTrafficPolicyResponse_trafficPolicy :: Lens' GetTrafficPolicyResponse TrafficPolicy Source #

A complex type that contains settings for the specified traffic policy.

ListTrafficPolicyVersions

listTrafficPolicyVersions_maxItems :: Lens' ListTrafficPolicyVersions (Maybe Text) Source #

The maximum number of traffic policy versions that you want Amazon Route 53 to include in the response body for this request. If the specified traffic policy has more than MaxItems versions, the value of IsTruncated in the response is true, and the value of the TrafficPolicyVersionMarker element is the ID of the first version that Route 53 will return if you submit another request.

listTrafficPolicyVersions_trafficPolicyVersionMarker :: Lens' ListTrafficPolicyVersions (Maybe Text) Source #

For your first request to ListTrafficPolicyVersions, don't include the TrafficPolicyVersionMarker parameter.

If you have more traffic policy versions than the value of MaxItems, ListTrafficPolicyVersions returns only the first group of MaxItems versions. To get more traffic policy versions, submit another ListTrafficPolicyVersions request. For the value of TrafficPolicyVersionMarker, specify the value of TrafficPolicyVersionMarker in the previous response.

listTrafficPolicyVersions_id :: Lens' ListTrafficPolicyVersions Text Source #

Specify the value of Id of the traffic policy for which you want to list all versions.

listTrafficPolicyVersionsResponse_trafficPolicies :: Lens' ListTrafficPolicyVersionsResponse [TrafficPolicy] Source #

A list that contains one TrafficPolicy element for each traffic policy version that is associated with the specified traffic policy.

listTrafficPolicyVersionsResponse_isTruncated :: Lens' ListTrafficPolicyVersionsResponse Bool Source #

A flag that indicates whether there are more traffic policies to be listed. If the response was truncated, you can get the next group of traffic policies by submitting another ListTrafficPolicyVersions request and specifying the value of NextMarker in the marker parameter.

listTrafficPolicyVersionsResponse_trafficPolicyVersionMarker :: Lens' ListTrafficPolicyVersionsResponse Text Source #

If IsTruncated is true, the value of TrafficPolicyVersionMarker identifies the first traffic policy that Amazon Route 53 will return if you submit another request. Call ListTrafficPolicyVersions again and specify the value of TrafficPolicyVersionMarker in the TrafficPolicyVersionMarker request parameter.

This element is present only if IsTruncated is true.

listTrafficPolicyVersionsResponse_maxItems :: Lens' ListTrafficPolicyVersionsResponse Text Source #

The value that you specified for the maxitems parameter in the ListTrafficPolicyVersions request that produced the current response.

DeleteHostedZone

deleteHostedZone_id :: Lens' DeleteHostedZone ResourceId Source #

The ID of the hosted zone you want to delete.

deleteHostedZoneResponse_changeInfo :: Lens' DeleteHostedZoneResponse ChangeInfo Source #

A complex type that contains the ID, the status, and the date and time of a request to delete a hosted zone.

GetGeoLocation

getGeoLocation_subdivisionCode :: Lens' GetGeoLocation (Maybe Text) Source #

The code for the subdivision, such as a particular state within the United States. For a list of US state abbreviations, see Appendix B: Two–Letter State and Possession Abbreviations on the United States Postal Service website. For a list of all supported subdivision codes, use the ListGeoLocations API.

getGeoLocation_countryCode :: Lens' GetGeoLocation (Maybe Text) Source #

Amazon Route 53 uses the two-letter country codes that are specified in ISO standard 3166-1 alpha-2.

getGeoLocation_continentCode :: Lens' GetGeoLocation (Maybe Text) Source #

For geolocation resource record sets, a two-letter abbreviation that identifies a continent. Amazon Route 53 supports the following continent codes:

  • AF: Africa
  • AN: Antarctica
  • AS: Asia
  • EU: Europe
  • OC: Oceania
  • NA: North America
  • SA: South America

getGeoLocationResponse_geoLocationDetails :: Lens' GetGeoLocationResponse GeoLocationDetails Source #

A complex type that contains the codes and full continent, country, and subdivision names for the specified geolocation code.

ListTagsForResources

listTagsForResources_resourceType :: Lens' ListTagsForResources TagResourceType Source #

The type of the resources.

  • The resource type for health checks is healthcheck.
  • The resource type for hosted zones is hostedzone.

listTagsForResources_resourceIds :: Lens' ListTagsForResources (NonEmpty Text) Source #

A complex type that contains the ResourceId element for each resource for which you want to get a list of tags.

listTagsForResourcesResponse_resourceTagSets :: Lens' ListTagsForResourcesResponse [ResourceTagSet] Source #

A list of ResourceTagSets containing tags associated with the specified resources.

CreateTrafficPolicy

createTrafficPolicy_comment :: Lens' CreateTrafficPolicy (Maybe Text) Source #

(Optional) Any comments that you want to include about the traffic policy.

createTrafficPolicy_document :: Lens' CreateTrafficPolicy Text Source #

The definition of this traffic policy in JSON format. For more information, see Traffic Policy Document Format.

createTrafficPolicyResponse_trafficPolicy :: Lens' CreateTrafficPolicyResponse TrafficPolicy Source #

A complex type that contains settings for the new traffic policy.

createTrafficPolicyResponse_location :: Lens' CreateTrafficPolicyResponse Text Source #

A unique URL that represents a new traffic policy.

ListTrafficPolicyInstancesByHostedZone

listTrafficPolicyInstancesByHostedZone_trafficPolicyInstanceTypeMarker :: Lens' ListTrafficPolicyInstancesByHostedZone (Maybe RRType) Source #

If the value of IsTruncated in the previous response is true, you have more traffic policy instances. To get more traffic policy instances, submit another ListTrafficPolicyInstances request. For the value of trafficpolicyinstancetype, specify the value of TrafficPolicyInstanceTypeMarker from the previous response, which is the type of the first traffic policy instance in the next group of traffic policy instances.

If the value of IsTruncated in the previous response was false, there are no more traffic policy instances to get.

listTrafficPolicyInstancesByHostedZone_maxItems :: Lens' ListTrafficPolicyInstancesByHostedZone (Maybe Text) Source #

The maximum number of traffic policy instances to be included in the response body for this request. If you have more than MaxItems traffic policy instances, the value of the IsTruncated element in the response is true, and the values of HostedZoneIdMarker, TrafficPolicyInstanceNameMarker, and TrafficPolicyInstanceTypeMarker represent the first traffic policy instance that Amazon Route 53 will return if you submit another request.

listTrafficPolicyInstancesByHostedZone_trafficPolicyInstanceNameMarker :: Lens' ListTrafficPolicyInstancesByHostedZone (Maybe Text) Source #

If the value of IsTruncated in the previous response is true, you have more traffic policy instances. To get more traffic policy instances, submit another ListTrafficPolicyInstances request. For the value of trafficpolicyinstancename, specify the value of TrafficPolicyInstanceNameMarker from the previous response, which is the name of the first traffic policy instance in the next group of traffic policy instances.

If the value of IsTruncated in the previous response was false, there are no more traffic policy instances to get.

listTrafficPolicyInstancesByHostedZone_hostedZoneId :: Lens' ListTrafficPolicyInstancesByHostedZone ResourceId Source #

The ID of the hosted zone that you want to list traffic policy instances for.

listTrafficPolicyInstancesByHostedZoneResponse_trafficPolicyInstanceTypeMarker :: Lens' ListTrafficPolicyInstancesByHostedZoneResponse (Maybe RRType) Source #

If IsTruncated is true, TrafficPolicyInstanceTypeMarker is the DNS type of the resource record sets that are associated with the first traffic policy instance in the next group of traffic policy instances.

listTrafficPolicyInstancesByHostedZoneResponse_trafficPolicyInstanceNameMarker :: Lens' ListTrafficPolicyInstancesByHostedZoneResponse (Maybe Text) Source #

If IsTruncated is true, TrafficPolicyInstanceNameMarker is the name of the first traffic policy instance in the next group of traffic policy instances.

listTrafficPolicyInstancesByHostedZoneResponse_trafficPolicyInstances :: Lens' ListTrafficPolicyInstancesByHostedZoneResponse [TrafficPolicyInstance] Source #

A list that contains one TrafficPolicyInstance element for each traffic policy instance that matches the elements in the request.

listTrafficPolicyInstancesByHostedZoneResponse_isTruncated :: Lens' ListTrafficPolicyInstancesByHostedZoneResponse Bool Source #

A flag that indicates whether there are more traffic policy instances to be listed. If the response was truncated, you can get the next group of traffic policy instances by submitting another ListTrafficPolicyInstancesByHostedZone request and specifying the values of HostedZoneIdMarker, TrafficPolicyInstanceNameMarker, and TrafficPolicyInstanceTypeMarker in the corresponding request parameters.

listTrafficPolicyInstancesByHostedZoneResponse_maxItems :: Lens' ListTrafficPolicyInstancesByHostedZoneResponse Text Source #

The value that you specified for the MaxItems parameter in the ListTrafficPolicyInstancesByHostedZone request that produced the current response.

ListTrafficPolicies

listTrafficPolicies_trafficPolicyIdMarker :: Lens' ListTrafficPolicies (Maybe Text) Source #

(Conditional) For your first request to ListTrafficPolicies, don't include the TrafficPolicyIdMarker parameter.

If you have more traffic policies than the value of MaxItems, ListTrafficPolicies returns only the first MaxItems traffic policies. To get the next group of policies, submit another request to ListTrafficPolicies. For the value of TrafficPolicyIdMarker, specify the value of TrafficPolicyIdMarker that was returned in the previous response.

listTrafficPolicies_maxItems :: Lens' ListTrafficPolicies (Maybe Text) Source #

(Optional) The maximum number of traffic policies that you want Amazon Route 53 to return in response to this request. If you have more than MaxItems traffic policies, the value of IsTruncated in the response is true, and the value of TrafficPolicyIdMarker is the ID of the first traffic policy that Route 53 will return if you submit another request.

listTrafficPoliciesResponse_trafficPolicySummaries :: Lens' ListTrafficPoliciesResponse [TrafficPolicySummary] Source #

A list that contains one TrafficPolicySummary element for each traffic policy that was created by the current Amazon Web Services account.

listTrafficPoliciesResponse_isTruncated :: Lens' ListTrafficPoliciesResponse Bool Source #

A flag that indicates whether there are more traffic policies to be listed. If the response was truncated, you can get the next group of traffic policies by submitting another ListTrafficPolicies request and specifying the value of TrafficPolicyIdMarker in the TrafficPolicyIdMarker request parameter.

listTrafficPoliciesResponse_trafficPolicyIdMarker :: Lens' ListTrafficPoliciesResponse Text Source #

If the value of IsTruncated is true, TrafficPolicyIdMarker is the ID of the first traffic policy in the next group of MaxItems traffic policies.

listTrafficPoliciesResponse_maxItems :: Lens' ListTrafficPoliciesResponse Text Source #

The value that you specified for the MaxItems parameter in the ListTrafficPolicies request that produced the current response.

Types

AccountLimit

accountLimit_type :: Lens' AccountLimit AccountLimitType Source #

The limit that you requested. Valid values include the following:

  • MAX_HEALTH_CHECKS_BY_OWNER: The maximum number of health checks that you can create using the current account.
  • MAX_HOSTED_ZONES_BY_OWNER: The maximum number of hosted zones that you can create using the current account.
  • MAX_REUSABLE_DELEGATION_SETS_BY_OWNER: The maximum number of reusable delegation sets that you can create using the current account.
  • MAX_TRAFFIC_POLICIES_BY_OWNER: The maximum number of traffic policies that you can create using the current account.
  • MAX_TRAFFIC_POLICY_INSTANCES_BY_OWNER: The maximum number of traffic policy instances that you can create using the current account. (Traffic policy instances are referred to as traffic flow policy records in the Amazon Route 53 console.)

accountLimit_value :: Lens' AccountLimit Natural Source #

The current value for the limit that is specified by Type.

AlarmIdentifier

alarmIdentifier_region :: Lens' AlarmIdentifier CloudWatchRegion Source #

For the CloudWatch alarm that you want Route 53 health checkers to use to determine whether this health check is healthy, the region that the alarm was created in.

For the current list of CloudWatch regions, see Amazon CloudWatch endpoints and quotas in the Amazon Web Services General Reference.

alarmIdentifier_name :: Lens' AlarmIdentifier Text Source #

The name of the CloudWatch alarm that you want Amazon Route 53 health checkers to use to determine whether this health check is healthy.

Route 53 supports CloudWatch alarms with the following features:

  • Standard-resolution metrics. High-resolution metrics aren't supported. For more information, see High-Resolution Metrics in the Amazon CloudWatch User Guide.
  • Statistics: Average, Minimum, Maximum, Sum, and SampleCount. Extended statistics aren't supported.

AliasTarget

aliasTarget_hostedZoneId :: Lens' AliasTarget ResourceId Source #

Alias resource records sets only: The value used depends on where you want to route traffic:

Amazon API Gateway custom regional APIs and edge-optimized APIs
Specify the hosted zone ID for your API. You can get the applicable value using the CLI command get-domain-names:
  • For regional APIs, specify the value of regionalHostedZoneId.
  • For edge-optimized APIs, specify the value of distributionHostedZoneId.
Amazon Virtual Private Cloud interface VPC endpoint
Specify the hosted zone ID for your interface endpoint. You can get the value of HostedZoneId using the CLI command describe-vpc-endpoints.
CloudFront distribution
Specify Z2FDTNDATAQYW2.

Alias resource record sets for CloudFront can't be created in a private zone.

Elastic Beanstalk environment
Specify the hosted zone ID for the region that you created the environment in. The environment must have a regionalized subdomain. For a list of regions and the corresponding hosted zone IDs, see Elastic Beanstalk endpoints and quotas in the the Amazon Web Services General Reference.
ELB load balancer
Specify the value of the hosted zone ID for the load balancer. Use the following methods to get the hosted zone ID:
  • Elastic Load Balancing endpoints and quotas topic in the Amazon Web Services General Reference: Use the value that corresponds with the region that you created your load balancer in. Note that there are separate columns for Application and Classic Load Balancers and for Network Load Balancers.
  • Amazon Web Services Management Console: Go to the Amazon EC2 page, choose Load Balancers in the navigation pane, select the load balancer, and get the value of the Hosted zone field on the Description tab.
  • Elastic Load Balancing API: Use DescribeLoadBalancers to get the applicable value. For more information, see the applicable guide:

  • CLI: Use describe-load-balancers to get the applicable value. For more information, see the applicable guide:

Global Accelerator accelerator
Specify Z2BJ6XQ5FK7U4H.
An Amazon S3 bucket configured as a static website
Specify the hosted zone ID for the region that you created the bucket in. For more information about valid values, see the table Amazon S3 Website Endpoints in the Amazon Web Services General Reference.
Another Route 53 resource record set in your hosted zone
Specify the hosted zone ID of your hosted zone. (An alias resource record set can't reference a resource record set in a different hosted zone.)

aliasTarget_dNSName :: Lens' AliasTarget Text Source #

Alias resource record sets only: The value that you specify depends on where you want to route queries:

Amazon API Gateway custom regional APIs and edge-optimized APIs
Specify the applicable domain name for your API. You can get the applicable value using the CLI command get-domain-names:
  • For regional APIs, specify the value of regionalDomainName.
  • For edge-optimized APIs, specify the value of distributionDomainName. This is the name of the associated CloudFront distribution, such as da1b2c3d4e5.cloudfront.net.

The name of the record that you're creating must match a custom domain name for your API, such as api.example.com.

Amazon Virtual Private Cloud interface VPC endpoint
Enter the API endpoint for the interface endpoint, such as vpce-123456789abcdef01-example-us-east-1a.elasticloadbalancing.us-east-1.vpce.amazonaws.com. For edge-optimized APIs, this is the domain name for the corresponding CloudFront distribution. You can get the value of DnsName using the CLI command describe-vpc-endpoints.
CloudFront distribution
Specify the domain name that CloudFront assigned when you created your distribution.

Your CloudFront distribution must include an alternate domain name that matches the name of the resource record set. For example, if the name of the resource record set is acme.example.com, your CloudFront distribution must include acme.example.com as one of the alternate domain names. For more information, see Using Alternate Domain Names (CNAMEs) in the Amazon CloudFront Developer Guide.

You can't create a resource record set in a private hosted zone to route traffic to a CloudFront distribution.

For failover alias records, you can't specify a CloudFront distribution for both the primary and secondary records. A distribution must include an alternate domain name that matches the name of the record. However, the primary and secondary records have the same name, and you can't include the same alternate domain name in more than one distribution.

Elastic Beanstalk environment
If the domain name for your Elastic Beanstalk environment includes the region that you deployed the environment in, you can create an alias record that routes traffic to the environment. For example, the domain name my-environment.us-west-2.elasticbeanstalk.com is a regionalized domain name.

For environments that were created before early 2016, the domain name doesn't include the region. To route traffic to these environments, you must create a CNAME record instead of an alias record. Note that you can't create a CNAME record for the root domain name. For example, if your domain name is example.com, you can create a record that routes traffic for acme.example.com to your Elastic Beanstalk environment, but you can't create a record that routes traffic for example.com to your Elastic Beanstalk environment.

For Elastic Beanstalk environments that have regionalized subdomains, specify the CNAME attribute for the environment. You can use the following methods to get the value of the CNAME attribute:

  • Amazon Web Services Management Console: For information about how to get the value by using the console, see Using Custom Domains with Elastic Beanstalk in the Elastic Beanstalk Developer Guide.
  • Elastic Beanstalk API: Use the DescribeEnvironments action to get the value of the CNAME attribute. For more information, see DescribeEnvironments in the Elastic Beanstalk API Reference.
  • CLI: Use the describe-environments command to get the value of the CNAME attribute. For more information, see describe-environments in the CLI Command Reference.
ELB load balancer
Specify the DNS name that is associated with the load balancer. Get the DNS name by using the Amazon Web Services Management Console, the ELB API, or the CLI.
  • Amazon Web Services Management Console: Go to the EC2 page, choose Load Balancers in the navigation pane, choose the load balancer, choose the Description tab, and get the value of the DNS name field.

    If you're routing traffic to a Classic Load Balancer, get the value that begins with dualstack. If you're routing traffic to another type of load balancer, get the value that applies to the record type, A or AAAA.

  • Elastic Load Balancing API: Use DescribeLoadBalancers to get the value of DNSName. For more information, see the applicable guide:

  • CLI: Use describe-load-balancers to get the value of DNSName. For more information, see the applicable guide:

Global Accelerator accelerator
Specify the DNS name for your accelerator:
Amazon S3 bucket that is configured as a static website
Specify the domain name of the Amazon S3 website endpoint that you created the bucket in, for example, s3-website.us-east-2.amazonaws.com. For more information about valid values, see the table Amazon S3 Website Endpoints in the Amazon Web Services General Reference. For more information about using S3 buckets for websites, see Getting Started with Amazon Route 53 in the Amazon Route 53 Developer Guide.
Another Route 53 resource record set
Specify the value of the Name element for a resource record set in the current hosted zone.

If you're creating an alias record that has the same name as the hosted zone (known as the zone apex), you can't specify the domain name for a record for which the value of Type is CNAME. This is because the alias record must have the same type as the record that you're routing traffic to, and creating a CNAME record for the zone apex isn't supported even for an alias record.

aliasTarget_evaluateTargetHealth :: Lens' AliasTarget Bool Source #

/Applies only to alias, failover alias, geolocation alias, latency alias, and weighted alias resource record sets:/ When EvaluateTargetHealth is true, an alias resource record set inherits the health of the referenced Amazon Web Services resource, such as an ELB load balancer or another resource record set in the hosted zone.

Note the following:

CloudFront distributions
You can't set EvaluateTargetHealth to true when the alias target is a CloudFront distribution.
Elastic Beanstalk environments that have regionalized subdomains
If you specify an Elastic Beanstalk environment in DNSName and the environment contains an ELB load balancer, Elastic Load Balancing routes queries only to the healthy Amazon EC2 instances that are registered with the load balancer. (An environment automatically contains an ELB load balancer if it includes more than one Amazon EC2 instance.) If you set EvaluateTargetHealth to true and either no Amazon EC2 instances are healthy or the load balancer itself is unhealthy, Route 53 routes queries to other available resources that are healthy, if any.

If the environment contains a single Amazon EC2 instance, there are no special requirements.

ELB load balancers
Health checking behavior depends on the type of load balancer:
  • Classic Load Balancers: If you specify an ELB Classic Load Balancer in DNSName, Elastic Load Balancing routes queries only to the healthy Amazon EC2 instances that are registered with the load balancer. If you set EvaluateTargetHealth to true and either no EC2 instances are healthy or the load balancer itself is unhealthy, Route 53 routes queries to other resources.
  • Application and Network Load Balancers: If you specify an ELB Application or Network Load Balancer and you set EvaluateTargetHealth to true, Route 53 routes queries to the load balancer based on the health of the target groups that are associated with the load balancer:

    • For an Application or Network Load Balancer to be considered healthy, every target group that contains targets must contain at least one healthy target. If any target group contains only unhealthy targets, the load balancer is considered unhealthy, and Route 53 routes queries to other resources.
    • A target group that has no registered targets is considered unhealthy.

When you create a load balancer, you configure settings for Elastic Load Balancing health checks; they're not Route 53 health checks, but they perform a similar function. Do not create Route 53 health checks for the EC2 instances that you register with an ELB load balancer.

S3 buckets
There are no special requirements for setting EvaluateTargetHealth to true when the alias target is an S3 bucket.
Other records in the same hosted zone
If the Amazon Web Services resource that you specify in DNSName is a record or a group of records (for example, a group of weighted records) but is not another alias record, we recommend that you associate a health check with all of the records in the alias target. For more information, see What Happens When You Omit Health Checks? in the Amazon Route 53 Developer Guide.

For more information and examples, see Amazon Route 53 Health Checks and DNS Failover in the Amazon Route 53 Developer Guide.

Change

change_action :: Lens' Change ChangeAction Source #

The action to perform:

  • CREATE: Creates a resource record set that has the specified values.
  • DELETE: Deletes a existing resource record set.

    To delete the resource record set that is associated with a traffic policy instance, use DeleteTrafficPolicyInstance. Amazon Route 53 will delete the resource record set automatically. If you delete the resource record set by using ChangeResourceRecordSets, Route 53 doesn't automatically delete the traffic policy instance, and you'll continue to be charged for it even though it's no longer in use.

  • UPSERT: If a resource record set doesn't already exist, Route 53 creates it. If a resource record set does exist, Route 53 updates it with the values in the request.

change_resourceRecordSet :: Lens' Change ResourceRecordSet Source #

Information about the resource record set to create, delete, or update.

ChangeBatch

changeBatch_comment :: Lens' ChangeBatch (Maybe Text) Source #

Optional: Any comments you want to include about a change batch request.

changeBatch_changes :: Lens' ChangeBatch (NonEmpty Change) Source #

Information about the changes to make to the record sets.

ChangeInfo

changeInfo_comment :: Lens' ChangeInfo (Maybe Text) Source #

A comment you can provide.

changeInfo_id :: Lens' ChangeInfo ResourceId Source #

This element contains an ID that you use when performing a GetChange action to get detailed information about the change.

changeInfo_status :: Lens' ChangeInfo ChangeStatus Source #

The current state of the request. PENDING indicates that this request has not yet been applied to all Amazon Route 53 DNS servers.

changeInfo_submittedAt :: Lens' ChangeInfo UTCTime Source #

The date and time that the change request was submitted in ISO 8601 format and Coordinated Universal Time (UTC). For example, the value 2017-03-27T17:48:16.751Z represents March 27, 2017 at 17:48:16.751 UTC.

CloudWatchAlarmConfiguration

cloudWatchAlarmConfiguration_dimensions :: Lens' CloudWatchAlarmConfiguration (Maybe [Dimension]) Source #

For the metric that the CloudWatch alarm is associated with, a complex type that contains information about the dimensions for the metric. For information, see Amazon CloudWatch Namespaces, Dimensions, and Metrics Reference in the Amazon CloudWatch User Guide.

cloudWatchAlarmConfiguration_evaluationPeriods :: Lens' CloudWatchAlarmConfiguration Natural Source #

For the metric that the CloudWatch alarm is associated with, the number of periods that the metric is compared to the threshold.

cloudWatchAlarmConfiguration_threshold :: Lens' CloudWatchAlarmConfiguration Double Source #

For the metric that the CloudWatch alarm is associated with, the value the metric is compared with.

cloudWatchAlarmConfiguration_comparisonOperator :: Lens' CloudWatchAlarmConfiguration ComparisonOperator Source #

For the metric that the CloudWatch alarm is associated with, the arithmetic operation that is used for the comparison.

cloudWatchAlarmConfiguration_period :: Lens' CloudWatchAlarmConfiguration Natural Source #

For the metric that the CloudWatch alarm is associated with, the duration of one evaluation period in seconds.

cloudWatchAlarmConfiguration_metricName :: Lens' CloudWatchAlarmConfiguration Text Source #

The name of the CloudWatch metric that the alarm is associated with.

cloudWatchAlarmConfiguration_namespace :: Lens' CloudWatchAlarmConfiguration Text Source #

The namespace of the metric that the alarm is associated with. For more information, see Amazon CloudWatch Namespaces, Dimensions, and Metrics Reference in the Amazon CloudWatch User Guide.

cloudWatchAlarmConfiguration_statistic :: Lens' CloudWatchAlarmConfiguration Statistic Source #

For the metric that the CloudWatch alarm is associated with, the statistic that is applied to the metric.

DNSSECStatus

dNSSECStatus_serveSignature :: Lens' DNSSECStatus (Maybe Text) Source #

A string that represents the current hosted zone signing status.

Status can have one of the following values:

SIGNING
DNSSEC signing is enabled for the hosted zone.
NOT_SIGNING
DNSSEC signing is not enabled for the hosted zone.
DELETING
DNSSEC signing is in the process of being removed for the hosted zone.
ACTION_NEEDED
There is a problem with signing in the hosted zone that requires you to take action to resolve. For example, the customer managed customer master key (CMK) might have been deleted, or the permissions for the customer managed CMK might have been changed.
INTERNAL_FAILURE
There was an error during a request. Before you can continue to work with DNSSEC signing, including with key-signing keys (KSKs), you must correct the problem by enabling or disabling DNSSEC signing for the hosted zone.

dNSSECStatus_statusMessage :: Lens' DNSSECStatus (Maybe Text) Source #

The status message provided for the following DNSSEC signing status: INTERNAL_FAILURE. The status message includes information about what the problem might be and steps that you can take to correct the issue.

DelegationSet

delegationSet_id :: Lens' DelegationSet (Maybe ResourceId) Source #

The ID that Amazon Route 53 assigns to a reusable delegation set.

delegationSet_callerReference :: Lens' DelegationSet (Maybe Text) Source #

The value that you specified for CallerReference when you created the reusable delegation set.

delegationSet_nameServers :: Lens' DelegationSet (NonEmpty Text) Source #

A complex type that contains a list of the authoritative name servers for a hosted zone or for a reusable delegation set.

Dimension

dimension_name :: Lens' Dimension Text Source #

For the metric that the CloudWatch alarm is associated with, the name of one dimension.

dimension_value :: Lens' Dimension Text Source #

For the metric that the CloudWatch alarm is associated with, the value of one dimension.

GeoLocation

geoLocation_subdivisionCode :: Lens' GeoLocation (Maybe Text) Source #

For geolocation resource record sets, the two-letter code for a state of the United States. Route 53 doesn't support any other values for SubdivisionCode. For a list of state abbreviations, see Appendix B: Two–Letter State and Possession Abbreviations on the United States Postal Service website.

If you specify subdivisioncode, you must also specify US for CountryCode.

geoLocation_countryCode :: Lens' GeoLocation (Maybe Text) Source #

For geolocation resource record sets, the two-letter code for a country.

Amazon Route 53 uses the two-letter country codes that are specified in ISO standard 3166-1 alpha-2.

geoLocation_continentCode :: Lens' GeoLocation (Maybe Text) Source #

The two-letter code for the continent.

Amazon Route 53 supports the following continent codes:

  • AF: Africa
  • AN: Antarctica
  • AS: Asia
  • EU: Europe
  • OC: Oceania
  • NA: North America
  • SA: South America

Constraint: Specifying ContinentCode with either CountryCode or SubdivisionCode returns an InvalidInput error.

GeoLocationDetails

geoLocationDetails_subdivisionName :: Lens' GeoLocationDetails (Maybe Text) Source #

The full name of the subdivision. Route 53 currently supports only states in the United States.

geoLocationDetails_subdivisionCode :: Lens' GeoLocationDetails (Maybe Text) Source #

The code for the subdivision, such as a particular state within the United States. For a list of US state abbreviations, see Appendix B: Two–Letter State and Possession Abbreviations on the United States Postal Service website. For a list of all supported subdivision codes, use the ListGeoLocations API.

geoLocationDetails_countryCode :: Lens' GeoLocationDetails (Maybe Text) Source #

The two-letter code for the country.

geoLocationDetails_continentCode :: Lens' GeoLocationDetails (Maybe Text) Source #

The two-letter code for the continent.

HealthCheck

healthCheck_linkedService :: Lens' HealthCheck (Maybe LinkedService) Source #

If the health check was created by another service, the service that created the health check. When a health check is created by another service, you can't edit or delete it using Amazon Route 53.

healthCheck_cloudWatchAlarmConfiguration :: Lens' HealthCheck (Maybe CloudWatchAlarmConfiguration) Source #

A complex type that contains information about the CloudWatch alarm that Amazon Route 53 is monitoring for this health check.

healthCheck_id :: Lens' HealthCheck Text Source #

The identifier that Amazon Route 53 assigned to the health check when you created it. When you add or update a resource record set, you use this value to specify which health check to use. The value can be up to 64 characters long.

healthCheck_callerReference :: Lens' HealthCheck Text Source #

A unique string that you specified when you created the health check.

healthCheck_healthCheckConfig :: Lens' HealthCheck HealthCheckConfig Source #

A complex type that contains detailed information about one health check.

healthCheck_healthCheckVersion :: Lens' HealthCheck Natural Source #

The version of the health check. You can optionally pass this value in a call to UpdateHealthCheck to prevent overwriting another change to the health check.

HealthCheckConfig

healthCheckConfig_failureThreshold :: Lens' HealthCheckConfig (Maybe Natural) Source #

The number of consecutive health checks that an endpoint must pass or fail for Amazon Route 53 to change the current status of the endpoint from unhealthy to healthy or vice versa. For more information, see How Amazon Route 53 Determines Whether an Endpoint Is Healthy in the Amazon Route 53 Developer Guide.

If you don't specify a value for FailureThreshold, the default value is three health checks.

healthCheckConfig_iPAddress :: Lens' HealthCheckConfig (Maybe Text) Source #

The IPv4 or IPv6 IP address of the endpoint that you want Amazon Route 53 to perform health checks on. If you don't specify a value for IPAddress, Route 53 sends a DNS request to resolve the domain name that you specify in FullyQualifiedDomainName at the interval that you specify in RequestInterval. Using an IP address returned by DNS, Route 53 then checks the health of the endpoint.

Use one of the following formats for the value of IPAddress:

  • IPv4 address: four values between 0 and 255, separated by periods (.), for example, 192.0.2.44.
  • IPv6 address: eight groups of four hexadecimal values, separated by colons (:), for example, 2001:0db8:85a3:0000:0000:abcd:0001:2345. You can also shorten IPv6 addresses as described in RFC 5952, for example, 2001:db8:85a3::abcd:1:2345.

If the endpoint is an EC2 instance, we recommend that you create an Elastic IP address, associate it with your EC2 instance, and specify the Elastic IP address for IPAddress. This ensures that the IP address of your instance will never change.

For more information, see FullyQualifiedDomainName.

Constraints: Route 53 can't check the health of endpoints for which the IP address is in local, private, non-routable, or multicast ranges. For more information about IP addresses for which you can't create health checks, see the following documents:

When the value of Type is CALCULATED or CLOUDWATCH_METRIC, omit IPAddress.

healthCheckConfig_enableSNI :: Lens' HealthCheckConfig (Maybe Bool) Source #

Specify whether you want Amazon Route 53 to send the value of FullyQualifiedDomainName to the endpoint in the client_hello message during TLS negotiation. This allows the endpoint to respond to HTTPS health check requests with the applicable SSL/TLS certificate.

Some endpoints require that HTTPS requests include the host name in the client_hello message. If you don't enable SNI, the status of the health check will be SSL alert handshake_failure. A health check can also have that status for other reasons. If SNI is enabled and you're still getting the error, check the SSL/TLS configuration on your endpoint and confirm that your certificate is valid.

The SSL/TLS certificate on your endpoint includes a domain name in the Common Name field and possibly several more in the Subject Alternative Names field. One of the domain names in the certificate should match the value that you specify for FullyQualifiedDomainName. If the endpoint responds to the client_hello message with a certificate that does not include the domain name that you specified in FullyQualifiedDomainName, a health checker will retry the handshake. In the second attempt, the health checker will omit FullyQualifiedDomainName from the client_hello message.

healthCheckConfig_disabled :: Lens' HealthCheckConfig (Maybe Bool) Source #

Stops Route 53 from performing health checks. When you disable a health check, here's what happens:

  • Health checks that check the health of endpoints: Route 53 stops submitting requests to your application, server, or other resource.
  • Calculated health checks: Route 53 stops aggregating the status of the referenced health checks.
  • Health checks that monitor CloudWatch alarms: Route 53 stops monitoring the corresponding CloudWatch metrics.

After you disable a health check, Route 53 considers the status of the health check to always be healthy. If you configured DNS failover, Route 53 continues to route traffic to the corresponding resources. If you want to stop routing traffic to a resource, change the value of Inverted.

Charges for a health check still apply when the health check is disabled. For more information, see Amazon Route 53 Pricing.

healthCheckConfig_searchString :: Lens' HealthCheckConfig (Maybe Text) Source #

If the value of Type is HTTP_STR_MATCH or HTTPS_STR_MATCH, the string that you want Amazon Route 53 to search for in the response body from the specified resource. If the string appears in the response body, Route 53 considers the resource healthy.

Route 53 considers case when searching for SearchString in the response body.

healthCheckConfig_healthThreshold :: Lens' HealthCheckConfig (Maybe Natural) Source #

The number of child health checks that are associated with a CALCULATED health check that Amazon Route 53 must consider healthy for the CALCULATED health check to be considered healthy. To specify the child health checks that you want to associate with a CALCULATED health check, use the ChildHealthChecks element.

Note the following:

  • If you specify a number greater than the number of child health checks, Route 53 always considers this health check to be unhealthy.
  • If you specify 0, Route 53 always considers this health check to be healthy.

healthCheckConfig_regions :: Lens' HealthCheckConfig (Maybe (NonEmpty HealthCheckRegion)) Source #

A complex type that contains one Region element for each region from which you want Amazon Route 53 health checkers to check the specified endpoint.

If you don't specify any regions, Route 53 health checkers automatically performs checks from all of the regions that are listed under Valid Values.

If you update a health check to remove a region that has been performing health checks, Route 53 will briefly continue to perform checks from that region to ensure that some health checkers are always checking the endpoint (for example, if you replace three regions with four different regions).

healthCheckConfig_resourcePath :: Lens' HealthCheckConfig (Maybe Text) Source #

The path, if any, that you want Amazon 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, for example, the file /docs/route53-health-check.html. You can also include query string parameters, for example, /welcome.html?language=jp&login=y.

healthCheckConfig_insufficientDataHealthStatus :: Lens' HealthCheckConfig (Maybe InsufficientDataHealthStatus) Source #

When CloudWatch has insufficient data about the metric to determine the alarm state, the status that you want Amazon Route 53 to assign to the health check:

  • Healthy: Route 53 considers the health check to be healthy.
  • Unhealthy: Route 53 considers the health check to be unhealthy.
  • LastKnownStatus: Route 53 uses the status of the health check from the last time that CloudWatch had sufficient data to determine the alarm state. For new health checks that have no last known status, the default status for the health check is healthy.

healthCheckConfig_alarmIdentifier :: Lens' HealthCheckConfig (Maybe AlarmIdentifier) Source #

A complex type that identifies the CloudWatch alarm that you want Amazon Route 53 health checkers to use to determine whether the specified health check is healthy.

healthCheckConfig_measureLatency :: Lens' HealthCheckConfig (Maybe Bool) Source #

Specify whether you want Amazon Route 53 to measure the latency between health checkers in multiple Amazon Web Services regions and your endpoint, and to display CloudWatch latency graphs on the __Health Checks__ page in the Route 53 console.

You can't change the value of MeasureLatency after you create a health check.

healthCheckConfig_inverted :: Lens' HealthCheckConfig (Maybe Bool) Source #

Specify whether you want Amazon Route 53 to invert the status of a health check, for example, to consider a health check unhealthy when it otherwise would be considered healthy.

healthCheckConfig_fullyQualifiedDomainName :: Lens' HealthCheckConfig (Maybe Text) Source #

Amazon Route 53 behavior depends on whether you specify a value for IPAddress.

If you specify a value for IPAddress:

Amazon Route 53 sends health check requests to the specified IPv4 or IPv6 address and passes the value of FullyQualifiedDomainName in the Host header for all health checks except TCP health checks. This is typically the fully qualified DNS name of the endpoint on which you want Route 53 to perform health checks.

When Route 53 checks the health of an endpoint, here is how it constructs the Host header:

  • If you specify a value of 80 for Port and HTTP or HTTP_STR_MATCH for Type, Route 53 passes the value of FullyQualifiedDomainName to the endpoint in the Host header.
  • If you specify a value of 443 for Port and HTTPS or HTTPS_STR_MATCH for Type, Route 53 passes the value of FullyQualifiedDomainName to the endpoint in the Host header.
  • If you specify another value for Port and any value except TCP for Type, Route 53 passes FullyQualifiedDomainName:Port to the endpoint in the Host header.

If you don't specify a value for FullyQualifiedDomainName, Route 53 substitutes the value of IPAddress in the Host header in each of the preceding cases.

If you don't specify a value for IPAddress:

Route 53 sends a DNS request to the domain that you specify for FullyQualifiedDomainName at the interval that you specify for RequestInterval. Using an IPv4 address that DNS returns, Route 53 then checks the health of the endpoint.

If you don't specify a value for IPAddress, Route 53 uses only IPv4 to send health checks to the endpoint. If there's no resource record set with a type of A for the name that you specify for FullyQualifiedDomainName, the health check fails with a "DNS resolution failed" error.

If you want to check the health of weighted, latency, or failover resource record sets and you choose to specify the endpoint only by FullyQualifiedDomainName, we recommend that you create a separate health check for each endpoint. For example, create a health check for each HTTP server that is serving content for www.example.com. For the value of FullyQualifiedDomainName, specify the domain name of the server (such as us-east-2-www.example.com), not the name of the resource record sets (www.example.com).

In this configuration, if you create a health check for which the value of FullyQualifiedDomainName matches the name of the resource record sets and you then associate the health check with those resource record sets, health check results will be unpredictable.

In addition, if the value that you specify for Type is HTTP, HTTPS, HTTP_STR_MATCH, or HTTPS_STR_MATCH, Route 53 passes the value of FullyQualifiedDomainName in the Host header, as it does when you specify a value for IPAddress. If the value of Type is TCP, Route 53 doesn't pass a Host header.

healthCheckConfig_childHealthChecks :: Lens' HealthCheckConfig (Maybe [Text]) Source #

(CALCULATED Health Checks Only) A complex type that contains one ChildHealthCheck element for each health check that you want to associate with a CALCULATED health check.

healthCheckConfig_routingControlArn :: Lens' HealthCheckConfig (Maybe Text) Source #

The Amazon Resource Name (ARN) for the Route 53 Application Recovery Controller routing control.

For more information about Route 53 Application Recovery Controller, see Route 53 Application Recovery Controller Developer Guide..

healthCheckConfig_requestInterval :: Lens' HealthCheckConfig (Maybe Natural) Source #

The number of seconds between the time that Amazon Route 53 gets a response from your endpoint and the time that it sends the next health check request. Each Route 53 health checker makes requests at this interval.

You can't change the value of RequestInterval after you create a health check.

If you don't specify a value for RequestInterval, the default value is 30 seconds.

healthCheckConfig_port :: Lens' HealthCheckConfig (Maybe Natural) Source #

The port on the endpoint that you want Amazon Route 53 to perform health checks on.

Don't specify a value for Port when you specify a value for Type of CLOUDWATCH_METRIC or CALCULATED.

healthCheckConfig_type :: Lens' HealthCheckConfig HealthCheckType Source #

The type of health check that you want to create, which indicates how Amazon Route 53 determines whether an endpoint is healthy.

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.

    If you specify HTTPS for the value of Type, the endpoint must support TLS v1.0 or later.

  • HTTP_STR_MATCH: Route 53 tries to establish a TCP connection. If successful, Route 53 submits an HTTP request and searches the first 5,120 bytes of the response body for the string that you specify in SearchString.
  • HTTPS_STR_MATCH: Route 53 tries to establish a TCP connection. If successful, Route 53 submits an HTTPS request and searches the first 5,120 bytes of the response body for the string that you specify in SearchString.
  • TCP: Route 53 tries to establish a TCP connection.
  • CLOUDWATCH_METRIC: The health check is associated with a CloudWatch alarm. If the state of the alarm is OK, the health check is considered healthy. If the state is ALARM, the health check is considered unhealthy. If CloudWatch doesn't have sufficient data to determine whether the state is OK or ALARM, the health check status depends on the setting for InsufficientDataHealthStatus: Healthy, Unhealthy, or LastKnownStatus.
  • CALCULATED: For health checks that monitor the status of other health checks, Route 53 adds up the number of health checks that Route 53 health checkers consider to be healthy and compares that number with the value of HealthThreshold.
  • RECOVERY_CONTROL: The health check is assocated with a Route53 Application Recovery Controller routing control. If the routing control state is ON, the health check is considered healthy. If the state is OFF, the health check is considered unhealthy.

For more information, see How Route 53 Determines Whether an Endpoint Is Healthy in the Amazon Route 53 Developer Guide.

HealthCheckObservation

healthCheckObservation_iPAddress :: Lens' HealthCheckObservation (Maybe Text) Source #

The IP address of the Amazon Route 53 health checker that provided the failure reason in StatusReport.

healthCheckObservation_statusReport :: Lens' HealthCheckObservation (Maybe StatusReport) Source #

A complex type that contains the last failure reason as reported by one Amazon Route 53 health checker and the time of the failed health check.

healthCheckObservation_region :: Lens' HealthCheckObservation (Maybe HealthCheckRegion) Source #

The region of the Amazon Route 53 health checker that provided the status in StatusReport.

HostedZone

hostedZone_linkedService :: Lens' HostedZone (Maybe LinkedService) Source #

If the hosted zone was created by another service, the service that created the hosted zone. When a hosted zone is created by another service, you can't edit or delete it using Route 53.

hostedZone_config :: Lens' HostedZone (Maybe HostedZoneConfig) Source #

A complex type that includes the Comment and PrivateZone elements. If you omitted the HostedZoneConfig and Comment elements from the request, the Config and Comment elements don't appear in the response.

hostedZone_resourceRecordSetCount :: Lens' HostedZone (Maybe Integer) Source #

The number of resource record sets in the hosted zone.

hostedZone_id :: Lens' HostedZone ResourceId Source #

The ID that Amazon Route 53 assigned to the hosted zone when you created it.

hostedZone_name :: Lens' HostedZone Text Source #

The name of the domain. For public hosted zones, this is the name that you have registered with your DNS registrar.

For information about how to specify characters other than a-z, 0-9, and - (hyphen) and how to specify internationalized domain names, see CreateHostedZone.

hostedZone_callerReference :: Lens' HostedZone Text Source #

The value that you specified for CallerReference when you created the hosted zone.

HostedZoneConfig

hostedZoneConfig_privateZone :: Lens' HostedZoneConfig (Maybe Bool) Source #

A value that indicates whether this is a private hosted zone.

hostedZoneConfig_comment :: Lens' HostedZoneConfig (Maybe Text) Source #

Any comments that you want to include about the hosted zone.

HostedZoneLimit

hostedZoneLimit_type :: Lens' HostedZoneLimit HostedZoneLimitType Source #

The limit that you requested. Valid values include the following:

  • MAX_RRSETS_BY_ZONE: The maximum number of records that you can create in the specified hosted zone.
  • MAX_VPCS_ASSOCIATED_BY_ZONE: The maximum number of Amazon VPCs that you can associate with the specified private hosted zone.

hostedZoneLimit_value :: Lens' HostedZoneLimit Natural Source #

The current value for the limit that is specified by Type.

HostedZoneOwner

hostedZoneOwner_owningAccount :: Lens' HostedZoneOwner (Maybe Text) Source #

If the hosted zone was created by an Amazon Web Services account, or was created by an Amazon Web Services service that creates hosted zones using the current account, OwningAccount contains the account ID of that account. For example, when you use Cloud Map to create a hosted zone, Cloud Map creates the hosted zone using the current Amazon Web Services account.

hostedZoneOwner_owningService :: Lens' HostedZoneOwner (Maybe Text) Source #

If an Amazon Web Services service uses its own account to create a hosted zone and associate the specified VPC with that hosted zone, OwningService contains an abbreviation that identifies the service. For example, if Amazon Elastic File System (Amazon EFS) created a hosted zone and associated a VPC with the hosted zone, the value of OwningService is efs.amazonaws.com.

HostedZoneSummary

hostedZoneSummary_hostedZoneId :: Lens' HostedZoneSummary ResourceId Source #

The Route 53 hosted zone ID of a private hosted zone that the specified VPC is associated with.

hostedZoneSummary_name :: Lens' HostedZoneSummary Text Source #

The name of the private hosted zone, such as example.com.

hostedZoneSummary_owner :: Lens' HostedZoneSummary HostedZoneOwner Source #

The owner of a private hosted zone that the specified VPC is associated with. The owner can be either an Amazon Web Services account or an Amazon Web Services service.

KeySigningKey

keySigningKey_status :: Lens' KeySigningKey (Maybe Text) Source #

A string that represents the current key-signing key (KSK) status.

Status can have one of the following values:

ACTIVE
The KSK is being used for signing.
INACTIVE
The KSK is not being used for signing.
DELETING
The KSK is in the process of being deleted.
ACTION_NEEDED
There is a problem with the KSK that requires you to take action to resolve. For example, the customer managed customer master key (CMK) might have been deleted, or the permissions for the customer managed CMK might have been changed.
INTERNAL_FAILURE
There was an error during a request. Before you can continue to work with DNSSEC signing, including actions that involve this KSK, you must correct the problem. For example, you may need to activate or deactivate the KSK.

keySigningKey_signingAlgorithmMnemonic :: Lens' KeySigningKey (Maybe Text) Source #

A string used to represent the signing algorithm. This value must follow the guidelines provided by RFC-8624 Section 3.1.

keySigningKey_digestAlgorithmMnemonic :: Lens' KeySigningKey (Maybe Text) Source #

A string used to represent the delegation signer digest algorithm. This value must follow the guidelines provided by RFC-8624 Section 3.3.

keySigningKey_lastModifiedDate :: Lens' KeySigningKey (Maybe UTCTime) Source #

The last time that the key-signing key (KSK) was changed.

keySigningKey_keyTag :: Lens' KeySigningKey (Maybe Natural) Source #

An integer used to identify the DNSSEC record for the domain name. The process used to calculate the value is described in RFC-4034 Appendix B.

keySigningKey_dNSKEYRecord :: Lens' KeySigningKey (Maybe Text) Source #

A string that represents a DNSKEY record.

keySigningKey_publicKey :: Lens' KeySigningKey (Maybe Text) Source #

The public key, represented as a Base64 encoding, as required by RFC-4034 Page 5.

keySigningKey_signingAlgorithmType :: Lens' KeySigningKey (Maybe Int) Source #

An integer used to represent the signing algorithm. This value must follow the guidelines provided by RFC-8624 Section 3.1.

keySigningKey_createdDate :: Lens' KeySigningKey (Maybe UTCTime) Source #

The date when the key-signing key (KSK) was created.

keySigningKey_flag :: Lens' KeySigningKey (Maybe Int) Source #

An integer that specifies how the key is used. For key-signing key (KSK), this value is always 257.

keySigningKey_digestAlgorithmType :: Lens' KeySigningKey (Maybe Int) Source #

An integer used to represent the delegation signer digest algorithm. This value must follow the guidelines provided by RFC-8624 Section 3.3.

keySigningKey_statusMessage :: Lens' KeySigningKey (Maybe Text) Source #

The status message provided for the following key-signing key (KSK) statuses: ACTION_NEEDED or INTERNAL_FAILURE. The status message includes information about what the problem might be and steps that you can take to correct the issue.

keySigningKey_name :: Lens' KeySigningKey (Maybe Text) Source #

A string used to identify a key-signing key (KSK). Name can include numbers, letters, and underscores (_). Name must be unique for each key-signing key in the same hosted zone.

keySigningKey_dSRecord :: Lens' KeySigningKey (Maybe Text) Source #

A string that represents a delegation signer (DS) record.

keySigningKey_kmsArn :: Lens' KeySigningKey (Maybe Text) Source #

The Amazon resource name (ARN) used to identify the customer managed customer master key (CMK) in Key Management Service (KMS). The KmsArn must be unique for each key-signing key (KSK) in a single hosted zone.

You must configure the CMK as follows:

Status
Enabled
Key spec
ECC_NIST_P256
Key usage
Sign and verify
Key policy
The key policy must give permission for the following actions:
  • DescribeKey
  • GetPublicKey
  • Sign

The key policy must also include the Amazon Route 53 service in the principal for your account. Specify the following:

  • "Service": "dnssec-route53.amazonaws.com"

For more information about working with the customer managed CMK in KMS, see Key Management Service concepts.

keySigningKey_digestValue :: Lens' KeySigningKey (Maybe Text) Source #

A cryptographic digest of a DNSKEY resource record (RR). DNSKEY records are used to publish the public key that resolvers can use to verify DNSSEC signatures that are used to secure certain kinds of information provided by the DNS system.

LinkedService

linkedService_servicePrincipal :: Lens' LinkedService (Maybe Text) Source #

If the health check or hosted zone was created by another service, the service that created the resource. When a resource is created by another service, you can't edit or delete it using Amazon Route 53.

linkedService_description :: Lens' LinkedService (Maybe Text) Source #

If the health check or hosted zone was created by another service, an optional description that can be provided by the other service. When a resource is created by another service, you can't edit or delete it using Amazon Route 53.

QueryLoggingConfig

queryLoggingConfig_id :: Lens' QueryLoggingConfig Text Source #

The ID for a configuration for DNS query logging.

queryLoggingConfig_hostedZoneId :: Lens' QueryLoggingConfig ResourceId Source #

The ID of the hosted zone that CloudWatch Logs is logging queries for.

queryLoggingConfig_cloudWatchLogsLogGroupArn :: Lens' QueryLoggingConfig Text Source #

The Amazon Resource Name (ARN) of the CloudWatch Logs log group that Amazon Route 53 is publishing logs to.

ResourceRecord

resourceRecord_value :: Lens' ResourceRecord Text Source #

The current or new DNS record value, not to exceed 4,000 characters. In the case of a DELETE action, if the current value does not match the actual value, an error is returned. For descriptions about how to format Value for different record types, see Supported DNS Resource Record Types in the Amazon Route 53 Developer Guide.

You can specify more than one value for all record types except CNAME and SOA.

If you're creating an alias resource record set, omit Value.

ResourceRecordSet

resourceRecordSet_ttl :: Lens' ResourceRecordSet (Maybe Natural) Source #

The resource record cache time to live (TTL), in seconds. Note the following:

  • If you're creating or updating an alias resource record set, omit TTL. Amazon Route 53 uses the value of TTL for the alias target.
  • If you're associating this resource record set with a health check (if you're adding a HealthCheckId element), we recommend that you specify a TTL of 60 seconds or less so clients respond quickly to changes in health status.
  • All of the resource record sets in a group of weighted resource record sets must have the same value for TTL.
  • If a group of weighted resource record sets includes one or more weighted alias resource record sets for which the alias target is an ELB load balancer, we recommend that you specify a TTL of 60 seconds for all of the non-alias weighted resource record sets that have the same name and type. Values other than 60 seconds (the TTL for load balancers) will change the effect of the values that you specify for Weight.

resourceRecordSet_resourceRecords :: Lens' ResourceRecordSet (Maybe (NonEmpty ResourceRecord)) Source #

Information about the resource records to act upon.

If you're creating an alias resource record set, omit ResourceRecords.

resourceRecordSet_aliasTarget :: Lens' ResourceRecordSet (Maybe AliasTarget) Source #

Alias resource record sets only: Information about the Amazon Web Services resource, such as a CloudFront distribution or an Amazon S3 bucket, that you want to route traffic to.

If you're creating resource records sets for a private hosted zone, note the following:

  • You can't create an alias resource record set in a private hosted zone to route traffic to a CloudFront distribution.
  • Creating geolocation alias resource record sets or latency alias resource record sets in a private hosted zone is unsupported.
  • For information about creating failover resource record sets in a private hosted zone, see Configuring Failover in a Private Hosted Zone in the Amazon Route 53 Developer Guide.

resourceRecordSet_weight :: Lens' ResourceRecordSet (Maybe Natural) Source #

Weighted resource record sets only: Among resource record sets that have the same combination of DNS name and type, a value that determines the proportion of DNS queries that Amazon Route 53 responds to using the current resource record set. Route 53 calculates the sum of the weights for the resource record sets that have the same combination of DNS name and type. Route 53 then responds to queries based on the ratio of a resource's weight to the total. Note the following:

  • You must specify a value for the Weight element for every weighted resource record set.
  • You can only specify one ResourceRecord per weighted resource record set.
  • You can't create latency, failover, or geolocation resource record sets that have the same values for the Name and Type elements as weighted resource record sets.
  • You can create a maximum of 100 weighted resource record sets that have the same values for the Name and Type elements.
  • For weighted (but not weighted alias) resource record sets, if you set Weight to 0 for a resource record set, Route 53 never responds to queries with the applicable value for that resource record set. However, if you set Weight to 0 for all resource record sets that have the same combination of DNS name and type, traffic is routed to all resources with equal probability.

    The effect of setting Weight to 0 is different when you associate health checks with weighted resource record sets. For more information, see Options for Configuring Route 53 Active-Active and Active-Passive Failover in the Amazon Route 53 Developer Guide.

resourceRecordSet_trafficPolicyInstanceId :: Lens' ResourceRecordSet (Maybe Text) Source #

When you create a traffic policy instance, Amazon Route 53 automatically creates a resource record set. TrafficPolicyInstanceId is the ID of the traffic policy instance that Route 53 created this resource record set for.

To delete the resource record set that is associated with a traffic policy instance, use DeleteTrafficPolicyInstance. Route 53 will delete the resource record set automatically. If you delete the resource record set by using ChangeResourceRecordSets, Route 53 doesn't automatically delete the traffic policy instance, and you'll continue to be charged for it even though it's no longer in use.

resourceRecordSet_setIdentifier :: Lens' ResourceRecordSet (Maybe Text) Source #

Resource record sets that have a routing policy other than simple: An identifier that differentiates among multiple resource record sets that have the same combination of name and type, such as multiple weighted resource record sets named acme.example.com that have a type of A. In a group of resource record sets that have the same name and type, the value of SetIdentifier must be unique for each resource record set.

For information about routing policies, see Choosing a Routing Policy in the Amazon Route 53 Developer Guide.

resourceRecordSet_failover :: Lens' ResourceRecordSet (Maybe ResourceRecordSetFailover) Source #

Failover resource record sets only: To configure failover, you add the Failover element to two resource record sets. For one resource record set, you specify PRIMARY as the value for Failover; for the other resource record set, you specify SECONDARY. In addition, you include the HealthCheckId element and specify the health check that you want Amazon Route 53 to perform for each resource record set.

Except where noted, the following failover behaviors assume that you have included the HealthCheckId element in both resource record sets:

  • When the primary resource record set is healthy, Route 53 responds to DNS queries with the applicable value from the primary resource record set regardless of the health of the secondary resource record set.
  • When the primary resource record set is unhealthy and the secondary resource record set is healthy, Route 53 responds to DNS queries with the applicable value from the secondary resource record set.
  • When the secondary resource record set is unhealthy, Route 53 responds to DNS queries with the applicable value from the primary resource record set regardless of the health of the primary resource record set.
  • If you omit the HealthCheckId element for the secondary resource record set, and if the primary resource record set is unhealthy, Route 53 always responds to DNS queries with the applicable value from the secondary resource record set. This is true regardless of the health of the associated endpoint.

You can't create non-failover resource record sets that have the same values for the Name and Type elements as failover resource record sets.

For failover alias resource record sets, you must also include the EvaluateTargetHealth element and set the value to true.

For more information about configuring failover for Route 53, see the following topics in the Amazon Route 53 Developer Guide:

resourceRecordSet_healthCheckId :: Lens' ResourceRecordSet (Maybe Text) Source #

If you want Amazon Route 53 to return this resource record set in response to a DNS query only when the status of a health check is healthy, include the HealthCheckId element and specify the ID of the applicable health check.

Route 53 determines whether a resource record set is healthy based on one of the following:

  • By periodically sending a request to the endpoint that is specified in the health check
  • By aggregating the status of a specified group of health checks (calculated health checks)
  • By determining the current state of a CloudWatch alarm (CloudWatch metric health checks)

Route 53 doesn't check the health of the endpoint that is specified in the resource record set, for example, the endpoint specified by the IP address in the Value element. When you add a HealthCheckId element to a resource record set, Route 53 checks the health of the endpoint that you specified in the health check.

For more information, see the following topics in the /Amazon Route 53 Developer Guide/:

When to Specify HealthCheckId

Specifying a value for HealthCheckId is useful only when Route 53 is choosing between two or more resource record sets to respond to a DNS query, and you want Route 53 to base the choice in part on the status of a health check. Configuring health checks makes sense only in the following configurations:

  • Non-alias resource record sets: You're checking the health of a group of non-alias resource record sets that have the same routing policy, name, and type (such as multiple weighted records named www.example.com with a type of A) and you specify health check IDs for all the resource record sets.

    If the health check status for a resource record set is healthy, Route 53 includes the record among the records that it responds to DNS queries with.

    If the health check status for a resource record set is unhealthy, Route 53 stops responding to DNS queries using the value for that resource record set.

    If the health check status for all resource record sets in the group is unhealthy, Route 53 considers all resource record sets in the group healthy and responds to DNS queries accordingly.

  • Alias resource record sets: You specify the following settings:

    • You set EvaluateTargetHealth to true for an alias resource record set in a group of resource record sets that have the same routing policy, name, and type (such as multiple weighted records named www.example.com with a type of A).
    • You configure the alias resource record set to route traffic to a non-alias resource record set in the same hosted zone.
    • You specify a health check ID for the non-alias resource record set.

    If the health check status is healthy, Route 53 considers the alias resource record set to be healthy and includes the alias record among the records that it responds to DNS queries with.

    If the health check status is unhealthy, Route 53 stops responding to DNS queries using the alias resource record set.

    The alias resource record set can also route traffic to a group of non-alias resource record sets that have the same routing policy, name, and type. In that configuration, associate health checks with all of the resource record sets in the group of non-alias resource record sets.

Geolocation Routing

For geolocation resource record sets, if an endpoint is unhealthy, Route 53 looks for a resource record set for the larger, associated geographic region. For example, suppose you have resource record sets for a state in the United States, for the entire United States, for North America, and a resource record set that has * for CountryCode is *, which applies to all locations. If the endpoint for the state resource record set is unhealthy, Route 53 checks for healthy resource record sets in the following order until it finds a resource record set for which the endpoint is healthy:

  • The United States
  • North America
  • The default resource record set

Specifying the Health Check Endpoint by Domain Name

If your health checks specify the endpoint only by domain name, we recommend that you create a separate health check for each endpoint. For example, create a health check for each HTTP server that is serving content for www.example.com. For the value of FullyQualifiedDomainName, specify the domain name of the server (such as us-east-2-www.example.com), not the name of the resource record sets (www.example.com).

Health check results will be unpredictable if you do the following:

  • Create a health check that has the same value for FullyQualifiedDomainName as the name of a resource record set.
  • Associate that health check with the resource record set.

resourceRecordSet_region :: Lens' ResourceRecordSet (Maybe Region) Source #

Latency-based resource record sets only: The Amazon EC2 Region where you created the resource that this resource record set refers to. The resource typically is an Amazon Web Services resource, such as an EC2 instance or an ELB load balancer, and is referred to by an IP address or a DNS domain name, depending on the record type.

Although creating latency and latency alias resource record sets in a private hosted zone is allowed, it's not supported.

When Amazon Route 53 receives a DNS query for a domain name and type for which you have created latency resource record sets, Route 53 selects the latency resource record set that has the lowest latency between the end user and the associated Amazon EC2 Region. Route 53 then returns the value that is associated with the selected resource record set.

Note the following:

  • You can only specify one ResourceRecord per latency resource record set.
  • You can only create one latency resource record set for each Amazon EC2 Region.
  • You aren't required to create latency resource record sets for all Amazon EC2 Regions. Route 53 will choose the region with the best latency from among the regions that you create latency resource record sets for.
  • You can't create non-latency resource record sets that have the same values for the Name and Type elements as latency resource record sets.

resourceRecordSet_geoLocation :: Lens' ResourceRecordSet (Maybe GeoLocation) Source #

Geolocation resource record sets only: A complex type that lets you control how Amazon Route 53 responds to DNS queries based on the geographic origin of the query. For example, if you want all queries from Africa to be routed to a web server with an IP address of 192.0.2.111, create a resource record set with a Type of A and a ContinentCode of AF.

Although creating geolocation and geolocation alias resource record sets in a private hosted zone is allowed, it's not supported.

If you create separate resource record sets for overlapping geographic regions (for example, one resource record set for a continent and one for a country on the same continent), priority goes to the smallest geographic region. This allows you to route most queries for a continent to one resource and to route queries for a country on that continent to a different resource.

You can't create two geolocation resource record sets that specify the same geographic location.

The value * in the CountryCode element matches all geographic locations that aren't specified in other geolocation resource record sets that have the same values for the Name and Type elements.

Geolocation works by mapping IP addresses to locations. However, some IP addresses aren't mapped to geographic locations, so even if you create geolocation resource record sets that cover all seven continents, Route 53 will receive some DNS queries from locations that it can't identify. We recommend that you create a resource record set for which the value of CountryCode is *. Two groups of queries are routed to the resource that you specify in this record: queries that come from locations for which you haven't created geolocation resource record sets and queries from IP addresses that aren't mapped to a location. If you don't create a * resource record set, Route 53 returns a "no answer" response for queries from those locations.

You can't create non-geolocation resource record sets that have the same values for the Name and Type elements as geolocation resource record sets.

resourceRecordSet_multiValueAnswer :: Lens' ResourceRecordSet (Maybe Bool) Source #

Multivalue answer resource record sets only: To route traffic approximately randomly to multiple resources, such as web servers, create one multivalue answer record for each resource and specify true for MultiValueAnswer. Note the following:

  • If you associate a health check with a multivalue answer resource record set, Amazon Route 53 responds to DNS queries with the corresponding IP address only when the health check is healthy.
  • If you don't associate a health check with a multivalue answer record, Route 53 always considers the record to be healthy.
  • Route 53 responds to DNS queries with up to eight healthy records; if you have eight or fewer healthy records, Route 53 responds to all DNS queries with all the healthy records.
  • If you have more than eight healthy records, Route 53 responds to different DNS resolvers with different combinations of healthy records.
  • When all records are unhealthy, Route 53 responds to DNS queries with up to eight unhealthy records.
  • If a resource becomes unavailable after a resolver caches a response, client software typically tries another of the IP addresses in the response.

You can't create multivalue answer alias records.

resourceRecordSet_name :: Lens' ResourceRecordSet Text Source #

For ChangeResourceRecordSets requests, the name of the record that you want to create, update, or delete. For ListResourceRecordSets responses, the name of a record in the specified hosted zone.

ChangeResourceRecordSets Only

Enter a fully qualified domain name, for example, www.example.com. You can optionally include a trailing dot. If you omit the trailing dot, Amazon Route 53 assumes that the domain name that you specify is fully qualified. This means that Route 53 treats www.example.com (without a trailing dot) and www.example.com. (with a trailing dot) as identical.

For information about how to specify characters other than a-z, 0-9, and - (hyphen) and how to specify internationalized domain names, see DNS Domain Name Format in the Amazon Route 53 Developer Guide.

You can use the asterisk (*) wildcard to replace the leftmost label in a domain name, for example, *.example.com. Note the following:

  • The * must replace the entire label. For example, you can't specify *prod.example.com or prod*.example.com.
  • The * can't replace any of the middle labels, for example, marketing.*.example.com.
  • If you include * in any position other than the leftmost label in a domain name, DNS treats it as an * character (ASCII 42), not as a wildcard.

    You can't use the * wildcard for resource records sets that have a type of NS.

You can use the * wildcard as the leftmost label in a domain name, for example, *.example.com. You can't use an * for one of the middle labels, for example, marketing.*.example.com. In addition, the * must replace the entire label; for example, you can't specify prod*.example.com.

resourceRecordSet_type :: Lens' ResourceRecordSet RRType Source #

The DNS record type. For information about different record types and how data is encoded for them, see Supported DNS Resource Record Types in the Amazon Route 53 Developer Guide.

Valid values for basic resource record sets: A | AAAA | CAA | CNAME | DS |MX | NAPTR | NS | PTR | SOA | SPF | SRV | TXT

Values for weighted, latency, geolocation, and failover resource record sets: A | AAAA | CAA | CNAME | MX | NAPTR | PTR | SPF | SRV | TXT. When creating a group of weighted, latency, geolocation, or failover resource record sets, specify the same value for all of the resource record sets in the group.

Valid values for multivalue answer resource record sets: A | AAAA | MX | NAPTR | PTR | SPF | SRV | TXT

SPF records were formerly used to verify the identity of the sender of email messages. However, we no longer recommend that you create resource record sets for which the value of Type is SPF. RFC 7208, /Sender Policy Framework (SPF) for Authorizing Use of Domains in Email, Version 1/, has been updated to say, "...[I]ts existence and mechanism defined in [RFC4408] have led to some interoperability issues. Accordingly, its use is no longer appropriate for SPF version 1; implementations are not to use it." In RFC 7208, see section 14.1, The SPF DNS Record Type.

Values for alias resource record sets:

  • Amazon API Gateway custom regional APIs and edge-optimized APIs: A
  • CloudFront distributions: A

    If IPv6 is enabled for the distribution, create two resource record sets to route traffic to your distribution, one with a value of A and one with a value of AAAA.

  • __Amazon API Gateway environment that has a regionalized subdomain__: A
  • ELB load balancers: A | AAAA
  • Amazon S3 buckets: A
  • Amazon Virtual Private Cloud interface VPC endpoints A
  • Another resource record set in this hosted zone: Specify the type of the resource record set that you're creating the alias for. All values are supported except NS and SOA.

    If you're creating an alias record that has the same name as the hosted zone (known as the zone apex), you can't route traffic to a record for which the value of Type is CNAME. This is because the alias record must have the same type as the record you're routing traffic to, and creating a CNAME record for the zone apex isn't supported even for an alias record.

ResourceTagSet

resourceTagSet_resourceId :: Lens' ResourceTagSet (Maybe Text) Source #

The ID for the specified resource.

resourceTagSet_resourceType :: Lens' ResourceTagSet (Maybe TagResourceType) Source #

The type of the resource.

  • The resource type for health checks is healthcheck.
  • The resource type for hosted zones is hostedzone.

resourceTagSet_tags :: Lens' ResourceTagSet (Maybe (NonEmpty Tag)) Source #

The tags associated with the specified resource.

ReusableDelegationSetLimit

reusableDelegationSetLimit_type :: Lens' ReusableDelegationSetLimit ReusableDelegationSetLimitType Source #

The limit that you requested: MAX_ZONES_BY_REUSABLE_DELEGATION_SET, the maximum number of hosted zones that you can associate with the specified reusable delegation set.

reusableDelegationSetLimit_value :: Lens' ReusableDelegationSetLimit Natural Source #

The current value for the MAX_ZONES_BY_REUSABLE_DELEGATION_SET limit.

StatusReport

statusReport_status :: Lens' StatusReport (Maybe Text) Source #

A description of the status of the health check endpoint as reported by one of the Amazon Route 53 health checkers.

statusReport_checkedTime :: Lens' StatusReport (Maybe UTCTime) Source #

The date and time that the health checker performed the health check in ISO 8601 format and Coordinated Universal Time (UTC). For example, the value 2017-03-27T17:48:16.751Z represents March 27, 2017 at 17:48:16.751 UTC.

Tag

tag_value :: Lens' Tag (Maybe Text) Source #

The value of Value depends on the operation that you want to perform:

  • Add a tag to a health check or hosted zone: Value is the value that you want to give the new tag.
  • Edit a tag: Value is the new value that you want to assign the tag.

tag_key :: Lens' Tag (Maybe Text) Source #

The value of Key depends on the operation that you want to perform:

  • Add a tag to a health check or hosted zone: Key is the name that you want to give the new tag.
  • Edit a tag: Key is the name of the tag that you want to change the Value for.
  • Delete a key: Key is the name of the tag you want to remove.
  • Give a name to a health check: Edit the default Name tag. In the Amazon Route 53 console, the list of your health checks includes a Name column that lets you see the name that you've given to each health check.

TrafficPolicy

trafficPolicy_comment :: Lens' TrafficPolicy (Maybe Text) Source #

The comment that you specify in the CreateTrafficPolicy request, if any.

trafficPolicy_id :: Lens' TrafficPolicy Text Source #

The ID that Amazon Route 53 assigned to a traffic policy when you created it.

trafficPolicy_version :: Lens' TrafficPolicy Natural Source #

The version number that Amazon Route 53 assigns to a traffic policy. For a new traffic policy, the value of Version is always 1.

trafficPolicy_name :: Lens' TrafficPolicy Text Source #

The name that you specified when you created the traffic policy.

trafficPolicy_type :: Lens' TrafficPolicy RRType Source #

The DNS type of the resource record sets that Amazon Route 53 creates when you use a traffic policy to create a traffic policy instance.

trafficPolicy_document :: Lens' TrafficPolicy Text Source #

The definition of a traffic policy in JSON format. You specify the JSON document to use for a new traffic policy in the CreateTrafficPolicy request. For more information about the JSON format, see Traffic Policy Document Format.

TrafficPolicyInstance

trafficPolicyInstance_id :: Lens' TrafficPolicyInstance Text Source #

The ID that Amazon Route 53 assigned to the new traffic policy instance.

trafficPolicyInstance_hostedZoneId :: Lens' TrafficPolicyInstance ResourceId Source #

The ID of the hosted zone that Amazon Route 53 created resource record sets in.

trafficPolicyInstance_name :: Lens' TrafficPolicyInstance Text Source #

The DNS name, such as www.example.com, for which Amazon Route 53 responds to queries by using the resource record sets that are associated with this traffic policy instance.

trafficPolicyInstance_ttl :: Lens' TrafficPolicyInstance Natural Source #

The TTL that Amazon Route 53 assigned to all of the resource record sets that it created in the specified hosted zone.

trafficPolicyInstance_state :: Lens' TrafficPolicyInstance Text Source #

The value of State is one of the following values:

Applied
Amazon Route 53 has finished creating resource record sets, and changes have propagated to all Route 53 edge locations.
Creating
Route 53 is creating the resource record sets. Use GetTrafficPolicyInstance to confirm that the CreateTrafficPolicyInstance request completed successfully.
Failed
Route 53 wasn't able to create or update the resource record sets. When the value of State is Failed, see Message for an explanation of what caused the request to fail.

trafficPolicyInstance_message :: Lens' TrafficPolicyInstance Text Source #

If State is Failed, an explanation of the reason for the failure. If State is another value, Message is empty.

trafficPolicyInstance_trafficPolicyId :: Lens' TrafficPolicyInstance Text Source #

The ID of the traffic policy that Amazon Route 53 used to create resource record sets in the specified hosted zone.

trafficPolicyInstance_trafficPolicyVersion :: Lens' TrafficPolicyInstance Natural Source #

The version of the traffic policy that Amazon Route 53 used to create resource record sets in the specified hosted zone.

trafficPolicyInstance_trafficPolicyType :: Lens' TrafficPolicyInstance RRType Source #

The DNS type that Amazon Route 53 assigned to all of the resource record sets that it created for this traffic policy instance.

TrafficPolicySummary

trafficPolicySummary_id :: Lens' TrafficPolicySummary Text Source #

The ID that Amazon Route 53 assigned to the traffic policy when you created it.

trafficPolicySummary_name :: Lens' TrafficPolicySummary Text Source #

The name that you specified for the traffic policy when you created it.

trafficPolicySummary_type :: Lens' TrafficPolicySummary RRType Source #

The DNS type of the resource record sets that Amazon Route 53 creates when you use a traffic policy to create a traffic policy instance.

trafficPolicySummary_latestVersion :: Lens' TrafficPolicySummary Natural Source #

The version number of the latest version of the traffic policy.

trafficPolicySummary_trafficPolicyCount :: Lens' TrafficPolicySummary Natural Source #

The number of traffic policies that are associated with the current Amazon Web Services account.

VPC

vpc_vPCRegion :: Lens' VPC (Maybe VPCRegion) Source #

(Private hosted zones only) The region that an Amazon VPC was created in.

vpc_vPCId :: Lens' VPC (Maybe Text) Source #

Undocumented member.