Skip to content

EC2  >  Operations  >  modify_instance_connect_endpoint

modify_instance_connect_endpoint

Operation

modify_instance_connect_endpoint async 

modify_instance_connect_endpoint(input: ModifyInstanceConnectEndpointInput, plugins: list[Plugin] | None = None) -> ModifyInstanceConnectEndpointOutput

Modifies the specified EC2 Instance Connect Endpoint.

For more information, see Modify an EC2 Instance Connect Endpoint in the Amazon EC2 User Guide.

Parameters:

Name Type Description Default
input ModifyInstanceConnectEndpointInput

An instance of ModifyInstanceConnectEndpointInput.

 required
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

 None

Returns:

Type Description
ModifyInstanceConnectEndpointOutput

An instance of ModifyInstanceConnectEndpointOutput.

Input

ModifyInstanceConnectEndpointInput dataclass

Bases: _SerdeShape

Dataclass for ModifyInstanceConnectEndpointInput structure.

Attributes

dry_run class-attribute instance-attribute 
dry_run: bool | None = ...

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 class-attribute instance-attribute 
instance_connect_endpoint_id: str | None = ...

The ID of the EC2 Instance Connect Endpoint to modify.

ip_address_type class-attribute instance-attribute 
ip_address_type: str | None = ...

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

Note

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

preserve_client_ip class-attribute instance-attribute 
preserve_client_ip: bool | None = ...

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 class-attribute instance-attribute 
security_group_ids: list[str] | None = ...

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.

Output

ModifyInstanceConnectEndpointOutput dataclass

Bases: _SerdeShape

Dataclass for ModifyInstanceConnectEndpointOutput structure.

Attributes

response_metadata class-attribute instance-attribute 
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.

return_ class-attribute instance-attribute 
return_: bool | None = ...

Is true if the request succeeds and an error otherwise.