reserved_db_instances

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

Overview

Name	reserved_db_instances
Type	Resource
Id	aws.rds.reserved_db_instances

Fields

The following fields are returned by SELECT queries:

describe_reserved_db_instances

Name	Datatype	Description
currency_code	string	The currency code for the reserved DB instance.
db_instance_class	string	The DB instance class for the reserved DB instance.
db_instance_count	integer	The number of reserved DB instances.
duration	integer	The duration of the reservation in seconds.
fixed_price	number	The fixed price charged for this reserved DB instance.
lease_id	string	The unique identifier for the lease associated with the reserved DB instance. Amazon Web Services Support might request the lease ID for an issue related to a reserved DB instance.
multi_az	boolean	Indicates whether the reservation applies to Multi-AZ deployments.
offering_type	string	The offering type of this reserved DB instance.
product_description	string	The description of the reserved DB instance.
recurring_charges	string	The recurring price charged to run this reserved DB instance.
reserved_db_instance_arn	string	The Amazon Resource Name (ARN) for the reserved DB instance.
reserved_db_instance_id	string	The unique identifier for the reservation.
reserved_db_instances_offering_id	string	The offering identifier.
start_time	string	The time the reservation started.
state	string	The state of the reserved DB instance.
usage_price	number	The hourly price charged for this reserved DB instance.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_reserved_db_instances	select	region	ReservedDBInstanceId, ReservedDBInstancesOfferingId, DBInstanceClass, Duration, ProductDescription, OfferingType, MultiAZ, LeaseId, Filters, MaxRecords, Marker	Returns information about reserved DB instances for this account, or about a specified reserved DB instance.

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)
DBInstanceClass	string	The DB instance class filter value. Specify this parameter to show only those reservations matching the specified DB instances class.
Duration	string	The 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.
LeaseId	string	The lease identifier filter value. Specify this parameter to show only the reservation that matches the specified lease ID. Amazon Web Services Support might request the lease ID for an issue related to a reserved DB instance.
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	The product description filter value. Specify this parameter to show only those reservations matching the specified product description.
ReservedDBInstanceId	string	The reserved DB instance identifier filter value. Specify this parameter to show only the reservation that matches the specified reservation ID.
ReservedDBInstancesOfferingId	string	The offering identifier filter value. Specify this parameter to show only purchased reservations matching the specified offering identifier.

SELECT examples

describe_reserved_db_instances

Returns information about reserved DB instances for this account, or about a specified reserved DB instance.

SELECT
currency_code,
db_instance_class,
db_instance_count,
duration,
fixed_price,
lease_id,
multi_az,
offering_type,
product_description,
recurring_charges,
reserved_db_instance_arn,
reserved_db_instance_id,
reserved_db_instances_offering_id,
start_time,
state,
usage_price
FROM aws.rds.reserved_db_instances
WHERE region = '{{ region }}' -- required
AND ReservedDBInstanceId = '{{ ReservedDBInstanceId }}'
AND ReservedDBInstancesOfferingId = '{{ ReservedDBInstancesOfferingId }}'
AND DBInstanceClass = '{{ DBInstanceClass }}'
AND Duration = '{{ Duration }}'
AND ProductDescription = '{{ ProductDescription }}'
AND OfferingType = '{{ OfferingType }}'
AND MultiAZ = '{{ MultiAZ }}'
AND LeaseId = '{{ LeaseId }}'
AND Filters = '{{ Filters }}'
AND MaxRecords = '{{ MaxRecords }}'
AND Marker = '{{ Marker }}'
;