Amazonka.Route53AutoNaming.Lens

Operations

CreateHttpNamespace

createHttpNamespace_creatorRequestId :: Lens' CreateHttpNamespace (Maybe Text)

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).

createHttpNamespace_description :: Lens' CreateHttpNamespace (Maybe Text)

A description for the namespace.

createHttpNamespace_tags :: Lens' CreateHttpNamespace (Maybe [Tag])

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.

createHttpNamespace_name :: Lens' CreateHttpNamespace Text

The name that you want to assign to this namespace.

createHttpNamespaceResponse_operationId :: Lens' CreateHttpNamespaceResponse (Maybe Text)

A value that you can use to determine whether the request completed successfully. To get the status of the operation, see GetOperation.

createHttpNamespaceResponse_httpStatus :: Lens' CreateHttpNamespaceResponse Int

The response's http status code.

CreatePrivateDnsNamespace

createPrivateDnsNamespace_creatorRequestId :: Lens' CreatePrivateDnsNamespace (Maybe Text)

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).

createPrivateDnsNamespace_description :: Lens' CreatePrivateDnsNamespace (Maybe Text)

A description for the namespace.

createPrivateDnsNamespace_properties :: Lens' CreatePrivateDnsNamespace (Maybe PrivateDnsNamespaceProperties)

Properties for the private DNS namespace.

createPrivateDnsNamespace_tags :: Lens' CreatePrivateDnsNamespace (Maybe [Tag])

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.

createPrivateDnsNamespace_name :: Lens' CreatePrivateDnsNamespace Text

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.

createPrivateDnsNamespace_vpc :: Lens' CreatePrivateDnsNamespace Text

The ID of the Amazon VPC that you want to associate the namespace with.

createPrivateDnsNamespaceResponse_operationId :: Lens' CreatePrivateDnsNamespaceResponse (Maybe Text)

A value that you can use to determine whether the request completed successfully. To get the status of the operation, see GetOperation.

createPrivateDnsNamespaceResponse_httpStatus :: Lens' CreatePrivateDnsNamespaceResponse Int

The response's http status code.

CreatePublicDnsNamespace

createPublicDnsNamespace_creatorRequestId :: Lens' CreatePublicDnsNamespace (Maybe Text)

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).

createPublicDnsNamespace_description :: Lens' CreatePublicDnsNamespace (Maybe Text)

A description for the namespace.

createPublicDnsNamespace_properties :: Lens' CreatePublicDnsNamespace (Maybe PublicDnsNamespaceProperties)

Properties for the public DNS namespace.

createPublicDnsNamespace_tags :: Lens' CreatePublicDnsNamespace (Maybe [Tag])

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.

createPublicDnsNamespace_name :: Lens' CreatePublicDnsNamespace Text

The name that you want to assign to this namespace.

Do not include sensitive information in the name. The name is publicly available using DNS queries.

createPublicDnsNamespaceResponse_operationId :: Lens' CreatePublicDnsNamespaceResponse (Maybe Text)

A value that you can use to determine whether the request completed successfully. To get the status of the operation, see GetOperation.

createPublicDnsNamespaceResponse_httpStatus :: Lens' CreatePublicDnsNamespaceResponse Int

The response's http status code.

CreateService

createService_creatorRequestId :: Lens' CreateService (Maybe Text)

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).

createService_description :: Lens' CreateService (Maybe Text)

A description for the service.

createService_dnsConfig :: Lens' CreateService (Maybe 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.

createService_healthCheckConfig :: Lens' CreateService (Maybe 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.

createService_healthCheckCustomConfig :: Lens' CreateService (Maybe 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.

createService_namespaceId :: Lens' CreateService (Maybe Text)

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.

createService_tags :: Lens' CreateService (Maybe [Tag])

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.

createService_type :: Lens' CreateService (Maybe ServiceTypeOption)

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.

createService_name :: Lens' CreateService Text

The name that you want to assign to the service.

Do not include sensitive information in the name if the namespace is discoverable by public DNS queries.

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.

createServiceResponse_service :: Lens' CreateServiceResponse (Maybe ServiceInfo)

A complex type that contains information about the new service.

createServiceResponse_httpStatus :: Lens' CreateServiceResponse Int

The response's http status code.

DeleteNamespace

deleteNamespace_id :: Lens' DeleteNamespace Text

The ID of the namespace that you want to delete.

deleteNamespaceResponse_operationId :: Lens' DeleteNamespaceResponse (Maybe Text)

A value that you can use to determine whether the request completed successfully. To get the status of the operation, see GetOperation.

deleteNamespaceResponse_httpStatus :: Lens' DeleteNamespaceResponse Int

The response's http status code.

DeleteService

deleteService_id :: Lens' DeleteService Text

The ID of the service that you want to delete.

deleteServiceResponse_httpStatus :: Lens' DeleteServiceResponse Int

The response's http status code.

DeregisterInstance

deregisterInstance_serviceId :: Lens' DeregisterInstance Text

The ID of the service that the instance is associated with.

deregisterInstance_instanceId :: Lens' DeregisterInstance Text

The value that you specified for Id in the RegisterInstance request.

deregisterInstanceResponse_operationId :: Lens' DeregisterInstanceResponse (Maybe Text)

A value that you can use to determine whether the request completed successfully. To get the status of the operation, see GetOperation.

