AWS Cloud Map

2020/06/08 - AWS Cloud Map - 3 new 4 updated api methods

Changes  Added support for tagging Service and Namespace type resources in Cloud Map

ListTagsForResource (new) Link ¶

Lists tags for the specified resource.

See also: AWS API Documentation

Request Syntax

client.list_tags_for_resource(
    ResourceARN='string'
)
type ResourceARN

string

param ResourceARN

[REQUIRED]

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

rtype

dict

returns

Response Syntax

{
    'Tags': [
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
}

Response Structure

  • (dict) --

    • Tags (list) --

      The tags that are assigned to the resource.

      • (dict) --

        A custom key-value pair associated with a resource.

        • Key (string) --

          The key identifier, or name, of the tag.

        • Value (string) --

          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.

TagResource (new) Link ¶

Adds one or more tags to the specified resource.

See also: AWS API Documentation

Request Syntax

client.tag_resource(
    ResourceARN='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)
type ResourceARN

string

param ResourceARN

[REQUIRED]

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

type Tags

list

param Tags

[REQUIRED]

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.

  • (dict) --

    A custom key-value pair associated with a resource.

    • Key (string) -- [REQUIRED]

      The key identifier, or name, of the tag.

    • Value (string) -- [REQUIRED]

      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.

rtype

dict

returns

Response Syntax

{}

Response Structure

  • (dict) --

UntagResource (new) Link ¶

Removes one or more tags from the specified resource.

See also: AWS API Documentation

Request Syntax

client.untag_resource(
    ResourceARN='string',
    TagKeys=[
        'string',
    ]
)
type ResourceARN

string

param ResourceARN

[REQUIRED]

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

type TagKeys

list

param TagKeys

[REQUIRED]

The tag keys to remove from the specified resource.

  • (string) --

rtype

dict

returns

Response Syntax

{}

Response Structure

  • (dict) --

CreateHttpNamespace (updated) Link ¶
Changes (request)
{'Tags': [{'Key': 'string', 'Value': 'string'}]}

Creates an HTTP namespace. Service instances that you register using an HTTP namespace can be discovered using a DiscoverInstances request but can't be discovered using DNS.

For the current limit on the number of namespaces that you can create using the same AWS account, see AWS Cloud Map Limits in the AWS Cloud Map Developer Guide .

See also: AWS API Documentation

Request Syntax

client.create_http_namespace(
    Name='string',
    CreatorRequestId='string',
    Description='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)
type Name

string

param Name

[REQUIRED]

The name that you want to assign to this namespace.

type CreatorRequestId

string

param CreatorRequestId

A unique string that identifies the request and that allows failed CreateHttpNamespace requests to be retried without the risk of executing the operation twice. CreatorRequestId can be any unique string, for example, a date/time stamp.

This field is autopopulated if not provided.

type Description

string

param Description

A description for the namespace.

type Tags

list

param Tags

The tags to add to the namespace. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.

  • (dict) --

    A custom key-value pair associated with a resource.

    • Key (string) -- [REQUIRED]

      The key identifier, or name, of the tag.

    • Value (string) -- [REQUIRED]

      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.

rtype

dict

returns

Response Syntax

{
    'OperationId': 'string'
}

Response Structure

  • (dict) --

    • OperationId (string) --

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

CreatePrivateDnsNamespace (updated) Link ¶
Changes (request)
{'Tags': [{'Key': 'string', 'Value': 'string'}]}

Creates a private namespace based on DNS, which will be visible only inside a specified Amazon VPC. The namespace defines your service naming scheme. For example, if you name your namespace example.com and name your service backend , the resulting DNS name for the service will be backend.example.com . For the current limit on the number of namespaces that you can create using the same AWS account, see AWS Cloud Map Limits in the AWS Cloud Map Developer Guide .

See also: AWS API Documentation

Request Syntax

client.create_private_dns_namespace(
    Name='string',
    CreatorRequestId='string',
    Description='string',
    Vpc='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)
type Name

string

param Name

[REQUIRED]

The name that you want to assign to this namespace. When you create a private DNS namespace, AWS Cloud Map automatically creates an Amazon Route 53 private hosted zone that has the same name as the namespace.

type CreatorRequestId

string

param CreatorRequestId

A unique string that identifies the request and that allows failed CreatePrivateDnsNamespace requests to be retried without the risk of executing the operation twice. CreatorRequestId can be any unique string, for example, a date/time stamp.

This field is autopopulated if not provided.

type Description

string

param Description

A description for the namespace.

type Vpc

string

param Vpc

[REQUIRED]

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

type Tags

list

param Tags

The tags to add to the namespace. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.

  • (dict) --

    A custom key-value pair associated with a resource.

    • Key (string) -- [REQUIRED]

      The key identifier, or name, of the tag.

    • Value (string) -- [REQUIRED]

      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.

rtype

dict

returns

Response Syntax

{
    'OperationId': 'string'
}

Response Structure

  • (dict) --

    • OperationId (string) --

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

CreatePublicDnsNamespace (updated) Link ¶
Changes (request)
{'Tags': [{'Key': 'string', 'Value': 'string'}]}

Creates a public namespace based on DNS, which will be visible on the internet. The namespace defines your service naming scheme. For example, if you name your namespace example.com and name your service backend , the resulting DNS name for the service will be backend.example.com . For the current limit on the number of namespaces that you can create using the same AWS account, see AWS Cloud Map Limits in the AWS Cloud Map Developer Guide .

See also: AWS API Documentation

Request Syntax

client.create_public_dns_namespace(
    Name='string',
    CreatorRequestId='string',
    Description='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)
type Name

string

param Name

[REQUIRED]

The name that you want to assign to this namespace.

type CreatorRequestId

string

param CreatorRequestId

A unique string that identifies the request and that allows failed CreatePublicDnsNamespace requests to be retried without the risk of executing the operation twice. CreatorRequestId can be any unique string, for example, a date/time stamp.

This field is autopopulated if not provided.

type Description

string

param Description

A description for the namespace.

type Tags

list

param Tags

The tags to add to the namespace. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.

  • (dict) --

    A custom key-value pair associated with a resource.

    • Key (string) -- [REQUIRED]

      The key identifier, or name, of the tag.

    • Value (string) -- [REQUIRED]

      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.

rtype

dict

returns

Response Syntax

{
    'OperationId': 'string'
}

Response Structure

  • (dict) --

    • OperationId (string) --

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

CreateService (updated) Link ¶
Changes (request)
{'Tags': [{'Key': 'string', 'Value': 'string'}]}

Creates a service, which defines the configuration for the following entities:

  • For public and private DNS namespaces, one of the following combinations of DNS records in Amazon Route 53:

    • A

    • AAAA

    • A and AAAA

    • SRV

    • CNAME

  • Optionally, a health check

After you create the service, you can submit a RegisterInstance request, and AWS Cloud Map uses the values in the configuration to create the specified entities.

For the current limit on the number of instances that you can register using the same namespace and using the same service, see AWS Cloud Map Limits in the AWS Cloud Map Developer Guide .

See also: AWS API Documentation

Request Syntax

client.create_service(
    Name='string',
    NamespaceId='string',
    CreatorRequestId='string',
    Description='string',
    DnsConfig={
        'NamespaceId': 'string',
        'RoutingPolicy': 'MULTIVALUE'|'WEIGHTED',
        'DnsRecords': [
            {
                'Type': 'SRV'|'A'|'AAAA'|'CNAME',
                'TTL': 123
            },
        ]
    },
    HealthCheckConfig={
        'Type': 'HTTP'|'HTTPS'|'TCP',
        'ResourcePath': 'string',
        'FailureThreshold': 123
    },
    HealthCheckCustomConfig={
        'FailureThreshold': 123
    },
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)
type Name

string

param Name

[REQUIRED]

The name that you want to assign to the service.

If you want AWS Cloud Map to create an SRV record when you register an instance, and if 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, AWS 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

type NamespaceId

string

param NamespaceId

The ID of the namespace that you want to use to create the service.

type CreatorRequestId

string

param CreatorRequestId

A unique string that identifies the request and that allows failed CreateService requests to be retried without the risk of executing the operation twice. CreatorRequestId can be any unique string, for example, a date/time stamp.

This field is autopopulated if not provided.

type Description

string

param Description

A description for the service.

type DnsConfig

dict

param DnsConfig

A complex type that contains information about the Amazon Route 53 records that you want AWS Cloud Map to create when you register an instance.

  • NamespaceId (string) --

    The ID of the namespace to use for DNS configuration.

  • RoutingPolicy (string) --

    The routing policy that you want to apply to all Route 53 DNS records that AWS Cloud Map creates when you register an instance and specify this service.

    Note

    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 the service includes configurations for one A record and a health check, and 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 the service includes configurations for one A record and a health check, and 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 .

  • DnsRecords (list) -- [REQUIRED]

    An array that contains one DnsRecord object for each Route 53 DNS record that you want AWS Cloud Map to create when you register an instance.

    • (dict) --

      A complex type that contains information about the Route 53 DNS records that you want AWS Cloud Map to create when you register an instance.

      • Type (string) -- [REQUIRED]

        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 AWS 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:

        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, AWS 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.

      • TTL (integer) -- [REQUIRED]

        The amount of time, in seconds, that you want DNS resolvers to cache the settings for this record.

        Note

        Alias records don't include a TTL because Route 53 uses the TTL for the AWS 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.

type HealthCheckConfig

dict

param 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, AWS Cloud Map associates the health check with all the Route 53 DNS records that you specify in DnsConfig .

Warning

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 AWS Cloud Map Pricing.

  • Type (string) -- [REQUIRED]

    The type of health check that you want to create, which indicates how Route 53 determines whether an endpoint is healthy.

    Warning

    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.

    Warning

    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 .

  • ResourcePath (string) --

    The path that you want Route 53 to request when performing health checks. The path can be any value for which your endpoint will return an HTTP status code of 2xx or 3xx when the endpoint is healthy, such as the file /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 .

  • FailureThreshold (integer) --

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

type HealthCheckCustomConfig

dict

param HealthCheckCustomConfig

A complex type that contains information about an optional custom health check.

Warning

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.

  • FailureThreshold (integer) --

    The number of 30-second intervals that you want AWS Cloud Map to wait after receiving an UpdateInstanceCustomHealthStatus request before it changes the health status of a service instance. For example, suppose you specify a value of 2 for FailureTheshold , and then your application sends an UpdateInstanceCustomHealthStatus request. AWS Cloud Map waits for approximately 60 seconds (2 x 30) before changing the status of the service instance based on that request.

    Sending a second or subsequent UpdateInstanceCustomHealthStatus request with the same value before FailureThreshold x 30 seconds has passed doesn't accelerate the change. AWS Cloud Map still waits FailureThreshold x 30 seconds after the first request to make the change.

type Tags

list

param Tags

The tags to add to the service. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.

  • (dict) --

    A custom key-value pair associated with a resource.

    • Key (string) -- [REQUIRED]

      The key identifier, or name, of the tag.

    • Value (string) -- [REQUIRED]

      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.

rtype

dict

returns

Response Syntax

{
    'Service': {
        'Id': 'string',
        'Arn': 'string',
        'Name': 'string',
        'NamespaceId': 'string',
        'Description': 'string',
        'InstanceCount': 123,
        'DnsConfig': {
            'NamespaceId': 'string',
            'RoutingPolicy': 'MULTIVALUE'|'WEIGHTED',
            'DnsRecords': [
                {
                    'Type': 'SRV'|'A'|'AAAA'|'CNAME',
                    'TTL': 123
                },
            ]
        },
        'HealthCheckConfig': {
            'Type': 'HTTP'|'HTTPS'|'TCP',
            'ResourcePath': 'string',
            'FailureThreshold': 123
        },
        'HealthCheckCustomConfig': {
            'FailureThreshold': 123
        },
        'CreateDate': datetime(2015, 1, 1),
        'CreatorRequestId': 'string'
    }
}

Response Structure

  • (dict) --

    • Service (dict) --

      A complex type that contains information about the new service.

      • Id (string) --

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

      • Arn (string) --

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

      • Name (string) --

        The name of the service.

      • NamespaceId (string) --

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

      • Description (string) --

        The description of the service.

      • InstanceCount (integer) --

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

      • DnsConfig (dict) --

        A complex type that contains information about the Route 53 DNS records that you want AWS Cloud Map to create when you register an instance.

        • NamespaceId (string) --

          The ID of the namespace to use for DNS configuration.

        • RoutingPolicy (string) --

          The routing policy that you want to apply to all Route 53 DNS records that AWS Cloud Map creates when you register an instance and specify this service.

          Note

          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 the service includes configurations for one A record and a health check, and 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 the service includes configurations for one A record and a health check, and 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 .

        • DnsRecords (list) --

          An array that contains one DnsRecord object for each Route 53 DNS record that you want AWS Cloud Map to create when you register an instance.

          • (dict) --

            A complex type that contains information about the Route 53 DNS records that you want AWS Cloud Map to create when you register an instance.

            • Type (string) --

              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 AWS 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:

              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, AWS 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.

            • TTL (integer) --

              The amount of time, in seconds, that you want DNS resolvers to cache the settings for this record.

              Note

              Alias records don't include a TTL because Route 53 uses the TTL for the AWS 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 (dict) --

        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, AWS 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.

        • Type (string) --

          The type of health check that you want to create, which indicates how Route 53 determines whether an endpoint is healthy.

          Warning

          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.

          Warning

          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 .

        • ResourcePath (string) --

          The path that you want Route 53 to request when performing health checks. The path can be any value for which your endpoint will return an HTTP status code of 2xx or 3xx when the endpoint is healthy, such as the file /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 .

        • FailureThreshold (integer) --

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

      • HealthCheckCustomConfig (dict) --

        A complex type that contains information about an optional custom health check.

        Warning

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

        • FailureThreshold (integer) --

          The number of 30-second intervals that you want AWS Cloud Map to wait after receiving an UpdateInstanceCustomHealthStatus request before it changes the health status of a service instance. For example, suppose you specify a value of 2 for FailureTheshold , and then your application sends an UpdateInstanceCustomHealthStatus request. AWS Cloud Map waits for approximately 60 seconds (2 x 30) before changing the status of the service instance based on that request.

          Sending a second or subsequent UpdateInstanceCustomHealthStatus request with the same value before FailureThreshold x 30 seconds has passed doesn't accelerate the change. AWS Cloud Map still waits FailureThreshold x 30 seconds after the first request to make the change.

      • CreateDate (datetime) --

        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.

      • CreatorRequestId (string) --

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