Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. rds
  5. ReservedInstance
AWS v6.76.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-aws

aws.rds.ReservedInstance

Explore with Pulumi AI

AWS v6.76.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-aws

Manages an RDS DB Reserved Instance.

NOTE: Once created, a reservation is valid for the duration of the provided offering_id and cannot be deleted. Performing a destroy will only remove the resource from state. For more information see RDS Reserved Instances Documentation and PurchaseReservedDBInstancesOffering.

NOTE: Due to the expense of testing this resource, we provide it as best effort. If you find it useful, and have the ability to help test or notice issues, consider reaching out to us on GitHub.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const test = aws.rds.getReservedInstanceOffering({
    dbInstanceClass: "db.t2.micro",
    duration: 31536000,
    multiAz: false,
    offeringType: "All Upfront",
    productDescription: "mysql",
});
const example = new aws.rds.ReservedInstance("example", {
    offeringId: test.then(test => test.offeringId),
    reservationId: "optionalCustomReservationID",
    instanceCount: 3,
});
Copy
import pulumi
import pulumi_aws as aws

test = aws.rds.get_reserved_instance_offering(db_instance_class="db.t2.micro",
    duration=31536000,
    multi_az=False,
    offering_type="All Upfront",
    product_description="mysql")
example = aws.rds.ReservedInstance("example",
    offering_id=test.offering_id,
    reservation_id="optionalCustomReservationID",
    instance_count=3)
