AWS SDK for Go (PILOT)
API Reference

PREVIEW DOCUMENTATION - This is a preview of a new format for the AWS SDK for Go API Reference documentation. For the current AWS SDK for Go API Reference, see https://docs.aws.amazon.com/sdk-for-go/api/.

We welcome your feedback on this new version of the documentation. Send your comments to aws-sdkdocs-feedback@amazon.com.

UpdateVpcLinkOutput

import "github.com/aws/aws-sdk-go/service/apigateway"

type UpdateVpcLinkOutput struct { Description *string `locationName:"description" type:"string"` Id *string `locationName:"id" type:"string"` Name *string `locationName:"name" type:"string"` Status *string `locationName:"status" type:"string" enum:"VpcLinkStatus"` StatusMessage *string `locationName:"statusMessage" type:"string"` TargetArns []*string `locationName:"targetArns" type:"list"` }

A API Gateway VPC link for a RestApi to access resources in an Amazon Virtual Private Cloud (VPC).

To enable access to a resource in an Amazon Virtual Private Cloud through Amazon API Gateway, you, as an API developer, create a VpcLink resource targeted for one or more network load balancers of the VPC and then integrate an API method with a private integration that uses the VpcLink. The private integration has an integration type of HTTP or HTTP_PROXY and has a connection type of VPC_LINK. The integration uses the connectionId property to identify the VpcLink used.

Description

Type: *string

The description of the VPC link.

Id

Type: *string

The identifier of the VpcLink. It is used in an Integration to reference this VpcLink.

Name

Type: *string

The name used to label and identify the VPC link.

Status

Type: *string

The status of the VPC link. The valid values are AVAILABLE, PENDING, DELETING, or FAILED. Deploying an API will wait if the status is PENDING and will fail if the status is DELETING.

StatusMessage

Type: *string

A description about the VPC link status.

TargetArns

Type: []*string

The ARNs of network load balancers of the VPC targeted by the VPC link. The network load balancers must be owned by the same AWS account of the API owner.

Method

GoString

func (s UpdateVpcLinkOutput) GoString() string

GoString returns the string representation

SetDescription

func (s *UpdateVpcLinkOutput) SetDescription(v string) *UpdateVpcLinkOutput

SetDescription sets the Description field's value.

SetId

func (s *UpdateVpcLinkOutput) SetId(v string) *UpdateVpcLinkOutput

SetId sets the Id field's value.

SetName

func (s *UpdateVpcLinkOutput) SetName(v string) *UpdateVpcLinkOutput

SetName sets the Name field's value.

SetStatus

func (s *UpdateVpcLinkOutput) SetStatus(v string) *UpdateVpcLinkOutput

SetStatus sets the Status field's value.

SetStatusMessage

func (s *UpdateVpcLinkOutput) SetStatusMessage(v string) *UpdateVpcLinkOutput

SetStatusMessage sets the StatusMessage field's value.

SetTargetArns

func (s *UpdateVpcLinkOutput) SetTargetArns(v []*string) *UpdateVpcLinkOutput

SetTargetArns sets the TargetArns field's value.

String

func (s UpdateVpcLinkOutput) String() string

String returns the string representation

On this page: