Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. apigatewayv2
  5. getVpcLink

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.apigatewayv2.getVpcLink

Explore with Pulumi AI

aws-native logo

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native

    The AWS::ApiGatewayV2::VpcLink resource creates a VPC link. Supported only for HTTP APIs. The VPC link status must transition from PENDING to AVAILABLE to successfully create a VPC link, which can take up to 10 minutes. To learn more, see Working with VPC Links for HTTP APIs in the API Gateway Developer Guide.

    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(vpc_link_id: Optional[str] = None,
                 opts: Optional[InvokeOptions] = None) -> GetVpcLinkResult
def get_vpc_link_output(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-native:apigatewayv2:getVpcLink
  arguments:
    # arguments dictionary

    The following arguments are supported:

    VpcLinkId string
    The VPC link ID.
    VpcLinkId string
    The VPC link ID.
    vpcLinkId String
    The VPC link ID.
    vpcLinkId string
    The VPC link ID.
    vpc_link_id str
    The VPC link ID.
    vpcLinkId String
    The VPC link ID.

    getVpcLink Result

    The following output properties are available:

    Name string
    The name of the VPC link.
    Tags Dictionary<string, string>
    The collection of tags. Each tag element is associated with a given resource.
    VpcLinkId string
    The VPC link ID.
    Name string
    The name of the VPC link.
    Tags map[string]string
    The collection of tags. Each tag element is associated with a given resource.
    VpcLinkId string
    The VPC link ID.
    name String
    The name of the VPC link.
    tags Map<String,String>
    The collection of tags. Each tag element is associated with a given resource.
    vpcLinkId String
    The VPC link ID.
    name string
    The name of the VPC link.
    tags {[key: string]: string}
    The collection of tags. Each tag element is associated with a given resource.
    vpcLinkId string
    The VPC link ID.
    name str
    The name of the VPC link.
    tags Mapping[str, str]
    The collection of tags. Each tag element is associated with a given resource.
    vpc_link_id str
    The VPC link ID.
    name String
    The name of the VPC link.
    tags Map<String>
    The collection of tags. Each tag element is associated with a given resource.
    vpcLinkId String
    The VPC link ID.

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    We recommend new projects start with resources from the AWS provider.

    AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
    pulumi/pulumi-aws-native