« blib/lib/Paws/ECS/DeleteTaskSetResponse.pm
↑ Summary
blib/lib/Paws/ECS/DeploymentCircuitBreaker.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::ECS::Deployment; | ||
| 3 | use Moose; | ||
| 4 | has CapacityProviderStrategy => (is => 'ro', isa => 'ArrayRef[Paws::ECS::CapacityProviderStrategyItem]', request_name => 'capacityProviderStrategy', traits => ['NameInRequest']); | ||
| 5 | has CreatedAt => (is => 'ro', isa => 'Str', request_name => 'createdAt', traits => ['NameInRequest']); | ||
| 6 | has DesiredCount => (is => 'ro', isa => 'Int', request_name => 'desiredCount', traits => ['NameInRequest']); | ||
| 7 | has FailedTasks => (is => 'ro', isa => 'Int', request_name => 'failedTasks', traits => ['NameInRequest']); | ||
| 8 | has Id => (is => 'ro', isa => 'Str', request_name => 'id', traits => ['NameInRequest']); | ||
| 9 | has LaunchType => (is => 'ro', isa => 'Str', request_name => 'launchType', traits => ['NameInRequest']); | ||
| 10 | has NetworkConfiguration => (is => 'ro', isa => 'Paws::ECS::NetworkConfiguration', request_name => 'networkConfiguration', traits => ['NameInRequest']); | ||
| 11 | has PendingCount => (is => 'ro', isa => 'Int', request_name => 'pendingCount', traits => ['NameInRequest']); | ||
| 12 | has PlatformVersion => (is => 'ro', isa => 'Str', request_name => 'platformVersion', traits => ['NameInRequest']); | ||
| 13 | has RolloutState => (is => 'ro', isa => 'Str', request_name => 'rolloutState', traits => ['NameInRequest']); | ||
| 14 | has RolloutStateReason => (is => 'ro', isa => 'Str', request_name => 'rolloutStateReason', traits => ['NameInRequest']); | ||
| 15 | has RunningCount => (is => 'ro', isa => 'Int', request_name => 'runningCount', traits => ['NameInRequest']); | ||
| 16 | has Status => (is => 'ro', isa => 'Str', request_name => 'status', traits => ['NameInRequest']); | ||
| 17 | has TaskDefinition => (is => 'ro', isa => 'Str', request_name => 'taskDefinition', traits => ['NameInRequest']); | ||
| 18 | has UpdatedAt => (is => 'ro', isa => 'Str', request_name => 'updatedAt', traits => ['NameInRequest']); | ||
| 19 | |||
| 20 | 1; | ||
| 21 | |||
| 22 | ### main pod documentation begin ### | ||
| 23 | |||
| 24 | =head1 NAME | ||
| 25 | |||
| 26 | Paws::ECS::Deployment | ||
| 27 | |||
| 28 | =head1 USAGE | ||
| 29 | |||
| 30 | This class represents one of two things: | ||
| 31 | |||
| 32 | =head3 Arguments in a call to a service | ||
| 33 | |||
| 34 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 35 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 36 | |||
| 37 | As an example, if Att1 is expected to be a Paws::ECS::Deployment object: | ||
| 38 | |||
| 39 | $service_obj->Method(Att1 => { CapacityProviderStrategy => $value, ..., UpdatedAt => $value }); | ||
| 40 | |||
| 41 | =head3 Results returned from an API call | ||
| 42 | |||
| 43 | Use accessors for each attribute. If Att1 is expected to be an Paws::ECS::Deployment object: | ||
| 44 | |||
| 45 | $result = $service_obj->Method(...); | ||
| 46 | $result->Att1->CapacityProviderStrategy | ||
| 47 | |||
| 48 | =head1 DESCRIPTION | ||
| 49 | |||
| 50 | The details of an Amazon ECS service deployment. This is used only when | ||
| 51 | a service uses the C<ECS> deployment controller type. | ||
| 52 | |||
| 53 | =head1 ATTRIBUTES | ||
| 54 | |||
| 55 | |||
| 56 | =head2 CapacityProviderStrategy => ArrayRef[L<Paws::ECS::CapacityProviderStrategyItem>] | ||
| 57 | |||
| 58 | The capacity provider strategy that the deployment is using. | ||
| 59 | |||
| 60 | |||
| 61 | =head2 CreatedAt => Str | ||
| 62 | |||
| 63 | The Unix timestamp for when the service deployment was created. | ||
| 64 | |||
| 65 | |||
| 66 | =head2 DesiredCount => Int | ||
| 67 | |||
| 68 | The most recent desired count of tasks that was specified for the | ||
| 69 | service to deploy or maintain. | ||
| 70 | |||
| 71 | |||
| 72 | =head2 FailedTasks => Int | ||
| 73 | |||
| 74 | The number of consecutively failed tasks in the deployment. A task is | ||
| 75 | considered a failure if the service scheduler can't launch the task, | ||
| 76 | the task doesn't transition to a C<RUNNING> state, or if it fails any | ||
| 77 | of its defined health checks and is stopped. | ||
| 78 | |||
| 79 | Once a service deployment has one or more successfully running tasks, | ||
| 80 | the failed task count resets to zero and stops being evaluated. | ||
| 81 | |||
| 82 | |||
| 83 | =head2 Id => Str | ||
| 84 | |||
| 85 | The ID of the deployment. | ||
| 86 | |||
| 87 | |||
| 88 | =head2 LaunchType => Str | ||
| 89 | |||
| 90 | The launch type the tasks in the service are using. For more | ||
| 91 | information, see Amazon ECS Launch Types | ||
| 92 | (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html) | ||
| 93 | in the I<Amazon Elastic Container Service Developer Guide>. | ||
| 94 | |||
| 95 | |||
| 96 | =head2 NetworkConfiguration => L<Paws::ECS::NetworkConfiguration> | ||
| 97 | |||
| 98 | The VPC subnet and security group configuration for tasks that receive | ||
| 99 | their own elastic network interface by using the C<awsvpc> networking | ||
| 100 | mode. | ||
| 101 | |||
| 102 | |||
| 103 | =head2 PendingCount => Int | ||
| 104 | |||
| 105 | The number of tasks in the deployment that are in the C<PENDING> | ||
| 106 | status. | ||
| 107 | |||
| 108 | |||
| 109 | =head2 PlatformVersion => Str | ||
| 110 | |||
| 111 | The platform version on which your tasks in the service are running. A | ||
| 112 | platform version is only specified for tasks using the Fargate launch | ||
| 113 | type. If one is not specified, the C<LATEST> platform version is used | ||
| 114 | by default. For more information, see AWS Fargate Platform Versions | ||
| 115 | (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html) | ||
| 116 | in the I<Amazon Elastic Container Service Developer Guide>. | ||
| 117 | |||
| 118 | |||
| 119 | =head2 RolloutState => Str | ||
| 120 | |||
| 121 | The C<rolloutState> of a service is only returned for services that use | ||
| 122 | the rolling update (C<ECS>) deployment type that are not behind a | ||
| 123 | Classic Load Balancer. | ||
| 124 | |||
| 125 | The rollout state of the deployment. When a service deployment is | ||
| 126 | started, it begins in an C<IN_PROGRESS> state. When the service reaches | ||
| 127 | a steady state, the deployment will transition to a C<COMPLETED> state. | ||
| 128 | If the service fails to reach a steady state and circuit breaker is | ||
| 129 | enabled, the deployment will transition to a C<FAILED> state. A | ||
| 130 | deployment in C<FAILED> state will launch no new tasks. For more | ||
| 131 | information, see DeploymentCircuitBreaker. | ||
| 132 | |||
| 133 | |||
| 134 | =head2 RolloutStateReason => Str | ||
| 135 | |||
| 136 | A description of the rollout state of a deployment. | ||
| 137 | |||
| 138 | |||
| 139 | =head2 RunningCount => Int | ||
| 140 | |||
| 141 | The number of tasks in the deployment that are in the C<RUNNING> | ||
| 142 | status. | ||
| 143 | |||
| 144 | |||
| 145 | =head2 Status => Str | ||
| 146 | |||
| 147 | The status of the deployment. The following describes each state: | ||
| 148 | |||
| 149 | =over | ||
| 150 | |||
| 151 | =item PRIMARY | ||
| 152 | |||
| 153 | The most recent deployment of a service. | ||
| 154 | |||
| 155 | =item ACTIVE | ||
| 156 | |||
| 157 | A service deployment that still has running tasks, but are in the | ||
| 158 | process of being replaced with a new C<PRIMARY> deployment. | ||
| 159 | |||
| 160 | =item INACTIVE | ||
| 161 | |||
| 162 | A deployment that has been completely replaced. | ||
| 163 | |||
| 164 | =back | ||
| 165 | |||
| 166 | |||
| 167 | |||
| 168 | =head2 TaskDefinition => Str | ||
| 169 | |||
| 170 | The most recent task definition that was specified for the tasks in the | ||
| 171 | service to use. | ||
| 172 | |||
| 173 | |||
| 174 | =head2 UpdatedAt => Str | ||
| 175 | |||
| 176 | The Unix timestamp for when the service deployment was last updated. | ||
| 177 | |||
| 178 | |||
| 179 | |||
| 180 | =head1 SEE ALSO | ||
| 181 | |||
| 182 | This class forms part of L<Paws>, describing an object used in L<Paws::ECS> | ||
| 183 | |||
| 184 | =head1 BUGS and CONTRIBUTIONS | ||
| 185 | |||
| 186 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 187 | |||
| 188 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 189 | |||
| 190 | =cut | ||
| 191 |