deregisterInstanceResponse_httpStatus :: Lens' DeregisterInstanceResponse Int

The response's http status code.

DiscoverInstances

discoverInstances_healthStatus :: Lens' DiscoverInstances (Maybe HealthStatusFilter)

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.

discoverInstances_maxResults :: Lens' DiscoverInstances (Maybe Natural)

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.

discoverInstances_optionalParameters :: Lens' DiscoverInstances (Maybe (HashMap Text Text))

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.

discoverInstances_queryParameters :: Lens' DiscoverInstances (Maybe (HashMap Text Text))

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.

discoverInstances_namespaceName :: Lens' DiscoverInstances Text

The HttpName name of the namespace. It's found in the HttpProperties member of the Properties member of the namespace.

discoverInstances_serviceName :: Lens' DiscoverInstances Text

The name of the service that you specified when you registered the instance.

discoverInstancesResponse_instances :: Lens' DiscoverInstancesResponse (Maybe [HttpInstanceSummary])

A complex type that contains one HttpInstanceSummary for each registered instance.

discoverInstancesResponse_httpStatus :: Lens' DiscoverInstancesResponse Int

The response's http status code.

GetInstance

getInstance_serviceId :: Lens' GetInstance Text

The ID of the service that the instance is associated with.

getInstance_instanceId :: Lens' GetInstance Text

The ID of the instance that you want to get information about.

getInstanceResponse_instance :: Lens' GetInstanceResponse (Maybe Instance)

A complex type that contains information about a specified instance.

getInstanceResponse_httpStatus :: Lens' GetInstanceResponse Int

The response's http status code.

GetInstancesHealthStatus

getInstancesHealthStatus_instances :: Lens' GetInstancesHealthStatus (Maybe (NonEmpty Text))

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.

getInstancesHealthStatus_maxResults :: Lens' GetInstancesHealthStatus (Maybe Natural)

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.

getInstancesHealthStatus_nextToken :: Lens' GetInstancesHealthStatus (Maybe Text)

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.

getInstancesHealthStatus_serviceId :: Lens' GetInstancesHealthStatus Text

The ID of the service that the instance is associated with.

getInstancesHealthStatusResponse_nextToken :: Lens' GetInstancesHealthStatusResponse (Maybe Text)

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.

getInstancesHealthStatusResponse_status :: Lens' GetInstancesHealthStatusResponse (Maybe (HashMap Text HealthStatus))

A complex type that contains the IDs and the health status of the instances that you specified in the GetInstancesHealthStatus request.

getInstancesHealthStatusResponse_httpStatus :: Lens' GetInstancesHealthStatusResponse Int

The response's http status code.

GetNamespace

getNamespace_id :: Lens' GetNamespace Text

The ID of the namespace that you want to get information about.

getNamespaceResponse_namespace :: Lens' GetNamespaceResponse (Maybe Namespace)

A complex type that contains information about the specified namespace.

getNamespaceResponse_httpStatus :: Lens' GetNamespaceResponse Int

The response's http status code.

GetOperation

getOperation_operationId :: Lens' GetOperation Text

The ID of the operation that you want to get more information about.

getOperationResponse_operation :: Lens' GetOperationResponse (Maybe Operation)

A complex type that contains information about the operation.

getOperationResponse_httpStatus :: Lens' GetOperationResponse Int

The response's http status code.

GetService

getService_id :: Lens' GetService Text

The ID of the service that you want to get settings for.

getServiceResponse_service :: Lens' GetServiceResponse (Maybe ServiceInfo)

A complex type that contains information about the service.

getServiceResponse_httpStatus :: Lens' GetServiceResponse Int

The response's http status code.

ListInstances

listInstances_maxResults :: Lens' ListInstances (Maybe Natural)

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.

listInstances_nextToken :: Lens' ListInstances (Maybe Text)

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.

listInstances_serviceId :: Lens' ListInstances Text

The ID of the service that you want to list instances for.

listInstancesResponse_instances :: Lens' ListInstancesResponse (Maybe [InstanceSummary])

Summary information about the instances that are associated with the specified service.

listInstancesResponse_nextToken :: Lens' ListInstancesResponse (Maybe Text)

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.

listInstancesResponse_httpStatus :: Lens' ListInstancesResponse Int

The response's http status code.

ListNamespaces

listNamespaces_filters :: Lens' ListNamespaces (Maybe [NamespaceFilter])

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.

listNamespaces_maxResults :: Lens' ListNamespaces (Maybe Natural)

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.

listNamespaces_nextToken :: Lens' ListNamespaces (Maybe Text)

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.

listNamespacesResponse_namespaces :: Lens' ListNamespacesResponse (Maybe [NamespaceSummary])

An array that contains one NamespaceSummary object for each namespace that matches the specified filter criteria.

listNamespacesResponse_nextToken :: Lens' ListNamespacesResponse (Maybe Text)

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.

listNamespacesResponse_httpStatus :: Lens' ListNamespacesResponse Int

The response's http status code.

ListOperations

listOperations_filters :: Lens' ListOperations (Maybe [OperationFilter])

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.

listOperations_maxResults :: Lens' ListOperations (Maybe Natural)

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.

listOperations_nextToken :: Lens' ListOperations (Maybe Text)

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.

