Skip to content

CapacityProvider

Source code in docs_src/capo_ecs/types/capacity_provider.py
class CapacityProvider(TypedDict, closed=True):
    capacity_provider_arn: NotRequired["capo_ecs.types.string.String"]
    """<p>The Amazon Resource Name (ARN) that identifies the capacity provider.</p>"""
    name: NotRequired["capo_ecs.types.string.String"]
    """<p>The name of the capacity provider.</p>"""
    cluster: NotRequired["capo_ecs.types.string.String"]
    """<p>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.</p> <p>This is required for Managed instances.</p>"""
    status: NotRequired[
        "capo_ecs.types.capacity_provider_status.CapacityProviderStatus"
    ]
    """<p>The current status of the capacity provider. Only capacity providers in an <code>ACTIVE</code> state can be used in a cluster. When a capacity provider is successfully deleted, it has an <code>INACTIVE</code> status.</p>"""
    auto_scaling_group_provider: NotRequired[
        "capo_ecs.types.auto_scaling_group_provider.AutoScalingGroupProvider"
    ]
    """<p>The Auto Scaling group settings for the capacity provider.</p>"""
    managed_instances_provider: NotRequired[
        "capo_ecs.types.managed_instances_provider.ManagedInstancesProvider"
    ]
    """<p>The configuration for the Amazon ECS Managed Instances provider. This includes the infrastructure role, the launch template configuration, and tag propagation settings.</p>"""
    update_status: NotRequired[
        "capo_ecs.types.capacity_provider_update_status.CapacityProviderUpdateStatus"
    ]
    """<p>The update status of the capacity provider. The following are the possible states that is returned.</p> <dl> <dt>DELETE_IN_PROGRESS</dt> <dd> <p>The capacity provider is in the process of being deleted.</p> </dd> <dt>DELETE_COMPLETE</dt> <dd> <p>The capacity provider was successfully deleted and has an <code>INACTIVE</code> status.</p> </dd> <dt>DELETE_FAILED</dt> <dd> <p>The capacity provider can't be deleted. The update status reason provides further details about why the delete failed.</p> </dd> </dl>"""
    update_status_reason: NotRequired["capo_ecs.types.string.String"]
    """<p>The update status reason. This provides further details about the update status for the capacity provider.</p>"""
    tags: NotRequired["capo_ecs.types.tags.Tags"]
    """<p>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.</p> <p>The following basic restrictions apply to tags:</p> <ul> <li> <p>Maximum number of tags per resource - 50</p> </li> <li> <p>For each resource, each tag key must be unique, and each tag key can have only one value.</p> </li> <li> <p>Maximum key length - 128 Unicode characters in UTF-8</p> </li> <li> <p>Maximum value length - 256 Unicode characters in UTF-8</p> </li> <li> <p>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: + - = . _ : / @.</p> </li> <li> <p>Tag keys and values are case-sensitive.</p> </li> <li> <p>Do not use <code>aws:</code>, <code>AWS:</code>, 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.</p> </li> </ul>"""
    type: NotRequired["capo_ecs.types.capacity_provider_type.CapacityProviderType"]
    """<p>The type of capacity provider. For Amazon ECS Managed Instances, this value is <code>MANAGED_INSTANCES</code>, indicating that Amazon ECS manages the underlying Amazon EC2 instances on your behalf.</p>"""

auto_scaling_group_provider instance-attribute

auto_scaling_group_provider: NotRequired[AutoScalingGroupProvider]

The Auto Scaling group settings for the capacity provider.

capacity_provider_arn instance-attribute

capacity_provider_arn: NotRequired[String]

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

cluster instance-attribute

cluster: NotRequired[String]

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 instance-attribute

managed_instances_provider: NotRequired[ManagedInstancesProvider]

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

name instance-attribute

name: NotRequired[String]

The name of the capacity provider.

status instance-attribute

status: NotRequired[CapacityProviderStatus]

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 instance-attribute

tags: NotRequired[Tags]

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 instance-attribute

type: NotRequired[CapacityProviderType]

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 instance-attribute

update_status: NotRequired[CapacityProviderUpdateStatus]

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 instance-attribute

update_status_reason: NotRequired[String]

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