File Coverage

blib/lib/Paws/ApplicationAutoScaling/ScalingActivity.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 bran cond sub pod time code
1             package Paws::ApplicationAutoScaling::ScalingActivity;
2 1     1   486 use Moose;
  1         3  
  1         8  
3             has ActivityId => (is => 'ro', isa => 'Str', required => 1);
4             has Cause => (is => 'ro', isa => 'Str', required => 1);
5             has Description => (is => 'ro', isa => 'Str', required => 1);
6             has Details => (is => 'ro', isa => 'Str');
7             has EndTime => (is => 'ro', isa => 'Str');
8             has ResourceId => (is => 'ro', isa => 'Str', required => 1);
9             has ScalableDimension => (is => 'ro', isa => 'Str', required => 1);
10             has ServiceNamespace => (is => 'ro', isa => 'Str', required => 1);
11             has StartTime => (is => 'ro', isa => 'Str', required => 1);
12             has StatusCode => (is => 'ro', isa => 'Str', required => 1);
13             has StatusMessage => (is => 'ro', isa => 'Str');
14             1;
15              
16             ### main pod documentation begin ###
17              
18             =head1 NAME
19              
20             Paws::ApplicationAutoScaling::ScalingActivity
21              
22             =head1 USAGE
23              
24             This class represents one of two things:
25              
26             =head3 Arguments in a call to a service
27              
28             Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
29             Each attribute should be used as a named argument in the calls that expect this type of object.
30              
31             As an example, if Att1 is expected to be a Paws::ApplicationAutoScaling::ScalingActivity object:
32              
33             $service_obj->Method(Att1 => { ActivityId => $value, ..., StatusMessage => $value });
34              
35             =head3 Results returned from an API call
36              
37             Use accessors for each attribute. If Att1 is expected to be an Paws::ApplicationAutoScaling::ScalingActivity object:
38              
39             $result = $service_obj->Method(...);
40             $result->Att1->ActivityId
41              
42             =head1 DESCRIPTION
43              
44             Represents a scaling activity.
45              
46             =head1 ATTRIBUTES
47              
48              
49             =head2 B<REQUIRED> ActivityId => Str
50              
51             The unique identifier of the scaling activity.
52              
53              
54             =head2 B<REQUIRED> Cause => Str
55              
56             A simple description of what caused the scaling activity to happen.
57              
58              
59             =head2 B<REQUIRED> Description => Str
60              
61             A simple description of what action the scaling activity intends to
62             accomplish.
63              
64              
65             =head2 Details => Str
66              
67             The details about the scaling activity.
68              
69              
70             =head2 EndTime => Str
71              
72             The Unix timestamp for when the scaling activity ended.
73              
74              
75             =head2 B<REQUIRED> ResourceId => Str
76              
77             The identifier of the resource associated with the scaling activity.
78             This string consists of the resource type and unique identifier.
79              
80             =over
81              
82             =item *
83              
84             ECS service - The resource type is C<service> and the unique identifier
85             is the cluster name and service name. Example:
86             C<service/default/sample-webapp>.
87              
88             =item *
89              
90             Spot fleet request - The resource type is C<spot-fleet-request> and the
91             unique identifier is the Spot fleet request ID. Example:
92             C<spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE>.
93              
94             =item *
95              
96             EMR cluster - The resource type is C<instancegroup> and the unique
97             identifier is the cluster ID and instance group ID. Example:
98             C<instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0>.
99              
100             =item *
101              
102             AppStream 2.0 fleet - The resource type is C<fleet> and the unique
103             identifier is the fleet name. Example: C<fleet/sample-fleet>.
104              
105             =item *
106              
107             DynamoDB table - The resource type is C<table> and the unique
108             identifier is the resource ID. Example: C<table/my-table>.
109              
110             =item *
111              
112             DynamoDB global secondary index - The resource type is C<index> and the
113             unique identifier is the resource ID. Example:
114             C<table/my-table/index/my-table-index>.
115              
116             =back
117              
118              
119              
120             =head2 B<REQUIRED> ScalableDimension => Str
121              
122             The scalable dimension. This string consists of the service namespace,
123             resource type, and scaling property.
124              
125             =over
126              
127             =item *
128              
129             C<ecs:service:DesiredCount> - The desired task count of an ECS service.
130              
131             =item *
132              
133             C<ec2:spot-fleet-request:TargetCapacity> - The target capacity of a
134             Spot fleet request.
135              
136             =item *
137              
138             C<elasticmapreduce:instancegroup:InstanceCount> - The instance count of
139             an EMR Instance Group.
140              
141             =item *
142              
143             C<appstream:fleet:DesiredCapacity> - The desired capacity of an
144             AppStream 2.0 fleet.
145              
146             =item *
147              
148             C<dynamodb:table:ReadCapacityUnits> - The provisioned read capacity for
149             a DynamoDB table.
150              
151             =item *
152              
153             C<dynamodb:table:WriteCapacityUnits> - The provisioned write capacity
154             for a DynamoDB table.
155              
156             =item *
157              
158             C<dynamodb:index:ReadCapacityUnits> - The provisioned read capacity for
159             a DynamoDB global secondary index.
160              
161             =item *
162              
163             C<dynamodb:index:WriteCapacityUnits> - The provisioned write capacity
164             for a DynamoDB global secondary index.
165              
166             =back
167              
168              
169              
170             =head2 B<REQUIRED> ServiceNamespace => Str
171              
172             The namespace of the AWS service. For more information, see AWS Service
173             Namespaces in the I<Amazon Web Services General Reference>.
174              
175              
176             =head2 B<REQUIRED> StartTime => Str
177              
178             The Unix timestamp for when the scaling activity began.
179              
180              
181             =head2 B<REQUIRED> StatusCode => Str
182              
183             Indicates the status of the scaling activity.
184              
185              
186             =head2 StatusMessage => Str
187              
188             A simple message about the current status of the scaling activity.
189              
190              
191              
192             =head1 SEE ALSO
193              
194             This class forms part of L<Paws>, describing an object used in L<Paws::ApplicationAutoScaling>
195              
196             =head1 BUGS and CONTRIBUTIONS
197              
198             The source code is located here: https://github.com/pplu/aws-sdk-perl
199              
200             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
201              
202             =cut
203