| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::ECS::TaskSet; | ||
| 3 | use Moose; | ||
| 4 | has CapacityProviderStrategy => (is => 'ro', isa => 'ArrayRef[Paws::ECS::CapacityProviderStrategyItem]', request_name => 'capacityProviderStrategy', traits => ['NameInRequest']); | ||
| 5 | has ClusterArn => (is => 'ro', isa => 'Str', request_name => 'clusterArn', traits => ['NameInRequest']); | ||
| 6 | has ComputedDesiredCount => (is => 'ro', isa => 'Int', request_name => 'computedDesiredCount', traits => ['NameInRequest']); | ||
| 7 | has CreatedAt => (is => 'ro', isa => 'Str', request_name => 'createdAt', traits => ['NameInRequest']); | ||
| 8 | has ExternalId => (is => 'ro', isa => 'Str', request_name => 'externalId', traits => ['NameInRequest']); | ||
| 9 | has Id => (is => 'ro', isa => 'Str', request_name => 'id', traits => ['NameInRequest']); | ||
| 10 | has LaunchType => (is => 'ro', isa => 'Str', request_name => 'launchType', traits => ['NameInRequest']); | ||
| 11 | has LoadBalancers => (is => 'ro', isa => 'ArrayRef[Paws::ECS::LoadBalancer]', request_name => 'loadBalancers', traits => ['NameInRequest']); | ||
| 12 | has NetworkConfiguration => (is => 'ro', isa => 'Paws::ECS::NetworkConfiguration', request_name => 'networkConfiguration', traits => ['NameInRequest']); | ||
| 13 | has PendingCount => (is => 'ro', isa => 'Int', request_name => 'pendingCount', traits => ['NameInRequest']); | ||
| 14 | has PlatformVersion => (is => 'ro', isa => 'Str', request_name => 'platformVersion', traits => ['NameInRequest']); | ||
| 15 | has RunningCount => (is => 'ro', isa => 'Int', request_name => 'runningCount', traits => ['NameInRequest']); | ||
| 16 | has Scale => (is => 'ro', isa => 'Paws::ECS::Scale', request_name => 'scale', traits => ['NameInRequest']); | ||
| 17 | has ServiceArn => (is => 'ro', isa => 'Str', request_name => 'serviceArn', traits => ['NameInRequest']); | ||
| 18 | has ServiceRegistries => (is => 'ro', isa => 'ArrayRef[Paws::ECS::ServiceRegistry]', request_name => 'serviceRegistries', traits => ['NameInRequest']); | ||
| 19 | has StabilityStatus => (is => 'ro', isa => 'Str', request_name => 'stabilityStatus', traits => ['NameInRequest']); | ||
| 20 | has StabilityStatusAt => (is => 'ro', isa => 'Str', request_name => 'stabilityStatusAt', traits => ['NameInRequest']); | ||
| 21 | has StartedBy => (is => 'ro', isa => 'Str', request_name => 'startedBy', traits => ['NameInRequest']); | ||
| 22 | has Status => (is => 'ro', isa => 'Str', request_name => 'status', traits => ['NameInRequest']); | ||
| 23 | has Tags => (is => 'ro', isa => 'ArrayRef[Paws::ECS::Tag]', request_name => 'tags', traits => ['NameInRequest']); | ||
| 24 | has TaskDefinition => (is => 'ro', isa => 'Str', request_name => 'taskDefinition', traits => ['NameInRequest']); | ||
| 25 | has TaskSetArn => (is => 'ro', isa => 'Str', request_name => 'taskSetArn', traits => ['NameInRequest']); | ||
| 26 | has UpdatedAt => (is => 'ro', isa => 'Str', request_name => 'updatedAt', traits => ['NameInRequest']); | ||
| 27 | |||
| 28 | 1; | ||
| 29 | |||
| 30 | ### main pod documentation begin ### | ||
| 31 | |||
| 32 | =head1 NAME | ||
| 33 | |||
| 34 | Paws::ECS::TaskSet | ||
| 35 | |||
| 36 | =head1 USAGE | ||
| 37 | |||
| 38 | This class represents one of two things: | ||
| 39 | |||
| 40 | =head3 Arguments in a call to a service | ||
| 41 | |||
| 42 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 43 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 44 | |||
| 45 | As an example, if Att1 is expected to be a Paws::ECS::TaskSet object: | ||
| 46 | |||
| 47 | $service_obj->Method(Att1 => { CapacityProviderStrategy => $value, ..., UpdatedAt => $value }); | ||
| 48 | |||
| 49 | =head3 Results returned from an API call | ||
| 50 | |||
| 51 | Use accessors for each attribute. If Att1 is expected to be an Paws::ECS::TaskSet object: | ||
| 52 | |||
| 53 | $result = $service_obj->Method(...); | ||
| 54 | $result->Att1->CapacityProviderStrategy | ||
| 55 | |||
| 56 | =head1 DESCRIPTION | ||
| 57 | |||
| 58 | Information about a set of Amazon ECS tasks in either an AWS CodeDeploy | ||
| 59 | or an C<EXTERNAL> deployment. An Amazon ECS task set includes details | ||
| 60 | such as the desired number of tasks, how many tasks are running, and | ||
| 61 | whether the task set serves production traffic. | ||
| 62 | |||
| 63 | =head1 ATTRIBUTES | ||
| 64 | |||
| 65 | |||
| 66 | =head2 CapacityProviderStrategy => ArrayRef[L<Paws::ECS::CapacityProviderStrategyItem>] | ||
| 67 | |||
| 68 | The capacity provider strategy associated with the task set. | ||
| 69 | |||
| 70 | |||
| 71 | =head2 ClusterArn => Str | ||
| 72 | |||
| 73 | The Amazon Resource Name (ARN) of the cluster that the service that | ||
| 74 | hosts the task set exists in. | ||
| 75 | |||
| 76 | |||
| 77 | =head2 ComputedDesiredCount => Int | ||
| 78 | |||
| 79 | The computed desired count for the task set. This is calculated by | ||
| 80 | multiplying the service's C<desiredCount> by the task set's C<scale> | ||
| 81 | percentage. The result is always rounded up. For example, if the | ||
| 82 | computed desired count is 1.2, it rounds up to 2 tasks. | ||
| 83 | |||
| 84 | |||
| 85 | =head2 CreatedAt => Str | ||
| 86 | |||
| 87 | The Unix timestamp for when the task set was created. | ||
| 88 | |||
| 89 | |||
| 90 | =head2 ExternalId => Str | ||
| 91 | |||
| 92 | The external ID associated with the task set. | ||
| 93 | |||
| 94 | If a task set is created by an AWS CodeDeploy deployment, the | ||
| 95 | C<externalId> parameter contains the AWS CodeDeploy deployment ID. | ||
| 96 | |||
| 97 | If a task set is created for an external deployment and is associated | ||
| 98 | with a service discovery registry, the C<externalId> parameter contains | ||
| 99 | the C<ECS_TASK_SET_EXTERNAL_ID> AWS Cloud Map attribute. | ||
| 100 | |||
| 101 | |||
| 102 | =head2 Id => Str | ||
| 103 | |||
| 104 | The ID of the task set. | ||
| 105 | |||
| 106 | |||
| 107 | =head2 LaunchType => Str | ||
| 108 | |||
| 109 | The launch type the tasks in the task set are using. For more | ||
| 110 | information, see Amazon ECS launch types | ||
| 111 | (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html) | ||
| 112 | in the I<Amazon Elastic Container Service Developer Guide>. | ||
| 113 | |||
| 114 | |||
| 115 | =head2 LoadBalancers => ArrayRef[L<Paws::ECS::LoadBalancer>] | ||
| 116 | |||
| 117 | Details on a load balancer that is used with a task set. | ||
| 118 | |||
| 119 | |||
| 120 | =head2 NetworkConfiguration => L<Paws::ECS::NetworkConfiguration> | ||
| 121 | |||
| 122 | The network configuration for the task set. | ||
| 123 | |||
| 124 | |||
| 125 | =head2 PendingCount => Int | ||
| 126 | |||
| 127 | The number of tasks in the task set that are in the C<PENDING> status | ||
| 128 | during a deployment. A task in the C<PENDING> state is preparing to | ||
| 129 | enter the C<RUNNING> state. A task set enters the C<PENDING> status | ||
| 130 | when it launches for the first time or when it is restarted after being | ||
| 131 | in the C<STOPPED> state. | ||
| 132 | |||
| 133 | |||
| 134 | =head2 PlatformVersion => Str | ||
| 135 | |||
| 136 | The AWS Fargate platform version on which the tasks in the task set are | ||
| 137 | running. A platform version is only specified for tasks run on AWS | ||
| 138 | Fargate. For more information, see AWS Fargate platform versions | ||
| 139 | (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html) | ||
| 140 | in the I<Amazon Elastic Container Service Developer Guide>. | ||
| 141 | |||
| 142 | |||
| 143 | =head2 RunningCount => Int | ||
| 144 | |||
| 145 | The number of tasks in the task set that are in the C<RUNNING> status | ||
| 146 | during a deployment. A task in the C<RUNNING> state is running and | ||
| 147 | ready for use. | ||
| 148 | |||
| 149 | |||
| 150 | =head2 Scale => L<Paws::ECS::Scale> | ||
| 151 | |||
| 152 | A floating-point percentage of the desired number of tasks to place and | ||
| 153 | keep running in the task set. | ||
| 154 | |||
| 155 | |||
| 156 | =head2 ServiceArn => Str | ||
| 157 | |||
| 158 | The Amazon Resource Name (ARN) of the service the task set exists in. | ||
| 159 | |||
| 160 | |||
| 161 | =head2 ServiceRegistries => ArrayRef[L<Paws::ECS::ServiceRegistry>] | ||
| 162 | |||
| 163 | The details of the service discovery registries to assign to this task | ||
| 164 | set. For more information, see Service discovery | ||
| 165 | (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-discovery.html). | ||
| 166 | |||
| 167 | |||
| 168 | =head2 StabilityStatus => Str | ||
| 169 | |||
| 170 | The stability status, which indicates whether the task set has reached | ||
| 171 | a steady state. If the following conditions are met, the task set will | ||
| 172 | be in C<STEADY_STATE>: | ||
| 173 | |||
| 174 | =over | ||
| 175 | |||
| 176 | =item * | ||
| 177 | |||
| 178 | The task C<runningCount> is equal to the C<computedDesiredCount>. | ||
| 179 | |||
| 180 | =item * | ||
| 181 | |||
| 182 | The C<pendingCount> is C<0>. | ||
| 183 | |||
| 184 | =item * | ||
| 185 | |||
| 186 | There are no tasks running on container instances in the C<DRAINING> | ||
| 187 | status. | ||
| 188 | |||
| 189 | =item * | ||
| 190 | |||
| 191 | All tasks are reporting a healthy status from the load balancers, | ||
| 192 | service discovery, and container health checks. | ||
| 193 | |||
| 194 | =back | ||
| 195 | |||
| 196 | If any of those conditions are not met, the stability status returns | ||
| 197 | C<STABILIZING>. | ||
| 198 | |||
| 199 | |||
| 200 | =head2 StabilityStatusAt => Str | ||
| 201 | |||
| 202 | The Unix timestamp for when the task set stability status was | ||
| 203 | retrieved. | ||
| 204 | |||
| 205 | |||
| 206 | =head2 StartedBy => Str | ||
| 207 | |||
| 208 | The tag specified when a task set is started. If the task set is | ||
| 209 | created by an AWS CodeDeploy deployment, the C<startedBy> parameter is | ||
| 210 | C<CODE_DEPLOY>. For a task set created for an external deployment, the | ||
| 211 | startedBy field isn't used. | ||
| 212 | |||
| 213 | |||
| 214 | =head2 Status => Str | ||
| 215 | |||
| 216 | The status of the task set. The following describes each state: | ||
| 217 | |||
| 218 | =over | ||
| 219 | |||
| 220 | =item PRIMARY | ||
| 221 | |||
| 222 | The task set is serving production traffic. | ||
| 223 | |||
| 224 | =item ACTIVE | ||
| 225 | |||
| 226 | The task set is not serving production traffic. | ||
| 227 | |||
| 228 | =item DRAINING | ||
| 229 | |||
| 230 | The tasks in the task set are being stopped and their corresponding | ||
| 231 | targets are being deregistered from their target group. | ||
| 232 | |||
| 233 | =back | ||
| 234 | |||
| 235 | |||
| 236 | |||
| 237 | =head2 Tags => ArrayRef[L<Paws::ECS::Tag>] | ||
| 238 | |||
| 239 | The metadata that you apply to the task set to help you categorize and | ||
| 240 | organize them. Each tag consists of a key and an optional value, both | ||
| 241 | of which you define. | ||
| 242 | |||
| 243 | The following basic restrictions apply to tags: | ||
| 244 | |||
| 245 | =over | ||
| 246 | |||
| 247 | =item * | ||
| 248 | |||
| 249 | Maximum number of tags per resource - 50 | ||
| 250 | |||
| 251 | =item * | ||
| 252 | |||
| 253 | For each resource, each tag key must be unique, and each tag key can | ||
| 254 | have only one value. | ||
| 255 | |||
| 256 | =item * | ||
| 257 | |||
| 258 | Maximum key length - 128 Unicode characters in UTF-8 | ||
| 259 | |||
| 260 | =item * | ||
| 261 | |||
| 262 | Maximum value length - 256 Unicode characters in UTF-8 | ||
| 263 | |||
| 264 | =item * | ||
| 265 | |||
| 266 | If your tagging schema is used across multiple services and resources, | ||
| 267 | remember that other services may have restrictions on allowed | ||
| 268 | characters. Generally allowed characters are: letters, numbers, and | ||
| 269 | spaces representable in UTF-8, and the following characters: + - = . _ | ||
| 270 | : / @. | ||
| 271 | |||
| 272 | =item * | ||
| 273 | |||
| 274 | Tag keys and values are case-sensitive. | ||
| 275 | |||
| 276 | =item * | ||
| 277 | |||
| 278 | Do not use C<aws:>, C<AWS:>, or any upper or lowercase combination of | ||
| 279 | such as a prefix for either keys or values as it is reserved for AWS | ||
| 280 | use. You cannot edit or delete tag keys or values with this prefix. | ||
| 281 | Tags with this prefix do not count against your tags per resource | ||
| 282 | limit. | ||
| 283 | |||
| 284 | =back | ||
| 285 | |||
| 286 | |||
| 287 | |||
| 288 | =head2 TaskDefinition => Str | ||
| 289 | |||
| 290 | The task definition the task set is using. | ||
| 291 | |||
| 292 | |||
| 293 | =head2 TaskSetArn => Str | ||
| 294 | |||
| 295 | The Amazon Resource Name (ARN) of the task set. | ||
| 296 | |||
| 297 | |||
| 298 | =head2 UpdatedAt => Str | ||
| 299 | |||
| 300 | The Unix timestamp for when the task set was last updated. | ||
| 301 | |||
| 302 | |||
| 303 | |||
| 304 | =head1 SEE ALSO | ||
| 305 | |||
| 306 | This class forms part of L<Paws>, describing an object used in L<Paws::ECS> | ||
| 307 | |||
| 308 | =head1 BUGS and CONTRIBUTIONS | ||
| 309 | |||
| 310 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 311 | |||
| 312 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 313 | |||
| 314 | =cut | ||
| 315 |