Skip to content

CreateInstanceConnectEndpointRequest

Source code in docs_src/capo_ec2/types/create_instance_connect_endpoint_request.py
class CreateInstanceConnectEndpointRequest(TypedDict, closed=True):
    dry_run: NotRequired["capo_ec2.types.boolean.Boolean"]
    """<p>Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is <code>DryRunOperation</code>. Otherwise, it is <code>UnauthorizedOperation</code>.</p>"""
    subnet_id: NotRequired["capo_ec2.types.subnet_id.SubnetId"]
    """<p>The ID of the subnet in which to create the EC2 Instance Connect Endpoint.</p>"""
    security_group_ids: NotRequired[
        "capo_ec2.types.security_group_id_string_list_request.SecurityGroupIdStringListRequest"
    ]
    """<p>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.</p>"""
    preserve_client_ip: NotRequired["capo_ec2.types.boolean.Boolean"]
    """<p>Indicates whether the client IP address is preserved as the source. The following are the possible values.</p> <ul> <li> <p> <code>true</code> - Use the client IP address as the source.</p> </li> <li> <p> <code>false</code> - Use the network interface IP address as the source.</p> </li> </ul> <note> <p> <code>PreserveClientIp</code> is only supported on IPv4 EC2 Instance Connect Endpoints. To use <code>PreserveClientIp</code>, the value for <code>IpAddressType</code> must be <code>ipv4</code>.</p> </note> <p>Default: <code>false</code> </p>"""
    client_token: NotRequired["capo_ec2.types.string.String"]
    """<p>Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</p>"""
    tag_specifications: NotRequired[
        "capo_ec2.types.tag_specification_list.TagSpecificationList"
    ]
    """<p>The tags to apply to the EC2 Instance Connect Endpoint during creation.</p>"""
    ip_address_type: NotRequired["capo_ec2.types.ip_address_type.IpAddressType"]
    """<p>The IP address type of the endpoint.</p> <p>If no value is specified, the default value is determined by the IP address type of the subnet:</p> <ul> <li> <p> <code>dualstack</code> - If the subnet has both IPv4 and IPv6 CIDRs</p> </li> <li> <p> <code>ipv4</code> - If the subnet has only IPv4 CIDRs</p> </li> <li> <p> <code>ipv6</code> - If the subnet has only IPv6 CIDRs</p> </li> </ul> <note> <p> <code>PreserveClientIp</code> is only supported on IPv4 EC2 Instance Connect Endpoints. To use <code>PreserveClientIp</code>, the value for <code>IpAddressType</code> must be <code>ipv4</code>.</p> </note>"""

client_token instance-attribute

client_token: NotRequired[String]

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

dry_run instance-attribute

dry_run: NotRequired[Boolean]

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

ip_address_type instance-attribute

ip_address_type: NotRequired[IpAddressType]

The IP address type of the endpoint.

If no value is specified, the default value is determined by the IP address type of the subnet:

  • dualstack - If the subnet has both IPv4 and IPv6 CIDRs

  • ipv4 - If the subnet has only IPv4 CIDRs

  • ipv6 - If the subnet has only IPv6 CIDRs

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

preserve_client_ip instance-attribute

preserve_client_ip: NotRequired[Boolean]

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

security_group_ids instance-attribute

security_group_ids: NotRequired[SecurityGroupIdStringListRequest]

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.

subnet_id instance-attribute

subnet_id: NotRequired[SubnetId]

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

tag_specifications instance-attribute

tag_specifications: NotRequired[TagSpecificationList]

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