File Coverage

blib/lib/Paws/ApplicationAutoScaling/RegisterScalableTarget.pm
Criterion Covered Total %
statement 6 6 100.0
branch n/a
condition n/a
subroutine 2 2 100.0
pod n/a
total 8 8 100.0


line stmt bran cond sub pod time code
1              
2             package Paws::ApplicationAutoScaling::RegisterScalableTarget;
3 1     1   368 use Moose;
  1         2  
  1         6  
4             has MaxCapacity => (is => 'ro', isa => 'Int');
5             has MinCapacity => (is => 'ro', isa => 'Int');
6             has ResourceId => (is => 'ro', isa => 'Str', required => 1);
7             has RoleARN => (is => 'ro', isa => 'Str');
8             has ScalableDimension => (is => 'ro', isa => 'Str', required => 1);
9             has ServiceNamespace => (is => 'ro', isa => 'Str', required => 1);
10              
11 1     1   5674 use MooseX::ClassAttribute;
  1         3  
  1         8  
12              
13             class_has _api_call => (isa => 'Str', is => 'ro', default => 'RegisterScalableTarget');
14             class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::ApplicationAutoScaling::RegisterScalableTargetResponse');
15             class_has _result_key => (isa => 'Str', is => 'ro');
16             1;
17              
18             ### main pod documentation begin ###
19              
20             =head1 NAME
21              
22             Paws::ApplicationAutoScaling::RegisterScalableTarget - Arguments for method RegisterScalableTarget on Paws::ApplicationAutoScaling
23              
24             =head1 DESCRIPTION
25              
26             This class represents the parameters used for calling the method RegisterScalableTarget on the
27             Application Auto Scaling service. Use the attributes of this class
28             as arguments to method RegisterScalableTarget.
29              
30             You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to RegisterScalableTarget.
31              
32             As an example:
33              
34             $service_obj->RegisterScalableTarget(Att1 => $value1, Att2 => $value2, ...);
35              
36             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.
37              
38             =head1 ATTRIBUTES
39              
40              
41             =head2 MaxCapacity => Int
42              
43             The maximum value to scale to in response to a scale out event. This
44             parameter is required if you are registering a scalable target and
45             optional if you are updating one.
46              
47              
48              
49             =head2 MinCapacity => Int
50              
51             The minimum value to scale to in response to a scale in event. This
52             parameter is required if you are registering a scalable target and
53             optional if you are updating one.
54              
55              
56              
57             =head2 B<REQUIRED> ResourceId => Str
58              
59             The identifier of the resource associated with the scalable target.
60             This string consists of the resource type and unique identifier.
61              
62             =over
63              
64             =item *
65              
66             ECS service - The resource type is C<service> and the unique identifier
67             is the cluster name and service name. Example:
68             C<service/default/sample-webapp>.
69              
70             =item *
71              
72             Spot fleet request - The resource type is C<spot-fleet-request> and the
73             unique identifier is the Spot fleet request ID. Example:
74             C<spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE>.
75              
76             =item *
77              
78             EMR cluster - The resource type is C<instancegroup> and the unique
79             identifier is the cluster ID and instance group ID. Example:
80             C<instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0>.
81              
82             =item *
83              
84             AppStream 2.0 fleet - The resource type is C<fleet> and the unique
85             identifier is the fleet name. Example: C<fleet/sample-fleet>.
86              
87             =item *
88              
89             DynamoDB table - The resource type is C<table> and the unique
90             identifier is the resource ID. Example: C<table/my-table>.
91              
92             =item *
93              
94             DynamoDB global secondary index - The resource type is C<index> and the
95             unique identifier is the resource ID. Example:
96             C<table/my-table/index/my-table-index>.
97              
98             =back
99              
100              
101              
102              
103             =head2 RoleARN => Str
104              
105             The ARN of an IAM role that allows Application Auto Scaling to modify
106             the scalable target on your behalf. This parameter is required when you
107             register a scalable target and optional when you update one.
108              
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             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">
161              
162             =head2 B<REQUIRED> ServiceNamespace => Str
163              
164             The namespace of the AWS service. For more information, see AWS Service
165             Namespaces in the I<Amazon Web Services General Reference>.
166              
167             Valid values are: C<"ecs">, C<"elasticmapreduce">, C<"ec2">, C<"appstream">, C<"dynamodb">
168              
169              
170             =head1 SEE ALSO
171              
172             This class forms part of L<Paws>, documenting arguments for method RegisterScalableTarget in L<Paws::ApplicationAutoScaling>
173              
174             =head1 BUGS and CONTRIBUTIONS
175              
176             The source code is located here: https://github.com/pplu/aws-sdk-perl
177              
178             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
179              
180             =cut
181