import { _TaskOverride } from "./_TaskOverride"; import { _NetworkConfiguration } from "./_NetworkConfiguration"; import { _Tag } from "./_Tag"; import { BrowserHttpOptions as __HttpOptions__ } from "@aws-sdk/types"; import * as __aws_sdk_types from "@aws-sdk/types"; /** * StartTaskInput shape */ export interface StartTaskInput { /** *

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.

*/ cluster?: string; /** *

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.

*/ taskDefinition: string; /** *

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.

*/ overrides?: _TaskOverride; /** *

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.

*/ containerInstances: Array | Iterable; /** *

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.

*/ startedBy?: string; /** *

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).

*/ group?: string; /** *

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

*/ networkConfiguration?: _NetworkConfiguration; /** *

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. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.

*/ tags?: Array<_Tag> | Iterable<_Tag>; /** *

Specifies whether to enable Amazon ECS managed tags for the task. For more information, see Tagging Your Amazon ECS Resources in the Amazon Elastic Container Service Developer Guide.

*/ enableECSManagedTags?: boolean; /** *

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.

*/ propagateTags?: "TASK_DEFINITION" | "SERVICE" | string; /** * The maximum number of times this operation should be retried. If set, this value will override the `maxRetries` configuration set on the client for this command. */ $maxRetries?: number; /** * An object that may be queried to determine if the underlying operation has been aborted. * * @see https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal */ $abortSignal?: __aws_sdk_types.AbortSignal; /** * Per-request HTTP configuration options. If set, any options specified will override the corresponding HTTP option set on the client for this command. */ $httpOptions?: __HttpOptions__; }