Package software.amazon.awscdk.services.events

Class CfnRule.EcsParametersProperty.Builder

java.lang.Object

software.amazon.awscdk.services.events.CfnRule.EcsParametersProperty.Builder

All Implemented Interfaces:

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

Enclosing interface:

CfnRule.EcsParametersProperty

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

A builder for CfnRule.EcsParametersProperty

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnRule.EcsParametersProperty	build()	Builds the configured instance.
CfnRule.EcsParametersProperty.Builder	capacityProviderStrategy(List<? extends Object> capacityProviderStrategy)	Sets the value of CfnRule.EcsParametersProperty.getCapacityProviderStrategy()
CfnRule.EcsParametersProperty.Builder	capacityProviderStrategy(IResolvable capacityProviderStrategy)	Sets the value of CfnRule.EcsParametersProperty.getCapacityProviderStrategy()
CfnRule.EcsParametersProperty.Builder	enableEcsManagedTags(Boolean enableEcsManagedTags)	Sets the value of CfnRule.EcsParametersProperty.getEnableEcsManagedTags()
CfnRule.EcsParametersProperty.Builder	enableEcsManagedTags(IResolvable enableEcsManagedTags)	Sets the value of CfnRule.EcsParametersProperty.getEnableEcsManagedTags()
CfnRule.EcsParametersProperty.Builder	enableExecuteCommand(Boolean enableExecuteCommand)	Sets the value of CfnRule.EcsParametersProperty.getEnableExecuteCommand()
CfnRule.EcsParametersProperty.Builder	enableExecuteCommand(IResolvable enableExecuteCommand)	Sets the value of CfnRule.EcsParametersProperty.getEnableExecuteCommand()
CfnRule.EcsParametersProperty.Builder	group(String group)	Sets the value of CfnRule.EcsParametersProperty.getGroup()
CfnRule.EcsParametersProperty.Builder	launchType(String launchType)	Sets the value of CfnRule.EcsParametersProperty.getLaunchType()
CfnRule.EcsParametersProperty.Builder	networkConfiguration(IResolvable networkConfiguration)	Sets the value of CfnRule.EcsParametersProperty.getNetworkConfiguration()
CfnRule.EcsParametersProperty.Builder	networkConfiguration(CfnRule.NetworkConfigurationProperty networkConfiguration)	Sets the value of CfnRule.EcsParametersProperty.getNetworkConfiguration()
CfnRule.EcsParametersProperty.Builder	placementConstraints(List<? extends Object> placementConstraints)	Sets the value of CfnRule.EcsParametersProperty.getPlacementConstraints()
CfnRule.EcsParametersProperty.Builder	placementConstraints(IResolvable placementConstraints)	Sets the value of CfnRule.EcsParametersProperty.getPlacementConstraints()
CfnRule.EcsParametersProperty.Builder	placementStrategies(List<? extends Object> placementStrategies)	Sets the value of CfnRule.EcsParametersProperty.getPlacementStrategies()
CfnRule.EcsParametersProperty.Builder	placementStrategies(IResolvable placementStrategies)	Sets the value of CfnRule.EcsParametersProperty.getPlacementStrategies()
CfnRule.EcsParametersProperty.Builder	platformVersion(String platformVersion)	Sets the value of CfnRule.EcsParametersProperty.getPlatformVersion()
CfnRule.EcsParametersProperty.Builder	propagateTags(String propagateTags)	Sets the value of CfnRule.EcsParametersProperty.getPropagateTags()
CfnRule.EcsParametersProperty.Builder	referenceId(String referenceId)	Sets the value of CfnRule.EcsParametersProperty.getReferenceId()
CfnRule.EcsParametersProperty.Builder	tagList(List<? extends Object> tagList)	Sets the value of CfnRule.EcsParametersProperty.getTagList()
CfnRule.EcsParametersProperty.Builder	tagList(IResolvable tagList)	Sets the value of CfnRule.EcsParametersProperty.getTagList()
CfnRule.EcsParametersProperty.Builder	taskCount(Number taskCount)	Sets the value of CfnRule.EcsParametersProperty.getTaskCount()
CfnRule.EcsParametersProperty.Builder	taskDefinitionArn(String taskDefinitionArn)	Sets the value of CfnRule.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 CfnRule.EcsParametersProperty.Builder taskDefinitionArn(String taskDefinitionArn)

