AWS SDK for C++  1.8.95
AWS SDK for C++
Public Member Functions | List of all members
Aws::ApiGatewayV2::Model::Stage Class Reference

#include <Stage.h>

Public Member Functions

 Stage ()
 
 Stage (Aws::Utils::Json::JsonView jsonValue)
 
Stageoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const AccessLogSettingsGetAccessLogSettings () const
 
bool AccessLogSettingsHasBeenSet () const
 
void SetAccessLogSettings (const AccessLogSettings &value)
 
void SetAccessLogSettings (AccessLogSettings &&value)
 
StageWithAccessLogSettings (const AccessLogSettings &value)
 
StageWithAccessLogSettings (AccessLogSettings &&value)
 
bool GetApiGatewayManaged () const
 
bool ApiGatewayManagedHasBeenSet () const
 
void SetApiGatewayManaged (bool value)
 
StageWithApiGatewayManaged (bool value)
 
bool GetAutoDeploy () const
 
bool AutoDeployHasBeenSet () const
 
void SetAutoDeploy (bool value)
 
StageWithAutoDeploy (bool value)
 
const Aws::StringGetClientCertificateId () const
 
bool ClientCertificateIdHasBeenSet () const
 
void SetClientCertificateId (const Aws::String &value)
 
void SetClientCertificateId (Aws::String &&value)
 
void SetClientCertificateId (const char *value)
 
StageWithClientCertificateId (const Aws::String &value)
 
StageWithClientCertificateId (Aws::String &&value)
 
StageWithClientCertificateId (const char *value)
 
const Aws::Utils::DateTimeGetCreatedDate () const
 
bool CreatedDateHasBeenSet () const
 
void SetCreatedDate (const Aws::Utils::DateTime &value)
 
void SetCreatedDate (Aws::Utils::DateTime &&value)
 
StageWithCreatedDate (const Aws::Utils::DateTime &value)
 
StageWithCreatedDate (Aws::Utils::DateTime &&value)
 
const RouteSettingsGetDefaultRouteSettings () const
 
bool DefaultRouteSettingsHasBeenSet () const
 
void SetDefaultRouteSettings (const RouteSettings &value)
 
void SetDefaultRouteSettings (RouteSettings &&value)
 
StageWithDefaultRouteSettings (const RouteSettings &value)
 
StageWithDefaultRouteSettings (RouteSettings &&value)
 
const Aws::StringGetDeploymentId () const
 
bool DeploymentIdHasBeenSet () const
 
void SetDeploymentId (const Aws::String &value)
 
void SetDeploymentId (Aws::String &&value)
 
void SetDeploymentId (const char *value)
 
StageWithDeploymentId (const Aws::String &value)
 
StageWithDeploymentId (Aws::String &&value)
 
StageWithDeploymentId (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)
 
StageWithDescription (const Aws::String &value)
 
StageWithDescription (Aws::String &&value)
 
StageWithDescription (const char *value)
 
const Aws::StringGetLastDeploymentStatusMessage () const
 
bool LastDeploymentStatusMessageHasBeenSet () const
 
void SetLastDeploymentStatusMessage (const Aws::String &value)
 
void SetLastDeploymentStatusMessage (Aws::String &&value)
 
void SetLastDeploymentStatusMessage (const char *value)
 
StageWithLastDeploymentStatusMessage (const Aws::String &value)
 
StageWithLastDeploymentStatusMessage (Aws::String &&value)
 
StageWithLastDeploymentStatusMessage (const char *value)
 
const Aws::Utils::DateTimeGetLastUpdatedDate () const
 
bool LastUpdatedDateHasBeenSet () const
 
void SetLastUpdatedDate (const Aws::Utils::DateTime &value)
 
void SetLastUpdatedDate (Aws::Utils::DateTime &&value)
 
StageWithLastUpdatedDate (const Aws::Utils::DateTime &value)
 
StageWithLastUpdatedDate (Aws::Utils::DateTime &&value)
 
const Aws::Map< Aws::String, RouteSettings > & GetRouteSettings () const
 
bool RouteSettingsHasBeenSet () const
 
void SetRouteSettings (const Aws::Map< Aws::String, RouteSettings > &value)
 
void SetRouteSettings (Aws::Map< Aws::String, RouteSettings > &&value)
 
StageWithRouteSettings (const Aws::Map< Aws::String, RouteSettings > &value)
 
StageWithRouteSettings (Aws::Map< Aws::String, RouteSettings > &&value)
 