Copy
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/rds"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		test, err := rds.GetReservedInstanceOffering(ctx, &rds.GetReservedInstanceOfferingArgs{
			DbInstanceClass:    "db.t2.micro",
			Duration:           31536000,
			MultiAz:            false,
			OfferingType:       "All Upfront",
			ProductDescription: "mysql",
		}, nil)
		if err != nil {
			return err
		}
		_, err = rds.NewReservedInstance(ctx, "example", &rds.ReservedInstanceArgs{
			OfferingId:    pulumi.String(test.OfferingId),
			ReservationId: pulumi.String("optionalCustomReservationID"),
			InstanceCount: pulumi.Int(3),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var test = Aws.Rds.GetReservedInstanceOffering.Invoke(new()
    {
        DbInstanceClass = "db.t2.micro",
        Duration = 31536000,
        MultiAz = false,
        OfferingType = "All Upfront",
        ProductDescription = "mysql",
    });

    var example = new Aws.Rds.ReservedInstance("example", new()
    {
        OfferingId = test.Apply(getReservedInstanceOfferingResult => getReservedInstanceOfferingResult.OfferingId),
        ReservationId = "optionalCustomReservationID",
        InstanceCount = 3,
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.rds.RdsFunctions;
import com.pulumi.aws.rds.inputs.GetReservedInstanceOfferingArgs;
import com.pulumi.aws.rds.ReservedInstance;
import com.pulumi.aws.rds.ReservedInstanceArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var test = RdsFunctions.getReservedInstanceOffering(GetReservedInstanceOfferingArgs.builder()
            .dbInstanceClass("db.t2.micro")
            .duration(31536000)
            .multiAz(false)
            .offeringType("All Upfront")
            .productDescription("mysql")
            .build());

        var example = new ReservedInstance("example", ReservedInstanceArgs.builder()
            .offeringId(test.applyValue(getReservedInstanceOfferingResult -> getReservedInstanceOfferingResult.offeringId()))
            .reservationId("optionalCustomReservationID")
            .instanceCount(3)
            .build());

    }
}
Copy
resources:
  example:
    type: aws:rds:ReservedInstance
    properties:
      offeringId: ${test.offeringId}
      reservationId: optionalCustomReservationID
      instanceCount: 3
variables:
  test:
    fn::invoke:
      function: aws:rds:getReservedInstanceOffering
      arguments:
        dbInstanceClass: db.t2.micro
        duration: 3.1536e+07
        multiAz: false
        offeringType: All Upfront
        productDescription: mysql
Copy

Create ReservedInstance Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new ReservedInstance(name: string, args: ReservedInstanceArgs, opts?: CustomResourceOptions);
@overload
def ReservedInstance(resource_name: str,
                     args: ReservedInstanceArgs,
                     opts: Optional[ResourceOptions] = None)

@overload
def ReservedInstance(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     offering_id: Optional[str] = None,
                     instance_count: Optional[int] = None,
                     reservation_id: Optional[str] = None,
                     tags: Optional[Mapping[str, str]] = None)
func NewReservedInstance(ctx *Context, name string, args ReservedInstanceArgs, opts ...ResourceOption) (*ReservedInstance, error)
public ReservedInstance(string name, ReservedInstanceArgs args, CustomResourceOptions? opts = null)
public ReservedInstance(String name, ReservedInstanceArgs args)
public ReservedInstance(String name, ReservedInstanceArgs args, CustomResourceOptions options)

type: aws:rds:ReservedInstance
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. ReservedInstanceArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. ReservedInstanceArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. ReservedInstanceArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. ReservedInstanceArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. ReservedInstanceArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var reservedInstanceResource = new Aws.Rds.ReservedInstance("reservedInstanceResource", new()
{
    OfferingId = "string",
    InstanceCount = 0,
    ReservationId = "string",
    Tags = 
    {
        { "string", "string" },
    },
});
Copy
example, err := rds.NewReservedInstance(ctx, "reservedInstanceResource", &rds.ReservedInstanceArgs{
	OfferingId:    pulumi.String("string"),
	InstanceCount: pulumi.Int(0),
	ReservationId: pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})
Copy
var reservedInstanceResource = new ReservedInstance("reservedInstanceResource", ReservedInstanceArgs.builder()
    .offeringId("string")
    .instanceCount(0)
    .reservationId("string")
    .tags(Map.of("string", "string"))
    .build());
Copy
reserved_instance_resource = aws.rds.ReservedInstance("reservedInstanceResource",
    offering_id="string",
    instance_count=0,
    reservation_id="string",
    tags={
        "string": "string",
    })
Copy
const reservedInstanceResource = new aws.rds.ReservedInstance("reservedInstanceResource", {
    offeringId: "string",
    instanceCount: 0,
    reservationId: "string",
    tags: {
        string: "string",
    },
});
Copy
type: aws:rds:ReservedInstance
properties:
    instanceCount: 0
    offeringId: string
    reservationId: string
    tags:
        string: string
Copy

ReservedInstance Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The ReservedInstance resource accepts the following input properties:

OfferingId
This property is required.
Changes to this property will trigger replacement.
string

ID of the Reserved DB instance offering to purchase. To determine an offering_id, see the aws.rds.getReservedInstanceOffering data source.

The following arguments are optional:

InstanceCount Changes to this property will trigger replacement. int
Number of instances to reserve. Default value is 1.
ReservationId Changes to this property will trigger replacement. string
Customer-specified identifier to track this reservation.
Tags Dictionary<string, string>
Map of tags to assign to the DB reservation. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
OfferingId
This property is required.
Changes to this property will trigger replacement.
string

ID of the Reserved DB instance offering to purchase. To determine an offering_id, see the aws.rds.getReservedInstanceOffering data source.

The following arguments are optional:

InstanceCount Changes to this property will trigger replacement. int
Number of instances to reserve. Default value is 1.
ReservationId Changes to this property will trigger replacement. string
Customer-specified identifier to track this reservation.
Tags map[string]string
Map of tags to assign to the DB reservation. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
offeringId
This property is required.
Changes to this property will trigger replacement.
String

ID of the Reserved DB instance offering to purchase. To determine an offering_id, see the aws.rds.getReservedInstanceOffering data source.

The following arguments are optional:

instanceCount Changes to this property will trigger replacement. Integer
Number of instances to reserve. Default value is 1.
reservationId Changes to this property will trigger replacement. String
Customer-specified identifier to track this reservation.
tags Map<String,String>
Map of tags to assign to the DB reservation. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
offeringId
This property is required.
Changes to this property will trigger replacement.
string

ID of the Reserved DB instance offering to purchase. To determine an offering_id, see the aws.rds.getReservedInstanceOffering data source.

The following arguments are optional:

instanceCount Changes to this property will trigger replacement. number
Number of instances to reserve. Default value is 1.
reservationId Changes to this property will trigger replacement. string
Customer-specified identifier to track this reservation.
tags {[key: string]: string}
Map of tags to assign to the DB reservation. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
offering_id
This property is required.
Changes to this property will trigger replacement.
str

ID of the Reserved DB instance offering to purchase. To determine an offering_id, see the aws.rds.getReservedInstanceOffering data source.

The following arguments are optional:

instance_count Changes to this property will trigger replacement. int
Number of instances to reserve. Default value is 1.
reservation_id Changes to this property will trigger replacement. str
Customer-specified identifier to track this reservation.
tags Mapping[str, str]
Map of tags to assign to the DB reservation. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
offeringId
This property is required.
Changes to this property will trigger replacement.
String

ID of the Reserved DB instance offering to purchase. To determine an offering_id, see the aws.rds.getReservedInstanceOffering data source.

The following arguments are optional:

instanceCount Changes to this property will trigger replacement. Number
Number of instances to reserve. Default value is 1.
reservationId Changes to this property will trigger replacement. String
Customer-specified identifier to track this reservation.
tags Map<String>
Map of tags to assign to the DB reservation. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

Outputs

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

Arn string
ARN for the reserved DB instance.
CurrencyCode string
Currency code for the reserved DB instance.
DbInstanceClass string
DB instance class for the reserved DB instance.
Duration int
Duration of the reservation in seconds.
FixedPrice double
Fixed price charged for this reserved DB instance.
Id string
The provider-assigned unique ID for this managed resource.
LeaseId string
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.
MultiAz bool
Whether the reservation applies to Multi-AZ deployments.
OfferingType string
Offering type of this reserved DB instance.
ProductDescription string
Description of the reserved DB instance.
RecurringCharges List<ReservedInstanceRecurringCharge>
Recurring price charged to run this reserved DB instance.
StartTime string
Time the reservation started.
State string
State of the reserved DB instance.
TagsAll Dictionary<string, string>
Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

UsagePrice double
Hourly price charged for this reserved DB instance.
Arn string
ARN for the reserved DB instance.
CurrencyCode string
Currency code for the reserved DB instance.
DbInstanceClass string
DB instance class for the reserved DB instance.
Duration int
Duration of the reservation in seconds.
FixedPrice float64
Fixed price charged for this reserved DB instance.
Id string
The provider-assigned unique ID for this managed resource.
LeaseId string
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.
MultiAz bool
Whether the reservation applies to Multi-AZ deployments.
OfferingType string
Offering type of this reserved DB instance.
ProductDescription string
Description of the reserved DB instance.
RecurringCharges []ReservedInstanceRecurringCharge
Recurring price charged to run this reserved DB instance.
StartTime string
Time the reservation started.
State string
State of the reserved DB instance.
TagsAll map[string]string
Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

UsagePrice float64
Hourly price charged for this reserved DB instance.
arn String
ARN for the reserved DB instance.
currencyCode String
Currency code for the reserved DB instance.
dbInstanceClass String
DB instance class for the reserved DB instance.
duration Integer
Duration of the reservation in seconds.
fixedPrice Double
Fixed price charged for this reserved DB instance.
id String
The provider-assigned unique ID for this managed resource.
leaseId String
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.
multiAz Boolean
Whether the reservation applies to Multi-AZ deployments.
offeringType String
Offering type of this reserved DB instance.
productDescription String
Description of the reserved DB instance.
recurringCharges List<ReservedInstanceRecurringCharge>
Recurring price charged to run this reserved DB instance.
startTime String
Time the reservation started.
state String
State of the reserved DB instance.
tagsAll Map<String,String>
Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

usagePrice Double
Hourly price charged for this reserved DB instance.
arn string
ARN for the reserved DB instance.
currencyCode string
Currency code for the reserved DB instance.
dbInstanceClass string
DB instance class for the reserved DB instance.
duration number
Duration of the reservation in seconds.
fixedPrice number
Fixed price charged for this reserved DB instance.
id string
The provider-assigned unique ID for this managed resource.
leaseId string
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.
multiAz boolean
Whether the reservation applies to Multi-AZ deployments.
offeringType string
Offering type of this reserved DB instance.
productDescription string
Description of the reserved DB instance.
recurringCharges ReservedInstanceRecurringCharge[]
Recurring price charged to run this reserved DB instance.
startTime string
Time the reservation started.
state string
State of the reserved DB instance.
tagsAll {[key: string]: string}
Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

usagePrice number
Hourly price charged for this reserved DB instance.
arn str
ARN for the reserved DB instance.
currency_code str
Currency code for the reserved DB instance.
db_instance_class str
DB instance class for the reserved DB instance.
duration int
Duration of the reservation in seconds.
fixed_price float
Fixed price charged for this reserved DB instance.
id str
The provider-assigned unique ID for this managed resource.
lease_id str
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 bool
Whether the reservation applies to Multi-AZ deployments.
offering_type str
Offering type of this reserved DB instance.
product_description str
Description of the reserved DB instance.
recurring_charges Sequence[ReservedInstanceRecurringCharge]
Recurring price charged to run this reserved DB instance.
start_time str
Time the reservation started.
state str
State of the reserved DB instance.
tags_all Mapping[str, str]
Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

usage_price float
Hourly price charged for this reserved DB instance.
arn String
ARN for the reserved DB instance.
currencyCode String
Currency code for the reserved DB instance.
dbInstanceClass String
DB instance class for the reserved DB instance.
duration Number
Duration of the reservation in seconds.
fixedPrice Number
Fixed price charged for this reserved DB instance.
id String
The provider-assigned unique ID for this managed resource.
leaseId String
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.
multiAz Boolean
Whether the reservation applies to Multi-AZ deployments.
offeringType String
Offering type of this reserved DB instance.
productDescription String
Description of the reserved DB instance.
recurringCharges List<Property Map>
Recurring price charged to run this reserved DB instance.
startTime String
Time the reservation started.
state String
State of the reserved DB instance.
tagsAll Map<String>
Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

usagePrice Number
Hourly price charged for this reserved DB instance.

Look up Existing ReservedInstance Resource

Get an existing ReservedInstance 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?: ReservedInstanceState, opts?: CustomResourceOptions): ReservedInstance
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        arn: Optional[str] = None,
        currency_code: Optional[str] = None,
        db_instance_class: Optional[str] = None,
        duration: Optional[int] = None,
        fixed_price: Optional[float] = None,
        instance_count: Optional[int] = None,
        lease_id: Optional[str] = None,
        multi_az: Optional[bool] = None,
        offering_id: Optional[str] = None,
        offering_type: Optional[str] = None,
        product_description: Optional[str] = None,
        recurring_charges: Optional[Sequence[ReservedInstanceRecurringChargeArgs]] = None,
        reservation_id: Optional[str] = None,
        start_time: Optional[str] = None,
        state: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = None,
        usage_price: Optional[float] = None) -> ReservedInstance
