Sign in Dashboard Get started
  1. Packages
  2. Packages
  3. AWS
  4. API Docs
  5. apigateway
  6. VpcLink
Viewing docs for AWS v5.43.0 (Older version)
published on Tuesday, Mar 10, 2026 by Pulumi
Go to latest version
Schema (JSON)
pulumi/pulumi-aws

aws.apigateway.VpcLink

aws logo
Viewing docs for AWS v5.43.0 (Older version)
published on Tuesday, Mar 10, 2026 by Pulumi
Go to latest version
Schema (JSON)
pulumi/pulumi-aws

    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

    Example coming soon!

    Example coming soon!

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.lb.LoadBalancer;
import com.pulumi.aws.lb.LoadBalancerArgs;
import com.pulumi.aws.lb.inputs.LoadBalancerSubnetMappingArgs;
import com.pulumi.aws.apigateway.VpcLink;
import com.pulumi.aws.apigateway.VpcLinkArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var exampleLoadBalancer = new LoadBalancer("exampleLoadBalancer", LoadBalancerArgs.builder()        
            .internal(true)
            .loadBalancerType("network")
            .subnetMappings(LoadBalancerSubnetMappingArgs.builder()
                .subnetId("12345")
                .build())
            .build());

        var exampleVpcLink = new VpcLink("exampleVpcLink", VpcLinkArgs.builder()        
            .description("example description")
            .targetArn(exampleLoadBalancer.arn())
            .build());

    }
}

    Example coming soon!

    Example coming soon!

    resources:
  exampleLoadBalancer:
    type: aws:lb:LoadBalancer
    properties:
      internal: true
      loadBalancerType: network
      subnetMappings:
        - subnetId: '12345'
  exampleVpcLink:
    type: aws:apigateway:VpcLink
    properties:
      description: example description
      targetArn:
        - ${exampleLoadBalancer.arn}

    Create VpcLink Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new VpcLink(name: string, args: VpcLinkArgs, opts?: CustomResourceOptions);
    @overload
def VpcLink(resource_name: str,
            args: VpcLinkArgs,
            opts: Optional[ResourceOptions] = None)

@overload
def VpcLink(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            target_arn: Optional[str] = None,
            description: Optional[str] = None,
            name: Optional[str] = None,
            tags: Optional[Mapping[str, str]] = None)
    func NewVpcLink(ctx *Context, name string, args VpcLinkArgs, opts ...ResourceOption) (*VpcLink, error)
    public VpcLink(string name, VpcLinkArgs args, CustomResourceOptions? opts = null)
    public VpcLink(String name, VpcLinkArgs args)
public VpcLink(String name, VpcLinkArgs args, CustomResourceOptions options)

    type: aws:apigateway:VpcLink
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args VpcLinkArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args VpcLinkArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args VpcLinkArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args VpcLinkArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args VpcLinkArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var vpcLinkResource = new Aws.ApiGateway.VpcLink("vpcLinkResource", new()
{
    TargetArn = "string",
    Description = "string",
    Name = "string",
    Tags = 
    {
        { "string", "string" },
    },
});

    example, err := apigateway.NewVpcLink(ctx, "vpcLinkResource", &apigateway.VpcLinkArgs{
	TargetArn:   pulumi.String("string"),
	Description: pulumi.String("string"),
	Name:        pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})

    var vpcLinkResource = new com.pulumi.aws.apigateway.VpcLink("vpcLinkResource", com.pulumi.aws.apigateway.VpcLinkArgs.builder()
    .targetArn("string")
    .description("string")
    .name("string")
    .tags(Map.of("string", "string"))
    .build());

    vpc_link_resource = aws.apigateway.VpcLink("vpcLinkResource",
    target_arn="string",
    description="string",
    name="string",
    tags={
        "string": "string",
    })

    const vpcLinkResource = new aws.apigateway.VpcLink("vpcLinkResource", {
    targetArn: "string",
    description: "string",
    name: "string",
    tags: {
        string: "string",
    },
});

    type: aws:apigateway:VpcLink
