public static interface EcsParameters.Builder extends SdkPojo, CopyableBuilder<EcsParameters.Builder,EcsParameters>
Modifier and Type | Method and Description |
---|---|
EcsParameters.Builder |
capacityProviderStrategy(CapacityProviderStrategyItem... capacityProviderStrategy)
The capacity provider strategy to use for the task.
|
EcsParameters.Builder |
capacityProviderStrategy(Collection<CapacityProviderStrategyItem> capacityProviderStrategy)
The capacity provider strategy to use for the task.
|
EcsParameters.Builder |
capacityProviderStrategy(Consumer<CapacityProviderStrategyItem.Builder>... capacityProviderStrategy)
The capacity provider strategy to use for the task.
|
EcsParameters.Builder |
enableECSManagedTags(Boolean enableECSManagedTags)
Specifies whether to enable Amazon ECS managed tags for the task.
|
EcsParameters.Builder |
enableExecuteCommand(Boolean enableExecuteCommand)
Whether or not to enable the execute command functionality for the containers in this task.
|
EcsParameters.Builder |
group(String group)
Specifies an ECS task group for the task.
|
EcsParameters.Builder |
launchType(LaunchType launchType)
Specifies the launch type on which your task is running.
|
EcsParameters.Builder |
launchType(String 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 the
awsvpc network mode. |
EcsParameters.Builder |
networkConfiguration(NetworkConfiguration networkConfiguration)
Use this structure if the Amazon ECS task uses the
awsvpc network mode. |
EcsParameters.Builder |
placementConstraints(Collection<PlacementConstraint> placementConstraints)
An array of placement constraint objects to use for the task.
|
EcsParameters.Builder |
placementConstraints(Consumer<PlacementConstraint.Builder>... placementConstraints)
An array of placement constraint objects to use for the task.
|
EcsParameters.Builder |
placementConstraints(PlacementConstraint... placementConstraints)
An array of placement constraint objects to use for the task.
|
EcsParameters.Builder |
placementStrategy(Collection<PlacementStrategy> placementStrategy)
The placement strategy objects to use for the task.
|
EcsParameters.Builder |
placementStrategy(Consumer<PlacementStrategy.Builder>... placementStrategy)
The placement strategy objects to use for the task.
|
EcsParameters.Builder |
placementStrategy(PlacementStrategy... placementStrategy)
The placement strategy objects to use for the task.
|
EcsParameters.Builder |
platformVersion(String platformVersion)
Specifies the platform version for the task.
|
EcsParameters.Builder |
propagateTags(PropagateTags propagateTags)
Specifies whether to propagate the tags from the task definition to the task.
|
EcsParameters.Builder |
propagateTags(String propagateTags)
Specifies whether to propagate the tags from the task definition to the task.
|
EcsParameters.Builder |
referenceId(String referenceId)
The reference ID to use for the task.
|
EcsParameters.Builder |
tags(Collection<Tag> tags)
The metadata that you apply to the task to help you categorize and organize them.
|
EcsParameters.Builder |
tags(Consumer<Tag.Builder>... tags)
The metadata that you apply to the task to help you categorize and organize them.
|
EcsParameters.Builder |
tags(Tag... tags)
The metadata that you apply to the task to help you categorize and organize them.
|
EcsParameters.Builder |
taskCount(Integer taskCount)
The number of tasks to create based on
TaskDefinition . |
EcsParameters.Builder |
taskDefinitionArn(String taskDefinitionArn)
The ARN of the task definition to use if the event target is an Amazon ECS task.
|
equalsBySdkFields, sdkFields
copy
applyMutation, build
EcsParameters.Builder taskDefinitionArn(String taskDefinitionArn)
The ARN of the task definition to use if the event target is an Amazon ECS task.
taskDefinitionArn
- The ARN of the task definition to use if the event target is an Amazon ECS task.EcsParameters.Builder taskCount(Integer taskCount)
The number of tasks to create based on TaskDefinition
. The default is 1.
taskCount
- The number of tasks to create based on TaskDefinition
. The default is 1.EcsParameters.Builder launchType(String 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 witt Amazon ECS is supported. For more information, see Fargate on Amazon ECS
in the Amazon Elastic Container Service Developer Guide.
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 witt Amazon ECS is supported. For more information, see Fargate on Amazon
ECS in the Amazon Elastic Container Service Developer Guide.LaunchType
,
LaunchType
EcsParameters.Builder launchType(LaunchType 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 witt Amazon ECS is supported. For more information, see Fargate on Amazon ECS
in the Amazon Elastic Container Service Developer Guide.
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 witt Amazon ECS is supported. For more information, see Fargate on Amazon
ECS in the Amazon Elastic Container Service Developer Guide.LaunchType
,
LaunchType
EcsParameters.Builder networkConfiguration(NetworkConfiguration 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 if LaunchType
is FARGATE
because the awsvpc
mode is required for Fargate tasks.
If you specify NetworkConfiguration
when the target ECS task does not use the
awsvpc
network mode, the task fails.
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 if LaunchType
is FARGATE
because the awsvpc
mode is required for Fargate tasks.
If you specify NetworkConfiguration
when the target ECS task does not use the
awsvpc
network mode, the task fails.
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 if LaunchType
is FARGATE
because the awsvpc
mode is required for Fargate tasks.
If you specify NetworkConfiguration
when the target ECS task does not use the
awsvpc
network mode, the task fails.
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)
.networkConfiguration
- a consumer that will call methods on NetworkConfiguration.Builder
networkConfiguration(NetworkConfiguration)
EcsParameters.Builder platformVersion(String 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
is FARGATE
. For more information about
valid platform versions, see Fargate Platform
Versions in the Amazon Elastic Container Service Developer Guide.
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
is FARGATE
. For more information
about valid platform versions, see Fargate
Platform Versions in the Amazon Elastic Container Service Developer Guide.
EcsParameters.Builder group(String group)
Specifies an ECS task group for the task. The maximum length is 255 characters.
group
- Specifies an ECS task group for the task. The maximum length is 255 characters.EcsParameters.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.
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.
EcsParameters.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.
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.
EcsParameters.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.
List.Builder
avoiding the need to create one manually via List#builder()
.
When the Consumer
completes, List.Builder#build()
is called
immediately and its result is passed to #capacityProviderStrategy(List)
.capacityProviderStrategy
- a consumer that will call methods on List.Builder
#capacityProviderStrategy(List)
EcsParameters.Builder enableECSManagedTags(Boolean 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.
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.EcsParameters.Builder enableExecuteCommand(Boolean 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.
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.EcsParameters.Builder placementConstraints(Collection<PlacementConstraint> 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).
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).EcsParameters.Builder placementConstraints(PlacementConstraint... 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).
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).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 that creates an instance of theList.Builder
avoiding the
need to create one manually via List#builder()
.
When the Consumer
completes, List.Builder#build()
is called immediately
and its result is passed to #placementConstraints(List)
.placementConstraints
- a consumer that will call methods on List.Builder
#placementConstraints(List)
EcsParameters.Builder placementStrategy(Collection<PlacementStrategy> placementStrategy)
The placement strategy objects to use for the task. You can specify a maximum of five strategy rules per task.
placementStrategy
- The placement strategy objects to use for the task. You can specify a maximum of five strategy rules
per task.EcsParameters.Builder placementStrategy(PlacementStrategy... placementStrategy)
The placement strategy objects to use for the task. You can specify a maximum of five strategy rules per task.
placementStrategy
- The placement strategy objects to use for the task. You can specify a maximum of five strategy rules
per task.EcsParameters.Builder placementStrategy(Consumer<PlacementStrategy.Builder>... 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 that creates an instance of theList.Builder
avoiding the
need to create one manually via List#builder()
.
When the Consumer
completes, List.Builder#build()
is called immediately
and its result is passed to #placementStrategy(List)
.placementStrategy
- a consumer that will call methods on List.Builder
#placementStrategy(List)
EcsParameters.Builder propagateTags(String 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.
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.PropagateTags
,
PropagateTags
EcsParameters.Builder propagateTags(PropagateTags 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.
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.PropagateTags
,
PropagateTags
EcsParameters.Builder referenceId(String referenceId)
The reference ID to use for the task.
referenceId
- The reference ID to use for the task.EcsParameters.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. To learn more, see RunTask in the Amazon ECS API Reference.
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.EcsParameters.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. To learn more, see RunTask in the Amazon ECS API Reference.
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.EcsParameters.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. To learn more, see RunTask in the Amazon ECS API Reference.
This is a convenience that creates an instance of theList.Builder
avoiding the need to create
one manually via List#builder()
.
When the Consumer
completes, List.Builder#build()
is called immediately and its result
is passed to #tags(List)
.tags
- a consumer that will call methods on List.Builder
#tags(List)
Copyright © 2022. All rights reserved.