StageAddRouteSettings (const Aws::String &key, const RouteSettings &value)
 
StageAddRouteSettings (Aws::String &&key, const RouteSettings &value)
 
StageAddRouteSettings (const Aws::String &key, RouteSettings &&value)
 
StageAddRouteSettings (Aws::String &&key, RouteSettings &&value)
 
StageAddRouteSettings (const char *key, RouteSettings &&value)
 
StageAddRouteSettings (const char *key, const RouteSettings &value)
 
const Aws::StringGetStageName () const
 
bool StageNameHasBeenSet () const
 
void SetStageName (const Aws::String &value)
 
void SetStageName (Aws::String &&value)
 
void SetStageName (const char *value)
 
StageWithStageName (const Aws::String &value)
 
StageWithStageName (Aws::String &&value)
 
StageWithStageName (const char *value)
 
const Aws::Map< Aws::String, Aws::String > & GetStageVariables () const
 
bool StageVariablesHasBeenSet () const
 
void SetStageVariables (const Aws::Map< Aws::String, Aws::String > &value)
 
void SetStageVariables (Aws::Map< Aws::String, Aws::String > &&value)
 
StageWithStageVariables (const Aws::Map< Aws::String, Aws::String > &value)
 
StageWithStageVariables (Aws::Map< Aws::String, Aws::String > &&value)
 
StageAddStageVariables (const Aws::String &key, const Aws::String &value)
 
StageAddStageVariables (Aws::String &&key, const Aws::String &value)
 
StageAddStageVariables (const Aws::String &key, Aws::String &&value)
 
StageAddStageVariables (Aws::String &&key, Aws::String &&value)
 
StageAddStageVariables (const char *key, Aws::String &&value)
 
StageAddStageVariables (Aws::String &&key, const char *value)
 
StageAddStageVariables (const char *key, 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)
 
StageWithTags (const Aws::Map< Aws::String, Aws::String > &value)
 
StageWithTags (Aws::Map< Aws::String, Aws::String > &&value)
 
StageAddTags (const Aws::String &key, const Aws::String &value)
 
StageAddTags (Aws::String &&key, const Aws::String &value)
 
StageAddTags (const Aws::String &key, Aws::String &&value)
 
StageAddTags (Aws::String &&key, Aws::String &&value)
 
StageAddTags (const char *key, Aws::String &&value)
 
StageAddTags (Aws::String &&key, const char *value)
 
StageAddTags (const char *key, const char *value)
 

Detailed Description

Represents an API stage.

See Also:

AWS API Reference

Definition at line 35 of file Stage.h.

Constructor & Destructor Documentation

◆ Stage() [1/2]

Aws::ApiGatewayV2::Model::Stage::Stage ( )

◆ Stage() [2/2]

Aws::ApiGatewayV2::Model::Stage::Stage ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ AccessLogSettingsHasBeenSet()

bool Aws::ApiGatewayV2::Model::Stage::AccessLogSettingsHasBeenSet ( ) const
inline

Settings for logging access in this stage.

Definition at line 52 of file Stage.h.

◆ AddRouteSettings() [1/6]

Stage& Aws::ApiGatewayV2::Model::Stage::AddRouteSettings ( const Aws::String key,
const RouteSettings value 
)
inline

Route settings for the stage, by routeKey.

Definition at line 443 of file Stage.h.

◆ AddRouteSettings() [2/6]

Stage& Aws::ApiGatewayV2::Model::Stage::AddRouteSettings ( Aws::String &&  key,
const RouteSettings value 
)
inline

Route settings for the stage, by routeKey.

Definition at line 448 of file Stage.h.

◆ AddRouteSettings() [3/6]

Stage& Aws::ApiGatewayV2::Model::Stage::AddRouteSettings ( const Aws::String key,
RouteSettings &&  value 
)
inline

Route settings for the stage, by routeKey.

Definition at line 453 of file Stage.h.

◆ AddRouteSettings() [4/6]

Stage& Aws::ApiGatewayV2::Model::Stage::AddRouteSettings ( Aws::String &&  key,
RouteSettings &&  value 
)
inline

Route settings for the stage, by routeKey.

Definition at line 458 of file Stage.h.

◆ AddRouteSettings() [5/6]

Stage& Aws::ApiGatewayV2::Model::Stage::AddRouteSettings ( const char *  key,
RouteSettings &&  value 
)
inline

Route settings for the stage, by routeKey.

Definition at line 463 of file Stage.h.

◆ AddRouteSettings() [6/6]

Stage& Aws::ApiGatewayV2::Model::Stage::AddRouteSettings ( const char *  key,
const RouteSettings value 
)
inline

Route settings for the stage, by routeKey.

Definition at line 468 of file Stage.h.

◆ AddStageVariables() [1/7]

Stage& Aws::ApiGatewayV2::Model::Stage::AddStageVariables ( const Aws::String key,
const Aws::String value 
)
inline

A map that defines the stage variables for a stage resource. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.

Definition at line 559 of file Stage.h.

◆ AddStageVariables() [2/7]

Stage& Aws::ApiGatewayV2::Model::Stage::AddStageVariables ( Aws::String &&  key,
const Aws::String value 
)
inline

A map that defines the stage variables for a stage resource. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.

Definition at line 566 of file Stage.h.

◆ AddStageVariables() [3/7]

Stage& Aws::ApiGatewayV2::Model::Stage::AddStageVariables ( const Aws::String key,
Aws::String &&  value 
)
inline

A map that defines the stage variables for a stage resource. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.

Definition at line 573 of file Stage.h.

◆ AddStageVariables() [4/7]

Stage& Aws::ApiGatewayV2::Model::Stage::AddStageVariables ( Aws::String &&  key,
Aws::String &&  value 
)
inline

A map that defines the stage variables for a stage resource. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.

Definition at line 580 of file Stage.h.

◆ AddStageVariables() [5/7]

Stage& Aws::ApiGatewayV2::Model::Stage::AddStageVariables ( const char *  key,
Aws::String &&  value 
)
inline

A map that defines the stage variables for a stage resource. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.

Definition at line 587 of file Stage.h.

◆ AddStageVariables() [6/7]

Stage& Aws::ApiGatewayV2::Model::Stage::AddStageVariables ( Aws::String &&  key,
const char *  value 
)
inline

A map that defines the stage variables for a stage resource. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.

Definition at line 594 of file Stage.h.

◆ AddStageVariables() [7/7]

Stage& Aws::ApiGatewayV2::Model::Stage::AddStageVariables ( const char *  key,
const char *  value 
)
inline

A map that defines the stage variables for a stage resource. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.

Definition at line 601 of file Stage.h.

◆ AddTags() [1/7]

Stage& Aws::ApiGatewayV2::Model::Stage::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 644 of file Stage.h.

◆ AddTags() [2/7]

Stage& Aws::ApiGatewayV2::Model::Stage::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 650 of file Stage.h.

◆ AddTags() [3/7]

Stage& Aws::ApiGatewayV2::Model::Stage::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 656 of file Stage.h.

◆ AddTags() [4/7]

Stage& Aws::ApiGatewayV2::Model::Stage::AddTags ( Aws::String &&  key,
Aws::String &&  value 
)
inline

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

Definition at line 662 of file Stage.h.

◆ AddTags() [5/7]

Stage& Aws::ApiGatewayV2::Model::Stage::AddTags ( const char *  key,
Aws::String &&  value 
)
inline

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

Definition at line 668 of file Stage.h.

◆ AddTags() [6/7]

Stage& Aws::ApiGatewayV2::Model::Stage::AddTags ( Aws::String &&  key,
const char *  value 
)
inline

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

Definition at line 674 of file Stage.h.

◆ AddTags() [7/7]

Stage& Aws::ApiGatewayV2::Model::Stage::AddTags ( const char *  key,
const char *  value 
)
inline

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

Definition at line 680 of file Stage.h.

◆ ApiGatewayManagedHasBeenSet()

bool Aws::ApiGatewayV2::Model::Stage::ApiGatewayManagedHasBeenSet ( ) const
inline

Specifies whether a stage is managed by API Gateway. If you created an API using quick create, the $default stage is managed by API Gateway. You can't modify the $default stage.

Definition at line 87 of file Stage.h.

◆ AutoDeployHasBeenSet()

bool Aws::ApiGatewayV2::Model::Stage::AutoDeployHasBeenSet ( ) const
inline

Specifies whether updates to an API automatically trigger a new deployment. The default value is false.

Definition at line 114 of file Stage.h.

◆ ClientCertificateIdHasBeenSet()

bool Aws::ApiGatewayV2::Model::Stage::ClientCertificateIdHasBeenSet ( ) const
inline

The identifier of a client certificate for a Stage. Supported only for WebSocket APIs.

Definition at line 139 of file Stage.h.

◆ CreatedDateHasBeenSet()

