blib/lib/Paws/ECS/CapacityProviderStrategyItem.pm untested

filter: Statementstmt 0.0% 0 / 9 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 1 Podpod n/a totaltotal 0.0% 0 / 10 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
CRAP 2.0
1 # Generated by default/object.tt
2 package Paws::ECS::CapacityProviderStrategyItem;
3 use Moose;
4 has Base => (is => 'ro', isa => 'Int', request_name => 'base', traits => ['NameInRequest']);
5 has CapacityProvider => (is => 'ro', isa => 'Str', request_name => 'capacityProvider', traits => ['NameInRequest'], required => 1);
6 has Weight => (is => 'ro', isa => 'Int', request_name => 'weight', traits => ['NameInRequest']);
7  
8 1;
9  
10 ### main pod documentation begin ###
11  
12 =head1 NAME
13  
14 Paws::ECS::CapacityProviderStrategyItem
15  
16 =head1 USAGE
17  
18 This class represents one of two things:
19  
20 =head3 Arguments in a call to a service
21  
22 Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
23 Each attribute should be used as a named argument in the calls that expect this type of object.
24  
25 As an example, if Att1 is expected to be a Paws::ECS::CapacityProviderStrategyItem object:
26  
27 $service_obj->Method(Att1 => { Base => $value, ..., Weight => $value });
28  
29 =head3 Results returned from an API call
30  
31 Use accessors for each attribute. If Att1 is expected to be an Paws::ECS::CapacityProviderStrategyItem object:
32  
33 $result = $service_obj->Method(...);
34 $result->Att1->Base
35  
36 =head1 DESCRIPTION
37  
38 The details of a capacity provider strategy. A capacity provider
39 strategy can be set when using the RunTask or CreateCluster APIs or as
40 the default capacity provider strategy for a cluster with the
41 CreateCluster API.
42  
43 Only capacity providers that are already associated with a cluster and
44 have an C<ACTIVE> or C<UPDATING> status can be used in a capacity
45 provider strategy. The PutClusterCapacityProviders API is used to
46 associate a capacity provider with a cluster.
47  
48 If specifying a capacity provider that uses an Auto Scaling group, the
49 capacity provider must already be created. New Auto Scaling group
50 capacity providers can be created with the CreateCapacityProvider API
51 operation.
52  
53 To use a AWS Fargate capacity provider, specify either the C<FARGATE>
54 or C<FARGATE_SPOT> capacity providers. The AWS Fargate capacity
55 providers are available to all accounts and only need to be associated
56 with a cluster to be used in a capacity provider strategy.
57  
58 =head1 ATTRIBUTES
59  
60  
61 =head2 Base => Int
62  
63 The I<base> value designates how many tasks, at a minimum, to run on
64 the specified capacity provider. Only one capacity provider in a
65 capacity provider strategy can have a I<base> defined. If no value is
66 specified, the default value of C<0> is used.
67  
68  
69 =head2 B<REQUIRED> CapacityProvider => Str
70  
71 The short name of the capacity provider.
72  
73  
74 =head2 Weight => Int
75  
76 The I<weight> value designates the relative percentage of the total
77 number of tasks launched that should use the specified capacity
78 provider. The C<weight> value is taken into consideration after the
79 C<base> value, if defined, is satisfied.
80  
81 If no C<weight> value is specified, the default value of C<0> is used.
82 When multiple capacity providers are specified within a capacity
83 provider strategy, at least one of the capacity providers must have a
84 weight value greater than zero and any capacity providers with a weight
85 of C<0> will not be used to place tasks. If you specify multiple
86 capacity providers in a strategy that all have a weight of C<0>, any
87 C<RunTask> or C<CreateService> actions using the capacity provider
88 strategy will fail.
89  
90 An example scenario for using weights is defining a strategy that
91 contains two capacity providers and both have a weight of C<1>, then
92 when the C<base> is satisfied, the tasks will be split evenly across
93 the two capacity providers. Using that same logic, if you specify a
94 weight of C<1> for I<capacityProviderA> and a weight of C<4> for
95 I<capacityProviderB>, then for every one task that is run using
96 I<capacityProviderA>, four tasks would use I<capacityProviderB>.
97  
98  
99  
100 =head1 SEE ALSO
101  
102 This class forms part of L<Paws>, describing an object used in L<Paws::ECS>
103  
104 =head1 BUGS and CONTRIBUTIONS
105  
106 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
107  
108 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
109  
110 =cut
111