ClusterCapacityProviders class

Manages the capacity providers of an ECS Cluster.

More information about capacity providers can be found in the ECS User Guide.

> NOTE: When an associated aws.ecs.CapacityProvider must be replaced, add a replaceTriggeredBy lifecycle rule referencing the capacity provider. This recreates the association so the old capacity provider is detached from the cluster before it is deleted, which AWS otherwise disallows.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.ecs.Cluster("example", {name: "my-cluster"});
const exampleClusterCapacityProviders = new aws.ecs.ClusterCapacityProviders("example", {
    defaultCapacityProviderStrategies: [{
        base: 1,
        weight: 100,
        capacityProvider: "FARGATE",
    }],
    clusterName: example.name,
    capacityProviders: ["FARGATE"],
});
import pulumi
import pulumi_aws as aws

example = aws.ecs.Cluster("example", name="my-cluster")
example_cluster_capacity_providers = aws.ecs.ClusterCapacityProviders("example",
    default_capacity_provider_strategies=[{
        "base": 1,
        "weight": 100,
        "capacity_provider": "FARGATE",
    }],
    cluster_name=example.name,
    capacity_providers=["FARGATE"])
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var example = new Aws.Ecs.Cluster("example", new()
    {
        Name = "my-cluster",
    });

    var exampleClusterCapacityProviders = new Aws.Ecs.ClusterCapacityProviders("example", new()
    {
        DefaultCapacityProviderStrategies = new[]
        {
            new Aws.Ecs.Inputs.ClusterCapacityProvidersDefaultCapacityProviderStrategyArgs
            {
                Base = 1,
                Weight = 100,
                CapacityProvider = "FARGATE",
            },
        },
        ClusterName = example.Name,
        CapacityProviders = new[]
        {
            "FARGATE",
        },
    });

});
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/ecs"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := ecs.NewCluster(ctx, "example", &ecs.ClusterArgs{
			Name: pulumi.String("my-cluster"),
		})
		if err != nil {
			return err
		}
		_, err = ecs.NewClusterCapacityProviders(ctx, "example", &ecs.ClusterCapacityProvidersArgs{
			DefaultCapacityProviderStrategies: ecs.ClusterCapacityProvidersDefaultCapacityProviderStrategyArray{
				&ecs.ClusterCapacityProvidersDefaultCapacityProviderStrategyArgs{
					Base:             pulumi.Int(1),
					Weight:           pulumi.Int(100),
					CapacityProvider: pulumi.String("FARGATE"),
				},
			},
			ClusterName: example.Name,
			CapacityProviders: pulumi.StringArray{
				pulumi.String("FARGATE"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_ecs_cluster" "example" {
  name = "my-cluster"
}
resource "aws_ecs_clustercapacityproviders" "example" {
  default_capacity_provider_strategies {
    base              = 1
    weight            = 100
    capacity_provider = "FARGATE"
  }
  cluster_name       = aws_ecs_cluster.example.name
  capacity_providers = ["FARGATE"]
}
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.ClusterCapacityProviders;
import com.pulumi.aws.ecs.ClusterCapacityProvidersArgs;
import com.pulumi.aws.ecs.inputs.ClusterCapacityProvidersDefaultCapacityProviderStrategyArgs;
import java.util.ArrayList;
import java.util.Arrays;
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 Cluster("example", ClusterArgs.builder()
            .name("my-cluster")
            .build());

        var exampleClusterCapacityProviders = new ClusterCapacityProviders("exampleClusterCapacityProviders", ClusterCapacityProvidersArgs.builder()
            .defaultCapacityProviderStrategies(ClusterCapacityProvidersDefaultCapacityProviderStrategyArgs.builder()
                .base(1)
                .weight(100)
                .capacityProvider("FARGATE")
                .build())
            .clusterName(example.name())
            .capacityProviders("FARGATE")
            .build());

    }
}
resources:
  example:
    type: aws:ecs:Cluster
    properties:
      name: my-cluster
  exampleClusterCapacityProviders:
    type: aws:ecs:ClusterCapacityProviders
    name: example
    properties:
      defaultCapacityProviderStrategies:
        - base: 1
          weight: 100
          capacityProvider: FARGATE
      clusterName: ${example.name}
      capacityProviders:
        - FARGATE

Import

Using pulumi import, import ECS cluster capacity providers using the clusterName attribute. For example:

$ pulumi import aws:ecs/clusterCapacityProviders:ClusterCapacityProviders example my-cluster

Constructors

ClusterCapacityProviders(String name, {ClusterCapacityProvidersArgs? args, CustomResourceOptions? options})
Creates a new ClusterCapacityProviders. name The Pulumi resource name. args Arguments used to configure this ClusterCapacityProviders. The set of arguments for ClusterCapacityProviders. options Resource options controlling this resource's behavior.
ClusterCapacityProviders.reference(String urn)
Creates a typed reference to an existing ClusterCapacityProviders resource.

Properties

capacityProviders ↔ Output<List<String>?>
Set of names of one or more capacity providers to associate with the cluster. Valid values also include FARGATE and FARGATE_SPOT.
latefinal
childResources → Set<Resource>
finalinherited
clusterName ↔ Output<String>
Name of the ECS cluster to manage capacity providers for.
latefinal
completionSources ↔ Map<String, IOutputCompletionSource>
latefinalinherited
defaultCapacityProviderStrategies ↔ Output<List<ClusterCapacityProvidersDefaultCapacityProviderStrategy>?>
Set of capacity provider strategies to use by default for the cluster. Detailed below.
latefinal
hashCode → int
The hash code for this object.
no setterinherited
id ↔ Output<String>
getter/setter pairinherited
isCustom → bool
Returns whether this resource is provider-managed.
no setterinherited
isProtected → bool
Returns whether this resource is protected from deletion.
no setterinherited
isRemote → bool
Whether this resource is registered as remote.
no setterinherited
isResourceReference → bool
Whether this instance represents a resource value returned over RPC.
finalinherited
region ↔ Output<String>
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
resourceTransforms → List<ResourceTransform>
Inherited/explicit async transforms.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
transformations → List<ResourceTransformation>
Inherited/explicit legacy transformations.
no setterinherited
urn ↔ Output<String>
latefinalinherited

Methods

failId(Object error) → void
Completes this resource ID with an error when registration fails.
inherited
failOutputs(Object error) → void
Completes all output properties with error.
inherited
failUrn(Object error) → void
Completes this resource URN with an error when registration fails.
inherited
getProvider(String moduleMember) → ProviderResource?
Returns provider for moduleMember's package, if configured.
inherited
getResourceName() → String
Returns this resource's logical name.
inherited
getResourceType() → String
Returns this resource's Pulumi type token.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>
Registers a dynamic output property for this resource.
inherited
resolveId(String? value, {required bool isKnown}) → void
Resolves the provider-assigned ID for this resource.
inherited
resolveOutputs(Struct outputs) → void
Resolves all output properties from a monitor response payload.
inherited
resolveUrn(String value) → void
Resolves this resource's URN once assigned by the engine.
inherited
serializeProperties(Map<String, dynamic> properties) → Future<Struct>
Serializes resource properties for RPC transmission.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Methods

get(String name, Input<String> id, {ClusterCapacityProvidersState? state, CustomResourceOptions? options}) → ClusterCapacityProviders
Gets an existing ClusterCapacityProviders resource's state with the given name and id.