Show / Hide Table of Contents

Class VpcLink

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

Inheritance
System.Object
Resource
VpcLink
Implements
IVpcLink
IResource
Constructs.IConstruct
Constructs.IDependable
Inherited Members
Resource.IsOwnedResource(IConstruct)
Resource.IsResource(IConstruct)
Resource.ApplyRemovalPolicy(RemovalPolicy)
Resource.GeneratePhysicalName()
Resource.GetResourceArnAttribute(String, IArnComponents)
Resource.GetResourceNameAttribute(String)
Resource.Env
Resource.PhysicalName
Resource.Stack
Namespace: Amazon.CDK.AWS.APIGateway
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class VpcLink : Resource, IVpcLink, IResource
Syntax (vb)
Public Class VpcLink
    Inherits Resource
    Implements IVpcLink, IResource
Remarks

ExampleMetadata: infused

Examples
using Amazon.CDK.AWS.ElasticLoadBalancingV2;


var vpc = new Vpc(this, "VPC");
var nlb = new NetworkLoadBalancer(this, "NLB", new NetworkLoadBalancerProps {
    Vpc = vpc
});
var link = new VpcLink(this, "link", new VpcLinkProps {
    Targets = new [] { nlb }
});

var integration = new Integration(new IntegrationProps {
    Type = IntegrationType.HTTP_PROXY,
    Options = new IntegrationOptions {
        ConnectionType = ConnectionType.VPC_LINK,
        VpcLink = link
    }
});

Synopsis

Constructors

VpcLink(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference

VpcLink(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps

VpcLink(Construct, String, IVpcLinkProps)

Properties

VpcLinkId

Physical ID of the VpcLink resource.

Methods

AddTargets(INetworkLoadBalancer[])
FromVpcLinkId(Construct, String, String)

Import a VPC Link by its Id.

Constructors

VpcLink(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference

protected VpcLink(ByRefValue reference)
Parameters
reference Amazon.JSII.Runtime.Deputy.ByRefValue

The Javascript-owned object reference

VpcLink(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps

protected VpcLink(DeputyBase.DeputyProps props)
Parameters
props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps

The deputy props

VpcLink(Construct, String, IVpcLinkProps)

public VpcLink(Construct scope, string id, IVpcLinkProps props = null)
Parameters
scope Constructs.Construct
id System.String
props IVpcLinkProps

Properties

VpcLinkId

Physical ID of the VpcLink resource.

public virtual string VpcLinkId { get; }
Property Value

System.String

Remarks

Attribute: true

Methods

AddTargets(INetworkLoadBalancer[])

public virtual void AddTargets(params INetworkLoadBalancer[] targets)
Parameters
targets INetworkLoadBalancer[]

FromVpcLinkId(Construct, String, String)

Import a VPC Link by its Id.

public static IVpcLink FromVpcLinkId(Construct scope, string id, string vpcLinkId)
Parameters
scope Constructs.Construct
id System.String
vpcLinkId System.String
Returns

IVpcLink

Implements

IVpcLink
IResource
Constructs.IConstruct
Constructs.IDependable
Back to top Generated by DocFX