amazonka-route53-1.4.0: Amazon Route 53 SDK.

Copyright(c) 2013-2016 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.Route53.Types

Contents

Description

 

Synopsis

Service Configuration

route53 :: Service Source

API version '2013-04-01' of the Amazon Route 53 SDK configuration.

Errors

_HealthCheckVersionMismatch :: AsError a => Getting (First ServiceError) a ServiceError Source

Prism for HealthCheckVersionMismatch' errors.

_InvalidInput :: AsError a => Getting (First ServiceError) a ServiceError Source

Some value specified in the request is invalid or the XML document is malformed.

_HostedZoneNotEmpty :: AsError a => Getting (First ServiceError) a ServiceError Source

The hosted zone contains resource record sets in addition to the default NS and SOA resource record sets. Before you can delete the hosted zone, you must delete the additional resource record sets.

_InvalidArgument :: AsError a => Getting (First ServiceError) a ServiceError Source

At least one of the specified arguments is invalid.

_TrafficPolicyInstanceAlreadyExists :: AsError a => Getting (First ServiceError) a ServiceError Source

Traffic policy instance with given Id already exists.

_ConflictingTypes :: AsError a => Getting (First ServiceError) a ServiceError Source

You tried to update a traffic policy instance by using a traffic policy version that has a different DNS type than the current type for the instance. You specified the type in the JSON document in the CreateTrafficPolicy or CreateTrafficPolicyVersionrequest.

_ConcurrentModification :: AsError a => Getting (First ServiceError) a ServiceError Source

Another user submitted a request to update the object at the same time that you did. Retry the request.

_DelegationSetAlreadyReusable :: AsError a => Getting (First ServiceError) a ServiceError Source

The specified delegation set has already been marked as reusable.

_PriorRequestNotComplete :: AsError a => Getting (First ServiceError) a ServiceError Source

The request was rejected because Amazon Route 53 was still processing a prior request.

_InvalidChangeBatch :: AsError a => Getting (First ServiceError) a ServiceError Source

This error contains a list of one or more error messages. Each error message indicates one error in the change batch. For more information, see Example InvalidChangeBatch Errors.

_TrafficPolicyAlreadyExists :: AsError a => Getting (First ServiceError) a ServiceError Source

A traffic policy that has the same value for Name already exists.

_InvalidTrafficPolicyDocument :: AsError a => Getting (First ServiceError) a ServiceError Source

The format of the traffic policy document that you specified in the Document element is invalid.

_DelegationSetNotReusable :: AsError a => Getting (First ServiceError) a ServiceError Source

The specified delegation set has not been marked as reusable.

_InvalidDomainName :: AsError a => Getting (First ServiceError) a ServiceError Source

This error indicates that the specified domain name is not valid.

_NoSuchTrafficPolicy :: AsError a => Getting (First ServiceError) a ServiceError Source

No traffic policy exists with the specified ID.

_HostedZoneNotFound :: AsError a => Getting (First ServiceError) a ServiceError Source

The specified HostedZone cannot be found.

_DelegationSetInUse :: AsError a => Getting (First ServiceError) a ServiceError Source

The specified delegation contains associated hosted zones which must be deleted before the reusable delegation set can be deleted.

_NoSuchDelegationSet :: AsError a => Getting (First ServiceError) a ServiceError Source

The specified delegation set does not exist.

_HealthCheckAlreadyExists :: AsError a => Getting (First ServiceError) a ServiceError Source

The health check you are trying to create already exists. Amazon Route 53 returns this error when a health check has already been created with the specified CallerReference.

_TooManyTrafficPolicies :: AsError a => Getting (First ServiceError) a ServiceError Source

You've created the maximum number of traffic policies that can be created for the current AWS account. You can request an increase to the limit on the Contact Us page.

_NoSuchGeoLocation :: AsError a => Getting (First ServiceError) a ServiceError Source

The geo location you are trying to get does not exist.

