EC2 / Client / modify_instance_connect_endpoint

modify_instance_connect_endpoint

EC2.Client.modify_instance_connect_endpoint(**kwargs)

Modifies the specified EC2 Instance Connect Endpoint.

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

See also: AWS API Documentation

Request Syntax

response = client.modify_instance_connect_endpoint(
    DryRun=True|False,
    InstanceConnectEndpointId='string',
    IpAddressType='ipv4'|'dualstack'|'ipv6',
    SecurityGroupIds=[
        'string',
    ],
    PreserveClientIp=True|False
)
Parameters:

  • DryRun (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.

  • InstanceConnectEndpointId (string) –

    [REQUIRED]

    The ID of the EC2 Instance Connect Endpoint to modify.

  • IpAddressType (string) –

    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.

  • SecurityGroupIds (list) –

    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.

    • (string) –

  • PreserveClientIp (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.

    Note

    PreserveClientIp=true is only supported on IPv4 EC2 Instance Connect Endpoints. If modifying PreserveClientIp to true, either the endpoint’s existing IpAddressType must be ipv4, or if modifying IpAddressType in the same request, the new value must be ipv4.

    Default: false

Return type:

dict

Returns:

Response Syntax

{
    'Return': True|False
}

Response Structure

  • (dict) –

    • Return (boolean) –

      The return value of the request. Returns true if the specified product code is owned by the requester and associated with the specified instance.