Class CapacityProvider


  • public class CapacityProvider
    extends com.pulumi.resources.CustomResource
    Provides an ECS cluster capacity provider. More information can be found on the [ECS Developer Guide](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cluster-capacity-providers.html). > **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 Terraform 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
     
     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());
     
         }
     }
     
     
    ### Managed Instances Provider
     
     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());
     
         }
     }
     
     
    ## Import ### Identity Schema #### Required - `arn` (String) ARN of the ECS capacity provider. Using `pulumi import`, import ECS Capacity Providers using the `arn`. For example: ```sh $ pulumi import aws:ecs/capacityProvider:CapacityProvider example arn:aws:ecs:us-west-2:123456789012:capacity-provider/example ```
    • Nested Class Summary

      • Nested classes/interfaces inherited from class com.pulumi.resources.CustomResource

        com.pulumi.resources.CustomResource.CustomResourceInternal
      • Nested classes/interfaces inherited from class com.pulumi.resources.Resource

        com.pulumi.resources.Resource.LazyField<T extends java.lang.Object>, com.pulumi.resources.Resource.LazyFields, com.pulumi.resources.Resource.ResourceInternal
    • Field Summary

      • Fields inherited from class com.pulumi.resources.Resource

        childResources, remote
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      com.pulumi.core.Output<java.lang.String> arn()  
      com.pulumi.core.Output<java.util.Optional<CapacityProviderAutoScalingGroupProvider>> autoScalingGroupProvider()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> cluster()  
      static CapacityProvider get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, CapacityProviderState state, com.pulumi.resources.CustomResourceOptions options)
      Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
      com.pulumi.core.Output<java.util.Optional<CapacityProviderManagedInstancesProvider>> managedInstancesProvider()  
      com.pulumi.core.Output<java.lang.String> name()  
      com.pulumi.core.Output<java.lang.String> region()  
      com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> tags()  
      com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> tagsAll()  
      • Methods inherited from class com.pulumi.resources.CustomResource

        getId, id, idFuture
      • Methods inherited from class com.pulumi.resources.Resource

        getChildResources, getResourceName, getResourceType, getUrn, pulumiChildResources, pulumiResourceName, pulumiResourceType, urn
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • CapacityProvider

        public CapacityProvider​(java.lang.String name)
        Parameters:
        name - The _unique_ name of the resulting resource.
      • CapacityProvider

        public CapacityProvider​(java.lang.String name,
                                @Nullable
                                CapacityProviderArgs args)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.
      • CapacityProvider

        public CapacityProvider​(java.lang.String name,
                                @Nullable
                                CapacityProviderArgs args,
                                @Nullable
                                com.pulumi.resources.CustomResourceOptions options)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.
        options - A bag of options that control this resource's behavior.
    • Method Detail

      • arn

        public com.pulumi.core.Output<java.lang.String> arn()
        Returns:
        ARN that identifies the capacity provider.
      • autoScalingGroupProvider

        public com.pulumi.core.Output<java.util.Optional<CapacityProviderAutoScalingGroupProvider>> autoScalingGroupProvider()
        Returns:
        Configuration block for the provider for the ECS Auto Scaling group. Detailed below. Exactly one of `autoScalingGroupProvider` or `managedInstancesProvider` must be specified.
      • cluster

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> cluster()
        Returns:
        Name of the ECS cluster. Required when using `managedInstancesProvider`. Must not be set when using `autoScalingGroupProvider`.
      • managedInstancesProvider

        public com.pulumi.core.Output<java.util.Optional<CapacityProviderManagedInstancesProvider>> managedInstancesProvider()
        Returns:
        Configuration block for the managed instances provider. Detailed below. Exactly one of `autoScalingGroupProvider` or `managedInstancesProvider` must be specified.
      • name

        public com.pulumi.core.Output<java.lang.String> name()
        Returns:
        Name of the capacity provider.
      • region

        public com.pulumi.core.Output<java.lang.String> region()
        Returns:
        Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
      • tags

        public com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> tags()
        Returns:
        Key-value map of resource tags. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
      • tagsAll

        public com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> tagsAll()
        Returns:
        Map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.
      • get

        public static CapacityProvider get​(java.lang.String name,
                                           com.pulumi.core.Output<java.lang.String> id,
                                           @Nullable
                                           CapacityProviderState state,
                                           @Nullable
                                           com.pulumi.resources.CustomResourceOptions options)
        Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
        Parameters:
        name - The _unique_ name of the resulting resource.
        id - The _unique_ provider ID of the resource to lookup.
        state -
        options - Optional settings to control the behavior of the CustomResource.