bool Aws::ApiGatewayV2::Model::Stage::CreatedDateHasBeenSet ( ) const
inline

The timestamp when the stage was created.

Definition at line 186 of file Stage.h.

◆ DefaultRouteSettingsHasBeenSet()

bool Aws::ApiGatewayV2::Model::Stage::DefaultRouteSettingsHasBeenSet ( ) const
inline

Default route settings for the stage.

Definition at line 217 of file Stage.h.

◆ DeploymentIdHasBeenSet()

bool Aws::ApiGatewayV2::Model::Stage::DeploymentIdHasBeenSet ( ) const
inline

The identifier of the Deployment that the Stage is associated with. Can't be updated if autoDeploy is enabled.

Definition at line 250 of file Stage.h.

◆ DescriptionHasBeenSet()

bool Aws::ApiGatewayV2::Model::Stage::DescriptionHasBeenSet ( ) const
inline

The description of the stage.

Definition at line 297 of file Stage.h.

◆ GetAccessLogSettings()

const AccessLogSettings& Aws::ApiGatewayV2::Model::Stage::GetAccessLogSettings ( ) const
inline

Settings for logging access in this stage.

Definition at line 47 of file Stage.h.

◆ GetApiGatewayManaged()

bool Aws::ApiGatewayV2::Model::Stage::GetApiGatewayManaged ( ) const
inline

Specifies whether a stage is managed by API Gateway. If you created an API using quick create, the $default stage is managed by API Gateway. You can't modify the $default stage.

Definition at line 80 of file Stage.h.

◆ GetAutoDeploy()

bool Aws::ApiGatewayV2::Model::Stage::GetAutoDeploy ( ) const
inline

Specifies whether updates to an API automatically trigger a new deployment. The default value is false.

Definition at line 108 of file Stage.h.

◆ GetClientCertificateId()

const Aws::String& Aws::ApiGatewayV2::Model::Stage::GetClientCertificateId ( ) const
inline

The identifier of a client certificate for a Stage. Supported only for WebSocket APIs.

Definition at line 133 of file Stage.h.

◆ GetCreatedDate()

const Aws::Utils::DateTime& Aws::ApiGatewayV2::Model::Stage::GetCreatedDate ( ) const
inline

The timestamp when the stage was created.

Definition at line 181 of file Stage.h.

◆ GetDefaultRouteSettings()

const RouteSettings& Aws::ApiGatewayV2::Model::Stage::GetDefaultRouteSettings ( ) const
inline

Default route settings for the stage.

Definition at line 212 of file Stage.h.

◆ GetDeploymentId()

const Aws::String& Aws::ApiGatewayV2::Model::Stage::GetDeploymentId ( ) const
inline

The identifier of the Deployment that the Stage is associated with. Can't be updated if autoDeploy is enabled.

Definition at line 244 of file Stage.h.

◆ GetDescription()

const Aws::String& Aws::ApiGatewayV2::Model::Stage::GetDescription ( ) const
inline

The description of the stage.

Definition at line 292 of file Stage.h.

◆ GetLastDeploymentStatusMessage()

const Aws::String& Aws::ApiGatewayV2::Model::Stage::GetLastDeploymentStatusMessage ( ) const
inline

Describes the status of the last deployment of a stage. Supported only for stages with autoDeploy enabled.

Definition at line 334 of file Stage.h.

◆ GetLastUpdatedDate()

const Aws::Utils::DateTime& Aws::ApiGatewayV2::Model::Stage::GetLastUpdatedDate ( ) const
inline

The timestamp when the stage was last updated.

Definition at line 382 of file Stage.h.

◆ GetRouteSettings()

const Aws::Map<Aws::String, RouteSettings>& Aws::ApiGatewayV2::Model::Stage::GetRouteSettings ( ) const
inline

Route settings for the stage, by routeKey.

Definition at line 413 of file Stage.h.

◆ GetStageName()

const Aws::String& Aws::ApiGatewayV2::Model::Stage::GetStageName ( ) const
inline

The name of the stage.

Definition at line 474 of file Stage.h.

◆ GetStageVariables()

const Aws::Map<Aws::String, Aws::String>& Aws::ApiGatewayV2::Model::Stage::GetStageVariables ( ) const
inline

A map that defines the stage variables for a stage resource. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.

Definition at line 517 of file Stage.h.

◆ GetTags()

const Aws::Map<Aws::String, Aws::String>& Aws::ApiGatewayV2::Model::Stage::GetTags ( ) const
inline

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

