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

#include <VpcLink.h>

Public Member Functions

 VpcLink ()
 
 VpcLink (Aws::Utils::Json::JsonView jsonValue)
 
VpcLinkoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::StringGetId () const
 
bool IdHasBeenSet () const
 
void SetId (const Aws::String &value)
 
void SetId (Aws::String &&value)
 
void SetId (const char *value)
 
VpcLinkWithId (const Aws::String &value)
 
VpcLinkWithId (Aws::String &&value)
 
VpcLinkWithId (const char *value)
 
const Aws::StringGetName () const
 
bool NameHasBeenSet () const
 
void SetName (const Aws::String &value)
 
void SetName (Aws::String &&value)
 
void SetName (const char *value)
 
VpcLinkWithName (const Aws::String &value)
 
VpcLinkWithName (Aws::String &&value)
 
VpcLinkWithName (const char *value)
 
const Aws::StringGetDescription () const
 
bool DescriptionHasBeenSet () const
 
void SetDescription (const Aws::String &value)
 
void SetDescription (Aws::String &&value)
 
void SetDescription (const char *value)
 
VpcLinkWithDescription (const Aws::String &value)
 
VpcLinkWithDescription (Aws::String &&value)
 
VpcLinkWithDescription (const char *value)
 
const Aws::Vector< Aws::String > & GetTargetArns () const
 
bool TargetArnsHasBeenSet () const
 
void SetTargetArns (const Aws::Vector< Aws::String > &value)
 
void SetTargetArns (Aws::Vector< Aws::String > &&value)
 
VpcLinkWithTargetArns (const Aws::Vector< Aws::String > &value)
 
VpcLinkWithTargetArns (Aws::Vector< Aws::String > &&value)
 
VpcLinkAddTargetArns (const Aws::String &value)
 
VpcLinkAddTargetArns (Aws::String &&value)
 
VpcLinkAddTargetArns (const char *value)
 
const VpcLinkStatusGetStatus () const
 
bool StatusHasBeenSet () const
 
void SetStatus (const VpcLinkStatus &value)
 
void SetStatus (VpcLinkStatus &&value)
 
VpcLinkWithStatus (const VpcLinkStatus &value)
 
VpcLinkWithStatus (VpcLinkStatus &&value)
 
const Aws::StringGetStatusMessage () const
 
bool StatusMessageHasBeenSet () const
 
void SetStatusMessage (const Aws::String &value)
 
void SetStatusMessage (Aws::String &&value)
 
void SetStatusMessage (const char *value)
 
VpcLinkWithStatusMessage (const Aws::String &value)
 
VpcLinkWithStatusMessage (Aws::String &&value)
 
VpcLinkWithStatusMessage (const char *value)
 
const Aws::Map< Aws::String, Aws::String > & GetTags () const
 
bool TagsHasBeenSet () const
 
void SetTags (const Aws::Map< Aws::String, Aws::String > &value)
 
void SetTags (Aws::Map< Aws::String, Aws::String > &&value)
 
VpcLinkWithTags (const Aws::Map< Aws::String, Aws::String > &value)
 
VpcLinkWithTags (Aws::Map< Aws::String, Aws::String > &&value)
 
VpcLinkAddTags (const Aws::String &key, const Aws::String &value)
 
VpcLinkAddTags (Aws::String &&key, const Aws::String &value)
 
VpcLinkAddTags (const Aws::String &key, Aws::String &&value)
 
VpcLinkAddTags (Aws::String &&key, Aws::String &&value)
 
VpcLinkAddTags (const char *key, Aws::String &&value)
 
VpcLinkAddTags (Aws::String &&key, const char *value)
 
