Interface IVpcLinkProps

Namespace

Amazon.CDK.AWS.APIGateway

Assembly

Amazon.CDK.AWS.APIGateway.dll

Properties for a VpcLink.

public interface IVpcLinkProps

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

Remarks

ExampleMetadata: infused

Properties

Description

The description of the VPC link.

string? Description { get; }

Property Value

string

Remarks

Default: no description

Targets

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

INetworkLoadBalancer[]? Targets { get; }

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.

string? VpcLinkName { get; }

Property Value

string

Remarks

Default: - automatically generated name