« blib/lib/Paws/ECS/UpdateContainerInstancesStateResponse.pm
↑ Summary
blib/lib/Paws/ECS/UpdateServicePrimaryTaskSet.pm »
| 1 | |||
| 2 | package Paws::ECS::UpdateService; | ||
| 3 | use Moose; | ||
| 4 | has CapacityProviderStrategy => (is => 'ro', isa => 'ArrayRef[Paws::ECS::CapacityProviderStrategyItem]', traits => ['NameInRequest'], request_name => 'capacityProviderStrategy' ); | ||
| 5 | has Cluster => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'cluster' ); | ||
| 6 | has DeploymentConfiguration => (is => 'ro', isa => 'Paws::ECS::DeploymentConfiguration', traits => ['NameInRequest'], request_name => 'deploymentConfiguration' ); | ||
| 7 | has DesiredCount => (is => 'ro', isa => 'Int', traits => ['NameInRequest'], request_name => 'desiredCount' ); | ||
| 8 | has EnableExecuteCommand => (is => 'ro', isa => 'Bool', traits => ['NameInRequest'], request_name => 'enableExecuteCommand' ); | ||
| 9 | has ForceNewDeployment => (is => 'ro', isa => 'Bool', traits => ['NameInRequest'], request_name => 'forceNewDeployment' ); | ||
| 10 | has HealthCheckGracePeriodSeconds => (is => 'ro', isa => 'Int', traits => ['NameInRequest'], request_name => 'healthCheckGracePeriodSeconds' ); | ||
| 11 | has NetworkConfiguration => (is => 'ro', isa => 'Paws::ECS::NetworkConfiguration', traits => ['NameInRequest'], request_name => 'networkConfiguration' ); | ||
| 12 | has PlacementConstraints => (is => 'ro', isa => 'ArrayRef[Paws::ECS::PlacementConstraint]', traits => ['NameInRequest'], request_name => 'placementConstraints' ); | ||
| 13 | has PlacementStrategy => (is => 'ro', isa => 'ArrayRef[Paws::ECS::PlacementStrategy]', traits => ['NameInRequest'], request_name => 'placementStrategy' ); | ||
| 14 | has PlatformVersion => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'platformVersion' ); | ||
| 15 | has Service => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'service' , required => 1); | ||
| 16 | has TaskDefinition => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'taskDefinition' ); | ||
| 17 | |||
| 18 | use MooseX::ClassAttribute; | ||
| 19 | |||
| 20 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'UpdateService'); | ||
| 21 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::ECS::UpdateServiceResponse'); | ||
| 22 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 23 | 1; | ||
| 24 | |||
| 25 | ### main pod documentation begin ### | ||
| 26 | |||
| 27 | =head1 NAME | ||
| 28 | |||
| 29 | Paws::ECS::UpdateService - Arguments for method UpdateService on L<Paws::ECS> | ||
| 30 | |||
| 31 | =head1 DESCRIPTION | ||
| 32 | |||
| 33 | This class represents the parameters used for calling the method UpdateService on the | ||
| 34 | L<Amazon EC2 Container Service|Paws::ECS> service. Use the attributes of this class | ||
| 35 | as arguments to method UpdateService. | ||
| 36 | |||
| 37 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to UpdateService. | ||
| 38 | |||
| 39 | =head1 SYNOPSIS | ||
| 40 | |||
| 41 | my $ecs = Paws->service('ECS'); | ||
| 42 | # To change the task definition used in a service | ||
| 43 | # This example updates the my-http-service service to use the amazon-ecs-sample | ||
| 44 | # task definition. | ||
| 45 | my $UpdateServiceResponse = $ecs->UpdateService( | ||
| 46 | 'Service' => 'my-http-service', | ||
| 47 | 'TaskDefinition' => 'amazon-ecs-sample' | ||
| 48 | ); | ||
| 49 | |||
| 50 | # To change the number of tasks in a service | ||
| 51 | # This example updates the desired count of the my-http-service service to 10. | ||
| 52 | my $UpdateServiceResponse = $ecs->UpdateService( | ||
| 53 | 'DesiredCount' => 10, | ||
| 54 | 'Service' => 'my-http-service' | ||
| 55 | ); | ||
| 56 | |||
| 57 | |||
| 58 | 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. | ||
| 59 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/ecs/UpdateService> | ||
| 60 | |||
| 61 | =head1 ATTRIBUTES | ||
| 62 | |||
| 63 | |||
| 64 | =head2 CapacityProviderStrategy => ArrayRef[L<Paws::ECS::CapacityProviderStrategyItem>] | ||
| 65 | |||
| 66 | The capacity provider strategy to update the service to use. | ||
| 67 | |||
| 68 | If the service is using the default capacity provider strategy for the | ||
| 69 | cluster, the service can be updated to use one or more capacity | ||
| 70 | providers as opposed to the default capacity provider strategy. | ||
| 71 | However, when a service is using a capacity provider strategy that is | ||
| 72 | not the default capacity provider strategy, the service cannot be | ||
| 73 | updated to use the cluster's default capacity provider strategy. | ||
| 74 | |||
| 75 | A capacity provider strategy consists of one or more capacity providers | ||
| 76 | along with the C<base> and C<weight> to assign to them. A capacity | ||
| 77 | provider must be associated with the cluster to be used in a capacity | ||
| 78 | provider strategy. The PutClusterCapacityProviders API is used to | ||
| 79 | associate a capacity provider with a cluster. Only capacity providers | ||
| 80 | with an C<ACTIVE> or C<UPDATING> status can be used. | ||
| 81 | |||
| 82 | If specifying a capacity provider that uses an Auto Scaling group, the | ||
| 83 | capacity provider must already be created. New capacity providers can | ||
| 84 | be created with the CreateCapacityProvider API operation. | ||
| 85 | |||
| 86 | To use a AWS Fargate capacity provider, specify either the C<FARGATE> | ||
| 87 | or C<FARGATE_SPOT> capacity providers. The AWS Fargate capacity | ||
| 88 | providers are available to all accounts and only need to be associated | ||
| 89 | with a cluster to be used. | ||
| 90 | |||
| 91 | The PutClusterCapacityProviders API operation is used to update the | ||
| 92 | list of available capacity providers for a cluster after the cluster is | ||
| 93 | created. | ||
| 94 | |||
| 95 | |||
| 96 | |||
| 97 | =head2 Cluster => Str | ||
| 98 | |||
| 99 | The short name or full Amazon Resource Name (ARN) of the cluster that | ||
| 100 | your service is running on. If you do not specify a cluster, the | ||
| 101 | default cluster is assumed. | ||
| 102 | |||
| 103 | |||
| 104 | |||
| 105 | =head2 DeploymentConfiguration => L<Paws::ECS::DeploymentConfiguration> | ||
| 106 | |||
| 107 | Optional deployment parameters that control how many tasks run during | ||
| 108 | the deployment and the ordering of stopping and starting tasks. | ||
| 109 | |||
| 110 | |||
| 111 | |||
| 112 | =head2 DesiredCount => Int | ||
| 113 | |||
| 114 | The number of instantiations of the task to place and keep running in | ||
| 115 | your service. | ||
| 116 | |||
| 117 | |||
| 118 | |||
| 119 | =head2 EnableExecuteCommand => Bool | ||
| 120 | |||
| 121 | If C<true>, this enables execute command functionality on all task | ||
| 122 | containers. | ||
| 123 | |||
| 124 | If you do not want to override the value that was set when the service | ||
| 125 | was created, you can set this to C<null> when performing this action. | ||
| 126 | |||
| 127 | |||
| 128 | |||
| 129 | =head2 ForceNewDeployment => Bool | ||
| 130 | |||
| 131 | Whether to force a new deployment of the service. Deployments are not | ||
| 132 | forced by default. You can use this option to trigger a new deployment | ||
| 133 | with no service definition changes. For example, you can update a | ||
| 134 | service's tasks to use a newer Docker image with the same image/tag | ||
| 135 | combination (C<my_image:latest>) or to roll Fargate tasks onto a newer | ||
| 136 | platform version. | ||
| 137 | |||
| 138 | |||
| 139 | |||
| 140 | =head2 HealthCheckGracePeriodSeconds => Int | ||
| 141 | |||
| 142 | The period of time, in seconds, that the Amazon ECS service scheduler | ||
| 143 | should ignore unhealthy Elastic Load Balancing target health checks | ||
| 144 | after a task has first started. This is only valid if your service is | ||
| 145 | configured to use a load balancer. If your service's tasks take a while | ||
| 146 | to start and respond to Elastic Load Balancing health checks, you can | ||
| 147 | specify a health check grace period of up to 2,147,483,647 seconds. | ||
| 148 | During that time, the Amazon ECS service scheduler ignores the Elastic | ||
| 149 | Load Balancing health check status. This grace period can prevent the | ||
| 150 | ECS service scheduler from marking tasks as unhealthy and stopping them | ||
| 151 | before they have time to come up. | ||
| 152 | |||
| 153 | |||
| 154 | |||
| 155 | =head2 NetworkConfiguration => L<Paws::ECS::NetworkConfiguration> | ||
| 156 | |||
| 157 | An object representing the network configuration for the service. | ||
| 158 | |||
| 159 | |||
| 160 | |||
| 161 | =head2 PlacementConstraints => ArrayRef[L<Paws::ECS::PlacementConstraint>] | ||
| 162 | |||
| 163 | An array of task placement constraint objects to update the service to | ||
| 164 | use. If no value is specified, the existing placement constraints for | ||
| 165 | the service will remain unchanged. If this value is specified, it will | ||
| 166 | override any existing placement constraints defined for the service. To | ||
| 167 | remove all existing placement constraints, specify an empty array. | ||
| 168 | |||
| 169 | You can specify a maximum of 10 constraints per task (this limit | ||
| 170 | includes constraints in the task definition and those specified at | ||
| 171 | runtime). | ||
| 172 | |||
| 173 | |||
| 174 | |||
| 175 | =head2 PlacementStrategy => ArrayRef[L<Paws::ECS::PlacementStrategy>] | ||
| 176 | |||
| 177 | The task placement strategy objects to update the service to use. If no | ||
| 178 | value is specified, the existing placement strategy for the service | ||
| 179 | will remain unchanged. If this value is specified, it will override the | ||
| 180 | existing placement strategy defined for the service. To remove an | ||
| 181 | existing placement strategy, specify an empty object. | ||
| 182 | |||
| 183 | You can specify a maximum of five strategy rules per service. | ||
| 184 | |||
| 185 | |||
| 186 | |||
| 187 | =head2 PlatformVersion => Str | ||
| 188 | |||
| 189 | The platform version on which your tasks in the service are running. A | ||
| 190 | platform version is only specified for tasks using the Fargate launch | ||
| 191 | type. If a platform version is not specified, the C<LATEST> platform | ||
| 192 | version is used by default. For more information, see AWS Fargate | ||
| 193 | Platform Versions | ||
| 194 | (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html) | ||
| 195 | in the I<Amazon Elastic Container Service Developer Guide>. | ||
| 196 | |||
| 197 | |||
| 198 | |||
| 199 | =head2 B<REQUIRED> Service => Str | ||
| 200 | |||
| 201 | The name of the service to update. | ||
| 202 | |||
| 203 | |||
| 204 | |||
| 205 | =head2 TaskDefinition => Str | ||
| 206 | |||
| 207 | The C<family> and C<revision> (C<family:revision>) or full ARN of the | ||
| 208 | task definition to run in your service. If a C<revision> is not | ||
| 209 | specified, the latest C<ACTIVE> revision is used. If you modify the | ||
| 210 | task definition with C<UpdateService>, Amazon ECS spawns a task with | ||
| 211 | the new version of the task definition and then stops an old task after | ||
| 212 | the new version is running. | ||
| 213 | |||
| 214 | |||
| 215 | |||
| 216 | |||
| 217 | =head1 SEE ALSO | ||
| 218 | |||
| 219 | This class forms part of L<Paws>, documenting arguments for method UpdateService in L<Paws::ECS> | ||
| 220 | |||
| 221 | =head1 BUGS and CONTRIBUTIONS | ||
| 222 | |||
| 223 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 224 | |||
| 225 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 226 | |||
| 227 | =cut | ||
| 228 |