aws.savingsplans.SavingsPlan

Timeouts SavingsPlanTimeouts

The unique ID of a Savings Plan offering. You can find available offerings using the aws savingsplans describe-savings-plans-offerings CLI command.

PurchaseTime string

The time at which to purchase the Savings Plan, in UTC format (YYYY-MM-DDTHH:MM:SSZ). If not specified, the plan is purchased immediately. Plans with a future purchase time are placed in queued state and can be deleted before they become active.

Tags Dictionary<string, string>

Map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

The up-front payment amount.

Commitment string

The hourly commitment, in USD. This is the amount you commit to pay per hour, regardless of actual usage.

The following arguments are optional:

Timeouts SavingsPlanTimeoutsArgs

The unique ID of a Savings Plan offering. You can find available offerings using the aws savingsplans describe-savings-plans-offerings CLI command.

PurchaseTime string

Tags map[string]string

Map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

The up-front payment amount.

commitment String

The hourly commitment, in USD. This is the amount you commit to pay per hour, regardless of actual usage.

The following arguments are optional:

The unique ID of a Savings Plan offering. You can find available offerings using the aws savingsplans describe-savings-plans-offerings CLI command.

purchaseTime String

tags Map<String,String>

Map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

The up-front payment amount.

commitment string

The hourly commitment, in USD. This is the amount you commit to pay per hour, regardless of actual usage.

The following arguments are optional:

savingsPlanOfferingId string

The unique ID of a Savings Plan offering. You can find available offerings using the aws savingsplans describe-savings-plans-offerings CLI command.

purchaseTime string

tags {[key: string]: string}

Map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

timeouts SavingsPlanTimeoutsArgs

upfrontPaymentAmount string

The up-front payment amount.

commitment str

The hourly commitment, in USD. This is the amount you commit to pay per hour, regardless of actual usage.

The following arguments are optional:

savings_plan_offering_id str

The unique ID of a Savings Plan offering. You can find available offerings using the aws savingsplans describe-savings-plans-offerings CLI command.

purchase_time str

tags Mapping[str, str]

Map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

upfront_payment_amount str

The up-front payment amount.

commitment String

The hourly commitment, in USD. This is the amount you commit to pay per hour, regardless of actual usage.

The following arguments are optional:

timeouts Property Map

The unique ID of a Savings Plan offering. You can find available offerings using the aws savingsplans describe-savings-plans-offerings CLI command.

purchaseTime String

tags Map<String>

Map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

The up-front payment amount.

Outputs

All input properties are implicitly available as output properties. Additionally, the SavingsPlan resource produces the following output properties:

Currency string: The currency of the Savings Plan (e.g., USD).
Description string: The description.
Ec2InstanceFamily string: The EC2 instance family for the Savings Plan (only applicable to EC2 Instance Savings Plans).
End string: The end time of the Savings Plan in RFC3339 format.
Id string: The provider-assigned unique ID for this managed resource.
OfferingId string: The ID of the offering.
PaymentOption string: The payment option for the Savings Plan (e.g., All Upfront, Partial Upfront, No Upfront).
ProductTypes List<string>: The product types.
RecurringPaymentAmount string: The recurring payment amount.
Region string: The AWS Region.
ReturnableUntil string: The recurring payment amount.
SavingsPlanArn string: The ARN of the Savings Plan.
SavingsPlanId string: The ID of the Savings Plan.
SavingsPlanType string: The type of Savings Plan (e.g., Compute, EC2Instance).
Start string: The start time of the Savings Plan in RFC3339 format.
State string: The current state of the Savings Plan (e.g., active, queued, retired).
TagsAll Dictionary<string, string>: A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
TermDurationInSeconds int: The duration of the term, in seconds.

Currency string: The currency of the Savings Plan (e.g., USD).
Description string: The description.
Ec2InstanceFamily string: The EC2 instance family for the Savings Plan (only applicable to EC2 Instance Savings Plans).
End string: The end time of the Savings Plan in RFC3339 format.
Id string: The provider-assigned unique ID for this managed resource.
OfferingId string: The ID of the offering.
PaymentOption string: The payment option for the Savings Plan (e.g., All Upfront, Partial Upfront, No Upfront).
ProductTypes []string: The product types.
RecurringPaymentAmount string: The recurring payment amount.
Region string: The AWS Region.
ReturnableUntil string: The recurring payment amount.
SavingsPlanArn string: The ARN of the Savings Plan.
SavingsPlanId string: The ID of the Savings Plan.
SavingsPlanType string: The type of Savings Plan (e.g., Compute, EC2Instance).
Start string: The start time of the Savings Plan in RFC3339 format.
State string: The current state of the Savings Plan (e.g., active, queued, retired).
TagsAll map[string]string: A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
TermDurationInSeconds int: The duration of the term, in seconds.

currency String: The currency of the Savings Plan (e.g., USD).
description String: The description.
ec2InstanceFamily String: The EC2 instance family for the Savings Plan (only applicable to EC2 Instance Savings Plans).
end String: The end time of the Savings Plan in RFC3339 format.
id String: The provider-assigned unique ID for this managed resource.
offeringId String: The ID of the offering.
paymentOption String: The payment option for the Savings Plan (e.g., All Upfront, Partial Upfront, No Upfront).
productTypes List<String>: The product types.
recurringPaymentAmount String: The recurring payment amount.
region String: The AWS Region.
returnableUntil String: The recurring payment amount.
savingsPlanArn String: The ARN of the Savings Plan.
savingsPlanId String: The ID of the Savings Plan.
savingsPlanType String: The type of Savings Plan (e.g., Compute, EC2Instance).
start String: The start time of the Savings Plan in RFC3339 format.
state String: The current state of the Savings Plan (e.g., active, queued, retired).
tagsAll Map<String,String>: A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
termDurationInSeconds Integer: The duration of the term, in seconds.

currency string: The currency of the Savings Plan (e.g., USD).
description string: The description.
ec2InstanceFamily string: The EC2 instance family for the Savings Plan (only applicable to EC2 Instance Savings Plans).
end string: The end time of the Savings Plan in RFC3339 format.
id string: The provider-assigned unique ID for this managed resource.
offeringId string: The ID of the offering.
paymentOption string: The payment option for the Savings Plan (e.g., All Upfront, Partial Upfront, No Upfront).
productTypes string[]: The product types.
recurringPaymentAmount string: The recurring payment amount.
region string: The AWS Region.
returnableUntil string: The recurring payment amount.
savingsPlanArn string: The ARN of the Savings Plan.
savingsPlanId string: The ID of the Savings Plan.
savingsPlanType string: The type of Savings Plan (e.g., Compute, EC2Instance).
start string: The start time of the Savings Plan in RFC3339 format.
state string: The current state of the Savings Plan (e.g., active, queued, retired).
tagsAll {[key: string]: string}: A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
termDurationInSeconds number: The duration of the term, in seconds.

currency str: The currency of the Savings Plan (e.g., USD).
description str: The description.
ec2_instance_family str: The EC2 instance family for the Savings Plan (only applicable to EC2 Instance Savings Plans).
end str: The end time of the Savings Plan in RFC3339 format.
id str: The provider-assigned unique ID for this managed resource.
offering_id str: The ID of the offering.
payment_option str: The payment option for the Savings Plan (e.g., All Upfront, Partial Upfront, No Upfront).
product_types Sequence[str]: The product types.
recurring_payment_amount str: The recurring payment amount.
region str: The AWS Region.
returnable_until str: The recurring payment amount.
savings_plan_arn str: The ARN of the Savings Plan.
savings_plan_id str: The ID of the Savings Plan.
savings_plan_type str: The type of Savings Plan (e.g., Compute, EC2Instance).
start str: The start time of the Savings Plan in RFC3339 format.
state str: The current state of the Savings Plan (e.g., active, queued, retired).
tags_all Mapping[str, str]: A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
term_duration_in_seconds int: The duration of the term, in seconds.

currency String: The currency of the Savings Plan (e.g., USD).
description String: The description.
ec2InstanceFamily String: The EC2 instance family for the Savings Plan (only applicable to EC2 Instance Savings Plans).
end String: The end time of the Savings Plan in RFC3339 format.
id String: The provider-assigned unique ID for this managed resource.
offeringId String: The ID of the offering.
paymentOption String: The payment option for the Savings Plan (e.g., All Upfront, Partial Upfront, No Upfront).
productTypes List<String>: The product types.
recurringPaymentAmount String: The recurring payment amount.
region String: The AWS Region.
returnableUntil String: The recurring payment amount.
savingsPlanArn String: The ARN of the Savings Plan.
savingsPlanId String: The ID of the Savings Plan.
savingsPlanType String: The type of Savings Plan (e.g., Compute, EC2Instance).
start String: The start time of the Savings Plan in RFC3339 format.
state String: The current state of the Savings Plan (e.g., active, queued, retired).
tagsAll Map<String>: A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
termDurationInSeconds Number: The duration of the term, in seconds.

Look up Existing SavingsPlan Resource

