Skip to content

ECS  >  Structures  >  CapacityProvider

CapacityProvider

Structure Class

CapacityProvider dataclass

Bases: _SerdeShape

The details for a capacity provider.

Attributes

auto_scaling_group_provider class-attribute instance-attribute
auto_scaling_group_provider: AutoScalingGroupProvider | None = ...

The Auto Scaling group settings for the capacity provider.

capacity_provider_arn class-attribute instance-attribute
capacity_provider_arn: str | None = ...

The Amazon Resource Name (ARN) that identifies the capacity provider.

cluster class-attribute instance-attribute
cluster: str | None = ...

The cluster that this capacity provider is associated with. Managed instances capacity providers are cluster-scoped, meaning they can only be used within their associated cluster.

This is required for Managed instances.

managed_instances_provider class-attribute instance-attribute
managed_instances_provider: ManagedInstancesProvider | None = ...

The configuration for the Amazon ECS Managed Instances provider. This includes the infrastructure role, the launch template configuration, and tag propagation settings.

name class-attribute instance-attribute
name: str | None = ...

The name of the capacity provider.

status class-attribute instance-attribute
status: str | None = ...

The current status of the capacity provider. Only capacity providers in an ACTIVE state can be used in a cluster. When a capacity provider is successfully deleted, it has an INACTIVE status.

tags class-attribute instance-attribute
tags: list[Tag] | None = ...

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 Amazon Web Services 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 class-attribute instance-attribute
type: str | None = ...

The type of capacity provider. For Amazon ECS Managed Instances, this value is MANAGED_INSTANCES, indicating that Amazon ECS manages the underlying Amazon EC2 instances on your behalf.

update_status class-attribute instance-attribute
update_status: str | None = ...

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 INACTIVE status.

DELETE_FAILED

The capacity provider can't be deleted. The update status reason provides further details about why the delete failed.

update_status_reason class-attribute instance-attribute
update_status_reason: str | None = ...

The update status reason. This provides further details about the update status for the capacity provider.