listOperationsResponse_nextToken :: Lens' ListOperationsResponse (Maybe Text)

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.

listOperationsResponse_operations :: Lens' ListOperationsResponse (Maybe [OperationSummary])

Summary information about the operations that match the specified criteria.

listOperationsResponse_httpStatus :: Lens' ListOperationsResponse Int

The response's http status code.

ListServices

listServices_filters :: Lens' ListServices (Maybe [ServiceFilter])

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.

listServices_maxResults :: Lens' ListServices (Maybe Natural)

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.

listServices_nextToken :: Lens' ListServices (Maybe Text)

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.

listServicesResponse_nextToken :: Lens' ListServicesResponse (Maybe Text)

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.

listServicesResponse_services :: Lens' ListServicesResponse (Maybe [ServiceSummary])

An array that contains one ServiceSummary object for each service that matches the specified filter criteria.

listServicesResponse_httpStatus :: Lens' ListServicesResponse Int

The response's http status code.

ListTagsForResource

listTagsForResource_resourceARN :: Lens' ListTagsForResource Text

The Amazon Resource Name (ARN) of the resource that you want to retrieve tags for.

listTagsForResourceResponse_tags :: Lens' ListTagsForResourceResponse (Maybe [Tag])

The tags that are assigned to the resource.

listTagsForResourceResponse_httpStatus :: Lens' ListTagsForResourceResponse Int

The response's http status code.

RegisterInstance

registerInstance_creatorRequestId :: Lens' RegisterInstance (Maybe Text)

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).

registerInstance_serviceId :: Lens' RegisterInstance Text

The ID of the service that you want to use for settings for the instance.

registerInstance_instanceId :: Lens' RegisterInstance Text

An identifier that you want to associate with the instance. Note the following:

• If the service that's specified by ServiceId includes settings for an SRV record, the value of InstanceId is automatically included as part of the value for the SRV record. 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 InstanceId and ServiceId, 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 ListHealthChecks request, for example.

Do not include sensitive information in InstanceId if the namespace is discoverable by public DNS queries and any Type member of DnsRecord for the service contains SRV because the InstanceId is discoverable by public DNS queries.

registerInstance_attributes :: Lens' RegisterInstance (HashMap Text Text)

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.

Do not include sensitive information in the attributes if the namespace is discoverable by public DNS queries.

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 ServiceId must include settings for an A record, an AAAA record, or both.
• In the service that's specified by ServiceId, the value of RoutingPolicy must be WEIGHTED.
• If the service that's specified by ServiceId includes HealthCheckConfig settings, 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 the AWS_INSTANCE attributes.

AWS_EC2_INSTANCE_ID

HTTP namespaces only. The Amazon EC2 instance ID for the instance. If the AWS_EC2_INSTANCE_ID attribute is specified, then the only other attribute that can be specified is AWS_INIT_HEALTH_STATUS. When the AWS_EC2_INSTANCE_ID attribute is specified, then the AWS_INSTANCE_IPV4 attribute will be filled out with the primary private IPv4 address.

AWS_INIT_HEALTH_STATUS

If the service configuration includes HealthCheckCustomConfig, you can optionally use AWS_INIT_HEALTH_STATUS to specify the initial status of the custom health check, HEALTHY or UNHEALTHY. If you don't specify a value for AWS_INIT_HEALTH_STATUS, the initial status is HEALTHY.

AWS_INSTANCE_CNAME

If the service configuration includes a CNAME record, 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 ServiceId includes settings for an CNAME record.

AWS_INSTANCE_IPV4

If the service configuration includes an A record, 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 ServiceId includes settings for an A record. If the service includes settings for an SRV record, you must specify a value for AWS_INSTANCE_IPV4, AWS_INSTANCE_IPV6, or both.

AWS_INSTANCE_IPV6

If the service configuration includes an AAAA record, 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 ServiceId includes settings for an AAAA record. If the service includes settings for an SRV record, you must specify a value for AWS_INSTANCE_IPV4, AWS_INSTANCE_IPV6, or both.

AWS_INSTANCE_PORT

If the service includes an SRV record, 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 SRV record 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.

registerInstanceResponse_operationId :: Lens' RegisterInstanceResponse (Maybe Text)

A value that you can use to determine whether the request completed successfully. To get the status of the operation, see GetOperation.

registerInstanceResponse_httpStatus :: Lens' RegisterInstanceResponse Int

The response's http status code.

TagResource

tagResource_resourceARN :: Lens' TagResource Text

The Amazon Resource Name (ARN) of the resource that you want to retrieve tags for.

tagResource_tags :: Lens' TagResource [Tag]

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.

tagResourceResponse_httpStatus :: Lens' TagResourceResponse Int

The response's http status code.

UntagResource

untagResource_resourceARN :: Lens' UntagResource Text

The Amazon Resource Name (ARN) of the resource that you want to retrieve tags for.

untagResource_tagKeys :: Lens' UntagResource [Text]

The tag keys to remove from the specified resource.

untagResourceResponse_httpStatus :: Lens' UntagResourceResponse Int

The response's http status code.

UpdateHttpNamespace

updateHttpNamespace_updaterRequestId :: Lens' UpdateHttpNamespace (Maybe Text)

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).

updateHttpNamespace_id :: Lens' UpdateHttpNamespace Text

