#include <RestApi.h>

Public Member Functions
	RestApi ()

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

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

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

const Aws::String &	GetId () const

bool	IdHasBeenSet () const

void	SetId (const Aws::String &value)

void	SetId (Aws::String &&value)

void	SetId (const char *value)

RestApi &	WithId (const Aws::String &value)

RestApi &	WithId (Aws::String &&value)

RestApi &	WithId (const char *value)

const Aws::String &	GetName () const

bool	NameHasBeenSet () const

void	SetName (const Aws::String &value)

void	SetName (Aws::String &&value)

void	SetName (const char *value)

RestApi &	WithName (const Aws::String &value)

RestApi &	WithName (Aws::String &&value)

RestApi &	WithName (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)

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

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

RestApi &	WithDescription (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)

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

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

const Aws::String &	GetVersion () const

bool	VersionHasBeenSet () const

void	SetVersion (const Aws::String &value)

void	SetVersion (Aws::String &&value)

void	SetVersion (const char *value)

RestApi &	WithVersion (const Aws::String &value)

RestApi &	WithVersion (Aws::String &&value)

RestApi &	WithVersion (const char *value)

const Aws::Vector< Aws::String > &	GetWarnings () const

bool	WarningsHasBeenSet () const

void	SetWarnings (const Aws::Vector< Aws::String > &value)

void	SetWarnings (Aws::Vector< Aws::String > &&value)

RestApi &	WithWarnings (const Aws::Vector< Aws::String > &value)

RestApi &	WithWarnings (Aws::Vector< Aws::String > &&value)

RestApi &	AddWarnings (const Aws::String &value)

RestApi &	AddWarnings (Aws::String &&value)

RestApi &	AddWarnings (const char *value)

const Aws::Vector< Aws::String > &	GetBinaryMediaTypes () const

bool	BinaryMediaTypesHasBeenSet () const

void	SetBinaryMediaTypes (const Aws::Vector< Aws::String > &value)

void	SetBinaryMediaTypes (Aws::Vector< Aws::String > &&value)

RestApi &	WithBinaryMediaTypes (const Aws::Vector< Aws::String > &value)

RestApi &	WithBinaryMediaTypes (Aws::Vector< Aws::String > &&value)

RestApi &	AddBinaryMediaTypes (const Aws::String &value)

RestApi &	AddBinaryMediaTypes (Aws::String &&value)

RestApi &	AddBinaryMediaTypes (const char *value)

int	GetMinimumCompressionSize () const

bool	MinimumCompressionSizeHasBeenSet () const

void	SetMinimumCompressionSize (int value)

RestApi &	WithMinimumCompressionSize (int value)

const ApiKeySourceType &	GetApiKeySource () const

bool	ApiKeySourceHasBeenSet () const

void	SetApiKeySource (const ApiKeySourceType &value)

void	SetApiKeySource (ApiKeySourceType &&value)

RestApi &	WithApiKeySource (const ApiKeySourceType &value)

RestApi &	WithApiKeySource (ApiKeySourceType &&value)

const EndpointConfiguration &	GetEndpointConfiguration () const

bool	EndpointConfigurationHasBeenSet () const

void	SetEndpointConfiguration (const EndpointConfiguration &value)

void	SetEndpointConfiguration (EndpointConfiguration &&value)

RestApi &	WithEndpointConfiguration (const EndpointConfiguration &value)

RestApi &	WithEndpointConfiguration (EndpointConfiguration &&value)

const Aws::String &	GetPolicy () const

bool	PolicyHasBeenSet () const

void	SetPolicy (const Aws::String &value)

void	SetPolicy (Aws::String &&value)

void	SetPolicy (const char *value)

RestApi &	WithPolicy (const Aws::String &value)

RestApi &	WithPolicy (Aws::String &&value)

RestApi &	WithPolicy (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)

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

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

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

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

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

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

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

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

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

bool	GetDisableExecuteApiEndpoint () const

bool	DisableExecuteApiEndpointHasBeenSet () const

void	SetDisableExecuteApiEndpoint (bool value)

