aws.apigatewayv2.getVpcLink

AWS v6 v6.83.2, Nov 20 25

AWS v6 v6.83.2 published on Thursday, Nov 20, 2025 by Pulumi

Schema (JSON)

pulumi/pulumi-aws

AWS v6 v6.83.2 published on Thursday, Nov 20, 2025 by Pulumi

Schema (JSON)

pulumi/pulumi-aws

Example Usage

Basic Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = aws.apigatewayv2.getVpcLink({
    vpcLinkId: "example",
});

import pulumi
import pulumi_aws as aws

example = aws.apigatewayv2.get_vpc_link(vpc_link_id="example")

package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/apigatewayv2"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := apigatewayv2.LookupVpcLink(ctx, &apigatewayv2.LookupVpcLinkArgs{
			VpcLinkId: "example",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = Aws.ApiGatewayV2.GetVpcLink.Invoke(new()
    {
        VpcLinkId = "example",
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.apigatewayv2.Apigatewayv2Functions;
import com.pulumi.aws.apigatewayv2.inputs.GetVpcLinkArgs;
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) {
        final var example = Apigatewayv2Functions.getVpcLink(GetVpcLinkArgs.builder()
            .vpcLinkId("example")
            .build());

    }
}

variables:
  example:
    fn::invoke:
      function: aws:apigatewayv2:getVpcLink
      arguments:
        vpcLinkId: example

Using getVpcLink

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getVpcLink(args: GetVpcLinkArgs, opts?: InvokeOptions): Promise<GetVpcLinkResult>
function getVpcLinkOutput(args: GetVpcLinkOutputArgs, opts?: InvokeOptions): Output<GetVpcLinkResult>

def get_vpc_link(tags: Optional[Mapping[str, str]] = None,
                 vpc_link_id: Optional[str] = None,
                 opts: Optional[InvokeOptions] = None) -> GetVpcLinkResult
def get_vpc_link_output(tags: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None,
                 vpc_link_id: Optional[pulumi.Input[str]] = None,
                 opts: Optional[InvokeOptions] = None) -> Output[GetVpcLinkResult]

func LookupVpcLink(ctx *Context, args *LookupVpcLinkArgs, opts ...InvokeOption) (*LookupVpcLinkResult, error)
func LookupVpcLinkOutput(ctx *Context, args *LookupVpcLinkOutputArgs, opts ...InvokeOption) LookupVpcLinkResultOutput

> Note: This function is named LookupVpcLink in the Go SDK.

public static class GetVpcLink 
{
    public static Task<GetVpcLinkResult> InvokeAsync(GetVpcLinkArgs args, InvokeOptions? opts = null)
    public static Output<GetVpcLinkResult> Invoke(GetVpcLinkInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetVpcLinkResult> getVpcLink(GetVpcLinkArgs args, InvokeOptions options)
public static Output<GetVpcLinkResult> getVpcLink(GetVpcLinkArgs args, InvokeOptions options)

fn::invoke:
  function: aws:apigatewayv2/getVpcLink:getVpcLink
  arguments:
    # arguments dictionary

The following arguments are supported:

VpcLinkId string: VPC Link ID
Tags Dictionary<string, string>: VPC Link Tags.

VpcLinkId string: VPC Link ID
Tags map[string]string: VPC Link Tags.

vpcLinkId String: VPC Link ID
tags Map<String,String>: VPC Link Tags.

vpcLinkId string: VPC Link ID
tags {[key: string]: string}: VPC Link Tags.

vpc_link_id str: VPC Link ID
tags Mapping[str, str]: VPC Link Tags.

vpcLinkId String: VPC Link ID
tags Map<String>: VPC Link Tags.

getVpcLink Result

The following output properties are available:

Arn string: ARN of the VPC Link.
Id string: The provider-assigned unique ID for this managed resource.
Name string: VPC Link Name.
SecurityGroupIds List<string>: List of security groups associated with the VPC Link.
SubnetIds List<string>: List of subnets attached to the VPC Link.
Tags Dictionary<string, string>: VPC Link Tags.
VpcLinkId string

Arn string: ARN of the VPC Link.
Id string: The provider-assigned unique ID for this managed resource.
Name string: VPC Link Name.
SecurityGroupIds []string: List of security groups associated with the VPC Link.
SubnetIds []string: List of subnets attached to the VPC Link.
Tags map[string]string: VPC Link Tags.
VpcLinkId string

arn String: ARN of the VPC Link.
id String: The provider-assigned unique ID for this managed resource.
name String: VPC Link Name.
securityGroupIds List<String>: List of security groups associated with the VPC Link.
subnetIds List<String>: List of subnets attached to the VPC Link.
tags Map<String,String>: VPC Link Tags.
vpcLinkId String

arn string: ARN of the VPC Link.
id string: The provider-assigned unique ID for this managed resource.
name string: VPC Link Name.
securityGroupIds string[]: List of security groups associated with the VPC Link.
subnetIds string[]: List of subnets attached to the VPC Link.
tags {[key: string]: string}: VPC Link Tags.
vpcLinkId string

arn str: ARN of the VPC Link.
id str: The provider-assigned unique ID for this managed resource.
name str: VPC Link Name.
security_group_ids Sequence[str]: List of security groups associated with the VPC Link.
subnet_ids Sequence[str]: List of subnets attached to the VPC Link.
tags Mapping[str, str]: VPC Link Tags.
vpc_link_id str

arn String: ARN of the VPC Link.
id String: The provider-assigned unique ID for this managed resource.
name String: VPC Link Name.
securityGroupIds List<String>: List of security groups associated with the VPC Link.
subnetIds List<String>: List of subnets attached to the VPC Link.
tags Map<String>: VPC Link Tags.
vpcLinkId String