Table of Contents

Class CfnVpcLink

Namespace
Amazon.CDK.AWS.APIGateway
Assembly
Amazon.CDK.AWS.APIGateway.dll

A CloudFormation AWS::ApiGateway::VpcLink.

public class CfnVpcLink : CfnResource, IInspectable
Inheritance
CfnVpcLink
Implements
IInspectable
// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.APIGateway;

             var cfnVpcLink = new CfnVpcLink(this, "MyCfnVpcLink", new CfnVpcLinkProps {
                 Name = "name",
                 TargetArns = new [] { "targetArns" },

                 // the properties below are optional
                 Description = "description",
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } }
             });

The AWS::ApiGateway::VpcLink resource creates an API Gateway VPC link for a REST API to access resources in an Amazon Virtual Private Cloud (VPC). For more information, see vpclink:create in the Amazon API Gateway REST API Reference .

CloudformationResource: AWS::ApiGateway::VpcLink

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-vpclink.html

ExampleMetadata: fixture=_generated

Constructors

CfnVpcLink(Construct, string, ICfnVpcLinkProps)

Create a new AWS::ApiGateway::VpcLink.

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

Parameters

scope Construct
  • scope in which this resource is defined.
id string
  • scoped id of the resource.
props ICfnVpcLinkProps
  • resource properties.

Properties 

public virtual string AttrVpcLinkId { get; }

Property Value

string

CloudformationAttribute: VpcLinkId

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }

Property Value

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

Property Value

IDictionary<string, object>

The description of the VPC link.

public virtual string? Description { get; set; }

Property Value

string

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-vpclink.html#cfn-apigateway-vpclink-description

The name used to label and identify the VPC link.

public virtual string Name { get; set; }

Property Value

string

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-vpclink.html#cfn-apigateway-vpclink-name

An array of arbitrary tags (key-value pairs) to associate with the VPC link.

public virtual TagManager Tags { get; }

Property Value

TagManager

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-vpclink.html#cfn-apigateway-vpclink-tags

The ARN of the network load balancer of the VPC targeted by the VPC link.

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

Property Value

string[]

The network load balancer must be owned by the same AWS account of the API owner.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-vpclink.html#cfn-apigateway-vpclink-targetarns

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 IDictionary<string, object>

Returns

IDictionary<string, object>