Copyright | (c) 2013-2021 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
- Service Configuration
- Errors
- Re-exported Types
- AccountLimitType
- ChangeAction
- ChangeStatus
- CloudWatchRegion
- ComparisonOperator
- HealthCheckRegion
- HealthCheckType
- HostedZoneLimitType
- InsufficientDataHealthStatus
- RRType
- ResettableElementName
- ResourceRecordSetFailover
- ReusableDelegationSetLimitType
- Statistic
- TagResourceType
- VPCRegion
- AccountLimit
- AlarmIdentifier
- AliasTarget
- Change
- ChangeBatch
- ChangeInfo
- CloudWatchAlarmConfiguration
- DNSSECStatus
- DelegationSet
- Dimension
- GeoLocation
- GeoLocationDetails
- HealthCheck
- HealthCheckConfig
- HealthCheckObservation
- HostedZone
- HostedZoneConfig
- HostedZoneLimit
- HostedZoneOwner
- HostedZoneSummary
- KeySigningKey
- LinkedService
- QueryLoggingConfig
- ResourceRecord
- ResourceRecordSet
- ResourceTagSet
- ReusableDelegationSetLimit
- StatusReport
- Tag
- TrafficPolicy
- TrafficPolicyInstance
- TrafficPolicySummary
- VPC
Synopsis
- defaultService :: Service
- _HealthCheckVersionMismatch :: AsError a => Getting (First ServiceError) a ServiceError
- _NoSuchQueryLoggingConfig :: AsError a => Getting (First ServiceError) a ServiceError
- _DNSSECNotFound :: AsError a => Getting (First ServiceError) a ServiceError
- _KeySigningKeyInUse :: AsError a => Getting (First ServiceError) a ServiceError
- _TooManyKeySigningKeys :: AsError a => Getting (First ServiceError) a ServiceError
- _HostedZoneNotPrivate :: 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
- _KeySigningKeyWithActiveStatusNotFound :: AsError a => Getting (First ServiceError) a ServiceError
- _TrafficPolicyInstanceAlreadyExists :: AsError a => Getting (First ServiceError) a ServiceError
- _ConflictingTypes :: AsError a => Getting (First ServiceError) a ServiceError
- _QueryLoggingConfigAlreadyExists :: AsError a => Getting (First ServiceError) a ServiceError
- _ConcurrentModification :: AsError a => Getting (First ServiceError) a ServiceError
- _DelegationSetAlreadyReusable :: AsError a => Getting (First ServiceError) a ServiceError
- _NotAuthorizedException :: AsError a => Getting (First ServiceError) a ServiceError
- _InsufficientCloudWatchLogsResourcePolicy :: AsError a => Getting (First ServiceError) a ServiceError
- _NoSuchCloudWatchLogsLogGroup :: AsError a => Getting (First ServiceError) a ServiceError
- _PriorRequestNotComplete :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidChangeBatch :: AsError a => Getting (First ServiceError) a ServiceError
- _TooManyVPCAssociationAuthorizations :: AsError a => Getting (First ServiceError) a ServiceError
- _TrafficPolicyAlreadyExists :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidTrafficPolicyDocument :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidSigningStatus :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidPaginationToken :: AsError a => Getting (First ServiceError) a ServiceError
- _DelegationSetNotReusable :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidDomainName :: AsError a => Getting (First ServiceError) a ServiceError
- _NoSuchTrafficPolicy :: AsError a => Getting (First ServiceError) a ServiceError
- _HostedZoneNotFound :: AsError a => Getting (First ServiceError) a ServiceError
- _DelegationSetInUse :: AsError a => Getting (First ServiceError) a ServiceError
- _NoSuchDelegationSet :: AsError a => Getting (First ServiceError) a ServiceError
- _HealthCheckAlreadyExists :: AsError a => Getting (First ServiceError) a ServiceError
- _TooManyTrafficPolicies :: AsError a => Getting (First ServiceError) a ServiceError
- _VPCAssociationAuthorizationNotFound :: AsError a => Getting (First ServiceError) a ServiceError
- _NoSuchGeoLocation :: AsError a => Getting (First ServiceError) a ServiceError
- _DelegationSetNotAvailable :: AsError a => Getting (First ServiceError) a ServiceError
- _NoSuchKeySigningKey :: AsError a => Getting (First ServiceError) a ServiceError
- _VPCAssociationNotFound :: AsError a => Getting (First ServiceError) a ServiceError
- _ThrottlingException :: AsError a => Getting (First ServiceError) a ServiceError
- _HostedZonePartiallyDelegated :: AsError a => Getting (First ServiceError) a ServiceError
- _KeySigningKeyInParentDSRecord :: AsError a => Getting (First ServiceError) a ServiceError
- _NoSuchChange :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidKeySigningKeyName :: AsError a => Getting (First ServiceError) a ServiceError
- _LimitsExceeded :: AsError a => Getting (First ServiceError) a ServiceError
- _KeySigningKeyAlreadyExists :: 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
- _InvalidKeySigningKeyStatus :: 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
- _InvalidKMSArn :: 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
- _TooManyTrafficPolicyVersionsForCurrentPolicy :: AsError a => Getting (First ServiceError) a ServiceError
- module Amazonka.Route53.Internal
- newtype AccountLimitType where
- AccountLimitType' { }
- pattern AccountLimitType_MAX_HEALTH_CHECKS_BY_OWNER :: AccountLimitType
- pattern AccountLimitType_MAX_HOSTED_ZONES_BY_OWNER :: AccountLimitType
- pattern AccountLimitType_MAX_REUSABLE_DELEGATION_SETS_BY_OWNER :: AccountLimitType
- pattern AccountLimitType_MAX_TRAFFIC_POLICIES_BY_OWNER :: AccountLimitType
- pattern AccountLimitType_MAX_TRAFFIC_POLICY_INSTANCES_BY_OWNER :: AccountLimitType
- newtype ChangeAction where
- ChangeAction' { }
- pattern ChangeAction_CREATE :: ChangeAction
- pattern ChangeAction_DELETE :: ChangeAction
- pattern ChangeAction_UPSERT :: ChangeAction
- newtype ChangeStatus where
- ChangeStatus' { }
- pattern ChangeStatus_INSYNC :: ChangeStatus
- pattern ChangeStatus_PENDING :: ChangeStatus
- newtype CloudWatchRegion where
- CloudWatchRegion' { }
- pattern CloudWatchRegion_Af_south_1 :: CloudWatchRegion
- pattern CloudWatchRegion_Ap_east_1 :: CloudWatchRegion
- pattern CloudWatchRegion_Ap_northeast_1 :: CloudWatchRegion
- pattern CloudWatchRegion_Ap_northeast_2 :: CloudWatchRegion
- pattern CloudWatchRegion_Ap_northeast_3 :: CloudWatchRegion
- pattern CloudWatchRegion_Ap_south_1 :: CloudWatchRegion
- pattern CloudWatchRegion_Ap_southeast_1 :: CloudWatchRegion
- pattern CloudWatchRegion_Ap_southeast_2 :: CloudWatchRegion
- pattern CloudWatchRegion_Ca_central_1 :: CloudWatchRegion
- pattern CloudWatchRegion_Cn_north_1 :: CloudWatchRegion
- pattern CloudWatchRegion_Cn_northwest_1 :: CloudWatchRegion
- pattern CloudWatchRegion_Eu_central_1 :: CloudWatchRegion
- pattern CloudWatchRegion_Eu_north_1 :: CloudWatchRegion
- pattern CloudWatchRegion_Eu_south_1 :: CloudWatchRegion
- pattern CloudWatchRegion_Eu_west_1 :: CloudWatchRegion
- pattern CloudWatchRegion_Eu_west_2 :: CloudWatchRegion
- pattern CloudWatchRegion_Eu_west_3 :: CloudWatchRegion
- pattern CloudWatchRegion_Me_south_1 :: CloudWatchRegion
- pattern CloudWatchRegion_Sa_east_1 :: CloudWatchRegion
- pattern CloudWatchRegion_Us_east_1 :: CloudWatchRegion
- pattern CloudWatchRegion_Us_east_2 :: CloudWatchRegion
- pattern CloudWatchRegion_Us_gov_east_1 :: CloudWatchRegion
- pattern CloudWatchRegion_Us_gov_west_1 :: CloudWatchRegion
- pattern CloudWatchRegion_Us_iso_east_1 :: CloudWatchRegion
- pattern CloudWatchRegion_Us_isob_east_1 :: CloudWatchRegion
- pattern CloudWatchRegion_Us_west_1 :: CloudWatchRegion
- pattern CloudWatchRegion_Us_west_2 :: CloudWatchRegion
- newtype ComparisonOperator where
- ComparisonOperator' { }
- pattern ComparisonOperator_GreaterThanOrEqualToThreshold :: ComparisonOperator
- pattern ComparisonOperator_GreaterThanThreshold :: ComparisonOperator
- pattern ComparisonOperator_LessThanOrEqualToThreshold :: ComparisonOperator
- pattern ComparisonOperator_LessThanThreshold :: ComparisonOperator
- newtype HealthCheckRegion where
- HealthCheckRegion' { }
- pattern HealthCheckRegion_Ap_northeast_1 :: HealthCheckRegion
- pattern HealthCheckRegion_Ap_southeast_1 :: HealthCheckRegion
- pattern HealthCheckRegion_Ap_southeast_2 :: HealthCheckRegion
- pattern HealthCheckRegion_Eu_west_1 :: HealthCheckRegion
- pattern HealthCheckRegion_Sa_east_1 :: HealthCheckRegion
- pattern HealthCheckRegion_Us_east_1 :: HealthCheckRegion
- pattern HealthCheckRegion_Us_west_1 :: HealthCheckRegion
- pattern HealthCheckRegion_Us_west_2 :: HealthCheckRegion
- newtype HealthCheckType where
- HealthCheckType' { }
- pattern HealthCheckType_CALCULATED :: HealthCheckType
- pattern HealthCheckType_CLOUDWATCH_METRIC :: HealthCheckType
- pattern HealthCheckType_HTTP :: HealthCheckType
- pattern HealthCheckType_HTTPS :: HealthCheckType
- pattern HealthCheckType_HTTPS_STR_MATCH :: HealthCheckType
- pattern HealthCheckType_HTTP_STR_MATCH :: HealthCheckType
- pattern HealthCheckType_RECOVERY_CONTROL :: HealthCheckType
- pattern HealthCheckType_TCP :: HealthCheckType
- newtype HostedZoneLimitType where
- newtype InsufficientDataHealthStatus where
- newtype RRType where
- RRType' {
- fromRRType :: Text
- pattern RRType_A :: RRType
- pattern RRType_AAAA :: RRType
- pattern RRType_CAA :: RRType
- pattern RRType_CNAME :: RRType
- pattern RRType_DS :: RRType
- pattern RRType_MX :: RRType
- pattern RRType_NAPTR :: RRType
- pattern RRType_NS :: RRType
- pattern RRType_PTR :: RRType
- pattern RRType_SOA :: RRType
- pattern RRType_SPF :: RRType
- pattern RRType_SRV :: RRType
- pattern RRType_TXT :: RRType
- RRType' {
- newtype ResettableElementName where
- ResettableElementName' { }
- pattern ResettableElementName_ChildHealthChecks :: ResettableElementName
- pattern ResettableElementName_FullyQualifiedDomainName :: ResettableElementName
- pattern ResettableElementName_Regions :: ResettableElementName
- pattern ResettableElementName_ResourcePath :: ResettableElementName
- newtype ResourceRecordSetFailover where
- newtype ReusableDelegationSetLimitType where
- newtype Statistic where
- Statistic' { }
- pattern Statistic_Average :: Statistic
- pattern Statistic_Maximum :: Statistic
- pattern Statistic_Minimum :: Statistic
- pattern Statistic_SampleCount :: Statistic
- pattern Statistic_Sum :: Statistic
- newtype TagResourceType where
- TagResourceType' { }
- pattern TagResourceType_Healthcheck :: TagResourceType
- pattern TagResourceType_Hostedzone :: TagResourceType
- newtype VPCRegion where
- VPCRegion' { }
- pattern VPCRegion_Af_south_1 :: VPCRegion
- pattern VPCRegion_Ap_east_1 :: VPCRegion
- pattern VPCRegion_Ap_northeast_1 :: VPCRegion
- pattern VPCRegion_Ap_northeast_2 :: VPCRegion
- pattern VPCRegion_Ap_northeast_3 :: VPCRegion
- pattern VPCRegion_Ap_south_1 :: VPCRegion
- pattern VPCRegion_Ap_southeast_1 :: VPCRegion
- pattern VPCRegion_Ap_southeast_2 :: VPCRegion
- pattern VPCRegion_Ca_central_1 :: VPCRegion
- pattern VPCRegion_Cn_north_1 :: VPCRegion
- pattern VPCRegion_Eu_central_1 :: VPCRegion
- pattern VPCRegion_Eu_north_1 :: VPCRegion
- pattern VPCRegion_Eu_south_1 :: VPCRegion
- pattern VPCRegion_Eu_west_1 :: VPCRegion
- pattern VPCRegion_Eu_west_2 :: VPCRegion
- pattern VPCRegion_Eu_west_3 :: VPCRegion
- pattern VPCRegion_Me_south_1 :: VPCRegion
- pattern VPCRegion_Sa_east_1 :: VPCRegion
- pattern VPCRegion_Us_east_1 :: VPCRegion
- pattern VPCRegion_Us_east_2 :: VPCRegion
- pattern VPCRegion_Us_gov_east_1 :: VPCRegion
- pattern VPCRegion_Us_gov_west_1 :: VPCRegion
- pattern VPCRegion_Us_iso_east_1 :: VPCRegion
- pattern VPCRegion_Us_isob_east_1 :: VPCRegion
- pattern VPCRegion_Us_west_1 :: VPCRegion
- pattern VPCRegion_Us_west_2 :: VPCRegion
- data AccountLimit = AccountLimit' {}
- newAccountLimit :: AccountLimitType -> Natural -> AccountLimit
- accountLimit_type :: Lens' AccountLimit AccountLimitType
- accountLimit_value :: Lens' AccountLimit Natural
- data AlarmIdentifier = AlarmIdentifier' {
- region :: CloudWatchRegion
- name :: Text
- newAlarmIdentifier :: CloudWatchRegion -> Text -> AlarmIdentifier
- alarmIdentifier_region :: Lens' AlarmIdentifier CloudWatchRegion
- alarmIdentifier_name :: Lens' AlarmIdentifier Text
- data AliasTarget = AliasTarget' {}
- newAliasTarget :: ResourceId -> Text -> Bool -> AliasTarget
- aliasTarget_hostedZoneId :: Lens' AliasTarget ResourceId
- aliasTarget_dNSName :: Lens' AliasTarget Text
- aliasTarget_evaluateTargetHealth :: Lens' AliasTarget Bool
- data Change = Change' {}
- newChange :: ChangeAction -> ResourceRecordSet -> Change
- change_action :: Lens' Change ChangeAction
- change_resourceRecordSet :: Lens' Change ResourceRecordSet
- data ChangeBatch = ChangeBatch' {}
- newChangeBatch :: NonEmpty Change -> ChangeBatch
- changeBatch_comment :: Lens' ChangeBatch (Maybe Text)
- changeBatch_changes :: Lens' ChangeBatch (NonEmpty Change)
- data ChangeInfo = ChangeInfo' {
- comment :: Maybe Text
- id :: ResourceId
- status :: ChangeStatus
- submittedAt :: ISO8601
- newChangeInfo :: ResourceId -> ChangeStatus -> UTCTime -> ChangeInfo
- changeInfo_comment :: Lens' ChangeInfo (Maybe Text)
- changeInfo_id :: Lens' ChangeInfo ResourceId
- changeInfo_status :: Lens' ChangeInfo ChangeStatus
- changeInfo_submittedAt :: Lens' ChangeInfo UTCTime
- data CloudWatchAlarmConfiguration = CloudWatchAlarmConfiguration' {}
- newCloudWatchAlarmConfiguration :: Natural -> Double -> ComparisonOperator -> Natural -> Text -> Text -> Statistic -> CloudWatchAlarmConfiguration
- cloudWatchAlarmConfiguration_dimensions :: Lens' CloudWatchAlarmConfiguration (Maybe [Dimension])
- cloudWatchAlarmConfiguration_evaluationPeriods :: Lens' CloudWatchAlarmConfiguration Natural
- cloudWatchAlarmConfiguration_threshold :: Lens' CloudWatchAlarmConfiguration Double
- cloudWatchAlarmConfiguration_comparisonOperator :: Lens' CloudWatchAlarmConfiguration ComparisonOperator
- cloudWatchAlarmConfiguration_period :: Lens' CloudWatchAlarmConfiguration Natural
- cloudWatchAlarmConfiguration_metricName :: Lens' CloudWatchAlarmConfiguration Text
- cloudWatchAlarmConfiguration_namespace :: Lens' CloudWatchAlarmConfiguration Text
- cloudWatchAlarmConfiguration_statistic :: Lens' CloudWatchAlarmConfiguration Statistic
- data DNSSECStatus = DNSSECStatus' {}
- newDNSSECStatus :: DNSSECStatus
- dNSSECStatus_serveSignature :: Lens' DNSSECStatus (Maybe Text)
- dNSSECStatus_statusMessage :: Lens' DNSSECStatus (Maybe Text)
- data DelegationSet = DelegationSet' {}
- newDelegationSet :: NonEmpty Text -> DelegationSet
- delegationSet_id :: Lens' DelegationSet (Maybe ResourceId)
- delegationSet_callerReference :: Lens' DelegationSet (Maybe Text)
- delegationSet_nameServers :: Lens' DelegationSet (NonEmpty Text)
- data Dimension = Dimension' {}
- newDimension :: Text -> Text -> Dimension
- dimension_name :: Lens' Dimension Text
- dimension_value :: Lens' Dimension Text
- data GeoLocation = GeoLocation' {}
- newGeoLocation :: GeoLocation
- geoLocation_subdivisionCode :: Lens' GeoLocation (Maybe Text)
- geoLocation_countryCode :: Lens' GeoLocation (Maybe Text)
- geoLocation_continentCode :: Lens' GeoLocation (Maybe Text)
- data GeoLocationDetails = GeoLocationDetails' {}
- newGeoLocationDetails :: GeoLocationDetails
- geoLocationDetails_subdivisionName :: Lens' GeoLocationDetails (Maybe Text)
- geoLocationDetails_subdivisionCode :: Lens' GeoLocationDetails (Maybe Text)
- geoLocationDetails_countryName :: Lens' GeoLocationDetails (Maybe Text)
- geoLocationDetails_countryCode :: Lens' GeoLocationDetails (Maybe Text)
- geoLocationDetails_continentCode :: Lens' GeoLocationDetails (Maybe Text)
- geoLocationDetails_continentName :: Lens' GeoLocationDetails (Maybe Text)
- data HealthCheck = HealthCheck' {}
- newHealthCheck :: Text -> Text -> HealthCheckConfig -> Natural -> HealthCheck
- healthCheck_linkedService :: Lens' HealthCheck (Maybe LinkedService)
- healthCheck_cloudWatchAlarmConfiguration :: Lens' HealthCheck (Maybe CloudWatchAlarmConfiguration)
- healthCheck_id :: Lens' HealthCheck Text
- healthCheck_callerReference :: Lens' HealthCheck Text
- healthCheck_healthCheckConfig :: Lens' HealthCheck HealthCheckConfig
- healthCheck_healthCheckVersion :: Lens' HealthCheck Natural
- data HealthCheckConfig = HealthCheckConfig' {
- failureThreshold :: Maybe Natural
- iPAddress :: Maybe Text
- enableSNI :: Maybe Bool
- disabled :: Maybe Bool
- searchString :: Maybe Text
- healthThreshold :: Maybe Natural
- regions :: Maybe (NonEmpty HealthCheckRegion)
- resourcePath :: Maybe Text
- insufficientDataHealthStatus :: Maybe InsufficientDataHealthStatus
- alarmIdentifier :: Maybe AlarmIdentifier
- measureLatency :: Maybe Bool
- inverted :: Maybe Bool
- fullyQualifiedDomainName :: Maybe Text
- childHealthChecks :: Maybe [Text]
- routingControlArn :: Maybe Text
- requestInterval :: Maybe Natural
- port :: Maybe Natural
- type' :: HealthCheckType
- newHealthCheckConfig :: HealthCheckType -> HealthCheckConfig
- healthCheckConfig_failureThreshold :: Lens' HealthCheckConfig (Maybe Natural)
- healthCheckConfig_iPAddress :: Lens' HealthCheckConfig (Maybe Text)
- healthCheckConfig_enableSNI :: Lens' HealthCheckConfig (Maybe Bool)
- healthCheckConfig_disabled :: Lens' HealthCheckConfig (Maybe Bool)
- healthCheckConfig_searchString :: Lens' HealthCheckConfig (Maybe Text)
- healthCheckConfig_healthThreshold :: Lens' HealthCheckConfig (Maybe Natural)
- healthCheckConfig_regions :: Lens' HealthCheckConfig (Maybe (NonEmpty HealthCheckRegion))
- healthCheckConfig_resourcePath :: Lens' HealthCheckConfig (Maybe Text)
- healthCheckConfig_insufficientDataHealthStatus :: Lens' HealthCheckConfig (Maybe InsufficientDataHealthStatus)
- healthCheckConfig_alarmIdentifier :: Lens' HealthCheckConfig (Maybe AlarmIdentifier)
- healthCheckConfig_measureLatency :: Lens' HealthCheckConfig (Maybe Bool)
- healthCheckConfig_inverted :: Lens' HealthCheckConfig (Maybe Bool)
- healthCheckConfig_fullyQualifiedDomainName :: Lens' HealthCheckConfig (Maybe Text)
- healthCheckConfig_childHealthChecks :: Lens' HealthCheckConfig (Maybe [Text])
- healthCheckConfig_routingControlArn :: Lens' HealthCheckConfig (Maybe Text)
- healthCheckConfig_requestInterval :: Lens' HealthCheckConfig (Maybe Natural)
- healthCheckConfig_port :: Lens' HealthCheckConfig (Maybe Natural)
- healthCheckConfig_type :: Lens' HealthCheckConfig HealthCheckType
- data HealthCheckObservation = HealthCheckObservation' {}
- newHealthCheckObservation :: HealthCheckObservation
- healthCheckObservation_iPAddress :: Lens' HealthCheckObservation (Maybe Text)
- healthCheckObservation_statusReport :: Lens' HealthCheckObservation (Maybe StatusReport)
- healthCheckObservation_region :: Lens' HealthCheckObservation (Maybe HealthCheckRegion)
- data HostedZone = HostedZone' {}
- newHostedZone :: ResourceId -> Text -> Text -> HostedZone
- hostedZone_linkedService :: Lens' HostedZone (Maybe LinkedService)
- hostedZone_config :: Lens' HostedZone (Maybe HostedZoneConfig)
- hostedZone_resourceRecordSetCount :: Lens' HostedZone (Maybe Integer)
- hostedZone_id :: Lens' HostedZone ResourceId
- hostedZone_name :: Lens' HostedZone Text
- hostedZone_callerReference :: Lens' HostedZone Text
- data HostedZoneConfig = HostedZoneConfig' {}
- newHostedZoneConfig :: HostedZoneConfig
- hostedZoneConfig_privateZone :: Lens' HostedZoneConfig (Maybe Bool)
- hostedZoneConfig_comment :: Lens' HostedZoneConfig (Maybe Text)
- data HostedZoneLimit = HostedZoneLimit' {}
- newHostedZoneLimit :: HostedZoneLimitType -> Natural -> HostedZoneLimit
- hostedZoneLimit_type :: Lens' HostedZoneLimit HostedZoneLimitType
- hostedZoneLimit_value :: Lens' HostedZoneLimit Natural
- data HostedZoneOwner = HostedZoneOwner' {}
- newHostedZoneOwner :: HostedZoneOwner
- hostedZoneOwner_owningAccount :: Lens' HostedZoneOwner (Maybe Text)
- hostedZoneOwner_owningService :: Lens' HostedZoneOwner (Maybe Text)
- data HostedZoneSummary = HostedZoneSummary' {}
- newHostedZoneSummary :: ResourceId -> Text -> HostedZoneOwner -> HostedZoneSummary
- hostedZoneSummary_hostedZoneId :: Lens' HostedZoneSummary ResourceId
- hostedZoneSummary_name :: Lens' HostedZoneSummary Text
- hostedZoneSummary_owner :: Lens' HostedZoneSummary HostedZoneOwner
- data KeySigningKey = KeySigningKey' {
- status :: Maybe Text
- signingAlgorithmMnemonic :: Maybe Text
- digestAlgorithmMnemonic :: Maybe Text
- lastModifiedDate :: Maybe ISO8601
- keyTag :: Maybe Natural
- dNSKEYRecord :: Maybe Text
- publicKey :: Maybe Text
- signingAlgorithmType :: Maybe Int
- createdDate :: Maybe ISO8601
- flag :: Maybe Int
- digestAlgorithmType :: Maybe Int
- statusMessage :: Maybe Text
- name :: Maybe Text
- dSRecord :: Maybe Text
- kmsArn :: Maybe Text
- digestValue :: Maybe Text
- newKeySigningKey :: KeySigningKey
- keySigningKey_status :: Lens' KeySigningKey (Maybe Text)
- keySigningKey_signingAlgorithmMnemonic :: Lens' KeySigningKey (Maybe Text)
- keySigningKey_digestAlgorithmMnemonic :: Lens' KeySigningKey (Maybe Text)
- keySigningKey_lastModifiedDate :: Lens' KeySigningKey (Maybe UTCTime)
- keySigningKey_keyTag :: Lens' KeySigningKey (Maybe Natural)
- keySigningKey_dNSKEYRecord :: Lens' KeySigningKey (Maybe Text)
- keySigningKey_publicKey :: Lens' KeySigningKey (Maybe Text)
- keySigningKey_signingAlgorithmType :: Lens' KeySigningKey (Maybe Int)
- keySigningKey_createdDate :: Lens' KeySigningKey (Maybe UTCTime)
- keySigningKey_flag :: Lens' KeySigningKey (Maybe Int)
- keySigningKey_digestAlgorithmType :: Lens' KeySigningKey (Maybe Int)
- keySigningKey_statusMessage :: Lens' KeySigningKey (Maybe Text)
- keySigningKey_name :: Lens' KeySigningKey (Maybe Text)
- keySigningKey_dSRecord :: Lens' KeySigningKey (Maybe Text)
- keySigningKey_kmsArn :: Lens' KeySigningKey (Maybe Text)
- keySigningKey_digestValue :: Lens' KeySigningKey (Maybe Text)
- data LinkedService = LinkedService' {}
- newLinkedService :: LinkedService
- linkedService_servicePrincipal :: Lens' LinkedService (Maybe Text)
- linkedService_description :: Lens' LinkedService (Maybe Text)
- data QueryLoggingConfig = QueryLoggingConfig' {}
- newQueryLoggingConfig :: Text -> ResourceId -> Text -> QueryLoggingConfig
- queryLoggingConfig_id :: Lens' QueryLoggingConfig Text
- queryLoggingConfig_hostedZoneId :: Lens' QueryLoggingConfig ResourceId
- queryLoggingConfig_cloudWatchLogsLogGroupArn :: Lens' QueryLoggingConfig Text
- data ResourceRecord = ResourceRecord' {}
- newResourceRecord :: Text -> ResourceRecord
- resourceRecord_value :: Lens' ResourceRecord Text
- data ResourceRecordSet = ResourceRecordSet' {
- ttl :: Maybe Natural
- resourceRecords :: Maybe (NonEmpty ResourceRecord)
- aliasTarget :: Maybe AliasTarget
- weight :: Maybe Natural
- trafficPolicyInstanceId :: Maybe Text
- setIdentifier :: Maybe Text
- failover :: Maybe ResourceRecordSetFailover
- healthCheckId :: Maybe Text
- region :: Maybe Region
- geoLocation :: Maybe GeoLocation
- multiValueAnswer :: Maybe Bool
- name :: Text
- type' :: RRType
- newResourceRecordSet :: Text -> RRType -> ResourceRecordSet
- resourceRecordSet_ttl :: Lens' ResourceRecordSet (Maybe Natural)
- resourceRecordSet_resourceRecords :: Lens' ResourceRecordSet (Maybe (NonEmpty ResourceRecord))
- resourceRecordSet_aliasTarget :: Lens' ResourceRecordSet (Maybe AliasTarget)
- resourceRecordSet_weight :: Lens' ResourceRecordSet (Maybe Natural)
- resourceRecordSet_trafficPolicyInstanceId :: Lens' ResourceRecordSet (Maybe Text)
- resourceRecordSet_setIdentifier :: Lens' ResourceRecordSet (Maybe Text)
- resourceRecordSet_failover :: Lens' ResourceRecordSet (Maybe ResourceRecordSetFailover)
- resourceRecordSet_healthCheckId :: Lens' ResourceRecordSet (Maybe Text)
- resourceRecordSet_region :: Lens' ResourceRecordSet (Maybe Region)
- resourceRecordSet_geoLocation :: Lens' ResourceRecordSet (Maybe GeoLocation)
- resourceRecordSet_multiValueAnswer :: Lens' ResourceRecordSet (Maybe Bool)
- resourceRecordSet_name :: Lens' ResourceRecordSet Text
- resourceRecordSet_type :: Lens' ResourceRecordSet RRType
- data ResourceTagSet = ResourceTagSet' {
- resourceId :: Maybe Text
- resourceType :: Maybe TagResourceType
- tags :: Maybe (NonEmpty Tag)
- newResourceTagSet :: ResourceTagSet
- resourceTagSet_resourceId :: Lens' ResourceTagSet (Maybe Text)
- resourceTagSet_resourceType :: Lens' ResourceTagSet (Maybe TagResourceType)
- resourceTagSet_tags :: Lens' ResourceTagSet (Maybe (NonEmpty Tag))
- data ReusableDelegationSetLimit = ReusableDelegationSetLimit' {}
- newReusableDelegationSetLimit :: ReusableDelegationSetLimitType -> Natural -> ReusableDelegationSetLimit
- reusableDelegationSetLimit_type :: Lens' ReusableDelegationSetLimit ReusableDelegationSetLimitType
- reusableDelegationSetLimit_value :: Lens' ReusableDelegationSetLimit Natural
- data StatusReport = StatusReport' {}
- newStatusReport :: StatusReport
- statusReport_status :: Lens' StatusReport (Maybe Text)
- statusReport_checkedTime :: Lens' StatusReport (Maybe UTCTime)
- data Tag = Tag' {}
- newTag :: Tag
- tag_value :: Lens' Tag (Maybe Text)
- tag_key :: Lens' Tag (Maybe Text)
- data TrafficPolicy = TrafficPolicy' {}
- newTrafficPolicy :: Text -> Natural -> Text -> RRType -> Text -> TrafficPolicy
- trafficPolicy_comment :: Lens' TrafficPolicy (Maybe Text)
- trafficPolicy_id :: Lens' TrafficPolicy Text
- trafficPolicy_version :: Lens' TrafficPolicy Natural
- trafficPolicy_name :: Lens' TrafficPolicy Text
- trafficPolicy_type :: Lens' TrafficPolicy RRType
- trafficPolicy_document :: Lens' TrafficPolicy Text
- data TrafficPolicyInstance = TrafficPolicyInstance' {
- id :: Text
- hostedZoneId :: ResourceId
- name :: Text
- ttl :: Natural
- state :: Text
- message :: Text
- trafficPolicyId :: Text
- trafficPolicyVersion :: Natural
- trafficPolicyType :: RRType
- newTrafficPolicyInstance :: Text -> ResourceId -> Text -> Natural -> Text -> Text -> Text -> Natural -> RRType -> TrafficPolicyInstance
- trafficPolicyInstance_id :: Lens' TrafficPolicyInstance Text
- trafficPolicyInstance_hostedZoneId :: Lens' TrafficPolicyInstance ResourceId
- trafficPolicyInstance_name :: Lens' TrafficPolicyInstance Text
- trafficPolicyInstance_ttl :: Lens' TrafficPolicyInstance Natural
- trafficPolicyInstance_state :: Lens' TrafficPolicyInstance Text
- trafficPolicyInstance_message :: Lens' TrafficPolicyInstance Text
- trafficPolicyInstance_trafficPolicyId :: Lens' TrafficPolicyInstance Text
- trafficPolicyInstance_trafficPolicyVersion :: Lens' TrafficPolicyInstance Natural
- trafficPolicyInstance_trafficPolicyType :: Lens' TrafficPolicyInstance RRType
- data TrafficPolicySummary = TrafficPolicySummary' {
- id :: Text
- name :: Text
- type' :: RRType
- latestVersion :: Natural
- trafficPolicyCount :: Natural
- newTrafficPolicySummary :: Text -> Text -> RRType -> Natural -> Natural -> TrafficPolicySummary
- trafficPolicySummary_id :: Lens' TrafficPolicySummary Text
- trafficPolicySummary_name :: Lens' TrafficPolicySummary Text
- trafficPolicySummary_type :: Lens' TrafficPolicySummary RRType
- trafficPolicySummary_latestVersion :: Lens' TrafficPolicySummary Natural
- trafficPolicySummary_trafficPolicyCount :: Lens' TrafficPolicySummary Natural
- data VPC = VPC' {}
- newVPC :: VPC
- vpc_vPCRegion :: Lens' VPC (Maybe VPCRegion)
- vpc_vPCId :: Lens' VPC (Maybe Text)
Service Configuration
defaultService :: Service Source #
API version 2013-04-01
of the Amazon Route 53 SDK configuration.
Errors
_HealthCheckVersionMismatch :: AsError a => Getting (First ServiceError) a ServiceError Source #
The value of HealthCheckVersion
in the request doesn't match the
value of HealthCheckVersion
in the health check.
_NoSuchQueryLoggingConfig :: AsError a => Getting (First ServiceError) a ServiceError Source #
There is no DNS query logging configuration with the specified ID.
_DNSSECNotFound :: AsError a => Getting (First ServiceError) a ServiceError Source #
The hosted zone doesn't have any DNSSEC resources.
_KeySigningKeyInUse :: AsError a => Getting (First ServiceError) a ServiceError Source #
The key-signing key (KSK) that you specified can't be deactivated because it's the only KSK for a currently-enabled DNSSEC. Disable DNSSEC signing, or add or enable another KSK.
_TooManyKeySigningKeys :: AsError a => Getting (First ServiceError) a ServiceError Source #
You've reached the limit for the number of key-signing keys (KSKs). Remove at least one KSK, and then try again.
_HostedZoneNotPrivate :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified hosted zone is a public hosted zone, not a private hosted zone.
_InvalidInput :: AsError a => Getting (First ServiceError) a ServiceError Source #
The input is not valid.
_HostedZoneNotEmpty :: AsError a => Getting (First ServiceError) a ServiceError Source #
The hosted zone contains resource records that are not SOA or NS records.
_InvalidArgument :: AsError a => Getting (First ServiceError) a ServiceError Source #
Parameter name is not valid.
_KeySigningKeyWithActiveStatusNotFound :: AsError a => Getting (First ServiceError) a ServiceError Source #
A key-signing key (KSK) with ACTIVE
status wasn't found.
_TrafficPolicyInstanceAlreadyExists :: AsError a => Getting (First ServiceError) a ServiceError Source #
There is already a traffic policy instance with the specified ID.
_ConflictingTypes :: AsError a => Getting (First ServiceError) a ServiceError Source #
You tried to update a traffic policy instance by using a traffic policy
version that has a different DNS type than the current type for the
instance. You specified the type in the JSON document in the
CreateTrafficPolicy
or CreateTrafficPolicyVersion
request.
_QueryLoggingConfigAlreadyExists :: AsError a => Getting (First ServiceError) a ServiceError Source #
You can create only one query logging configuration for a hosted zone, and a query logging configuration already exists for this hosted zone.
_ConcurrentModification :: AsError a => Getting (First ServiceError) a ServiceError Source #
Another user submitted a request to create, update, or delete the object at the same time that you did. Retry the request.
_DelegationSetAlreadyReusable :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified delegation set has already been marked as reusable.
_NotAuthorizedException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Associating the specified VPC with the specified hosted zone has not been authorized.
_InsufficientCloudWatchLogsResourcePolicy :: AsError a => Getting (First ServiceError) a ServiceError Source #
Amazon Route 53 doesn't have the permissions required to create log streams and send query logs to log streams. Possible causes include the following:
- There is no resource policy that specifies the log group ARN in the
value for
Resource
. - The resource policy that includes the log group ARN in the value for
Resource
doesn't have the necessary permissions. - The resource policy hasn't finished propagating yet.
- The Key management service (KMS) key you specified doesn’t exist or it can’t be used with the log group associated with query log. Update or provide a resource policy to grant permissions for the KMS key.
_NoSuchCloudWatchLogsLogGroup :: AsError a => Getting (First ServiceError) a ServiceError Source #
There is no CloudWatch Logs log group with the specified ARN.
_PriorRequestNotComplete :: AsError a => Getting (First ServiceError) a ServiceError Source #
If Amazon Route 53 can't process a request before the next request
arrives, it will reject subsequent requests for the same hosted zone and
return an HTTP 400 error
(Bad request
). If Route 53 returns this
error repeatedly for the same request, we recommend that you wait, in
intervals of increasing duration, before you try the request again.
_InvalidChangeBatch :: AsError a => Getting (First ServiceError) a ServiceError Source #
This exception contains a list of messages that might contain one or more error messages. Each error message indicates one error in the change batch.
_TooManyVPCAssociationAuthorizations :: AsError a => Getting (First ServiceError) a ServiceError Source #
You've created the maximum number of authorizations that can be created
for the specified hosted zone. To authorize another VPC to be associated
with the hosted zone, submit a DeleteVPCAssociationAuthorization
request to remove an existing authorization. To get a list of existing
authorizations, submit a ListVPCAssociationAuthorizations
request.
_TrafficPolicyAlreadyExists :: AsError a => Getting (First ServiceError) a ServiceError Source #
A traffic policy that has the same value for Name
already exists.
_InvalidTrafficPolicyDocument :: AsError a => Getting (First ServiceError) a ServiceError Source #
The format of the traffic policy document that you specified in the
Document
element is not valid.
_InvalidSigningStatus :: AsError a => Getting (First ServiceError) a ServiceError Source #
Your hosted zone status isn't valid for this operation. In the hosted
zone, change the status to enable DNSSEC
or disable DNSSEC
.
_InvalidPaginationToken :: AsError a => Getting (First ServiceError) a ServiceError Source #
The value that you specified to get the second or subsequent page of results is invalid.
_DelegationSetNotReusable :: AsError a => Getting (First ServiceError) a ServiceError Source #
A reusable delegation set with the specified ID does not exist.
_InvalidDomainName :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified domain name is not valid.
_NoSuchTrafficPolicy :: AsError a => Getting (First ServiceError) a ServiceError Source #
No traffic policy exists with the specified ID.
_HostedZoneNotFound :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified HostedZone can't be found.
_DelegationSetInUse :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified delegation contains associated hosted zones which must be deleted before the reusable delegation set can be deleted.
_NoSuchDelegationSet :: AsError a => Getting (First ServiceError) a ServiceError Source #
A reusable delegation set with the specified ID does not exist.
_HealthCheckAlreadyExists :: AsError a => Getting (First ServiceError) a ServiceError Source #
The health check you're attempting to create already exists. Amazon Route 53 returns this error when you submit a request that has the following values:
- The same value for
CallerReference
as an existing health check, and one or more values that differ from the existing health check that has the same caller reference. - The same value for
CallerReference
as a health check that you created and later deleted, regardless of the other settings in the request.
_TooManyTrafficPolicies :: AsError a => Getting (First ServiceError) a ServiceError Source #
This traffic policy can't be created because the current account has reached the limit on the number of traffic policies.
For information about default limits, see Limits in the Amazon Route 53 Developer Guide.
To get the current limit for an account, see GetAccountLimit.
To request a higher limit, create a case with the Amazon Web Services Support Center.
_VPCAssociationAuthorizationNotFound :: AsError a => Getting (First ServiceError) a ServiceError Source #
The VPC that you specified is not authorized to be associated with the hosted zone.
_NoSuchGeoLocation :: AsError a => Getting (First ServiceError) a ServiceError Source #
Amazon Route 53 doesn't support the specified geographic location. For a list of supported geolocation codes, see the GeoLocation data type.
_DelegationSetNotAvailable :: AsError a => Getting (First ServiceError) a ServiceError Source #
You can create a hosted zone that has the same name as an existing hosted zone (example.com is common), but there is a limit to the number of hosted zones that have the same name. If you get this error, Amazon Route 53 has reached that limit. If you own the domain name and Route 53 generates this error, contact Customer Support.
_NoSuchKeySigningKey :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified key-signing key (KSK) doesn't exist.
_VPCAssociationNotFound :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified VPC and hosted zone are not currently associated.
_ThrottlingException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The limit on the number of requests per second was exceeded.
_HostedZonePartiallyDelegated :: AsError a => Getting (First ServiceError) a ServiceError Source #
The hosted zone nameservers don't match the parent nameservers. The hosted zone and parent must have the same nameservers.
_KeySigningKeyInParentDSRecord :: AsError a => Getting (First ServiceError) a ServiceError Source #
The key-signing key (KSK) is specified in a parent DS record.
_NoSuchChange :: AsError a => Getting (First ServiceError) a ServiceError Source #
A change with the specified change ID does not exist.
_InvalidKeySigningKeyName :: AsError a => Getting (First ServiceError) a ServiceError Source #
The key-signing key (KSK) name that you specified isn't a valid name.
_LimitsExceeded :: AsError a => Getting (First ServiceError) a ServiceError Source #
This operation can't be completed either because the current account has reached the limit on reusable delegation sets that it can create or because you've reached the limit on the number of Amazon VPCs that you can associate with a private hosted zone. To get the current limit on the number of reusable delegation sets, see GetAccountLimit. To get the current limit on the number of Amazon VPCs that you can associate with a private hosted zone, see GetHostedZoneLimit. To request a higher limit, create a case with the Amazon Web Services Support Center.
_KeySigningKeyAlreadyExists :: AsError a => Getting (First ServiceError) a ServiceError Source #
You've already created a key-signing key (KSK) with this name or with the same customer managed customer master key (CMK) ARN.
_TooManyTrafficPolicyInstances :: AsError a => Getting (First ServiceError) a ServiceError Source #
This traffic policy instance can't be created because the current account has reached the limit on the number of traffic policy instances.
For information about default limits, see Limits in the Amazon Route 53 Developer Guide.
For information about how to get the current limit for an account, see GetAccountLimit.
To request a higher limit, create a case with the Amazon Web Services Support Center.
_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're trying to access is unsupported on this Amazon Route 53 endpoint.
_PublicZoneVPCAssociation :: AsError a => Getting (First ServiceError) a ServiceError Source #
You're trying to associate a VPC with a public hosted zone. Amazon Route 53 doesn't support associating a VPC with a public hosted zone.
_NoSuchHostedZone :: AsError a => Getting (First ServiceError) a ServiceError Source #
No hosted zone exists with the ID that you specified.
_TooManyHostedZones :: AsError a => Getting (First ServiceError) a ServiceError Source #
This operation can't be completed either because the current account has reached the limit on the number of hosted zones or because you've reached the limit on the number of hosted zones that can be associated with a reusable delegation set.
For information about default limits, see Limits in the Amazon Route 53 Developer Guide.
To get the current limit on hosted zones that can be created by an account, see GetAccountLimit.
To get the current limit on hosted zones that can be associated with a reusable delegation set, see GetReusableDelegationSetLimit.
To request a higher limit, create a case with the Amazon Web Services Support Center.
_HealthCheckInUse :: AsError a => Getting (First ServiceError) a ServiceError Source #
This error code is not in use.
_InvalidKeySigningKeyStatus :: AsError a => Getting (First ServiceError) a ServiceError Source #
The key-signing key (KSK) status isn't valid or another KSK has the
status INTERNAL_FAILURE
.
_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 #
The cause of this error depends on the operation that you're performing:
- Create a public hosted zone: Two hosted zones that have the same name or that have a parent/child relationship (example.com and test.example.com) can't have any common name servers. You tried to create a hosted zone that has the same name as an existing hosted zone or that's the parent or child of an existing hosted zone, and you specified a delegation set that shares one or more name servers with the existing hosted zone. For more information, see CreateReusableDelegationSet.
- Create a private hosted zone: A hosted zone with the specified name already exists and is already associated with the Amazon VPC that you specified.
- Associate VPCs with a private hosted zone: The VPC that you specified is already associated with another hosted zone that has the same name.
_LastVPCAssociation :: AsError a => Getting (First ServiceError) a ServiceError Source #
The VPC that you're trying to disassociate from the private hosted zone is the last VPC that is associated with the hosted zone. Amazon Route 53 doesn't support disassociating the last VPC from a hosted zone.
_TooManyHealthChecks :: AsError a => Getting (First ServiceError) a ServiceError Source #
This health check can't be created because the current account has reached the limit on the number of active health checks.
For information about default limits, see Limits in the Amazon Route 53 Developer Guide.
For information about how to get the current limit for an account, see GetAccountLimit. To request a higher limit, create a case with the Amazon Web Services Support Center.
You have reached the maximum number of active health checks for an Amazon Web Services account. To request a higher limit, create a case with the Amazon Web Services Support Center.
_NoSuchHealthCheck :: AsError a => Getting (First ServiceError) a ServiceError Source #
No health check exists with the specified ID.
_InvalidKMSArn :: AsError a => Getting (First ServiceError) a ServiceError Source #
The KeyManagementServiceArn that you specified isn't valid to use with DNSSEC signing.
_TrafficPolicyInUse :: AsError a => Getting (First ServiceError) a ServiceError Source #
One or more traffic policy instances were created by using the specified traffic policy.
_InvalidVPCId :: AsError a => Getting (First ServiceError) a ServiceError Source #
The VPC ID that you specified either isn't a valid ID or the current account is not authorized to access this VPC.
_HostedZoneAlreadyExists :: AsError a => Getting (First ServiceError) a ServiceError Source #
The hosted zone you're trying to create already exists. Amazon Route 53
returns this error when a hosted zone has already been created with the
specified CallerReference
.
_TooManyTrafficPolicyVersionsForCurrentPolicy :: AsError a => Getting (First ServiceError) a ServiceError Source #
This traffic policy version can't be created because you've reached the limit of 1000 on the number of versions that you can create for the current traffic policy.
To create more traffic policy versions, you can use GetTrafficPolicy to get the traffic policy document for a specified traffic policy version, and then use CreateTrafficPolicy to create a new traffic policy using the traffic policy document.
Re-exported Types
module Amazonka.Route53.Internal
AccountLimitType
newtype AccountLimitType Source #
Instances
ChangeAction
newtype ChangeAction Source #
pattern ChangeAction_CREATE :: ChangeAction | |
pattern ChangeAction_DELETE :: ChangeAction | |
pattern ChangeAction_UPSERT :: ChangeAction |
Instances
ChangeStatus
newtype ChangeStatus Source #
pattern ChangeStatus_INSYNC :: ChangeStatus | |
pattern ChangeStatus_PENDING :: ChangeStatus |
Instances
CloudWatchRegion
newtype CloudWatchRegion Source #
Instances
ComparisonOperator
newtype ComparisonOperator Source #
Instances
HealthCheckRegion
newtype HealthCheckRegion Source #
pattern HealthCheckRegion_Ap_northeast_1 :: HealthCheckRegion | |
pattern HealthCheckRegion_Ap_southeast_1 :: HealthCheckRegion | |
pattern HealthCheckRegion_Ap_southeast_2 :: HealthCheckRegion | |
pattern HealthCheckRegion_Eu_west_1 :: HealthCheckRegion | |
pattern HealthCheckRegion_Sa_east_1 :: HealthCheckRegion | |
pattern HealthCheckRegion_Us_east_1 :: HealthCheckRegion | |
pattern HealthCheckRegion_Us_west_1 :: HealthCheckRegion | |
pattern HealthCheckRegion_Us_west_2 :: HealthCheckRegion |
Instances
HealthCheckType
newtype HealthCheckType Source #
pattern HealthCheckType_CALCULATED :: HealthCheckType | |
pattern HealthCheckType_CLOUDWATCH_METRIC :: HealthCheckType | |
pattern HealthCheckType_HTTP :: HealthCheckType | |
pattern HealthCheckType_HTTPS :: HealthCheckType | |
pattern HealthCheckType_HTTPS_STR_MATCH :: HealthCheckType | |
pattern HealthCheckType_HTTP_STR_MATCH :: HealthCheckType | |
pattern HealthCheckType_RECOVERY_CONTROL :: HealthCheckType | |
pattern HealthCheckType_TCP :: HealthCheckType |
Instances
HostedZoneLimitType
newtype HostedZoneLimitType Source #
pattern HostedZoneLimitType_MAX_RRSETS_BY_ZONE :: HostedZoneLimitType | |
pattern HostedZoneLimitType_MAX_VPCS_ASSOCIATED_BY_ZONE :: HostedZoneLimitType |
Instances
InsufficientDataHealthStatus
newtype InsufficientDataHealthStatus Source #
Instances
RRType
pattern RRType_A :: RRType | |
pattern RRType_AAAA :: RRType | |
pattern RRType_CAA :: RRType | |
pattern RRType_CNAME :: RRType | |
pattern RRType_DS :: RRType | |
pattern RRType_MX :: RRType | |
pattern RRType_NAPTR :: RRType | |
pattern RRType_NS :: RRType | |
pattern RRType_PTR :: RRType | |
pattern RRType_SOA :: RRType | |
pattern RRType_SPF :: RRType | |
pattern RRType_SRV :: RRType | |
pattern RRType_TXT :: RRType |
Instances
ResettableElementName
newtype ResettableElementName Source #
Instances
ResourceRecordSetFailover
newtype ResourceRecordSetFailover Source #
pattern ResourceRecordSetFailover_PRIMARY :: ResourceRecordSetFailover | |
pattern ResourceRecordSetFailover_SECONDARY :: ResourceRecordSetFailover |
Instances
ReusableDelegationSetLimitType
newtype ReusableDelegationSetLimitType Source #
pattern ReusableDelegationSetLimitType_MAX_ZONES_BY_REUSABLE_DELEGATION_SET :: ReusableDelegationSetLimitType |
Instances
Statistic
pattern Statistic_Average :: Statistic | |
pattern Statistic_Maximum :: Statistic | |
pattern Statistic_Minimum :: Statistic | |
pattern Statistic_SampleCount :: Statistic | |
pattern Statistic_Sum :: Statistic |
Instances
TagResourceType
newtype TagResourceType Source #
pattern TagResourceType_Healthcheck :: TagResourceType | |
pattern TagResourceType_Hostedzone :: TagResourceType |
Instances
VPCRegion
Instances
AccountLimit
data AccountLimit Source #
A complex type that contains the type of limit that you specified in the request and the current value for that limit.
See: newAccountLimit
smart constructor.
AccountLimit' | |
|
Instances
Create a value of AccountLimit
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:type':AccountLimit'
, accountLimit_type
- The limit that you requested. Valid values include the following:
- MAX_HEALTH_CHECKS_BY_OWNER: The maximum number of health checks that you can create using the current account.
- MAX_HOSTED_ZONES_BY_OWNER: The maximum number of hosted zones that you can create using the current account.
- MAX_REUSABLE_DELEGATION_SETS_BY_OWNER: The maximum number of reusable delegation sets that you can create using the current account.
- MAX_TRAFFIC_POLICIES_BY_OWNER: The maximum number of traffic policies that you can create using the current account.
- MAX_TRAFFIC_POLICY_INSTANCES_BY_OWNER: The maximum number of traffic policy instances that you can create using the current account. (Traffic policy instances are referred to as traffic flow policy records in the Amazon Route 53 console.)
$sel:value:AccountLimit'
, accountLimit_value
- The current value for the limit that is specified by
Type.
accountLimit_type :: Lens' AccountLimit AccountLimitType Source #
The limit that you requested. Valid values include the following:
- MAX_HEALTH_CHECKS_BY_OWNER: The maximum number of health checks that you can create using the current account.
- MAX_HOSTED_ZONES_BY_OWNER: The maximum number of hosted zones that you can create using the current account.
- MAX_REUSABLE_DELEGATION_SETS_BY_OWNER: The maximum number of reusable delegation sets that you can create using the current account.
- MAX_TRAFFIC_POLICIES_BY_OWNER: The maximum number of traffic policies that you can create using the current account.
- MAX_TRAFFIC_POLICY_INSTANCES_BY_OWNER: The maximum number of traffic policy instances that you can create using the current account. (Traffic policy instances are referred to as traffic flow policy records in the Amazon Route 53 console.)
accountLimit_value :: Lens' AccountLimit Natural Source #
The current value for the limit that is specified by Type.
AlarmIdentifier
data AlarmIdentifier Source #
A complex type that identifies the CloudWatch alarm that you want Amazon Route 53 health checkers to use to determine whether the specified health check is healthy.
See: newAlarmIdentifier
smart constructor.
AlarmIdentifier' | |
|
Instances
Create a value of AlarmIdentifier
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:region:AlarmIdentifier'
, alarmIdentifier_region
- For the CloudWatch alarm that you want Route 53 health checkers to use
to determine whether this health check is healthy, the region that the
alarm was created in.
For the current list of CloudWatch regions, see Amazon CloudWatch endpoints and quotas in the Amazon Web Services General Reference.
$sel:name:AlarmIdentifier'
, alarmIdentifier_name
- The name of the CloudWatch alarm that you want Amazon Route 53 health
checkers to use to determine whether this health check is healthy.
Route 53 supports CloudWatch alarms with the following features:
- Standard-resolution metrics. High-resolution metrics aren't supported. For more information, see High-Resolution Metrics in the Amazon CloudWatch User Guide.
- Statistics: Average, Minimum, Maximum, Sum, and SampleCount. Extended statistics aren't supported.
alarmIdentifier_region :: Lens' AlarmIdentifier CloudWatchRegion Source #
For the CloudWatch alarm that you want Route 53 health checkers to use to determine whether this health check is healthy, the region that the alarm was created in.
For the current list of CloudWatch regions, see Amazon CloudWatch endpoints and quotas in the Amazon Web Services General Reference.
alarmIdentifier_name :: Lens' AlarmIdentifier Text Source #
The name of the CloudWatch alarm that you want Amazon Route 53 health checkers to use to determine whether this health check is healthy.
Route 53 supports CloudWatch alarms with the following features:
- Standard-resolution metrics. High-resolution metrics aren't supported. For more information, see High-Resolution Metrics in the Amazon CloudWatch User Guide.
- Statistics: Average, Minimum, Maximum, Sum, and SampleCount. Extended statistics aren't supported.
AliasTarget
data AliasTarget Source #
Alias resource record sets only: Information about the Amazon Web Services resource, such as a CloudFront distribution or an Amazon S3 bucket, that you want to route traffic to.
When creating resource record sets for a private hosted zone, note the following:
- Creating geolocation alias resource record sets or latency alias resource record sets in a private hosted zone is unsupported.
- For information about creating failover resource record sets in a private hosted zone, see Configuring Failover in a Private Hosted Zone.
See: newAliasTarget
smart constructor.
AliasTarget' | |
|
Instances
:: ResourceId | |
-> Text | |
-> Bool | |
-> AliasTarget |
Create a value of AliasTarget
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:hostedZoneId:AliasTarget'
, aliasTarget_hostedZoneId
- Alias resource records sets only: The value used depends on where you
want to route traffic:
- Amazon API Gateway custom regional APIs and edge-optimized APIs
- Specify the hosted zone ID for your API. You can get the applicable
value using the CLI command
get-domain-names:
- For regional APIs, specify the value of
regionalHostedZoneId
. - For edge-optimized APIs, specify the value of
distributionHostedZoneId
.
- For regional APIs, specify the value of
- Amazon Virtual Private Cloud interface VPC endpoint
- Specify the hosted zone ID for your interface endpoint. You can get
the value of
HostedZoneId
using the CLI command describe-vpc-endpoints. - CloudFront distribution
- Specify
Z2FDTNDATAQYW2
.Alias resource record sets for CloudFront can't be created in a private zone.
- Elastic Beanstalk environment
- Specify the hosted zone ID for the region that you created the environment in. The environment must have a regionalized subdomain. For a list of regions and the corresponding hosted zone IDs, see Elastic Beanstalk endpoints and quotas in the the Amazon Web Services General Reference.
- ELB load balancer
- Specify the value of the hosted zone ID for the load balancer. Use
the following methods to get the hosted zone ID:
- Elastic Load Balancing endpoints and quotas topic in the Amazon Web Services General Reference: Use the value that corresponds with the region that you created your load balancer in. Note that there are separate columns for Application and Classic Load Balancers and for Network Load Balancers.
- Amazon Web Services Management Console: Go to the Amazon EC2 page, choose Load Balancers in the navigation pane, select the load balancer, and get the value of the Hosted zone field on the Description tab.
Elastic Load Balancing API: Use
DescribeLoadBalancers
to get the applicable value. For more information, see the applicable guide:- Classic Load Balancers: Use
DescribeLoadBalancers
to get the value of
CanonicalHostedZoneNameId
. - Application and Network Load Balancers: Use
DescribeLoadBalancers
to get the value of
CanonicalHostedZoneId
.
- Classic Load Balancers: Use
DescribeLoadBalancers
to get the value of
CLI: Use
describe-load-balancers
to get the applicable value. For more information, see the applicable guide:- Classic Load Balancers: Use
describe-load-balancers
to get the value of
CanonicalHostedZoneNameId
. - Application and Network Load Balancers: Use
describe-load-balancers
to get the value of
CanonicalHostedZoneId
.
- Classic Load Balancers: Use
describe-load-balancers
to get the value of
- Global Accelerator accelerator
- Specify
Z2BJ6XQ5FK7U4H
. - An Amazon S3 bucket configured as a static website
- Specify the hosted zone ID for the region that you created the bucket in. For more information about valid values, see the table Amazon S3 Website Endpoints in the Amazon Web Services General Reference.
- Another Route 53 resource record set in your hosted zone
- Specify the hosted zone ID of your hosted zone. (An alias resource record set can't reference a resource record set in a different hosted zone.)
$sel:dNSName:AliasTarget'
, aliasTarget_dNSName
- Alias resource record sets only: The value that you specify depends on
where you want to route queries:
- Amazon API Gateway custom regional APIs and edge-optimized APIs
- Specify the applicable domain name for your API. You can get the
applicable value using the CLI command
get-domain-names:
- For regional APIs, specify the value of
regionalDomainName
. - For edge-optimized APIs, specify the value of
distributionDomainName
. This is the name of the associated CloudFront distribution, such asda1b2c3d4e5.cloudfront.net
.
The name of the record that you're creating must match a custom domain name for your API, such as
api.example.com
. - For regional APIs, specify the value of
- Amazon Virtual Private Cloud interface VPC endpoint
- Enter the API endpoint for the interface endpoint, such as
vpce-123456789abcdef01-example-us-east-1a.elasticloadbalancing.us-east-1.vpce.amazonaws.com
. For edge-optimized APIs, this is the domain name for the corresponding CloudFront distribution. You can get the value ofDnsName
using the CLI command describe-vpc-endpoints. - CloudFront distribution
- Specify the domain name that CloudFront assigned when you created
your distribution.
Your CloudFront distribution must include an alternate domain name that matches the name of the resource record set. For example, if the name of the resource record set is acme.example.com, your CloudFront distribution must include acme.example.com as one of the alternate domain names. For more information, see Using Alternate Domain Names (CNAMEs) in the Amazon CloudFront Developer Guide.
You can't create a resource record set in a private hosted zone to route traffic to a CloudFront distribution.
For failover alias records, you can't specify a CloudFront distribution for both the primary and secondary records. A distribution must include an alternate domain name that matches the name of the record. However, the primary and secondary records have the same name, and you can't include the same alternate domain name in more than one distribution.
- Elastic Beanstalk environment
- If the domain name for your Elastic Beanstalk environment includes
the region that you deployed the environment in, you can create an
alias record that routes traffic to the environment. For example,
the domain name
my-environment.us-west-2.elasticbeanstalk.com
is a regionalized domain name.For environments that were created before early 2016, the domain name doesn't include the region. To route traffic to these environments, you must create a CNAME record instead of an alias record. Note that you can't create a CNAME record for the root domain name. For example, if your domain name is example.com, you can create a record that routes traffic for acme.example.com to your Elastic Beanstalk environment, but you can't create a record that routes traffic for example.com to your Elastic Beanstalk environment.
For Elastic Beanstalk environments that have regionalized subdomains, specify the
CNAME
attribute for the environment. You can use the following methods to get the value of the CNAME attribute:- Amazon Web Services Management Console: For information about how to get the value by using the console, see Using Custom Domains with Elastic Beanstalk in the Elastic Beanstalk Developer Guide.
- Elastic Beanstalk API: Use the
DescribeEnvironments
action to get the value of theCNAME
attribute. For more information, see DescribeEnvironments in the Elastic Beanstalk API Reference. - CLI: Use the
describe-environments
command to get the value of theCNAME
attribute. For more information, see describe-environments in the CLI Command Reference.
- ELB load balancer
- Specify the DNS name that is associated with the load balancer. Get
the DNS name by using the Amazon Web Services Management Console,
the ELB API, or the CLI.
Amazon Web Services Management Console: Go to the EC2 page, choose Load Balancers in the navigation pane, choose the load balancer, choose the Description tab, and get the value of the DNS name field.
If you're routing traffic to a Classic Load Balancer, get the value that begins with dualstack. If you're routing traffic to another type of load balancer, get the value that applies to the record type, A or AAAA.
Elastic Load Balancing API: Use
DescribeLoadBalancers
to get the value ofDNSName
. For more information, see the applicable guide:- Classic Load Balancers: DescribeLoadBalancers
- Application and Network Load Balancers: DescribeLoadBalancers
CLI: Use
describe-load-balancers
to get the value ofDNSName
. For more information, see the applicable guide:- Classic Load Balancers: describe-load-balancers
- Application and Network Load Balancers: describe-load-balancers
- Global Accelerator accelerator
- Specify the DNS name for your accelerator:
- Global Accelerator API: To get the DNS name, use DescribeAccelerator.
- CLI: To get the DNS name, use describe-accelerator.
- Amazon S3 bucket that is configured as a static website
- Specify the domain name of the Amazon S3 website endpoint that you
created the bucket in, for example,
s3-website.us-east-2.amazonaws.com
. For more information about valid values, see the table Amazon S3 Website Endpoints in the Amazon Web Services General Reference. For more information about using S3 buckets for websites, see Getting Started with Amazon Route 53 in the Amazon Route 53 Developer Guide. - Another Route 53 resource record set
- Specify the value of the
Name
element for a resource record set in the current hosted zone.If you're creating an alias record that has the same name as the hosted zone (known as the zone apex), you can't specify the domain name for a record for which the value of
Type
isCNAME
. This is because the alias record must have the same type as the record that you're routing traffic to, and creating a CNAME record for the zone apex isn't supported even for an alias record.
$sel:evaluateTargetHealth:AliasTarget'
, aliasTarget_evaluateTargetHealth
- /Applies only to alias, failover alias, geolocation alias, latency
alias, and weighted alias resource record sets:/ When
EvaluateTargetHealth
is true
, an alias resource record set inherits
the health of the referenced Amazon Web Services resource, such as an
ELB load balancer or another resource record set in the hosted zone.
Note the following:
- CloudFront distributions
- You can't set
EvaluateTargetHealth
totrue
when the alias target is a CloudFront distribution. - Elastic Beanstalk environments that have regionalized subdomains
- If you specify an Elastic Beanstalk environment in
DNSName
and the environment contains an ELB load balancer, Elastic Load Balancing routes queries only to the healthy Amazon EC2 instances that are registered with the load balancer. (An environment automatically contains an ELB load balancer if it includes more than one Amazon EC2 instance.) If you setEvaluateTargetHealth
totrue
and either no Amazon EC2 instances are healthy or the load balancer itself is unhealthy, Route 53 routes queries to other available resources that are healthy, if any.If the environment contains a single Amazon EC2 instance, there are no special requirements.
- ELB load balancers
- Health checking behavior depends on the type of load balancer:
- Classic Load Balancers: If you specify an ELB Classic Load
Balancer in
DNSName
, Elastic Load Balancing routes queries only to the healthy Amazon EC2 instances that are registered with the load balancer. If you setEvaluateTargetHealth
totrue
and either no EC2 instances are healthy or the load balancer itself is unhealthy, Route 53 routes queries to other resources. Application and Network Load Balancers: If you specify an ELB Application or Network Load Balancer and you set
EvaluateTargetHealth
totrue
, Route 53 routes queries to the load balancer based on the health of the target groups that are associated with the load balancer:- For an Application or Network Load Balancer to be considered healthy, every target group that contains targets must contain at least one healthy target. If any target group contains only unhealthy targets, the load balancer is considered unhealthy, and Route 53 routes queries to other resources.
- A target group that has no registered targets is considered unhealthy.
When you create a load balancer, you configure settings for Elastic Load Balancing health checks; they're not Route 53 health checks, but they perform a similar function. Do not create Route 53 health checks for the EC2 instances that you register with an ELB load balancer.
- Classic Load Balancers: If you specify an ELB Classic Load
Balancer in
- S3 buckets
- There are no special requirements for setting
EvaluateTargetHealth
totrue
when the alias target is an S3 bucket. - Other records in the same hosted zone
- If the Amazon Web Services resource that you specify in
DNSName
is a record or a group of records (for example, a group of weighted records) but is not another alias record, we recommend that you associate a health check with all of the records in the alias target. For more information, see What Happens When You Omit Health Checks? in the Amazon Route 53 Developer Guide.
For more information and examples, see Amazon Route 53 Health Checks and DNS Failover in the Amazon Route 53 Developer Guide.
aliasTarget_hostedZoneId :: Lens' AliasTarget ResourceId Source #
Alias resource records sets only: The value used depends on where you want to route traffic:
- Amazon API Gateway custom regional APIs and edge-optimized APIs
- Specify the hosted zone ID for your API. You can get the applicable
value using the CLI command
get-domain-names:
- For regional APIs, specify the value of
regionalHostedZoneId
. - For edge-optimized APIs, specify the value of
distributionHostedZoneId
.
- For regional APIs, specify the value of
- Amazon Virtual Private Cloud interface VPC endpoint
- Specify the hosted zone ID for your interface endpoint. You can get
the value of
HostedZoneId
using the CLI command describe-vpc-endpoints. - CloudFront distribution
- Specify
Z2FDTNDATAQYW2
.Alias resource record sets for CloudFront can't be created in a private zone.
- Elastic Beanstalk environment
- Specify the hosted zone ID for the region that you created the environment in. The environment must have a regionalized subdomain. For a list of regions and the corresponding hosted zone IDs, see Elastic Beanstalk endpoints and quotas in the the Amazon Web Services General Reference.
- ELB load balancer
- Specify the value of the hosted zone ID for the load balancer. Use
the following methods to get the hosted zone ID:
- Elastic Load Balancing endpoints and quotas topic in the Amazon Web Services General Reference: Use the value that corresponds with the region that you created your load balancer in. Note that there are separate columns for Application and Classic Load Balancers and for Network Load Balancers.
- Amazon Web Services Management Console: Go to the Amazon EC2 page, choose Load Balancers in the navigation pane, select the load balancer, and get the value of the Hosted zone field on the Description tab.
Elastic Load Balancing API: Use
DescribeLoadBalancers
to get the applicable value. For more information, see the applicable guide:- Classic Load Balancers: Use
DescribeLoadBalancers
to get the value of
CanonicalHostedZoneNameId
. - Application and Network Load Balancers: Use
DescribeLoadBalancers
to get the value of
CanonicalHostedZoneId
.
- Classic Load Balancers: Use
DescribeLoadBalancers
to get the value of
CLI: Use
describe-load-balancers
to get the applicable value. For more information, see the applicable guide:- Classic Load Balancers: Use
describe-load-balancers
to get the value of
CanonicalHostedZoneNameId
. - Application and Network Load Balancers: Use
describe-load-balancers
to get the value of
CanonicalHostedZoneId
.
- Classic Load Balancers: Use
describe-load-balancers
to get the value of
- Global Accelerator accelerator
- Specify
Z2BJ6XQ5FK7U4H
. - An Amazon S3 bucket configured as a static website
- Specify the hosted zone ID for the region that you created the bucket in. For more information about valid values, see the table Amazon S3 Website Endpoints in the Amazon Web Services General Reference.
- Another Route 53 resource record set in your hosted zone
- Specify the hosted zone ID of your hosted zone. (An alias resource record set can't reference a resource record set in a different hosted zone.)
aliasTarget_dNSName :: Lens' AliasTarget Text Source #
Alias resource record sets only: The value that you specify depends on where you want to route queries:
- Amazon API Gateway custom regional APIs and edge-optimized APIs
- Specify the applicable domain name for your API. You can get the
applicable value using the CLI command
get-domain-names:
- For regional APIs, specify the value of
regionalDomainName
. - For edge-optimized APIs, specify the value of
distributionDomainName
. This is the name of the associated CloudFront distribution, such asda1b2c3d4e5.cloudfront.net
.
The name of the record that you're creating must match a custom domain name for your API, such as
api.example.com
. - For regional APIs, specify the value of
- Amazon Virtual Private Cloud interface VPC endpoint
- Enter the API endpoint for the interface endpoint, such as
vpce-123456789abcdef01-example-us-east-1a.elasticloadbalancing.us-east-1.vpce.amazonaws.com
. For edge-optimized APIs, this is the domain name for the corresponding CloudFront distribution. You can get the value ofDnsName
using the CLI command describe-vpc-endpoints. - CloudFront distribution
- Specify the domain name that CloudFront assigned when you created
your distribution.
Your CloudFront distribution must include an alternate domain name that matches the name of the resource record set. For example, if the name of the resource record set is acme.example.com, your CloudFront distribution must include acme.example.com as one of the alternate domain names. For more information, see Using Alternate Domain Names (CNAMEs) in the Amazon CloudFront Developer Guide.
You can't create a resource record set in a private hosted zone to route traffic to a CloudFront distribution.
For failover alias records, you can't specify a CloudFront distribution for both the primary and secondary records. A distribution must include an alternate domain name that matches the name of the record. However, the primary and secondary records have the same name, and you can't include the same alternate domain name in more than one distribution.
- Elastic Beanstalk environment
- If the domain name for your Elastic Beanstalk environment includes
the region that you deployed the environment in, you can create an
alias record that routes traffic to the environment. For example,
the domain name
my-environment.us-west-2.elasticbeanstalk.com
is a regionalized domain name.For environments that were created before early 2016, the domain name doesn't include the region. To route traffic to these environments, you must create a CNAME record instead of an alias record. Note that you can't create a CNAME record for the root domain name. For example, if your domain name is example.com, you can create a record that routes traffic for acme.example.com to your Elastic Beanstalk environment, but you can't create a record that routes traffic for example.com to your Elastic Beanstalk environment.
For Elastic Beanstalk environments that have regionalized subdomains, specify the
CNAME
attribute for the environment. You can use the following methods to get the value of the CNAME attribute:- Amazon Web Services Management Console: For information about how to get the value by using the console, see Using Custom Domains with Elastic Beanstalk in the Elastic Beanstalk Developer Guide.
- Elastic Beanstalk API: Use the
DescribeEnvironments
action to get the value of theCNAME
attribute. For more information, see DescribeEnvironments in the Elastic Beanstalk API Reference. - CLI: Use the
describe-environments
command to get the value of theCNAME
attribute. For more information, see describe-environments in the CLI Command Reference.
- ELB load balancer
- Specify the DNS name that is associated with the load balancer. Get
the DNS name by using the Amazon Web Services Management Console,
the ELB API, or the CLI.
Amazon Web Services Management Console: Go to the EC2 page, choose Load Balancers in the navigation pane, choose the load balancer, choose the Description tab, and get the value of the DNS name field.
If you're routing traffic to a Classic Load Balancer, get the value that begins with dualstack. If you're routing traffic to another type of load balancer, get the value that applies to the record type, A or AAAA.
Elastic Load Balancing API: Use
DescribeLoadBalancers
to get the value ofDNSName
. For more information, see the applicable guide:- Classic Load Balancers: DescribeLoadBalancers
- Application and Network Load Balancers: DescribeLoadBalancers
CLI: Use
describe-load-balancers
to get the value ofDNSName
. For more information, see the applicable guide:- Classic Load Balancers: describe-load-balancers
- Application and Network Load Balancers: describe-load-balancers
- Global Accelerator accelerator
- Specify the DNS name for your accelerator:
- Global Accelerator API: To get the DNS name, use DescribeAccelerator.
- CLI: To get the DNS name, use describe-accelerator.
- Amazon S3 bucket that is configured as a static website
- Specify the domain name of the Amazon S3 website endpoint that you
created the bucket in, for example,
s3-website.us-east-2.amazonaws.com
. For more information about valid values, see the table Amazon S3 Website Endpoints in the Amazon Web Services General Reference. For more information about using S3 buckets for websites, see Getting Started with Amazon Route 53 in the Amazon Route 53 Developer Guide. - Another Route 53 resource record set
- Specify the value of the
Name
element for a resource record set in the current hosted zone.If you're creating an alias record that has the same name as the hosted zone (known as the zone apex), you can't specify the domain name for a record for which the value of
Type
isCNAME
. This is because the alias record must have the same type as the record that you're routing traffic to, and creating a CNAME record for the zone apex isn't supported even for an alias record.
aliasTarget_evaluateTargetHealth :: Lens' AliasTarget Bool Source #
/Applies only to alias, failover alias, geolocation alias, latency
alias, and weighted alias resource record sets:/ When
EvaluateTargetHealth
is true
, an alias resource record set inherits
the health of the referenced Amazon Web Services resource, such as an
ELB load balancer or another resource record set in the hosted zone.
Note the following:
- CloudFront distributions
- You can't set
EvaluateTargetHealth
totrue
when the alias target is a CloudFront distribution. - Elastic Beanstalk environments that have regionalized subdomains
- If you specify an Elastic Beanstalk environment in
DNSName
and the environment contains an ELB load balancer, Elastic Load Balancing routes queries only to the healthy Amazon EC2 instances that are registered with the load balancer. (An environment automatically contains an ELB load balancer if it includes more than one Amazon EC2 instance.) If you setEvaluateTargetHealth
totrue
and either no Amazon EC2 instances are healthy or the load balancer itself is unhealthy, Route 53 routes queries to other available resources that are healthy, if any.If the environment contains a single Amazon EC2 instance, there are no special requirements.
- ELB load balancers
- Health checking behavior depends on the type of load balancer:
- Classic Load Balancers: If you specify an ELB Classic Load
Balancer in
DNSName
, Elastic Load Balancing routes queries only to the healthy Amazon EC2 instances that are registered with the load balancer. If you setEvaluateTargetHealth
totrue
and either no EC2 instances are healthy or the load balancer itself is unhealthy, Route 53 routes queries to other resources. Application and Network Load Balancers: If you specify an ELB Application or Network Load Balancer and you set
EvaluateTargetHealth
totrue
, Route 53 routes queries to the load balancer based on the health of the target groups that are associated with the load balancer:- For an Application or Network Load Balancer to be considered healthy, every target group that contains targets must contain at least one healthy target. If any target group contains only unhealthy targets, the load balancer is considered unhealthy, and Route 53 routes queries to other resources.
- A target group that has no registered targets is considered unhealthy.
When you create a load balancer, you configure settings for Elastic Load Balancing health checks; they're not Route 53 health checks, but they perform a similar function. Do not create Route 53 health checks for the EC2 instances that you register with an ELB load balancer.
- Classic Load Balancers: If you specify an ELB Classic Load
Balancer in
- S3 buckets
- There are no special requirements for setting
EvaluateTargetHealth
totrue
when the alias target is an S3 bucket. - Other records in the same hosted zone
- If the Amazon Web Services resource that you specify in
DNSName
is a record or a group of records (for example, a group of weighted records) but is not another alias record, we recommend that you associate a health check with all of the records in the alias target. For more information, see What Happens When You Omit Health Checks? in the Amazon Route 53 Developer Guide.
For more information and examples, see Amazon Route 53 Health Checks and DNS Failover in the Amazon Route 53 Developer Guide.
Change
The information for each resource record set that you want to change.
See: newChange
smart constructor.
Change' | |
|
Instances
Eq Change Source # | |
Read Change Source # | |
Show Change Source # | |
Generic Change Source # | |
NFData Change Source # | |
Defined in Amazonka.Route53.Types.Change | |
Hashable Change Source # | |
Defined in Amazonka.Route53.Types.Change | |
ToXML Change Source # | |
Defined in Amazonka.Route53.Types.Change | |
type Rep Change Source # | |
Defined in Amazonka.Route53.Types.Change type Rep Change = D1 ('MetaData "Change" "Amazonka.Route53.Types.Change" "libZSservicesZSamazonka-route53ZSamazonka-route53" 'False) (C1 ('MetaCons "Change'" 'PrefixI 'True) (S1 ('MetaSel ('Just "action") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ChangeAction) :*: S1 ('MetaSel ('Just "resourceRecordSet") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ResourceRecordSet))) |
Create a value of Change
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:action:Change'
, change_action
- The action to perform:
CREATE
: Creates a resource record set that has the specified values.DELETE
: Deletes a existing resource record set.To delete the resource record set that is associated with a traffic policy instance, use DeleteTrafficPolicyInstance. Amazon Route 53 will delete the resource record set automatically. If you delete the resource record set by using
ChangeResourceRecordSets
, Route 53 doesn't automatically delete the traffic policy instance, and you'll continue to be charged for it even though it's no longer in use.UPSERT
: If a resource record set doesn't already exist, Route 53 creates it. If a resource record set does exist, Route 53 updates it with the values in the request.
$sel:resourceRecordSet:Change'
, change_resourceRecordSet
- Information about the resource record set to create, delete, or update.
change_action :: Lens' Change ChangeAction Source #
The action to perform:
CREATE
: Creates a resource record set that has the specified values.DELETE
: Deletes a existing resource record set.To delete the resource record set that is associated with a traffic policy instance, use DeleteTrafficPolicyInstance. Amazon Route 53 will delete the resource record set automatically. If you delete the resource record set by using
ChangeResourceRecordSets
, Route 53 doesn't automatically delete the traffic policy instance, and you'll continue to be charged for it even though it's no longer in use.UPSERT
: If a resource record set doesn't already exist, Route 53 creates it. If a resource record set does exist, Route 53 updates it with the values in the request.
change_resourceRecordSet :: Lens' Change ResourceRecordSet Source #
Information about the resource record set to create, delete, or update.
ChangeBatch
data ChangeBatch Source #
The information for a change request.
See: newChangeBatch
smart constructor.
Instances
Create a value of ChangeBatch
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:comment:ChangeBatch'
, changeBatch_comment
- Optional: Any comments you want to include about a change batch
request.
$sel:changes:ChangeBatch'
, changeBatch_changes
- Information about the changes to make to the record sets.
changeBatch_comment :: Lens' ChangeBatch (Maybe Text) Source #
Optional: Any comments you want to include about a change batch request.
changeBatch_changes :: Lens' ChangeBatch (NonEmpty Change) Source #
Information about the changes to make to the record sets.
ChangeInfo
data ChangeInfo Source #
A complex type that describes change information about changes made to your hosted zone.
See: newChangeInfo
smart constructor.
ChangeInfo' | |
|
Instances
:: ResourceId | |
-> ChangeStatus | |
-> UTCTime | |
-> ChangeInfo |
Create a value of ChangeInfo
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:comment:ChangeInfo'
, changeInfo_comment
- A comment you can provide.
$sel:id:ChangeInfo'
, changeInfo_id
- This element contains an ID that you use when performing a
GetChange
action to get detailed information about the change.
$sel:status:ChangeInfo'
, changeInfo_status
- The current state of the request. PENDING
indicates that this request
has not yet been applied to all Amazon Route 53 DNS servers.
$sel:submittedAt:ChangeInfo'
, changeInfo_submittedAt
- The date and time that the change request was submitted in
ISO 8601 format and Coordinated
Universal Time (UTC). For example, the value 2017-03-27T17:48:16.751Z
represents March 27, 2017 at 17:48:16.751 UTC.
changeInfo_comment :: Lens' ChangeInfo (Maybe Text) Source #
A comment you can provide.
changeInfo_id :: Lens' ChangeInfo ResourceId Source #
This element contains an ID that you use when performing a GetChange action to get detailed information about the change.
changeInfo_status :: Lens' ChangeInfo ChangeStatus Source #
The current state of the request. PENDING
indicates that this request
has not yet been applied to all Amazon Route 53 DNS servers.
changeInfo_submittedAt :: Lens' ChangeInfo UTCTime Source #
The date and time that the change request was submitted in
ISO 8601 format and Coordinated
Universal Time (UTC). For example, the value 2017-03-27T17:48:16.751Z
represents March 27, 2017 at 17:48:16.751 UTC.
CloudWatchAlarmConfiguration
data CloudWatchAlarmConfiguration Source #
A complex type that contains information about the CloudWatch alarm that Amazon Route 53 is monitoring for this health check.
See: newCloudWatchAlarmConfiguration
smart constructor.
CloudWatchAlarmConfiguration' | |
|
Instances
newCloudWatchAlarmConfiguration Source #
:: Natural | |
-> Double | |
-> ComparisonOperator | |
-> Natural | |
-> Text | |
-> Text | |
-> Statistic | |
-> CloudWatchAlarmConfiguration |
Create a value of CloudWatchAlarmConfiguration
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dimensions:CloudWatchAlarmConfiguration'
, cloudWatchAlarmConfiguration_dimensions
- For the metric that the CloudWatch alarm is associated with, a complex
type that contains information about the dimensions for the metric. For
information, see
Amazon CloudWatch Namespaces, Dimensions, and Metrics Reference
in the Amazon CloudWatch User Guide.
$sel:evaluationPeriods:CloudWatchAlarmConfiguration'
, cloudWatchAlarmConfiguration_evaluationPeriods
- For the metric that the CloudWatch alarm is associated with, the number
of periods that the metric is compared to the threshold.
$sel:threshold:CloudWatchAlarmConfiguration'
, cloudWatchAlarmConfiguration_threshold
- For the metric that the CloudWatch alarm is associated with, the value
the metric is compared with.
$sel:comparisonOperator:CloudWatchAlarmConfiguration'
, cloudWatchAlarmConfiguration_comparisonOperator
- For the metric that the CloudWatch alarm is associated with, the
arithmetic operation that is used for the comparison.
$sel:period:CloudWatchAlarmConfiguration'
, cloudWatchAlarmConfiguration_period
- For the metric that the CloudWatch alarm is associated with, the
duration of one evaluation period in seconds.
$sel:metricName:CloudWatchAlarmConfiguration'
, cloudWatchAlarmConfiguration_metricName
- The name of the CloudWatch metric that the alarm is associated with.
$sel:namespace:CloudWatchAlarmConfiguration'
, cloudWatchAlarmConfiguration_namespace
- The namespace of the metric that the alarm is associated with. For more
information, see
Amazon CloudWatch Namespaces, Dimensions, and Metrics Reference
in the Amazon CloudWatch User Guide.
$sel:statistic:CloudWatchAlarmConfiguration'
, cloudWatchAlarmConfiguration_statistic
- For the metric that the CloudWatch alarm is associated with, the
statistic that is applied to the metric.
cloudWatchAlarmConfiguration_dimensions :: Lens' CloudWatchAlarmConfiguration (Maybe [Dimension]) Source #
For the metric that the CloudWatch alarm is associated with, a complex type that contains information about the dimensions for the metric. For information, see Amazon CloudWatch Namespaces, Dimensions, and Metrics Reference in the Amazon CloudWatch User Guide.
cloudWatchAlarmConfiguration_evaluationPeriods :: Lens' CloudWatchAlarmConfiguration Natural Source #
For the metric that the CloudWatch alarm is associated with, the number of periods that the metric is compared to the threshold.
cloudWatchAlarmConfiguration_threshold :: Lens' CloudWatchAlarmConfiguration Double Source #
For the metric that the CloudWatch alarm is associated with, the value the metric is compared with.
cloudWatchAlarmConfiguration_comparisonOperator :: Lens' CloudWatchAlarmConfiguration ComparisonOperator Source #
For the metric that the CloudWatch alarm is associated with, the arithmetic operation that is used for the comparison.
cloudWatchAlarmConfiguration_period :: Lens' CloudWatchAlarmConfiguration Natural Source #
For the metric that the CloudWatch alarm is associated with, the duration of one evaluation period in seconds.
cloudWatchAlarmConfiguration_metricName :: Lens' CloudWatchAlarmConfiguration Text Source #
The name of the CloudWatch metric that the alarm is associated with.
cloudWatchAlarmConfiguration_namespace :: Lens' CloudWatchAlarmConfiguration Text Source #
The namespace of the metric that the alarm is associated with. For more information, see Amazon CloudWatch Namespaces, Dimensions, and Metrics Reference in the Amazon CloudWatch User Guide.
cloudWatchAlarmConfiguration_statistic :: Lens' CloudWatchAlarmConfiguration Statistic Source #
For the metric that the CloudWatch alarm is associated with, the statistic that is applied to the metric.
DNSSECStatus
data DNSSECStatus Source #
A string repesenting the status of DNSSEC signing.
See: newDNSSECStatus
smart constructor.
DNSSECStatus' | |
|
Instances
newDNSSECStatus :: DNSSECStatus Source #
Create a value of DNSSECStatus
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:serveSignature:DNSSECStatus'
, dNSSECStatus_serveSignature
- A string that represents the current hosted zone signing status.
Status can have one of the following values:
- SIGNING
- DNSSEC signing is enabled for the hosted zone.
- NOT_SIGNING
- DNSSEC signing is not enabled for the hosted zone.
- DELETING
- DNSSEC signing is in the process of being removed for the hosted zone.
- ACTION_NEEDED
- There is a problem with signing in the hosted zone that requires you to take action to resolve. For example, the customer managed customer master key (CMK) might have been deleted, or the permissions for the customer managed CMK might have been changed.
- INTERNAL_FAILURE
- There was an error during a request. Before you can continue to work with DNSSEC signing, including with key-signing keys (KSKs), you must correct the problem by enabling or disabling DNSSEC signing for the hosted zone.
$sel:statusMessage:DNSSECStatus'
, dNSSECStatus_statusMessage
- The status message provided for the following DNSSEC signing status:
INTERNAL_FAILURE
. The status message includes information about what
the problem might be and steps that you can take to correct the issue.
dNSSECStatus_serveSignature :: Lens' DNSSECStatus (Maybe Text) Source #
A string that represents the current hosted zone signing status.
Status can have one of the following values:
- SIGNING
- DNSSEC signing is enabled for the hosted zone.
- NOT_SIGNING
- DNSSEC signing is not enabled for the hosted zone.
- DELETING
- DNSSEC signing is in the process of being removed for the hosted zone.
- ACTION_NEEDED
- There is a problem with signing in the hosted zone that requires you to take action to resolve. For example, the customer managed customer master key (CMK) might have been deleted, or the permissions for the customer managed CMK might have been changed.
- INTERNAL_FAILURE
- There was an error during a request. Before you can continue to work with DNSSEC signing, including with key-signing keys (KSKs), you must correct the problem by enabling or disabling DNSSEC signing for the hosted zone.
dNSSECStatus_statusMessage :: Lens' DNSSECStatus (Maybe Text) Source #
The status message provided for the following DNSSEC signing status:
INTERNAL_FAILURE
. The status message includes information about what
the problem might be and steps that you can take to correct the issue.
DelegationSet
data DelegationSet Source #
A complex type that lists the name servers in a delegation set, as well
as the CallerReference
and the ID
for the delegation set.
See: newDelegationSet
smart constructor.
DelegationSet' | |
|
Instances
Create a value of DelegationSet
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:id:DelegationSet'
, delegationSet_id
- The ID that Amazon Route 53 assigns to a reusable delegation set.
$sel:callerReference:DelegationSet'
, delegationSet_callerReference
- The value that you specified for CallerReference
when you created the
reusable delegation set.
$sel:nameServers:DelegationSet'
, delegationSet_nameServers
- A complex type that contains a list of the authoritative name servers
for a hosted zone or for a reusable delegation set.
delegationSet_id :: Lens' DelegationSet (Maybe ResourceId) Source #
The ID that Amazon Route 53 assigns to a reusable delegation set.
delegationSet_callerReference :: Lens' DelegationSet (Maybe Text) Source #
The value that you specified for CallerReference
when you created the
reusable delegation set.
delegationSet_nameServers :: Lens' DelegationSet (NonEmpty Text) Source #
A complex type that contains a list of the authoritative name servers for a hosted zone or for a reusable delegation set.
Dimension
For the metric that the CloudWatch alarm is associated with, a complex type that contains information about one dimension.
See: newDimension
smart constructor.
Instances
Eq Dimension Source # | |
Read Dimension Source # | |
Show Dimension Source # | |
Generic Dimension Source # | |
NFData Dimension Source # | |
Defined in Amazonka.Route53.Types.Dimension | |
Hashable Dimension Source # | |
Defined in Amazonka.Route53.Types.Dimension | |
FromXML Dimension Source # | |
type Rep Dimension Source # | |
Defined in Amazonka.Route53.Types.Dimension type Rep Dimension = D1 ('MetaData "Dimension" "Amazonka.Route53.Types.Dimension" "libZSservicesZSamazonka-route53ZSamazonka-route53" 'False) (C1 ('MetaCons "Dimension'" 'PrefixI 'True) (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) |
Create a value of Dimension
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:name:Dimension'
, dimension_name
- For the metric that the CloudWatch alarm is associated with, the name of
one dimension.
$sel:value:Dimension'
, dimension_value
- For the metric that the CloudWatch alarm is associated with, the value
of one dimension.
dimension_name :: Lens' Dimension Text Source #
For the metric that the CloudWatch alarm is associated with, the name of one dimension.
dimension_value :: Lens' Dimension Text Source #
For the metric that the CloudWatch alarm is associated with, the value of one dimension.
GeoLocation
data GeoLocation Source #
A complex type that contains information about a geographic location.
See: newGeoLocation
smart constructor.
GeoLocation' | |
|
Instances
newGeoLocation :: GeoLocation Source #
Create a value of GeoLocation
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:subdivisionCode:GeoLocation'
, geoLocation_subdivisionCode
- For geolocation resource record sets, the two-letter code for a state of
the United States. Route 53 doesn't support any other values for
SubdivisionCode
. For a list of state abbreviations, see
Appendix B: Two–Letter State and Possession Abbreviations
on the United States Postal Service website.
If you specify subdivisioncode
, you must also specify US
for
CountryCode
.
$sel:countryCode:GeoLocation'
, geoLocation_countryCode
- For geolocation resource record sets, the two-letter code for a country.
Amazon Route 53 uses the two-letter country codes that are specified in ISO standard 3166-1 alpha-2.
$sel:continentCode:GeoLocation'
, geoLocation_continentCode
- The two-letter code for the continent.
Amazon Route 53 supports the following continent codes:
- AF: Africa
- AN: Antarctica
- AS: Asia
- EU: Europe
- OC: Oceania
- NA: North America
- SA: South America
Constraint: Specifying ContinentCode
with either CountryCode
or
SubdivisionCode
returns an InvalidInput
error.
geoLocation_subdivisionCode :: Lens' GeoLocation (Maybe Text) Source #
For geolocation resource record sets, the two-letter code for a state of
the United States. Route 53 doesn't support any other values for
SubdivisionCode
. For a list of state abbreviations, see
Appendix B: Two–Letter State and Possession Abbreviations
on the United States Postal Service website.
If you specify subdivisioncode
, you must also specify US
for
CountryCode
.
geoLocation_countryCode :: Lens' GeoLocation (Maybe Text) Source #
For geolocation resource record sets, the two-letter code for a country.
Amazon Route 53 uses the two-letter country codes that are specified in ISO standard 3166-1 alpha-2.
geoLocation_continentCode :: Lens' GeoLocation (Maybe Text) Source #
The two-letter code for the continent.
Amazon Route 53 supports the following continent codes:
- AF: Africa
- AN: Antarctica
- AS: Asia
- EU: Europe
- OC: Oceania
- NA: North America
- SA: South America
Constraint: Specifying ContinentCode
with either CountryCode
or
SubdivisionCode
returns an InvalidInput
error.
GeoLocationDetails
data GeoLocationDetails Source #
A complex type that contains the codes and full continent, country, and
subdivision names for the specified geolocation
code.
See: newGeoLocationDetails
smart constructor.
GeoLocationDetails' | |
|
Instances
newGeoLocationDetails :: GeoLocationDetails Source #
Create a value of GeoLocationDetails
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:subdivisionName:GeoLocationDetails'
, geoLocationDetails_subdivisionName
- The full name of the subdivision. Route 53 currently supports only
states in the United States.
$sel:subdivisionCode:GeoLocationDetails'
, geoLocationDetails_subdivisionCode
- The code for the subdivision, such as a particular state within the
United States. For a list of US state abbreviations, see
Appendix B: Two–Letter State and Possession Abbreviations
on the United States Postal Service website. For a list of all supported
subdivision codes, use the
ListGeoLocations
API.
$sel:countryName:GeoLocationDetails'
, geoLocationDetails_countryName
- The name of the country.
$sel:countryCode:GeoLocationDetails'
, geoLocationDetails_countryCode
- The two-letter code for the country.
$sel:continentCode:GeoLocationDetails'
, geoLocationDetails_continentCode
- The two-letter code for the continent.
$sel:continentName:GeoLocationDetails'
, geoLocationDetails_continentName
- The full name of the continent.
geoLocationDetails_subdivisionName :: Lens' GeoLocationDetails (Maybe Text) Source #
The full name of the subdivision. Route 53 currently supports only states in the United States.
geoLocationDetails_subdivisionCode :: Lens' GeoLocationDetails (Maybe Text) Source #
The code for the subdivision, such as a particular state within the United States. For a list of US state abbreviations, see Appendix B: Two–Letter State and Possession Abbreviations on the United States Postal Service website. For a list of all supported subdivision codes, use the ListGeoLocations API.
geoLocationDetails_countryName :: Lens' GeoLocationDetails (Maybe Text) Source #
The name of the country.
geoLocationDetails_countryCode :: Lens' GeoLocationDetails (Maybe Text) Source #
The two-letter code for the country.
geoLocationDetails_continentCode :: Lens' GeoLocationDetails (Maybe Text) Source #
The two-letter code for the continent.
geoLocationDetails_continentName :: Lens' GeoLocationDetails (Maybe Text) Source #
The full name of the continent.
HealthCheck
data HealthCheck Source #
A complex type that contains information about one health check that is associated with the current Amazon Web Services account.
See: newHealthCheck
smart constructor.
HealthCheck' | |
|
Instances
:: Text | |
-> Text | |
-> HealthCheckConfig | |
-> Natural | |
-> HealthCheck |
Create a value of HealthCheck
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:linkedService:HealthCheck'
, healthCheck_linkedService
- If the health check was created by another service, the service that
created the health check. When a health check is created by another
service, you can't edit or delete it using Amazon Route 53.
$sel:cloudWatchAlarmConfiguration:HealthCheck'
, healthCheck_cloudWatchAlarmConfiguration
- A complex type that contains information about the CloudWatch alarm that
Amazon Route 53 is monitoring for this health check.
$sel:id:HealthCheck'
, healthCheck_id
- The identifier that Amazon Route 53 assigned to the health check when
you created it. When you add or update a resource record set, you use
this value to specify which health check to use. The value can be up to
64 characters long.
$sel:callerReference:HealthCheck'
, healthCheck_callerReference
- A unique string that you specified when you created the health check.
$sel:healthCheckConfig:HealthCheck'
, healthCheck_healthCheckConfig
- A complex type that contains detailed information about one health
check.
$sel:healthCheckVersion:HealthCheck'
, healthCheck_healthCheckVersion
- 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.
healthCheck_linkedService :: Lens' HealthCheck (Maybe LinkedService) Source #
If the health check was created by another service, the service that created the health check. When a health check is created by another service, you can't edit or delete it using Amazon Route 53.
healthCheck_cloudWatchAlarmConfiguration :: Lens' HealthCheck (Maybe CloudWatchAlarmConfiguration) Source #
A complex type that contains information about the CloudWatch alarm that Amazon Route 53 is monitoring for this health check.
healthCheck_id :: Lens' HealthCheck Text Source #
The identifier that Amazon Route 53 assigned to the health check when you created it. When you add or update a resource record set, you use this value to specify which health check to use. The value can be up to 64 characters long.
healthCheck_callerReference :: Lens' HealthCheck Text Source #
A unique string that you specified when you created the health check.
healthCheck_healthCheckConfig :: Lens' HealthCheck HealthCheckConfig Source #
A complex type that contains detailed information about one health check.
healthCheck_healthCheckVersion :: Lens' HealthCheck Natural Source #
The version of the health check. You can optionally pass this value in a
call to UpdateHealthCheck
to prevent overwriting another change to the
health check.
HealthCheckConfig
data HealthCheckConfig Source #
A complex type that contains information about the health check.
See: newHealthCheckConfig
smart constructor.
HealthCheckConfig' | |
|
Instances
Create a value of HealthCheckConfig
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:failureThreshold:HealthCheckConfig'
, healthCheckConfig_failureThreshold
- The number of consecutive health checks that an endpoint must pass or
fail for Amazon Route 53 to change the current status of the endpoint
from unhealthy to healthy or vice versa. For more information, see
How Amazon Route 53 Determines Whether an Endpoint Is Healthy
in the Amazon Route 53 Developer Guide.
If you don't specify a value for FailureThreshold
, the default value
is three health checks.
$sel:iPAddress:HealthCheckConfig'
, healthCheckConfig_iPAddress
- The IPv4 or IPv6 IP address of the endpoint that you want Amazon Route
53 to perform health checks on. If you don't specify a value for
IPAddress
, Route 53 sends a DNS request to resolve the domain name
that you specify in FullyQualifiedDomainName
at the interval that you
specify in RequestInterval
. Using an IP address returned by DNS, Route
53 then checks the health of the endpoint.
Use one of the following formats for the value of IPAddress
:
- IPv4 address: four values between 0 and 255, separated by
periods (.), for example,
192.0.2.44
. - IPv6 address: eight groups of four hexadecimal values, separated
by colons (:), for example,
2001:0db8:85a3:0000:0000:abcd:0001:2345
. You can also shorten IPv6 addresses as described in RFC 5952, for example,2001:db8:85a3::abcd:1:2345
.
If the endpoint is an EC2 instance, we recommend that you create an
Elastic IP address, associate it with your EC2 instance, and specify the
Elastic IP address for IPAddress
. This ensures that the IP address of
your instance will never change.
For more information, see FullyQualifiedDomainName.
Constraints: Route 53 can't check the health of endpoints for which the IP address is in local, private, non-routable, or multicast ranges. For more information about IP addresses for which you can't create health checks, see the following documents:
- RFC 5735, Special Use IPv4 Addresses
- RFC 6598, IANA-Reserved IPv4 Prefix for Shared Address Space
- RFC 5156, Special-Use IPv6 Addresses
When the value of Type
is CALCULATED
or CLOUDWATCH_METRIC
, omit
IPAddress
.
$sel:enableSNI:HealthCheckConfig'
, healthCheckConfig_enableSNI
- Specify whether you want Amazon Route 53 to send the value of
FullyQualifiedDomainName
to the endpoint in the client_hello
message
during TLS negotiation. This allows the endpoint to respond to HTTPS
health check requests with the applicable SSL/TLS certificate.
Some endpoints require that HTTPS
requests include the host name in
the client_hello
message. If you don't enable SNI, the status of the
health check will be SSL alert handshake_failure
. A health check can
also have that status for other reasons. If SNI is enabled and you're
still getting the error, check the SSL/TLS configuration on your
endpoint and confirm that your certificate is valid.
The SSL/TLS certificate on your endpoint includes a domain name in the
Common Name
field and possibly several more in the
Subject Alternative Names
field. One of the domain names in the
certificate should match the value that you specify for
FullyQualifiedDomainName
. If the endpoint responds to the
client_hello
message with a certificate that does not include the
domain name that you specified in FullyQualifiedDomainName
, a health
checker will retry the handshake. In the second attempt, the health
checker will omit FullyQualifiedDomainName
from the client_hello
message.
$sel:disabled:HealthCheckConfig'
, healthCheckConfig_disabled
- Stops Route 53 from performing health checks. When you disable a health
check, here's what happens:
- Health checks that check the health of endpoints: Route 53 stops submitting requests to your application, server, or other resource.
- Calculated health checks: Route 53 stops aggregating the status of the referenced health checks.
- Health checks that monitor CloudWatch alarms: Route 53 stops monitoring the corresponding CloudWatch metrics.
After you disable a health check, Route 53 considers the status of the health check to always be healthy. If you configured DNS failover, Route 53 continues to route traffic to the corresponding resources. If you want to stop routing traffic to a resource, change the value of Inverted.
Charges for a health check still apply when the health check is disabled. For more information, see Amazon Route 53 Pricing.
$sel:searchString:HealthCheckConfig'
, healthCheckConfig_searchString
- If the value of Type is HTTP_STR_MATCH
or HTTPS_STR_MATCH
, the
string that you want Amazon Route 53 to search for in the response body
from the specified resource. If the string appears in the response body,
Route 53 considers the resource healthy.
Route 53 considers case when searching for SearchString
in the
response body.
$sel:healthThreshold:HealthCheckConfig'
, healthCheckConfig_healthThreshold
- The number of child health checks that are associated with a
CALCULATED
health check that Amazon Route 53 must consider healthy for
the CALCULATED
health check to be considered healthy. To specify the
child health checks that you want to associate with a CALCULATED
health check, use the
ChildHealthChecks
element.
Note the following:
- If you specify a number greater than the number of child health checks, Route 53 always considers this health check to be unhealthy.
- If you specify
0
, Route 53 always considers this health check to be healthy.
$sel:regions:HealthCheckConfig'
, healthCheckConfig_regions
- A complex type that contains one Region
element for each region from
which you want Amazon Route 53 health checkers to check the specified
endpoint.
If you don't specify any regions, Route 53 health checkers automatically performs checks from all of the regions that are listed under Valid Values.
If you update a health check to remove a region that has been performing health checks, Route 53 will briefly continue to perform checks from that region to ensure that some health checkers are always checking the endpoint (for example, if you replace three regions with four different regions).
$sel:resourcePath:HealthCheckConfig'
, healthCheckConfig_resourcePath
- The path, if any, that you want Amazon Route 53 to request when
performing health checks. The path can be any value for which your
endpoint will return an HTTP status code of 2xx or 3xx when the endpoint
is healthy, for example, the file /docs/route53-health-check.html. You
can also include query string parameters, for example,
/welcome.html?language=jp&login=y
.
$sel:insufficientDataHealthStatus:HealthCheckConfig'
, healthCheckConfig_insufficientDataHealthStatus
- When CloudWatch has insufficient data about the metric to determine the
alarm state, the status that you want Amazon Route 53 to assign to the
health check:
Healthy
: Route 53 considers the health check to be healthy.Unhealthy
: Route 53 considers the health check to be unhealthy.LastKnownStatus
: Route 53 uses the status of the health check from the last time that CloudWatch had sufficient data to determine the alarm state. For new health checks that have no last known status, the default status for the health check is healthy.
$sel:alarmIdentifier:HealthCheckConfig'
, healthCheckConfig_alarmIdentifier
- A complex type that identifies the CloudWatch alarm that you want Amazon
Route 53 health checkers to use to determine whether the specified
health check is healthy.
$sel:measureLatency:HealthCheckConfig'
, healthCheckConfig_measureLatency
- Specify whether you want Amazon Route 53 to measure the latency between
health checkers in multiple Amazon Web Services regions and your
endpoint, and to display CloudWatch latency graphs on the __Health
Checks__ page in the Route 53 console.
You can't change the value of MeasureLatency
after you create a
health check.
$sel:inverted:HealthCheckConfig'
, healthCheckConfig_inverted
- Specify whether you want Amazon Route 53 to invert the status of a
health check, for example, to consider a health check unhealthy when it
otherwise would be considered healthy.
$sel:fullyQualifiedDomainName:HealthCheckConfig'
, healthCheckConfig_fullyQualifiedDomainName
- Amazon Route 53 behavior depends on whether you specify a value for
IPAddress
.
If you specify a value for IPAddress
:
Amazon Route 53 sends health check requests to the specified IPv4 or
IPv6 address and passes the value of FullyQualifiedDomainName
in the
Host
header for all health checks except TCP health checks. This is
typically the fully qualified DNS name of the endpoint on which you want
Route 53 to perform health checks.
When Route 53 checks the health of an endpoint, here is how it
constructs the Host
header:
- If you specify a value of
80
forPort
andHTTP
orHTTP_STR_MATCH
forType
, Route 53 passes the value ofFullyQualifiedDomainName
to the endpoint in the Host header. - If you specify a value of
443
forPort
andHTTPS
orHTTPS_STR_MATCH
forType
, Route 53 passes the value ofFullyQualifiedDomainName
to the endpoint in theHost
header. - If you specify another value for
Port
and any value exceptTCP
forType
, Route 53 passesFullyQualifiedDomainName:Port
to the endpoint in theHost
header.
If you don't specify a value for FullyQualifiedDomainName
, Route 53
substitutes the value of IPAddress
in the Host
header in each of the
preceding cases.
If you don't specify a value for IPAddress
:
Route 53 sends a DNS request to the domain that you specify for
FullyQualifiedDomainName
at the interval that you specify for
RequestInterval
. Using an IPv4 address that DNS returns, Route 53 then
checks the health of the endpoint.
If you don't specify a value for IPAddress
, Route 53 uses only IPv4
to send health checks to the endpoint. If there's no resource record
set with a type of A for the name that you specify for
FullyQualifiedDomainName
, the health check fails with a "DNS
resolution failed" error.
If you want to check the health of weighted, latency, or failover
resource record sets and you choose to specify the endpoint only by
FullyQualifiedDomainName
, we recommend that you create a separate
health check for each endpoint. For example, create a health check for
each HTTP server that is serving content for www.example.com. For the
value of FullyQualifiedDomainName
, specify the domain name of the
server (such as us-east-2-www.example.com), not the name of the resource
record sets (www.example.com).
In this configuration, if you create a health check for which the value
of FullyQualifiedDomainName
matches the name of the resource record
sets and you then associate the health check with those resource record
sets, health check results will be unpredictable.
In addition, if the value that you specify for Type
is HTTP
,
HTTPS
, HTTP_STR_MATCH
, or HTTPS_STR_MATCH
, Route 53 passes the
value of FullyQualifiedDomainName
in the Host
header, as it does
when you specify a value for IPAddress
. If the value of Type
is
TCP
, Route 53 doesn't pass a Host
header.
$sel:childHealthChecks:HealthCheckConfig'
, healthCheckConfig_childHealthChecks
- (CALCULATED Health Checks Only) A complex type that contains one
ChildHealthCheck
element for each health check that you want to
associate with a CALCULATED
health check.
$sel:routingControlArn:HealthCheckConfig'
, healthCheckConfig_routingControlArn
- The Amazon Resource Name (ARN) for the Route 53 Application Recovery
Controller routing control.
For more information about Route 53 Application Recovery Controller, see Route 53 Application Recovery Controller Developer Guide..
$sel:requestInterval:HealthCheckConfig'
, healthCheckConfig_requestInterval
- The number of seconds between the time that Amazon Route 53 gets a
response from your endpoint and the time that it sends the next health
check request. Each Route 53 health checker makes requests at this
interval.
You can't change the value of RequestInterval
after you create a
health check.
If you don't specify a value for RequestInterval
, the default value
is 30
seconds.
$sel:port:HealthCheckConfig'
, healthCheckConfig_port
- The port on the endpoint that you want Amazon Route 53 to perform health
checks on.
Don't specify a value for Port
when you specify a value for Type
of
CLOUDWATCH_METRIC
or CALCULATED
.
$sel:type':HealthCheckConfig'
, healthCheckConfig_type
- The type of health check that you want to create, which indicates how
Amazon Route 53 determines whether an endpoint is healthy.
You can't change the value of Type
after you create a health check.
You can create the following types of health checks:
- HTTP: Route 53 tries to establish a TCP connection. If successful, Route 53 submits an HTTP request and waits for an HTTP status code of 200 or greater and less than 400.
HTTPS: Route 53 tries to establish a TCP connection. If successful, Route 53 submits an HTTPS request and waits for an HTTP status code of 200 or greater and less than 400.
If you specify
HTTPS
for the value ofType
, the endpoint must support TLS v1.0 or later.- HTTP_STR_MATCH: Route 53 tries to establish a TCP connection. If
successful, Route 53 submits an HTTP request and searches the first
5,120 bytes of the response body for the string that you specify in
SearchString
. - HTTPS_STR_MATCH: Route 53 tries to establish a TCP connection.
If successful, Route 53 submits an
HTTPS
request and searches the first 5,120 bytes of the response body for the string that you specify inSearchString
. - TCP: Route 53 tries to establish a TCP connection.
- CLOUDWATCH_METRIC: The health check is associated with a
CloudWatch alarm. If the state of the alarm is
OK
, the health check is considered healthy. If the state isALARM
, the health check is considered unhealthy. If CloudWatch doesn't have sufficient data to determine whether the state isOK
orALARM
, the health check status depends on the setting forInsufficientDataHealthStatus
:Healthy
,Unhealthy
, orLastKnownStatus
. - CALCULATED: For health checks that monitor the status of other
health checks, Route 53 adds up the number of health checks that
Route 53 health checkers consider to be healthy and compares that
number with the value of
HealthThreshold
. - RECOVERY_CONTROL: The health check is assocated with a Route53
Application Recovery Controller routing control. If the routing
control state is
ON
, the health check is considered healthy. If the state isOFF
, the health check is considered unhealthy.
For more information, see How Route 53 Determines Whether an Endpoint Is Healthy in the Amazon Route 53 Developer Guide.
healthCheckConfig_failureThreshold :: Lens' HealthCheckConfig (Maybe Natural) Source #
The number of consecutive health checks that an endpoint must pass or fail for Amazon Route 53 to change the current status of the endpoint from unhealthy to healthy or vice versa. For more information, see How Amazon Route 53 Determines Whether an Endpoint Is Healthy in the Amazon Route 53 Developer Guide.
If you don't specify a value for FailureThreshold
, the default value
is three health checks.
healthCheckConfig_iPAddress :: Lens' HealthCheckConfig (Maybe Text) Source #
The IPv4 or IPv6 IP address of the endpoint that you want Amazon Route
53 to perform health checks on. If you don't specify a value for
IPAddress
, Route 53 sends a DNS request to resolve the domain name
that you specify in FullyQualifiedDomainName
at the interval that you
specify in RequestInterval
. Using an IP address returned by DNS, Route
53 then checks the health of the endpoint.
Use one of the following formats for the value of IPAddress
:
- IPv4 address: four values between 0 and 255, separated by
periods (.), for example,
192.0.2.44
. - IPv6 address: eight groups of four hexadecimal values, separated
by colons (:), for example,
2001:0db8:85a3:0000:0000:abcd:0001:2345
. You can also shorten IPv6 addresses as described in RFC 5952, for example,2001:db8:85a3::abcd:1:2345
.
If the endpoint is an EC2 instance, we recommend that you create an
Elastic IP address, associate it with your EC2 instance, and specify the
Elastic IP address for IPAddress
. This ensures that the IP address of
your instance will never change.
For more information, see FullyQualifiedDomainName.
Constraints: Route 53 can't check the health of endpoints for which the IP address is in local, private, non-routable, or multicast ranges. For more information about IP addresses for which you can't create health checks, see the following documents:
- RFC 5735, Special Use IPv4 Addresses
- RFC 6598, IANA-Reserved IPv4 Prefix for Shared Address Space
- RFC 5156, Special-Use IPv6 Addresses
When the value of Type
is CALCULATED
or CLOUDWATCH_METRIC
, omit
IPAddress
.
healthCheckConfig_enableSNI :: Lens' HealthCheckConfig (Maybe Bool) Source #
Specify whether you want Amazon Route 53 to send the value of
FullyQualifiedDomainName
to the endpoint in the client_hello
message
during TLS negotiation. This allows the endpoint to respond to HTTPS
health check requests with the applicable SSL/TLS certificate.
Some endpoints require that HTTPS
requests include the host name in
the client_hello
message. If you don't enable SNI, the status of the
health check will be SSL alert handshake_failure
. A health check can
also have that status for other reasons. If SNI is enabled and you're
still getting the error, check the SSL/TLS configuration on your
endpoint and confirm that your certificate is valid.
The SSL/TLS certificate on your endpoint includes a domain name in the
Common Name
field and possibly several more in the
Subject Alternative Names
field. One of the domain names in the
certificate should match the value that you specify for
FullyQualifiedDomainName
. If the endpoint responds to the
client_hello
message with a certificate that does not include the
domain name that you specified in FullyQualifiedDomainName
, a health
checker will retry the handshake. In the second attempt, the health
checker will omit FullyQualifiedDomainName
from the client_hello
message.
healthCheckConfig_disabled :: Lens' HealthCheckConfig (Maybe Bool) Source #
Stops Route 53 from performing health checks. When you disable a health check, here's what happens:
- Health checks that check the health of endpoints: Route 53 stops submitting requests to your application, server, or other resource.
- Calculated health checks: Route 53 stops aggregating the status of the referenced health checks.
- Health checks that monitor CloudWatch alarms: Route 53 stops monitoring the corresponding CloudWatch metrics.
After you disable a health check, Route 53 considers the status of the health check to always be healthy. If you configured DNS failover, Route 53 continues to route traffic to the corresponding resources. If you want to stop routing traffic to a resource, change the value of Inverted.
Charges for a health check still apply when the health check is disabled. For more information, see Amazon Route 53 Pricing.
healthCheckConfig_searchString :: Lens' HealthCheckConfig (Maybe Text) Source #
If the value of Type is HTTP_STR_MATCH
or HTTPS_STR_MATCH
, the
string that you want Amazon Route 53 to search for in the response body
from the specified resource. If the string appears in the response body,
Route 53 considers the resource healthy.
Route 53 considers case when searching for SearchString
in the
response body.
healthCheckConfig_healthThreshold :: Lens' HealthCheckConfig (Maybe Natural) Source #
The number of child health checks that are associated with a
CALCULATED
health check that Amazon Route 53 must consider healthy for
the CALCULATED
health check to be considered healthy. To specify the
child health checks that you want to associate with a CALCULATED
health check, use the
ChildHealthChecks
element.
Note the following:
- If you specify a number greater than the number of child health checks, Route 53 always considers this health check to be unhealthy.
- If you specify
0
, Route 53 always considers this health check to be healthy.
healthCheckConfig_regions :: Lens' HealthCheckConfig (Maybe (NonEmpty HealthCheckRegion)) Source #
A complex type that contains one Region
element for each region from
which you want Amazon Route 53 health checkers to check the specified
endpoint.
If you don't specify any regions, Route 53 health checkers automatically performs checks from all of the regions that are listed under Valid Values.
If you update a health check to remove a region that has been performing health checks, Route 53 will briefly continue to perform checks from that region to ensure that some health checkers are always checking the endpoint (for example, if you replace three regions with four different regions).
healthCheckConfig_resourcePath :: Lens' HealthCheckConfig (Maybe Text) Source #
The path, if any, that you want Amazon Route 53 to request when
performing health checks. The path can be any value for which your
endpoint will return an HTTP status code of 2xx or 3xx when the endpoint
is healthy, for example, the file /docs/route53-health-check.html. You
can also include query string parameters, for example,
/welcome.html?language=jp&login=y
.
healthCheckConfig_insufficientDataHealthStatus :: Lens' HealthCheckConfig (Maybe InsufficientDataHealthStatus) Source #
When CloudWatch has insufficient data about the metric to determine the alarm state, the status that you want Amazon Route 53 to assign to the health check:
Healthy
: Route 53 considers the health check to be healthy.Unhealthy
: Route 53 considers the health check to be unhealthy.LastKnownStatus
: Route 53 uses the status of the health check from the last time that CloudWatch had sufficient data to determine the alarm state. For new health checks that have no last known status, the default status for the health check is healthy.
healthCheckConfig_alarmIdentifier :: Lens' HealthCheckConfig (Maybe AlarmIdentifier) Source #
A complex type that identifies the CloudWatch alarm that you want Amazon Route 53 health checkers to use to determine whether the specified health check is healthy.
healthCheckConfig_measureLatency :: Lens' HealthCheckConfig (Maybe Bool) Source #
Specify whether you want Amazon Route 53 to measure the latency between health checkers in multiple Amazon Web Services regions and your endpoint, and to display CloudWatch latency graphs on the __Health Checks__ page in the Route 53 console.
You can't change the value of MeasureLatency
after you create a
health check.
healthCheckConfig_inverted :: Lens' HealthCheckConfig (Maybe Bool) Source #
Specify whether you want Amazon Route 53 to invert the status of a health check, for example, to consider a health check unhealthy when it otherwise would be considered healthy.
healthCheckConfig_fullyQualifiedDomainName :: Lens' HealthCheckConfig (Maybe Text) Source #
Amazon Route 53 behavior depends on whether you specify a value for
IPAddress
.
If you specify a value for IPAddress
:
Amazon Route 53 sends health check requests to the specified IPv4 or
IPv6 address and passes the value of FullyQualifiedDomainName
in the
Host
header for all health checks except TCP health checks. This is
typically the fully qualified DNS name of the endpoint on which you want
Route 53 to perform health checks.
When Route 53 checks the health of an endpoint, here is how it
constructs the Host
header:
- If you specify a value of
80
forPort
andHTTP
orHTTP_STR_MATCH
forType
, Route 53 passes the value ofFullyQualifiedDomainName
to the endpoint in the Host header. - If you specify a value of
443
forPort
andHTTPS
orHTTPS_STR_MATCH
forType
, Route 53 passes the value ofFullyQualifiedDomainName
to the endpoint in theHost
header. - If you specify another value for
Port
and any value exceptTCP
forType
, Route 53 passesFullyQualifiedDomainName:Port
to the endpoint in theHost
header.
If you don't specify a value for FullyQualifiedDomainName
, Route 53
substitutes the value of IPAddress
in the Host
header in each of the
preceding cases.
If you don't specify a value for IPAddress
:
Route 53 sends a DNS request to the domain that you specify for
FullyQualifiedDomainName
at the interval that you specify for
RequestInterval
. Using an IPv4 address that DNS returns, Route 53 then
checks the health of the endpoint.
If you don't specify a value for IPAddress
, Route 53 uses only IPv4
to send health checks to the endpoint. If there's no resource record
set with a type of A for the name that you specify for
FullyQualifiedDomainName
, the health check fails with a "DNS
resolution failed" error.
If you want to check the health of weighted, latency, or failover
resource record sets and you choose to specify the endpoint only by
FullyQualifiedDomainName
, we recommend that you create a separate
health check for each endpoint. For example, create a health check for
each HTTP server that is serving content for www.example.com. For the
value of FullyQualifiedDomainName
, specify the domain name of the
server (such as us-east-2-www.example.com), not the name of the resource
record sets (www.example.com).
In this configuration, if you create a health check for which the value
of FullyQualifiedDomainName
matches the name of the resource record
sets and you then associate the health check with those resource record
sets, health check results will be unpredictable.
In addition, if the value that you specify for Type
is HTTP
,
HTTPS
, HTTP_STR_MATCH
, or HTTPS_STR_MATCH
, Route 53 passes the
value of FullyQualifiedDomainName
in the Host
header, as it does
when you specify a value for IPAddress
. If the value of Type
is
TCP
, Route 53 doesn't pass a Host
header.
healthCheckConfig_childHealthChecks :: Lens' HealthCheckConfig (Maybe [Text]) Source #
(CALCULATED Health Checks Only) A complex type that contains one
ChildHealthCheck
element for each health check that you want to
associate with a CALCULATED
health check.
healthCheckConfig_routingControlArn :: Lens' HealthCheckConfig (Maybe Text) Source #
The Amazon Resource Name (ARN) for the Route 53 Application Recovery Controller routing control.
For more information about Route 53 Application Recovery Controller, see Route 53 Application Recovery Controller Developer Guide..
healthCheckConfig_requestInterval :: Lens' HealthCheckConfig (Maybe Natural) Source #
The number of seconds between the time that Amazon Route 53 gets a response from your endpoint and the time that it sends the next health check request. Each Route 53 health checker makes requests at this interval.
You can't change the value of RequestInterval
after you create a
health check.
If you don't specify a value for RequestInterval
, the default value
is 30
seconds.
healthCheckConfig_port :: Lens' HealthCheckConfig (Maybe Natural) Source #
The port on the endpoint that you want Amazon Route 53 to perform health checks on.
Don't specify a value for Port
when you specify a value for Type
of
CLOUDWATCH_METRIC
or CALCULATED
.
healthCheckConfig_type :: Lens' HealthCheckConfig HealthCheckType Source #
The type of health check that you want to create, which indicates how Amazon Route 53 determines whether an endpoint is healthy.
You can't change the value of Type
after you create a health check.
You can create the following types of health checks:
- HTTP: Route 53 tries to establish a TCP connection. If successful, Route 53 submits an HTTP request and waits for an HTTP status code of 200 or greater and less than 400.
HTTPS: Route 53 tries to establish a TCP connection. If successful, Route 53 submits an HTTPS request and waits for an HTTP status code of 200 or greater and less than 400.
If you specify
HTTPS
for the value ofType
, the endpoint must support TLS v1.0 or later.- HTTP_STR_MATCH: Route 53 tries to establish a TCP connection. If
successful, Route 53 submits an HTTP request and searches the first
5,120 bytes of the response body for the string that you specify in
SearchString
. - HTTPS_STR_MATCH: Route 53 tries to establish a TCP connection.
If successful, Route 53 submits an
HTTPS
request and searches the first 5,120 bytes of the response body for the string that you specify inSearchString
. - TCP: Route 53 tries to establish a TCP connection.
- CLOUDWATCH_METRIC: The health check is associated with a
CloudWatch alarm. If the state of the alarm is
OK
, the health check is considered healthy. If the state isALARM
, the health check is considered unhealthy. If CloudWatch doesn't have sufficient data to determine whether the state isOK
orALARM
, the health check status depends on the setting forInsufficientDataHealthStatus
:Healthy
,Unhealthy
, orLastKnownStatus
. - CALCULATED: For health checks that monitor the status of other
health checks, Route 53 adds up the number of health checks that
Route 53 health checkers consider to be healthy and compares that
number with the value of
HealthThreshold
. - RECOVERY_CONTROL: The health check is assocated with a Route53
Application Recovery Controller routing control. If the routing
control state is
ON
, the health check is considered healthy. If the state isOFF
, the health check is considered unhealthy.
For more information, see How Route 53 Determines Whether an Endpoint Is Healthy in the Amazon Route 53 Developer Guide.
HealthCheckObservation
data HealthCheckObservation Source #
A complex type that contains the last failure reason as reported by one Amazon Route 53 health checker.
See: newHealthCheckObservation
smart constructor.
HealthCheckObservation' | |
|
Instances
newHealthCheckObservation :: HealthCheckObservation Source #
Create a value of HealthCheckObservation
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:iPAddress:HealthCheckObservation'
, healthCheckObservation_iPAddress
- The IP address of the Amazon Route 53 health checker that provided the
failure reason in StatusReport
.
$sel:statusReport:HealthCheckObservation'
, healthCheckObservation_statusReport
- A complex type that contains the last failure reason as reported by one
Amazon Route 53 health checker and the time of the failed health check.
$sel:region:HealthCheckObservation'
, healthCheckObservation_region
- The region of the Amazon Route 53 health checker that provided the
status in StatusReport
.
healthCheckObservation_iPAddress :: Lens' HealthCheckObservation (Maybe Text) Source #
The IP address of the Amazon Route 53 health checker that provided the
failure reason in StatusReport
.
healthCheckObservation_statusReport :: Lens' HealthCheckObservation (Maybe StatusReport) Source #
A complex type that contains the last failure reason as reported by one Amazon Route 53 health checker and the time of the failed health check.
healthCheckObservation_region :: Lens' HealthCheckObservation (Maybe HealthCheckRegion) Source #
The region of the Amazon Route 53 health checker that provided the
status in StatusReport
.
HostedZone
data HostedZone Source #
A complex type that contains general information about the hosted zone.
See: newHostedZone
smart constructor.
HostedZone' | |
|
Instances
:: ResourceId | |
-> Text | |
-> Text | |
-> HostedZone |
Create a value of HostedZone
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:linkedService:HostedZone'
, hostedZone_linkedService
- If the hosted zone was created by another service, the service that
created the hosted zone. When a hosted zone is created by another
service, you can't edit or delete it using Route 53.
$sel:config:HostedZone'
, hostedZone_config
- A complex type that includes the Comment
and PrivateZone
elements.
If you omitted the HostedZoneConfig
and Comment
elements from the
request, the Config
and Comment
elements don't appear in the
response.
$sel:resourceRecordSetCount:HostedZone'
, hostedZone_resourceRecordSetCount
- The number of resource record sets in the hosted zone.
$sel:id:HostedZone'
, hostedZone_id
- The ID that Amazon Route 53 assigned to the hosted zone when you created
it.
$sel:name:HostedZone'
, hostedZone_name
- The name of the domain. For public hosted zones, this is the name that
you have registered with your DNS registrar.
For information about how to specify characters other than a-z
, 0-9
,
and -
(hyphen) and how to specify internationalized domain names, see
CreateHostedZone.
$sel:callerReference:HostedZone'
, hostedZone_callerReference
- The value that you specified for CallerReference
when you created the
hosted zone.
hostedZone_linkedService :: Lens' HostedZone (Maybe LinkedService) Source #
If the hosted zone was created by another service, the service that created the hosted zone. When a hosted zone is created by another service, you can't edit or delete it using Route 53.
hostedZone_config :: Lens' HostedZone (Maybe HostedZoneConfig) Source #
A complex type that includes the Comment
and PrivateZone
elements.
If you omitted the HostedZoneConfig
and Comment
elements from the
request, the Config
and Comment
elements don't appear in the
response.
hostedZone_resourceRecordSetCount :: Lens' HostedZone (Maybe Integer) Source #
The number of resource record sets in the hosted zone.
hostedZone_id :: Lens' HostedZone ResourceId Source #
The ID that Amazon Route 53 assigned to the hosted zone when you created it.
hostedZone_name :: Lens' HostedZone Text Source #
The name of the domain. For public hosted zones, this is the name that you have registered with your DNS registrar.
For information about how to specify characters other than a-z
, 0-9
,
and -
(hyphen) and how to specify internationalized domain names, see
CreateHostedZone.
hostedZone_callerReference :: Lens' HostedZone Text Source #
The value that you specified for CallerReference
when you created the
hosted zone.
HostedZoneConfig
data HostedZoneConfig Source #
A complex type that contains an optional comment about your hosted zone.
If you don't want to specify a comment, omit both the
HostedZoneConfig
and Comment
elements.
See: newHostedZoneConfig
smart constructor.
Instances
newHostedZoneConfig :: HostedZoneConfig Source #
Create a value of HostedZoneConfig
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:privateZone:HostedZoneConfig'
, hostedZoneConfig_privateZone
- A value that indicates whether this is a private hosted zone.
$sel:comment:HostedZoneConfig'
, hostedZoneConfig_comment
- Any comments that you want to include about the hosted zone.
hostedZoneConfig_privateZone :: Lens' HostedZoneConfig (Maybe Bool) Source #
A value that indicates whether this is a private hosted zone.
hostedZoneConfig_comment :: Lens' HostedZoneConfig (Maybe Text) Source #
Any comments that you want to include about the hosted zone.
HostedZoneLimit
data HostedZoneLimit Source #
A complex type that contains the type of limit that you specified in the request and the current value for that limit.
See: newHostedZoneLimit
smart constructor.
HostedZoneLimit' | |
|
Instances
Create a value of HostedZoneLimit
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:type':HostedZoneLimit'
, hostedZoneLimit_type
- The limit that you requested. Valid values include the following:
- MAX_RRSETS_BY_ZONE: The maximum number of records that you can create in the specified hosted zone.
- MAX_VPCS_ASSOCIATED_BY_ZONE: The maximum number of Amazon VPCs that you can associate with the specified private hosted zone.
$sel:value:HostedZoneLimit'
, hostedZoneLimit_value
- The current value for the limit that is specified by Type
.
hostedZoneLimit_type :: Lens' HostedZoneLimit HostedZoneLimitType Source #
The limit that you requested. Valid values include the following:
- MAX_RRSETS_BY_ZONE: The maximum number of records that you can create in the specified hosted zone.
- MAX_VPCS_ASSOCIATED_BY_ZONE: The maximum number of Amazon VPCs that you can associate with the specified private hosted zone.
hostedZoneLimit_value :: Lens' HostedZoneLimit Natural Source #
The current value for the limit that is specified by Type
.
HostedZoneOwner
data HostedZoneOwner Source #
A complex type that identifies a hosted zone that a specified Amazon VPC
is associated with and the owner of the hosted zone. If there is a value
for OwningAccount
, there is no value for OwningService
, and vice
versa.
See: newHostedZoneOwner
smart constructor.
HostedZoneOwner' | |
|
Instances
newHostedZoneOwner :: HostedZoneOwner Source #
Create a value of HostedZoneOwner
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:owningAccount:HostedZoneOwner'
, hostedZoneOwner_owningAccount
- If the hosted zone was created by an Amazon Web Services account, or was
created by an Amazon Web Services service that creates hosted zones
using the current account, OwningAccount
contains the account ID of
that account. For example, when you use Cloud Map to create a hosted
zone, Cloud Map creates the hosted zone using the current Amazon Web
Services account.
$sel:owningService:HostedZoneOwner'
, hostedZoneOwner_owningService
- If an Amazon Web Services service uses its own account to create a
hosted zone and associate the specified VPC with that hosted zone,
OwningService
contains an abbreviation that identifies the service.
For example, if Amazon Elastic File System (Amazon EFS) created a hosted
zone and associated a VPC with the hosted zone, the value of
OwningService
is efs.amazonaws.com
.
hostedZoneOwner_owningAccount :: Lens' HostedZoneOwner (Maybe Text) Source #
If the hosted zone was created by an Amazon Web Services account, or was
created by an Amazon Web Services service that creates hosted zones
using the current account, OwningAccount
contains the account ID of
that account. For example, when you use Cloud Map to create a hosted
zone, Cloud Map creates the hosted zone using the current Amazon Web
Services account.
hostedZoneOwner_owningService :: Lens' HostedZoneOwner (Maybe Text) Source #
If an Amazon Web Services service uses its own account to create a
hosted zone and associate the specified VPC with that hosted zone,
OwningService
contains an abbreviation that identifies the service.
For example, if Amazon Elastic File System (Amazon EFS) created a hosted
zone and associated a VPC with the hosted zone, the value of
OwningService
is efs.amazonaws.com
.
HostedZoneSummary
data HostedZoneSummary Source #
In the response to a ListHostedZonesByVPC
request, the
HostedZoneSummaries
element contains one HostedZoneSummary
element
for each hosted zone that the specified Amazon VPC is associated with.
Each HostedZoneSummary
element contains the hosted zone name and ID,
and information about who owns the hosted zone.
See: newHostedZoneSummary
smart constructor.
HostedZoneSummary' | |
|
Instances
:: ResourceId | |
-> Text | |
-> HostedZoneOwner | |
-> HostedZoneSummary |
Create a value of HostedZoneSummary
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:hostedZoneId:HostedZoneSummary'
, hostedZoneSummary_hostedZoneId
- The Route 53 hosted zone ID of a private hosted zone that the specified
VPC is associated with.
$sel:name:HostedZoneSummary'
, hostedZoneSummary_name
- The name of the private hosted zone, such as example.com
.
$sel:owner:HostedZoneSummary'
, hostedZoneSummary_owner
- The owner of a private hosted zone that the specified VPC is associated
with. The owner can be either an Amazon Web Services account or an
Amazon Web Services service.
hostedZoneSummary_hostedZoneId :: Lens' HostedZoneSummary ResourceId Source #
The Route 53 hosted zone ID of a private hosted zone that the specified VPC is associated with.
hostedZoneSummary_name :: Lens' HostedZoneSummary Text Source #
The name of the private hosted zone, such as example.com
.
hostedZoneSummary_owner :: Lens' HostedZoneSummary HostedZoneOwner Source #
The owner of a private hosted zone that the specified VPC is associated with. The owner can be either an Amazon Web Services account or an Amazon Web Services service.
KeySigningKey
data KeySigningKey Source #
A key-signing key (KSK) is a complex type that represents a public/private key pair. The private key is used to generate a digital signature for the zone signing key (ZSK). The public key is stored in the DNS and is used to authenticate the ZSK. A KSK is always associated with a hosted zone; it cannot exist by itself.
See: newKeySigningKey
smart constructor.
KeySigningKey' | |
|
Instances
newKeySigningKey :: KeySigningKey Source #
Create a value of KeySigningKey
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:status:KeySigningKey'
, keySigningKey_status
- A string that represents the current key-signing key (KSK) status.
Status can have one of the following values:
- ACTIVE
- The KSK is being used for signing.
- INACTIVE
- The KSK is not being used for signing.
- DELETING
- The KSK is in the process of being deleted.
- ACTION_NEEDED
- There is a problem with the KSK that requires you to take action to resolve. For example, the customer managed customer master key (CMK) might have been deleted, or the permissions for the customer managed CMK might have been changed.
- INTERNAL_FAILURE
- There was an error during a request. Before you can continue to work with DNSSEC signing, including actions that involve this KSK, you must correct the problem. For example, you may need to activate or deactivate the KSK.
$sel:signingAlgorithmMnemonic:KeySigningKey'
, keySigningKey_signingAlgorithmMnemonic
- A string used to represent the signing algorithm. This value must follow
the guidelines provided by
RFC-8624 Section 3.1.
$sel:digestAlgorithmMnemonic:KeySigningKey'
, keySigningKey_digestAlgorithmMnemonic
- A string used to represent the delegation signer digest algorithm. This
value must follow the guidelines provided by
RFC-8624 Section 3.3.
$sel:lastModifiedDate:KeySigningKey'
, keySigningKey_lastModifiedDate
- The last time that the key-signing key (KSK) was changed.
$sel:keyTag:KeySigningKey'
, keySigningKey_keyTag
- An integer used to identify the DNSSEC record for the domain name. The
process used to calculate the value is described in
RFC-4034 Appendix B.
$sel:dNSKEYRecord:KeySigningKey'
, keySigningKey_dNSKEYRecord
- A string that represents a DNSKEY record.
$sel:publicKey:KeySigningKey'
, keySigningKey_publicKey
- The public key, represented as a Base64 encoding, as required by
RFC-4034 Page 5.
$sel:signingAlgorithmType:KeySigningKey'
, keySigningKey_signingAlgorithmType
- An integer used to represent the signing algorithm. This value must
follow the guidelines provided by
RFC-8624 Section 3.1.
$sel:createdDate:KeySigningKey'
, keySigningKey_createdDate
- The date when the key-signing key (KSK) was created.
$sel:flag:KeySigningKey'
, keySigningKey_flag
- An integer that specifies how the key is used. For key-signing key
(KSK), this value is always 257.
$sel:digestAlgorithmType:KeySigningKey'
, keySigningKey_digestAlgorithmType
- An integer used to represent the delegation signer digest algorithm.
This value must follow the guidelines provided by
RFC-8624 Section 3.3.
$sel:statusMessage:KeySigningKey'
, keySigningKey_statusMessage
- The status message provided for the following key-signing key (KSK)
statuses: ACTION_NEEDED
or INTERNAL_FAILURE
. The status message
includes information about what the problem might be and steps that you
can take to correct the issue.
$sel:name:KeySigningKey'
, keySigningKey_name
- A string used to identify a key-signing key (KSK). Name
can include
numbers, letters, and underscores (_). Name
must be unique for each
key-signing key in the same hosted zone.
$sel:dSRecord:KeySigningKey'
, keySigningKey_dSRecord
- A string that represents a delegation signer (DS) record.
$sel:kmsArn:KeySigningKey'
, keySigningKey_kmsArn
- The Amazon resource name (ARN) used to identify the customer managed
customer master key (CMK) in Key Management Service (KMS). The KmsArn
must be unique for each key-signing key (KSK) in a single hosted zone.
You must configure the CMK as follows:
- Status
- Enabled
- Key spec
- ECC_NIST_P256
- Key usage
- Sign and verify
- Key policy
- The key policy must give permission for the following actions:
- DescribeKey
- GetPublicKey
- Sign
The key policy must also include the Amazon Route 53 service in the principal for your account. Specify the following:
"Service": "dnssec-route53.amazonaws.com"
For more information about working with the customer managed CMK in KMS, see Key Management Service concepts.
$sel:digestValue:KeySigningKey'
, keySigningKey_digestValue
- A cryptographic digest of a DNSKEY resource record (RR). DNSKEY records
are used to publish the public key that resolvers can use to verify
DNSSEC signatures that are used to secure certain kinds of information
provided by the DNS system.
keySigningKey_status :: Lens' KeySigningKey (Maybe Text) Source #
A string that represents the current key-signing key (KSK) status.
Status can have one of the following values:
- ACTIVE
- The KSK is being used for signing.
- INACTIVE
- The KSK is not being used for signing.
- DELETING
- The KSK is in the process of being deleted.
- ACTION_NEEDED
- There is a problem with the KSK that requires you to take action to resolve. For example, the customer managed customer master key (CMK) might have been deleted, or the permissions for the customer managed CMK might have been changed.
- INTERNAL_FAILURE
- There was an error during a request. Before you can continue to work with DNSSEC signing, including actions that involve this KSK, you must correct the problem. For example, you may need to activate or deactivate the KSK.
keySigningKey_signingAlgorithmMnemonic :: Lens' KeySigningKey (Maybe Text) Source #
A string used to represent the signing algorithm. This value must follow the guidelines provided by RFC-8624 Section 3.1.
keySigningKey_digestAlgorithmMnemonic :: Lens' KeySigningKey (Maybe Text) Source #
A string used to represent the delegation signer digest algorithm. This value must follow the guidelines provided by RFC-8624 Section 3.3.
keySigningKey_lastModifiedDate :: Lens' KeySigningKey (Maybe UTCTime) Source #
The last time that the key-signing key (KSK) was changed.
keySigningKey_keyTag :: Lens' KeySigningKey (Maybe Natural) Source #
An integer used to identify the DNSSEC record for the domain name. The process used to calculate the value is described in RFC-4034 Appendix B.
keySigningKey_dNSKEYRecord :: Lens' KeySigningKey (Maybe Text) Source #
A string that represents a DNSKEY record.
keySigningKey_publicKey :: Lens' KeySigningKey (Maybe Text) Source #
The public key, represented as a Base64 encoding, as required by RFC-4034 Page 5.
keySigningKey_signingAlgorithmType :: Lens' KeySigningKey (Maybe Int) Source #
An integer used to represent the signing algorithm. This value must follow the guidelines provided by RFC-8624 Section 3.1.
keySigningKey_createdDate :: Lens' KeySigningKey (Maybe UTCTime) Source #
The date when the key-signing key (KSK) was created.
keySigningKey_flag :: Lens' KeySigningKey (Maybe Int) Source #
An integer that specifies how the key is used. For key-signing key (KSK), this value is always 257.
keySigningKey_digestAlgorithmType :: Lens' KeySigningKey (Maybe Int) Source #
An integer used to represent the delegation signer digest algorithm. This value must follow the guidelines provided by RFC-8624 Section 3.3.
keySigningKey_statusMessage :: Lens' KeySigningKey (Maybe Text) Source #
The status message provided for the following key-signing key (KSK)
statuses: ACTION_NEEDED
or INTERNAL_FAILURE
. The status message
includes information about what the problem might be and steps that you
can take to correct the issue.
keySigningKey_name :: Lens' KeySigningKey (Maybe Text) Source #
A string used to identify a key-signing key (KSK). Name
can include
numbers, letters, and underscores (_). Name
must be unique for each
key-signing key in the same hosted zone.
keySigningKey_dSRecord :: Lens' KeySigningKey (Maybe Text) Source #
A string that represents a delegation signer (DS) record.
keySigningKey_kmsArn :: Lens' KeySigningKey (Maybe Text) Source #
The Amazon resource name (ARN) used to identify the customer managed
customer master key (CMK) in Key Management Service (KMS). The KmsArn
must be unique for each key-signing key (KSK) in a single hosted zone.
You must configure the CMK as follows:
- Status
- Enabled
- Key spec
- ECC_NIST_P256
- Key usage
- Sign and verify
- Key policy
- The key policy must give permission for the following actions:
- DescribeKey
- GetPublicKey
- Sign
The key policy must also include the Amazon Route 53 service in the principal for your account. Specify the following:
"Service": "dnssec-route53.amazonaws.com"
For more information about working with the customer managed CMK in KMS, see Key Management Service concepts.
keySigningKey_digestValue :: Lens' KeySigningKey (Maybe Text) Source #
A cryptographic digest of a DNSKEY resource record (RR). DNSKEY records are used to publish the public key that resolvers can use to verify DNSSEC signatures that are used to secure certain kinds of information provided by the DNS system.
LinkedService
data LinkedService Source #
If a health check or hosted zone was created by another service,
LinkedService
is a complex type that describes the service that
created the resource. When a resource is created by another service, you
can't edit or delete it using Amazon Route 53.
See: newLinkedService
smart constructor.
LinkedService' | |
|
Instances
newLinkedService :: LinkedService Source #
Create a value of LinkedService
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:servicePrincipal:LinkedService'
, linkedService_servicePrincipal
- If the health check or hosted zone was created by another service, the
service that created the resource. When a resource is created by another
service, you can't edit or delete it using Amazon Route 53.
$sel:description:LinkedService'
, linkedService_description
- If the health check or hosted zone was created by another service, an
optional description that can be provided by the other service. When a
resource is created by another service, you can't edit or delete it
using Amazon Route 53.
linkedService_servicePrincipal :: Lens' LinkedService (Maybe Text) Source #
If the health check or hosted zone was created by another service, the service that created the resource. When a resource is created by another service, you can't edit or delete it using Amazon Route 53.
linkedService_description :: Lens' LinkedService (Maybe Text) Source #
If the health check or hosted zone was created by another service, an optional description that can be provided by the other service. When a resource is created by another service, you can't edit or delete it using Amazon Route 53.
QueryLoggingConfig
data QueryLoggingConfig Source #
A complex type that contains information about a configuration for DNS query logging.
See: newQueryLoggingConfig
smart constructor.
QueryLoggingConfig' | |
|
Instances
newQueryLoggingConfig Source #
:: Text | |
-> ResourceId | |
-> Text | |
-> QueryLoggingConfig |
Create a value of QueryLoggingConfig
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:id:QueryLoggingConfig'
, queryLoggingConfig_id
- The ID for a configuration for DNS query logging.
$sel:hostedZoneId:QueryLoggingConfig'
, queryLoggingConfig_hostedZoneId
- The ID of the hosted zone that CloudWatch Logs is logging queries for.
$sel:cloudWatchLogsLogGroupArn:QueryLoggingConfig'
, queryLoggingConfig_cloudWatchLogsLogGroupArn
- The Amazon Resource Name (ARN) of the CloudWatch Logs log group that
Amazon Route 53 is publishing logs to.
queryLoggingConfig_id :: Lens' QueryLoggingConfig Text Source #
The ID for a configuration for DNS query logging.
queryLoggingConfig_hostedZoneId :: Lens' QueryLoggingConfig ResourceId Source #
The ID of the hosted zone that CloudWatch Logs is logging queries for.
queryLoggingConfig_cloudWatchLogsLogGroupArn :: Lens' QueryLoggingConfig Text Source #
The Amazon Resource Name (ARN) of the CloudWatch Logs log group that Amazon Route 53 is publishing logs to.
ResourceRecord
data ResourceRecord Source #
Information specific to the resource record.
If you're creating an alias resource record set, omit ResourceRecord
.
See: newResourceRecord
smart constructor.
ResourceRecord' | |
|
Instances
Create a value of ResourceRecord
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:value:ResourceRecord'
, resourceRecord_value
- The current or new DNS record value, not to exceed 4,000 characters. In
the case of a DELETE
action, if the current value does not match the
actual value, an error is returned. For descriptions about how to format
Value
for different record types, see
Supported DNS Resource Record Types
in the Amazon Route 53 Developer Guide.
You can specify more than one value for all record types except CNAME
and SOA
.
If you're creating an alias resource record set, omit Value
.
resourceRecord_value :: Lens' ResourceRecord Text Source #
The current or new DNS record value, not to exceed 4,000 characters. In
the case of a DELETE
action, if the current value does not match the
actual value, an error is returned. For descriptions about how to format
Value
for different record types, see
Supported DNS Resource Record Types
in the Amazon Route 53 Developer Guide.
You can specify more than one value for all record types except CNAME
and SOA
.
If you're creating an alias resource record set, omit Value
.
ResourceRecordSet
data ResourceRecordSet Source #
Information about the resource record set to create or delete.
See: newResourceRecordSet
smart constructor.
ResourceRecordSet' | |
|
Instances
Create a value of ResourceRecordSet
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:ttl:ResourceRecordSet'
, resourceRecordSet_ttl
- The resource record cache time to live (TTL), in seconds. Note the
following:
- If you're creating or updating an alias resource record set, omit
TTL
. Amazon Route 53 uses the value ofTTL
for the alias target. - If you're associating this resource record set with a health check
(if you're adding a
HealthCheckId
element), we recommend that you specify aTTL
of 60 seconds or less so clients respond quickly to changes in health status. - All of the resource record sets in a group of weighted resource
record sets must have the same value for
TTL
. - If a group of weighted resource record sets includes one or more
weighted alias resource record sets for which the alias target is an
ELB load balancer, we recommend that you specify a
TTL
of 60 seconds for all of the non-alias weighted resource record sets that have the same name and type. Values other than 60 seconds (the TTL for load balancers) will change the effect of the values that you specify forWeight
.
$sel:resourceRecords:ResourceRecordSet'
, resourceRecordSet_resourceRecords
- Information about the resource records to act upon.
If you're creating an alias resource record set, omit
ResourceRecords
.
$sel:aliasTarget:ResourceRecordSet'
, resourceRecordSet_aliasTarget
- Alias resource record sets only: Information about the Amazon Web
Services resource, such as a CloudFront distribution or an Amazon S3
bucket, that you want to route traffic to.
If you're creating resource records sets for a private hosted zone, note the following:
- You can't create an alias resource record set in a private hosted zone to route traffic to a CloudFront distribution.
- Creating geolocation alias resource record sets or latency alias resource record sets in a private hosted zone is unsupported.
- For information about creating failover resource record sets in a private hosted zone, see Configuring Failover in a Private Hosted Zone in the Amazon Route 53 Developer Guide.
$sel:weight:ResourceRecordSet'
, resourceRecordSet_weight
- Weighted resource record sets only: Among resource record sets that
have the same combination of DNS name and type, a value that determines
the proportion of DNS queries that Amazon Route 53 responds to using the
current resource record set. Route 53 calculates the sum of the weights
for the resource record sets that have the same combination of DNS name
and type. Route 53 then responds to queries based on the ratio of a
resource's weight to the total. Note the following:
- You must specify a value for the
Weight
element for every weighted resource record set. - You can only specify one
ResourceRecord
per weighted resource record set. - You can't create latency, failover, or geolocation resource record
sets that have the same values for the
Name
andType
elements as weighted resource record sets. - You can create a maximum of 100 weighted resource record sets that
have the same values for the
Name
andType
elements. For weighted (but not weighted alias) resource record sets, if you set
Weight
to0
for a resource record set, Route 53 never responds to queries with the applicable value for that resource record set. However, if you setWeight
to0
for all resource record sets that have the same combination of DNS name and type, traffic is routed to all resources with equal probability.The effect of setting
Weight
to0
is different when you associate health checks with weighted resource record sets. For more information, see Options for Configuring Route 53 Active-Active and Active-Passive Failover in the Amazon Route 53 Developer Guide.
$sel:trafficPolicyInstanceId:ResourceRecordSet'
, resourceRecordSet_trafficPolicyInstanceId
- When you create a traffic policy instance, Amazon Route 53 automatically
creates a resource record set. TrafficPolicyInstanceId
is the ID of
the traffic policy instance that Route 53 created this resource record
set for.
To delete the resource record set that is associated with a traffic
policy instance, use DeleteTrafficPolicyInstance
. Route 53 will delete
the resource record set automatically. If you delete the resource record
set by using ChangeResourceRecordSets
, Route 53 doesn't automatically
delete the traffic policy instance, and you'll continue to be charged
for it even though it's no longer in use.
$sel:setIdentifier:ResourceRecordSet'
, resourceRecordSet_setIdentifier
- Resource record sets that have a routing policy other than simple: An
identifier that differentiates among multiple resource record sets that
have the same combination of name and type, such as multiple weighted
resource record sets named acme.example.com that have a type of A. In a
group of resource record sets that have the same name and type, the
value of SetIdentifier
must be unique for each resource record set.
For information about routing policies, see Choosing a Routing Policy in the Amazon Route 53 Developer Guide.
$sel:failover:ResourceRecordSet'
, resourceRecordSet_failover
- Failover resource record sets only: To configure failover, you add the
Failover
element to two resource record sets. For one resource record
set, you specify PRIMARY
as the value for Failover
; for the other
resource record set, you specify SECONDARY
. In addition, you include
the HealthCheckId
element and specify the health check that you want
Amazon Route 53 to perform for each resource record set.
Except where noted, the following failover behaviors assume that you
have included the HealthCheckId
element in both resource record sets:
- When the primary resource record set is healthy, Route 53 responds to DNS queries with the applicable value from the primary resource record set regardless of the health of the secondary resource record set.
- When the primary resource record set is unhealthy and the secondary resource record set is healthy, Route 53 responds to DNS queries with the applicable value from the secondary resource record set.
- When the secondary resource record set is unhealthy, Route 53 responds to DNS queries with the applicable value from the primary resource record set regardless of the health of the primary resource record set.
- If you omit the
HealthCheckId
element for the secondary resource record set, and if the primary resource record set is unhealthy, Route 53 always responds to DNS queries with the applicable value from the secondary resource record set. This is true regardless of the health of the associated endpoint.
You can't create non-failover resource record sets that have the same
values for the Name
and Type
elements as failover resource record
sets.
For failover alias resource record sets, you must also include the
EvaluateTargetHealth
element and set the value to true.
For more information about configuring failover for Route 53, see the following topics in the Amazon Route 53 Developer Guide:
$sel:healthCheckId:ResourceRecordSet'
, resourceRecordSet_healthCheckId
- If you want Amazon Route 53 to return this resource record set in
response to a DNS query only when the status of a health check is
healthy, include the HealthCheckId
element and specify the ID of the
applicable health check.
Route 53 determines whether a resource record set is healthy based on one of the following:
- By periodically sending a request to the endpoint that is specified in the health check
- By aggregating the status of a specified group of health checks (calculated health checks)
- By determining the current state of a CloudWatch alarm (CloudWatch metric health checks)
Route 53 doesn't check the health of the endpoint that is specified in
the resource record set, for example, the endpoint specified by the IP
address in the Value
element. When you add a HealthCheckId
element
to a resource record set, Route 53 checks the health of the endpoint
that you specified in the health check.
For more information, see the following topics in the /Amazon Route 53 Developer Guide/:
- How Amazon Route 53 Determines Whether an Endpoint Is Healthy
- Route 53 Health Checks and DNS Failover
- Configuring Failover in a Private Hosted Zone
When to Specify HealthCheckId
Specifying a value for HealthCheckId
is useful only when Route 53 is
choosing between two or more resource record sets to respond to a DNS
query, and you want Route 53 to base the choice in part on the status of
a health check. Configuring health checks makes sense only in the
following configurations:
Non-alias resource record sets: You're checking the health of a group of non-alias resource record sets that have the same routing policy, name, and type (such as multiple weighted records named www.example.com with a type of A) and you specify health check IDs for all the resource record sets.
If the health check status for a resource record set is healthy, Route 53 includes the record among the records that it responds to DNS queries with.
If the health check status for a resource record set is unhealthy, Route 53 stops responding to DNS queries using the value for that resource record set.
If the health check status for all resource record sets in the group is unhealthy, Route 53 considers all resource record sets in the group healthy and responds to DNS queries accordingly.
Alias resource record sets: You specify the following settings:
- You set
EvaluateTargetHealth
to true for an alias resource record set in a group of resource record sets that have the same routing policy, name, and type (such as multiple weighted records named www.example.com with a type of A). - You configure the alias resource record set to route traffic to a non-alias resource record set in the same hosted zone.
- You specify a health check ID for the non-alias resource record set.
If the health check status is healthy, Route 53 considers the alias resource record set to be healthy and includes the alias record among the records that it responds to DNS queries with.
If the health check status is unhealthy, Route 53 stops responding to DNS queries using the alias resource record set.
The alias resource record set can also route traffic to a group of non-alias resource record sets that have the same routing policy, name, and type. In that configuration, associate health checks with all of the resource record sets in the group of non-alias resource record sets.
- You set
Geolocation Routing
For geolocation resource record sets, if an endpoint is unhealthy, Route
53 looks for a resource record set for the larger, associated geographic
region. For example, suppose you have resource record sets for a state
in the United States, for the entire United States, for North America,
and a resource record set that has *
for CountryCode
is *
, which
applies to all locations. If the endpoint for the state resource record
set is unhealthy, Route 53 checks for healthy resource record sets in
the following order until it finds a resource record set for which the
endpoint is healthy:
- The United States
- North America
- The default resource record set
Specifying the Health Check Endpoint by Domain Name
If your health checks specify the endpoint only by domain name, we
recommend that you create a separate health check for each endpoint. For
example, create a health check for each HTTP
server that is serving
content for www.example.com
. For the value of
FullyQualifiedDomainName
, specify the domain name of the server (such
as us-east-2-www.example.com
), not the name of the resource record
sets (www.example.com
).
Health check results will be unpredictable if you do the following:
- Create a health check that has the same value for
FullyQualifiedDomainName
as the name of a resource record set. - Associate that health check with the resource record set.
$sel:region:ResourceRecordSet'
, resourceRecordSet_region
- Latency-based resource record sets only: The Amazon EC2 Region where
you created the resource that this resource record set refers to. The
resource typically is an Amazon Web Services resource, such as an EC2
instance or an ELB load balancer, and is referred to by an IP address or
a DNS domain name, depending on the record type.
Although creating latency and latency alias resource record sets in a private hosted zone is allowed, it's not supported.
When Amazon Route 53 receives a DNS query for a domain name and type for which you have created latency resource record sets, Route 53 selects the latency resource record set that has the lowest latency between the end user and the associated Amazon EC2 Region. Route 53 then returns the value that is associated with the selected resource record set.
Note the following:
- You can only specify one
ResourceRecord
per latency resource record set. - You can only create one latency resource record set for each Amazon EC2 Region.
- You aren't required to create latency resource record sets for all Amazon EC2 Regions. Route 53 will choose the region with the best latency from among the regions that you create latency resource record sets for.
- You can't create non-latency resource record sets that have the
same values for the
Name
andType
elements as latency resource record sets.
$sel:geoLocation:ResourceRecordSet'
, resourceRecordSet_geoLocation
- Geolocation resource record sets only: A complex type that lets you
control how Amazon Route 53 responds to DNS queries based on the
geographic origin of the query. For example, if you want all queries
from Africa to be routed to a web server with an IP address of
192.0.2.111
, create a resource record set with a Type
of A
and a
ContinentCode
of AF
.
Although creating geolocation and geolocation alias resource record sets in a private hosted zone is allowed, it's not supported.
If you create separate resource record sets for overlapping geographic regions (for example, one resource record set for a continent and one for a country on the same continent), priority goes to the smallest geographic region. This allows you to route most queries for a continent to one resource and to route queries for a country on that continent to a different resource.
You can't create two geolocation resource record sets that specify the same geographic location.
The value *
in the CountryCode
element matches all geographic
locations that aren't specified in other geolocation resource record
sets that have the same values for the Name
and Type
elements.
Geolocation works by mapping IP addresses to locations. However, some IP
addresses aren't mapped to geographic locations, so even if you create
geolocation resource record sets that cover all seven continents, Route
53 will receive some DNS queries from locations that it can't identify.
We recommend that you create a resource record set for which the value
of CountryCode
is *
. Two groups of queries are routed to the
resource that you specify in this record: queries that come from
locations for which you haven't created geolocation resource record
sets and queries from IP addresses that aren't mapped to a location. If
you don't create a *
resource record set, Route 53 returns a "no
answer" response for queries from those locations.
You can't create non-geolocation resource record sets that have the
same values for the Name
and Type
elements as geolocation resource
record sets.
$sel:multiValueAnswer:ResourceRecordSet'
, resourceRecordSet_multiValueAnswer
- Multivalue answer resource record sets only: To route traffic
approximately randomly to multiple resources, such as web servers,
create one multivalue answer record for each resource and specify true
for MultiValueAnswer
. Note the following:
- If you associate a health check with a multivalue answer resource record set, Amazon Route 53 responds to DNS queries with the corresponding IP address only when the health check is healthy.
- If you don't associate a health check with a multivalue answer record, Route 53 always considers the record to be healthy.
- Route 53 responds to DNS queries with up to eight healthy records; if you have eight or fewer healthy records, Route 53 responds to all DNS queries with all the healthy records.
- If you have more than eight healthy records, Route 53 responds to different DNS resolvers with different combinations of healthy records.
- When all records are unhealthy, Route 53 responds to DNS queries with up to eight unhealthy records.
- If a resource becomes unavailable after a resolver caches a response, client software typically tries another of the IP addresses in the response.
You can't create multivalue answer alias records.
$sel:name:ResourceRecordSet'
, resourceRecordSet_name
- For ChangeResourceRecordSets
requests, the name of the record that you
want to create, update, or delete. For ListResourceRecordSets
responses, the name of a record in the specified hosted zone.
ChangeResourceRecordSets Only
Enter a fully qualified domain name, for example, www.example.com
. You
can optionally include a trailing dot. If you omit the trailing dot,
Amazon Route 53 assumes that the domain name that you specify is fully
qualified. This means that Route 53 treats www.example.com
(without a
trailing dot) and www.example.com.
(with a trailing dot) as identical.
For information about how to specify characters other than a-z
, 0-9
,
and -
(hyphen) and how to specify internationalized domain names, see
DNS Domain Name Format
in the Amazon Route 53 Developer Guide.
You can use the asterisk (*) wildcard to replace the leftmost label in a
domain name, for example, *.example.com
. Note the following:
- The * must replace the entire label. For example, you can't specify
*prod.example.com
orprod*.example.com
. - The * can't replace any of the middle labels, for example, marketing.*.example.com.
If you include * in any position other than the leftmost label in a domain name, DNS treats it as an * character (ASCII 42), not as a wildcard.
You can't use the * wildcard for resource records sets that have a type of NS.
You can use the * wildcard as the leftmost label in a domain name, for
example, *.example.com
. You can't use an * for one of the middle
labels, for example, marketing.*.example.com
. In addition, the * must
replace the entire label; for example, you can't specify
prod*.example.com
.
$sel:type':ResourceRecordSet'
, resourceRecordSet_type
- The DNS record type. For information about different record types and
how data is encoded for them, see
Supported DNS Resource Record Types
in the Amazon Route 53 Developer Guide.
Valid values for basic resource record sets: A
| AAAA
| CAA
|
CNAME
| DS
|MX
| NAPTR
| NS
| PTR
| SOA
| SPF
| SRV
|
TXT
Values for weighted, latency, geolocation, and failover resource record
sets: A
| AAAA
| CAA
| CNAME
| MX
| NAPTR
| PTR
| SPF
|
SRV
| TXT
. When creating a group of weighted, latency, geolocation,
or failover resource record sets, specify the same value for all of the
resource record sets in the group.
Valid values for multivalue answer resource record sets: A
| AAAA
|
MX
| NAPTR
| PTR
| SPF
| SRV
| TXT
SPF records were formerly used to verify the identity of the sender of
email messages. However, we no longer recommend that you create resource
record sets for which the value of Type
is SPF
. RFC 7208, /Sender
Policy Framework (SPF) for Authorizing Use of Domains in Email, Version
1/, has been updated to say, "...[I]ts existence and mechanism defined
in [RFC4408] have led to some interoperability issues. Accordingly, its
use is no longer appropriate for SPF version 1; implementations are not
to use it." In RFC 7208, see section 14.1,
The SPF DNS Record Type.
Values for alias resource record sets:
- Amazon API Gateway custom regional APIs and edge-optimized APIs:
A
CloudFront distributions:
A
If IPv6 is enabled for the distribution, create two resource record sets to route traffic to your distribution, one with a value of
A
and one with a value ofAAAA
.- __Amazon API Gateway environment that has a regionalized
subdomain__:
A
- ELB load balancers:
A
|AAAA
- Amazon S3 buckets:
A
- Amazon Virtual Private Cloud interface VPC endpoints
A
Another resource record set in this hosted zone: Specify the type of the resource record set that you're creating the alias for. All values are supported except
NS
andSOA
.If you're creating an alias record that has the same name as the hosted zone (known as the zone apex), you can't route traffic to a record for which the value of
Type
isCNAME
. This is because the alias record must have the same type as the record you're routing traffic to, and creating a CNAME record for the zone apex isn't supported even for an alias record.
resourceRecordSet_ttl :: Lens' ResourceRecordSet (Maybe Natural) Source #
The resource record cache time to live (TTL), in seconds. Note the following:
- If you're creating or updating an alias resource record set, omit
TTL
. Amazon Route 53 uses the value ofTTL
for the alias target. - If you're associating this resource record set with a health check
(if you're adding a
HealthCheckId
element), we recommend that you specify aTTL
of 60 seconds or less so clients respond quickly to changes in health status. - All of the resource record sets in a group of weighted resource
record sets must have the same value for
TTL
. - If a group of weighted resource record sets includes one or more
weighted alias resource record sets for which the alias target is an
ELB load balancer, we recommend that you specify a
TTL
of 60 seconds for all of the non-alias weighted resource record sets that have the same name and type. Values other than 60 seconds (the TTL for load balancers) will change the effect of the values that you specify forWeight
.
resourceRecordSet_resourceRecords :: Lens' ResourceRecordSet (Maybe (NonEmpty ResourceRecord)) Source #
Information about the resource records to act upon.
If you're creating an alias resource record set, omit
ResourceRecords
.
resourceRecordSet_aliasTarget :: Lens' ResourceRecordSet (Maybe AliasTarget) Source #
Alias resource record sets only: Information about the Amazon Web Services resource, such as a CloudFront distribution or an Amazon S3 bucket, that you want to route traffic to.
If you're creating resource records sets for a private hosted zone, note the following:
- You can't create an alias resource record set in a private hosted zone to route traffic to a CloudFront distribution.
- Creating geolocation alias resource record sets or latency alias resource record sets in a private hosted zone is unsupported.
- For information about creating failover resource record sets in a private hosted zone, see Configuring Failover in a Private Hosted Zone in the Amazon Route 53 Developer Guide.
resourceRecordSet_weight :: Lens' ResourceRecordSet (Maybe Natural) Source #
Weighted resource record sets only: Among resource record sets that have the same combination of DNS name and type, a value that determines the proportion of DNS queries that Amazon Route 53 responds to using the current resource record set. Route 53 calculates the sum of the weights for the resource record sets that have the same combination of DNS name and type. Route 53 then responds to queries based on the ratio of a resource's weight to the total. Note the following:
- You must specify a value for the
Weight
element for every weighted resource record set. - You can only specify one
ResourceRecord
per weighted resource record set. - You can't create latency, failover, or geolocation resource record
sets that have the same values for the
Name
andType
elements as weighted resource record sets. - You can create a maximum of 100 weighted resource record sets that
have the same values for the
Name
andType
elements. For weighted (but not weighted alias) resource record sets, if you set
Weight
to0
for a resource record set, Route 53 never responds to queries with the applicable value for that resource record set. However, if you setWeight
to0
for all resource record sets that have the same combination of DNS name and type, traffic is routed to all resources with equal probability.The effect of setting
Weight
to0
is different when you associate health checks with weighted resource record sets. For more information, see Options for Configuring Route 53 Active-Active and Active-Passive Failover in the Amazon Route 53 Developer Guide.
resourceRecordSet_trafficPolicyInstanceId :: Lens' ResourceRecordSet (Maybe Text) Source #
When you create a traffic policy instance, Amazon Route 53 automatically
creates a resource record set. TrafficPolicyInstanceId
is the ID of
the traffic policy instance that Route 53 created this resource record
set for.
To delete the resource record set that is associated with a traffic
policy instance, use DeleteTrafficPolicyInstance
. Route 53 will delete
the resource record set automatically. If you delete the resource record
set by using ChangeResourceRecordSets
, Route 53 doesn't automatically
delete the traffic policy instance, and you'll continue to be charged
for it even though it's no longer in use.
resourceRecordSet_setIdentifier :: Lens' ResourceRecordSet (Maybe Text) Source #
Resource record sets that have a routing policy other than simple: An
identifier that differentiates among multiple resource record sets that
have the same combination of name and type, such as multiple weighted
resource record sets named acme.example.com that have a type of A. In a
group of resource record sets that have the same name and type, the
value of SetIdentifier
must be unique for each resource record set.
For information about routing policies, see Choosing a Routing Policy in the Amazon Route 53 Developer Guide.
resourceRecordSet_failover :: Lens' ResourceRecordSet (Maybe ResourceRecordSetFailover) Source #
Failover resource record sets only: To configure failover, you add the
Failover
element to two resource record sets. For one resource record
set, you specify PRIMARY
as the value for Failover
; for the other
resource record set, you specify SECONDARY
. In addition, you include
the HealthCheckId
element and specify the health check that you want
Amazon Route 53 to perform for each resource record set.
Except where noted, the following failover behaviors assume that you
have included the HealthCheckId
element in both resource record sets:
- When the primary resource record set is healthy, Route 53 responds to DNS queries with the applicable value from the primary resource record set regardless of the health of the secondary resource record set.
- When the primary resource record set is unhealthy and the secondary resource record set is healthy, Route 53 responds to DNS queries with the applicable value from the secondary resource record set.
- When the secondary resource record set is unhealthy, Route 53 responds to DNS queries with the applicable value from the primary resource record set regardless of the health of the primary resource record set.
- If you omit the
HealthCheckId
element for the secondary resource record set, and if the primary resource record set is unhealthy, Route 53 always responds to DNS queries with the applicable value from the secondary resource record set. This is true regardless of the health of the associated endpoint.
You can't create non-failover resource record sets that have the same
values for the Name
and Type
elements as failover resource record
sets.
For failover alias resource record sets, you must also include the
EvaluateTargetHealth
element and set the value to true.
For more information about configuring failover for Route 53, see the following topics in the Amazon Route 53 Developer Guide:
resourceRecordSet_healthCheckId :: Lens' ResourceRecordSet (Maybe Text) Source #
If you want Amazon Route 53 to return this resource record set in
response to a DNS query only when the status of a health check is
healthy, include the HealthCheckId
element and specify the ID of the
applicable health check.
Route 53 determines whether a resource record set is healthy based on one of the following:
- By periodically sending a request to the endpoint that is specified in the health check
- By aggregating the status of a specified group of health checks (calculated health checks)
- By determining the current state of a CloudWatch alarm (CloudWatch metric health checks)
Route 53 doesn't check the health of the endpoint that is specified in
the resource record set, for example, the endpoint specified by the IP
address in the Value
element. When you add a HealthCheckId
element
to a resource record set, Route 53 checks the health of the endpoint
that you specified in the health check.
For more information, see the following topics in the /Amazon Route 53 Developer Guide/:
- How Amazon Route 53 Determines Whether an Endpoint Is Healthy
- Route 53 Health Checks and DNS Failover
- Configuring Failover in a Private Hosted Zone
When to Specify HealthCheckId
Specifying a value for HealthCheckId
is useful only when Route 53 is
choosing between two or more resource record sets to respond to a DNS
query, and you want Route 53 to base the choice in part on the status of
a health check. Configuring health checks makes sense only in the
following configurations:
Non-alias resource record sets: You're checking the health of a group of non-alias resource record sets that have the same routing policy, name, and type (such as multiple weighted records named www.example.com with a type of A) and you specify health check IDs for all the resource record sets.
If the health check status for a resource record set is healthy, Route 53 includes the record among the records that it responds to DNS queries with.
If the health check status for a resource record set is unhealthy, Route 53 stops responding to DNS queries using the value for that resource record set.
If the health check status for all resource record sets in the group is unhealthy, Route 53 considers all resource record sets in the group healthy and responds to DNS queries accordingly.
Alias resource record sets: You specify the following settings:
- You set
EvaluateTargetHealth
to true for an alias resource record set in a group of resource record sets that have the same routing policy, name, and type (such as multiple weighted records named www.example.com with a type of A). - You configure the alias resource record set to route traffic to a non-alias resource record set in the same hosted zone.
- You specify a health check ID for the non-alias resource record set.
If the health check status is healthy, Route 53 considers the alias resource record set to be healthy and includes the alias record among the records that it responds to DNS queries with.
If the health check status is unhealthy, Route 53 stops responding to DNS queries using the alias resource record set.
The alias resource record set can also route traffic to a group of non-alias resource record sets that have the same routing policy, name, and type. In that configuration, associate health checks with all of the resource record sets in the group of non-alias resource record sets.
- You set
Geolocation Routing
For geolocation resource record sets, if an endpoint is unhealthy, Route
53 looks for a resource record set for the larger, associated geographic
region. For example, suppose you have resource record sets for a state
in the United States, for the entire United States, for North America,
and a resource record set that has *
for CountryCode
is *
, which
applies to all locations. If the endpoint for the state resource record
set is unhealthy, Route 53 checks for healthy resource record sets in
the following order until it finds a resource record set for which the
endpoint is healthy:
- The United States
- North America
- The default resource record set
Specifying the Health Check Endpoint by Domain Name
If your health checks specify the endpoint only by domain name, we
recommend that you create a separate health check for each endpoint. For
example, create a health check for each HTTP
server that is serving
content for www.example.com
. For the value of
FullyQualifiedDomainName
, specify the domain name of the server (such
as us-east-2-www.example.com
), not the name of the resource record
sets (www.example.com
).
Health check results will be unpredictable if you do the following:
- Create a health check that has the same value for
FullyQualifiedDomainName
as the name of a resource record set. - Associate that health check with the resource record set.
resourceRecordSet_region :: Lens' ResourceRecordSet (Maybe Region) Source #
Latency-based resource record sets only: The Amazon EC2 Region where you created the resource that this resource record set refers to. The resource typically is an Amazon Web Services resource, such as an EC2 instance or an ELB load balancer, and is referred to by an IP address or a DNS domain name, depending on the record type.
Although creating latency and latency alias resource record sets in a private hosted zone is allowed, it's not supported.
When Amazon Route 53 receives a DNS query for a domain name and type for which you have created latency resource record sets, Route 53 selects the latency resource record set that has the lowest latency between the end user and the associated Amazon EC2 Region. Route 53 then returns the value that is associated with the selected resource record set.
Note the following:
- You can only specify one
ResourceRecord
per latency resource record set. - You can only create one latency resource record set for each Amazon EC2 Region.
- You aren't required to create latency resource record sets for all Amazon EC2 Regions. Route 53 will choose the region with the best latency from among the regions that you create latency resource record sets for.
- You can't create non-latency resource record sets that have the
same values for the
Name
andType
elements as latency resource record sets.
resourceRecordSet_geoLocation :: Lens' ResourceRecordSet (Maybe GeoLocation) Source #
Geolocation resource record sets only: A complex type that lets you
control how Amazon Route 53 responds to DNS queries based on the
geographic origin of the query. For example, if you want all queries
from Africa to be routed to a web server with an IP address of
192.0.2.111
, create a resource record set with a Type
of A
and a
ContinentCode
of AF
.
Although creating geolocation and geolocation alias resource record sets in a private hosted zone is allowed, it's not supported.
If you create separate resource record sets for overlapping geographic regions (for example, one resource record set for a continent and one for a country on the same continent), priority goes to the smallest geographic region. This allows you to route most queries for a continent to one resource and to route queries for a country on that continent to a different resource.
You can't create two geolocation resource record sets that specify the same geographic location.
The value *
in the CountryCode
element matches all geographic
locations that aren't specified in other geolocation resource record
sets that have the same values for the Name
and Type
elements.
Geolocation works by mapping IP addresses to locations. However, some IP
addresses aren't mapped to geographic locations, so even if you create
geolocation resource record sets that cover all seven continents, Route
53 will receive some DNS queries from locations that it can't identify.
We recommend that you create a resource record set for which the value
of CountryCode
is *
. Two groups of queries are routed to the
resource that you specify in this record: queries that come from
locations for which you haven't created geolocation resource record
sets and queries from IP addresses that aren't mapped to a location. If
you don't create a *
resource record set, Route 53 returns a "no
answer" response for queries from those locations.
You can't create non-geolocation resource record sets that have the
same values for the Name
and Type
elements as geolocation resource
record sets.
resourceRecordSet_multiValueAnswer :: Lens' ResourceRecordSet (Maybe Bool) Source #
Multivalue answer resource record sets only: To route traffic
approximately randomly to multiple resources, such as web servers,
create one multivalue answer record for each resource and specify true
for MultiValueAnswer
. Note the following:
- If you associate a health check with a multivalue answer resource record set, Amazon Route 53 responds to DNS queries with the corresponding IP address only when the health check is healthy.
- If you don't associate a health check with a multivalue answer record, Route 53 always considers the record to be healthy.
- Route 53 responds to DNS queries with up to eight healthy records; if you have eight or fewer healthy records, Route 53 responds to all DNS queries with all the healthy records.
- If you have more than eight healthy records, Route 53 responds to different DNS resolvers with different combinations of healthy records.
- When all records are unhealthy, Route 53 responds to DNS queries with up to eight unhealthy records.
- If a resource becomes unavailable after a resolver caches a response, client software typically tries another of the IP addresses in the response.
You can't create multivalue answer alias records.
resourceRecordSet_name :: Lens' ResourceRecordSet Text Source #
For ChangeResourceRecordSets
requests, the name of the record that you
want to create, update, or delete. For ListResourceRecordSets
responses, the name of a record in the specified hosted zone.
ChangeResourceRecordSets Only
Enter a fully qualified domain name, for example, www.example.com
. You
can optionally include a trailing dot. If you omit the trailing dot,
Amazon Route 53 assumes that the domain name that you specify is fully
qualified. This means that Route 53 treats www.example.com
(without a
trailing dot) and www.example.com.
(with a trailing dot) as identical.
For information about how to specify characters other than a-z
, 0-9
,
and -
(hyphen) and how to specify internationalized domain names, see
DNS Domain Name Format
in the Amazon Route 53 Developer Guide.
You can use the asterisk (*) wildcard to replace the leftmost label in a
domain name, for example, *.example.com
. Note the following:
- The * must replace the entire label. For example, you can't specify
*prod.example.com
orprod*.example.com
. - The * can't replace any of the middle labels, for example, marketing.*.example.com.
If you include * in any position other than the leftmost label in a domain name, DNS treats it as an * character (ASCII 42), not as a wildcard.
You can't use the * wildcard for resource records sets that have a type of NS.
You can use the * wildcard as the leftmost label in a domain name, for
example, *.example.com
. You can't use an * for one of the middle
labels, for example, marketing.*.example.com
. In addition, the * must
replace the entire label; for example, you can't specify
prod*.example.com
.
resourceRecordSet_type :: Lens' ResourceRecordSet RRType Source #
The DNS record type. For information about different record types and how data is encoded for them, see Supported DNS Resource Record Types in the Amazon Route 53 Developer Guide.
Valid values for basic resource record sets: A
| AAAA
| CAA
|
CNAME
| DS
|MX
| NAPTR
| NS
| PTR
| SOA
| SPF
| SRV
|
TXT
Values for weighted, latency, geolocation, and failover resource record
sets: A
| AAAA
| CAA
| CNAME
| MX
| NAPTR
| PTR
| SPF
|
SRV
| TXT
. When creating a group of weighted, latency, geolocation,
or failover resource record sets, specify the same value for all of the
resource record sets in the group.
Valid values for multivalue answer resource record sets: A
| AAAA
|
MX
| NAPTR
| PTR
| SPF
| SRV
| TXT
SPF records were formerly used to verify the identity of the sender of
email messages. However, we no longer recommend that you create resource
record sets for which the value of Type
is SPF
. RFC 7208, /Sender
Policy Framework (SPF) for Authorizing Use of Domains in Email, Version
1/, has been updated to say, "...[I]ts existence and mechanism defined
in [RFC4408] have led to some interoperability issues. Accordingly, its
use is no longer appropriate for SPF version 1; implementations are not
to use it." In RFC 7208, see section 14.1,
The SPF DNS Record Type.
Values for alias resource record sets:
- Amazon API Gateway custom regional APIs and edge-optimized APIs:
A
CloudFront distributions:
A
If IPv6 is enabled for the distribution, create two resource record sets to route traffic to your distribution, one with a value of
A
and one with a value ofAAAA
.- __Amazon API Gateway environment that has a regionalized
subdomain__:
A
- ELB load balancers:
A
|AAAA
- Amazon S3 buckets:
A
- Amazon Virtual Private Cloud interface VPC endpoints
A
Another resource record set in this hosted zone: Specify the type of the resource record set that you're creating the alias for. All values are supported except
NS
andSOA
.If you're creating an alias record that has the same name as the hosted zone (known as the zone apex), you can't route traffic to a record for which the value of
Type
isCNAME
. This is because the alias record must have the same type as the record you're routing traffic to, and creating a CNAME record for the zone apex isn't supported even for an alias record.
ResourceTagSet
data ResourceTagSet Source #
A complex type containing a resource and its associated tags.
See: newResourceTagSet
smart constructor.
ResourceTagSet' | |
|
Instances
newResourceTagSet :: ResourceTagSet Source #
Create a value of ResourceTagSet
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:resourceId:ResourceTagSet'
, resourceTagSet_resourceId
- The ID for the specified resource.
$sel:resourceType:ResourceTagSet'
, resourceTagSet_resourceType
- The type of the resource.
- The resource type for health checks is
healthcheck
. - The resource type for hosted zones is
hostedzone
.
$sel:tags:ResourceTagSet'
, resourceTagSet_tags
- The tags associated with the specified resource.
resourceTagSet_resourceId :: Lens' ResourceTagSet (Maybe Text) Source #
The ID for the specified resource.
resourceTagSet_resourceType :: Lens' ResourceTagSet (Maybe TagResourceType) Source #
The type of the resource.
- The resource type for health checks is
healthcheck
. - The resource type for hosted zones is
hostedzone
.
resourceTagSet_tags :: Lens' ResourceTagSet (Maybe (NonEmpty Tag)) Source #
The tags associated with the specified resource.
ReusableDelegationSetLimit
data ReusableDelegationSetLimit Source #
A complex type that contains the type of limit that you specified in the request and the current value for that limit.
See: newReusableDelegationSetLimit
smart constructor.
ReusableDelegationSetLimit' | |
|
Instances
newReusableDelegationSetLimit Source #
Create a value of ReusableDelegationSetLimit
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:type':ReusableDelegationSetLimit'
, reusableDelegationSetLimit_type
- The limit that you requested: MAX_ZONES_BY_REUSABLE_DELEGATION_SET
,
the maximum number of hosted zones that you can associate with the
specified reusable delegation set.
$sel:value:ReusableDelegationSetLimit'
, reusableDelegationSetLimit_value
- The current value for the MAX_ZONES_BY_REUSABLE_DELEGATION_SET
limit.
reusableDelegationSetLimit_type :: Lens' ReusableDelegationSetLimit ReusableDelegationSetLimitType Source #
The limit that you requested: MAX_ZONES_BY_REUSABLE_DELEGATION_SET
,
the maximum number of hosted zones that you can associate with the
specified reusable delegation set.
reusableDelegationSetLimit_value :: Lens' ReusableDelegationSetLimit Natural Source #
The current value for the MAX_ZONES_BY_REUSABLE_DELEGATION_SET
limit.
StatusReport
data StatusReport Source #
A complex type that contains the status that one Amazon Route 53 health checker reports and the time of the health check.
See: newStatusReport
smart constructor.
StatusReport' | |
|
Instances
newStatusReport :: StatusReport Source #
Create a value of StatusReport
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:status:StatusReport'
, statusReport_status
- A description of the status of the health check endpoint as reported by
one of the Amazon Route 53 health checkers.
$sel:checkedTime:StatusReport'
, statusReport_checkedTime
- The date and time that the health checker performed the health check in
ISO 8601 format and Coordinated
Universal Time (UTC). For example, the value 2017-03-27T17:48:16.751Z
represents March 27, 2017 at 17:48:16.751 UTC.
statusReport_status :: Lens' StatusReport (Maybe Text) Source #
A description of the status of the health check endpoint as reported by one of the Amazon Route 53 health checkers.
statusReport_checkedTime :: Lens' StatusReport (Maybe UTCTime) Source #
The date and time that the health checker performed the health check in
ISO 8601 format and Coordinated
Universal Time (UTC). For example, the value 2017-03-27T17:48:16.751Z
represents March 27, 2017 at 17:48:16.751 UTC.
Tag
A complex type that contains information about a tag that you want to add or edit for the specified health check or hosted zone.
See: newTag
smart constructor.
Tag' | |
|
Instances
Eq Tag Source # | |
Read Tag Source # | |
Show Tag Source # | |
Generic Tag Source # | |
NFData Tag Source # | |
Defined in Amazonka.Route53.Types.Tag | |
Hashable Tag Source # | |
Defined in Amazonka.Route53.Types.Tag | |
FromXML Tag Source # | |
ToXML Tag Source # | |
Defined in Amazonka.Route53.Types.Tag | |
type Rep Tag Source # | |
Defined in Amazonka.Route53.Types.Tag type Rep Tag = D1 ('MetaData "Tag" "Amazonka.Route53.Types.Tag" "libZSservicesZSamazonka-route53ZSamazonka-route53" 'False) (C1 ('MetaCons "Tag'" 'PrefixI 'True) (S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "key") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) |
Create a value of Tag
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:value:Tag'
, tag_value
- The value of Value
depends on the operation that you want to perform:
- Add a tag to a health check or hosted zone:
Value
is the value that you want to give the new tag. - Edit a tag:
Value
is the new value that you want to assign the tag.
$sel:key:Tag'
, tag_key
- The value of Key
depends on the operation that you want to perform:
- Add a tag to a health check or hosted zone:
Key
is the name that you want to give the new tag. - Edit a tag:
Key
is the name of the tag that you want to change theValue
for. - Delete a key:
Key
is the name of the tag you want to remove. - Give a name to a health check: Edit the default
Name
tag. In the Amazon Route 53 console, the list of your health checks includes a Name column that lets you see the name that you've given to each health check.
tag_value :: Lens' Tag (Maybe Text) Source #
The value of Value
depends on the operation that you want to perform:
- Add a tag to a health check or hosted zone:
Value
is the value that you want to give the new tag. - Edit a tag:
Value
is the new value that you want to assign the tag.
tag_key :: Lens' Tag (Maybe Text) Source #
The value of Key
depends on the operation that you want to perform:
- Add a tag to a health check or hosted zone:
Key
is the name that you want to give the new tag. - Edit a tag:
Key
is the name of the tag that you want to change theValue
for. - Delete a key:
Key
is the name of the tag you want to remove. - Give a name to a health check: Edit the default
Name
tag. In the Amazon Route 53 console, the list of your health checks includes a Name column that lets you see the name that you've given to each health check.
TrafficPolicy
data TrafficPolicy Source #
A complex type that contains settings for a traffic policy.
See: newTrafficPolicy
smart constructor.
TrafficPolicy' | |
|
Instances
Create a value of TrafficPolicy
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:comment:TrafficPolicy'
, trafficPolicy_comment
- The comment that you specify in the CreateTrafficPolicy
request, if
any.
$sel:id:TrafficPolicy'
, trafficPolicy_id
- The ID that Amazon Route 53 assigned to a traffic policy when you
created it.
$sel:version:TrafficPolicy'
, trafficPolicy_version
- The version number that Amazon Route 53 assigns to a traffic policy. For
a new traffic policy, the value of Version
is always 1.
$sel:name:TrafficPolicy'
, trafficPolicy_name
- The name that you specified when you created the traffic policy.
$sel:type':TrafficPolicy'
, trafficPolicy_type
- The DNS type of the resource record sets that Amazon Route 53 creates
when you use a traffic policy to create a traffic policy instance.
$sel:document:TrafficPolicy'
, trafficPolicy_document
- The definition of a traffic policy in JSON format. You specify the JSON
document to use for a new traffic policy in the CreateTrafficPolicy
request. For more information about the JSON format, see
Traffic Policy Document Format.
trafficPolicy_comment :: Lens' TrafficPolicy (Maybe Text) Source #
The comment that you specify in the CreateTrafficPolicy
request, if
any.
trafficPolicy_id :: Lens' TrafficPolicy Text Source #
The ID that Amazon Route 53 assigned to a traffic policy when you created it.
trafficPolicy_version :: Lens' TrafficPolicy Natural Source #
The version number that Amazon Route 53 assigns to a traffic policy. For
a new traffic policy, the value of Version
is always 1.
trafficPolicy_name :: Lens' TrafficPolicy Text Source #
The name that you specified when you created the traffic policy.
trafficPolicy_type :: Lens' TrafficPolicy RRType Source #
The DNS type of the resource record sets that Amazon Route 53 creates when you use a traffic policy to create a traffic policy instance.
trafficPolicy_document :: Lens' TrafficPolicy Text Source #
The definition of a traffic policy in JSON format. You specify the JSON
document to use for a new traffic policy in the CreateTrafficPolicy
request. For more information about the JSON format, see
Traffic Policy Document Format.
TrafficPolicyInstance
data TrafficPolicyInstance Source #
A complex type that contains settings for the new traffic policy instance.
See: newTrafficPolicyInstance
smart constructor.
TrafficPolicyInstance' | |
|
Instances
newTrafficPolicyInstance Source #
:: Text | |
-> ResourceId | |
-> Text | |
-> Natural | |
-> Text | |
-> Text | |
-> Text | |
-> Natural | |
-> RRType | |
-> TrafficPolicyInstance |
Create a value of TrafficPolicyInstance
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:id:TrafficPolicyInstance'
, trafficPolicyInstance_id
- The ID that Amazon Route 53 assigned to the new traffic policy instance.
$sel:hostedZoneId:TrafficPolicyInstance'
, trafficPolicyInstance_hostedZoneId
- The ID of the hosted zone that Amazon Route 53 created resource record
sets in.
$sel:name:TrafficPolicyInstance'
, trafficPolicyInstance_name
- The DNS name, such as www.example.com, for which Amazon Route 53
responds to queries by using the resource record sets that are
associated with this traffic policy instance.
$sel:ttl:TrafficPolicyInstance'
, trafficPolicyInstance_ttl
- The TTL that Amazon Route 53 assigned to all of the resource record sets
that it created in the specified hosted zone.
$sel:state:TrafficPolicyInstance'
, trafficPolicyInstance_state
- The value of State
is one of the following values:
- Applied
- Amazon Route 53 has finished creating resource record sets, and changes have propagated to all Route 53 edge locations.
- Creating
- Route 53 is creating the resource record sets. Use
GetTrafficPolicyInstance
to confirm that theCreateTrafficPolicyInstance
request completed successfully. - Failed
- Route 53 wasn't able to create or update the resource record sets.
When the value of
State
isFailed
, seeMessage
for an explanation of what caused the request to fail.
$sel:message:TrafficPolicyInstance'
, trafficPolicyInstance_message
- If State
is Failed
, an explanation of the reason for the failure. If
State
is another value, Message
is empty.
$sel:trafficPolicyId:TrafficPolicyInstance'
, trafficPolicyInstance_trafficPolicyId
- The ID of the traffic policy that Amazon Route 53 used to create
resource record sets in the specified hosted zone.
$sel:trafficPolicyVersion:TrafficPolicyInstance'
, trafficPolicyInstance_trafficPolicyVersion
- The version of the traffic policy that Amazon Route 53 used to create
resource record sets in the specified hosted zone.
$sel:trafficPolicyType:TrafficPolicyInstance'
, trafficPolicyInstance_trafficPolicyType
- The DNS type that Amazon Route 53 assigned to all of the resource record
sets that it created for this traffic policy instance.
trafficPolicyInstance_id :: Lens' TrafficPolicyInstance Text Source #
The ID that Amazon Route 53 assigned to the new traffic policy instance.
trafficPolicyInstance_hostedZoneId :: Lens' TrafficPolicyInstance ResourceId Source #
The ID of the hosted zone that Amazon Route 53 created resource record sets in.
trafficPolicyInstance_name :: Lens' TrafficPolicyInstance Text Source #
The DNS name, such as www.example.com, for which Amazon Route 53 responds to queries by using the resource record sets that are associated with this traffic policy instance.
trafficPolicyInstance_ttl :: Lens' TrafficPolicyInstance Natural Source #
The TTL that Amazon Route 53 assigned to all of the resource record sets that it created in the specified hosted zone.
trafficPolicyInstance_state :: Lens' TrafficPolicyInstance Text Source #
The value of State
is one of the following values:
- Applied
- Amazon Route 53 has finished creating resource record sets, and changes have propagated to all Route 53 edge locations.
- Creating
- Route 53 is creating the resource record sets. Use
GetTrafficPolicyInstance
to confirm that theCreateTrafficPolicyInstance
request completed successfully. - Failed
- Route 53 wasn't able to create or update the resource record sets.
When the value of
State
isFailed
, seeMessage
for an explanation of what caused the request to fail.
trafficPolicyInstance_message :: Lens' TrafficPolicyInstance Text Source #
If State
is Failed
, an explanation of the reason for the failure. If
State
is another value, Message
is empty.
trafficPolicyInstance_trafficPolicyId :: Lens' TrafficPolicyInstance Text Source #
The ID of the traffic policy that Amazon Route 53 used to create resource record sets in the specified hosted zone.
trafficPolicyInstance_trafficPolicyVersion :: Lens' TrafficPolicyInstance Natural Source #
The version of the traffic policy that Amazon Route 53 used to create resource record sets in the specified hosted zone.
trafficPolicyInstance_trafficPolicyType :: Lens' TrafficPolicyInstance RRType Source #
The DNS type that Amazon Route 53 assigned to all of the resource record sets that it created for this traffic policy instance.
TrafficPolicySummary
data TrafficPolicySummary Source #
A complex type that contains information about the latest version of one traffic policy that is associated with the current Amazon Web Services account.
See: newTrafficPolicySummary
smart constructor.
TrafficPolicySummary' | |
|
Instances
newTrafficPolicySummary Source #
Create a value of TrafficPolicySummary
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:id:TrafficPolicySummary'
, trafficPolicySummary_id
- The ID that Amazon Route 53 assigned to the traffic policy when you
created it.
$sel:name:TrafficPolicySummary'
, trafficPolicySummary_name
- The name that you specified for the traffic policy when you created it.
$sel:type':TrafficPolicySummary'
, trafficPolicySummary_type
- The DNS type of the resource record sets that Amazon Route 53 creates
when you use a traffic policy to create a traffic policy instance.
$sel:latestVersion:TrafficPolicySummary'
, trafficPolicySummary_latestVersion
- The version number of the latest version of the traffic policy.
$sel:trafficPolicyCount:TrafficPolicySummary'
, trafficPolicySummary_trafficPolicyCount
- The number of traffic policies that are associated with the current
Amazon Web Services account.
trafficPolicySummary_id :: Lens' TrafficPolicySummary Text Source #
The ID that Amazon Route 53 assigned to the traffic policy when you created it.
trafficPolicySummary_name :: Lens' TrafficPolicySummary Text Source #
The name that you specified for the traffic policy when you created it.
trafficPolicySummary_type :: Lens' TrafficPolicySummary RRType Source #
The DNS type of the resource record sets that Amazon Route 53 creates when you use a traffic policy to create a traffic policy instance.
trafficPolicySummary_latestVersion :: Lens' TrafficPolicySummary Natural Source #
The version number of the latest version of the traffic policy.
trafficPolicySummary_trafficPolicyCount :: Lens' TrafficPolicySummary Natural Source #
The number of traffic policies that are associated with the current Amazon Web Services account.
VPC
(Private hosted zones only) A complex type that contains information about an Amazon VPC.
See: newVPC
smart constructor.
Instances
Eq VPC Source # | |
Read VPC Source # | |
Show VPC Source # | |
Generic VPC Source # | |
NFData VPC Source # | |
Defined in Amazonka.Route53.Types.VPC | |
Hashable VPC Source # | |
Defined in Amazonka.Route53.Types.VPC | |
FromXML VPC Source # | |
ToXML VPC Source # | |
Defined in Amazonka.Route53.Types.VPC | |
type Rep VPC Source # | |
Defined in Amazonka.Route53.Types.VPC type Rep VPC = D1 ('MetaData "VPC" "Amazonka.Route53.Types.VPC" "libZSservicesZSamazonka-route53ZSamazonka-route53" 'False) (C1 ('MetaCons "VPC'" 'PrefixI 'True) (S1 ('MetaSel ('Just "vPCRegion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe VPCRegion)) :*: S1 ('MetaSel ('Just "vPCId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) |
Create a value of VPC
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:vPCRegion:VPC'
, vpc_vPCRegion
- (Private hosted zones only) The region that an Amazon VPC was created
in.
$sel:vPCId:VPC'
, vpc_vPCId
- Undocumented member.