Skip to content

ModifyInstanceConnectEndpointRequest

Source code in docs_src/capo_ec2/types/modify_instance_connect_endpoint_request.py
class ModifyInstanceConnectEndpointRequest(TypedDict, closed=True):
    dry_run: NotRequired["capo_ec2.types.boolean.Boolean"]
    """<p>Checks whether you have the required permissions for the operation, 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>"""
    instance_connect_endpoint_id: NotRequired[
        "capo_ec2.types.instance_connect_endpoint_id.InstanceConnectEndpointId"
    ]
    """<p>The ID of the EC2 Instance Connect Endpoint to modify.</p>"""
    ip_address_type: NotRequired["capo_ec2.types.ip_address_type.IpAddressType"]
    """<p>The new IP address type for the EC2 Instance Connect Endpoint.</p> <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>"""
    security_group_ids: NotRequired[
        "capo_ec2.types.security_group_id_string_list_request.SecurityGroupIdStringListRequest"
    ]
    """<p>Changes the security groups for the EC2 Instance Connect Endpoint. The new set of groups you specify replaces the current set. You must specify at least one group, even if it's just the default security group in the VPC. You must specify the ID of the security group, not the name.</p>"""
    preserve_client_ip: NotRequired["capo_ec2.types.boolean.Boolean"]
    """<p>Indicates whether the client 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>"""

dry_run instance-attribute

dry_run: NotRequired[Boolean]

Checks whether you have the required permissions for the operation, 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.

instance_connect_endpoint_id instance-attribute

instance_connect_endpoint_id: NotRequired[InstanceConnectEndpointId]

The ID of the EC2 Instance Connect Endpoint to modify.

ip_address_type instance-attribute

ip_address_type: NotRequired[IpAddressType]

The new IP address type for the EC2 Instance Connect Endpoint.

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 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.

security_group_ids instance-attribute

security_group_ids: NotRequired[SecurityGroupIdStringListRequest]

Changes the security groups for the EC2 Instance Connect Endpoint. The new set of groups you specify replaces the current set. You must specify at least one group, even if it's just the default security group in the VPC. You must specify the ID of the security group, not the name.