Package software.amazon.awscdk.cfnpropertymixins.services.pipes

Class CfnPipePropsMixin.PipeTargetEcsTaskParametersProperty.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.pipes.CfnPipePropsMixin.PipeTargetEcsTaskParametersProperty.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnPipePropsMixin.PipeTargetEcsTaskParametersProperty>

Enclosing interface:

CfnPipePropsMixin.PipeTargetEcsTaskParametersProperty

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

A builder for CfnPipePropsMixin.PipeTargetEcsTaskParametersProperty

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnPipePropsMixin.PipeTargetEcsTaskParametersProperty	build()	Builds the configured instance.
CfnPipePropsMixin.PipeTargetEcsTaskParametersProperty.Builder	capacityProviderStrategy(List<? extends Object> capacityProviderStrategy)	Sets the value of CfnPipePropsMixin.PipeTargetEcsTaskParametersProperty.getCapacityProviderStrategy()
CfnPipePropsMixin.PipeTargetEcsTaskParametersProperty.Builder	capacityProviderStrategy(IResolvable capacityProviderStrategy)	Sets the value of CfnPipePropsMixin.PipeTargetEcsTaskParametersProperty.getCapacityProviderStrategy()
CfnPipePropsMixin.PipeTargetEcsTaskParametersProperty.Builder	enableEcsManagedTags(Boolean enableEcsManagedTags)	Sets the value of CfnPipePropsMixin.PipeTargetEcsTaskParametersProperty.getEnableEcsManagedTags()
CfnPipePropsMixin.PipeTargetEcsTaskParametersProperty.Builder	enableEcsManagedTags(IResolvable enableEcsManagedTags)	Sets the value of CfnPipePropsMixin.PipeTargetEcsTaskParametersProperty.getEnableEcsManagedTags()
CfnPipePropsMixin.PipeTargetEcsTaskParametersProperty.Builder	enableExecuteCommand(Boolean enableExecuteCommand)	Sets the value of CfnPipePropsMixin.PipeTargetEcsTaskParametersProperty.getEnableExecuteCommand()
CfnPipePropsMixin.PipeTargetEcsTaskParametersProperty.Builder	enableExecuteCommand(IResolvable enableExecuteCommand)	Sets the value of CfnPipePropsMixin.PipeTargetEcsTaskParametersProperty.getEnableExecuteCommand()
CfnPipePropsMixin.PipeTargetEcsTaskParametersProperty.Builder	group(String group)	Sets the value of CfnPipePropsMixin.PipeTargetEcsTaskParametersProperty.getGroup()
CfnPipePropsMixin.PipeTargetEcsTaskParametersProperty.Builder	launchType(String launchType)	Sets the value of CfnPipePropsMixin.PipeTargetEcsTaskParametersProperty.getLaunchType()
CfnPipePropsMixin.PipeTargetEcsTaskParametersProperty.Builder	networkConfiguration(CfnPipePropsMixin.NetworkConfigurationProperty networkConfiguration)	Sets the value of CfnPipePropsMixin.PipeTargetEcsTaskParametersProperty.getNetworkConfiguration()
CfnPipePropsMixin.PipeTargetEcsTaskParametersProperty.Builder	networkConfiguration(IResolvable networkConfiguration)	Sets the value of CfnPipePropsMixin.PipeTargetEcsTaskParametersProperty.getNetworkConfiguration()
CfnPipePropsMixin.PipeTargetEcsTaskParametersProperty.Builder	overrides(CfnPipePropsMixin.EcsTaskOverrideProperty overrides)	Sets the value of CfnPipePropsMixin.PipeTargetEcsTaskParametersProperty.getOverrides()
CfnPipePropsMixin.PipeTargetEcsTaskParametersProperty.Builder	overrides(IResolvable overrides)	Sets the value of CfnPipePropsMixin.PipeTargetEcsTaskParametersProperty.getOverrides()
CfnPipePropsMixin.PipeTargetEcsTaskParametersProperty.Builder	placementConstraints(List<? extends Object> placementConstraints)	Sets the value of CfnPipePropsMixin.PipeTargetEcsTaskParametersProperty.getPlacementConstraints()
CfnPipePropsMixin.PipeTargetEcsTaskParametersProperty.Builder	placementConstraints(IResolvable placementConstraints)	Sets the value of CfnPipePropsMixin.PipeTargetEcsTaskParametersProperty.getPlacementConstraints()
CfnPipePropsMixin.PipeTargetEcsTaskParametersProperty.Builder	placementStrategy(List<? extends Object> placementStrategy)	Sets the value of CfnPipePropsMixin.PipeTargetEcsTaskParametersProperty.getPlacementStrategy()
CfnPipePropsMixin.PipeTargetEcsTaskParametersProperty.Builder	placementStrategy(IResolvable placementStrategy)	Sets the value of CfnPipePropsMixin.PipeTargetEcsTaskParametersProperty.getPlacementStrategy()
CfnPipePropsMixin.PipeTargetEcsTaskParametersProperty.Builder	platformVersion(String platformVersion)	Sets the value of CfnPipePropsMixin.PipeTargetEcsTaskParametersProperty.getPlatformVersion()
CfnPipePropsMixin.PipeTargetEcsTaskParametersProperty.Builder	propagateTags(String propagateTags)	Sets the value of CfnPipePropsMixin.PipeTargetEcsTaskParametersProperty.getPropagateTags()
CfnPipePropsMixin.PipeTargetEcsTaskParametersProperty.Builder	referenceId(String referenceId)	Sets the value of CfnPipePropsMixin.PipeTargetEcsTaskParametersProperty.getReferenceId()
CfnPipePropsMixin.PipeTargetEcsTaskParametersProperty.Builder	tags(List<? extends CfnTag> tags)	Sets the value of CfnPipePropsMixin.PipeTargetEcsTaskParametersProperty.getTags()
CfnPipePropsMixin.PipeTargetEcsTaskParametersProperty.Builder	taskCount(Number taskCount)	Sets the value of CfnPipePropsMixin.PipeTargetEcsTaskParametersProperty.getTaskCount()
CfnPipePropsMixin.PipeTargetEcsTaskParametersProperty.Builder	taskDefinitionArn(String taskDefinitionArn)	Sets the value of CfnPipePropsMixin.PipeTargetEcsTaskParametersProperty.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

