CfnServicePropsMixin

class aws_cdk.mixins_preview.aws_servicediscovery.mixins.CfnServicePropsMixin(props, *, strategy=None)

Bases: Mixin

A complex type that contains information about the specified service.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-servicediscovery-service.html

CloudformationResource:

AWS::ServiceDiscovery::Service

Mixin:

true

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview import mixins
from aws_cdk.mixins_preview.aws_servicediscovery import mixins as servicediscovery_mixins

# service_attributes: Any

cfn_service_props_mixin = servicediscovery_mixins.CfnServicePropsMixin(servicediscovery_mixins.CfnServiceMixinProps(
    description="description",
    dns_config=servicediscovery_mixins.CfnServicePropsMixin.DnsConfigProperty(
        dns_records=[servicediscovery_mixins.CfnServicePropsMixin.DnsRecordProperty(
            ttl=123,
            type="type"
        )],
        namespace_id="namespaceId",
        routing_policy="routingPolicy"
    ),
    health_check_config=servicediscovery_mixins.CfnServicePropsMixin.HealthCheckConfigProperty(
        failure_threshold=123,
        resource_path="resourcePath",
        type="type"
    ),
    health_check_custom_config=servicediscovery_mixins.CfnServicePropsMixin.HealthCheckCustomConfigProperty(
        failure_threshold=123
    ),
    name="name",
    namespace_id="namespaceId",
    service_attributes=service_attributes,
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    type="type"
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::ServiceDiscovery::Service.

Parameters:

  • props (Union[CfnServiceMixinProps, Dict[str, Any]]) – L1 properties to apply.

  • strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:

construct (IConstruct)

Return type:

IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:

construct (IConstruct)

Return type:

bool

Attributes

CFN_PROPERTY_KEYS = ['description', 'dnsConfig', 'healthCheckConfig', 'healthCheckCustomConfig', 'name', 'namespaceId', 'serviceAttributes', 'tags', 'type']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:

x (Any) – Any object.

Return type:

bool

Returns:

true if x is an object created from a class which extends Mixin.

Stability:

experimental

DnsConfigProperty

class CfnServicePropsMixin.DnsConfigProperty(*, dns_records=None, namespace_id=None, routing_policy=None)

Bases: object

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

Parameters:

  • dns_records (Union[IResolvable, Sequence[Union[IResolvable, DnsRecordProperty, Dict[str, Any]]], None]) – 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. .. epigraph:: The record type of a service can’t be updated directly and can only be changed by deleting the service and recreating it with a new DnsConfig .

  • namespace_id (Optional[str]) – Use NamespaceId in `Service <https://docs.aws.amazon.com/cloud-map/latest/api/API_Service.html>`_ instead.. The ID of the namespace to use for DNS configuration.

  • routing_policy (Optional[str]) – 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. .. epigraph:: 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 .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-servicediscovery-service-dnsconfig.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_servicediscovery import mixins as servicediscovery_mixins

dns_config_property = servicediscovery_mixins.CfnServicePropsMixin.DnsConfigProperty(
    dns_records=[servicediscovery_mixins.CfnServicePropsMixin.DnsRecordProperty(
        ttl=123,
        type="type"
    )],
    namespace_id="namespaceId",
    routing_policy="routingPolicy"
)

Attributes

dns_records

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.

The record type of a service can’t be updated directly and can only be changed by deleting the service and recreating it with a new DnsConfig .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-servicediscovery-service-dnsconfig.html#cfn-servicediscovery-service-dnsconfig-dnsrecords

namespace_id

Use NamespaceId in `Service <https://docs.aws.amazon.com/cloud-map/latest/api/API_Service.html>`_ instead..

The ID of the namespace to use for DNS configuration.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-servicediscovery-service-dnsconfig.html#cfn-servicediscovery-service-dnsconfig-namespaceid

routing_policy

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.

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 .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-servicediscovery-service-dnsconfig.html#cfn-servicediscovery-service-dnsconfig-routingpolicy

DnsRecordProperty

class CfnServicePropsMixin.DnsRecordProperty(*, ttl=None, type=None)

Bases: object

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.

Parameters:

  • ttl (Union[int, float, None]) – The amount of time, in seconds, that you want DNS resolvers to cache the settings for this record. .. epigraph:: 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 (Optional[str]) –

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

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-servicediscovery-service-dnsrecord.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_servicediscovery import mixins as servicediscovery_mixins

dns_record_property = servicediscovery_mixins.CfnServicePropsMixin.DnsRecordProperty(
    ttl=123,
    type="type"
)

Attributes

ttl

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

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

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-servicediscovery-service-dnsrecord.html#cfn-servicediscovery-service-dnsrecord-ttl

type

The type of the resource, which indicates the type of value that Route 53 returns in response to DNS queries.

You can specify values for Type in the following combinations:

  • 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 and 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.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-servicediscovery-service-dnsrecord.html#cfn-servicediscovery-service-dnsrecord-type

HealthCheckConfigProperty

class CfnServicePropsMixin.HealthCheckConfigProperty(*, failure_threshold=None, resource_path=None, type=None)

Bases: object

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 .

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

Health checks are basic Route 53 health checks that monitor an AWS endpoint. For information about pricing for health checks, see Amazon Route 53 Pricing .

Note the following about configuring health checks.

  • A and AAAA records - If DnsConfig includes configurations for both A and AAAA records, AWS Cloud Map creates a health check that uses the IPv4 address to check the health of the resource. If the endpoint tthat’s specified by the IPv4 address is unhealthy, Route 53 considers both the A and AAAA records to be unhealthy.

  • CNAME records - You can’t specify settings for HealthCheckConfig when the DNSConfig includes CNAME for the value of Type . If you do, the CreateService request will fail with an InvalidInput error.

  • Request interval - A Route 53 health checker in each health-checking AWS Region sends a health check request to an endpoint every 30 seconds. On average, your endpoint receives a health check request about every two seconds. However, health checkers don’t coordinate with one another. Therefore, you might sometimes see several requests in one second that’s followed by a few seconds with no health checks at all.

  • Health checking regions - Health checkers perform checks from all Route 53 health-checking Regions. For a list of the current Regions, see Regions .

  • Alias records - When you register an instance, if you include the AWS_ALIAS_DNS_NAME attribute, AWS Cloud Map creates a Route 53 alias record. Note the following:

  • Route 53 automatically sets EvaluateTargetHealth to true for alias records. When EvaluateTargetHealth is true, the alias record inherits the health of the referenced AWS resource. such as an ELB load balancer. For more information, see EvaluateTargetHealth .

  • If you include HealthCheckConfig and then use the service to register an instance that creates an alias record, Route 53 doesn’t create the health check.

  • Charges for health checks - Health checks are basic Route 53 health checks that monitor an AWS endpoint. For information about pricing for health checks, see Amazon Route 53 Pricing .

Parameters:

  • failure_threshold (Union[int, float, None]) – 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 .

  • resource_path (Optional[str]) – 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 .

  • type (Optional[str]) –

    The type of health check that you want to create, which indicates how Route 53 determines whether an endpoint is healthy. .. epigraph:: 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. .. epigraph:: 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 .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-servicediscovery-service-healthcheckconfig.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_servicediscovery import mixins as servicediscovery_mixins

health_check_config_property = servicediscovery_mixins.CfnServicePropsMixin.HealthCheckConfigProperty(
    failure_threshold=123,
    resource_path="resourcePath",
    type="type"
)

Attributes

failure_threshold

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 .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-servicediscovery-service-healthcheckconfig.html#cfn-servicediscovery-service-healthcheckconfig-failurethreshold

resource_path

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 .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-servicediscovery-service-healthcheckconfig.html#cfn-servicediscovery-service-healthcheckconfig-resourcepath

type

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

You can’t change the value of Type after you create a health check.

You can create the following types of health checks:

  • HTTP : Route 53 tries to establish a TCP connection. If successful, Route 53 submits an HTTP request and waits for an HTTP status code of 200 or greater and less than 400.

  • HTTPS : Route 53 tries to establish a TCP connection. If successful, Route 53 submits an HTTPS request and waits for an HTTP status code of 200 or greater and less than 400.

If you specify HTTPS for the value of Type , the endpoint must support TLS v1.0 or later.

  • TCP : Route 53 tries to establish a TCP connection.

If you specify 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 .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-servicediscovery-service-healthcheckconfig.html#cfn-servicediscovery-service-healthcheckconfig-type

HealthCheckCustomConfigProperty

class CfnServicePropsMixin.HealthCheckCustomConfigProperty(*, failure_threshold=None)

Bases: object

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

A custom health check, which requires that you use a third-party health checker to evaluate the health of your resources, is useful in the following circumstances:

  • You can’t use a health check that’s defined by 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.

To change the status of a custom health check, submit an UpdateInstanceCustomHealthStatus request. AWS Cloud Map doesn’t monitor the status of the resource, it just keeps a record of the status specified in the most recent UpdateInstanceCustomHealthStatus request.

Here’s how custom health checks work:

  • You create a service.

  • You register an instance.

  • You configure a third-party health checker to monitor the resource that’s associated with the new instance.

AWS Cloud Map doesn’t check the health of the resource directly.

  • The third-party health-checker determines that the resource is unhealthy and notifies your application.

  • Your application submits an UpdateInstanceCustomHealthStatus request.

  • AWS Cloud Map waits for 30 seconds.

  • If another UpdateInstanceCustomHealthStatus request doesn’t arrive during that time to change the status back to healthy, AWS Cloud Map stops routing traffic to the resource.

Parameters:

failure_threshold (Union[int, float, None]) –

This parameter is no longer supported and is always set to 1. AWS 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 AWS 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. AWS Cloud Map still waits 30 seconds after the first request to make the change.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-servicediscovery-service-healthcheckcustomconfig.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_servicediscovery import mixins as servicediscovery_mixins

health_check_custom_config_property = servicediscovery_mixins.CfnServicePropsMixin.HealthCheckCustomConfigProperty(
    failure_threshold=123
)

Attributes

failure_threshold

This parameter is no longer supported and is always set to 1.

AWS 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 AWS 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. AWS Cloud Map still waits 30 seconds after the first request to make the change.

see:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-servicediscovery-service-healthcheckcustomconfig.html#cfn-servicediscovery-service-healthcheckcustomconfig-failurethreshold