_DelegationSetNotAvailable :: AsError a => Getting (First ServiceError) a ServiceError Source

Amazon Route 53 allows some duplicate domain names, but there is a maximum number of duplicate names. This error indicates that you have reached that maximum. If you want to create another hosted zone with the same name and Amazon Route 53 generates this error, you can request an increase to the limit on the Contact Us page.

_VPCAssociationNotFound :: AsError a => Getting (First ServiceError) a ServiceError Source

The VPC you specified is not currently associated with the hosted zone.

_ThrottlingException :: AsError a => Getting (First ServiceError) a ServiceError Source

Prism for ThrottlingException' errors.

_NoSuchChange :: AsError a => Getting (First ServiceError) a ServiceError Source

Prism for NoSuchChange' errors.

_LimitsExceeded :: AsError a => Getting (First ServiceError) a ServiceError Source

The limits specified for a resource have been exceeded.

_TooManyTrafficPolicyInstances :: AsError a => Getting (First ServiceError) a ServiceError Source

You've created the maximum number of traffic policy instances that can be created for the current AWS account. You can request an increase to the limit on the Contact Us page.

_NoSuchTrafficPolicyInstance :: AsError a => Getting (First ServiceError) a ServiceError Source

No traffic policy instance exists with the specified ID.

_IncompatibleVersion :: AsError a => Getting (First ServiceError) a ServiceError Source

The resource you are trying to access is unsupported on this Amazon Route 53 endpoint. Please consider using a newer endpoint or a tool that does so.

_PublicZoneVPCAssociation :: AsError a => Getting (First ServiceError) a ServiceError Source

The hosted zone you are trying to associate VPC with doesn't have any VPC association. Amazon Route 53 currently doesn't support associate a VPC with a public hosted zone.

_NoSuchHostedZone :: AsError a => Getting (First ServiceError) a ServiceError Source

Prism for NoSuchHostedZone' errors.

_TooManyHostedZones :: AsError a => Getting (First ServiceError) a ServiceError Source

This error indicates that you've reached the maximum number of hosted zones that can be created for the current AWS account. You can request an increase to the limit on the Contact Us page.

_HealthCheckInUse :: AsError a => Getting (First ServiceError) a ServiceError Source

There are resource records associated with this health check. Before you can delete the health check, you must disassociate it from the resource record sets.

_DelegationSetAlreadyCreated :: AsError a => Getting (First ServiceError) a ServiceError Source

A delegation set with the same owner and caller reference combination has already been created.

_ConflictingDomainExists :: AsError a => Getting (First ServiceError) a ServiceError Source

Prism for ConflictingDomainExists' errors.

_LastVPCAssociation :: AsError a => Getting (First ServiceError) a ServiceError Source

The VPC you are trying to disassociate from the hosted zone is the last the VPC that is associated with the hosted zone. Amazon Route 53 currently doesn't support disassociate the last VPC from the hosted zone.

_TooManyHealthChecks :: AsError a => Getting (First ServiceError) a ServiceError Source

Prism for TooManyHealthChecks' errors.

_NoSuchHealthCheck :: AsError a => Getting (First ServiceError) a ServiceError Source

The health check you are trying to get or delete does not exist.

_TrafficPolicyInUse :: AsError a => Getting (First ServiceError) a ServiceError Source

One or more traffic policy instances were created by using the specified traffic policy.

_InvalidVPCId :: AsError a => Getting (First ServiceError) a ServiceError Source

The hosted zone you are trying to create for your VPC_ID does not belong to you. Amazon Route 53 returns this error when the VPC specified by VPCId does not belong to you.

_HostedZoneAlreadyExists :: AsError a => Getting (First ServiceError) a ServiceError Source

The hosted zone you are trying to create already exists. Amazon Route 53 returns this error when a hosted zone has already been created with the specified CallerReference.

Re-exported Types

data Region :: *

The sum of available AWS regions.

