| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::ApiGateway::MethodSetting; | ||
| 3 | use Moose; | ||
| 4 | has CacheDataEncrypted => (is => 'ro', isa => 'Bool', request_name => 'cacheDataEncrypted', traits => ['NameInRequest']); | ||
| 5 | has CacheTtlInSeconds => (is => 'ro', isa => 'Int', request_name => 'cacheTtlInSeconds', traits => ['NameInRequest']); | ||
| 6 | has CachingEnabled => (is => 'ro', isa => 'Bool', request_name => 'cachingEnabled', traits => ['NameInRequest']); | ||
| 7 | has DataTraceEnabled => (is => 'ro', isa => 'Bool', request_name => 'dataTraceEnabled', traits => ['NameInRequest']); | ||
| 8 | has LoggingLevel => (is => 'ro', isa => 'Str', request_name => 'loggingLevel', traits => ['NameInRequest']); | ||
| 9 | has MetricsEnabled => (is => 'ro', isa => 'Bool', request_name => 'metricsEnabled', traits => ['NameInRequest']); | ||
| 10 | has RequireAuthorizationForCacheControl => (is => 'ro', isa => 'Bool', request_name => 'requireAuthorizationForCacheControl', traits => ['NameInRequest']); | ||
| 11 | has ThrottlingBurstLimit => (is => 'ro', isa => 'Int', request_name => 'throttlingBurstLimit', traits => ['NameInRequest']); | ||
| 12 | has ThrottlingRateLimit => (is => 'ro', isa => 'Num', request_name => 'throttlingRateLimit', traits => ['NameInRequest']); | ||
| 13 | has UnauthorizedCacheControlHeaderStrategy => (is => 'ro', isa => 'Str', request_name => 'unauthorizedCacheControlHeaderStrategy', traits => ['NameInRequest']); | ||
| 14 | |||
| 15 | 1; | ||
| 16 | |||
| 17 | ### main pod documentation begin ### | ||
| 18 | |||
| 19 | =head1 NAME | ||
| 20 | |||
| 21 | Paws::ApiGateway::MethodSetting | ||
| 22 | |||
| 23 | =head1 USAGE | ||
| 24 | |||
| 25 | This class represents one of two things: | ||
| 26 | |||
| 27 | =head3 Arguments in a call to a service | ||
| 28 | |||
| 29 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 30 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 31 | |||
| 32 | As an example, if Att1 is expected to be a Paws::ApiGateway::MethodSetting object: | ||
| 33 | |||
| 34 | $service_obj->Method(Att1 => { CacheDataEncrypted => $value, ..., UnauthorizedCacheControlHeaderStrategy => $value }); | ||
| 35 | |||
| 36 | =head3 Results returned from an API call | ||
| 37 | |||
| 38 | Use accessors for each attribute. If Att1 is expected to be an Paws::ApiGateway::MethodSetting object: | ||
| 39 | |||
| 40 | $result = $service_obj->Method(...); | ||
| 41 | $result->Att1->CacheDataEncrypted | ||
| 42 | |||
| 43 | =head1 DESCRIPTION | ||
| 44 | |||
| 45 | Specifies the method setting properties. | ||
| 46 | |||
| 47 | =head1 ATTRIBUTES | ||
| 48 | |||
| 49 | |||
| 50 | =head2 CacheDataEncrypted => Bool | ||
| 51 | |||
| 52 | Specifies whether the cached responses are encrypted. The PATCH path | ||
| 53 | for this setting is C</{method_setting_key}/caching/dataEncrypted>, and | ||
| 54 | the value is a Boolean. | ||
| 55 | |||
| 56 | |||
| 57 | =head2 CacheTtlInSeconds => Int | ||
| 58 | |||
| 59 | Specifies the time to live (TTL), in seconds, for cached responses. The | ||
| 60 | higher the TTL, the longer the response will be cached. The PATCH path | ||
| 61 | for this setting is C</{method_setting_key}/caching/ttlInSeconds>, and | ||
| 62 | the value is an integer. | ||
| 63 | |||
| 64 | |||
| 65 | =head2 CachingEnabled => Bool | ||
| 66 | |||
| 67 | Specifies whether responses should be cached and returned for requests. | ||
| 68 | A cache cluster must be enabled on the stage for responses to be | ||
| 69 | cached. The PATCH path for this setting is | ||
| 70 | C</{method_setting_key}/caching/enabled>, and the value is a Boolean. | ||
| 71 | |||
| 72 | |||
| 73 | =head2 DataTraceEnabled => Bool | ||
| 74 | |||
| 75 | Specifies whether data trace logging is enabled for this method, which | ||
| 76 | affects the log entries pushed to Amazon CloudWatch Logs. The PATCH | ||
| 77 | path for this setting is C</{method_setting_key}/logging/dataTrace>, | ||
| 78 | and the value is a Boolean. | ||
| 79 | |||
| 80 | |||
| 81 | =head2 LoggingLevel => Str | ||
| 82 | |||
| 83 | Specifies the logging level for this method, which affects the log | ||
| 84 | entries pushed to Amazon CloudWatch Logs. The PATCH path for this | ||
| 85 | setting is C</{method_setting_key}/logging/loglevel>, and the available | ||
| 86 | levels are C<OFF>, C<ERROR>, and C<INFO>. Choose C<ERROR> to write only | ||
| 87 | error-level entries to CloudWatch Logs, or choose C<INFO> to include | ||
| 88 | all C<ERROR> events as well as extra informational events. | ||
| 89 | |||
| 90 | |||
| 91 | =head2 MetricsEnabled => Bool | ||
| 92 | |||
| 93 | Specifies whether Amazon CloudWatch metrics are enabled for this | ||
| 94 | method. The PATCH path for this setting is | ||
| 95 | C</{method_setting_key}/metrics/enabled>, and the value is a Boolean. | ||
| 96 | |||
| 97 | |||
| 98 | =head2 RequireAuthorizationForCacheControl => Bool | ||
| 99 | |||
| 100 | Specifies whether authorization is required for a cache invalidation | ||
| 101 | request. The PATCH path for this setting is | ||
| 102 | C</{method_setting_key}/caching/requireAuthorizationForCacheControl>, | ||
| 103 | and the value is a Boolean. | ||
| 104 | |||
| 105 | |||
| 106 | =head2 ThrottlingBurstLimit => Int | ||
| 107 | |||
| 108 | Specifies the throttling burst limit. The PATCH path for this setting | ||
| 109 | is C</{method_setting_key}/throttling/burstLimit>, and the value is an | ||
| 110 | integer. | ||
| 111 | |||
| 112 | |||
| 113 | =head2 ThrottlingRateLimit => Num | ||
| 114 | |||
| 115 | Specifies the throttling rate limit. The PATCH path for this setting is | ||
| 116 | C</{method_setting_key}/throttling/rateLimit>, and the value is a | ||
| 117 | double. | ||
| 118 | |||
| 119 | |||
| 120 | =head2 UnauthorizedCacheControlHeaderStrategy => Str | ||
| 121 | |||
| 122 | Specifies how to handle unauthorized requests for cache invalidation. | ||
| 123 | The PATCH path for this setting is | ||
| 124 | C</{method_setting_key}/caching/unauthorizedCacheControlHeaderStrategy>, | ||
| 125 | and the available values are C<FAIL_WITH_403>, | ||
| 126 | C<SUCCEED_WITH_RESPONSE_HEADER>, C<SUCCEED_WITHOUT_RESPONSE_HEADER>. | ||
| 127 | |||
| 128 | |||
| 129 | |||
| 130 | =head1 SEE ALSO | ||
| 131 | |||
| 132 | This class forms part of L<Paws>, describing an object used in L<Paws::ApiGateway> | ||
| 133 | |||
| 134 | =head1 BUGS and CONTRIBUTIONS | ||
| 135 | |||
| 136 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 137 | |||
| 138 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 139 | |||
| 140 | =cut | ||
| 141 |