Purchases a reserved DB instance offering.
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
purchase-reserved-db-instances-offering
--reserved-db-instances-offering-id <value>
[--reserved-db-instance-id <value>]
[--db-instance-count <value>]
[--tags <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
--reserved-db-instances-offering-id
(string)
The ID of the Reserved DB instance offering to purchase.
Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706
--reserved-db-instance-id
(string)
Customer-specified identifier to track this reservation.
Example: myreservationID
--db-instance-count
(integer)
The number of instances to reserve.
Default:
1
--tags
(list)
A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.
(structure)
Metadata assigned to an Amazon RDS resource consisting of a key-value pair.
Key -> (string)
A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can’t be prefixed with
aws:
orrds:
. The string can only contain only the set of Unicode letters, digits, white-space, ‘_’, ‘.’, ‘:’, ‘/’, ‘=’, ‘+’, ‘-‘, ‘@’ (Java regex: “^([\p{L}\p{Z}\p{N}_.:/=+-@]*)$”).Value -> (string)
A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can’t be prefixed with
aws:
orrds:
. The string can only contain only the set of Unicode letters, digits, white-space, ‘_’, ‘.’, ‘:’, ‘/’, ‘=’, ‘+’, ‘-‘, ‘@’ (Java regex: “^([\p{L}\p{Z}\p{N}_.:/=+-@]*)$”).
Shorthand Syntax:
Key=string,Value=string ...
JSON Syntax:
[
{
"Key": "string",
"Value": "string"
}
...
]
--cli-input-json
| --cli-input-yaml
(string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton
. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml
.
--generate-cli-skeleton
(string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input
, prints a sample input JSON that can be used as an argument for --cli-input-json
. Similarly, if provided yaml-input
it will print a sample input YAML that can be used with --cli-input-yaml
. If provided with the value output
, it validates the command inputs and returns a sample output JSON for that command.
See ‘aws help’ for descriptions of global parameters.
ReservedDBInstance -> (structure)
This data type is used as a response element in the
DescribeReservedDBInstances
andPurchaseReservedDBInstancesOffering
actions.ReservedDBInstanceId -> (string)
The unique identifier for the reservation.
ReservedDBInstancesOfferingId -> (string)
The offering identifier.
DBInstanceClass -> (string)
The DB instance class for the reserved DB instance.
StartTime -> (timestamp)
The time the reservation started.
Duration -> (integer)
The duration of the reservation in seconds.
FixedPrice -> (double)
The fixed price charged for this reserved DB instance.
UsagePrice -> (double)
The hourly price charged for this reserved DB instance.
CurrencyCode -> (string)
The currency code for the reserved DB instance.
DBInstanceCount -> (integer)
The number of reserved DB instances.
ProductDescription -> (string)
The description of the reserved DB instance.
OfferingType -> (string)
The offering type of this reserved DB instance.
MultiAZ -> (boolean)
Indicates if the reservation applies to Multi-AZ deployments.
State -> (string)
The state of the reserved DB instance.
RecurringCharges -> (list)
The recurring price charged to run this reserved DB instance.
(structure)
This data type is used as a response element in the
DescribeReservedDBInstances
andDescribeReservedDBInstancesOfferings
actions.RecurringChargeAmount -> (double)
The amount of the recurring charge.
RecurringChargeFrequency -> (string)
The frequency of the recurring charge.
ReservedDBInstanceArn -> (string)
The Amazon Resource Name (ARN) for the reserved DB instance.
LeaseId -> (string)
The unique identifier for the lease associated with the reserved DB instance.
Note
Amazon Web Services Support might request the lease ID for an issue related to a reserved DB instance.