reservations

Creates, updates, deletes, gets or lists a reservations resource.

Overview

Name	reservations
Type	Resource
Id	aws.redshift_serverless.reservations

Fields

The following fields are returned by SELECT queries:

get_reservation

Name	Datatype	Description
capacity	integer	The number of Redshift Processing Units (RPUs) to reserve.
end_date	string (date-time)	The end date for the serverless reservation. This date is one year after the start date that you specify.
offering	object	The type of offering for the reservation. The offering class determines the payment schedule for the reservation.
reservation_arn	string	The Amazon Resource Name (ARN) that uniquely identifies the serverless reservation.
reservation_id	string	The identifier that uniquely identifies the serverless reservation.
start_date	string (date-time)	The start date for the serverless reservation. This is the date you created the reservation.
status	string	The status of the reservation. Possible values include the following: payment-pending active payment-failed retired

list_reservations

Name	Datatype	Description
capacity	integer	The number of Redshift Processing Units (RPUs) to reserve.
end_date	string (date-time)	The end date for the serverless reservation. This date is one year after the start date that you specify.
offering	object	The type of offering for the reservation. The offering class determines the payment schedule for the reservation.
reservation_arn	string	The Amazon Resource Name (ARN) that uniquely identifies the serverless reservation.
reservation_id	string	The identifier that uniquely identifies the serverless reservation.
start_date	string (date-time)	The start date for the serverless reservation. This is the date you created the reservation.
status	string	The status of the reservation. Possible values include the following: payment-pending active payment-failed retired

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_reservation	select	region		Gets an Amazon Redshift Serverless reservation. A reservation gives you the option to commit to a specified number of Redshift Processing Units (RPUs) for a year at a discount from Serverless on-demand (OD) rates.
list_reservations	select	region		Returns a list of Reservation objects.
create_reservation	insert	region, capacity, offeringId		Creates an Amazon Redshift Serverless reservation, which gives you the option to commit to a specified number of Redshift Processing Units (RPUs) for a year at a discount from Serverless on-demand (OD) rates.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

get_reservation

Gets an Amazon Redshift Serverless reservation. A reservation gives you the option to commit to a specified number of Redshift Processing Units (RPUs) for a year at a discount from Serverless on-demand (OD) rates.

SELECT
capacity,
end_date,
offering,
reservation_arn,
reservation_id,
start_date,
status
FROM aws.redshift_serverless.reservations
WHERE region = '{{ region }}' -- required
;

list_reservations

Returns a list of Reservation objects.

SELECT
capacity,
end_date,
offering,
reservation_arn,
reservation_id,
start_date,
status
FROM aws.redshift_serverless.reservations
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_reservation

Creates an Amazon Redshift Serverless reservation, which gives you the option to commit to a specified number of Redshift Processing Units (RPUs) for a year at a discount from Serverless on-demand (OD) rates.

INSERT INTO aws.redshift_serverless.reservations (
capacity,
clientToken,
offeringId,
region
)
SELECT 
{{ capacity }} /* required */,
'{{ clientToken }}',
'{{ offeringId }}' /* required */,
'{{ region }}'
RETURNING
reservation
;

Manifest

# Description fields are for documentation purposes
- name: reservations
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the reservations resource.
  - name: capacity
    value: {{ capacity }}
    description: |
      The number of Redshift Processing Units (RPUs) to reserve.
  - name: clientToken
    value: "{{ clientToken }}"
    description: |
      A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. This token must be a valid UUIDv4 value. For more information about idempotency, see Making retries safe with idempotent APIs .
  - name: offeringId
    value: "{{ offeringId }}"
    description: |
      The ID of the offering associated with the reservation. The offering determines the payment schedule for the reservation.