Copyright | (c) 2013-2015 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 |
- Service Configuration
- Errors
- HealthCheckVersionMismatch
- InvalidInput
- HostedZoneNotEmpty
- InvalidArgument
- DelegationSetAlreadyReusable
- PriorRequestNotComplete
- InvalidChangeBatch
- InvalidDomainName
- DelegationSetNotReusable
- HealthCheckAlreadyExists
- HostedZoneNotFound
- DelegationSetInUse
- NoSuchDelegationSet
- NoSuchGeoLocation
- DelegationSetNotAvailable
- VPCAssociationNotFound
- ThrottlingException
- NoSuchChange
- LimitsExceeded
- IncompatibleVersion
- NoSuchHostedZone
- TooManyHostedZones
- PublicZoneVPCAssociation
- ConflictingDomainExists
- LastVPCAssociation
- HealthCheckInUse
- DelegationSetAlreadyCreated
- TooManyHealthChecks
- NoSuchHealthCheck
- HostedZoneAlreadyExists
- InvalidVPCId
- Waiters
- Operations
- AssociateVPCWithHostedZone
- GetHealthCheckLastFailureReason
- ListHostedZonesByName
- DeleteReusableDelegationSet
- ListReusableDelegationSets
- GetCheckerIPRanges
- ListTagsForResource
- ChangeResourceRecordSets
- GetChange
- CreateHostedZone
- DeleteHealthCheck
- UpdateHealthCheck
- ChangeTagsForResource
- CreateHealthCheck
- ListHostedZones (Paginated)
- DisassociateVPCFromHostedZone
- GetHostedZone
- ListGeoLocations
- GetHealthCheck
- ListResourceRecordSets (Paginated)
- GetHealthCheckCount
- CreateReusableDelegationSet
- GetHostedZoneCount
- GetReusableDelegationSet
- UpdateHostedZoneComment
- GetHealthCheckStatus
- ListHealthChecks (Paginated)
- DeleteHostedZone
- GetGeoLocation
- ListTagsForResources
- Types
- Re-exported Types
- ChangeAction
- ChangeStatus
- Failover
- HealthCheckType
- RecordType
- TagResourceType
- VPCRegion
- AliasTarget
- Change
- ChangeBatch
- ChangeInfo
- DelegationSet
- GeoLocation
- GeoLocationDetails
- HealthCheck
- HealthCheckConfig
- HealthCheckObservation
- HostedZone
- HostedZoneConfig
- ResourceRecord
- ResourceRecordSet
- ResourceTagSet
- StatusReport
- Tag
- VPC
Amazon Route 53 is a scalable Domain Name System (DNS) web service. It provides secure and reliable routing to your infrastructure that uses Amazon Web Services (AWS) products, such as Amazon Elastic Compute Cloud (Amazon EC2), Elastic Load Balancing, or Amazon Simple Storage Service (Amazon S3). You can also use Amazon Route 53 to route users to your infrastructure outside of AWS.
See: AWS API Reference
- 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
- _DelegationSetAlreadyReusable :: AsError a => Getting (First ServiceError) a ServiceError
- _PriorRequestNotComplete :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidChangeBatch :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidDomainName :: AsError a => Getting (First ServiceError) a ServiceError
- _DelegationSetNotReusable :: AsError a => Getting (First ServiceError) a ServiceError
- _HealthCheckAlreadyExists :: 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
- _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
- _IncompatibleVersion :: AsError a => Getting (First ServiceError) a ServiceError
- _NoSuchHostedZone :: AsError a => Getting (First ServiceError) a ServiceError
- _TooManyHostedZones :: AsError a => Getting (First ServiceError) a ServiceError
- _PublicZoneVPCAssociation :: AsError a => Getting (First ServiceError) a ServiceError
- _ConflictingDomainExists :: AsError a => Getting (First ServiceError) a ServiceError
- _LastVPCAssociation :: AsError a => Getting (First ServiceError) a ServiceError
- _HealthCheckInUse :: AsError a => Getting (First ServiceError) a ServiceError
- _DelegationSetAlreadyCreated :: AsError a => Getting (First ServiceError) a ServiceError
- _TooManyHealthChecks :: AsError a => Getting (First ServiceError) a ServiceError
- _NoSuchHealthCheck :: AsError a => Getting (First ServiceError) a ServiceError
- _HostedZoneAlreadyExists :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidVPCId :: AsError a => Getting (First ServiceError) a ServiceError
- resourceRecordSetsChanged :: Wait GetChange
- module Network.AWS.Route53.AssociateVPCWithHostedZone
- module Network.AWS.Route53.GetHealthCheckLastFailureReason
- module Network.AWS.Route53.ListHostedZonesByName
- module Network.AWS.Route53.DeleteReusableDelegationSet
- module Network.AWS.Route53.ListReusableDelegationSets
- module Network.AWS.Route53.GetCheckerIPRanges
- module Network.AWS.Route53.ListTagsForResource
- module Network.AWS.Route53.ChangeResourceRecordSets
- module Network.AWS.Route53.GetChange
- module Network.AWS.Route53.CreateHostedZone
- module Network.AWS.Route53.DeleteHealthCheck
- module Network.AWS.Route53.UpdateHealthCheck
- module Network.AWS.Route53.ChangeTagsForResource
- module Network.AWS.Route53.CreateHealthCheck
- module Network.AWS.Route53.ListHostedZones
- module Network.AWS.Route53.DisassociateVPCFromHostedZone
- module Network.AWS.Route53.GetHostedZone
- module Network.AWS.Route53.ListGeoLocations
- module Network.AWS.Route53.GetHealthCheck
- module Network.AWS.Route53.ListResourceRecordSets
- module Network.AWS.Route53.GetHealthCheckCount
- module Network.AWS.Route53.CreateReusableDelegationSet
- module Network.AWS.Route53.GetHostedZoneCount
- module Network.AWS.Route53.GetReusableDelegationSet
- module Network.AWS.Route53.UpdateHostedZoneComment
- module Network.AWS.Route53.GetHealthCheckStatus
- module Network.AWS.Route53.ListHealthChecks
- module Network.AWS.Route53.DeleteHostedZone
- module Network.AWS.Route53.GetGeoLocation
- module Network.AWS.Route53.ListTagsForResources
- data Region :: *
- data ChangeAction
- data ChangeStatus
- data Failover
- data HealthCheckType
- = HTTP
- | HTTPS
- | HTTPSStrMatch
- | HTTPStrMatch
- | TCP
- data RecordType
- data TagResourceType
- data VPCRegion
- 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 DelegationSet
- delegationSet :: NonEmpty Text -> DelegationSet
- dsId :: Lens' DelegationSet (Maybe Text)
- dsCallerReference :: Lens' DelegationSet (Maybe Text)
- dsNameServers :: Lens' DelegationSet (NonEmpty 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
- hcId :: Lens' HealthCheck Text
- hcCallerReference :: Lens' HealthCheck Text
- hcHealthCheckConfig :: Lens' HealthCheck HealthCheckConfig
- hcHealthCheckVersion :: Lens' HealthCheck Natural
- data HealthCheckConfig
- healthCheckConfig :: HealthCheckType -> HealthCheckConfig
- hccIPAddress :: Lens' HealthCheckConfig (Maybe Text)
- hccFailureThreshold :: Lens' HealthCheckConfig (Maybe Natural)
- hccSearchString :: Lens' HealthCheckConfig (Maybe Text)
- hccResourcePath :: Lens' HealthCheckConfig (Maybe Text)
- hccFullyQualifiedDomainName :: Lens' HealthCheckConfig (Maybe 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)
- 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
- rrsResourceRecords :: Lens' ResourceRecordSet (Maybe (NonEmpty ResourceRecord))
- rrsTTL :: Lens' ResourceRecordSet (Maybe Natural)
- rrsAliasTarget :: Lens' ResourceRecordSet (Maybe AliasTarget)
- rrsWeight :: Lens' ResourceRecordSet (Maybe Natural)
- 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 VPC
- vpc :: VPC
- vpcVPCRegion :: Lens' VPC (Maybe VPCRegion)
- vpcVPCId :: Lens' VPC (Maybe Text)
Service Configuration
Errors
Error matchers are designed for use with the functions provided by
Control.Exception.Lens.
This allows catching (and rethrowing) service specific errors returned
by Route53
.
HealthCheckVersionMismatch
_HealthCheckVersionMismatch :: AsError a => Getting (First ServiceError) a ServiceError Source
Prism for HealthCheckVersionMismatch' errors.
InvalidInput
_InvalidInput :: AsError a => Getting (First ServiceError) a ServiceError Source
Some value specified in the request is invalid or the XML document is malformed.
HostedZoneNotEmpty
_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
_InvalidArgument :: AsError a => Getting (First ServiceError) a ServiceError Source
At least one of the specified arguments is invalid.
DelegationSetAlreadyReusable
_DelegationSetAlreadyReusable :: AsError a => Getting (First ServiceError) a ServiceError Source
The specified delegation set has already been marked as reusable.
PriorRequestNotComplete
_PriorRequestNotComplete :: AsError a => Getting (First ServiceError) a ServiceError Source
The request was rejected because Route 53 was still processing a prior request.
InvalidChangeBatch
_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.
InvalidDomainName
_InvalidDomainName :: AsError a => Getting (First ServiceError) a ServiceError Source
This error indicates that the specified domain name is not valid.
DelegationSetNotReusable
_DelegationSetNotReusable :: AsError a => Getting (First ServiceError) a ServiceError Source
The specified delegation set has not been marked as reusable.
HealthCheckAlreadyExists
_HealthCheckAlreadyExists :: AsError a => Getting (First ServiceError) a ServiceError Source
The health check you are trying to create already exists. Route 53
returns this error when a health check has already been created with the
specified CallerReference
.
HostedZoneNotFound
_HostedZoneNotFound :: AsError a => Getting (First ServiceError) a ServiceError Source
The specified HostedZone cannot be found.
DelegationSetInUse
_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
_NoSuchDelegationSet :: AsError a => Getting (First ServiceError) a ServiceError Source
The specified delegation set does not exist.
NoSuchGeoLocation
_NoSuchGeoLocation :: AsError a => Getting (First ServiceError) a ServiceError Source
The geo location you are trying to get does not exist.
DelegationSetNotAvailable
_DelegationSetNotAvailable :: AsError a => Getting (First ServiceError) a ServiceError Source
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 Route 53 generates this error, you can request an increase to the limit on the Contact Us page.
VPCAssociationNotFound
_VPCAssociationNotFound :: AsError a => Getting (First ServiceError) a ServiceError Source
The VPC you specified is not currently associated with the hosted zone.
ThrottlingException
_ThrottlingException :: AsError a => Getting (First ServiceError) a ServiceError Source
Prism for ThrottlingException' errors.
NoSuchChange
_NoSuchChange :: AsError a => Getting (First ServiceError) a ServiceError Source
Prism for NoSuchChange' errors.
LimitsExceeded
_LimitsExceeded :: AsError a => Getting (First ServiceError) a ServiceError Source
The limits specified for a resource have been exceeded.
IncompatibleVersion
_IncompatibleVersion :: AsError a => Getting (First ServiceError) a ServiceError Source
The resource you are trying to access is unsupported on this Route 53 endpoint. Please consider using a newer endpoint or a tool that does so.
NoSuchHostedZone
_NoSuchHostedZone :: AsError a => Getting (First ServiceError) a ServiceError Source
Prism for NoSuchHostedZone' errors.
TooManyHostedZones
_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.
PublicZoneVPCAssociation
_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. Route 53 currently doesn't support associate a VPC with a public hosted zone.
ConflictingDomainExists
_ConflictingDomainExists :: AsError a => Getting (First ServiceError) a ServiceError Source
Prism for ConflictingDomainExists' errors.
LastVPCAssociation
_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. Route 53 currently doesn't support disassociate the last VPC from the hosted zone.
HealthCheckInUse
_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
_DelegationSetAlreadyCreated :: AsError a => Getting (First ServiceError) a ServiceError Source
A delegation set with the same owner and caller reference combination has already been created.
TooManyHealthChecks
_TooManyHealthChecks :: AsError a => Getting (First ServiceError) a ServiceError Source
Prism for TooManyHealthChecks' errors.
NoSuchHealthCheck
_NoSuchHealthCheck :: AsError a => Getting (First ServiceError) a ServiceError Source
The health check you are trying to get or delete does not exist.
HostedZoneAlreadyExists
_HostedZoneAlreadyExists :: AsError a => Getting (First ServiceError) a ServiceError Source
The hosted zone you are trying to create already exists. Route 53
returns this error when a hosted zone has already been created with the
specified CallerReference
.
InvalidVPCId
_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. Route 53 returns this error when the VPC specified by VPCId
does not belong to you.
Waiters
Waiters poll by repeatedly sending a request until some remote success condition
configured by the Wait
specification is fulfilled. The Wait
specification
determines how many attempts should be made, in addition to delay and retry strategies.
ResourceRecordSetsChanged
resourceRecordSetsChanged :: Wait GetChange Source
Polls GetChange
every 30 seconds until a
successful state is reached. An error is returned after 60 failed checks.
Operations
Some AWS operations return results that are incomplete and require subsequent
requests in order to obtain the entire result set. The process of sending
subsequent requests to continue where a previous request left off is called
pagination. For example, the ListObjects
operation of Amazon S3 returns up to
1000 objects at a time, and you must send subsequent requests with the
appropriate Marker in order to retrieve the next page of results.
Operations that have an AWSPager
instance can transparently perform subsequent
requests, correctly setting Markers and other request facets to iterate through
the entire result set of a truncated API operation. Operations which support
this have an additional note in the documentation.
Many operations have the ability to filter results on the server side. See the individual operation parameters for details.
AssociateVPCWithHostedZone
GetHealthCheckLastFailureReason
ListHostedZonesByName
DeleteReusableDelegationSet
ListReusableDelegationSets
GetCheckerIPRanges
ListTagsForResource
ChangeResourceRecordSets
GetChange
CreateHostedZone
DeleteHealthCheck
UpdateHealthCheck
ChangeTagsForResource
CreateHealthCheck
ListHostedZones (Paginated)
DisassociateVPCFromHostedZone
GetHostedZone
ListGeoLocations
GetHealthCheck
ListResourceRecordSets (Paginated)
GetHealthCheckCount
CreateReusableDelegationSet
GetHostedZoneCount
GetReusableDelegationSet
UpdateHostedZoneComment
GetHealthCheckStatus
ListHealthChecks (Paginated)
DeleteHostedZone
GetGeoLocation
ListTagsForResources
Types
Re-exported Types
data Region :: *
The sum of available AWS regions.
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 |
Eq Region | |
Data Region | |
Ord Region | |
Read Region | |
Show Region | |
Generic Region | |
Hashable Region | |
ToLog Region | |
FromXML Region | |
ToXML Region | |
ToByteString Region | |
FromText Region | |
ToText Region | |
Typeable * Region | |
type Rep Region = D1 D1Region ((:+:) ((:+:) ((:+:) (C1 C1_0Region U1) ((:+:) (C1 C1_1Region U1) (C1 C1_2Region U1))) ((:+:) (C1 C1_3Region U1) ((:+:) (C1 C1_4Region U1) (C1 C1_5Region U1)))) ((:+:) ((:+:) (C1 C1_6Region U1) ((:+:) (C1 C1_7Region U1) (C1 C1_8Region U1))) ((:+:) (C1 C1_9Region U1) ((:+:) (C1 C1_10Region U1) (C1 C1_11Region U1))))) |
ChangeAction
data ChangeAction Source
ChangeStatus
data ChangeStatus Source
Failover
HealthCheckType
data HealthCheckType Source
RecordType
data RecordType Source
TagResourceType
data TagResourceType Source
VPCRegion
AliasTarget
data AliasTarget Source
Alias resource record sets only: Information about the domain to which you are redirecting traffic.
For more information and an example, see Creating Alias Resource Record Sets in the Amazon Route 53 Developer Guide
.
See: aliasTarget
smart constructor.
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 of the hosted zone ID for the AWS resource.
For more information and an example, see Creating Alias Resource Record Sets in the Amazon Route 53 Developer Guide
.
atDNSName :: Lens' AliasTarget Text Source
Alias resource record sets only: The external DNS name associated with the AWS Resource.
For more information and an example, see Creating Alias Resource Record Sets in the Amazon Route 53 Developer Guide
.
atEvaluateTargetHealth :: Lens' AliasTarget Bool Source
Alias resource record sets only: A boolean value that indicates whether this Resource Record Set should respect the health status of any health checks associated with the ALIAS target record which it is linked to.
For more information and an example, see Creating Alias Resource Record Sets 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.
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.
Valid values: CREATE
| DELETE
| UPSERT
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.
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.
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), which is
synonymous with Greenwich Mean Time in this context.
DelegationSet
data DelegationSet Source
A complex type that contains name server information.
See: delegationSet
smart constructor.
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.
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.
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.
:: 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:
hcId :: Lens' HealthCheck Text Source
The ID of the specified health check.
hcCallerReference :: Lens' HealthCheck Text Source
A unique string that identifies the request to create the health check.
hcHealthCheckConfig :: Lens' HealthCheck HealthCheckConfig Source
A complex type that contains the health check configuration.
hcHealthCheckVersion :: Lens' HealthCheck Natural Source
The version of the health check. You can optionally pass this value in a
call to UpdateHealthCheck
to prevent overwriting another change to the
health check.
HealthCheckConfig
data HealthCheckConfig Source
A complex type that contains the health check configuration.
See: healthCheckConfig
smart constructor.
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:
hccIPAddress :: Lens' HealthCheckConfig (Maybe Text) Source
IP Address of the instance being checked.
hccFailureThreshold :: Lens' HealthCheckConfig (Maybe Natural) Source
The number of consecutive health checks that an endpoint must pass or fail for Route 53 to change the current status of the endpoint from unhealthy to healthy or vice versa.
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.
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.
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, HTTP request is issued to the instance on the given port and path.
hccFullyQualifiedDomainName :: Lens' HealthCheckConfig (Maybe Text) Source
Fully qualified domain name of the instance to be health checked.
hccRequestInterval :: Lens' HealthCheckConfig (Maybe Natural) Source
The number of seconds between the time that Route 53 gets a response from your endpoint and the time that it sends the next health-check request.
Each Route 53 health checker makes requests at this interval. Valid values are 10 and 30. The default value is 30.
hccPort :: Lens' HealthCheckConfig (Maybe Natural) Source
Port on which connection will be opened to the instance to health check. For HTTP and HTTP_STR_MATCH this defaults to 80 if the port is not specified. For HTTPS and HTTPS_STR_MATCH this defaults to 443 if the port is not specified.
hccType :: Lens' HealthCheckConfig HealthCheckType Source
The type of health check to be performed. Currently supported types are TCP, HTTP, HTTPS, HTTP_STR_MATCH, and HTTPS_STR_MATCH.
HealthCheckObservation
data HealthCheckObservation Source
A complex type that contains the IP address of a Route 53 health checker and the reason for the health check status.
See: healthCheckObservation
smart constructor.
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 Route 53 health checker that performed the health check.
hcoStatusReport :: Lens' HealthCheckObservation (Maybe StatusReport) Source
A complex type that contains information about the health check status for the current observation.
HostedZone
data HostedZone Source
A complex type that contain information about the specified hosted zone.
See: hostedZone
smart constructor.
Creates a value of HostedZone
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
hzConfig :: Lens' HostedZone (Maybe HostedZoneConfig) Source
A complex type that contains the Comment
element.
hzResourceRecordSetCount :: Lens' HostedZone (Maybe Integer) Source
Total number of resource record sets in the hosted zone.
hzId :: Lens' HostedZone Text Source
The ID of the specified hosted zone.
hzName :: Lens' HostedZone Text Source
The name of the domain. This must be a fully-specified domain, for example, www.example.com. The trailing dot is optional; Route 53 assumes that the domain name is fully qualified. This means that Route 53 treats www.example.com (without a trailing dot) and www.example.com. (with a trailing dot) as identical.
This is the name you have registered with your DNS registrar. You should
ask your registrar to change the authoritative name servers for your
domain to the set of NameServers
elements returned in DelegationSet
.
hzCallerReference :: Lens' HostedZone Text Source
A unique string that identifies the request to create the hosted zone.
HostedZoneConfig
data HostedZoneConfig Source
A complex type that contains an optional comment about your hosted zone.
If you don't want to specify a comment, you can omit the
HostedZoneConfig
and Comment
elements from the XML document.
See: hostedZoneConfig
smart constructor.
hostedZoneConfig :: HostedZoneConfig Source
Creates a value of HostedZoneConfig
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
hzcPrivateZone :: Lens' HostedZoneConfig (Maybe Bool) Source
A value that indicates whether this is a private hosted zone. The value is returned in the response; do not specify it in the request.
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.
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 value of the Value
element for the current resource record set.
ResourceRecordSet
data ResourceRecordSet Source
A complex type that contains information about the current resource record set.
See: resourceRecordSet
smart constructor.
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:
rrsResourceRecords :: Lens' ResourceRecordSet (Maybe (NonEmpty ResourceRecord)) Source
A complex type that contains the resource records for the current resource record set.
rrsTTL :: Lens' ResourceRecordSet (Maybe Natural) Source
The cache time to live 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 what portion of traffic for the current resource record set is routed to the associated location.
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.
rrsFailover :: Lens' ResourceRecordSet (Maybe Failover) Source
Failover resource record sets only: Among resource record sets that have the same combination of DNS name and type, a value that indicates whether the current resource record set is a primary or secondary resource record set. A failover set may contain at most one resource record set marked as primary and one resource record set marked as secondary. A resource record set marked as primary will be returned if any of the following are true: (1) an associated health check is passing, (2) if the resource record set is an alias with the evaluate target health and at least one target resource record set is healthy, (3) both the primary and secondary resource record set are failing health checks or (4) there is no secondary resource record set. A secondary resource record set will be returned if: (1) the primary is failing a health check and either the secondary is passing a health check or has no associated health check, or (2) there is no primary resource record set.
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: Among resource record sets that have the same combination of DNS name and type, a value that specifies the AWS region for the current resource record set.
rrsGeoLocation :: Lens' ResourceRecordSet (Maybe GeoLocation) Source
Geo location resource record sets only: Among resource record sets that have the same combination of DNS name and type, a value that specifies the geo location for the current resource record set.
rrsName :: Lens' ResourceRecordSet Text Source
The domain name of the current resource record set.
rrsType :: Lens' ResourceRecordSet RecordType Source
The type of the current resource record set.
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), which is
synonymous with Greenwich Mean Time in this context.
Tag
A single tag containing a key and value.
See: tag
smart constructor.
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: