| 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
- 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
- _PriorRequestNotComplete :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidChangeBatch :: AsError a => Getting (First ServiceError) a ServiceError
- _TrafficPolicyAlreadyExists :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidTrafficPolicyDocument :: 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
- _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 :: *
- 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 :: Text -> Text -> Bool -> AliasTarget
- atHostedZoneId :: Lens' AliasTarget Text
- 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 :: Text -> ChangeStatus -> UTCTime -> ChangeInfo
- ciComment :: Lens' ChangeInfo (Maybe Text)
- ciId :: Lens' ChangeInfo Text
- 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 Text)
- 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 :: Text -> Text -> Text -> HostedZone
- hzConfig :: Lens' HostedZone (Maybe HostedZoneConfig)
- hzResourceRecordSetCount :: Lens' HostedZone (Maybe Integer)
- hzId :: Lens' HostedZone Text
- 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 -> Text -> Text -> Natural -> Text -> Text -> Text -> Natural -> RecordType -> TrafficPolicyInstance
- tpiId :: Lens' TrafficPolicyInstance Text
- tpiHostedZoneId :: Lens' TrafficPolicyInstance Text
- 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 #
Prism for HealthCheckVersionMismatch' errors.
_InvalidInput :: AsError a => Getting (First ServiceError) a ServiceError Source #
Some value specified in the request is invalid or the XML document is malformed.
_HostedZoneNotEmpty :: AsError a => Getting (First ServiceError) a ServiceError Source #
The hosted zone contains resource record sets in addition to the default NS and SOA resource record sets. Before you can delete the hosted zone, you must delete the additional resource record sets.
_InvalidArgument :: AsError a => Getting (First ServiceError) a ServiceError Source #
At least one of the specified arguments is invalid.
_TrafficPolicyInstanceAlreadyExists :: AsError a => Getting (First ServiceError) a ServiceError Source #
Traffic policy instance with given Id already exists.
_ConflictingTypes :: AsError a => Getting (First ServiceError) a ServiceError Source #
You tried to update a traffic policy instance by using a traffic policy
version that has a different DNS type than the current type for the
instance. You specified the type in the JSON document in the
CreateTrafficPolicy or CreateTrafficPolicyVersionrequest.
_ConcurrentModification :: AsError a => Getting (First ServiceError) a ServiceError Source #
Another user submitted a request to update the object at the same time that you did. Retry the request.
_DelegationSetAlreadyReusable :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified delegation set has already been marked as reusable.
_PriorRequestNotComplete :: AsError a => Getting (First ServiceError) a ServiceError Source #
The request was rejected because Amazon Route 53 was still processing a prior request.
_InvalidChangeBatch :: AsError a => Getting (First ServiceError) a ServiceError Source #
This error contains a list of one or more error messages. Each error message indicates one error in the change batch. For more information, see Example InvalidChangeBatch Errors.
_TrafficPolicyAlreadyExists :: AsError a => Getting (First ServiceError) a ServiceError Source #
A traffic policy that has the same value for Name already exists.
_InvalidTrafficPolicyDocument :: AsError a => Getting (First ServiceError) a ServiceError Source #
The format of the traffic policy document that you specified in the
Document element is invalid.
_DelegationSetNotReusable :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified delegation set has not been marked as reusable.
_InvalidDomainName :: AsError a => Getting (First ServiceError) a ServiceError Source #
This error indicates that the specified domain name is not valid.
_NoSuchTrafficPolicy :: AsError a => Getting (First ServiceError) a ServiceError Source #
No traffic policy exists with the specified ID.
_HostedZoneNotFound :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified HostedZone cannot be found.
_DelegationSetInUse :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified delegation contains associated hosted zones which must be deleted before the reusable delegation set can be deleted.
_NoSuchDelegationSet :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified delegation set does not exist.
_HealthCheckAlreadyExists :: AsError a => Getting (First ServiceError) a ServiceError Source #
The health check you are trying to create already exists. Amazon Route
53 returns this error when a health check has already been created with
the specified CallerReference.
_TooManyTrafficPolicies :: AsError a => Getting (First ServiceError) a ServiceError Source #
You've created the maximum number of traffic policies that can be created for the current AWS account. You can request an increase to the limit on the Contact Us page.
_NoSuchGeoLocation :: AsError a => Getting (First ServiceError) a ServiceError Source #
The geo location you are trying to get does not exist.
_DelegationSetNotAvailable :: AsError a => Getting (First ServiceError) a ServiceError Source #
Amazon Route 53 allows some duplicate domain names, but there is a maximum number of duplicate names. This error indicates that you have reached that maximum. If you want to create another hosted zone with the same name and Amazon Route 53 generates this error, you can request an increase to the limit on the Contact Us page.
_VPCAssociationNotFound :: AsError a => Getting (First ServiceError) a ServiceError Source #
The VPC you specified is not currently associated with the hosted zone.
_ThrottlingException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Prism for ThrottlingException' errors.
_NoSuchChange :: AsError a => Getting (First ServiceError) a ServiceError Source #
Prism for NoSuchChange' errors.
_LimitsExceeded :: AsError a => Getting (First ServiceError) a ServiceError Source #
The limits specified for a resource have been exceeded.
_TooManyTrafficPolicyInstances :: AsError a => Getting (First ServiceError) a ServiceError Source #
You've created the maximum number of traffic policy instances that can be created for the current AWS account. You can request an increase to the limit on the Contact Us page.
_NoSuchTrafficPolicyInstance :: AsError a => Getting (First ServiceError) a ServiceError Source #
No traffic policy instance exists with the specified ID.
_IncompatibleVersion :: AsError a => Getting (First ServiceError) a ServiceError Source #
The resource you are trying to access is unsupported on this Amazon Route 53 endpoint. Please consider using a newer endpoint or a tool that does so.
_PublicZoneVPCAssociation :: AsError a => Getting (First ServiceError) a ServiceError Source #
The hosted zone you are trying to associate VPC with doesn't have any VPC association. Amazon Route 53 currently doesn't support associate a VPC with a public hosted zone.
_NoSuchHostedZone :: AsError a => Getting (First ServiceError) a ServiceError Source #
Prism for NoSuchHostedZone' errors.
_TooManyHostedZones :: AsError a => Getting (First ServiceError) a ServiceError Source #
This error indicates that you've reached the maximum number of hosted zones that can be created for the current AWS account. You can request an increase to the limit on the Contact Us page.
_HealthCheckInUse :: AsError a => Getting (First ServiceError) a ServiceError Source #
There are resource records associated with this health check. Before you can delete the health check, you must disassociate it from the resource record sets.
_DelegationSetAlreadyCreated :: AsError a => Getting (First ServiceError) a ServiceError Source #
A delegation set with the same owner and caller reference combination has already been created.
_ConflictingDomainExists :: AsError a => Getting (First ServiceError) a ServiceError Source #
Prism for ConflictingDomainExists' errors.
_LastVPCAssociation :: AsError a => Getting (First ServiceError) a ServiceError Source #
The VPC you are trying to disassociate from the hosted zone is the last the VPC that is associated with the hosted zone. Amazon Route 53 currently doesn't support disassociate the last VPC from the hosted zone.
_TooManyHealthChecks :: AsError a => Getting (First ServiceError) a ServiceError Source #
Prism for TooManyHealthChecks' errors.
_NoSuchHealthCheck :: AsError a => Getting (First ServiceError) a ServiceError Source #
The health check you are trying to get or delete does not exist.
_TrafficPolicyInUse :: AsError a => Getting (First ServiceError) a ServiceError Source #
One or more traffic policy instances were created by using the specified traffic policy.
_InvalidVPCId :: AsError a => Getting (First ServiceError) a ServiceError Source #
The hosted zone you are trying to create for your VPC_ID does not belong
to you. Amazon Route 53 returns this error when the VPC specified by
VPCId does not belong to you.
_HostedZoneAlreadyExists :: AsError a => Getting (First ServiceError) a ServiceError Source #
The hosted zone you are trying to create already exists. Amazon Route 53
returns this error when a hosted zone has already been created with the
specified CallerReference.
Re-exported Types
The sum of available AWS regions.
Constructors
| Ireland | Europe / eu-west-1 |
| Frankfurt | Europe / eu-central-1 |
| Tokyo | Asia Pacific / ap-northeast-1 |
| Singapore | Asia Pacific / ap-southeast-1 |
| Sydney | Asia Pacific / ap-southeast-2 |
| Beijing | China / cn-north-1 |
| NorthVirginia | US / us-east-1 |
| NorthCalifornia | US / us-west-1 |
| Oregon | US / us-west-2 |
| GovCloud | AWS GovCloud / us-gov-west-1 |
| GovCloudFIPS | AWS GovCloud (FIPS 140-2) S3 Only / fips-us-gov-west-1 |
| SaoPaulo | South America / sa-east-1 |
ChangeAction
data ChangeAction Source #
Instances
ChangeStatus
data ChangeStatus Source #
Instances
CloudWatchRegion
data CloudWatchRegion Source #
Constructors
| CWRApNortheast1 | |
| CWRApNortheast2 | |
| CWRApSoutheast1 | |
| CWRApSoutheast2 | |
| CWREuCentral1 | |
| CWREuWest1 | |
| CWRSaEast1 | |
| CWRUsEast1 | |
| 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 | |
| ApSoutheast1 | |
| ApSoutheast2 | |
| CnNorth1 | |
| EuCentral1 | |
| EuWest1 | |
| SaEast1 | |
| UsEast1 | |
| UsWest1 | |
| UsWest2 |
Instances
AlarmIdentifier
data AlarmIdentifier Source #
A complex type that contains information to uniquely identify the CloudWatch alarm that you're associating with a Route 53 health check.
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 :: Lens' AlarmIdentifier CloudWatchRegion Source #
The CloudWatchRegion that the CloudWatch alarm was created in.
AliasTarget
data AliasTarget Source #
Alias resource record sets only: Information about the CloudFront distribution, ELB load balancer, Amazon S3 bucket, or Amazon Route 53 resource record set to which you are routing traffic.
If you're creating resource record sets for a private hosted zone, note the following:
- You can create alias resource record sets only for Amazon Route 53 resource record sets in the same private hosted zone. Creating alias resource record sets for CloudFront distributions, ELB load balancers, and Amazon S3 buckets is not supported.
- You can't create alias resource record sets for failover, geolocation, or latency resource record sets in a private hosted zone.
For more information and an example, see Example: Creating Alias Resource Record Sets in the Amazon Route 53 API Reference.
See: aliasTarget smart constructor.
Arguments
| :: Text | |
| -> 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 :: Lens' AliasTarget Text Source #
Alias resource record sets only: The value you use depends on where you want to route queries:
- A CloudFront distribution: Specify
Z2FDTNDATAQYW2. - An ELB load balancer: Specify the value of the hosted zone ID for
the load balancer. You can get the hosted zone ID by using the AWS
Management Console, the ELB API, or the AWS CLI. Use the same method
to get values for
HostedZoneIdandDNSName. If you get one value from the console and the other value from the API or the CLI, creating the resource record set will fail. - An Amazon S3 bucket that is configured as a static website: Specify the hosted zone ID for the Amazon S3 website endpoint in which you created the bucket. For more information about valid values, see the table Amazon Simple Storage Service (S3) Website Endpoints in the Amazon Web Services General Reference.
- Another Amazon Route 53 resource record set in your hosted zone: Specify the hosted zone ID of your hosted zone. (An alias resource record set cannot reference a resource record set in a different hosted zone.)
For more information and an example, see Example: Creating Alias Resource Record Sets in the Amazon Route 53 API Reference.
atDNSName :: Lens' AliasTarget Text Source #
Alias resource record sets only: The external DNS name associated with the AWS Resource. The value that you specify depends on where you want to route queries:
- A CloudFront distribution: Specify the domain name that CloudFront assigned when you created your distribution. Your CloudFront distribution must include an alternate domain name that matches the name of the resource record set. For example, if the name of the resource record set is 'acme.example.com', your CloudFront distribution must include 'acme.example.com' as one of the alternate domain names. For more information, see Using Alternate Domain Names (CNAMEs) in the Amazon CloudFront Developer Guide.
- An ELB load balancer: Specify the DNS name associated with the
load balancer. You can get the DNS name by using the AWS Management
Console, the ELB API, or the AWS CLI. Use the same method to get
values for
HostedZoneIdandDNSName. If you get one value from the console and the other value from the API or the CLI, creating the resource record set will fail. - An Elastic Beanstalk environment: Specify the CNAME attribute for the environment. (The environment must have a regionalized domain name.)
- An Amazon S3 bucket that is configured as a static website: Specify the domain name of the Amazon S3 website endpoint in which you created the bucket; for example, 's3-website-us-east-1.amazonaws.com'. For more information about valid values, see the table Amazon Simple Storage Service (S3) Website Endpoints in the Amazon Web Services General Reference. For more information about using Amazon S3 buckets for websites, see Hosting a Static Website on Amazon S3 in the Amazon Simple Storage Service Developer Guide.
- Another Amazon Route 53 resource record set: Specify the value
of the
Nameelement for a resource record set in the current hosted zone.
For more information and an example, see Example: Creating Alias Resource Record Sets in the Amazon Route 53 API Reference.
atEvaluateTargetHealth :: Lens' AliasTarget Bool Source #
Alias resource record sets only: If you set the value of
EvaluateTargetHealth to true for the resource record set or sets in
an alias, weighted alias, latency alias, or failover alias resource
record set, and if you specify a value for HealthCheckId for every
resource record set that is referenced by these alias resource record
sets, the alias resource record sets inherit the health of the
referenced resource record sets.
In this configuration, when Amazon Route 53 receives a DNS query for an alias resource record set:
- 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 cannot set
EvaluateTargetHealthto true when the alias target is a CloudFront distribution. - If the AWS resource that you specify in
AliasTargetis a resource record set or a group of resource record sets (for example, a group of weighted resource record sets), but it is not another alias resource record set, we recommend that you associate a health check with all of the resource record sets in the alias target. For more information, see What Happens When You Omit Health Checks? in the Amazon Route 53 Developer Guide. - If you specify an ELB load balancer in
AliasTarget, Elastic Load Balancing routes queries only to the healthy Amazon EC2 instances that are registered with the load balancer. If no Amazon EC2 instances are healthy or if the load balancer itself is unhealthy, and ifEvaluateTargetHealthistruefor the corresponding alias resource record set, Amazon Route 53 routes queries to other resources. - When you create a load balancer, you configure settings for Elastic Load Balancing health checks; they're not Amazon Route 53 health checks, but they perform a similar function. Do not create Amazon Route 53 health checks for the Amazon EC2 instances that you register with an ELB load balancer. For more information, see How Health Checks Work in More Complex Amazon Route 53 Configurations in the Amazon Route 53 Developer Guide.
We recommend that you set EvaluateTargetHealth to true only when you
have enough idle capacity to handle the failure of one or more
endpoints.
For more information and examples, see Amazon Route 53 Health Checks and DNS Failover in the Amazon Route 53 Developer Guide.
Change
A complex type that contains the information for each change in a change batch request.
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 :: Lens' Change ChangeAction Source #
The action to perform:
CREATE: Creates a resource record set that has the specified values.DELETE: Deletes a existing resource record set that has the specified values forName,Type,SetIdentifier(for latency, weighted, geolocation, and failover resource record sets), andTTL(except alias resource record sets, for which the TTL is determined by the AWS resource that you're routing DNS queries to).UPSERT: If a resource record set does not already exist, Amazon Route 53 creates it. If a resource record set does exist, Amazon Route 53 updates it with the values in the request. Amazon Route 53 can update an existing resource record set only when all of the following values match:Name,Type, andSetIdentifier(for weighted, latency, geolocation, and failover resource record sets).
cResourceRecordSet :: Lens' Change ResourceRecordSet Source #
Information about the resource record set to create or delete.
ChangeBatch
data ChangeBatch Source #
A complex type that contains an optional comment and the changes that you want to make with a change batch request.
See: changeBatch smart constructor.
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 #
A complex type that contains one Change element for each resource
record set that you want to create or delete.
ChangeInfo
data ChangeInfo Source #
A complex type that describes change information about changes made to your hosted zone.
This element contains an ID that you use when performing a GetChange action to get detailed information about the change.
See: changeInfo smart constructor.
Instances
Arguments
| :: Text | |
| -> 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 :: Lens' ChangeInfo (Maybe Text) Source #
A complex type that describes change information about changes made to your hosted zone.
This element contains an ID that you use when performing a GetChange action to get detailed information about the change.
ciId :: Lens' ChangeInfo Text Source #
The ID of the request. Use this ID to track when the change has completed across all Amazon Route 53 DNS servers.
ciStatus :: Lens' ChangeInfo ChangeStatus Source #
The current state of the request. PENDING indicates that this request
has not yet been applied to all Amazon Route 53 DNS servers.
Valid Values: PENDING | INSYNC
ciSubmittedAt :: Lens' ChangeInfo UTCTime Source #
The date and time the change was submitted, in the format
'YYYY-MM-DDThh:mm:ssZ', as specified in the ISO 8601 standard (for
example, 2009-11-19T19:37:58Z). The Z after the time indicates that
the time is listed in Coordinated Universal Time (UTC).
CloudWatchAlarmConfiguration
data CloudWatchAlarmConfiguration Source #
For CLOUDWATCH_METRIC health checks, a complex type that contains information about the CloudWatch alarm that you're associating with the 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 :: Lens' CloudWatchAlarmConfiguration [Dimension] Source #
A list of Dimension elements for the CloudWatch metric that is
associated with the CloudWatch alarm. For information about the metrics
and dimensions that CloudWatch supports, see
Amazon CloudWatch Namespaces, Dimensions, and Metrics Reference.
cwacEvaluationPeriods :: Lens' CloudWatchAlarmConfiguration Natural Source #
The number of periods over which data is compared to the specified threshold.
cwacThreshold :: Lens' CloudWatchAlarmConfiguration Double Source #
The value that the metric is compared with to determine the state of the alarm. For example, if you want the health check to fail if the average TCP connection time is greater than 500 milliseconds for more than 60 seconds, the threshold is 500.
cwacComparisonOperator :: Lens' CloudWatchAlarmConfiguration ComparisonOperator Source #
The arithmetic operation to use when comparing the specified Statistic and Threshold.
Valid Values are GreaterThanOrEqualToThreshold,
GreaterThanThreshold, LessThanThreshold and
LessThanOrEqualToThreshold
cwacPeriod :: Lens' CloudWatchAlarmConfiguration Natural Source #
An integer that represents the period in seconds over which the statistic is applied.
cwacMetricName :: Lens' CloudWatchAlarmConfiguration Text Source #
The name of the CloudWatch metric that is associated with the CloudWatch alarm.
cwacNamespace :: Lens' CloudWatchAlarmConfiguration Text Source #
The namespace of the CloudWatch metric that is associated with the CloudWatch alarm.
cwacStatistic :: Lens' CloudWatchAlarmConfiguration Statistic Source #
The statistic to apply to the CloudWatch metric that is associated with the CloudWatch alarm.
Valid Values are SampleCount, Average, Sum, Minimum and
Maximum
DelegationSet
data DelegationSet Source #
A complex type that contains name server information.
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:
dsCallerReference :: Lens' DelegationSet (Maybe Text) Source #
Undocumented member.
dsNameServers :: Lens' DelegationSet (NonEmpty Text) Source #
A complex type that contains the authoritative name servers for the
hosted zone. Use the method provided by your domain registrar to add an
NS record to your domain for each NameServer that is assigned to your
hosted zone.
Dimension
The name and value of a dimension for a CloudWatch metric.
See: dimension smart constructor.
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 :: Lens' GeoLocation (Maybe Text) Source #
The code for a country's subdivision (e.g., a province of Canada). A subdivision code is only valid with the appropriate country code.
Constraint: Specifying SubdivisionCode without CountryCode returns
an InvalidInput error.
glCountryCode :: Lens' GeoLocation (Maybe Text) Source #
The code for a country geo location. The default location uses '*' for the country code and will match all locations that are not matched by a geo location.
The default geo location uses a * for the country code. All other
country codes follow the ISO 3166 two-character code.
glContinentCode :: Lens' GeoLocation (Maybe Text) Source #
The code for a continent geo location. Note: only continent locations have a continent code.
Valid values: AF | AN | AS | EU | OC | NA | SA
Constraint: Specifying ContinentCode with either CountryCode or
SubdivisionCode returns an InvalidInput error.
GeoLocationDetails
data GeoLocationDetails Source #
A complex type that contains information about a GeoLocation.
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 :: Lens' GeoLocationDetails (Maybe Text) Source #
The name of the subdivision. This element is only present if
SubdivisionCode is also present.
gldSubdivisionCode :: Lens' GeoLocationDetails (Maybe Text) Source #
The code for a country's subdivision (e.g., a province of Canada). A subdivision code is only valid with the appropriate country code.
gldCountryName :: Lens' GeoLocationDetails (Maybe Text) Source #
The name of the country. This element is only present if CountryCode
is also present.
gldCountryCode :: Lens' GeoLocationDetails (Maybe Text) Source #
The code for a country geo location. The default location uses '*' for the country code and will match all locations that are not matched by a geo location.
The default geo location uses a * for the country code. All other
country codes follow the ISO 3166 two-character code.
gldContinentCode :: Lens' GeoLocationDetails (Maybe Text) Source #
The code for a continent geo location. Note: only continent locations have a continent code.
gldContinentName :: Lens' GeoLocationDetails (Maybe Text) Source #
The name of the continent. This element is only present if
ContinentCode is also present.
HealthCheck
data HealthCheck Source #
A complex type that contains identifying information about the health check.
See: healthCheck smart constructor.
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 :: Lens' HealthCheck (Maybe CloudWatchAlarmConfiguration) Source #
For CLOUDWATCH_METRIC health checks, a complex type that contains information about the CloudWatch alarm that you're associating with the health check.
hcCallerReference :: Lens' HealthCheck Text Source #
A unique string that identifies the request to create the health check.
hcHealthCheckConfig :: Lens' HealthCheck HealthCheckConfig Source #
A complex type that contains the health check configuration.
hcHealthCheckVersion :: Lens' HealthCheck Natural Source #
The version of the health check. You can optionally pass this value in a
call to UpdateHealthCheck to prevent overwriting another change to the
health check.
HealthCheckConfig
data HealthCheckConfig Source #
A complex type that contains the health check configuration.
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 :: Lens' HealthCheckConfig (Maybe Natural) Source #
The number of consecutive health checks that an endpoint must pass or fail for Amazon Route 53 to change the current status of the endpoint from unhealthy to healthy or vice versa.
Valid values are integers between 1 and 10. For more information, see "How Amazon Route 53 Determines Whether an Endpoint Is Healthy" in the Amazon Route 53 Developer Guide.
hccIPAddress :: Lens' HealthCheckConfig (Maybe Text) Source #
IP Address of the instance being checked.
hccEnableSNI :: Lens' HealthCheckConfig (Maybe Bool) Source #
Specify whether you want Amazon Route 53 to send the value of
FullyQualifiedDomainName to the endpoint in the client_hello message
during TLS negotiation. If you don't specify a value for EnableSNI,
Amazon Route 53 defaults to true when Type is HTTPS or
HTTPS_STR_MATCH and defaults to false when Type is any other
value.
hccSearchString :: Lens' HealthCheckConfig (Maybe Text) Source #
A string to search for in the body of a health check response. Required
for HTTP_STR_MATCH and HTTPS_STR_MATCH health checks. Amazon Route 53
considers case when searching for SearchString in the response body.
hccHealthThreshold :: Lens' HealthCheckConfig (Maybe Natural) Source #
The minimum number of child health checks that must be healthy for Amazon Route 53 to consider the parent health check to be healthy. Valid values are integers between 0 and 256, inclusive.
hccRegions :: Lens' HealthCheckConfig (Maybe (NonEmpty HealthCheckRegion)) Source #
A list of HealthCheckRegion values that you want Amazon Route 53 to
use to perform health checks for the specified endpoint. You must
specify at least three regions.
hccResourcePath :: Lens' HealthCheckConfig (Maybe Text) Source #
Path to ping on the instance to check the health. Required for HTTP, HTTPS, HTTP_STR_MATCH, and HTTPS_STR_MATCH health checks. The HTTP request is issued to the instance on the given port and path.
hccInsufficientDataHealthStatus :: Lens' HealthCheckConfig (Maybe InsufficientDataHealthStatus) Source #
The status of the health check when CloudWatch has insufficient data
about the state of associated alarm. Valid values are Healthy,
Unhealthy and LastKnownStatus.
hccAlarmIdentifier :: Lens' HealthCheckConfig (Maybe AlarmIdentifier) Source #
A complex type that contains information to uniquely identify the CloudWatch alarm that you're associating with a Route 53 health check.
hccMeasureLatency :: Lens' HealthCheckConfig (Maybe Bool) Source #
A Boolean value that indicates whether you want Amazon Route 53 to measure the latency between health checkers in multiple AWS regions and your endpoint and to display CloudWatch latency graphs in the Amazon Route 53 console.
hccInverted :: Lens' HealthCheckConfig (Maybe Bool) Source #
A boolean value that indicates whether the status of health check should
be inverted. For example, if a health check is healthy but Inverted is
True, then Amazon Route 53 considers the health check to be unhealthy.
hccFullyQualifiedDomainName :: Lens' HealthCheckConfig (Maybe Text) Source #
Fully qualified domain name of the instance to be health checked.
hccChildHealthChecks :: Lens' HealthCheckConfig [Text] Source #
For a specified parent health check, a list of HealthCheckId values
for the associated child health checks.
hccRequestInterval :: Lens' HealthCheckConfig (Maybe Natural) Source #
The number of seconds between the time that Amazon Route 53 gets a response from your endpoint and the time that it sends the next health-check request.
Each Amazon Route 53 health checker makes requests at this interval. Valid values are 10 and 30. The default value is 30.
hccPort :: Lens' HealthCheckConfig (Maybe Natural) Source #
Port on which connection will be opened to the instance to health check. For HTTP and HTTP_STR_MATCH this defaults to 80 if the port is not specified. For HTTPS and HTTPS_STR_MATCH this defaults to 443 if the port is not specified.
hccType :: Lens' HealthCheckConfig HealthCheckType Source #
The type of health check to be performed. Currently supported types are TCP, HTTP, HTTPS, HTTP_STR_MATCH, HTTPS_STR_MATCH, CALCULATED and CLOUDWATCH_METRIC.
HealthCheckObservation
data HealthCheckObservation Source #
A complex type that contains the IP address of a Amazon Route 53 health checker and the reason for the health check status.
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 :: Lens' HealthCheckObservation (Maybe Text) Source #
The IP address of the Amazon Route 53 health checker that performed this health check.
hcoStatusReport :: Lens' HealthCheckObservation (Maybe StatusReport) Source #
A complex type that contains information about the health check status for the current observation.
hcoRegion :: Lens' HealthCheckObservation (Maybe HealthCheckRegion) Source #
The HealthCheckRegion of the Amazon Route 53 health checker that
performed this health check.
HostedZone
data HostedZone Source #
A complex type that contain information about the specified hosted zone.
See: hostedZone smart constructor.
Instances
Arguments
| :: Text | |
| -> 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 :: Lens' HostedZone (Maybe HostedZoneConfig) Source #
A complex type that contains the Comment element.
hzResourceRecordSetCount :: Lens' HostedZone (Maybe Integer) Source #
Total number of resource record sets in the hosted zone.
hzName :: Lens' HostedZone Text Source #
The name of the domain. This must be a fully-specified domain, for example, www.example.com. The trailing dot is optional; Amazon Route 53 assumes that the domain name is fully qualified. This means that Amazon Route 53 treats www.example.com (without a trailing dot) and www.example.com. (with a trailing dot) as identical.
This is the name you have registered with your DNS registrar. You should
ask your registrar to change the authoritative name servers for your
domain to the set of NameServers elements returned in DelegationSet.
hzCallerReference :: Lens' HostedZone Text Source #
A unique string that identifies the request to create the hosted zone.
HostedZoneConfig
data HostedZoneConfig Source #
A complex type that contains an optional comment about your hosted zone.
If you don't want to specify a comment, you can omit the
HostedZoneConfig and Comment elements from the XML document.
See: hostedZoneConfig smart constructor.
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 :: Lens' HostedZoneConfig (Maybe Bool) Source #
Undocumented member.
hzcComment :: Lens' HostedZoneConfig (Maybe Text) Source #
An optional comment about your hosted zone. If you don't want to
specify a comment, you can omit the HostedZoneConfig and Comment
elements from the XML document.
ResourceRecord
data ResourceRecord Source #
A complex type that contains the value of the Value element for the
current resource record set.
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 :: 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 #
A complex type that contains information about the current resource record set.
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 :: Lens' ResourceRecordSet (Maybe Natural) Source #
The cache time to live for the current resource record set. Note the following:
- If you're creating an alias resource record set, omit
TTL. Amazon Route 53 uses the value ofTTLfor the alias target. - If you're associating this resource record set with a health check
(if you're adding a
HealthCheckIdelement), 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 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
TTLof 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 :: Lens' ResourceRecordSet (Maybe (NonEmpty ResourceRecord)) Source #
A complex type that contains the resource records for the current resource record set.
rrsAliasTarget :: Lens' ResourceRecordSet (Maybe AliasTarget) Source #
Alias resource record sets only: Information about the AWS resource to which you are redirecting traffic.
rrsWeight :: Lens' ResourceRecordSet (Maybe Natural) Source #
Weighted resource record sets only: Among resource record sets that have the same combination of DNS name and type, a value that determines the proportion of DNS queries that Amazon Route 53 responds to using the current resource record set. Amazon Route 53 calculates the sum of the weights for the resource record sets that have the same combination of DNS name and type. Amazon Route 53 then responds to queries based on the ratio of a resource's weight to the total. Note the following:
- You must specify a value for the
Weightelement for every weighted resource record set. - You can only specify one
ResourceRecordper weighted resource record set. - You cannot create latency, failover, or geolocation resource record
sets that have the same values for the
NameandTypeelements as weighted resource record sets. - You can create a maximum of 100 weighted resource record sets that
have the same values for the
NameandTypeelements. For weighted (but not weighted alias) resource record sets, if you set
Weightto '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 setWeightto '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
Weightto '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 #
Undocumented member.
rrsSetIdentifier :: Lens' ResourceRecordSet (Maybe Text) Source #
Weighted, Latency, Geo, and Failover resource record sets only: An
identifier that differentiates among multiple resource record sets that
have the same combination of DNS name and type. The value of
SetIdentifier must be unique for each resource record set that has the
same combination of DNS name and type.
rrsFailover :: Lens' ResourceRecordSet (Maybe Failover) Source #
Failover resource record sets only: To configure failover, you add the
Failover element to two resource record sets. For one resource record
set, you specify PRIMARY as the value for Failover; for the other
resource record set, you specify SECONDARY. In addition, you include
the HealthCheckId element and specify the health check that you want
Amazon Route 53 to perform for each resource record set.
You can create failover and failover alias resource record sets only in public hosted zones.
Except where noted, the following failover behaviors assume that you
have included the HealthCheckId element in both resource record sets:
- When the primary resource record set is healthy, Amazon Route 53 responds to DNS queries with the applicable value from the primary resource record set regardless of the health of the secondary resource record set.
- When the primary resource record set is unhealthy and the secondary resource record set is healthy, Amazon Route 53 responds to DNS queries with the applicable value from the secondary resource record set.
- When the secondary resource record set is unhealthy, Amazon Route 53 responds to DNS queries with the applicable value from the primary resource record set regardless of the health of the primary resource record set.
- If you omit the
HealthCheckIdelement for the secondary resource record set, and if the primary resource record set is unhealthy, Amazon Route 53 always responds to DNS queries with the applicable value from the secondary resource record set. This is true regardless of the health of the associated endpoint.
You cannot create non-failover resource record sets that have the same
values for the Name and Type elements as failover resource record
sets.
For failover alias resource record sets, you must also include the
EvaluateTargetHealth element and set the value to true.
For more information about configuring failover for Amazon Route 53, see Amazon Route 53 Health Checks and DNS Failover in the Amazon Route 53 Developer Guide.
Valid values: PRIMARY | SECONDARY
rrsHealthCheckId :: Lens' ResourceRecordSet (Maybe Text) Source #
/Health Check resource record sets only, not required for alias resource record sets:/ An identifier that is used to identify health check associated with the resource record set.
rrsRegion :: Lens' ResourceRecordSet (Maybe Region) Source #
Latency-based resource record sets only: The Amazon EC2 region where the resource that is specified in this resource record set resides. The resource typically is an AWS resource, such as an Amazon EC2 instance or an ELB load balancer, and is referred to by an IP address or a DNS domain name, depending on the record type.
You can create latency and latency alias resource record sets only in public hosted zones.
When Amazon Route 53 receives a DNS query for a domain name and type for which you have created latency resource record sets, Amazon Route 53 selects the latency resource record set that has the lowest latency between the end user and the associated Amazon EC2 region. Amazon Route 53 then returns the value that is associated with the selected resource record set.
Note the following:
- You can only specify one
ResourceRecordper latency resource record set. - You can only create one latency resource record set for each Amazon EC2 region.
- You are not required to create latency resource record sets for all Amazon EC2 regions. Amazon Route 53 will choose the region with the best latency from among the regions for which you create latency resource record sets.
- You cannot create non-latency resource record sets that have the
same values for the
NameandTypeelements as latency resource record sets.
rrsGeoLocation :: Lens' ResourceRecordSet (Maybe GeoLocation) Source #
Geo location resource record sets only: A complex type that lets you
control how Amazon Route 53 responds to DNS queries based on the
geographic origin of the query. For example, if you want all queries
from Africa to be routed to a web server with an IP address of
'192.0.2.111', create a resource record set with a Type of A and a
ContinentCode of AF.
You can create geolocation and geolocation alias resource record sets only in public hosted zones.
If you create separate resource record sets for overlapping geographic regions (for example, one resource record set for a continent and one for a country on the same continent), priority goes to the smallest geographic region. This allows you to route most queries for a continent to one resource and to route queries for a country on that continent to a different resource.
You cannot create two geolocation resource record sets that specify the same geographic location.
The value * in the CountryCode element matches all geographic
locations that aren't specified in other geolocation resource record
sets that have the same values for the Name and Type elements.
Geolocation works by mapping IP addresses to locations. However, some IP
addresses aren't mapped to geographic locations, so even if you create
geolocation resource record sets that cover all seven continents, Amazon
Route 53 will receive some DNS queries from locations that it can't
identify. We recommend that you create a resource record set for which
the value of CountryCode is *, which handles both queries that come
from locations for which you haven't created geolocation resource
record sets and queries from IP addresses that aren't mapped to a
location. If you don't create a * resource record set, Amazon Route
53 returns a "no answer" response for queries from those locations.
You cannot create non-geolocation resource record sets that have the
same values for the Name and Type elements as geolocation resource
record sets.
rrsName :: Lens' ResourceRecordSet Text Source #
The name of the domain you want to perform the action on.
Enter a fully qualified domain name, for example, 'www.example.com'. You can optionally include a trailing dot. If you omit the trailing dot, Amazon Route 53 still assumes that the domain name that you specify is fully qualified. This means that Amazon Route 53 treats 'www.example.com' (without a trailing dot) and 'www.example.com.' (with a trailing dot) as identical.
For information about how to specify characters other than a-z, 0-9, and - (hyphen) and how to specify internationalized domain names, see DNS Domain Name Format in the Amazon Route 53 Developer Guide.
You can use an asterisk (*) character in the name. DNS treats the * character either as a wildcard or as the * character (ASCII 42), depending on where it appears in the name. For more information, see Using an Asterisk (*) in the Names of Hosted Zones and Resource Record Sets in the Amazon Route 53 Developer Guide
You can't use the * wildcard for resource records sets that have a type of NS.
rrsType :: Lens' ResourceRecordSet RecordType Source #
The DNS record type. For information about different record types and how data is encoded for them, see Supported DNS Resource Record Types in the Amazon Route 53 Developer Guide.
Valid values for basic resource record sets: A | AAAA | CNAME |
MX | NS | PTR | SOA | SPF | SRV | TXT
Values for weighted, latency, geolocation, and failover resource record
sets: A | AAAA | CNAME | MX | PTR | SPF | SRV | TXT.
When creating a group of weighted, latency, geolocation, or failover
resource record sets, specify the same value for all of the resource
record sets in the group.
SPF records were formerly used to verify the identity of the sender of
email messages. However, we no longer recommend that you create resource
record sets for which the value of Type is SPF. RFC 7208, /Sender
Policy Framework (SPF) for Authorizing Use of Domains in Email, Version
1/, has been updated to say, "...[I]ts existence and mechanism defined
in [RFC4408] have led to some interoperability issues. Accordingly, its
use is no longer appropriate for SPF version 1; implementations are not
to use it." In RFC 7208, see section 14.1,
The SPF DNS Record Type.
Values for alias resource record sets:
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 :: Lens' ResourceTagSet (Maybe Text) Source #
The ID for the specified resource.
rtsResourceType :: Lens' ResourceTagSet (Maybe TagResourceType) Source #
The type of the resource.
- The resource type for health checks is
healthcheck. - The resource type for hosted zones is
hostedzone.
rtsTags :: Lens' ResourceTagSet (Maybe (NonEmpty Tag)) Source #
The tags associated with the specified resource.
StatusReport
data StatusReport Source #
A complex type that contains information about the health check status for the current observation.
See: statusReport smart constructor.
statusReport :: StatusReport Source #
Creates a value of StatusReport with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
srCheckedTime :: Lens' StatusReport (Maybe UTCTime) Source #
The date and time the health check status was observed, in the format
'YYYY-MM-DDThh:mm:ssZ', as specified in the ISO 8601 standard (for
example, 2009-11-19T19:37:58Z). The Z after the time indicates that
the time is listed in Coordinated Universal Time (UTC).
Tag
A single tag containing a key and value.
See: tag smart constructor.
TrafficPolicy
data TrafficPolicy Source #
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:
tpType :: Lens' TrafficPolicy RecordType Source #
Undocumented member.
tpDocument :: Lens' TrafficPolicy Text Source #
Undocumented member.
TrafficPolicyInstance
data TrafficPolicyInstance Source #
See: trafficPolicyInstance smart constructor.
Instances
trafficPolicyInstance Source #
Arguments
| :: Text | |
| -> Text | |
| -> 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:
tpiHostedZoneId :: Lens' TrafficPolicyInstance Text Source #
Undocumented member.
tpiMessage :: Lens' TrafficPolicyInstance Text Source #
Undocumented member.
tpiTrafficPolicyId :: Lens' TrafficPolicyInstance Text Source #
Undocumented member.
tpiTrafficPolicyVersion :: Lens' TrafficPolicyInstance Natural Source #
Undocumented member.
tpiTrafficPolicyType :: Lens' TrafficPolicyInstance RecordType Source #
Undocumented member.
TrafficPolicySummary
data TrafficPolicySummary Source #
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:
tpsType :: Lens' TrafficPolicySummary RecordType Source #
Undocumented member.
tpsLatestVersion :: Lens' TrafficPolicySummary Natural Source #
Undocumented member.
tpsTrafficPolicyCount :: Lens' TrafficPolicySummary Natural Source #
Undocumented member.
VPC
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: