Skip to content

Ec2InstanceConnectEndpoint

Source code in docs_src/capo_ec2/types/ec2_instance_connect_endpoint.py
class Ec2InstanceConnectEndpoint(TypedDict, closed=True):
    owner_id: NotRequired["capo_ec2.types.string.String"]
    """<p>The ID of the Amazon Web Services account that created the EC2 Instance Connect Endpoint.</p>"""
    instance_connect_endpoint_id: NotRequired[
        "capo_ec2.types.instance_connect_endpoint_id.InstanceConnectEndpointId"
    ]
    """<p>The ID of the EC2 Instance Connect Endpoint.</p>"""
    instance_connect_endpoint_arn: NotRequired[
        "capo_ec2.types.resource_arn.ResourceArn"
    ]
    """<p>The Amazon Resource Name (ARN) of the EC2 Instance Connect Endpoint.</p>"""
    state: NotRequired[
        "capo_ec2.types.ec2_instance_connect_endpoint_state.Ec2InstanceConnectEndpointState"
    ]
    """<p>The current state of the EC2 Instance Connect Endpoint.</p>"""
    state_message: NotRequired["capo_ec2.types.string.String"]
    """<p>The message for the current state of the EC2 Instance Connect Endpoint. Can include a failure message.</p>"""
    dns_name: NotRequired["capo_ec2.types.string.String"]
    """<p>The DNS name of the EC2 Instance Connect Endpoint.</p>"""
    fips_dns_name: NotRequired["capo_ec2.types.string.String"]
    """<p>The Federal Information Processing Standards (FIPS) compliant DNS name of the EC2 Instance Connect Endpoint.</p>"""
    network_interface_ids: NotRequired[
        "capo_ec2.types.network_interface_id_set.NetworkInterfaceIdSet"
    ]
    """<p>The ID of the elastic network interface that Amazon EC2 automatically created when creating the EC2 Instance Connect Endpoint.</p>"""
    vpc_id: NotRequired["capo_ec2.types.vpc_id.VpcId"]
    """<p>The ID of the VPC in which the EC2 Instance Connect Endpoint was created.</p>"""
    availability_zone: NotRequired["capo_ec2.types.string.String"]
    """<p>The Availability Zone of the EC2 Instance Connect Endpoint.</p>"""
    created_at: NotRequired["capo_ec2.types.millisecond_date_time.MillisecondDateTime"]
    """<p>The date and time that the EC2 Instance Connect Endpoint was created.</p>"""
    subnet_id: NotRequired["capo_ec2.types.subnet_id.SubnetId"]
    """<p>The ID of the subnet in which the EC2 Instance Connect Endpoint was created.</p>"""
    preserve_client_ip: NotRequired["capo_ec2.types.boolean.Boolean"]
    """<p>Indicates whether your client's IP address is preserved as the source when you connect to a resource. The following are the possible values.</p> <ul> <li> <p> <code>true</code> - Use the IP address of the client. Your instance must have an IPv4 address.</p> </li> <li> <p> <code>false</code> - Use the IP address of the network interface.</p> </li> </ul> <p>Default: <code>false</code> </p>"""
    security_group_ids: NotRequired[
        "capo_ec2.types.security_group_id_set.SecurityGroupIdSet"
    ]
    """<p>The security groups associated with the endpoint. If you didn't specify a security group, the default security group for your VPC is associated with the endpoint.</p>"""
    tags: NotRequired["capo_ec2.types.tag_list.TagList"]
    """<p>The tags assigned to the EC2 Instance Connect Endpoint.</p>"""
    ip_address_type: NotRequired["capo_ec2.types.ip_address_type.IpAddressType"]
    """<p>The IP address type of the endpoint.</p>"""
    public_dns_names: NotRequired[
        "capo_ec2.types.instance_connect_endpoint_public_dns_names.InstanceConnectEndpointPublicDnsNames"
    ]
    """<p>The public DNS names of the endpoint.</p>"""
    availability_zone_id: NotRequired[
        "capo_ec2.types.availability_zone_id.AvailabilityZoneId"
    ]
    """<p>The ID of the Availability Zone of the EC2 Instance Connect Endpoint.</p>"""

availability_zone instance-attribute

availability_zone: NotRequired[String]

The Availability Zone of the EC2 Instance Connect Endpoint.

availability_zone_id instance-attribute

availability_zone_id: NotRequired[AvailabilityZoneId]

The ID of the Availability Zone of the EC2 Instance Connect Endpoint.

created_at instance-attribute

created_at: NotRequired[MillisecondDateTime]

The date and time that the EC2 Instance Connect Endpoint was created.

dns_name instance-attribute

dns_name: NotRequired[String]

The DNS name of the EC2 Instance Connect Endpoint.

fips_dns_name instance-attribute

fips_dns_name: NotRequired[String]

The Federal Information Processing Standards (FIPS) compliant DNS name of the EC2 Instance Connect Endpoint.

instance_connect_endpoint_arn instance-attribute

instance_connect_endpoint_arn: NotRequired[ResourceArn]

The Amazon Resource Name (ARN) of the EC2 Instance Connect Endpoint.

instance_connect_endpoint_id instance-attribute

instance_connect_endpoint_id: NotRequired[InstanceConnectEndpointId]

The ID of the EC2 Instance Connect Endpoint.

ip_address_type instance-attribute

ip_address_type: NotRequired[IpAddressType]

The IP address type of the endpoint.

network_interface_ids instance-attribute

network_interface_ids: NotRequired[NetworkInterfaceIdSet]

The ID of the elastic network interface that Amazon EC2 automatically created when creating the EC2 Instance Connect Endpoint.

owner_id instance-attribute

owner_id: NotRequired[String]

The ID of the Amazon Web Services account that created the EC2 Instance Connect Endpoint.

preserve_client_ip instance-attribute

preserve_client_ip: NotRequired[Boolean]

Indicates whether your client's IP address is preserved as the source when you connect to a resource. The following are the possible values.

  • true - Use the IP address of the client. Your instance must have an IPv4 address.

  • false - Use the IP address of the network interface.

Default: false

public_dns_names instance-attribute

public_dns_names: NotRequired[InstanceConnectEndpointPublicDnsNames]

The public DNS names of the endpoint.

security_group_ids instance-attribute

security_group_ids: NotRequired[SecurityGroupIdSet]

The security groups associated with the endpoint. If you didn't specify a security group, the default security group for your VPC is associated with the endpoint.

state instance-attribute

state: NotRequired[Ec2InstanceConnectEndpointState]

The current state of the EC2 Instance Connect Endpoint.

state_message instance-attribute

state_message: NotRequired[String]

The message for the current state of the EC2 Instance Connect Endpoint. Can include a failure message.

subnet_id instance-attribute

subnet_id: NotRequired[SubnetId]

The ID of the subnet in which the EC2 Instance Connect Endpoint was created.

tags instance-attribute

tags: NotRequired[TagList]

The tags assigned to the EC2 Instance Connect Endpoint.

vpc_id instance-attribute

vpc_id: NotRequired[VpcId]

The ID of the VPC in which the EC2 Instance Connect Endpoint was created.