aws.rds.ReservedInstance
Explore with Pulumi AI
Manages an RDS DB Reserved Instance.
NOTE: Once created, a reservation is valid for the
durationof the providedoffering_idand cannot be deleted. Performing adestroywill 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,
});
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)
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
	})
}
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,
    });
});
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());
    }
}
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
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 string
- The unique name of the resource.
- args ReservedInstanceArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args 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 string
- The unique name of the resource.
- args ReservedInstanceArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args ReservedInstanceArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args 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" },
    },
});
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"),
	},
})
var reservedInstanceResource = new ReservedInstance("reservedInstanceResource", ReservedInstanceArgs.builder()
    .offeringId("string")
    .instanceCount(0)
    .reservationId("string")
    .tags(Map.of("string", "string"))
    .build());
reserved_instance_resource = aws.rds.ReservedInstance("reservedInstanceResource",
    offering_id="string",
    instance_count=0,
    reservation_id="string",
    tags={
        "string": "string",
    })
const reservedInstanceResource = new aws.rds.ReservedInstance("reservedInstanceResource", {
    offeringId: "string",
    instanceCount: 0,
    reservationId: "string",
    tags: {
        string: "string",
    },
});
type: aws:rds:ReservedInstance
properties:
    instanceCount: 0
    offeringId: string
    reservationId: string
    tags:
        string: string
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 string
- ID of the Reserved DB instance offering to purchase. To determine an - offering_id, see the- aws.rds.getReservedInstanceOfferingdata source.- The following arguments are optional: 
- InstanceCount int
- Number of instances to reserve. Default value is 1.
- ReservationId string
- Customer-specified identifier to track this reservation.
- Dictionary<string, string>
- Map of tags to assign to the DB reservation. If configured with a provider default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.
- OfferingId string
- ID of the Reserved DB instance offering to purchase. To determine an - offering_id, see the- aws.rds.getReservedInstanceOfferingdata source.- The following arguments are optional: 
- InstanceCount int
- Number of instances to reserve. Default value is 1.
- ReservationId string
- Customer-specified identifier to track this reservation.
- map[string]string
- Map of tags to assign to the DB reservation. If configured with a provider default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.
- offeringId String
- ID of the Reserved DB instance offering to purchase. To determine an - offering_id, see the- aws.rds.getReservedInstanceOfferingdata source.- The following arguments are optional: 
- instanceCount Integer
- Number of instances to reserve. Default value is 1.
- reservationId String
- Customer-specified identifier to track this reservation.
- Map<String,String>
- Map of tags to assign to the DB reservation. If configured with a provider default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.
- offeringId string
- ID of the Reserved DB instance offering to purchase. To determine an - offering_id, see the- aws.rds.getReservedInstanceOfferingdata source.- The following arguments are optional: 
- instanceCount number
- Number of instances to reserve. Default value is 1.
- reservationId string
- Customer-specified identifier to track this reservation.
- {[key: string]: string}
- Map of tags to assign to the DB reservation. If configured with a provider default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.
- offering_id str
- ID of the Reserved DB instance offering to purchase. To determine an - offering_id, see the- aws.rds.getReservedInstanceOfferingdata source.- The following arguments are optional: 
- instance_count int
- Number of instances to reserve. Default value is 1.
- reservation_id str
- Customer-specified identifier to track this reservation.
- Mapping[str, str]
- Map of tags to assign to the DB reservation. If configured with a provider default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.
- offeringId String
- ID of the Reserved DB instance offering to purchase. To determine an - offering_id, see the- aws.rds.getReservedInstanceOfferingdata source.- The following arguments are optional: 
- instanceCount Number
- Number of instances to reserve. Default value is 1.
- reservationId String
- Customer-specified identifier to track this reservation.
- Map<String>
- Map of tags to assign to the DB reservation. If configured with a provider default_tagsconfiguration 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.
- DbInstance stringClass 
- 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<ReservedInstance Recurring Charge> 
- Recurring price charged to run this reserved DB instance.
- StartTime string
- Time the reservation started.
- State string
- State of the reserved DB instance.
- Dictionary<string, string>
- Map of tags assigned to the resource, including those inherited from the provider default_tagsconfiguration block.
- 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.
- DbInstance stringClass 
- 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 []ReservedInstance Recurring Charge 
- Recurring price charged to run this reserved DB instance.
- StartTime string
- Time the reservation started.
- State string
- State of the reserved DB instance.
- map[string]string
- Map of tags assigned to the resource, including those inherited from the provider default_tagsconfiguration block.
- 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.
- dbInstance StringClass 
- 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<ReservedInstance Recurring Charge> 
- Recurring price charged to run this reserved DB instance.
- startTime String
- Time the reservation started.
- state String
- State of the reserved DB instance.
- Map<String,String>
- Map of tags assigned to the resource, including those inherited from the provider default_tagsconfiguration block.
- 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.
- dbInstance stringClass 
- 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 ReservedInstance Recurring Charge[] 
- Recurring price charged to run this reserved DB instance.
- startTime string
- Time the reservation started.
- state string
- State of the reserved DB instance.
- {[key: string]: string}
- Map of tags assigned to the resource, including those inherited from the provider default_tagsconfiguration block.
- 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_ strclass 
- 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[ReservedInstance Recurring Charge] 
- Recurring price charged to run this reserved DB instance.
- start_time str
- Time the reservation started.
- state str
- State of the reserved DB instance.
- Mapping[str, str]
- Map of tags assigned to the resource, including those inherited from the provider default_tagsconfiguration block.
- 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.
- dbInstance StringClass 
- 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.
- Map<String>
- Map of tags assigned to the resource, including those inherited from the provider default_tagsconfiguration block.
- 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) -> ReservedInstancefunc 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
- 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.
- Arn string
- ARN for the reserved DB instance.
- CurrencyCode string
- Currency code for the reserved DB instance.
- DbInstance stringClass 
- 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 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 string
- ID of the Reserved DB instance offering to purchase. To determine an - offering_id, see the- aws.rds.getReservedInstanceOfferingdata 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<ReservedInstance Recurring Charge> 
- Recurring price charged to run this reserved DB instance.
- ReservationId string
- Customer-specified identifier to track this reservation.
- StartTime string
- Time the reservation started.
- State string
- State of the reserved DB instance.
- Dictionary<string, string>
- Map of tags to assign to the DB reservation. If configured with a provider default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.
- Dictionary<string, string>
- Map of tags assigned to the resource, including those inherited from the provider default_tagsconfiguration block.
- 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.
- DbInstance stringClass 
- 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 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 string
- ID of the Reserved DB instance offering to purchase. To determine an - offering_id, see the- aws.rds.getReservedInstanceOfferingdata source.- The following arguments are optional: 
- OfferingType string
- Offering type of this reserved DB instance.
- ProductDescription string
- Description of the reserved DB instance.
- RecurringCharges []ReservedInstance Recurring Charge Args 
- Recurring price charged to run this reserved DB instance.
- ReservationId string
- Customer-specified identifier to track this reservation.
- StartTime string
- Time the reservation started.
- State string
- State of the reserved DB instance.
- map[string]string
- Map of tags to assign to the DB reservation. If configured with a provider default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.
- map[string]string
- Map of tags assigned to the resource, including those inherited from the provider default_tagsconfiguration block.
- 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.
- dbInstance StringClass 
- 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 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 String
- ID of the Reserved DB instance offering to purchase. To determine an - offering_id, see the- aws.rds.getReservedInstanceOfferingdata 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<ReservedInstance Recurring Charge> 
- Recurring price charged to run this reserved DB instance.
- reservationId String
- Customer-specified identifier to track this reservation.
- startTime String
- Time the reservation started.
- state String
- State of the reserved DB instance.
- Map<String,String>
- Map of tags to assign to the DB reservation. If configured with a provider default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.
- Map<String,String>
- Map of tags assigned to the resource, including those inherited from the provider default_tagsconfiguration block.
- 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.
- dbInstance stringClass 
- 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 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 string
- ID of the Reserved DB instance offering to purchase. To determine an - offering_id, see the- aws.rds.getReservedInstanceOfferingdata source.- The following arguments are optional: 
- offeringType string
- Offering type of this reserved DB instance.
- productDescription string
- Description of the reserved DB instance.
- recurringCharges ReservedInstance Recurring Charge[] 
- Recurring price charged to run this reserved DB instance.
- reservationId string
- Customer-specified identifier to track this reservation.
- startTime string
- Time the reservation started.
- state string
- State of the reserved DB instance.
- {[key: string]: string}
- Map of tags to assign to the DB reservation. If configured with a provider default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.
- {[key: string]: string}
- Map of tags assigned to the resource, including those inherited from the provider default_tagsconfiguration block.
- 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_ strclass 
- 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 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 str
- ID of the Reserved DB instance offering to purchase. To determine an - offering_id, see the- aws.rds.getReservedInstanceOfferingdata 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[ReservedInstance Recurring Charge Args] 
- Recurring price charged to run this reserved DB instance.
- reservation_id str
- Customer-specified identifier to track this reservation.
- start_time str
- Time the reservation started.
- state str
- State of the reserved DB instance.
- Mapping[str, str]
- Map of tags to assign to the DB reservation. If configured with a provider default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.
- Mapping[str, str]
- Map of tags assigned to the resource, including those inherited from the provider default_tagsconfiguration block.
- 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.
- dbInstance StringClass 
- 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 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 String
- ID of the Reserved DB instance offering to purchase. To determine an - offering_id, see the- aws.rds.getReservedInstanceOfferingdata 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 String
- Customer-specified identifier to track this reservation.
- startTime String
- Time the reservation started.
- state String
- State of the reserved DB instance.
- Map<String>
- Map of tags to assign to the DB reservation. If configured with a provider default_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.
- Map<String>
- Map of tags assigned to the resource, including those inherited from the provider default_tagsconfiguration block.
- usagePrice Number
- Hourly price charged for this reserved DB instance.
Supporting Types
ReservedInstanceRecurringCharge, ReservedInstanceRecurringChargeArgs        
- recurringCharge IntegerAmount 
- recurringCharge StringFrequency 
- recurringCharge numberAmount 
- recurringCharge stringFrequency 
- recurringCharge NumberAmount 
- recurringCharge StringFrequency 
Import
Using pulumi import, import RDS DB Instance Reservations using the instance_id. For example:
$ pulumi import aws:rds/reservedInstance:ReservedInstance reservation_instance CustomReservationID
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 awsTerraform Provider.