CapacityTaskState class

Input properties used for looking up and filtering CapacityTask resources.

Constructors

CapacityTaskState({Input<String?>? assetId, Input<String?>? capacityTaskId, Input<String?>? completionDate, Input<String?>? creationDate, Input<String?>? failureReason, Input<List<CapacityTaskInstancePool>?>? instancePools, Input<CapacityTaskInstancesToExclude?>? instancesToExclude, Input<String?>? orderId, Input<String?>? outpostIdentifier, Input<String?>? region, Input<String?>? status, Input<String?>? taskActionOnBlockingInstances, Input<CapacityTaskTimeouts?>? timeouts})
Creates a new CapacityTaskState. assetId 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 ID assigned by AWS to the capacity task (for example, cap-1a2b3c4d5e6f7g8h9). completionDate RFC 3339 timestamp at which the capacity task reached a terminal state (if any). creationDate RFC 3339 timestamp at which the capacity task was created. failureReason Human-readable reason reported by AWS when the capacity task failed. null unless the terminal state is FAILED. instancePools 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 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 ID of the Amazon Web Services Outposts order associated with the capacity task. Changing this value forces a new resource. outpostIdentifier 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 Region where this resource will be managed. Defaults to the Region set in the provider configuration. status 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 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 Configuration block with timeouts. See below.
const
CapacityTaskState.fromMap(Map<String, dynamic> map)
factory

Properties

assetId → Input<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.
final
capacityTaskId → Input<String?>?
ID assigned by AWS to the capacity task (for example, cap-1a2b3c4d5e6f7g8h9).
final
completionDate → Input<String?>?
RFC 3339 timestamp at which the capacity task reached a terminal state (if any).
final
creationDate → Input<String?>?
RFC 3339 timestamp at which the capacity task was created.
final
failureReason → Input<String?>?
Human-readable reason reported by AWS when the capacity task failed. null unless the terminal state is FAILED.
final
hashCode → int
The hash code for this object.
no setterinherited
instancePools → Input<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.
final
instancesToExclude → Input<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.
final
orderId → Input<String?>?
ID of the Amazon Web Services Outposts order associated with the capacity task. Changing this value forces a new resource.
final
outpostIdentifier → Input<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.
final
region → Input<String?>?
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
status → Input<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.
final
taskActionOnBlockingInstances → Input<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.
final
timeouts → Input<CapacityTaskTimeouts?>?
Configuration block with timeouts. See below.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toMap() → Map<String, dynamic>
toString() → String
A string representation of this object.
inherited

Operators

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