Package software.amazon.awssdk.services.ecs.model

Interface StartTaskRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<StartTaskRequest.Builder,StartTaskRequest>, EcsRequest.Builder, SdkBuilder<StartTaskRequest.Builder,StartTaskRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
StartTaskRequest
public static interface StartTaskRequest.Builder extends EcsRequest.Builder, SdkPojo, CopyableBuilder<StartTaskRequest.Builder,StartTaskRequest>

  • Method Details

    • cluster

      StartTaskRequest.Builder cluster(String cluster)

      The short name or full Amazon Resource Name (ARN) of the cluster where 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 where 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.

    • containerInstances

      StartTaskRequest.Builder containerInstances(Collection<String> containerInstances)

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

      Parameters:
      containerInstances - The container instance IDs or full ARN entries for the container instances where 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 ARN entries for the container instances where you would like to place your task. You can specify up to 10 container instances.

      Parameters:
      containerInstances - The container instance IDs or full ARN entries for the container instances where 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.

    • enableECSManagedTags

      StartTaskRequest.Builder enableECSManagedTags(Boolean enableECSManagedTags)

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

      Parameters:
      enableECSManagedTags - Specifies whether to use Amazon ECS managed tags for the task. For more information, see Tagging Your Amazon ECS Resources in the Amazon Elastic Container Service Developer Guide.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • enableExecuteCommand

      StartTaskRequest.Builder enableExecuteCommand(Boolean enableExecuteCommand)

      Whether or not the execute command functionality is turned on for the task. If true, this turns on the execute command functionality on all containers in the task.

      Parameters:
      enableExecuteCommand - Whether or not the execute command functionality is turned on for the task. If true, this turns on the execute command functionality on all containers in the task.
      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 method 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:

    • 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 receives. You can override the default command for a container (that's 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 receives. You can override the default command for a container (that's 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 receives. You can override the default command for a container (that's 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 method 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:

    • propagateTags

      StartTaskRequest.Builder propagateTags(String propagateTags)

      Specifies whether to propagate the tags from the task definition or the service to the task. If no value is specified, the tags aren't propagated.

      Parameters:
      propagateTags - Specifies whether to propagate the tags from the task definition or the service to the task. If no value is specified, the tags aren't propagated.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • propagateTags

      StartTaskRequest.Builder propagateTags(PropagateTags propagateTags)

      Specifies whether to propagate the tags from the task definition or the service to the task. If no value is specified, the tags aren't propagated.

      Parameters:
      propagateTags - Specifies whether to propagate the tags from the task definition or the service to the task. If no value is specified, the tags aren't propagated.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • referenceId

      StartTaskRequest.Builder referenceId(String referenceId)

      The reference ID to use for the task.

      Parameters:
      referenceId - The reference ID to use for the task.
      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, 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, 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.

    • tags

      StartTaskRequest.Builder tags(Collection<Tag> tags)

      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 Amazon Web Services 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.

      Parameters:
      tags - 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 Amazon Web Services 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.

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

    • tags

      StartTaskRequest.Builder tags(Tag... tags)

      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 Amazon Web Services 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.

      Parameters:
      tags - 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 Amazon Web Services 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.

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

    • tags

      StartTaskRequest.Builder tags(Consumer<Tag.Builder>... tags)

      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 Amazon Web Services 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.

      This is a convenience method that creates an instance of the Tag.Builder avoiding the need to create one manually via Tag.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to tags(List<Tag>).

      Parameters:
      tags - a consumer that will call methods on Tag.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • taskDefinition

      StartTaskRequest.Builder taskDefinition(String taskDefinition)

      The family and revision (family:revision) or full ARN of the task definition to start. If a revision isn't specified, the latest ACTIVE revision is used.

      Parameters:
      taskDefinition - The family and revision (family:revision) or full ARN of the task definition to start. If a revision isn't specified, the latest ACTIVE revision is used.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • volumeConfigurations

      StartTaskRequest.Builder volumeConfigurations(Collection<TaskVolumeConfiguration> volumeConfigurations)

      The details of the volume that was configuredAtLaunch. You can configure the size, volumeType, IOPS, throughput, snapshot and encryption in TaskManagedEBSVolumeConfiguration. The name of the volume must match the name from the task definition.

      Parameters:
      volumeConfigurations - The details of the volume that was configuredAtLaunch. You can configure the size, volumeType, IOPS, throughput, snapshot and encryption in TaskManagedEBSVolumeConfiguration. The name of the volume must match the name from the task definition.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • volumeConfigurations

      StartTaskRequest.Builder volumeConfigurations(TaskVolumeConfiguration... volumeConfigurations)

      The details of the volume that was configuredAtLaunch. You can configure the size, volumeType, IOPS, throughput, snapshot and encryption in TaskManagedEBSVolumeConfiguration. The name of the volume must match the name from the task definition.

      Parameters:
      volumeConfigurations - The details of the volume that was configuredAtLaunch. You can configure the size, volumeType, IOPS, throughput, snapshot and encryption in TaskManagedEBSVolumeConfiguration. The name of the volume must match the name from the task definition.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • volumeConfigurations

      StartTaskRequest.Builder volumeConfigurations(Consumer<TaskVolumeConfiguration.Builder>... volumeConfigurations)

      The details of the volume that was configuredAtLaunch. You can configure the size, volumeType, IOPS, throughput, snapshot and encryption in TaskManagedEBSVolumeConfiguration. The name of the volume must match the name from the task definition.

      This is a convenience method that creates an instance of the TaskVolumeConfiguration.Builder avoiding the need to create one manually via TaskVolumeConfiguration.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to volumeConfigurations(List<TaskVolumeConfiguration>).

      Parameters:
      volumeConfigurations - a consumer that will call methods on TaskVolumeConfiguration.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

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