aws.ecs.Cluster
Explore with Pulumi AI
Provides an ECS cluster.
NOTE on Clusters and Cluster Capacity Providers: this provider provides both a standalone
aws.ecs.ClusterCapacityProviders
resource, as well as allowing the capacity providers and default strategies to be managed in-line by theaws.ecs.Cluster
resource. You cannot use a Cluster with in-line capacity providers in conjunction with the Capacity Providers resource, nor use more than one Capacity Providers resource with a single Cluster, as doing so will cause a conflict and will lead to mutual overwrites.
Example Usage
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()
{
Settings = new[]
{
new Aws.Ecs.Inputs.ClusterSettingArgs
{
Name = "containerInsights",
Value = "enabled",
},
},
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v5/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{
Settings: ecs.ClusterSettingArray{
&ecs.ClusterSettingArgs{
Name: pulumi.String("containerInsights"),
Value: pulumi.String("enabled"),
},
},
})
if err != nil {
return err
}
return nil
})
}
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()
.settings(ClusterSettingArgs.builder()
.name("containerInsights")
.value("enabled")
.build())
.build());
}
}
import pulumi
import pulumi_aws as aws
foo = aws.ecs.Cluster("foo", settings=[aws.ecs.ClusterSettingArgs(
name="containerInsights",
value="enabled",
)])
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const foo = new aws.ecs.Cluster("foo", {settings: [{
name: "containerInsights",
value: "enabled",
}]});
resources:
foo:
type: aws:ecs:Cluster
properties:
settings:
- name: containerInsights
value: enabled
Example with Log Configuration
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var exampleKey = new Aws.Kms.Key("exampleKey", new()
{
Description = "example",
DeletionWindowInDays = 7,
});
var exampleLogGroup = new Aws.CloudWatch.LogGroup("exampleLogGroup");
var test = new Aws.Ecs.Cluster("test", new()
{
Configuration = new Aws.Ecs.Inputs.ClusterConfigurationArgs
{
ExecuteCommandConfiguration = new Aws.Ecs.Inputs.ClusterConfigurationExecuteCommandConfigurationArgs
{
KmsKeyId = exampleKey.Arn,
Logging = "OVERRIDE",
LogConfiguration = new Aws.Ecs.Inputs.ClusterConfigurationExecuteCommandConfigurationLogConfigurationArgs
{
CloudWatchEncryptionEnabled = true,
CloudWatchLogGroupName = exampleLogGroup.Name,
},
},
},
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v5/go/aws/cloudwatch"
"github.com/pulumi/pulumi-aws/sdk/v5/go/aws/ecs"
"github.com/pulumi/pulumi-aws/sdk/v5/go/aws/kms"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
exampleKey, err := kms.NewKey(ctx, "exampleKey", &kms.KeyArgs{
Description: pulumi.String("example"),
DeletionWindowInDays: pulumi.Int(7),
})
if err != nil {
return err
}
exampleLogGroup, err := cloudwatch.NewLogGroup(ctx, "exampleLogGroup", nil)
if err != nil {
return err
}
_, err = ecs.NewCluster(ctx, "test", &ecs.ClusterArgs{
Configuration: &ecs.ClusterConfigurationArgs{
ExecuteCommandConfiguration: &ecs.ClusterConfigurationExecuteCommandConfigurationArgs{
KmsKeyId: exampleKey.Arn,
Logging: pulumi.String("OVERRIDE"),
LogConfiguration: &ecs.ClusterConfigurationExecuteCommandConfigurationLogConfigurationArgs{
CloudWatchEncryptionEnabled: pulumi.Bool(true),
CloudWatchLogGroupName: exampleLogGroup.Name,
},
},
},
})
if err != nil {
return err
}
return nil
})
}
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.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 exampleKey = new Key("exampleKey", KeyArgs.builder()
.description("example")
.deletionWindowInDays(7)
.build());
var exampleLogGroup = new LogGroup("exampleLogGroup");
var test = new Cluster("test", ClusterArgs.builder()
.configuration(ClusterConfigurationArgs.builder()
.executeCommandConfiguration(ClusterConfigurationExecuteCommandConfigurationArgs.builder()
.kmsKeyId(exampleKey.arn())
.logging("OVERRIDE")
.logConfiguration(ClusterConfigurationExecuteCommandConfigurationLogConfigurationArgs.builder()
.cloudWatchEncryptionEnabled(true)
.cloudWatchLogGroupName(exampleLogGroup.name())
.build())
.build())
.build())
.build());
}
}
import pulumi
import pulumi_aws as aws
example_key = aws.kms.Key("exampleKey",
description="example",
deletion_window_in_days=7)
example_log_group = aws.cloudwatch.LogGroup("exampleLogGroup")
test = aws.ecs.Cluster("test", configuration=aws.ecs.ClusterConfigurationArgs(
execute_command_configuration=aws.ecs.ClusterConfigurationExecuteCommandConfigurationArgs(
kms_key_id=example_key.arn,
logging="OVERRIDE",
log_configuration=aws.ecs.ClusterConfigurationExecuteCommandConfigurationLogConfigurationArgs(
cloud_watch_encryption_enabled=True,
cloud_watch_log_group_name=example_log_group.name,
),
),
))
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const exampleKey = new aws.kms.Key("exampleKey", {
description: "example",
deletionWindowInDays: 7,
});
const exampleLogGroup = new aws.cloudwatch.LogGroup("exampleLogGroup", {});
const test = new aws.ecs.Cluster("test", {configuration: {
executeCommandConfiguration: {
kmsKeyId: exampleKey.arn,
logging: "OVERRIDE",
logConfiguration: {
cloudWatchEncryptionEnabled: true,
cloudWatchLogGroupName: exampleLogGroup.name,
},
},
}});
resources:
exampleKey:
type: aws:kms:Key
properties:
description: example
deletionWindowInDays: 7
exampleLogGroup:
type: aws:cloudwatch:LogGroup
test:
type: aws:ecs:Cluster
properties:
configuration:
executeCommandConfiguration:
kmsKeyId: ${exampleKey.arn}
logging: OVERRIDE
logConfiguration:
cloudWatchEncryptionEnabled: true
cloudWatchLogGroupName: ${exampleLogGroup.name}
Example with Capacity Providers
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var exampleCluster = new Aws.Ecs.Cluster("exampleCluster");
var exampleCapacityProvider = new Aws.Ecs.CapacityProvider("exampleCapacityProvider", new()
{
AutoScalingGroupProvider = new Aws.Ecs.Inputs.CapacityProviderAutoScalingGroupProviderArgs
{
AutoScalingGroupArn = aws_autoscaling_group.Example.Arn,
},
});
var exampleClusterCapacityProviders = new Aws.Ecs.ClusterCapacityProviders("exampleClusterCapacityProviders", new()
{
ClusterName = exampleCluster.Name,
CapacityProviders = new[]
{
exampleCapacityProvider.Name,
},
DefaultCapacityProviderStrategies = new[]
{
new Aws.Ecs.Inputs.ClusterCapacityProvidersDefaultCapacityProviderStrategyArgs
{
Base = 1,
Weight = 100,
CapacityProvider = exampleCapacityProvider.Name,
},
},
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v5/go/aws/ecs"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
exampleCluster, err := ecs.NewCluster(ctx, "exampleCluster", nil)
if err != nil {
return err
}
exampleCapacityProvider, err := ecs.NewCapacityProvider(ctx, "exampleCapacityProvider", &ecs.CapacityProviderArgs{
AutoScalingGroupProvider: &ecs.CapacityProviderAutoScalingGroupProviderArgs{
AutoScalingGroupArn: pulumi.Any(aws_autoscaling_group.Example.Arn),
},
})
if err != nil {
return err
}
_, err = ecs.NewClusterCapacityProviders(ctx, "exampleClusterCapacityProviders", &ecs.ClusterCapacityProvidersArgs{
ClusterName: exampleCluster.Name,
CapacityProviders: pulumi.StringArray{
exampleCapacityProvider.Name,
},
DefaultCapacityProviderStrategies: ecs.ClusterCapacityProvidersDefaultCapacityProviderStrategyArray{
&ecs.ClusterCapacityProvidersDefaultCapacityProviderStrategyArgs{
Base: pulumi.Int(1),
Weight: pulumi.Int(100),
CapacityProvider: exampleCapacityProvider.Name,
},
},
})
if err != nil {
return err
}
return nil
})
}
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.CapacityProvider;
import com.pulumi.aws.ecs.CapacityProviderArgs;
import com.pulumi.aws.ecs.inputs.CapacityProviderAutoScalingGroupProviderArgs;
import com.pulumi.aws.ecs.ClusterCapacityProviders;
import com.pulumi.aws.ecs.ClusterCapacityProvidersArgs;
import com.pulumi.aws.ecs.inputs.ClusterCapacityProvidersDefaultCapacityProviderStrategyArgs;
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 exampleCluster = new Cluster("exampleCluster");
var exampleCapacityProvider = new CapacityProvider("exampleCapacityProvider", CapacityProviderArgs.builder()
.autoScalingGroupProvider(CapacityProviderAutoScalingGroupProviderArgs.builder()
.autoScalingGroupArn(aws_autoscaling_group.example().arn())
.build())
.build());
var exampleClusterCapacityProviders = new ClusterCapacityProviders("exampleClusterCapacityProviders", ClusterCapacityProvidersArgs.builder()
.clusterName(exampleCluster.name())
.capacityProviders(exampleCapacityProvider.name())
.defaultCapacityProviderStrategies(ClusterCapacityProvidersDefaultCapacityProviderStrategyArgs.builder()
.base(1)
.weight(100)
.capacityProvider(exampleCapacityProvider.name())
.build())
.build());
}
}
import pulumi
import pulumi_aws as aws
example_cluster = aws.ecs.Cluster("exampleCluster")
example_capacity_provider = aws.ecs.CapacityProvider("exampleCapacityProvider", auto_scaling_group_provider=aws.ecs.CapacityProviderAutoScalingGroupProviderArgs(
auto_scaling_group_arn=aws_autoscaling_group["example"]["arn"],
))
example_cluster_capacity_providers = aws.ecs.ClusterCapacityProviders("exampleClusterCapacityProviders",
cluster_name=example_cluster.name,
capacity_providers=[example_capacity_provider.name],
default_capacity_provider_strategies=[aws.ecs.ClusterCapacityProvidersDefaultCapacityProviderStrategyArgs(
base=1,
weight=100,
capacity_provider=example_capacity_provider.name,
)])
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const exampleCluster = new aws.ecs.Cluster("exampleCluster", {});
const exampleCapacityProvider = new aws.ecs.CapacityProvider("exampleCapacityProvider", {autoScalingGroupProvider: {
autoScalingGroupArn: aws_autoscaling_group.example.arn,
}});
const exampleClusterCapacityProviders = new aws.ecs.ClusterCapacityProviders("exampleClusterCapacityProviders", {
clusterName: exampleCluster.name,
capacityProviders: [exampleCapacityProvider.name],
defaultCapacityProviderStrategies: [{
base: 1,
weight: 100,
capacityProvider: exampleCapacityProvider.name,
}],
});
resources:
exampleCluster:
type: aws:ecs:Cluster
exampleClusterCapacityProviders:
type: aws:ecs:ClusterCapacityProviders
properties:
clusterName: ${exampleCluster.name}
capacityProviders:
- ${exampleCapacityProvider.name}
defaultCapacityProviderStrategies:
- base: 1
weight: 100
capacityProvider: ${exampleCapacityProvider.name}
exampleCapacityProvider:
type: aws:ecs:CapacityProvider
properties:
autoScalingGroupProvider:
autoScalingGroupArn: ${aws_autoscaling_group.example.arn}
Create Cluster Resource
new Cluster(name: string, args?: ClusterArgs, opts?: CustomResourceOptions);
@overload
def Cluster(resource_name: str,
opts: Optional[ResourceOptions] = None,
capacity_providers: Optional[Sequence[str]] = None,
configuration: Optional[ClusterConfigurationArgs] = None,
default_capacity_provider_strategies: Optional[Sequence[ClusterDefaultCapacityProviderStrategyArgs]] = None,
name: Optional[str] = None,
service_connect_defaults: Optional[ClusterServiceConnectDefaultsArgs] = None,
settings: Optional[Sequence[ClusterSettingArgs]] = None,
tags: Optional[Mapping[str, str]] = None)
@overload
def Cluster(resource_name: str,
args: Optional[ClusterArgs] = None,
opts: Optional[ResourceOptions] = 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.
- 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.
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:
- Capacity
Providers List<string> List of short names of one or more capacity providers to associate with the cluster. Valid values also include
FARGATE
andFARGATE_SPOT
.Use the aws_ecs_cluster_capacity_providers resource instead
- Configuration
Cluster
Configuration Args The execute command configuration for the cluster. Detailed below.
- Default
Capacity List<ClusterProvider Strategies Default Capacity Provider Strategy Args> Configuration block for capacity provider strategy to use by default for the cluster. Can be one or more. Detailed below.
Use the aws_ecs_cluster_capacity_providers resource instead
- Name string
Name of the cluster (up to 255 letters, numbers, hyphens, and underscores)
- Service
Connect ClusterDefaults Service Connect Defaults Args Configures a default Service Connect namespace. Detailed below.
- Settings
List<Cluster
Setting Args> Configuration block(s) with cluster settings. For example, this can be used to enable CloudWatch Container Insights for a cluster. Detailed below.
- 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.
- Capacity
Providers []string List of short names of one or more capacity providers to associate with the cluster. Valid values also include
FARGATE
andFARGATE_SPOT
.Use the aws_ecs_cluster_capacity_providers resource instead
- Configuration
Cluster
Configuration Args The execute command configuration for the cluster. Detailed below.
- Default
Capacity []ClusterProvider Strategies Default Capacity Provider Strategy Args Configuration block for capacity provider strategy to use by default for the cluster. Can be one or more. Detailed below.
Use the aws_ecs_cluster_capacity_providers resource instead
- Name string
Name of the cluster (up to 255 letters, numbers, hyphens, and underscores)
- Service
Connect ClusterDefaults Service Connect Defaults Args Configures a default Service Connect namespace. Detailed below.
- Settings
[]Cluster
Setting Args Configuration block(s) with cluster settings. For example, this can be used to enable CloudWatch Container Insights for a cluster. Detailed below.
- 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.
- capacity
Providers List<String> List of short names of one or more capacity providers to associate with the cluster. Valid values also include
FARGATE
andFARGATE_SPOT
.Use the aws_ecs_cluster_capacity_providers resource instead
- configuration
Cluster
Configuration Args The execute command configuration for the cluster. Detailed below.
- default
Capacity List<ClusterProvider Strategies Default Capacity Provider Strategy Args> Configuration block for capacity provider strategy to use by default for the cluster. Can be one or more. Detailed below.
Use the aws_ecs_cluster_capacity_providers resource instead
- name String
Name of the cluster (up to 255 letters, numbers, hyphens, and underscores)
- service
Connect ClusterDefaults Service Connect Defaults Args Configures a default Service Connect namespace. Detailed below.
- settings
List<Cluster
Setting Args> Configuration block(s) with cluster settings. For example, this can be used to enable CloudWatch Container Insights for a cluster. Detailed below.
- 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.
- capacity
Providers string[] List of short names of one or more capacity providers to associate with the cluster. Valid values also include
FARGATE
andFARGATE_SPOT
.Use the aws_ecs_cluster_capacity_providers resource instead
- configuration
Cluster
Configuration Args The execute command configuration for the cluster. Detailed below.
- default
Capacity ClusterProvider Strategies Default Capacity Provider Strategy Args[] Configuration block for capacity provider strategy to use by default for the cluster. Can be one or more. Detailed below.
Use the aws_ecs_cluster_capacity_providers resource instead
- name string
Name of the cluster (up to 255 letters, numbers, hyphens, and underscores)
- service
Connect ClusterDefaults Service Connect Defaults Args Configures a default Service Connect namespace. Detailed below.
- settings
Cluster
Setting Args[] Configuration block(s) with cluster settings. For example, this can be used to enable CloudWatch Container Insights for a cluster. Detailed below.
- {[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.
- capacity_
providers Sequence[str] List of short names of one or more capacity providers to associate with the cluster. Valid values also include
FARGATE
andFARGATE_SPOT
.Use the aws_ecs_cluster_capacity_providers resource instead
- configuration
Cluster
Configuration Args The execute command configuration for the cluster. Detailed below.
- default_
capacity_ Sequence[Clusterprovider_ strategies Default Capacity Provider Strategy Args] Configuration block for capacity provider strategy to use by default for the cluster. Can be one or more. Detailed below.
Use the aws_ecs_cluster_capacity_providers resource instead
- name str
Name of the cluster (up to 255 letters, numbers, hyphens, and underscores)
- service_
connect_ Clusterdefaults Service Connect Defaults Args Configures a default Service Connect namespace. Detailed below.
- settings
Sequence[Cluster
Setting Args] Configuration block(s) with cluster settings. For example, this can be used to enable CloudWatch Container Insights for a cluster. Detailed below.
- 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.
- capacity
Providers List<String> List of short names of one or more capacity providers to associate with the cluster. Valid values also include
FARGATE
andFARGATE_SPOT
.Use the aws_ecs_cluster_capacity_providers resource instead
- configuration Property Map
The execute command configuration for the cluster. Detailed below.
- default
Capacity List<Property Map>Provider Strategies Configuration block for capacity provider strategy to use by default for the cluster. Can be one or more. Detailed below.
Use the aws_ecs_cluster_capacity_providers resource instead
- name String
Name of the cluster (up to 255 letters, numbers, hyphens, and underscores)
- service
Connect Property MapDefaults 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.
- 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:
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,
capacity_providers: Optional[Sequence[str]] = None,
configuration: Optional[ClusterConfigurationArgs] = None,
default_capacity_provider_strategies: Optional[Sequence[ClusterDefaultCapacityProviderStrategyArgs]] = 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.
- Arn string
ARN that identifies the cluster.
- Capacity
Providers List<string> List of short names of one or more capacity providers to associate with the cluster. Valid values also include
FARGATE
andFARGATE_SPOT
.Use the aws_ecs_cluster_capacity_providers resource instead
- Configuration
Cluster
Configuration Args The execute command configuration for the cluster. Detailed below.
- Default
Capacity List<ClusterProvider Strategies Default Capacity Provider Strategy Args> Configuration block for capacity provider strategy to use by default for the cluster. Can be one or more. Detailed below.
Use the aws_ecs_cluster_capacity_providers resource instead
- Name string
Name of the cluster (up to 255 letters, numbers, hyphens, and underscores)
- Service
Connect ClusterDefaults Service Connect Defaults Args Configures a default Service Connect namespace. Detailed below.
- Settings
List<Cluster
Setting Args> Configuration block(s) with cluster settings. For example, this can be used to enable CloudWatch Container Insights for a cluster. Detailed below.
- 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.- Dictionary<string, string>
Map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.
- Arn string
ARN that identifies the cluster.
- Capacity
Providers []string List of short names of one or more capacity providers to associate with the cluster. Valid values also include
FARGATE
andFARGATE_SPOT
.Use the aws_ecs_cluster_capacity_providers resource instead
- Configuration
Cluster
Configuration Args The execute command configuration for the cluster. Detailed below.
- Default
Capacity []ClusterProvider Strategies Default Capacity Provider Strategy Args Configuration block for capacity provider strategy to use by default for the cluster. Can be one or more. Detailed below.
Use the aws_ecs_cluster_capacity_providers resource instead
- Name string
Name of the cluster (up to 255 letters, numbers, hyphens, and underscores)
- Service
Connect ClusterDefaults Service Connect Defaults Args Configures a default Service Connect namespace. Detailed below.
- Settings
[]Cluster
Setting Args Configuration block(s) with cluster settings. For example, this can be used to enable CloudWatch Container Insights for a cluster. Detailed below.
- 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.- map[string]string
Map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.
- arn String
ARN that identifies the cluster.
- capacity
Providers List<String> List of short names of one or more capacity providers to associate with the cluster. Valid values also include
FARGATE
andFARGATE_SPOT
.Use the aws_ecs_cluster_capacity_providers resource instead
- configuration
Cluster
Configuration Args The execute command configuration for the cluster. Detailed below.
- default
Capacity List<ClusterProvider Strategies Default Capacity Provider Strategy Args> Configuration block for capacity provider strategy to use by default for the cluster. Can be one or more. Detailed below.
Use the aws_ecs_cluster_capacity_providers resource instead
- name String
Name of the cluster (up to 255 letters, numbers, hyphens, and underscores)
- service
Connect ClusterDefaults Service Connect Defaults Args Configures a default Service Connect namespace. Detailed below.
- settings
List<Cluster
Setting Args> Configuration block(s) with cluster settings. For example, this can be used to enable CloudWatch Container Insights for a cluster. Detailed below.
- 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.- Map<String,String>
Map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.
- arn string
ARN that identifies the cluster.
- capacity
Providers string[] List of short names of one or more capacity providers to associate with the cluster. Valid values also include
FARGATE
andFARGATE_SPOT
.Use the aws_ecs_cluster_capacity_providers resource instead
- configuration
Cluster
Configuration Args The execute command configuration for the cluster. Detailed below.
- default
Capacity ClusterProvider Strategies Default Capacity Provider Strategy Args[] Configuration block for capacity provider strategy to use by default for the cluster. Can be one or more. Detailed below.
Use the aws_ecs_cluster_capacity_providers resource instead
- name string
Name of the cluster (up to 255 letters, numbers, hyphens, and underscores)
- service
Connect ClusterDefaults Service Connect Defaults Args Configures a default Service Connect namespace. Detailed below.
- settings
Cluster
Setting Args[] Configuration block(s) with cluster settings. For example, this can be used to enable CloudWatch Container Insights for a cluster. Detailed below.
- {[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.- {[key: string]: string}
Map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.
- arn str
ARN that identifies the cluster.
- capacity_
providers Sequence[str] List of short names of one or more capacity providers to associate with the cluster. Valid values also include
FARGATE
andFARGATE_SPOT
.Use the aws_ecs_cluster_capacity_providers resource instead
- configuration
Cluster
Configuration Args The execute command configuration for the cluster. Detailed below.
- default_
capacity_ Sequence[Clusterprovider_ strategies Default Capacity Provider Strategy Args] Configuration block for capacity provider strategy to use by default for the cluster. Can be one or more. Detailed below.
Use the aws_ecs_cluster_capacity_providers resource instead
- name str
Name of the cluster (up to 255 letters, numbers, hyphens, and underscores)
- service_
connect_ Clusterdefaults Service Connect Defaults Args Configures a default Service Connect namespace. Detailed below.
- settings
Sequence[Cluster
Setting Args] Configuration block(s) with cluster settings. For example, this can be used to enable CloudWatch Container Insights for a cluster. Detailed below.
- 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.- Mapping[str, str]
Map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.
- arn String
ARN that identifies the cluster.
- capacity
Providers List<String> List of short names of one or more capacity providers to associate with the cluster. Valid values also include
FARGATE
andFARGATE_SPOT
.Use the aws_ecs_cluster_capacity_providers resource instead
- configuration Property Map
The execute command configuration for the cluster. Detailed below.
- default
Capacity List<Property Map>Provider Strategies Configuration block for capacity provider strategy to use by default for the cluster. Can be one or more. Detailed below.
Use the aws_ecs_cluster_capacity_providers resource instead
- name String
Name of the cluster (up to 255 letters, numbers, hyphens, and underscores)
- service
Connect Property MapDefaults 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.
- 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.- Map<String>
Map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.
Supporting Types
ClusterConfiguration
- Execute
Command ClusterConfiguration Configuration Execute Command Configuration The details of the execute command configuration. Detailed below.
- Execute
Command ClusterConfiguration Configuration Execute Command Configuration The details of the execute command configuration. Detailed below.
- execute
Command ClusterConfiguration Configuration Execute Command Configuration The details of the execute command configuration. Detailed below.
- execute
Command ClusterConfiguration Configuration Execute Command Configuration The details of the execute command configuration. Detailed below.
- execute_
command_ Clusterconfiguration Configuration Execute Command Configuration The details of the execute command configuration. Detailed below.
- execute
Command Property MapConfiguration The details of the execute command configuration. Detailed below.
ClusterConfigurationExecuteCommandConfiguration
- Kms
Key stringId The AWS Key Management Service key ID to encrypt the data between the local client and the container.
- Log
Configuration ClusterConfiguration Execute Command Configuration Log Configuration The log configuration for the results of the execute command actions Required when
logging
isOVERRIDE
. Detailed below.- Logging string
The log setting to use for redirecting logs for your execute command results. Valid values are
NONE
,DEFAULT
, andOVERRIDE
.
- Kms
Key stringId The AWS Key Management Service key ID to encrypt the data between the local client and the container.
- Log
Configuration ClusterConfiguration Execute Command Configuration Log Configuration The log configuration for the results of the execute command actions Required when
logging
isOVERRIDE
. Detailed below.- Logging string
The log setting to use for redirecting logs for your execute command results. Valid values are
NONE
,DEFAULT
, andOVERRIDE
.
- kms
Key StringId The AWS Key Management Service key ID to encrypt the data between the local client and the container.
- log
Configuration ClusterConfiguration Execute Command Configuration Log Configuration The log configuration for the results of the execute command actions Required when
logging
isOVERRIDE
. Detailed below.- logging String
The log setting to use for redirecting logs for your execute command results. Valid values are
NONE
,DEFAULT
, andOVERRIDE
.
- kms
Key stringId The AWS Key Management Service key ID to encrypt the data between the local client and the container.
- log
Configuration ClusterConfiguration Execute Command Configuration Log Configuration The log configuration for the results of the execute command actions Required when
logging
isOVERRIDE
. Detailed below.- logging string
The log setting to use for redirecting logs for your execute command results. Valid values are
NONE
,DEFAULT
, andOVERRIDE
.
- kms_
key_ strid The AWS Key Management Service key ID to encrypt the data between the local client and the container.
- log_
configuration ClusterConfiguration Execute Command Configuration Log Configuration The log configuration for the results of the execute command actions Required when
logging
isOVERRIDE
. Detailed below.- logging str
The log setting to use for redirecting logs for your execute command results. Valid values are
NONE
,DEFAULT
, andOVERRIDE
.
- kms
Key StringId The AWS Key Management Service key ID to encrypt the data between the local client and the container.
- log
Configuration Property Map The log configuration for the results of the execute command actions Required when
logging
isOVERRIDE
. Detailed below.- logging String
The log setting to use for redirecting logs for your execute command results. Valid values are
NONE
,DEFAULT
, andOVERRIDE
.
ClusterConfigurationExecuteCommandConfigurationLogConfiguration
- Cloud
Watch boolEncryption Enabled Whether or not to enable encryption on the CloudWatch logs. If not specified, encryption will be disabled.
- Cloud
Watch stringLog Group Name The name of the CloudWatch log group to send logs to.
- S3Bucket
Encryption boolEnabled Whether or not to enable encryption on the logs sent to S3. If not specified, encryption will be disabled.
- S3Bucket
Name string The name of the S3 bucket to send logs to.
- S3Key
Prefix string An optional folder in the S3 bucket to place logs in.
- Cloud
Watch boolEncryption Enabled Whether or not to enable encryption on the CloudWatch logs. If not specified, encryption will be disabled.
- Cloud
Watch stringLog Group Name The name of the CloudWatch log group to send logs to.
- S3Bucket
Encryption boolEnabled Whether or not to enable encryption on the logs sent to S3. If not specified, encryption will be disabled.
- S3Bucket
Name string The name of the S3 bucket to send logs to.
- S3Key
Prefix string An optional folder in the S3 bucket to place logs in.
- cloud
Watch BooleanEncryption Enabled Whether or not to enable encryption on the CloudWatch logs. If not specified, encryption will be disabled.
- cloud
Watch StringLog Group Name The name of the CloudWatch log group to send logs to.
- s3Bucket
Encryption BooleanEnabled Whether or not to enable encryption on the logs sent to S3. If not specified, encryption will be disabled.
- s3Bucket
Name String The name of the S3 bucket to send logs to.
- s3Key
Prefix String An optional folder in the S3 bucket to place logs in.
- cloud
Watch booleanEncryption Enabled Whether or not to enable encryption on the CloudWatch logs. If not specified, encryption will be disabled.
- cloud
Watch stringLog Group Name The name of the CloudWatch log group to send logs to.
- s3Bucket
Encryption booleanEnabled Whether or not to enable encryption on the logs sent to S3. If not specified, encryption will be disabled.
- s3Bucket
Name string The name of the S3 bucket to send logs to.
- s3Key
Prefix string An optional folder in the S3 bucket to place logs in.
- cloud_
watch_ boolencryption_ enabled Whether or not to enable encryption on the CloudWatch logs. If not specified, encryption will be disabled.
- cloud_
watch_ strlog_ group_ name The name of the CloudWatch log group to send logs to.
- s3_
bucket_ boolencryption_ enabled Whether or not to enable encryption on the logs sent to S3. If not specified, encryption will be disabled.
- s3_
bucket_ strname The name of the S3 bucket to send logs to.
- s3_
key_ strprefix An optional folder in the S3 bucket to place logs in.
- cloud
Watch BooleanEncryption Enabled Whether or not to enable encryption on the CloudWatch logs. If not specified, encryption will be disabled.
- cloud
Watch StringLog Group Name The name of the CloudWatch log group to send logs to.
- s3Bucket
Encryption BooleanEnabled Whether or not to enable encryption on the logs sent to S3. If not specified, encryption will be disabled.
- s3Bucket
Name String The name of the S3 bucket to send logs to.
- s3Key
Prefix String An optional folder in the S3 bucket to place logs in.
ClusterDefaultCapacityProviderStrategy
- Capacity
Provider string The short name of the capacity provider.
- Base int
The number of tasks, at a minimum, to run on the specified capacity provider. Only one capacity provider in a capacity provider strategy can have a base defined.
- Weight int
The relative percentage of the total number of launched tasks that should use the specified capacity provider.
- Capacity
Provider string The short name of the capacity provider.
- Base int
The number of tasks, at a minimum, to run on the specified capacity provider. Only one capacity provider in a capacity provider strategy can have a base defined.
- Weight int
The relative percentage of the total number of launched tasks that should use the specified capacity provider.
- capacity
Provider String The short name of the capacity provider.
- base Integer
The number of tasks, at a minimum, to run on the specified capacity provider. Only one capacity provider in a capacity provider strategy can have a base defined.
- weight Integer
The relative percentage of the total number of launched tasks that should use the specified capacity provider.
- capacity
Provider string The short name of the capacity provider.
- base number
The number of tasks, at a minimum, to run on the specified capacity provider. Only one capacity provider in a capacity provider strategy can have a base defined.
- weight number
The relative percentage of the total number of launched tasks that should use the specified capacity provider.
- capacity_
provider str The short name of the capacity provider.
- base int
The number of tasks, at a minimum, to run on the specified capacity provider. Only one capacity provider in a capacity provider strategy can have a base defined.
- weight int
The relative percentage of the total number of launched tasks that should use the specified capacity provider.
- capacity
Provider String The short name of the capacity provider.
- base Number
The number of tasks, at a minimum, to run on the specified capacity provider. Only one capacity provider in a capacity provider strategy can have a base defined.
- weight Number
The relative percentage of the total number of launched tasks that should use the specified capacity provider.
ClusterServiceConnectDefaults
- 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
Import
ECS clusters can be imported using the name
, e.g.,
$ pulumi import aws:ecs/cluster:Cluster stateless stateless-app
Package Details
- Repository
- AWS Classic pulumi/pulumi-aws
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
aws
Terraform Provider.