func GetReservedInstance(ctx *Context, name string, id IDInput, state *ReservedInstanceState, opts ...ResourceOption) (*ReservedInstance, error)
public static ReservedInstance Get(string name, Input<string> id, ReservedInstanceState? state, CustomResourceOptions? opts = null)
public static ReservedInstance get(String name, Output<String> id, ReservedInstanceState state, CustomResourceOptions options)
resources:  _:    type: aws:rds:ReservedInstance    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
Arn string
ARN for the reserved DB instance.
CurrencyCode string
Currency code for the reserved DB instance.
DbInstanceClass string
DB instance class for the reserved DB instance.
Duration int
Duration of the reservation in seconds.
FixedPrice double
Fixed price charged for this reserved DB instance.
InstanceCount Changes to this property will trigger replacement. int
Number of instances to reserve. Default value is 1.
LeaseId string
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.
MultiAz bool
Whether the reservation applies to Multi-AZ deployments.
OfferingId Changes to this property will trigger replacement. string

ID of the Reserved DB instance offering to purchase. To determine an offering_id, see the aws.rds.getReservedInstanceOffering data source.

The following arguments are optional:

OfferingType string
Offering type of this reserved DB instance.
ProductDescription string
Description of the reserved DB instance.
RecurringCharges List<ReservedInstanceRecurringCharge>
Recurring price charged to run this reserved DB instance.
ReservationId Changes to this property will trigger replacement. string
Customer-specified identifier to track this reservation.
StartTime string
Time the reservation started.
State string
State of the reserved DB instance.
Tags Dictionary<string, string>
Map of tags to assign to the DB reservation. 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>
Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

