#include <Stage.h>

Public Member Functions
	Stage ()

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

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

Aws::Utils::Json::JsonValue	Jsonize () const

const Aws::String &	GetDeploymentId () const

bool	DeploymentIdHasBeenSet () const

void	SetDeploymentId (const Aws::String &value)

void	SetDeploymentId (Aws::String &&value)

void	SetDeploymentId (const char *value)

Stage &	WithDeploymentId (const Aws::String &value)

Stage &	WithDeploymentId (Aws::String &&value)

Stage &	WithDeploymentId (const char *value)

const Aws::String &	GetClientCertificateId () const

bool	ClientCertificateIdHasBeenSet () const

void	SetClientCertificateId (const Aws::String &value)

void	SetClientCertificateId (Aws::String &&value)

void	SetClientCertificateId (const char *value)

Stage &	WithClientCertificateId (const Aws::String &value)

Stage &	WithClientCertificateId (Aws::String &&value)

Stage &	WithClientCertificateId (const char *value)

const Aws::String &	GetStageName () const

bool	StageNameHasBeenSet () const

void	SetStageName (const Aws::String &value)

void	SetStageName (Aws::String &&value)

void	SetStageName (const char *value)

Stage &	WithStageName (const Aws::String &value)

Stage &	WithStageName (Aws::String &&value)

Stage &	WithStageName (const char *value)

const Aws::String &	GetDescription () const

bool	DescriptionHasBeenSet () const

void	SetDescription (const Aws::String &value)

void	SetDescription (Aws::String &&value)

void	SetDescription (const char *value)

Stage &	WithDescription (const Aws::String &value)

Stage &	WithDescription (Aws::String &&value)

Stage &	WithDescription (const char *value)

bool	GetCacheClusterEnabled () const

bool	CacheClusterEnabledHasBeenSet () const

void	SetCacheClusterEnabled (bool value)

Stage &	WithCacheClusterEnabled (bool value)

const CacheClusterSize &	GetCacheClusterSize () const

bool	CacheClusterSizeHasBeenSet () const

void	SetCacheClusterSize (const CacheClusterSize &value)

void	SetCacheClusterSize (CacheClusterSize &&value)

Stage &	WithCacheClusterSize (const CacheClusterSize &value)

Stage &	WithCacheClusterSize (CacheClusterSize &&value)

const CacheClusterStatus &	GetCacheClusterStatus () const

bool	CacheClusterStatusHasBeenSet () const

void	SetCacheClusterStatus (const CacheClusterStatus &value)

void	SetCacheClusterStatus (CacheClusterStatus &&value)

Stage &	WithCacheClusterStatus (const CacheClusterStatus &value)

Stage &	WithCacheClusterStatus (CacheClusterStatus &&value)

const Aws::Map< Aws::String, MethodSetting > &	GetMethodSettings () const

bool	MethodSettingsHasBeenSet () const

void	SetMethodSettings (const Aws::Map< Aws::String, MethodSetting > &value)

void	SetMethodSettings (Aws::Map< Aws::String, MethodSetting > &&value)

Stage &	WithMethodSettings (const Aws::Map< Aws::String, MethodSetting > &value)

Stage &	WithMethodSettings (Aws::Map< Aws::String, MethodSetting > &&value)

Stage &	AddMethodSettings (const Aws::String &key, const MethodSetting &value)

Stage &	AddMethodSettings (Aws::String &&key, const MethodSetting &value)

Stage &	AddMethodSettings (const Aws::String &key, MethodSetting &&value)

Stage &	AddMethodSettings (Aws::String &&key, MethodSetting &&value)

Stage &	AddMethodSettings (const char *key, MethodSetting &&value)

Stage &	AddMethodSettings (const char *key, const MethodSetting &value)

const Aws::Map< Aws::String, Aws::String > &	GetVariables () const

bool	VariablesHasBeenSet () const

void	SetVariables (const Aws::Map< Aws::String, Aws::String > &value)

void	SetVariables (Aws::Map< Aws::String, Aws::String > &&value)

Stage &	WithVariables (const Aws::Map< Aws::String, Aws::String > &value)

Stage &	WithVariables (Aws::Map< Aws::String, Aws::String > &&value)

Stage &	AddVariables (const Aws::String &key, const Aws::String &value)

Stage &	AddVariables (Aws::String &&key, const Aws::String &value)

Stage &	AddVariables (const Aws::String &key, Aws::String &&value)

Stage &	AddVariables (Aws::String &&key, Aws::String &&value)

Stage &	AddVariables (const char *key, Aws::String &&value)

Stage &	AddVariables (Aws::String &&key, const char *value)

Stage &	AddVariables (const char key, const char value)

const Aws::String &	GetDocumentationVersion () const

bool	DocumentationVersionHasBeenSet () const

void	SetDocumentationVersion (const Aws::String &value)

void	SetDocumentationVersion (Aws::String &&value)

void	SetDocumentationVersion (const char *value)

Stage &	WithDocumentationVersion (const Aws::String &value)

Stage &	WithDocumentationVersion (Aws::String &&value)

Stage &	WithDocumentationVersion (const char *value)

const AccessLogSettings &	GetAccessLogSettings () const

bool	AccessLogSettingsHasBeenSet () const

void	SetAccessLogSettings (const AccessLogSettings &value)

void	SetAccessLogSettings (AccessLogSettings &&value)

Stage &	WithAccessLogSettings (const AccessLogSettings &value)

Stage &	WithAccessLogSettings (AccessLogSettings &&value)

const CanarySettings &	GetCanarySettings () const

bool	CanarySettingsHasBeenSet () const

void	SetCanarySettings (const CanarySettings &value)

void	SetCanarySettings (CanarySettings &&value)

Stage &	WithCanarySettings (const CanarySettings &value)

Stage &	WithCanarySettings (CanarySettings &&value)

bool	GetTracingEnabled () const

bool	TracingEnabledHasBeenSet () const

void	SetTracingEnabled (bool value)

Stage &	WithTracingEnabled (bool value)

const Aws::String &	GetWebAclArn () const

bool	WebAclArnHasBeenSet () const

void	SetWebAclArn (const Aws::String &value)

void	SetWebAclArn (Aws::String &&value)

void	SetWebAclArn (const char *value)

Stage &	WithWebAclArn (const Aws::String &value)

Stage &	WithWebAclArn (Aws::String &&value)

Stage &	WithWebAclArn (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)

Stage &	WithTags (const Aws::Map< Aws::String, Aws::String > &value)

Stage &	WithTags (Aws::Map< Aws::String, Aws::String > &&value)

Stage &	AddTags (const Aws::String &key, const Aws::String &value)

Stage &	AddTags (Aws::String &&key, const Aws::String &value)

Stage &	AddTags (const Aws::String &key, Aws::String &&value)

Stage &	AddTags (Aws::String &&key, Aws::String &&value)

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

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

Stage &	AddTags (const char key, const char value)

const Aws::Utils::DateTime &	GetCreatedDate () const

bool	CreatedDateHasBeenSet () const

void	SetCreatedDate (const Aws::Utils::DateTime &value)

void	SetCreatedDate (Aws::Utils::DateTime &&value)

Stage &	WithCreatedDate (const Aws::Utils::DateTime &value)

Stage &	WithCreatedDate (Aws::Utils::DateTime &&value)

const Aws::Utils::DateTime &	GetLastUpdatedDate () const

bool	LastUpdatedDateHasBeenSet () const

void	SetLastUpdatedDate (const Aws::Utils::DateTime &value)

void	SetLastUpdatedDate (Aws::Utils::DateTime &&value)

Stage &	WithLastUpdatedDate (const Aws::Utils::DateTime &value)

Stage &	WithLastUpdatedDate (Aws::Utils::DateTime &&value)

Detailed Description

Represents a unique identifier for a version of a deployed RestApi that is callable by users.

Deploy an API

Constructor & Destructor Documentation

◆ Stage() [1/2]

Aws::APIGateway::Model::Stage::Stage ( )

◆ Stage() [2/2]

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

Member Function Documentation

◆ AccessLogSettingsHasBeenSet()

bool Aws::APIGateway::Model::Stage::AccessLogSettingsHasBeenSet ( ) const

inline

Settings for logging access in this stage.

Definition at line 559 of file Stage.h.

◆ AddMethodSettings() [1/6]

Stage& Aws::APIGateway::Model::Stage::AddMethodSettings	(	Aws::String &&	key,
		const MethodSetting &	value
	)

inline

