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

#include <MethodSetting.h>

Public Member Functions

 MethodSetting ()
 
 MethodSetting (Aws::Utils::Json::JsonView jsonValue)
 
MethodSettingoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
bool GetMetricsEnabled () const
 
bool MetricsEnabledHasBeenSet () const
 
void SetMetricsEnabled (bool value)
 
MethodSettingWithMetricsEnabled (bool value)
 
const Aws::StringGetLoggingLevel () const
 
bool LoggingLevelHasBeenSet () const
 
void SetLoggingLevel (const Aws::String &value)
 
void SetLoggingLevel (Aws::String &&value)
 
void SetLoggingLevel (const char *value)
 
MethodSettingWithLoggingLevel (const Aws::String &value)
 
MethodSettingWithLoggingLevel (Aws::String &&value)
 
MethodSettingWithLoggingLevel (const char *value)
 
bool GetDataTraceEnabled () const
 
bool DataTraceEnabledHasBeenSet () const
 
void SetDataTraceEnabled (bool value)
 
MethodSettingWithDataTraceEnabled (bool value)
 
int GetThrottlingBurstLimit () const
 
bool ThrottlingBurstLimitHasBeenSet () const
 
void SetThrottlingBurstLimit (int value)
 
MethodSettingWithThrottlingBurstLimit (int value)
 
double GetThrottlingRateLimit () const
 
bool ThrottlingRateLimitHasBeenSet () const
 
void SetThrottlingRateLimit (double value)
 
MethodSettingWithThrottlingRateLimit (double value)
 
bool GetCachingEnabled () const
 
bool CachingEnabledHasBeenSet () const
 
void SetCachingEnabled (bool value)
 
MethodSettingWithCachingEnabled (bool value)
 
int GetCacheTtlInSeconds () const
 
bool CacheTtlInSecondsHasBeenSet () const
 
void SetCacheTtlInSeconds (int value)
 
MethodSettingWithCacheTtlInSeconds (int value)
 
bool GetCacheDataEncrypted () const
 
bool CacheDataEncryptedHasBeenSet () const
 
void SetCacheDataEncrypted (bool value)
 
MethodSettingWithCacheDataEncrypted (bool value)
 
bool GetRequireAuthorizationForCacheControl () const
 
bool RequireAuthorizationForCacheControlHasBeenSet () const
 
void SetRequireAuthorizationForCacheControl (bool value)
 
MethodSettingWithRequireAuthorizationForCacheControl (bool value)
 
const UnauthorizedCacheControlHeaderStrategyGetUnauthorizedCacheControlHeaderStrategy () const
 
bool UnauthorizedCacheControlHeaderStrategyHasBeenSet () const
 
void SetUnauthorizedCacheControlHeaderStrategy (const UnauthorizedCacheControlHeaderStrategy &value)
 
void SetUnauthorizedCacheControlHeaderStrategy (UnauthorizedCacheControlHeaderStrategy &&value)
 
MethodSettingWithUnauthorizedCacheControlHeaderStrategy (const UnauthorizedCacheControlHeaderStrategy &value)
 
MethodSettingWithUnauthorizedCacheControlHeaderStrategy (UnauthorizedCacheControlHeaderStrategy &&value)
 

Detailed Description

Specifies the method setting properties.

See Also:

AWS API Reference

Definition at line 32 of file MethodSetting.h.

Constructor & Destructor Documentation

◆ MethodSetting() [1/2]

Aws::APIGateway::Model::MethodSetting::MethodSetting ( )

◆ MethodSetting() [2/2]

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

Member Function Documentation

◆ CacheDataEncryptedHasBeenSet()

bool Aws::APIGateway::Model::MethodSetting::CacheDataEncryptedHasBeenSet ( ) const
inline

Specifies whether the cached responses are encrypted. The PATCH path for this setting is /{method_setting_key}/caching/dataEncrypted, and the value is a Boolean.

Definition at line 332 of file MethodSetting.h.

◆ CacheTtlInSecondsHasBeenSet()

