Class CfnSchedulePropsMixin.EcsParametersProperty.Builder
java.lang.Object
software.amazon.awscdk.cfnpropertymixins.services.scheduler.CfnSchedulePropsMixin.EcsParametersProperty.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<CfnSchedulePropsMixin.EcsParametersProperty>
- Enclosing interface:
CfnSchedulePropsMixin.EcsParametersProperty
@Stability(Stable)
public static final class CfnSchedulePropsMixin.EcsParametersProperty.Builder
extends Object
implements software.amazon.jsii.Builder<CfnSchedulePropsMixin.EcsParametersProperty>
A builder for
CfnSchedulePropsMixin.EcsParametersProperty-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbuild()Builds the configured instance.capacityProviderStrategy(List<? extends Object> capacityProviderStrategy) capacityProviderStrategy(IResolvable capacityProviderStrategy) enableEcsManagedTags(Boolean enableEcsManagedTags) Sets the value ofCfnSchedulePropsMixin.EcsParametersProperty.getEnableEcsManagedTags()enableEcsManagedTags(IResolvable enableEcsManagedTags) Sets the value ofCfnSchedulePropsMixin.EcsParametersProperty.getEnableEcsManagedTags()enableExecuteCommand(Boolean enableExecuteCommand) Sets the value ofCfnSchedulePropsMixin.EcsParametersProperty.getEnableExecuteCommand()enableExecuteCommand(IResolvable enableExecuteCommand) Sets the value ofCfnSchedulePropsMixin.EcsParametersProperty.getEnableExecuteCommand()Sets the value ofCfnSchedulePropsMixin.EcsParametersProperty.getGroup()launchType(String launchType) Sets the value ofCfnSchedulePropsMixin.EcsParametersProperty.getLaunchType()networkConfiguration(CfnSchedulePropsMixin.NetworkConfigurationProperty networkConfiguration) Sets the value ofCfnSchedulePropsMixin.EcsParametersProperty.getNetworkConfiguration()networkConfiguration(IResolvable networkConfiguration) Sets the value ofCfnSchedulePropsMixin.EcsParametersProperty.getNetworkConfiguration()placementConstraints(List<? extends Object> placementConstraints) Sets the value ofCfnSchedulePropsMixin.EcsParametersProperty.getPlacementConstraints()placementConstraints(IResolvable placementConstraints) Sets the value ofCfnSchedulePropsMixin.EcsParametersProperty.getPlacementConstraints()placementStrategy(List<? extends Object> placementStrategy) Sets the value ofCfnSchedulePropsMixin.EcsParametersProperty.getPlacementStrategy()placementStrategy(IResolvable placementStrategy) Sets the value ofCfnSchedulePropsMixin.EcsParametersProperty.getPlacementStrategy()platformVersion(String platformVersion) Sets the value ofCfnSchedulePropsMixin.EcsParametersProperty.getPlatformVersion()propagateTags(String propagateTags) Sets the value ofCfnSchedulePropsMixin.EcsParametersProperty.getPropagateTags()referenceId(String referenceId) Sets the value ofCfnSchedulePropsMixin.EcsParametersProperty.getReferenceId()Sets the value ofCfnSchedulePropsMixin.EcsParametersProperty.getTags()Sets the value ofCfnSchedulePropsMixin.EcsParametersProperty.getTaskCount()taskDefinitionArn(String taskDefinitionArn) Sets the value ofCfnSchedulePropsMixin.EcsParametersProperty.getTaskDefinitionArn()
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
capacityProviderStrategy
@Stability(Stable) public CfnSchedulePropsMixin.EcsParametersProperty.Builder capacityProviderStrategy(IResolvable capacityProviderStrategy) - Parameters:
capacityProviderStrategy- The capacity provider strategy to use for the task.- Returns:
this
-
capacityProviderStrategy
@Stability(Stable) public CfnSchedulePropsMixin.EcsParametersProperty.Builder capacityProviderStrategy(List<? extends Object> capacityProviderStrategy) - Parameters:
capacityProviderStrategy- The capacity provider strategy to use for the task.- Returns:
this
-
enableEcsManagedTags
@Stability(Stable) public CfnSchedulePropsMixin.EcsParametersProperty.Builder enableEcsManagedTags(Boolean enableEcsManagedTags) Sets the value ofCfnSchedulePropsMixin.EcsParametersProperty.getEnableEcsManagedTags()- 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 ECS Developer Guide .- Returns:
this
-
enableEcsManagedTags
@Stability(Stable) public CfnSchedulePropsMixin.EcsParametersProperty.Builder enableEcsManagedTags(IResolvable enableEcsManagedTags) Sets the value ofCfnSchedulePropsMixin.EcsParametersProperty.getEnableEcsManagedTags()- 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 ECS Developer Guide .- Returns:
this
-
enableExecuteCommand
@Stability(Stable) public CfnSchedulePropsMixin.EcsParametersProperty.Builder enableExecuteCommand(Boolean enableExecuteCommand) Sets the value ofCfnSchedulePropsMixin.EcsParametersProperty.getEnableExecuteCommand()- 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:
this
-
enableExecuteCommand
@Stability(Stable) public CfnSchedulePropsMixin.EcsParametersProperty.Builder enableExecuteCommand(IResolvable enableExecuteCommand) Sets the value ofCfnSchedulePropsMixin.EcsParametersProperty.getEnableExecuteCommand()- 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:
this
-
group
Sets the value ofCfnSchedulePropsMixin.EcsParametersProperty.getGroup()- Parameters:
group- Specifies an Amazon ECS task group for the task. The maximum length is 255 characters.- Returns:
this
-
launchType
@Stability(Stable) public CfnSchedulePropsMixin.EcsParametersProperty.Builder launchType(String launchType) Sets the value ofCfnSchedulePropsMixin.EcsParametersProperty.getLaunchType()- 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. TheFARGATEvalue is supported only in the Regions where Fargate with Amazon ECS is supported. For more information, see AWS Fargate on Amazon ECS in the Amazon ECS Developer Guide .- Returns:
this
-
networkConfiguration
@Stability(Stable) public CfnSchedulePropsMixin.EcsParametersProperty.Builder networkConfiguration(IResolvable networkConfiguration) Sets the value ofCfnSchedulePropsMixin.EcsParametersProperty.getNetworkConfiguration()- Parameters:
networkConfiguration- This structure specifies the network configuration for an ECS task.- Returns:
this
-
networkConfiguration
@Stability(Stable) public CfnSchedulePropsMixin.EcsParametersProperty.Builder networkConfiguration(CfnSchedulePropsMixin.NetworkConfigurationProperty networkConfiguration) Sets the value ofCfnSchedulePropsMixin.EcsParametersProperty.getNetworkConfiguration()- Parameters:
networkConfiguration- This structure specifies the network configuration for an ECS task.- Returns:
this
-
placementConstraints
@Stability(Stable) public CfnSchedulePropsMixin.EcsParametersProperty.Builder placementConstraints(IResolvable placementConstraints) Sets the value ofCfnSchedulePropsMixin.EcsParametersProperty.getPlacementConstraints()- 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:
this
-
placementConstraints
@Stability(Stable) public CfnSchedulePropsMixin.EcsParametersProperty.Builder placementConstraints(List<? extends Object> placementConstraints) Sets the value ofCfnSchedulePropsMixin.EcsParametersProperty.getPlacementConstraints()- 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:
this
-
placementStrategy
@Stability(Stable) public CfnSchedulePropsMixin.EcsParametersProperty.Builder placementStrategy(IResolvable placementStrategy) Sets the value ofCfnSchedulePropsMixin.EcsParametersProperty.getPlacementStrategy()- Parameters:
placementStrategy- The task placement strategy for a task or service.- Returns:
this
-
placementStrategy
@Stability(Stable) public CfnSchedulePropsMixin.EcsParametersProperty.Builder placementStrategy(List<? extends Object> placementStrategy) Sets the value ofCfnSchedulePropsMixin.EcsParametersProperty.getPlacementStrategy()- Parameters:
placementStrategy- The task placement strategy for a task or service.- Returns:
this
-
platformVersion
@Stability(Stable) public CfnSchedulePropsMixin.EcsParametersProperty.Builder platformVersion(String platformVersion) Sets the value ofCfnSchedulePropsMixin.EcsParametersProperty.getPlatformVersion()- Parameters:
platformVersion- Specifies the platform version for the task. Specify only the numeric portion of the platform version, such as1.1.0.- Returns:
this
-
propagateTags
@Stability(Stable) public CfnSchedulePropsMixin.EcsParametersProperty.Builder propagateTags(String propagateTags) Sets the value ofCfnSchedulePropsMixin.EcsParametersProperty.getPropagateTags()- 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 Amazon ECSTagResourceAPI action.- Returns:
this
-
referenceId
@Stability(Stable) public CfnSchedulePropsMixin.EcsParametersProperty.Builder referenceId(String referenceId) Sets the value ofCfnSchedulePropsMixin.EcsParametersProperty.getReferenceId()- Parameters:
referenceId- The reference ID to use for the task.- Returns:
this
-
tags
Sets the value ofCfnSchedulePropsMixin.EcsParametersProperty.getTags()- 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. For more information, seeRunTaskin the Amazon ECS API Reference .- Returns:
this
-
taskCount
@Stability(Stable) public CfnSchedulePropsMixin.EcsParametersProperty.Builder taskCount(Number taskCount) Sets the value ofCfnSchedulePropsMixin.EcsParametersProperty.getTaskCount()- Parameters:
taskCount- The number of tasks to create based onTaskDefinition. The default is1.- Returns:
this
-
taskDefinitionArn
@Stability(Stable) public CfnSchedulePropsMixin.EcsParametersProperty.Builder taskDefinitionArn(String taskDefinitionArn) Sets the value ofCfnSchedulePropsMixin.EcsParametersProperty.getTaskDefinitionArn()- Parameters:
taskDefinitionArn- The Amazon Resource Name (ARN) of the task definition to use if the event target is an Amazon ECS task.- Returns:
this
-
build
Builds the configured instance.- Specified by:
buildin interfacesoftware.amazon.jsii.Builder<CfnSchedulePropsMixin.EcsParametersProperty>- Returns:
- a new instance of
CfnSchedulePropsMixin.EcsParametersProperty - Throws:
NullPointerException- if any required attribute was not provided
-