A map that defines the method settings for a Stage resource. Keys (designated as /{method_setting_key below) are method paths defined as {resource_path}/{http_method} for an individual method override, or /* /* for overriding all methods in the stage.

Definition at line 383 of file Stage.h.

◆ AddMethodSettings() [2/6]

Stage& Aws::APIGateway::Model::Stage::AddMethodSettings	(	Aws::String &&	key,
		MethodSetting &&	value
	)

inline

A map that defines the method settings for a Stage resource. Keys (designated as /{method_setting_key below) are method paths defined as {resource_path}/{http_method} for an individual method override, or /* /* for overriding all methods in the stage.

Definition at line 399 of file Stage.h.

◆ AddMethodSettings() [3/6]

Stage& Aws::APIGateway::Model::Stage::AddMethodSettings	(	const Aws::String &	key,
		const MethodSetting &	value
	)

inline

A map that defines the method settings for a Stage resource. Keys (designated as /{method_setting_key below) are method paths defined as {resource_path}/{http_method} for an individual method override, or /* /* for overriding all methods in the stage.

Definition at line 375 of file Stage.h.

◆ AddMethodSettings() [4/6]

Stage& Aws::APIGateway::Model::Stage::AddMethodSettings	(	const Aws::String &	key,
		MethodSetting &&	value
	)

inline

A map that defines the method settings for a Stage resource. Keys (designated as /{method_setting_key below) are method paths defined as {resource_path}/{http_method} for an individual method override, or /* /* for overriding all methods in the stage.

Definition at line 391 of file Stage.h.

◆ AddMethodSettings() [5/6]

Stage& Aws::APIGateway::Model::Stage::AddMethodSettings	(	const char *	key,
		const MethodSetting &	value
	)

inline

A map that defines the method settings for a Stage resource. Keys (designated as /{method_setting_key below) are method paths defined as {resource_path}/{http_method} for an individual method override, or /* /* for overriding all methods in the stage.

Definition at line 415 of file Stage.h.

◆ AddMethodSettings() [6/6]

Stage& Aws::APIGateway::Model::Stage::AddMethodSettings	(	const char *	key,
		MethodSetting &&	value
	)

inline

A map that defines the method settings for a Stage resource. Keys (designated as /{method_setting_key below) are method paths defined as {resource_path}/{http_method} for an individual method override, or /* /* for overriding all methods in the stage.

Definition at line 407 of file Stage.h.

◆ AddTags() [1/7]

Stage& Aws::APIGateway::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 737 of file Stage.h.

◆ AddTags() [2/7]

Stage& Aws::APIGateway::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 725 of file Stage.h.

◆ AddTags() [3/7]

Stage& Aws::APIGateway::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 749 of file Stage.h.

◆ AddTags() [4/7]

Stage& Aws::APIGateway::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 731 of file Stage.h.

◆ AddTags() [5/7]

Stage& Aws::APIGateway::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 719 of file Stage.h.

◆ AddTags() [6/7]

Stage& Aws::APIGateway::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 743 of file Stage.h.

◆ AddTags() [7/7]

Stage& Aws::APIGateway::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 755 of file Stage.h.

◆ AddVariables() [1/7]

Stage& Aws::APIGateway::Model::Stage::AddVariables	(	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 486 of file Stage.h.

◆ AddVariables() [2/7]

Stage& Aws::APIGateway::Model::Stage::AddVariables	(	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 472 of file Stage.h.

◆ AddVariables() [3/7]

Stage& Aws::APIGateway::Model::Stage::AddVariables	(	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 500 of file Stage.h.

◆ AddVariables() [4/7]

Stage& Aws::APIGateway::Model::Stage::AddVariables	(	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 479 of file Stage.h.

◆ AddVariables() [5/7]

Stage& Aws::APIGateway::Model::Stage::AddVariables	(	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 465 of file Stage.h.

◆ AddVariables() [6/7]

Stage& Aws::APIGateway::Model::Stage::AddVariables	(	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 493 of file Stage.h.

◆ AddVariables() [7/7]

Stage& Aws::APIGateway::Model::Stage::AddVariables	(	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 507 of file Stage.h.

◆ CacheClusterEnabledHasBeenSet()

bool Aws::APIGateway::Model::Stage::CacheClusterEnabledHasBeenSet ( ) const

inline

Specifies whether a cache cluster is enabled for the stage.

Definition at line 246 of file Stage.h.

◆ CacheClusterSizeHasBeenSet()

bool Aws::APIGateway::Model::Stage::CacheClusterSizeHasBeenSet ( ) const

inline

The size of the cache cluster for the stage, if enabled.

Definition at line 267 of file Stage.h.

◆ CacheClusterStatusHasBeenSet()

bool Aws::APIGateway::Model::Stage::CacheClusterStatusHasBeenSet ( ) const

inline

The status of the cache cluster for the stage, if enabled.

Definition at line 298 of file Stage.h.

◆ CanarySettingsHasBeenSet()

bool Aws::APIGateway::Model::Stage::CanarySettingsHasBeenSet ( ) const

inline

Settings for the canary deployment in this stage.

Definition at line 590 of file Stage.h.

◆ ClientCertificateIdHasBeenSet()

bool Aws::APIGateway::Model::Stage::ClientCertificateIdHasBeenSet ( ) const

inline

The identifier of a client certificate for an API stage.

Definition at line 99 of file Stage.h.

◆ CreatedDateHasBeenSet()

bool Aws::APIGateway::Model::Stage::CreatedDateHasBeenSet ( ) const

inline

The timestamp when the stage was created.

Definition at line 766 of file Stage.h.

◆ DeploymentIdHasBeenSet()

bool Aws::APIGateway::Model::Stage::DeploymentIdHasBeenSet ( ) const

inline

The identifier of the Deployment that the stage points to.

Definition at line 58 of file Stage.h.

◆ DescriptionHasBeenSet()

bool Aws::APIGateway::Model::Stage::DescriptionHasBeenSet ( ) const

inline

The stage's description.

Definition at line 205 of file Stage.h.

◆ DocumentationVersionHasBeenSet()

bool Aws::APIGateway::Model::Stage::DocumentationVersionHasBeenSet ( ) const

inline

The version of the associated API documentation.

Definition at line 518 of file Stage.h.

◆ GetAccessLogSettings()

const AccessLogSettings& Aws::APIGateway::Model::Stage::GetAccessLogSettings ( ) const

inline

Settings for logging access in this stage.

Definition at line 554 of file Stage.h.

◆ GetCacheClusterEnabled()

bool Aws::APIGateway::Model::Stage::GetCacheClusterEnabled ( ) const

inline

Specifies whether a cache cluster is enabled for the stage.

Definition at line 241 of file Stage.h.

◆ GetCacheClusterSize()

const CacheClusterSize& Aws::APIGateway::Model::Stage::GetCacheClusterSize ( ) const

inline

The size of the cache cluster for the stage, if enabled.

Definition at line 262 of file Stage.h.

◆ GetCacheClusterStatus()

const CacheClusterStatus& Aws::APIGateway::Model::Stage::GetCacheClusterStatus ( ) const

inline

The status of the cache cluster for the stage, if enabled.

Definition at line 293 of file Stage.h.

◆ GetCanarySettings()

const CanarySettings& Aws::APIGateway::Model::Stage::GetCanarySettings ( ) const

inline

Settings for the canary deployment in this stage.

Definition at line 585 of file Stage.h.

◆ GetClientCertificateId()

const Aws::String& Aws::APIGateway::Model::Stage::GetClientCertificateId ( ) const

inline

The identifier of a client certificate for an API stage.

Definition at line 94 of file Stage.h.

◆ GetCreatedDate()

const Aws::Utils::DateTime& Aws::APIGateway::Model::Stage::GetCreatedDate ( ) const

inline

The timestamp when the stage was created.

Definition at line 761 of file Stage.h.

◆ GetDeploymentId()

const Aws::String& Aws::APIGateway::Model::Stage::GetDeploymentId ( ) const

inline

The identifier of the Deployment that the stage points to.

Definition at line 53 of file Stage.h.

◆ GetDescription()

const Aws::String& Aws::APIGateway::Model::Stage::GetDescription ( ) const

inline

The stage's description.

Definition at line 200 of file Stage.h.

◆ GetDocumentationVersion()

const Aws::String& Aws::APIGateway::Model::Stage::GetDocumentationVersion ( ) const

inline

The version of the associated API documentation.

Definition at line 513 of file Stage.h.

◆ GetLastUpdatedDate()

const Aws::Utils::DateTime& Aws::APIGateway::Model::Stage::GetLastUpdatedDate ( ) const

inline

The timestamp when the stage last updated.

Definition at line 792 of file Stage.h.

◆ GetMethodSettings()

const Aws::Map<Aws::String, MethodSetting>& Aws::APIGateway::Model::Stage::GetMethodSettings ( ) const

inline

A map that defines the method settings for a Stage resource. Keys (designated as /{method_setting_key below) are method paths defined as {resource_path}/{http_method} for an individual method override, or /* /* for overriding all methods in the stage.

Definition at line 327 of file Stage.h.

◆ GetStageName()

const Aws::String& Aws::APIGateway::Model::Stage::GetStageName ( ) const

inline

The name of the stage is the first path segment in the Uniform Resource Identifier (URI) of a call to API Gateway. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.

Definition at line 138 of file Stage.h.

◆ GetTags()

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

inline

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

Definition at line 683 of file Stage.h.

◆ GetTracingEnabled()

bool Aws::APIGateway::Model::Stage::GetTracingEnabled ( ) const

inline

Specifies whether active tracing with X-ray is enabled for the Stage.

Definition at line 617 of file Stage.h.

◆ GetVariables()

const Aws::Map<Aws::String, Aws::String>& Aws::APIGateway::Model::Stage::GetVariables ( ) 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 423 of file Stage.h.

◆ GetWebAclArn()

const Aws::String& Aws::APIGateway::Model::Stage::GetWebAclArn ( ) const

inline

The ARN of the WebAcl associated with the Stage.

Definition at line 641 of file Stage.h.

◆ Jsonize()

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

◆ LastUpdatedDateHasBeenSet()

bool Aws::APIGateway::Model::Stage::LastUpdatedDateHasBeenSet ( ) const

inline

The timestamp when the stage last updated.

Definition at line 797 of file Stage.h.

◆ MethodSettingsHasBeenSet()

bool Aws::APIGateway::Model::Stage::MethodSettingsHasBeenSet ( ) const

inline

A map that defines the method settings for a Stage resource. Keys (designated as /{method_setting_key below) are method paths defined as {resource_path}/{http_method} for an individual method override, or /* /* for overriding all methods in the stage.

Definition at line 335 of file Stage.h.

◆ operator=()

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

◆ SetAccessLogSettings() [1/2]

void Aws::APIGateway::Model::Stage::SetAccessLogSettings ( AccessLogSettings && value )

inline

Settings for logging access in this stage.

Definition at line 569 of file Stage.h.

◆ SetAccessLogSettings() [2/2]

void Aws::APIGateway::Model::Stage::SetAccessLogSettings ( const AccessLogSettings & value )

inline

Settings for logging access in this stage.

Definition at line 564 of file Stage.h.

◆ SetCacheClusterEnabled()

void Aws::APIGateway::Model::Stage::SetCacheClusterEnabled ( bool value )

inline

Specifies whether a cache cluster is enabled for the stage.

Definition at line 251 of file Stage.h.

◆ SetCacheClusterSize() [1/2]

void Aws::APIGateway::Model::Stage::SetCacheClusterSize ( CacheClusterSize && value )

inline

The size of the cache cluster for the stage, if enabled.

Definition at line 277 of file Stage.h.

◆ SetCacheClusterSize() [2/2]

void Aws::APIGateway::Model::Stage::SetCacheClusterSize ( const CacheClusterSize & value )

inline

The size of the cache cluster for the stage, if enabled.

Definition at line 272 of file Stage.h.

◆ SetCacheClusterStatus() [1/2]

void Aws::APIGateway::Model::Stage::SetCacheClusterStatus ( CacheClusterStatus && value )

inline

The status of the cache cluster for the stage, if enabled.

Definition at line 308 of file Stage.h.

◆ SetCacheClusterStatus() [2/2]

void Aws::APIGateway::Model::Stage::SetCacheClusterStatus ( const CacheClusterStatus & value )

inline

The status of the cache cluster for the stage, if enabled.

Definition at line 303 of file Stage.h.

◆ SetCanarySettings() [1/2]

void Aws::APIGateway::Model::Stage::SetCanarySettings ( CanarySettings && value )

inline

Settings for the canary deployment in this stage.

Definition at line 600 of file Stage.h.

◆ SetCanarySettings() [2/2]

void Aws::APIGateway::Model::Stage::SetCanarySettings ( const CanarySettings & value )

inline

Settings for the canary deployment in this stage.

Definition at line 595 of file Stage.h.

◆ SetClientCertificateId() [1/3]

void Aws::APIGateway::Model::Stage::SetClientCertificateId ( Aws::String && value )

inline

The identifier of a client certificate for an API stage.

Definition at line 109 of file Stage.h.

◆ SetClientCertificateId() [2/3]

void Aws::APIGateway::Model::Stage::SetClientCertificateId ( const Aws::String & value )

inline

The identifier of a client certificate for an API stage.

Definition at line 104 of file Stage.h.

◆ SetClientCertificateId() [3/3]

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

inline

The identifier of a client certificate for an API stage.

Definition at line 114 of file Stage.h.

◆ SetCreatedDate() [1/2]

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

inline

The timestamp when the stage was created.

Definition at line 776 of file Stage.h.

◆ SetCreatedDate() [2/2]

void Aws::APIGateway::Model::Stage::SetCreatedDate ( const Aws::Utils::DateTime & value )

inline

The timestamp when the stage was created.

Definition at line 771 of file Stage.h.

◆ SetDeploymentId() [1/3]

void Aws::APIGateway::Model::Stage::SetDeploymentId ( Aws::String && value )

inline

The identifier of the Deployment that the stage points to.

Definition at line 68 of file Stage.h.

◆ SetDeploymentId() [2/3]

void Aws::APIGateway::Model::Stage::SetDeploymentId ( const Aws::String & value )

inline

The identifier of the Deployment that the stage points to.

Definition at line 63 of file Stage.h.

◆ SetDeploymentId() [3/3]

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

inline

The identifier of the Deployment that the stage points to.

Definition at line 73 of file Stage.h.

◆ SetDescription() [1/3]

void Aws::APIGateway::Model::Stage::SetDescription ( Aws::String && value )

inline

The stage's description.

Definition at line 215 of file Stage.h.

◆ SetDescription() [2/3]

void Aws::APIGateway::Model::Stage::SetDescription ( const Aws::String & value )

inline

The stage's description.

Definition at line 210 of file Stage.h.

◆ SetDescription() [3/3]

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

inline

The stage's description.

Definition at line 220 of file Stage.h.

◆ SetDocumentationVersion() [1/3]

void Aws::APIGateway::Model::Stage::SetDocumentationVersion ( Aws::String && value )

inline

The version of the associated API documentation.

Definition at line 528 of file Stage.h.

◆ SetDocumentationVersion() [2/3]

void Aws::APIGateway::Model::Stage::SetDocumentationVersion ( const Aws::String & value )

inline

The version of the associated API documentation.

Definition at line 523 of file Stage.h.

◆ SetDocumentationVersion() [3/3]

void Aws::APIGateway::Model::Stage::SetDocumentationVersion ( const char * value )

inline

The version of the associated API documentation.

Definition at line 533 of file Stage.h.

◆ SetLastUpdatedDate() [1/2]

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

inline

The timestamp when the stage last updated.

Definition at line 807 of file Stage.h.

◆ SetLastUpdatedDate() [2/2]

void Aws::APIGateway::Model::Stage::SetLastUpdatedDate ( const Aws::Utils::DateTime & value )

inline

The timestamp when the stage last updated.

Definition at line 802 of file Stage.h.

◆ SetMethodSettings() [1/2]

void Aws::APIGateway::Model::Stage::SetMethodSettings ( Aws::Map< Aws::String, MethodSetting > && value )

inline

A map that defines the method settings for a Stage resource. Keys (designated as /{method_setting_key below) are method paths defined as {resource_path}/{http_method} for an individual method override, or /* /* for overriding all methods in the stage.

Definition at line 351 of file Stage.h.

◆ SetMethodSettings() [2/2]

void Aws::APIGateway::Model::Stage::SetMethodSettings ( const Aws::Map< Aws::String, MethodSetting > & value )

inline

A map that defines the method settings for a Stage resource. Keys (designated as /{method_setting_key below) are method paths defined as {resource_path}/{http_method} for an individual method override, or /* /* for overriding all methods in the stage.

Definition at line 343 of file Stage.h.

◆ SetStageName() [1/3]

void Aws::APIGateway::Model::Stage::SetStageName ( Aws::String && value )

inline

The name of the stage is the first path segment in the Uniform Resource Identifier (URI) of a call to API Gateway. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.

Definition at line 162 of file Stage.h.

◆ SetStageName() [2/3]

void Aws::APIGateway::Model::Stage::SetStageName ( const Aws::String & value )

inline

The name of the stage is the first path segment in the Uniform Resource Identifier (URI) of a call to API Gateway. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.

Definition at line 154 of file Stage.h.

◆ SetStageName() [3/3]

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

inline

The name of the stage is the first path segment in the Uniform Resource Identifier (URI) of a call to API Gateway. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.

Definition at line 170 of file Stage.h.

◆ SetTags() [1/2]

void Aws::APIGateway::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 701 of file Stage.h.

◆ SetTags() [2/2]

void Aws::APIGateway::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 695 of file Stage.h.

◆ SetTracingEnabled()

void Aws::APIGateway::Model::Stage::SetTracingEnabled ( bool value )

inline

Specifies whether active tracing with X-ray is enabled for the Stage.

Definition at line 629 of file Stage.h.

◆ SetVariables() [1/2]

void Aws::APIGateway::Model::Stage::SetVariables ( 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 444 of file Stage.h.

◆ SetVariables() [2/2]

void Aws::APIGateway::Model::Stage::SetVariables ( 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 437 of file Stage.h.

◆ SetWebAclArn() [1/3]

void Aws::APIGateway::Model::Stage::SetWebAclArn ( Aws::String && value )

inline

The ARN of the WebAcl associated with the Stage.

Definition at line 656 of file Stage.h.

◆ SetWebAclArn() [2/3]

void Aws::APIGateway::Model::Stage::SetWebAclArn ( const Aws::String & value )

inline

The ARN of the WebAcl associated with the Stage.

Definition at line 651 of file Stage.h.

◆ SetWebAclArn() [3/3]

void Aws::APIGateway::Model::Stage::SetWebAclArn ( const char * value )

inline

The ARN of the WebAcl associated with the Stage.

Definition at line 661 of file Stage.h.

◆ StageNameHasBeenSet()

bool Aws::APIGateway::Model::Stage::StageNameHasBeenSet ( ) const

inline

The name of the stage is the first path segment in the Uniform Resource Identifier (URI) of a call to API Gateway. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.

Definition at line 146 of file Stage.h.

◆ TagsHasBeenSet()

bool Aws::APIGateway::Model::Stage::TagsHasBeenSet ( ) const

inline

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

Definition at line 689 of file Stage.h.

◆ TracingEnabledHasBeenSet()

bool Aws::APIGateway::Model::Stage::TracingEnabledHasBeenSet ( ) const

inline

Specifies whether active tracing with X-ray is enabled for the Stage.

Definition at line 623 of file Stage.h.

◆ VariablesHasBeenSet()

bool Aws::APIGateway::Model::Stage::VariablesHasBeenSet ( ) 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 430 of file Stage.h.

◆ WebAclArnHasBeenSet()

bool Aws::APIGateway::Model::Stage::WebAclArnHasBeenSet ( ) const

inline

The ARN of the WebAcl associated with the Stage.

Definition at line 646 of file Stage.h.

◆ WithAccessLogSettings() [1/2]

Stage& Aws::APIGateway::Model::Stage::WithAccessLogSettings ( AccessLogSettings && value )

inline

Settings for logging access in this stage.

Definition at line 579 of file Stage.h.

◆ WithAccessLogSettings() [2/2]

Stage& Aws::APIGateway::Model::Stage::WithAccessLogSettings ( const AccessLogSettings & value )

inline

Settings for logging access in this stage.

Definition at line 574 of file Stage.h.

◆ WithCacheClusterEnabled()

Stage& Aws::APIGateway::Model::Stage::WithCacheClusterEnabled ( bool value )

inline

Specifies whether a cache cluster is enabled for the stage.

Definition at line 256 of file Stage.h.

◆ WithCacheClusterSize() [1/2]

Stage& Aws::APIGateway::Model::Stage::WithCacheClusterSize ( CacheClusterSize && value )

inline

The size of the cache cluster for the stage, if enabled.

Definition at line 287 of file Stage.h.

◆ WithCacheClusterSize() [2/2]

Stage& Aws::APIGateway::Model::Stage::WithCacheClusterSize ( const CacheClusterSize & value )

inline

The size of the cache cluster for the stage, if enabled.

Definition at line 282 of file Stage.h.

◆ WithCacheClusterStatus() [1/2]

Stage& Aws::APIGateway::Model::Stage::WithCacheClusterStatus ( CacheClusterStatus && value )

inline

The status of the cache cluster for the stage, if enabled.

Definition at line 318 of file Stage.h.

◆ WithCacheClusterStatus() [2/2]

Stage& Aws::APIGateway::Model::Stage::WithCacheClusterStatus ( const CacheClusterStatus & value )

inline

The status of the cache cluster for the stage, if enabled.

Definition at line 313 of file Stage.h.

◆ WithCanarySettings() [1/2]

Stage& Aws::APIGateway::Model::Stage::WithCanarySettings ( CanarySettings && value )

inline

Settings for the canary deployment in this stage.

Definition at line 610 of file Stage.h.

◆ WithCanarySettings() [2/2]

Stage& Aws::APIGateway::Model::Stage::WithCanarySettings ( const CanarySettings & value )

inline

Settings for the canary deployment in this stage.

Definition at line 605 of file Stage.h.

◆ WithClientCertificateId() [1/3]

Stage& Aws::APIGateway::Model::Stage::WithClientCertificateId ( Aws::String && value )

inline

The identifier of a client certificate for an API stage.

Definition at line 124 of file Stage.h.

◆ WithClientCertificateId() [2/3]

Stage& Aws::APIGateway::Model::Stage::WithClientCertificateId ( const Aws::String & value )

inline

The identifier of a client certificate for an API stage.

Definition at line 119 of file Stage.h.

◆ WithClientCertificateId() [3/3]

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

inline

The identifier of a client certificate for an API stage.

Definition at line 129 of file Stage.h.

◆ WithCreatedDate() [1/2]

Stage& Aws::APIGateway::Model::Stage::WithCreatedDate ( Aws::Utils::DateTime && value )

inline

The timestamp when the stage was created.

Definition at line 786 of file Stage.h.

◆ WithCreatedDate() [2/2]

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

inline

The timestamp when the stage was created.

Definition at line 781 of file Stage.h.

◆ WithDeploymentId() [1/3]

Stage& Aws::APIGateway::Model::Stage::WithDeploymentId ( Aws::String && value )

inline

The identifier of the Deployment that the stage points to.

Definition at line 83 of file Stage.h.

◆ WithDeploymentId() [2/3]

Stage& Aws::APIGateway::Model::Stage::WithDeploymentId ( const Aws::String & value )

inline

The identifier of the Deployment that the stage points to.

Definition at line 78 of file Stage.h.

◆ WithDeploymentId() [3/3]

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

inline

The identifier of the Deployment that the stage points to.

Definition at line 88 of file Stage.h.

◆ WithDescription() [1/3]

Stage& Aws::APIGateway::Model::Stage::WithDescription ( Aws::String && value )

inline

The stage's description.

Definition at line 230 of file Stage.h.

◆ WithDescription() [2/3]

Stage& Aws::APIGateway::Model::Stage::WithDescription ( const Aws::String & value )

inline

The stage's description.

Definition at line 225 of file Stage.h.

◆ WithDescription() [3/3]

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

inline

The stage's description.

Definition at line 235 of file Stage.h.

◆ WithDocumentationVersion() [1/3]

Stage& Aws::APIGateway::Model::Stage::WithDocumentationVersion ( Aws::String && value )

inline

The version of the associated API documentation.

Definition at line 543 of file Stage.h.

◆ WithDocumentationVersion() [2/3]

Stage& Aws::APIGateway::Model::Stage::WithDocumentationVersion ( const Aws::String & value )

inline

The version of the associated API documentation.

Definition at line 538 of file Stage.h.

◆ WithDocumentationVersion() [3/3]

Stage& Aws::APIGateway::Model::Stage::WithDocumentationVersion ( const char * value )

inline

The version of the associated API documentation.

Definition at line 548 of file Stage.h.

◆ WithLastUpdatedDate() [1/2]

Stage& Aws::APIGateway::Model::Stage::WithLastUpdatedDate ( Aws::Utils::DateTime && value )

inline

The timestamp when the stage last updated.

Definition at line 817 of file Stage.h.

◆ WithLastUpdatedDate() [2/2]

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

inline

The timestamp when the stage last updated.

Definition at line 812 of file Stage.h.

◆ WithMethodSettings() [1/2]

Stage& Aws::APIGateway::Model::Stage::WithMethodSettings ( Aws::Map< Aws::String, MethodSetting > && value )

inline

A map that defines the method settings for a Stage resource. Keys (designated as /{method_setting_key below) are method paths defined as {resource_path}/{http_method} for an individual method override, or /* /* for overriding all methods in the stage.

Definition at line 367 of file Stage.h.

◆ WithMethodSettings() [2/2]

Stage& Aws::APIGateway::Model::Stage::WithMethodSettings ( const Aws::Map< Aws::String, MethodSetting > & value )

inline

A map that defines the method settings for a Stage resource. Keys (designated as /{method_setting_key below) are method paths defined as {resource_path}/{http_method} for an individual method override, or /* /* for overriding all methods in the stage.

Definition at line 359 of file Stage.h.

◆ WithStageName() [1/3]

Stage& Aws::APIGateway::Model::Stage::WithStageName ( Aws::String && value )

inline

The name of the stage is the first path segment in the Uniform Resource Identifier (URI) of a call to API Gateway. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.

Definition at line 186 of file Stage.h.

◆ WithStageName() [2/3]

Stage& Aws::APIGateway::Model::Stage::WithStageName ( const Aws::String & value )

inline

The name of the stage is the first path segment in the Uniform Resource Identifier (URI) of a call to API Gateway. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.

Definition at line 178 of file Stage.h.

◆ WithStageName() [3/3]

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

inline

The name of the stage is the first path segment in the Uniform Resource Identifier (URI) of a call to API Gateway. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.

Definition at line 194 of file Stage.h.

◆ WithTags() [1/2]

Stage& Aws::APIGateway::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 713 of file Stage.h.

◆ WithTags() [2/2]

Stage& Aws::APIGateway::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 707 of file Stage.h.

◆ WithTracingEnabled()

Stage& Aws::APIGateway::Model::Stage::WithTracingEnabled ( bool value )

inline

Specifies whether active tracing with X-ray is enabled for the Stage.

Definition at line 635 of file Stage.h.

◆ WithVariables() [1/2]

Stage& Aws::APIGateway::Model::Stage::WithVariables ( 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 458 of file Stage.h.

◆ WithVariables() [2/2]

Stage& Aws::APIGateway::Model::Stage::WithVariables ( 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 451 of file Stage.h.

◆ WithWebAclArn() [1/3]

Stage& Aws::APIGateway::Model::Stage::WithWebAclArn ( Aws::String && value )

inline

The ARN of the WebAcl associated with the Stage.

Definition at line 671 of file Stage.h.

◆ WithWebAclArn() [2/3]

Stage& Aws::APIGateway::Model::Stage::WithWebAclArn ( const Aws::String & value )

inline

The ARN of the WebAcl associated with the Stage.

Definition at line 666 of file Stage.h.

◆ WithWebAclArn() [3/3]

Stage& Aws::APIGateway::Model::Stage::WithWebAclArn ( const char * value )

inline

The ARN of the WebAcl associated with the Stage.

Definition at line 676 of file Stage.h.

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

aws-cpp-sdk-apigateway/include/aws/apigateway/model/Stage.h

Public Member Functions

Detailed Description

See Also:

Constructor & Destructor Documentation

◆ Stage() [1/2]

◆ Stage() [2/2]

Member Function Documentation

◆ AccessLogSettingsHasBeenSet()

◆ AddMethodSettings() [1/6]

◆ AddMethodSettings() [2/6]

◆ AddMethodSettings() [3/6]

◆ AddMethodSettings() [4/6]

◆ AddMethodSettings() [5/6]

◆ AddMethodSettings() [6/6]

◆ AddTags() [1/7]

◆ AddTags() [2/7]

◆ AddTags() [3/7]

◆ AddTags() [4/7]

◆ AddTags() [5/7]

◆ AddTags() [6/7]

◆ AddTags() [7/7]

◆ AddVariables() [1/7]

◆ AddVariables() [2/7]

◆ AddVariables() [3/7]

◆ AddVariables() [4/7]

◆ AddVariables() [5/7]

◆ AddVariables() [6/7]

◆ AddVariables() [7/7]

◆ CacheClusterEnabledHasBeenSet()

◆ CacheClusterSizeHasBeenSet()

◆ CacheClusterStatusHasBeenSet()

◆ CanarySettingsHasBeenSet()

◆ ClientCertificateIdHasBeenSet()

◆ CreatedDateHasBeenSet()

◆ DeploymentIdHasBeenSet()

◆ DescriptionHasBeenSet()

◆ DocumentationVersionHasBeenSet()

◆ GetAccessLogSettings()

◆ GetCacheClusterEnabled()

◆ GetCacheClusterSize()

◆ GetCacheClusterStatus()

◆ GetCanarySettings()

◆ GetClientCertificateId()

◆ GetCreatedDate()

◆ GetDeploymentId()

◆ GetDescription()

◆ GetDocumentationVersion()

◆ GetLastUpdatedDate()

◆ GetMethodSettings()

◆ GetStageName()

◆ GetTags()

◆ GetTracingEnabled()

◆ GetVariables()

◆ GetWebAclArn()

◆ Jsonize()

◆ LastUpdatedDateHasBeenSet()

◆ MethodSettingsHasBeenSet()

◆ operator=()

◆ SetAccessLogSettings() [1/2]

◆ SetAccessLogSettings() [2/2]

◆ SetCacheClusterEnabled()

◆ SetCacheClusterSize() [1/2]

◆ SetCacheClusterSize() [2/2]

◆ SetCacheClusterStatus() [1/2]

◆ SetCacheClusterStatus() [2/2]

◆ SetCanarySettings() [1/2]

◆ SetCanarySettings() [2/2]

◆ SetClientCertificateId() [1/3]

◆ SetClientCertificateId() [2/3]

◆ SetClientCertificateId() [3/3]

◆ SetCreatedDate() [1/2]

◆ SetCreatedDate() [2/2]

◆ SetDeploymentId() [1/3]

◆ SetDeploymentId() [2/3]

◆ SetDeploymentId() [3/3]

◆ SetDescription() [1/3]

◆ SetDescription() [2/3]

◆ SetDescription() [3/3]

◆ SetDocumentationVersion() [1/3]

◆ SetDocumentationVersion() [2/3]