/ 
Paws-0.24
River stage two • 9 direct dependents • 11 total dependents
/ Paws::ApiGateway::MethodSetting

NAME

Paws::ApiGateway::MethodSetting

USAGE

This class represents one of two things:

Arguments in a call to a service

Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. Each attribute should be used as a named argument in the calls that expect this type of object.

As an example, if Att1 is expected to be a Paws::ApiGateway::MethodSetting object:

$service_obj->Method(Att1 => { CacheDataEncrypted => $value, ..., UnauthorizedCacheControlHeaderStrategy => $value  });

Results returned from an API call

Use accessors for each attribute. If Att1 is expected to be an Paws::ApiGateway::MethodSetting object:

$result = $service_obj->Method(...);
$result->Att1->CacheDataEncrypted

DESCRIPTION

Specifies the method setting properties.

ATTRIBUTES

CacheDataEncrypted => Bool

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

CacheTtlInSeconds => Int

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

CachingEnabled => Bool

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
C</{method_setting_key}/caching/enabled>, and the value is a Boolean.

DataTraceEnabled => Bool

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

LoggingLevel => Str

Specifies the logging level for this method, which effects the log
entries pushed to Amazon CloudWatch Logs. The PATCH path for this
setting is C</{method_setting_key}/logging/loglevel>, and the available
levels are C<OFF>, C<ERROR>, and C<INFO>.

MetricsEnabled => Bool

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

RequireAuthorizationForCacheControl => Bool

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

ThrottlingBurstLimit => Int

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

ThrottlingRateLimit => Num

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

UnauthorizedCacheControlHeaderStrategy => Str

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

SEE ALSO

This class forms part of Paws, describing an object used in Paws::ApiGateway

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues