savings_plans

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

Overview

Name	savings_plans
Type	Resource
Id	aws.savingsplans.savings_plans

Fields

The following fields are returned by SELECT queries:

describe_savings_plans

Name	Datatype	Description
next_token	string	The token to use to retrieve the next page of results. This value is null when there are no more results to return. (pattern: <code>^[A-Za-z0-9/=+]+$</code>)
savings_plans	array	Information about the Savings Plans.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_savings_plans	select	region		Describes the specified Savings Plans.
create_savings_plan	insert	region, savingsPlanOfferingId, commitment		Creates a Savings Plan.
delete_queued_savings_plan	delete	region		Deletes the queued purchase for the specified Savings Plan.
return_savings_plan	exec	region, savingsPlanId		Returns the specified Savings Plan.

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

describe_savings_plans

Describes the specified Savings Plans.

SELECT
next_token,
savings_plans
FROM aws.savingsplans.savings_plans
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_savings_plan

Creates a Savings Plan.

INSERT INTO aws.savingsplans.savings_plans (
savingsPlanOfferingId,
commitment,
upfrontPaymentAmount,
purchaseTime,
clientToken,
tags,
region
)
SELECT 
'{{ savingsPlanOfferingId }}' /* required */,
'{{ commitment }}' /* required */,
'{{ upfrontPaymentAmount }}',
'{{ purchaseTime }}',
'{{ clientToken }}',
'{{ tags }}',
'{{ region }}'
RETURNING
savings_plan_id
;

Manifest

# Description fields are for documentation purposes
- name: savings_plans
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the savings_plans resource.
  - name: savingsPlanOfferingId
    value: "{{ savingsPlanOfferingId }}"
  - name: commitment
    value: "{{ commitment }}"
  - name: upfrontPaymentAmount
    value: "{{ upfrontPaymentAmount }}"
  - name: purchaseTime
    value: "{{ purchaseTime }}"
  - name: clientToken
    value: "{{ clientToken }}"
  - name: tags
    value: "{{ tags }}"

DELETE examples

delete_queued_savings_plan

Deletes the queued purchase for the specified Savings Plan.

DELETE FROM aws.savingsplans.savings_plans
WHERE region = '{{ region }}' --required
;

Lifecycle Methods

return_savings_plan

Returns the specified Savings Plan.

EXEC aws.savingsplans.savings_plans.return_savings_plan 
@region='{{ region }}' --required 
@@json=
'{
"savingsPlanId": "{{ savingsPlanId }}", 
"clientToken": "{{ clientToken }}"
}'
;