Definition at line 608 of file Stage.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::ApiGatewayV2::Model::Stage::Jsonize ( ) const

◆ LastDeploymentStatusMessageHasBeenSet()

bool Aws::ApiGatewayV2::Model::Stage::LastDeploymentStatusMessageHasBeenSet ( ) const
inline

Describes the status of the last deployment of a stage. Supported only for stages with autoDeploy enabled.

Definition at line 340 of file Stage.h.

◆ LastUpdatedDateHasBeenSet()

bool Aws::ApiGatewayV2::Model::Stage::LastUpdatedDateHasBeenSet ( ) const
inline

The timestamp when the stage was last updated.

Definition at line 387 of file Stage.h.

◆ operator=()

Stage& Aws::ApiGatewayV2::Model::Stage::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ RouteSettingsHasBeenSet()

bool Aws::ApiGatewayV2::Model::Stage::RouteSettingsHasBeenSet ( ) const
inline

Route settings for the stage, by routeKey.

Definition at line 418 of file Stage.h.

◆ SetAccessLogSettings() [1/2]

void Aws::ApiGatewayV2::Model::Stage::SetAccessLogSettings ( const AccessLogSettings value)
inline

Settings for logging access in this stage.

Definition at line 57 of file Stage.h.

◆ SetAccessLogSettings() [2/2]

void Aws::ApiGatewayV2::Model::Stage::SetAccessLogSettings ( AccessLogSettings &&  value)
inline

Settings for logging access in this stage.

Definition at line 62 of file Stage.h.

◆ SetApiGatewayManaged()

void Aws::ApiGatewayV2::Model::Stage::SetApiGatewayManaged ( bool  value)
inline

Specifies whether a stage is managed by API Gateway. If you created an API using quick create, the $default stage is managed by API Gateway. You can't modify the $default stage.

Definition at line 94 of file Stage.h.

◆ SetAutoDeploy()

void Aws::ApiGatewayV2::Model::Stage::SetAutoDeploy ( bool  value)
inline

Specifies whether updates to an API automatically trigger a new deployment. The default value is false.

Definition at line 120 of file Stage.h.

◆ SetClientCertificateId() [1/3]

void Aws::ApiGatewayV2::Model::Stage::SetClientCertificateId ( const Aws::String value)
inline

The identifier of a client certificate for a Stage. Supported only for WebSocket APIs.

Definition at line 145 of file Stage.h.

◆ SetClientCertificateId() [2/3]

void Aws::ApiGatewayV2::Model::Stage::SetClientCertificateId ( Aws::String &&  value)
inline

The identifier of a client certificate for a Stage. Supported only for WebSocket APIs.

Definition at line 151 of file Stage.h.

◆ SetClientCertificateId() [3/3]

void Aws::ApiGatewayV2::Model::Stage::SetClientCertificateId ( const char *  value)
inline

The identifier of a client certificate for a Stage. Supported only for WebSocket APIs.

Definition at line 157 of file Stage.h.

◆ SetCreatedDate() [1/2]

void Aws::ApiGatewayV2::Model::Stage::SetCreatedDate ( const Aws::Utils::DateTime value)
inline

The timestamp when the stage was created.

Definition at line 191 of file Stage.h.

◆ SetCreatedDate() [2/2]

void Aws::ApiGatewayV2::Model::Stage::SetCreatedDate ( Aws::Utils::DateTime &&  value)
inline

The timestamp when the stage was created.

Definition at line 196 of file Stage.h.

◆ SetDefaultRouteSettings() [1/2]

void Aws::ApiGatewayV2::Model::Stage::SetDefaultRouteSettings ( const RouteSettings value)
inline

Default route settings for the stage.

Definition at line 222 of file Stage.h.

◆ SetDefaultRouteSettings() [2/2]

void Aws::ApiGatewayV2::Model::Stage::SetDefaultRouteSettings ( RouteSettings &&  value)
inline

Default route settings for the stage.

Definition at line 227 of file Stage.h.

◆ SetDeploymentId() [1/3]

void Aws::ApiGatewayV2::Model::Stage::SetDeploymentId ( const Aws::String value)
inline

The identifier of the Deployment that the Stage is associated with. Can't be updated if autoDeploy is enabled.

Definition at line 256 of file Stage.h.

◆ SetDeploymentId() [2/3]

void Aws::ApiGatewayV2::Model::Stage::SetDeploymentId ( Aws::String &&  value)
inline