The ID of the namespace that you want to update.

updateHttpNamespace_namespace :: Lens' UpdateHttpNamespace HttpNamespaceChange

Updated properties for the the HTTP namespace.

updateHttpNamespaceResponse_operationId :: Lens' UpdateHttpNamespaceResponse (Maybe Text)

A value that you can use to determine whether the request completed successfully. To get the status of the operation, see GetOperation.

updateHttpNamespaceResponse_httpStatus :: Lens' UpdateHttpNamespaceResponse Int

The response's http status code.

UpdateInstanceCustomHealthStatus

updateInstanceCustomHealthStatus_serviceId :: Lens' UpdateInstanceCustomHealthStatus Text

The ID of the service that includes the configuration for the custom health check that you want to change the status for.

updateInstanceCustomHealthStatus_instanceId :: Lens' UpdateInstanceCustomHealthStatus Text

The ID of the instance that you want to change the health status for.

updateInstanceCustomHealthStatus_status :: Lens' UpdateInstanceCustomHealthStatus CustomHealthStatus

The new status of the instance, HEALTHY or UNHEALTHY.

UpdatePrivateDnsNamespace

updatePrivateDnsNamespace_updaterRequestId :: Lens' UpdatePrivateDnsNamespace (Maybe Text)

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).

updatePrivateDnsNamespace_id :: Lens' UpdatePrivateDnsNamespace Text

The ID of the namespace that you want to update.

updatePrivateDnsNamespace_namespace :: Lens' UpdatePrivateDnsNamespace PrivateDnsNamespaceChange

Updated properties for the private DNS namespace.

updatePrivateDnsNamespaceResponse_operationId :: Lens' UpdatePrivateDnsNamespaceResponse (Maybe Text)

A value that you can use to determine whether the request completed successfully. To get the status of the operation, see GetOperation.

updatePrivateDnsNamespaceResponse_httpStatus :: Lens' UpdatePrivateDnsNamespaceResponse Int

The response's http status code.

UpdatePublicDnsNamespace

updatePublicDnsNamespace_updaterRequestId :: Lens' UpdatePublicDnsNamespace (Maybe Text)

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).

updatePublicDnsNamespace_id :: Lens' UpdatePublicDnsNamespace Text

The ID of the namespace being updated.

updatePublicDnsNamespace_namespace :: Lens' UpdatePublicDnsNamespace PublicDnsNamespaceChange

Updated properties for the public DNS namespace.

updatePublicDnsNamespaceResponse_operationId :: Lens' UpdatePublicDnsNamespaceResponse (Maybe Text)

A value that you can use to determine whether the request completed successfully. To get the status of the operation, see GetOperation.

updatePublicDnsNamespaceResponse_httpStatus :: Lens' UpdatePublicDnsNamespaceResponse Int

The response's http status code.

UpdateService

updateService_id :: Lens' UpdateService Text

The ID of the service that you want to update.

updateService_service :: Lens' UpdateService ServiceChange

A complex type that contains the new settings for the service.

updateServiceResponse_operationId :: Lens' UpdateServiceResponse (Maybe Text)

A value that you can use to determine whether the request completed successfully. To get the status of the operation, see GetOperation.

updateServiceResponse_httpStatus :: Lens' UpdateServiceResponse Int

The response's http status code.

Types

DnsConfig

dnsConfig_namespaceId :: Lens' DnsConfig (Maybe Text)

/Use NamespaceId in Service instead./

The ID of the namespace to use for DNS configuration.

dnsConfig_routingPolicy :: Lens' DnsConfig (Maybe 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 A record 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 A record and a health check. You use the service to register 10 instances. Route 53 responds to DNS queries with the IP address for one randomly selected instance from among the healthy instances. If no instances are healthy, Route 53 responds to DNS queries as if all of the instances were healthy.

If you don't define a health check for the service, Route 53 assumes that all instances are healthy and returns the applicable value for one randomly selected instance.

For more information about the weighted routing policy, see Weighted Routing in the Route 53 Developer Guide.

dnsConfig_dnsRecords :: Lens' DnsConfig [DnsRecord]

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

dnsConfigChange_dnsRecords :: Lens' DnsConfigChange [DnsRecord]

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

dnsProperties_hostedZoneId :: Lens' DnsProperties (Maybe Text)

The ID for the Route 53 hosted zone that Cloud Map creates when you create a namespace.

dnsProperties_soa :: Lens' DnsProperties (Maybe SOA)

Start of Authority (SOA) record for the hosted zone.

DnsRecord

dnsRecord_type :: Lens' DnsRecord RecordType

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:

• A
• AAAA
• A and AAAA
• SRV
• CNAME

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 WEIGHTED for the value of RoutingPolicy.
• You can't specify both CNAME for Type and settings for HealthCheckConfig. If you do, the request will fail with an InvalidInput error.

SRV

Route 53 returns the value for an SRV record. The value for an SRV record uses the following values:

priority weight port service-hostname

Note the following about the values:

• The values of priority and weight are both set to 1 and can't be changed.
• The value of port comes from the value that you specify for the AWS_INSTANCE_PORT attribute when you submit a RegisterInstance request.

• The value of service-hostname is a concatenation of the following values:

  • The value that you specify for InstanceId when you register an instance.
  • The name of the service.
  • The name of the namespace.

  For example, if the value of InstanceId is test, the name of the service is backend, and the name of the namespace is example.com, the value of service-hostname is the following:

  test.backend.example.com