Sets the value of CfnRule.EcsParametersProperty.getTaskDefinitionArn()

Parameters:

taskDefinitionArn - The 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 CfnRule.EcsParametersProperty.Builder capacityProviderStrategy(IResolvable capacityProviderStrategy)

Sets the value of CfnRule.EcsParametersProperty.getCapacityProviderStrategy()

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:

this

capacityProviderStrategy

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

Sets the value of CfnRule.EcsParametersProperty.getCapacityProviderStrategy()

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:

this

enableEcsManagedTags

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

Sets the value of CfnRule.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 Elastic Container Service Developer Guide.

Returns:

this

enableEcsManagedTags

@Stability(Stable)
public CfnRule.EcsParametersProperty.Builder enableEcsManagedTags(IResolvable enableEcsManagedTags)

Sets the value of CfnRule.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 Elastic Container Service Developer Guide.

Returns:

this

enableExecuteCommand

@Stability(Stable)
public CfnRule.EcsParametersProperty.Builder enableExecuteCommand(Boolean enableExecuteCommand)

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

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

Sets the value of CfnRule.EcsParametersProperty.getGroup()

Parameters:

group - Specifies an ECS task group for the task. The maximum length is 255 characters.

Returns:

this

launchType

@Stability(Stable)
public CfnRule.EcsParametersProperty.Builder launchType(String launchType)

Sets the value of CfnRule.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 AWS Fargate with Amazon ECS is supported. For more information, see AWS Fargate on Amazon ECS in the Amazon Elastic Container Service Developer Guide .

Returns:

this

networkConfiguration

@Stability(Stable)
public CfnRule.EcsParametersProperty.Builder networkConfiguration(IResolvable networkConfiguration)

Sets the value of CfnRule.EcsParametersProperty.getNetworkConfiguration()

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:

this

networkConfiguration

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

Sets the value of CfnRule.EcsParametersProperty.getNetworkConfiguration()

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:

this

placementConstraints

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

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

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

placementStrategies

@Stability(Stable)
public CfnRule.EcsParametersProperty.Builder placementStrategies(IResolvable placementStrategies)

Sets the value of CfnRule.EcsParametersProperty.getPlacementStrategies()

Parameters:

placementStrategies - The placement strategy objects to use for the task. You can specify a maximum of five strategy rules per task.

Returns:

this

placementStrategies

@Stability(Stable)
public CfnRule.EcsParametersProperty.Builder placementStrategies(List<? extends Object> placementStrategies)

Sets the value of CfnRule.EcsParametersProperty.getPlacementStrategies()

Parameters:

placementStrategies - The placement strategy objects to use for the task. You can specify a maximum of five strategy rules per task.

Returns:

this

platformVersion

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

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

This structure is used only if LaunchType is FARGATE . For more information about valid platform versions, see AWS Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide .

Returns:

this

propagateTags

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

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

Returns:

this

referenceId

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

Sets the value of CfnRule.EcsParametersProperty.getReferenceId()

Parameters:

referenceId - The reference ID to use for the task.

Returns:

this

tagList

@Stability(Stable)
public CfnRule.EcsParametersProperty.Builder tagList(IResolvable tagList)

Sets the value of CfnRule.EcsParametersProperty.getTagList()

Parameters:

tagList - 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:

this

tagList

@Stability(Stable)
public CfnRule.EcsParametersProperty.Builder tagList(List<? extends Object> tagList)

Sets the value of CfnRule.EcsParametersProperty.getTagList()

Parameters:

tagList - 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:

this

taskCount

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

Sets the value of CfnRule.EcsParametersProperty.getTaskCount()

Parameters:

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

Returns:

this

build

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

Builds the configured instance.

Specified by:

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

Returns:

a new instance of CfnRule.EcsParametersProperty

Throws:

NullPointerException - if any required attribute was not provided