Get an existing SavingsPlan resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: SavingsPlanState, opts?: CustomResourceOptions): SavingsPlan

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        commitment: Optional[str] = None,
        currency: Optional[str] = None,
        description: Optional[str] = None,
        ec2_instance_family: Optional[str] = None,
        end: Optional[str] = None,
        offering_id: Optional[str] = None,
        payment_option: Optional[str] = None,
        product_types: Optional[Sequence[str]] = None,
        purchase_time: Optional[str] = None,
        recurring_payment_amount: Optional[str] = None,
        region: Optional[str] = None,
        returnable_until: Optional[str] = None,
        savings_plan_arn: Optional[str] = None,
        savings_plan_id: Optional[str] = None,
        savings_plan_offering_id: Optional[str] = None,
        savings_plan_type: Optional[str] = None,
        start: Optional[str] = None,
        state: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = None,
        term_duration_in_seconds: Optional[int] = None,
        timeouts: Optional[SavingsPlanTimeoutsArgs] = None,
        upfront_payment_amount: Optional[str] = None) -> SavingsPlan

func GetSavingsPlan(ctx *Context, name string, id IDInput, state *SavingsPlanState, opts ...ResourceOption) (*SavingsPlan, error)

public static SavingsPlan Get(string name, Input<string> id, SavingsPlanState? state, CustomResourceOptions? opts = null)

public static SavingsPlan get(String name, Output<String> id, SavingsPlanState state, CustomResourceOptions options)

resources:  _:    type: aws:savingsplans:SavingsPlan    get:      id: ${id}

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

Commitment string

The hourly commitment, in USD. This is the amount you commit to pay per hour, regardless of actual usage.

The following arguments are optional:

Currency string

The currency of the Savings Plan (e.g., USD).

Description string

The description.

Ec2InstanceFamily string

The EC2 instance family for the Savings Plan (only applicable to EC2 Instance Savings Plans).

End string

The end time of the Savings Plan in RFC3339 format.

OfferingId string

The ID of the offering.

PaymentOption string

The payment option for the Savings Plan (e.g., All Upfront, Partial Upfront, No Upfront).

ProductTypes List<string>

The product types.

PurchaseTime string

RecurringPaymentAmount string

The recurring payment amount.

Region string

The AWS Region.

ReturnableUntil string

The recurring payment amount.

SavingsPlanArn string

The ARN of the Savings Plan.

SavingsPlanId string

The ID of the Savings Plan.

Timeouts SavingsPlanTimeouts

The unique ID of a Savings Plan offering. You can find available offerings using the aws savingsplans describe-savings-plans-offerings CLI command.

SavingsPlanType string

The type of Savings Plan (e.g., Compute, EC2Instance).

Start string

The start time of the Savings Plan in RFC3339 format.

State string

The current state of the Savings Plan (e.g., active, queued, retired).

Tags Dictionary<string, string>

Map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

TagsAll Dictionary<string, string>

A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

TermDurationInSeconds int

The duration of the term, in seconds.

The up-front payment amount.

Commitment string

The hourly commitment, in USD. This is the amount you commit to pay per hour, regardless of actual usage.

The following arguments are optional:

Currency string

The currency of the Savings Plan (e.g., USD).

Description string

The description.

Ec2InstanceFamily string

The EC2 instance family for the Savings Plan (only applicable to EC2 Instance Savings Plans).

End string

The end time of the Savings Plan in RFC3339 format.

OfferingId string

The ID of the offering.

PaymentOption string

The payment option for the Savings Plan (e.g., All Upfront, Partial Upfront, No Upfront).

ProductTypes []string

The product types.

PurchaseTime string

RecurringPaymentAmount string

The recurring payment amount.

Region string

The AWS Region.

ReturnableUntil string

The recurring payment amount.

SavingsPlanArn string

The ARN of the Savings Plan.

SavingsPlanId string

The ID of the Savings Plan.

Timeouts SavingsPlanTimeoutsArgs

The unique ID of a Savings Plan offering. You can find available offerings using the aws savingsplans describe-savings-plans-offerings CLI command.

SavingsPlanType string

The type of Savings Plan (e.g., Compute, EC2Instance).

Start string

The start time of the Savings Plan in RFC3339 format.

State string

The current state of the Savings Plan (e.g., active, queued, retired).

Tags map[string]string

Map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

TagsAll map[string]string

A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

TermDurationInSeconds int

The duration of the term, in seconds.

The up-front payment amount.

commitment String

The hourly commitment, in USD. This is the amount you commit to pay per hour, regardless of actual usage.

The following arguments are optional:

currency String

The currency of the Savings Plan (e.g., USD).

description String

The description.

ec2InstanceFamily String

The EC2 instance family for the Savings Plan (only applicable to EC2 Instance Savings Plans).

end String

The end time of the Savings Plan in RFC3339 format.

offeringId String

The ID of the offering.

paymentOption String

The payment option for the Savings Plan (e.g., All Upfront, Partial Upfront, No Upfront).

productTypes List<String>

The product types.

purchaseTime String

recurringPaymentAmount String

The recurring payment amount.

region String

The AWS Region.

returnableUntil String

The recurring payment amount.

savingsPlanArn String

The ARN of the Savings Plan.

