Class CfnCluster

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

Inheritance

object

CfnElement

CfnRefElement

CfnResource

CfnCluster

Implements

IInspectable

IClusterRef

IConstruct

IDependable

IEnvironmentAware

ITaggable

Inherited Members

CfnResource.IsCfnResource(object)

CfnResource.AddDeletionOverride(string)

CfnResource.AddDependency(CfnResource)

CfnResource.AddDependsOn(CfnResource)

CfnResource.AddMetadata(string, object)

CfnResource.AddOverride(string, object)

CfnResource.AddPropertyDeletionOverride(string)

CfnResource.AddPropertyOverride(string, object)

CfnResource.ApplyRemovalPolicy(RemovalPolicy?, IRemovalPolicyOptions)

CfnResource.GetAtt(string, ResolutionTypeHint?)

CfnResource.GetMetadata(string)

CfnResource.ObtainDependencies()

CfnResource.ObtainResourceDependencies()

CfnResource.RemoveDependency(CfnResource)

CfnResource.ReplaceDependency(CfnResource, CfnResource)

CfnResource.ShouldSynthesize()

CfnResource.ToString()

CfnResource.ValidateProperties(object)

CfnResource.CfnOptions

CfnResource.CfnResourceType

CfnResource.Env

CfnResource.UpdatedProperites

CfnResource.UpdatedProperties

CfnRefElement.Ref

CfnElement.IsCfnElement(object)

CfnElement.OverrideLogicalId(string)

CfnElement.With(params IMixin[])

CfnElement.CreationStack

CfnElement.LogicalId

CfnElement.Stack

Namespace: Amazon.CDK.AWS.ECS

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnCluster : CfnResource, IInspectable, IClusterRef, IConstruct, IDependable, IEnvironmentAware, ITaggable

Syntax (vb)

Public Class CfnCluster Inherits CfnResource Implements IInspectable, IClusterRef, IConstruct, IDependable, IEnvironmentAware, ITaggable

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-cluster.html

CloudformationResource: AWS::ECS::Cluster

ExampleMetadata: infused

Examples

new CfnCluster(this, "Cluster").With(new Mixins.ClusterSettings(new [] { new ClusterSettingsProperty { Name = "containerInsights", Value = "enhanced" } }));

Synopsis

Constructors

CfnCluster(Construct, string, ICfnClusterProps?)

Create a new AWS::ECS::Cluster.

Properties

AttrArn	The Amazon Resource Name (ARN) of the Amazon ECS cluster, such as `arn:aws:ecs:us-east-2:123456789012:cluster/MyECSCluster` .
CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.
CapacityProviders	The short name of one or more capacity providers to associate with the cluster.
CfnProperties	The `AWS::ECS::Cluster` resource creates an Amazon Elastic Container Service (Amazon ECS) cluster.
ClusterName	A user-generated string that you use to identify your cluster.
ClusterRef	A reference to a Cluster resource.
ClusterSettings	The settings to use when creating a cluster.
Configuration	The execute command and managed storage configuration for the cluster.
DefaultCapacityProviderStrategy	The default capacity provider strategy for the cluster.
ServiceConnectDefaults	Use this parameter to set a default Service Connect namespace.
Tags	Tag Manager which manages the tags for this resource.
TagsRaw	The metadata that you apply to the cluster to help you categorize and organize them.

Methods

ArnForCluster(IClusterRef)	The `AWS::ECS::Cluster` resource creates an Amazon Elastic Container Service (Amazon ECS) cluster.
FromClusterArn(Construct, string, string)	Creates a new IClusterRef from an ARN.
FromClusterName(Construct, string, string)	Creates a new IClusterRef from a clusterName.
Inspect(TreeInspector)	Examines the CloudFormation resource and discloses attributes.
IsCfnCluster(object)	Checks whether the given object is a CfnCluster.
RenderProperties(IDictionary<string, object>)	The `AWS::ECS::Cluster` resource creates an Amazon Elastic Container Service (Amazon ECS) cluster.

Constructors

CfnCluster(Construct, string, ICfnClusterProps?)

Create a new AWS::ECS::Cluster.

public CfnCluster(Construct scope, string id, ICfnClusterProps? props = null)

Parameters

scope Construct: Scope in which this resource is defined.
id string: Construct identifier for this resource (unique in its scope).
props ICfnClusterProps: Resource properties.

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-cluster.html

CloudformationResource: AWS::ECS::Cluster

