| 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
Contents
- Service Configuration
- Errors
- Waiters
- Operations
- ListServices (Paginated)
- DeleteService
- UpdateService
- ListOperations (Paginated)
- CreateHttpNamespace
- CreatePublicDnsNamespace
- GetInstance
- ListNamespaces (Paginated)
- DeleteNamespace
- UpdatePublicDnsNamespace
- ListTagsForResource
- DiscoverInstances
- GetInstancesHealthStatus
- UpdateHttpNamespace
- GetNamespace
- RegisterInstance
- TagResource
- ListInstances (Paginated)
- GetOperation
- UpdateInstanceCustomHealthStatus
- GetService
- CreatePrivateDnsNamespace
- UntagResource
- UpdatePrivateDnsNamespace
- CreateService
- DeregisterInstance
- Types
- 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
Derived from API version 2017-03-14 of the AWS service descriptions, licensed under Apache 2.0.
Cloud Map
With Cloud Map, you can configure public DNS, private DNS, or HTTP namespaces that your microservice applications run in. When an instance becomes available, you can call the Cloud Map API to register the instance with Cloud Map. For public or private DNS namespaces, Cloud Map automatically creates DNS records and an optional health check. Clients that submit public or private DNS queries, or HTTP requests, for the service receive an answer that contains up to eight healthy records.
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
- data ListServices = ListServices' (Maybe [ServiceFilter]) (Maybe Text) (Maybe Natural)
- newListServices :: ListServices
- data ListServicesResponse = ListServicesResponse' (Maybe Text) (Maybe [ServiceSummary]) Int
- newListServicesResponse :: Int -> ListServicesResponse
- data DeleteService = DeleteService' Text
- newDeleteService :: Text -> DeleteService
- data DeleteServiceResponse = DeleteServiceResponse' Int
- newDeleteServiceResponse :: Int -> DeleteServiceResponse
- data UpdateService = UpdateService' Text ServiceChange
- newUpdateService :: Text -> ServiceChange -> UpdateService
- data UpdateServiceResponse = UpdateServiceResponse' (Maybe Text) Int
- newUpdateServiceResponse :: Int -> UpdateServiceResponse
- data ListOperations = ListOperations' (Maybe [OperationFilter]) (Maybe Text) (Maybe Natural)
- newListOperations :: ListOperations
- data ListOperationsResponse = ListOperationsResponse' (Maybe Text) (Maybe [OperationSummary]) Int
- newListOperationsResponse :: Int -> ListOperationsResponse
- data CreateHttpNamespace = CreateHttpNamespace' (Maybe Text) (Maybe Text) (Maybe [Tag]) Text
- newCreateHttpNamespace :: Text -> CreateHttpNamespace
- data CreateHttpNamespaceResponse = CreateHttpNamespaceResponse' (Maybe Text) Int
- newCreateHttpNamespaceResponse :: Int -> CreateHttpNamespaceResponse
- data CreatePublicDnsNamespace = CreatePublicDnsNamespace' (Maybe Text) (Maybe Text) (Maybe [Tag]) (Maybe PublicDnsNamespaceProperties) Text
- newCreatePublicDnsNamespace :: Text -> CreatePublicDnsNamespace
- data CreatePublicDnsNamespaceResponse = CreatePublicDnsNamespaceResponse' (Maybe Text) Int
- newCreatePublicDnsNamespaceResponse :: Int -> CreatePublicDnsNamespaceResponse
- data GetInstance = GetInstance' Text Text
- newGetInstance :: Text -> Text -> GetInstance
- data GetInstanceResponse = GetInstanceResponse' (Maybe Instance) Int
- newGetInstanceResponse :: Int -> GetInstanceResponse
- data ListNamespaces = ListNamespaces' (Maybe [NamespaceFilter]) (Maybe Text) (Maybe Natural)
- newListNamespaces :: ListNamespaces
- data ListNamespacesResponse = ListNamespacesResponse' (Maybe [NamespaceSummary]) (Maybe Text) Int
- newListNamespacesResponse :: Int -> ListNamespacesResponse
- data DeleteNamespace = DeleteNamespace' Text
- newDeleteNamespace :: Text -> DeleteNamespace
- data DeleteNamespaceResponse = DeleteNamespaceResponse' (Maybe Text) Int
- newDeleteNamespaceResponse :: Int -> DeleteNamespaceResponse
- data UpdatePublicDnsNamespace = UpdatePublicDnsNamespace' (Maybe Text) Text PublicDnsNamespaceChange
- newUpdatePublicDnsNamespace :: Text -> PublicDnsNamespaceChange -> UpdatePublicDnsNamespace
- data UpdatePublicDnsNamespaceResponse = UpdatePublicDnsNamespaceResponse' (Maybe Text) Int
- newUpdatePublicDnsNamespaceResponse :: Int -> UpdatePublicDnsNamespaceResponse
- data ListTagsForResource = ListTagsForResource' Text
- newListTagsForResource :: Text -> ListTagsForResource
- data ListTagsForResourceResponse = ListTagsForResourceResponse' (Maybe [Tag]) Int
- newListTagsForResourceResponse :: Int -> ListTagsForResourceResponse
- data DiscoverInstances = DiscoverInstances' (Maybe (HashMap Text Text)) (Maybe (HashMap Text Text)) (Maybe HealthStatusFilter) (Maybe Natural) Text Text
- newDiscoverInstances :: Text -> Text -> DiscoverInstances
- data DiscoverInstancesResponse = DiscoverInstancesResponse' (Maybe [HttpInstanceSummary]) Int
- newDiscoverInstancesResponse :: Int -> DiscoverInstancesResponse
- data GetInstancesHealthStatus = GetInstancesHealthStatus' (Maybe Text) (Maybe (NonEmpty Text)) (Maybe Natural) Text
- newGetInstancesHealthStatus :: Text -> GetInstancesHealthStatus
- data GetInstancesHealthStatusResponse = GetInstancesHealthStatusResponse' (Maybe (HashMap Text HealthStatus)) (Maybe Text) Int
- newGetInstancesHealthStatusResponse :: Int -> GetInstancesHealthStatusResponse
- data UpdateHttpNamespace = UpdateHttpNamespace' (Maybe Text) Text HttpNamespaceChange
- newUpdateHttpNamespace :: Text -> HttpNamespaceChange -> UpdateHttpNamespace
- data UpdateHttpNamespaceResponse = UpdateHttpNamespaceResponse' (Maybe Text) Int
- newUpdateHttpNamespaceResponse :: Int -> UpdateHttpNamespaceResponse
- data GetNamespace = GetNamespace' Text
- newGetNamespace :: Text -> GetNamespace
- data GetNamespaceResponse = GetNamespaceResponse' (Maybe Namespace) Int
- newGetNamespaceResponse :: Int -> GetNamespaceResponse
- data RegisterInstance = RegisterInstance' (Maybe Text) Text Text (HashMap Text Text)
- newRegisterInstance :: Text -> Text -> RegisterInstance
- data RegisterInstanceResponse = RegisterInstanceResponse' (Maybe Text) Int
- newRegisterInstanceResponse :: Int -> RegisterInstanceResponse
- data TagResource = TagResource' Text [Tag]
- newTagResource :: Text -> TagResource
- data TagResourceResponse = TagResourceResponse' Int
- newTagResourceResponse :: Int -> TagResourceResponse
- data ListInstances = ListInstances' (Maybe Text) (Maybe Natural) Text
- newListInstances :: Text -> ListInstances
- data ListInstancesResponse = ListInstancesResponse' (Maybe Text) (Maybe [InstanceSummary]) Int
- newListInstancesResponse :: Int -> ListInstancesResponse
- data GetOperation = GetOperation' Text
- newGetOperation :: Text -> GetOperation
- data GetOperationResponse = GetOperationResponse' (Maybe Operation) Int
- newGetOperationResponse :: Int -> GetOperationResponse
- data UpdateInstanceCustomHealthStatus = UpdateInstanceCustomHealthStatus' Text Text CustomHealthStatus
- newUpdateInstanceCustomHealthStatus :: Text -> Text -> CustomHealthStatus -> UpdateInstanceCustomHealthStatus
- data UpdateInstanceCustomHealthStatusResponse = UpdateInstanceCustomHealthStatusResponse' {
- newUpdateInstanceCustomHealthStatusResponse :: UpdateInstanceCustomHealthStatusResponse
- data GetService = GetService' Text
- newGetService :: Text -> GetService
- data GetServiceResponse = GetServiceResponse' (Maybe ServiceInfo) Int
- newGetServiceResponse :: Int -> GetServiceResponse
- data CreatePrivateDnsNamespace = CreatePrivateDnsNamespace' (Maybe Text) (Maybe Text) (Maybe [Tag]) (Maybe PrivateDnsNamespaceProperties) Text Text
- newCreatePrivateDnsNamespace :: Text -> Text -> CreatePrivateDnsNamespace
- data CreatePrivateDnsNamespaceResponse = CreatePrivateDnsNamespaceResponse' (Maybe Text) Int
- newCreatePrivateDnsNamespaceResponse :: Int -> CreatePrivateDnsNamespaceResponse
- data UntagResource = UntagResource' Text [Text]
- newUntagResource :: Text -> UntagResource
- data UntagResourceResponse = UntagResourceResponse' Int
- newUntagResourceResponse :: Int -> UntagResourceResponse
- data UpdatePrivateDnsNamespace = UpdatePrivateDnsNamespace' (Maybe Text) Text PrivateDnsNamespaceChange
- newUpdatePrivateDnsNamespace :: Text -> PrivateDnsNamespaceChange -> UpdatePrivateDnsNamespace
- data UpdatePrivateDnsNamespaceResponse = UpdatePrivateDnsNamespaceResponse' (Maybe Text) Int
- newUpdatePrivateDnsNamespaceResponse :: Int -> UpdatePrivateDnsNamespaceResponse
- data CreateService = CreateService' (Maybe HealthCheckConfig) (Maybe Text) (Maybe HealthCheckCustomConfig) (Maybe Text) (Maybe ServiceTypeOption) (Maybe DnsConfig) (Maybe Text) (Maybe [Tag]) Text
- newCreateService :: Text -> CreateService
- data CreateServiceResponse = CreateServiceResponse' (Maybe ServiceInfo) Int
- newCreateServiceResponse :: Int -> CreateServiceResponse
- data DeregisterInstance = DeregisterInstance' Text Text
- newDeregisterInstance :: Text -> Text -> DeregisterInstance
- data DeregisterInstanceResponse = DeregisterInstanceResponse' (Maybe Text) Int
- newDeregisterInstanceResponse :: Int -> DeregisterInstanceResponse
- 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' (Maybe RoutingPolicy) (Maybe Text) [DnsRecord]
- newDnsConfig :: DnsConfig
- data DnsConfigChange = DnsConfigChange' [DnsRecord]
- newDnsConfigChange :: DnsConfigChange
- data DnsProperties = DnsProperties' (Maybe Text) (Maybe SOA)
- newDnsProperties :: DnsProperties
- data DnsRecord = DnsRecord' RecordType Natural
- newDnsRecord :: RecordType -> Natural -> DnsRecord
- data HealthCheckConfig = HealthCheckConfig' (Maybe Natural) (Maybe Text) HealthCheckType
- newHealthCheckConfig :: HealthCheckType -> HealthCheckConfig
- data HealthCheckCustomConfig = HealthCheckCustomConfig' (Maybe Natural)
- newHealthCheckCustomConfig :: HealthCheckCustomConfig
- data HttpInstanceSummary = HttpInstanceSummary' (Maybe Text) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe Text) (Maybe HealthStatus)
- newHttpInstanceSummary :: HttpInstanceSummary
- data HttpNamespaceChange = HttpNamespaceChange' Text
- newHttpNamespaceChange :: Text -> HttpNamespaceChange
- data HttpProperties = HttpProperties' (Maybe Text)
- newHttpProperties :: HttpProperties
- data Instance = Instance' (Maybe Text) (Maybe (HashMap Text Text)) Text
- newInstance :: Text -> Instance
- data InstanceSummary = InstanceSummary' (Maybe (HashMap Text Text)) (Maybe Text)
- newInstanceSummary :: InstanceSummary
- data Namespace = Namespace' (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Int) (Maybe Text) (Maybe Text) (Maybe NamespaceType) (Maybe Text) (Maybe NamespaceProperties)
- newNamespace :: Namespace
- data NamespaceFilter = NamespaceFilter' (Maybe FilterCondition) NamespaceFilterName [Text]
- newNamespaceFilter :: NamespaceFilterName -> NamespaceFilter
- data NamespaceProperties = NamespaceProperties' (Maybe DnsProperties) (Maybe HttpProperties)
- newNamespaceProperties :: NamespaceProperties
- data NamespaceSummary = NamespaceSummary' (Maybe Text) (Maybe POSIX) (Maybe Int) (Maybe Text) (Maybe Text) (Maybe NamespaceType) (Maybe Text) (Maybe NamespaceProperties)
- newNamespaceSummary :: NamespaceSummary
- data Operation = Operation' (Maybe OperationStatus) (Maybe POSIX) (Maybe POSIX) (Maybe (HashMap OperationTargetType Text)) (Maybe Text) (Maybe Text) (Maybe OperationType) (Maybe Text)
- newOperation :: Operation
- data OperationFilter = OperationFilter' (Maybe FilterCondition) OperationFilterName [Text]
- newOperationFilter :: OperationFilterName -> OperationFilter
- data OperationSummary = OperationSummary' (Maybe OperationStatus) (Maybe Text)
- newOperationSummary :: OperationSummary
- data PrivateDnsNamespaceChange = PrivateDnsNamespaceChange' (Maybe Text) (Maybe PrivateDnsNamespacePropertiesChange)
- newPrivateDnsNamespaceChange :: PrivateDnsNamespaceChange
- data PrivateDnsNamespaceProperties = PrivateDnsNamespaceProperties' PrivateDnsPropertiesMutable
- newPrivateDnsNamespaceProperties :: PrivateDnsPropertiesMutable -> PrivateDnsNamespaceProperties
- data PrivateDnsNamespacePropertiesChange = PrivateDnsNamespacePropertiesChange' PrivateDnsPropertiesMutableChange
- newPrivateDnsNamespacePropertiesChange :: PrivateDnsPropertiesMutableChange -> PrivateDnsNamespacePropertiesChange
- data PrivateDnsPropertiesMutable = PrivateDnsPropertiesMutable' SOA
- newPrivateDnsPropertiesMutable :: SOA -> PrivateDnsPropertiesMutable
- data PrivateDnsPropertiesMutableChange = PrivateDnsPropertiesMutableChange' SOAChange
- newPrivateDnsPropertiesMutableChange :: SOAChange -> PrivateDnsPropertiesMutableChange
- data PublicDnsNamespaceChange = PublicDnsNamespaceChange' (Maybe Text) (Maybe PublicDnsNamespacePropertiesChange)
- newPublicDnsNamespaceChange :: PublicDnsNamespaceChange
- data PublicDnsNamespaceProperties = PublicDnsNamespaceProperties' PublicDnsPropertiesMutable
- newPublicDnsNamespaceProperties :: PublicDnsPropertiesMutable -> PublicDnsNamespaceProperties
- data PublicDnsNamespacePropertiesChange = PublicDnsNamespacePropertiesChange' PublicDnsPropertiesMutableChange
- newPublicDnsNamespacePropertiesChange :: PublicDnsPropertiesMutableChange -> PublicDnsNamespacePropertiesChange
- data PublicDnsPropertiesMutable = PublicDnsPropertiesMutable' SOA
- newPublicDnsPropertiesMutable :: SOA -> PublicDnsPropertiesMutable
- data PublicDnsPropertiesMutableChange = PublicDnsPropertiesMutableChange' SOAChange
- newPublicDnsPropertiesMutableChange :: SOAChange -> PublicDnsPropertiesMutableChange
- data SOA = SOA' Natural
- newSOA :: Natural -> SOA
- data SOAChange = SOAChange' Natural
- newSOAChange :: Natural -> SOAChange
- data ServiceChange = ServiceChange' (Maybe HealthCheckConfig) (Maybe DnsConfigChange) (Maybe Text)
- newServiceChange :: ServiceChange
- data ServiceFilter = ServiceFilter' (Maybe FilterCondition) ServiceFilterName [Text]
- newServiceFilter :: ServiceFilterName -> ServiceFilter
- data ServiceInfo = ServiceInfo' (Maybe Int) (Maybe Text) (Maybe HealthCheckConfig) (Maybe Text) (Maybe POSIX) (Maybe HealthCheckCustomConfig) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe ServiceType) (Maybe DnsConfig) (Maybe Text)
- newServiceInfo :: ServiceInfo
- data ServiceSummary = ServiceSummary' (Maybe Int) (Maybe Text) (Maybe HealthCheckConfig) (Maybe POSIX) (Maybe HealthCheckCustomConfig) (Maybe Text) (Maybe Text) (Maybe ServiceType) (Maybe DnsConfig) (Maybe Text)
- newServiceSummary :: ServiceSummary
- data Tag = Tag' Text Text
- newTag :: Text -> Text -> Tag
Service Configuration
defaultService :: Service Source #
API version 2017-03-14 of the Amazon Cloud Map SDK configuration.
Errors
Error matchers are designed for use with the functions provided by
Control.Exception.Lens.
This allows catching (and rethrowing) service specific errors returned
by Route53AutoNaming.
ResourceLimitExceeded
_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
_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
_NamespaceAlreadyExists :: AsError a => Getting (First ServiceError) a ServiceError Source #
The namespace that you're trying to create already exists.
NamespaceNotFound
_NamespaceNotFound :: AsError a => Getting (First ServiceError) a ServiceError Source #
No namespace exists with the specified ID.
ServiceAlreadyExists
_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
_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
_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
_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
_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
_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
_DuplicateRequest :: AsError a => Getting (First ServiceError) a ServiceError Source #
The operation is already in progress.
ServiceNotFound
_ServiceNotFound :: AsError a => Getting (First ServiceError) a ServiceError Source #
No service exists with the specified ID.
OperationNotFound
_OperationNotFound :: AsError a => Getting (First ServiceError) a ServiceError Source #
No operation exists with the specified ID.
ResourceNotFoundException
_ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The operation can't be completed because the resource was not found.
Waiters
Waiters poll by repeatedly sending a request until some remote success condition
configured by the Wait specification is fulfilled. The Wait specification
determines how many attempts should be made, in addition to delay and retry strategies.
Operations
Some AWS operations return results that are incomplete and require subsequent
requests in order to obtain the entire result set. The process of sending
subsequent requests to continue where a previous request left off is called
pagination. For example, the ListObjects operation of Amazon S3 returns up to
1000 objects at a time, and you must send subsequent requests with the
appropriate Marker in order to retrieve the next page of results.
Operations that have an AWSPager instance can transparently perform subsequent
requests, correctly setting Markers and other request facets to iterate through
the entire result set of a truncated API operation. Operations which support
this have an additional note in the documentation.
Many operations have the ability to filter results on the server side. See the individual operation parameters for details.
ListServices (Paginated)
data ListServices Source #
See: newListServices smart constructor.
Constructors
| ListServices' (Maybe [ServiceFilter]) (Maybe Text) (Maybe Natural) |
Instances
newListServices :: ListServices Source #
Create a value of ListServices 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:filters:ListServices', listServices_filters - A complex type that contains specifications for the namespaces that you
want to list services for.
If you specify more than one filter, an operation must match all filters
to be returned by ListServices.
$sel:nextToken:ListServices', listServices_nextToken - For the first ListServices request, omit this value.
If the response contains NextToken, submit another ListServices
request to get the next group of results. Specify the value of
NextToken from the previous response in the next request.
Cloud Map gets MaxResults services and then filters them based on the
specified criteria. It's possible that no services in the first
MaxResults services matched the specified criteria but that subsequent
groups of MaxResults services do contain services that match the
criteria.
$sel:maxResults:ListServices', listServices_maxResults - The maximum number of services that you want Cloud Map to return in the
response to a ListServices request. If you don't specify a value for
MaxResults, Cloud Map returns up to 100 services.
data ListServicesResponse Source #
See: newListServicesResponse smart constructor.
Constructors
| ListServicesResponse' (Maybe Text) (Maybe [ServiceSummary]) Int |
Instances
newListServicesResponse Source #
Arguments
| :: Int | |
| -> ListServicesResponse |
Create a value of ListServicesResponse 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:nextToken:ListServices', listServicesResponse_nextToken - If the response contains NextToken, submit another ListServices
request to get the next group of results. Specify the value of
NextToken from the previous response in the next request.
Cloud Map gets MaxResults services and then filters them based on the
specified criteria. It's possible that no services in the first
MaxResults services matched the specified criteria but that subsequent
groups of MaxResults services do contain services that match the
criteria.
$sel:services:ListServicesResponse', listServicesResponse_services - An array that contains one ServiceSummary object for each service that
matches the specified filter criteria.
$sel:httpStatus:ListServicesResponse', listServicesResponse_httpStatus - The response's http status code.
DeleteService
data DeleteService Source #
See: newDeleteService smart constructor.
Constructors
| DeleteService' Text |
Instances
Arguments
| :: Text | |
| -> DeleteService |
Create a value of DeleteService with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:id:DeleteService', deleteService_id - The ID of the service that you want to delete.
data DeleteServiceResponse Source #
See: newDeleteServiceResponse smart constructor.
Constructors
| DeleteServiceResponse' Int |
Instances
newDeleteServiceResponse Source #
Create a value of DeleteServiceResponse 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:httpStatus:DeleteServiceResponse', deleteServiceResponse_httpStatus - The response's http status code.
UpdateService
data UpdateService Source #
See: newUpdateService smart constructor.
Constructors
| UpdateService' Text ServiceChange |
Instances
Create a value of UpdateService with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:id:UpdateService', updateService_id - The ID of the service that you want to update.
$sel:service:UpdateService', updateService_service - A complex type that contains the new settings for the service.
data UpdateServiceResponse Source #
See: newUpdateServiceResponse smart constructor.
Constructors
| UpdateServiceResponse' (Maybe Text) Int |
Instances
newUpdateServiceResponse Source #
Create a value of UpdateServiceResponse 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:operationId:UpdateServiceResponse', updateServiceResponse_operationId - A value that you can use to determine whether the request completed
successfully. To get the status of the operation, see
GetOperation.
$sel:httpStatus:UpdateServiceResponse', updateServiceResponse_httpStatus - The response's http status code.
ListOperations (Paginated)
data ListOperations Source #
See: newListOperations smart constructor.
Constructors
| ListOperations' (Maybe [OperationFilter]) (Maybe Text) (Maybe Natural) |
Instances
newListOperations :: ListOperations Source #
Create a value of ListOperations 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:filters:ListOperations', listOperations_filters - A complex type that contains specifications for the operations that you
want to list, for example, operations that you started between a
specified start date and end date.
If you specify more than one filter, an operation must match all filters
to be returned by ListOperations.
$sel:nextToken:ListOperations', listOperations_nextToken - For the first ListOperations request, omit this value.
If the response contains NextToken, submit another ListOperations
request to get the next group of results. Specify the value of
NextToken from the previous response in the next request.
Cloud Map gets MaxResults operations and then filters them based on
the specified criteria. It's possible that no operations in the first
MaxResults operations matched the specified criteria but that
subsequent groups of MaxResults operations do contain operations that
match the criteria.
$sel:maxResults:ListOperations', listOperations_maxResults - The maximum number of items that you want Cloud Map to return in the
response to a ListOperations request. If you don't specify a value
for MaxResults, Cloud Map returns up to 100 operations.
data ListOperationsResponse Source #
See: newListOperationsResponse smart constructor.
Constructors
| ListOperationsResponse' (Maybe Text) (Maybe [OperationSummary]) Int |
Instances
newListOperationsResponse Source #
Create a value of ListOperationsResponse 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:nextToken:ListOperations', listOperationsResponse_nextToken - If the response contains NextToken, submit another ListOperations
request to get the next group of results. Specify the value of
NextToken from the previous response in the next request.
Cloud Map gets MaxResults operations and then filters them based on
the specified criteria. It's possible that no operations in the first
MaxResults operations matched the specified criteria but that
subsequent groups of MaxResults operations do contain operations that
match the criteria.
$sel:operations:ListOperationsResponse', listOperationsResponse_operations - Summary information about the operations that match the specified
criteria.
$sel:httpStatus:ListOperationsResponse', listOperationsResponse_httpStatus - The response's http status code.
CreateHttpNamespace
data CreateHttpNamespace Source #
See: newCreateHttpNamespace smart constructor.
Instances
newCreateHttpNamespace Source #
Arguments
| :: Text | |
| -> CreateHttpNamespace |
Create a value of CreateHttpNamespace 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:CreateHttpNamespace', createHttpNamespace_creatorRequestId - A unique string that identifies the request and that allows failed
CreateHttpNamespace requests to be retried without the risk of running
the operation twice. CreatorRequestId can be any unique string (for
example, a date/time stamp).
$sel:description:CreateHttpNamespace', createHttpNamespace_description - A description for the namespace.
$sel:tags:CreateHttpNamespace', createHttpNamespace_tags - The tags to add to the namespace. Each tag consists of a key and an
optional value that you define. Tags keys can be up to 128 characters in
length, and tag values can be up to 256 characters in length.
$sel:name:CreateHttpNamespace', createHttpNamespace_name - The name that you want to assign to this namespace.
data CreateHttpNamespaceResponse Source #
See: newCreateHttpNamespaceResponse smart constructor.
Constructors
| CreateHttpNamespaceResponse' (Maybe Text) Int |
Instances
newCreateHttpNamespaceResponse Source #
Create a value of CreateHttpNamespaceResponse 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:operationId:CreateHttpNamespaceResponse', createHttpNamespaceResponse_operationId - A value that you can use to determine whether the request completed
successfully. To get the status of the operation, see
GetOperation.
$sel:httpStatus:CreateHttpNamespaceResponse', createHttpNamespaceResponse_httpStatus - The response's http status code.
CreatePublicDnsNamespace
data CreatePublicDnsNamespace Source #
See: newCreatePublicDnsNamespace smart constructor.
Constructors
| CreatePublicDnsNamespace' (Maybe Text) (Maybe Text) (Maybe [Tag]) (Maybe PublicDnsNamespaceProperties) Text |
Instances
newCreatePublicDnsNamespace Source #
Create a value of CreatePublicDnsNamespace 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:CreatePublicDnsNamespace', createPublicDnsNamespace_creatorRequestId - A unique string that identifies the request and that allows failed
CreatePublicDnsNamespace requests to be retried without the risk of
running the operation twice. CreatorRequestId can be any unique string
(for example, a date/timestamp).
$sel:description:CreatePublicDnsNamespace', createPublicDnsNamespace_description - A description for the namespace.
$sel:tags:CreatePublicDnsNamespace', createPublicDnsNamespace_tags - The tags to add to the namespace. Each tag consists of a key and an
optional value that you define. Tags keys can be up to 128 characters in
length, and tag values can be up to 256 characters in length.
$sel:properties:CreatePublicDnsNamespace', createPublicDnsNamespace_properties - Properties for the public DNS namespace.
$sel:name:CreatePublicDnsNamespace', createPublicDnsNamespace_name - The name that you want to assign to this namespace.
data CreatePublicDnsNamespaceResponse Source #
See: newCreatePublicDnsNamespaceResponse smart constructor.
Constructors
| CreatePublicDnsNamespaceResponse' (Maybe Text) Int |
Instances
newCreatePublicDnsNamespaceResponse Source #
Create a value of CreatePublicDnsNamespaceResponse 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:operationId:CreatePublicDnsNamespaceResponse', createPublicDnsNamespaceResponse_operationId - A value that you can use to determine whether the request completed
successfully. To get the status of the operation, see
GetOperation.
$sel:httpStatus:CreatePublicDnsNamespaceResponse', createPublicDnsNamespaceResponse_httpStatus - The response's http status code.
GetInstance
data GetInstance Source #
See: newGetInstance smart constructor.
Constructors
| GetInstance' Text Text |
Instances
Create a value of GetInstance 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:serviceId:GetInstance', getInstance_serviceId - The ID of the service that the instance is associated with.
$sel:instanceId:GetInstance', getInstance_instanceId - The ID of the instance that you want to get information about.
data GetInstanceResponse Source #
See: newGetInstanceResponse smart constructor.
Constructors
| GetInstanceResponse' (Maybe Instance) Int |
Instances
newGetInstanceResponse Source #
Arguments
| :: Int | |
| -> GetInstanceResponse |
Create a value of GetInstanceResponse 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:instance':GetInstanceResponse', getInstanceResponse_instance - A complex type that contains information about a specified instance.
$sel:httpStatus:GetInstanceResponse', getInstanceResponse_httpStatus - The response's http status code.
ListNamespaces (Paginated)
data ListNamespaces Source #
See: newListNamespaces smart constructor.
Constructors
| ListNamespaces' (Maybe [NamespaceFilter]) (Maybe Text) (Maybe Natural) |
Instances
newListNamespaces :: ListNamespaces Source #
Create a value of ListNamespaces 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:filters:ListNamespaces', listNamespaces_filters - A complex type that contains specifications for the namespaces that you
want to list.
If you specify more than one filter, a namespace must match all filters
to be returned by ListNamespaces.
$sel:nextToken:ListNamespaces', listNamespaces_nextToken - For the first ListNamespaces request, omit this value.
If the response contains NextToken, submit another ListNamespaces
request to get the next group of results. Specify the value of
NextToken from the previous response in the next request.
Cloud Map gets MaxResults namespaces and then filters them based on
the specified criteria. It's possible that no namespaces in the first
MaxResults namespaces matched the specified criteria but that
subsequent groups of MaxResults namespaces do contain namespaces that
match the criteria.
$sel:maxResults:ListNamespaces', listNamespaces_maxResults - The maximum number of namespaces that you want Cloud Map to return in
the response to a ListNamespaces request. If you don't specify a
value for MaxResults, Cloud Map returns up to 100 namespaces.
data ListNamespacesResponse Source #
See: newListNamespacesResponse smart constructor.
Constructors
| ListNamespacesResponse' (Maybe [NamespaceSummary]) (Maybe Text) Int |
Instances
newListNamespacesResponse Source #
Create a value of ListNamespacesResponse 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:namespaces:ListNamespacesResponse', listNamespacesResponse_namespaces - An array that contains one NamespaceSummary object for each namespace
that matches the specified filter criteria.
$sel:nextToken:ListNamespaces', listNamespacesResponse_nextToken - If the response contains NextToken, submit another ListNamespaces
request to get the next group of results. Specify the value of
NextToken from the previous response in the next request.
Cloud Map gets MaxResults namespaces and then filters them based on
the specified criteria. It's possible that no namespaces in the first
MaxResults namespaces matched the specified criteria but that
subsequent groups of MaxResults namespaces do contain namespaces that
match the criteria.
$sel:httpStatus:ListNamespacesResponse', listNamespacesResponse_httpStatus - The response's http status code.
DeleteNamespace
data DeleteNamespace Source #
See: newDeleteNamespace smart constructor.
Constructors
| DeleteNamespace' Text |
Instances
Arguments
| :: Text | |
| -> DeleteNamespace |
Create a value of DeleteNamespace with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:id:DeleteNamespace', deleteNamespace_id - The ID of the namespace that you want to delete.
data DeleteNamespaceResponse Source #
See: newDeleteNamespaceResponse smart constructor.
Constructors
| DeleteNamespaceResponse' (Maybe Text) Int |
Instances
newDeleteNamespaceResponse Source #
Create a value of DeleteNamespaceResponse 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:operationId:DeleteNamespaceResponse', deleteNamespaceResponse_operationId - A value that you can use to determine whether the request completed
successfully. To get the status of the operation, see
GetOperation.
$sel:httpStatus:DeleteNamespaceResponse', deleteNamespaceResponse_httpStatus - The response's http status code.
UpdatePublicDnsNamespace
data UpdatePublicDnsNamespace Source #
See: newUpdatePublicDnsNamespace smart constructor.
Constructors
| UpdatePublicDnsNamespace' (Maybe Text) Text PublicDnsNamespaceChange |
Instances
newUpdatePublicDnsNamespace Source #
Arguments
| :: Text | |
| -> PublicDnsNamespaceChange | |
| -> UpdatePublicDnsNamespace |
Create a value of UpdatePublicDnsNamespace 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:updaterRequestId:UpdatePublicDnsNamespace', updatePublicDnsNamespace_updaterRequestId - A unique string that identifies the request and that allows failed
UpdatePublicDnsNamespace requests to be retried without the risk of
running the operation twice. UpdaterRequestId can be any unique string
(for example, a date/timestamp).
$sel:id:UpdatePublicDnsNamespace', updatePublicDnsNamespace_id - The ID of the namespace being updated.
$sel:namespace:UpdatePublicDnsNamespace', updatePublicDnsNamespace_namespace - Updated properties for the public DNS namespace.
data UpdatePublicDnsNamespaceResponse Source #
See: newUpdatePublicDnsNamespaceResponse smart constructor.
Constructors
| UpdatePublicDnsNamespaceResponse' (Maybe Text) Int |
Instances
newUpdatePublicDnsNamespaceResponse Source #
Create a value of UpdatePublicDnsNamespaceResponse 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:operationId:UpdatePublicDnsNamespaceResponse', updatePublicDnsNamespaceResponse_operationId - A value that you can use to determine whether the request completed
successfully. To get the status of the operation, see
GetOperation.
$sel:httpStatus:UpdatePublicDnsNamespaceResponse', updatePublicDnsNamespaceResponse_httpStatus - The response's http status code.
ListTagsForResource
data ListTagsForResource Source #
See: newListTagsForResource smart constructor.
Constructors
| ListTagsForResource' Text |
Instances
newListTagsForResource Source #
Arguments
| :: Text | |
| -> ListTagsForResource |
Create a value of ListTagsForResource 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:resourceARN:ListTagsForResource', listTagsForResource_resourceARN - The Amazon Resource Name (ARN) of the resource that you want to retrieve
tags for.
data ListTagsForResourceResponse Source #
See: newListTagsForResourceResponse smart constructor.
Constructors
| ListTagsForResourceResponse' (Maybe [Tag]) Int |
Instances
newListTagsForResourceResponse Source #
Create a value of ListTagsForResourceResponse 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:tags:ListTagsForResourceResponse', listTagsForResourceResponse_tags - The tags that are assigned to the resource.
$sel:httpStatus:ListTagsForResourceResponse', listTagsForResourceResponse_httpStatus - The response's http status code.
DiscoverInstances
data DiscoverInstances Source #
See: newDiscoverInstances smart constructor.
Constructors
| DiscoverInstances' (Maybe (HashMap Text Text)) (Maybe (HashMap Text Text)) (Maybe HealthStatusFilter) (Maybe Natural) Text Text |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> DiscoverInstances |
Create a value of DiscoverInstances 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:queryParameters:DiscoverInstances', discoverInstances_queryParameters - Filters to scope the results based on custom attributes for the instance
(for example, {version=v1, az=1a}). Only instances that match all the
specified key-value pairs are returned.
$sel:optionalParameters:DiscoverInstances', discoverInstances_optionalParameters - Opportunistic filters to scope the results based on custom attributes.
If there are instances that match both the filters specified in both the
QueryParameters parameter and this parameter, all of these instances
are returned. Otherwise, the filters are ignored, and only instances
that match the filters that are specified in the QueryParameters
parameter are returned.
$sel:healthStatus:DiscoverInstances', discoverInstances_healthStatus - The health status of the instances that you want to discover. This
parameter is ignored for services that don't have a health check
configured, and all instances are returned.
- HEALTHY
- Returns healthy instances.
- UNHEALTHY
- Returns unhealthy instances.
- ALL
- Returns all instances.
- HEALTHY_OR_ELSE_ALL
- Returns healthy instances, unless none are reporting a healthy state. In that case, return all instances. This is also called failing open.
$sel:maxResults:DiscoverInstances', discoverInstances_maxResults - The maximum number of instances that you want Cloud Map to return in the
response to a DiscoverInstances request. If you don't specify a value
for MaxResults, Cloud Map returns up to 100 instances.
$sel:namespaceName:DiscoverInstances', discoverInstances_namespaceName - The HttpName name of the namespace. It's found in the
HttpProperties member of the Properties member of the namespace.
$sel:serviceName:DiscoverInstances', discoverInstances_serviceName - The name of the service that you specified when you registered the
instance.
data DiscoverInstancesResponse Source #
See: newDiscoverInstancesResponse smart constructor.
Constructors
| DiscoverInstancesResponse' (Maybe [HttpInstanceSummary]) Int |
Instances
newDiscoverInstancesResponse Source #
Create a value of DiscoverInstancesResponse 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:instances:DiscoverInstancesResponse', discoverInstancesResponse_instances - A complex type that contains one HttpInstanceSummary for each
registered instance.
$sel:httpStatus:DiscoverInstancesResponse', discoverInstancesResponse_httpStatus - The response's http status code.
GetInstancesHealthStatus
data GetInstancesHealthStatus Source #
See: newGetInstancesHealthStatus smart constructor.
Instances
newGetInstancesHealthStatus Source #
Create a value of GetInstancesHealthStatus 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:nextToken:GetInstancesHealthStatus', getInstancesHealthStatus_nextToken - For the first GetInstancesHealthStatus request, omit this value.
If more than MaxResults instances match the specified criteria, you
can submit another GetInstancesHealthStatus request to get the next
group of results. Specify the value of NextToken from the previous
response in the next request.
$sel:instances:GetInstancesHealthStatus', getInstancesHealthStatus_instances - An array that contains the IDs of all the instances that you want to get
the health status for.
If you omit Instances, Cloud Map returns the health status for all the
instances that are associated with the specified service.
To get the IDs for the instances that you've registered by using a specified service, submit a ListInstances request.
$sel:maxResults:GetInstancesHealthStatus', getInstancesHealthStatus_maxResults - The maximum number of instances that you want Cloud Map to return in the
response to a GetInstancesHealthStatus request. If you don't specify
a value for MaxResults, Cloud Map returns up to 100 instances.
$sel:serviceId:GetInstancesHealthStatus', getInstancesHealthStatus_serviceId - The ID of the service that the instance is associated with.
data GetInstancesHealthStatusResponse Source #
See: newGetInstancesHealthStatusResponse smart constructor.
Constructors
| GetInstancesHealthStatusResponse' (Maybe (HashMap Text HealthStatus)) (Maybe Text) Int |
Instances
newGetInstancesHealthStatusResponse Source #
Create a value of GetInstancesHealthStatusResponse 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:GetInstancesHealthStatusResponse', getInstancesHealthStatusResponse_status - A complex type that contains the IDs and the health status of the
instances that you specified in the GetInstancesHealthStatus request.
$sel:nextToken:GetInstancesHealthStatus', getInstancesHealthStatusResponse_nextToken - If more than MaxResults instances match the specified criteria, you
can submit another GetInstancesHealthStatus request to get the next
group of results. Specify the value of NextToken from the previous
response in the next request.
$sel:httpStatus:GetInstancesHealthStatusResponse', getInstancesHealthStatusResponse_httpStatus - The response's http status code.
UpdateHttpNamespace
data UpdateHttpNamespace Source #
See: newUpdateHttpNamespace smart constructor.
Constructors
| UpdateHttpNamespace' (Maybe Text) Text HttpNamespaceChange |
Instances
newUpdateHttpNamespace Source #
Arguments
| :: Text | |
| -> HttpNamespaceChange | |
| -> UpdateHttpNamespace |
Create a value of UpdateHttpNamespace 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:updaterRequestId:UpdateHttpNamespace', updateHttpNamespace_updaterRequestId - A unique string that identifies the request and that allows failed
UpdateHttpNamespace requests to be retried without the risk of running
the operation twice. UpdaterRequestId can be any unique string (for
example, a date/timestamp).
$sel:id:UpdateHttpNamespace', updateHttpNamespace_id - The ID of the namespace that you want to update.
$sel:namespace:UpdateHttpNamespace', updateHttpNamespace_namespace - Updated properties for the the HTTP namespace.
data UpdateHttpNamespaceResponse Source #
See: newUpdateHttpNamespaceResponse smart constructor.
Constructors
| UpdateHttpNamespaceResponse' (Maybe Text) Int |
Instances
newUpdateHttpNamespaceResponse Source #
Create a value of UpdateHttpNamespaceResponse 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:operationId:UpdateHttpNamespaceResponse', updateHttpNamespaceResponse_operationId - A value that you can use to determine whether the request completed
successfully. To get the status of the operation, see
GetOperation.
$sel:httpStatus:UpdateHttpNamespaceResponse', updateHttpNamespaceResponse_httpStatus - The response's http status code.
GetNamespace
data GetNamespace Source #
See: newGetNamespace smart constructor.
Constructors
| GetNamespace' Text |
Instances
Arguments
| :: Text | |
| -> GetNamespace |
Create a value of GetNamespace with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:id:GetNamespace', getNamespace_id - The ID of the namespace that you want to get information about.
data GetNamespaceResponse Source #
See: newGetNamespaceResponse smart constructor.
Constructors
| GetNamespaceResponse' (Maybe Namespace) Int |
Instances
newGetNamespaceResponse Source #
Arguments
| :: Int | |
| -> GetNamespaceResponse |
Create a value of GetNamespaceResponse 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:namespace:GetNamespaceResponse', getNamespaceResponse_namespace - A complex type that contains information about the specified namespace.
$sel:httpStatus:GetNamespaceResponse', getNamespaceResponse_httpStatus - The response's http status code.
RegisterInstance
data RegisterInstance Source #
See: newRegisterInstance smart constructor.
Instances
Arguments
| :: Text | |
| -> Text | |
| -> RegisterInstance |
Create a value of RegisterInstance 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:RegisterInstance', registerInstance_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:serviceId:RegisterInstance', registerInstance_serviceId - The ID of the service that you want to use for settings for the
instance.
$sel:instanceId:RegisterInstance', registerInstance_instanceId - 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 any. 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.
$sel:attributes:RegisterInstance', registerInstance_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 an Amazon 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 "DNSName" in the
topic
AliasTarget
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 will create the Route 53 health check, but it doesn'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 Elastic Load Balancing 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.
If the
AWS_EC2_INSTANCE_IDattribute is specified, then the only other attribute that can be specified isAWS_INIT_HEALTH_STATUS. When theAWS_EC2_INSTANCE_IDattribute is specified, then theAWS_INSTANCE_IPV4attribute will be filled out with 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. - Custom attributes
- You can add up to 30 custom attributes. For each key-value pair, the maximum length of the attribute name is 255 characters, and the maximum length of the attribute value is 1,024 characters. The total size of all provided attributes (sum of all keys and values) must not exceed 5,000 characters.
data RegisterInstanceResponse Source #
See: newRegisterInstanceResponse smart constructor.
Constructors
| RegisterInstanceResponse' (Maybe Text) Int |
Instances
newRegisterInstanceResponse Source #
Create a value of RegisterInstanceResponse 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:operationId:RegisterInstanceResponse', registerInstanceResponse_operationId - A value that you can use to determine whether the request completed
successfully. To get the status of the operation, see
GetOperation.
$sel:httpStatus:RegisterInstanceResponse', registerInstanceResponse_httpStatus - The response's http status code.
TagResource
data TagResource Source #
See: newTagResource smart constructor.
Constructors
| TagResource' Text [Tag] |
Instances
Arguments
| :: Text | |
| -> TagResource |
Create a value of TagResource 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:resourceARN:TagResource', tagResource_resourceARN - The Amazon Resource Name (ARN) of the resource that you want to retrieve
tags for.
$sel:tags:TagResource', tagResource_tags - The tags to add to the specified resource. Specifying the tag key is
required. You can set the value of a tag to an empty string, but you
can't set the value of a tag to null.
data TagResourceResponse Source #
See: newTagResourceResponse smart constructor.
Constructors
| TagResourceResponse' Int |
Instances
newTagResourceResponse Source #
Arguments
| :: Int | |
| -> TagResourceResponse |
Create a value of TagResourceResponse 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:httpStatus:TagResourceResponse', tagResourceResponse_httpStatus - The response's http status code.
ListInstances (Paginated)
data ListInstances Source #
See: newListInstances smart constructor.
Instances
Arguments
| :: Text | |
| -> ListInstances |
Create a value of ListInstances 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:nextToken:ListInstances', listInstances_nextToken - For the first ListInstances request, omit this value.
If more than MaxResults instances match the specified criteria, you
can submit another ListInstances request to get the next group of
results. Specify the value of NextToken from the previous response in
the next request.
$sel:maxResults:ListInstances', listInstances_maxResults - The maximum number of instances that you want Cloud Map to return in the
response to a ListInstances request. If you don't specify a value for
MaxResults, Cloud Map returns up to 100 instances.
$sel:serviceId:ListInstances', listInstances_serviceId - The ID of the service that you want to list instances for.
data ListInstancesResponse Source #
See: newListInstancesResponse smart constructor.
Constructors
| ListInstancesResponse' (Maybe Text) (Maybe [InstanceSummary]) Int |
Instances
newListInstancesResponse Source #
Create a value of ListInstancesResponse 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:nextToken:ListInstances', listInstancesResponse_nextToken - If more than MaxResults instances match the specified criteria, you
can submit another ListInstances request to get the next group of
results. Specify the value of NextToken from the previous response in
the next request.
$sel:instances:ListInstancesResponse', listInstancesResponse_instances - Summary information about the instances that are associated with the
specified service.
$sel:httpStatus:ListInstancesResponse', listInstancesResponse_httpStatus - The response's http status code.
GetOperation
data GetOperation Source #
See: newGetOperation smart constructor.
Constructors
| GetOperation' Text |
Instances
Arguments
| :: Text | |
| -> GetOperation |
Create a value of GetOperation 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:operationId:GetOperation', getOperation_operationId - The ID of the operation that you want to get more information about.
data GetOperationResponse Source #
See: newGetOperationResponse smart constructor.
Constructors
| GetOperationResponse' (Maybe Operation) Int |
Instances
newGetOperationResponse Source #
Arguments
| :: Int | |
| -> GetOperationResponse |
Create a value of GetOperationResponse 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:operation:GetOperationResponse', getOperationResponse_operation - A complex type that contains information about the operation.
$sel:httpStatus:GetOperationResponse', getOperationResponse_httpStatus - The response's http status code.
UpdateInstanceCustomHealthStatus
data UpdateInstanceCustomHealthStatus Source #
See: newUpdateInstanceCustomHealthStatus smart constructor.
Constructors
| UpdateInstanceCustomHealthStatus' Text Text CustomHealthStatus |
Instances
newUpdateInstanceCustomHealthStatus Source #
Arguments
| :: Text | |
| -> Text | |
| -> CustomHealthStatus | |
| -> UpdateInstanceCustomHealthStatus |
Create a value of UpdateInstanceCustomHealthStatus 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:serviceId:UpdateInstanceCustomHealthStatus', updateInstanceCustomHealthStatus_serviceId - The ID of the service that includes the configuration for the custom
health check that you want to change the status for.
$sel:instanceId:UpdateInstanceCustomHealthStatus', updateInstanceCustomHealthStatus_instanceId - The ID of the instance that you want to change the health status for.
$sel:status:UpdateInstanceCustomHealthStatus', updateInstanceCustomHealthStatus_status - The new status of the instance, HEALTHY or UNHEALTHY.
data UpdateInstanceCustomHealthStatusResponse Source #
See: newUpdateInstanceCustomHealthStatusResponse smart constructor.
Constructors
| UpdateInstanceCustomHealthStatusResponse' | |
Instances
newUpdateInstanceCustomHealthStatusResponse :: UpdateInstanceCustomHealthStatusResponse Source #
Create a value of UpdateInstanceCustomHealthStatusResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
GetService
data GetService Source #
See: newGetService smart constructor.
Constructors
| GetService' Text |
Instances
Arguments
| :: Text | |
| -> GetService |
Create a value of GetService with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:id:GetService', getService_id - The ID of the service that you want to get settings for.
data GetServiceResponse Source #
See: newGetServiceResponse smart constructor.
Constructors
| GetServiceResponse' (Maybe ServiceInfo) Int |
Instances
newGetServiceResponse Source #
Arguments
| :: Int | |
| -> GetServiceResponse |
Create a value of GetServiceResponse 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:service:GetServiceResponse', getServiceResponse_service - A complex type that contains information about the service.
$sel:httpStatus:GetServiceResponse', getServiceResponse_httpStatus - The response's http status code.
CreatePrivateDnsNamespace
data CreatePrivateDnsNamespace Source #
See: newCreatePrivateDnsNamespace smart constructor.
Constructors
| CreatePrivateDnsNamespace' (Maybe Text) (Maybe Text) (Maybe [Tag]) (Maybe PrivateDnsNamespaceProperties) Text Text |
Instances
newCreatePrivateDnsNamespace Source #
Arguments
| :: Text | |
| -> Text | |
| -> CreatePrivateDnsNamespace |
Create a value of CreatePrivateDnsNamespace 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:CreatePrivateDnsNamespace', createPrivateDnsNamespace_creatorRequestId - A unique string that identifies the request and that allows failed
CreatePrivateDnsNamespace requests to be retried without the risk of
running the operation twice. CreatorRequestId can be any unique string
(for example, a date/timestamp).
$sel:description:CreatePrivateDnsNamespace', createPrivateDnsNamespace_description - A description for the namespace.
$sel:tags:CreatePrivateDnsNamespace', createPrivateDnsNamespace_tags - The tags to add to the namespace. Each tag consists of a key and an
optional value that you define. Tags keys can be up to 128 characters in
length, and tag values can be up to 256 characters in length.
$sel:properties:CreatePrivateDnsNamespace', createPrivateDnsNamespace_properties - Properties for the private DNS namespace.
$sel:name:CreatePrivateDnsNamespace', createPrivateDnsNamespace_name - The name that you want to assign to this namespace. When you create a
private DNS namespace, Cloud Map automatically creates an Amazon Route
53 private hosted zone that has the same name as the namespace.
$sel:vpc:CreatePrivateDnsNamespace', createPrivateDnsNamespace_vpc - The ID of the Amazon VPC that you want to associate the namespace with.
data CreatePrivateDnsNamespaceResponse Source #
See: newCreatePrivateDnsNamespaceResponse smart constructor.
Constructors
| CreatePrivateDnsNamespaceResponse' (Maybe Text) Int |
Instances
newCreatePrivateDnsNamespaceResponse Source #
Arguments
| :: Int | |
| -> CreatePrivateDnsNamespaceResponse |
Create a value of CreatePrivateDnsNamespaceResponse 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:operationId:CreatePrivateDnsNamespaceResponse', createPrivateDnsNamespaceResponse_operationId - A value that you can use to determine whether the request completed
successfully. To get the status of the operation, see
GetOperation.
$sel:httpStatus:CreatePrivateDnsNamespaceResponse', createPrivateDnsNamespaceResponse_httpStatus - The response's http status code.
UntagResource
data UntagResource Source #
See: newUntagResource smart constructor.
Constructors
| UntagResource' Text [Text] |
Instances
Arguments
| :: Text | |
| -> UntagResource |
Create a value of UntagResource 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:resourceARN:UntagResource', untagResource_resourceARN - The Amazon Resource Name (ARN) of the resource that you want to retrieve
tags for.
$sel:tagKeys:UntagResource', untagResource_tagKeys - The tag keys to remove from the specified resource.
data UntagResourceResponse Source #
See: newUntagResourceResponse smart constructor.
Constructors
| UntagResourceResponse' Int |
Instances
newUntagResourceResponse Source #
Create a value of UntagResourceResponse 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:httpStatus:UntagResourceResponse', untagResourceResponse_httpStatus - The response's http status code.
UpdatePrivateDnsNamespace
data UpdatePrivateDnsNamespace Source #
See: newUpdatePrivateDnsNamespace smart constructor.
Constructors
| UpdatePrivateDnsNamespace' (Maybe Text) Text PrivateDnsNamespaceChange |
Instances
newUpdatePrivateDnsNamespace Source #
Arguments
| :: Text | |
| -> PrivateDnsNamespaceChange | |
| -> UpdatePrivateDnsNamespace |
Create a value of UpdatePrivateDnsNamespace 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:updaterRequestId:UpdatePrivateDnsNamespace', updatePrivateDnsNamespace_updaterRequestId - A unique string that identifies the request and that allows failed
UpdatePrivateDnsNamespace requests to be retried without the risk of
running the operation twice. UpdaterRequestId can be any unique string
(for example, a date/timestamp).
$sel:id:UpdatePrivateDnsNamespace', updatePrivateDnsNamespace_id - The ID of the namespace that you want to update.
$sel:namespace:UpdatePrivateDnsNamespace', updatePrivateDnsNamespace_namespace - Updated properties for the private DNS namespace.
data UpdatePrivateDnsNamespaceResponse Source #
See: newUpdatePrivateDnsNamespaceResponse smart constructor.
Constructors
| UpdatePrivateDnsNamespaceResponse' (Maybe Text) Int |
Instances
newUpdatePrivateDnsNamespaceResponse Source #
Arguments
| :: Int | |
| -> UpdatePrivateDnsNamespaceResponse |
Create a value of UpdatePrivateDnsNamespaceResponse 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:operationId:UpdatePrivateDnsNamespaceResponse', updatePrivateDnsNamespaceResponse_operationId - A value that you can use to determine whether the request completed
successfully. To get the status of the operation, see
GetOperation.
$sel:httpStatus:UpdatePrivateDnsNamespaceResponse', updatePrivateDnsNamespaceResponse_httpStatus - The response's http status code.
CreateService
data CreateService Source #
See: newCreateService smart constructor.
Constructors
| CreateService' (Maybe HealthCheckConfig) (Maybe Text) (Maybe HealthCheckCustomConfig) (Maybe Text) (Maybe ServiceTypeOption) (Maybe DnsConfig) (Maybe Text) (Maybe [Tag]) Text |
Instances
Arguments
| :: Text | |
| -> CreateService |
Create a value of CreateService 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:CreateService', createService_healthCheckConfig - Public DNS and HTTP namespaces only. A complex type that contains
settings for an optional Route 53 health check. If you specify settings
for a health check, Cloud Map associates the health check with all the
Route 53 DNS records that you specify in DnsConfig.
If you specify a health check configuration, you can specify either
HealthCheckCustomConfig or HealthCheckConfig but not both.
For information about the charges for health checks, see Cloud Map Pricing.
$sel:creatorRequestId:CreateService', createService_creatorRequestId - A unique string that identifies the request and that allows failed
CreateService requests to be retried without the risk of running the
operation twice. CreatorRequestId can be any unique string (for
example, a date/timestamp).
$sel:healthCheckCustomConfig:CreateService', createService_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.
You can't add, update, or delete a HealthCheckCustomConfig
configuration from an existing service.
$sel:namespaceId:CreateService', createService_namespaceId - The ID of the namespace that you want to use to create the service. The
namespace ID must be specified, but it can be specified either here or
in the DnsConfig object.
$sel:type':CreateService', createService_type - If present, specifies that the service instances are only discoverable
using the DiscoverInstances API operation. No DNS records is
registered for the service instances. The only valid value is HTTP.
$sel:dnsConfig:CreateService', createService_dnsConfig - A complex type that contains information about the Amazon Route 53
records that you want Cloud Map to create when you register an instance.
$sel:description:CreateService', createService_description - A description for the service.
$sel:tags:CreateService', createService_tags - The tags to add to the service. Each tag consists of a key and an
optional value that you define. Tags keys can be up to 128 characters in
length, and tag values can be up to 256 characters in length.
$sel:name:CreateService', createService_name - The name that you want to assign to the service.
If you want Cloud Map to create an SRV record when you register an
instance and you're using a system that requires a specific SRV
format, such as HAProxy, specify the following
for Name:
- Start the name with an underscore (_), such as
_exampleservice. - End the name with ._protocol, such as
._tcp.
When you register an instance, Cloud Map creates an SRV record and
assigns a name to the record by concatenating the service name and the
namespace name (for example,
_exampleservice._tcp.example.com).
For services that are accessible by DNS queries, you can't create multiple services with names that differ only by case (such as EXAMPLE and example). Otherwise, these services have the same DNS name and can't be distinguished. However, if you use a namespace that's only accessible by API calls, then you can create services that with names that differ only by case.
data CreateServiceResponse Source #
See: newCreateServiceResponse smart constructor.
Constructors
| CreateServiceResponse' (Maybe ServiceInfo) Int |
Instances
newCreateServiceResponse Source #
Create a value of CreateServiceResponse 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:service:CreateServiceResponse', createServiceResponse_service - A complex type that contains information about the new service.
$sel:httpStatus:CreateServiceResponse', createServiceResponse_httpStatus - The response's http status code.
DeregisterInstance
data DeregisterInstance Source #
See: newDeregisterInstance smart constructor.
Constructors
| DeregisterInstance' Text Text |
Instances
newDeregisterInstance Source #
Arguments
| :: Text | |
| -> Text | |
| -> DeregisterInstance |
Create a value of DeregisterInstance 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:serviceId:DeregisterInstance', deregisterInstance_serviceId - The ID of the service that the instance is associated with.
$sel:instanceId:DeregisterInstance', deregisterInstance_instanceId - The value that you specified for Id in the
RegisterInstance
request.
data DeregisterInstanceResponse Source #
See: newDeregisterInstanceResponse smart constructor.
Constructors
| DeregisterInstanceResponse' (Maybe Text) Int |
Instances
newDeregisterInstanceResponse Source #
Create a value of DeregisterInstanceResponse 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:operationId:DeregisterInstanceResponse', deregisterInstanceResponse_operationId - A value that you can use to determine whether the request completed
successfully. To get the status of the operation, see
GetOperation.
$sel:httpStatus:DeregisterInstanceResponse', deregisterInstanceResponse_httpStatus - The response's http status code.
Types
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' (Maybe RoutingPolicy) (Maybe Text) [DnsRecord] |
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.
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' [DnsRecord] |
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.
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' (Maybe Text) (Maybe SOA) |
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.
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' RecordType Natural |
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.
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' (Maybe Natural) (Maybe Text) HealthCheckType |
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.
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' (Maybe Natural) |
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.
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' (Maybe Text) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe Text) (Maybe HealthStatus) |
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.
HttpNamespaceChange
data HttpNamespaceChange Source #
Updated properties for the HTTP namespace.
See: newHttpNamespaceChange smart constructor.
Constructors
| HttpNamespaceChange' Text |
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.
HttpProperties
data HttpProperties Source #
A complex type that contains the name of an HTTP namespace.
See: newHttpProperties smart constructor.
Constructors
| HttpProperties' (Maybe Text) |
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.
Instance
A complex type that contains information about an instance that Cloud
Map creates when you submit a RegisterInstance request.
See: newInstance smart constructor.
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.
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.
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.
Namespace
A complex type that contains information about a specified namespace.
See: newNamespace smart constructor.
Constructors
| Namespace' (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Int) (Maybe Text) (Maybe Text) (Maybe NamespaceType) (Maybe Text) (Maybe NamespaceProperties) |
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.
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' (Maybe FilterCondition) NamespaceFilterName [Text] |
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.
NamespaceProperties
data NamespaceProperties Source #
A complex type that contains information that's specific to the namespace type.
See: newNamespaceProperties smart constructor.
Constructors
| NamespaceProperties' (Maybe DnsProperties) (Maybe HttpProperties) |
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.
NamespaceSummary
data NamespaceSummary Source #
A complex type that contains information about a namespace.
See: newNamespaceSummary smart constructor.
Constructors
| NamespaceSummary' (Maybe Text) (Maybe POSIX) (Maybe Int) (Maybe Text) (Maybe Text) (Maybe NamespaceType) (Maybe Text) (Maybe NamespaceProperties) |
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.
Operation
A complex type that contains information about a specified operation.
See: newOperation smart constructor.
Constructors
| Operation' (Maybe OperationStatus) (Maybe POSIX) (Maybe POSIX) (Maybe (HashMap OperationTargetType Text)) (Maybe Text) (Maybe Text) (Maybe OperationType) (Maybe Text) |
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.
OperationFilter
data OperationFilter Source #
A complex type that lets you select the operations that you want to list.
See: newOperationFilter smart constructor.
Constructors
| OperationFilter' (Maybe FilterCondition) OperationFilterName [Text] |
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.
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' (Maybe OperationStatus) (Maybe Text) |
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.
PrivateDnsNamespaceChange
data PrivateDnsNamespaceChange Source #
Updated properties for the private DNS namespace.
See: newPrivateDnsNamespaceChange smart constructor.
Constructors
| PrivateDnsNamespaceChange' (Maybe Text) (Maybe PrivateDnsNamespacePropertiesChange) |
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.
PrivateDnsNamespaceProperties
data PrivateDnsNamespaceProperties Source #
DNS properties for the private DNS namespace.
See: newPrivateDnsNamespaceProperties smart constructor.
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.
PrivateDnsNamespacePropertiesChange
data PrivateDnsNamespacePropertiesChange Source #
Updated properties for the private DNS namespace.
See: newPrivateDnsNamespacePropertiesChange smart constructor.
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.
PrivateDnsPropertiesMutable
data PrivateDnsPropertiesMutable Source #
DNS properties for the private DNS namespace.
See: newPrivateDnsPropertiesMutable smart constructor.
Constructors
| PrivateDnsPropertiesMutable' SOA |
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.
PrivateDnsPropertiesMutableChange
data PrivateDnsPropertiesMutableChange Source #
Updated DNS properties for the private DNS namespace.
See: newPrivateDnsPropertiesMutableChange smart constructor.
Constructors
| PrivateDnsPropertiesMutableChange' SOAChange |
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.
PublicDnsNamespaceChange
data PublicDnsNamespaceChange Source #
Updated properties for the public DNS namespace.
See: newPublicDnsNamespaceChange smart constructor.
Constructors
| PublicDnsNamespaceChange' (Maybe Text) (Maybe PublicDnsNamespacePropertiesChange) |
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.
PublicDnsNamespaceProperties
data PublicDnsNamespaceProperties Source #
DNS properties for the public DNS namespace.
See: newPublicDnsNamespaceProperties smart constructor.
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.
PublicDnsNamespacePropertiesChange
data PublicDnsNamespacePropertiesChange Source #
Updated properties for the public DNS namespace.
See: newPublicDnsNamespacePropertiesChange smart constructor.
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.
PublicDnsPropertiesMutable
data PublicDnsPropertiesMutable Source #
DNS properties for the public DNS namespace.
See: newPublicDnsPropertiesMutable smart constructor.
Constructors
| PublicDnsPropertiesMutable' SOA |
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.
PublicDnsPropertiesMutableChange
data PublicDnsPropertiesMutableChange Source #
Updated DNS properties for the public DNS namespace.
See: newPublicDnsPropertiesMutableChange smart constructor.
Constructors
| PublicDnsPropertiesMutableChange' SOAChange |
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.
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' Natural |
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.
ServiceChange
data ServiceChange Source #
A complex type that contains changes to an existing service.
See: newServiceChange smart constructor.
Constructors
| ServiceChange' (Maybe HealthCheckConfig) (Maybe DnsConfigChange) (Maybe Text) |
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.
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' (Maybe FilterCondition) ServiceFilterName [Text] |
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.
ServiceInfo
data ServiceInfo Source #
A complex type that contains information about the specified service.
See: newServiceInfo smart constructor.
Constructors
| ServiceInfo' (Maybe Int) (Maybe Text) (Maybe HealthCheckConfig) (Maybe Text) (Maybe POSIX) (Maybe HealthCheckCustomConfig) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe ServiceType) (Maybe DnsConfig) (Maybe Text) |
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.
ServiceSummary
data ServiceSummary Source #
A complex type that contains information about a specified service.
See: newServiceSummary smart constructor.
Constructors
| ServiceSummary' (Maybe Int) (Maybe Text) (Maybe HealthCheckConfig) (Maybe POSIX) (Maybe HealthCheckCustomConfig) (Maybe Text) (Maybe Text) (Maybe ServiceType) (Maybe DnsConfig) (Maybe Text) |
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.
Tag
A custom key-value pair that's associated with a resource.
See: newTag smart constructor.
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.