Class VpcLinkProps

Properties for a VpcLink.

Inheritance

System.Object

VpcLinkProps

Implements

IVpcLinkProps

Namespace: Amazon.CDK.AWS.APIGateway

Assembly: Amazon.CDK.AWS.APIGateway.dll

Syntax (csharp)

public class VpcLinkProps : Object, IVpcLinkProps

Syntax (vb)

Public Class VpcLinkProps
    Inherits Object
    Implements IVpcLinkProps

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

VpcLinkProps()

Properties

Description	The description of the VPC link.
Targets	The network load balancers of the VPC targeted by the VPC link.
VpcLinkName	The name used to label and identify the VPC link.

Constructors

VpcLinkProps()

public VpcLinkProps()

Properties

Description

The description of the VPC link.

public string Description { get; set; }

Property Value

System.String

Remarks

Default: no description

Targets

The network load balancers of the VPC targeted by the VPC link.

public INetworkLoadBalancer[] Targets { get; set; }

Property Value

INetworkLoadBalancer[]

Remarks

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

Default: - no targets. Use addTargets to add targets

VpcLinkName

The name used to label and identify the VPC link.

public string VpcLinkName { get; set; }

Property Value

System.String

Remarks

Default: - automatically generated name

Implements

IVpcLinkProps