github.com/pulumi/pulumi-aws/sdk/v6@v6.32.0/go/aws/apigateway/getVpcLink.go

// Code generated by the Pulumi Terraform Bridge (tfgen) Tool DO NOT EDIT.
// *** WARNING: Do not edit by hand unless you're certain you know what you are doing! ***

package apigateway

import (
	"context"
	"reflect"

	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/internal"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

// Use this data source to get the id of a VPC Link in
// API Gateway. To fetch the VPC Link you must provide a name to match against.
// As there is no unique name constraint on API Gateway VPC Links this data source will
// error if there is more than one match.
//
// ## Example Usage
//
// <!--Start PulumiCodeChooser -->
// ```go
// package main
//
// import (
//
//	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/apigateway"
//	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
//
// )
//
//	func main() {
//		pulumi.Run(func(ctx *pulumi.Context) error {
//			_, err := apigateway.LookupVpcLink(ctx, &apigateway.LookupVpcLinkArgs{
//				Name: "my-vpc-link",
//			}, nil)
//			if err != nil {
//				return err
//			}
//			return nil
//		})
//	}
//
// ```
// <!--End PulumiCodeChooser -->
func LookupVpcLink(ctx *pulumi.Context, args *LookupVpcLinkArgs, opts ...pulumi.InvokeOption) (*LookupVpcLinkResult, error) {
	opts = internal.PkgInvokeDefaultOpts(opts)
	var rv LookupVpcLinkResult
	err := ctx.Invoke("aws:apigateway/getVpcLink:getVpcLink", args, &rv, opts...)
	if err != nil {
		return nil, err
	}
	return &rv, nil
}

// A collection of arguments for invoking getVpcLink.
type LookupVpcLinkArgs struct {
	// Name of the API Gateway VPC Link to look up. If no API Gateway VPC Link is found with this name, an error will be returned.
	// If multiple API Gateway VPC Links are found with this name, an error will be returned.
	Name string `pulumi:"name"`
	// Key-value map of resource tags
	Tags map[string]string `pulumi:"tags"`
}

// A collection of values returned by getVpcLink.
type LookupVpcLinkResult struct {
	// Description of the VPC link.
	Description string `pulumi:"description"`
	// Set to the ID of the found API Gateway VPC Link.
	Id   string `pulumi:"id"`
	Name string `pulumi:"name"`
	// Status of the VPC link.
	Status string `pulumi:"status"`
	// Status message of the VPC link.
	StatusMessage string `pulumi:"statusMessage"`
	// Key-value map of resource tags
	Tags map[string]string `pulumi:"tags"`
	// List of network load balancer arns in the VPC targeted by the VPC link. Currently AWS only supports 1 target.
	TargetArns []string `pulumi:"targetArns"`
}

func LookupVpcLinkOutput(ctx *pulumi.Context, args LookupVpcLinkOutputArgs, opts ...pulumi.InvokeOption) LookupVpcLinkResultOutput {
	return pulumi.ToOutputWithContext(context.Background(), args).
		ApplyT(func(v interface{}) (LookupVpcLinkResult, error) {
			args := v.(LookupVpcLinkArgs)
			r, err := LookupVpcLink(ctx, &args, opts...)
			var s LookupVpcLinkResult
			if r != nil {
				s = *r
			}
			return s, err
		}).(LookupVpcLinkResultOutput)
}

// A collection of arguments for invoking getVpcLink.
type LookupVpcLinkOutputArgs struct {
	// Name of the API Gateway VPC Link to look up. If no API Gateway VPC Link is found with this name, an error will be returned.
	// If multiple API Gateway VPC Links are found with this name, an error will be returned.
	Name pulumi.StringInput `pulumi:"name"`
	// Key-value map of resource tags
	Tags pulumi.StringMapInput `pulumi:"tags"`
}

func (LookupVpcLinkOutputArgs) ElementType() reflect.Type {
	return reflect.TypeOf((*LookupVpcLinkArgs)(nil)).Elem()
}

// A collection of values returned by getVpcLink.
type LookupVpcLinkResultOutput struct{ *pulumi.OutputState }

func (LookupVpcLinkResultOutput) ElementType() reflect.Type {
	return reflect.TypeOf((*LookupVpcLinkResult)(nil)).Elem()
}

func (o LookupVpcLinkResultOutput) ToLookupVpcLinkResultOutput() LookupVpcLinkResultOutput {
	return o
}

func (o LookupVpcLinkResultOutput) ToLookupVpcLinkResultOutputWithContext(ctx context.Context) LookupVpcLinkResultOutput {
	return o
}

// Description of the VPC link.
func (o LookupVpcLinkResultOutput) Description() pulumi.StringOutput {
	return o.ApplyT(func(v LookupVpcLinkResult) string { return v.Description }).(pulumi.StringOutput)
}

// Set to the ID of the found API Gateway VPC Link.
func (o LookupVpcLinkResultOutput) Id() pulumi.StringOutput {
	return o.ApplyT(func(v LookupVpcLinkResult) string { return v.Id }).(pulumi.StringOutput)
}

func (o LookupVpcLinkResultOutput) Name() pulumi.StringOutput {
	return o.ApplyT(func(v LookupVpcLinkResult) string { return v.Name }).(pulumi.StringOutput)
}

// Status of the VPC link.
func (o LookupVpcLinkResultOutput) Status() pulumi.StringOutput {
	return o.ApplyT(func(v LookupVpcLinkResult) string { return v.Status }).(pulumi.StringOutput)
}

// Status message of the VPC link.
func (o LookupVpcLinkResultOutput) StatusMessage() pulumi.StringOutput {
	return o.ApplyT(func(v LookupVpcLinkResult) string { return v.StatusMessage }).(pulumi.StringOutput)
}

// Key-value map of resource tags
func (o LookupVpcLinkResultOutput) Tags() pulumi.StringMapOutput {
	return o.ApplyT(func(v LookupVpcLinkResult) map[string]string { return v.Tags }).(pulumi.StringMapOutput)
}

// List of network load balancer arns in the VPC targeted by the VPC link. Currently AWS only supports 1 target.
func (o LookupVpcLinkResultOutput) TargetArns() pulumi.StringArrayOutput {
	return o.ApplyT(func(v LookupVpcLinkResult) []string { return v.TargetArns }).(pulumi.StringArrayOutput)
}

func init() {
	pulumi.RegisterOutputType(LookupVpcLinkResultOutput{})
}