If you specify settings for an SRV record, note the following:

• If you specify values for AWS_INSTANCE_IPV4, AWS_INSTANCE_IPV6, or both in the RegisterInstance request, Cloud Map automatically creates A and/or AAAA records that have the same name as the value of service-hostname in the SRV record. You can ignore these records.
• If you're using a system that requires a specific SRV format, such as HAProxy, see the Name element in the documentation about CreateService for information about how to specify the correct name format.

dnsRecord_ttl :: Lens' DnsRecord Natural

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

healthCheckConfig_failureThreshold :: Lens' HealthCheckConfig (Maybe Natural)

The number of consecutive health checks that an endpoint must pass or fail for Route 53 to change the current status of the endpoint from unhealthy to healthy or the other way around. For more information, see How Route 53 Determines Whether an Endpoint Is Healthy in the Route 53 Developer Guide.

healthCheckConfig_resourcePath :: Lens' HealthCheckConfig (Maybe Text)

The path that you want Route 53 to request when performing health checks. The path can be any value that your endpoint returns an HTTP status code of a 2xx or 3xx format for when the endpoint is healthy. An example file is /docs/route53-health-check.html. Route 53 automatically adds the DNS name for the service. If you don't specify a value for ResourcePath, the default value is /.

If you specify TCP for Type, you must not specify a value for ResourcePath.

healthCheckConfig_type :: Lens' HealthCheckConfig HealthCheckType

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 TCP for Type, don't specify a value for ResourcePath.

For more information, see How Route 53 Determines Whether an Endpoint Is Healthy in the Route 53 Developer Guide.

HealthCheckCustomConfig

healthCheckCustomConfig_failureThreshold :: Lens' HealthCheckCustomConfig (Maybe Natural)

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

httpInstanceSummary_attributes :: Lens' HttpInstanceSummary (Maybe (HashMap Text Text))

If you included any attributes when you registered the instance, the values of those attributes.

httpInstanceSummary_healthStatus :: Lens' HttpInstanceSummary (Maybe HealthStatus)

If you configured health checking in the service, the current health status of the service instance.

httpInstanceSummary_instanceId :: Lens' HttpInstanceSummary (Maybe Text)

The ID of an instance that matches the values that you specified in the request.

httpInstanceSummary_namespaceName :: Lens' HttpInstanceSummary (Maybe Text)

The HttpName name of the namespace. It's found in the HttpProperties member of the Properties member of the namespace.

httpInstanceSummary_serviceName :: Lens' HttpInstanceSummary (Maybe Text)

The name of the service that you specified when you registered the instance.

HttpNamespaceChange

httpNamespaceChange_description :: Lens' HttpNamespaceChange Text

An updated description for the HTTP namespace.

HttpProperties

httpProperties_httpName :: Lens' HttpProperties (Maybe Text)

The name of an HTTP namespace.

Instance

instance_attributes :: Lens' Instance (Maybe (HashMap Text Text))

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.

Do not include sensitive information in the attributes if the namespace is discoverable by public DNS queries.

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 ServiceId must include settings for an A record, an AAAA record, or both.
• In the service that's specified by ServiceId, the value of RoutingPolicy must be WEIGHTED.
• If the service that's specified by ServiceId includes HealthCheckConfig settings, 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 the AWS_INSTANCE attributes.

AWS_EC2_INSTANCE_ID

HTTP namespaces only. The Amazon EC2 instance ID for the instance. The AWS_INSTANCE_IPV4 attribute contains the primary private IPv4 address.

AWS_INIT_HEALTH_STATUS

If the service configuration includes HealthCheckCustomConfig, you can optionally use AWS_INIT_HEALTH_STATUS to specify the initial status of the custom health check, HEALTHY or UNHEALTHY. If you don't specify a value for AWS_INIT_HEALTH_STATUS, the initial status is HEALTHY.

AWS_INSTANCE_CNAME

If the service configuration includes a CNAME record, 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 ServiceId includes settings for an CNAME record.

AWS_INSTANCE_IPV4

If the service configuration includes an A record, 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 ServiceId includes settings for an A record. If the service includes settings for an SRV record, you must specify a value for AWS_INSTANCE_IPV4, AWS_INSTANCE_IPV6, or both.

AWS_INSTANCE_IPV6

If the service configuration includes an AAAA record, 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 ServiceId includes settings for an AAAA record. If the service includes settings for an SRV record, you must specify a value for AWS_INSTANCE_IPV4, AWS_INSTANCE_IPV6, or both.

AWS_INSTANCE_PORT

If the service includes an SRV record, 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 SRV record or a Route 53 health check when you created the service.

instance_creatorRequestId :: Lens' Instance (Maybe Text)

A unique string that identifies the request and that allows failed RegisterInstance requests to be retried without the risk of executing the operation twice. You must use a unique CreatorRequestId string every time you submit a RegisterInstance request if you're registering additional instances for the same namespace and service. CreatorRequestId can be any unique string (for example, a date/time stamp).

instance_id :: Lens' Instance Text

An identifier that you want to associate with the instance. Note the following:

