capacity_providers

Creates, updates, deletes or gets a capacity_provider resource or lists capacity_providers in a region

Overview

Name	capacity_providers
Type	Resource
Description	Resource Type definition for AWS::ECS::CapacityProvider.
Id	awscc.ecs.capacity_providers

Fields

get (all properties)

Name	Datatype	Description
▶auto_scaling_group_provider	object
▶tags	array
name	string
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
name	string
region	string	AWS region.

For more information, see AWS::ECS::CapacityProvider.

Methods

Name	Resource	Accessible by	Required Params
create_resource	capacity_providers	INSERT	region
delete_resource	capacity_providers	DELETE	Identifier, region
update_resource	capacity_providers	UPDATE	Identifier, PatchDocument, region
list_resources	capacity_providers_list_only	SELECT	region
get_resource	capacity_providers	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual capacity_provider.

SELECT
  region,
  auto_scaling_group_provider,
  tags,
  name
FROM awscc.ecs.capacity_providers
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ name }}';

list (identifiers only)

Lists all capacity_providers in a region.

SELECT
  region,
  name
FROM awscc.ecs.capacity_providers_list_only
WHERE
  region = '{{ region }}';

INSERT example

Use the following StackQL query and manifest file to create a new capacity_provider resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO awscc.ecs.capacity_providers (
  AutoScalingGroupProvider,
  Tags,
  Name,
  region
)
SELECT
  '{{ auto_scaling_group_provider }}',
  '{{ tags }}',
  '{{ name }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.ecs.capacity_providers (
  AutoScalingGroupProvider,
  Tags,
  Name,
  region
)
SELECT
  '{{ auto_scaling_group_provider }}',
  '{{ tags }}',
  '{{ name }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Manifest

version: 1
name: stack name
description: stack description
providers:
- aws
globals:
- name: region
  value: '{{ vars.AWS_REGION }}'
resources:
- name: capacity_provider
  props:
    - name: auto_scaling_group_provider
      value:
        managed_scaling:
          status: '{{ status }}'
          minimum_scaling_step_size: '{{ minimum_scaling_step_size }}'
          instance_warmup_period: '{{ instance_warmup_period }}'
          target_capacity: '{{ target_capacity }}'
          maximum_scaling_step_size: '{{ maximum_scaling_step_size }}'
        auto_scaling_group_arn: '{{ auto_scaling_group_arn }}'
        managed_termination_protection: '{{ managed_termination_protection }}'
        managed_draining: '{{ managed_draining }}'
    - name: tags
      value:
        - value: '{{ value }}'
          key: '{{ key }}'
    - name: name
      value: '{{ name }}'

UPDATE example

Use the following StackQL query and manifest file to update a capacity_provider resource, using stack-deploy.

/*+ update */
UPDATE awscc.ecs.capacity_providers
SET PatchDocument = string('{{ {
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ name }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.ecs.capacity_providers
WHERE
  Identifier = '{{ name }}' AND
  region = '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Additional Parameters

Mutable resources in the Cloud Control provider support additional optional parameters which can be supplied with INSERT, UPDATE, or DELETE operations. These include:

Parameter	Description
ClientToken	A unique identifier to ensure the idempotency of the resource request. This allows the provider to accurately distinguish between retries and new requests. A client token is valid for 36 hours once used. After that, a resource request with the same client token is treated as a new request. If you do not specify a client token, one is generated for inclusion in the request.
RoleArn	The ARN of the IAM role used to perform this resource operation. The role specified must have the permissions required for this operation. If you do not specify a role, a temporary session is created using your AWS user credentials.
TypeVersionId	For private resource types, the type version to use in this resource operation. If you do not specify a resource version, the default version is used.

Permissions

To operate on the capacity_providers resource, the following permissions are required:

Read

ecs:DescribeCapacityProviders

Create

autoscaling:CreateOrUpdateTags,
ecs:CreateCapacityProvider,
ecs:DescribeCapacityProviders,
ecs:TagResource

Update

ecs:UpdateCapacityProvider,
ecs:DescribeCapacityProviders,
ecs:ListTagsForResource,
ecs:TagResource,
ecs:UntagResource

List

ecs:DescribeCapacityProviders

Delete

ecs:DescribeCapacityProviders,
ecs:DeleteCapacityProvider