properties:
    description: string
    name: string
    tags:
        string: string
    targetArn: string

    VpcLink Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The VpcLink resource accepts the following input properties:

    TargetArn string
    List of network load balancer arns in the VPC targeted by the VPC link. Currently AWS only supports 1 target.
    Description string
    Description of the VPC link.
    Name string
    Name used to label and identify the VPC link.
    Tags Dictionary<string, string>
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TargetArn string
    List of network load balancer arns in the VPC targeted by the VPC link. Currently AWS only supports 1 target.
    Description string
    Description of the VPC link.
    Name string
    Name used to label and identify the VPC link.
    Tags map[string]string
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    targetArn String
    List of network load balancer arns in the VPC targeted by the VPC link. Currently AWS only supports 1 target.
    description String
    Description of the VPC link.
    name String
    Name used to label and identify the VPC link.
    tags Map<String,String>
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    targetArn string
    List of network load balancer arns in the VPC targeted by the VPC link. Currently AWS only supports 1 target.
    description string
    Description of the VPC link.
    name string
    Name used to label and identify the VPC link.
    tags {[key: string]: string}
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    target_arn str
    List of network load balancer arns in the VPC targeted by the VPC link. Currently AWS only supports 1 target.
    description str
    Description of the VPC link.
    name str
    Name used to label and identify the VPC link.
    tags Mapping[str, str]
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    targetArn String
    List of network load balancer arns in the VPC targeted by the VPC link. Currently AWS only supports 1 target.
    description String
    Description of the VPC link.
    name String
    Name used to label and identify the VPC link.
    tags Map<String>
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the VpcLink resource produces the following output properties:

    Arn string
    Id string
    The provider-assigned unique ID for this managed resource.
    TagsAll Dictionary<string, string>
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
    Arn string
    Id string
    The provider-assigned unique ID for this managed resource.
    TagsAll map[string]string
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
    arn String
    id String
    The provider-assigned unique ID for this managed resource.
    tagsAll Map<String,String>
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
    arn string
    id string
    The provider-assigned unique ID for this managed resource.
    tagsAll {[key: string]: string}
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
    arn str
    id str
    The provider-assigned unique ID for this managed resource.
    tags_all Mapping[str, str]
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
    arn String
    id String
    The provider-assigned unique ID for this managed resource.
    tagsAll Map<String>
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Look up Existing VpcLink Resource

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

    public static get(name: string, id: Input<ID>, state?: VpcLinkState, opts?: CustomResourceOptions): VpcLink
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        arn: Optional[str] = None,
        description: Optional[str] = None,
        name: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = None,
        target_arn: Optional[str] = None) -> VpcLink
    func GetVpcLink(ctx *Context, name string, id IDInput, state *VpcLinkState, opts ...ResourceOption) (*VpcLink, error)
    public static VpcLink Get(string name, Input<string> id, VpcLinkState? state, CustomResourceOptions? opts = null)
    public static VpcLink get(String name, Output<String> id, VpcLinkState state, CustomResourceOptions options)
    resources:  _:    type: aws:apigateway:VpcLink    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Arn string
    Description string
    Description of the VPC link.
    Name string
    Name used to label and identify the VPC link.
    Tags Dictionary<string, string>
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll Dictionary<string, string>
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
    TargetArn string
    List of network load balancer arns in the VPC targeted by the VPC link. Currently AWS only supports 1 target.
    Arn string
    Description string
    Description of the VPC link.
    Name string
    Name used to label and identify the VPC link.
    Tags map[string]string
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll map[string]string
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
    TargetArn string
    List of network load balancer arns in the VPC targeted by the VPC link. Currently AWS only supports 1 target.
    arn String
    description String
    Description of the VPC link.
    name String
    Name used to label and identify the VPC link.
    tags Map<String,String>
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String,String>
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
    targetArn String
    List of network load balancer arns in the VPC targeted by the VPC link. Currently AWS only supports 1 target.
    arn string
    description string
    Description of the VPC link.
    name string
    Name used to label and identify the VPC link.
    tags {[key: string]: string}
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll {[key: string]: string}
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
    targetArn string
    List of network load balancer arns in the VPC targeted by the VPC link. Currently AWS only supports 1 target.
    arn str
    description str
    Description of the VPC link.
    name str
    Name used to label and identify the VPC link.
    tags Mapping[str, str]
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tags_all Mapping[str, str]
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
    target_arn str
    List of network load balancer arns in the VPC targeted by the VPC link. Currently AWS only supports 1 target.
    arn String
    description String
    Description of the VPC link.
    name String
    Name used to label and identify the VPC link.
    tags Map<String>
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String>
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
    targetArn String
    List of network load balancer arns in the VPC targeted by the VPC link. Currently AWS only supports 1 target.

    Import

    API Gateway VPC Link can be imported using the id, e.g.,

     $ pulumi import aws:apigateway/vpcLink:VpcLink example 12345abcde

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo
    Viewing docs for AWS v5.43.0 (Older version)
    published on Tuesday, Mar 10, 2026 by Pulumi
    Go to latest version
    Schema (JSON)
    pulumi/pulumi-aws

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial