reserved_node_offerings
Creates, updates, deletes, gets or lists a reserved_node_offerings resource.
Overview
| Name | reserved_node_offerings |
| Type | Resource |
| Id | aws.redshift.reserved_node_offerings |
Fields
The following fields are returned by SELECT queries:
- describe_reserved_node_offerings
| Name | Datatype | Description |
|---|---|---|
currency_code | string | The currency code for the compute nodes offering. |
duration | integer | The duration, in seconds, for which the offering will reserve the node. |
fixed_price | number | The upfront fixed charge you will pay to purchase the specific reserved node offering. |
node_type | string | The node type offered by the reserved node offering. |
offering_type | string | The anticipated utilization of the reserved node, as defined in the reserved node offering. |
recurring_charges | string | The charge to your account regardless of whether you are creating any clusters using the node offering. Recurring charges are only in effect for heavy-utilization reserved nodes. |
reserved_node_offering_id | string | The offering identifier. |
reserved_node_offering_type | string | |
usage_price | number | The rate you are charged for each hour the cluster that is using the offering is running. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
describe_reserved_node_offerings | select | region | ReservedNodeOfferingId, MaxRecords, Marker | Returns a list of the available reserved node offerings by Amazon Redshift with their descriptions including the node type, the fixed and recurring costs of reserving the node and duration the node will be reserved for you. These descriptions help you determine which reserve node offering you want to purchase. You then use the unique offering ID in you call to PurchaseReservedNodeOffering to reserve one or more nodes for your Amazon Redshift cluster. For more information about reserved node offerings, go to Purchasing Reserved Nodes in the Amazon Redshift Cluster Management Guide. |
purchase_reserved_node_offering | exec | ReservedNodeOfferingId, region | NodeCount | Allows you to purchase reserved nodes. Amazon Redshift offers a predefined set of reserved node offerings. You can purchase one or more of the offerings. You can call the DescribeReservedNodeOfferings API to obtain the available reserved node offerings. You can call this API by providing a specific reserved node offering and the number of nodes you want to reserve. For more information about reserved node offerings, go to Purchasing Reserved Nodes in the Amazon Redshift Cluster Management Guide. |
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 |
|---|---|---|
ReservedNodeOfferingId | string | The unique identifier of the reserved node offering you want to purchase. |
region | string | AWS region (default: us-east-1) |
Marker | string | An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeReservedNodeOfferings request exceed the value specified in MaxRecords, Amazon Web Services returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request. |
MaxRecords | integer | The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value. Default: 100 Constraints: minimum 20, maximum 100. |
NodeCount | integer | The number of reserved nodes that you want to purchase. Default: 1 |
ReservedNodeOfferingId | string | The unique identifier for the offering. |
SELECT examples
- describe_reserved_node_offerings
Returns a list of the available reserved node offerings by Amazon Redshift with their descriptions including the node type, the fixed and recurring costs of reserving the node and duration the node will be reserved for you. These descriptions help you determine which reserve node offering you want to purchase. You then use the unique offering ID in you call to PurchaseReservedNodeOffering to reserve one or more nodes for your Amazon Redshift cluster. For more information about reserved node offerings, go to Purchasing Reserved Nodes in the Amazon Redshift Cluster Management Guide.
SELECT
currency_code,
duration,
fixed_price,
node_type,
offering_type,
recurring_charges,
reserved_node_offering_id,
reserved_node_offering_type,
usage_price
FROM aws.redshift.reserved_node_offerings
WHERE region = '{{ region }}' -- required
AND ReservedNodeOfferingId = '{{ ReservedNodeOfferingId }}'
AND MaxRecords = '{{ MaxRecords }}'
AND Marker = '{{ Marker }}'
;
Lifecycle Methods
- purchase_reserved_node_offering
Allows you to purchase reserved nodes. Amazon Redshift offers a predefined set of reserved node offerings. You can purchase one or more of the offerings. You can call the DescribeReservedNodeOfferings API to obtain the available reserved node offerings. You can call this API by providing a specific reserved node offering and the number of nodes you want to reserve. For more information about reserved node offerings, go to Purchasing Reserved Nodes in the Amazon Redshift Cluster Management Guide.
EXEC aws.redshift.reserved_node_offerings.purchase_reserved_node_offering
@ReservedNodeOfferingId='{{ ReservedNodeOfferingId }}' --required,
@region='{{ region }}' --required,
@NodeCount='{{ NodeCount }}'
;