Skip to content
v2.275.0

CfnInstanceConnectEndpointProps Struct ​

Properties for defining a CfnInstanceConnectEndpoint.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_ec2 as ec2 } from 'aws-cdk-lib';
const cfnInstanceConnectEndpointProps: ec2.CfnInstanceConnectEndpointProps = {
  subnetId: 'subnetId',

  // the properties below are optional
  clientToken: 'clientToken',
  preserveClientIp: false,
  securityGroupIds: ['securityGroupIds'],
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties ​

clientTokenoptionalstringclient_tokenoptionalstrclientTokenoptionalStringClientTokenoptionalstringClientTokenoptional*string#
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
preserveClientIpoptionalboolean | IResolvablepreserve_client_ipoptionaltyping.Union[bool, IResolvable]preserveClientIpoptionalBooleanPreserveClientIpoptionalboolPreserveClientIpoptionalinterface{}#
Indicates whether the client IP address is preserved as the source. The following are the possible values.
notes
  • true - Use the client IP address as the source.
  • false - Use the network interface IP address as the source.

PreserveClientIp is only supported on IPv4 EC2 Instance Connect Endpoints. To use PreserveClientIp , the value for IpAddressType must be ipv4 .

Default: false

securityGroupIdsoptionalstring[]security_group_idsoptionaltyping.List[str]securityGroupIdsoptionalList<String>SecurityGroupIdsoptionalstring[]SecurityGroupIdsoptional*[]*string#
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.

subnetIdstringsubnet_idstrsubnetIdStringSubnetIdstringSubnetId*stringrequired#
The ID of the subnet in which to create the EC2 Instance Connect Endpoint.
tagsoptionalCfnTag[]tagsoptionaltyping.List[CfnTag]tagsoptionalList<CfnTag>TagsoptionalCfnTag[]Tagsoptional*[]CfnTag#
The tags to apply to the EC2 Instance Connect Endpoint during creation.