Class CfnVpcLink
A CloudFormation AWS::ApiGatewayV2::VpcLink
.
Inherited Members
Namespace: Amazon.CDK.AWS.APIGatewayv2
Assembly: Amazon.CDK.AWS.APIGatewayv2.dll
Syntax (csharp)
public class CfnVpcLink : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnVpcLink
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
The AWS::ApiGatewayV2::VpcLink
resource creates a VPC link. Supported only for HTTP APIs. The VPC link status must transition from PENDING
to AVAILABLE
to successfully create a VPC link, which can take up to 10 minutes. To learn more, see Working with VPC Links for HTTP APIs in the API Gateway Developer Guide .
CloudformationResource: AWS::ApiGatewayV2::VpcLink
Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-vpclink.html
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.APIGatewayv2;
var cfnVpcLink = new CfnVpcLink(this, "MyCfnVpcLink", new CfnVpcLinkProps {
Name = "name",
SubnetIds = new [] { "subnetIds" },
// the properties below are optional
SecurityGroupIds = new [] { "securityGroupIds" },
Tags = new Dictionary<string, string> {
{ "tagsKey", "tags" }
}
});
Synopsis
Constructors
CfnVpcLink(Construct, String, ICfnVpcLinkProps) | Create a new |
CfnVpcLink(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnVpcLink(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Properties
AttrVpcLinkId | The VPC link ID. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
Name | The name of the VPC link. |
SecurityGroupIds | A list of security group IDs for the VPC link. |
SubnetIds | A list of subnet IDs to include in the VPC link. |
Tags | The collection of tags. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnVpcLink(Construct, String, ICfnVpcLinkProps)
Create a new AWS::ApiGatewayV2::VpcLink
.
public CfnVpcLink(Construct scope, string id, ICfnVpcLinkProps props)
Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnVpcLinkProps
- resource properties.
CfnVpcLink(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnVpcLink(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnVpcLink(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnVpcLink(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
AttrVpcLinkId
The VPC link ID.
public virtual string AttrVpcLinkId { get; }
Property Value
System.String
Remarks
CloudformationAttribute: VpcLinkId
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
Name
The name of the VPC link.
public virtual string Name { get; set; }
Property Value
System.String
Remarks
SecurityGroupIds
A list of security group IDs for the VPC link.
public virtual string[] SecurityGroupIds { get; set; }
Property Value
System.String[]
Remarks
SubnetIds
A list of subnet IDs to include in the VPC link.
public virtual string[] SubnetIds { get; set; }
Property Value
System.String[]
Remarks
Tags
The collection of tags.
public virtual TagManager Tags { get; }
Property Value
Remarks
Each tag element is associated with a given resource.
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>