bool Aws::APIGateway::Model::MethodSetting::CacheTtlInSecondsHasBeenSet ( ) const
inline

Specifies the time to live (TTL), in seconds, for cached responses. The higher the TTL, the longer the response will be cached. The PATCH path for this setting is /{method_setting_key}/caching/ttlInSeconds, and the value is an integer.

Definition at line 301 of file MethodSetting.h.

◆ CachingEnabledHasBeenSet()

bool Aws::APIGateway::Model::MethodSetting::CachingEnabledHasBeenSet ( ) const
inline

Specifies whether responses should be cached and returned for requests. A cache cluster must be enabled on the stage for responses to be cached. The PATCH path for this setting is /{method_setting_key}/caching/enabled, and the value is a Boolean.

Definition at line 268 of file MethodSetting.h.

◆ DataTraceEnabledHasBeenSet()

bool Aws::APIGateway::Model::MethodSetting::DataTraceEnabledHasBeenSet ( ) const
inline

Specifies whether data trace logging is enabled for this method, which affects the log entries pushed to Amazon CloudWatch Logs. The PATCH path for this setting is /{method_setting_key}/logging/dataTrace, and the value is a Boolean.

Definition at line 177 of file MethodSetting.h.

◆ GetCacheDataEncrypted()

bool Aws::APIGateway::Model::MethodSetting::GetCacheDataEncrypted ( ) const
inline

Specifies whether the cached responses are encrypted. The PATCH path for this setting is /{method_setting_key}/caching/dataEncrypted, and the value is a Boolean.

Definition at line 325 of file MethodSetting.h.

◆ GetCacheTtlInSeconds()

int Aws::APIGateway::Model::MethodSetting::GetCacheTtlInSeconds ( ) const
inline

Specifies the time to live (TTL), in seconds, for cached responses. The higher the TTL, the longer the response will be cached. The PATCH path for this setting is /{method_setting_key}/caching/ttlInSeconds, and the value is an integer.

Definition at line 293 of file MethodSetting.h.

◆ GetCachingEnabled()

bool Aws::APIGateway::Model::MethodSetting::GetCachingEnabled ( ) const
inline

Specifies whether responses should be cached and returned for requests. A cache cluster must be enabled on the stage for responses to be cached. The PATCH path for this setting is /{method_setting_key}/caching/enabled, and the value is a Boolean.

Definition at line 260 of file MethodSetting.h.

◆ GetDataTraceEnabled()

bool Aws::APIGateway::Model::MethodSetting::GetDataTraceEnabled ( ) const
inline

Specifies whether data trace logging is enabled for this method, which affects the log entries pushed to Amazon CloudWatch Logs. The PATCH path for this setting is /{method_setting_key}/logging/dataTrace, and the value is a Boolean.

Definition at line 169 of file MethodSetting.h.

◆ GetLoggingLevel()

const Aws::String& Aws::APIGateway::Model::MethodSetting::GetLoggingLevel ( ) const
inline

Specifies the logging level for this method, which affects the log entries pushed to Amazon CloudWatch Logs. The PATCH path for this setting is /{method_setting_key}/logging/loglevel, and the available levels are OFF, ERROR, and INFO. Choose ERROR to write only error-level entries to CloudWatch Logs, or choose INFO to include all ERROR events as well as extra informational events.

Definition at line 83 of file MethodSetting.h.

◆ GetMetricsEnabled()

bool Aws::APIGateway::Model::MethodSetting::GetMetricsEnabled ( ) const
inline

Specifies whether Amazon CloudWatch metrics are enabled for this method. The PATCH path for this setting is /{method_setting_key}/metrics/enabled, and the value is a Boolean.

Definition at line 47 of file MethodSetting.h.

◆ GetRequireAuthorizationForCacheControl()

bool Aws::APIGateway::Model::MethodSetting::GetRequireAuthorizationForCacheControl ( ) const
inline

Specifies whether authorization is required for a cache invalidation request. The PATCH path for this setting is /{method_setting_key}/caching/requireAuthorizationForCacheControl, and the value is a Boolean.

Definition at line 355 of file MethodSetting.h.

◆ GetThrottlingBurstLimit()

int Aws::APIGateway::Model::MethodSetting::GetThrottlingBurstLimit ( ) const
inline

Specifies the throttling burst limit. The PATCH path for this setting is /{method_setting_key}/throttling/burstLimit, and the value is an integer.

Definition at line 201 of file MethodSetting.h.

◆ GetThrottlingRateLimit()

double Aws::APIGateway::Model::MethodSetting::GetThrottlingRateLimit ( ) const
inline

Specifies the throttling rate limit. The PATCH path for this setting is /{method_setting_key}/throttling/rateLimit, and the value is a double.

Definition at line 230 of file MethodSetting.h.

◆ GetUnauthorizedCacheControlHeaderStrategy()

const UnauthorizedCacheControlHeaderStrategy& Aws::APIGateway::Model::MethodSetting::GetUnauthorizedCacheControlHeaderStrategy ( ) const
inline

Specifies how to handle unauthorized requests for cache invalidation. The PATCH path for this setting is /{method_setting_key}/caching/unauthorizedCacheControlHeaderStrategy, and the available values are FAIL_WITH_403, SUCCEED_WITH_RESPONSE_HEADER, SUCCEED_WITHOUT_RESPONSE_HEADER.

Definition at line 390 of file MethodSetting.h.

◆ Jsonize()

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

◆ LoggingLevelHasBeenSet()

bool Aws::APIGateway::Model::MethodSetting::LoggingLevelHasBeenSet ( ) const
inline

Specifies the logging level for this method, which affects the log entries pushed to Amazon CloudWatch Logs. The PATCH path for this setting is /{method_setting_key}/logging/loglevel, and the available levels are OFF, ERROR, and INFO. Choose ERROR to write only error-level entries to CloudWatch Logs, or choose INFO to include all ERROR events as well as extra informational events.

Definition at line 94 of file MethodSetting.h.

◆ MetricsEnabledHasBeenSet()

bool Aws::APIGateway::Model::MethodSetting::MetricsEnabledHasBeenSet ( ) const
inline

Specifies whether Amazon CloudWatch metrics are enabled for this method. The PATCH path for this setting is /{method_setting_key}/metrics/enabled, and the value is a Boolean.

Definition at line 55 of file MethodSetting.h.

◆ operator=()

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

◆ RequireAuthorizationForCacheControlHasBeenSet()

bool Aws::APIGateway::Model::MethodSetting::RequireAuthorizationForCacheControlHasBeenSet ( ) const
inline

Specifies whether authorization is required for a cache invalidation request. The PATCH path for this setting is /{method_setting_key}/caching/requireAuthorizationForCacheControl, and the value is a Boolean.

Definition at line 363 of file MethodSetting.h.

◆ SetCacheDataEncrypted()

void Aws::APIGateway::Model::MethodSetting::SetCacheDataEncrypted ( bool  value)
inline

Specifies whether the cached responses are encrypted. The PATCH path for this setting is /{method_setting_key}/caching/dataEncrypted, and the value is a Boolean.

Definition at line 339 of file MethodSetting.h.

◆ SetCacheTtlInSeconds()

void Aws::APIGateway::Model::MethodSetting::SetCacheTtlInSeconds ( int  value)
inline

Specifies the time to live (TTL), in seconds, for cached responses. The higher the TTL, the longer the response will be cached. The PATCH path for this setting is /{method_setting_key}/caching/ttlInSeconds, and the value is an integer.

Definition at line 309 of file MethodSetting.h.

◆ SetCachingEnabled()

void Aws::APIGateway::Model::MethodSetting::SetCachingEnabled ( bool  value)
inline

Specifies whether responses should be cached and returned for requests. A cache cluster must be enabled on the stage for responses to be cached. The PATCH path for this setting is /{method_setting_key}/caching/enabled, and the value is a Boolean.

Definition at line 276 of file MethodSetting.h.

◆ SetDataTraceEnabled()

void Aws::APIGateway::Model::MethodSetting::SetDataTraceEnabled ( bool  value)
inline