VpcLinkAddTags (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 43 of file VpcLink.h.

Constructor & Destructor Documentation

◆ VpcLink() [1/2]

Aws::APIGateway::Model::VpcLink::VpcLink ( )

◆ VpcLink() [2/2]

Aws::APIGateway::Model::VpcLink::VpcLink ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ AddTags() [1/7]

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

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

Definition at line 395 of file VpcLink.h.

◆ AddTags() [2/7]

VpcLink& Aws::APIGateway::Model::VpcLink::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 383 of file VpcLink.h.

◆ AddTags() [3/7]

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

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

Definition at line 407 of file VpcLink.h.

◆ AddTags() [4/7]

VpcLink& Aws::APIGateway::Model::VpcLink::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 389 of file VpcLink.h.

◆ AddTags() [5/7]

VpcLink& Aws::APIGateway::Model::VpcLink::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 377 of file VpcLink.h.

◆ AddTags() [6/7]

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

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

Definition at line 401 of file VpcLink.h.

◆ AddTags() [7/7]

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

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

Definition at line 413 of file VpcLink.h.

◆ AddTargetArns() [1/3]

VpcLink& Aws::APIGateway::Model::VpcLink::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 237 of file VpcLink.h.

◆ AddTargetArns() [2/3]

VpcLink& Aws::APIGateway::Model::VpcLink::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 230 of file VpcLink.h.

◆ AddTargetArns() [3/3]

VpcLink& Aws::APIGateway::Model::VpcLink::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 244 of file VpcLink.h.

◆ DescriptionHasBeenSet()

bool Aws::APIGateway::Model::VpcLink::DescriptionHasBeenSet ( ) const
inline

The description of the VPC link.

Definition at line 150 of file VpcLink.h.

◆ GetDescription()

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

The description of the VPC link.

Definition at line 145 of file VpcLink.h.

◆ GetId()

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

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

Definition at line 56 of file VpcLink.h.

◆ GetName()

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

The name used to label and identify the VPC link.

Definition at line 104 of file VpcLink.h.

◆ GetStatus()

const VpcLinkStatus& Aws::APIGateway::Model::VpcLink::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 253 of file VpcLink.h.

◆ GetStatusMessage()

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

A description about the VPC link status.

Definition at line 299 of file VpcLink.h.

◆ GetTags()

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

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

Definition at line 341 of file VpcLink.h.

◆ GetTargetArns()

const Aws::Vector<Aws::String>& Aws::APIGateway::Model::VpcLink::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 188 of file VpcLink.h.

◆ IdHasBeenSet()

bool Aws::APIGateway::Model::VpcLink::IdHasBeenSet ( ) const
inline

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

Definition at line 62 of file VpcLink.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::APIGateway::Model::VpcLink::Jsonize ( ) const

◆ NameHasBeenSet()

bool Aws::APIGateway::Model::VpcLink::NameHasBeenSet ( ) const
inline

The name used to label and identify the VPC link.

Definition at line 109 of file VpcLink.h.

◆ operator=()

VpcLink& Aws::APIGateway::Model::VpcLink::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ SetDescription() [1/3]

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

The description of the VPC link.

Definition at line 160 of file VpcLink.h.

◆ SetDescription() [2/3]

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

The description of the VPC link.

Definition at line 155 of file VpcLink.h.

◆ SetDescription() [3/3]

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

The description of the VPC link.

Definition at line 165 of file VpcLink.h.

◆ SetId() [1/3]

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

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

Definition at line 74 of file VpcLink.h.

◆ SetId() [2/3]

void Aws::APIGateway::Model::VpcLink::SetId ( const 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 VpcLink.h.

◆ SetId() [3/3]

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

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

Definition at line 80 of file VpcLink.h.

◆ SetName() [1/3]

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

The name used to label and identify the VPC link.

Definition at line 119 of file VpcLink.h.

◆ SetName() [2/3]

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

The name used to label and identify the VPC link.

Definition at line 114 of file VpcLink.h.

◆ SetName() [3/3]

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

The name used to label and identify the VPC link.

Definition at line 124 of file VpcLink.h.

◆ SetStatus() [1/2]

void Aws::APIGateway::Model::VpcLink::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 269 of file VpcLink.h.

◆ SetStatus() [2/2]

void Aws::APIGateway::Model::VpcLink::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 277 of file VpcLink.h.

◆ SetStatusMessage() [1/3]

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

A description about the VPC link status.

Definition at line 314 of file VpcLink.h.

◆ SetStatusMessage() [2/3]

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

A description about the VPC link status.

Definition at line 309 of file VpcLink.h.

◆ SetStatusMessage() [3/3]

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

A description about the VPC link status.

Definition at line 319 of file VpcLink.h.

◆ SetTags() [1/2]

void Aws::APIGateway::Model::VpcLink::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 359 of file VpcLink.h.

◆ SetTags() [2/2]

void Aws::APIGateway::Model::VpcLink::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 353 of file VpcLink.h.

◆ SetTargetArns() [1/2]

void Aws::APIGateway::Model::VpcLink::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 209 of file VpcLink.h.

◆ SetTargetArns() [2/2]

void Aws::APIGateway::Model::VpcLink::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 202 of file VpcLink.h.

◆ StatusHasBeenSet()

bool Aws::APIGateway::Model::VpcLink::StatusHasBeenSet ( ) 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 261 of file VpcLink.h.

◆ StatusMessageHasBeenSet()

bool Aws::APIGateway::Model::VpcLink::StatusMessageHasBeenSet ( ) const
inline

A description about the VPC link status.

Definition at line 304 of file VpcLink.h.

◆ TagsHasBeenSet()

bool Aws::APIGateway::Model::VpcLink::TagsHasBeenSet ( ) const
inline

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

Definition at line 347 of file VpcLink.h.

◆ TargetArnsHasBeenSet()

bool Aws::APIGateway::Model::VpcLink::TargetArnsHasBeenSet ( ) 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 195 of file VpcLink.h.

◆ WithDescription() [1/3]

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

The description of the VPC link.

Definition at line 175 of file VpcLink.h.

◆ WithDescription() [2/3]

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

The description of the VPC link.

Definition at line 170 of file VpcLink.h.

◆ WithDescription() [3/3]

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

The description of the VPC link.

Definition at line 180 of file VpcLink.h.

◆ WithId() [1/3]

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

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

Definition at line 92 of file VpcLink.h.

◆ WithId() [2/3]

VpcLink& Aws::APIGateway::Model::VpcLink::WithId ( const 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 VpcLink.h.

◆ WithId() [3/3]

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

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

Definition at line 98 of file VpcLink.h.

◆ WithName() [1/3]

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

The name used to label and identify the VPC link.

Definition at line 134 of file VpcLink.h.

◆ WithName() [2/3]

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

The name used to label and identify the VPC link.

Definition at line 129 of file VpcLink.h.

◆ WithName() [3/3]

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

The name used to label and identify the VPC link.

Definition at line 139 of file VpcLink.h.

◆ WithStatus() [1/2]

VpcLink& Aws::APIGateway::Model::VpcLink::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 285 of file VpcLink.h.

◆ WithStatus() [2/2]

VpcLink& Aws::APIGateway::Model::VpcLink::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 293 of file VpcLink.h.

◆ WithStatusMessage() [1/3]

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

A description about the VPC link status.

Definition at line 329 of file VpcLink.h.

◆ WithStatusMessage() [2/3]

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

A description about the VPC link status.

Definition at line 324 of file VpcLink.h.

◆ WithStatusMessage() [3/3]

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

A description about the VPC link status.

Definition at line 334 of file VpcLink.h.

◆ WithTags() [1/2]

VpcLink& Aws::APIGateway::Model::VpcLink::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 371 of file VpcLink.h.

◆ WithTags() [2/2]

VpcLink& Aws::APIGateway::Model::VpcLink::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 365 of file VpcLink.h.

◆ WithTargetArns() [1/2]

VpcLink& Aws::APIGateway::Model::VpcLink::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 223 of file VpcLink.h.

◆ WithTargetArns() [2/2]

VpcLink& Aws::APIGateway::Model::VpcLink::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 216 of file VpcLink.h.


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