ExampleMetadata: infused

Properties

AttrArn

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

public virtual string AttrArn { get; }

Property Value

string

Remarks

CloudformationAttribute: Arn

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-cluster.html

CloudformationResource: AWS::ECS::Cluster

ExampleMetadata: infused

CapacityProviders

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

public virtual string[]? CapacityProviders { get; set; }

Property Value

string[]

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-cluster.html

CloudformationResource: AWS::ECS::Cluster

ExampleMetadata: infused

CfnProperties

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

protected override IDictionary<string, object> CfnProperties { get; }

CloudformationResource: AWS::ECS::Cluster

ExampleMetadata: infused

ClusterName

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

public virtual string? ClusterName { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-cluster.html

CloudformationResource: AWS::ECS::Cluster

ExampleMetadata: infused

ClusterRef

A reference to a Cluster resource.

public virtual IClusterReference ClusterRef { get; }

Property Value

IClusterReference

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-cluster.html

CloudformationResource: AWS::ECS::Cluster

ExampleMetadata: infused

ClusterSettings

The settings to use when creating a cluster.

public virtual object? ClusterSettings { get; set; }

Property Value

object

Remarks

Type union: either IResolvable or (either IResolvable or CfnCluster.IClusterSettingsProperty)[]

Configuration

The execute command and managed storage configuration for the cluster.

public virtual object? Configuration { get; set; }

Property Value

object

Remarks

Type union: either IResolvable or CfnCluster.IClusterConfigurationProperty

DefaultCapacityProviderStrategy

The default capacity provider strategy for the cluster.

public virtual object? DefaultCapacityProviderStrategy { get; set; }

Property Value

object

Remarks

Type union: either IResolvable or (either IResolvable or CfnCluster.ICapacityProviderStrategyItemProperty)[]

ServiceConnectDefaults

Use this parameter to set a default Service Connect namespace.

public virtual object? ServiceConnectDefaults { get; set; }

Property Value

object

Remarks

Type union: either IResolvable or CfnCluster.IServiceConnectDefaultsProperty

TagsRaw

The metadata that you apply to the cluster to help you categorize and organize them.

public virtual ICfnTag[]? TagsRaw { get; set; }

Property Value

ICfnTag[]

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-cluster.html

CloudformationResource: AWS::ECS::Cluster

ExampleMetadata: infused

Methods

ArnForCluster(IClusterRef)

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

public static string ArnForCluster(IClusterRef resource)

Parameters

resource IClusterRef

Returns

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-cluster.html

CloudformationResource: AWS::ECS::Cluster

ExampleMetadata: infused

Examples

new CfnCluster(this, "Cluster").With(new Mixins.ClusterSettings(new [] { new ClusterSettingsProperty { Name = "containerInsights", Value = "enhanced" } }));

FromClusterArn(Construct, string, string)

Creates a new IClusterRef from an ARN.

public static IClusterRef FromClusterArn(Construct scope, string id, string arn)

Parameters

scope Construct
id string
arn string

Returns

IClusterRef

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-cluster.html

CloudformationResource: AWS::ECS::Cluster

ExampleMetadata: infused

FromClusterName(Construct, string, string)

Creates a new IClusterRef from a clusterName.

public static IClusterRef FromClusterName(Construct scope, string id, string clusterName)

Parameters

scope Construct
id string
clusterName string

Returns

IClusterRef

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-cluster.html

CloudformationResource: AWS::ECS::Cluster

ExampleMetadata: infused

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.

public virtual void Inspect(TreeInspector inspector)

Parameters

inspector TreeInspector: tree inspector to collect and process attributes.

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-cluster.html

CloudformationResource: AWS::ECS::Cluster

ExampleMetadata: infused

IsCfnCluster(object)

Checks whether the given object is a CfnCluster.

public static bool IsCfnCluster(object x)

Parameters

x object

Returns

bool

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-cluster.html

CloudformationResource: AWS::ECS::Cluster

ExampleMetadata: infused

RenderProperties(IDictionary<string, object>)

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

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)

Parameters

props IDictionary<string, object>

Returns

IDictionary<string, object>

Overrides

CfnResource.RenderProperties(IDictionary<string, object>)

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-cluster.html

CloudformationResource: AWS::ECS::Cluster

ExampleMetadata: infused

Implements

IInspectable

IClusterRef

Constructs.IConstruct

Constructs.IDependable

IEnvironmentAware

ITaggable