CnameInstanceProps¶

class aws_cdk.aws_servicediscovery.CnameInstanceProps(*, custom_attributes=None, instance_id=None, instance_cname, service)¶

Bases: aws_cdk.aws_servicediscovery.CnameInstanceBaseProps

Parameters

custom_attributes (Optional[Mapping[str, str]]) – Custom attributes of the instance. Default: none
instance_id (Optional[str]) – The id of the instance resource. Default: Automatically generated name
instance_cname (str) – 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.
service (IService) – The Cloudmap service this resource is registered to.

ExampleMetadata

fixture=_generated

Example:

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

# service: servicediscovery.Service

cname_instance_props = servicediscovery.CnameInstanceProps(
    instance_cname="instanceCname",
    service=service,

    # the properties below are optional
    custom_attributes={
        "custom_attributes_key": "customAttributes"
    },
    instance_id="instanceId"
)

Attributes

custom_attributes¶

Custom attributes of the instance.

Default: none
Return type: Optional[Mapping[str, str]]

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.

Return type: str

instance_id¶

The id of the instance resource.

Default: Automatically generated name
Return type: Optional[str]

service¶

The Cloudmap service this resource is registered to.

Return type: IService