Package software.amazon.awscdk.services.ecs

Class CfnTaskSet.Builder

java.lang.Object

software.amazon.awscdk.services.ecs.CfnTaskSet.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnTaskSet>

Enclosing class:

CfnTaskSet

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

A fluent builder for CfnTaskSet.

Method Summary

Modifier and Type	Method	Description
CfnTaskSet	build()
CfnTaskSet.Builder	cluster(String cluster)	The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service to create the task set in.
static CfnTaskSet.Builder	create(software.constructs.Construct scope, String id)
CfnTaskSet.Builder	externalId(String externalId)	An optional non-unique tag that identifies this task set in external systems.
CfnTaskSet.Builder	launchType(String launchType)	The launch type that new tasks in the task set uses.
CfnTaskSet.Builder	loadBalancers(List<? extends Object> loadBalancers)	A load balancer object representing the load balancer to use with the task set.
CfnTaskSet.Builder	loadBalancers(IResolvable loadBalancers)	A load balancer object representing the load balancer to use with the task set.
CfnTaskSet.Builder	networkConfiguration(IResolvable networkConfiguration)	The network configuration for the task set.
CfnTaskSet.Builder	networkConfiguration(CfnTaskSet.NetworkConfigurationProperty networkConfiguration)	The network configuration for the task set.
CfnTaskSet.Builder	platformVersion(String platformVersion)	The platform version that the tasks in the task set uses.
CfnTaskSet.Builder	scale(IResolvable scale)	A floating-point percentage of your desired number of tasks to place and keep running in the task set.
CfnTaskSet.Builder	scale(CfnTaskSet.ScaleProperty scale)	A floating-point percentage of your desired number of tasks to place and keep running in the task set.
CfnTaskSet.Builder	service(String service)	The short name or full Amazon Resource Name (ARN) of the service to create the task set in.
CfnTaskSet.Builder	serviceRegistries(List<? extends Object> serviceRegistries)	The details of the service discovery registries to assign to this task set.
CfnTaskSet.Builder	serviceRegistries(IResolvable serviceRegistries)	The details of the service discovery registries to assign to this task set.
CfnTaskSet.Builder	tags(List<? extends CfnTag> tags)	The metadata that you apply to the task set to help you categorize and organize them.
CfnTaskSet.Builder	taskDefinition(String taskDefinition)	The task definition for the tasks in the task set to use.

Methods inherited from class java.lang.Object

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

Method Details

create

@Stability(Stable)
public static CfnTaskSet.Builder create(software.constructs.Construct scope,
 String id)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

Returns:

a new instance of CfnTaskSet.Builder.

cluster

@Stability(Stable)
public CfnTaskSet.Builder cluster(String cluster)

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service to create the task set in.

Parameters:

cluster - The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service to create the task set in. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-taskset.html#cfn-ecs-taskset-cluster

service

@Stability(Stable)
public CfnTaskSet.Builder service(String service)

The short name or full Amazon Resource Name (ARN) of the service to create the task set in.

Parameters:

service - The short name or full Amazon Resource Name (ARN) of the service to create the task set in. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-taskset.html#cfn-ecs-taskset-service

taskDefinition

@Stability(Stable)
public CfnTaskSet.Builder taskDefinition(String taskDefinition)

The task definition for the tasks in the task set to use.

If a revision isn't specified, the latest ACTIVE revision is used.

Parameters:

taskDefinition - The task definition for the tasks in the task set to use. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-taskset.html#cfn-ecs-taskset-taskdefinition

externalId

@Stability(Stable)
public CfnTaskSet.Builder externalId(String externalId)

An optional non-unique tag that identifies this task set in external systems.

If the task set is associated with a service discovery registry, the tasks in this task set will have the ECS_TASK_SET_EXTERNAL_ID AWS Cloud Map attribute set to the provided value.

Parameters:

externalId - An optional non-unique tag that identifies this task set in external systems. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-taskset.html#cfn-ecs-taskset-externalid

launchType

@Stability(Stable)
public CfnTaskSet.Builder launchType(String launchType)

The launch type that new tasks in the task set uses.

For more information, see Amazon ECS launch types in the Amazon Elastic Container Service Developer Guide .

If a launchType is specified, the capacityProviderStrategy parameter must be omitted.

Parameters:

launchType - The launch type that new tasks in the task set uses. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-taskset.html#cfn-ecs-taskset-launchtype

loadBalancers

@Stability(Stable)
public CfnTaskSet.Builder loadBalancers(IResolvable loadBalancers)

A load balancer object representing the load balancer to use with the task set.

The supported load balancer types are either an Application Load Balancer or a Network Load Balancer.

Parameters:

loadBalancers - A load balancer object representing the load balancer to use with the task set. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-taskset.html#cfn-ecs-taskset-loadbalancers

loadBalancers

@Stability(Stable)
public CfnTaskSet.Builder loadBalancers(List<? extends Object> loadBalancers)

A load balancer object representing the load balancer to use with the task set.

The supported load balancer types are either an Application Load Balancer or a Network Load Balancer.

Parameters:

loadBalancers - A load balancer object representing the load balancer to use with the task set. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-taskset.html#cfn-ecs-taskset-loadbalancers

networkConfiguration

@Stability(Stable)
public CfnTaskSet.Builder networkConfiguration(IResolvable networkConfiguration)

The network configuration for the task set.

Parameters:

networkConfiguration - The network configuration for the task set. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-taskset.html#cfn-ecs-taskset-networkconfiguration

networkConfiguration

@Stability(Stable)
public CfnTaskSet.Builder networkConfiguration(CfnTaskSet.NetworkConfigurationProperty networkConfiguration)

The network configuration for the task set.

Parameters:

networkConfiguration - The network configuration for the task set. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-taskset.html#cfn-ecs-taskset-networkconfiguration

platformVersion

@Stability(Stable)
public CfnTaskSet.Builder platformVersion(String platformVersion)

The platform version that the tasks in the task set uses.

A platform version is specified only for tasks using the Fargate launch type. If one isn't specified, the LATEST platform version is used.

Parameters:

platformVersion - The platform version that the tasks in the task set uses. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-taskset.html#cfn-ecs-taskset-platformversion

scale

@Stability(Stable)
public CfnTaskSet.Builder scale(IResolvable scale)

A floating-point percentage of your desired number of tasks to place and keep running in the task set.

Parameters:

scale - A floating-point percentage of your desired number of tasks to place and keep running in the task set. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-taskset.html#cfn-ecs-taskset-scale

scale

@Stability(Stable)
public CfnTaskSet.Builder scale(CfnTaskSet.ScaleProperty scale)

A floating-point percentage of your desired number of tasks to place and keep running in the task set.

Parameters:

scale - A floating-point percentage of your desired number of tasks to place and keep running in the task set. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-taskset.html#cfn-ecs-taskset-scale

serviceRegistries

@Stability(Stable)
public CfnTaskSet.Builder serviceRegistries(IResolvable serviceRegistries)

The details of the service discovery registries to assign to this task set.

For more information, see Service discovery .

Parameters:

serviceRegistries - The details of the service discovery registries to assign to this task set. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-taskset.html#cfn-ecs-taskset-serviceregistries

serviceRegistries

@Stability(Stable)
public CfnTaskSet.Builder serviceRegistries(List<? extends Object> serviceRegistries)

The details of the service discovery registries to assign to this task set.

For more information, see Service discovery .

Parameters:

serviceRegistries - The details of the service discovery registries to assign to this task set. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-taskset.html#cfn-ecs-taskset-serviceregistries

tags

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

The metadata that you apply to the task set to help you categorize and organize them.

Each tag consists of a key and an optional value. You define both.

The following basic restrictions apply to tags:

• Maximum number of tags per resource - 50
• For each resource, each tag key must be unique, and each tag key can have only one value.
• Maximum key length - 128 Unicode characters in UTF-8
• Maximum value length - 256 Unicode characters in UTF-8
• If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : /

Parameters:

tags - The metadata that you apply to the task set to help you categorize and organize them. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-taskset.html#cfn-ecs-taskset-tags

build

@Stability(Stable)
public CfnTaskSet build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnTaskSet>

Returns:

a newly built instance of CfnTaskSet.