Package software.amazon.awscdk.services.scheduler

Class CfnSchedule.EcsParametersProperty.Builder

java.lang.Object

software.amazon.awscdk.services.scheduler.CfnSchedule.EcsParametersProperty.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnSchedule.EcsParametersProperty>

Enclosing interface:

CfnSchedule.EcsParametersProperty

@Stability(Stable)
public static final class CfnSchedule.EcsParametersProperty.Builder
extends Object
implements software.amazon.jsii.Builder<CfnSchedule.EcsParametersProperty>

A builder for CfnSchedule.EcsParametersProperty

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnSchedule.EcsParametersProperty	build()	Builds the configured instance.
CfnSchedule.EcsParametersProperty.Builder	capacityProviderStrategy(List<? extends Object> capacityProviderStrategy)	Sets the value of CfnSchedule.EcsParametersProperty.getCapacityProviderStrategy()
CfnSchedule.EcsParametersProperty.Builder	capacityProviderStrategy(IResolvable capacityProviderStrategy)	Sets the value of CfnSchedule.EcsParametersProperty.getCapacityProviderStrategy()
CfnSchedule.EcsParametersProperty.Builder	enableEcsManagedTags(Boolean enableEcsManagedTags)	Sets the value of CfnSchedule.EcsParametersProperty.getEnableEcsManagedTags()
CfnSchedule.EcsParametersProperty.Builder	enableEcsManagedTags(IResolvable enableEcsManagedTags)	Sets the value of CfnSchedule.EcsParametersProperty.getEnableEcsManagedTags()
CfnSchedule.EcsParametersProperty.Builder	enableExecuteCommand(Boolean enableExecuteCommand)	Sets the value of CfnSchedule.EcsParametersProperty.getEnableExecuteCommand()
CfnSchedule.EcsParametersProperty.Builder	enableExecuteCommand(IResolvable enableExecuteCommand)	Sets the value of CfnSchedule.EcsParametersProperty.getEnableExecuteCommand()
CfnSchedule.EcsParametersProperty.Builder	group(String group)	Sets the value of CfnSchedule.EcsParametersProperty.getGroup()
CfnSchedule.EcsParametersProperty.Builder	launchType(String launchType)	Sets the value of CfnSchedule.EcsParametersProperty.getLaunchType()
CfnSchedule.EcsParametersProperty.Builder	networkConfiguration(IResolvable networkConfiguration)	Sets the value of CfnSchedule.EcsParametersProperty.getNetworkConfiguration()
CfnSchedule.EcsParametersProperty.Builder	networkConfiguration(CfnSchedule.NetworkConfigurationProperty networkConfiguration)	Sets the value of CfnSchedule.EcsParametersProperty.getNetworkConfiguration()
CfnSchedule.EcsParametersProperty.Builder	placementConstraints(List<? extends Object> placementConstraints)	Sets the value of CfnSchedule.EcsParametersProperty.getPlacementConstraints()
CfnSchedule.EcsParametersProperty.Builder	placementConstraints(IResolvable placementConstraints)	Sets the value of CfnSchedule.EcsParametersProperty.getPlacementConstraints()
CfnSchedule.EcsParametersProperty.Builder	placementStrategy(List<? extends Object> placementStrategy)	Sets the value of CfnSchedule.EcsParametersProperty.getPlacementStrategy()
CfnSchedule.EcsParametersProperty.Builder	placementStrategy(IResolvable placementStrategy)	Sets the value of CfnSchedule.EcsParametersProperty.getPlacementStrategy()
CfnSchedule.EcsParametersProperty.Builder	platformVersion(String platformVersion)	Sets the value of CfnSchedule.EcsParametersProperty.getPlatformVersion()
CfnSchedule.EcsParametersProperty.Builder	propagateTags(String propagateTags)	Sets the value of CfnSchedule.EcsParametersProperty.getPropagateTags()
CfnSchedule.EcsParametersProperty.Builder	referenceId(String referenceId)	Sets the value of CfnSchedule.EcsParametersProperty.getReferenceId()
CfnSchedule.EcsParametersProperty.Builder	tags(Object tags)	Sets the value of CfnSchedule.EcsParametersProperty.getTags()
CfnSchedule.EcsParametersProperty.Builder	taskCount(Number taskCount)	Sets the value of CfnSchedule.EcsParametersProperty.getTaskCount()
CfnSchedule.EcsParametersProperty.Builder	taskDefinitionArn(String taskDefinitionArn)	Sets the value of CfnSchedule.EcsParametersProperty.getTaskDefinitionArn()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

taskDefinitionArn

@Stability(Stable)
public CfnSchedule.EcsParametersProperty.Builder taskDefinitionArn(String taskDefinitionArn)

Sets the value of CfnSchedule.EcsParametersProperty.getTaskDefinitionArn()

Parameters:

taskDefinitionArn - The Amazon Resource Name (ARN) of the task definition to use if the event target is an Amazon ECS task. This parameter is required.

