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	aws.athena.capacity_reservations

Fields

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.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	Name, TargetDpus, region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all capacity_reservations in a region.

SELECT
region,
arn,
name,
status,
target_dpus,
allocated_dpus,
capacity_assignment_configuration,
creation_time,
last_successful_allocation_time,
tags
FROM aws.athena.capacity_reservations
WHERE region = 'us-east-1';

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 aws.athena.capacity_reservations
WHERE region = 'us-east-1' AND data__Identifier = '<Arn>';

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 aws.athena.capacity_reservations (
 Name,
 TargetDpus,
 region
)
SELECT 
'{{ Name }}',
 '{{ TargetDpus }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.athena.capacity_reservations (
 Name,
 TargetDpus,
 CapacityAssignmentConfiguration,
 Tags,
 region
)
SELECT 
 '{{ Name }}',
 '{{ TargetDpus }}',
 '{{ CapacityAssignmentConfiguration }}',
 '{{ Tags }}',
 '{{ region }}';

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: TargetDpus
        value: '{{ TargetDpus }}'
      - name: CapacityAssignmentConfiguration
        value:
          CapacityAssignments:
            - WorkgroupNames:
                - '{{ WorkgroupNames[0] }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'

DELETE example

/*+ delete */
DELETE FROM aws.athena.capacity_reservations
WHERE data__Identifier = '<Arn>'
AND region = 'us-east-1';

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