software.amazon.awssdk.services.eventbridge.model

Interface EcsParameters.Builder

All Superinterfaces:

Buildable, CopyableBuilder<EcsParameters.Builder,EcsParameters>, SdkBuilder<EcsParameters.Builder,EcsParameters>, SdkPojo

Enclosing class:

EcsParameters

public static interface EcsParameters.Builder
extends SdkPojo, CopyableBuilder<EcsParameters.Builder,EcsParameters>

Method Summary

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.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

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

copy

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

applyMutation, build

Method Detail

taskDefinitionArn

EcsParameters.Builder taskDefinitionArn(String 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

EcsParameters.Builder taskCount(Integer taskCount)

The number of tasks to create based on TaskDefinition. The default is 1.

Parameters:

taskCount - The number of tasks to create based on TaskDefinition. The default is 1.

Returns:

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

launchType

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

Returns:

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

See Also:

LaunchType, 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 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. 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.

Returns:

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

See Also:

LaunchType, LaunchType

networkConfiguration

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.

Parameters:

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.

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

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:

networkConfiguration(NetworkConfiguration)

platformVersion

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.

Parameters:

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.

Returns:

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

group

EcsParameters.Builder group(String 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, the launchType parameter must be omitted. If no capacityProviderStrategy or launchType is specified, the defaultCapacityProviderStrategy for the cluster is used.

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.

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, the launchType parameter must be omitted. If no capacityProviderStrategy or launchType is specified, the defaultCapacityProviderStrategy for the cluster is used.

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.

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 capacityProviderStrategy is specified, the launchType parameter must be omitted. If no capacityProviderStrategy or launchType is specified, the defaultCapacityProviderStrategy for the cluster is used.

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

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:

#capacityProviderStrategy(java.util.Collection)

enableECSManagedTags

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.

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

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.

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

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

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

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

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:

#placementConstraints(java.util.Collection)

placementStrategy

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.

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

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.

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

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

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:

#placementStrategy(java.util.Collection)

propagateTags

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.

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

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, PropagateTags

referenceId

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

tags

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.

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

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.

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

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

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:

#tags(java.util.Collection)