Skip to content

Purchase Reserved Db Instances Offering

rds_purchase_reserved_db_instances_offering R Documentation

Purchases a reserved DB instance offering

Description

Purchases a reserved DB instance offering.

Usage

rds_purchase_reserved_db_instances_offering(
  ReservedDBInstancesOfferingId, ReservedDBInstanceId, DBInstanceCount,
  Tags)

Arguments

ReservedDBInstancesOfferingId

[required] The ID of the Reserved DB instance offering to purchase.

Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706
ReservedDBInstanceId

Customer-specified identifier to track this reservation.

Example: myreservationID
DBInstanceCount

The number of instances to reserve.

Default: 1
Tags

A list of tags.

For more information, see Tagging Amazon RDS resources in the Amazon RDS User Guide or Tagging Amazon Aurora and Amazon RDS resources in the Amazon Aurora User Guide.

Value

A list with the following syntax:

list(
  ReservedDBInstance = list(
    ReservedDBInstanceId = "string",
    ReservedDBInstancesOfferingId = "string",
    DBInstanceClass = "string",
    StartTime = as.POSIXct(
      "2015-01-01"
    ),
    Duration = 123,
    FixedPrice = 123.0,
    UsagePrice = 123.0,
    CurrencyCode = "string",
    DBInstanceCount = 123,
    ProductDescription = "string",
    OfferingType = "string",
    MultiAZ = TRUE|FALSE,
    State = "string",
    RecurringCharges = list(
      list(
        RecurringChargeAmount = 123.0,
        RecurringChargeFrequency = "string"
      )
    ),
    ReservedDBInstanceArn = "string",
    LeaseId = "string"
  )
)

Request syntax

svc$purchase_reserved_db_instances_offering(
  ReservedDBInstancesOfferingId = "string",
  ReservedDBInstanceId = "string",
  DBInstanceCount = 123,
  Tags = list(
    list(
      Key = "string",
      Value = "string"
    )
  )
)

Examples

## Not run: 
# This example purchases a reserved DB instance offering that matches the
# specified settings.
svc$purchase_reserved_db_instances_offering(
  ReservedDBInstanceId = "myreservationid",
  ReservedDBInstancesOfferingId = "fb29428a-646d-4390-850e-5fe89926e727"
)

## End(Not run)