UsagePrice double
Hourly price charged for this reserved DB instance.
Arn string
ARN for the reserved DB instance.
CurrencyCode string
Currency code for the reserved DB instance.
DbInstanceClass string
DB instance class for the reserved DB instance.
Duration int
Duration of the reservation in seconds.
FixedPrice float64
Fixed price charged for this reserved DB instance.
InstanceCount Changes to this property will trigger replacement. int
Number of instances to reserve. Default value is 1.
LeaseId string
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.
MultiAz bool
Whether the reservation applies to Multi-AZ deployments.
OfferingId Changes to this property will trigger replacement. string

ID of the Reserved DB instance offering to purchase. To determine an offering_id, see the aws.rds.getReservedInstanceOffering data source.

The following arguments are optional:

OfferingType string
Offering type of this reserved DB instance.
ProductDescription string
Description of the reserved DB instance.
RecurringCharges []ReservedInstanceRecurringChargeArgs
Recurring price charged to run this reserved DB instance.
ReservationId Changes to this property will trigger replacement. string
Customer-specified identifier to track this reservation.
StartTime string
Time the reservation started.
State string
State of the reserved DB instance.
Tags map[string]string
Map of tags to assign to the DB reservation. 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
Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

UsagePrice float64
Hourly price charged for this reserved DB instance.
arn String
ARN for the reserved DB instance.
currencyCode String
Currency code for the reserved DB instance.
dbInstanceClass String
DB instance class for the reserved DB instance.
duration Integer
Duration of the reservation in seconds.
fixedPrice Double
Fixed price charged for this reserved DB instance.
instanceCount Changes to this property will trigger replacement. Integer
Number of instances to reserve. Default value is 1.
leaseId String
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.
multiAz Boolean
Whether the reservation applies to Multi-AZ deployments.
offeringId Changes to this property will trigger replacement. String