RestApi &	WithDisableExecuteApiEndpoint (bool value)

Detailed Description

Represents a REST API.

Create an API

Constructor & Destructor Documentation

◆ RestApi() [1/2]

Aws::APIGateway::Model::RestApi::RestApi ( )

◆ RestApi() [2/2]

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

Member Function Documentation

◆ AddBinaryMediaTypes() [1/3]

RestApi& Aws::APIGateway::Model::RestApi::AddBinaryMediaTypes ( Aws::String && value )

inline

The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads.

Definition at line 351 of file RestApi.h.

◆ AddBinaryMediaTypes() [2/3]

RestApi& Aws::APIGateway::Model::RestApi::AddBinaryMediaTypes ( const Aws::String & value )

inline

The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads.

Definition at line 345 of file RestApi.h.

◆ AddBinaryMediaTypes() [3/3]

RestApi& Aws::APIGateway::Model::RestApi::AddBinaryMediaTypes ( const char * value )

inline

The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads.

Definition at line 357 of file RestApi.h.

◆ AddTags() [1/7]

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

inline

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

Definition at line 596 of file RestApi.h.

◆ AddTags() [2/7]

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

◆ AddTags() [3/7]

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

inline

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

Definition at line 608 of file RestApi.h.

◆ AddTags() [4/7]

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

◆ AddTags() [5/7]

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

◆ AddTags() [6/7]

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

inline

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

Definition at line 602 of file RestApi.h.

◆ AddTags() [7/7]

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

inline

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

Definition at line 614 of file RestApi.h.

◆ AddWarnings() [1/3]

RestApi& Aws::APIGateway::Model::RestApi::AddWarnings ( Aws::String && value )

inline

The warning messages reported when failonwarnings is turned on during API import.

Definition at line 296 of file RestApi.h.

◆ AddWarnings() [2/3]

RestApi& Aws::APIGateway::Model::RestApi::AddWarnings ( const Aws::String & value )

inline

The warning messages reported when failonwarnings is turned on during API import.

Definition at line 290 of file RestApi.h.

◆ AddWarnings() [3/3]

RestApi& Aws::APIGateway::Model::RestApi::AddWarnings ( const char * value )

inline

The warning messages reported when failonwarnings is turned on during API import.

Definition at line 302 of file RestApi.h.

◆ ApiKeySourceHasBeenSet()

bool Aws::APIGateway::Model::RestApi::ApiKeySourceHasBeenSet ( ) const

inline

The source of the API key for metering requests according to a usage plan. Valid values are:

HEADER to read the API key from the X-API-Key header of a request.
AUTHORIZER to read the API key from the UsageIdentifierKey from a custom authorizer.

Definition at line 413 of file RestApi.h.

◆ BinaryMediaTypesHasBeenSet()

bool Aws::APIGateway::Model::RestApi::BinaryMediaTypesHasBeenSet ( ) const

inline

The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads.

Definition at line 315 of file RestApi.h.

◆ CreatedDateHasBeenSet()

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

inline

The timestamp when the API was created.

Definition at line 186 of file RestApi.h.

◆ DescriptionHasBeenSet()

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

inline

The API's description.

Definition at line 145 of file RestApi.h.

◆ DisableExecuteApiEndpointHasBeenSet()

bool Aws::APIGateway::Model::RestApi::DisableExecuteApiEndpointHasBeenSet ( ) const

inline

Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.

Definition at line 633 of file RestApi.h.

◆ EndpointConfigurationHasBeenSet()

bool Aws::APIGateway::Model::RestApi::EndpointConfigurationHasBeenSet ( ) const

inline

The endpoint configuration of this RestApi showing the endpoint types of the API.

Definition at line 462 of file RestApi.h.

◆ GetApiKeySource()

const ApiKeySourceType& Aws::APIGateway::Model::RestApi::GetApiKeySource ( ) const

inline

The source of the API key for metering requests according to a usage plan. Valid values are:

HEADER to read the API key from the X-API-Key header of a request.
AUTHORIZER to read the API key from the UsageIdentifierKey from a custom authorizer.

Definition at line 404 of file RestApi.h.

◆ GetBinaryMediaTypes()

const Aws::Vector<Aws::String>& Aws::APIGateway::Model::RestApi::GetBinaryMediaTypes ( ) const

inline

The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads.

Definition at line 309 of file RestApi.h.

◆ GetCreatedDate()

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

inline

The timestamp when the API was created.

Definition at line 181 of file RestApi.h.

◆ GetDescription()

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

inline

The API's description.

Definition at line 140 of file RestApi.h.

◆ GetDisableExecuteApiEndpoint()

bool Aws::APIGateway::Model::RestApi::GetDisableExecuteApiEndpoint ( ) const

inline

Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.

Definition at line 624 of file RestApi.h.

◆ GetEndpointConfiguration()

const EndpointConfiguration& Aws::APIGateway::Model::RestApi::GetEndpointConfiguration ( ) const

inline

The endpoint configuration of this RestApi showing the endpoint types of the API.

Definition at line 456 of file RestApi.h.

◆ GetId()

const Aws::String& Aws::APIGateway::Model::RestApi::GetId ( ) const

inline

The API's identifier. This identifier is unique across all of your APIs in API Gateway.

Definition at line 51 of file RestApi.h.

◆ GetMinimumCompressionSize()

int Aws::APIGateway::Model::RestApi::GetMinimumCompressionSize ( ) const

inline

A nullable integer that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (with a null value) on an API. When compression is enabled, compression or decompression is not applied on the payload if the payload size is smaller than this value. Setting it to zero allows compression for any payload size.

Definition at line 367 of file RestApi.h.

◆ GetName()

const Aws::String& Aws::APIGateway::Model::RestApi::GetName ( ) const

inline

The API's name.

Definition at line 99 of file RestApi.h.

◆ GetPolicy()

const Aws::String& Aws::APIGateway::Model::RestApi::GetPolicy ( ) const

inline

A stringified JSON policy document that applies to this RestApi regardless of the caller and Method configuration.

Definition at line 493 of file RestApi.h.

◆ GetTags()

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

inline

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

Definition at line 542 of file RestApi.h.

◆ GetVersion()

const Aws::String& Aws::APIGateway::Model::RestApi::GetVersion ( ) const

inline

A version identifier for the API.

Definition at line 212 of file RestApi.h.

◆ GetWarnings()

const Aws::Vector<Aws::String>& Aws::APIGateway::Model::RestApi::GetWarnings ( ) const

inline

The warning messages reported when failonwarnings is turned on during API import.

Definition at line 254 of file RestApi.h.

◆ IdHasBeenSet()

bool Aws::APIGateway::Model::RestApi::IdHasBeenSet ( ) const

inline

The API's identifier. This identifier is unique across all of your APIs in API Gateway.

Definition at line 57 of file RestApi.h.

◆ Jsonize()

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

◆ MinimumCompressionSizeHasBeenSet()

bool Aws::APIGateway::Model::RestApi::MinimumCompressionSizeHasBeenSet ( ) const

inline

A nullable integer that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (with a null value) on an API. When compression is enabled, compression or decompression is not applied on the payload if the payload size is smaller than this value. Setting it to zero allows compression for any payload size.

Definition at line 376 of file RestApi.h.

◆ NameHasBeenSet()

bool Aws::APIGateway::Model::RestApi::NameHasBeenSet ( ) const

inline

The API's name.

Definition at line 104 of file RestApi.h.

◆ operator=()

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

◆ PolicyHasBeenSet()

bool Aws::APIGateway::Model::RestApi::PolicyHasBeenSet ( ) const

inline

A stringified JSON policy document that applies to this RestApi regardless of the caller and Method configuration.

Definition at line 499 of file RestApi.h.

◆ SetApiKeySource() [1/2]

void Aws::APIGateway::Model::RestApi::SetApiKeySource ( ApiKeySourceType && value )

inline

The source of the API key for metering requests according to a usage plan. Valid values are:

HEADER to read the API key from the X-API-Key header of a request.
AUTHORIZER to read the API key from the UsageIdentifierKey from a custom authorizer.

Definition at line 431 of file RestApi.h.

◆ SetApiKeySource() [2/2]

void Aws::APIGateway::Model::RestApi::SetApiKeySource ( const ApiKeySourceType & value )

inline

The source of the API key for metering requests according to a usage plan. Valid values are:

HEADER to read the API key from the X-API-Key header of a request.
AUTHORIZER to read the API key from the UsageIdentifierKey from a custom authorizer.

Definition at line 422 of file RestApi.h.

◆ SetBinaryMediaTypes() [1/2]

void Aws::APIGateway::Model::RestApi::SetBinaryMediaTypes ( Aws::Vector< Aws::String > && value )

inline

The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads.

Definition at line 327 of file RestApi.h.

◆ SetBinaryMediaTypes() [2/2]

void Aws::APIGateway::Model::RestApi::SetBinaryMediaTypes ( const Aws::Vector< Aws::String > & value )

inline

The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads.

Definition at line 321 of file RestApi.h.

◆ SetCreatedDate() [1/2]

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

inline

The timestamp when the API was created.

Definition at line 196 of file RestApi.h.

◆ SetCreatedDate() [2/2]

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

inline

The timestamp when the API was created.

Definition at line 191 of file RestApi.h.

◆ SetDescription() [1/3]

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

inline

The API's description.

Definition at line 155 of file RestApi.h.

◆ SetDescription() [2/3]

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

inline

The API's description.

Definition at line 150 of file RestApi.h.

◆ SetDescription() [3/3]

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

inline

The API's description.

Definition at line 160 of file RestApi.h.

◆ SetDisableExecuteApiEndpoint()

void Aws::APIGateway::Model::RestApi::SetDisableExecuteApiEndpoint ( bool value )

inline

Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.

Definition at line 642 of file RestApi.h.

◆ SetEndpointConfiguration() [1/2]

void Aws::APIGateway::Model::RestApi::SetEndpointConfiguration ( const EndpointConfiguration & value )

inline

The endpoint configuration of this RestApi showing the endpoint types of the API.

Definition at line 468 of file RestApi.h.

◆ SetEndpointConfiguration() [2/2]

void Aws::APIGateway::Model::RestApi::SetEndpointConfiguration ( EndpointConfiguration && value )

inline

The endpoint configuration of this RestApi showing the endpoint types of the API.

Definition at line 474 of file RestApi.h.

◆ SetId() [1/3]

void Aws::APIGateway::Model::RestApi::SetId ( Aws::String && value )

inline

The API's identifier. This identifier is unique across all of your APIs in API Gateway.

Definition at line 69 of file RestApi.h.

◆ SetId() [2/3]

void Aws::APIGateway::Model::RestApi::SetId ( const Aws::String & value )

inline

The API's identifier. This identifier is unique across all of your APIs in API Gateway.

Definition at line 63 of file RestApi.h.

◆ SetId() [3/3]

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

inline

The API's identifier. This identifier is unique across all of your APIs in API Gateway.

Definition at line 75 of file RestApi.h.

◆ SetMinimumCompressionSize()

void Aws::APIGateway::Model::RestApi::SetMinimumCompressionSize ( int value )

inline

A nullable integer that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (with a null value) on an API. When compression is enabled, compression or decompression is not applied on the payload if the payload size is smaller than this value. Setting it to zero allows compression for any payload size.

Definition at line 385 of file RestApi.h.

◆ SetName() [1/3]

void Aws::APIGateway::Model::RestApi::SetName ( Aws::String && value )

inline

The API's name.

Definition at line 114 of file RestApi.h.

◆ SetName() [2/3]

void Aws::APIGateway::Model::RestApi::SetName ( const Aws::String & value )

inline

The API's name.

Definition at line 109 of file RestApi.h.

◆ SetName() [3/3]

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

inline

The API's name.

Definition at line 119 of file RestApi.h.

◆ SetPolicy() [1/3]

