| Copyright | (c) 2013-2016 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
| Language | Haskell2010 |
Network.AWS.Route53.Types
Contents
- Service Configuration
- Errors
- Re-exported Types
- Website Endpoints
- ChangeAction
- ChangeStatus
- CloudWatchRegion
- ComparisonOperator
- Failover
- HealthCheckRegion
- HealthCheckType
- InsufficientDataHealthStatus
- RecordType
- Statistic
- TagResourceType
- VPCRegion
- AlarmIdentifier
- AliasTarget
- Change
- ChangeBatch
- ChangeInfo
- CloudWatchAlarmConfiguration
- DelegationSet
- Dimension
- GeoLocation
- GeoLocationDetails
- HealthCheck
- HealthCheckConfig
- HealthCheckObservation
- HostedZone
- HostedZoneConfig
- ResourceRecord
- ResourceRecordSet
- ResourceTagSet
- StatusReport
- Tag
- TrafficPolicy
- TrafficPolicyInstance
- TrafficPolicySummary
- VPC
Description
- route53 :: Service
- _HealthCheckVersionMismatch :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidInput :: AsError a => Getting (First ServiceError) a ServiceError
- _HostedZoneNotEmpty :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidArgument :: AsError a => Getting (First ServiceError) a ServiceError
- _TrafficPolicyInstanceAlreadyExists :: AsError a => Getting (First ServiceError) a ServiceError
- _ConflictingTypes :: AsError a => Getting (First ServiceError) a ServiceError
- _ConcurrentModification :: AsError a => Getting (First ServiceError) a ServiceError
- _DelegationSetAlreadyReusable :: AsError a => Getting (First ServiceError) a ServiceError
- _NotAuthorizedException :: AsError a => Getting (First ServiceError) a ServiceError
- _PriorRequestNotComplete :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidChangeBatch :: AsError a => Getting (First ServiceError) a ServiceError
- _TooManyVPCAssociationAuthorizations :: AsError a => Getting (First ServiceError) a ServiceError
- _TrafficPolicyAlreadyExists :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidTrafficPolicyDocument :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidPaginationToken :: AsError a => Getting (First ServiceError) a ServiceError
- _DelegationSetNotReusable :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidDomainName :: AsError a => Getting (First ServiceError) a ServiceError
- _NoSuchTrafficPolicy :: AsError a => Getting (First ServiceError) a ServiceError
- _HostedZoneNotFound :: AsError a => Getting (First ServiceError) a ServiceError
- _DelegationSetInUse :: AsError a => Getting (First ServiceError) a ServiceError
- _NoSuchDelegationSet :: AsError a => Getting (First ServiceError) a ServiceError
- _HealthCheckAlreadyExists :: AsError a => Getting (First ServiceError) a ServiceError
- _TooManyTrafficPolicies :: AsError a => Getting (First ServiceError) a ServiceError
- _VPCAssociationAuthorizationNotFound :: AsError a => Getting (First ServiceError) a ServiceError
- _NoSuchGeoLocation :: AsError a => Getting (First ServiceError) a ServiceError
- _DelegationSetNotAvailable :: AsError a => Getting (First ServiceError) a ServiceError
- _VPCAssociationNotFound :: AsError a => Getting (First ServiceError) a ServiceError
- _ThrottlingException :: AsError a => Getting (First ServiceError) a ServiceError
- _NoSuchChange :: AsError a => Getting (First ServiceError) a ServiceError
- _LimitsExceeded :: AsError a => Getting (First ServiceError) a ServiceError
- _TooManyTrafficPolicyInstances :: AsError a => Getting (First ServiceError) a ServiceError
- _NoSuchTrafficPolicyInstance :: AsError a => Getting (First ServiceError) a ServiceError
- _IncompatibleVersion :: AsError a => Getting (First ServiceError) a ServiceError
- _PublicZoneVPCAssociation :: AsError a => Getting (First ServiceError) a ServiceError
- _NoSuchHostedZone :: AsError a => Getting (First ServiceError) a ServiceError
- _TooManyHostedZones :: AsError a => Getting (First ServiceError) a ServiceError
- _HealthCheckInUse :: AsError a => Getting (First ServiceError) a ServiceError
- _DelegationSetAlreadyCreated :: AsError a => Getting (First ServiceError) a ServiceError
- _ConflictingDomainExists :: AsError a => Getting (First ServiceError) a ServiceError
- _LastVPCAssociation :: AsError a => Getting (First ServiceError) a ServiceError
- _TooManyHealthChecks :: AsError a => Getting (First ServiceError) a ServiceError
- _NoSuchHealthCheck :: AsError a => Getting (First ServiceError) a ServiceError
- _TrafficPolicyInUse :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidVPCId :: AsError a => Getting (First ServiceError) a ServiceError
- _HostedZoneAlreadyExists :: AsError a => Getting (First ServiceError) a ServiceError
- data Region :: *
- = NorthVirginia
- | Ohio
- | NorthCalifornia
- | Oregon
- | Tokyo
- | Seoul
- | Mumbai
- | Singapore
- | Sydney
- | SaoPaulo
- | Ireland
- | Frankfurt
- | GovCloud
- | GovCloudFIPS
- | Beijing
- newtype ResourceId = ResourceId {}
- getHostedZoneId :: Region -> Maybe ResourceId
- data ChangeAction
- data ChangeStatus
- data CloudWatchRegion
- data ComparisonOperator
- data Failover
- data HealthCheckRegion
- data HealthCheckType
- data InsufficientDataHealthStatus
- data RecordType
- data Statistic
- = Average
- | Maximum
- | Minimum
- | SampleCount
- | Sum
- data TagResourceType
- data VPCRegion
- data AlarmIdentifier
- alarmIdentifier :: CloudWatchRegion -> Text -> AlarmIdentifier
- aiRegion :: Lens' AlarmIdentifier CloudWatchRegion
- aiName :: Lens' AlarmIdentifier Text
- data AliasTarget
- aliasTarget :: ResourceId -> Text -> Bool -> AliasTarget
- atHostedZoneId :: Lens' AliasTarget ResourceId
- atDNSName :: Lens' AliasTarget Text
- atEvaluateTargetHealth :: Lens' AliasTarget Bool
- data Change
- change :: ChangeAction -> ResourceRecordSet -> Change
- cAction :: Lens' Change ChangeAction
- cResourceRecordSet :: Lens' Change ResourceRecordSet
- data ChangeBatch
- changeBatch :: NonEmpty Change -> ChangeBatch
- cbComment :: Lens' ChangeBatch (Maybe Text)
- cbChanges :: Lens' ChangeBatch (NonEmpty Change)
- data ChangeInfo
- changeInfo :: ResourceId -> ChangeStatus -> UTCTime -> ChangeInfo
- ciComment :: Lens' ChangeInfo (Maybe Text)
- ciId :: Lens' ChangeInfo ResourceId
- ciStatus :: Lens' ChangeInfo ChangeStatus
- ciSubmittedAt :: Lens' ChangeInfo UTCTime
- data CloudWatchAlarmConfiguration
- cloudWatchAlarmConfiguration :: Natural -> Double -> ComparisonOperator -> Natural -> Text -> Text -> Statistic -> CloudWatchAlarmConfiguration
- cwacDimensions :: Lens' CloudWatchAlarmConfiguration [Dimension]
- cwacEvaluationPeriods :: Lens' CloudWatchAlarmConfiguration Natural
- cwacThreshold :: Lens' CloudWatchAlarmConfiguration Double
- cwacComparisonOperator :: Lens' CloudWatchAlarmConfiguration ComparisonOperator
- cwacPeriod :: Lens' CloudWatchAlarmConfiguration Natural
- cwacMetricName :: Lens' CloudWatchAlarmConfiguration Text
- cwacNamespace :: Lens' CloudWatchAlarmConfiguration Text
- cwacStatistic :: Lens' CloudWatchAlarmConfiguration Statistic
- data DelegationSet
- delegationSet :: NonEmpty Text -> DelegationSet
- dsId :: Lens' DelegationSet (Maybe ResourceId)
- dsCallerReference :: Lens' DelegationSet (Maybe Text)
- dsNameServers :: Lens' DelegationSet (NonEmpty Text)
- data Dimension
- dimension :: Text -> Text -> Dimension
- dName :: Lens' Dimension Text
- dValue :: Lens' Dimension Text
- data GeoLocation
- geoLocation :: GeoLocation
- glSubdivisionCode :: Lens' GeoLocation (Maybe Text)
- glCountryCode :: Lens' GeoLocation (Maybe Text)
- glContinentCode :: Lens' GeoLocation (Maybe Text)
- data GeoLocationDetails
- geoLocationDetails :: GeoLocationDetails
- gldSubdivisionName :: Lens' GeoLocationDetails (Maybe Text)
- gldSubdivisionCode :: Lens' GeoLocationDetails (Maybe Text)
- gldCountryName :: Lens' GeoLocationDetails (Maybe Text)
- gldCountryCode :: Lens' GeoLocationDetails (Maybe Text)
- gldContinentCode :: Lens' GeoLocationDetails (Maybe Text)
- gldContinentName :: Lens' GeoLocationDetails (Maybe Text)
- data HealthCheck
- healthCheck :: Text -> Text -> HealthCheckConfig -> Natural -> HealthCheck
- hcCloudWatchAlarmConfiguration :: Lens' HealthCheck (Maybe CloudWatchAlarmConfiguration)
- hcId :: Lens' HealthCheck Text
- hcCallerReference :: Lens' HealthCheck Text
- hcHealthCheckConfig :: Lens' HealthCheck HealthCheckConfig
- hcHealthCheckVersion :: Lens' HealthCheck Natural
- data HealthCheckConfig
- healthCheckConfig :: HealthCheckType -> HealthCheckConfig
- hccFailureThreshold :: Lens' HealthCheckConfig (Maybe Natural)
- hccIPAddress :: Lens' HealthCheckConfig (Maybe Text)
- hccEnableSNI :: Lens' HealthCheckConfig (Maybe Bool)
- hccSearchString :: Lens' HealthCheckConfig (Maybe Text)
- hccHealthThreshold :: Lens' HealthCheckConfig (Maybe Natural)
- hccRegions :: Lens' HealthCheckConfig (Maybe (NonEmpty HealthCheckRegion))
- hccResourcePath :: Lens' HealthCheckConfig (Maybe Text)
- hccInsufficientDataHealthStatus :: Lens' HealthCheckConfig (Maybe InsufficientDataHealthStatus)
- hccAlarmIdentifier :: Lens' HealthCheckConfig (Maybe AlarmIdentifier)
- hccMeasureLatency :: Lens' HealthCheckConfig (Maybe Bool)
- hccInverted :: Lens' HealthCheckConfig (Maybe Bool)
- hccFullyQualifiedDomainName :: Lens' HealthCheckConfig (Maybe Text)
- hccChildHealthChecks :: Lens' HealthCheckConfig [Text]
- hccRequestInterval :: Lens' HealthCheckConfig (Maybe Natural)
- hccPort :: Lens' HealthCheckConfig (Maybe Natural)
- hccType :: Lens' HealthCheckConfig HealthCheckType
- data HealthCheckObservation
- healthCheckObservation :: HealthCheckObservation
- hcoIPAddress :: Lens' HealthCheckObservation (Maybe Text)
- hcoStatusReport :: Lens' HealthCheckObservation (Maybe StatusReport)
- hcoRegion :: Lens' HealthCheckObservation (Maybe HealthCheckRegion)
- data HostedZone
- hostedZone :: ResourceId -> Text -> Text -> HostedZone
- hzConfig :: Lens' HostedZone (Maybe HostedZoneConfig)
- hzResourceRecordSetCount :: Lens' HostedZone (Maybe Integer)
- hzId :: Lens' HostedZone ResourceId
- hzName :: Lens' HostedZone Text
- hzCallerReference :: Lens' HostedZone Text
- data HostedZoneConfig
- hostedZoneConfig :: HostedZoneConfig
- hzcPrivateZone :: Lens' HostedZoneConfig (Maybe Bool)
- hzcComment :: Lens' HostedZoneConfig (Maybe Text)
- data ResourceRecord
- resourceRecord :: Text -> ResourceRecord
- rrValue :: Lens' ResourceRecord Text
- data ResourceRecordSet
- resourceRecordSet :: Text -> RecordType -> ResourceRecordSet
- rrsTTL :: Lens' ResourceRecordSet (Maybe Natural)
- rrsResourceRecords :: Lens' ResourceRecordSet (Maybe (NonEmpty ResourceRecord))
- rrsAliasTarget :: Lens' ResourceRecordSet (Maybe AliasTarget)
- rrsWeight :: Lens' ResourceRecordSet (Maybe Natural)
- rrsTrafficPolicyInstanceId :: Lens' ResourceRecordSet (Maybe Text)
- rrsSetIdentifier :: Lens' ResourceRecordSet (Maybe Text)
- rrsFailover :: Lens' ResourceRecordSet (Maybe Failover)
- rrsHealthCheckId :: Lens' ResourceRecordSet (Maybe Text)
- rrsRegion :: Lens' ResourceRecordSet (Maybe Region)
- rrsGeoLocation :: Lens' ResourceRecordSet (Maybe GeoLocation)
- rrsName :: Lens' ResourceRecordSet Text
- rrsType :: Lens' ResourceRecordSet RecordType
- data ResourceTagSet
- resourceTagSet :: ResourceTagSet
- rtsResourceId :: Lens' ResourceTagSet (Maybe Text)
- rtsResourceType :: Lens' ResourceTagSet (Maybe TagResourceType)
- rtsTags :: Lens' ResourceTagSet (Maybe (NonEmpty Tag))
- data StatusReport
- statusReport :: StatusReport
- srStatus :: Lens' StatusReport (Maybe Text)
- srCheckedTime :: Lens' StatusReport (Maybe UTCTime)
- data Tag
- tag :: Tag
- tagValue :: Lens' Tag (Maybe Text)
- tagKey :: Lens' Tag (Maybe Text)
- data TrafficPolicy
- trafficPolicy :: Text -> Natural -> Text -> RecordType -> Text -> TrafficPolicy
- tpComment :: Lens' TrafficPolicy (Maybe Text)
- tpId :: Lens' TrafficPolicy Text
- tpVersion :: Lens' TrafficPolicy Natural
- tpName :: Lens' TrafficPolicy Text
- tpType :: Lens' TrafficPolicy RecordType
- tpDocument :: Lens' TrafficPolicy Text
- data TrafficPolicyInstance
- trafficPolicyInstance :: Text -> ResourceId -> Text -> Natural -> Text -> Text -> Text -> Natural -> RecordType -> TrafficPolicyInstance
- tpiId :: Lens' TrafficPolicyInstance Text
- tpiHostedZoneId :: Lens' TrafficPolicyInstance ResourceId
- tpiName :: Lens' TrafficPolicyInstance Text
- tpiTTL :: Lens' TrafficPolicyInstance Natural
- tpiState :: Lens' TrafficPolicyInstance Text
- tpiMessage :: Lens' TrafficPolicyInstance Text
- tpiTrafficPolicyId :: Lens' TrafficPolicyInstance Text
- tpiTrafficPolicyVersion :: Lens' TrafficPolicyInstance Natural
- tpiTrafficPolicyType :: Lens' TrafficPolicyInstance RecordType
- data TrafficPolicySummary
- trafficPolicySummary :: Text -> Text -> RecordType -> Natural -> Natural -> TrafficPolicySummary
- tpsId :: Lens' TrafficPolicySummary Text
- tpsName :: Lens' TrafficPolicySummary Text
- tpsType :: Lens' TrafficPolicySummary RecordType
- tpsLatestVersion :: Lens' TrafficPolicySummary Natural
- tpsTrafficPolicyCount :: Lens' TrafficPolicySummary Natural
- data VPC
- vpc :: VPC
- vpcVPCRegion :: Lens' VPC (Maybe VPCRegion)
- vpcVPCId :: Lens' VPC (Maybe Text)
Service Configuration
Errors
_HealthCheckVersionMismatch :: AsError a => Getting (First ServiceError) a ServiceError Source #
The value of HealthCheckVersion in the request doesn't match the value of HealthCheckVersion in the health check.
_InvalidInput :: AsError a => Getting (First ServiceError) a ServiceError Source #
The input is not valid.
_HostedZoneNotEmpty :: AsError a => Getting (First ServiceError) a ServiceError Source #
The hosted zone contains resource records that are not SOA or NS records.
_InvalidArgument :: AsError a => Getting (First ServiceError) a ServiceError Source #
Parameter name and problem.
_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 CreateTrafficPolicyVersion request.
_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.
_NotAuthorizedException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Associating the specified VPC with the specified hosted zone has not been authorized.
_PriorRequestNotComplete :: AsError a => Getting (First ServiceError) a ServiceError Source #
If Amazon Route 53 can't process a request before the next request arrives, it will reject subsequent requests for the same hosted zone and return an HTTP 400 error (Bad request ). If Amazon Route 53 returns this error repeatedly for the same request, we recommend that you wait, in intervals of increasing duration, before you try the request again.
_InvalidChangeBatch :: AsError a => Getting (First ServiceError) a ServiceError Source #
This exception contains a list of messages that might contain one or more error messages. Each error message indicates one error in the change batch.
_TooManyVPCAssociationAuthorizations :: AsError a => Getting (First ServiceError) a ServiceError Source #
You've created the maximum number of authorizations that can be created for the specified hosted zone. To authorize another VPC to be associated with the hosted zone, submit a DeleteVPCAssociationAuthorization request to remove an existing authorization. To get a list of existing authorizations, submit a ListVPCAssociationAuthorizations request.
_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.
_InvalidPaginationToken :: AsError a => Getting (First ServiceError) a ServiceError Source #
Prism for InvalidPaginationToken' errors.
_DelegationSetNotReusable :: AsError a => Getting (First ServiceError) a ServiceError Source #
A reusable delegation set with the specified ID does not exist.
_InvalidDomainName :: AsError a => Getting (First ServiceError) a ServiceError Source #
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 can't 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 #
A reusable delegation set with the specified ID does not exist.
_HealthCheckAlreadyExists :: AsError a => Getting (First ServiceError) a ServiceError Source #
The health check you're attempting to create already exists.
Amazon Route 53 returns this error when a health check has already been created with the specified value for 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.
_VPCAssociationAuthorizationNotFound :: AsError a => Getting (First ServiceError) a ServiceError Source #
The VPC that you specified is not authorized to be associated with the hosted zone.
_NoSuchGeoLocation :: AsError a => Getting (First ServiceError) a ServiceError Source #
Amazon Route 53 doesn't support the specified geolocation.
_DelegationSetNotAvailable :: AsError a => Getting (First ServiceError) a ServiceError Source #
You can create a hosted zone that has the same name as an existing hosted zone (example.com is common), but there is a limit to the number of hosted zones that have the same name. If you get this error, Amazon Route 53 has reached that limit. If you own the domain name and Amazon Route 53 generates this error, contact Customer Support.
_VPCAssociationNotFound :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified VPC and hosted zone are not currently associated.
_ThrottlingException :: AsError a => Getting (First ServiceError) a ServiceError Source #
_NoSuchChange :: AsError a => Getting (First ServiceError) a ServiceError Source #
A change with the specified change ID does not exist.
_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 #
You're trying to associate a VPC with a public hosted zone. Amazon Route 53 doesn't support associating a VPC with a public hosted zone.
_NoSuchHostedZone :: AsError a => Getting (First ServiceError) a ServiceError Source #
No hosted zone exists with the ID that you specified.
_TooManyHostedZones :: AsError a => Getting (First ServiceError) a ServiceError Source #
This hosted zone can't be created because the hosted zone limit is exceeded. To request a limit increase, go to the Amazon Route 53 Contact Us page.
_HealthCheckInUse :: AsError a => Getting (First ServiceError) a ServiceError Source #
The health check ID for this health check is referenced in the HealthCheckId element in one of the resource record sets in one of the hosted zones that are owned by the current AWS account.
_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 #
You specified an Amazon VPC that you're already using for another hosted zone, and the domain that you specified for one of the hosted zones is a subdomain of the domain that you specified for the other hosted zone. For example, you can't use the same Amazon VPC for the hosted zones for example.com and test.example.com.
_LastVPCAssociation :: AsError a => Getting (First ServiceError) a ServiceError Source #
The VPC that you're trying to disassociate from the private hosted zone is the last VPC that is associated with the hosted zone. Amazon Route 53 doesn't support disassociating the last VPC from a hosted zone.
_TooManyHealthChecks :: AsError a => Getting (First ServiceError) a ServiceError Source #
You have reached the maximum number of active health checks for an AWS account. The default limit is 100. To request a higher limit, create a case with the AWS Support Center.
_NoSuchHealthCheck :: AsError a => Getting (First ServiceError) a ServiceError Source #
No health check exists with the ID that you specified in the DeleteHealthCheck request.
_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 VPC ID that you specified either isn't a valid ID or the current account is not authorized to access this VPC.
_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
The available AWS regions.
Constructors
| NorthVirginia | US East ('us-east-1'). |
| Ohio | US East ('us-east-2'). |
| NorthCalifornia | US West ('us-west-1'). |
| Oregon | US West ('us-west-2'). |
| Tokyo | Asia Pacific ('ap-northeast-1'). |
| Seoul | Asia Pacific ('ap-northeast-2'). |
| Mumbai | Asia Pacific ('ap-south-1'). |
| Singapore | Asia Pacific ('ap-southeast-1'). |
| Sydney | Asia Pacific ('ap-southeast-2'). |
| SaoPaulo | South America ('sa-east-1'). |
| Ireland | EU ('eu-west-1'). |
| Frankfurt | EU ('eu-central-1'). |
| GovCloud | US GovCloud ('us-gov-west-1'). |
| GovCloudFIPS | US GovCloud FIPS (S3 Only, 'fips-us-gov-west-1'). |
| Beijing | China ('cn-north-1'). |
newtype ResourceId Source #
A Route53 identifier for resources such as hosted zones and delegation sets.
Since Route53 outputs prefixed resource identifiers such as
hostedzoneABC123, but expects unprefixed identifiers as inputs, such as
ABC123, the FromXML instance will strip this prefix take care to ensure
the correct input format is observed and decodeXML . encodeXML == id
holds.
Constructors
| ResourceId | |
Fields | |
Instances
| Eq ResourceId Source # | |
| Data ResourceId Source # | |
| Ord ResourceId Source # | |
| Read ResourceId Source # | |
| Show ResourceId Source # | |
| IsString ResourceId Source # | |
| Generic ResourceId Source # | |
| Hashable ResourceId Source # | |
| NFData ResourceId Source # | |
| ToLog ResourceId Source # | |
| FromXML ResourceId Source # | Handles prefixed Route53 resource identifiers. |
| ToXML ResourceId Source # | |
| ToQuery ResourceId Source # | |
| ToByteString ResourceId Source # | |
| FromText ResourceId Source # | |
| ToText ResourceId Source # | |
| type Rep ResourceId Source # | |
Website Endpoints
getHostedZoneId :: Region -> Maybe ResourceId Source #
Get the hosted zone identifier for an S3 website endpoint.
When you configure your bucket as a website, the website is available using a region-specific website endpoint. This hosted zone identifier is used adding an alias record to the website to your hosted zone.
ChangeAction
data ChangeAction Source #
Instances
ChangeStatus
data ChangeStatus Source #
Instances
CloudWatchRegion
data CloudWatchRegion Source #
Constructors
| CWRApNortheast1 | |
| CWRApNortheast2 | |
| CWRApSouth1 | |
| CWRApSoutheast1 | |
| CWRApSoutheast2 | |
| CWREuCentral1 | |
| CWREuWest1 | |
| CWRSaEast1 | |
| CWRUsEast1 | |
| CWRUsEast2 | |
| CWRUsWest1 | |
| CWRUsWest2 |
Instances
ComparisonOperator
data ComparisonOperator Source #
Constructors
| GreaterThanOrEqualToThreshold | |
| GreaterThanThreshold | |
| LessThanOrEqualToThreshold | |
| LessThanThreshold |
Instances
Failover
Instances
HealthCheckRegion
data HealthCheckRegion Source #
An Amazon EC2 Region that you want Amazon Route 53 to use to perform health checks.
Constructors
| HCRApNortheast1 | |
| HCRApSoutheast1 | |
| HCRApSoutheast2 | |
| HCREuWest1 | |
| HCRSaEast1 | |
| HCRUsEast1 | |
| HCRUsWest1 | |
| HCRUsWest2 |
Instances
HealthCheckType
data HealthCheckType Source #
Constructors
| Calculated | |
| CloudwatchMetric | |
| HTTP | |
| HTTPS | |
| HTTPSStrMatch | |
| HTTPStrMatch | |
| TCP |
Instances
InsufficientDataHealthStatus
data InsufficientDataHealthStatus Source #
Constructors
| Healthy | |
| LastKnownStatus | |
| Unhealthy |
Instances
RecordType
data RecordType Source #
Instances
Statistic
Constructors
| Average | |
| Maximum | |
| Minimum | |
| SampleCount | |
| Sum |
Instances
TagResourceType
data TagResourceType Source #
Constructors
| Healthcheck | |
| Hostedzone |
Instances
VPCRegion
Constructors
| ApNortheast1 | |
| ApNortheast2 | |
| ApSouth1 | |
| ApSoutheast1 | |
| ApSoutheast2 | |
| CnNorth1 | |
| EuCentral1 | |
| EuWest1 | |
| SaEast1 | |
| UsEast1 | |
| UsEast2 | |
| UsWest1 | |
| UsWest2 |
Instances
AlarmIdentifier
data AlarmIdentifier Source #
A complex type that identifies the CloudWatch alarm that you want Amazon Route 53 health checkers to use to determine whether this health check is healthy.
See: alarmIdentifier smart constructor.
Instances
Arguments
| :: CloudWatchRegion | |
| -> Text | |
| -> AlarmIdentifier |
Creates a value of AlarmIdentifier with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
aiRegion- A complex type that identifies the CloudWatch alarm that you want Amazon Route 53 health checkers to use to determine whether this health check is healthy. For the current list of CloudWatch regions, see Amazon CloudWatch in AWS Regions and Endpoints in the Amazon Web Services General Reference .aiName- The name of the CloudWatch alarm that you want Amazon Route 53 health checkers to use to determine whether this health check is healthy.
aiRegion :: Lens' AlarmIdentifier CloudWatchRegion Source #
A complex type that identifies the CloudWatch alarm that you want Amazon Route 53 health checkers to use to determine whether this health check is healthy. For the current list of CloudWatch regions, see Amazon CloudWatch in AWS Regions and Endpoints in the Amazon Web Services General Reference .
aiName :: 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.
AliasTarget
data AliasTarget Source #
Alias resource record sets only: Information about the CloudFront distribution, Elastic Beanstalk environment, ELB load balancer, Amazon S3 bucket, or Amazon Route 53 resource record set that you're redirecting queries to. The Elastic Beanstalk environment must have a regionalized subdomain.
When creating resource record sets for a private hosted zone, note the following:
- Resource record sets can't be created for CloudFront distributions in a private hosted zone.
- 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 .
See: aliasTarget smart constructor.
Arguments
| :: ResourceId | |
| -> Text | |
| -> Bool | |
| -> AliasTarget |
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- Alias resource records sets only : The value used depends on where the queries are routed: * A CloudFront distribution * SpecifyZ2FDTNDATAQYW2. * Elastic Beanstalk environment * Specify the hosted zone ID for the region in which you created the environment. The environment must have a regionalized subdomain. For a list of regions and the corresponding hosted zone IDs, see AWS Elastic Beanstalk in the Regions and Endpoints chapter of 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: * AWS Management Console: Go to the Amazon EC2 page, click Load Balancers in the navigation pane, select the load balancer, and get the value of the Hosted Zone ID field on the Description tab. Use the same process to get the value of DNS Name . See 'HostedZone$Name' . * Elastic Load Balancing API: UseDescribeLoadBalancersto get the value ofCanonicalHostedZoneNameID. Use the same process to get theCanonicalHostedZoneName. See 'HostedZone$Name' . * AWS CLI: Usedescribe-load-balancersto get the value ofCanonicalHostedZoneNameID. Use the same process to get theCanonicalHostedZoneName. See 'HostedZone$Name' . * An Amazon S3 bucket 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 S3 (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 can't reference a resource record set in a different hosted zone.)atDNSName- Alias resource record sets only: 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 . * Elastic Beanstalk environment : Specify theCNAMEattribute for the environment. (The environment must have a regionalized domain name.) You can use the following methods to get the value of the CNAME attribute: * AWS Managment Console : For information about how to get the value by using the console, see Using Custom Domains with AWS Elastic Beanstalk in the AWS Elastic Beanstalk Developer Guide . * Elastic Load Balancing API : Use theDescribeEnvironmentsaction to get the value of theCNAMEattribute. For more information, see DescribeEnvironments in the AWS Elastic Beanstalk API Reference . * AWS CLI : Use the describe-environments command to get the value of theCNAMEattribute. For more information, see describe-environments in the AWS Command Line Interface Reference . * An ELB load balancer: Specify the DNS name associated with the load balancer. Get the DNS name by using the AWS Management Console, the ELB API, or the AWS CLI. Use the same method to get values forHostedZoneIdandDNSName. 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. * AWS Management Console : Go to the EC2 page, click Load Balancers in the navigation pane, choose the load balancer, choose the Description tab, and get the value of the DNS Name field that begins with dualstack. Use the same process to get the Hosted Zone ID . See 'HostedZone$Id' . * Elastic Load Balancing API : UseDescribeLoadBalancersto get the value ofCanonicalHostedZoneName. Use the same process to get theCanonicalHostedZoneNameId. See 'HostedZone$Id' . * AWS CLI : Usedescribe-load-balancersto get the value ofCanonicalHostedZoneName. Use the same process to get theCanonicalHostedZoneNameId. See HostedZoneId. * 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 S3 buckets for websites, see Hosting a Static Website on Amazon S3 in the Amazon S3 Developer Guide. * Another Amazon Route 53 resource record set : Specify the value of theNameelement for a resource record set in the current hosted zone.atEvaluateTargetHealth- Applies only to alias, weighted alias, latency alias, and failover alias record sets: If you set the value ofEvaluateTargetHealthtotruefor 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'HealthCheck$Id'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: * 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. * 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.) * 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. * 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 can't setEvaluateTargetHealthtotruewhen the alias target is a CloudFront distribution. * If the AWS resource that you specify inAliasTargetis 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 Elastic Beanstalk environment inHostedZoneIdandDNSName, and if 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 EC2 instance.) If you setEvaluateTargetHealthtotrueand either no EC2 instances are healthy or the load balancer itself is unhealthy, Amazon Route 53 routes queries to other available resources that are healthy, if any. If the environment contains a single EC2 instance, there are no special requirements. * If you specify an ELB load balancer inAliasTargetEvaluateTargetHealthis 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 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 Developers Guide . * We recommend that you setEvaluateTargetHealthto 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 .
atHostedZoneId :: Lens' AliasTarget ResourceId Source #
Alias resource records sets only : The value used depends on where the queries are routed: * A CloudFront distribution * Specify Z2FDTNDATAQYW2 . * Elastic Beanstalk environment * Specify the hosted zone ID for the region in which you created the environment. The environment must have a regionalized subdomain. For a list of regions and the corresponding hosted zone IDs, see AWS Elastic Beanstalk in the Regions and Endpoints chapter of 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: * AWS Management Console: Go to the Amazon EC2 page, click Load Balancers in the navigation pane, select the load balancer, and get the value of the Hosted Zone ID field on the Description tab. Use the same process to get the value of DNS Name . See 'HostedZone$Name' . * Elastic Load Balancing API: Use DescribeLoadBalancers to get the value of CanonicalHostedZoneNameID . Use the same process to get the CanonicalHostedZoneName . See 'HostedZone$Name' . * AWS CLI: Use describe-load-balancers to get the value of CanonicalHostedZoneNameID . Use the same process to get the CanonicalHostedZoneName . See 'HostedZone$Name' . * An Amazon S3 bucket 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 S3 (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 can't reference a resource record set in a different hosted zone.)
atDNSName :: Lens' AliasTarget Text Source #
Alias resource record sets only: 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 . * Elastic Beanstalk environment : Specify the CNAME attribute for the environment. (The environment must have a regionalized domain name.) You can use the following methods to get the value of the CNAME attribute: * AWS Managment Console : For information about how to get the value by using the console, see Using Custom Domains with AWS Elastic Beanstalk in the AWS Elastic Beanstalk Developer Guide . * Elastic Load Balancing API : Use the DescribeEnvironments action to get the value of the CNAME attribute. For more information, see DescribeEnvironments in the AWS Elastic Beanstalk API Reference . * AWS CLI : Use the describe-environments command to get the value of the CNAME attribute. For more information, see describe-environments in the AWS Command Line Interface Reference . * An ELB load balancer: Specify the DNS name associated with the load balancer. 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. * AWS Management Console : Go to the EC2 page, click Load Balancers in the navigation pane, choose the load balancer, choose the Description tab, and get the value of the DNS Name field that begins with dualstack. Use the same process to get the Hosted Zone ID . See 'HostedZone$Id' . * Elastic Load Balancing API : Use DescribeLoadBalancers to get the value of CanonicalHostedZoneName . Use the same process to get the CanonicalHostedZoneNameId . See 'HostedZone$Id' . * AWS CLI : Use describe-load-balancers to get the value of CanonicalHostedZoneName . Use the same process to get the CanonicalHostedZoneNameId . See HostedZoneId. * 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 S3 buckets for websites, see Hosting a Static Website on Amazon S3 in the Amazon S3 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.
atEvaluateTargetHealth :: Lens' AliasTarget Bool Source #
Applies only to alias, weighted alias, latency alias, and failover alias record sets: 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 'HealthCheck$Id' 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: * 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. * 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.) * 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. * 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 can't 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 Elastic Beanstalk environment in HostedZoneId and DNSName , and if 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 EC2 instance.) If you set EvaluateTargetHealth to true and either no EC2 instances are healthy or the load balancer itself is unhealthy, Amazon Route 53 routes queries to other available resources that are healthy, if any. If the environment contains a single EC2 instance, there are no special requirements. * If you specify an ELB load balancer in AliasTarget 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 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 Developers 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
The information for each resource record set that you want to change.
See: change smart constructor.
Arguments
| :: ChangeAction | |
| -> ResourceRecordSet | |
| -> Change |
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- The action to perform: *CREATE: Creates a resource record set that has the specified values. *DELETE: Deletes a existing resource record set. Important: To delete the resource record set that is associated with a traffic policy instance, useDeleteTrafficPolicyInstanceChangeResourceRecordSets, Amazon 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, Amazon Route 53 creates it. If a resource record set does exist, Amazon Route 53 updates it with the values in the request. The values that you need to include in the request depend on the type of resource record set that you're creating, deleting, or updating: Basic resource record sets (excluding alias, failover, geolocation, latency, and weighted resource record sets) *Name*Type*TTLFailover, geolocation, latency, or weighted resource record sets (excluding alias resource record sets) *Name*Type*TTL*SetIdentifierAlias resource record sets (including failover alias, geolocation alias, latency alias, and weighted alias resource record sets) *Name*Type*AliasTarget(includesDNSName,EvaluateTargetHealth, andHostedZoneId) *SetIdentifier(for failover, geolocation, latency, and weighted resource record sets)cResourceRecordSet- Information about the resource record set to create, delete, or update.
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. Important: To delete the resource record set that is associated with a traffic policy instance, use DeleteTrafficPolicyInstance ChangeResourceRecordSets , Amazon 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, Amazon Route 53 creates it. If a resource record set does exist, Amazon Route 53 updates it with the values in the request. The values that you need to include in the request depend on the type of resource record set that you're creating, deleting, or updating: Basic resource record sets (excluding alias, failover, geolocation, latency, and weighted resource record sets) * Name * Type * TTL Failover, geolocation, latency, or weighted resource record sets (excluding alias resource record sets) * Name * Type * TTL * SetIdentifier Alias resource record sets (including failover alias, geolocation alias, latency alias, and weighted alias resource record sets) * Name * Type * AliasTarget (includes DNSName , EvaluateTargetHealth , and HostedZoneId ) * SetIdentifier (for failover, geolocation, latency, and weighted resource record sets)
cResourceRecordSet :: Lens' Change ResourceRecordSet Source #
Information about the resource record set to create, delete, or update.
ChangeBatch
data ChangeBatch Source #
The information for a change request.
See: changeBatch smart constructor.
Arguments
| :: NonEmpty Change | |
| -> ChangeBatch |
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 #
Information about the changes to make to the record sets.
ChangeInfo
data ChangeInfo Source #
A complex type that describes change information about changes made to your hosted zone.
See: changeInfo smart constructor.
Instances
Arguments
| :: ResourceId | |
| -> ChangeStatus | |
| -> UTCTime | |
| -> ChangeInfo |
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- A complex type that describes change information about changes made to your hosted zone. This element contains an ID that you use when performing aGetChangeaction to get detailed information about the change.ciId- The ID of the request.ciStatus- The current state of the request.PENDINGindicates that this request has not yet been applied to all Amazon Route 53 DNS servers.ciSubmittedAt- The date and time the change request was submitted, in Coordinated Universal Time (UTC) format:YYYY-MM-DDThh:mm:ssZ. For more information, see the Wikipedia entry ISO 8601 .
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 ResourceId Source #
The ID of the request.
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.
ciSubmittedAt :: Lens' ChangeInfo UTCTime Source #
The date and time the change request was submitted, in Coordinated Universal Time (UTC) format: YYYY-MM-DDThh:mm:ssZ . For more information, see the Wikipedia entry ISO 8601 .
CloudWatchAlarmConfiguration
data CloudWatchAlarmConfiguration Source #
A complex type that contains information about the CloudWatch alarm that Amazon Route 53 is monitoring for this health check.
See: cloudWatchAlarmConfiguration smart constructor.
Instances
cloudWatchAlarmConfiguration Source #
Arguments
| :: Natural | |
| -> Double | |
| -> ComparisonOperator | |
| -> Natural | |
| -> Text | |
| -> Text | |
| -> Statistic | |
| -> CloudWatchAlarmConfiguration |
Creates a value of CloudWatchAlarmConfiguration with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
cwacDimensions- 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 .cwacEvaluationPeriods- For the metric that the CloudWatch alarm is associated with, the number of periods that the metric is compared to the threshold.cwacThreshold- For the metric that the CloudWatch alarm is associated with, the value the metric is compared with.cwacComparisonOperator- For the metric that the CloudWatch alarm is associated with, the arithmetic operation that is used for the comparison.cwacPeriod- For the metric that the CloudWatch alarm is associated with, the duration of one evaluation period in seconds.cwacMetricName- The name of the CloudWatch metric that the alarm is associated with.cwacNamespace- 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 .cwacStatistic- For the metric that the CloudWatch alarm is associated with, the statistic that is applied to the metric.
cwacDimensions :: Lens' CloudWatchAlarmConfiguration [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 .
cwacEvaluationPeriods :: 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.
cwacThreshold :: Lens' CloudWatchAlarmConfiguration Double Source #
For the metric that the CloudWatch alarm is associated with, the value the metric is compared with.
cwacComparisonOperator :: Lens' CloudWatchAlarmConfiguration ComparisonOperator Source #
For the metric that the CloudWatch alarm is associated with, the arithmetic operation that is used for the comparison.
cwacPeriod :: Lens' CloudWatchAlarmConfiguration Natural Source #
For the metric that the CloudWatch alarm is associated with, the duration of one evaluation period in seconds.
cwacMetricName :: Lens' CloudWatchAlarmConfiguration Text Source #
The name of the CloudWatch metric that the alarm is associated with.
cwacNamespace :: 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 .
cwacStatistic :: Lens' CloudWatchAlarmConfiguration Statistic Source #
For the metric that the CloudWatch alarm is associated with, the statistic that is applied to the metric.
DelegationSet
data DelegationSet Source #
A complex type that describes the name servers for this hosted zone.
See: delegationSet smart constructor.
Arguments
| :: NonEmpty Text | |
| -> DelegationSet |
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- The ID that Amazon Route 53 assigns to a reusable delegation set.dsCallerReference- A unique string that identifies the request, and that allows you to retry failedCreateReusableDelegationSetrequests without the risk of executing the operation twice. You must use a uniqueCallerReferencestring every time you submit aCreateReusableDelegationSetrequest.CallerReferencecan be any unique string, for example, a date/time stamp.dsNameServers- A complex type that contains a list of the authoritative name servers for the hosted zone.
dsId :: Lens' DelegationSet (Maybe ResourceId) Source #
The ID that Amazon Route 53 assigns to a reusable delegation set.
dsCallerReference :: Lens' DelegationSet (Maybe 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.
dsNameServers :: Lens' DelegationSet (NonEmpty Text) Source #
A complex type that contains a list of the authoritative name servers for the hosted zone.
Dimension
For the metric that the CloudWatch alarm is associated with, a complex type that contains information about one dimension.
See: dimension smart constructor.
Creates a value of Dimension with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
dName :: Lens' Dimension Text Source #
For the metric that the CloudWatch alarm is associated with, the name of one dimension.
dValue :: Lens' Dimension Text Source #
For the metric that the CloudWatch alarm is associated with, the value of one dimension.
GeoLocation
data GeoLocation Source #
A complex type that contains information about a geo location.
See: geoLocation smart constructor.
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- The code for the subdivision, for example, a state in the United States or a province in Canada.glCountryCode- The two-letter code for the country.glContinentCode- The two-letter code for the continent. Valid values:AF|AN|AS|EU|OC|NA|SAConstraint: SpecifyingContinentCodewith eitherCountryCodeorSubdivisionCodereturns anInvalidInputerror.
glSubdivisionCode :: Lens' GeoLocation (Maybe Text) Source #
The code for the subdivision, for example, a state in the United States or a province in Canada.
glCountryCode :: Lens' GeoLocation (Maybe Text) Source #
The two-letter code for the country.
glContinentCode :: Lens' GeoLocation (Maybe Text) Source #
The two-letter code for the continent. Valid values: AF | AN | AS | EU | OC | NA | SA Constraint: Specifying ContinentCode with either CountryCode or SubdivisionCode returns an InvalidInput error.
GeoLocationDetails
data GeoLocationDetails Source #
A complex type that contains the codes and full continent, country, and subdivision names for the specified geolocation code.
See: geoLocationDetails smart constructor.
Instances
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- The full name of the subdivision, for example, a state in the United States or a province in Canada.gldSubdivisionCode- The code for the subdivision, for example, a state in the United States or a province in Canada.gldCountryName- The name of the country.gldCountryCode- The two-letter code for the country.gldContinentCode- The two-letter code for the continent.gldContinentName- The full name of the continent.
gldSubdivisionName :: Lens' GeoLocationDetails (Maybe Text) Source #
The full name of the subdivision, for example, a state in the United States or a province in Canada.
gldSubdivisionCode :: Lens' GeoLocationDetails (Maybe Text) Source #
The code for the subdivision, for example, a state in the United States or a province in Canada.
gldCountryName :: Lens' GeoLocationDetails (Maybe Text) Source #
The name of the country.
gldCountryCode :: Lens' GeoLocationDetails (Maybe Text) Source #
The two-letter code for the country.
gldContinentCode :: Lens' GeoLocationDetails (Maybe Text) Source #
The two-letter code for the continent.
gldContinentName :: Lens' GeoLocationDetails (Maybe Text) Source #
The full name of the continent.
HealthCheck
data HealthCheck Source #
A complex type that contains information about one health check that is associated with the current AWS account.
See: healthCheck smart constructor.
Arguments
| :: Text | |
| -> Text | |
| -> HealthCheckConfig | |
| -> Natural | |
| -> HealthCheck |
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:
hcCloudWatchAlarmConfiguration- A complex type that contains information about the CloudWatch alarm that Amazon Route 53 is monitoring for this health check.hcId- The identifier that Amazon Route 53assigned 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.hcCallerReference- A unique string that you specified when you created the health check.hcHealthCheckConfig- A complex type that contains detailed information about one health check.hcHealthCheckVersion- The version of the health check. You can optionally pass this value in a call toUpdateHealthCheckto prevent overwriting another change to the health check.
hcCloudWatchAlarmConfiguration :: 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.
hcId :: Lens' HealthCheck Text Source #
The identifier that Amazon Route 53assigned 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.
hcCallerReference :: Lens' HealthCheck Text Source #
A unique string that you specified when you created the health check.
hcHealthCheckConfig :: Lens' HealthCheck HealthCheckConfig Source #
A complex type that contains detailed information about one health check.
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
data HealthCheckConfig Source #
A complex type that contains information about the health check.
See: healthCheckConfig smart constructor.
Instances
Arguments
| :: HealthCheckType | |
| -> HealthCheckConfig |
Creates a value of HealthCheckConfig with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
hccFailureThreshold- The number of consecutive health checks that an endpoint must pass or fail for 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 .hccIPAddress- 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 forIPAddress, Amazon Route 53 sends a DNS request to resolve the domain name that you specify inFullyQualifiedDomainNameat the interval that you specify inRequestInterval. Using an IP address returned by DNS, Amazon Route 53 then checks the health of the endpoint. 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 forIPAddress. This ensures that the IP address of your instance will never change. For more information, see 'HealthCheckConfig$FullyQualifiedDomainName' . Constraints: Amazon 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: * RFC 5735, Special Use IPv4 Addresses * RFC 6598, IANA-Reserved IPv4 Prefix for Shared Address Space * RFC 5156, Special-Use IPv6 Addresses When the value ofTypeisCALCULATEDorCLOUDWATCH_METRIC, omitIPAddress.hccEnableSNI- Specify whether you want Amazon Route 53 to send the value ofFullyQualifiedDomainNameto the endpoint in theclient_hellomessage during TLS negotiation. This allows the endpoint to respond toHTTPShealth check requests with the applicable SSLTLS certificate. Some endpoints require thatHTTPSrequests include the host name in theclient_hellomessage. If you don't enable SNI, the status of the health check will beSSL 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 SSLTLS configuration on your endpoint and confirm that your certificate is valid. The SSL/TLS certificate on your endpoint includes a domain name in theCommon Namefield and possibly several more in theSubject Alternative Namesfield. One of the domain names in the certificate should match the value that you specify forFullyQualifiedDomainName. If the endpoint responds to theclient_hellomessage with a certificate that does not include the domain name that you specified inFullyQualifiedDomainName, a health checker will retry the handshake. In the second attempt, the health checker will omitFullyQualifiedDomainNamefrom theclient_hellomessage.hccSearchString- If the value of Type isHTTP_STR_MATCHorHTTP_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, Amazon Route 53 considers the resource healthy. Amazon Route 53 considers case when searching forSearchStringin the response body.hccHealthThreshold- The number of child health checks that are associated with aCALCULATEDhealth that Amazon Route 53 must consider healthy for theCALCULATEDhealth check to be considered healthy. To specify the child health checks that you want to associate with aCALCULATEDhealth check, use the 'HealthCheckConfig$ChildHealthChecks' and 'HealthCheckConfig$ChildHealthChecks' elements. Note the following: * If you specify a number greater than the number of child health checks, Amazon Route 53 always considers this health check to be unhealthy. * If you specify0, Amazon Route 53 always considers this health check to be healthy.hccRegions- 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.hccResourcePath- 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 docsroute53-health-check.html.hccInsufficientDataHealthStatus- 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: Amazon Route 53 considers the health check to be healthy. *Unhealthy: Amazon Route 53 considers the health check to be unhealthy. *LastKnownStatus: Amazon Route 53uses 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.hccAlarmIdentifier- A complex type that identifies the CloudWatch alarm that you want Amazon Route 53 health checkers to use to determine whether this health check is healthy.hccMeasureLatency- Specify 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 on the Health Checks page in the Amazon Route 53 console. Important: You can't change the value ofMeasureLatencyafter you create a health check.hccInverted- 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.hccFullyQualifiedDomainName- Amazon Route 53 behavior depends on whether you specify a value forIPAddress. If you specify a value forIPAddress: Amazon Route 53 sends health check requests to the specified IPv4 or IPv6 address and passes the value ofFullyQualifiedDomainNamein theHostheader for all health checks except TCP health checks. This is typically the fully qualified DNS name of the endpoint on which you want Amazon Route 53 to perform health checks. When Amazon Route 53 checks the health of an endpoint, here is how it constructs theHostheader: * If you specify a value of80forPortandHTTPorHTTP_STR_MATCHforType, Amazon Route 53 passes the value ofFullyQualifiedDomainNameto the endpoint in the Host header. * If you specify a value of443forPortandHTTPSorHTTPS_STR_MATCHforType, Amazon Route 53 passes the value ofFullyQualifiedDomainNameto the endpoint in theHostheader. * If you specify another value forPortand any value exceptTCPforType, Amazon Route 53 passesFullyQualifiedDomainName:Portto the endpoint in theHostheader. If you don't specify a value forFullyQualifiedDomainName, Amazon Route 53 substitutes the value ofIPAddressin theHostheader in each of the preceding cases. If you don't specify a value forIPAddress: Amazon Route 53 sends a DNS request to the domain that you specify forFullyQualifiedDomainNameat the interval that you specify forRequestInterval. Using an IPv4 address that DNS returns, Amazon Route 53 then checks the health of the endpoint. If you want to check the health of weighted, latency, or failover resource record sets and you choose to specify the endpoint only byFullyQualifiedDomainName, 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 ofFullyQualifiedDomainName, specify the domain name of the server (such as us-east-1-www.example.com), not the name of the resource record sets (www.example.com). Important: In this configuration, if you create a health check for which the value ofFullyQualifiedDomainNamematches 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 forTypeisHTTP,HTTPS,HTTP_STR_MATCH, orHTTPS_STR_MATCH, Amazon Route 53 passes the value ofFullyQualifiedDomainNamein theHostheader, as it does when you specify a value forIPAddress. If the value ofTypeisTCP, Amazon Route 53 doesn't pass aHostheader.hccChildHealthChecks- (CALCULATED Health Checks Only) A complex type that contains oneChildHealthCheckelement for each health check that you want to associate with aCALCULATEDhealth check.hccRequestInterval- 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. Important: You can't change the value ofRequestIntervalafter you create a health check.hccPort- The port on the endpoint on which you want Amazon Route 53 to perform health checks. Specify a value for Port only when you specify a value forIPAddress.hccType- The type of health check that you want to create, which indicates how Amazon Route 53 determines whether an endpoint is healthy. Important: You can't change the value ofTypeafter you create a health check. You can create the following types of health checks: * HTTP : Amazon Route 53 tries to establish a TCP connection. If successful, Amazon Route 53 submits an HTTP request and waits for an HTTP status code of 200 or greater and less than 400. * HTTPS : Amazon Route 53 tries to establish a TCP connection. If successful, Amazon Route 53 submits an HTTPS request and waits for an HTTP status code of 200 or greater and less than 400. Important: If you specifyHTTPSfor the value ofType, the endpoint must support TLS v1.0 or later. * HTTP_STR_MATCH : Amazon Route 53 tries to establish a TCP connection. If successful, Amazon Route 53 submits an HTTP request and searches the first 5,120 bytes of the response body for the string that you specify inSearchString. * HTTPS_STR_MATCH : Amazon Route 53 tries to establish a TCP connection. If successful, Amazon Route 53 submits anHTTPSrequest and searches the first 5,120 bytes of the response body for the string that you specify inSearchString. * TCP : Amazon 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 isOK, the health check is considered healthy. If the state isALARM, the health check is considered unhealthy. If CloudWatch doesn't have sufficient data to determine whether the state isOKorALARM, the health check status depends on the setting forInsufficientDataHealthStatus:Healthy,Unhealthy, orLastKnownStatus. * CALCULATED : For health checks that monitor the status of other health checks, Amazon Route 53 adds up the number of health checks that Amazon Route 53 health checkers consider to be healthy and compares that number with the value ofHealthThreshold. For more information about how Amazon Route 53 determines whether an endpoint is healthy, see the introduction to this topic.
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. 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 #
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 , Amazon 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, Amazon Route 53 then checks the health of the endpoint. 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 'HealthCheckConfig$FullyQualifiedDomainName' . Constraints: Amazon 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: * RFC 5735, Special Use IPv4 Addresses * RFC 6598, IANA-Reserved IPv4 Prefix for Shared Address Space * RFC 5156, Special-Use IPv6 Addresses When the value of Type is CALCULATED or CLOUDWATCH_METRIC , omit IPAddress .
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. This allows the endpoint to respond to HTTPS health check requests with the applicable SSLTLS 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 SSLTLS 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.
hccSearchString :: Lens' HealthCheckConfig (Maybe Text) Source #
If the value of Type is HTTP_STR_MATCH or HTTP_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, Amazon Route 53 considers the resource healthy. Amazon Route 53 considers case when searching for SearchString in the response body.
hccHealthThreshold :: Lens' HealthCheckConfig (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 'HealthCheckConfig$ChildHealthChecks' and 'HealthCheckConfig$ChildHealthChecks' elements. Note the following: * If you specify a number greater than the number of child health checks, Amazon Route 53 always considers this health check to be unhealthy. * If you specify 0 , Amazon Route 53 always considers this health check to be healthy.
hccRegions :: 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.
hccResourcePath :: 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 docsroute53-health-check.html.
hccInsufficientDataHealthStatus :: 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 : Amazon Route 53 considers the health check to be healthy. * Unhealthy : Amazon Route 53 considers the health check to be unhealthy. * LastKnownStatus : Amazon Route 53uses 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.
hccAlarmIdentifier :: 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 this health check is healthy.
hccMeasureLatency :: Lens' HealthCheckConfig (Maybe Bool) Source #
Specify 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 on the Health Checks page in the Amazon Route 53 console. Important: You can't change the value of MeasureLatency after you create a health check.
hccInverted :: 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.
hccFullyQualifiedDomainName :: 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 Amazon Route 53 to perform health checks. When Amazon 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 , Amazon 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 , Amazon 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 , Amazon Route 53 passes FullyQualifiedDomainName:Port to the endpoint in the Host header. If you don't specify a value for FullyQualifiedDomainName , Amazon 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 : Amazon 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, Amazon Route 53 then checks the health of the endpoint. 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-1-www.example.com), not the name of the resource record sets (www.example.com). Important: 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 , Amazon 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 , Amazon Route 53 doesn't pass a Host header.
hccChildHealthChecks :: Lens' HealthCheckConfig [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.
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. Important: You can't change the value of RequestInterval after you create a health check.
hccPort :: Lens' HealthCheckConfig (Maybe Natural) Source #
The port on the endpoint on which you want Amazon Route 53 to perform health checks. Specify a value for Port only when you specify a value for IPAddress .
hccType :: 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. Important: You can't change the value of Type after you create a health check. You can create the following types of health checks: * HTTP : Amazon Route 53 tries to establish a TCP connection. If successful, Amazon Route 53 submits an HTTP request and waits for an HTTP status code of 200 or greater and less than 400. * HTTPS : Amazon Route 53 tries to establish a TCP connection. If successful, Amazon Route 53 submits an HTTPS request and waits for an HTTP status code of 200 or greater and less than 400. Important: If you specify HTTPS for the value of Type , the endpoint must support TLS v1.0 or later. * HTTP_STR_MATCH : Amazon Route 53 tries to establish a TCP connection. If successful, Amazon 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 : Amazon Route 53 tries to establish a TCP connection. If successful, Amazon 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 : Amazon 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, Amazon Route 53 adds up the number of health checks that Amazon Route 53 health checkers consider to be healthy and compares that number with the value of HealthThreshold . For more information about how Amazon Route 53 determines whether an endpoint is healthy, see the introduction to this topic.
HealthCheckObservation
data HealthCheckObservation Source #
A complex type that contains the last failure reason as reported by one Amazon Route 53 health checker.
See: healthCheckObservation smart constructor.
Instances
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- The IP address of the Amazon Route 53 health checker that provided the failure reason inStatusReport.hcoStatusReport- 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.hcoRegion- The region of the Amazon Route 53 health checker that provided the status in StatusReport.
hcoIPAddress :: Lens' HealthCheckObservation (Maybe Text) Source #
The IP address of the Amazon Route 53 health checker that provided the failure reason in StatusReport .
hcoStatusReport :: 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.
hcoRegion :: Lens' HealthCheckObservation (Maybe HealthCheckRegion) Source #
The region of the Amazon Route 53 health checker that provided the status in StatusReport.
HostedZone
data HostedZone Source #
A complex type that contains general information about the hosted zone.
See: hostedZone smart constructor.
Instances
Arguments
| :: ResourceId | |
| -> Text | |
| -> Text | |
| -> HostedZone |
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- A complex type that includes theCommentandPrivateZoneelements. If you omitted theHostedZoneConfigandCommentelements from the request, theConfigandCommentelements don't appear in the response.hzResourceRecordSetCount- The number of resource record sets in the hosted zone.hzId- The ID that Amazon Route 53 assigned to the hosted zone when you created it.hzName- 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 thana-z,0-9, and-(hyphen) and how to specify internationalized domain names, seeCreateHostedZone.hzCallerReference- The value that you specified forCallerReferencewhen you created the hosted zone.
hzConfig :: 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.
hzResourceRecordSetCount :: Lens' HostedZone (Maybe Integer) Source #
The number of resource record sets in the hosted zone.
hzId :: Lens' HostedZone ResourceId Source #
The ID that Amazon Route 53 assigned to the hosted zone when you created it.
hzName :: 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 .
hzCallerReference :: Lens' HostedZone Text Source #
The value that you specified for CallerReference when you created 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, omit both the HostedZoneConfig and Comment elements.
See: hostedZoneConfig smart constructor.
Instances
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:
hzcPrivateZone- A value that indicates whether this is a private hosted zone.hzcComment- Any comments that you want to include about the hosted zone.
hzcPrivateZone :: Lens' HostedZoneConfig (Maybe Bool) Source #
A value that indicates whether this is a private hosted zone.
hzcComment :: Lens' HostedZoneConfig (Maybe Text) Source #
Any comments that you want to include about the hosted zone.
ResourceRecord
data ResourceRecord Source #
Information specific to the resource record.
See: resourceRecord smart constructor.
Instances
Arguments
| :: Text | |
| -> 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- The current or new DNS record value, not to exceed 4,000 characters. In the case of aDELETEaction, if the current value does not match the actual value, an error is returned. For descriptions about how to formatValuefor 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 exceptCNAMEandSOA.
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
data ResourceRecordSet Source #
Information about the resource record set to create or delete.
See: resourceRecordSet smart constructor.
Instances
Arguments
| :: Text | |
| -> RecordType | |
| -> ResourceRecordSet |
Creates a value of ResourceRecordSet with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rrsTTL- The resource record cache time to live (TTL), in seconds. Note the following: * If you're creating an alias resource record set, omitTTL. Amazon Route 53 uses the value ofTTLfor the alias target. * If you're associating this resource record set with a health check (if you're adding aHealthCheckIdelement), we recommend that you specify aTTLof 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 forTTL. * 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 aTTLof 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 forWeight.rrsResourceRecords- Information about the resource records to act upon.rrsAliasTarget- Alias resource record sets only: Information about the CloudFront distribution, AWS Elastic Beanstalk environment, ELB load balancer, Amazon S3 bucket, or Amazon Route 53 resource record set to which you are redirecting queries. The AWS Elastic Beanstalk environment must have a regionalized subdomain. If you're creating resource records sets for a private hosted zone, note the following: * You can't create alias resource record sets for CloudFront distributions in a private hosted zone. * 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 .rrsWeight- 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 theWeightelement for every weighted resource record set. * You can only specify oneResourceRecordper weighted resource record set. * You can't create latency, failover, or geolocation resource record sets that have the same values for theNameandTypeelements as weighted resource record sets. * You can create a maximum of 100 weighted resource record sets that have the same values for theNameandTypeelements. * For weighted (but not weighted alias) resource record sets, if you setWeightto0for a resource record set, Amazon Route 53 never responds to queries with the applicable value for that resource record set. However, if you setWeightto0for 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 settingWeightto0is 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 .rrsTrafficPolicyInstanceId- When you create a traffic policy instance, Amazon Route 53 automatically creates a resource record set.TrafficPolicyInstanceIdis the ID of the traffic policy instance that Amazon Route 53 created this resource record set for. Important: To delete the resource record set that is associated with a traffic policy instance, useDeleteTrafficPolicyInstance. Amazon Route 53 will delete the resource record set automatically. If you delete the resource record set by usingChangeResourceRecordSets, Amazon 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.rrsSetIdentifier- 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 ofSetIdentifiermust be unique for each resource record set that has the same combination of DNS name and type. OmitSetIdentifierfor any other types of record sets.rrsFailover- Failover resource record sets only: To configure failover, you add theFailoverelement to two resource record sets. For one resource record set, you specifyPRIMARYas the value forFailover; for the other resource record set, you specifySECONDARY. In addition, you include theHealthCheckIdelement 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 theHealthCheckIdelement 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 theHealthCheckIdelement 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 can't create non-failover resource record sets that have the same values for theNameandTypeelements as failover resource record sets. For failover alias resource record sets, you must also include theEvaluateTargetHealthelement and set the value to true. For more information about configuring failover for Amazon Route 53, see the following topics in the Amazon Route 53 Developer Guide : * Amazon Route 53 Health Checks and DNS Failover * Configuring Failover in a Private Hosted Zone Valid values:PRIMARY|SECONDARYrrsHealthCheckId- If you want Amazon Route 53 to return this resource record set in response to a DNS query only when a health check is passing, include theHealthCheckIdelement and specify the ID of the applicable health check. Amazon 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) For information about how Amazon Route 53 determines whether a health check is healthy, seeCreateHealthCheck. TheHealthCheckIdelement is only useful when Amazon Route 53 is choosing between two or more resource record sets to respond to a DNS query, and you want Amazon Route 53 to base the choice in part on the status of a health check. Configuring health checks only makes sense in the following configurations: * You're checking the health of the resource record sets in a weighted, latency, geolocation, or failover resource record set, and you specify health check IDs for all of the resource record sets. If the health check for one resource record set specifies an endpoint that is not healthy, Amazon Route 53 stops responding to queries using the value for that resource record set. * You setEvaluateTargetHealthto true for the resource record sets in an alias, weighted alias, latency alias, geolocation alias, or failover alias resource record set, and you specify health check IDs for all of the resource record sets that are referenced by the alias resource record sets. Important: Amazon Route 53 doesn't check the health of the endpoint specified in the resource record set, for example, the endpoint specified by the IP address in theValueelement. When you add aHealthCheckIdelement to a resource record set, Amazon Route 53 checks the health of the endpoint that you specified in the health check. For geolocation resource record sets, if an endpoint is unhealthy, Amazon 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 United States, for North America, and for all locations. If the endpoint for the state resource record set is unhealthy, Amazon Route 53 checks the resource record sets for the United States, for North America, and for all locations (a resource record set for which the value ofCountryCodeis*), in that order, until it finds a resource record set for which the endpoint is healthy. 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 eachHTTPserver that is serving content forwww.example.com. For the value ofFullyQualifiedDomainName, specify the domain name of the server (such asus-east-1-www.example.com), not the name of the resource record sets (example.com). Important: n this configuration, if you create a health check for which the value ofFullyQualifiedDomainNamematches the name of the resource record sets and then associate the health check with those resource record sets, health check results will be unpredictable. For more information, see the following topics in the Amazon Route 53 Developer Guide : * Amazon Route 53 Health Checks and DNS Failover * Configuring Failover in a Private Hosted ZonerrsRegion- 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 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. 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 oneResourceRecordper 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 can't create non-latency resource record sets that have the same values for theNameandTypeelements as latency resource record sets.rrsGeoLocation- 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 of192.0.2.111, create a resource record set with aTypeofAand aContinentCodeofAF. 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 theCountryCodeelement matches all geographic locations that aren't specified in other geolocation resource record sets that have the same values for theNameandTypeelements. Important: 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 ofCountryCodeis*, 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 can't create non-geolocation resource record sets that have the same values for theNameandTypeelements as geolocation resource record sets.rrsName- 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 treatswww.example.com(without a trailing dot) andwww.example.com.(with a trailing dot) as identical. For information about how to specify characters other thana-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.comorprod*.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. Important: 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 specifyprod*.example.com.rrsType- 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|NAPTR|NS|PTR|SOA|SPF|SRV|TXTValues for weighted, latency, geolocation, and failover resource record sets:A|AAAA|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. Values for alias resource record sets: * CloudFront distributions:AIf IPv6 is enabled for the distribution, create two resource record sets to route traffic to your distribution, one with a value ofAand one with a value ofAAAA. * AWS Elastic Beanstalk environment that has a regionalized subdomain :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 exceptNSorSOA.
rrsTTL :: Lens' ResourceRecordSet (Maybe Natural) Source #
The resource record cache time to live (TTL), in seconds. 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 #
Information about the resource records to act upon.
rrsAliasTarget :: Lens' ResourceRecordSet (Maybe AliasTarget) Source #
Alias resource record sets only: Information about the CloudFront distribution, AWS Elastic Beanstalk environment, ELB load balancer, Amazon S3 bucket, or Amazon Route 53 resource record set to which you are redirecting queries. The AWS Elastic Beanstalk environment must have a regionalized subdomain. If you're creating resource records sets for a private hosted zone, note the following: * You can't create alias resource record sets for CloudFront distributions in a private hosted zone. * 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 .
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 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, 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 .
rrsTrafficPolicyInstanceId :: 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 Amazon Route 53 created this resource record set for. Important: 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 , Amazon 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.
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. Omit SetIdentifier for any other types of record sets.
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. 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 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 Amazon Route 53, see the following topics in the Amazon Route 53 Developer Guide : * Amazon Route 53 Health Checks and DNS Failover * Configuring Failover in a Private Hosted Zone Valid values: PRIMARY | SECONDARY
rrsHealthCheckId :: 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 a health check is passing, include the HealthCheckId element and specify the ID of the applicable health check. Amazon 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) For information about how Amazon Route 53 determines whether a health check is healthy, see CreateHealthCheck . The HealthCheckId element is only useful when Amazon Route 53 is choosing between two or more resource record sets to respond to a DNS query, and you want Amazon Route 53 to base the choice in part on the status of a health check. Configuring health checks only makes sense in the following configurations: * You're checking the health of the resource record sets in a weighted, latency, geolocation, or failover resource record set, and you specify health check IDs for all of the resource record sets. If the health check for one resource record set specifies an endpoint that is not healthy, Amazon Route 53 stops responding to queries using the value for that resource record set. * You set EvaluateTargetHealth to true for the resource record sets in an alias, weighted alias, latency alias, geolocation alias, or failover alias resource record set, and you specify health check IDs for all of the resource record sets that are referenced by the alias resource record sets. Important: Amazon Route 53 doesn't check the health of the endpoint 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, Amazon Route 53 checks the health of the endpoint that you specified in the health check. For geolocation resource record sets, if an endpoint is unhealthy, Amazon 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 United States, for North America, and for all locations. If the endpoint for the state resource record set is unhealthy, Amazon Route 53 checks the resource record sets for the United States, for North America, and for all locations (a resource record set for which the value of CountryCode is * ), in that order, until it finds a resource record set for which the endpoint is healthy. 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-1-www.example.com ), not the name of the resource record sets (example.com). Important: n this configuration, if you create a health check for which the value of FullyQualifiedDomainName matches the name of the resource record sets and then associate the health check with those resource record sets, health check results will be unpredictable. For more information, see the following topics in the Amazon Route 53 Developer Guide : * Amazon Route 53 Health Checks and DNS Failover * Configuring Failover in a Private Hosted Zone
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 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. 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 can't 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 . 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. Important: 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 can't 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 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. Important: 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 .
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 | NAPTR | NS | PTR | SOA | SPF | SRV | TXT Values for weighted, latency, geolocation, and failover resource record sets: A | AAAA | 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. Values for alias resource record sets: * 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 . * AWS Elastic Beanstalk environment that has a regionalized subdomain : 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
data ResourceTagSet Source #
A complex type containing a resource and its associated tags.
See: resourceTagSet smart constructor.
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- The ID for the specified resource.rtsResourceType- The type of the resource. * The resource type for health checks ishealthcheck. * The resource type for hosted zones ishostedzone.rtsTags- The tags associated with the specified resource.
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 the status that one Amazon Route 53 health checker reports and the time of the health check.
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- A description of the status of the health check endpoint as reported by one of the Amazon Route 53 health checkers.srCheckedTime- The time at which the health checker performed the health check in ISO 8601 format and Coordinated Universal Time (UTC). For example, the value2014-10-27T17:48:16.751Zrepresents October 27, 2014 at 17:48:16.751 UTC.
srStatus :: 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.
srCheckedTime :: Lens' StatusReport (Maybe UTCTime) Source #
The time at which the health checker performed the health check in ISO 8601 format and Coordinated Universal Time (UTC). For example, the value 2014-10-27T17:48:16.751Z represents October 27, 2014 at 17:48:16.751 UTC.
Tag
A complex type that contains information about a tag that you want to add or edit for the specified health check or hosted zone.
See: tag smart constructor.
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- The value ofValuedepends on the operation that you want to perform: * Add a tag to a health check or hosted zone :Valueis the value that you want to give the new tag. * Edit a tag :Valueis the new value that you want to assign the tag.tagKey- The value ofKeydepends on the operation that you want to perform: * Add a tag to a health check or hosted zone :Keyis the name that you want to give the new tag. * Edit a tag :Keyis the name of the tag whoseValueelement you want to remove. * Delete a key :Keyis the name of the tag you want to remove. * Give a name to a health check : Edit the defaultNametag. 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.
tagValue :: 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.
tagKey :: 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 whose Value element you want to remove. * 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
data TrafficPolicy Source #
A complex type that contains settings for a traffic policy.
See: trafficPolicy smart constructor.
Arguments
| :: Text | |
| -> Natural | |
| -> Text | |
| -> RecordType | |
| -> Text | |
| -> TrafficPolicy |
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- The comment that you specify in theCreateTrafficPolicyrequest, if any.tpId- The ID that Amazon Route 53 assigned to a traffic policy when you created it.tpVersion- The version number that Amazon Route 53 assigns to a traffic policy. For a new traffic policy, the value ofVersionis always 1.tpName- The name that you specified when you created the traffic policy.tpType- 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.tpDocument- The definition of a traffic policy in JSON format. You specify the JSON document to use for a new traffic policy in theCreateTrafficPolicyrequest. For more information about the JSON format, see Traffic Policy Document Format .
tpComment :: Lens' TrafficPolicy (Maybe Text) Source #
The comment that you specify in the CreateTrafficPolicy request, if any.
tpId :: Lens' TrafficPolicy Text Source #
The ID that Amazon Route 53 assigned to a traffic policy when you created it.
tpVersion :: 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.
tpName :: Lens' TrafficPolicy Text Source #
The name that you specified when you created the traffic policy.
tpType :: Lens' TrafficPolicy RecordType 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.
tpDocument :: 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
data TrafficPolicyInstance Source #
A complex type that contains settings for the new traffic policy instance.
See: trafficPolicyInstance smart constructor.
Instances
trafficPolicyInstance Source #
Arguments
| :: Text | |
| -> ResourceId | |
| -> Text | |
| -> Natural | |
| -> Text | |
| -> Text | |
| -> Text | |
| -> Natural | |
| -> RecordType | |
| -> TrafficPolicyInstance |
Creates a value of TrafficPolicyInstance with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
tpiId- The ID that Amazon Route 53 assigned to the new traffic policy instance.tpiHostedZoneId- The ID of the hosted zone that Amazon Route 53 created resource record sets in.tpiName- 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.tpiTTL- The TTL that Amazon Route 53 assigned to all of the resource record sets that it created in the specified hosted zone.tpiState- The value ofStateis one of the following values: * Applied * Amazon Route 53 has finished creating resource record sets, and changes have propagated to all Amazon Route 53 edge locations. * Creating * Amazon Route 53 is creating the resource record sets. UseGetTrafficPolicyInstanceto confirm that theCreateTrafficPolicyInstancerequest completed successfully. * Failed * Amazon Route 53 wasn't able to create or update the resource record sets. When the value ofStateisFailed, seeMessagefor an explanation of what caused the request to fail.tpiMessage- IfStateisFailed, an explanation of the reason for the failure. IfStateis another value,Messageis empty.tpiTrafficPolicyId- The ID of the traffic policy that Amazon Route 53 used to create resource record sets in the specified hosted zone.tpiTrafficPolicyVersion- The version of the traffic policy that Amazon Route 53 used to create resource record sets in the specified hosted zone.tpiTrafficPolicyType- The DNS type that Amazon Route 53 assigned to all of the resource record sets that it created for this traffic policy instance.
tpiId :: Lens' TrafficPolicyInstance Text Source #
The ID that Amazon Route 53 assigned to the new traffic policy instance.
tpiHostedZoneId :: Lens' TrafficPolicyInstance ResourceId Source #
The ID of the hosted zone that Amazon Route 53 created resource record sets in.
tpiName :: 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.
tpiTTL :: 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.
tpiState :: 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 Amazon Route 53 edge locations. * Creating * Amazon Route 53 is creating the resource record sets. Use GetTrafficPolicyInstance to confirm that the CreateTrafficPolicyInstance request completed successfully. * Failed * Amazon 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.
tpiMessage :: Lens' TrafficPolicyInstance Text Source #
If State is Failed , an explanation of the reason for the failure. If State is another value, Message is empty.
tpiTrafficPolicyId :: 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.
tpiTrafficPolicyVersion :: 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.
tpiTrafficPolicyType :: Lens' TrafficPolicyInstance RecordType 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
data TrafficPolicySummary Source #
A complex type that contains information about the latest version of one traffic policy that is associated with the current AWS account.
See: trafficPolicySummary smart constructor.
Instances
Arguments
| :: Text | |
| -> Text | |
| -> RecordType | |
| -> Natural | |
| -> Natural | |
| -> TrafficPolicySummary |
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- The ID that Amazon Route 53 assigned to the traffic policy when you created it.tpsName- The name that you specified for the traffic policy when you created it.tpsType- 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.tpsLatestVersion- The version number of the latest version of the traffic policy.tpsTrafficPolicyCount- The number of traffic policies that are associated with the current AWS account.
tpsId :: Lens' TrafficPolicySummary Text Source #
The ID that Amazon Route 53 assigned to the traffic policy when you created it.
tpsName :: Lens' TrafficPolicySummary Text Source #
The name that you specified for the traffic policy when you created it.
tpsType :: Lens' TrafficPolicySummary RecordType 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.
tpsLatestVersion :: Lens' TrafficPolicySummary Natural Source #
The version number of the latest version of the traffic policy.
tpsTrafficPolicyCount :: Lens' TrafficPolicySummary Natural Source #
The number of traffic policies that are associated with the current AWS account.
VPC
A complex type that contains information about an Amazon VPC that is associated with a private hosted zone.
See: vpc smart constructor.
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- The region in which you created the VPC that you want to associate with the specified Amazon Route 53 hosted zone.vpcVPCId- Undocumented member.