File Coverage

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