Package software.amazon.awscdk.services.ecs

Class CfnCluster.Builder

java.lang.Object

software.amazon.awscdk.services.ecs.CfnCluster.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnCluster>

Enclosing class:

CfnCluster

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

A fluent builder for CfnCluster.

Method Summary

Modifier and Type	Method	Description
CfnCluster	build()
CfnCluster.Builder	capacityProviders(List<String> capacityProviders)	The short name of one or more capacity providers to associate with the cluster.
CfnCluster.Builder	clusterName(String clusterName)	A user-generated string that you use to identify your cluster.
CfnCluster.Builder	clusterSettings(List<? extends Object> clusterSettings)	The settings to use when creating a cluster.
CfnCluster.Builder	clusterSettings(IResolvable clusterSettings)	The settings to use when creating a cluster.
CfnCluster.Builder	configuration(IResolvable configuration)	The execute command and managed storage configuration for the cluster.
CfnCluster.Builder	configuration(CfnCluster.ClusterConfigurationProperty configuration)	The execute command and managed storage configuration for the cluster.
static CfnCluster.Builder	create(software.constructs.Construct scope, String id)
CfnCluster.Builder	defaultCapacityProviderStrategy(List<? extends Object> defaultCapacityProviderStrategy)	The default capacity provider strategy for the cluster.
CfnCluster.Builder	defaultCapacityProviderStrategy(IResolvable defaultCapacityProviderStrategy)	The default capacity provider strategy for the cluster.
CfnCluster.Builder	serviceConnectDefaults(IResolvable serviceConnectDefaults)	Use this parameter to set a default Service Connect namespace.
CfnCluster.Builder	serviceConnectDefaults(CfnCluster.ServiceConnectDefaultsProperty serviceConnectDefaults)	Use this parameter to set a default Service Connect namespace.
CfnCluster.Builder	tags(List<? extends CfnTag> tags)	The metadata that you apply to the cluster to help you categorize and organize them.

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 CfnCluster.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 CfnCluster.Builder.

capacityProviders

@Stability(Stable)
public CfnCluster.Builder capacityProviders(List<String> capacityProviders)

The short name of one or more capacity providers to associate with the cluster.

A capacity provider must be associated with a cluster before it can be included as part of the default capacity provider strategy of the cluster or used in a capacity provider strategy when calling the CreateService or RunTask actions.

If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must be created but not associated with another cluster. New Auto Scaling group capacity providers can be created with the CreateCapacityProvider API operation.

To use a AWS Fargate capacity provider, specify either the FARGATE or FARGATE_SPOT capacity providers. The AWS Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used.

The PutCapacityProvider API operation is used to update the list of available capacity providers for a cluster after the cluster is created.

Parameters:

capacityProviders - The short name of one or more capacity providers to associate with the cluster. This parameter is required.

Returns:

this

See Also:

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

clusterName

@Stability(Stable)
public CfnCluster.Builder clusterName(String clusterName)

A user-generated string that you use to identify your cluster.

If you don't specify a name, AWS CloudFormation generates a unique physical ID for the name.

Parameters:

clusterName - A user-generated string that you use to identify your cluster. This parameter is required.

Returns:

this

See Also:

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

clusterSettings

@Stability(Stable)
public CfnCluster.Builder clusterSettings(IResolvable clusterSettings)

The settings to use when creating a cluster.

This parameter is used to turn on CloudWatch Container Insights for a cluster.

Parameters:

clusterSettings - The settings to use when creating a cluster. This parameter is required.

Returns:

this

See Also:

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

clusterSettings

@Stability(Stable)
public CfnCluster.Builder clusterSettings(List<? extends Object> clusterSettings)

The settings to use when creating a cluster.

This parameter is used to turn on CloudWatch Container Insights for a cluster.

Parameters:

clusterSettings - The settings to use when creating a cluster. This parameter is required.

Returns:

this

See Also:

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

configuration

@Stability(Stable)
public CfnCluster.Builder configuration(IResolvable configuration)

The execute command and managed storage configuration for the cluster.

Parameters:

configuration - The execute command and managed storage configuration for the cluster. This parameter is required.

Returns:

this

See Also:

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

configuration

@Stability(Stable)
public CfnCluster.Builder configuration(CfnCluster.ClusterConfigurationProperty configuration)

The execute command and managed storage configuration for the cluster.

Parameters:

configuration - The execute command and managed storage configuration for the cluster. This parameter is required.

Returns:

this

See Also:

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

defaultCapacityProviderStrategy

@Stability(Stable)
public CfnCluster.Builder defaultCapacityProviderStrategy(IResolvable defaultCapacityProviderStrategy)

The default capacity provider strategy for the cluster.

When services or tasks are run in the cluster with no launch type or capacity provider strategy specified, the default capacity provider strategy is used.

Parameters:

defaultCapacityProviderStrategy - The default capacity provider strategy for the cluster. This parameter is required.

Returns:

this

See Also:

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

defaultCapacityProviderStrategy

@Stability(Stable)
public CfnCluster.Builder defaultCapacityProviderStrategy(List<? extends Object> defaultCapacityProviderStrategy)

The default capacity provider strategy for the cluster.

When services or tasks are run in the cluster with no launch type or capacity provider strategy specified, the default capacity provider strategy is used.

Parameters:

defaultCapacityProviderStrategy - The default capacity provider strategy for the cluster. This parameter is required.

Returns:

this

See Also:

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

serviceConnectDefaults

@Stability(Stable)
public CfnCluster.Builder serviceConnectDefaults(IResolvable serviceConnectDefaults)

Use this parameter to set a default Service Connect namespace.

After you set a default Service Connect namespace, any new services with Service Connect turned on that are created in the cluster are added as client services in the namespace. This setting only applies to new services that set the enabled parameter to true in the ServiceConnectConfiguration . You can set the namespace of each service individually in the ServiceConnectConfiguration to override this default parameter.

Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide .

Parameters:

serviceConnectDefaults - Use this parameter to set a default Service Connect namespace. This parameter is required.

Returns:

this

See Also:

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

serviceConnectDefaults

@Stability(Stable)
public CfnCluster.Builder serviceConnectDefaults(CfnCluster.ServiceConnectDefaultsProperty serviceConnectDefaults)

Use this parameter to set a default Service Connect namespace.

After you set a default Service Connect namespace, any new services with Service Connect turned on that are created in the cluster are added as client services in the namespace. This setting only applies to new services that set the enabled parameter to true in the ServiceConnectConfiguration . You can set the namespace of each service individually in the ServiceConnectConfiguration to override this default parameter.

Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide .

Parameters:

serviceConnectDefaults - Use this parameter to set a default Service Connect namespace. This parameter is required.

Returns:

this

See Also:

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

tags

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

The metadata that you apply to the cluster 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 cluster 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-cluster.html#cfn-ecs-cluster-tags

build

@Stability(Stable)
public CfnCluster build()

Specified by:

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

Returns:

a newly built instance of CfnCluster.