void Aws::APIGateway::Model::RestApi::SetPolicy ( Aws::String && value )

inline

A stringified JSON policy document that applies to this RestApi regardless of the caller and Method configuration.

Definition at line 511 of file RestApi.h.

◆ SetPolicy() [2/3]

void Aws::APIGateway::Model::RestApi::SetPolicy ( const Aws::String & value )

inline

A stringified JSON policy document that applies to this RestApi regardless of the caller and Method configuration.

Definition at line 505 of file RestApi.h.

◆ SetPolicy() [3/3]

void Aws::APIGateway::Model::RestApi::SetPolicy ( const char * value )

inline

A stringified JSON policy document that applies to this RestApi regardless of the caller and Method configuration.

Definition at line 517 of file RestApi.h.

◆ SetTags() [1/2]

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

◆ SetTags() [2/2]

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

◆ SetVersion() [1/3]

void Aws::APIGateway::Model::RestApi::SetVersion ( Aws::String && value )

inline

A version identifier for the API.

Definition at line 227 of file RestApi.h.

◆ SetVersion() [2/3]

void Aws::APIGateway::Model::RestApi::SetVersion ( const Aws::String & value )

inline

A version identifier for the API.

Definition at line 222 of file RestApi.h.

◆ SetVersion() [3/3]

void Aws::APIGateway::Model::RestApi::SetVersion ( const char * value )

inline

A version identifier for the API.

Definition at line 232 of file RestApi.h.

◆ SetWarnings() [1/2]

void Aws::APIGateway::Model::RestApi::SetWarnings ( Aws::Vector< Aws::String > && value )

inline

The warning messages reported when failonwarnings is turned on during API import.

Definition at line 272 of file RestApi.h.

◆ SetWarnings() [2/2]

void Aws::APIGateway::Model::RestApi::SetWarnings ( const Aws::Vector< Aws::String > & value )

inline

The warning messages reported when failonwarnings is turned on during API import.

Definition at line 266 of file RestApi.h.

◆ TagsHasBeenSet()

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

inline

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

Definition at line 548 of file RestApi.h.

◆ VersionHasBeenSet()

bool Aws::APIGateway::Model::RestApi::VersionHasBeenSet ( ) const

inline

A version identifier for the API.

Definition at line 217 of file RestApi.h.

◆ WarningsHasBeenSet()

bool Aws::APIGateway::Model::RestApi::WarningsHasBeenSet ( ) const

inline

The warning messages reported when failonwarnings is turned on during API import.

Definition at line 260 of file RestApi.h.

◆ WithApiKeySource() [1/2]

RestApi& Aws::APIGateway::Model::RestApi::WithApiKeySource ( ApiKeySourceType && value )

inline

The source of the API key for metering requests according to a usage plan. Valid values are:

HEADER to read the API key from the X-API-Key header of a request.
AUTHORIZER to read the API key from the UsageIdentifierKey from a custom authorizer.

Definition at line 449 of file RestApi.h.

◆ WithApiKeySource() [2/2]

RestApi& Aws::APIGateway::Model::RestApi::WithApiKeySource ( const ApiKeySourceType & value )

inline

The source of the API key for metering requests according to a usage plan. Valid values are:

HEADER to read the API key from the X-API-Key header of a request.
AUTHORIZER to read the API key from the UsageIdentifierKey from a custom authorizer.

Definition at line 440 of file RestApi.h.

◆ WithBinaryMediaTypes() [1/2]

RestApi& Aws::APIGateway::Model::RestApi::WithBinaryMediaTypes ( Aws::Vector< Aws::String > && value )

inline

The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads.

Definition at line 339 of file RestApi.h.

◆ WithBinaryMediaTypes() [2/2]

RestApi& Aws::APIGateway::Model::RestApi::WithBinaryMediaTypes ( const Aws::Vector< Aws::String > & value )

inline

The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads.

Definition at line 333 of file RestApi.h.

◆ WithCreatedDate() [1/2]

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

inline

The timestamp when the API was created.

Definition at line 206 of file RestApi.h.

◆ WithCreatedDate() [2/2]

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

inline

The timestamp when the API was created.

Definition at line 201 of file RestApi.h.

◆ WithDescription() [1/3]

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

inline

The API's description.

Definition at line 170 of file RestApi.h.

◆ WithDescription() [2/3]

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

inline

The API's description.

Definition at line 165 of file RestApi.h.

◆ WithDescription() [3/3]

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

inline

The API's description.

Definition at line 175 of file RestApi.h.

◆ WithDisableExecuteApiEndpoint()

RestApi& Aws::APIGateway::Model::RestApi::WithDisableExecuteApiEndpoint ( bool value )

inline

Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.

Definition at line 651 of file RestApi.h.

◆ WithEndpointConfiguration() [1/2]

RestApi& Aws::APIGateway::Model::RestApi::WithEndpointConfiguration ( const EndpointConfiguration & value )

inline

The endpoint configuration of this RestApi showing the endpoint types of the API.

Definition at line 480 of file RestApi.h.

◆ WithEndpointConfiguration() [2/2]

RestApi& Aws::APIGateway::Model::RestApi::WithEndpointConfiguration ( EndpointConfiguration && value )

inline

The endpoint configuration of this RestApi showing the endpoint types of the API.

Definition at line 486 of file RestApi.h.

◆ WithId() [1/3]

RestApi& Aws::APIGateway::Model::RestApi::WithId ( Aws::String && value )

inline

The API's identifier. This identifier is unique across all of your APIs in API Gateway.

Definition at line 87 of file RestApi.h.

◆ WithId() [2/3]

RestApi& Aws::APIGateway::Model::RestApi::WithId ( const Aws::String & value )

inline

The API's identifier. This identifier is unique across all of your APIs in API Gateway.

Definition at line 81 of file RestApi.h.

◆ WithId() [3/3]

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

inline

The API's identifier. This identifier is unique across all of your APIs in API Gateway.

Definition at line 93 of file RestApi.h.

◆ WithMinimumCompressionSize()

RestApi& Aws::APIGateway::Model::RestApi::WithMinimumCompressionSize ( int value )

inline

A nullable integer that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (with a null value) on an API. When compression is enabled, compression or decompression is not applied on the payload if the payload size is smaller than this value. Setting it to zero allows compression for any payload size.

Definition at line 394 of file RestApi.h.

◆ WithName() [1/3]

RestApi& Aws::APIGateway::Model::RestApi::WithName ( Aws::String && value )

inline

The API's name.

Definition at line 129 of file RestApi.h.

◆ WithName() [2/3]

RestApi& Aws::APIGateway::Model::RestApi::WithName ( const Aws::String & value )

inline

The API's name.

Definition at line 124 of file RestApi.h.

◆ WithName() [3/3]

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

inline

The API's name.

Definition at line 134 of file RestApi.h.

◆ WithPolicy() [1/3]

RestApi& Aws::APIGateway::Model::RestApi::WithPolicy ( Aws::String && value )

inline

A stringified JSON policy document that applies to this RestApi regardless of the caller and Method configuration.

Definition at line 529 of file RestApi.h.

◆ WithPolicy() [2/3]

RestApi& Aws::APIGateway::Model::RestApi::WithPolicy ( const Aws::String & value )

inline

A stringified JSON policy document that applies to this RestApi regardless of the caller and Method configuration.

Definition at line 523 of file RestApi.h.

◆ WithPolicy() [3/3]

RestApi& Aws::APIGateway::Model::RestApi::WithPolicy ( const char * value )

inline

A stringified JSON policy document that applies to this RestApi regardless of the caller and Method configuration.

Definition at line 535 of file RestApi.h.

◆ WithTags() [1/2]

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

◆ WithTags() [2/2]

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

◆ WithVersion() [1/3]

RestApi& Aws::APIGateway::Model::RestApi::WithVersion ( Aws::String && value )

inline

A version identifier for the API.

Definition at line 242 of file RestApi.h.

◆ WithVersion() [2/3]

