IpInstanceProps

class aws_cdk.aws_servicediscovery.IpInstanceProps(*, custom_attributes=None, instance_id=None, ipv4=None, ipv6=None, port=None, service)

Bases: IpInstanceBaseProps

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
ipv4 (Optional[str]) – If the service that you specify contains a template for an A record, the IPv4 address that you want AWS Cloud Map to use for the value of the A record. Default: none
ipv6 (Optional[str]) – If the service that you specify contains a template for an AAAA record, the IPv6 address that you want AWS Cloud Map to use for the value of the AAAA record. Default: none
port (Union[int, float, None]) – The port on the endpoint that you want AWS Cloud Map to perform health checks on. This value is also used for the port value in an SRV record if the service that you specify includes an SRV record. You can also specify a default port that is applied to all instances in the Service configuration. Default: 80
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.
from aws_cdk import aws_servicediscovery as servicediscovery

# service: servicediscovery.Service

ip_instance_props = servicediscovery.IpInstanceProps(
    service=service,

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

Attributes

custom_attributes

Custom attributes of the instance.

Default:: none

instance_id

The id of the instance resource.

Default:: Automatically generated name

ipv4

If the service that you specify contains a template for an A record, the IPv4 address that you want AWS Cloud Map to use for the value of the A record.

Default:: none

ipv6

If the service that you specify contains a template for an AAAA record, the IPv6 address that you want AWS Cloud Map to use for the value of the AAAA record.

Default:: none

port

The port on the endpoint that you want AWS Cloud Map to perform health checks on.

This value is also used for the port value in an SRV record if the service that you specify includes an SRV record. You can also specify a default port that is applied to all instances in the Service configuration.

Default:: 80

service: The Cloudmap service this resource is registered to.