| 1 | |||
| 2 | package Paws::ECS::CreateTaskSet; | ||
| 3 | use Moose; | ||
| 4 | has CapacityProviderStrategy => (is => 'ro', isa => 'ArrayRef[Paws::ECS::CapacityProviderStrategyItem]', traits => ['NameInRequest'], request_name => 'capacityProviderStrategy' ); | ||
| 5 | has ClientToken => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'clientToken' ); | ||
| 6 | has Cluster => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'cluster' , required => 1); | ||
| 7 | has ExternalId => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'externalId' ); | ||
| 8 | has LaunchType => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'launchType' ); | ||
| 9 | has LoadBalancers => (is => 'ro', isa => 'ArrayRef[Paws::ECS::LoadBalancer]', traits => ['NameInRequest'], request_name => 'loadBalancers' ); | ||
| 10 | has NetworkConfiguration => (is => 'ro', isa => 'Paws::ECS::NetworkConfiguration', traits => ['NameInRequest'], request_name => 'networkConfiguration' ); | ||
| 11 | has PlatformVersion => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'platformVersion' ); | ||
| 12 | has Scale => (is => 'ro', isa => 'Paws::ECS::Scale', traits => ['NameInRequest'], request_name => 'scale' ); | ||
| 13 | has Service => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'service' , required => 1); | ||
| 14 | has ServiceRegistries => (is => 'ro', isa => 'ArrayRef[Paws::ECS::ServiceRegistry]', traits => ['NameInRequest'], request_name => 'serviceRegistries' ); | ||
| 15 | has Tags => (is => 'ro', isa => 'ArrayRef[Paws::ECS::Tag]', traits => ['NameInRequest'], request_name => 'tags' ); | ||
| 16 | has TaskDefinition => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'taskDefinition' , required => 1); | ||
| 17 | |||
| 18 | use MooseX::ClassAttribute; | ||
| 19 | |||
| 20 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateTaskSet'); | ||
| 21 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::ECS::CreateTaskSetResponse'); | ||
| 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::CreateTaskSet - Arguments for method CreateTaskSet on L<Paws::ECS> | ||
| 30 | |||
| 31 | =head1 DESCRIPTION | ||
| 32 | |||
| 33 | This class represents the parameters used for calling the method CreateTaskSet on the | ||
| 34 | L<Amazon EC2 Container Service|Paws::ECS> service. Use the attributes of this class | ||
| 35 | as arguments to method CreateTaskSet. | ||
| 36 | |||
| 37 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateTaskSet. | ||
| 38 | |||
| 39 | =head1 SYNOPSIS | ||
| 40 | |||
| 41 | my $ecs = Paws->service('ECS'); | ||
| 42 | my $CreateTaskSetResponse = $ecs->CreateTaskSet( | ||
| 43 | Cluster => 'MyString', | ||
| 44 | Service => 'MyString', | ||
| 45 | TaskDefinition => 'MyString', | ||
| 46 | CapacityProviderStrategy => [ | ||
| 47 | { | ||
| 48 | CapacityProvider => 'MyString', | ||
| 49 | Base => 1, # max: 100000; OPTIONAL | ||
| 50 | Weight => 1, # max: 1000; OPTIONAL | ||
| 51 | }, | ||
| 52 | ... | ||
| 53 | ], # OPTIONAL | ||
| 54 | ClientToken => 'MyString', # OPTIONAL | ||
| 55 | ExternalId => 'MyString', # OPTIONAL | ||
| 56 | LaunchType => 'EC2', # OPTIONAL | ||
| 57 | LoadBalancers => [ | ||
| 58 | { | ||
| 59 | ContainerName => 'MyString', | ||
| 60 | ContainerPort => 1, # OPTIONAL | ||
| 61 | LoadBalancerName => 'MyString', | ||
| 62 | TargetGroupArn => 'MyString', | ||
| 63 | }, | ||
| 64 | ... | ||
| 65 | ], # OPTIONAL | ||
| 66 | NetworkConfiguration => { | ||
| 67 | AwsvpcConfiguration => { | ||
| 68 | Subnets => [ 'MyString', ... ], | ||
| 69 | AssignPublicIp => 'ENABLED', # values: ENABLED, DISABLED; OPTIONAL | ||
| 70 | SecurityGroups => [ 'MyString', ... ], | ||
| 71 | }, # OPTIONAL | ||
| 72 | }, # OPTIONAL | ||
| 73 | PlatformVersion => 'MyString', # OPTIONAL | ||
| 74 | Scale => { | ||
| 75 | Unit => 'PERCENT', # values: PERCENT; OPTIONAL | ||
| 76 | Value => 1, # OPTIONAL | ||
| 77 | }, # OPTIONAL | ||
| 78 | ServiceRegistries => [ | ||
| 79 | { | ||
| 80 | ContainerName => 'MyString', | ||
| 81 | ContainerPort => 1, # OPTIONAL | ||
| 82 | Port => 1, # OPTIONAL | ||
| 83 | RegistryArn => 'MyString', | ||
| 84 | }, | ||
| 85 | ... | ||
| 86 | ], # OPTIONAL | ||
| 87 | Tags => [ | ||
| 88 | { | ||
| 89 | Key => 'MyTagKey', # min: 1, max: 128; OPTIONAL | ||
| 90 | Value => 'MyTagValue', # max: 256; OPTIONAL | ||
| 91 | }, | ||
| 92 | ... | ||
| 93 | ], # OPTIONAL | ||
| 94 | ); | ||
| 95 | |||
| 96 | # Results: | ||
| 97 | my $TaskSet = $CreateTaskSetResponse->TaskSet; | ||
| 98 | |||
| 99 | # Returns a L<Paws::ECS::CreateTaskSetResponse> object. | ||
| 100 | |||
| 101 | 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. | ||
| 102 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/ecs/CreateTaskSet> | ||
| 103 | |||
| 104 | =head1 ATTRIBUTES | ||
| 105 | |||
| 106 | |||
| 107 | =head2 CapacityProviderStrategy => ArrayRef[L<Paws::ECS::CapacityProviderStrategyItem>] | ||
| 108 | |||
| 109 | The capacity provider strategy to use for the task set. | ||
| 110 | |||
| 111 | A capacity provider strategy consists of one or more capacity providers | ||
| 112 | along with the C<base> and C<weight> to assign to them. A capacity | ||
| 113 | provider must be associated with the cluster to be used in a capacity | ||
| 114 | provider strategy. The PutClusterCapacityProviders API is used to | ||
| 115 | associate a capacity provider with a cluster. Only capacity providers | ||
| 116 | with an C<ACTIVE> or C<UPDATING> status can be used. | ||
| 117 | |||
| 118 | If a C<capacityProviderStrategy> is specified, the C<launchType> | ||
| 119 | parameter must be omitted. If no C<capacityProviderStrategy> or | ||
| 120 | C<launchType> is specified, the C<defaultCapacityProviderStrategy> for | ||
| 121 | the cluster is used. | ||
| 122 | |||
| 123 | If specifying a capacity provider that uses an Auto Scaling group, the | ||
| 124 | capacity provider must already be created. New capacity providers can | ||
| 125 | be created with the CreateCapacityProvider API operation. | ||
| 126 | |||
| 127 | To use a AWS Fargate capacity provider, specify either the C<FARGATE> | ||
| 128 | or C<FARGATE_SPOT> capacity providers. The AWS Fargate capacity | ||
| 129 | providers are available to all accounts and only need to be associated | ||
| 130 | with a cluster to be used. | ||
| 131 | |||
| 132 | The PutClusterCapacityProviders API operation is used to update the | ||
| 133 | list of available capacity providers for a cluster after the cluster is | ||
| 134 | created. | ||
| 135 | |||
| 136 | |||
| 137 | |||
| 138 | =head2 ClientToken => Str | ||
| 139 | |||
| 140 | Unique, case-sensitive identifier that you provide to ensure the | ||
| 141 | idempotency of the request. Up to 32 ASCII characters are allowed. | ||
| 142 | |||
| 143 | |||
| 144 | |||
| 145 | =head2 B<REQUIRED> Cluster => Str | ||
| 146 | |||
| 147 | The short name or full Amazon Resource Name (ARN) of the cluster that | ||
| 148 | hosts the service to create the task set in. | ||
| 149 | |||
| 150 | |||
| 151 | |||
| 152 | =head2 ExternalId => Str | ||
| 153 | |||
| 154 | An optional non-unique tag that identifies this task set in external | ||
| 155 | systems. If the task set is associated with a service discovery | ||
| 156 | registry, the tasks in this task set will have the | ||
| 157 | C<ECS_TASK_SET_EXTERNAL_ID> AWS Cloud Map attribute set to the provided | ||
| 158 | value. | ||
| 159 | |||
| 160 | |||
| 161 | |||
| 162 | =head2 LaunchType => Str | ||
| 163 | |||
| 164 | The launch type that new tasks in the task set will use. For more | ||
| 165 | information, see Amazon ECS Launch Types | ||
| 166 | (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html) | ||
| 167 | in the I<Amazon Elastic Container Service Developer Guide>. | ||
| 168 | |||
| 169 | If a C<launchType> is specified, the C<capacityProviderStrategy> | ||
| 170 | parameter must be omitted. | ||
| 171 | |||
| 172 | Valid values are: C<"EC2">, C<"FARGATE">, C<"EXTERNAL"> | ||
| 173 | |||
| 174 | =head2 LoadBalancers => ArrayRef[L<Paws::ECS::LoadBalancer>] | ||
| 175 | |||
| 176 | A load balancer object representing the load balancer to use with the | ||
| 177 | task set. The supported load balancer types are either an Application | ||
| 178 | Load Balancer or a Network Load Balancer. | ||
| 179 | |||
| 180 | |||
| 181 | |||
| 182 | =head2 NetworkConfiguration => L<Paws::ECS::NetworkConfiguration> | ||
| 183 | |||
| 184 | An object representing the network configuration for a task set. | ||
| 185 | |||
| 186 | |||
| 187 | |||
| 188 | =head2 PlatformVersion => Str | ||
| 189 | |||
| 190 | The platform version that the tasks in the task set should use. A | ||
| 191 | platform version is specified only for tasks using the Fargate launch | ||
| 192 | type. If one isn't specified, the C<LATEST> platform version is used by | ||
| 193 | default. | ||
| 194 | |||
| 195 | |||
| 196 | |||
| 197 | =head2 Scale => L<Paws::ECS::Scale> | ||
| 198 | |||
| 199 | A floating-point percentage of the desired number of tasks to place and | ||
| 200 | keep running in the task set. | ||
| 201 | |||
| 202 | |||
| 203 | |||
| 204 | =head2 B<REQUIRED> Service => Str | ||
| 205 | |||
| 206 | The short name or full Amazon Resource Name (ARN) of the service to | ||
| 207 | create the task set in. | ||
| 208 | |||
| 209 | |||
| 210 | |||
| 211 | =head2 ServiceRegistries => ArrayRef[L<Paws::ECS::ServiceRegistry>] | ||
| 212 | |||
| 213 | The details of the service discovery registries to assign to this task | ||
| 214 | set. For more information, see Service Discovery | ||
| 215 | (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-discovery.html). | ||
| 216 | |||
| 217 | |||
| 218 | |||
| 219 | =head2 Tags => ArrayRef[L<Paws::ECS::Tag>] | ||
| 220 | |||
| 221 | The metadata that you apply to the task set to help you categorize and | ||
| 222 | organize them. Each tag consists of a key and an optional value, both | ||
| 223 | of which you define. When a service is deleted, the tags are deleted as | ||
| 224 | well. | ||
| 225 | |||
| 226 | The following basic restrictions apply to tags: | ||
| 227 | |||
| 228 | =over | ||
| 229 | |||
| 230 | =item * | ||
| 231 | |||
| 232 | Maximum number of tags per resource - 50 | ||
| 233 | |||
| 234 | =item * | ||
| 235 | |||
| 236 | For each resource, each tag key must be unique, and each tag key can | ||
| 237 | have only one value. | ||
| 238 | |||
| 239 | =item * | ||
| 240 | |||
| 241 | Maximum key length - 128 Unicode characters in UTF-8 | ||
| 242 | |||
| 243 | =item * | ||
| 244 | |||
| 245 | Maximum value length - 256 Unicode characters in UTF-8 | ||
| 246 | |||
| 247 | =item * | ||
| 248 | |||
| 249 | If your tagging schema is used across multiple services and resources, | ||
| 250 | remember that other services may have restrictions on allowed | ||
| 251 | characters. Generally allowed characters are: letters, numbers, and | ||
| 252 | spaces representable in UTF-8, and the following characters: + - = . _ | ||
| 253 | : / @. | ||
| 254 | |||
| 255 | =item * | ||
| 256 | |||
| 257 | Tag keys and values are case-sensitive. | ||
| 258 | |||
| 259 | =item * | ||
| 260 | |||
| 261 | Do not use C<aws:>, C<AWS:>, or any upper or lowercase combination of | ||
| 262 | such as a prefix for either keys or values as it is reserved for AWS | ||
| 263 | use. You cannot edit or delete tag keys or values with this prefix. | ||
| 264 | Tags with this prefix do not count against your tags per resource | ||
| 265 | limit. | ||
| 266 | |||
| 267 | =back | ||
| 268 | |||
| 269 | |||
| 270 | |||
| 271 | |||
| 272 | =head2 B<REQUIRED> TaskDefinition => Str | ||
| 273 | |||
| 274 | The task definition for the tasks in the task set to use. | ||
| 275 | |||
| 276 | |||
| 277 | |||
| 278 | |||
| 279 | =head1 SEE ALSO | ||
| 280 | |||
| 281 | This class forms part of L<Paws>, documenting arguments for method CreateTaskSet in L<Paws::ECS> | ||
| 282 | |||
| 283 | =head1 BUGS and CONTRIBUTIONS | ||
| 284 | |||
| 285 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 286 | |||
| 287 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 288 | |||
| 289 | =cut | ||
| 290 |