Constructors

Ireland

Europe / eu-west-1

Frankfurt

Europe / eu-central-1

Tokyo

Asia Pacific / ap-northeast-1

Singapore

Asia Pacific / ap-southeast-1

Sydney

Asia Pacific / ap-southeast-2

Beijing

China / cn-north-1

NorthVirginia

US / us-east-1

NorthCalifornia

US / us-west-1

Oregon

US / us-west-2

GovCloud

AWS GovCloud / us-gov-west-1

GovCloudFIPS

AWS GovCloud (FIPS 140-2) S3 Only / fips-us-gov-west-1

SaoPaulo

South America / sa-east-1

Instances

Eq Region 
Data Region 
Ord Region 
Read Region 
Show Region 
Generic Region 
Hashable Region 
ToLog Region 
FromXML Region 
ToXML Region 
ToByteString Region 
FromText Region 
ToText Region 
type Rep Region = D1 D1Region ((:+:) ((:+:) ((:+:) (C1 C1_0Region U1) ((:+:) (C1 C1_1Region U1) (C1 C1_2Region U1))) ((:+:) (C1 C1_3Region U1) ((:+:) (C1 C1_4Region U1) (C1 C1_5Region U1)))) ((:+:) ((:+:) (C1 C1_6Region U1) ((:+:) (C1 C1_7Region U1) (C1 C1_8Region U1))) ((:+:) (C1 C1_9Region U1) ((:+:) (C1 C1_10Region U1) (C1 C1_11Region U1))))) 

ChangeAction

ChangeStatus

Failover

HealthCheckType

RecordType

TagResourceType

VPCRegion

AliasTarget

data AliasTarget Source

Alias resource record sets only: Information about the CloudFront distribution, ELB load balancer, Amazon S3 bucket, or Amazon Route 53 resource record set to which you are routing traffic.

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

  • You can create alias resource record sets only for Amazon Route 53 resource record sets in the same private hosted zone. Creating alias resource record sets for CloudFront distributions, ELB load balancers, and Amazon S3 buckets is not supported.
  • You can't create alias resource record sets for failover, geolocation, or latency resource record sets in a private hosted zone.

For more information and an example, see Example: Creating Alias Resource Record Sets in the Amazon Route 53 API Reference.

See: aliasTarget smart constructor.

aliasTarget Source

Creates a value of AliasTarget with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

atHostedZoneId :: Lens' AliasTarget Text Source

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

  • A CloudFront distribution: Specify Z2FDTNDATAQYW2.
  • An ELB load balancer: Specify the value of the hosted zone ID for the load balancer. You can get the hosted zone ID by using the AWS Management Console, the ELB API, or the AWS CLI. Use the same method to get values for HostedZoneId and DNSName. If you get one value from the console and the other value from the API or the CLI, creating the resource record set will fail.
  • An Amazon S3 bucket that is configured as a static website: Specify the hosted zone ID for the Amazon S3 website endpoint in which you created the bucket. For more information about valid values, see the table Amazon Simple Storage Service (S3) Website Endpoints in the Amazon Web Services General Reference.
  • Another Amazon Route 53 resource record set in your hosted zone: Specify the hosted zone ID of your hosted zone. (An alias resource record set cannot reference a resource record set in a different hosted zone.)

For more information and an example, see Example: Creating Alias Resource Record Sets in the Amazon Route 53 API Reference.

atDNSName :: Lens' AliasTarget Text Source

