Class VpcLink

Provides an API Gateway VPC Link.

Note: Amazon API Gateway Version 1 VPC Links enable private integrations that connect REST APIs to private resources in a VPC. To enable private integration for HTTP APIs, use the Amazon API Gateway Version 2 VPC Link resource.

Example Usage

using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
public MyStack()
{
    var exampleLoadBalancer = new Aws.LB.LoadBalancer("exampleLoadBalancer", new Aws.LB.LoadBalancerArgs
    {
        Internal = true,
        LoadBalancerType = "network",
        SubnetMappings = 
        {
            new Aws.LB.Inputs.LoadBalancerSubnetMappingArgs
            {
                SubnetId = "12345",
            },
        },
    });
    var exampleVpcLink = new Aws.ApiGateway.VpcLink("exampleVpcLink", new Aws.ApiGateway.VpcLinkArgs
    {
        Description = "example description",
        TargetArn = exampleLoadBalancer.Arn,
    });
}

}

Inheritance

System.Object

Resource

CustomResource

VpcLink

Inherited Members

CustomResource.Id

Resource.GetResourceType()

Resource.GetResourceName()

Resource.Urn

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Pulumi.Aws.ApiGateway

Assembly: Pulumi.Aws.dll

Syntax

public class VpcLink : CustomResource

Constructors

VpcLink(String, VpcLinkArgs, CustomResourceOptions)

Create a VpcLink resource with the given unique name, arguments, and options.

Declaration

public VpcLink(string name, VpcLinkArgs args, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resource
VpcLinkArgs	args	The arguments used to populate this resource's properties
CustomResourceOptions	options	A bag of options that control this resource's behavior

Properties

Arn

Declaration

public Output<string> Arn { get; }

Property Value

Type	Description
Output<System.String>

Description

The description of the VPC link.

Declaration

public Output<string> Description { get; }

Property Value

Type	Description
Output<System.String>

Name

The name used to label and identify the VPC link.

Declaration

public Output<string> Name { get; }

Property Value

Type	Description
Output<System.String>

Tags

Key-value map of resource tags

Declaration

public Output<ImmutableDictionary<string, object>> Tags { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableDictionary<System.String, System.Object>>

TargetArn

The list of network load balancer arns in the VPC targeted by the VPC link. Currently AWS only supports 1 target.

Declaration

public Output<string> TargetArn { get; }

Property Value

Type	Description
Output<System.String>

Methods

Get(String, Input<String>, VpcLinkState, CustomResourceOptions)

Get an existing VpcLink resource's state with the given name, ID, and optional extra properties used to qualify the lookup.

Declaration

public static VpcLink Get(string name, Input<string> id, VpcLinkState state = null, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resulting resource.
Input<System.String>	id	The unique provider ID of the resource to lookup.
VpcLinkState	state	Any extra arguments used during the lookup.
CustomResourceOptions	options	A bag of options that control this resource's behavior

Returns

Type	Description
VpcLink