reserved_db_instances_offerings

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

Overview

Name	reserved_db_instances_offerings
Type	Resource
Id	aws.rds.reserved_db_instances_offerings

Fields

The following fields are returned by SELECT queries:

describe_reserved_db_instances_offerings

Name	Datatype	Description
currency_code	string	The currency code for the reserved DB instance offering.
db_instance_class	string	The DB instance class for the reserved DB instance.
duration	integer	The duration of the offering in seconds.
fixed_price	number	The fixed price charged for this offering.
multi_az	boolean	Indicates whether the offering applies to Multi-AZ deployments.
offering_type	string	The offering type.
product_description	string	The database engine used by the offering.
recurring_charges	string	The recurring price charged to run this reserved DB instance.
reserved_db_instances_offering_id	string	The offering identifier.
usage_price	number	The hourly price charged for this offering.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_reserved_db_instances_offerings	select	region	ReservedDBInstancesOfferingId, DBInstanceClass, Duration, ProductDescription, OfferingType, MultiAZ, Filters, MaxRecords, Marker	Lists available reserved DB instance offerings.
purchase_reserved_db_instances_offering	exec	ReservedDBInstancesOfferingId, region	ReservedDBInstanceId, DBInstanceCount, Tags	Purchases a reserved DB instance offering.

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
ReservedDBInstancesOfferingId	string	The ID of the Reserved DB instance offering to purchase. Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706
region	string	AWS region (default: us-east-1)
DBInstanceClass	string	The DB instance class filter value. Specify this parameter to show only the available offerings matching the specified DB instance class.
DBInstanceCount	integer	The number of instances to reserve. Default: 1
Duration	string	Duration filter value, specified in years or seconds. Specify this parameter to show only reservations for this duration. Valid Values: 1 | 3 | 31536000 | 94608000
Filters	array	This parameter isn't currently supported.
Marker	string	An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
MaxRecords	integer	The maximum number of records to include in the response. If more than the MaxRecords value is available, a pagination token called a marker is included in the response so you can retrieve the remaining results. Default: 100 Constraints: Minimum 20, maximum 100.
MultiAZ	boolean	Specifies whether to show only those reservations that support Multi-AZ.
OfferingType	string	The offering type filter value. Specify this parameter to show only the available offerings matching the specified offering type. Valid Values: "Partial Upfront" | "All Upfront" | "No Upfront"
ProductDescription	string	Product description filter value. Specify this parameter to show only the available offerings that contain the specified product description. The results show offerings that partially match the filter value.
ReservedDBInstanceId	string	Customer-specified identifier to track this reservation. Example: myreservationID
ReservedDBInstancesOfferingId	string	The offering identifier filter value. Specify this parameter to show only the available offering that matches the specified reservation identifier. Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706
Tags	array

SELECT examples

describe_reserved_db_instances_offerings

Lists available reserved DB instance offerings.

SELECT
currency_code,
db_instance_class,
duration,
fixed_price,
multi_az,
offering_type,
product_description,
recurring_charges,
reserved_db_instances_offering_id,
usage_price
FROM aws.rds.reserved_db_instances_offerings
WHERE region = '{{ region }}' -- required
AND ReservedDBInstancesOfferingId = '{{ ReservedDBInstancesOfferingId }}'
AND DBInstanceClass = '{{ DBInstanceClass }}'
AND Duration = '{{ Duration }}'
AND ProductDescription = '{{ ProductDescription }}'
AND OfferingType = '{{ OfferingType }}'
AND MultiAZ = '{{ MultiAZ }}'
AND Filters = '{{ Filters }}'
AND MaxRecords = '{{ MaxRecords }}'
AND Marker = '{{ Marker }}'
;

Lifecycle Methods

purchase_reserved_db_instances_offering

Purchases a reserved DB instance offering.

EXEC aws.rds.reserved_db_instances_offerings.purchase_reserved_db_instances_offering 
@ReservedDBInstancesOfferingId='{{ ReservedDBInstancesOfferingId }}' --required, 
@region='{{ region }}' --required, 
@ReservedDBInstanceId='{{ ReservedDBInstanceId }}', 
@DBInstanceCount='{{ DBInstanceCount }}', 
@Tags='{{ Tags }}'
;