AWS SDK for C++  1.9.47
AWS SDK for C++
Public Member Functions | List of all members
Aws::APIGateway::Model::GetVpcLinkResult Class Reference

#include <GetVpcLinkResult.h>

Public Member Functions

 GetVpcLinkResult ()
 
 GetVpcLinkResult (const Aws::AmazonWebServiceResult< Aws::Utils::Json::JsonValue > &result)
 
GetVpcLinkResultoperator= (const Aws::AmazonWebServiceResult< Aws::Utils::Json::JsonValue > &result)
 
const Aws::StringGetId () const
 
void SetId (const Aws::String &value)
 
void SetId (Aws::String &&value)
 
void SetId (const char *value)
 
GetVpcLinkResultWithId (const Aws::String &value)
 
GetVpcLinkResultWithId (Aws::String &&value)
 
GetVpcLinkResultWithId (const char *value)
 
const Aws::StringGetName () const
 
void SetName (const Aws::String &value)
 
void SetName (Aws::String &&value)
 
void SetName (const char *value)
 
GetVpcLinkResultWithName (const Aws::String &value)
 
GetVpcLinkResultWithName (Aws::String &&value)
 
GetVpcLinkResultWithName (const char *value)
 
const Aws::StringGetDescription () const
 
void SetDescription (const Aws::String &value)
 
void SetDescription (Aws::String &&value)
 
void SetDescription (const char *value)
 
GetVpcLinkResultWithDescription (const Aws::String &value)
 
GetVpcLinkResultWithDescription (Aws::String &&value)
 
GetVpcLinkResultWithDescription (const char *value)
 
const Aws::Vector< Aws::String > & GetTargetArns () const
 
void SetTargetArns (const Aws::Vector< Aws::String > &value)
 
void SetTargetArns (Aws::Vector< Aws::String > &&value)
 
GetVpcLinkResultWithTargetArns (const Aws::Vector< Aws::String > &value)
 
GetVpcLinkResultWithTargetArns (Aws::Vector< Aws::String > &&value)
 
GetVpcLinkResultAddTargetArns (const Aws::String &value)
 
GetVpcLinkResultAddTargetArns (Aws::String &&value)
 
GetVpcLinkResultAddTargetArns (const char *value)
 
const VpcLinkStatusGetStatus () const
 
void SetStatus (const VpcLinkStatus &value)
 
void SetStatus (VpcLinkStatus &&value)
 
GetVpcLinkResultWithStatus (const VpcLinkStatus &value)
 
GetVpcLinkResultWithStatus (VpcLinkStatus &&value)
 
const Aws::StringGetStatusMessage () const
 
void SetStatusMessage (const Aws::String &value)
 
void SetStatusMessage (Aws::String &&value)
 
void SetStatusMessage (const char *value)
 
GetVpcLinkResultWithStatusMessage (const Aws::String &value)
 
GetVpcLinkResultWithStatusMessage (Aws::String &&value)
 
GetVpcLinkResultWithStatusMessage (const char *value)
 
const Aws::Map< Aws::String, Aws::String > & GetTags () const
 
void SetTags (const Aws::Map< Aws::String, Aws::String > &value)
 
void SetTags (Aws::Map< Aws::String, Aws::String > &&value)
 
GetVpcLinkResultWithTags (const Aws::Map< Aws::String, Aws::String > &value)
 
GetVpcLinkResultWithTags (Aws::Map< Aws::String, Aws::String > &&value)
 
GetVpcLinkResultAddTags (const Aws::String &key, const Aws::String &value)
 
GetVpcLinkResultAddTags (Aws::String &&key, const Aws::String &value)
 
GetVpcLinkResultAddTags (const Aws::String &key, Aws::String &&value)
 
GetVpcLinkResultAddTags (Aws::String &&key, Aws::String &&value)
 
GetVpcLinkResultAddTags (const char *key, Aws::String &&value)
 
GetVpcLinkResultAddTags (Aws::String &&key, const char *value)
 
GetVpcLinkResultAddTags (const char *key, const char *value)
 

Detailed Description

An 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.

See Also:

AWS API Reference

Definition at line 44 of file GetVpcLinkResult.h.

Constructor & Destructor Documentation

◆ GetVpcLinkResult() [1/2]

Aws::APIGateway::Model::GetVpcLinkResult::GetVpcLinkResult ( )

◆ GetVpcLinkResult() [2/2]

Aws::APIGateway::Model::GetVpcLinkResult::GetVpcLinkResult ( const Aws::AmazonWebServiceResult< Aws::Utils::Json::JsonValue > &  result)

Member Function Documentation

◆ AddTags() [1/7]

