Class VpcLink

Manages an Amazon API Gateway Version 2 VPC Link.

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

Example Usage

using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
public MyStack()
{
    var example = new Aws.ApiGatewayV2.VpcLink("example", new Aws.ApiGatewayV2.VpcLinkArgs
    {
        SecurityGroupIds = 
        {
            data.Aws_security_group.Example.Id,
        },
        SubnetIds = data.Aws_subnet_ids.Example.Ids,
        Tags = 
        {
            { "Usage", "example" },
        },
    });
}

}

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.ApiGatewayV2

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

The VPC Link ARN.

Declaration

public Output<string> Arn { get; }

Property Value

Type	Description
Output<System.String>

Name

The name of the VPC Link.

Declaration

public Output<string> Name { get; }

Property Value

Type	Description
Output<System.String>

SecurityGroupIds

Security group IDs for the VPC Link.

Declaration

public Output<ImmutableArray<string>> SecurityGroupIds { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<System.String>>

SubnetIds

Subnet IDs for the VPC Link.

Declaration

public Output<ImmutableArray<string>> SubnetIds { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<System.String>>

Tags

A map of tags to assign to the VPC Link.

Declaration

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

Property Value

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

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