The identifier of the Deployment that the Stage is associated with. Can't be updated if autoDeploy is enabled.

Definition at line 262 of file Stage.h.

◆ SetDeploymentId() [3/3]

void Aws::ApiGatewayV2::Model::Stage::SetDeploymentId ( const char *  value)
inline

The identifier of the Deployment that the Stage is associated with. Can't be updated if autoDeploy is enabled.

Definition at line 268 of file Stage.h.

◆ SetDescription() [1/3]

void Aws::ApiGatewayV2::Model::Stage::SetDescription ( const Aws::String value)
inline

The description of the stage.

Definition at line 302 of file Stage.h.

◆ SetDescription() [2/3]

void Aws::ApiGatewayV2::Model::Stage::SetDescription ( Aws::String &&  value)
inline

The description of the stage.

Definition at line 307 of file Stage.h.

◆ SetDescription() [3/3]

void Aws::ApiGatewayV2::Model::Stage::SetDescription ( const char *  value)
inline

The description of the stage.

Definition at line 312 of file Stage.h.

◆ SetLastDeploymentStatusMessage() [1/3]

void Aws::ApiGatewayV2::Model::Stage::SetLastDeploymentStatusMessage ( const Aws::String value)
inline

Describes the status of the last deployment of a stage. Supported only for stages with autoDeploy enabled.

Definition at line 346 of file Stage.h.

◆ SetLastDeploymentStatusMessage() [2/3]

void Aws::ApiGatewayV2::Model::Stage::SetLastDeploymentStatusMessage ( Aws::String &&  value)
inline

Describes the status of the last deployment of a stage. Supported only for stages with autoDeploy enabled.

Definition at line 352 of file Stage.h.

◆ SetLastDeploymentStatusMessage() [3/3]

void Aws::ApiGatewayV2::Model::Stage::SetLastDeploymentStatusMessage ( const char *  value)
inline

Describes the status of the last deployment of a stage. Supported only for stages with autoDeploy enabled.

Definition at line 358 of file Stage.h.

◆ SetLastUpdatedDate() [1/2]

void Aws::ApiGatewayV2::Model::Stage::SetLastUpdatedDate ( const Aws::Utils::DateTime value)
inline

The timestamp when the stage was last updated.

Definition at line 392 of file Stage.h.

◆ SetLastUpdatedDate() [2/2]

void Aws::ApiGatewayV2::Model::Stage::SetLastUpdatedDate ( Aws::Utils::DateTime &&  value)
inline

The timestamp when the stage was last updated.

Definition at line 397 of file Stage.h.

◆ SetRouteSettings() [1/2]

void Aws::ApiGatewayV2::Model::Stage::SetRouteSettings ( const Aws::Map< Aws::String, RouteSettings > &  value)
inline

Route settings for the stage, by routeKey.

Definition at line 423 of file Stage.h.

◆ SetRouteSettings() [2/2]

void Aws::ApiGatewayV2::Model::Stage::SetRouteSettings ( Aws::Map< Aws::String, RouteSettings > &&  value)
inline

Route settings for the stage, by routeKey.

Definition at line 428 of file Stage.h.

◆ SetStageName() [1/3]

void Aws::ApiGatewayV2::Model::Stage::SetStageName ( const Aws::String value)
inline

The name of the stage.

Definition at line 484 of file Stage.h.

◆ SetStageName() [2/3]

void Aws::ApiGatewayV2::Model::Stage::SetStageName ( Aws::String &&  value)
inline

The name of the stage.

Definition at line 489 of file Stage.h.

◆ SetStageName() [3/3]

void Aws::ApiGatewayV2::Model::Stage::SetStageName ( const char *  value)
inline

The name of the stage.

Definition at line 494 of file Stage.h.

◆ SetStageVariables() [1/2]

void Aws::ApiGatewayV2::Model::Stage::SetStageVariables ( const Aws::Map< Aws::String, Aws::String > &  value)
inline

A map that defines the stage variables for a stage resource. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.

Definition at line 531 of file Stage.h.

◆ SetStageVariables() [2/2]

void Aws::ApiGatewayV2::Model::Stage::SetStageVariables ( Aws::Map< Aws::String, Aws::String > &&  value)
inline

A map that defines the stage variables for a stage resource. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.

Definition at line 538 of file Stage.h.

◆ SetTags() [1/2]

void Aws::ApiGatewayV2::Model::Stage::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 620 of file Stage.h.

◆ SetTags() [2/2]