capacityProviderStrategy

@Stability(Stable)
public CfnPipePropsMixin.PipeTargetEcsTaskParametersProperty.Builder capacityProviderStrategy(IResolvable capacityProviderStrategy)

Sets the value of CfnPipePropsMixin.PipeTargetEcsTaskParametersProperty.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 CfnPipePropsMixin.PipeTargetEcsTaskParametersProperty.Builder capacityProviderStrategy(List<? extends Object> capacityProviderStrategy)

Sets the value of CfnPipePropsMixin.PipeTargetEcsTaskParametersProperty.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 CfnPipePropsMixin.PipeTargetEcsTaskParametersProperty.Builder enableEcsManagedTags(Boolean enableEcsManagedTags)

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

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

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

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

Sets the value of CfnPipePropsMixin.PipeTargetEcsTaskParametersProperty.getGroup()

Parameters:

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

Returns:

this

launchType

@Stability(Stable)
public CfnPipePropsMixin.PipeTargetEcsTaskParametersProperty.Builder launchType(String launchType)

Sets the value of CfnPipePropsMixin.PipeTargetEcsTaskParametersProperty.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 CfnPipePropsMixin.PipeTargetEcsTaskParametersProperty.Builder networkConfiguration(IResolvable networkConfiguration)

Sets the value of CfnPipePropsMixin.PipeTargetEcsTaskParametersProperty.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 CfnPipePropsMixin.PipeTargetEcsTaskParametersProperty.Builder networkConfiguration(CfnPipePropsMixin.NetworkConfigurationProperty networkConfiguration)

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

overrides

@Stability(Stable)
public CfnPipePropsMixin.PipeTargetEcsTaskParametersProperty.Builder overrides(IResolvable overrides)

Sets the value of CfnPipePropsMixin.PipeTargetEcsTaskParametersProperty.getOverrides()

Parameters:

overrides - The overrides that are associated with a task.

Returns:

this

overrides

@Stability(Stable)
public CfnPipePropsMixin.PipeTargetEcsTaskParametersProperty.Builder overrides(CfnPipePropsMixin.EcsTaskOverrideProperty overrides)

Sets the value of CfnPipePropsMixin.PipeTargetEcsTaskParametersProperty.getOverrides()

Parameters:

overrides - The overrides that are associated with a task.

Returns:

this

placementConstraints

@Stability(Stable)
public CfnPipePropsMixin.PipeTargetEcsTaskParametersProperty.Builder placementConstraints(IResolvable placementConstraints)

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

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

Sets the value of CfnPipePropsMixin.PipeTargetEcsTaskParametersProperty.getPlacementStrategy()

Parameters:

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

Returns:

this

placementStrategy

@Stability(Stable)
public CfnPipePropsMixin.PipeTargetEcsTaskParametersProperty.Builder placementStrategy(List<? extends Object> placementStrategy)

Sets the value of CfnPipePropsMixin.PipeTargetEcsTaskParametersProperty.getPlacementStrategy()

Parameters:

placementStrategy - 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 CfnPipePropsMixin.PipeTargetEcsTaskParametersProperty.Builder platformVersion(String platformVersion)

Sets the value of CfnPipePropsMixin.PipeTargetEcsTaskParametersProperty.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 CfnPipePropsMixin.PipeTargetEcsTaskParametersProperty.Builder propagateTags(String propagateTags)

Sets the value of CfnPipePropsMixin.PipeTargetEcsTaskParametersProperty.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 CfnPipePropsMixin.PipeTargetEcsTaskParametersProperty.Builder referenceId(String referenceId)

Sets the value of CfnPipePropsMixin.PipeTargetEcsTaskParametersProperty.getReferenceId()

Parameters:

referenceId - The reference ID to use for the task.

Returns:

this

tags

@Stability(Stable)
public CfnPipePropsMixin.PipeTargetEcsTaskParametersProperty.Builder tags(List<? extends CfnTag> tags)

Sets the value of CfnPipePropsMixin.PipeTargetEcsTaskParametersProperty.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. To learn more, see RunTask in the Amazon ECS API Reference.

Returns:

this

taskCount

@Stability(Stable)
public CfnPipePropsMixin.PipeTargetEcsTaskParametersProperty.Builder taskCount(Number taskCount)

Sets the value of CfnPipePropsMixin.PipeTargetEcsTaskParametersProperty.getTaskCount()

Parameters:

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

Returns:

this

taskDefinitionArn

@Stability(Stable)
public CfnPipePropsMixin.PipeTargetEcsTaskParametersProperty.Builder taskDefinitionArn(String taskDefinitionArn)

Sets the value of CfnPipePropsMixin.PipeTargetEcsTaskParametersProperty.getTaskDefinitionArn()

Parameters:

taskDefinitionArn - The ARN of the task definition to use if the event target is an Amazon ECS task.

Returns:

this

build

@Stability(Stable)
public CfnPipePropsMixin.PipeTargetEcsTaskParametersProperty build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CfnPipePropsMixin.PipeTargetEcsTaskParametersProperty>

Returns:

a new instance of CfnPipePropsMixin.PipeTargetEcsTaskParametersProperty

Throws:

NullPointerException - if any required attribute was not provided