GetVpcLinkResult& Aws::APIGateway::Model::GetVpcLinkResult::AddTags ( Aws::String &&  key,
Aws::String &&  value 
)
inline

The collection of tags. Each tag element is associated with a given resource.

Definition at line 353 of file GetVpcLinkResult.h.

◆ AddTags() [2/7]

GetVpcLinkResult& Aws::APIGateway::Model::GetVpcLinkResult::AddTags ( Aws::String &&  key,
const Aws::String value 
)
inline

The collection of tags. Each tag element is associated with a given resource.

Definition at line 341 of file GetVpcLinkResult.h.

◆ AddTags() [3/7]

GetVpcLinkResult& Aws::APIGateway::Model::GetVpcLinkResult::AddTags ( Aws::String &&  key,
const char *  value 
)
inline

The collection of tags. Each tag element is associated with a given resource.

Definition at line 365 of file GetVpcLinkResult.h.

◆ AddTags() [4/7]

GetVpcLinkResult& Aws::APIGateway::Model::GetVpcLinkResult::AddTags ( const Aws::String key,
Aws::String &&  value 
)
inline

The collection of tags. Each tag element is associated with a given resource.

Definition at line 347 of file GetVpcLinkResult.h.

◆ AddTags() [5/7]

GetVpcLinkResult& Aws::APIGateway::Model::GetVpcLinkResult::AddTags ( const Aws::String key,
const Aws::String value 
)
inline

The collection of tags. Each tag element is associated with a given resource.

Definition at line 335 of file GetVpcLinkResult.h.

◆ AddTags() [6/7]

GetVpcLinkResult& Aws::APIGateway::Model::GetVpcLinkResult::AddTags ( const char *  key,
Aws::String &&  value 
)
inline

The collection of tags. Each tag element is associated with a given resource.

Definition at line 359 of file GetVpcLinkResult.h.

◆ AddTags() [7/7]

GetVpcLinkResult& Aws::APIGateway::Model::GetVpcLinkResult::AddTags ( const char *  key,
const char *  value 
)
inline

The collection of tags. Each tag element is associated with a given resource.

Definition at line 371 of file GetVpcLinkResult.h.

◆ AddTargetArns() [1/3]

GetVpcLinkResult& Aws::APIGateway::Model::GetVpcLinkResult::AddTargetArns ( Aws::String &&  value)
inline

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

Definition at line 214 of file GetVpcLinkResult.h.

◆ AddTargetArns() [2/3]

GetVpcLinkResult& Aws::APIGateway::Model::GetVpcLinkResult::AddTargetArns ( const Aws::String value)
inline

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

Definition at line 207 of file GetVpcLinkResult.h.

◆ AddTargetArns() [3/3]

GetVpcLinkResult& Aws::APIGateway::Model::GetVpcLinkResult::AddTargetArns ( const char *  value)
inline

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

Definition at line 221 of file GetVpcLinkResult.h.

◆ GetDescription()

const Aws::String& Aws::APIGateway::Model::GetVpcLinkResult::GetDescription ( ) const
inline

The description of the VPC link.

Definition at line 134 of file GetVpcLinkResult.h.

◆ GetId()

const Aws::String& Aws::APIGateway::Model::GetVpcLinkResult::GetId ( ) const
inline

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

Definition at line 56 of file GetVpcLinkResult.h.

◆ GetName()

const Aws::String& Aws::APIGateway::Model::GetVpcLinkResult::GetName ( ) const
inline

The name used to label and identify the VPC link.

Definition at line 98 of file GetVpcLinkResult.h.

◆ GetStatus()

const VpcLinkStatus& Aws::APIGateway::Model::GetVpcLinkResult::GetStatus ( ) const
inline

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.

Definition at line 230 of file GetVpcLinkResult.h.

◆ GetStatusMessage()

const Aws::String& Aws::APIGateway::Model::GetVpcLinkResult::GetStatusMessage ( ) const
inline

A description about the VPC link status.

Definition at line 268 of file GetVpcLinkResult.h.

◆ GetTags()

const Aws::Map<Aws::String, Aws::String>& Aws::APIGateway::Model::GetVpcLinkResult::GetTags ( ) const
inline

The collection of tags. Each tag element is associated with a given resource.

Definition at line 305 of file GetVpcLinkResult.h.

◆ GetTargetArns()

const Aws::Vector<Aws::String>& Aws::APIGateway::Model::GetVpcLinkResult::GetTargetArns ( ) const
inline

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

Definition at line 172 of file GetVpcLinkResult.h.

◆ operator=()

