AWS v7.8.0 published on Tuesday, Oct 7, 2025 by Pulumi
aws.apigatewayv2.getVpcLink
Data source for managing an AWS API Gateway V2 VPC Link.
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/v7/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(region: Optional[str] = None,
tags: Optional[Mapping[str, str]] = None,
vpc_link_id: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetVpcLinkResult
def get_vpc_link_output(region: Optional[pulumi.Input[str]] = None,
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 dictionaryThe following arguments are supported:
- vpc_
link_ strid - VPC Link ID
- region str
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- Mapping[str, str]
- 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.
- Region string
- Security
Group List<string>Ids - List of security groups associated with the VPC Link.
- Subnet
Ids List<string> - List of subnets attached to the VPC Link.
- Dictionary<string, string>
- VPC Link Tags.
- Vpc
Link stringId
- Arn string
- ARN of the VPC Link.
- Id string
- The provider-assigned unique ID for this managed resource.
- Name string
- VPC Link Name.
- Region string
- Security
Group []stringIds - List of security groups associated with the VPC Link.
- Subnet
Ids []string - List of subnets attached to the VPC Link.
- map[string]string
- VPC Link Tags.
- Vpc
Link stringId
- arn String
- ARN of the VPC Link.
- id String
- The provider-assigned unique ID for this managed resource.
- name String
- VPC Link Name.
- region String
- security
Group List<String>Ids - List of security groups associated with the VPC Link.
- subnet
Ids List<String> - List of subnets attached to the VPC Link.
- Map<String,String>
- VPC Link Tags.
- vpc
Link StringId
- arn string
- ARN of the VPC Link.
- id string
- The provider-assigned unique ID for this managed resource.
- name string
- VPC Link Name.
- region string
- security
Group string[]Ids - List of security groups associated with the VPC Link.
- subnet
Ids string[] - List of subnets attached to the VPC Link.
- {[key: string]: string}
- VPC Link Tags.
- vpc
Link stringId
- arn str
- ARN of the VPC Link.
- id str
- The provider-assigned unique ID for this managed resource.
- name str
- VPC Link Name.
- region str
- security_
group_ Sequence[str]ids - List of security groups associated with the VPC Link.
- subnet_
ids Sequence[str] - List of subnets attached to the VPC Link.
- Mapping[str, str]
- VPC Link Tags.
- vpc_
link_ strid
- arn String
- ARN of the VPC Link.
- id String
- The provider-assigned unique ID for this managed resource.
- name String
- VPC Link Name.
- region String
- security
Group List<String>Ids - List of security groups associated with the VPC Link.
- subnet
Ids List<String> - List of subnets attached to the VPC Link.
- Map<String>
- VPC Link Tags.
- vpc
Link StringId
Package Details
- Repository
- AWS Classic pulumi/pulumi-aws
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
awsTerraform Provider.
