« blib/lib/Paws/ECS/PutAttributesResponse.pm
↑ Summary
blib/lib/Paws/ECS/PutClusterCapacityProvidersResponse.pm »
| 1 | |||
| 2 | package Paws::ECS::PutClusterCapacityProviders; | ||
| 3 | use Moose; | ||
| 4 | has CapacityProviders => (is => 'ro', isa => 'ArrayRef[Str|Undef]', traits => ['NameInRequest'], request_name => 'capacityProviders' , required => 1); | ||
| 5 | has Cluster => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'cluster' , required => 1); | ||
| 6 | has DefaultCapacityProviderStrategy => (is => 'ro', isa => 'ArrayRef[Paws::ECS::CapacityProviderStrategyItem]', traits => ['NameInRequest'], request_name => 'defaultCapacityProviderStrategy' , required => 1); | ||
| 7 | |||
| 8 | use MooseX::ClassAttribute; | ||
| 9 | |||
| 10 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'PutClusterCapacityProviders'); | ||
| 11 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::ECS::PutClusterCapacityProvidersResponse'); | ||
| 12 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 13 | 1; | ||
| 14 | |||
| 15 | ### main pod documentation begin ### | ||
| 16 | |||
| 17 | =head1 NAME | ||
| 18 | |||
| 19 | Paws::ECS::PutClusterCapacityProviders - Arguments for method PutClusterCapacityProviders on L<Paws::ECS> | ||
| 20 | |||
| 21 | =head1 DESCRIPTION | ||
| 22 | |||
| 23 | This class represents the parameters used for calling the method PutClusterCapacityProviders on the | ||
| 24 | L<Amazon EC2 Container Service|Paws::ECS> service. Use the attributes of this class | ||
| 25 | as arguments to method PutClusterCapacityProviders. | ||
| 26 | |||
| 27 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to PutClusterCapacityProviders. | ||
| 28 | |||
| 29 | =head1 SYNOPSIS | ||
| 30 | |||
| 31 | my $ecs = Paws->service('ECS'); | ||
| 32 | my $PutClusterCapacityProvidersResponse = $ecs->PutClusterCapacityProviders( | ||
| 33 | CapacityProviders => [ 'MyString', ... ], | ||
| 34 | Cluster => 'MyString', | ||
| 35 | DefaultCapacityProviderStrategy => [ | ||
| 36 | { | ||
| 37 | CapacityProvider => 'MyString', | ||
| 38 | Base => 1, # max: 100000; OPTIONAL | ||
| 39 | Weight => 1, # max: 1000; OPTIONAL | ||
| 40 | }, | ||
| 41 | ... | ||
| 42 | ], | ||
| 43 | |||
| 44 | ); | ||
| 45 | |||
| 46 | # Results: | ||
| 47 | my $Cluster = $PutClusterCapacityProvidersResponse->Cluster; | ||
| 48 | |||
| 49 | # Returns a L<Paws::ECS::PutClusterCapacityProvidersResponse> object. | ||
| 50 | |||
| 51 | 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. | ||
| 52 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/ecs/PutClusterCapacityProviders> | ||
| 53 | |||
| 54 | =head1 ATTRIBUTES | ||
| 55 | |||
| 56 | |||
| 57 | =head2 B<REQUIRED> CapacityProviders => ArrayRef[Str|Undef] | ||
| 58 | |||
| 59 | The name of one or more capacity providers to associate with the | ||
| 60 | cluster. | ||
| 61 | |||
| 62 | If specifying a capacity provider that uses an Auto Scaling group, the | ||
| 63 | capacity provider must already be created. New capacity providers can | ||
| 64 | be created with the CreateCapacityProvider API operation. | ||
| 65 | |||
| 66 | To use a AWS Fargate capacity provider, specify either the C<FARGATE> | ||
| 67 | or C<FARGATE_SPOT> capacity providers. The AWS Fargate capacity | ||
| 68 | providers are available to all accounts and only need to be associated | ||
| 69 | with a cluster to be used. | ||
| 70 | |||
| 71 | |||
| 72 | |||
| 73 | =head2 B<REQUIRED> Cluster => Str | ||
| 74 | |||
| 75 | The short name or full Amazon Resource Name (ARN) of the cluster to | ||
| 76 | modify the capacity provider settings for. If you do not specify a | ||
| 77 | cluster, the default cluster is assumed. | ||
| 78 | |||
| 79 | |||
| 80 | |||
| 81 | =head2 B<REQUIRED> DefaultCapacityProviderStrategy => ArrayRef[L<Paws::ECS::CapacityProviderStrategyItem>] | ||
| 82 | |||
| 83 | The capacity provider strategy to use by default for the cluster. | ||
| 84 | |||
| 85 | When creating a service or running a task on a cluster, if no capacity | ||
| 86 | provider or launch type is specified then the default capacity provider | ||
| 87 | strategy for the cluster is used. | ||
| 88 | |||
| 89 | A capacity provider strategy consists of one or more capacity providers | ||
| 90 | along with the C<base> and C<weight> to assign to them. A capacity | ||
| 91 | provider must be associated with the cluster to be used in a capacity | ||
| 92 | provider strategy. The PutClusterCapacityProviders API is used to | ||
| 93 | associate a capacity provider with a cluster. Only capacity providers | ||
| 94 | with an C<ACTIVE> or C<UPDATING> status can be used. | ||
| 95 | |||
| 96 | If specifying a capacity provider that uses an Auto Scaling group, the | ||
| 97 | capacity provider must already be created. New capacity providers can | ||
| 98 | be created with the CreateCapacityProvider API operation. | ||
| 99 | |||
| 100 | To use a AWS Fargate capacity provider, specify either the C<FARGATE> | ||
| 101 | or C<FARGATE_SPOT> capacity providers. The AWS Fargate capacity | ||
| 102 | providers are available to all accounts and only need to be associated | ||
| 103 | with a cluster to be used. | ||
| 104 | |||
| 105 | |||
| 106 | |||
| 107 | |||
| 108 | =head1 SEE ALSO | ||
| 109 | |||
| 110 | This class forms part of L<Paws>, documenting arguments for method PutClusterCapacityProviders in L<Paws::ECS> | ||
| 111 | |||
| 112 | =head1 BUGS and CONTRIBUTIONS | ||
| 113 | |||
| 114 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 115 | |||
| 116 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 117 | |||
| 118 | =cut | ||
| 119 |