Class VpcLink

Define a new VPC Link Specifies an API Gateway VPC link for a HTTP API to access resources in an Amazon Virtual Private Cloud (VPC).

Inheritance
object
Resource
VpcLink
Implements
IConstruct
IDependable
Inherited Members
Namespace: Amazon.CDK.AWS.Apigatewayv2
Assembly: Amazon.CDK.Lib.dll
public class VpcLink : Resource, IVpcLink, IResource, IConstruct, IDependable
Public Class VpcLink Inherits Resource Implements IVpcLink, IResource, IConstruct, IDependable

ExampleMetadata: infused

using Amazon.CDK.AWS.EC2;
            using Amazon.CDK.AWS.ElasticLoadBalancingV2;
            using Amazon.CDK.AwsApigatewayv2Integrations;


            var vpc = new Vpc(this, "VPC");
            var alb = new ApplicationLoadBalancer(this, "AppLoadBalancer", new ApplicationLoadBalancerProps { Vpc = vpc });

            var vpcLink = new VpcLink(this, "VpcLink", new VpcLinkProps { Vpc = vpc });

            // Creating an HTTP ALB Integration:
            var albIntegration = new HttpAlbIntegration("ALBIntegration", alb.Listeners[0], new HttpAlbIntegrationProps { });

Constructors

VpcLink(Construct, string, IVpcLinkProps)

Define a new VPC Link Specifies an API Gateway VPC link for a HTTP API to access resources in an Amazon Virtual Private Cloud (VPC).

Properties

PROPERTY_INJECTION_ID

Uniquely identifies this class.
Vpc

The VPC to which this VPC Link is associated with.
VpcLinkId

Physical ID of the VpcLink resource.

Methods

AddSecurityGroups(params ISecurityGroup[])

Adds the provided security groups to the vpc link.
AddSubnets(params ISubnet[])

Adds the provided subnets to the vpc link.
FromVpcLinkAttributes(Construct, string, IVpcLinkAttributes)

Import a VPC Link by specifying its attributes.

Constructors

VpcLink(Construct, string, IVpcLinkProps)

Define a new VPC Link Specifies an API Gateway VPC link for a HTTP API to access resources in an Amazon Virtual Private Cloud (VPC).

public VpcLink(Construct scope, string id, IVpcLinkProps props)
Parameters
scope Construct
id string
props IVpcLinkProps
Remarks

ExampleMetadata: infused

Examples
using Amazon.CDK.AWS.EC2;
            using Amazon.CDK.AWS.ElasticLoadBalancingV2;
            using Amazon.CDK.AwsApigatewayv2Integrations;


            var vpc = new Vpc(this, "VPC");
            var alb = new ApplicationLoadBalancer(this, "AppLoadBalancer", new ApplicationLoadBalancerProps { Vpc = vpc });

            var vpcLink = new VpcLink(this, "VpcLink", new VpcLinkProps { Vpc = vpc });

            // Creating an HTTP ALB Integration:
            var albIntegration = new HttpAlbIntegration("ALBIntegration", alb.Listeners[0], new HttpAlbIntegrationProps { });

Properties

Uniquely identifies this class.

public static string PROPERTY_INJECTION_ID { get; }
Property Value

string

ExampleMetadata: infused

The VPC to which this VPC Link is associated with.

public virtual IVpc Vpc { get; }
Property Value

IVpc

ExampleMetadata: infused

Physical ID of the VpcLink resource.

public virtual string VpcLinkId { get; }
Property Value

string

ExampleMetadata: infused

Methods

AddSecurityGroups(params ISecurityGroup[])

Adds the provided security groups to the vpc link.

public virtual void AddSecurityGroups(params ISecurityGroup[] groups)
Parameters
groups ISecurityGroup[]
Remarks

ExampleMetadata: infused

AddSubnets(params ISubnet[])

Adds the provided subnets to the vpc link.

public virtual void AddSubnets(params ISubnet[] subnets)
Parameters
subnets ISubnet[]
Remarks

ExampleMetadata: infused

FromVpcLinkAttributes(Construct, string, IVpcLinkAttributes)

Import a VPC Link by specifying its attributes.

public static IVpcLink FromVpcLinkAttributes(Construct scope, string id, IVpcLinkAttributes attrs)
Parameters
scope Construct
id string
attrs IVpcLinkAttributes
Returns

IVpcLink

Remarks

ExampleMetadata: infused

Implements

Constructs.IConstruct
Constructs.IDependable