ID of the Reserved DB instance offering to purchase. To determine an offering_id, see the aws.rds.getReservedInstanceOffering data source.

The following arguments are optional:

offeringType String
Offering type of this reserved DB instance.
productDescription String
Description of the reserved DB instance.
recurringCharges List<ReservedInstanceRecurringCharge>
Recurring price charged to run this reserved DB instance.
reservationId Changes to this property will trigger replacement. String
Customer-specified identifier to track this reservation.
startTime String
Time the reservation started.
state String
State of the reserved DB instance.
tags Map<String,String>
Map of tags to assign to the DB reservation. 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>
Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

usagePrice Double
Hourly price charged for this reserved DB instance.
arn string
ARN for the reserved DB instance.
currencyCode string
Currency code for the reserved DB instance.
dbInstanceClass string
DB instance class for the reserved DB instance.
duration number
Duration of the reservation in seconds.
fixedPrice number
Fixed price charged for this reserved DB instance.
instanceCount Changes to this property will trigger replacement. number
Number of instances to reserve. Default value is 1.
leaseId string
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.
multiAz boolean
Whether the reservation applies to Multi-AZ deployments.
offeringId Changes to this property will trigger replacement. string

ID of the Reserved DB instance offering to purchase. To determine an offering_id, see the aws.rds.getReservedInstanceOffering data source.

