Class CfnVpcLink

A CloudFormation AWS::ApiGateway::VpcLink.

Inheritance
System.Object
CfnElement
CfnRefElement
CfnResource
CfnVpcLink
Implements
Inherited Members
Namespace: Amazon.CDK.AWS.APIGateway
Assembly: Amazon.CDK.Lib.dll
public class CfnVpcLink : CfnResource, IInspectable
Public Class CfnVpcLink
    Inherits CfnResource
    Implements IInspectable

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

// 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"
    } }
});

Constructors

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
CfnVpcLink(Construct, String, ICfnVpcLinkProps)

Create a new AWS::ApiGateway::VpcLink.

Properties

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.
CfnProperties
Description

The description of the VPC link.
Name

The name used to label and identify the VPC link.
Tags

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

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

Methods

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.
RenderProperties(IDictionary<String, Object>)

Constructors

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

CfnVpcLink(Construct, String, ICfnVpcLinkProps)

Create a new AWS::ApiGateway::VpcLink.

public CfnVpcLink(Construct scope, string id, ICfnVpcLinkProps props)
Parameters
scope Constructs.Construct
  • scope in which this resource is defined.
id System.String
  • scoped id of the resource.
props ICfnVpcLinkProps
  • resource properties.

Properties

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value

System.String

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

System.Collections.Generic.IDictionary<System.String, System.Object>

Overrides

The description of the VPC link.

public virtual string Description { get; set; }
Property Value

System.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

System.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

System.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 System.Collections.Generic.IDictionary<System.String, System.Object>
Returns

System.Collections.Generic.IDictionary<System.String, System.Object>

Overrides

Implements