1. Packages
  2. AWS Classic
  3. API Docs
  4. ecs
  5. Cluster

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.45.0 published on Tuesday, Jul 16, 2024 by Pulumi

aws.ecs.Cluster

Explore with Pulumi AI

aws logo

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.45.0 published on Tuesday, Jul 16, 2024 by Pulumi

    Provides an ECS cluster.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as aws from "@pulumi/aws";
    
    const foo = new aws.ecs.Cluster("foo", {
        name: "white-hart",
        settings: [{
            name: "containerInsights",
            value: "enabled",
        }],
    });
    
    import pulumi
    import pulumi_aws as aws
    
    foo = aws.ecs.Cluster("foo",
        name="white-hart",
        settings=[{
            "name": "containerInsights",
            "value": "enabled",
        }])
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/ecs"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := ecs.NewCluster(ctx, "foo", &ecs.ClusterArgs{
    			Name: pulumi.String("white-hart"),
    			Settings: ecs.ClusterSettingArray{
    				&ecs.ClusterSettingArgs{
    					Name:  pulumi.String("containerInsights"),
    					Value: pulumi.String("enabled"),
    				},
    			},
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Aws = Pulumi.Aws;
    
    return await Deployment.RunAsync(() => 
    {
        var foo = new Aws.Ecs.Cluster("foo", new()
        {
            Name = "white-hart",
            Settings = new[]
            {
                new Aws.Ecs.Inputs.ClusterSettingArgs
                {
                    Name = "containerInsights",
                    Value = "enabled",
                },
            },
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.aws.ecs.Cluster;
    import com.pulumi.aws.ecs.ClusterArgs;
    import com.pulumi.aws.ecs.inputs.ClusterSettingArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            var foo = new Cluster("foo", ClusterArgs.builder()
                .name("white-hart")
                .settings(ClusterSettingArgs.builder()
                    .name("containerInsights")
                    .value("enabled")
                    .build())
                .build());
    
        }
    }
    
    resources:
      foo:
        type: aws:ecs:Cluster
        properties:
          name: white-hart
          settings:
            - name: containerInsights
              value: enabled
    

    Example with Log Configuration

    import * as pulumi from "@pulumi/pulumi";
    import * as aws from "@pulumi/aws";
    
    const example = new aws.kms.Key("example", {
        description: "example",
        deletionWindowInDays: 7,
    });
    const exampleLogGroup = new aws.cloudwatch.LogGroup("example", {name: "example"});
    const test = new aws.ecs.Cluster("test", {
        name: "example",
        configuration: {
            executeCommandConfiguration: {
                kmsKeyId: example.arn,
                logging: "OVERRIDE",
                logConfiguration: {
                    cloudWatchEncryptionEnabled: true,
                    cloudWatchLogGroupName: exampleLogGroup.name,
                },
            },
        },
    });
    
    import pulumi
    import pulumi_aws as aws
    
    example = aws.kms.Key("example",
        description="example",
        deletion_window_in_days=7)
    example_log_group = aws.cloudwatch.LogGroup("example", name="example")
    test = aws.ecs.Cluster("test",
        name="example",
        configuration={
            "executeCommandConfiguration": {
                "kmsKeyId": example.arn,
                "logging": "OVERRIDE",
                "logConfiguration": {
                    "cloudWatchEncryptionEnabled": True,
                    "cloudWatchLogGroupName": example_log_group.name,
                },
            },
        })
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/cloudwatch"
    	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/ecs"
    	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/kms"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		example, err := kms.NewKey(ctx, "example", &kms.KeyArgs{
    			Description:          pulumi.String("example"),
    			DeletionWindowInDays: pulumi.Int(7),
    		})
    		if err != nil {
    			return err
    		}
    		exampleLogGroup, err := cloudwatch.NewLogGroup(ctx, "example", &cloudwatch.LogGroupArgs{
    			Name: pulumi.String("example"),
    		})
    		if err != nil {
    			return err
    		}
    		_, err = ecs.NewCluster(ctx, "test", &ecs.ClusterArgs{
    			Name: pulumi.String("example"),
    			Configuration: &ecs.ClusterConfigurationArgs{
    				ExecuteCommandConfiguration: &ecs.ClusterConfigurationExecuteCommandConfigurationArgs{
    					KmsKeyId: example.Arn,
    					Logging:  pulumi.String("OVERRIDE"),
    					LogConfiguration: &ecs.ClusterConfigurationExecuteCommandConfigurationLogConfigurationArgs{
    						CloudWatchEncryptionEnabled: pulumi.Bool(true),
    						CloudWatchLogGroupName:      exampleLogGroup.Name,
    					},
    				},
    			},
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Aws = Pulumi.Aws;
    
    return await Deployment.RunAsync(() => 
    {
        var example = new Aws.Kms.Key("example", new()
        {
            Description = "example",
            DeletionWindowInDays = 7,
        });
    
        var exampleLogGroup = new Aws.CloudWatch.LogGroup("example", new()
        {
            Name = "example",
        });
    
        var test = new Aws.Ecs.Cluster("test", new()
        {
            Name = "example",
            Configuration = new Aws.Ecs.Inputs.ClusterConfigurationArgs
            {
                ExecuteCommandConfiguration = new Aws.Ecs.Inputs.ClusterConfigurationExecuteCommandConfigurationArgs
                {
                    KmsKeyId = example.Arn,
                    Logging = "OVERRIDE",
                    LogConfiguration = new Aws.Ecs.Inputs.ClusterConfigurationExecuteCommandConfigurationLogConfigurationArgs
                    {
                        CloudWatchEncryptionEnabled = true,
                        CloudWatchLogGroupName = exampleLogGroup.Name,
                    },
                },
            },
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.aws.kms.Key;
    import com.pulumi.aws.kms.KeyArgs;
    import com.pulumi.aws.cloudwatch.LogGroup;
    import com.pulumi.aws.cloudwatch.LogGroupArgs;
    import com.pulumi.aws.ecs.Cluster;
    import com.pulumi.aws.ecs.ClusterArgs;
    import com.pulumi.aws.ecs.inputs.ClusterConfigurationArgs;
    import com.pulumi.aws.ecs.inputs.ClusterConfigurationExecuteCommandConfigurationArgs;
    import com.pulumi.aws.ecs.inputs.ClusterConfigurationExecuteCommandConfigurationLogConfigurationArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            var example = new Key("example", KeyArgs.builder()
                .description("example")
                .deletionWindowInDays(7)
                .build());
    
            var exampleLogGroup = new LogGroup("exampleLogGroup", LogGroupArgs.builder()
                .name("example")
                .build());
    
            var test = new Cluster("test", ClusterArgs.builder()
                .name("example")
                .configuration(ClusterConfigurationArgs.builder()
                    .executeCommandConfiguration(ClusterConfigurationExecuteCommandConfigurationArgs.builder()
                        .kmsKeyId(example.arn())
                        .logging("OVERRIDE")
                        .logConfiguration(ClusterConfigurationExecuteCommandConfigurationLogConfigurationArgs.builder()
                            .cloudWatchEncryptionEnabled(true)
                            .cloudWatchLogGroupName(exampleLogGroup.name())
                            .build())
                        .build())
                    .build())
                .build());
    
        }
    }
    
    resources:
      example:
        type: aws:kms:Key
        properties:
          description: example
          deletionWindowInDays: 7
      exampleLogGroup:
        type: aws:cloudwatch:LogGroup
        name: example
        properties:
          name: example
      test:
        type: aws:ecs:Cluster
        properties:
          name: example
          configuration:
            executeCommandConfiguration:
              kmsKeyId: ${example.arn}
              logging: OVERRIDE
              logConfiguration:
                cloudWatchEncryptionEnabled: true
                cloudWatchLogGroupName: ${exampleLogGroup.name}
    

    Create Cluster Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Cluster(name: string, args?: ClusterArgs, opts?: CustomResourceOptions);
    @overload
    def Cluster(resource_name: str,
                args: Optional[ClusterArgs] = None,
                opts: Optional[ResourceOptions] = None)
    
    @overload
    def Cluster(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                configuration: Optional[ClusterConfigurationArgs] = None,
                name: Optional[str] = None,
                service_connect_defaults: Optional[ClusterServiceConnectDefaultsArgs] = None,
                settings: Optional[Sequence[ClusterSettingArgs]] = None,
                tags: Optional[Mapping[str, str]] = None)
    func NewCluster(ctx *Context, name string, args *ClusterArgs, opts ...ResourceOption) (*Cluster, error)
    public Cluster(string name, ClusterArgs? args = null, CustomResourceOptions? opts = null)
    public Cluster(String name, ClusterArgs args)
    public Cluster(String name, ClusterArgs args, CustomResourceOptions options)
    
    type: aws:ecs:Cluster
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args ClusterArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args ClusterArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args ClusterArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ClusterArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ClusterArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var exampleclusterResourceResourceFromEcscluster = new Aws.Ecs.Cluster("exampleclusterResourceResourceFromEcscluster", new()
    {
        Configuration = new Aws.Ecs.Inputs.ClusterConfigurationArgs
        {
            ExecuteCommandConfiguration = new Aws.Ecs.Inputs.ClusterConfigurationExecuteCommandConfigurationArgs
            {
                KmsKeyId = "string",
                LogConfiguration = new Aws.Ecs.Inputs.ClusterConfigurationExecuteCommandConfigurationLogConfigurationArgs
                {
                    CloudWatchEncryptionEnabled = false,
                    CloudWatchLogGroupName = "string",
                    S3BucketEncryptionEnabled = false,
                    S3BucketName = "string",
                    S3KeyPrefix = "string",
                },
                Logging = "string",
            },
        },
        Name = "string",
        ServiceConnectDefaults = new Aws.Ecs.Inputs.ClusterServiceConnectDefaultsArgs
        {
            Namespace = "string",
        },
        Settings = new[]
        {
            new Aws.Ecs.Inputs.ClusterSettingArgs
            {
                Name = "string",
                Value = "string",
            },
        },
        Tags = 
        {
            { "string", "string" },
        },
    });
    
    example, err := ecs.NewCluster(ctx, "exampleclusterResourceResourceFromEcscluster", &ecs.ClusterArgs{
    	Configuration: &ecs.ClusterConfigurationArgs{
    		ExecuteCommandConfiguration: &ecs.ClusterConfigurationExecuteCommandConfigurationArgs{
    			KmsKeyId: pulumi.String("string"),
    			LogConfiguration: &ecs.ClusterConfigurationExecuteCommandConfigurationLogConfigurationArgs{
    				CloudWatchEncryptionEnabled: pulumi.Bool(false),
    				CloudWatchLogGroupName:      pulumi.String("string"),
    				S3BucketEncryptionEnabled:   pulumi.Bool(false),
    				S3BucketName:                pulumi.String("string"),
    				S3KeyPrefix:                 pulumi.String("string"),
    			},
    			Logging: pulumi.String("string"),
    		},
    	},
    	Name: pulumi.String("string"),
    	ServiceConnectDefaults: &ecs.ClusterServiceConnectDefaultsArgs{
    		Namespace: pulumi.String("string"),
    	},
    	Settings: ecs.ClusterSettingArray{
    		&ecs.ClusterSettingArgs{
    			Name:  pulumi.String("string"),
    			Value: pulumi.String("string"),
    		},
    	},
    	Tags: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    })
    
    var exampleclusterResourceResourceFromEcscluster = new Cluster("exampleclusterResourceResourceFromEcscluster", ClusterArgs.builder()
        .configuration(ClusterConfigurationArgs.builder()
            .executeCommandConfiguration(ClusterConfigurationExecuteCommandConfigurationArgs.builder()
                .kmsKeyId("string")
                .logConfiguration(ClusterConfigurationExecuteCommandConfigurationLogConfigurationArgs.builder()
                    .cloudWatchEncryptionEnabled(false)
                    .cloudWatchLogGroupName("string")
                    .s3BucketEncryptionEnabled(false)
                    .s3BucketName("string")
                    .s3KeyPrefix("string")
                    .build())
                .logging("string")
                .build())
            .build())
        .name("string")
        .serviceConnectDefaults(ClusterServiceConnectDefaultsArgs.builder()
            .namespace("string")
            .build())
        .settings(ClusterSettingArgs.builder()
            .name("string")
            .value("string")
            .build())
        .tags(Map.of("string", "string"))
        .build());
    
    examplecluster_resource_resource_from_ecscluster = aws.ecs.Cluster("exampleclusterResourceResourceFromEcscluster",
        configuration={
            "executeCommandConfiguration": {
                "kmsKeyId": "string",
                "logConfiguration": {
                    "cloudWatchEncryptionEnabled": False,
                    "cloudWatchLogGroupName": "string",
                    "s3BucketEncryptionEnabled": False,
                    "s3BucketName": "string",
                    "s3KeyPrefix": "string",
                },
                "logging": "string",
            },
        },
        name="string",
        service_connect_defaults={
            "namespace": "string",
        },
        settings=[{
            "name": "string",
            "value": "string",
        }],
        tags={
            "string": "string",
        })
    
    const exampleclusterResourceResourceFromEcscluster = new aws.ecs.Cluster("exampleclusterResourceResourceFromEcscluster", {
        configuration: {
            executeCommandConfiguration: {
                kmsKeyId: "string",
                logConfiguration: {
                    cloudWatchEncryptionEnabled: false,
                    cloudWatchLogGroupName: "string",
                    s3BucketEncryptionEnabled: false,
                    s3BucketName: "string",
                    s3KeyPrefix: "string",
                },
                logging: "string",
            },
        },
        name: "string",
        serviceConnectDefaults: {
            namespace: "string",
        },
        settings: [{
            name: "string",
            value: "string",
        }],
        tags: {
            string: "string",
        },
    });
    
    type: aws:ecs:Cluster
    properties:
        configuration:
            executeCommandConfiguration:
                kmsKeyId: string
                logConfiguration:
                    cloudWatchEncryptionEnabled: false
                    cloudWatchLogGroupName: string
                    s3BucketEncryptionEnabled: false
                    s3BucketName: string
                    s3KeyPrefix: string
                logging: string
        name: string
        serviceConnectDefaults:
            namespace: string
        settings:
            - name: string
              value: string
        tags:
            string: string
    

    Cluster Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The Cluster resource accepts the following input properties:

    Configuration ClusterConfiguration
    The execute command configuration for the cluster. Detailed below.
    Name string
    Name of the cluster (up to 255 letters, numbers, hyphens, and underscores)
    ServiceConnectDefaults ClusterServiceConnectDefaults
    Configures a default Service Connect namespace. Detailed below.
    Settings List<ClusterSetting>
    Configuration block(s) with cluster settings. For example, this can be used to enable CloudWatch Container Insights for a cluster. Detailed below.
    Tags Dictionary<string, string>
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    Configuration ClusterConfigurationArgs
    The execute command configuration for the cluster. Detailed below.
    Name string
    Name of the cluster (up to 255 letters, numbers, hyphens, and underscores)
    ServiceConnectDefaults ClusterServiceConnectDefaultsArgs
    Configures a default Service Connect namespace. Detailed below.
    Settings []ClusterSettingArgs
    Configuration block(s) with cluster settings. For example, this can be used to enable CloudWatch Container Insights for a cluster. Detailed below.
    Tags map[string]string
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    configuration ClusterConfiguration
    The execute command configuration for the cluster. Detailed below.
    name String
    Name of the cluster (up to 255 letters, numbers, hyphens, and underscores)
    serviceConnectDefaults ClusterServiceConnectDefaults
    Configures a default Service Connect namespace. Detailed below.
    settings List<ClusterSetting>
    Configuration block(s) with cluster settings. For example, this can be used to enable CloudWatch Container Insights for a cluster. Detailed below.
    tags Map<String,String>
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    configuration ClusterConfiguration
    The execute command configuration for the cluster. Detailed below.
    name string
    Name of the cluster (up to 255 letters, numbers, hyphens, and underscores)
    serviceConnectDefaults ClusterServiceConnectDefaults
    Configures a default Service Connect namespace. Detailed below.
    settings ClusterSetting[]
    Configuration block(s) with cluster settings. For example, this can be used to enable CloudWatch Container Insights for a cluster. Detailed below.
    tags {[key: string]: string}
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    configuration ClusterConfigurationArgs
    The execute command configuration for the cluster. Detailed below.
    name str
    Name of the cluster (up to 255 letters, numbers, hyphens, and underscores)
    service_connect_defaults ClusterServiceConnectDefaultsArgs
    Configures a default Service Connect namespace. Detailed below.
    settings Sequence[ClusterSettingArgs]
    Configuration block(s) with cluster settings. For example, this can be used to enable CloudWatch Container Insights for a cluster. Detailed below.
    tags Mapping[str, str]
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    configuration Property Map
    The execute command configuration for the cluster. Detailed below.
    name String
    Name of the cluster (up to 255 letters, numbers, hyphens, and underscores)
    serviceConnectDefaults Property Map
    Configures a default Service Connect namespace. Detailed below.
    settings List<Property Map>
    Configuration block(s) with cluster settings. For example, this can be used to enable CloudWatch Container Insights for a cluster. Detailed below.
    tags Map<String>
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Cluster resource produces the following output properties:

    Arn string
    ARN that identifies the cluster.
    Id string
    The provider-assigned unique ID for this managed resource.
    TagsAll Dictionary<string, string>
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Arn string
    ARN that identifies the cluster.
    Id string
    The provider-assigned unique ID for this managed resource.
    TagsAll map[string]string
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    ARN that identifies the cluster.
    id String
    The provider-assigned unique ID for this managed resource.
    tagsAll Map<String,String>
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn string
    ARN that identifies the cluster.
    id string
    The provider-assigned unique ID for this managed resource.
    tagsAll {[key: string]: string}
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn str
    ARN that identifies the cluster.
    id str
    The provider-assigned unique ID for this managed resource.
    tags_all Mapping[str, str]
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    ARN that identifies the cluster.
    id String
    The provider-assigned unique ID for this managed resource.
    tagsAll Map<String>
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Look up Existing Cluster Resource

    Get an existing Cluster resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: ClusterState, opts?: CustomResourceOptions): Cluster
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            arn: Optional[str] = None,
            configuration: Optional[ClusterConfigurationArgs] = None,
            name: Optional[str] = None,
            service_connect_defaults: Optional[ClusterServiceConnectDefaultsArgs] = None,
            settings: Optional[Sequence[ClusterSettingArgs]] = None,
            tags: Optional[Mapping[str, str]] = None,
            tags_all: Optional[Mapping[str, str]] = None) -> Cluster
    func GetCluster(ctx *Context, name string, id IDInput, state *ClusterState, opts ...ResourceOption) (*Cluster, error)
    public static Cluster Get(string name, Input<string> id, ClusterState? state, CustomResourceOptions? opts = null)
    public static Cluster get(String name, Output<String> id, ClusterState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Arn string
    ARN that identifies the cluster.
    Configuration ClusterConfiguration
    The execute command configuration for the cluster. Detailed below.
    Name string
    Name of the cluster (up to 255 letters, numbers, hyphens, and underscores)
    ServiceConnectDefaults ClusterServiceConnectDefaults
    Configures a default Service Connect namespace. Detailed below.
    Settings List<ClusterSetting>
    Configuration block(s) with cluster settings. For example, this can be used to enable CloudWatch Container Insights for a cluster. Detailed below.
    Tags Dictionary<string, string>
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll Dictionary<string, string>
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Arn string
    ARN that identifies the cluster.
    Configuration ClusterConfigurationArgs
    The execute command configuration for the cluster. Detailed below.
    Name string
    Name of the cluster (up to 255 letters, numbers, hyphens, and underscores)
    ServiceConnectDefaults ClusterServiceConnectDefaultsArgs
    Configures a default Service Connect namespace. Detailed below.
    Settings []ClusterSettingArgs
    Configuration block(s) with cluster settings. For example, this can be used to enable CloudWatch Container Insights for a cluster. Detailed below.
    Tags map[string]string
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll map[string]string
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    ARN that identifies the cluster.
    configuration ClusterConfiguration
    The execute command configuration for the cluster. Detailed below.
    name String
    Name of the cluster (up to 255 letters, numbers, hyphens, and underscores)
    serviceConnectDefaults ClusterServiceConnectDefaults
    Configures a default Service Connect namespace. Detailed below.
    settings List<ClusterSetting>
    Configuration block(s) with cluster settings. For example, this can be used to enable CloudWatch Container Insights for a cluster. Detailed below.
    tags Map<String,String>
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String,String>
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn string
    ARN that identifies the cluster.
    configuration ClusterConfiguration
    The execute command configuration for the cluster. Detailed below.
    name string
    Name of the cluster (up to 255 letters, numbers, hyphens, and underscores)
    serviceConnectDefaults ClusterServiceConnectDefaults
    Configures a default Service Connect namespace. Detailed below.
    settings ClusterSetting[]
    Configuration block(s) with cluster settings. For example, this can be used to enable CloudWatch Container Insights for a cluster. Detailed below.
    tags {[key: string]: string}
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll {[key: string]: string}
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn str
    ARN that identifies the cluster.
    configuration ClusterConfigurationArgs
    The execute command configuration for the cluster. Detailed below.
    name str
    Name of the cluster (up to 255 letters, numbers, hyphens, and underscores)
    service_connect_defaults ClusterServiceConnectDefaultsArgs
    Configures a default Service Connect namespace. Detailed below.
    settings Sequence[ClusterSettingArgs]
    Configuration block(s) with cluster settings. For example, this can be used to enable CloudWatch Container Insights for a cluster. Detailed below.
    tags Mapping[str, str]
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tags_all Mapping[str, str]
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    ARN that identifies the cluster.
    configuration Property Map
    The execute command configuration for the cluster. Detailed below.
    name String
    Name of the cluster (up to 255 letters, numbers, hyphens, and underscores)
    serviceConnectDefaults Property Map
    Configures a default Service Connect namespace. Detailed below.
    settings List<Property Map>
    Configuration block(s) with cluster settings. For example, this can be used to enable CloudWatch Container Insights for a cluster. Detailed below.
    tags Map<String>
    Key-value map of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String>
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Supporting Types

    ClusterConfiguration, ClusterConfigurationArgs

    ExecuteCommandConfiguration ClusterConfigurationExecuteCommandConfiguration
    The details of the execute command configuration. Detailed below.
    ExecuteCommandConfiguration ClusterConfigurationExecuteCommandConfiguration
    The details of the execute command configuration. Detailed below.
    executeCommandConfiguration ClusterConfigurationExecuteCommandConfiguration
    The details of the execute command configuration. Detailed below.
    executeCommandConfiguration ClusterConfigurationExecuteCommandConfiguration
    The details of the execute command configuration. Detailed below.
    execute_command_configuration ClusterConfigurationExecuteCommandConfiguration
    The details of the execute command configuration. Detailed below.
    executeCommandConfiguration Property Map
    The details of the execute command configuration. Detailed below.

    ClusterConfigurationExecuteCommandConfiguration, ClusterConfigurationExecuteCommandConfigurationArgs

    KmsKeyId string
    The AWS Key Management Service key ID to encrypt the data between the local client and the container.
    LogConfiguration ClusterConfigurationExecuteCommandConfigurationLogConfiguration
    The log configuration for the results of the execute command actions Required when logging is OVERRIDE. Detailed below.
    Logging string
    The log setting to use for redirecting logs for your execute command results. Valid values are NONE, DEFAULT, and OVERRIDE.
    KmsKeyId string
    The AWS Key Management Service key ID to encrypt the data between the local client and the container.
    LogConfiguration ClusterConfigurationExecuteCommandConfigurationLogConfiguration
    The log configuration for the results of the execute command actions Required when logging is OVERRIDE. Detailed below.
    Logging string
    The log setting to use for redirecting logs for your execute command results. Valid values are NONE, DEFAULT, and OVERRIDE.
    kmsKeyId String
    The AWS Key Management Service key ID to encrypt the data between the local client and the container.
    logConfiguration ClusterConfigurationExecuteCommandConfigurationLogConfiguration
    The log configuration for the results of the execute command actions Required when logging is OVERRIDE. Detailed below.
    logging String
    The log setting to use for redirecting logs for your execute command results. Valid values are NONE, DEFAULT, and OVERRIDE.
    kmsKeyId string
    The AWS Key Management Service key ID to encrypt the data between the local client and the container.
    logConfiguration ClusterConfigurationExecuteCommandConfigurationLogConfiguration
    The log configuration for the results of the execute command actions Required when logging is OVERRIDE. Detailed below.
    logging string
    The log setting to use for redirecting logs for your execute command results. Valid values are NONE, DEFAULT, and OVERRIDE.
    kms_key_id str
    The AWS Key Management Service key ID to encrypt the data between the local client and the container.
    log_configuration ClusterConfigurationExecuteCommandConfigurationLogConfiguration
    The log configuration for the results of the execute command actions Required when logging is OVERRIDE. Detailed below.
    logging str
    The log setting to use for redirecting logs for your execute command results. Valid values are NONE, DEFAULT, and OVERRIDE.
    kmsKeyId String
    The AWS Key Management Service key ID to encrypt the data between the local client and the container.
    logConfiguration Property Map
    The log configuration for the results of the execute command actions Required when logging is OVERRIDE. Detailed below.
    logging String
    The log setting to use for redirecting logs for your execute command results. Valid values are NONE, DEFAULT, and OVERRIDE.

    ClusterConfigurationExecuteCommandConfigurationLogConfiguration, ClusterConfigurationExecuteCommandConfigurationLogConfigurationArgs

    CloudWatchEncryptionEnabled bool
    Whether or not to enable encryption on the CloudWatch logs. If not specified, encryption will be disabled.
    CloudWatchLogGroupName string
    The name of the CloudWatch log group to send logs to.
    S3BucketEncryptionEnabled bool
    Whether or not to enable encryption on the logs sent to S3. If not specified, encryption will be disabled.
    S3BucketName string
    The name of the S3 bucket to send logs to.
    S3KeyPrefix string
    An optional folder in the S3 bucket to place logs in.
    CloudWatchEncryptionEnabled bool
    Whether or not to enable encryption on the CloudWatch logs. If not specified, encryption will be disabled.
    CloudWatchLogGroupName string
    The name of the CloudWatch log group to send logs to.
    S3BucketEncryptionEnabled bool
    Whether or not to enable encryption on the logs sent to S3. If not specified, encryption will be disabled.
    S3BucketName string
    The name of the S3 bucket to send logs to.
    S3KeyPrefix string
    An optional folder in the S3 bucket to place logs in.
    cloudWatchEncryptionEnabled Boolean
    Whether or not to enable encryption on the CloudWatch logs. If not specified, encryption will be disabled.
    cloudWatchLogGroupName String
    The name of the CloudWatch log group to send logs to.
    s3BucketEncryptionEnabled Boolean
    Whether or not to enable encryption on the logs sent to S3. If not specified, encryption will be disabled.
    s3BucketName String
    The name of the S3 bucket to send logs to.
    s3KeyPrefix String
    An optional folder in the S3 bucket to place logs in.
    cloudWatchEncryptionEnabled boolean
    Whether or not to enable encryption on the CloudWatch logs. If not specified, encryption will be disabled.
    cloudWatchLogGroupName string
    The name of the CloudWatch log group to send logs to.
    s3BucketEncryptionEnabled boolean
    Whether or not to enable encryption on the logs sent to S3. If not specified, encryption will be disabled.
    s3BucketName string
    The name of the S3 bucket to send logs to.
    s3KeyPrefix string
    An optional folder in the S3 bucket to place logs in.
    cloud_watch_encryption_enabled bool
    Whether or not to enable encryption on the CloudWatch logs. If not specified, encryption will be disabled.
    cloud_watch_log_group_name str
    The name of the CloudWatch log group to send logs to.
    s3_bucket_encryption_enabled bool
    Whether or not to enable encryption on the logs sent to S3. If not specified, encryption will be disabled.
    s3_bucket_name str
    The name of the S3 bucket to send logs to.
    s3_key_prefix str
    An optional folder in the S3 bucket to place logs in.
    cloudWatchEncryptionEnabled Boolean
    Whether or not to enable encryption on the CloudWatch logs. If not specified, encryption will be disabled.
    cloudWatchLogGroupName String
    The name of the CloudWatch log group to send logs to.
    s3BucketEncryptionEnabled Boolean
    Whether or not to enable encryption on the logs sent to S3. If not specified, encryption will be disabled.
    s3BucketName String
    The name of the S3 bucket to send logs to.
    s3KeyPrefix String
    An optional folder in the S3 bucket to place logs in.

    ClusterServiceConnectDefaults, ClusterServiceConnectDefaultsArgs

    Namespace string
    The ARN of the aws.servicediscovery.HttpNamespace that's used when you create a service and don't specify a Service Connect configuration.
    Namespace string
    The ARN of the aws.servicediscovery.HttpNamespace that's used when you create a service and don't specify a Service Connect configuration.
    namespace String
    The ARN of the aws.servicediscovery.HttpNamespace that's used when you create a service and don't specify a Service Connect configuration.
    namespace string
    The ARN of the aws.servicediscovery.HttpNamespace that's used when you create a service and don't specify a Service Connect configuration.
    namespace str
    The ARN of the aws.servicediscovery.HttpNamespace that's used when you create a service and don't specify a Service Connect configuration.
    namespace String
    The ARN of the aws.servicediscovery.HttpNamespace that's used when you create a service and don't specify a Service Connect configuration.

    ClusterSetting, ClusterSettingArgs

    Name string
    Name of the setting to manage. Valid values: containerInsights.
    Value string
    The value to assign to the setting. Valid values are enabled and disabled.
    Name string
    Name of the setting to manage. Valid values: containerInsights.
    Value string
    The value to assign to the setting. Valid values are enabled and disabled.
    name String
    Name of the setting to manage. Valid values: containerInsights.
    value String
    The value to assign to the setting. Valid values are enabled and disabled.
    name string
    Name of the setting to manage. Valid values: containerInsights.
    value string
    The value to assign to the setting. Valid values are enabled and disabled.
    name str
    Name of the setting to manage. Valid values: containerInsights.
    value str
    The value to assign to the setting. Valid values are enabled and disabled.
    name String
    Name of the setting to manage. Valid values: containerInsights.
    value String
    The value to assign to the setting. Valid values are enabled and disabled.

    Import

    Using pulumi import, import ECS clusters using the name. For example:

    $ pulumi import aws:ecs/cluster:Cluster stateless stateless-app
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo

    Try AWS Native preview for resources not in the classic version.

    AWS Classic v6.45.0 published on Tuesday, Jul 16, 2024 by Pulumi