CfnInstanceConnectEndpointProps

class aws_cdk.aws_ec2.CfnInstanceConnectEndpointProps(*, subnet_id, client_token=None, preserve_client_ip=None, security_group_ids=None, tags=None)

Bases: object

Properties for defining a CfnInstanceConnectEndpoint.

Parameters:

  • subnet_id (str) – The ID of the subnet in which to create the EC2 Instance Connect Endpoint.

  • client_token (Optional[str]) – Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

  • preserve_client_ip (Union[bool, IResolvable, None]) – Indicates whether the client IP address is preserved as the source. The following are the possible values. - true - Use the client IP address as the source. - false - Use the network interface IP address as the source. .. epigraph:: PreserveClientIp is only supported on IPv4 EC2 Instance Connect Endpoints. To use PreserveClientIp , the value for IpAddressType must be ipv4 . Default: false

  • security_group_ids (Optional[Sequence[str]]) – One or more security groups to associate with the endpoint. If you don’t specify a security group, the default security group for your VPC will be associated with the endpoint.

  • tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – The tags to apply to the EC2 Instance Connect Endpoint during creation.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-instanceconnectendpoint.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 import aws_ec2 as ec2

cfn_instance_connect_endpoint_props = ec2.CfnInstanceConnectEndpointProps(
    subnet_id="subnetId",

    # the properties below are optional
    client_token="clientToken",
    preserve_client_ip=False,
    security_group_ids=["securityGroupIds"],
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Attributes

client_token

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-instanceconnectendpoint.html#cfn-ec2-instanceconnectendpoint-clienttoken

preserve_client_ip

Indicates whether the client IP address is preserved as the source. The following are the possible values.

  • true - Use the client IP address as the source.

  • false - Use the network interface IP address as the source.

PreserveClientIp is only supported on IPv4 EC2 Instance Connect Endpoints. To use PreserveClientIp , the value for IpAddressType must be ipv4 .

Default: false

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-instanceconnectendpoint.html#cfn-ec2-instanceconnectendpoint-preserveclientip

security_group_ids

One or more security groups to associate with the endpoint.

If you don’t specify a security group, the default security group for your VPC will be associated with the endpoint.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-instanceconnectendpoint.html#cfn-ec2-instanceconnectendpoint-securitygroupids

subnet_id

The ID of the subnet in which to create the EC2 Instance Connect Endpoint.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-instanceconnectendpoint.html#cfn-ec2-instanceconnectendpoint-subnetid

tags

The tags to apply to the EC2 Instance Connect Endpoint during creation.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-instanceconnectendpoint.html#cfn-ec2-instanceconnectendpoint-tags