NAME

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

DESCRIPTION

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

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

SYNOPSIS

    my $ecs = Paws->service('ECS');
    my $StartTaskResponse = $ecs->StartTask(
      ContainerInstances   => [ 'MyString', ... ],
      TaskDefinition       => 'MyString',
      Cluster              => 'MyString',            # OPTIONAL
      EnableECSManagedTags => 1,                     # OPTIONAL
      EnableExecuteCommand => 1,                     # OPTIONAL
      Group                => 'MyString',            # OPTIONAL
      NetworkConfiguration => {
        AwsvpcConfiguration => {
          Subnets        => [ 'MyString', ... ],
          AssignPublicIp => 'ENABLED',    # values: ENABLED, DISABLED; OPTIONAL
          SecurityGroups => [ 'MyString', ... ],
        },    # OPTIONAL
      },    # OPTIONAL
      Overrides => {
        ContainerOverrides => [
          {
            Command     => [ 'MyString', ... ],
            Cpu         => 1,                     # OPTIONAL
            Environment => [
              {
                Name  => 'MyString',
                Value => 'MyString',
              },
              ...
            ],                                    # OPTIONAL
            EnvironmentFiles => [
              {
                Type  => 's3',                    # values: s3
                Value => 'MyString',
              },
              ...
            ],    # OPTIONAL
            Memory               => 1,            # OPTIONAL
            MemoryReservation    => 1,            # OPTIONAL
            Name                 => 'MyString',
            ResourceRequirements => [
              {
                Type  => 'GPU',        # values: GPU, InferenceAccelerator
                Value => 'MyString',
              },
              ...
            ],    # OPTIONAL
          },
          ...
        ],    # OPTIONAL
        Cpu              => 'MyString',
        EphemeralStorage => {
          SizeInGiB => 1,
        },    # OPTIONAL
        ExecutionRoleArn              => 'MyString',
        InferenceAcceleratorOverrides => [
          {
            DeviceName => 'MyString',
            DeviceType => 'MyString',
          },
          ...
        ],    # OPTIONAL
        Memory      => 'MyString',
        TaskRoleArn => 'MyString',
      },    # OPTIONAL
      PropagateTags => 'TASK_DEFINITION',    # OPTIONAL
      ReferenceId   => 'MyString',           # OPTIONAL
      StartedBy     => 'MyString',           # OPTIONAL
      Tags          => [
        {
          Key   => 'MyTagKey',      # min: 1, max: 128; OPTIONAL
          Value => 'MyTagValue',    # max: 256; OPTIONAL
        },
        ...
      ],    # OPTIONAL
    );
    # Results:
    my $Failures = $StartTaskResponse->Failures;
    my $Tasks    = $StartTaskResponse->Tasks;
    # Returns a L<Paws::ECS::StartTaskResponse> 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/StartTask>

ATTRIBUTES

Cluster => Str

The short name or full Amazon Resource Name (ARN) of the cluster on which to start your task. If you do not specify a cluster, the default cluster is assumed.

REQUIRED ContainerInstances => ArrayRef[Str|Undef]

The container instance IDs or full ARN entries for the container instances on which you would like to place your task. You can specify up to 10 container instances.

EnableECSManagedTags => Bool

Specifies whether to enable Amazon ECS managed tags for the task. For more information, see Tagging Your Amazon ECS Resources (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-using-tags.html) in the Amazon Elastic Container Service Developer Guide.

EnableExecuteCommand => Bool

Whether or not the execute command functionality is enabled for the task. If "true", this enables execute command functionality on all containers in the task.

Group => Str

The name of the task group to associate with the task. The default value is the family name of the task definition (for example, family:my-family-name).

NetworkConfiguration => Paws::ECS::NetworkConfiguration

The VPC subnet and security group configuration for tasks that receive their own elastic network interface by using the "awsvpc" networking mode.

Overrides => Paws::ECS::TaskOverride

A list of container overrides in JSON format that specify the name of a container in the specified task definition and the overrides it should receive. You can override the default command for a container (that is specified in the task definition or Docker image) with a "command" override. You can also override existing environment variables (that are specified in the task definition or Docker image) on a container or add new environment variables to it with an "environment" override.

A total of 8192 characters are allowed for overrides. This limit includes the JSON formatting characters of the override structure.

PropagateTags => Str

Specifies whether to propagate the tags from the task definition or the service to the task. If no value is specified, the tags are not propagated.

Valid values are: "TASK_DEFINITION", "SERVICE"

ReferenceId => Str

The reference ID to use for the task.

StartedBy => Str

An optional tag specified when a task is started. For example, if you automatically trigger a task to run a batch process job, you could apply a unique identifier for that job to your task with the "startedBy" parameter. You can then identify which tasks belong to that job by filtering the results of a ListTasks call with the "startedBy" value. Up to 36 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.

If a task is started by an Amazon ECS service, then the "startedBy" parameter contains the deployment ID of the service that starts it.

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

The metadata that you apply to the task to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.

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 "family" and "revision" ("family:revision") or full ARN of the task definition to start. If a "revision" is not specified, the latest "ACTIVE" revision is used.

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>