createCapacityProvider method

Future<CreateCapacityProviderResponse> createCapacityProvider({ required AutoScalingGroupProvider autoScalingGroupProvider, required String name, List<Tag>? tags, })

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 using an Auto Scaling group can be created. Amazon ECS tasks on AWS Fargate use the FARGATE and FARGATE_SPOT capacity providers which are already created and available to all accounts in Regions supported by AWS Fargate.

May throw ServerException. May throw ClientException. May throw InvalidParameterException. May throw LimitExceededException. May throw UpdateInProgressException.

Parameter autoScalingGroupProvider : The details of the Auto Scaling group for the capacity provider.

Parameter name : The name of the capacity provider. Up to 255 characters are allowed, including letters (upper and lowercase), numbers, underscores, and hyphens. The name cannot be prefixed with "aws", "ecs", or "fargate".

Parameter tags : The metadata that you apply to the capacity provider to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.

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.

Implementation

Future<CreateCapacityProviderResponse> createCapacityProvider({
  required AutoScalingGroupProvider autoScalingGroupProvider,
  required String name,
  List<Tag>? tags,
}) async {
  ArgumentError.checkNotNull(
      autoScalingGroupProvider, 'autoScalingGroupProvider');
  ArgumentError.checkNotNull(name, 'name');
  final headers = <String, String>{
    'Content-Type': 'application/x-amz-json-1.1',
    'X-Amz-Target':
        'AmazonEC2ContainerServiceV20141113.CreateCapacityProvider'
  };
  final jsonResponse = await _protocol.send(
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    // TODO queryParams
    headers: headers,
    payload: {
      'autoScalingGroupProvider': autoScalingGroupProvider,
      'name': name,
      if (tags != null) 'tags': tags,
    },
  );

  return CreateCapacityProviderResponse.fromJson(jsonResponse.body);
}