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

Interface RunTaskRequest.Builder

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

  • Method Details

    • capacityProviderStrategy

      RunTaskRequest.Builder capacityProviderStrategy(Collection<CapacityProviderStrategyItem> capacityProviderStrategy)

      The capacity provider strategy to use for the task.

      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.

      When you use cluster auto scaling, you must specify capacityProviderStrategy and not launchType.

      A capacity provider strategy may contain a maximum of 6 capacity providers.

      Parameters:
      capacityProviderStrategy - The capacity provider strategy to use for the task.

      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.

      When you use cluster auto scaling, you must specify capacityProviderStrategy and not launchType.

      A capacity provider strategy may contain a maximum of 6 capacity providers.

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

    • capacityProviderStrategy

      RunTaskRequest.Builder capacityProviderStrategy(CapacityProviderStrategyItem... capacityProviderStrategy)

      The capacity provider strategy to use for the task.

      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.

      When you use cluster auto scaling, you must specify capacityProviderStrategy and not launchType.

      A capacity provider strategy may contain a maximum of 6 capacity providers.

      Parameters:
      capacityProviderStrategy - The capacity provider strategy to use for the task.

      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.

      When you use cluster auto scaling, you must specify capacityProviderStrategy and not launchType.

      A capacity provider strategy may contain a maximum of 6 capacity providers.

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

    • capacityProviderStrategy

      RunTaskRequest.Builder capacityProviderStrategy(Consumer<CapacityProviderStrategyItem.Builder>... capacityProviderStrategy)

      The capacity provider strategy to use for the task.

      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.

      When you use cluster auto scaling, you must specify capacityProviderStrategy and not launchType.

      A capacity provider strategy may contain a maximum of 6 capacity providers.

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

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

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

    • cluster

      RunTaskRequest.Builder cluster(String cluster)

      The short name or full Amazon Resource Name (ARN) of the cluster to run your task on. 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 to run your task on. 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.

    • count

      RunTaskRequest.Builder count(Integer count)

      The number of instantiations of the specified task to place on your cluster. You can specify up to 10 tasks for each call.

      Parameters:
      count - The number of instantiations of the specified task to place on your cluster. You can specify up to 10 tasks for each call.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • enableECSManagedTags

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

      RunTaskRequest.Builder enableExecuteCommand(Boolean enableExecuteCommand)

      Determines whether to use the execute command functionality for the containers in this task. If true, this enables execute command functionality on all containers in the task.

      If true, then the task definition must have a task role, or you must provide one as an override.

      Parameters:
      enableExecuteCommand - Determines whether to use the execute command functionality for the containers in this task. If true, this enables execute command functionality on all containers in the task.

      If true, then the task definition must have a task role, or you must provide one as an override.

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

    • group

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

    • launchType

      RunTaskRequest.Builder launchType(String launchType)

      The infrastructure to run your standalone task on. For more information, see Amazon ECS launch types in the Amazon Elastic Container Service Developer Guide.

      The FARGATE launch type runs your tasks on Fargate On-Demand infrastructure.

      Fargate Spot infrastructure is available for use but a capacity provider strategy must be used. For more information, see Fargate capacity providers in the Amazon ECS Developer Guide.

      The EC2 launch type runs your tasks on Amazon EC2 instances registered to your cluster.

      The EXTERNAL launch type runs your tasks on your on-premises server or virtual machine (VM) capacity registered to your cluster.

      A task can use either a launch type or a capacity provider strategy. If a launchType is specified, the capacityProviderStrategy parameter must be omitted.

      When you use cluster auto scaling, you must specify capacityProviderStrategy and not launchType.

      Parameters:
      launchType - The infrastructure to run your standalone task on. For more information, see Amazon ECS launch types in the Amazon Elastic Container Service Developer Guide.

      The FARGATE launch type runs your tasks on Fargate On-Demand infrastructure.

      Fargate Spot infrastructure is available for use but a capacity provider strategy must be used. For more information, see Fargate capacity providers in the Amazon ECS Developer Guide.

      The EC2 launch type runs your tasks on Amazon EC2 instances registered to your cluster.

      The EXTERNAL launch type runs your tasks on your on-premises server or virtual machine (VM) capacity registered to your cluster.

      A task can use either a launch type or a capacity provider strategy. If a launchType is specified, the capacityProviderStrategy parameter must be omitted.

      When you use cluster auto scaling, you must specify capacityProviderStrategy and not launchType.

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

    • launchType

      RunTaskRequest.Builder launchType(LaunchType launchType)

      The infrastructure to run your standalone task on. For more information, see Amazon ECS launch types in the Amazon Elastic Container Service Developer Guide.

      The FARGATE launch type runs your tasks on Fargate On-Demand infrastructure.

      Fargate Spot infrastructure is available for use but a capacity provider strategy must be used. For more information, see Fargate capacity providers in the Amazon ECS Developer Guide.

      The EC2 launch type runs your tasks on Amazon EC2 instances registered to your cluster.

      The EXTERNAL launch type runs your tasks on your on-premises server or virtual machine (VM) capacity registered to your cluster.

      A task can use either a launch type or a capacity provider strategy. If a launchType is specified, the capacityProviderStrategy parameter must be omitted.

      When you use cluster auto scaling, you must specify capacityProviderStrategy and not launchType.

      Parameters:
      launchType - The infrastructure to run your standalone task on. For more information, see Amazon ECS launch types in the Amazon Elastic Container Service Developer Guide.

      The FARGATE launch type runs your tasks on Fargate On-Demand infrastructure.

      Fargate Spot infrastructure is available for use but a capacity provider strategy must be used. For more information, see Fargate capacity providers in the Amazon ECS Developer Guide.

      The EC2 launch type runs your tasks on Amazon EC2 instances registered to your cluster.

      The EXTERNAL launch type runs your tasks on your on-premises server or virtual machine (VM) capacity registered to your cluster.

      A task can use either a launch type or a capacity provider strategy. If a launchType is specified, the capacityProviderStrategy parameter must be omitted.

      When you use cluster auto scaling, you must specify capacityProviderStrategy and not launchType.

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

    • networkConfiguration

      RunTaskRequest.Builder networkConfiguration(NetworkConfiguration networkConfiguration)

      The network configuration for the task. This parameter is required for task definitions that use the awsvpc network mode to receive their own elastic network interface, and it isn't supported for other network modes. For more information, see Task networking in the Amazon Elastic Container Service Developer Guide.

      Parameters:
      networkConfiguration - The network configuration for the task. This parameter is required for task definitions that use the awsvpc network mode to receive their own elastic network interface, and it isn't supported for other network modes. For more information, see Task networking in the Amazon Elastic Container Service Developer Guide.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • networkConfiguration

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

      The network configuration for the task. This parameter is required for task definitions that use the awsvpc network mode to receive their own elastic network interface, and it isn't supported for other network modes. For more information, see Task networking in the Amazon Elastic Container Service Developer Guide.

      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

      RunTaskRequest.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'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 should receive. 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 RunTaskRequest.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'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:

    • placementConstraints

      RunTaskRequest.Builder placementConstraints(Collection<PlacementConstraint> placementConstraints)

      An array of placement constraint objects to use for the task. You can specify up to 10 constraints for each task (including constraints in the task definition and those specified at runtime).

      Parameters:
      placementConstraints - An array of placement constraint objects to use for the task. You can specify up to 10 constraints for each task (including constraints in the task definition and those specified at runtime).
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • placementConstraints

      RunTaskRequest.Builder placementConstraints(PlacementConstraint... placementConstraints)

      An array of placement constraint objects to use for the task. You can specify up to 10 constraints for each task (including constraints in the task definition and those specified at runtime).

      Parameters:
      placementConstraints - An array of placement constraint objects to use for the task. You can specify up to 10 constraints for each task (including constraints in the task definition and those specified at runtime).
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • placementConstraints

      RunTaskRequest.Builder placementConstraints(Consumer<PlacementConstraint.Builder>... placementConstraints)

      An array of placement constraint objects to use for the task. You can specify up to 10 constraints for each task (including constraints in the task definition and those specified at runtime).

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

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

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

    • placementStrategy

      RunTaskRequest.Builder placementStrategy(Collection<PlacementStrategy> placementStrategy)

      The placement strategy objects to use for the task. You can specify a maximum of 5 strategy rules for each task.

      Parameters:
      placementStrategy - The placement strategy objects to use for the task. You can specify a maximum of 5 strategy rules for each task.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • placementStrategy

      RunTaskRequest.Builder placementStrategy(PlacementStrategy... placementStrategy)

      The placement strategy objects to use for the task. You can specify a maximum of 5 strategy rules for each task.

      Parameters:
      placementStrategy - The placement strategy objects to use for the task. You can specify a maximum of 5 strategy rules for each task.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • placementStrategy

      RunTaskRequest.Builder placementStrategy(Consumer<PlacementStrategy.Builder>... placementStrategy)

      The placement strategy objects to use for the task. You can specify a maximum of 5 strategy rules for each task.

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

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

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

    • platformVersion

      RunTaskRequest.Builder platformVersion(String platformVersion)

      The platform version the task uses. A platform version is only specified for tasks hosted on Fargate. If one isn't specified, the LATEST platform version is used. For more information, see Fargate platform versions in the Amazon Elastic Container Service Developer Guide.

      Parameters:
      platformVersion - The platform version the task uses. A platform version is only specified for tasks hosted on Fargate. If one isn't specified, the LATEST platform version is used. For more information, see Fargate platform versions in the Amazon Elastic Container Service Developer Guide.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • propagateTags

      RunTaskRequest.Builder propagateTags(String propagateTags)

      Specifies whether to propagate the tags from the task definition to the task. If no value is specified, the tags aren't propagated. Tags can only be propagated to the task during task creation. To add tags to a task after task creation, use the TagResource API action.

      An error will be received if you specify the SERVICE option when running a task.

      Parameters:
      propagateTags - Specifies whether to propagate the tags from the task definition to the task. If no value is specified, the tags aren't propagated. Tags can only be propagated to the task during task creation. To add tags to a task after task creation, use the TagResource API action.

      An error will be received if you specify the SERVICE option when running a task.

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

    • propagateTags

      RunTaskRequest.Builder propagateTags(PropagateTags propagateTags)

      Specifies whether to propagate the tags from the task definition to the task. If no value is specified, the tags aren't propagated. Tags can only be propagated to the task during task creation. To add tags to a task after task creation, use the TagResource API action.

      An error will be received if you specify the SERVICE option when running a task.

      Parameters:
      propagateTags - Specifies whether to propagate the tags from the task definition to the task. If no value is specified, the tags aren't propagated. Tags can only be propagated to the task during task creation. To add tags to a task after task creation, use the TagResource API action.

      An error will be received if you specify the SERVICE option when running a task.

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

    • referenceId

      RunTaskRequest.Builder referenceId(String referenceId)

      The reference ID to use for the task. The reference ID can have a maximum length of 1024 characters.

      Parameters:
      referenceId - The reference ID to use for the task. The reference ID can have a maximum length of 1024 characters.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • startedBy

      RunTaskRequest.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 128 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 128 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.

    • tags

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

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

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

      RunTaskRequest.Builder taskDefinition(String taskDefinition)

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

      The full ARN value must match the value that you specified as the Resource of the principal's permissions policy.

      When you specify a task definition, you must either specify a specific revision, or all revisions in the ARN.

      To specify a specific revision, include the revision number in the ARN. For example, to specify revision 2, use arn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName:2.

      To specify all revisions, use the wildcard (*) in the ARN. For example, to specify all revisions, use arn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName:*.

      For more information, see Policy Resources for Amazon ECS in the Amazon Elastic Container Service Developer Guide.

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

      The full ARN value must match the value that you specified as the Resource of the principal's permissions policy.

      When you specify a task definition, you must either specify a specific revision, or all revisions in the ARN.

      To specify a specific revision, include the revision number in the ARN. For example, to specify revision 2, use arn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName:2.

      To specify all revisions, use the wildcard (*) in the ARN. For example, to specify all revisions, use arn:aws:ecs:us-east-1:111122223333:task-definition/TaskFamilyName:*.

      For more information, see Policy Resources for Amazon ECS in the Amazon Elastic Container Service Developer Guide.

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

    • clientToken

      RunTaskRequest.Builder clientToken(String clientToken)

      An identifier that you provide to ensure the idempotency of the request. It must be unique and is case sensitive. Up to 64 characters are allowed. The valid characters are characters in the range of 33-126, inclusive. For more information, see Ensuring idempotency.

      Parameters:
      clientToken - An identifier that you provide to ensure the idempotency of the request. It must be unique and is case sensitive. Up to 64 characters are allowed. The valid characters are characters in the range of 33-126, inclusive. For more information, see Ensuring idempotency.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • volumeConfigurations

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

      RunTaskRequest.Builder volumeConfigurations(TaskVolumeConfiguration... volumeConfigurations)

      The details of the volume that was configuredAtLaunch. You can configure the size, volumeType, IOPS, throughput, snapshot and encryption in 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 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

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

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

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