Alias resource record sets only: The external DNS name associated with the AWS Resource. The value that you specify depends on where you want to route queries:

  • A 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.
  • An ELB load balancer: Specify the DNS name associated with the load balancer. You can get the DNS name by using the AWS Management Console, the ELB API, or the AWS CLI. Use the same method to get values for HostedZoneId and DNSName. If you get one value from the console and the other value from the API or the CLI, creating the resource record set will fail.
  • An Elastic Beanstalk environment: Specify the CNAME attribute for the environment. (The environment must have a regionalized domain name.)
  • An Amazon S3 bucket that is configured as a static website: Specify the domain name of the Amazon S3 website endpoint in which you created the bucket; for example, 's3-website-us-east-1.amazonaws.com'. For more information about valid values, see the table Amazon Simple Storage Service (S3) Website Endpoints in the Amazon Web Services General Reference. For more information about using Amazon S3 buckets for websites, see Hosting a Static Website on Amazon S3 in the Amazon Simple Storage Service Developer Guide.
  • Another Amazon Route 53 resource record set: Specify the value of the Name element for a resource record set in the current hosted zone.

For more information and an example, see Example: Creating Alias Resource Record Sets in the Amazon Route 53 API Reference.

atEvaluateTargetHealth :: Lens' AliasTarget Bool Source

Alias resource record sets only: If you set the value of EvaluateTargetHealth to true for the resource record set or sets in an alias, weighted alias, latency alias, or failover alias resource record set, and if you specify a value for HealthCheckId for every resource record set that is referenced by these alias resource record sets, the alias resource record sets inherit the health of the referenced resource record sets.

