blib/lib/Paws/ApplicationAutoScaling/PutScheduledAction.pm untested

filter: Statementstmt 0.0% 0 / 18 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 2 Podpod n/a totaltotal 0.0% 0 / 20 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
BEGIN
2.0
CRAP 2.0
1  
2 package Paws::ApplicationAutoScaling::PutScheduledAction;
3 use Moose;
4 has EndTime => (is => 'ro', isa => 'Str');
5 has ResourceId => (is => 'ro', isa => 'Str', required => 1);
6 has ScalableDimension => (is => 'ro', isa => 'Str', required => 1);
7 has ScalableTargetAction => (is => 'ro', isa => 'Paws::ApplicationAutoScaling::ScalableTargetAction');
8 has Schedule => (is => 'ro', isa => 'Str');
9 has ScheduledActionName => (is => 'ro', isa => 'Str', required => 1);
10 has ServiceNamespace => (is => 'ro', isa => 'Str', required => 1);
11 has StartTime => (is => 'ro', isa => 'Str');
12 has Timezone => (is => 'ro', isa => 'Str');
13  
14 use MooseX::ClassAttribute;
15  
16 class_has _api_call => (isa => 'Str', is => 'ro', default => 'PutScheduledAction');
17 class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::ApplicationAutoScaling::PutScheduledActionResponse');
18 class_has _result_key => (isa => 'Str', is => 'ro');
19 1;
20  
21 ### main pod documentation begin ###
22  
23 =head1 NAME
24  
25 Paws::ApplicationAutoScaling::PutScheduledAction - Arguments for method PutScheduledAction on L<Paws::ApplicationAutoScaling>
26  
27 =head1 DESCRIPTION
28  
29 This class represents the parameters used for calling the method PutScheduledAction on the
30 L<Application Auto Scaling|Paws::ApplicationAutoScaling> service. Use the attributes of this class
31 as arguments to method PutScheduledAction.
32  
33 You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to PutScheduledAction.
34  
35 =head1 SYNOPSIS
36  
37 my $application-autoscaling = Paws->service('ApplicationAutoScaling');
38 my $PutScheduledActionResponse =
39 $application -autoscaling->PutScheduledAction(
40 ResourceId => 'MyResourceIdMaxLen1600',
41 ScalableDimension => 'ecs:service:DesiredCount',
42 ScheduledActionName => 'MyScheduledActionName',
43 ServiceNamespace => 'ecs',
44 EndTime => '1970-01-01T01:00:00', # OPTIONAL
45 ScalableTargetAction => {
46 MaxCapacity => 1, # OPTIONAL
47 MinCapacity => 1, # OPTIONAL
48 }, # OPTIONAL
49 Schedule => 'MyResourceIdMaxLen1600', # OPTIONAL
50 StartTime => '1970-01-01T01:00:00', # OPTIONAL
51 Timezone => 'MyResourceIdMaxLen1600', # OPTIONAL
52 );
53  
54 Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object.
55 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/application-autoscaling/PutScheduledAction>
56  
57 =head1 ATTRIBUTES
58  
59  
60 =head2 EndTime => Str
61  
62 The date and time for the recurring schedule to end, in UTC.
63  
64  
65  
66 =head2 B<REQUIRED> ResourceId => Str
67  
68 The identifier of the resource associated with the scheduled action.
69 This string consists of the resource type and unique identifier.
70  
71 =over
72  
73 =item *
74  
75 ECS service - The resource type is C<service> and the unique identifier
76 is the cluster name and service name. Example:
77 C<service/default/sample-webapp>.
78  
79 =item *
80  
81 Spot Fleet request - The resource type is C<spot-fleet-request> and the
82 unique identifier is the Spot Fleet request ID. Example:
83 C<spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE>.
84  
85 =item *
86  
87 EMR cluster - The resource type is C<instancegroup> and the unique
88 identifier is the cluster ID and instance group ID. Example:
89 C<instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0>.
90  
91 =item *
92  
93 AppStream 2.0 fleet - The resource type is C<fleet> and the unique
94 identifier is the fleet name. Example: C<fleet/sample-fleet>.
95  
96 =item *
97  
98 DynamoDB table - The resource type is C<table> and the unique
99 identifier is the table name. Example: C<table/my-table>.
100  
101 =item *
102  
103 DynamoDB global secondary index - The resource type is C<index> and the
104 unique identifier is the index name. Example:
105 C<table/my-table/index/my-table-index>.
106  
107 =item *
108  
109 Aurora DB cluster - The resource type is C<cluster> and the unique
110 identifier is the cluster name. Example: C<cluster:my-db-cluster>.
111  
112 =item *
113  
114 Amazon SageMaker endpoint variant - The resource type is C<variant> and
115 the unique identifier is the resource ID. Example:
116 C<endpoint/my-end-point/variant/KMeansClustering>.
117  
118 =item *
119  
120 Custom resources are not supported with a resource type. This parameter
121 must specify the C<OutputValue> from the CloudFormation template stack
122 used to access the resources. The unique identifier is defined by the
123 service provider. More information is available in our GitHub
124 repository (https://github.com/aws/aws-auto-scaling-custom-resource).
125  
126 =item *
127  
128 Amazon Comprehend document classification endpoint - The resource type
129 and unique identifier are specified using the endpoint ARN. Example:
130 C<arn:aws:comprehend:us-west-2:123456789012:document-classifier-endpoint/EXAMPLE>.
131  
132 =item *
133  
134 Amazon Comprehend entity recognizer endpoint - The resource type and
135 unique identifier are specified using the endpoint ARN. Example:
136 C<arn:aws:comprehend:us-west-2:123456789012:entity-recognizer-endpoint/EXAMPLE>.
137  
138 =item *
139  
140 Lambda provisioned concurrency - The resource type is C<function> and
141 the unique identifier is the function name with a function version or
142 alias name suffix that is not C<$LATEST>. Example:
143 C<function:my-function:prod> or C<function:my-function:1>.
144  
145 =item *
146  
147 Amazon Keyspaces table - The resource type is C<table> and the unique
148 identifier is the table name. Example:
149 C<keyspace/mykeyspace/table/mytable>.
150  
151 =item *
152  
153 Amazon MSK cluster - The resource type and unique identifier are
154 specified using the cluster ARN. Example:
155 C<arn:aws:kafka:us-east-1:123456789012:cluster/demo-cluster-1/6357e0b2-0e6a-4b86-a0b4-70df934c2e31-5>.
156  
157 =back
158  
159  
160  
161  
162 =head2 B<REQUIRED> ScalableDimension => Str
163  
164 The scalable dimension. This string consists of the service namespace,
165 resource type, and scaling property.
166  
167 =over
168  
169 =item *
170  
171 C<ecs:service:DesiredCount> - The desired task count of an ECS service.
172  
173 =item *
174  
175 C<ec2:spot-fleet-request:TargetCapacity> - The target capacity of a
176 Spot Fleet request.
177  
178 =item *
179  
180 C<elasticmapreduce:instancegroup:InstanceCount> - The instance count of
181 an EMR Instance Group.
182  
183 =item *
184  
185 C<appstream:fleet:DesiredCapacity> - The desired capacity of an
186 AppStream 2.0 fleet.
187  
188 =item *
189  
190 C<dynamodb:table:ReadCapacityUnits> - The provisioned read capacity for
191 a DynamoDB table.
192  
193 =item *
194  
195 C<dynamodb:table:WriteCapacityUnits> - The provisioned write capacity
196 for a DynamoDB table.
197  
198 =item *
199  
200 C<dynamodb:index:ReadCapacityUnits> - The provisioned read capacity for
201 a DynamoDB global secondary index.
202  
203 =item *
204  
205 C<dynamodb:index:WriteCapacityUnits> - The provisioned write capacity
206 for a DynamoDB global secondary index.
207  
208 =item *
209  
210 C<rds:cluster:ReadReplicaCount> - The count of Aurora Replicas in an
211 Aurora DB cluster. Available for Aurora MySQL-compatible edition and
212 Aurora PostgreSQL-compatible edition.
213  
214 =item *
215  
216 C<sagemaker:variant:DesiredInstanceCount> - The number of EC2 instances
217 for an Amazon SageMaker model endpoint variant.
218  
219 =item *
220  
221 C<custom-resource:ResourceType:Property> - The scalable dimension for a
222 custom resource provided by your own application or service.
223  
224 =item *
225  
226 C<comprehend:document-classifier-endpoint:DesiredInferenceUnits> - The
227 number of inference units for an Amazon Comprehend document
228 classification endpoint.
229  
230 =item *
231  
232 C<comprehend:entity-recognizer-endpoint:DesiredInferenceUnits> - The
233 number of inference units for an Amazon Comprehend entity recognizer
234 endpoint.
235  
236 =item *
237  
238 C<lambda:function:ProvisionedConcurrency> - The provisioned concurrency
239 for a Lambda function.
240  
241 =item *
242  
243 C<cassandra:table:ReadCapacityUnits> - The provisioned read capacity
244 for an Amazon Keyspaces table.
245  
246 =item *
247  
248 C<cassandra:table:WriteCapacityUnits> - The provisioned write capacity
249 for an Amazon Keyspaces table.
250  
251 =item *
252  
253 C<kafka:broker-storage:VolumeSize> - The provisioned volume size (in
254 GiB) for brokers in an Amazon MSK cluster.
255  
256 =back
257  
258  
259 Valid values are: C<"ecs:service:DesiredCount">, C<"ec2:spot-fleet-request:TargetCapacity">, C<"elasticmapreduce:instancegroup:InstanceCount">, C<"appstream:fleet:DesiredCapacity">, C<"dynamodb:table:ReadCapacityUnits">, C<"dynamodb:table:WriteCapacityUnits">, C<"dynamodb:index:ReadCapacityUnits">, C<"dynamodb:index:WriteCapacityUnits">, C<"rds:cluster:ReadReplicaCount">, C<"sagemaker:variant:DesiredInstanceCount">, C<"custom-resource:ResourceType:Property">, C<"comprehend:document-classifier-endpoint:DesiredInferenceUnits">, C<"comprehend:entity-recognizer-endpoint:DesiredInferenceUnits">, C<"lambda:function:ProvisionedConcurrency">, C<"cassandra:table:ReadCapacityUnits">, C<"cassandra:table:WriteCapacityUnits">, C<"kafka:broker-storage:VolumeSize">
260  
261 =head2 ScalableTargetAction => L<Paws::ApplicationAutoScaling::ScalableTargetAction>
262  
263 The new minimum and maximum capacity. You can set both values or just
264 one. At the scheduled time, if the current capacity is below the
265 minimum capacity, Application Auto Scaling scales out to the minimum
266 capacity. If the current capacity is above the maximum capacity,
267 Application Auto Scaling scales in to the maximum capacity.
268  
269  
270  
271 =head2 Schedule => Str
272  
273 The schedule for this action. The following formats are supported:
274  
275 =over
276  
277 =item *
278  
279 At expressions - "C<at(I<yyyy>-I<mm>-I<dd>TI<hh>:I<mm>:I<ss>)>"
280  
281 =item *
282  
283 Rate expressions - "C<rate(I<value> I<unit>)>"
284  
285 =item *
286  
287 Cron expressions - "C<cron(I<fields>)>"
288  
289 =back
290  
291 At expressions are useful for one-time schedules. Cron expressions are
292 useful for scheduled actions that run periodically at a specified date
293 and time, and rate expressions are useful for scheduled actions that
294 run at a regular interval.
295  
296 At and cron expressions use Universal Coordinated Time (UTC) by
297 default.
298  
299 The cron format consists of six fields separated by white spaces:
300 [Minutes] [Hours] [Day_of_Month] [Month] [Day_of_Week] [Year].
301  
302 For rate expressions, I<value> is a positive integer and I<unit> is
303 C<minute> | C<minutes> | C<hour> | C<hours> | C<day> | C<days>.
304  
305 For more information and examples, see Example scheduled actions for
306 Application Auto Scaling
307 (https://docs.aws.amazon.com/autoscaling/application/userguide/examples-scheduled-actions.html)
308 in the I<Application Auto Scaling User Guide>.
309  
310  
311  
312 =head2 B<REQUIRED> ScheduledActionName => Str
313  
314 The name of the scheduled action. This name must be unique among all
315 other scheduled actions on the specified scalable target.
316  
317  
318  
319 =head2 B<REQUIRED> ServiceNamespace => Str
320  
321 The namespace of the AWS service that provides the resource. For a
322 resource provided by your own application or service, use
323 C<custom-resource> instead.
324  
325 Valid values are: C<"ecs">, C<"elasticmapreduce">, C<"ec2">, C<"appstream">, C<"dynamodb">, C<"rds">, C<"sagemaker">, C<"custom-resource">, C<"comprehend">, C<"lambda">, C<"cassandra">, C<"kafka">
326  
327 =head2 StartTime => Str
328  
329 The date and time for this scheduled action to start, in UTC.
330  
331  
332  
333 =head2 Timezone => Str
334  
335 Specifies the time zone used when setting a scheduled action by using
336 an at or cron expression. If a time zone is not provided, UTC is used
337 by default.
338  
339 Valid values are the canonical names of the IANA time zones supported
340 by Joda-Time (such as C<Etc/GMT+9> or C<Pacific/Tahiti>). For more
341 information, see https://www.joda.org/joda-time/timezones.html
342 (https://www.joda.org/joda-time/timezones.html).
343  
344  
345  
346  
347 =head1 SEE ALSO
348  
349 This class forms part of L<Paws>, documenting arguments for method PutScheduledAction in L<Paws::ApplicationAutoScaling>
350  
351 =head1 BUGS and CONTRIBUTIONS
352  
353 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
354  
355 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
356  
357 =cut
358