software.amazon.awssdk.services.ecs.model

Interface StartTaskRequest.Builder

All Superinterfaces:

AwsRequest.Builder, CopyableBuilder<StartTaskRequest.Builder,StartTaskRequest>, EcsRequest.Builder, SdkBuilder<StartTaskRequest.Builder,StartTaskRequest>, SdkRequest.Builder

Enclosing class:

StartTaskRequest

public static interface StartTaskRequest.Builder
extends EcsRequest.Builder, CopyableBuilder<StartTaskRequest.Builder,StartTaskRequest>

Method Summary

Modifier and Type	Method and Description
StartTaskRequest.Builder	cluster(String cluster) The short name or full Amazon Resource Name (ARN) of the cluster on which to start your task.
StartTaskRequest.Builder	containerInstances(Collection<String> containerInstances) The container instance IDs or full Amazon Resource Name (ARN) entries for the container instances on which you would like to place your task.
StartTaskRequest.Builder	containerInstances(String... containerInstances) The container instance IDs or full Amazon Resource Name (ARN) entries for the container instances on which you would like to place your task.
StartTaskRequest.Builder	group(String group) The name of the task group to associate with the task.
default StartTaskRequest.Builder	networkConfiguration(Consumer<NetworkConfiguration.Builder> networkConfiguration) The VPC subnet and security group configuration for tasks that receive their own Elastic Network Interface by using the awsvpc networking mode.
StartTaskRequest.Builder	networkConfiguration(NetworkConfiguration networkConfiguration) The VPC subnet and security group configuration for tasks that receive their own Elastic Network Interface by using the awsvpc networking mode.
StartTaskRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.
StartTaskRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.
default StartTaskRequest.Builder	overrides(Consumer<TaskOverride.Builder> overrides) 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.
StartTaskRequest.Builder	overrides(TaskOverride overrides) 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.
StartTaskRequest.Builder	startedBy(String startedBy) An optional tag specified when a task is started.
StartTaskRequest.Builder	taskDefinition(String taskDefinition) The family and revision (family:revision) or full Amazon Resource Name (ARN) of the task definition to start.

Methods inherited from interface software.amazon.awssdk.services.ecs.model.EcsRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

cluster

StartTaskRequest.Builder cluster(String cluster)

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.

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

taskDefinition

StartTaskRequest.Builder taskDefinition(String taskDefinition)

The family and revision (family:revision) or full Amazon Resource Name (ARN) of the task definition to start. If a revision is not specified, the latest ACTIVE revision is used.

Parameters:

taskDefinition - The family and revision (family:revision) or full Amazon Resource Name (ARN) of the task definition to start. If a revision is not specified, the latest ACTIVE revision is used.

Returns:

Returns a reference to this object so that method calls can be chained together.

overrides

StartTaskRequest.Builder overrides(TaskOverride overrides)

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.

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

overrides

default StartTaskRequest.Builder overrides(Consumer<TaskOverride.Builder> overrides)

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.

This is a convenience that creates an instance of the TaskOverride.Builder avoiding the need to create one manually via TaskOverride.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to overrides(TaskOverride).

Parameters:

overrides - a consumer that will call methods on TaskOverride.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

overrides(TaskOverride)

containerInstances

StartTaskRequest.Builder containerInstances(Collection<String> containerInstances)

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

Parameters:

containerInstances - The container instance IDs or full Amazon Resource Name (ARN) entries for the container instances on which you would like to place your task. You can specify up to 10 container instances.

Returns:

Returns a reference to this object so that method calls can be chained together.

containerInstances

StartTaskRequest.Builder containerInstances(String... containerInstances)

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

Parameters:

containerInstances - The container instance IDs or full Amazon Resource Name (ARN) entries for the container instances on which you would like to place your task. You can specify up to 10 container instances.

Returns:

Returns a reference to this object so that method calls can be chained together.

startedBy

StartTaskRequest.Builder startedBy(String startedBy)

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.

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

group

StartTaskRequest.Builder group(String group)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

networkConfiguration

StartTaskRequest.Builder networkConfiguration(NetworkConfiguration networkConfiguration)

The VPC subnet and security group configuration for tasks that receive their own Elastic Network Interface by using the awsvpc networking mode.

Parameters:

networkConfiguration - The VPC subnet and security group configuration for tasks that receive their own Elastic Network Interface by using the awsvpc networking mode.

Returns:

Returns a reference to this object so that method calls can be chained together.

networkConfiguration

default StartTaskRequest.Builder networkConfiguration(Consumer<NetworkConfiguration.Builder> networkConfiguration)

The VPC subnet and security group configuration for tasks that receive their own Elastic Network Interface by using the awsvpc networking mode.

This is a convenience that creates an instance of the NetworkConfiguration.Builder avoiding the need to create one manually via NetworkConfiguration.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to networkConfiguration(NetworkConfiguration).

Parameters:

networkConfiguration - a consumer that will call methods on NetworkConfiguration.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

networkConfiguration(NetworkConfiguration)

overrideConfiguration

StartTaskRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

overrideConfiguration - The override configuration.

Returns:

This object for method chaining.

overrideConfiguration

StartTaskRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.

Returns:

This object for method chaining.