Package software.amazon.awscdk.services.ec2

Class CfnInstanceConnectEndpoint

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.ec2.CfnInstanceConnectEndpoint
All Implemented Interfaces:
IEnvironmentAware, IInspectable, ITaggableV2, IInstanceConnectEndpointRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.118.0 (build 02eec31)", date="2025-11-04T09:27:39.428Z") @Stability(Stable) public class CfnInstanceConnectEndpoint extends CfnResource implements IInspectable, IInstanceConnectEndpointRef, ITaggableV2
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.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.ec2.*;
 CfnInstanceConnectEndpoint cfnInstanceConnectEndpoint = CfnInstanceConnectEndpoint.Builder.create(this, "MyCfnInstanceConnectEndpoint")
         .subnetId("subnetId")
         // the properties below are optional
         .clientToken("clientToken")
         .preserveClientIp(false)
         .securityGroupIds(List.of("securityGroupIds"))
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnInstanceConnectEndpoint

      protected CfnInstanceConnectEndpoint(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnInstanceConnectEndpoint

      protected CfnInstanceConnectEndpoint(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnInstanceConnectEndpoint

      @Stability(Stable) public CfnInstanceConnectEndpoint(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnInstanceConnectEndpointProps props)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • fromInstanceConnectEndpointId

      @Stability(Stable) @NotNull public static IInstanceConnectEndpointRef fromInstanceConnectEndpointId(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String instanceConnectEndpointId)
      Creates a new IInstanceConnectEndpointRef from a instanceConnectEndpointId.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      instanceConnectEndpointId - This parameter is required.

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrId

      @Stability(Stable) @NotNull public String getAttrId()
      The ID of the EC2 Instance Connect Endpoint.

    • getCdkTagManager

      @Stability(Stable) @NotNull public TagManager getCdkTagManager()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getCdkTagManager in interface ITaggableV2

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getInstanceConnectEndpointRef

      @Stability(Stable) @NotNull public InstanceConnectEndpointReference getInstanceConnectEndpointRef()
      A reference to a InstanceConnectEndpoint resource.
      Specified by:
      getInstanceConnectEndpointRef in interface IInstanceConnectEndpointRef

    • getSubnetId

      @Stability(Stable) @NotNull public String getSubnetId()
      The ID of the subnet in which to create the EC2 Instance Connect Endpoint.

    • setSubnetId

      @Stability(Stable) public void setSubnetId(@NotNull String value)
      The ID of the subnet in which to create the EC2 Instance Connect Endpoint.

    • getClientToken

      @Stability(Stable) @Nullable public String getClientToken()
      Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

    • setClientToken

      @Stability(Stable) public void setClientToken(@Nullable String value)
      Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

    • getPreserveClientIp

      @Stability(Stable) @Nullable public Object getPreserveClientIp()
      Indicates whether the client IP address is preserved as the source.

      The following are the possible values.

      Returns union: either Boolean or IResolvable

    • setPreserveClientIp

      @Stability(Stable) public void setPreserveClientIp(@Nullable Boolean value)
      Indicates whether the client IP address is preserved as the source.

      The following are the possible values.

    • setPreserveClientIp

      @Stability(Stable) public void setPreserveClientIp(@Nullable IResolvable value)
      Indicates whether the client IP address is preserved as the source.

      The following are the possible values.

    • getSecurityGroupIds

      @Stability(Stable) @Nullable public List<String> getSecurityGroupIds()
      One or more security groups to associate with the endpoint.

    • setSecurityGroupIds

      @Stability(Stable) public void setSecurityGroupIds(@Nullable List<String> value)
      One or more security groups to associate with the endpoint.

    • getTags

      @Stability(Stable) @Nullable public List<CfnTag> getTags()
      The tags to apply to the EC2 Instance Connect Endpoint during creation.

    • setTags

      @Stability(Stable) public void setTags(@Nullable List<CfnTag> value)
      The tags to apply to the EC2 Instance Connect Endpoint during creation.