GetVpcLinkResult& Aws::APIGateway::Model::GetVpcLinkResult::operator= ( const Aws::AmazonWebServiceResult< Aws::Utils::Json::JsonValue > &  result)

◆ SetDescription() [1/3]

void Aws::APIGateway::Model::GetVpcLinkResult::SetDescription ( Aws::String &&  value)
inline

The description of the VPC link.

Definition at line 144 of file GetVpcLinkResult.h.

◆ SetDescription() [2/3]

void Aws::APIGateway::Model::GetVpcLinkResult::SetDescription ( const Aws::String value)
inline

The description of the VPC link.

Definition at line 139 of file GetVpcLinkResult.h.

◆ SetDescription() [3/3]

void Aws::APIGateway::Model::GetVpcLinkResult::SetDescription ( const char *  value)
inline

The description of the VPC link.

Definition at line 149 of file GetVpcLinkResult.h.

◆ SetId() [1/3]

void Aws::APIGateway::Model::GetVpcLinkResult::SetId ( Aws::String &&  value)
inline

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

Definition at line 68 of file GetVpcLinkResult.h.

◆ SetId() [2/3]

void Aws::APIGateway::Model::GetVpcLinkResult::SetId ( const Aws::String value)
inline

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

Definition at line 62 of file GetVpcLinkResult.h.

◆ SetId() [3/3]

void Aws::APIGateway::Model::GetVpcLinkResult::SetId ( const char *  value)
inline

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

Definition at line 74 of file GetVpcLinkResult.h.

◆ SetName() [1/3]

void Aws::APIGateway::Model::GetVpcLinkResult::SetName ( Aws::String &&  value)
inline

The name used to label and identify the VPC link.

Definition at line 108 of file GetVpcLinkResult.h.

◆ SetName() [2/3]

void Aws::APIGateway::Model::GetVpcLinkResult::SetName ( const Aws::String value)
inline

The name used to label and identify the VPC link.

Definition at line 103 of file GetVpcLinkResult.h.

◆ SetName() [3/3]

void Aws::APIGateway::Model::GetVpcLinkResult::SetName ( const char *  value)
inline

The name used to label and identify the VPC link.

Definition at line 113 of file GetVpcLinkResult.h.

◆ SetStatus() [1/2]

void Aws::APIGateway::Model::GetVpcLinkResult::SetStatus ( const VpcLinkStatus value)
inline

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.

Definition at line 238 of file GetVpcLinkResult.h.

◆ SetStatus() [2/2]

void Aws::APIGateway::Model::GetVpcLinkResult::SetStatus ( VpcLinkStatus &&  value)
inline

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.

Definition at line 246 of file GetVpcLinkResult.h.

◆ SetStatusMessage() [1/3]

void Aws::APIGateway::Model::GetVpcLinkResult::SetStatusMessage ( Aws::String &&  value)
inline

A description about the VPC link status.

Definition at line 278 of file GetVpcLinkResult.h.

◆ SetStatusMessage() [2/3]

void Aws::APIGateway::Model::GetVpcLinkResult::SetStatusMessage ( const Aws::String value)
inline

A description about the VPC link status.

Definition at line 273 of file GetVpcLinkResult.h.

◆ SetStatusMessage() [3/3]

void Aws::APIGateway::Model::GetVpcLinkResult::SetStatusMessage ( const char *  value)
inline

A description about the VPC link status.

Definition at line 283 of file GetVpcLinkResult.h.

◆ SetTags() [1/2]

void Aws::APIGateway::Model::GetVpcLinkResult::SetTags ( Aws::Map< Aws::String, Aws::String > &&  value)
inline

The collection of tags. Each tag element is associated with a given resource.

Definition at line 317 of file GetVpcLinkResult.h.

◆ SetTags() [2/2]

void Aws::APIGateway::Model::GetVpcLinkResult::SetTags ( const Aws::Map< Aws::String, Aws::String > &  value)
inline

The collection of tags. Each tag element is associated with a given resource.

Definition at line 311 of file GetVpcLinkResult.h.

◆ SetTargetArns() [1/2]

void Aws::APIGateway::Model::GetVpcLinkResult::SetTargetArns ( Aws::Vector< Aws::String > &&  value)
inline

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

Definition at line 186 of file GetVpcLinkResult.h.

◆ SetTargetArns() [2/2]

void Aws::APIGateway::Model::GetVpcLinkResult::SetTargetArns ( const Aws::Vector< Aws::String > &  value)
inline

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

Definition at line 179 of file GetVpcLinkResult.h.

◆ WithDescription() [1/3]

GetVpcLinkResult& Aws::APIGateway::Model::GetVpcLinkResult::WithDescription ( Aws::String &&  value)
inline

