Request Parameters Response Elements Errors Examples See Also

CreateInstanceConnectEndpoint

Creates an EC2 Instance Connect Endpoint.

An EC2 Instance Connect Endpoint allows you to connect to an instance, without requiring the instance to have a public IPv4 address. For more information, see Connect to your instances without requiring a public IPv4 address using EC2 Instance Connect Endpoint in the Amazon EC2 User Guide.

Request Parameters

The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see Common Query Parameters.

ClientToken

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

Type: String

Required: No

DryRun

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.

Type: Boolean

Required: No

PreserveClientIp

Indicates whether your client's IP address is preserved as the source. The value is true or false.

If true, your client's IP address is used when you connect to a resource.
If false, the elastic network interface IP address is used when you connect to a resource.

Default: true

Type: Boolean

Required: No

SecurityGroupId.N

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.

Type: Array of strings

Array Members: Minimum number of 0 items. Maximum number of 16 items.

Required: No

SubnetId

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

Type: String

Required: Yes

TagSpecification.N

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

Type: Array of TagSpecification objects

Required: No

Response Elements

The following elements are returned by the service.

clientToken

Unique, case-sensitive idempotency token provided by the client in the the request.

Type: String

instanceConnectEndpoint

Information about the EC2 Instance Connect Endpoint.

Type: Ec2InstanceConnectEndpoint object

requestId

The ID of the request.

Type: String

Errors

For information about the errors that are common to all actions, see Common client error codes.

Examples

Example: Create an EC2 Instance Connect Endpoint

This example creates an EC2 Instance Connect Endpoint in the specified subnet.

Sample Request


https://ec2.amazonaws.com/?Action=CreateInstanceConnectEndpoint
&SubnetId=subnet-0123456789example
&AUTHPARAMS

Sample Response


<CreateInstanceConnectEndpointResponse xmlns="http://ec2.amazonaws.com/doc/2016-11-15/">
  <requestId>a9effc88-e86c-4730-b1e8-30ba091babd1</requestId>
  <instanceConnectEndpoint>
    <createdAt>2023-06-06T20:01:31.000Z</createdAt>
    <instanceConnectEndpointArn>arn:aws:ec2:region:account-id:instance-connect-endpoint/eice-0123456789example</instanceConnectEndpointArn>
    <instanceConnectEndpointId>eice-0123456789example</instanceConnectEndpointId>
    <networkInterfaceIdSet />
    <ownerId>account-id</ownerId>
    <preserveClientIp>false</preserveClientIp>
    <securityGroupIdSet>
      <item>sg-0123456789example</item>
    </securityGroupIdSet>
    <state>create-in-progress</state>
    <stateMessage />
    <subnetId>subnet-0123456789example</subnetId>
    <tagSet />
    <vpcId>vpc-0123456789example</vpcId>
  </instanceConnectEndpoint>
</CreateInstanceConnectEndpointResponse>