Specifies whether data trace logging is enabled for this method, which affects the log entries pushed to Amazon CloudWatch Logs. The PATCH path for this setting is /{method_setting_key}/logging/dataTrace, and the value is a Boolean.

Definition at line 185 of file MethodSetting.h.

◆ SetLoggingLevel() [1/3]

void Aws::APIGateway::Model::MethodSetting::SetLoggingLevel ( const Aws::String value)
inline

Specifies the logging level for this method, which affects the log entries pushed to Amazon CloudWatch Logs. The PATCH path for this setting is /{method_setting_key}/logging/loglevel, and the available levels are OFF, ERROR, and INFO. Choose ERROR to write only error-level entries to CloudWatch Logs, or choose INFO to include all ERROR events as well as extra informational events.

Definition at line 105 of file MethodSetting.h.

◆ SetLoggingLevel() [2/3]

void Aws::APIGateway::Model::MethodSetting::SetLoggingLevel ( Aws::String &&  value)
inline

Specifies the logging level for this method, which affects the log entries pushed to Amazon CloudWatch Logs. The PATCH path for this setting is /{method_setting_key}/logging/loglevel, and the available levels are OFF, ERROR, and INFO. Choose ERROR to write only error-level entries to CloudWatch Logs, or choose INFO to include all ERROR events as well as extra informational events.

Definition at line 116 of file MethodSetting.h.

◆ SetLoggingLevel() [3/3]

void Aws::APIGateway::Model::MethodSetting::SetLoggingLevel ( const char *  value)
inline

Specifies the logging level for this method, which affects the log entries pushed to Amazon CloudWatch Logs. The PATCH path for this setting is /{method_setting_key}/logging/loglevel, and the available levels are OFF, ERROR, and INFO. Choose ERROR to write only error-level entries to CloudWatch Logs, or choose INFO to include all ERROR events as well as extra informational events.

Definition at line 127 of file MethodSetting.h.

◆ SetMetricsEnabled()

void Aws::APIGateway::Model::MethodSetting::SetMetricsEnabled ( bool  value)
inline

Specifies whether Amazon CloudWatch metrics are enabled for this method. The PATCH path for this setting is /{method_setting_key}/metrics/enabled, and the value is a Boolean.

Definition at line 63 of file MethodSetting.h.

◆ SetRequireAuthorizationForCacheControl()

void Aws::APIGateway::Model::MethodSetting::SetRequireAuthorizationForCacheControl ( bool  value)
inline

Specifies whether authorization is required for a cache invalidation request. The PATCH path for this setting is /{method_setting_key}/caching/requireAuthorizationForCacheControl, and the value is a Boolean.

Definition at line 371 of file MethodSetting.h.

◆ SetThrottlingBurstLimit()

void Aws::APIGateway::Model::MethodSetting::SetThrottlingBurstLimit ( int  value)
inline

Specifies the throttling burst limit. The PATCH path for this setting is /{method_setting_key}/throttling/burstLimit, and the value is an integer.

Definition at line 215 of file MethodSetting.h.

◆ SetThrottlingRateLimit()

void Aws::APIGateway::Model::MethodSetting::SetThrottlingRateLimit ( double  value)
inline

Specifies the throttling rate limit. The PATCH path for this setting is /{method_setting_key}/throttling/rateLimit, and the value is a double.

Definition at line 244 of file MethodSetting.h.

◆ SetUnauthorizedCacheControlHeaderStrategy() [1/2]

void Aws::APIGateway::Model::MethodSetting::SetUnauthorizedCacheControlHeaderStrategy ( const UnauthorizedCacheControlHeaderStrategy value)
inline

Specifies how to handle unauthorized requests for cache invalidation. The PATCH path for this setting is /{method_setting_key}/caching/unauthorizedCacheControlHeaderStrategy, and the available values are FAIL_WITH_403, SUCCEED_WITH_RESPONSE_HEADER, SUCCEED_WITHOUT_RESPONSE_HEADER.

Definition at line 410 of file MethodSetting.h.

◆ SetUnauthorizedCacheControlHeaderStrategy() [2/2]

