Skip to content

ECS  >  Operations  >  create_capacity_provider

create_capacity_provider

Operation

create_capacity_provider async

create_capacity_provider(request: CreateCapacityProviderInput | CreateCapacityProviderInputDict, /, *, plugins: list[Plugin] | None = None) -> CreateCapacityProviderOutput
create_capacity_provider(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[CreateCapacityProviderInputDict]) -> CreateCapacityProviderOutput

Creates a capacity provider. Capacity providers are associated with a cluster and are used in capacity provider strategies to facilitate cluster auto scaling. You can create capacity providers for Amazon ECS Managed Instances and EC2 instances. Fargate has the predefined FARGATE and FARGATE_SPOT capacity providers.

Parameters:

Name Type Description Default
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None

Returns:

Type Description
CreateCapacityProviderOutput

An instance of CreateCapacityProviderOutput.

Input

Pass the input fields as keyword arguments, or pass a model or dictionary as the first positional argument. Pass plugins separately as a keyword argument.

Model

CreateCapacityProviderInput dataclass

Bases: _SerdeShape

Dataclass for CreateCapacityProviderInput structure.

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

The details of the Auto Scaling group for the capacity provider.

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

The name of the cluster to associate with the capacity provider. When you create a capacity provider with Amazon ECS Managed Instances, it becomes available only within the specified cluster.

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

The configuration for the Amazon ECS Managed Instances provider. This configuration specifies how Amazon ECS manages Amazon EC2 instances on your behalf, including the infrastructure role, instance launch template, and tag propagation settings.

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

The name of the capacity provider. Up to 255 characters are allowed. They include letters (both upper and lowercase letters), numbers, underscores (_), and hyphens (-). The name can't be prefixed with "aws", "ecs", or "fargate".

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

The metadata that you apply to the capacity provider to categorize and organize them more conveniently. Each tag consists of a key and an optional value. You define both of them.

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.

Dictionaries

CreateCapacityProviderInputDict

Bases: TypedDict

Dictionary form of CreateCapacityProviderInput.

Attributes
auto_scaling_group_provider instance-attribute
auto_scaling_group_provider: AutoScalingGroupProvider | AutoScalingGroupProviderDict | None

The details of the Auto Scaling group for the capacity provider.

cluster instance-attribute
cluster: str | None

The name of the cluster to associate with the capacity provider. When you create a capacity provider with Amazon ECS Managed Instances, it becomes available only within the specified cluster.

managed_instances_provider instance-attribute

The configuration for the Amazon ECS Managed Instances provider. This configuration specifies how Amazon ECS manages Amazon EC2 instances on your behalf, including the infrastructure role, instance launch template, and tag propagation settings.

name instance-attribute
name: Required[str]

The name of the capacity provider. Up to 255 characters are allowed. They include letters (both upper and lowercase letters), numbers, underscores (_), and hyphens (-). The name can't be prefixed with "aws", "ecs", or "fargate".

tags instance-attribute
tags: Sequence[Tag | TagDict] | None

The metadata that you apply to the capacity provider to categorize and organize them more conveniently. Each tag consists of a key and an optional value. You define both of them.

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.

Output

CreateCapacityProviderOutput dataclass

Bases: _SerdeShape

Dataclass for CreateCapacityProviderOutput structure.

Attributes

capacity_provider class-attribute instance-attribute
capacity_provider: CapacityProvider | None = ...

The full description of the new capacity provider.

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.