savingsPlanId String

The ID of the Savings Plan.

The unique ID of a Savings Plan offering. You can find available offerings using the aws savingsplans describe-savings-plans-offerings CLI command.

savingsPlanType String

The type of Savings Plan (e.g., Compute, EC2Instance).

start String

The start time of the Savings Plan in RFC3339 format.

state String

The current state of the Savings Plan (e.g., active, queued, retired).

tags Map<String,String>

Map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

tagsAll Map<String,String>

A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

termDurationInSeconds Integer

The duration of the term, in seconds.

The up-front payment amount.

commitment string

The hourly commitment, in USD. This is the amount you commit to pay per hour, regardless of actual usage.

The following arguments are optional:

currency string

The currency of the Savings Plan (e.g., USD).

description string

The description.

ec2InstanceFamily string

The EC2 instance family for the Savings Plan (only applicable to EC2 Instance Savings Plans).

end string

The end time of the Savings Plan in RFC3339 format.

offeringId string

The ID of the offering.

paymentOption string

The payment option for the Savings Plan (e.g., All Upfront, Partial Upfront, No Upfront).

productTypes string[]

The product types.

purchaseTime string

recurringPaymentAmount string

The recurring payment amount.

region string

The AWS Region.

returnableUntil string

The recurring payment amount.

savingsPlanArn string

The ARN of the Savings Plan.

savingsPlanId string

The ID of the Savings Plan.

savingsPlanOfferingId string

The unique ID of a Savings Plan offering. You can find available offerings using the aws savingsplans describe-savings-plans-offerings CLI command.

savingsPlanType string

The type of Savings Plan (e.g., Compute, EC2Instance).

start string

The start time of the Savings Plan in RFC3339 format.

state string

The current state of the Savings Plan (e.g., active, queued, retired).

tags {[key: string]: string}

Map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

tagsAll {[key: string]: string}

A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

termDurationInSeconds number

The duration of the term, in seconds.

timeouts SavingsPlanTimeoutsArgs

upfrontPaymentAmount string

The up-front payment amount.

commitment str

The hourly commitment, in USD. This is the amount you commit to pay per hour, regardless of actual usage.

The following arguments are optional:

currency str

The currency of the Savings Plan (e.g., USD).

description str

The description.

ec2_instance_family str

The EC2 instance family for the Savings Plan (only applicable to EC2 Instance Savings Plans).

end str

The end time of the Savings Plan in RFC3339 format.

offering_id str

The ID of the offering.

payment_option str

The payment option for the Savings Plan (e.g., All Upfront, Partial Upfront, No Upfront).

product_types Sequence[str]

The product types.

purchase_time str

recurring_payment_amount str

The recurring payment amount.

region str

The AWS Region.

returnable_until str

The recurring payment amount.

savings_plan_arn str

The ARN of the Savings Plan.

savings_plan_id str

The ID of the Savings Plan.

savings_plan_offering_id str

The unique ID of a Savings Plan offering. You can find available offerings using the aws savingsplans describe-savings-plans-offerings CLI command.

savings_plan_type str

The type of Savings Plan (e.g., Compute, EC2Instance).

start str

The start time of the Savings Plan in RFC3339 format.

state str

The current state of the Savings Plan (e.g., active, queued, retired).

tags Mapping[str, str]

Map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

tags_all Mapping[str, str]

A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

term_duration_in_seconds int

The duration of the term, in seconds.

upfront_payment_amount str

The up-front payment amount.

commitment String

The hourly commitment, in USD. This is the amount you commit to pay per hour, regardless of actual usage.

The following arguments are optional:

currency String

The currency of the Savings Plan (e.g., USD).

description String

The description.

ec2InstanceFamily String

The EC2 instance family for the Savings Plan (only applicable to EC2 Instance Savings Plans).

end String

The end time of the Savings Plan in RFC3339 format.

offeringId String

The ID of the offering.

paymentOption String

The payment option for the Savings Plan (e.g., All Upfront, Partial Upfront, No Upfront).

productTypes List<String>

The product types.

purchaseTime String

recurringPaymentAmount String

The recurring payment amount.

region String

The AWS Region.

returnableUntil String

The recurring payment amount.

savingsPlanArn String

The ARN of the Savings Plan.

savingsPlanId String

The ID of the Savings Plan.

timeouts Property Map

The unique ID of a Savings Plan offering. You can find available offerings using the aws savingsplans describe-savings-plans-offerings CLI command.

savingsPlanType String

The type of Savings Plan (e.g., Compute, EC2Instance).

start String

The start time of the Savings Plan in RFC3339 format.

state String

The current state of the Savings Plan (e.g., active, queued, retired).

tags Map<String>

Map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

tagsAll Map<String>

A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

termDurationInSeconds Number

The duration of the term, in seconds.