The following arguments are optional:

offeringType string
Offering type of this reserved DB instance.
productDescription string
Description of the reserved DB instance.
recurringCharges ReservedInstanceRecurringCharge[]
Recurring price charged to run this reserved DB instance.
reservationId Changes to this property will trigger replacement. string
Customer-specified identifier to track this reservation.
startTime string
Time the reservation started.
state string
State of the reserved DB instance.
tags {[key: string]: string}
Map of tags to assign to the DB reservation. 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}
Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

usagePrice number
Hourly price charged for this reserved DB instance.
arn str
ARN for the reserved DB instance.
currency_code str
Currency code for the reserved DB instance.
db_instance_class str
DB instance class for the reserved DB instance.
duration int
Duration of the reservation in seconds.
fixed_price float
Fixed price charged for this reserved DB instance.
instance_count Changes to this property will trigger replacement. int
Number of instances to reserve. Default value is 1.
lease_id str
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 bool
Whether the reservation applies to Multi-AZ deployments.
offering_id Changes to this property will trigger replacement. str

ID of the Reserved DB instance offering to purchase. To determine an offering_id, see the aws.rds.getReservedInstanceOffering data source.

The following arguments are optional:

offering_type str
Offering type of this reserved DB instance.
product_description str
Description of the reserved DB instance.
recurring_charges Sequence[ReservedInstanceRecurringChargeArgs]
Recurring price charged to run this reserved DB instance.
reservation_id Changes to this property will trigger replacement. str
Customer-specified identifier to track this reservation.
start_time str
Time the reservation started.
state str
State of the reserved DB instance.
tags Mapping[str, str]
Map of tags to assign to the DB reservation. 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]
Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

usage_price float
Hourly price charged for this reserved DB instance.
arn String
ARN for the reserved DB instance.
currencyCode String
Currency code for the reserved DB instance.
dbInstanceClass String
DB instance class for the reserved DB instance.
duration Number
Duration of the reservation in seconds.
fixedPrice Number
Fixed price charged for this reserved DB instance.
instanceCount Changes to this property will trigger replacement. Number
Number of instances to reserve. Default value is 1.
leaseId String
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.
multiAz Boolean
Whether the reservation applies to Multi-AZ deployments.
offeringId Changes to this property will trigger replacement. String

ID of the Reserved DB instance offering to purchase. To determine an offering_id, see the aws.rds.getReservedInstanceOffering data source.

The following arguments are optional:

offeringType String
Offering type of this reserved DB instance.
productDescription String
Description of the reserved DB instance.
recurringCharges List<Property Map>
Recurring price charged to run this reserved DB instance.
reservationId Changes to this property will trigger replacement. String
Customer-specified identifier to track this reservation.
startTime String
Time the reservation started.
state String
State of the reserved DB instance.
tags Map<String>
Map of tags to assign to the DB reservation. 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>
Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

usagePrice Number
Hourly price charged for this reserved DB instance.

Supporting Types

ReservedInstanceRecurringCharge
, ReservedInstanceRecurringChargeArgs

Import

Using pulumi import, import RDS DB Instance Reservations using the instance_id. For example:

$ pulumi import aws:rds/reservedInstance:ReservedInstance reservation_instance CustomReservationID
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
AWS Classic pulumi/pulumi-aws
License
Apache-2.0
Notes
This Pulumi package is based on the aws Terraform Provider.
AWS v6.76.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-aws