void Aws::ApiGatewayV2::Model::Stage::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 626 of file Stage.h.

◆ StageNameHasBeenSet()

bool Aws::ApiGatewayV2::Model::Stage::StageNameHasBeenSet ( ) const
inline

The name of the stage.

Definition at line 479 of file Stage.h.

◆ StageVariablesHasBeenSet()

bool Aws::ApiGatewayV2::Model::Stage::StageVariablesHasBeenSet ( ) const
inline

A map that defines the stage variables for a stage resource. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.

Definition at line 524 of file Stage.h.

◆ TagsHasBeenSet()

bool Aws::ApiGatewayV2::Model::Stage::TagsHasBeenSet ( ) const
inline

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

Definition at line 614 of file Stage.h.

◆ WithAccessLogSettings() [1/2]

Stage& Aws::ApiGatewayV2::Model::Stage::WithAccessLogSettings ( const AccessLogSettings value)
inline

Settings for logging access in this stage.

Definition at line 67 of file Stage.h.

◆ WithAccessLogSettings() [2/2]

Stage& Aws::ApiGatewayV2::Model::Stage::WithAccessLogSettings ( AccessLogSettings &&  value)
inline

Settings for logging access in this stage.

Definition at line 72 of file Stage.h.

◆ WithApiGatewayManaged()

Stage& Aws::ApiGatewayV2::Model::Stage::WithApiGatewayManaged ( bool  value)
inline

Specifies whether a stage is managed by API Gateway. If you created an API using quick create, the $default stage is managed by API Gateway. You can't modify the $default stage.

Definition at line 101 of file Stage.h.

◆ WithAutoDeploy()

Stage& Aws::ApiGatewayV2::Model::Stage::WithAutoDeploy ( bool  value)
inline

Specifies whether updates to an API automatically trigger a new deployment. The default value is false.

Definition at line 126 of file Stage.h.

◆ WithClientCertificateId() [1/3]

Stage& Aws::ApiGatewayV2::Model::Stage::WithClientCertificateId ( const Aws::String value)
inline

The identifier of a client certificate for a Stage. Supported only for WebSocket APIs.

Definition at line 163 of file Stage.h.

◆ WithClientCertificateId() [2/3]

Stage& Aws::ApiGatewayV2::Model::Stage::WithClientCertificateId ( Aws::String &&  value)
inline

The identifier of a client certificate for a Stage. Supported only for WebSocket APIs.

Definition at line 169 of file Stage.h.

◆ WithClientCertificateId() [3/3]

Stage& Aws::ApiGatewayV2::Model::Stage::WithClientCertificateId ( const char *  value)
inline

The identifier of a client certificate for a Stage. Supported only for WebSocket APIs.

Definition at line 175 of file Stage.h.

◆ WithCreatedDate() [1/2]

Stage& Aws::ApiGatewayV2::Model::Stage::WithCreatedDate ( const Aws::Utils::DateTime value)
inline

The timestamp when the stage was created.

Definition at line 201 of file Stage.h.

◆ WithCreatedDate() [2/2]

Stage& Aws::ApiGatewayV2::Model::Stage::WithCreatedDate ( Aws::Utils::DateTime &&  value)
inline

The timestamp when the stage was created.

Definition at line 206 of file Stage.h.

◆ WithDefaultRouteSettings() [1/2]

Stage& Aws::ApiGatewayV2::Model::Stage::WithDefaultRouteSettings ( const RouteSettings value)
inline

Default route settings for the stage.

Definition at line 232 of file Stage.h.

◆ WithDefaultRouteSettings() [2/2]

Stage& Aws::ApiGatewayV2::Model::Stage::WithDefaultRouteSettings ( RouteSettings &&  value)
inline

Default route settings for the stage.

Definition at line 237 of file Stage.h.

◆ WithDeploymentId() [1/3]

Stage& Aws::ApiGatewayV2::Model::Stage::WithDeploymentId ( const Aws::String value)
inline

The identifier of the Deployment that the Stage is associated with. Can't be updated if autoDeploy is enabled.

Definition at line 274 of file Stage.h.

◆ WithDeploymentId() [2/3]

Stage& Aws::ApiGatewayV2::Model::Stage::WithDeploymentId ( Aws::String &&  value)
inline

The identifier of the Deployment that the Stage is associated with. Can't be updated if autoDeploy is enabled.

Definition at line 280 of file Stage.h.

◆ WithDeploymentId() [3/3]

