software.amazon.awscdk.services.ecs

Interface CfnClusterProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnClusterProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:38.602Z")
 @Stability(value=Stable)
public interface CfnClusterProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a `CfnCluster`.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.ecs.*;
 CfnClusterProps cfnClusterProps = CfnClusterProps.builder()
         .capacityProviders(List.of("capacityProviders"))
         .clusterName("clusterName")
         .clusterSettings(List.of(ClusterSettingsProperty.builder()
                 .name("name")
                 .value("value")
                 .build()))
         .configuration(ClusterConfigurationProperty.builder()
                 .executeCommandConfiguration(ExecuteCommandConfigurationProperty.builder()
                         .kmsKeyId("kmsKeyId")
                         .logConfiguration(ExecuteCommandLogConfigurationProperty.builder()
                                 .cloudWatchEncryptionEnabled(false)
                                 .cloudWatchLogGroupName("cloudWatchLogGroupName")
                                 .s3BucketName("s3BucketName")
                                 .s3EncryptionEnabled(false)
                                 .s3KeyPrefix("s3KeyPrefix")
                                 .build())
                         .logging("logging")
                         .build())
                 .build())
         .defaultCapacityProviderStrategy(List.of(CapacityProviderStrategyItemProperty.builder()
                 .base(123)
                 .capacityProvider("capacityProvider")
                 .weight(123)
                 .build()))
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnClusterProps.Builder A builder for CfnClusterProps
static class	CfnClusterProps.Jsii$Proxy An implementation for CfnClusterProps

Method Summary

Modifier and Type	Method and Description
static CfnClusterProps.Builder	builder()
default List<String>	getCapacityProviders() The short name of one or more capacity providers to associate with the cluster.
default String	getClusterName() A user-generated string that you use to identify your cluster.
default Object	getClusterSettings() The setting to use when creating a cluster.
default Object	getConfiguration() The execute command configuration for the cluster.
default Object	getDefaultCapacityProviderStrategy() The default capacity provider strategy for the cluster.
default List<CfnTag>	getTags() The metadata that you apply to the cluster to help you categorize and organize them.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getCapacityProviders

@Stability(value=Stable)
 @Nullable
default List<String> getCapacityProviders()

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.

getClusterName

@Stability(value=Stable)
 @Nullable
default String getClusterName()

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.

getClusterSettings

@Stability(value=Stable)
 @Nullable
default Object getClusterSettings()

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 .

getConfiguration

@Stability(value=Stable)
 @Nullable
default Object getConfiguration()

The execute command configuration for the cluster.

getDefaultCapacityProviderStrategy

@Stability(value=Stable)
 @Nullable
default Object getDefaultCapacityProviderStrategy()

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.

getTags

@Stability(value=Stable)
 @Nullable
default List<CfnTag> getTags()

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.

builder

@Stability(value=Stable)
static CfnClusterProps.Builder builder()

Returns:

a CfnClusterProps.Builder of CfnClusterProps