Class CfnInstanceConnectEndpoint
Creates an EC2 Instance Connect Endpoint.
Inherited Members
Namespace: Amazon.CDK.AWS.EC2
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnInstanceConnectEndpoint : CfnResource, IInspectable, ITaggableV2
Syntax (vb)
Public Class CfnInstanceConnectEndpoint
Inherits CfnResource
Implements IInspectable, ITaggableV2
Remarks
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.
CloudformationResource: AWS::EC2::InstanceConnectEndpoint
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.EC2;
var cfnInstanceConnectEndpoint = new CfnInstanceConnectEndpoint(this, "MyCfnInstanceConnectEndpoint", new CfnInstanceConnectEndpointProps {
SubnetId = "subnetId",
// the properties below are optional
ClientToken = "clientToken",
PreserveClientIp = false,
SecurityGroupIds = new [] { "securityGroupIds" },
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
});
Synopsis
Constructors
CfnInstanceConnectEndpoint(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnInstanceConnectEndpoint(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
CfnInstanceConnectEndpoint(Construct, String, ICfnInstanceConnectEndpointProps) |
Properties
AttrId | The ID of the EC2 Instance Connect Endpoint. |
CdkTagManager | Tag Manager which manages the tags for this resource. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
ClientToken | Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. |
PreserveClientIp | Indicates whether the client IP address is preserved as the source. |
SecurityGroupIds | One or more security groups to associate with the endpoint. |
SubnetId | The ID of the subnet in which to create the EC2 Instance Connect Endpoint. |
Tags | The tags to apply to the EC2 Instance Connect Endpoint during creation. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnInstanceConnectEndpoint(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnInstanceConnectEndpoint(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnInstanceConnectEndpoint(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnInstanceConnectEndpoint(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
CfnInstanceConnectEndpoint(Construct, String, ICfnInstanceConnectEndpointProps)
public CfnInstanceConnectEndpoint(Construct scope, string id, ICfnInstanceConnectEndpointProps props)
Parameters
- scope Constructs.Construct
Scope in which this resource is defined.
- id System.String
Construct identifier for this resource (unique in its scope).
- props ICfnInstanceConnectEndpointProps
Resource properties.
Properties
AttrId
The ID of the EC2 Instance Connect Endpoint.
public virtual string AttrId { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Id
CdkTagManager
Tag Manager which manages the tags for this resource.
public virtual TagManager CdkTagManager { get; }
Property Value
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
ClientToken
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
public virtual string ClientToken { get; set; }
Property Value
System.String
PreserveClientIp
Indicates whether the client IP address is preserved as the source.
public virtual object PreserveClientIp { get; set; }
Property Value
System.Object
Remarks
The following are the possible values.
SecurityGroupIds
One or more security groups to associate with the endpoint.
public virtual string[] SecurityGroupIds { get; set; }
Property Value
System.String[]
SubnetId
The ID of the subnet in which to create the EC2 Instance Connect Endpoint.
public virtual string SubnetId { get; set; }
Property Value
System.String
Tags
The tags to apply to the EC2 Instance Connect Endpoint during creation.
public virtual ICfnTag[] Tags { get; set; }
Property Value
ICfnTag[]
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>