• If the service that's specified by ServiceId includes settings for an SRV record, the value of InstanceId is automatically included as part of the value for the SRV record. 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 InstanceId and ServiceId, 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 ListHealthChecks request, for example.

InstanceSummary

instanceSummary_attributes :: Lens' InstanceSummary (Maybe (HashMap Text Text))

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_ID attribute is specified, then the AWS_INSTANCE_IPV4 attribute contains the primary private IPv4 address.

AWS_INIT_HEALTH_STATUS

If the service configuration includes HealthCheckCustomConfig, you can optionally use AWS_INIT_HEALTH_STATUS to specify the initial status of the custom health check, HEALTHY or UNHEALTHY. If you don't specify a value for AWS_INIT_HEALTH_STATUS, the initial status is HEALTHY.

AWS_INSTANCE_CNAME

For a CNAME record, the domain name that Route 53 returns in response to DNS queries (for example, example.com).

AWS_INSTANCE_IPV4

For an A record, the IPv4 address that Route 53 returns in response to DNS queries (for example, 192.0.2.44).

AWS_INSTANCE_IPV6

For an AAAA record, 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 SRV record, the value that Route 53 returns for the port. In addition, if the service includes HealthCheckConfig, the port on the endpoint that Route 53 sends requests to.

instanceSummary_id :: Lens' InstanceSummary (Maybe Text)

The ID for an instance that you created by using a specified service.

Namespace

namespace_arn :: Lens' Namespace (Maybe Text)

The Amazon Resource Name (ARN) that Cloud Map assigns to the namespace when you create it.

namespace_createDate :: Lens' Namespace (Maybe UTCTime)

The date that the namespace was created, in Unix date/time format and Coordinated Universal Time (UTC). The value of CreateDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

namespace_creatorRequestId :: Lens' Namespace (Maybe Text)

A unique string that identifies the request and that allows failed requests to be retried without the risk of running an operation twice.

namespace_description :: Lens' Namespace (Maybe Text)

The description that you specify for the namespace when you create it.

namespace_id :: Lens' Namespace (Maybe Text)

The ID of a namespace.

namespace_name :: Lens' Namespace (Maybe Text)

The name of the namespace, such as example.com.

namespace_properties :: Lens' Namespace (Maybe NamespaceProperties)

A complex type that contains information that's specific to the type of the namespace.

namespace_serviceCount :: Lens' Namespace (Maybe Int)

The number of services that are associated with the namespace.

namespace_type :: Lens' Namespace (Maybe NamespaceType)

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 DiscoverInstances API.

DNS_PUBLIC

Instances can be discovered using public DNS queries and using the DiscoverInstances API.

DNS_PRIVATE

Instances can be discovered using DNS queries in VPCs and using the DiscoverInstances API.

NamespaceFilter

namespaceFilter_condition :: Lens' NamespaceFilter (Maybe FilterCondition)

Specify the operator that you want to use to determine whether a namespace matches the specified value. Valid values for Condition are one of the following.

• EQ: When you specify EQ for Condition, you can specify only one value. EQ is supported for TYPE, NAME, and HTTP_NAME. EQ is the default condition and can be omitted.
• BEGINS_WITH: When you specify BEGINS_WITH for Condition, you can specify only one value. BEGINS_WITH is supported for TYPE, NAME, and HTTP_NAME.

namespaceFilter_name :: Lens' NamespaceFilter NamespaceFilterName

Specify the namespaces that you want to get using one of the following.

• TYPE: Gets the namespaces of the specified type.
• NAME: Gets the namespaces with the specified name.
• HTTP_NAME: Gets the namespaces with the specified HTTP name.

namespaceFilter_values :: Lens' NamespaceFilter [Text]

Specify the values that are applicable to the value that you specify for Name.

• TYPE: Specify HTTP, DNS_PUBLIC, or DNS_PRIVATE.
• NAME: Specify the name of the namespace, which is found in Namespace.Name.
• HTTP_NAME: Specify the HTTP name of the namespace, which is found in Namespace.Properties.HttpProperties.HttpName.

NamespaceProperties

namespaceProperties_dnsProperties :: Lens' NamespaceProperties (Maybe DnsProperties)

A complex type that contains the ID for the Route 53 hosted zone that Cloud Map creates when you create a namespace.

namespaceProperties_httpProperties :: Lens' NamespaceProperties (Maybe HttpProperties)

A complex type that contains the name of an HTTP namespace.

NamespaceSummary

namespaceSummary_arn :: Lens' NamespaceSummary (Maybe Text)

The Amazon Resource Name (ARN) that Cloud Map assigns to the namespace when you create it.

namespaceSummary_createDate :: Lens' NamespaceSummary (Maybe UTCTime)

The date and time that the namespace was created.

namespaceSummary_description :: Lens' NamespaceSummary (Maybe Text)

A description for the namespace.

namespaceSummary_id :: Lens' NamespaceSummary (Maybe Text)

The ID of the namespace.

namespaceSummary_name :: Lens' NamespaceSummary (Maybe Text)

The name of the namespace. When you create a namespace, Cloud Map automatically creates a Route 53 hosted zone that has the same name as the namespace.

namespaceSummary_properties :: Lens' NamespaceSummary (Maybe NamespaceProperties)

The properties of the namespace.

namespaceSummary_serviceCount :: Lens' NamespaceSummary (Maybe Int)

