/ 
Paws-0.46
River stage two • 9 direct dependents • 11 total dependents
/ Paws::ECS::CreateTaskSet

NAME

Paws::ECS::CreateTaskSet - Arguments for method CreateTaskSet on Paws::ECS

DESCRIPTION

This class represents the parameters used for calling the method CreateTaskSet on the Amazon EC2 Container Service service. Use the attributes of this class as arguments to method CreateTaskSet.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateTaskSet.

SYNOPSIS

my $ecs = Paws->service('ECS');
my $CreateTaskSetResponse = $ecs->CreateTaskSet(
  Cluster                  => 'MyString',
  Service                  => 'MyString',
  TaskDefinition           => 'MyString',
  CapacityProviderStrategy => [
    {
      CapacityProvider => 'MyString',
      Base             => 1,            # max: 100000; OPTIONAL
      Weight           => 1,            # max: 1000; OPTIONAL
    },
    ...
  ],    # OPTIONAL
  ClientToken   => 'MyString',    # OPTIONAL
  ExternalId    => 'MyString',    # OPTIONAL
  LaunchType    => 'EC2',         # OPTIONAL
  LoadBalancers => [
    {
      ContainerName    => 'MyString',
      ContainerPort    => 1,            # OPTIONAL
      LoadBalancerName => 'MyString',
      TargetGroupArn   => 'MyString',
    },
    ...
  ],    # OPTIONAL
  NetworkConfiguration => {
    AwsvpcConfiguration => {
      Subnets        => [ 'MyString', ... ],
      AssignPublicIp => 'ENABLED',    # values: ENABLED, DISABLED; OPTIONAL
      SecurityGroups => [ 'MyString', ... ],
    },    # OPTIONAL
  },    # OPTIONAL
  PlatformVersion => 'MyString',    # OPTIONAL
  Scale           => {
    Unit  => 'PERCENT',             # values: PERCENT; OPTIONAL
    Value => 1,                     # OPTIONAL
  },    # OPTIONAL
  ServiceRegistries => [
    {
      ContainerName => 'MyString',
      ContainerPort => 1,            # OPTIONAL
      Port          => 1,            # OPTIONAL
      RegistryArn   => 'MyString',
    },
    ...
  ],    # OPTIONAL
  Tags => [
    {
      Key   => 'MyTagKey',      # min: 1, max: 128; OPTIONAL
      Value => 'MyTagValue',    # max: 256; OPTIONAL
    },
    ...
  ],    # OPTIONAL
);

# Results:
my $TaskSet = $CreateTaskSetResponse->TaskSet;

# Returns a L<Paws::ECS::CreateTaskSetResponse> object.

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. For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/ecs/CreateTaskSet

ATTRIBUTES

CapacityProviderStrategy => ArrayRef[Paws::ECS::CapacityProviderStrategyItem]

The capacity provider strategy to use for the task set.

A capacity provider strategy consists of one or more capacity providers along with the base and weight to assign to them. A capacity provider must be associated with the cluster to be used in a capacity provider strategy. The PutClusterCapacityProviders API is used to associate a capacity provider with a cluster. Only capacity providers with an ACTIVE or UPDATING status can be used.

If a capacityProviderStrategy is specified, the launchType parameter must be omitted. If no capacityProviderStrategy or launchType is specified, the defaultCapacityProviderStrategy for the cluster is used.

If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created. New capacity providers can be created with the CreateCapacityProvider API operation.

To use a AWS Fargate capacity provider, specify either the FARGATE or FARGATE_SPOT capacity providers. The AWS Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used.

The PutClusterCapacityProviders API operation is used to update the list of available capacity providers for a cluster after the cluster is created.

ClientToken => Str

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 32 ASCII characters are allowed.

REQUIRED Cluster => Str

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service to create the task set in.

ExternalId => Str

An optional non-unique tag that identifies this task set in external systems. If the task set is associated with a service discovery registry, the tasks in this task set will have the ECS_TASK_SET_EXTERNAL_ID AWS Cloud Map attribute set to the provided value.

LaunchType => Str

The launch type that new tasks in the task set will use. For more information, see Amazon ECS Launch Types (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_types.html) in the Amazon Elastic Container Service Developer Guide.

If a launchType is specified, the capacityProviderStrategy parameter must be omitted.

Valid values are: "EC2", "FARGATE", "EXTERNAL"

LoadBalancers => ArrayRef[Paws::ECS::LoadBalancer]

A load balancer object representing the load balancer to use with the task set. The supported load balancer types are either an Application Load Balancer or a Network Load Balancer.

NetworkConfiguration => Paws::ECS::NetworkConfiguration

An object representing the network configuration for a task set.

PlatformVersion => Str

The platform version that the tasks in the task set should use. A platform version is specified only for tasks using the Fargate launch type. If one isn't specified, the LATEST platform version is used by default.

Scale => Paws::ECS::Scale

A floating-point percentage of the desired number of tasks to place and keep running in the task set.

REQUIRED Service => Str

The short name or full Amazon Resource Name (ARN) of the service to create the task set in.

ServiceRegistries => ArrayRef[Paws::ECS::ServiceRegistry]

The details of the service discovery registries to assign to this task set. For more information, see Service Discovery (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-discovery.html).

Tags => ArrayRef[Paws::ECS::Tag]

The metadata that you apply to the task set to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define. When a service is deleted, the tags are deleted as well.

The following basic restrictions apply to tags:

  • Maximum number of tags per resource - 50

  • For each resource, each tag key must be unique, and each tag key can have only one value.

  • Maximum key length - 128 Unicode characters in UTF-8

  • Maximum value length - 256 Unicode characters in UTF-8

  • If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.

  • Tag keys and values are case-sensitive.

  • Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.

REQUIRED TaskDefinition => Str

The task definition for the tasks in the task set to use.

SEE ALSO

This class forms part of Paws, documenting arguments for method CreateTaskSet in Paws::ECS

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues