1. Packages
  2. Packages
  3. AWS
  4. API Docs
  5. outposts
  6. CapacityTask
Viewing docs for AWS v7.32.0
published on Friday, May 29, 2026 by Pulumi
aws logo
Viewing docs for AWS v7.32.0
published on Friday, May 29, 2026 by Pulumi

    Resource for managing an AWS Outposts Capacity Task.

    A capacity task redistributes the instance pools available on an Outpost rack or server to match the instancePool configuration declared in the resource. Starting a capacity task is a long-running, asynchronous operation — Terraform waits for it to reach a terminal state (COMPLETED, CANCELLED, or FAILED) before finishing the apply.

    Example Usage

    Minimal

    import * as pulumi from "@pulumi/pulumi";
    import * as aws from "@pulumi/aws";
    
    const example = aws.outposts.getOutposts({});
    const exampleCapacityTask = new aws.outposts.CapacityTask("example", {
        outpostIdentifier: example.then(example => example.arns?.[0]),
        instancePools: [{
            instanceType: "m5.large",
            count: 2,
        }],
    });
    
    import pulumi
    import pulumi_aws as aws
    
    example = aws.outposts.get_outposts()
    example_capacity_task = aws.outposts.CapacityTask("example",
        outpost_identifier=example.arns[0],
        instance_pools=[{
            "instance_type": "m5.large",
            "count": 2,
        }])
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/outposts"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		example, err := outposts.GetOutposts(ctx, &outposts.GetOutpostsArgs{}, nil)
    		if err != nil {
    			return err
    		}
    		_, err = outposts.NewCapacityTask(ctx, "example", &outposts.CapacityTaskArgs{
    			OutpostIdentifier: pulumi.String(pulumi.String(example.Arns[0])),
    			InstancePools: outposts.CapacityTaskInstancePoolArray{
    				&outposts.CapacityTaskInstancePoolArgs{
    					InstanceType: pulumi.String("m5.large"),
    					Count:        pulumi.Int(2),
    				},
    			},
    		})
    		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 = Aws.Outposts.GetOutposts.Invoke();
    
        var exampleCapacityTask = new Aws.Outposts.CapacityTask("example", new()
        {
            OutpostIdentifier = example.Apply(getOutpostsResult => getOutpostsResult.Arns[0]),
            InstancePools = new[]
            {
                new Aws.Outposts.Inputs.CapacityTaskInstancePoolArgs
                {
                    InstanceType = "m5.large",
                    Count = 2,
                },
            },
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.aws.outposts.OutpostsFunctions;
    import com.pulumi.aws.outposts.inputs.GetOutpostsArgs;
    import com.pulumi.aws.outposts.CapacityTask;
    import com.pulumi.aws.outposts.CapacityTaskArgs;
    import com.pulumi.aws.outposts.inputs.CapacityTaskInstancePoolArgs;
    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) {
            final var example = OutpostsFunctions.getOutposts(GetOutpostsArgs.builder()
                .build());
    
            var exampleCapacityTask = new CapacityTask("exampleCapacityTask", CapacityTaskArgs.builder()
                .outpostIdentifier(example.arns()[0])
                .instancePools(CapacityTaskInstancePoolArgs.builder()
                    .instanceType("m5.large")
                    .count(2)
                    .build())
                .build());
    
        }
    }
    
    resources:
      exampleCapacityTask:
        type: aws:outposts:CapacityTask
        name: example
        properties:
          outpostIdentifier: ${example.arns[0]}
          instancePools:
            - instanceType: m5.large
              count: 2
    variables:
      example:
        fn::invoke:
          function: aws:outposts:getOutposts
          arguments: {}
    
    pulumi {
      required_providers {
        aws = {
          source = "pulumi/aws"
        }
      }
    }
    
    data "aws_outposts_getoutposts" "example" {
    }
    
    resource "aws_outposts_capacitytask" "example" {
      outpost_identifier = data.aws_outposts_getoutposts.example.arns[0]
      instance_pools {
        instance_type = "m5.large"
        count         = 2
      }
    }
    

    Multiple instance pools, excluded instances, and a specified blocking-instance action

    import * as pulumi from "@pulumi/pulumi";
    import * as aws from "@pulumi/aws";
    
    const example = aws.outposts.getAssets({
        arn: "arn:aws:outposts:us-west-2:123456789012:outpost/op-1234567890abcdef",
    });
    const exampleCapacityTask = new aws.outposts.CapacityTask("example", {
        outpostIdentifier: "op-1234567890abcdef",
        taskActionOnBlockingInstances: "WAIT_FOR_EVACUATION",
        assetId: example.then(example => example.assetIds?.[0]),
        instancePools: [
            {
                instanceType: "m5.large",
                count: 4,
            },
            {
                instanceType: "c5.xlarge",
                count: 2,
            },
        ],
        instancesToExclude: {
            instances: [
                "i-0123456789abcdef0",
                "i-0fedcba9876543210",
            ],
        },
    });
    
    import pulumi
    import pulumi_aws as aws
    
    example = aws.outposts.get_assets(arn="arn:aws:outposts:us-west-2:123456789012:outpost/op-1234567890abcdef")
    example_capacity_task = aws.outposts.CapacityTask("example",
        outpost_identifier="op-1234567890abcdef",
        task_action_on_blocking_instances="WAIT_FOR_EVACUATION",
        asset_id=example.asset_ids[0],
        instance_pools=[
            {
                "instance_type": "m5.large",
                "count": 4,
            },
            {
                "instance_type": "c5.xlarge",
                "count": 2,
            },
        ],
        instances_to_exclude={
            "instances": [
                "i-0123456789abcdef0",
                "i-0fedcba9876543210",
            ],
        })
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/outposts"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		example, err := outposts.GetAssets(ctx, &outposts.GetAssetsArgs{
    			Arn: "arn:aws:outposts:us-west-2:123456789012:outpost/op-1234567890abcdef",
    		}, nil)
    		if err != nil {
    			return err
    		}
    		_, err = outposts.NewCapacityTask(ctx, "example", &outposts.CapacityTaskArgs{
    			OutpostIdentifier:             pulumi.String("op-1234567890abcdef"),
    			TaskActionOnBlockingInstances: pulumi.String("WAIT_FOR_EVACUATION"),
    			AssetId:                       pulumi.String(pulumi.String(example.AssetIds[0])),
    			InstancePools: outposts.CapacityTaskInstancePoolArray{
    				&outposts.CapacityTaskInstancePoolArgs{
    					InstanceType: pulumi.String("m5.large"),
    					Count:        pulumi.Int(4),
    				},
    				&outposts.CapacityTaskInstancePoolArgs{
    					InstanceType: pulumi.String("c5.xlarge"),
    					Count:        pulumi.Int(2),
    				},
    			},
    			InstancesToExclude: &outposts.CapacityTaskInstancesToExcludeArgs{
    				Instances: pulumi.StringArray{
    					pulumi.String("i-0123456789abcdef0"),
    					pulumi.String("i-0fedcba9876543210"),
    				},
    			},
    		})
    		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 = Aws.Outposts.GetAssets.Invoke(new()
        {
            Arn = "arn:aws:outposts:us-west-2:123456789012:outpost/op-1234567890abcdef",
        });
    
        var exampleCapacityTask = new Aws.Outposts.CapacityTask("example", new()
        {
            OutpostIdentifier = "op-1234567890abcdef",
            TaskActionOnBlockingInstances = "WAIT_FOR_EVACUATION",
            AssetId = example.Apply(getAssetsResult => getAssetsResult.AssetIds[0]),
            InstancePools = new[]
            {
                new Aws.Outposts.Inputs.CapacityTaskInstancePoolArgs
                {
                    InstanceType = "m5.large",
                    Count = 4,
                },
                new Aws.Outposts.Inputs.CapacityTaskInstancePoolArgs
                {
                    InstanceType = "c5.xlarge",
                    Count = 2,
                },
            },
            InstancesToExclude = new Aws.Outposts.Inputs.CapacityTaskInstancesToExcludeArgs
            {
                Instances = new[]
                {
                    "i-0123456789abcdef0",
                    "i-0fedcba9876543210",
                },
            },
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.aws.outposts.OutpostsFunctions;
    import com.pulumi.aws.outposts.inputs.GetAssetsArgs;
    import com.pulumi.aws.outposts.CapacityTask;
    import com.pulumi.aws.outposts.CapacityTaskArgs;
    import com.pulumi.aws.outposts.inputs.CapacityTaskInstancePoolArgs;
    import com.pulumi.aws.outposts.inputs.CapacityTaskInstancesToExcludeArgs;
    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) {
            final var example = OutpostsFunctions.getAssets(GetAssetsArgs.builder()
                .arn("arn:aws:outposts:us-west-2:123456789012:outpost/op-1234567890abcdef")
                .build());
    
            var exampleCapacityTask = new CapacityTask("exampleCapacityTask", CapacityTaskArgs.builder()
                .outpostIdentifier("op-1234567890abcdef")
                .taskActionOnBlockingInstances("WAIT_FOR_EVACUATION")
                .assetId(example.assetIds()[0])
                .instancePools(            
                    CapacityTaskInstancePoolArgs.builder()
                        .instanceType("m5.large")
                        .count(4)
                        .build(),
                    CapacityTaskInstancePoolArgs.builder()
                        .instanceType("c5.xlarge")
                        .count(2)
                        .build())
                .instancesToExclude(CapacityTaskInstancesToExcludeArgs.builder()
                    .instances(                
                        "i-0123456789abcdef0",
                        "i-0fedcba9876543210")
                    .build())
                .build());
    
        }
    }
    
    resources:
      exampleCapacityTask:
        type: aws:outposts:CapacityTask
        name: example
        properties:
          outpostIdentifier: op-1234567890abcdef
          taskActionOnBlockingInstances: WAIT_FOR_EVACUATION
          assetId: ${example.assetIds[0]}
          instancePools:
            - instanceType: m5.large
              count: 4
            - instanceType: c5.xlarge
              count: 2
          instancesToExclude:
            instances:
              - i-0123456789abcdef0
              - i-0fedcba9876543210
    variables:
      example:
        fn::invoke:
          function: aws:outposts:getAssets
          arguments:
            arn: arn:aws:outposts:us-west-2:123456789012:outpost/op-1234567890abcdef
    
    pulumi {
      required_providers {
        aws = {
          source = "pulumi/aws"
        }
      }
    }
    
    data "aws_outposts_getassets" "example" {
      arn = "arn:aws:outposts:us-west-2:123456789012:outpost/op-1234567890abcdef"
    }
    
    resource "aws_outposts_capacitytask" "example" {
      outpost_identifier                = "op-1234567890abcdef"
      task_action_on_blocking_instances = "WAIT_FOR_EVACUATION"
      asset_id                          = data.aws_outposts_getassets.example.asset_ids[0]
      instance_pools {
        instance_type = "m5.large"
        count         = 4
      }
      instance_pools {
        instance_type = "c5.xlarge"
        count         = 2
      }
      instances_to_exclude = {
        instances = ["i-0123456789abcdef0", "i-0fedcba9876543210"]
      }
    }
    

    Lifecycle

    Because every argument of this resource is marked as forces-new, any change to the configuration results in destroying and re-creating the capacity task. Tasks that are already in a terminal state (COMPLETED or CANCELLED) are left in place on destroy and only removed from Terraform state; tasks still in flight are cancelled and Terraform waits for them to reach CANCELLED. If a task reaches the terminal state FAILED during delete, the provider tolerates the “already in a terminal state” error returned by CancelCapacityTask and considers the resource successfully destroyed.

    If a create operation produces a FAILED task, the resource is not written to Terraform state (the failureReason is surfaced in the diagnostic instead), so no follow-up destroy is required.

    Create CapacityTask Resource

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

    Constructor syntax

    new CapacityTask(name: string, args: CapacityTaskArgs, opts?: CustomResourceOptions);
    @overload
    def CapacityTask(resource_name: str,
                     args: CapacityTaskArgs,
                     opts: Optional[ResourceOptions] = None)
    
    @overload
    def CapacityTask(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     outpost_identifier: Optional[str] = None,
                     asset_id: Optional[str] = None,
                     instance_pools: Optional[Sequence[CapacityTaskInstancePoolArgs]] = None,
                     instances_to_exclude: Optional[CapacityTaskInstancesToExcludeArgs] = None,
                     order_id: Optional[str] = None,
                     region: Optional[str] = None,
                     task_action_on_blocking_instances: Optional[str] = None,
                     timeouts: Optional[CapacityTaskTimeoutsArgs] = None)
    func NewCapacityTask(ctx *Context, name string, args CapacityTaskArgs, opts ...ResourceOption) (*CapacityTask, error)
    public CapacityTask(string name, CapacityTaskArgs args, CustomResourceOptions? opts = null)
    public CapacityTask(String name, CapacityTaskArgs args)
    public CapacityTask(String name, CapacityTaskArgs args, CustomResourceOptions options)
    
    type: aws:outposts:CapacityTask
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    resource "aws_outposts_capacitytask" "name" {
        # resource properties
    }

    Parameters

    name string
    The unique name of the resource.
    args CapacityTaskArgs
    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 CapacityTaskArgs
    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 CapacityTaskArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args CapacityTaskArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args CapacityTaskArgs
    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 capacityTaskResource = new Aws.Outposts.CapacityTask("capacityTaskResource", new()
    {
        OutpostIdentifier = "string",
        AssetId = "string",
        InstancePools = new[]
        {
            new Aws.Outposts.Inputs.CapacityTaskInstancePoolArgs
            {
                Count = 0,
                InstanceType = "string",
            },
        },
        InstancesToExclude = new Aws.Outposts.Inputs.CapacityTaskInstancesToExcludeArgs
        {
            Instances = new[]
            {
                "string",
            },
        },
        OrderId = "string",
        Region = "string",
        TaskActionOnBlockingInstances = "string",
        Timeouts = new Aws.Outposts.Inputs.CapacityTaskTimeoutsArgs
        {
            Create = "string",
            Delete = "string",
        },
    });
    
    example, err := outposts.NewCapacityTask(ctx, "capacityTaskResource", &outposts.CapacityTaskArgs{
    	OutpostIdentifier: pulumi.String("string"),
    	AssetId:           pulumi.String("string"),
    	InstancePools: outposts.CapacityTaskInstancePoolArray{
    		&outposts.CapacityTaskInstancePoolArgs{
    			Count:        pulumi.Int(0),
    			InstanceType: pulumi.String("string"),
    		},
    	},
    	InstancesToExclude: &outposts.CapacityTaskInstancesToExcludeArgs{
    		Instances: pulumi.StringArray{
    			pulumi.String("string"),
    		},
    	},
    	OrderId:                       pulumi.String("string"),
    	Region:                        pulumi.String("string"),
    	TaskActionOnBlockingInstances: pulumi.String("string"),
    	Timeouts: &outposts.CapacityTaskTimeoutsArgs{
    		Create: pulumi.String("string"),
    		Delete: pulumi.String("string"),
    	},
    })
    
    resource "aws_outposts_capacitytask" "capacityTaskResource" {
      outpost_identifier = "string"
      asset_id           = "string"
      instance_pools {
        count         = 0
        instance_type = "string"
      }
      instances_to_exclude = {
        instances = ["string"]
      }
      order_id                          = "string"
      region                            = "string"
      task_action_on_blocking_instances = "string"
      timeouts = {
        create = "string"
        delete = "string"
      }
    }
    
    var capacityTaskResource = new CapacityTask("capacityTaskResource", CapacityTaskArgs.builder()
        .outpostIdentifier("string")
        .assetId("string")
        .instancePools(CapacityTaskInstancePoolArgs.builder()
            .count(0)
            .instanceType("string")
            .build())
        .instancesToExclude(CapacityTaskInstancesToExcludeArgs.builder()
            .instances("string")
            .build())
        .orderId("string")
        .region("string")
        .taskActionOnBlockingInstances("string")
        .timeouts(CapacityTaskTimeoutsArgs.builder()
            .create("string")
            .delete("string")
            .build())
        .build());
    
    capacity_task_resource = aws.outposts.CapacityTask("capacityTaskResource",
        outpost_identifier="string",
        asset_id="string",
        instance_pools=[{
            "count": 0,
            "instance_type": "string",
        }],
        instances_to_exclude={
            "instances": ["string"],
        },
        order_id="string",
        region="string",
        task_action_on_blocking_instances="string",
        timeouts={
            "create": "string",
            "delete": "string",
        })
    
    const capacityTaskResource = new aws.outposts.CapacityTask("capacityTaskResource", {
        outpostIdentifier: "string",
        assetId: "string",
        instancePools: [{
            count: 0,
            instanceType: "string",
        }],
        instancesToExclude: {
            instances: ["string"],
        },
        orderId: "string",
        region: "string",
        taskActionOnBlockingInstances: "string",
        timeouts: {
            create: "string",
            "delete": "string",
        },
    });
    
    type: aws:outposts:CapacityTask
    properties:
        assetId: string
        instancePools:
            - count: 0
              instanceType: string
        instancesToExclude:
            instances:
                - string
        orderId: string
        outpostIdentifier: string
        region: string
        taskActionOnBlockingInstances: string
        timeouts:
            create: string
            delete: string
    

    CapacityTask Resource Properties

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

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The CapacityTask resource accepts the following input properties:

    OutpostIdentifier string
    ID or ARN of the Outpost on which to run the capacity task. Both forms are accepted; the provider normalizes the value internally. Changing this value forces a new resource.
    AssetId string
    ID of a specific Outposts asset (hardware server) to target for the capacity task. If omitted, AWS selects an appropriate asset automatically. Discover valid asset IDs with the aws.outposts.getAssets data source. Changing this value forces a new resource.
    InstancePools List<CapacityTaskInstancePool>
    One or more instancePool blocks defining the desired instance-type layout for the Outpost. See below. At least one block is required. Changing any value forces a new resource.
    InstancesToExclude CapacityTaskInstancesToExclude
    Single instancesToExclude block specifying user-owned running instances that must not be stopped to free up capacity. See below. Note: AWS does not return this value via the Get/Describe API; after import, you must add the block back to your configuration manually — see Import.
    OrderId string
    ID of the Amazon Web Services Outposts order associated with the capacity task. Changing this value forces a new resource.
    Region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    TaskActionOnBlockingInstances string
    Action to take if running instances block the capacity task. Valid values are WAIT_FOR_EVACUATION and FAIL_TASK. Changing this value forces a new resource.
    Timeouts CapacityTaskTimeouts
    Configuration block with timeouts. See below.
    OutpostIdentifier string
    ID or ARN of the Outpost on which to run the capacity task. Both forms are accepted; the provider normalizes the value internally. Changing this value forces a new resource.
    AssetId string
    ID of a specific Outposts asset (hardware server) to target for the capacity task. If omitted, AWS selects an appropriate asset automatically. Discover valid asset IDs with the aws.outposts.getAssets data source. Changing this value forces a new resource.
    InstancePools []CapacityTaskInstancePoolArgs
    One or more instancePool blocks defining the desired instance-type layout for the Outpost. See below. At least one block is required. Changing any value forces a new resource.
    InstancesToExclude CapacityTaskInstancesToExcludeArgs
    Single instancesToExclude block specifying user-owned running instances that must not be stopped to free up capacity. See below. Note: AWS does not return this value via the Get/Describe API; after import, you must add the block back to your configuration manually — see Import.
    OrderId string
    ID of the Amazon Web Services Outposts order associated with the capacity task. Changing this value forces a new resource.
    Region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    TaskActionOnBlockingInstances string
    Action to take if running instances block the capacity task. Valid values are WAIT_FOR_EVACUATION and FAIL_TASK. Changing this value forces a new resource.
    Timeouts CapacityTaskTimeoutsArgs
    Configuration block with timeouts. See below.
    outpost_identifier string
    ID or ARN of the Outpost on which to run the capacity task. Both forms are accepted; the provider normalizes the value internally. Changing this value forces a new resource.
    asset_id string
    ID of a specific Outposts asset (hardware server) to target for the capacity task. If omitted, AWS selects an appropriate asset automatically. Discover valid asset IDs with the aws.outposts.getAssets data source. Changing this value forces a new resource.
    instance_pools list(object)
    One or more instancePool blocks defining the desired instance-type layout for the Outpost. See below. At least one block is required. Changing any value forces a new resource.
    instances_to_exclude object
    Single instancesToExclude block specifying user-owned running instances that must not be stopped to free up capacity. See below. Note: AWS does not return this value via the Get/Describe API; after import, you must add the block back to your configuration manually — see Import.
    order_id string
    ID of the Amazon Web Services Outposts order associated with the capacity task. Changing this value forces a new resource.
    region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    task_action_on_blocking_instances string
    Action to take if running instances block the capacity task. Valid values are WAIT_FOR_EVACUATION and FAIL_TASK. Changing this value forces a new resource.
    timeouts object
    Configuration block with timeouts. See below.
    outpostIdentifier String
    ID or ARN of the Outpost on which to run the capacity task. Both forms are accepted; the provider normalizes the value internally. Changing this value forces a new resource.
    assetId String
    ID of a specific Outposts asset (hardware server) to target for the capacity task. If omitted, AWS selects an appropriate asset automatically. Discover valid asset IDs with the aws.outposts.getAssets data source. Changing this value forces a new resource.
    instancePools List<CapacityTaskInstancePool>
    One or more instancePool blocks defining the desired instance-type layout for the Outpost. See below. At least one block is required. Changing any value forces a new resource.
    instancesToExclude CapacityTaskInstancesToExclude
    Single instancesToExclude block specifying user-owned running instances that must not be stopped to free up capacity. See below. Note: AWS does not return this value via the Get/Describe API; after import, you must add the block back to your configuration manually — see Import.
    orderId String
    ID of the Amazon Web Services Outposts order associated with the capacity task. Changing this value forces a new resource.
    region String
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    taskActionOnBlockingInstances String
    Action to take if running instances block the capacity task. Valid values are WAIT_FOR_EVACUATION and FAIL_TASK. Changing this value forces a new resource.
    timeouts CapacityTaskTimeouts
    Configuration block with timeouts. See below.
    outpostIdentifier string
    ID or ARN of the Outpost on which to run the capacity task. Both forms are accepted; the provider normalizes the value internally. Changing this value forces a new resource.
    assetId string
    ID of a specific Outposts asset (hardware server) to target for the capacity task. If omitted, AWS selects an appropriate asset automatically. Discover valid asset IDs with the aws.outposts.getAssets data source. Changing this value forces a new resource.
    instancePools CapacityTaskInstancePool[]
    One or more instancePool blocks defining the desired instance-type layout for the Outpost. See below. At least one block is required. Changing any value forces a new resource.
    instancesToExclude CapacityTaskInstancesToExclude
    Single instancesToExclude block specifying user-owned running instances that must not be stopped to free up capacity. See below. Note: AWS does not return this value via the Get/Describe API; after import, you must add the block back to your configuration manually — see Import.
    orderId string
    ID of the Amazon Web Services Outposts order associated with the capacity task. Changing this value forces a new resource.
    region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    taskActionOnBlockingInstances string
    Action to take if running instances block the capacity task. Valid values are WAIT_FOR_EVACUATION and FAIL_TASK. Changing this value forces a new resource.
    timeouts CapacityTaskTimeouts
    Configuration block with timeouts. See below.
    outpost_identifier str
    ID or ARN of the Outpost on which to run the capacity task. Both forms are accepted; the provider normalizes the value internally. Changing this value forces a new resource.
    asset_id str
    ID of a specific Outposts asset (hardware server) to target for the capacity task. If omitted, AWS selects an appropriate asset automatically. Discover valid asset IDs with the aws.outposts.getAssets data source. Changing this value forces a new resource.
    instance_pools Sequence[CapacityTaskInstancePoolArgs]
    One or more instancePool blocks defining the desired instance-type layout for the Outpost. See below. At least one block is required. Changing any value forces a new resource.
    instances_to_exclude CapacityTaskInstancesToExcludeArgs
    Single instancesToExclude block specifying user-owned running instances that must not be stopped to free up capacity. See below. Note: AWS does not return this value via the Get/Describe API; after import, you must add the block back to your configuration manually — see Import.
    order_id str
    ID of the Amazon Web Services Outposts order associated with the capacity task. Changing this value forces a new resource.
    region str
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    task_action_on_blocking_instances str
    Action to take if running instances block the capacity task. Valid values are WAIT_FOR_EVACUATION and FAIL_TASK. Changing this value forces a new resource.
    timeouts CapacityTaskTimeoutsArgs
    Configuration block with timeouts. See below.
    outpostIdentifier String
    ID or ARN of the Outpost on which to run the capacity task. Both forms are accepted; the provider normalizes the value internally. Changing this value forces a new resource.
    assetId String
    ID of a specific Outposts asset (hardware server) to target for the capacity task. If omitted, AWS selects an appropriate asset automatically. Discover valid asset IDs with the aws.outposts.getAssets data source. Changing this value forces a new resource.
    instancePools List<Property Map>
    One or more instancePool blocks defining the desired instance-type layout for the Outpost. See below. At least one block is required. Changing any value forces a new resource.
    instancesToExclude Property Map
    Single instancesToExclude block specifying user-owned running instances that must not be stopped to free up capacity. See below. Note: AWS does not return this value via the Get/Describe API; after import, you must add the block back to your configuration manually — see Import.
    orderId String
    ID of the Amazon Web Services Outposts order associated with the capacity task. Changing this value forces a new resource.
    region String
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    taskActionOnBlockingInstances String
    Action to take if running instances block the capacity task. Valid values are WAIT_FOR_EVACUATION and FAIL_TASK. Changing this value forces a new resource.
    timeouts Property Map
    Configuration block with timeouts. See below.

    Outputs

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

    CapacityTaskId string
    ID assigned by AWS to the capacity task (for example, cap-1a2b3c4d5e6f7g8h9).
    CompletionDate string
    RFC 3339 timestamp at which the capacity task reached a terminal state (if any).
    CreationDate string
    RFC 3339 timestamp at which the capacity task was created.
    FailureReason string
    Human-readable reason reported by AWS when the capacity task failed. null unless the terminal state is FAILED.
    Id string
    The provider-assigned unique ID for this managed resource.
    Status string
    Current status of the capacity task. One of REQUESTED, IN_PROGRESS, WAITING_FOR_EVACUATION, CANCELLATION_IN_PROGRESS, COMPLETED, CANCELLED, or FAILED. See the AWS documentation for semantics.
    CapacityTaskId string
    ID assigned by AWS to the capacity task (for example, cap-1a2b3c4d5e6f7g8h9).
    CompletionDate string
    RFC 3339 timestamp at which the capacity task reached a terminal state (if any).
    CreationDate string
    RFC 3339 timestamp at which the capacity task was created.
    FailureReason string
    Human-readable reason reported by AWS when the capacity task failed. null unless the terminal state is FAILED.
    Id string
    The provider-assigned unique ID for this managed resource.
    Status string
    Current status of the capacity task. One of REQUESTED, IN_PROGRESS, WAITING_FOR_EVACUATION, CANCELLATION_IN_PROGRESS, COMPLETED, CANCELLED, or FAILED. See the AWS documentation for semantics.
    capacity_task_id string
    ID assigned by AWS to the capacity task (for example, cap-1a2b3c4d5e6f7g8h9).
    completion_date string
    RFC 3339 timestamp at which the capacity task reached a terminal state (if any).
    creation_date string
    RFC 3339 timestamp at which the capacity task was created.
    failure_reason string
    Human-readable reason reported by AWS when the capacity task failed. null unless the terminal state is FAILED.
    id string
    The provider-assigned unique ID for this managed resource.
    status string
    Current status of the capacity task. One of REQUESTED, IN_PROGRESS, WAITING_FOR_EVACUATION, CANCELLATION_IN_PROGRESS, COMPLETED, CANCELLED, or FAILED. See the AWS documentation for semantics.
    capacityTaskId String
    ID assigned by AWS to the capacity task (for example, cap-1a2b3c4d5e6f7g8h9).
    completionDate String
    RFC 3339 timestamp at which the capacity task reached a terminal state (if any).
    creationDate String
    RFC 3339 timestamp at which the capacity task was created.
    failureReason String
    Human-readable reason reported by AWS when the capacity task failed. null unless the terminal state is FAILED.
    id String
    The provider-assigned unique ID for this managed resource.
    status String
    Current status of the capacity task. One of REQUESTED, IN_PROGRESS, WAITING_FOR_EVACUATION, CANCELLATION_IN_PROGRESS, COMPLETED, CANCELLED, or FAILED. See the AWS documentation for semantics.
    capacityTaskId string
    ID assigned by AWS to the capacity task (for example, cap-1a2b3c4d5e6f7g8h9).
    completionDate string
    RFC 3339 timestamp at which the capacity task reached a terminal state (if any).
    creationDate string
    RFC 3339 timestamp at which the capacity task was created.
    failureReason string
    Human-readable reason reported by AWS when the capacity task failed. null unless the terminal state is FAILED.
    id string
    The provider-assigned unique ID for this managed resource.
    status string
    Current status of the capacity task. One of REQUESTED, IN_PROGRESS, WAITING_FOR_EVACUATION, CANCELLATION_IN_PROGRESS, COMPLETED, CANCELLED, or FAILED. See the AWS documentation for semantics.
    capacity_task_id str
    ID assigned by AWS to the capacity task (for example, cap-1a2b3c4d5e6f7g8h9).
    completion_date str
    RFC 3339 timestamp at which the capacity task reached a terminal state (if any).
    creation_date str
    RFC 3339 timestamp at which the capacity task was created.
    failure_reason str
    Human-readable reason reported by AWS when the capacity task failed. null unless the terminal state is FAILED.
    id str
    The provider-assigned unique ID for this managed resource.
    status str
    Current status of the capacity task. One of REQUESTED, IN_PROGRESS, WAITING_FOR_EVACUATION, CANCELLATION_IN_PROGRESS, COMPLETED, CANCELLED, or FAILED. See the AWS documentation for semantics.
    capacityTaskId String
    ID assigned by AWS to the capacity task (for example, cap-1a2b3c4d5e6f7g8h9).
    completionDate String
    RFC 3339 timestamp at which the capacity task reached a terminal state (if any).
    creationDate String
    RFC 3339 timestamp at which the capacity task was created.
    failureReason String
    Human-readable reason reported by AWS when the capacity task failed. null unless the terminal state is FAILED.
    id String
    The provider-assigned unique ID for this managed resource.
    status String
    Current status of the capacity task. One of REQUESTED, IN_PROGRESS, WAITING_FOR_EVACUATION, CANCELLATION_IN_PROGRESS, COMPLETED, CANCELLED, or FAILED. See the AWS documentation for semantics.

    Look up Existing CapacityTask Resource

    Get an existing CapacityTask 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?: CapacityTaskState, opts?: CustomResourceOptions): CapacityTask
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            asset_id: Optional[str] = None,
            capacity_task_id: Optional[str] = None,
            completion_date: Optional[str] = None,
            creation_date: Optional[str] = None,
            failure_reason: Optional[str] = None,
            instance_pools: Optional[Sequence[CapacityTaskInstancePoolArgs]] = None,
            instances_to_exclude: Optional[CapacityTaskInstancesToExcludeArgs] = None,
            order_id: Optional[str] = None,
            outpost_identifier: Optional[str] = None,
            region: Optional[str] = None,
            status: Optional[str] = None,
            task_action_on_blocking_instances: Optional[str] = None,
            timeouts: Optional[CapacityTaskTimeoutsArgs] = None) -> CapacityTask
    func GetCapacityTask(ctx *Context, name string, id IDInput, state *CapacityTaskState, opts ...ResourceOption) (*CapacityTask, error)
    public static CapacityTask Get(string name, Input<string> id, CapacityTaskState? state, CustomResourceOptions? opts = null)
    public static CapacityTask get(String name, Output<String> id, CapacityTaskState state, CustomResourceOptions options)
    resources:  _:    type: aws:outposts:CapacityTask    get:      id: ${id}
    import {
      to = aws_outposts_capacitytask.example
      id = "${id}"
    }
    
    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:
    AssetId string
    ID of a specific Outposts asset (hardware server) to target for the capacity task. If omitted, AWS selects an appropriate asset automatically. Discover valid asset IDs with the aws.outposts.getAssets data source. Changing this value forces a new resource.
    CapacityTaskId string
    ID assigned by AWS to the capacity task (for example, cap-1a2b3c4d5e6f7g8h9).
    CompletionDate string
    RFC 3339 timestamp at which the capacity task reached a terminal state (if any).
    CreationDate string
    RFC 3339 timestamp at which the capacity task was created.
    FailureReason string
    Human-readable reason reported by AWS when the capacity task failed. null unless the terminal state is FAILED.
    InstancePools List<CapacityTaskInstancePool>
    One or more instancePool blocks defining the desired instance-type layout for the Outpost. See below. At least one block is required. Changing any value forces a new resource.
    InstancesToExclude CapacityTaskInstancesToExclude
    Single instancesToExclude block specifying user-owned running instances that must not be stopped to free up capacity. See below. Note: AWS does not return this value via the Get/Describe API; after import, you must add the block back to your configuration manually — see Import.
    OrderId string
    ID of the Amazon Web Services Outposts order associated with the capacity task. Changing this value forces a new resource.
    OutpostIdentifier string
    ID or ARN of the Outpost on which to run the capacity task. Both forms are accepted; the provider normalizes the value internally. Changing this value forces a new resource.
    Region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    Status string
    Current status of the capacity task. One of REQUESTED, IN_PROGRESS, WAITING_FOR_EVACUATION, CANCELLATION_IN_PROGRESS, COMPLETED, CANCELLED, or FAILED. See the AWS documentation for semantics.
    TaskActionOnBlockingInstances string
    Action to take if running instances block the capacity task. Valid values are WAIT_FOR_EVACUATION and FAIL_TASK. Changing this value forces a new resource.
    Timeouts CapacityTaskTimeouts
    Configuration block with timeouts. See below.
    AssetId string
    ID of a specific Outposts asset (hardware server) to target for the capacity task. If omitted, AWS selects an appropriate asset automatically. Discover valid asset IDs with the aws.outposts.getAssets data source. Changing this value forces a new resource.
    CapacityTaskId string
    ID assigned by AWS to the capacity task (for example, cap-1a2b3c4d5e6f7g8h9).
    CompletionDate string
    RFC 3339 timestamp at which the capacity task reached a terminal state (if any).
    CreationDate string
    RFC 3339 timestamp at which the capacity task was created.
    FailureReason string
    Human-readable reason reported by AWS when the capacity task failed. null unless the terminal state is FAILED.
    InstancePools []CapacityTaskInstancePoolArgs
    One or more instancePool blocks defining the desired instance-type layout for the Outpost. See below. At least one block is required. Changing any value forces a new resource.
    InstancesToExclude CapacityTaskInstancesToExcludeArgs
    Single instancesToExclude block specifying user-owned running instances that must not be stopped to free up capacity. See below. Note: AWS does not return this value via the Get/Describe API; after import, you must add the block back to your configuration manually — see Import.
    OrderId string
    ID of the Amazon Web Services Outposts order associated with the capacity task. Changing this value forces a new resource.
    OutpostIdentifier string
    ID or ARN of the Outpost on which to run the capacity task. Both forms are accepted; the provider normalizes the value internally. Changing this value forces a new resource.
    Region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    Status string
    Current status of the capacity task. One of REQUESTED, IN_PROGRESS, WAITING_FOR_EVACUATION, CANCELLATION_IN_PROGRESS, COMPLETED, CANCELLED, or FAILED. See the AWS documentation for semantics.
    TaskActionOnBlockingInstances string
    Action to take if running instances block the capacity task. Valid values are WAIT_FOR_EVACUATION and FAIL_TASK. Changing this value forces a new resource.
    Timeouts CapacityTaskTimeoutsArgs
    Configuration block with timeouts. See below.
    asset_id string
    ID of a specific Outposts asset (hardware server) to target for the capacity task. If omitted, AWS selects an appropriate asset automatically. Discover valid asset IDs with the aws.outposts.getAssets data source. Changing this value forces a new resource.
    capacity_task_id string
    ID assigned by AWS to the capacity task (for example, cap-1a2b3c4d5e6f7g8h9).
    completion_date string
    RFC 3339 timestamp at which the capacity task reached a terminal state (if any).
    creation_date string
    RFC 3339 timestamp at which the capacity task was created.
    failure_reason string
    Human-readable reason reported by AWS when the capacity task failed. null unless the terminal state is FAILED.
    instance_pools list(object)
    One or more instancePool blocks defining the desired instance-type layout for the Outpost. See below. At least one block is required. Changing any value forces a new resource.
    instances_to_exclude object
    Single instancesToExclude block specifying user-owned running instances that must not be stopped to free up capacity. See below. Note: AWS does not return this value via the Get/Describe API; after import, you must add the block back to your configuration manually — see Import.
    order_id string
    ID of the Amazon Web Services Outposts order associated with the capacity task. Changing this value forces a new resource.
    outpost_identifier string
    ID or ARN of the Outpost on which to run the capacity task. Both forms are accepted; the provider normalizes the value internally. Changing this value forces a new resource.
    region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    status string
    Current status of the capacity task. One of REQUESTED, IN_PROGRESS, WAITING_FOR_EVACUATION, CANCELLATION_IN_PROGRESS, COMPLETED, CANCELLED, or FAILED. See the AWS documentation for semantics.
    task_action_on_blocking_instances string
    Action to take if running instances block the capacity task. Valid values are WAIT_FOR_EVACUATION and FAIL_TASK. Changing this value forces a new resource.
    timeouts object
    Configuration block with timeouts. See below.
    assetId String
    ID of a specific Outposts asset (hardware server) to target for the capacity task. If omitted, AWS selects an appropriate asset automatically. Discover valid asset IDs with the aws.outposts.getAssets data source. Changing this value forces a new resource.
    capacityTaskId String
    ID assigned by AWS to the capacity task (for example, cap-1a2b3c4d5e6f7g8h9).
    completionDate String
    RFC 3339 timestamp at which the capacity task reached a terminal state (if any).
    creationDate String
    RFC 3339 timestamp at which the capacity task was created.
    failureReason String
    Human-readable reason reported by AWS when the capacity task failed. null unless the terminal state is FAILED.
    instancePools List<CapacityTaskInstancePool>
    One or more instancePool blocks defining the desired instance-type layout for the Outpost. See below. At least one block is required. Changing any value forces a new resource.
    instancesToExclude CapacityTaskInstancesToExclude
    Single instancesToExclude block specifying user-owned running instances that must not be stopped to free up capacity. See below. Note: AWS does not return this value via the Get/Describe API; after import, you must add the block back to your configuration manually — see Import.
    orderId String
    ID of the Amazon Web Services Outposts order associated with the capacity task. Changing this value forces a new resource.
    outpostIdentifier String
    ID or ARN of the Outpost on which to run the capacity task. Both forms are accepted; the provider normalizes the value internally. Changing this value forces a new resource.
    region String
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    status String
    Current status of the capacity task. One of REQUESTED, IN_PROGRESS, WAITING_FOR_EVACUATION, CANCELLATION_IN_PROGRESS, COMPLETED, CANCELLED, or FAILED. See the AWS documentation for semantics.
    taskActionOnBlockingInstances String
    Action to take if running instances block the capacity task. Valid values are WAIT_FOR_EVACUATION and FAIL_TASK. Changing this value forces a new resource.
    timeouts CapacityTaskTimeouts
    Configuration block with timeouts. See below.
    assetId string
    ID of a specific Outposts asset (hardware server) to target for the capacity task. If omitted, AWS selects an appropriate asset automatically. Discover valid asset IDs with the aws.outposts.getAssets data source. Changing this value forces a new resource.
    capacityTaskId string
    ID assigned by AWS to the capacity task (for example, cap-1a2b3c4d5e6f7g8h9).
    completionDate string
    RFC 3339 timestamp at which the capacity task reached a terminal state (if any).
    creationDate string
    RFC 3339 timestamp at which the capacity task was created.
    failureReason string
    Human-readable reason reported by AWS when the capacity task failed. null unless the terminal state is FAILED.
    instancePools CapacityTaskInstancePool[]
    One or more instancePool blocks defining the desired instance-type layout for the Outpost. See below. At least one block is required. Changing any value forces a new resource.
    instancesToExclude CapacityTaskInstancesToExclude
    Single instancesToExclude block specifying user-owned running instances that must not be stopped to free up capacity. See below. Note: AWS does not return this value via the Get/Describe API; after import, you must add the block back to your configuration manually — see Import.
    orderId string
    ID of the Amazon Web Services Outposts order associated with the capacity task. Changing this value forces a new resource.
    outpostIdentifier string
    ID or ARN of the Outpost on which to run the capacity task. Both forms are accepted; the provider normalizes the value internally. Changing this value forces a new resource.
    region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    status string
    Current status of the capacity task. One of REQUESTED, IN_PROGRESS, WAITING_FOR_EVACUATION, CANCELLATION_IN_PROGRESS, COMPLETED, CANCELLED, or FAILED. See the AWS documentation for semantics.
    taskActionOnBlockingInstances string
    Action to take if running instances block the capacity task. Valid values are WAIT_FOR_EVACUATION and FAIL_TASK. Changing this value forces a new resource.
    timeouts CapacityTaskTimeouts
    Configuration block with timeouts. See below.
    asset_id str
    ID of a specific Outposts asset (hardware server) to target for the capacity task. If omitted, AWS selects an appropriate asset automatically. Discover valid asset IDs with the aws.outposts.getAssets data source. Changing this value forces a new resource.
    capacity_task_id str
    ID assigned by AWS to the capacity task (for example, cap-1a2b3c4d5e6f7g8h9).
    completion_date str
    RFC 3339 timestamp at which the capacity task reached a terminal state (if any).
    creation_date str
    RFC 3339 timestamp at which the capacity task was created.
    failure_reason str
    Human-readable reason reported by AWS when the capacity task failed. null unless the terminal state is FAILED.
    instance_pools Sequence[CapacityTaskInstancePoolArgs]
    One or more instancePool blocks defining the desired instance-type layout for the Outpost. See below. At least one block is required. Changing any value forces a new resource.
    instances_to_exclude CapacityTaskInstancesToExcludeArgs
    Single instancesToExclude block specifying user-owned running instances that must not be stopped to free up capacity. See below. Note: AWS does not return this value via the Get/Describe API; after import, you must add the block back to your configuration manually — see Import.
    order_id str
    ID of the Amazon Web Services Outposts order associated with the capacity task. Changing this value forces a new resource.
    outpost_identifier str
    ID or ARN of the Outpost on which to run the capacity task. Both forms are accepted; the provider normalizes the value internally. Changing this value forces a new resource.
    region str
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    status str
    Current status of the capacity task. One of REQUESTED, IN_PROGRESS, WAITING_FOR_EVACUATION, CANCELLATION_IN_PROGRESS, COMPLETED, CANCELLED, or FAILED. See the AWS documentation for semantics.
    task_action_on_blocking_instances str
    Action to take if running instances block the capacity task. Valid values are WAIT_FOR_EVACUATION and FAIL_TASK. Changing this value forces a new resource.
    timeouts CapacityTaskTimeoutsArgs
    Configuration block with timeouts. See below.
    assetId String
    ID of a specific Outposts asset (hardware server) to target for the capacity task. If omitted, AWS selects an appropriate asset automatically. Discover valid asset IDs with the aws.outposts.getAssets data source. Changing this value forces a new resource.
    capacityTaskId String
    ID assigned by AWS to the capacity task (for example, cap-1a2b3c4d5e6f7g8h9).
    completionDate String
    RFC 3339 timestamp at which the capacity task reached a terminal state (if any).
    creationDate String
    RFC 3339 timestamp at which the capacity task was created.
    failureReason String
    Human-readable reason reported by AWS when the capacity task failed. null unless the terminal state is FAILED.
    instancePools List<Property Map>
    One or more instancePool blocks defining the desired instance-type layout for the Outpost. See below. At least one block is required. Changing any value forces a new resource.
    instancesToExclude Property Map
    Single instancesToExclude block specifying user-owned running instances that must not be stopped to free up capacity. See below. Note: AWS does not return this value via the Get/Describe API; after import, you must add the block back to your configuration manually — see Import.
    orderId String
    ID of the Amazon Web Services Outposts order associated with the capacity task. Changing this value forces a new resource.
    outpostIdentifier String
    ID or ARN of the Outpost on which to run the capacity task. Both forms are accepted; the provider normalizes the value internally. Changing this value forces a new resource.
    region String
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    status String
    Current status of the capacity task. One of REQUESTED, IN_PROGRESS, WAITING_FOR_EVACUATION, CANCELLATION_IN_PROGRESS, COMPLETED, CANCELLED, or FAILED. See the AWS documentation for semantics.
    taskActionOnBlockingInstances String
    Action to take if running instances block the capacity task. Valid values are WAIT_FOR_EVACUATION and FAIL_TASK. Changing this value forces a new resource.
    timeouts Property Map
    Configuration block with timeouts. See below.

    Supporting Types

    CapacityTaskInstancePool, CapacityTaskInstancePoolArgs

    Count int
    Number of instances of instanceType that should be present after the task completes. Must be at least 1. Changing this value forces a new resource.
    InstanceType string
    Instance type for this pool entry. Must be an instance type supported by the target Outpost. Changing this value forces a new resource.
    Count int
    Number of instances of instanceType that should be present after the task completes. Must be at least 1. Changing this value forces a new resource.
    InstanceType string
    Instance type for this pool entry. Must be an instance type supported by the target Outpost. Changing this value forces a new resource.
    count number
    Number of instances of instanceType that should be present after the task completes. Must be at least 1. Changing this value forces a new resource.
    instance_type string
    Instance type for this pool entry. Must be an instance type supported by the target Outpost. Changing this value forces a new resource.
    count Integer
    Number of instances of instanceType that should be present after the task completes. Must be at least 1. Changing this value forces a new resource.
    instanceType String
    Instance type for this pool entry. Must be an instance type supported by the target Outpost. Changing this value forces a new resource.
    count number
    Number of instances of instanceType that should be present after the task completes. Must be at least 1. Changing this value forces a new resource.
    instanceType string
    Instance type for this pool entry. Must be an instance type supported by the target Outpost. Changing this value forces a new resource.
    count int
    Number of instances of instanceType that should be present after the task completes. Must be at least 1. Changing this value forces a new resource.
    instance_type str
    Instance type for this pool entry. Must be an instance type supported by the target Outpost. Changing this value forces a new resource.
    count Number
    Number of instances of instanceType that should be present after the task completes. Must be at least 1. Changing this value forces a new resource.
    instanceType String
    Instance type for this pool entry. Must be an instance type supported by the target Outpost. Changing this value forces a new resource.

    CapacityTaskInstancesToExclude, CapacityTaskInstancesToExcludeArgs

    Instances List<string>
    Set of EC2 instance IDs (of user-owned instances running on the Outpost) that the capacity task must not stop. At least one instance ID is required.
    Instances []string
    Set of EC2 instance IDs (of user-owned instances running on the Outpost) that the capacity task must not stop. At least one instance ID is required.
    instances list(string)
    Set of EC2 instance IDs (of user-owned instances running on the Outpost) that the capacity task must not stop. At least one instance ID is required.
    instances List<String>
    Set of EC2 instance IDs (of user-owned instances running on the Outpost) that the capacity task must not stop. At least one instance ID is required.
    instances string[]
    Set of EC2 instance IDs (of user-owned instances running on the Outpost) that the capacity task must not stop. At least one instance ID is required.
    instances Sequence[str]
    Set of EC2 instance IDs (of user-owned instances running on the Outpost) that the capacity task must not stop. At least one instance ID is required.
    instances List<String>
    Set of EC2 instance IDs (of user-owned instances running on the Outpost) that the capacity task must not stop. At least one instance ID is required.

    CapacityTaskTimeouts, CapacityTaskTimeoutsArgs

    Create string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    Delete string

    Long-running capacity tasks. The default create timeout of 60m is sufficient for most re-balancing operations on small to medium instance types. However, capacity tasks that change the configuration of bare-metal instance types (*.metal) or very large instance types (24xlarge, 48xlarge, etc.) in the current or target state can take 8 to 12 hours to complete, because AWS must stop, reconfigure, and re-start the underlying hardware. If your instancePool configuration or the current state of the Outpost involves one of these instance types, override the create timeout accordingly — for example:

    Create string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    Delete string

    Long-running capacity tasks. The default create timeout of 60m is sufficient for most re-balancing operations on small to medium instance types. However, capacity tasks that change the configuration of bare-metal instance types (*.metal) or very large instance types (24xlarge, 48xlarge, etc.) in the current or target state can take 8 to 12 hours to complete, because AWS must stop, reconfigure, and re-start the underlying hardware. If your instancePool configuration or the current state of the Outpost involves one of these instance types, override the create timeout accordingly — for example:

    create string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    delete string

    Long-running capacity tasks. The default create timeout of 60m is sufficient for most re-balancing operations on small to medium instance types. However, capacity tasks that change the configuration of bare-metal instance types (*.metal) or very large instance types (24xlarge, 48xlarge, etc.) in the current or target state can take 8 to 12 hours to complete, because AWS must stop, reconfigure, and re-start the underlying hardware. If your instancePool configuration or the current state of the Outpost involves one of these instance types, override the create timeout accordingly — for example:

    create String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    delete String

    Long-running capacity tasks. The default create timeout of 60m is sufficient for most re-balancing operations on small to medium instance types. However, capacity tasks that change the configuration of bare-metal instance types (*.metal) or very large instance types (24xlarge, 48xlarge, etc.) in the current or target state can take 8 to 12 hours to complete, because AWS must stop, reconfigure, and re-start the underlying hardware. If your instancePool configuration or the current state of the Outpost involves one of these instance types, override the create timeout accordingly — for example:

    create string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    delete string

    Long-running capacity tasks. The default create timeout of 60m is sufficient for most re-balancing operations on small to medium instance types. However, capacity tasks that change the configuration of bare-metal instance types (*.metal) or very large instance types (24xlarge, 48xlarge, etc.) in the current or target state can take 8 to 12 hours to complete, because AWS must stop, reconfigure, and re-start the underlying hardware. If your instancePool configuration or the current state of the Outpost involves one of these instance types, override the create timeout accordingly — for example:

    create str
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    delete str

    Long-running capacity tasks. The default create timeout of 60m is sufficient for most re-balancing operations on small to medium instance types. However, capacity tasks that change the configuration of bare-metal instance types (*.metal) or very large instance types (24xlarge, 48xlarge, etc.) in the current or target state can take 8 to 12 hours to complete, because AWS must stop, reconfigure, and re-start the underlying hardware. If your instancePool configuration or the current state of the Outpost involves one of these instance types, override the create timeout accordingly — for example:

    create String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    delete String

    Long-running capacity tasks. The default create timeout of 60m is sufficient for most re-balancing operations on small to medium instance types. However, capacity tasks that change the configuration of bare-metal instance types (*.metal) or very large instance types (24xlarge, 48xlarge, etc.) in the current or target state can take 8 to 12 hours to complete, because AWS must stop, reconfigure, and re-start the underlying hardware. If your instancePool configuration or the current state of the Outpost involves one of these instance types, override the create timeout accordingly — for example:

    Import

    Identity Schema

    Required

    • outpostIdentifier (String) Outpost identifier supplied when the task was created (ID or ARN).
    • capacityTaskId (String) AWS-assigned capacity task ID.

    Optional

    • accountId (String) AWS Account where this resource is managed.
    • region (String) Region where this resource is managed.

    Using pulumi import, import a Capacity Task using the same composite ID. For example:

    $ pulumi import aws:outposts/capacityTask:CapacityTask example op-1234567890abcdef/cap-1a2b3c4d5e6f7g8h9
    

    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
    Viewing docs for AWS v7.32.0
    published on Friday, May 29, 2026 by Pulumi

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial