AWS::Athena::CapacityReservation

Specifies a capacity reservation with the provided name and number of requested data processing units.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::Athena::CapacityReservation",
  "Properties" : {
      "CapacityAssignmentConfiguration" : CapacityAssignmentConfiguration,
      "Name" : String,
      "Tags" : [ Tag, ... ],
      "TargetDpus" : Integer
    }
}

YAML

Type: AWS::Athena::CapacityReservation
Properties:
  CapacityAssignmentConfiguration: 
    CapacityAssignmentConfiguration
  Name: String
  Tags: 
    - Tag
  TargetDpus: Integer

Properties

CapacityAssignmentConfiguration

Assigns Athena workgroups (and hence their queries) to capacity reservations. A capacity reservation can have only one capacity assignment configuration, but the capacity assignment configuration can be made up of multiple individual assignments. Each assignment specifies how Athena queries can consume capacity from the capacity reservation that their workgroup is mapped to.

Required: No

Type: CapacityAssignmentConfiguration

Update requires: No interruption

Name

The name of the capacity reservation.

Required: Yes

Type: String

Pattern: [a-zA-Z0-9._-]{1,128}

Update requires: Replacement

Tags

An array of key-value pairs to apply to the capacity reservation.

For more information, see Tag.

Required: No

Type: Array of Tag

Update requires: No interruption

TargetDpus

The number of data processing units requested.

Required: Yes

Type: Integer

Minimum: 1

Update requires: No interruption

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the ARN of the capacity reservation.

For more information about using the Ref function, see Ref.

Fn::GetAtt

The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.

AllocatedDpus

The number of data processing units currently allocated.

Arn

The ARN of the capacity reservation.

CreationTime

The time in UTC epoch millis when the capacity reservation was created.

LastSuccessfulAllocationTime

The time of the most recent capacity allocation that succeeded.

Status

The status of the capacity reservation.