class CfnCluster (construct)

Language	Type name
.NET	`Amazon.CDK.AWS.ECS.CfnCluster`
Java	`software.amazon.awscdk.services.ecs.CfnCluster`
Python	`aws_cdk.aws_ecs.CfnCluster`
TypeScript	`@aws-cdk/aws-ecs` » `CfnCluster`

Implements IConstruct, IConstruct, IDependable, IInspectable

A CloudFormation AWS::ECS::Cluster.

The AWS::ECS::Cluster resource creates an Amazon Elastic Container Service (Amazon ECS) cluster.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as ecs from '@aws-cdk/aws-ecs';
const cfnCluster = new ecs.CfnCluster(this, 'MyCfnCluster', /* all optional props */ {
  capacityProviders: ['capacityProviders'],
  clusterName: 'clusterName',
  clusterSettings: [{
    name: 'name',
    value: 'value',
  }],
  configuration: {
    executeCommandConfiguration: {
      kmsKeyId: 'kmsKeyId',
      logConfiguration: {
        cloudWatchEncryptionEnabled: false,
        cloudWatchLogGroupName: 'cloudWatchLogGroupName',
        s3BucketName: 's3BucketName',
        s3EncryptionEnabled: false,
        s3KeyPrefix: 's3KeyPrefix',
      },
      logging: 'logging',
    },
  },
  defaultCapacityProviderStrategy: [{
    base: 123,
    capacityProvider: 'capacityProvider',
    weight: 123,
  }],
  serviceConnectDefaults: {
    namespace: 'namespace',
  },
  tags: [{
    key: 'key',
    value: 'value',
  }],
});

Initializer

new CfnCluster(scope: Construct, id: string, props?: CfnClusterProps)

Parameters

scope Construct — - scope in which this resource is defined.
id string — - scoped id of the resource.
props CfnClusterProps — - resource properties.

Create a new AWS::ECS::Cluster.

Construct Props

Name	Type	Description
capacityProviders?	`string[]`	The short name of one or more capacity providers to associate with the cluster.
clusterName?	`string`	A user-generated string that you use to identify your cluster.
clusterSettings?	`IResolvable` `\|` `IResolvable` `\|` `ClusterSettingsProperty[]`	The settings to use when creating a cluster.
configuration?	`IResolvable` `\|` `ClusterConfigurationProperty`	The execute command configuration for the cluster.
defaultCapacityProviderStrategy?	`IResolvable` `\|` `IResolvable` `\|` `CapacityProviderStrategyItemProperty[]`	The default capacity provider strategy for the cluster.
serviceConnectDefaults?	`IResolvable` `\|` `ServiceConnectDefaultsProperty`	Use this parameter to set a default Service Connect namespace.
tags?	`CfnTag[]`	The metadata that you apply to the cluster to help you categorize and organize them.

capacityProviders?

Type: string[] (optional)

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.

clusterName?

Type: string (optional)

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.

clusterSettings?

Type: IResolvable | IResolvable | ClusterSettingsProperty[] (optional)

The settings to use when creating a cluster.

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

configuration?

Type: IResolvable | ClusterConfigurationProperty (optional)

The execute command configuration for the cluster.

defaultCapacityProviderStrategy?

Type: IResolvable | IResolvable | CapacityProviderStrategyItemProperty[] (optional)

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.

serviceConnectDefaults?

Type: IResolvable | ServiceConnectDefaultsProperty (optional)

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 .

tags?

Type: CfnTag[] (optional)

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.

Properties

Name	Type	Description
attrArn	`string`	The Amazon Resource Name (ARN) of the Amazon ECS cluster, such as `arn:aws:ecs:us-east-2:123456789012:cluster/MyECSCluster` .
cfnOptions	`ICfnResourceOptions`	Options for this resource, such as condition, update policy etc.
cfnProperties	`{ [string]: any }`
cfnResourceType	`string`	AWS resource type.
creationStack	`string[]`
logicalId	`string`	The logical ID for this CloudFormation stack element.
node	`ConstructNode`	The construct tree node associated with this construct.
ref	`string`	Return a string that will be resolved to a CloudFormation `{ Ref }` for this element.
stack	`Stack`	The stack in which this element is defined.
tags	`TagManager`	The metadata that you apply to the cluster to help you categorize and organize them.
capacityProviders?	`string[]`	The short name of one or more capacity providers to associate with the cluster.
clusterName?	`string`	A user-generated string that you use to identify your cluster.
clusterSettings?	`IResolvable` `\|` `IResolvable` `\|` `ClusterSettingsProperty[]`	The settings to use when creating a cluster.
configuration?	`IResolvable` `\|` `ClusterConfigurationProperty`	The execute command configuration for the cluster.
defaultCapacityProviderStrategy?	`IResolvable` `\|` `IResolvable` `\|` `CapacityProviderStrategyItemProperty[]`	The default capacity provider strategy for the cluster.
serviceConnectDefaults?	`IResolvable` `\|` `ServiceConnectDefaultsProperty`	Use this parameter to set a default Service Connect namespace.
static CFN_RESOURCE_TYPE_NAME	`string`	The CloudFormation resource type name for this resource class.

