Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. apigateway
  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.apigateway.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::ApiGateway::VpcLink resource creates an API Gateway VPC link for a REST API to access resources in an Amazon Virtual Private Cloud (VPC). For more information, see vpclink:create in the Amazon API Gateway REST API Reference.

    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:apigateway:getVpcLink
  arguments:
    # arguments dictionary

    The following arguments are supported:

    VpcLinkId string
    The ID for the VPC link. For example: abc123 .
    VpcLinkId string
    The ID for the VPC link. For example: abc123 .
    vpcLinkId String
    The ID for the VPC link. For example: abc123 .
    vpcLinkId string
    The ID for the VPC link. For example: abc123 .
    vpc_link_id str
    The ID for the VPC link. For example: abc123 .
    vpcLinkId String
    The ID for the VPC link. For example: abc123 .

    getVpcLink Result

    The following output properties are available:

    Description string
    The description of the VPC link.
    Name string
    The name used to label and identify the VPC link.
    Tags List<Pulumi.AwsNative.Outputs.Tag>
    An array of arbitrary tags (key-value pairs) to associate with the VPC link.
    VpcLinkId string
    The ID for the VPC link. For example: abc123 .
    Description string
    The description of the VPC link.
    Name string
    The name used to label and identify the VPC link.
    Tags Tag
    An array of arbitrary tags (key-value pairs) to associate with the VPC link.
    VpcLinkId string
    The ID for the VPC link. For example: abc123 .
    description String
    The description of the VPC link.
    name String
    The name used to label and identify the VPC link.
    tags List<Tag>
    An array of arbitrary tags (key-value pairs) to associate with the VPC link.
    vpcLinkId String
    The ID for the VPC link. For example: abc123 .
    description string
    The description of the VPC link.
    name string
    The name used to label and identify the VPC link.
    tags Tag[]
    An array of arbitrary tags (key-value pairs) to associate with the VPC link.
    vpcLinkId string
    The ID for the VPC link. For example: abc123 .
    description str
    The description of the VPC link.
    name str
    The name used to label and identify the VPC link.
    tags Sequence[root_Tag]
    An array of arbitrary tags (key-value pairs) to associate with the VPC link.
    vpc_link_id str
    The ID for the VPC link. For example: abc123 .
    description String
    The description of the VPC link.
    name String
    The name used to label and identify the VPC link.
    tags List<Property Map>
    An array of arbitrary tags (key-value pairs) to associate with the VPC link.
    vpcLinkId String
    The ID for the VPC link. For example: abc123 .

    Supporting Types

    Tag

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    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