In this configuration, when Amazon Route 53 receives a DNS query for an alias resource record set:

  1. Amazon Route 53 looks at the resource record sets that are referenced by the alias resource record sets to determine which health checks they're using.
  2. Amazon Route 53 checks the current status of each health check. (Amazon Route 53 periodically checks the health of the endpoint that is specified in a health check; it doesn't perform the health check when the DNS query arrives.)
  3. Based on the status of the health checks, Amazon Route 53 determines which resource record sets are healthy. Unhealthy resource record sets are immediately removed from consideration. In addition, if all of the resource record sets that are referenced by an alias resource record set are unhealthy, that alias resource record set also is immediately removed from consideration.
  4. Based on the configuration of the alias resource record sets (weighted alias or latency alias, for example) and the configuration of the resource record sets that they reference, Amazon Route 53 chooses a resource record set from the healthy resource record sets, and responds to the query.

Note the following:

  • You cannot set EvaluateTargetHealth to true when the alias target is a CloudFront distribution.
  • If the AWS resource that you specify in AliasTarget is a resource record set or a group of resource record sets (for example, a group of weighted resource record sets), but it is not another alias resource record set, we recommend that you associate a health check with all of the resource record sets in the alias target. For more information, see What Happens When You Omit Health Checks? in the Amazon Route 53 Developer Guide.
  • If you specify an ELB load balancer in AliasTarget, Elastic Load Balancing routes queries only to the healthy Amazon EC2 instances that are registered with the load balancer. If no Amazon EC2 instances are healthy or if the load balancer itself is unhealthy, and if EvaluateTargetHealth is true for the corresponding alias resource record set, Amazon Route 53 routes queries to other resources.
  • When you create a load balancer, you configure settings for Elastic Load Balancing health checks; they're not Amazon Route 53 health checks, but they perform a similar function. Do not create Amazon Route 53 health checks for the Amazon EC2 instances that you register with an ELB load balancer. For more information, see How Health Checks Work in More Complex Amazon Route 53 Configurations in the Amazon Route 53 Developer Guide.

We recommend that you set EvaluateTargetHealth to true only when you have enough idle capacity to handle the failure of one or more endpoints.

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

Change

data Change Source

A complex type that contains the information for each change in a change batch request.

See: change smart constructor.

change Source

Creates a value of Change with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

cAction :: 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 that has the specified values for Name, Type, SetIdentifier (for latency, weighted, geolocation, and failover resource record sets), and TTL (except alias resource record sets, for which the TTL is determined by the AWS resource that you're routing DNS queries to).
  • UPSERT: If a resource record set does not already exist, Amazon Route 53 creates it. If a resource record set does exist, Amazon Route 53 updates it with the values in the request. Amazon Route 53 can update an existing resource record set only when all of the following values match: Name, Type, and SetIdentifier (for weighted, latency, geolocation, and failover resource record sets).

cResourceRecordSet :: Lens' Change ResourceRecordSet Source

Information about the resource record set to create or delete.

ChangeBatch

data ChangeBatch Source

A complex type that contains an optional comment and the changes that you want to make with a change batch request.

See: changeBatch smart constructor.

changeBatch Source

Creates a value of ChangeBatch with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

cbComment :: Lens' ChangeBatch (Maybe Text) Source

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

cbChanges :: Lens' ChangeBatch (NonEmpty Change) Source

A complex type that contains one Change element for each resource record set that you want to create or delete.

ChangeInfo

data ChangeInfo Source

A complex type that describes change 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.

See: changeInfo smart constructor.

changeInfo Source

Creates a value of ChangeInfo with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

ciComment :: Lens' ChangeInfo (Maybe Text) Source

A complex type that describes change 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.

ciId :: Lens' ChangeInfo Text Source

The ID of the request. Use this ID to track when the change has completed across all Amazon Route 53 DNS servers.

ciStatus :: 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.

Valid Values: PENDING | INSYNC

ciSubmittedAt :: Lens' ChangeInfo UTCTime Source

The date and time the change was submitted, in the format 'YYYY-MM-DDThh:mm:ssZ', as specified in the ISO 8601 standard (for example, 2009-11-19T19:37:58Z). The Z after the time indicates that the time is listed in Coordinated Universal Time (UTC).

DelegationSet

delegationSet Source

Creates a value of DelegationSet with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

dsId :: Lens' DelegationSet (Maybe Text) Source

Undocumented member.

dsNameServers :: Lens' DelegationSet (NonEmpty Text) Source

A complex type that contains the authoritative name servers for the hosted zone. Use the method provided by your domain registrar to add an NS record to your domain for each NameServer that is assigned to your hosted zone.

GeoLocation

geoLocation :: GeoLocation Source

Creates a value of GeoLocation with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

glSubdivisionCode :: Lens' GeoLocation (Maybe Text) Source

The code for a country's subdivision (e.g., a province of Canada). A subdivision code is only valid with the appropriate country code.

Constraint: Specifying SubdivisionCode without CountryCode returns an InvalidInput error.

glCountryCode :: Lens' GeoLocation (Maybe Text) Source

The code for a country geo location. The default location uses '*' for the country code and will match all locations that are not matched by a geo location.

The default geo location uses a * for the country code. All other country codes follow the ISO 3166 two-character code.

glContinentCode :: Lens' GeoLocation (Maybe Text) Source

The code for a continent geo location. Note: only continent locations have a continent code.

Valid values: AF | AN | AS | EU | OC | NA | SA

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

GeoLocationDetails

geoLocationDetails :: GeoLocationDetails Source

Creates a value of GeoLocationDetails with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

gldSubdivisionName :: Lens' GeoLocationDetails (Maybe Text) Source

The name of the subdivision. This element is only present if SubdivisionCode is also present.

gldSubdivisionCode :: Lens' GeoLocationDetails (Maybe Text) Source

The code for a country's subdivision (e.g., a province of Canada). A subdivision code is only valid with the appropriate country code.

gldCountryName :: Lens' GeoLocationDetails (Maybe Text) Source

The name of the country. This element is only present if CountryCode is also present.

gldCountryCode :: Lens' GeoLocationDetails (Maybe Text) Source

The code for a country geo location. The default location uses '*' for the country code and will match all locations that are not matched by a geo location.

The default geo location uses a * for the country code. All other country codes follow the ISO 3166 two-character code.

gldContinentCode :: Lens' GeoLocationDetails (Maybe Text) Source

The code for a continent geo location. Note: only continent locations have a continent code.

gldContinentName :: Lens' GeoLocationDetails (Maybe Text) Source

The name of the continent. This element is only present if ContinentCode is also present.

HealthCheck

data HealthCheck Source

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

See: healthCheck smart constructor.

healthCheck Source

Creates a value of HealthCheck with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

hcId :: Lens' HealthCheck Text Source

The ID of the specified health check.

hcCallerReference :: Lens' HealthCheck Text Source

A unique string that identifies the request to create the health check.

hcHealthCheckConfig :: Lens' HealthCheck HealthCheckConfig Source

A complex type that contains the health check configuration.

hcHealthCheckVersion :: 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

hccFailureThreshold :: 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.

Valid values are integers between 1 and 10. For more information, see "How Amazon Route 53 Determines Whether an Endpoint Is Healthy" in the Amazon Route 53 Developer Guide.

hccIPAddress :: Lens' HealthCheckConfig (Maybe Text) Source

IP Address of the instance being checked.

hccEnableSNI :: 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. If you don't specify a value for EnableSNI, Amazon Route 53 defaults to true when Type is HTTPS or HTTPS_STR_MATCH and defaults to false when Type is any other value.

hccSearchString :: Lens' HealthCheckConfig (Maybe Text) Source

A string to search for in the body of a health check response. Required for HTTP_STR_MATCH and HTTPS_STR_MATCH health checks. Amazon Route 53 considers case when searching for SearchString in the response body.

hccHealthThreshold :: Lens' HealthCheckConfig (Maybe Natural) Source

The minimum number of child health checks that must be healthy for Amazon Route 53 to consider the parent health check to be healthy. Valid values are integers between 0 and 256, inclusive.

hccResourcePath :: Lens' HealthCheckConfig (Maybe Text) Source

Path to ping on the instance to check the health. Required for HTTP, HTTPS, HTTP_STR_MATCH, and HTTPS_STR_MATCH health checks. The HTTP request is issued to the instance on the given port and path.

hccMeasureLatency :: Lens' HealthCheckConfig (Maybe Bool) Source

A Boolean value that indicates whether you want Amazon Route 53 to measure the latency between health checkers in multiple AWS regions and your endpoint and to display CloudWatch latency graphs in the Amazon Route 53 console.

hccInverted :: Lens' HealthCheckConfig (Maybe Bool) Source

A boolean value that indicates whether the status of health check should be inverted. For example, if a health check is healthy but Inverted is True, then Amazon Route 53 considers the health check to be unhealthy.

hccFullyQualifiedDomainName :: Lens' HealthCheckConfig (Maybe Text) Source

Fully qualified domain name of the instance to be health checked.

hccChildHealthChecks :: Lens' HealthCheckConfig [Text] Source

For a specified parent health check, a list of HealthCheckId values for the associated child health checks.

hccRequestInterval :: 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 Amazon Route 53 health checker makes requests at this interval. Valid values are 10 and 30. The default value is 30.

hccPort :: Lens' HealthCheckConfig (Maybe Natural) Source

Port on which connection will be opened to the instance to health check. For HTTP and HTTP_STR_MATCH this defaults to 80 if the port is not specified. For HTTPS and HTTPS_STR_MATCH this defaults to 443 if the port is not specified.

hccType :: Lens' HealthCheckConfig HealthCheckType Source

The type of health check to be performed. Currently supported types are TCP, HTTP, HTTPS, HTTP_STR_MATCH, and HTTPS_STR_MATCH.

HealthCheckObservation

healthCheckObservation :: HealthCheckObservation Source

Creates a value of HealthCheckObservation with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

hcoIPAddress :: Lens' HealthCheckObservation (Maybe Text) Source

The IP address of the Amazon Route 53 health checker that performed the health check.

hcoStatusReport :: Lens' HealthCheckObservation (Maybe StatusReport) Source

A complex type that contains information about the health check status for the current observation.

HostedZone

data HostedZone Source

A complex type that contain information about the specified hosted zone.

See: hostedZone smart constructor.

hostedZone Source

Creates a value of HostedZone with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

hzConfig :: Lens' HostedZone (Maybe HostedZoneConfig) Source

A complex type that contains the Comment element.

hzResourceRecordSetCount :: Lens' HostedZone (Maybe Integer) Source

Total number of resource record sets in the hosted zone.

hzId :: Lens' HostedZone Text Source

The ID of the specified hosted zone.

hzName :: Lens' HostedZone Text Source

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

This is the name you have registered with your DNS registrar. You should ask your registrar to change the authoritative name servers for your domain to the set of NameServers elements returned in DelegationSet.

hzCallerReference :: Lens' HostedZone Text Source

A unique string that identifies the request to create the hosted zone.

HostedZoneConfig

data HostedZoneConfig Source

A complex type that contains an optional comment about your hosted zone. If you don't want to specify a comment, you can omit the HostedZoneConfig and Comment elements from the XML document.

See: hostedZoneConfig smart constructor.

hostedZoneConfig :: HostedZoneConfig Source

Creates a value of HostedZoneConfig with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

hzcComment :: Lens' HostedZoneConfig (Maybe Text) Source

An optional comment about your hosted zone. If you don't want to specify a comment, you can omit the HostedZoneConfig and Comment elements from the XML document.

ResourceRecord

resourceRecord Source

Arguments

:: Text

rrValue

-> ResourceRecord 

Creates a value of ResourceRecord with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

rrValue :: 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.

ResourceRecordSet

rrsTTL :: Lens' ResourceRecordSet (Maybe Natural) Source

The cache time to live for the current resource record set. Note the following:

  • If you're creating 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, latency, geolocation, or failover 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.

rrsResourceRecords :: Lens' ResourceRecordSet (Maybe (NonEmpty ResourceRecord)) Source

A complex type that contains the resource records for the current resource record set.

rrsAliasTarget :: Lens' ResourceRecordSet (Maybe AliasTarget) Source

Alias resource record sets only: Information about the AWS resource to which you are redirecting traffic.

rrsWeight :: 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. Amazon Route 53 calculates the sum of the weights for the resource record sets that have the same combination of DNS name and type. Amazon 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 cannot 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, Amazon 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 Amazon Route 53 Active-Active and Active-Passive Failover in the Amazon Route 53 Developer Guide.

rrsSetIdentifier :: Lens' ResourceRecordSet (Maybe Text) Source

Weighted, Latency, Geo, and Failover resource record sets only: An identifier that differentiates among multiple resource record sets that have the same combination of DNS name and type. The value of SetIdentifier must be unique for each resource record set that has the same combination of DNS name and type.

rrsFailover :: Lens' ResourceRecordSet (Maybe Failover) 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.

You can create failover and failover alias resource record sets only in public hosted zones.

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, Amazon 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, Amazon Route 53 responds to DNS queries with the applicable value from the secondary resource record set.
  • When the secondary resource record set is unhealthy, Amazon 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, Amazon 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 cannot 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 Amazon Route 53, see Amazon Route 53 Health Checks and DNS Failover in the Amazon Route 53 Developer Guide.

Valid values: PRIMARY | SECONDARY

rrsHealthCheckId :: Lens' ResourceRecordSet (Maybe Text) Source

/Health Check resource record sets only, not required for alias resource record sets:/ An identifier that is used to identify health check associated with the resource record set.

rrsRegion :: Lens' ResourceRecordSet (Maybe Region) Source

Latency-based resource record sets only: The Amazon EC2 region where the resource that is specified in this resource record set resides. The resource typically is an AWS resource, such as an Amazon 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.

You can create latency and latency alias resource record sets only in public hosted zones.

When Amazon Route 53 receives a DNS query for a domain name and type for which you have created latency resource record sets, Amazon Route 53 selects the latency resource record set that has the lowest latency between the end user and the associated Amazon EC2 region. Amazon 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 are not required to create latency resource record sets for all Amazon EC2 regions. Amazon Route 53 will choose the region with the best latency from among the regions for which you create latency resource record sets.
  • You cannot create non-latency resource record sets that have the same values for the Name and Type elements as latency resource record sets.

rrsGeoLocation :: Lens' ResourceRecordSet (Maybe GeoLocation) Source

Geo location 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.

You can create geolocation and geolocation alias resource record sets only in public hosted zones.

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 cannot 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, Amazon 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 *, which handles both 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, Amazon Route 53 returns a "no answer" response for queries from those locations.

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

rrsName :: Lens' ResourceRecordSet Text Source

The name of the domain you want to perform the action on.

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 still assumes that the domain name that you specify is fully qualified. This means that Amazon 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 an asterisk (*) character in the name. DNS treats the * character either as a wildcard or as the * character (ASCII 42), depending on where it appears in the name. For more information, see Using an Asterisk (*) in the Names of Hosted Zones and Resource Record Sets in the Amazon Route 53 Developer Guide

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

rrsType :: Lens' ResourceRecordSet RecordType 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 | CNAME | MX | NS | PTR | SOA | SPF | SRV | TXT

Values for weighted, latency, geolocation, and failover resource record sets: A | AAAA | CNAME | MX | 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.

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:

  • CloudFront distributions: A
  • ELB load balancers: A | AAAA
  • Amazon S3 buckets: A
  • Another resource record set in this hosted zone: Specify the type of the resource record set for which you're creating the alias. Specify any value except NS or SOA.

ResourceTagSet

resourceTagSet :: ResourceTagSet Source

Creates a value of ResourceTagSet with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

rtsResourceId :: Lens' ResourceTagSet (Maybe Text) Source

The ID for the specified resource.

rtsResourceType :: 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.

rtsTags :: Lens' ResourceTagSet (Maybe (NonEmpty Tag)) Source

The tags associated with the specified resource.

StatusReport

data StatusReport Source

A complex type that contains information about the health check status for the current observation.

See: statusReport smart constructor.

statusReport :: StatusReport Source

Creates a value of StatusReport with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

srStatus :: Lens' StatusReport (Maybe Text) Source

The observed health check status.

srCheckedTime :: Lens' StatusReport (Maybe UTCTime) Source

The date and time the health check status was observed, in the format 'YYYY-MM-DDThh:mm:ssZ', as specified in the ISO 8601 standard (for example, 2009-11-19T19:37:58Z). The Z after the time indicates that the time is listed in Coordinated Universal Time (UTC).

Tag

data Tag Source

A single tag containing a key and value.

See: tag smart constructor.

tag :: Tag Source

Creates a value of Tag with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

tagValue :: Lens' Tag (Maybe Text) Source

The value for a Tag.

tagKey :: Lens' Tag (Maybe Text) Source

The key for a Tag.

TrafficPolicy

trafficPolicy Source

Creates a value of TrafficPolicy with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

tpComment :: Lens' TrafficPolicy (Maybe Text) Source

Undocumented member.

tpId :: Lens' TrafficPolicy Text Source

Undocumented member.

tpVersion :: Lens' TrafficPolicy Natural Source

Undocumented member.

tpName :: Lens' TrafficPolicy Text Source

Undocumented member.

tpType :: Lens' TrafficPolicy RecordType Source

Undocumented member.

tpDocument :: Lens' TrafficPolicy Text Source

Undocumented member.

TrafficPolicyInstance

TrafficPolicySummary

trafficPolicySummary Source

Creates a value of TrafficPolicySummary with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

tpsId :: Lens' TrafficPolicySummary Text Source

Undocumented member.

VPC

vpc :: VPC Source

Creates a value of VPC with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

vpcVPCRegion :: Lens' VPC (Maybe VPCRegion) Source

Undocumented member.

vpcVPCId :: Lens' VPC (Maybe Text) Source

Undocumented member.