RestApi& Aws::APIGateway::Model::RestApi::WithVersion ( const Aws::String & value )

inline

A version identifier for the API.

Definition at line 237 of file RestApi.h.

◆ WithVersion() [3/3]

RestApi& Aws::APIGateway::Model::RestApi::WithVersion ( const char * value )

inline

A version identifier for the API.

Definition at line 247 of file RestApi.h.

◆ WithWarnings() [1/2]

RestApi& Aws::APIGateway::Model::RestApi::WithWarnings ( Aws::Vector< Aws::String > && value )

inline

The warning messages reported when failonwarnings is turned on during API import.

Definition at line 284 of file RestApi.h.

◆ WithWarnings() [2/2]

RestApi& Aws::APIGateway::Model::RestApi::WithWarnings ( const Aws::Vector< Aws::String > & value )

inline

The warning messages reported when failonwarnings is turned on during API import.

Definition at line 278 of file RestApi.h.

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

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

Public Member Functions

Detailed Description

See Also:

Constructor & Destructor Documentation

◆ RestApi() [1/2]

◆ RestApi() [2/2]

Member Function Documentation

◆ AddBinaryMediaTypes() [1/3]

◆ AddBinaryMediaTypes() [2/3]

◆ AddBinaryMediaTypes() [3/3]

◆ AddTags() [1/7]

◆ AddTags() [2/7]

◆ AddTags() [3/7]

◆ AddTags() [4/7]

◆ AddTags() [5/7]

◆ AddTags() [6/7]

◆ AddTags() [7/7]

◆ AddWarnings() [1/3]

◆ AddWarnings() [2/3]

◆ AddWarnings() [3/3]

◆ ApiKeySourceHasBeenSet()

◆ BinaryMediaTypesHasBeenSet()

◆ CreatedDateHasBeenSet()

◆ DescriptionHasBeenSet()

◆ DisableExecuteApiEndpointHasBeenSet()

◆ EndpointConfigurationHasBeenSet()

◆ GetApiKeySource()

◆ GetBinaryMediaTypes()

◆ GetCreatedDate()

◆ GetDescription()

◆ GetDisableExecuteApiEndpoint()

◆ GetEndpointConfiguration()

◆ GetId()

◆ GetMinimumCompressionSize()

◆ GetName()

◆ GetPolicy()

◆ GetTags()

◆ GetVersion()

◆ GetWarnings()

◆ IdHasBeenSet()

◆ Jsonize()

◆ MinimumCompressionSizeHasBeenSet()

◆ NameHasBeenSet()

◆ operator=()

◆ PolicyHasBeenSet()

◆ SetApiKeySource() [1/2]

◆ SetApiKeySource() [2/2]

◆ SetBinaryMediaTypes() [1/2]

◆ SetBinaryMediaTypes() [2/2]

◆ SetCreatedDate() [1/2]

◆ SetCreatedDate() [2/2]

◆ SetDescription() [1/3]

◆ SetDescription() [2/3]

◆ SetDescription() [3/3]

◆ SetDisableExecuteApiEndpoint()

◆ SetEndpointConfiguration() [1/2]

◆ SetEndpointConfiguration() [2/2]

◆ SetId() [1/3]

◆ SetId() [2/3]

◆ SetId() [3/3]

◆ SetMinimumCompressionSize()

◆ SetName() [1/3]

◆ SetName() [2/3]

◆ SetName() [3/3]

◆ SetPolicy() [1/3]

◆ SetPolicy() [2/3]

◆ SetPolicy() [3/3]

◆ SetTags() [1/2]

◆ SetTags() [2/2]

◆ SetVersion() [1/3]

◆ SetVersion() [2/3]

◆ SetVersion() [3/3]

◆ SetWarnings() [1/2]

◆ SetWarnings() [2/2]

◆ TagsHasBeenSet()

◆ VersionHasBeenSet()

◆ WarningsHasBeenSet()

◆ WithApiKeySource() [1/2]

◆ WithApiKeySource() [2/2]

◆ WithBinaryMediaTypes() [1/2]