The description of the VPC link.

Definition at line 159 of file GetVpcLinkResult.h.

◆ WithDescription() [2/3]

GetVpcLinkResult& Aws::APIGateway::Model::GetVpcLinkResult::WithDescription ( const Aws::String value)
inline

The description of the VPC link.

Definition at line 154 of file GetVpcLinkResult.h.

◆ WithDescription() [3/3]

GetVpcLinkResult& Aws::APIGateway::Model::GetVpcLinkResult::WithDescription ( const char *  value)
inline

The description of the VPC link.

Definition at line 164 of file GetVpcLinkResult.h.

◆ WithId() [1/3]

GetVpcLinkResult& Aws::APIGateway::Model::GetVpcLinkResult::WithId ( Aws::String &&  value)
inline

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

Definition at line 86 of file GetVpcLinkResult.h.

◆ WithId() [2/3]

GetVpcLinkResult& Aws::APIGateway::Model::GetVpcLinkResult::WithId ( const Aws::String value)
inline

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

Definition at line 80 of file GetVpcLinkResult.h.

◆ WithId() [3/3]

GetVpcLinkResult& Aws::APIGateway::Model::GetVpcLinkResult::WithId ( const char *  value)
inline

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

Definition at line 92 of file GetVpcLinkResult.h.

◆ WithName() [1/3]

GetVpcLinkResult& Aws::APIGateway::Model::GetVpcLinkResult::WithName ( Aws::String &&  value)
inline

The name used to label and identify the VPC link.

Definition at line 123 of file GetVpcLinkResult.h.

◆ WithName() [2/3]

GetVpcLinkResult& Aws::APIGateway::Model::GetVpcLinkResult::WithName ( const Aws::String value)
inline

The name used to label and identify the VPC link.

Definition at line 118 of file GetVpcLinkResult.h.

◆ WithName() [3/3]

GetVpcLinkResult& Aws::APIGateway::Model::GetVpcLinkResult::WithName ( const char *  value)
inline

The name used to label and identify the VPC link.

Definition at line 128 of file GetVpcLinkResult.h.

◆ WithStatus() [1/2]

GetVpcLinkResult& Aws::APIGateway::Model::GetVpcLinkResult::WithStatus ( const VpcLinkStatus value)
inline

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.

Definition at line 254 of file GetVpcLinkResult.h.

◆ WithStatus() [2/2]

GetVpcLinkResult& Aws::APIGateway::Model::GetVpcLinkResult::WithStatus ( VpcLinkStatus &&  value)
inline

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.

Definition at line 262 of file GetVpcLinkResult.h.

◆ WithStatusMessage() [1/3]

GetVpcLinkResult& Aws::APIGateway::Model::GetVpcLinkResult::WithStatusMessage ( Aws::String &&  value)
inline

A description about the VPC link status.

Definition at line 293 of file GetVpcLinkResult.h.

◆ WithStatusMessage() [2/3]

GetVpcLinkResult& Aws::APIGateway::Model::GetVpcLinkResult::WithStatusMessage ( const Aws::String value)
inline

A description about the VPC link status.

Definition at line 288 of file GetVpcLinkResult.h.

◆ WithStatusMessage() [3/3]

GetVpcLinkResult& Aws::APIGateway::Model::GetVpcLinkResult::WithStatusMessage ( const char *  value)
inline

A description about the VPC link status.

Definition at line 298 of file GetVpcLinkResult.h.

◆ WithTags() [1/2]

GetVpcLinkResult& Aws::APIGateway::Model::GetVpcLinkResult::WithTags ( Aws::Map< Aws::String, Aws::String > &&  value)
inline

The collection of tags. Each tag element is associated with a given resource.

Definition at line 329 of file GetVpcLinkResult.h.

◆ WithTags() [2/2]

GetVpcLinkResult& Aws::APIGateway::Model::GetVpcLinkResult::WithTags ( const Aws::Map< Aws::String, Aws::String > &  value)
inline

The collection of tags. Each tag element is associated with a given resource.

Definition at line 323 of file GetVpcLinkResult.h.

◆ WithTargetArns() [1/2]

GetVpcLinkResult& Aws::APIGateway::Model::GetVpcLinkResult::WithTargetArns ( Aws::Vector< Aws::String > &&  value)
inline

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

Definition at line 200 of file GetVpcLinkResult.h.

◆ WithTargetArns() [2/2]

GetVpcLinkResult& Aws::APIGateway::Model::GetVpcLinkResult::WithTargetArns ( const Aws::Vector< Aws::String > &  value)
inline

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

Definition at line 193 of file GetVpcLinkResult.h.


The documentation for this class was generated from the following file: