« blib/lib/Paws/ECS/AwsVpcConfiguration.pm
↑ Summary
blib/lib/Paws/ECS/CapacityProviderStrategyItem.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::ECS::CapacityProvider; | ||
| 3 | use Moose; | ||
| 4 | has AutoScalingGroupProvider => (is => 'ro', isa => 'Paws::ECS::AutoScalingGroupProvider', request_name => 'autoScalingGroupProvider', traits => ['NameInRequest']); | ||
| 5 | has CapacityProviderArn => (is => 'ro', isa => 'Str', request_name => 'capacityProviderArn', traits => ['NameInRequest']); | ||
| 6 | has Name => (is => 'ro', isa => 'Str', request_name => 'name', traits => ['NameInRequest']); | ||
| 7 | has Status => (is => 'ro', isa => 'Str', request_name => 'status', traits => ['NameInRequest']); | ||
| 8 | has Tags => (is => 'ro', isa => 'ArrayRef[Paws::ECS::Tag]', request_name => 'tags', traits => ['NameInRequest']); | ||
| 9 | has UpdateStatus => (is => 'ro', isa => 'Str', request_name => 'updateStatus', traits => ['NameInRequest']); | ||
| 10 | has UpdateStatusReason => (is => 'ro', isa => 'Str', request_name => 'updateStatusReason', traits => ['NameInRequest']); | ||
| 11 | |||
| 12 | 1; | ||
| 13 | |||
| 14 | ### main pod documentation begin ### | ||
| 15 | |||
| 16 | =head1 NAME | ||
| 17 | |||
| 18 | Paws::ECS::CapacityProvider | ||
| 19 | |||
| 20 | =head1 USAGE | ||
| 21 | |||
| 22 | This class represents one of two things: | ||
| 23 | |||
| 24 | =head3 Arguments in a call to a service | ||
| 25 | |||
| 26 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 27 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 28 | |||
| 29 | As an example, if Att1 is expected to be a Paws::ECS::CapacityProvider object: | ||
| 30 | |||
| 31 | $service_obj->Method(Att1 => { AutoScalingGroupProvider => $value, ..., UpdateStatusReason => $value }); | ||
| 32 | |||
| 33 | =head3 Results returned from an API call | ||
| 34 | |||
| 35 | Use accessors for each attribute. If Att1 is expected to be an Paws::ECS::CapacityProvider object: | ||
| 36 | |||
| 37 | $result = $service_obj->Method(...); | ||
| 38 | $result->Att1->AutoScalingGroupProvider | ||
| 39 | |||
| 40 | =head1 DESCRIPTION | ||
| 41 | |||
| 42 | The details of a capacity provider. | ||
| 43 | |||
| 44 | =head1 ATTRIBUTES | ||
| 45 | |||
| 46 | |||
| 47 | =head2 AutoScalingGroupProvider => L<Paws::ECS::AutoScalingGroupProvider> | ||
| 48 | |||
| 49 | The Auto Scaling group settings for the capacity provider. | ||
| 50 | |||
| 51 | |||
| 52 | =head2 CapacityProviderArn => Str | ||
| 53 | |||
| 54 | The Amazon Resource Name (ARN) that identifies the capacity provider. | ||
| 55 | |||
| 56 | |||
| 57 | =head2 Name => Str | ||
| 58 | |||
| 59 | The name of the capacity provider. | ||
| 60 | |||
| 61 | |||
| 62 | =head2 Status => Str | ||
| 63 | |||
| 64 | The current status of the capacity provider. Only capacity providers in | ||
| 65 | an C<ACTIVE> state can be used in a cluster. When a capacity provider | ||
| 66 | is successfully deleted, it will have an C<INACTIVE> status. | ||
| 67 | |||
| 68 | |||
| 69 | =head2 Tags => ArrayRef[L<Paws::ECS::Tag>] | ||
| 70 | |||
| 71 | The metadata that you apply to the capacity provider to help you | ||
| 72 | categorize and organize it. Each tag consists of a key and an optional | ||
| 73 | value, both of which you define. | ||
| 74 | |||
| 75 | The following basic restrictions apply to tags: | ||
| 76 | |||
| 77 | =over | ||
| 78 | |||
| 79 | =item * | ||
| 80 | |||
| 81 | Maximum number of tags per resource - 50 | ||
| 82 | |||
| 83 | =item * | ||
| 84 | |||
| 85 | For each resource, each tag key must be unique, and each tag key can | ||
| 86 | have only one value. | ||
| 87 | |||
| 88 | =item * | ||
| 89 | |||
| 90 | Maximum key length - 128 Unicode characters in UTF-8 | ||
| 91 | |||
| 92 | =item * | ||
| 93 | |||
| 94 | Maximum value length - 256 Unicode characters in UTF-8 | ||
| 95 | |||
| 96 | =item * | ||
| 97 | |||
| 98 | If your tagging schema is used across multiple services and resources, | ||
| 99 | remember that other services may have restrictions on allowed | ||
| 100 | characters. Generally allowed characters are: letters, numbers, and | ||
| 101 | spaces representable in UTF-8, and the following characters: + - = . _ | ||
| 102 | : / @. | ||
| 103 | |||
| 104 | =item * | ||
| 105 | |||
| 106 | Tag keys and values are case-sensitive. | ||
| 107 | |||
| 108 | =item * | ||
| 109 | |||
| 110 | Do not use C<aws:>, C<AWS:>, or any upper or lowercase combination of | ||
| 111 | such as a prefix for either keys or values as it is reserved for AWS | ||
| 112 | use. You cannot edit or delete tag keys or values with this prefix. | ||
| 113 | Tags with this prefix do not count against your tags per resource | ||
| 114 | limit. | ||
| 115 | |||
| 116 | =back | ||
| 117 | |||
| 118 | |||
| 119 | |||
| 120 | =head2 UpdateStatus => Str | ||
| 121 | |||
| 122 | The update status of the capacity provider. The following are the | ||
| 123 | possible states that will be returned. | ||
| 124 | |||
| 125 | =over | ||
| 126 | |||
| 127 | =item DELETE_IN_PROGRESS | ||
| 128 | |||
| 129 | The capacity provider is in the process of being deleted. | ||
| 130 | |||
| 131 | =item DELETE_COMPLETE | ||
| 132 | |||
| 133 | The capacity provider has been successfully deleted and will have an | ||
| 134 | C<INACTIVE> status. | ||
| 135 | |||
| 136 | =item DELETE_FAILED | ||
| 137 | |||
| 138 | The capacity provider was unable to be deleted. The update status | ||
| 139 | reason will provide further details about why the delete failed. | ||
| 140 | |||
| 141 | =back | ||
| 142 | |||
| 143 | |||
| 144 | |||
| 145 | =head2 UpdateStatusReason => Str | ||
| 146 | |||
| 147 | The update status reason. This provides further details about the | ||
| 148 | update status for the capacity provider. | ||
| 149 | |||
| 150 | |||
| 151 | |||
| 152 | =head1 SEE ALSO | ||
| 153 | |||
| 154 | This class forms part of L<Paws>, describing an object used in L<Paws::ECS> | ||
| 155 | |||
| 156 | =head1 BUGS and CONTRIBUTIONS | ||
| 157 | |||
| 158 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 159 | |||
| 160 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 161 | |||
| 162 | =cut | ||
| 163 |