| 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 |
Amazonka.Route53AutoNaming.Types
Contents
- Service Configuration
- Errors
- CustomHealthStatus
- FilterCondition
- HealthCheckType
- HealthStatus
- HealthStatusFilter
- NamespaceFilterName
- NamespaceType
- OperationFilterName
- OperationStatus
- OperationTargetType
- OperationType
- RecordType
- RoutingPolicy
- ServiceFilterName
- ServiceType
- ServiceTypeOption
- DnsConfig
- DnsConfigChange
- DnsProperties
- DnsRecord
- HealthCheckConfig
- HealthCheckCustomConfig
- HttpInstanceSummary
- HttpNamespaceChange
- HttpProperties
- Instance
- InstanceSummary
- Namespace
- NamespaceFilter
- NamespaceProperties
- NamespaceSummary
- Operation
- OperationFilter
- OperationSummary
- PrivateDnsNamespaceChange
- PrivateDnsNamespaceProperties
- PrivateDnsNamespacePropertiesChange
- PrivateDnsPropertiesMutable
- PrivateDnsPropertiesMutableChange
- PublicDnsNamespaceChange
- PublicDnsNamespaceProperties
- PublicDnsNamespacePropertiesChange
- PublicDnsPropertiesMutable
- PublicDnsPropertiesMutableChange
- SOA
- SOAChange
- ServiceChange
- ServiceFilter
- ServiceInfo
- ServiceSummary
- Tag
Description
Synopsis
- defaultService :: Service
- _ResourceLimitExceeded :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidInput :: AsError a => Getting (First ServiceError) a ServiceError
- _NamespaceAlreadyExists :: AsError a => Getting (First ServiceError) a ServiceError
- _NamespaceNotFound :: AsError a => Getting (First ServiceError) a ServiceError
- _ServiceAlreadyExists :: AsError a => Getting (First ServiceError) a ServiceError
- _ResourceInUse :: AsError a => Getting (First ServiceError) a ServiceError
- _TooManyTagsException :: AsError a => Getting (First ServiceError) a ServiceError
- _CustomHealthNotFound :: AsError a => Getting (First ServiceError) a ServiceError
- _RequestLimitExceeded :: AsError a => Getting (First ServiceError) a ServiceError
- _InstanceNotFound :: AsError a => Getting (First ServiceError) a ServiceError
- _DuplicateRequest :: AsError a => Getting (First ServiceError) a ServiceError
- _ServiceNotFound :: AsError a => Getting (First ServiceError) a ServiceError
- _OperationNotFound :: AsError a => Getting (First ServiceError) a ServiceError
- _ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
- newtype CustomHealthStatus where
- newtype FilterCondition where
- FilterCondition' { }
- pattern FilterCondition_BETWEEN :: FilterCondition
- pattern FilterCondition_EQ :: FilterCondition
- pattern FilterCondition_IN :: FilterCondition
- newtype HealthCheckType where
- HealthCheckType' { }
- pattern HealthCheckType_HTTP :: HealthCheckType
- pattern HealthCheckType_HTTPS :: HealthCheckType
- pattern HealthCheckType_TCP :: HealthCheckType
- newtype HealthStatus where
- HealthStatus' { }
- pattern HealthStatus_HEALTHY :: HealthStatus
- pattern HealthStatus_UNHEALTHY :: HealthStatus
- pattern HealthStatus_UNKNOWN :: HealthStatus
- newtype HealthStatusFilter where
- newtype NamespaceFilterName where
- newtype NamespaceType where
- NamespaceType' { }
- pattern NamespaceType_DNS_PRIVATE :: NamespaceType
- pattern NamespaceType_DNS_PUBLIC :: NamespaceType
- pattern NamespaceType_HTTP :: NamespaceType
- newtype OperationFilterName where
- OperationFilterName' { }
- pattern OperationFilterName_NAMESPACE_ID :: OperationFilterName
- pattern OperationFilterName_SERVICE_ID :: OperationFilterName
- pattern OperationFilterName_STATUS :: OperationFilterName
- pattern OperationFilterName_TYPE :: OperationFilterName
- pattern OperationFilterName_UPDATE_DATE :: OperationFilterName
- newtype OperationStatus where
- OperationStatus' { }
- pattern OperationStatus_FAIL :: OperationStatus
- pattern OperationStatus_PENDING :: OperationStatus
- pattern OperationStatus_SUBMITTED :: OperationStatus
- pattern OperationStatus_SUCCESS :: OperationStatus
- newtype OperationTargetType where
- newtype OperationType where
- OperationType' { }
- pattern OperationType_CREATE_NAMESPACE :: OperationType
- pattern OperationType_DELETE_NAMESPACE :: OperationType
- pattern OperationType_DEREGISTER_INSTANCE :: OperationType
- pattern OperationType_REGISTER_INSTANCE :: OperationType
- pattern OperationType_UPDATE_NAMESPACE :: OperationType
- pattern OperationType_UPDATE_SERVICE :: OperationType
- newtype RecordType where
- RecordType' { }
- pattern RecordType_A :: RecordType
- pattern RecordType_AAAA :: RecordType
- pattern RecordType_CNAME :: RecordType
- pattern RecordType_SRV :: RecordType
- newtype RoutingPolicy where
- RoutingPolicy' { }
- pattern RoutingPolicy_MULTIVALUE :: RoutingPolicy
- pattern RoutingPolicy_WEIGHTED :: RoutingPolicy
- newtype ServiceFilterName where
- newtype ServiceType where
- ServiceType' { }
- pattern ServiceType_DNS :: ServiceType
- pattern ServiceType_DNS_HTTP :: ServiceType
- pattern ServiceType_HTTP :: ServiceType
- newtype ServiceTypeOption where
- ServiceTypeOption' { }
- pattern ServiceTypeOption_HTTP :: ServiceTypeOption
- data DnsConfig = DnsConfig' {}
- newDnsConfig :: DnsConfig
- dnsConfig_routingPolicy :: Lens' DnsConfig (Maybe RoutingPolicy)
- dnsConfig_namespaceId :: Lens' DnsConfig (Maybe Text)
- dnsConfig_dnsRecords :: Lens' DnsConfig [DnsRecord]
- data DnsConfigChange = DnsConfigChange' {
- dnsRecords :: [DnsRecord]
- newDnsConfigChange :: DnsConfigChange
- dnsConfigChange_dnsRecords :: Lens' DnsConfigChange [DnsRecord]
- data DnsProperties = DnsProperties' {}
- newDnsProperties :: DnsProperties
- dnsProperties_hostedZoneId :: Lens' DnsProperties (Maybe Text)
- dnsProperties_soa :: Lens' DnsProperties (Maybe SOA)
- data DnsRecord = DnsRecord' {
- type' :: RecordType
- ttl :: Natural
- newDnsRecord :: RecordType -> Natural -> DnsRecord
- dnsRecord_type :: Lens' DnsRecord RecordType
- dnsRecord_ttl :: Lens' DnsRecord Natural
- data HealthCheckConfig = HealthCheckConfig' {}
- newHealthCheckConfig :: HealthCheckType -> HealthCheckConfig
- healthCheckConfig_failureThreshold :: Lens' HealthCheckConfig (Maybe Natural)
- healthCheckConfig_resourcePath :: Lens' HealthCheckConfig (Maybe Text)
- healthCheckConfig_type :: Lens' HealthCheckConfig HealthCheckType
- data HealthCheckCustomConfig = HealthCheckCustomConfig' {}
- newHealthCheckCustomConfig :: HealthCheckCustomConfig
- healthCheckCustomConfig_failureThreshold :: Lens' HealthCheckCustomConfig (Maybe Natural)
- data HttpInstanceSummary = HttpInstanceSummary' {}
- newHttpInstanceSummary :: HttpInstanceSummary
- httpInstanceSummary_instanceId :: Lens' HttpInstanceSummary (Maybe Text)
- httpInstanceSummary_namespaceName :: Lens' HttpInstanceSummary (Maybe Text)
- httpInstanceSummary_attributes :: Lens' HttpInstanceSummary (Maybe (HashMap Text Text))
- httpInstanceSummary_serviceName :: Lens' HttpInstanceSummary (Maybe Text)
- httpInstanceSummary_healthStatus :: Lens' HttpInstanceSummary (Maybe HealthStatus)
- data HttpNamespaceChange = HttpNamespaceChange' {
- description :: Text
- newHttpNamespaceChange :: Text -> HttpNamespaceChange
- httpNamespaceChange_description :: Lens' HttpNamespaceChange Text
- data HttpProperties = HttpProperties' {}
- newHttpProperties :: HttpProperties
- httpProperties_httpName :: Lens' HttpProperties (Maybe Text)
- data Instance = Instance' {
- creatorRequestId :: Maybe Text
- attributes :: Maybe (HashMap Text Text)
- id :: Text
- newInstance :: Text -> Instance
- instance_creatorRequestId :: Lens' Instance (Maybe Text)
- instance_attributes :: Lens' Instance (Maybe (HashMap Text Text))
- instance_id :: Lens' Instance Text
- data InstanceSummary = InstanceSummary' {}
- newInstanceSummary :: InstanceSummary
- instanceSummary_attributes :: Lens' InstanceSummary (Maybe (HashMap Text Text))
- instanceSummary_id :: Lens' InstanceSummary (Maybe Text)
- data Namespace = Namespace' {
- arn :: Maybe Text
- creatorRequestId :: Maybe Text
- createDate :: Maybe POSIX
- serviceCount :: Maybe Int
- name :: Maybe Text
- id :: Maybe Text
- type' :: Maybe NamespaceType
- description :: Maybe Text
- properties :: Maybe NamespaceProperties
- newNamespace :: Namespace
- namespace_arn :: Lens' Namespace (Maybe Text)
- namespace_creatorRequestId :: Lens' Namespace (Maybe Text)
- namespace_createDate :: Lens' Namespace (Maybe UTCTime)
- namespace_serviceCount :: Lens' Namespace (Maybe Int)
- namespace_name :: Lens' Namespace (Maybe Text)
- namespace_id :: Lens' Namespace (Maybe Text)
- namespace_type :: Lens' Namespace (Maybe NamespaceType)
- namespace_description :: Lens' Namespace (Maybe Text)
- namespace_properties :: Lens' Namespace (Maybe NamespaceProperties)
- data NamespaceFilter = NamespaceFilter' {}
- newNamespaceFilter :: NamespaceFilterName -> NamespaceFilter
- namespaceFilter_condition :: Lens' NamespaceFilter (Maybe FilterCondition)
- namespaceFilter_name :: Lens' NamespaceFilter NamespaceFilterName
- namespaceFilter_values :: Lens' NamespaceFilter [Text]
- data NamespaceProperties = NamespaceProperties' {}
- newNamespaceProperties :: NamespaceProperties
- namespaceProperties_dnsProperties :: Lens' NamespaceProperties (Maybe DnsProperties)
- namespaceProperties_httpProperties :: Lens' NamespaceProperties (Maybe HttpProperties)
- data NamespaceSummary = NamespaceSummary' {
- arn :: Maybe Text
- createDate :: Maybe POSIX
- serviceCount :: Maybe Int
- name :: Maybe Text
- id :: Maybe Text
- type' :: Maybe NamespaceType
- description :: Maybe Text
- properties :: Maybe NamespaceProperties
- newNamespaceSummary :: NamespaceSummary
- namespaceSummary_arn :: Lens' NamespaceSummary (Maybe Text)
- namespaceSummary_createDate :: Lens' NamespaceSummary (Maybe UTCTime)
- namespaceSummary_serviceCount :: Lens' NamespaceSummary (Maybe Int)
- namespaceSummary_name :: Lens' NamespaceSummary (Maybe Text)
- namespaceSummary_id :: Lens' NamespaceSummary (Maybe Text)
- namespaceSummary_type :: Lens' NamespaceSummary (Maybe NamespaceType)
- namespaceSummary_description :: Lens' NamespaceSummary (Maybe Text)
- namespaceSummary_properties :: Lens' NamespaceSummary (Maybe NamespaceProperties)
- data Operation = Operation' {}
- newOperation :: Operation
- operation_status :: Lens' Operation (Maybe OperationStatus)
- operation_updateDate :: Lens' Operation (Maybe UTCTime)
- operation_createDate :: Lens' Operation (Maybe UTCTime)
- operation_targets :: Lens' Operation (Maybe (HashMap OperationTargetType Text))
- operation_errorCode :: Lens' Operation (Maybe Text)
- operation_id :: Lens' Operation (Maybe Text)
- operation_type :: Lens' Operation (Maybe OperationType)
- operation_errorMessage :: Lens' Operation (Maybe Text)
- data OperationFilter = OperationFilter' {}
- newOperationFilter :: OperationFilterName -> OperationFilter
- operationFilter_condition :: Lens' OperationFilter (Maybe FilterCondition)
- operationFilter_name :: Lens' OperationFilter OperationFilterName
- operationFilter_values :: Lens' OperationFilter [Text]
- data OperationSummary = OperationSummary' {}
- newOperationSummary :: OperationSummary
- operationSummary_status :: Lens' OperationSummary (Maybe OperationStatus)
- operationSummary_id :: Lens' OperationSummary (Maybe Text)
- data PrivateDnsNamespaceChange = PrivateDnsNamespaceChange' {}
- newPrivateDnsNamespaceChange :: PrivateDnsNamespaceChange
- privateDnsNamespaceChange_description :: Lens' PrivateDnsNamespaceChange (Maybe Text)
- privateDnsNamespaceChange_properties :: Lens' PrivateDnsNamespaceChange (Maybe PrivateDnsNamespacePropertiesChange)
- data PrivateDnsNamespaceProperties = PrivateDnsNamespaceProperties' {}
- newPrivateDnsNamespaceProperties :: PrivateDnsPropertiesMutable -> PrivateDnsNamespaceProperties
- privateDnsNamespaceProperties_dnsProperties :: Lens' PrivateDnsNamespaceProperties PrivateDnsPropertiesMutable
- data PrivateDnsNamespacePropertiesChange = PrivateDnsNamespacePropertiesChange' {}
- newPrivateDnsNamespacePropertiesChange :: PrivateDnsPropertiesMutableChange -> PrivateDnsNamespacePropertiesChange
- privateDnsNamespacePropertiesChange_dnsProperties :: Lens' PrivateDnsNamespacePropertiesChange PrivateDnsPropertiesMutableChange
- data PrivateDnsPropertiesMutable = PrivateDnsPropertiesMutable' {}
- newPrivateDnsPropertiesMutable :: SOA -> PrivateDnsPropertiesMutable
- privateDnsPropertiesMutable_soa :: Lens' PrivateDnsPropertiesMutable SOA
- data PrivateDnsPropertiesMutableChange = PrivateDnsPropertiesMutableChange' {}
- newPrivateDnsPropertiesMutableChange :: SOAChange -> PrivateDnsPropertiesMutableChange
- privateDnsPropertiesMutableChange_soa :: Lens' PrivateDnsPropertiesMutableChange SOAChange
- data PublicDnsNamespaceChange = PublicDnsNamespaceChange' {}
- newPublicDnsNamespaceChange :: PublicDnsNamespaceChange
- publicDnsNamespaceChange_description :: Lens' PublicDnsNamespaceChange (Maybe Text)
- publicDnsNamespaceChange_properties :: Lens' PublicDnsNamespaceChange (Maybe PublicDnsNamespacePropertiesChange)
- data PublicDnsNamespaceProperties = PublicDnsNamespaceProperties' {}
- newPublicDnsNamespaceProperties :: PublicDnsPropertiesMutable -> PublicDnsNamespaceProperties
- publicDnsNamespaceProperties_dnsProperties :: Lens' PublicDnsNamespaceProperties PublicDnsPropertiesMutable
- data PublicDnsNamespacePropertiesChange = PublicDnsNamespacePropertiesChange' {}
- newPublicDnsNamespacePropertiesChange :: PublicDnsPropertiesMutableChange -> PublicDnsNamespacePropertiesChange
- publicDnsNamespacePropertiesChange_dnsProperties :: Lens' PublicDnsNamespacePropertiesChange PublicDnsPropertiesMutableChange
- data PublicDnsPropertiesMutable = PublicDnsPropertiesMutable' {}
- newPublicDnsPropertiesMutable :: SOA -> PublicDnsPropertiesMutable
- publicDnsPropertiesMutable_soa :: Lens' PublicDnsPropertiesMutable SOA
- data PublicDnsPropertiesMutableChange = PublicDnsPropertiesMutableChange' {}
- newPublicDnsPropertiesMutableChange :: SOAChange -> PublicDnsPropertiesMutableChange
- publicDnsPropertiesMutableChange_soa :: Lens' PublicDnsPropertiesMutableChange SOAChange
- data SOA = SOA' {}
- newSOA :: Natural -> SOA
- soa_ttl :: Lens' SOA Natural
- data SOAChange = SOAChange' {}
- newSOAChange :: Natural -> SOAChange
- sOAChange_ttl :: Lens' SOAChange Natural
- data ServiceChange = ServiceChange' {}
- newServiceChange :: ServiceChange
- serviceChange_healthCheckConfig :: Lens' ServiceChange (Maybe HealthCheckConfig)
- serviceChange_dnsConfig :: Lens' ServiceChange (Maybe DnsConfigChange)
- serviceChange_description :: Lens' ServiceChange (Maybe Text)
- data ServiceFilter = ServiceFilter' {
- condition :: Maybe FilterCondition
- name :: ServiceFilterName
- values :: [Text]
- newServiceFilter :: ServiceFilterName -> ServiceFilter
- serviceFilter_condition :: Lens' ServiceFilter (Maybe FilterCondition)
- serviceFilter_name :: Lens' ServiceFilter ServiceFilterName
- serviceFilter_values :: Lens' ServiceFilter [Text]
- data ServiceInfo = ServiceInfo' {
- instanceCount :: Maybe Int
- arn :: Maybe Text
- healthCheckConfig :: Maybe HealthCheckConfig
- creatorRequestId :: Maybe Text
- createDate :: Maybe POSIX
- healthCheckCustomConfig :: Maybe HealthCheckCustomConfig
- namespaceId :: Maybe Text
- name :: Maybe Text
- id :: Maybe Text
- type' :: Maybe ServiceType
- dnsConfig :: Maybe DnsConfig
- description :: Maybe Text
- newServiceInfo :: ServiceInfo
- serviceInfo_instanceCount :: Lens' ServiceInfo (Maybe Int)
- serviceInfo_arn :: Lens' ServiceInfo (Maybe Text)
- serviceInfo_healthCheckConfig :: Lens' ServiceInfo (Maybe HealthCheckConfig)
- serviceInfo_creatorRequestId :: Lens' ServiceInfo (Maybe Text)
- serviceInfo_createDate :: Lens' ServiceInfo (Maybe UTCTime)
- serviceInfo_healthCheckCustomConfig :: Lens' ServiceInfo (Maybe HealthCheckCustomConfig)
- serviceInfo_namespaceId :: Lens' ServiceInfo (Maybe Text)
- serviceInfo_name :: Lens' ServiceInfo (Maybe Text)
- serviceInfo_id :: Lens' ServiceInfo (Maybe Text)
- serviceInfo_type :: Lens' ServiceInfo (Maybe ServiceType)
- serviceInfo_dnsConfig :: Lens' ServiceInfo (Maybe DnsConfig)
- serviceInfo_description :: Lens' ServiceInfo (Maybe Text)
- data ServiceSummary = ServiceSummary' {}
- newServiceSummary :: ServiceSummary
- serviceSummary_instanceCount :: Lens' ServiceSummary (Maybe Int)
- serviceSummary_arn :: Lens' ServiceSummary (Maybe Text)
- serviceSummary_healthCheckConfig :: Lens' ServiceSummary (Maybe HealthCheckConfig)
- serviceSummary_createDate :: Lens' ServiceSummary (Maybe UTCTime)
- serviceSummary_healthCheckCustomConfig :: Lens' ServiceSummary (Maybe HealthCheckCustomConfig)
- serviceSummary_name :: Lens' ServiceSummary (Maybe Text)
- serviceSummary_id :: Lens' ServiceSummary (Maybe Text)
- serviceSummary_type :: Lens' ServiceSummary (Maybe ServiceType)
- serviceSummary_dnsConfig :: Lens' ServiceSummary (Maybe DnsConfig)
- serviceSummary_description :: Lens' ServiceSummary (Maybe Text)
- data Tag = Tag' {}
- newTag :: Text -> Text -> Tag
- tag_key :: Lens' Tag Text
- tag_value :: Lens' Tag Text
Service Configuration
defaultService :: Service Source #
API version 2017-03-14 of the Amazon Cloud Map SDK configuration.
Errors
_ResourceLimitExceeded :: AsError a => Getting (First ServiceError) a ServiceError Source #
The resource can't be created because you've reached the quota on the number of resources.
_InvalidInput :: AsError a => Getting (First ServiceError) a ServiceError Source #
One or more specified values aren't valid. For example, a required value might be missing, a numeric value might be outside the allowed range, or a string value might exceed length constraints.
_NamespaceAlreadyExists :: AsError a => Getting (First ServiceError) a ServiceError Source #
The namespace that you're trying to create already exists.
_NamespaceNotFound :: AsError a => Getting (First ServiceError) a ServiceError Source #
No namespace exists with the specified ID.
_ServiceAlreadyExists :: AsError a => Getting (First ServiceError) a ServiceError Source #
The service can't be created because a service with the same name already exists.
_ResourceInUse :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified resource can't be deleted because it contains other resources. For example, you can't delete a service that contains any instances.
_TooManyTagsException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The list of tags on the resource is over the quota. The maximum number of tags that can be applied to a resource is 50.
_CustomHealthNotFound :: AsError a => Getting (First ServiceError) a ServiceError Source #
The health check for the instance that's specified by ServiceId and
InstanceId isn't a custom health check.
_RequestLimitExceeded :: AsError a => Getting (First ServiceError) a ServiceError Source #
The operation can't be completed because you've reached the quota for the number of requests. For more information, see Cloud Map API request throttling quota in the Cloud Map Developer Guide.
_InstanceNotFound :: AsError a => Getting (First ServiceError) a ServiceError Source #
No instance exists with the specified ID, or the instance was recently registered, and information about the instance hasn't propagated yet.
_DuplicateRequest :: AsError a => Getting (First ServiceError) a ServiceError Source #
The operation is already in progress.
_ServiceNotFound :: AsError a => Getting (First ServiceError) a ServiceError Source #
No service exists with the specified ID.
_OperationNotFound :: AsError a => Getting (First ServiceError) a ServiceError Source #
No operation exists with the specified ID.
_ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The operation can't be completed because the resource was not found.
CustomHealthStatus
newtype CustomHealthStatus Source #
Constructors
| CustomHealthStatus' | |
Fields | |
Bundled Patterns
| pattern CustomHealthStatus_HEALTHY :: CustomHealthStatus | |
| pattern CustomHealthStatus_UNHEALTHY :: CustomHealthStatus |
Instances
FilterCondition
newtype FilterCondition Source #
Constructors
| FilterCondition' | |
Fields | |
Bundled Patterns
| pattern FilterCondition_BETWEEN :: FilterCondition | |
| pattern FilterCondition_EQ :: FilterCondition | |
| pattern FilterCondition_IN :: FilterCondition |
Instances
HealthCheckType
newtype HealthCheckType Source #
Constructors
| HealthCheckType' | |
Fields | |
Bundled Patterns
| pattern HealthCheckType_HTTP :: HealthCheckType | |
| pattern HealthCheckType_HTTPS :: HealthCheckType | |
| pattern HealthCheckType_TCP :: HealthCheckType |
Instances
HealthStatus
newtype HealthStatus Source #
Constructors
| HealthStatus' | |
Fields | |
Bundled Patterns
| pattern HealthStatus_HEALTHY :: HealthStatus | |
| pattern HealthStatus_UNHEALTHY :: HealthStatus | |
| pattern HealthStatus_UNKNOWN :: HealthStatus |
Instances
HealthStatusFilter
newtype HealthStatusFilter Source #
Constructors
| HealthStatusFilter' | |
Fields | |
Bundled Patterns
| pattern HealthStatusFilter_ALL :: HealthStatusFilter | |
| pattern HealthStatusFilter_HEALTHY :: HealthStatusFilter | |
| pattern HealthStatusFilter_HEALTHY_OR_ELSE_ALL :: HealthStatusFilter | |
| pattern HealthStatusFilter_UNHEALTHY :: HealthStatusFilter |
Instances
NamespaceFilterName
newtype NamespaceFilterName Source #
Constructors
| NamespaceFilterName' | |
Fields | |
Bundled Patterns
| pattern NamespaceFilterName_TYPE :: NamespaceFilterName |
Instances
NamespaceType
newtype NamespaceType Source #
Constructors
| NamespaceType' | |
Fields | |
Bundled Patterns
| pattern NamespaceType_DNS_PRIVATE :: NamespaceType | |
| pattern NamespaceType_DNS_PUBLIC :: NamespaceType | |
| pattern NamespaceType_HTTP :: NamespaceType |
Instances
OperationFilterName
newtype OperationFilterName Source #
Constructors
| OperationFilterName' | |
Fields | |
Bundled Patterns
| pattern OperationFilterName_NAMESPACE_ID :: OperationFilterName | |
| pattern OperationFilterName_SERVICE_ID :: OperationFilterName | |
| pattern OperationFilterName_STATUS :: OperationFilterName | |
| pattern OperationFilterName_TYPE :: OperationFilterName | |
| pattern OperationFilterName_UPDATE_DATE :: OperationFilterName |
Instances
OperationStatus
newtype OperationStatus Source #
Constructors
| OperationStatus' | |
Fields | |
Bundled Patterns
| pattern OperationStatus_FAIL :: OperationStatus | |
| pattern OperationStatus_PENDING :: OperationStatus | |
| pattern OperationStatus_SUBMITTED :: OperationStatus | |
| pattern OperationStatus_SUCCESS :: OperationStatus |
Instances
OperationTargetType
newtype OperationTargetType Source #
Constructors
| OperationTargetType' | |
Fields | |
Bundled Patterns
| pattern OperationTargetType_INSTANCE :: OperationTargetType | |
| pattern OperationTargetType_NAMESPACE :: OperationTargetType | |
| pattern OperationTargetType_SERVICE :: OperationTargetType |
Instances
OperationType
newtype OperationType Source #
Constructors
| OperationType' | |
Fields | |
Bundled Patterns
| pattern OperationType_CREATE_NAMESPACE :: OperationType | |
| pattern OperationType_DELETE_NAMESPACE :: OperationType | |
| pattern OperationType_DEREGISTER_INSTANCE :: OperationType | |
| pattern OperationType_REGISTER_INSTANCE :: OperationType | |
| pattern OperationType_UPDATE_NAMESPACE :: OperationType | |
| pattern OperationType_UPDATE_SERVICE :: OperationType |
Instances
RecordType
newtype RecordType Source #
Constructors
| RecordType' | |
Fields | |
Bundled Patterns
| pattern RecordType_A :: RecordType | |
| pattern RecordType_AAAA :: RecordType | |
| pattern RecordType_CNAME :: RecordType | |
| pattern RecordType_SRV :: RecordType |
Instances
RoutingPolicy
newtype RoutingPolicy Source #
Constructors
| RoutingPolicy' | |
Fields | |
Bundled Patterns
| pattern RoutingPolicy_MULTIVALUE :: RoutingPolicy | |
| pattern RoutingPolicy_WEIGHTED :: RoutingPolicy |
Instances
ServiceFilterName
newtype ServiceFilterName Source #
Constructors
| ServiceFilterName' | |
Fields | |
Bundled Patterns
| pattern ServiceFilterName_NAMESPACE_ID :: ServiceFilterName |
Instances
ServiceType
newtype ServiceType Source #
Constructors
| ServiceType' | |
Fields | |
Bundled Patterns
| pattern ServiceType_DNS :: ServiceType | |
| pattern ServiceType_DNS_HTTP :: ServiceType | |
| pattern ServiceType_HTTP :: ServiceType |
Instances
ServiceTypeOption
newtype ServiceTypeOption Source #
Constructors
| ServiceTypeOption' | |
Fields | |
Bundled Patterns
| pattern ServiceTypeOption_HTTP :: ServiceTypeOption |
Instances
DnsConfig
A complex type that contains information about the Amazon Route 53 DNS records that you want Cloud Map to create when you register an instance.
See: newDnsConfig smart constructor.
Constructors
| DnsConfig' | |
Fields
| |
Instances
newDnsConfig :: DnsConfig Source #
Create a value of DnsConfig 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:routingPolicy:DnsConfig', dnsConfig_routingPolicy - The routing policy that you want to apply to all Route 53 DNS records
that Cloud Map creates when you register an instance and specify this
service.
If you want to use this service to register instances that create alias
records, specify WEIGHTED for the routing policy.
You can specify the following values:
- MULTIVALUE
- If you define a health check for the service and the health check is
healthy, Route 53 returns the applicable value for up to eight
instances.
For example, suppose that the service includes configurations for one
Arecord and a health check. You use the service to register 10 instances. Route 53 responds to DNS queries with IP addresses for up to eight healthy instances. If fewer than eight instances are healthy, Route 53 responds to every DNS query with the IP addresses for all of the healthy instances.If you don't define a health check for the service, Route 53 assumes that all instances are healthy and returns the values for up to eight instances.
For more information about the multivalue routing policy, see Multivalue Answer Routing in the Route 53 Developer Guide.
- WEIGHTED
- Route 53 returns the applicable value from one randomly selected
instance from among the instances that you registered using the same
service. Currently, all records have the same weight, so you can't
route more or less traffic to any instances.
For example, suppose that the service includes configurations for one
Arecord and a health check. You use the service to register 10 instances. Route 53 responds to DNS queries with the IP address for one randomly selected instance from among the healthy instances. If no instances are healthy, Route 53 responds to DNS queries as if all of the instances were healthy.If you don't define a health check for the service, Route 53 assumes that all instances are healthy and returns the applicable value for one randomly selected instance.
For more information about the weighted routing policy, see Weighted Routing in the Route 53 Developer Guide.
$sel:namespaceId:DnsConfig', dnsConfig_namespaceId - The ID of the namespace to use for DNS configuration.
$sel:dnsRecords:DnsConfig', dnsConfig_dnsRecords - An array that contains one DnsRecord object for each Route 53 DNS
record that you want Cloud Map to create when you register an instance.
dnsConfig_routingPolicy :: Lens' DnsConfig (Maybe RoutingPolicy) Source #
The routing policy that you want to apply to all Route 53 DNS records that Cloud Map creates when you register an instance and specify this service.
If you want to use this service to register instances that create alias
records, specify WEIGHTED for the routing policy.
You can specify the following values:
- MULTIVALUE
- If you define a health check for the service and the health check is
healthy, Route 53 returns the applicable value for up to eight
instances.
For example, suppose that the service includes configurations for one
Arecord and a health check. You use the service to register 10 instances. Route 53 responds to DNS queries with IP addresses for up to eight healthy instances. If fewer than eight instances are healthy, Route 53 responds to every DNS query with the IP addresses for all of the healthy instances.If you don't define a health check for the service, Route 53 assumes that all instances are healthy and returns the values for up to eight instances.
For more information about the multivalue routing policy, see Multivalue Answer Routing in the Route 53 Developer Guide.
- WEIGHTED
- Route 53 returns the applicable value from one randomly selected
instance from among the instances that you registered using the same
service. Currently, all records have the same weight, so you can't
route more or less traffic to any instances.
For example, suppose that the service includes configurations for one
Arecord and a health check. You use the service to register 10 instances. Route 53 responds to DNS queries with the IP address for one randomly selected instance from among the healthy instances. If no instances are healthy, Route 53 responds to DNS queries as if all of the instances were healthy.If you don't define a health check for the service, Route 53 assumes that all instances are healthy and returns the applicable value for one randomly selected instance.
For more information about the weighted routing policy, see Weighted Routing in the Route 53 Developer Guide.
dnsConfig_namespaceId :: Lens' DnsConfig (Maybe Text) Source #
The ID of the namespace to use for DNS configuration.
dnsConfig_dnsRecords :: Lens' DnsConfig [DnsRecord] Source #
An array that contains one DnsRecord object for each Route 53 DNS
record that you want Cloud Map to create when you register an instance.
DnsConfigChange
data DnsConfigChange Source #
A complex type that contains information about changes to the Route 53 DNS records that Cloud Map creates when you register an instance.
See: newDnsConfigChange smart constructor.
Constructors
| DnsConfigChange' | |
Fields
| |
Instances
newDnsConfigChange :: DnsConfigChange Source #
Create a value of DnsConfigChange 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:dnsRecords:DnsConfigChange', dnsConfigChange_dnsRecords - An array that contains one DnsRecord object for each Route 53 record
that you want Cloud Map to create when you register an instance.
dnsConfigChange_dnsRecords :: Lens' DnsConfigChange [DnsRecord] Source #
An array that contains one DnsRecord object for each Route 53 record
that you want Cloud Map to create when you register an instance.
DnsProperties
data DnsProperties Source #
A complex type that contains the ID for the Route 53 hosted zone that Cloud Map creates when you create a namespace.
See: newDnsProperties smart constructor.
Constructors
| DnsProperties' | |
Instances
newDnsProperties :: DnsProperties Source #
Create a value of DnsProperties 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:DnsProperties', dnsProperties_hostedZoneId - The ID for the Route 53 hosted zone that Cloud Map creates when you
create a namespace.
$sel:soa:DnsProperties', dnsProperties_soa - Start of Authority (SOA) record for the hosted zone.
dnsProperties_hostedZoneId :: Lens' DnsProperties (Maybe Text) Source #
The ID for the Route 53 hosted zone that Cloud Map creates when you create a namespace.
dnsProperties_soa :: Lens' DnsProperties (Maybe SOA) Source #
Start of Authority (SOA) record for the hosted zone.
DnsRecord
A complex type that contains information about the Route 53 DNS records that you want Cloud Map to create when you register an instance.
See: newDnsRecord smart constructor.
Constructors
| DnsRecord' | |
Fields
| |
Instances
| Eq DnsRecord Source # | |
| Read DnsRecord Source # | |
| Show DnsRecord Source # | |
| Generic DnsRecord Source # | |
| NFData DnsRecord Source # | |
Defined in Amazonka.Route53AutoNaming.Types.DnsRecord | |
| Hashable DnsRecord Source # | |
Defined in Amazonka.Route53AutoNaming.Types.DnsRecord | |
| ToJSON DnsRecord Source # | |
Defined in Amazonka.Route53AutoNaming.Types.DnsRecord | |
| FromJSON DnsRecord Source # | |
| type Rep DnsRecord Source # | |
Defined in Amazonka.Route53AutoNaming.Types.DnsRecord type Rep DnsRecord = D1 ('MetaData "DnsRecord" "Amazonka.Route53AutoNaming.Types.DnsRecord" "libZSservicesZSamazonka-route53-autonamingZSamazonka-route53-autonaming" 'False) (C1 ('MetaCons "DnsRecord'" 'PrefixI 'True) (S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 RecordType) :*: S1 ('MetaSel ('Just "ttl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Natural))) | |
Arguments
| :: RecordType | |
| -> Natural | |
| -> DnsRecord |
Create a value of DnsRecord 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':DnsRecord', dnsRecord_type - The type of the resource, which indicates the type of value that Route
53 returns in response to DNS queries. You can specify values for Type
in the following combinations:
AAAAAAandAAAASRVCNAME
If you want Cloud Map to create a Route 53 alias record when you
register an instance, specify A or AAAA for Type.
You specify other settings, such as the IP address for A and AAAA
records, when you register an instance. For more information, see
RegisterInstance.
The following values are supported:
- A
- Route 53 returns the IP address of the resource in IPv4 format, such as 192.0.2.44.
- AAAA
- Route 53 returns the IP address of the resource in IPv6 format, such as 2001:0db8:85a3:0000:0000:abcd:0001:2345.
- CNAME
- Route 53 returns the domain name of the resource, such as
www.example.com. Note the following:
- You specify the domain name that you want to route traffic to when you register an instance. For more information, see Attributes in the topic RegisterInstance.
- You must specify
WEIGHTEDfor the value ofRoutingPolicy. - You can't specify both
CNAMEforTypeand settings forHealthCheckConfig. If you do, the request will fail with anInvalidInputerror.
- SRV
- Route 53 returns the value for an
SRVrecord. The value for anSRVrecord uses the following values:priority weight port service-hostname
Note the following about the values:
- The values of
priorityandweightare both set to1and can't be changed. - The value of
portcomes from the value that you specify for theAWS_INSTANCE_PORTattribute when you submit a RegisterInstance request. The value of
service-hostnameis a concatenation of the following values:- The value that you specify for
InstanceIdwhen you register an instance. - The name of the service.
- The name of the namespace.
For example, if the value of
InstanceIdistest, the name of the service isbackend, and the name of the namespace isexample.com, the value ofservice-hostnameis the following:test.backend.example.com
- The value that you specify for
If you specify settings for an
SRVrecord, note the following:- If you specify values for
AWS_INSTANCE_IPV4,AWS_INSTANCE_IPV6, or both in theRegisterInstancerequest, Cloud Map automatically createsAand/orAAAArecords that have the same name as the value ofservice-hostnamein theSRVrecord. You can ignore these records. - If you're using a system that requires a specific
SRVformat, such as HAProxy, see the Name element in the documentation aboutCreateServicefor information about how to specify the correct name format.
- The values of
$sel:ttl:DnsRecord', dnsRecord_ttl - The amount of time, in seconds, that you want DNS resolvers to cache the
settings for this record.
Alias records don't include a TTL because Route 53 uses the TTL for the
Amazon Web Services resource that an alias record routes traffic to. If
you include the AWS_ALIAS_DNS_NAME attribute when you submit a
RegisterInstance
request, the TTL value is ignored. Always specify a TTL for the
service; you can use a service to register instances that create either
alias or non-alias records.
dnsRecord_type :: Lens' DnsRecord RecordType Source #
The type of the resource, which indicates the type of value that Route
53 returns in response to DNS queries. You can specify values for Type
in the following combinations:
AAAAAAandAAAASRVCNAME
If you want Cloud Map to create a Route 53 alias record when you
register an instance, specify A or AAAA for Type.
You specify other settings, such as the IP address for A and AAAA
records, when you register an instance. For more information, see
RegisterInstance.
The following values are supported:
- A
- Route 53 returns the IP address of the resource in IPv4 format, such as 192.0.2.44.
- AAAA
- Route 53 returns the IP address of the resource in IPv6 format, such as 2001:0db8:85a3:0000:0000:abcd:0001:2345.
- CNAME
- Route 53 returns the domain name of the resource, such as
www.example.com. Note the following:
- You specify the domain name that you want to route traffic to when you register an instance. For more information, see Attributes in the topic RegisterInstance.
- You must specify
WEIGHTEDfor the value ofRoutingPolicy. - You can't specify both
CNAMEforTypeand settings forHealthCheckConfig. If you do, the request will fail with anInvalidInputerror.
- SRV
- Route 53 returns the value for an
SRVrecord. The value for anSRVrecord uses the following values:priority weight port service-hostname
Note the following about the values:
- The values of
priorityandweightare both set to1and can't be changed. - The value of
portcomes from the value that you specify for theAWS_INSTANCE_PORTattribute when you submit a RegisterInstance request. The value of
service-hostnameis a concatenation of the following values:- The value that you specify for
InstanceIdwhen you register an instance. - The name of the service.
- The name of the namespace.
For example, if the value of
InstanceIdistest, the name of the service isbackend, and the name of the namespace isexample.com, the value ofservice-hostnameis the following:test.backend.example.com
- The value that you specify for
If you specify settings for an
SRVrecord, note the following:- If you specify values for
AWS_INSTANCE_IPV4,AWS_INSTANCE_IPV6, or both in theRegisterInstancerequest, Cloud Map automatically createsAand/orAAAArecords that have the same name as the value ofservice-hostnamein theSRVrecord. You can ignore these records. - If you're using a system that requires a specific
SRVformat, such as HAProxy, see the Name element in the documentation aboutCreateServicefor information about how to specify the correct name format.
- The values of
dnsRecord_ttl :: Lens' DnsRecord Natural Source #
The amount of time, in seconds, that you want DNS resolvers to cache the settings for this record.
Alias records don't include a TTL because Route 53 uses the TTL for the
Amazon Web Services resource that an alias record routes traffic to. If
you include the AWS_ALIAS_DNS_NAME attribute when you submit a
RegisterInstance
request, the TTL value is ignored. Always specify a TTL for the
service; you can use a service to register instances that create either
alias or non-alias records.
HealthCheckConfig
data HealthCheckConfig Source #
Public DNS and HTTP namespaces only. A complex type that contains
settings for an optional health check. If you specify settings for a
health check, Cloud Map associates the health check with the records
that you specify in DnsConfig.
If you specify a health check configuration, you can specify either
HealthCheckCustomConfig or HealthCheckConfig but not both.
Health checks are basic Route 53 health checks that monitor an Amazon Web Services endpoint. For information about pricing for health checks, see Amazon Route 53 Pricing.
Note the following about configuring health checks.
- A and AAAA records
- If
DnsConfigincludes configurations for bothAandAAAArecords, Cloud Map creates a health check that uses the IPv4 address to check the health of the resource. If the endpoint tthat's specified by the IPv4 address is unhealthy, Route 53 considers both theAandAAAArecords to be unhealthy. - CNAME records
- You can't specify settings for
HealthCheckConfigwhen theDNSConfigincludesCNAMEfor the value ofType. If you do, theCreateServicerequest will fail with anInvalidInputerror. - Request interval
- A Route 53 health checker in each health-checking Amazon Web Services Region sends a health check request to an endpoint every 30 seconds. On average, your endpoint receives a health check request about every two seconds. However, health checkers don't coordinate with one another. Therefore, you might sometimes see several requests in one second that's followed by a few seconds with no health checks at all.
- Health checking regions
- Health checkers perform checks from all Route 53 health-checking Regions. For a list of the current Regions, see Regions.
- Alias records
- When you register an instance, if you include the
AWS_ALIAS_DNS_NAMEattribute, Cloud Map creates a Route 53 alias record. Note the following:- Route 53 automatically sets
EvaluateTargetHealthto true for alias records. WhenEvaluateTargetHealthis true, the alias record inherits the health of the referenced Amazon Web Services resource. such as an ELB load balancer. For more information, see EvaluateTargetHealth. - If you include
HealthCheckConfigand then use the service to register an instance that creates an alias record, Route 53 doesn't create the health check.
- Route 53 automatically sets
- Charges for health checks
- Health checks are basic Route 53 health checks that monitor an Amazon Web Services endpoint. For information about pricing for health checks, see Amazon Route 53 Pricing.
See: newHealthCheckConfig smart constructor.
Constructors
| HealthCheckConfig' | |
Fields
| |
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 Route 53 to change the current status of the endpoint from
unhealthy to healthy or the other way around. For more information, see
How Route 53 Determines Whether an Endpoint Is Healthy
in the Route 53 Developer Guide.
$sel:resourcePath:HealthCheckConfig', healthCheckConfig_resourcePath - The path that you want Route 53 to request when performing health
checks. The path can be any value that your endpoint returns an HTTP
status code of a 2xx or 3xx format for when the endpoint is healthy. An
example file is /docs/route53-health-check.html. Route 53
automatically adds the DNS name for the service. If you don't specify a
value for ResourcePath, the default value is /.
If you specify TCP for Type, you must not specify a value for
ResourcePath.
$sel:type':HealthCheckConfig', healthCheckConfig_type - The type of health check that you want to create, which indicates how
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 of
Type, the endpoint must support TLS v1.0 or later.TCP: Route 53 tries to establish a TCP connection.
If you specify
TCPforType, don't specify a value forResourcePath.
For more information, see How Route 53 Determines Whether an Endpoint Is Healthy in the 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 Route 53 to change the current status of the endpoint from unhealthy to healthy or the other way around. For more information, see How Route 53 Determines Whether an Endpoint Is Healthy in the Route 53 Developer Guide.
healthCheckConfig_resourcePath :: Lens' HealthCheckConfig (Maybe Text) Source #
The path that you want Route 53 to request when performing health
checks. The path can be any value that your endpoint returns an HTTP
status code of a 2xx or 3xx format for when the endpoint is healthy. An
example file is /docs/route53-health-check.html. Route 53
automatically adds the DNS name for the service. If you don't specify a
value for ResourcePath, the default value is /.
If you specify TCP for Type, you must not specify a value for
ResourcePath.
healthCheckConfig_type :: Lens' HealthCheckConfig HealthCheckType Source #
The type of health check that you want to create, which indicates how 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 of
Type, the endpoint must support TLS v1.0 or later.TCP: Route 53 tries to establish a TCP connection.
If you specify
TCPforType, don't specify a value forResourcePath.
For more information, see How Route 53 Determines Whether an Endpoint Is Healthy in the Route 53 Developer Guide.
HealthCheckCustomConfig
data HealthCheckCustomConfig Source #
A complex type that contains information about an optional custom health check. A custom health check, which requires that you use a third-party health checker to evaluate the health of your resources, is useful in the following circumstances:
- You can't use a health check that's defined by
HealthCheckConfigbecause the resource isn't available over the internet. For example, you can use a custom health check when the instance is in an Amazon VPC. (To check the health of resources in a VPC, the health checker must also be in the VPC.) - You want to use a third-party health checker regardless of where your resources are located.
If you specify a health check configuration, you can specify either
HealthCheckCustomConfig or HealthCheckConfig but not both.
To change the status of a custom health check, submit an
UpdateInstanceCustomHealthStatus request. Cloud Map doesn't monitor
the status of the resource, it just keeps a record of the status
specified in the most recent UpdateInstanceCustomHealthStatus request.
Here's how custom health checks work:
- You create a service.
- You register an instance.
You configure a third-party health checker to monitor the resource that's associated with the new instance.
Cloud Map doesn't check the health of the resource directly.
- The third-party health-checker determines that the resource is unhealthy and notifies your application.
- Your application submits an
UpdateInstanceCustomHealthStatusrequest. - Cloud Map waits for 30 seconds.
- If another
UpdateInstanceCustomHealthStatusrequest doesn't arrive during that time to change the status back to healthy, Cloud Map stops routing traffic to the resource.
See: newHealthCheckCustomConfig smart constructor.
Constructors
| HealthCheckCustomConfig' | |
Fields
| |
Instances
newHealthCheckCustomConfig :: HealthCheckCustomConfig Source #
Create a value of HealthCheckCustomConfig 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:HealthCheckCustomConfig', healthCheckCustomConfig_failureThreshold - This parameter is no longer supported and is always set to 1. Cloud Map
waits for approximately 30 seconds after receiving an
UpdateInstanceCustomHealthStatus request before changing the status of
the service instance.
The number of 30-second intervals that you want Cloud Map to wait after
receiving an UpdateInstanceCustomHealthStatus request before it
changes the health status of a service instance.
Sending a second or subsequent UpdateInstanceCustomHealthStatus
request with the same value before 30 seconds has passed doesn't
accelerate the change. Cloud Map still waits 30 seconds after the
first request to make the change.
healthCheckCustomConfig_failureThreshold :: Lens' HealthCheckCustomConfig (Maybe Natural) Source #
This parameter is no longer supported and is always set to 1. Cloud Map
waits for approximately 30 seconds after receiving an
UpdateInstanceCustomHealthStatus request before changing the status of
the service instance.
The number of 30-second intervals that you want Cloud Map to wait after
receiving an UpdateInstanceCustomHealthStatus request before it
changes the health status of a service instance.
Sending a second or subsequent UpdateInstanceCustomHealthStatus
request with the same value before 30 seconds has passed doesn't
accelerate the change. Cloud Map still waits 30 seconds after the
first request to make the change.
HttpInstanceSummary
data HttpInstanceSummary Source #
In a response to a
DiscoverInstances
request, HttpInstanceSummary contains information about one instance
that matches the values that you specified in the request.
See: newHttpInstanceSummary smart constructor.
Constructors
| HttpInstanceSummary' | |
Fields
| |
Instances
newHttpInstanceSummary :: HttpInstanceSummary Source #
Create a value of HttpInstanceSummary 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:instanceId:HttpInstanceSummary', httpInstanceSummary_instanceId - The ID of an instance that matches the values that you specified in the
request.
$sel:namespaceName:HttpInstanceSummary', httpInstanceSummary_namespaceName - @ @
The HttpName name of the namespace. It's found in the
HttpProperties member of the Properties member of the namespace.
$sel:attributes:HttpInstanceSummary', httpInstanceSummary_attributes - If you included any attributes when you registered the instance, the
values of those attributes.
$sel:serviceName:HttpInstanceSummary', httpInstanceSummary_serviceName - The name of the service that you specified when you registered the
instance.
$sel:healthStatus:HttpInstanceSummary', httpInstanceSummary_healthStatus - If you configured health checking in the service, the current health
status of the service instance.
httpInstanceSummary_instanceId :: Lens' HttpInstanceSummary (Maybe Text) Source #
The ID of an instance that matches the values that you specified in the request.
httpInstanceSummary_namespaceName :: Lens' HttpInstanceSummary (Maybe Text) Source #
@ @
The HttpName name of the namespace. It's found in the
HttpProperties member of the Properties member of the namespace.
httpInstanceSummary_attributes :: Lens' HttpInstanceSummary (Maybe (HashMap Text Text)) Source #
If you included any attributes when you registered the instance, the values of those attributes.
httpInstanceSummary_serviceName :: Lens' HttpInstanceSummary (Maybe Text) Source #
The name of the service that you specified when you registered the instance.
httpInstanceSummary_healthStatus :: Lens' HttpInstanceSummary (Maybe HealthStatus) Source #
If you configured health checking in the service, the current health status of the service instance.
HttpNamespaceChange
data HttpNamespaceChange Source #
Updated properties for the HTTP namespace.
See: newHttpNamespaceChange smart constructor.
Constructors
| HttpNamespaceChange' | |
Fields
| |
Instances
newHttpNamespaceChange Source #
Arguments
| :: Text | |
| -> HttpNamespaceChange |
Create a value of HttpNamespaceChange 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:description:HttpNamespaceChange', httpNamespaceChange_description - An updated description for the HTTP namespace.
httpNamespaceChange_description :: Lens' HttpNamespaceChange Text Source #
An updated description for the HTTP namespace.
HttpProperties
data HttpProperties Source #
A complex type that contains the name of an HTTP namespace.
See: newHttpProperties smart constructor.
Constructors
| HttpProperties' | |
Instances
newHttpProperties :: HttpProperties Source #
Create a value of HttpProperties 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:httpName:HttpProperties', httpProperties_httpName - The name of an HTTP namespace.
httpProperties_httpName :: Lens' HttpProperties (Maybe Text) Source #
The name of an HTTP namespace.
Instance
A complex type that contains information about an instance that Cloud
Map creates when you submit a RegisterInstance request.
See: newInstance smart constructor.
Constructors
| Instance' | |
Fields
| |
Instances
| Eq Instance Source # | |
| Read Instance Source # | |
| Show Instance Source # | |
| Generic Instance Source # | |
| NFData Instance Source # | |
Defined in Amazonka.Route53AutoNaming.Types.Instance | |
| Hashable Instance Source # | |
Defined in Amazonka.Route53AutoNaming.Types.Instance | |
| FromJSON Instance Source # | |
| type Rep Instance Source # | |
Defined in Amazonka.Route53AutoNaming.Types.Instance type Rep Instance = D1 ('MetaData "Instance" "Amazonka.Route53AutoNaming.Types.Instance" "libZSservicesZSamazonka-route53-autonamingZSamazonka-route53-autonaming" 'False) (C1 ('MetaCons "Instance'" 'PrefixI 'True) (S1 ('MetaSel ('Just "creatorRequestId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "attributes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :*: S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))) | |
Create a value of Instance 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:creatorRequestId:Instance', instance_creatorRequestId - A unique string that identifies the request and that allows failed
RegisterInstance requests to be retried without the risk of executing
the operation twice. You must use a unique CreatorRequestId string
every time you submit a RegisterInstance request if you're
registering additional instances for the same namespace and service.
CreatorRequestId can be any unique string (for example, a date/time
stamp).
$sel:attributes:Instance', instance_attributes - A string map that contains the following information for the service
that you specify in ServiceId:
- The attributes that apply to the records that are defined in the service.
- For each attribute, the applicable value.
Supported attribute keys include the following:
- AWS_ALIAS_DNS_NAME
- If you want Cloud Map to create a Route 53 alias record that routes
traffic to an Elastic Load Balancing load balancer, specify the DNS
name that's associated with the load balancer. For information
about how to get the DNS name, see
AliasTarget-DNSName>
in the Route 53 API Reference.
Note the following:
- The configuration for the service that's specified by
ServiceIdmust include settings for anArecord, anAAAArecord, or both. - In the service that's specified by
ServiceId, the value ofRoutingPolicymust beWEIGHTED. - If the service that's specified by
ServiceIdincludesHealthCheckConfigsettings, Cloud Map creates the health check, but it won't associate the health check with the alias record. - Auto naming currently doesn't support creating alias records that route traffic to Amazon Web Services resources other than ELB load balancers.
- If you specify a value for
AWS_ALIAS_DNS_NAME, don't specify values for any of theAWS_INSTANCEattributes.
- The configuration for the service that's specified by
- AWS_EC2_INSTANCE_ID
- HTTP namespaces only. The Amazon EC2 instance ID for the instance.
The
AWS_INSTANCE_IPV4attribute contains the primary private IPv4 address. - AWS_INIT_HEALTH_STATUS
- If the service configuration includes
HealthCheckCustomConfig, you can optionally useAWS_INIT_HEALTH_STATUSto specify the initial status of the custom health check,HEALTHYorUNHEALTHY. If you don't specify a value forAWS_INIT_HEALTH_STATUS, the initial status isHEALTHY. - AWS_INSTANCE_CNAME
- If the service configuration includes a
CNAMErecord, the domain name that you want Route 53 to return in response to DNS queries (for example,example.com).This value is required if the service specified by
ServiceIdincludes settings for anCNAMErecord. - AWS_INSTANCE_IPV4
- If the service configuration includes an
Arecord, the IPv4 address that you want Route 53 to return in response to DNS queries (for example,192.0.2.44).This value is required if the service specified by
ServiceIdincludes settings for anArecord. If the service includes settings for anSRVrecord, you must specify a value forAWS_INSTANCE_IPV4,AWS_INSTANCE_IPV6, or both. - AWS_INSTANCE_IPV6
- If the service configuration includes an
AAAArecord, the IPv6 address that you want Route 53 to return in response to DNS queries (for example,2001:0db8:85a3:0000:0000:abcd:0001:2345).This value is required if the service specified by
ServiceIdincludes settings for anAAAArecord. If the service includes settings for anSRVrecord, you must specify a value forAWS_INSTANCE_IPV4,AWS_INSTANCE_IPV6, or both. - AWS_INSTANCE_PORT
- If the service includes an
SRVrecord, the value that you want Route 53 to return for the port.If the service includes
HealthCheckConfig, the port on the endpoint that you want Route 53 to send requests to.This value is required if you specified settings for an
SRVrecord or a Route 53 health check when you created the service.
$sel:id:Instance', instance_id - An identifier that you want to associate with the instance. Note the
following:
- If the service that's specified by
ServiceIdincludes settings for anSRVrecord, the value ofInstanceIdis automatically included as part of the value for theSRVrecord. For more information, see DnsRecord Type>. - You can use this value to update an existing instance.
- To register a new instance, you must specify a value that's unique among instances that you register by using the same service.
If you specify an existing
InstanceIdandServiceId, Cloud Map updates the existing DNS records. If there's also an existing health check, Cloud Map deletes the old health check and creates a new one.The health check isn't deleted immediately, so it will still appear for a while if you submit a
ListHealthChecksrequest, for example.
instance_creatorRequestId :: Lens' Instance (Maybe Text) Source #
A unique string that identifies the request and that allows failed
RegisterInstance requests to be retried without the risk of executing
the operation twice. You must use a unique CreatorRequestId string
every time you submit a RegisterInstance request if you're
registering additional instances for the same namespace and service.
CreatorRequestId can be any unique string (for example, a date/time
stamp).
instance_attributes :: Lens' Instance (Maybe (HashMap Text Text)) Source #
A string map that contains the following information for the service
that you specify in ServiceId:
- The attributes that apply to the records that are defined in the service.
- For each attribute, the applicable value.
Supported attribute keys include the following:
- AWS_ALIAS_DNS_NAME
- If you want Cloud Map to create a Route 53 alias record that routes
traffic to an Elastic Load Balancing load balancer, specify the DNS
name that's associated with the load balancer. For information
about how to get the DNS name, see
AliasTarget-DNSName>
in the Route 53 API Reference.
Note the following:
- The configuration for the service that's specified by
ServiceIdmust include settings for anArecord, anAAAArecord, or both. - In the service that's specified by
ServiceId, the value ofRoutingPolicymust beWEIGHTED. - If the service that's specified by
ServiceIdincludesHealthCheckConfigsettings, Cloud Map creates the health check, but it won't associate the health check with the alias record. - Auto naming currently doesn't support creating alias records that route traffic to Amazon Web Services resources other than ELB load balancers.
- If you specify a value for
AWS_ALIAS_DNS_NAME, don't specify values for any of theAWS_INSTANCEattributes.
- The configuration for the service that's specified by
- AWS_EC2_INSTANCE_ID
- HTTP namespaces only. The Amazon EC2 instance ID for the instance.
The
AWS_INSTANCE_IPV4attribute contains the primary private IPv4 address. - AWS_INIT_HEALTH_STATUS
- If the service configuration includes
HealthCheckCustomConfig, you can optionally useAWS_INIT_HEALTH_STATUSto specify the initial status of the custom health check,HEALTHYorUNHEALTHY. If you don't specify a value forAWS_INIT_HEALTH_STATUS, the initial status isHEALTHY. - AWS_INSTANCE_CNAME
- If the service configuration includes a
CNAMErecord, the domain name that you want Route 53 to return in response to DNS queries (for example,example.com).This value is required if the service specified by
ServiceIdincludes settings for anCNAMErecord. - AWS_INSTANCE_IPV4
- If the service configuration includes an
Arecord, the IPv4 address that you want Route 53 to return in response to DNS queries (for example,192.0.2.44).This value is required if the service specified by
ServiceIdincludes settings for anArecord. If the service includes settings for anSRVrecord, you must specify a value forAWS_INSTANCE_IPV4,AWS_INSTANCE_IPV6, or both. - AWS_INSTANCE_IPV6
- If the service configuration includes an
AAAArecord, the IPv6 address that you want Route 53 to return in response to DNS queries (for example,2001:0db8:85a3:0000:0000:abcd:0001:2345).This value is required if the service specified by
ServiceIdincludes settings for anAAAArecord. If the service includes settings for anSRVrecord, you must specify a value forAWS_INSTANCE_IPV4,AWS_INSTANCE_IPV6, or both. - AWS_INSTANCE_PORT
- If the service includes an
SRVrecord, the value that you want Route 53 to return for the port.If the service includes
HealthCheckConfig, the port on the endpoint that you want Route 53 to send requests to.This value is required if you specified settings for an
SRVrecord or a Route 53 health check when you created the service.
instance_id :: Lens' Instance Text Source #
An identifier that you want to associate with the instance. Note the following:
- If the service that's specified by
ServiceIdincludes settings for anSRVrecord, the value ofInstanceIdis automatically included as part of the value for theSRVrecord. For more information, see DnsRecord Type>. - You can use this value to update an existing instance.
- To register a new instance, you must specify a value that's unique among instances that you register by using the same service.
If you specify an existing
InstanceIdandServiceId, Cloud Map updates the existing DNS records. If there's also an existing health check, Cloud Map deletes the old health check and creates a new one.The health check isn't deleted immediately, so it will still appear for a while if you submit a
ListHealthChecksrequest, for example.
InstanceSummary
data InstanceSummary Source #
A complex type that contains information about the instances that you registered by using a specified service.
See: newInstanceSummary smart constructor.
Constructors
| InstanceSummary' | |
Fields
| |
Instances
newInstanceSummary :: InstanceSummary Source #
Create a value of InstanceSummary 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:attributes:InstanceSummary', instanceSummary_attributes - A string map that contains the following information:
- The attributes that are associated with the instance.
- For each attribute, the applicable value.
Supported attribute keys include the following:
- AWS_ALIAS_DNS_NAME
- For an alias record that routes traffic to an Elastic Load Balancing load balancer, the DNS name that's associated with the load balancer.
- AWS_EC2_INSTANCE_ID (HTTP namespaces only)
- The Amazon EC2 instance ID for the instance. When the
AWS_EC2_INSTANCE_IDattribute is specified, then theAWS_INSTANCE_IPV4attribute contains the primary private IPv4 address. - AWS_INIT_HEALTH_STATUS
- If the service configuration includes
HealthCheckCustomConfig, you can optionally useAWS_INIT_HEALTH_STATUSto specify the initial status of the custom health check,HEALTHYorUNHEALTHY. If you don't specify a value forAWS_INIT_HEALTH_STATUS, the initial status isHEALTHY. - AWS_INSTANCE_CNAME
- For a
CNAMErecord, the domain name that Route 53 returns in response to DNS queries (for example,example.com). - AWS_INSTANCE_IPV4
- For an
Arecord, the IPv4 address that Route 53 returns in response to DNS queries (for example,192.0.2.44). - AWS_INSTANCE_IPV6
- For an
AAAArecord, the IPv6 address that Route 53 returns in response to DNS queries (for example,2001:0db8:85a3:0000:0000:abcd:0001:2345). - AWS_INSTANCE_PORT
- For an
SRVrecord, the value that Route 53 returns for the port. In addition, if the service includesHealthCheckConfig, the port on the endpoint that Route 53 sends requests to.
$sel:id:InstanceSummary', instanceSummary_id - The ID for an instance that you created by using a specified service.
instanceSummary_attributes :: Lens' InstanceSummary (Maybe (HashMap Text Text)) Source #
A string map that contains the following information:
- The attributes that are associated with the instance.
- For each attribute, the applicable value.
Supported attribute keys include the following:
- AWS_ALIAS_DNS_NAME
- For an alias record that routes traffic to an Elastic Load Balancing load balancer, the DNS name that's associated with the load balancer.
- AWS_EC2_INSTANCE_ID (HTTP namespaces only)
- The Amazon EC2 instance ID for the instance. When the
AWS_EC2_INSTANCE_IDattribute is specified, then theAWS_INSTANCE_IPV4attribute contains the primary private IPv4 address. - AWS_INIT_HEALTH_STATUS
- If the service configuration includes
HealthCheckCustomConfig, you can optionally useAWS_INIT_HEALTH_STATUSto specify the initial status of the custom health check,HEALTHYorUNHEALTHY. If you don't specify a value forAWS_INIT_HEALTH_STATUS, the initial status isHEALTHY. - AWS_INSTANCE_CNAME
- For a
CNAMErecord, the domain name that Route 53 returns in response to DNS queries (for example,example.com). - AWS_INSTANCE_IPV4
- For an
Arecord, the IPv4 address that Route 53 returns in response to DNS queries (for example,192.0.2.44). - AWS_INSTANCE_IPV6
- For an
AAAArecord, the IPv6 address that Route 53 returns in response to DNS queries (for example,2001:0db8:85a3:0000:0000:abcd:0001:2345). - AWS_INSTANCE_PORT
- For an
SRVrecord, the value that Route 53 returns for the port. In addition, if the service includesHealthCheckConfig, the port on the endpoint that Route 53 sends requests to.
instanceSummary_id :: Lens' InstanceSummary (Maybe Text) Source #
The ID for an instance that you created by using a specified service.
Namespace
A complex type that contains information about a specified namespace.
See: newNamespace smart constructor.
Constructors
| Namespace' | |
Fields
| |
Instances
newNamespace :: Namespace Source #
Create a value of Namespace 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:arn:Namespace', namespace_arn - The Amazon Resource Name (ARN) that Cloud Map assigns to the namespace
when you create it.
$sel:creatorRequestId:Namespace', namespace_creatorRequestId - A unique string that identifies the request and that allows failed
requests to be retried without the risk of running an operation twice.
$sel:createDate:Namespace', namespace_createDate - The date that the namespace was created, in Unix date/time format and
Coordinated Universal Time (UTC). The value of CreateDate is accurate
to milliseconds. For example, the value 1516925490.087 represents
Friday, January 26, 2018 12:11:30.087 AM.
$sel:serviceCount:Namespace', namespace_serviceCount - The number of services that are associated with the namespace.
$sel:name:Namespace', namespace_name - The name of the namespace, such as example.com.
$sel:id:Namespace', namespace_id - The ID of a namespace.
$sel:type':Namespace', namespace_type - The type of the namespace. The methods for discovering instances depends
on the value that you specify:
- HTTP
- Instances can be discovered only programmatically, using the Cloud
Map
DiscoverInstancesAPI. - DNS_PUBLIC
- Instances can be discovered using public DNS queries and using the
DiscoverInstancesAPI. - DNS_PRIVATE
- Instances can be discovered using DNS queries in VPCs and using the
DiscoverInstancesAPI.
$sel:description:Namespace', namespace_description - The description that you specify for the namespace when you create it.
$sel:properties:Namespace', namespace_properties - A complex type that contains information that's specific to the type of
the namespace.
namespace_arn :: Lens' Namespace (Maybe Text) Source #
The Amazon Resource Name (ARN) that Cloud Map assigns to the namespace when you create it.
namespace_creatorRequestId :: Lens' Namespace (Maybe Text) Source #
A unique string that identifies the request and that allows failed requests to be retried without the risk of running an operation twice.
namespace_createDate :: Lens' Namespace (Maybe UTCTime) Source #
The date that the namespace was created, in Unix date/time format and
Coordinated Universal Time (UTC). The value of CreateDate is accurate
to milliseconds. For example, the value 1516925490.087 represents
Friday, January 26, 2018 12:11:30.087 AM.
namespace_serviceCount :: Lens' Namespace (Maybe Int) Source #
The number of services that are associated with the namespace.
namespace_name :: Lens' Namespace (Maybe Text) Source #
The name of the namespace, such as example.com.
namespace_type :: Lens' Namespace (Maybe NamespaceType) Source #
The type of the namespace. The methods for discovering instances depends on the value that you specify:
- HTTP
- Instances can be discovered only programmatically, using the Cloud
Map
DiscoverInstancesAPI. - DNS_PUBLIC
- Instances can be discovered using public DNS queries and using the
DiscoverInstancesAPI. - DNS_PRIVATE
- Instances can be discovered using DNS queries in VPCs and using the
DiscoverInstancesAPI.
namespace_description :: Lens' Namespace (Maybe Text) Source #
The description that you specify for the namespace when you create it.
namespace_properties :: Lens' Namespace (Maybe NamespaceProperties) Source #
A complex type that contains information that's specific to the type of the namespace.
NamespaceFilter
data NamespaceFilter Source #
A complex type that identifies the namespaces that you want to list. You can choose to list public or private namespaces.
See: newNamespaceFilter smart constructor.
Constructors
| NamespaceFilter' | |
Fields
| |
Instances
Arguments
| :: NamespaceFilterName | |
| -> NamespaceFilter |
Create a value of NamespaceFilter 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:condition:NamespaceFilter', namespaceFilter_condition - The operator that you want to use to determine whether ListNamespaces
returns a namespace. Valid values for condition include:
- EQ
- When you specify
EQfor the condition, you can choose to list only public namespaces or private namespaces, but not both.EQis the default condition and can be omitted. - IN
- When you specify
INfor the condition, you can choose to list public namespaces, private namespaces, or both. - BETWEEN
- Not applicable
$sel:name:NamespaceFilter', namespaceFilter_name - Specify TYPE.
$sel:values:NamespaceFilter', namespaceFilter_values - If you specify EQ for Condition, specify either DNS_PUBLIC or
DNS_PRIVATE.
If you specify IN for Condition, you can specify DNS_PUBLIC,
DNS_PRIVATE, or both.
namespaceFilter_condition :: Lens' NamespaceFilter (Maybe FilterCondition) Source #
The operator that you want to use to determine whether ListNamespaces
returns a namespace. Valid values for condition include:
- EQ
- When you specify
EQfor the condition, you can choose to list only public namespaces or private namespaces, but not both.EQis the default condition and can be omitted. - IN
- When you specify
INfor the condition, you can choose to list public namespaces, private namespaces, or both. - BETWEEN
- Not applicable
namespaceFilter_name :: Lens' NamespaceFilter NamespaceFilterName Source #
Specify TYPE.
namespaceFilter_values :: Lens' NamespaceFilter [Text] Source #
If you specify EQ for Condition, specify either DNS_PUBLIC or
DNS_PRIVATE.
If you specify IN for Condition, you can specify DNS_PUBLIC,
DNS_PRIVATE, or both.
NamespaceProperties
data NamespaceProperties Source #
A complex type that contains information that's specific to the namespace type.
See: newNamespaceProperties smart constructor.
Constructors
| NamespaceProperties' | |
Fields
| |
Instances
newNamespaceProperties :: NamespaceProperties Source #
Create a value of NamespaceProperties 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:dnsProperties:NamespaceProperties', namespaceProperties_dnsProperties - A complex type that contains the ID for the Route 53 hosted zone that
Cloud Map creates when you create a namespace.
$sel:httpProperties:NamespaceProperties', namespaceProperties_httpProperties - A complex type that contains the name of an HTTP namespace.
namespaceProperties_dnsProperties :: Lens' NamespaceProperties (Maybe DnsProperties) Source #
A complex type that contains the ID for the Route 53 hosted zone that Cloud Map creates when you create a namespace.
namespaceProperties_httpProperties :: Lens' NamespaceProperties (Maybe HttpProperties) Source #
A complex type that contains the name of an HTTP namespace.
NamespaceSummary
data NamespaceSummary Source #
A complex type that contains information about a namespace.
See: newNamespaceSummary smart constructor.
Constructors
| NamespaceSummary' | |
Fields
| |
Instances
newNamespaceSummary :: NamespaceSummary Source #
Create a value of NamespaceSummary 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:arn:NamespaceSummary', namespaceSummary_arn - The Amazon Resource Name (ARN) that Cloud Map assigns to the namespace
when you create it.
$sel:createDate:NamespaceSummary', namespaceSummary_createDate - The date and time that the namespace was created.
$sel:serviceCount:NamespaceSummary', namespaceSummary_serviceCount - The number of services that were created using the namespace.
$sel:name:NamespaceSummary', namespaceSummary_name - The name of the namespace. When you create a namespace, Cloud Map
automatically creates a Route 53 hosted zone that has the same name as
the namespace.
$sel:id:NamespaceSummary', namespaceSummary_id - The ID of the namespace.
$sel:type':NamespaceSummary', namespaceSummary_type - The type of the namespace, either public or private.
$sel:description:NamespaceSummary', namespaceSummary_description - A description for the namespace.
$sel:properties:NamespaceSummary', namespaceSummary_properties - The properties of the namespace.
namespaceSummary_arn :: Lens' NamespaceSummary (Maybe Text) Source #
The Amazon Resource Name (ARN) that Cloud Map assigns to the namespace when you create it.
namespaceSummary_createDate :: Lens' NamespaceSummary (Maybe UTCTime) Source #
The date and time that the namespace was created.
namespaceSummary_serviceCount :: Lens' NamespaceSummary (Maybe Int) Source #
The number of services that were created using the namespace.
namespaceSummary_name :: Lens' NamespaceSummary (Maybe Text) Source #
The name of the namespace. When you create a namespace, Cloud Map automatically creates a Route 53 hosted zone that has the same name as the namespace.
namespaceSummary_id :: Lens' NamespaceSummary (Maybe Text) Source #
The ID of the namespace.
namespaceSummary_type :: Lens' NamespaceSummary (Maybe NamespaceType) Source #
The type of the namespace, either public or private.
namespaceSummary_description :: Lens' NamespaceSummary (Maybe Text) Source #
A description for the namespace.
namespaceSummary_properties :: Lens' NamespaceSummary (Maybe NamespaceProperties) Source #
The properties of the namespace.
Operation
A complex type that contains information about a specified operation.
See: newOperation smart constructor.
Constructors
| Operation' | |
Fields
| |
Instances
newOperation :: Operation Source #
Create a value of Operation 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:Operation', operation_status - The status of the operation. Values include the following:
- SUBMITTED
- This is the initial state that occurs immediately after you submit a request.
- PENDING
- Cloud Map is performing the operation.
- SUCCESS
- The operation succeeded.
- FAIL
- The operation failed. For the failure reason, see
ErrorMessage.
$sel:updateDate:Operation', operation_updateDate - The date and time that the value of Status changed to the current
value, in Unix date/time format and Coordinated Universal Time (UTC).
The value of UpdateDate is accurate to milliseconds. For example, the
value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087
AM.
$sel:createDate:Operation', operation_createDate - The date and time that the request was submitted, in Unix date/time
format and Coordinated Universal Time (UTC). The value of CreateDate
is accurate to milliseconds. For example, the value 1516925490.087
represents Friday, January 26, 2018 12:11:30.087 AM.
$sel:targets:Operation', operation_targets - The name of the target entity that's associated with the operation:
- NAMESPACE
- The namespace ID is returned in the
ResourceIdproperty. - SERVICE
- The service ID is returned in the
ResourceIdproperty. - INSTANCE
- The instance ID is returned in the
ResourceIdproperty.
$sel:errorCode:Operation', operation_errorCode - The code associated with ErrorMessage. Values for ErrorCode include
the following:
ACCESS_DENIED
CANNOT_CREATE_HOSTED_ZONE
EXPIRED_TOKEN
HOSTED_ZONE_NOT_FOUND
INTERNAL_FAILURE
INVALID_CHANGE_BATCH
THROTTLED_REQUEST
$sel:id:Operation', operation_id - The ID of the operation that you want to get information about.
$sel:type':Operation', operation_type - The name of the operation that's associated with the specified ID.
$sel:errorMessage:Operation', operation_errorMessage - If the value of Status is FAIL, the reason that the operation
failed.
operation_status :: Lens' Operation (Maybe OperationStatus) Source #
The status of the operation. Values include the following:
- SUBMITTED
- This is the initial state that occurs immediately after you submit a request.
- PENDING
- Cloud Map is performing the operation.
- SUCCESS
- The operation succeeded.
- FAIL
- The operation failed. For the failure reason, see
ErrorMessage.
operation_updateDate :: Lens' Operation (Maybe UTCTime) Source #
The date and time that the value of Status changed to the current
value, in Unix date/time format and Coordinated Universal Time (UTC).
The value of UpdateDate is accurate to milliseconds. For example, the
value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087
AM.
operation_createDate :: Lens' Operation (Maybe UTCTime) Source #
The date and time that the request was submitted, in Unix date/time
format and Coordinated Universal Time (UTC). The value of CreateDate
is accurate to milliseconds. For example, the value 1516925490.087
represents Friday, January 26, 2018 12:11:30.087 AM.
operation_targets :: Lens' Operation (Maybe (HashMap OperationTargetType Text)) Source #
The name of the target entity that's associated with the operation:
- NAMESPACE
- The namespace ID is returned in the
ResourceIdproperty. - SERVICE
- The service ID is returned in the
ResourceIdproperty. - INSTANCE
- The instance ID is returned in the
ResourceIdproperty.
operation_errorCode :: Lens' Operation (Maybe Text) Source #
The code associated with ErrorMessage. Values for ErrorCode include
the following:
ACCESS_DENIED
CANNOT_CREATE_HOSTED_ZONE
EXPIRED_TOKEN
HOSTED_ZONE_NOT_FOUND
INTERNAL_FAILURE
INVALID_CHANGE_BATCH
THROTTLED_REQUEST
operation_id :: Lens' Operation (Maybe Text) Source #
The ID of the operation that you want to get information about.
operation_type :: Lens' Operation (Maybe OperationType) Source #
The name of the operation that's associated with the specified ID.
operation_errorMessage :: Lens' Operation (Maybe Text) Source #
If the value of Status is FAIL, the reason that the operation
failed.
OperationFilter
data OperationFilter Source #
A complex type that lets you select the operations that you want to list.
See: newOperationFilter smart constructor.
Constructors
| OperationFilter' | |
Fields
| |
Instances
Arguments
| :: OperationFilterName | |
| -> OperationFilter |
Create a value of OperationFilter 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:condition:OperationFilter', operationFilter_condition - The operator that you want to use to determine whether an operation
matches the specified value. Valid values for condition include:
EQ: When you specifyEQfor the condition, you can specify only one value.EQis supported forNAMESPACE_ID,SERVICE_ID,STATUS, andTYPE.EQis the default condition and can be omitted.IN: When you specifyINfor the condition, you can specify a list of one or more values.INis supported forSTATUSandTYPE. An operation must match one of the specified values to be returned in the response.BETWEEN: Specify a start date and an end date in Unix date/time format and Coordinated Universal Time (UTC). The start date must be the first value.BETWEENis supported forUPDATE_DATE.
$sel:name:OperationFilter', operationFilter_name - Specify the operations that you want to get:
- NAMESPACE_ID: Gets operations related to specified namespaces.
- SERVICE_ID: Gets operations related to specified services.
- STATUS: Gets operations based on the status of the operations:
SUBMITTED,PENDING,SUCCEED, orFAIL. - TYPE: Gets specified types of operation.
- UPDATE_DATE: Gets operations that changed status during a specified date/time range.
$sel:values:OperationFilter', operationFilter_values - Specify values that are applicable to the value that you specify for
Name:
- NAMESPACE_ID: Specify one namespace ID.
- SERVICE_ID: Specify one service ID.
- STATUS: Specify one or more statuses:
SUBMITTED,PENDING,SUCCEED, orFAIL. - TYPE: Specify one or more of the following types:
CREATE_NAMESPACE,DELETE_NAMESPACE,UPDATE_SERVICE,REGISTER_INSTANCE, orDEREGISTER_INSTANCE. - UPDATE_DATE: Specify a start date and an end date in Unix date/time format and Coordinated Universal Time (UTC). The start date must be the first value.
operationFilter_condition :: Lens' OperationFilter (Maybe FilterCondition) Source #
The operator that you want to use to determine whether an operation matches the specified value. Valid values for condition include:
EQ: When you specifyEQfor the condition, you can specify only one value.EQis supported forNAMESPACE_ID,SERVICE_ID,STATUS, andTYPE.EQis the default condition and can be omitted.IN: When you specifyINfor the condition, you can specify a list of one or more values.INis supported forSTATUSandTYPE. An operation must match one of the specified values to be returned in the response.BETWEEN: Specify a start date and an end date in Unix date/time format and Coordinated Universal Time (UTC). The start date must be the first value.BETWEENis supported forUPDATE_DATE.
operationFilter_name :: Lens' OperationFilter OperationFilterName Source #
Specify the operations that you want to get:
- NAMESPACE_ID: Gets operations related to specified namespaces.
- SERVICE_ID: Gets operations related to specified services.
- STATUS: Gets operations based on the status of the operations:
SUBMITTED,PENDING,SUCCEED, orFAIL. - TYPE: Gets specified types of operation.
- UPDATE_DATE: Gets operations that changed status during a specified date/time range.
operationFilter_values :: Lens' OperationFilter [Text] Source #
Specify values that are applicable to the value that you specify for
Name:
- NAMESPACE_ID: Specify one namespace ID.
- SERVICE_ID: Specify one service ID.
- STATUS: Specify one or more statuses:
SUBMITTED,PENDING,SUCCEED, orFAIL. - TYPE: Specify one or more of the following types:
CREATE_NAMESPACE,DELETE_NAMESPACE,UPDATE_SERVICE,REGISTER_INSTANCE, orDEREGISTER_INSTANCE. - UPDATE_DATE: Specify a start date and an end date in Unix date/time format and Coordinated Universal Time (UTC). The start date must be the first value.
OperationSummary
data OperationSummary Source #
A complex type that contains information about an operation that matches the criteria that you specified in a ListOperations request.
See: newOperationSummary smart constructor.
Constructors
| OperationSummary' | |
Fields
| |
Instances
newOperationSummary :: OperationSummary Source #
Create a value of OperationSummary 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:OperationSummary', operationSummary_status - The status of the operation. Values include the following:
- SUBMITTED: This is the initial state immediately after you submit a request.
- PENDING: Cloud Map is performing the operation.
- SUCCESS: The operation succeeded.
- FAIL: The operation failed. For the failure reason, see
ErrorMessage.
$sel:id:OperationSummary', operationSummary_id - The ID for an operation.
operationSummary_status :: Lens' OperationSummary (Maybe OperationStatus) Source #
The status of the operation. Values include the following:
- SUBMITTED: This is the initial state immediately after you submit a request.
- PENDING: Cloud Map is performing the operation.
- SUCCESS: The operation succeeded.
- FAIL: The operation failed. For the failure reason, see
ErrorMessage.
operationSummary_id :: Lens' OperationSummary (Maybe Text) Source #
The ID for an operation.
PrivateDnsNamespaceChange
data PrivateDnsNamespaceChange Source #
Updated properties for the private DNS namespace.
See: newPrivateDnsNamespaceChange smart constructor.
Constructors
| PrivateDnsNamespaceChange' | |
Fields
| |
Instances
newPrivateDnsNamespaceChange :: PrivateDnsNamespaceChange Source #
Create a value of PrivateDnsNamespaceChange 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:description:PrivateDnsNamespaceChange', privateDnsNamespaceChange_description - An updated description for the private DNS namespace.
$sel:properties:PrivateDnsNamespaceChange', privateDnsNamespaceChange_properties - Properties to be updated in the private DNS namespace.
privateDnsNamespaceChange_description :: Lens' PrivateDnsNamespaceChange (Maybe Text) Source #
An updated description for the private DNS namespace.
privateDnsNamespaceChange_properties :: Lens' PrivateDnsNamespaceChange (Maybe PrivateDnsNamespacePropertiesChange) Source #
Properties to be updated in the private DNS namespace.
PrivateDnsNamespaceProperties
data PrivateDnsNamespaceProperties Source #
DNS properties for the private DNS namespace.
See: newPrivateDnsNamespaceProperties smart constructor.
Constructors
| PrivateDnsNamespaceProperties' | |
Fields
| |
Instances
newPrivateDnsNamespaceProperties Source #
Arguments
| :: PrivateDnsPropertiesMutable | |
| -> PrivateDnsNamespaceProperties |
Create a value of PrivateDnsNamespaceProperties 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:dnsProperties:PrivateDnsNamespaceProperties', privateDnsNamespaceProperties_dnsProperties - DNS properties for the private DNS namespace.
privateDnsNamespaceProperties_dnsProperties :: Lens' PrivateDnsNamespaceProperties PrivateDnsPropertiesMutable Source #
DNS properties for the private DNS namespace.
PrivateDnsNamespacePropertiesChange
data PrivateDnsNamespacePropertiesChange Source #
Updated properties for the private DNS namespace.
See: newPrivateDnsNamespacePropertiesChange smart constructor.
Constructors
| PrivateDnsNamespacePropertiesChange' | |
Fields
| |
Instances
newPrivateDnsNamespacePropertiesChange Source #
Create a value of PrivateDnsNamespacePropertiesChange 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:dnsProperties:PrivateDnsNamespacePropertiesChange', privateDnsNamespacePropertiesChange_dnsProperties - Updated DNS properties for the private DNS namespace.
privateDnsNamespacePropertiesChange_dnsProperties :: Lens' PrivateDnsNamespacePropertiesChange PrivateDnsPropertiesMutableChange Source #
Updated DNS properties for the private DNS namespace.
PrivateDnsPropertiesMutable
data PrivateDnsPropertiesMutable Source #
DNS properties for the private DNS namespace.
See: newPrivateDnsPropertiesMutable smart constructor.
Constructors
| PrivateDnsPropertiesMutable' | |
Instances
newPrivateDnsPropertiesMutable Source #
Create a value of PrivateDnsPropertiesMutable 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:soa:PrivateDnsPropertiesMutable', privateDnsPropertiesMutable_soa - Fields for the Start of Authority (SOA) record for the hosted zone for
the private DNS namespace.
privateDnsPropertiesMutable_soa :: Lens' PrivateDnsPropertiesMutable SOA Source #
Fields for the Start of Authority (SOA) record for the hosted zone for the private DNS namespace.
PrivateDnsPropertiesMutableChange
data PrivateDnsPropertiesMutableChange Source #
Updated DNS properties for the private DNS namespace.
See: newPrivateDnsPropertiesMutableChange smart constructor.
Constructors
| PrivateDnsPropertiesMutableChange' | |
Instances
newPrivateDnsPropertiesMutableChange Source #
Arguments
| :: SOAChange | |
| -> PrivateDnsPropertiesMutableChange |
Create a value of PrivateDnsPropertiesMutableChange 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:soa:PrivateDnsPropertiesMutableChange', privateDnsPropertiesMutableChange_soa - Updated fields for the Start of Authority (SOA) record for the hosted
zone for the private DNS namespace.
privateDnsPropertiesMutableChange_soa :: Lens' PrivateDnsPropertiesMutableChange SOAChange Source #
Updated fields for the Start of Authority (SOA) record for the hosted zone for the private DNS namespace.
PublicDnsNamespaceChange
data PublicDnsNamespaceChange Source #
Updated properties for the public DNS namespace.
See: newPublicDnsNamespaceChange smart constructor.
Constructors
| PublicDnsNamespaceChange' | |
Fields
| |
Instances
newPublicDnsNamespaceChange :: PublicDnsNamespaceChange Source #
Create a value of PublicDnsNamespaceChange 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:description:PublicDnsNamespaceChange', publicDnsNamespaceChange_description - An updated description for the public DNS namespace.
$sel:properties:PublicDnsNamespaceChange', publicDnsNamespaceChange_properties - Properties to be updated in the public DNS namespace.
publicDnsNamespaceChange_description :: Lens' PublicDnsNamespaceChange (Maybe Text) Source #
An updated description for the public DNS namespace.
publicDnsNamespaceChange_properties :: Lens' PublicDnsNamespaceChange (Maybe PublicDnsNamespacePropertiesChange) Source #
Properties to be updated in the public DNS namespace.
PublicDnsNamespaceProperties
data PublicDnsNamespaceProperties Source #
DNS properties for the public DNS namespace.
See: newPublicDnsNamespaceProperties smart constructor.
Constructors
| PublicDnsNamespaceProperties' | |
Fields
| |
Instances
newPublicDnsNamespaceProperties Source #
Arguments
| :: PublicDnsPropertiesMutable | |
| -> PublicDnsNamespaceProperties |
Create a value of PublicDnsNamespaceProperties 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:dnsProperties:PublicDnsNamespaceProperties', publicDnsNamespaceProperties_dnsProperties - DNS properties for the public DNS namespace.
publicDnsNamespaceProperties_dnsProperties :: Lens' PublicDnsNamespaceProperties PublicDnsPropertiesMutable Source #
DNS properties for the public DNS namespace.
PublicDnsNamespacePropertiesChange
data PublicDnsNamespacePropertiesChange Source #
Updated properties for the public DNS namespace.
See: newPublicDnsNamespacePropertiesChange smart constructor.
Constructors
| PublicDnsNamespacePropertiesChange' | |
Fields
| |
Instances
newPublicDnsNamespacePropertiesChange Source #
Create a value of PublicDnsNamespacePropertiesChange 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:dnsProperties:PublicDnsNamespacePropertiesChange', publicDnsNamespacePropertiesChange_dnsProperties - Updated DNS properties for the hosted zone for the public DNS namespace.
publicDnsNamespacePropertiesChange_dnsProperties :: Lens' PublicDnsNamespacePropertiesChange PublicDnsPropertiesMutableChange Source #
Updated DNS properties for the hosted zone for the public DNS namespace.
PublicDnsPropertiesMutable
data PublicDnsPropertiesMutable Source #
DNS properties for the public DNS namespace.
See: newPublicDnsPropertiesMutable smart constructor.
Constructors
| PublicDnsPropertiesMutable' | |
Instances
newPublicDnsPropertiesMutable Source #
Create a value of PublicDnsPropertiesMutable 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:soa:PublicDnsPropertiesMutable', publicDnsPropertiesMutable_soa - Start of Authority (SOA) record for the hosted zone for the public DNS
namespace.
publicDnsPropertiesMutable_soa :: Lens' PublicDnsPropertiesMutable SOA Source #
Start of Authority (SOA) record for the hosted zone for the public DNS namespace.
PublicDnsPropertiesMutableChange
data PublicDnsPropertiesMutableChange Source #
Updated DNS properties for the public DNS namespace.
See: newPublicDnsPropertiesMutableChange smart constructor.
Constructors
| PublicDnsPropertiesMutableChange' | |
Instances
newPublicDnsPropertiesMutableChange Source #
Create a value of PublicDnsPropertiesMutableChange 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:soa:PublicDnsPropertiesMutableChange', publicDnsPropertiesMutableChange_soa - Updated fields for the Start of Authority (SOA) record for the hosted
zone for the public DNS namespace.
publicDnsPropertiesMutableChange_soa :: Lens' PublicDnsPropertiesMutableChange SOAChange Source #
Updated fields for the Start of Authority (SOA) record for the hosted zone for the public DNS namespace.
SOA
Start of Authority (SOA) properties for a public or private DNS namespace.
See: newSOA smart constructor.
Instances
| Eq SOA Source # | |
| Read SOA Source # | |
| Show SOA Source # | |
| Generic SOA Source # | |
| NFData SOA Source # | |
Defined in Amazonka.Route53AutoNaming.Types.SOA | |
| Hashable SOA Source # | |
Defined in Amazonka.Route53AutoNaming.Types.SOA | |
| ToJSON SOA Source # | |
Defined in Amazonka.Route53AutoNaming.Types.SOA | |
| FromJSON SOA Source # | |
| type Rep SOA Source # | |
Defined in Amazonka.Route53AutoNaming.Types.SOA | |
Create a value of SOA 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:SOA', soa_ttl - The time to live (TTL) for purposes of negative caching.
SOAChange
Updated Start of Authority (SOA) properties for a public or private DNS namespace.
See: newSOAChange smart constructor.
Constructors
| SOAChange' | |
Instances
| Eq SOAChange Source # | |
| Read SOAChange Source # | |
| Show SOAChange Source # | |
| Generic SOAChange Source # | |
| NFData SOAChange Source # | |
Defined in Amazonka.Route53AutoNaming.Types.SOAChange | |
| Hashable SOAChange Source # | |
Defined in Amazonka.Route53AutoNaming.Types.SOAChange | |
| ToJSON SOAChange Source # | |
Defined in Amazonka.Route53AutoNaming.Types.SOAChange | |
| type Rep SOAChange Source # | |
Defined in Amazonka.Route53AutoNaming.Types.SOAChange type Rep SOAChange = D1 ('MetaData "SOAChange" "Amazonka.Route53AutoNaming.Types.SOAChange" "libZSservicesZSamazonka-route53-autonamingZSamazonka-route53-autonaming" 'False) (C1 ('MetaCons "SOAChange'" 'PrefixI 'True) (S1 ('MetaSel ('Just "ttl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Natural))) | |
Create a value of SOAChange 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:SOAChange', sOAChange_ttl - The updated time to live (TTL) for purposes of negative caching.
sOAChange_ttl :: Lens' SOAChange Natural Source #
The updated time to live (TTL) for purposes of negative caching.
ServiceChange
data ServiceChange Source #
A complex type that contains changes to an existing service.
See: newServiceChange smart constructor.
Constructors
| ServiceChange' | |
Fields
| |
Instances
newServiceChange :: ServiceChange Source #
Create a value of ServiceChange 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:healthCheckConfig:ServiceChange', serviceChange_healthCheckConfig - Public DNS and HTTP namespaces only. Settings for an optional health
check. If you specify settings for a health check, Cloud Map associates
the health check with the records that you specify in DnsConfig.
$sel:dnsConfig:ServiceChange', serviceChange_dnsConfig - Information about the Route 53 DNS records that you want Cloud Map to
create when you register an instance.
$sel:description:ServiceChange', serviceChange_description - A description for the service.
serviceChange_healthCheckConfig :: Lens' ServiceChange (Maybe HealthCheckConfig) Source #
Public DNS and HTTP namespaces only. Settings for an optional health
check. If you specify settings for a health check, Cloud Map associates
the health check with the records that you specify in DnsConfig.
serviceChange_dnsConfig :: Lens' ServiceChange (Maybe DnsConfigChange) Source #
Information about the Route 53 DNS records that you want Cloud Map to create when you register an instance.
serviceChange_description :: Lens' ServiceChange (Maybe Text) Source #
A description for the service.
ServiceFilter
data ServiceFilter Source #
A complex type that lets you specify the namespaces that you want to list services for.
See: newServiceFilter smart constructor.
Constructors
| ServiceFilter' | |
Fields
| |
Instances
Arguments
| :: ServiceFilterName | |
| -> ServiceFilter |
Create a value of ServiceFilter 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:condition:ServiceFilter', serviceFilter_condition - The operator that you want to use to determine whether a service is
returned by ListServices. Valid values for Condition include the
following:
EQ: When you specifyEQ, specify one namespace ID forValues.EQis the default condition and can be omitted.IN: When you specifyIN, specify a list of the IDs for the namespaces that you wantListServicesto return a list of services for.BETWEEN: Not applicable.
$sel:name:ServiceFilter', serviceFilter_name - Specify NAMESPACE_ID.
$sel:values:ServiceFilter', serviceFilter_values - The values that are applicable to the value that you specify for
Condition to filter the list of services.
serviceFilter_condition :: Lens' ServiceFilter (Maybe FilterCondition) Source #
The operator that you want to use to determine whether a service is
returned by ListServices. Valid values for Condition include the
following:
EQ: When you specifyEQ, specify one namespace ID forValues.EQis the default condition and can be omitted.IN: When you specifyIN, specify a list of the IDs for the namespaces that you wantListServicesto return a list of services for.BETWEEN: Not applicable.
serviceFilter_name :: Lens' ServiceFilter ServiceFilterName Source #
Specify NAMESPACE_ID.
serviceFilter_values :: Lens' ServiceFilter [Text] Source #
The values that are applicable to the value that you specify for
Condition to filter the list of services.
ServiceInfo
data ServiceInfo Source #
A complex type that contains information about the specified service.
See: newServiceInfo smart constructor.
Constructors
| ServiceInfo' | |
Fields
| |
Instances
newServiceInfo :: ServiceInfo Source #
Create a value of ServiceInfo 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:instanceCount:ServiceInfo', serviceInfo_instanceCount - The number of instances that are currently associated with the service.
Instances that were previously associated with the service but that are
deleted aren't included in the count. The count might not reflect
pending registrations and deregistrations.
$sel:arn:ServiceInfo', serviceInfo_arn - The Amazon Resource Name (ARN) that Cloud Map assigns to the service
when you create it.
$sel:healthCheckConfig:ServiceInfo', serviceInfo_healthCheckConfig - Public DNS and HTTP namespaces only. A complex type that contains
settings for an optional health check. If you specify settings for a
health check, Cloud Map associates the health check with the records
that you specify in DnsConfig.
For information about the charges for health checks, see Amazon Route 53 Pricing.
$sel:creatorRequestId:ServiceInfo', serviceInfo_creatorRequestId - A unique string that identifies the request and that allows failed
requests to be retried without the risk of running the operation twice.
CreatorRequestId can be any unique string (for example, a
date/timestamp).
$sel:createDate:ServiceInfo', serviceInfo_createDate - The date and time that the service was created, in Unix format and
Coordinated Universal Time (UTC). The value of CreateDate is accurate
to milliseconds. For example, the value 1516925490.087 represents
Friday, January 26, 2018 12:11:30.087 AM.
$sel:healthCheckCustomConfig:ServiceInfo', serviceInfo_healthCheckCustomConfig - A complex type that contains information about an optional custom health
check.
If you specify a health check configuration, you can specify either
HealthCheckCustomConfig or HealthCheckConfig but not both.
$sel:namespaceId:ServiceInfo', serviceInfo_namespaceId - The ID of the namespace that was used to create the service.
$sel:name:ServiceInfo', serviceInfo_name - The name of the service.
$sel:id:ServiceInfo', serviceInfo_id - The ID that Cloud Map assigned to the service when you created it.
$sel:type':ServiceInfo', serviceInfo_type - Describes the systems that can be used to discover the service
instances.
- DNS_HTTP
- The service instances can be discovered using either DNS queries or
the
DiscoverInstancesAPI operation. - HTTP
- The service instances can only be discovered using the
DiscoverInstancesAPI operation. - DNS
- Reserved.
$sel:dnsConfig:ServiceInfo', serviceInfo_dnsConfig - A complex type that contains information about the Route 53 DNS records
that you want Cloud Map to create when you register an instance.
$sel:description:ServiceInfo', serviceInfo_description - The description of the service.
serviceInfo_instanceCount :: Lens' ServiceInfo (Maybe Int) Source #
The number of instances that are currently associated with the service. Instances that were previously associated with the service but that are deleted aren't included in the count. The count might not reflect pending registrations and deregistrations.
serviceInfo_arn :: Lens' ServiceInfo (Maybe Text) Source #
The Amazon Resource Name (ARN) that Cloud Map assigns to the service when you create it.
serviceInfo_healthCheckConfig :: Lens' ServiceInfo (Maybe HealthCheckConfig) Source #
Public DNS and HTTP namespaces only. A complex type that contains
settings for an optional health check. If you specify settings for a
health check, Cloud Map associates the health check with the records
that you specify in DnsConfig.
For information about the charges for health checks, see Amazon Route 53 Pricing.
serviceInfo_creatorRequestId :: Lens' ServiceInfo (Maybe Text) Source #
A unique string that identifies the request and that allows failed
requests to be retried without the risk of running the operation twice.
CreatorRequestId can be any unique string (for example, a
date/timestamp).
serviceInfo_createDate :: Lens' ServiceInfo (Maybe UTCTime) Source #
The date and time that the service was created, in Unix format and
Coordinated Universal Time (UTC). The value of CreateDate is accurate
to milliseconds. For example, the value 1516925490.087 represents
Friday, January 26, 2018 12:11:30.087 AM.
serviceInfo_healthCheckCustomConfig :: Lens' ServiceInfo (Maybe HealthCheckCustomConfig) Source #
A complex type that contains information about an optional custom health check.
If you specify a health check configuration, you can specify either
HealthCheckCustomConfig or HealthCheckConfig but not both.
serviceInfo_namespaceId :: Lens' ServiceInfo (Maybe Text) Source #
The ID of the namespace that was used to create the service.
serviceInfo_name :: Lens' ServiceInfo (Maybe Text) Source #
The name of the service.
serviceInfo_id :: Lens' ServiceInfo (Maybe Text) Source #
The ID that Cloud Map assigned to the service when you created it.
serviceInfo_type :: Lens' ServiceInfo (Maybe ServiceType) Source #
Describes the systems that can be used to discover the service instances.
- DNS_HTTP
- The service instances can be discovered using either DNS queries or
the
DiscoverInstancesAPI operation. - HTTP
- The service instances can only be discovered using the
DiscoverInstancesAPI operation. - DNS
- Reserved.
serviceInfo_dnsConfig :: Lens' ServiceInfo (Maybe DnsConfig) Source #
A complex type that contains information about the Route 53 DNS records that you want Cloud Map to create when you register an instance.
serviceInfo_description :: Lens' ServiceInfo (Maybe Text) Source #
The description of the service.
ServiceSummary
data ServiceSummary Source #
A complex type that contains information about a specified service.
See: newServiceSummary smart constructor.
Constructors
| ServiceSummary' | |
Fields
| |
Instances
newServiceSummary :: ServiceSummary Source #
Create a value of ServiceSummary 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:instanceCount:ServiceSummary', serviceSummary_instanceCount - The number of instances that are currently associated with the service.
Instances that were previously associated with the service but that are
deleted aren't included in the count. The count might not reflect
pending registrations and deregistrations.
$sel:arn:ServiceSummary', serviceSummary_arn - The Amazon Resource Name (ARN) that Cloud Map assigns to the service
when you create it.
$sel:healthCheckConfig:ServiceSummary', serviceSummary_healthCheckConfig - Public DNS and HTTP namespaces only. Settings for an optional health
check. If you specify settings for a health check, Cloud Map associates
the health check with the records that you specify in DnsConfig.
$sel:createDate:ServiceSummary', serviceSummary_createDate - The date and time that the service was created.
$sel:healthCheckCustomConfig:ServiceSummary', serviceSummary_healthCheckCustomConfig - Information about an optional custom health check. A custom health
check, which requires that you use a third-party health checker to
evaluate the health of your resources, is useful in the following
circumstances:
- You can't use a health check that's defined by
HealthCheckConfigbecause the resource isn't available over the internet. For example, you can use a custom health check when the instance is in an Amazon VPC. (To check the health of resources in a VPC, the health checker must also be in the VPC.) - You want to use a third-party health checker regardless of where your resources are located.
If you specify a health check configuration, you can specify either
HealthCheckCustomConfig or HealthCheckConfig but not both.
$sel:name:ServiceSummary', serviceSummary_name - The name of the service.
$sel:id:ServiceSummary', serviceSummary_id - The ID that Cloud Map assigned to the service when you created it.
$sel:type':ServiceSummary', serviceSummary_type - Describes the systems that can be used to discover the service
instances.
- DNS_HTTP
- The service instances can be discovered using either DNS queries or
the
DiscoverInstancesAPI operation. - HTTP
- The service instances can only be discovered using the
DiscoverInstancesAPI operation. - DNS
- Reserved.
$sel:dnsConfig:ServiceSummary', serviceSummary_dnsConfig - Information about the Route 53 DNS records that you want Cloud Map to
create when you register an instance.
$sel:description:ServiceSummary', serviceSummary_description - The description that you specify when you create the service.
serviceSummary_instanceCount :: Lens' ServiceSummary (Maybe Int) Source #
The number of instances that are currently associated with the service. Instances that were previously associated with the service but that are deleted aren't included in the count. The count might not reflect pending registrations and deregistrations.
serviceSummary_arn :: Lens' ServiceSummary (Maybe Text) Source #
The Amazon Resource Name (ARN) that Cloud Map assigns to the service when you create it.
serviceSummary_healthCheckConfig :: Lens' ServiceSummary (Maybe HealthCheckConfig) Source #
Public DNS and HTTP namespaces only. Settings for an optional health
check. If you specify settings for a health check, Cloud Map associates
the health check with the records that you specify in DnsConfig.
serviceSummary_createDate :: Lens' ServiceSummary (Maybe UTCTime) Source #
The date and time that the service was created.
serviceSummary_healthCheckCustomConfig :: Lens' ServiceSummary (Maybe HealthCheckCustomConfig) Source #
Information about an optional custom health check. A custom health check, which requires that you use a third-party health checker to evaluate the health of your resources, is useful in the following circumstances:
- You can't use a health check that's defined by
HealthCheckConfigbecause the resource isn't available over the internet. For example, you can use a custom health check when the instance is in an Amazon VPC. (To check the health of resources in a VPC, the health checker must also be in the VPC.) - You want to use a third-party health checker regardless of where your resources are located.
If you specify a health check configuration, you can specify either
HealthCheckCustomConfig or HealthCheckConfig but not both.
serviceSummary_name :: Lens' ServiceSummary (Maybe Text) Source #
The name of the service.
serviceSummary_id :: Lens' ServiceSummary (Maybe Text) Source #
The ID that Cloud Map assigned to the service when you created it.
serviceSummary_type :: Lens' ServiceSummary (Maybe ServiceType) Source #
Describes the systems that can be used to discover the service instances.
- DNS_HTTP
- The service instances can be discovered using either DNS queries or
the
DiscoverInstancesAPI operation. - HTTP
- The service instances can only be discovered using the
DiscoverInstancesAPI operation. - DNS
- Reserved.
serviceSummary_dnsConfig :: Lens' ServiceSummary (Maybe DnsConfig) Source #
Information about the Route 53 DNS records that you want Cloud Map to create when you register an instance.
serviceSummary_description :: Lens' ServiceSummary (Maybe Text) Source #
The description that you specify when you create the service.
Tag
A custom key-value pair that's associated with a resource.
See: newTag smart constructor.
Constructors
| Tag' | |
Instances
| Eq Tag Source # | |
| Read Tag Source # | |
| Show Tag Source # | |
| Generic Tag Source # | |
| NFData Tag Source # | |
Defined in Amazonka.Route53AutoNaming.Types.Tag | |
| Hashable Tag Source # | |
Defined in Amazonka.Route53AutoNaming.Types.Tag | |
| ToJSON Tag Source # | |
Defined in Amazonka.Route53AutoNaming.Types.Tag | |
| FromJSON Tag Source # | |
| type Rep Tag Source # | |
Defined in Amazonka.Route53AutoNaming.Types.Tag type Rep Tag = D1 ('MetaData "Tag" "Amazonka.Route53AutoNaming.Types.Tag" "libZSservicesZSamazonka-route53-autonamingZSamazonka-route53-autonaming" 'False) (C1 ('MetaCons "Tag'" 'PrefixI 'True) (S1 ('MetaSel ('Just "key") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 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:key:Tag', tag_key - The key identifier, or name, of the tag.
$sel:value:Tag', tag_value - The string value that's associated with the key of the tag. You can set
the value of a tag to an empty string, but you can't set the value of a
tag to null.