CapacityProvider class
Provides an ECS cluster capacity provider. More information can be found on the ECS Developer Guide.
> NOTE: Associating an ECS Capacity Provider to an Auto Scaling Group will automatically add the AmazonECSManaged tag to the Auto Scaling Group. This tag should be included in the aws.autoscaling.Group resource configuration to prevent the provider from removing it in subsequent executions as well as ensuring the AmazonECSManaged tag is propagated to all EC2 Instances in the Auto Scaling Group if minSize is above 0 on creation. Any EC2 Instances in the Auto Scaling Group without this tag must be manually be updated, otherwise they may cause unexpected scaling behavior and metrics.
> NOTE: You must specify exactly one of autoScalingGroupProvider or managedInstancesProvider. When using managedInstancesProvider, the cluster parameter is required. When using autoScalingGroupProvider, the cluster parameter must not be set.
> NOTE: AWS cannot delete a capacity provider that is still associated with a cluster through aws.ecs.ClusterCapacityProviders. When a change forces replacement, add a replaceTriggeredBy lifecycle rule to the aws.ecs.ClusterCapacityProviders resource so the association is recreated before the old capacity provider is deleted.
Example Usage
Auto Scaling Group Provider
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.autoscaling.Group("example", {tags: [{
key: "AmazonECSManaged",
value: "true",
propagateAtLaunch: true,
}]});
const exampleCapacityProvider = new aws.ecs.CapacityProvider("example", {
autoScalingGroupProvider: {
managedScaling: {
maximumScalingStepSize: 1000,
minimumScalingStepSize: 1,
status: "ENABLED",
targetCapacity: 10,
},
autoScalingGroupArn: example.arn,
managedTerminationProtection: "ENABLED",
},
name: "example",
});
import pulumi
import pulumi_aws as aws
example = aws.autoscaling.Group("example", tags=[{
"key": "AmazonECSManaged",
"value": "true",
"propagate_at_launch": True,
}])
example_capacity_provider = aws.ecs.CapacityProvider("example",
auto_scaling_group_provider={
"managed_scaling": {
"maximum_scaling_step_size": 1000,
"minimum_scaling_step_size": 1,
"status": "ENABLED",
"target_capacity": 10,
},
"auto_scaling_group_arn": example.arn,
"managed_termination_protection": "ENABLED",
},
name="example")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = new Aws.AutoScaling.Group("example", new()
{
Tags = new[]
{
new Aws.AutoScaling.Inputs.GroupTagArgs
{
Key = "AmazonECSManaged",
Value = "true",
PropagateAtLaunch = true,
},
},
});
var exampleCapacityProvider = new Aws.Ecs.CapacityProvider("example", new()
{
AutoScalingGroupProvider = new Aws.Ecs.Inputs.CapacityProviderAutoScalingGroupProviderArgs
{
ManagedScaling = new Aws.Ecs.Inputs.CapacityProviderAutoScalingGroupProviderManagedScalingArgs
{
MaximumScalingStepSize = 1000,
MinimumScalingStepSize = 1,
Status = "ENABLED",
TargetCapacity = 10,
},
AutoScalingGroupArn = example.Arn,
ManagedTerminationProtection = "ENABLED",
},
Name = "example",
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/autoscaling"
"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 := autoscaling.NewGroup(ctx, "example", &autoscaling.GroupArgs{
Tags: autoscaling.GroupTagArray{
&autoscaling.GroupTagArgs{
Key: pulumi.String("AmazonECSManaged"),
Value: pulumi.String("true"),
PropagateAtLaunch: pulumi.Bool(true),
},
},
})
if err != nil {
return err
}
_, err = ecs.NewCapacityProvider(ctx, "example", &ecs.CapacityProviderArgs{
AutoScalingGroupProvider: &ecs.CapacityProviderAutoScalingGroupProviderArgs{
ManagedScaling: &ecs.CapacityProviderAutoScalingGroupProviderManagedScalingArgs{
MaximumScalingStepSize: pulumi.Int(1000),
MinimumScalingStepSize: pulumi.Int(1),
Status: pulumi.String("ENABLED"),
TargetCapacity: pulumi.Int(10),
},
AutoScalingGroupArn: example.Arn,
ManagedTerminationProtection: pulumi.String("ENABLED"),
},
Name: pulumi.String("example"),
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_autoscaling_group" "example" {
tags {
key = "AmazonECSManaged"
value = true
propagate_at_launch = true
}
}
resource "aws_ecs_capacityprovider" "example" {
auto_scaling_group_provider = {
managed_scaling = {
maximum_scaling_step_size = 1000
minimum_scaling_step_size = 1
status = "ENABLED"
target_capacity = 10
}
auto_scaling_group_arn = aws_autoscaling_group.example.arn
managed_termination_protection = "ENABLED"
}
name = "example"
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.autoscaling.Group;
import com.pulumi.aws.autoscaling.GroupArgs;
import com.pulumi.aws.autoscaling.inputs.GroupTagArgs;
import com.pulumi.aws.ecs.CapacityProvider;
import com.pulumi.aws.ecs.CapacityProviderArgs;
import com.pulumi.aws.ecs.inputs.CapacityProviderAutoScalingGroupProviderArgs;
import com.pulumi.aws.ecs.inputs.CapacityProviderAutoScalingGroupProviderManagedScalingArgs;
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 Group("example", GroupArgs.builder()
.tags(GroupTagArgs.builder()
.key("AmazonECSManaged")
.value("true")
.propagateAtLaunch(true)
.build())
.build());
var exampleCapacityProvider = new CapacityProvider("exampleCapacityProvider", CapacityProviderArgs.builder()
.autoScalingGroupProvider(CapacityProviderAutoScalingGroupProviderArgs.builder()
.managedScaling(CapacityProviderAutoScalingGroupProviderManagedScalingArgs.builder()
.maximumScalingStepSize(1000)
.minimumScalingStepSize(1)
.status("ENABLED")
.targetCapacity(10)
.build())
.autoScalingGroupArn(example.arn())
.managedTerminationProtection("ENABLED")
.build())
.name("example")
.build());
}
}
resources:
example:
type: aws:autoscaling:Group
properties:
tags:
- key: AmazonECSManaged
value: true
propagateAtLaunch: true
exampleCapacityProvider:
type: aws:ecs:CapacityProvider
name: example
properties:
autoScalingGroupProvider:
managedScaling:
maximumScalingStepSize: 1000
minimumScalingStepSize: 1
status: ENABLED
targetCapacity: 10
autoScalingGroupArn: ${example.arn}
managedTerminationProtection: ENABLED
name: example
Managed Instances Provider
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.ecs.CapacityProvider("example", {
managedInstancesProvider: {
instanceLaunchTemplate: {
networkConfiguration: {
subnets: [exampleAwsSubnet.id],
securityGroups: [exampleAwsSecurityGroup.id],
},
storageConfiguration: {
storageSizeGib: 30,
},
instanceRequirements: {
memoryMib: {
min: 1024,
max: 8192,
},
vcpuCount: {
min: 1,
max: 4,
},
instanceGenerations: ["current"],
cpuManufacturers: [
"intel",
"amd",
],
},
ec2InstanceProfileArn: ecsInstance.arn,
monitoring: "DETAILED",
},
infrastructureRoleArn: ecsInfrastructure.arn,
propagateTags: "CAPACITY_PROVIDER",
},
name: "example",
cluster: "my-cluster",
});
import pulumi
import pulumi_aws as aws
example = aws.ecs.CapacityProvider("example",
managed_instances_provider={
"instance_launch_template": {
"network_configuration": {
"subnets": [example_aws_subnet["id"]],
"security_groups": [example_aws_security_group["id"]],
},
"storage_configuration": {
"storage_size_gib": 30,
},
"instance_requirements": {
"memory_mib": {
"min": 1024,
"max": 8192,
},
"vcpu_count": {
"min": 1,
"max": 4,
},
"instance_generations": ["current"],
"cpu_manufacturers": [
"intel",
"amd",
],
},
"ec2_instance_profile_arn": ecs_instance["arn"],
"monitoring": "DETAILED",
},
"infrastructure_role_arn": ecs_infrastructure["arn"],
"propagate_tags": "CAPACITY_PROVIDER",
},
name="example",
cluster="my-cluster")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = new Aws.Ecs.CapacityProvider("example", new()
{
ManagedInstancesProvider = new Aws.Ecs.Inputs.CapacityProviderManagedInstancesProviderArgs
{
InstanceLaunchTemplate = new Aws.Ecs.Inputs.CapacityProviderManagedInstancesProviderInstanceLaunchTemplateArgs
{
NetworkConfiguration = new Aws.Ecs.Inputs.CapacityProviderManagedInstancesProviderInstanceLaunchTemplateNetworkConfigurationArgs
{
Subnets = new[]
{
exampleAwsSubnet.Id,
},
SecurityGroups = new[]
{
exampleAwsSecurityGroup.Id,
},
},
StorageConfiguration = new Aws.Ecs.Inputs.CapacityProviderManagedInstancesProviderInstanceLaunchTemplateStorageConfigurationArgs
{
StorageSizeGib = 30,
},
InstanceRequirements = new Aws.Ecs.Inputs.CapacityProviderManagedInstancesProviderInstanceLaunchTemplateInstanceRequirementsArgs
{
MemoryMib = new Aws.Ecs.Inputs.CapacityProviderManagedInstancesProviderInstanceLaunchTemplateInstanceRequirementsMemoryMibArgs
{
Min = 1024,
Max = 8192,
},
VcpuCount = new Aws.Ecs.Inputs.CapacityProviderManagedInstancesProviderInstanceLaunchTemplateInstanceRequirementsVcpuCountArgs
{
Min = 1,
Max = 4,
},
InstanceGenerations = new[]
{
"current",
},
CpuManufacturers = new[]
{
"intel",
"amd",
},
},
Ec2InstanceProfileArn = ecsInstance.Arn,
Monitoring = "DETAILED",
},
InfrastructureRoleArn = ecsInfrastructure.Arn,
PropagateTags = "CAPACITY_PROVIDER",
},
Name = "example",
Cluster = "my-cluster",
});
});
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 {
_, err := ecs.NewCapacityProvider(ctx, "example", &ecs.CapacityProviderArgs{
ManagedInstancesProvider: &ecs.CapacityProviderManagedInstancesProviderArgs{
InstanceLaunchTemplate: &ecs.CapacityProviderManagedInstancesProviderInstanceLaunchTemplateArgs{
NetworkConfiguration: &ecs.CapacityProviderManagedInstancesProviderInstanceLaunchTemplateNetworkConfigurationArgs{
Subnets: pulumi.StringArray{
exampleAwsSubnet.Id,
},
SecurityGroups: pulumi.StringArray{
exampleAwsSecurityGroup.Id,
},
},
StorageConfiguration: &ecs.CapacityProviderManagedInstancesProviderInstanceLaunchTemplateStorageConfigurationArgs{
StorageSizeGib: pulumi.Int(30),
},
InstanceRequirements: &ecs.CapacityProviderManagedInstancesProviderInstanceLaunchTemplateInstanceRequirementsArgs{
MemoryMib: &ecs.CapacityProviderManagedInstancesProviderInstanceLaunchTemplateInstanceRequirementsMemoryMibArgs{
Min: pulumi.Int(1024),
Max: pulumi.Int(8192),
},
VcpuCount: &ecs.CapacityProviderManagedInstancesProviderInstanceLaunchTemplateInstanceRequirementsVcpuCountArgs{
Min: pulumi.Int(1),
Max: pulumi.Int(4),
},
InstanceGenerations: pulumi.StringArray{
pulumi.String("current"),
},
CpuManufacturers: pulumi.StringArray{
pulumi.String("intel"),
pulumi.String("amd"),
},
},
Ec2InstanceProfileArn: pulumi.Any(ecsInstance.Arn),
Monitoring: pulumi.String("DETAILED"),
},
InfrastructureRoleArn: pulumi.Any(ecsInfrastructure.Arn),
PropagateTags: pulumi.String("CAPACITY_PROVIDER"),
},
Name: pulumi.String("example"),
Cluster: pulumi.String("my-cluster"),
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_ecs_capacityprovider" "example" {
managed_instances_provider = {
instance_launch_template = {
network_configuration = {
subnets = [exampleAwsSubnet.id]
security_groups = [exampleAwsSecurityGroup.id]
}
storage_configuration = {
storage_size_gib = 30
}
instance_requirements = {
memory_mib = {
min = 1024
max = 8192
}
vcpu_count = {
min = 1
max = 4
}
instance_generations = ["current"]
cpu_manufacturers = ["intel", "amd"]
}
ec2_instance_profile_arn = ecsInstance.arn
monitoring = "DETAILED"
}
infrastructure_role_arn = ecsInfrastructure.arn
propagate_tags = "CAPACITY_PROVIDER"
}
name = "example"
cluster = "my-cluster"
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.ecs.CapacityProvider;
import com.pulumi.aws.ecs.CapacityProviderArgs;
import com.pulumi.aws.ecs.inputs.CapacityProviderManagedInstancesProviderArgs;
import com.pulumi.aws.ecs.inputs.CapacityProviderManagedInstancesProviderInstanceLaunchTemplateArgs;
import com.pulumi.aws.ecs.inputs.CapacityProviderManagedInstancesProviderInstanceLaunchTemplateNetworkConfigurationArgs;
import com.pulumi.aws.ecs.inputs.CapacityProviderManagedInstancesProviderInstanceLaunchTemplateStorageConfigurationArgs;
import com.pulumi.aws.ecs.inputs.CapacityProviderManagedInstancesProviderInstanceLaunchTemplateInstanceRequirementsArgs;
import com.pulumi.aws.ecs.inputs.CapacityProviderManagedInstancesProviderInstanceLaunchTemplateInstanceRequirementsMemoryMibArgs;
import com.pulumi.aws.ecs.inputs.CapacityProviderManagedInstancesProviderInstanceLaunchTemplateInstanceRequirementsVcpuCountArgs;
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 CapacityProvider("example", CapacityProviderArgs.builder()
.managedInstancesProvider(CapacityProviderManagedInstancesProviderArgs.builder()
.instanceLaunchTemplate(CapacityProviderManagedInstancesProviderInstanceLaunchTemplateArgs.builder()
.networkConfiguration(CapacityProviderManagedInstancesProviderInstanceLaunchTemplateNetworkConfigurationArgs.builder()
.subnets(exampleAwsSubnet.id())
.securityGroups(exampleAwsSecurityGroup.id())
.build())
.storageConfiguration(CapacityProviderManagedInstancesProviderInstanceLaunchTemplateStorageConfigurationArgs.builder()
.storageSizeGib(30)
.build())
.instanceRequirements(CapacityProviderManagedInstancesProviderInstanceLaunchTemplateInstanceRequirementsArgs.builder()
.memoryMib(CapacityProviderManagedInstancesProviderInstanceLaunchTemplateInstanceRequirementsMemoryMibArgs.builder()
.min(1024)
.max(8192)
.build())
.vcpuCount(CapacityProviderManagedInstancesProviderInstanceLaunchTemplateInstanceRequirementsVcpuCountArgs.builder()
.min(1)
.max(4)
.build())
.instanceGenerations("current")
.cpuManufacturers(
"intel",
"amd")
.build())
.ec2InstanceProfileArn(ecsInstance.arn())
.monitoring("DETAILED")
.build())
.infrastructureRoleArn(ecsInfrastructure.arn())
.propagateTags("CAPACITY_PROVIDER")
.build())
.name("example")
.cluster("my-cluster")
.build());
}
}
resources:
example:
type: aws:ecs:CapacityProvider
properties:
managedInstancesProvider:
instanceLaunchTemplate:
networkConfiguration:
subnets:
- ${exampleAwsSubnet.id}
securityGroups:
- ${exampleAwsSecurityGroup.id}
storageConfiguration:
storageSizeGib: 30
instanceRequirements:
memoryMib:
min: 1024
max: 8192
vcpuCount:
min: 1
max: 4
instanceGenerations:
- current
cpuManufacturers:
- intel
- amd
ec2InstanceProfileArn: ${ecsInstance.arn}
monitoring: DETAILED
infrastructureRoleArn: ${ecsInfrastructure.arn}
propagateTags: CAPACITY_PROVIDER
name: example
cluster: my-cluster
Import
Identity Schema
Required
arn(String) ARN of the ECS capacity provider.
Using pulumi import, import ECS Capacity Providers using the arn. For example:
$ pulumi import aws:ecs/capacityProvider:CapacityProvider example arn:aws:ecs:us-west-2:123456789012:capacity-provider/example
Constructors
- CapacityProvider(String name, {CapacityProviderArgs? args, CustomResourceOptions? options})
-
Creates a new CapacityProvider.
nameThe Pulumi resource name.argsArguments used to configure this CapacityProvider. The set of arguments for CapacityProvider.optionsResource options controlling this resource's behavior. - CapacityProvider.reference(String urn)
- Creates a typed reference to an existing CapacityProvider resource.
Properties
-
arn
↔ Output<
String> -
ARN that identifies the capacity provider.
latefinal
-
autoScalingGroupProvider
↔ Output<
CapacityProviderAutoScalingGroupProvider?> -
Configuration block for the provider for the ECS auto scaling group. Detailed below. Exactly one of
autoScalingGroupProviderormanagedInstancesProvidermust be specified.latefinal -
childResources
→ Set<
Resource> -
finalinherited
-
cluster
↔ Output<
String?> -
Name of the ECS cluster. Required when using
managedInstancesProvider. Must not be set when usingautoScalingGroupProvider.latefinal -
completionSources
↔ Map<
String, IOutputCompletionSource> -
latefinalinherited
- 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
-
managedInstancesProvider
↔ Output<
CapacityProviderManagedInstancesProvider?> -
Configuration block for the managed instances provider. Detailed below. Exactly one of
autoScalingGroupProviderormanagedInstancesProvidermust be specified.latefinal -
name
↔ Output<
String> -
Name of the capacity provider.
latefinal
-
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
-
Key-value map of resource tags. If configured with a provider
defaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.latefinal -
Map of tags assigned to the resource, including those inherited from the provider
defaultTagsconfiguration block.latefinal -
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, {CapacityProviderState? state, CustomResourceOptions? options}) → CapacityProvider -
Gets an existing CapacityProvider resource's state with the given
nameandid.