Returns:

this

capacityProviderStrategy

@Stability(Stable)
public CfnSchedule.EcsParametersProperty.Builder capacityProviderStrategy(IResolvable capacityProviderStrategy)

Sets the value of CfnSchedule.EcsParametersProperty.getCapacityProviderStrategy()

Parameters:

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

Returns:

this

capacityProviderStrategy

@Stability(Stable)
public CfnSchedule.EcsParametersProperty.Builder capacityProviderStrategy(List<? extends Object> capacityProviderStrategy)

Sets the value of CfnSchedule.EcsParametersProperty.getCapacityProviderStrategy()

Parameters:

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

Returns:

this

enableEcsManagedTags

@Stability(Stable)
public CfnSchedule.EcsParametersProperty.Builder enableEcsManagedTags(Boolean enableEcsManagedTags)

Sets the value of CfnSchedule.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 CfnSchedule.EcsParametersProperty.Builder enableEcsManagedTags(IResolvable enableEcsManagedTags)

Sets the value of CfnSchedule.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 CfnSchedule.EcsParametersProperty.Builder enableExecuteCommand(Boolean enableExecuteCommand)

Sets the value of CfnSchedule.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 CfnSchedule.EcsParametersProperty.Builder enableExecuteCommand(IResolvable enableExecuteCommand)

Sets the value of CfnSchedule.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

@Stability(Stable)
public CfnSchedule.EcsParametersProperty.Builder group(String group)

Sets the value of CfnSchedule.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 CfnSchedule.EcsParametersProperty.Builder launchType(String launchType)

Sets the value of CfnSchedule.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. The FARGATE value 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 CfnSchedule.EcsParametersProperty.Builder networkConfiguration(IResolvable networkConfiguration)

Sets the value of CfnSchedule.EcsParametersProperty.getNetworkConfiguration()

Parameters:

networkConfiguration - This structure specifies the network configuration for an ECS task.

Returns:

this

networkConfiguration

@Stability(Stable)
public CfnSchedule.EcsParametersProperty.Builder networkConfiguration(CfnSchedule.NetworkConfigurationProperty networkConfiguration)

Sets the value of CfnSchedule.EcsParametersProperty.getNetworkConfiguration()

Parameters:

networkConfiguration - This structure specifies the network configuration for an ECS task.

Returns:

this

placementConstraints

@Stability(Stable)
public CfnSchedule.EcsParametersProperty.Builder placementConstraints(IResolvable placementConstraints)

Sets the value of CfnSchedule.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 CfnSchedule.EcsParametersProperty.Builder placementConstraints(List<? extends Object> placementConstraints)

Sets the value of CfnSchedule.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 CfnSchedule.EcsParametersProperty.Builder placementStrategy(IResolvable placementStrategy)

Sets the value of CfnSchedule.EcsParametersProperty.getPlacementStrategy()

Parameters:

placementStrategy - The task placement strategy for a task or service.

Returns:

this

placementStrategy

@Stability(Stable)
public CfnSchedule.EcsParametersProperty.Builder placementStrategy(List<? extends Object> placementStrategy)

Sets the value of CfnSchedule.EcsParametersProperty.getPlacementStrategy()

Parameters:

placementStrategy - The task placement strategy for a task or service.

Returns:

this

platformVersion

@Stability(Stable)
public CfnSchedule.EcsParametersProperty.Builder platformVersion(String platformVersion)

Sets the value of CfnSchedule.EcsParametersProperty.getPlatformVersion()

Parameters:

platformVersion - Specifies the platform version for the task. Specify only the numeric portion of the platform version, such as 1.1.0 .

Returns:

this

propagateTags

@Stability(Stable)
public CfnSchedule.EcsParametersProperty.Builder propagateTags(String propagateTags)

Sets the value of CfnSchedule.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 ECS TagResource API action.

Returns:

this

referenceId

@Stability(Stable)
public CfnSchedule.EcsParametersProperty.Builder referenceId(String referenceId)

Sets the value of CfnSchedule.EcsParametersProperty.getReferenceId()

Parameters:

referenceId - The reference ID to use for the task.

Returns:

this

tags

@Stability(Stable)
public CfnSchedule.EcsParametersProperty.Builder tags(Object tags)

Sets the value of CfnSchedule.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, see RunTask in the Amazon ECS API Reference .

Returns:

this

taskCount

@Stability(Stable)
public CfnSchedule.EcsParametersProperty.Builder taskCount(Number taskCount)

Sets the value of CfnSchedule.EcsParametersProperty.getTaskCount()

Parameters:

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

Returns:

this

build

@Stability(Stable)
public CfnSchedule.EcsParametersProperty build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CfnSchedule.EcsParametersProperty>

Returns:

a new instance of CfnSchedule.EcsParametersProperty

Throws:

NullPointerException - if any required attribute was not provided