The number of services that were created using the namespace.

namespaceSummary_type :: Lens' NamespaceSummary (Maybe NamespaceType)

The type of the namespace, either public or private.

Operation

operation_createDate :: Lens' Operation (Maybe UTCTime)

The date and time that the request was submitted, in Unix date/time format and Coordinated Universal Time (UTC). The value of CreateDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

operation_errorCode :: Lens' Operation (Maybe Text)

The code associated with ErrorMessage. Values for ErrorCode include the following:

• ACCESS_DENIED

• CANNOT_CREATE_HOSTED_ZONE

• EXPIRED_TOKEN

• HOSTED_ZONE_NOT_FOUND

• INTERNAL_FAILURE

• INVALID_CHANGE_BATCH

• THROTTLED_REQUEST

operation_errorMessage :: Lens' Operation (Maybe Text)

If the value of Status is FAIL, the reason that the operation failed.

operation_id :: Lens' Operation (Maybe Text)

The ID of the operation that you want to get information about.

operation_status :: Lens' Operation (Maybe OperationStatus)

The status of the operation. Values include the following:

SUBMITTED

This is the initial state that occurs immediately after you submit a request.

PENDING

Cloud Map is performing the operation.

SUCCESS

The operation succeeded.

FAIL

The operation failed. For the failure reason, see ErrorMessage.

operation_targets :: Lens' Operation (Maybe (HashMap OperationTargetType Text))

The name of the target entity that's associated with the operation:

NAMESPACE

The namespace ID is returned in the ResourceId property.

SERVICE

The service ID is returned in the ResourceId property.

INSTANCE

The instance ID is returned in the ResourceId property.

operation_type :: Lens' Operation (Maybe OperationType)

The name of the operation that's associated with the specified ID.

operation_updateDate :: Lens' Operation (Maybe UTCTime)

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.

OperationFilter

operationFilter_condition :: Lens' OperationFilter (Maybe FilterCondition)

The operator that you want to use to determine whether an operation matches the specified value. Valid values for condition include:

• EQ: When you specify EQ for the condition, you can specify only one value. EQ is supported for NAMESPACE_ID, SERVICE_ID, STATUS, and TYPE. EQ is the default condition and can be omitted.
• IN: When you specify IN for the condition, you can specify a list of one or more values. IN is supported for STATUS and TYPE. 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. BETWEEN is supported for UPDATE_DATE.

operationFilter_name :: Lens' OperationFilter OperationFilterName

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, or FAIL.
• TYPE: Gets specified types of operation.
• UPDATE_DATE: Gets operations that changed status during a specified date/time range.

operationFilter_values :: Lens' OperationFilter [Text]

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, or FAIL.
• TYPE: Specify one or more of the following types: CREATE_NAMESPACE, DELETE_NAMESPACE, UPDATE_SERVICE, REGISTER_INSTANCE, or DEREGISTER_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

operationSummary_id :: Lens' OperationSummary (Maybe Text)

The ID for an operation.

operationSummary_status :: Lens' OperationSummary (Maybe OperationStatus)

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.

PrivateDnsNamespaceChange

privateDnsNamespaceChange_description :: Lens' PrivateDnsNamespaceChange (Maybe Text)

An updated description for the private DNS namespace.

privateDnsNamespaceChange_properties :: Lens' PrivateDnsNamespaceChange (Maybe PrivateDnsNamespacePropertiesChange)

Properties to be updated in the private DNS namespace.

PrivateDnsNamespaceProperties

privateDnsNamespaceProperties_dnsProperties :: Lens' PrivateDnsNamespaceProperties PrivateDnsPropertiesMutable

DNS properties for the private DNS namespace.

PrivateDnsNamespacePropertiesChange

privateDnsNamespacePropertiesChange_dnsProperties :: Lens' PrivateDnsNamespacePropertiesChange PrivateDnsPropertiesMutableChange

Updated DNS properties for the private DNS namespace.

PrivateDnsPropertiesMutable

privateDnsPropertiesMutable_soa :: Lens' PrivateDnsPropertiesMutable SOA

Fields for the Start of Authority (SOA) record for the hosted zone for the private DNS namespace.

PrivateDnsPropertiesMutableChange

privateDnsPropertiesMutableChange_soa :: Lens' PrivateDnsPropertiesMutableChange SOAChange

Updated fields for the Start of Authority (SOA) record for the hosted zone for the private DNS namespace.

PublicDnsNamespaceChange

publicDnsNamespaceChange_description :: Lens' PublicDnsNamespaceChange (Maybe Text)

An updated description for the public DNS namespace.

publicDnsNamespaceChange_properties :: Lens' PublicDnsNamespaceChange (Maybe PublicDnsNamespacePropertiesChange)

Properties to be updated in the public DNS namespace.

PublicDnsNamespaceProperties

publicDnsNamespaceProperties_dnsProperties :: Lens' PublicDnsNamespaceProperties PublicDnsPropertiesMutable

DNS properties for the public DNS namespace.

PublicDnsNamespacePropertiesChange

publicDnsNamespacePropertiesChange_dnsProperties :: Lens' PublicDnsNamespacePropertiesChange PublicDnsPropertiesMutableChange

Updated DNS properties for the hosted zone for the public DNS namespace.

PublicDnsPropertiesMutable

