Package software.amazon.awscdk.services.pipes

Class CfnPipe.PipeTargetEcsTaskParametersProperty.Builder

java.lang.Object

software.amazon.awscdk.services.pipes.CfnPipe.PipeTargetEcsTaskParametersProperty.Builder

All Implemented Interfaces:

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

Enclosing interface:

CfnPipe.PipeTargetEcsTaskParametersProperty

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

A builder for CfnPipe.PipeTargetEcsTaskParametersProperty

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

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

taskDefinitionArn

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

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

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

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

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

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

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

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

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

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

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

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

Sets the value of CfnPipe.PipeTargetEcsTaskParametersProperty.getOverrides()

Parameters:

overrides - The overrides that are associated with a task.

Returns:

this

overrides

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

Sets the value of CfnPipe.PipeTargetEcsTaskParametersProperty.getOverrides()

Parameters:

overrides - The overrides that are associated with a task.

Returns:

this

placementConstraints

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

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

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

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

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

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

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

Sets the value of CfnPipe.PipeTargetEcsTaskParametersProperty.getReferenceId()

Parameters:

referenceId - The reference ID to use for the task.

Returns:

this

tags

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

Sets the value of CfnPipe.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 CfnPipe.PipeTargetEcsTaskParametersProperty.Builder taskCount(Number taskCount)

Sets the value of CfnPipe.PipeTargetEcsTaskParametersProperty.getTaskCount()

Parameters:

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

Returns:

this

build

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

Builds the configured instance.

Specified by:

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

Returns:

a new instance of CfnPipe.PipeTargetEcsTaskParametersProperty

Throws:

NullPointerException - if any required attribute was not provided