File Coverage

blib/lib/Paws/ApiGateway/MethodSetting.pm

Criterion	Covered	Total	%
statement	3	3	100.0
branch			n/a
condition			n/a
subroutine	1	1	100.0
pod			n/a
total	4	4	100.0

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