AWS::EC2::InstanceConnectEndpoint - AWS CloudFormation
SyntaxPropertiesReturn values

AWS::EC2::InstanceConnectEndpoint

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 using EC2 Instance Connect Endpoint in the Amazon EC2 User Guide.

With the replacement update behavior, AWS CloudFormation usually creates the new resource first, changes references to point to the new resource, and then deletes the old resource. However, you can create only one EC2 Instance Connect Endpoint per VPC, so the replacement process fails. If you need to modify an EC2 Instance Connect Endpoint, you must replace the resource manually.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::EC2::InstanceConnectEndpoint",
  "Properties" : {
      "ClientToken" : String,
      "PreserveClientIp" : Boolean,
      "SecurityGroupIds" : [ String, ... ],
      "SubnetId" : String,
      "Tags" : [ Tag, ... ]
    }
}

YAML

Type: AWS::EC2::InstanceConnectEndpoint
Properties:
  ClientToken: String
  PreserveClientIp: Boolean
  SecurityGroupIds: 
    - String
  SubnetId: String
  Tags: 
    - Tag

Properties

ClientToken

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

Required: No

Type: String

Update requires: Replacement

PreserveClientIp

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.

Default: false

Required: No

Type: Boolean

Update requires: Replacement

SecurityGroupIds

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.

Required: No

Type: Array of String

Minimum: 0

Maximum: 16

Update requires: Replacement

SubnetId

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

Required: Yes

Type: String

Update requires: Replacement

Tags

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

Required: No

Type: Array of Tag

Update requires: No interruption

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the ID of the EC2 Instance Connect Endpoint.

For more information about using the Ref function, see Ref.

Fn::GetAtt

The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.

Id

The ID of the EC2 Instance Connect Endpoint.