Stage& Aws::ApiGatewayV2::Model::Stage::WithDeploymentId ( const char *  value)
inline

The identifier of the Deployment that the Stage is associated with. Can't be updated if autoDeploy is enabled.

Definition at line 286 of file Stage.h.

◆ WithDescription() [1/3]

Stage& Aws::ApiGatewayV2::Model::Stage::WithDescription ( const Aws::String value)
inline

The description of the stage.

Definition at line 317 of file Stage.h.

◆ WithDescription() [2/3]

Stage& Aws::ApiGatewayV2::Model::Stage::WithDescription ( Aws::String &&  value)
inline

The description of the stage.

Definition at line 322 of file Stage.h.

◆ WithDescription() [3/3]

Stage& Aws::ApiGatewayV2::Model::Stage::WithDescription ( const char *  value)
inline

The description of the stage.

Definition at line 327 of file Stage.h.

◆ WithLastDeploymentStatusMessage() [1/3]

Stage& Aws::ApiGatewayV2::Model::Stage::WithLastDeploymentStatusMessage ( const Aws::String value)
inline

Describes the status of the last deployment of a stage. Supported only for stages with autoDeploy enabled.

Definition at line 364 of file Stage.h.

◆ WithLastDeploymentStatusMessage() [2/3]

Stage& Aws::ApiGatewayV2::Model::Stage::WithLastDeploymentStatusMessage ( Aws::String &&  value)
inline

Describes the status of the last deployment of a stage. Supported only for stages with autoDeploy enabled.

Definition at line 370 of file Stage.h.

◆ WithLastDeploymentStatusMessage() [3/3]

Stage& Aws::ApiGatewayV2::Model::Stage::WithLastDeploymentStatusMessage ( const char *  value)
inline

Describes the status of the last deployment of a stage. Supported only for stages with autoDeploy enabled.

Definition at line 376 of file Stage.h.

◆ WithLastUpdatedDate() [1/2]

Stage& Aws::ApiGatewayV2::Model::Stage::WithLastUpdatedDate ( const Aws::Utils::DateTime value)
inline

The timestamp when the stage was last updated.

Definition at line 402 of file Stage.h.

◆ WithLastUpdatedDate() [2/2]

Stage& Aws::ApiGatewayV2::Model::Stage::WithLastUpdatedDate ( Aws::Utils::DateTime &&  value)
inline

The timestamp when the stage was last updated.

Definition at line 407 of file Stage.h.

◆ WithRouteSettings() [1/2]

Stage& Aws::ApiGatewayV2::Model::Stage::WithRouteSettings ( const Aws::Map< Aws::String, RouteSettings > &  value)
inline

Route settings for the stage, by routeKey.

Definition at line 433 of file Stage.h.

◆ WithRouteSettings() [2/2]

Stage& Aws::ApiGatewayV2::Model::Stage::WithRouteSettings ( Aws::Map< Aws::String, RouteSettings > &&  value)
inline

Route settings for the stage, by routeKey.

Definition at line 438 of file Stage.h.

◆ WithStageName() [1/3]

Stage& Aws::ApiGatewayV2::Model::Stage::WithStageName ( const Aws::String value)
inline

The name of the stage.

Definition at line 499 of file Stage.h.

◆ WithStageName() [2/3]

Stage& Aws::ApiGatewayV2::Model::Stage::WithStageName ( Aws::String &&  value)
inline

The name of the stage.

Definition at line 504 of file Stage.h.

◆ WithStageName() [3/3]

Stage& Aws::ApiGatewayV2::Model::Stage::WithStageName ( const char *  value)
inline

The name of the stage.

Definition at line 509 of file Stage.h.

◆ WithStageVariables() [1/2]

Stage& Aws::ApiGatewayV2::Model::Stage::WithStageVariables ( const Aws::Map< Aws::String, Aws::String > &  value)
inline

A map that defines the stage variables for a stage resource. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.

Definition at line 545 of file Stage.h.

◆ WithStageVariables() [2/2]

Stage& Aws::ApiGatewayV2::Model::Stage::WithStageVariables ( Aws::Map< Aws::String, Aws::String > &&  value)
inline

A map that defines the stage variables for a stage resource. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.

Definition at line 552 of file Stage.h.

◆ WithTags() [1/2]

Stage& Aws::ApiGatewayV2::Model::Stage::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 632 of file Stage.h.

◆ WithTags() [2/2]

Stage& Aws::ApiGatewayV2::Model::Stage::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 638 of file Stage.h.


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