attrArn

Type: string

The Amazon Resource Name (ARN) of the Amazon ECS cluster, such as arn:aws:ecs:us-east-2:123456789012:cluster/MyECSCluster .

cfnOptions

Type: ICfnResourceOptions

Options for this resource, such as condition, update policy etc.

cfnProperties

Type: { [string]: any }

cfnResourceType

Type: string

AWS resource type.

creationStack

Type: string[]

logicalId

Type: string

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

node

Type: ConstructNode

The construct tree node associated with this construct.

ref

Type: string

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

stack

Type: Stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

capacityProviders?

Type: string[] (optional)

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

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

clusterName?

Type: string (optional)

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.

clusterSettings?

Type: IResolvable | IResolvable | ClusterSettingsProperty[] (optional)

The settings to use when creating a cluster.

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

configuration?

Type: IResolvable | ClusterConfigurationProperty (optional)

The execute command configuration for the cluster.

defaultCapacityProviderStrategy?

Type: IResolvable | IResolvable | CapacityProviderStrategyItemProperty[] (optional)

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.

serviceConnectDefaults?

Type: IResolvable | ServiceConnectDefaultsProperty (optional)

Use this parameter to set a default Service Connect namespace.

static CFN_RESOURCE_TYPE_NAME

Type: string

The CloudFormation resource type name for this resource class.

Methods

Name	Description
addDeletionOverride(path)	Syntactic sugar for `addOverride(path, undefined)`.
addDependsOn(target)	Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addMetadata(key, value)	Add a value to the CloudFormation Resource Metadata.
addOverride(path, value)	Adds an override to the synthesized CloudFormation resource.
addPropertyDeletionOverride(propertyPath)	Adds an override that deletes the value of a property from the resource definition.
addPropertyOverride(propertyPath, value)	Adds an override to a resource property.
applyRemovalPolicy(policy?, options?)	Sets the deletion policy of the resource based on the removal policy specified.
getAtt(attributeName)	Returns a token for an runtime attribute of this resource.
getMetadata(key)	Retrieve a value value from the CloudFormation Resource Metadata.
inspect(inspector)	Examines the CloudFormation resource and discloses attributes.
overrideLogicalId(newLogicalId)	Overrides the auto-generated logical ID with a specific ID.
toString()	Returns a string representation of this construct.
protected renderProperties(props)

addDeletionOverride(path)

public addDeletionOverride(path: string): void

Parameters

path string — The path of the value to delete.

Syntactic sugar for addOverride(path, undefined).

addDependsOn(target)

public addDependsOn(target: CfnResource): void

Parameters

target CfnResource

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

addMetadata(key, value)

public addMetadata(key: string, value: any): void

Parameters

key string
value any

Add a value to the CloudFormation Resource Metadata.

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)

addOverride(path, value)

public addOverride(path: string, value: any): void

Parameters

path string — - The path of the property, you can use dot notation to override values in complex types.
value any — - The value.

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example,

cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');

would add the overrides

"Properties": {
   "GlobalSecondaryIndexes": [
     {
       "Projection": {
         "NonKeyAttributes": [ "myattribute" ]
         ...
       }
       ...
     },
     {
       "ProjectionType": "INCLUDE"
       ...
     },
   ]
   ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

addPropertyDeletionOverride(propertyPath)

public addPropertyDeletionOverride(propertyPath: string): void

Parameters

propertyPath string — The path to the property.

Adds an override that deletes the value of a property from the resource definition.

addPropertyOverride(propertyPath, value)

public addPropertyOverride(propertyPath: string, value: any): void

Parameters

propertyPath string — The path of the property.
value any — The value.

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

applyRemovalPolicy(policy?, options?)

public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void

Parameters

policy RemovalPolicy
options RemovalPolicyOptions

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

getAtt(attributeName)

public getAtt(attributeName: string): Reference

Parameters

attributeName string — The name of the attribute.

Returns

Reference

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

getMetadata(key)

public getMetadata(key: string): any

Parameters

key string

Returns

any

Retrieve a value value from the CloudFormation Resource Metadata.

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)

inspect(inspector)

public inspect(inspector: TreeInspector): void

Parameters

inspector TreeInspector — - tree inspector to collect and process attributes.

Examines the CloudFormation resource and discloses attributes.

overrideLogicalId(newLogicalId)

public overrideLogicalId(newLogicalId: string): void

Parameters

newLogicalId string — The new logical ID to use for this stack element.

Overrides the auto-generated logical ID with a specific ID.

toString()

public toString(): string

Returns

string

Returns a string representation of this construct.

protected renderProperties(props)

protected renderProperties(props: { [string]: any }): { [string]: any }

Parameters

props { [string]: any }

Returns

{ [string]: any }