CapacityProvider
The details for a capacity provider.
Contents
- autoScalingGroupProvider
-
The Auto Scaling group settings for the capacity provider.
Type: AutoScalingGroupProvider object
Required: No
- capacityProviderArn
-
The Amazon Resource Name (ARN) that identifies the capacity provider.
Type: String
Required: No
- name
-
The name of the capacity provider.
Type: String
Required: No
- status
-
The current status of the capacity provider. Only capacity providers in an
ACTIVEstate can be used in a cluster. When a capacity provider is successfully deleted, it has anINACTIVEstatus.Type: String
Valid Values:
ACTIVE | INACTIVERequired: No
-
The metadata that you apply to the capacity provider to help you categorize and organize it. Each tag consists of a key and an optional value. You define both.
The following basic restrictions apply to tags:
-
Maximum number of tags per resource - 50
-
For each resource, each tag key must be unique, and each tag key can have only one value.
-
Maximum key length - 128 Unicode characters in UTF-8
-
Maximum value length - 256 Unicode characters in UTF-8
-
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
-
Tag keys and values are case-sensitive.
-
Do not use
aws:,AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
Type: Array of Tag objects
Array Members: Minimum number of 0 items. Maximum number of 50 items.
Required: No
-
- updateStatus
-
The update status of the capacity provider. The following are the possible states that is returned.
- DELETE_IN_PROGRESS
-
The capacity provider is in the process of being deleted.
- DELETE_COMPLETE
-
The capacity provider was successfully deleted and has an
INACTIVEstatus. - DELETE_FAILED
-
The capacity provider can't be deleted. The update status reason provides further details about why the delete failed.
Type: String
Valid Values:
DELETE_IN_PROGRESS | DELETE_COMPLETE | DELETE_FAILED | UPDATE_IN_PROGRESS | UPDATE_COMPLETE | UPDATE_FAILEDRequired: No
- updateStatusReason
-
The update status reason. This provides further details about the update status for the capacity provider.
Type: String
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
