Interface EcsParameters.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<EcsParameters.Builder,
,EcsParameters> SdkBuilder<EcsParameters.Builder,
,EcsParameters> SdkPojo
- Enclosing class:
EcsParameters
-
Method Summary
Modifier and TypeMethodDescriptioncapacityProviderStrategy
(Collection<CapacityProviderStrategyItem> capacityProviderStrategy) The capacity provider strategy to use for the task.capacityProviderStrategy
(Consumer<CapacityProviderStrategyItem.Builder>... capacityProviderStrategy) The capacity provider strategy to use for the task.capacityProviderStrategy
(CapacityProviderStrategyItem... capacityProviderStrategy) The capacity provider strategy to use for the task.enableECSManagedTags
(Boolean enableECSManagedTags) Specifies whether to enable Amazon ECS managed tags for the task.enableExecuteCommand
(Boolean enableExecuteCommand) Whether or not to enable the execute command functionality for the containers in this task.Specifies an ECS task group for the task.launchType
(String launchType) Specifies the launch type on which your task is running.launchType
(LaunchType launchType) Specifies the launch type on which your task is running.default EcsParameters.Builder
networkConfiguration
(Consumer<NetworkConfiguration.Builder> networkConfiguration) Use this structure if the Amazon ECS task uses theawsvpc
network mode.networkConfiguration
(NetworkConfiguration networkConfiguration) Use this structure if the Amazon ECS task uses theawsvpc
network mode.placementConstraints
(Collection<PlacementConstraint> placementConstraints) An array of placement constraint objects to use for the task.placementConstraints
(Consumer<PlacementConstraint.Builder>... placementConstraints) An array of placement constraint objects to use for the task.placementConstraints
(PlacementConstraint... placementConstraints) An array of placement constraint objects to use for the task.placementStrategy
(Collection<PlacementStrategy> placementStrategy) The placement strategy objects to use for the task.placementStrategy
(Consumer<PlacementStrategy.Builder>... placementStrategy) The placement strategy objects to use for the task.placementStrategy
(PlacementStrategy... placementStrategy) The placement strategy objects to use for the task.platformVersion
(String platformVersion) Specifies the platform version for the task.propagateTags
(String propagateTags) Specifies whether to propagate the tags from the task definition to the task.propagateTags
(PropagateTags propagateTags) Specifies whether to propagate the tags from the task definition to the task.referenceId
(String referenceId) The reference ID to use for the task.tags
(Collection<Tag> tags) The metadata that you apply to the task to help you categorize and organize them.tags
(Consumer<Tag.Builder>... tags) The metadata that you apply to the task to help you categorize and organize them.The metadata that you apply to the task to help you categorize and organize them.The number of tasks to create based onTaskDefinition
.taskDefinitionArn
(String taskDefinitionArn) The ARN of the task definition to use if the event target is an Amazon ECS task.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
taskDefinitionArn
The ARN of the task definition to use if the event target is an Amazon ECS task.
- Parameters:
taskDefinitionArn
- The ARN of the task definition to use if the event target is an Amazon ECS task.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
taskCount
The number of tasks to create based on
TaskDefinition
. The default is 1.- Parameters:
taskCount
- The number of tasks to create based onTaskDefinition
. The default is 1.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
launchType
Specifies the launch type on which your task is running. The launch type that you specify here must match one of the launch type (compatibilities) of the target task. The
FARGATE
value is supported only in the Regions where Fargate with Amazon ECS is supported. For more information, see Fargate on Amazon ECS in the Amazon Elastic Container Service Developer Guide.- Parameters:
launchType
- Specifies the launch type on which your task is running. The launch type that you specify here must match one of the launch type (compatibilities) of the target task. TheFARGATE
value is supported only in the Regions where Fargate with Amazon ECS is supported. For more information, see Fargate on 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.
- See Also:
-
launchType
Specifies the launch type on which your task is running. The launch type that you specify here must match one of the launch type (compatibilities) of the target task. The
FARGATE
value is supported only in the Regions where Fargate with Amazon ECS is supported. For more information, see Fargate on Amazon ECS in the Amazon Elastic Container Service Developer Guide.- Parameters:
launchType
- Specifies the launch type on which your task is running. The launch type that you specify here must match one of the launch type (compatibilities) of the target task. TheFARGATE
value is supported only in the Regions where Fargate with Amazon ECS is supported. For more information, see Fargate on 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.
- See Also:
-
networkConfiguration
Use this structure if the Amazon ECS task uses the
awsvpc
network mode. This structure specifies the VPC subnets and security groups associated with the task, and whether a public IP address is to be used. This structure is required ifLaunchType
isFARGATE
because theawsvpc
mode is required for Fargate tasks.If you specify
NetworkConfiguration
when the target ECS task does not use theawsvpc
network mode, the task fails.- Parameters:
networkConfiguration
- Use this structure if the Amazon ECS task uses theawsvpc
network mode. This structure specifies the VPC subnets and security groups associated with the task, and whether a public IP address is to be used. This structure is required ifLaunchType
isFARGATE
because theawsvpc
mode is required for Fargate tasks.If you specify
NetworkConfiguration
when the target ECS task does not use theawsvpc
network mode, the task fails.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
networkConfiguration
default EcsParameters.Builder networkConfiguration(Consumer<NetworkConfiguration.Builder> networkConfiguration) Use this structure if the Amazon ECS task uses the
awsvpc
network mode. This structure specifies the VPC subnets and security groups associated with the task, and whether a public IP address is to be used. This structure is required ifLaunchType
isFARGATE
because theawsvpc
mode is required for Fargate tasks.If you specify
This is a convenience method that creates an instance of theNetworkConfiguration
when the target ECS task does not use theawsvpc
network mode, the task fails.NetworkConfiguration.Builder
avoiding the need to create one manually viaNetworkConfiguration.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tonetworkConfiguration(NetworkConfiguration)
.- Parameters:
networkConfiguration
- a consumer that will call methods onNetworkConfiguration.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
platformVersion
Specifies the platform version for the task. Specify only the numeric portion of the platform version, such as
1.1.0
.This structure is used only if
LaunchType
isFARGATE
. For more information about valid platform versions, see Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.- Parameters:
platformVersion
- Specifies the platform version for the task. Specify only the numeric portion of the platform version, such as1.1.0
.This structure is used only if
LaunchType
isFARGATE
. For more information about valid platform versions, 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.
-
group
Specifies an ECS task group for the task. The maximum length is 255 characters.
- Parameters:
group
- Specifies an ECS task group for the task. The maximum length is 255 characters.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
capacityProviderStrategy
EcsParameters.Builder capacityProviderStrategy(Collection<CapacityProviderStrategyItem> capacityProviderStrategy) The capacity provider strategy to use for the task.
If a
capacityProviderStrategy
is specified, thelaunchType
parameter must be omitted. If nocapacityProviderStrategy
or launchType is specified, thedefaultCapacityProviderStrategy
for the cluster is used.- Parameters:
capacityProviderStrategy
- The capacity provider strategy to use for the task.If a
capacityProviderStrategy
is specified, thelaunchType
parameter must be omitted. If nocapacityProviderStrategy
or launchType is specified, thedefaultCapacityProviderStrategy
for the cluster is used.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
capacityProviderStrategy
EcsParameters.Builder capacityProviderStrategy(CapacityProviderStrategyItem... capacityProviderStrategy) The capacity provider strategy to use for the task.
If a
capacityProviderStrategy
is specified, thelaunchType
parameter must be omitted. If nocapacityProviderStrategy
or launchType is specified, thedefaultCapacityProviderStrategy
for the cluster is used.- Parameters:
capacityProviderStrategy
- The capacity provider strategy to use for the task.If a
capacityProviderStrategy
is specified, thelaunchType
parameter must be omitted. If nocapacityProviderStrategy
or launchType is specified, thedefaultCapacityProviderStrategy
for the cluster is used.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
capacityProviderStrategy
EcsParameters.Builder capacityProviderStrategy(Consumer<CapacityProviderStrategyItem.Builder>... capacityProviderStrategy) The capacity provider strategy to use for the task.
If a
This is a convenience method that creates an instance of thecapacityProviderStrategy
is specified, thelaunchType
parameter must be omitted. If nocapacityProviderStrategy
or launchType is specified, thedefaultCapacityProviderStrategy
for the cluster is used.CapacityProviderStrategyItem.Builder
avoiding the need to create one manually viaCapacityProviderStrategyItem.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tocapacityProviderStrategy(List<CapacityProviderStrategyItem>)
.- Parameters:
capacityProviderStrategy
- a consumer that will call methods onCapacityProviderStrategyItem.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
enableECSManagedTags
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.
- Parameters:
enableECSManagedTags
- 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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
enableExecuteCommand
Whether or not to enable the execute command functionality for the containers in this task. If true, this enables execute command functionality on all containers in the task.
- Parameters:
enableExecuteCommand
- Whether or not to enable the execute command functionality for the containers in this task. If true, this enables execute command functionality on all containers in the task.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
placementConstraints
An array of placement constraint objects to use for the task. You can specify up to 10 constraints per 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 per 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
An array of placement constraint objects to use for the task. You can specify up to 10 constraints per 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 per 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
EcsParameters.Builder placementConstraints(Consumer<PlacementConstraint.Builder>... placementConstraints) An array of placement constraint objects to use for the task. You can specify up to 10 constraints per task (including constraints in the task definition and those specified at runtime).
This is a convenience method that creates an instance of thePlacementConstraint.Builder
avoiding the need to create one manually viaPlacementConstraint.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toplacementConstraints(List<PlacementConstraint>)
.- Parameters:
placementConstraints
- a consumer that will call methods onPlacementConstraint.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
placementStrategy
The placement strategy objects to use for the task. You can specify a maximum of five strategy rules per task.
- Parameters:
placementStrategy
- The placement strategy objects to use for the task. You can specify a maximum of five strategy rules per task.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
placementStrategy
The placement strategy objects to use for the task. You can specify a maximum of five strategy rules per task.
- Parameters:
placementStrategy
- The placement strategy objects to use for the task. You can specify a maximum of five strategy rules per task.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
placementStrategy
The placement strategy objects to use for the task. You can specify a maximum of five strategy rules per task.
This is a convenience method that creates an instance of thePlacementStrategy.Builder
avoiding the need to create one manually viaPlacementStrategy.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toplacementStrategy(List<PlacementStrategy>)
.- Parameters:
placementStrategy
- a consumer that will call methods onPlacementStrategy.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
propagateTags
Specifies whether to propagate the tags from the task definition to the task. If no value is specified, the tags are not 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.
- Parameters:
propagateTags
- Specifies whether to propagate the tags from the task definition to the task. If no value is specified, the tags are not 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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
propagateTags
Specifies whether to propagate the tags from the task definition to the task. If no value is specified, the tags are not 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.
- Parameters:
propagateTags
- Specifies whether to propagate the tags from the task definition to the task. If no value is specified, the tags are not 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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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.
-
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. To learn more, see RunTask in the Amazon ECS API Reference.
- 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. To learn more, see RunTask in the Amazon ECS API Reference.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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. To learn more, see RunTask in the Amazon ECS API Reference.
- 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. To learn more, see RunTask in the Amazon ECS API Reference.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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. To learn more, see RunTask in the Amazon ECS API Reference.
This is a convenience method that creates an instance of theTag.Builder
avoiding the need to create one manually viaTag.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed totags(List<Tag>)
.- Parameters:
tags
- a consumer that will call methods onTag.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-