void Aws::APIGateway::Model::MethodSetting::SetUnauthorizedCacheControlHeaderStrategy ( UnauthorizedCacheControlHeaderStrategy &&  value)
inline

Specifies how to handle unauthorized requests for cache invalidation. The PATCH path for this setting is /{method_setting_key}/caching/unauthorizedCacheControlHeaderStrategy, and the available values are FAIL_WITH_403, SUCCEED_WITH_RESPONSE_HEADER, SUCCEED_WITHOUT_RESPONSE_HEADER.

Definition at line 420 of file MethodSetting.h.

◆ ThrottlingBurstLimitHasBeenSet()

bool Aws::APIGateway::Model::MethodSetting::ThrottlingBurstLimitHasBeenSet ( ) const
inline

Specifies the throttling burst limit. The PATCH path for this setting is /{method_setting_key}/throttling/burstLimit, and the value is an integer.

Definition at line 208 of file MethodSetting.h.

◆ ThrottlingRateLimitHasBeenSet()

bool Aws::APIGateway::Model::MethodSetting::ThrottlingRateLimitHasBeenSet ( ) const
inline

Specifies the throttling rate limit. The PATCH path for this setting is /{method_setting_key}/throttling/rateLimit, and the value is a double.

Definition at line 237 of file MethodSetting.h.

◆ UnauthorizedCacheControlHeaderStrategyHasBeenSet()

bool Aws::APIGateway::Model::MethodSetting::UnauthorizedCacheControlHeaderStrategyHasBeenSet ( ) const
inline

Specifies how to handle unauthorized requests for cache invalidation. The PATCH path for this setting is /{method_setting_key}/caching/unauthorizedCacheControlHeaderStrategy, and the available values are FAIL_WITH_403, SUCCEED_WITH_RESPONSE_HEADER, SUCCEED_WITHOUT_RESPONSE_HEADER.

Definition at line 400 of file MethodSetting.h.

◆ WithCacheDataEncrypted()

MethodSetting& Aws::APIGateway::Model::MethodSetting::WithCacheDataEncrypted ( bool  value)
inline

Specifies whether the cached responses are encrypted. The PATCH path for this setting is /{method_setting_key}/caching/dataEncrypted, and the value is a Boolean.

Definition at line 346 of file MethodSetting.h.

◆ WithCacheTtlInSeconds()

MethodSetting& Aws::APIGateway::Model::MethodSetting::WithCacheTtlInSeconds ( int  value)
inline

Specifies the time to live (TTL), in seconds, for cached responses. The higher the TTL, the longer the response will be cached. The PATCH path for this setting is /{method_setting_key}/caching/ttlInSeconds, and the value is an integer.

Definition at line 317 of file MethodSetting.h.

◆ WithCachingEnabled()

MethodSetting& Aws::APIGateway::Model::MethodSetting::WithCachingEnabled ( bool  value)
inline

Specifies whether responses should be cached and returned for requests. A cache cluster must be enabled on the stage for responses to be cached. The PATCH path for this setting is /{method_setting_key}/caching/enabled, and the value is a Boolean.

Definition at line 284 of file MethodSetting.h.

◆ WithDataTraceEnabled()

MethodSetting& Aws::APIGateway::Model::MethodSetting::WithDataTraceEnabled ( bool  value)
inline

Specifies whether data trace logging is enabled for this method, which affects the log entries pushed to Amazon CloudWatch Logs. The PATCH path for this setting is /{method_setting_key}/logging/dataTrace, and the value is a Boolean.

Definition at line 193 of file MethodSetting.h.

◆ WithLoggingLevel() [1/3]

MethodSetting& Aws::APIGateway::Model::MethodSetting::WithLoggingLevel ( const Aws::String value)
inline

Specifies the logging level for this method, which affects the log entries pushed to Amazon CloudWatch Logs. The PATCH path for this setting is /{method_setting_key}/logging/loglevel, and the available levels are OFF, ERROR, and INFO. Choose ERROR to write only error-level entries to CloudWatch Logs, or choose INFO to include all ERROR events as well as extra informational events.

