Class CfnVpcLink

The AWS::ApiGatewayV2::VpcLink resource creates a VPC link.

Inheritance

object

CfnElement

CfnRefElement

CfnResource

CfnVpcLink

Implements

IInspectable

ITaggable

Inherited Members

CfnResource.IsCfnResource(object)

CfnResource.AddDeletionOverride(string)

CfnResource.AddDependency(CfnResource)

CfnResource.AddDependsOn(CfnResource)

CfnResource.AddMetadata(string, object)

CfnResource.AddOverride(string, object)

CfnResource.AddPropertyDeletionOverride(string)

CfnResource.AddPropertyOverride(string, object)

CfnResource.ApplyRemovalPolicy(RemovalPolicy?, IRemovalPolicyOptions)

CfnResource.GetAtt(string, ResolutionTypeHint?)

CfnResource.GetMetadata(string)

CfnResource.ObtainDependencies()

CfnResource.ObtainResourceDependencies()

CfnResource.RemoveDependency(CfnResource)

CfnResource.ReplaceDependency(CfnResource, CfnResource)

CfnResource.ShouldSynthesize()

CfnResource.ToString()

CfnResource.ValidateProperties(object)

CfnResource.CfnOptions

CfnResource.CfnResourceType

CfnResource.UpdatedProperites

CfnResource.UpdatedProperties

CfnRefElement.Ref

CfnElement.IsCfnElement(object)

CfnElement.OverrideLogicalId(string)

CfnElement.CreationStack

CfnElement.LogicalId

CfnElement.Stack

Namespace: Amazon.CDK.AWS.Apigatewayv2

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnVpcLink : CfnResource, IInspectable, ITaggable

Syntax (vb)

Public Class CfnVpcLink Inherits CfnResource Implements IInspectable, ITaggable

Remarks

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 .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-vpclink.html

CloudformationResource: AWS::ApiGatewayV2::VpcLink

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)

The AWS::ApiGatewayV2::VpcLink resource creates a VPC link.

Properties

AttrVpcLinkId	The VPC link ID.
CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.
CfnProperties	The AWS::ApiGatewayV2::VpcLink resource creates a VPC link.
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	Tag Manager which manages the tags for this resource.
TagsRaw	The collection of tags.

Methods

Inspect(TreeInspector)	Examines the CloudFormation resource and discloses attributes.
RenderProperties(IDictionary<string, object>)	The AWS::ApiGatewayV2::VpcLink resource creates a VPC link.

Constructors

CfnVpcLink(Construct, string, ICfnVpcLinkProps)

The AWS::ApiGatewayV2::VpcLink resource creates a VPC link.

public CfnVpcLink(Construct scope, string id, ICfnVpcLinkProps props)

Parameters

scope Construct

Scope in which this resource is defined.

id string

Construct identifier for this resource (unique in its scope).

props ICfnVpcLinkProps

Resource properties.

Remarks

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 .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-vpclink.html

CloudformationResource: AWS::ApiGatewayV2::VpcLink

ExampleMetadata: fixture=_generated

Properties

AttrVpcLinkId

The VPC link ID.

public virtual string AttrVpcLinkId { get; }

Property Value

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

string

Remarks

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 .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-vpclink.html

CloudformationResource: AWS::ApiGatewayV2::VpcLink

ExampleMetadata: fixture=_generated

CfnProperties

The AWS::ApiGatewayV2::VpcLink resource creates a VPC link.

protected override IDictionary<string, object> CfnProperties { get; }

Property Value

IDictionary<string, object>

Overrides

CfnResource.CfnProperties

Remarks

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 .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-vpclink.html

CloudformationResource: AWS::ApiGatewayV2::VpcLink

ExampleMetadata: fixture=_generated

Name

The name of the VPC link.

public virtual string Name { get; set; }

Property Value

string

Remarks

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 .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-vpclink.html

CloudformationResource: AWS::ApiGatewayV2::VpcLink

ExampleMetadata: fixture=_generated

SecurityGroupIds

A list of security group IDs for the VPC link.

public virtual string[]? SecurityGroupIds { get; set; }

Property Value

string[]

Remarks

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 .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-vpclink.html

CloudformationResource: AWS::ApiGatewayV2::VpcLink

ExampleMetadata: fixture=_generated

SubnetIds

A list of subnet IDs to include in the VPC link.

public virtual string[] SubnetIds { get; set; }

Property Value

string[]

Remarks

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 .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-vpclink.html

CloudformationResource: AWS::ApiGatewayV2::VpcLink

ExampleMetadata: fixture=_generated

Tags

Tag Manager which manages the tags for this resource.

public virtual TagManager Tags { get; }

Property Value

TagManager

Remarks

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 .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-vpclink.html

CloudformationResource: AWS::ApiGatewayV2::VpcLink

ExampleMetadata: fixture=_generated

TagsRaw

The collection of tags.

public virtual IDictionary<string, string>? TagsRaw { get; set; }

Property Value

IDictionary<string, string>

Remarks

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 .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-vpclink.html

CloudformationResource: AWS::ApiGatewayV2::VpcLink

ExampleMetadata: fixture=_generated

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.

Remarks

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 .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-vpclink.html

CloudformationResource: AWS::ApiGatewayV2::VpcLink

ExampleMetadata: fixture=_generated

RenderProperties(IDictionary<string, object>)

The AWS::ApiGatewayV2::VpcLink resource creates a VPC link.

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)

Parameters

props IDictionary<string, object>

Returns

IDictionary<string, object>

Overrides

CfnResource.RenderProperties(IDictionary<string, object>)

Remarks

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 .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-vpclink.html

CloudformationResource: AWS::ApiGatewayV2::VpcLink

ExampleMetadata: fixture=_generated

Implements

IInspectable

ITaggable