publicDnsPropertiesMutable_soa :: Lens' PublicDnsPropertiesMutable SOA

Start of Authority (SOA) record for the hosted zone for the public DNS namespace.

PublicDnsPropertiesMutableChange

publicDnsPropertiesMutableChange_soa :: Lens' PublicDnsPropertiesMutableChange SOAChange

Updated fields for the Start of Authority (SOA) record for the hosted zone for the public DNS namespace.

SOA

soa_ttl :: Lens' SOA Natural

The time to live (TTL) for purposes of negative caching.

SOAChange

sOAChange_ttl :: Lens' SOAChange Natural

The updated time to live (TTL) for purposes of negative caching.

ServiceChange

serviceChange_description :: Lens' ServiceChange (Maybe Text)

A description for the service.

serviceChange_dnsConfig :: Lens' ServiceChange (Maybe DnsConfigChange)

Information about the Route 53 DNS records that you want Cloud Map to create when you register an instance.

serviceChange_healthCheckConfig :: Lens' ServiceChange (Maybe 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.

ServiceFilter

serviceFilter_condition :: Lens' ServiceFilter (Maybe FilterCondition)

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 specify EQ, specify one namespace ID for Values. EQ is the default condition and can be omitted.

serviceFilter_name :: Lens' ServiceFilter ServiceFilterName

Specify NAMESPACE_ID.

serviceFilter_values :: Lens' ServiceFilter [Text]

The values that are applicable to the value that you specify for Condition to filter the list of services.

ServiceInfo

serviceInfo_arn :: Lens' ServiceInfo (Maybe Text)

The Amazon Resource Name (ARN) that Cloud Map assigns to the service when you create it.

serviceInfo_createDate :: Lens' ServiceInfo (Maybe UTCTime)

The date and time that the service was created, in Unix format and Coordinated Universal Time (UTC). The value of CreateDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

serviceInfo_creatorRequestId :: Lens' ServiceInfo (Maybe Text)

A unique string that identifies the request and that allows failed requests to be retried without the risk of running the operation twice. CreatorRequestId can be any unique string (for example, a date/timestamp).

serviceInfo_description :: Lens' ServiceInfo (Maybe Text)

The description of the service.

serviceInfo_dnsConfig :: Lens' ServiceInfo (Maybe 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.

The record types of a service can only be changed by deleting the service and recreating it with a new Dnsconfig.

serviceInfo_healthCheckConfig :: Lens' ServiceInfo (Maybe 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.

serviceInfo_healthCheckCustomConfig :: Lens' ServiceInfo (Maybe 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.

serviceInfo_id :: Lens' ServiceInfo (Maybe Text)

The ID that Cloud Map assigned to the service when you created it.

serviceInfo_instanceCount :: Lens' ServiceInfo (Maybe Int)

The number of instances that are currently associated with the service. Instances that were previously associated with the service but that are deleted aren't included in the count. The count might not reflect pending registrations and deregistrations.

serviceInfo_name :: Lens' ServiceInfo (Maybe Text)

The name of the service.

serviceInfo_namespaceId :: Lens' ServiceInfo (Maybe Text)

The ID of the namespace that was used to create the service.

serviceInfo_type :: Lens' ServiceInfo (Maybe ServiceType)

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 DiscoverInstances API operation.

HTTP

The service instances can only be discovered using the DiscoverInstances API operation.

DNS

Reserved.

ServiceSummary

serviceSummary_arn :: Lens' ServiceSummary (Maybe Text)

The Amazon Resource Name (ARN) that Cloud Map assigns to the service when you create it.

serviceSummary_createDate :: Lens' ServiceSummary (Maybe UTCTime)

The date and time that the service was created.

serviceSummary_description :: Lens' ServiceSummary (Maybe Text)

The description that you specify when you create the service.

serviceSummary_dnsConfig :: Lens' ServiceSummary (Maybe DnsConfig)

Information about the Route 53 DNS records that you want Cloud Map to create when you register an instance.

serviceSummary_healthCheckConfig :: Lens' ServiceSummary (Maybe 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.

serviceSummary_healthCheckCustomConfig :: Lens' ServiceSummary (Maybe 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 HealthCheckConfig because the resource isn't available over the internet. For example, you can use a custom health check when the instance is in an Amazon VPC. (To check the health of resources in a VPC, the health checker must also be in the VPC.)
• You want to use a third-party health checker regardless of where your resources are located.

If you specify a health check configuration, you can specify either HealthCheckCustomConfig or HealthCheckConfig but not both.

serviceSummary_id :: Lens' ServiceSummary (Maybe Text)

The ID that Cloud Map assigned to the service when you created it.

serviceSummary_instanceCount :: Lens' ServiceSummary (Maybe Int)

The number of instances that are currently associated with the service. Instances that were previously associated with the service but that are deleted aren't included in the count. The count might not reflect pending registrations and deregistrations.

serviceSummary_name :: Lens' ServiceSummary (Maybe Text)

The name of the service.

serviceSummary_type :: Lens' ServiceSummary (Maybe ServiceType)

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 DiscoverInstances API operation.

HTTP

The service instances can only be discovered using the DiscoverInstances API operation.

DNS

Reserved.

Tag

tag_key :: Lens' Tag Text

The key identifier, or name, of the tag.

tag_value :: Lens' Tag Text

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.