amazonka-ecs-2.0: Amazon EC2 Container Service SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.ECS.CreateCapacityProvider

Description

Creates a new capacity provider. Capacity providers are associated with an Amazon ECS cluster and are used in capacity provider strategies to facilitate cluster auto scaling.

Only capacity providers that use an Auto Scaling group can be created. Amazon ECS tasks on Fargate use the FARGATE and FARGATE_SPOT capacity providers. These providers are available to all accounts in the Amazon Web Services Regions that Fargate supports.

Synopsis

Creating a Request

data CreateCapacityProvider Source #

See: newCreateCapacityProvider smart constructor.

Constructors

CreateCapacityProvider' 

Fields

  • tags :: Maybe [Tag]

    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.
  • name :: Text

    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".

  • autoScalingGroupProvider :: AutoScalingGroupProvider

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

Instances

Instances details
ToJSON CreateCapacityProvider Source # 
Instance details

Defined in Amazonka.ECS.CreateCapacityProvider

ToHeaders CreateCapacityProvider Source # 
Instance details

Defined in Amazonka.ECS.CreateCapacityProvider

ToPath CreateCapacityProvider Source # 
Instance details

Defined in Amazonka.ECS.CreateCapacityProvider

ToQuery CreateCapacityProvider Source # 
Instance details

Defined in Amazonka.ECS.CreateCapacityProvider

AWSRequest CreateCapacityProvider Source # 
Instance details

Defined in Amazonka.ECS.CreateCapacityProvider

Associated Types

type AWSResponse CreateCapacityProvider #

Generic CreateCapacityProvider Source # 
Instance details

Defined in Amazonka.ECS.CreateCapacityProvider

Associated Types

type Rep CreateCapacityProvider :: Type -> Type #

Read CreateCapacityProvider Source # 
Instance details

Defined in Amazonka.ECS.CreateCapacityProvider

Show CreateCapacityProvider Source # 
Instance details

Defined in Amazonka.ECS.CreateCapacityProvider

NFData CreateCapacityProvider Source # 
Instance details

Defined in Amazonka.ECS.CreateCapacityProvider

Methods

rnf :: CreateCapacityProvider -> () #

Eq CreateCapacityProvider Source # 
Instance details

Defined in Amazonka.ECS.CreateCapacityProvider

Hashable CreateCapacityProvider Source # 
Instance details

Defined in Amazonka.ECS.CreateCapacityProvider

type AWSResponse CreateCapacityProvider Source # 
Instance details

Defined in Amazonka.ECS.CreateCapacityProvider

type Rep CreateCapacityProvider Source # 
Instance details

Defined in Amazonka.ECS.CreateCapacityProvider

type Rep CreateCapacityProvider = D1 ('MetaData "CreateCapacityProvider" "Amazonka.ECS.CreateCapacityProvider" "amazonka-ecs-2.0-3xFxVqi9x5nBZ44jBEC5G8" 'False) (C1 ('MetaCons "CreateCapacityProvider'" 'PrefixI 'True) (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])) :*: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "autoScalingGroupProvider") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 AutoScalingGroupProvider))))

newCreateCapacityProvider Source #

Create a value of CreateCapacityProvider with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

CreateCapacityProvider, createCapacityProvider_tags - 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.

CreateCapacityProvider, createCapacityProvider_name - 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".

CreateCapacityProvider, createCapacityProvider_autoScalingGroupProvider - The details of the Auto Scaling group for the capacity provider.

Request Lenses

createCapacityProvider_tags :: Lens' CreateCapacityProvider (Maybe [Tag]) Source #

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.

createCapacityProvider_name :: Lens' CreateCapacityProvider Text Source #

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".

createCapacityProvider_autoScalingGroupProvider :: Lens' CreateCapacityProvider AutoScalingGroupProvider Source #

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

Destructuring the Response

data CreateCapacityProviderResponse Source #

See: newCreateCapacityProviderResponse smart constructor.

Constructors

CreateCapacityProviderResponse' 

Fields

Instances

Instances details
Generic CreateCapacityProviderResponse Source # 
Instance details

Defined in Amazonka.ECS.CreateCapacityProvider

Associated Types

type Rep CreateCapacityProviderResponse :: Type -> Type #

Read CreateCapacityProviderResponse Source # 
Instance details

Defined in Amazonka.ECS.CreateCapacityProvider

Show CreateCapacityProviderResponse Source # 
Instance details

Defined in Amazonka.ECS.CreateCapacityProvider

NFData CreateCapacityProviderResponse Source # 
Instance details

Defined in Amazonka.ECS.CreateCapacityProvider

Eq CreateCapacityProviderResponse Source # 
Instance details

Defined in Amazonka.ECS.CreateCapacityProvider

type Rep CreateCapacityProviderResponse Source # 
Instance details

Defined in Amazonka.ECS.CreateCapacityProvider

type Rep CreateCapacityProviderResponse = D1 ('MetaData "CreateCapacityProviderResponse" "Amazonka.ECS.CreateCapacityProvider" "amazonka-ecs-2.0-3xFxVqi9x5nBZ44jBEC5G8" 'False) (C1 ('MetaCons "CreateCapacityProviderResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "capacityProvider") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CapacityProvider)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCreateCapacityProviderResponse Source #

Create a value of CreateCapacityProviderResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

CreateCapacityProviderResponse, createCapacityProviderResponse_capacityProvider - The full description of the new capacity provider.

$sel:httpStatus:CreateCapacityProviderResponse', createCapacityProviderResponse_httpStatus - The response's http status code.

Response Lenses