software.amazon.awscdk.services.ecs

Class CfnClusterProps.Builder

java.lang.Object

software.amazon.awscdk.services.ecs.CfnClusterProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnClusterProps>

Enclosing interface:

CfnClusterProps

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

A builder for CfnClusterProps

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
CfnClusterProps	build() Builds the configured instance.
CfnClusterProps.Builder	capacityProviders(List<String> capacityProviders) Sets the value of CfnClusterProps.getCapacityProviders()
CfnClusterProps.Builder	clusterName(String clusterName) Sets the value of CfnClusterProps.getClusterName()
CfnClusterProps.Builder	clusterSettings(IResolvable clusterSettings) Sets the value of CfnClusterProps.getClusterSettings()
CfnClusterProps.Builder	clusterSettings(List<? extends Object> clusterSettings) Sets the value of CfnClusterProps.getClusterSettings()
CfnClusterProps.Builder	configuration(CfnCluster.ClusterConfigurationProperty configuration) Sets the value of CfnClusterProps.getConfiguration()
CfnClusterProps.Builder	configuration(IResolvable configuration) Sets the value of CfnClusterProps.getConfiguration()
CfnClusterProps.Builder	defaultCapacityProviderStrategy(IResolvable defaultCapacityProviderStrategy) Sets the value of CfnClusterProps.getDefaultCapacityProviderStrategy()
CfnClusterProps.Builder	defaultCapacityProviderStrategy(List<? extends Object> defaultCapacityProviderStrategy) Sets the value of CfnClusterProps.getDefaultCapacityProviderStrategy()
CfnClusterProps.Builder	tags(List<? extends CfnTag> tags) Sets the value of CfnClusterProps.getTags()

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

capacityProviders

@Stability(value=Stable)
public CfnClusterProps.Builder capacityProviders(List<String> capacityProviders)

Sets the value of CfnClusterProps.getCapacityProviders()

Parameters:

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.

If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created and not already associated with another cluster.

To use an 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.

Returns:

this

clusterName

@Stability(value=Stable)
public CfnClusterProps.Builder clusterName(String clusterName)

Sets the value of CfnClusterProps.getClusterName()

Parameters:

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.

Returns:

this

clusterSettings

@Stability(value=Stable)
public CfnClusterProps.Builder clusterSettings(IResolvable clusterSettings)

Sets the value of CfnClusterProps.getClusterSettings()

Parameters:

clusterSettings - The setting to use when creating a cluster. This parameter is used to enable CloudWatch Container Insights for a cluster. If this value is specified, it will override the containerInsights value set with PutAccountSetting or PutAccountSettingDefault .

Returns:

this

clusterSettings

@Stability(value=Stable)
public CfnClusterProps.Builder clusterSettings(List<? extends Object> clusterSettings)

Sets the value of CfnClusterProps.getClusterSettings()

Parameters:

clusterSettings - The setting to use when creating a cluster. This parameter is used to enable CloudWatch Container Insights for a cluster. If this value is specified, it will override the containerInsights value set with PutAccountSetting or PutAccountSettingDefault .

Returns:

this

configuration

@Stability(value=Stable)
public CfnClusterProps.Builder configuration(CfnCluster.ClusterConfigurationProperty configuration)

Sets the value of CfnClusterProps.getConfiguration()

Parameters:

configuration - The execute command configuration for the cluster.

Returns:

this

configuration

@Stability(value=Stable)
public CfnClusterProps.Builder configuration(IResolvable configuration)

Sets the value of CfnClusterProps.getConfiguration()

Parameters:

configuration - The execute command configuration for the cluster.

Returns:

this

defaultCapacityProviderStrategy

@Stability(value=Stable)
public CfnClusterProps.Builder defaultCapacityProviderStrategy(IResolvable defaultCapacityProviderStrategy)

Sets the value of CfnClusterProps.getDefaultCapacityProviderStrategy()

Parameters:

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.

Returns:

this

defaultCapacityProviderStrategy

@Stability(value=Stable)
public CfnClusterProps.Builder defaultCapacityProviderStrategy(List<? extends Object> defaultCapacityProviderStrategy)

Sets the value of CfnClusterProps.getDefaultCapacityProviderStrategy()

Parameters:

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.

Returns:

this

tags

@Stability(value=Stable)
public CfnClusterProps.Builder tags(List<? extends CfnTag> tags)

Sets the value of CfnClusterProps.getTags()

Parameters:

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: + - = . _ : / @.
• Tag keys and values are case-sensitive.
• Do not use aws: , AWS: , or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.

Returns:

this

build

@Stability(value=Stable)
public CfnClusterProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of CfnClusterProps

Throws:

NullPointerException - if any required attribute was not provided