« blib/lib/Paws/ECS/ContainerStateChange.pm
↑ Summary
blib/lib/Paws/ECS/CreateCapacityProviderResponse.pm »
| 1 | |||
| 2 | package Paws::ECS::CreateCapacityProvider; | ||
| 3 | use Moose; | ||
| 4 | has AutoScalingGroupProvider => (is => 'ro', isa => 'Paws::ECS::AutoScalingGroupProvider', traits => ['NameInRequest'], request_name => 'autoScalingGroupProvider' , required => 1); | ||
| 5 | has Name => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'name' , required => 1); | ||
| 6 | has Tags => (is => 'ro', isa => 'ArrayRef[Paws::ECS::Tag]', traits => ['NameInRequest'], request_name => 'tags' ); | ||
| 7 | |||
| 8 | use MooseX::ClassAttribute; | ||
| 9 | |||
| 10 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateCapacityProvider'); | ||
| 11 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::ECS::CreateCapacityProviderResponse'); | ||
| 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::CreateCapacityProvider - Arguments for method CreateCapacityProvider on L<Paws::ECS> | ||
| 20 | |||
| 21 | =head1 DESCRIPTION | ||
| 22 | |||
| 23 | This class represents the parameters used for calling the method CreateCapacityProvider on the | ||
| 24 | L<Amazon EC2 Container Service|Paws::ECS> service. Use the attributes of this class | ||
| 25 | as arguments to method CreateCapacityProvider. | ||
| 26 | |||
| 27 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateCapacityProvider. | ||
| 28 | |||
| 29 | =head1 SYNOPSIS | ||
| 30 | |||
| 31 | my $ecs = Paws->service('ECS'); | ||
| 32 | my $CreateCapacityProviderResponse = $ecs->CreateCapacityProvider( | ||
| 33 | AutoScalingGroupProvider => { | ||
| 34 | AutoScalingGroupArn => 'MyString', | ||
| 35 | ManagedScaling => { | ||
| 36 | InstanceWarmupPeriod => 1, # max: 10000; OPTIONAL | ||
| 37 | MaximumScalingStepSize => 1, # min: 1, max: 10000; OPTIONAL | ||
| 38 | MinimumScalingStepSize => 1, # min: 1, max: 10000; OPTIONAL | ||
| 39 | Status => 'ENABLED', # values: ENABLED, DISABLED; OPTIONAL | ||
| 40 | TargetCapacity => 1, # min: 1, max: 100; OPTIONAL | ||
| 41 | }, # OPTIONAL | ||
| 42 | ManagedTerminationProtection => | ||
| 43 | 'ENABLED', # values: ENABLED, DISABLED; OPTIONAL | ||
| 44 | }, | ||
| 45 | Name => 'MyString', | ||
| 46 | Tags => [ | ||
| 47 | { | ||
| 48 | Key => 'MyTagKey', # min: 1, max: 128; OPTIONAL | ||
| 49 | Value => 'MyTagValue', # max: 256; OPTIONAL | ||
| 50 | }, | ||
| 51 | ... | ||
| 52 | ], # OPTIONAL | ||
| 53 | ); | ||
| 54 | |||
| 55 | # Results: | ||
| 56 | my $CapacityProvider = $CreateCapacityProviderResponse->CapacityProvider; | ||
| 57 | |||
| 58 | # Returns a L<Paws::ECS::CreateCapacityProviderResponse> object. | ||
| 59 | |||
| 60 | 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. | ||
| 61 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/ecs/CreateCapacityProvider> | ||
| 62 | |||
| 63 | =head1 ATTRIBUTES | ||
| 64 | |||
| 65 | |||
| 66 | =head2 B<REQUIRED> AutoScalingGroupProvider => L<Paws::ECS::AutoScalingGroupProvider> | ||
| 67 | |||
| 68 | The details of the Auto Scaling group for the capacity provider. | ||
| 69 | |||
| 70 | |||
| 71 | |||
| 72 | =head2 B<REQUIRED> Name => Str | ||
| 73 | |||
| 74 | The name of the capacity provider. Up to 255 characters are allowed, | ||
| 75 | including letters (upper and lowercase), numbers, underscores, and | ||
| 76 | hyphens. The name cannot be prefixed with "C<aws>", "C<ecs>", or | ||
| 77 | "C<fargate>". | ||
| 78 | |||
| 79 | |||
| 80 | |||
| 81 | =head2 Tags => ArrayRef[L<Paws::ECS::Tag>] | ||
| 82 | |||
| 83 | The metadata that you apply to the capacity provider to help you | ||
| 84 | categorize and organize them. Each tag consists of a key and an | ||
| 85 | optional value, both of which you define. | ||
| 86 | |||
| 87 | The following basic restrictions apply to tags: | ||
| 88 | |||
| 89 | =over | ||
| 90 | |||
| 91 | =item * | ||
| 92 | |||
| 93 | Maximum number of tags per resource - 50 | ||
| 94 | |||
| 95 | =item * | ||
| 96 | |||
| 97 | For each resource, each tag key must be unique, and each tag key can | ||
| 98 | have only one value. | ||
| 99 | |||
| 100 | =item * | ||
| 101 | |||
| 102 | Maximum key length - 128 Unicode characters in UTF-8 | ||
| 103 | |||
| 104 | =item * | ||
| 105 | |||
| 106 | Maximum value length - 256 Unicode characters in UTF-8 | ||
| 107 | |||
| 108 | =item * | ||
| 109 | |||
| 110 | If your tagging schema is used across multiple services and resources, | ||
| 111 | remember that other services may have restrictions on allowed | ||
| 112 | characters. Generally allowed characters are: letters, numbers, and | ||
| 113 | spaces representable in UTF-8, and the following characters: + - = . _ | ||
| 114 | : / @. | ||
| 115 | |||
| 116 | =item * | ||
| 117 | |||
| 118 | Tag keys and values are case-sensitive. | ||
| 119 | |||
| 120 | =item * | ||
| 121 | |||
| 122 | Do not use C<aws:>, C<AWS:>, or any upper or lowercase combination of | ||
| 123 | such as a prefix for either keys or values as it is reserved for AWS | ||
| 124 | use. You cannot edit or delete tag keys or values with this prefix. | ||
| 125 | Tags with this prefix do not count against your tags per resource | ||
| 126 | limit. | ||
| 127 | |||
| 128 | =back | ||
| 129 | |||
| 130 | |||
| 131 | |||
| 132 | |||
| 133 | |||
| 134 | =head1 SEE ALSO | ||
| 135 | |||
| 136 | This class forms part of L<Paws>, documenting arguments for method CreateCapacityProvider in L<Paws::ECS> | ||
| 137 | |||
| 138 | =head1 BUGS and CONTRIBUTIONS | ||
| 139 | |||
| 140 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 141 | |||
| 142 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 143 | |||
| 144 | =cut | ||
| 145 |