Class CfnClusterProps

Properties for defining a CfnCluster.

Inheritance

System.Object

CfnClusterProps

Implements

ICfnClusterProps

Namespace: Amazon.CDK.AWS.ECS

Assembly: Amazon.CDK.AWS.ECS.dll

Syntax (csharp)

public class CfnClusterProps : Object, ICfnClusterProps

Syntax (vb)

Public Class CfnClusterProps
    Inherits Object
    Implements ICfnClusterProps

Remarks

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

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.ECS;

CfnClusterProps cfnClusterProps = new CfnClusterProps {
    CapacityProviders = new [] { "capacityProviders" },
    ClusterName = "clusterName",
    ClusterSettings = new [] { new ClusterSettingsProperty {
        Name = "name",
        Value = "value"
    } },
    Configuration = new ClusterConfigurationProperty {
        ExecuteCommandConfiguration = new ExecuteCommandConfigurationProperty {
            KmsKeyId = "kmsKeyId",
            LogConfiguration = new ExecuteCommandLogConfigurationProperty {
                CloudWatchEncryptionEnabled = false,
                CloudWatchLogGroupName = "cloudWatchLogGroupName",
                S3BucketName = "s3BucketName",
                S3EncryptionEnabled = false,
                S3KeyPrefix = "s3KeyPrefix"
            },
            Logging = "logging"
        }
    },
    DefaultCapacityProviderStrategy = new [] { new CapacityProviderStrategyItemProperty {
        Base = 123,
        CapacityProvider = "capacityProvider",
        Weight = 123
    } },
    Tags = new [] { new CfnTag {
        Key = "key",
        Value = "value"
    } }
};

Synopsis

Constructors

CfnClusterProps()

Properties

CapacityProviders	The short name of one or more capacity providers to associate with the cluster.
ClusterName	A user-generated string that you use to identify your cluster.
ClusterSettings	The setting to use when creating a cluster.
Configuration	The execute command configuration for the cluster.
DefaultCapacityProviderStrategy	The default capacity provider strategy for the cluster.
Tags	The metadata that you apply to the cluster to help you categorize and organize them.

Constructors

CfnClusterProps()

public CfnClusterProps()

Properties

CapacityProviders

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

public string[] CapacityProviders { get; set; }

Property Value

System.String[]

Remarks

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.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-cluster.html#cfn-ecs-cluster-capacityproviders

ClusterName

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

public string ClusterName { get; set; }

Property Value

System.String

Remarks

If you don't specify a name, AWS CloudFormation generates a unique physical ID for the name.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-cluster.html#cfn-ecs-cluster-clustername

ClusterSettings

The setting to use when creating a cluster.

public object ClusterSettings { get; set; }

Property Value

System.Object

Remarks

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 .

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-cluster.html#cfn-ecs-cluster-clustersettings

Configuration

The execute command configuration for the cluster.

public object Configuration { get; set; }

Property Value

System.Object

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-cluster.html#cfn-ecs-cluster-configuration

DefaultCapacityProviderStrategy

The default capacity provider strategy for the cluster.

public object DefaultCapacityProviderStrategy { get; set; }

Property Value

System.Object

Remarks

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.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-cluster.html#cfn-ecs-cluster-defaultcapacityproviderstrategy

Implements

ICfnClusterProps