capacity_reservations

Creates, updates, deletes or gets a capacity_reservation resource or lists capacity_reservations in a region

Overview

Name	capacity_reservations
Type	Resource
Description	Resource schema for AWS::Athena::CapacityReservation
Id	awscc.athena.capacity_reservations

Fields

get (all properties)

Name	Datatype	Description
arn	string	The Amazon Resource Name (ARN) of the specified capacity reservation
name	string	The reservation name.
status	string	The status of the reservation.
target_dpus	integer	The number of DPUs to request to be allocated to the reservation.
allocated_dpus	integer	The number of DPUs Athena has provisioned and allocated for the reservation
▶capacity_assignment_configuration	object	Assignment configuration to assign workgroups to a reservation
creation_time	string	The date and time the reservation was created.
last_successful_allocation_time	string	The timestamp when the last successful allocated was made
▶tags	array	An array of key-value pairs to apply to this resource.
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
arn	string	The Amazon Resource Name (ARN) of the specified capacity reservation
region	string	AWS region.

For more information, see AWS::Athena::CapacityReservation.

Methods

Name	Resource	Accessible by	Required Params
create_resource	capacity_reservations	INSERT	Name, TargetDpus, region
delete_resource	capacity_reservations	DELETE	Identifier, region
update_resource	capacity_reservations	UPDATE	Identifier, PatchDocument, region
list_resources	capacity_reservations_list_only	SELECT	region
get_resource	capacity_reservations	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual capacity_reservation.

SELECT
  region,
  arn,
  name,
  status,
  target_dpus,
  allocated_dpus,
  capacity_assignment_configuration,
  creation_time,
  last_successful_allocation_time,
  tags
FROM awscc.athena.capacity_reservations
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ arn }}';

list (identifiers only)

Lists all capacity_reservations in a region.

SELECT
  region,
  arn
FROM awscc.athena.capacity_reservations_list_only
WHERE
  region = '{{ region }}';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.athena.capacity_reservations (
  Name,
  TargetDpus,
  region
)
SELECT
  '{{ name }}',
  '{{ target_dpus }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.athena.capacity_reservations (
  Name,
  TargetDpus,
  CapacityAssignmentConfiguration,
  Tags,
  region
)
SELECT
  '{{ name }}',
  '{{ target_dpus }}',
  '{{ capacity_assignment_configuration }}',
  '{{ tags }}',
  '{{ 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_reservation
  props:
    - name: name
      value: '{{ name }}'
    - name: target_dpus
      value: '{{ target_dpus }}'
    - name: capacity_assignment_configuration
      value:
        capacity_assignments:
          - workgroup_names:
              - '{{ workgroup_names[0] }}'
    - name: tags
      value:
        - key: '{{ key }}'
          value: '{{ value }}'

UPDATE example

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

/*+ update */
UPDATE awscc.athena.capacity_reservations
SET PatchDocument = string('{{ {
    "TargetDpus": target_dpus,
    "CapacityAssignmentConfiguration": capacity_assignment_configuration,
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ arn }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.athena.capacity_reservations
WHERE
  Identifier = '{{ arn }}' 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_reservations resource, the following permissions are required:

Create

athena:CreateCapacityReservation,
athena:PutCapacityAssignmentConfiguration,
athena:GetCapacityReservation,
athena:TagResource

Read

athena:GetCapacityReservation,
athena:GetCapacityAssignmentConfiguration,
athena:ListTagsForResource

Update

athena:UpdateCapacityReservation,
athena:PutCapacityAssignmentConfiguration,
athena:GetCapacityReservation,
athena:TagResource,
athena:UntagResource

Delete

athena:CancelCapacityReservation,
athena:GetCapacityReservation,
athena:DeleteCapacityReservation

List

athena:ListCapacityReservations,
athena:GetCapacityReservation