Package software.amazon.awscdk.services.ec2

Interface CfnInstanceConnectEndpointProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnInstanceConnectEndpointProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.93.0 (build 1706ca5)",
           date="2024-01-03T18:29:25.212Z")
@Stability(Stable)
public interface CfnInstanceConnectEndpointProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnInstanceConnectEndpoint.

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.*;
 CfnInstanceConnectEndpointProps cfnInstanceConnectEndpointProps = CfnInstanceConnectEndpointProps.builder()
         .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:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-instanceconnectendpoint.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnInstanceConnectEndpointProps.Builder	A builder for CfnInstanceConnectEndpointProps
static final class	CfnInstanceConnectEndpointProps.Jsii$Proxy	An implementation for CfnInstanceConnectEndpointProps

Method Summary

Modifier and Type	Method	Description
static CfnInstanceConnectEndpointProps.Builder	builder()
default String	getClientToken()	Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
default Object	getPreserveClientIp()	Indicates whether your client's IP address is preserved as the source.
default List<String>	getSecurityGroupIds()	One or more security groups to associate with the endpoint.
String	getSubnetId()	The ID of the subnet in which to create the EC2 Instance Connect Endpoint.
default List<CfnTag>	getTags()	The tags to apply to the EC2 Instance Connect Endpoint during creation.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getSubnetId

@Stability(Stable)
@NotNull
String getSubnetId()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-instanceconnectendpoint.html#cfn-ec2-instanceconnectendpoint-subnetid

getClientToken

@Stability(Stable)
@Nullable
default String getClientToken()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-instanceconnectendpoint.html#cfn-ec2-instanceconnectendpoint-clienttoken

getPreserveClientIp

@Stability(Stable)
@Nullable
default Object getPreserveClientIp()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-instanceconnectendpoint.html#cfn-ec2-instanceconnectendpoint-preserveclientip

getSecurityGroupIds

@Stability(Stable)
@Nullable
default List<String> getSecurityGroupIds()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-instanceconnectendpoint.html#cfn-ec2-instanceconnectendpoint-securitygroupids

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-instanceconnectendpoint.html#cfn-ec2-instanceconnectendpoint-tags

builder

@Stability(Stable)
static CfnInstanceConnectEndpointProps.Builder builder()

Returns:

a CfnInstanceConnectEndpointProps.Builder of CfnInstanceConnectEndpointProps