CfnCluster.Builder

java.lang.Object
- software.amazon.awscdk.services.ecs.CfnCluster.Builder

Enclosing class:: CfnCluster

public static final class CfnCluster.Builder
extends java.lang.Object

A fluent builder for CfnCluster.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CfnCluster`	`build()`
`CfnCluster.Builder`	`capacityProviders(java.util.List<java.lang.String> capacityProviders)` The short name of one or more capacity providers to associate with the cluster.
`CfnCluster.Builder`	`clusterName(java.lang.String clusterName)` A user-generated string that you use to identify your cluster.
`CfnCluster.Builder`	`clusterSettings(IResolvable clusterSettings)` The setting to use when creating a cluster.
`CfnCluster.Builder`	`clusterSettings(java.util.List<? extends java.lang.Object> clusterSettings)` The setting to use when creating a cluster.
`CfnCluster.Builder`	`configuration(CfnCluster.ClusterConfigurationProperty configuration)` The execute command configuration for the cluster.
`CfnCluster.Builder`	`configuration(IResolvable configuration)` The execute command configuration for the cluster.
`static CfnCluster.Builder`	`create(Construct scope, java.lang.String id)`
`CfnCluster.Builder`	`defaultCapacityProviderStrategy(IResolvable defaultCapacityProviderStrategy)` The default capacity provider strategy for the cluster.
`CfnCluster.Builder`	`defaultCapacityProviderStrategy(java.util.List<? extends java.lang.Object> defaultCapacityProviderStrategy)` The default capacity provider strategy for the cluster.
`CfnCluster.Builder`	`tags(java.util.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 Detail
  - create
```
public static CfnCluster.Builder create(Construct scope,
                                        java.lang.String id)
```
    Parameters:
    
    scope - - scope in which this resource is defined. This parameter is required.
    
    id - - scoped id of the resource. This parameter is required.
    
    Returns:
    
    a new instance of CfnCluster.CapacityProviderStrategyItemProperty.Builder.
  - capacityProviders
```
public CfnCluster.Builder capacityProviders(java.util.List<java.lang.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.
    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.
    
    Parameters:
    
    capacityProviders - The short name of one or more capacity providers to associate with the cluster. This parameter is required.
    
    Returns:
    
    this
  - clusterName
```
public CfnCluster.Builder clusterName(java.lang.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
  - clusterSettings
```
public CfnCluster.Builder clusterSettings(IResolvable 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 .
    
    Parameters:
    
    clusterSettings - The setting to use when creating a cluster. This parameter is required.
    
    Returns:
    
    this
  - clusterSettings
```
public CfnCluster.Builder clusterSettings(java.util.List<? extends java.lang.Object> 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 .
    
    Parameters:
    
    clusterSettings - The setting to use when creating a cluster. This parameter is required.
    
    Returns:
    
    this
  - configuration
```
public CfnCluster.Builder configuration(IResolvable configuration)
```
    The execute command configuration for the cluster.
    
    Parameters:
    
    configuration - The execute command configuration for the cluster. This parameter is required.
    
    Returns:
    
    this
  - configuration
```
public CfnCluster.Builder configuration(CfnCluster.ClusterConfigurationProperty configuration)
```
    The execute command configuration for the cluster.
    
    Parameters:
    
    configuration - The execute command configuration for the cluster. This parameter is required.
    
    Returns:
    
    this
  - defaultCapacityProviderStrategy
```
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
  - defaultCapacityProviderStrategy
```
public CfnCluster.Builder defaultCapacityProviderStrategy(java.util.List<? extends java.lang.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
  - tags
```
public CfnCluster.Builder tags(java.util.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: + - = . _ : / @.
    - 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.
    Parameters:
    
    tags - The metadata that you apply to the cluster to help you categorize and organize them. This parameter is required.
    
    Returns:
    
    this
  - build
```
public CfnCluster build()
```

Class CfnCluster.Builder

Method Summary

Methods inherited from class java.lang.Object

Method Detail

create

capacityProviders

clusterName

clusterSettings

clusterSettings

configuration

configuration

defaultCapacityProviderStrategy

defaultCapacityProviderStrategy

tags

build