Definition at line 138 of file MethodSetting.h.

◆ WithLoggingLevel() [2/3]

MethodSetting& Aws::APIGateway::Model::MethodSetting::WithLoggingLevel ( Aws::String &&  value)
inline

Specifies the logging level for this method, which affects the log entries pushed to Amazon CloudWatch Logs. The PATCH path for this setting is /{method_setting_key}/logging/loglevel, and the available levels are OFF, ERROR, and INFO. Choose ERROR to write only error-level entries to CloudWatch Logs, or choose INFO to include all ERROR events as well as extra informational events.

Definition at line 149 of file MethodSetting.h.

◆ WithLoggingLevel() [3/3]

MethodSetting& Aws::APIGateway::Model::MethodSetting::WithLoggingLevel ( const char *  value)
inline

Specifies the logging level for this method, which affects the log entries pushed to Amazon CloudWatch Logs. The PATCH path for this setting is /{method_setting_key}/logging/loglevel, and the available levels are OFF, ERROR, and INFO. Choose ERROR to write only error-level entries to CloudWatch Logs, or choose INFO to include all ERROR events as well as extra informational events.

Definition at line 160 of file MethodSetting.h.

◆ WithMetricsEnabled()

MethodSetting& Aws::APIGateway::Model::MethodSetting::WithMetricsEnabled ( bool  value)
inline

Specifies whether Amazon CloudWatch metrics are enabled for this method. The PATCH path for this setting is /{method_setting_key}/metrics/enabled, and the value is a Boolean.

Definition at line 71 of file MethodSetting.h.

◆ WithRequireAuthorizationForCacheControl()

MethodSetting& Aws::APIGateway::Model::MethodSetting::WithRequireAuthorizationForCacheControl ( bool  value)
inline

Specifies whether authorization is required for a cache invalidation request. The PATCH path for this setting is /{method_setting_key}/caching/requireAuthorizationForCacheControl, and the value is a Boolean.

Definition at line 379 of file MethodSetting.h.

◆ WithThrottlingBurstLimit()

MethodSetting& Aws::APIGateway::Model::MethodSetting::WithThrottlingBurstLimit ( int  value)
inline

Specifies the throttling burst limit. The PATCH path for this setting is /{method_setting_key}/throttling/burstLimit, and the value is an integer.

Definition at line 222 of file MethodSetting.h.

◆ WithThrottlingRateLimit()

MethodSetting& Aws::APIGateway::Model::MethodSetting::WithThrottlingRateLimit ( double  value)
inline

Specifies the throttling rate limit. The PATCH path for this setting is /{method_setting_key}/throttling/rateLimit, and the value is a double.

Definition at line 251 of file MethodSetting.h.

◆ WithUnauthorizedCacheControlHeaderStrategy() [1/2]

MethodSetting& Aws::APIGateway::Model::MethodSetting::WithUnauthorizedCacheControlHeaderStrategy ( const UnauthorizedCacheControlHeaderStrategy value)
inline

Specifies how to handle unauthorized requests for cache invalidation. The PATCH path for this setting is /{method_setting_key}/caching/unauthorizedCacheControlHeaderStrategy, and the available values are FAIL_WITH_403, SUCCEED_WITH_RESPONSE_HEADER, SUCCEED_WITHOUT_RESPONSE_HEADER.

Definition at line 430 of file MethodSetting.h.

◆ WithUnauthorizedCacheControlHeaderStrategy() [2/2]

MethodSetting& Aws::APIGateway::Model::MethodSetting::WithUnauthorizedCacheControlHeaderStrategy ( UnauthorizedCacheControlHeaderStrategy &&  value)
inline

Specifies how to handle unauthorized requests for cache invalidation. The PATCH path for this setting is /{method_setting_key}/caching/unauthorizedCacheControlHeaderStrategy, and the available values are FAIL_WITH_403, SUCCEED_WITH_RESPONSE_HEADER, SUCCEED_WITHOUT_RESPONSE_HEADER.

Definition at line 440 of file MethodSetting.h.


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