Provided by: rdscli_1.10.003-0ubuntu1_all
NAME
rds-purchase-reserved-db-instances-offering - Purchase a reserved database instance
SYNOPSIS
rds-purchase-reserved-db-instances-offering ReservedDBInstancesOfferingId [--instance-count value ] [--reserved-db-instance-id value ] [General Options]
DESCRIPTION
Purchases a reserved database instance offering. For a one-time up-front fee, you receive guaranteed access to one or more database instances at a reduced hourly rate.
ARGUMENTS
ReservedDBInstancesOfferingId The unique identifier of the offering to purchase. To see available offerings, use rds-describe-reserved-db-instances-offerings. You can also set this value using "--reserved-db-instances-offering-id". Required.
SPECIFIC OPTIONS
-c, --instance-count VALUE Number of database instances to reserve. Defaults to 1. -i, --reserved-db-instance-id VALUE The unique identifier of the purchased reservation.
GENERAL OPTIONS
--aws-credential-file VALUE Location of the file with your AWS credentials. Must not be specified in conjunction with --ec2-cert-file-path or --ec2-private-key-file-path. This value can be set by using the environment variable 'AWS_CREDENTIAL_FILE'. -C, --ec2-cert-file-path VALUE Path to AWS X.509 certificate file. Must be specified in conjunction with --ec2-private-key-file-path and must not be specified in conjunction with --aws-credential-file. This value can be set by using the environment variable 'EC2_CERT'. --connection-timeout VALUE Specify a connection timeout VALUE (in seconds) for API calls. The default value is '30'. --debug If an error occurs while --debug is used, it will display information useful for debugging the problem. The default value is 'false'. --delimiter VALUE What delimiter to use when displaying delimited (long) results. --headers If you are displaying tabular or delimited results, it includes the column headers. If you are showing xml results, it returns the HTTP headers from the service request, if applicable. This is off by default. -I, --access-key-id VALUE Specify the AWS Access ID to use. -K, --ec2-private-key-file-path VALUE Path to AWS X.509 private key file. Must be specified in conjunction with --ec2-cert-file-path and must not be specified in conjunction with --aws-credential-file. This value can be set by using the environment variable 'EC2_PRIVATE_KEY'. --region VALUE Specify region VALUE as the web service region to use. This value can be set by using the environment variable 'EC2_REGION'. -S, --secret-key VALUE Specify the AWS Secret Key to use. --service-sig-name VALUE Specify the service name to use when signing requests. The default is "rds". This value can be set by using the environment variable 'SERVICE_SIG_NAME'. --show-empty-fields Show empty fields and rows, using a "(nil)" value. The default is to not show empty fields or columns. --show-request Displays the URL used by the tools to call the AWS Service. The default value is 'false'. --show-table, --show-long, --show-xml, --quiet Specify how the results are displayed: tabular, delimited (long), xml, or no output (quiet). Tabular shows a subset of the data in fixed column-width form, while long shows all of the returned values delimited by a character. The xml is the raw return from the service, while quiet suppresses all standard output. The default is tabular, or 'show-table'. -U, --url VALUE This option will override the URL for the service call with VALUE. This value can be set by using the environment variable 'RDS_URL'.
INPUT EXAMPLES
Reserves one database instance from offering o-12345678 $PROMPT>rds-purchase-reserved-db-instances-offering o-12345678 -i reservationId Reserves five database instances from offering o-12345678 $PROMPT>rds-purchase-reserved-db-instances-offering o-12345678 -i reservationId -c 5
OUTPUT
This command returns a table that contains the following: * ReservationId - Unique identifier of the reservation. * OfferingId - Offering identifier for the reservation. This column appears only in the --show-long view. * Class - Class of database instances to which the reservation applies. * Multi-AZ - Indicates whether the reservation applies to Multi-AZ deployments. * Start Time - Time at which the reservation began. * Duration - Length of the reservation period in years. * Fixed Price - Fixed price charged for each database instance in this reservation. * Usage Price - Hourly price to run each reserved database instance. * Count - Number of database instances reserved. * State - Payment status. * Description - Indicates the database engine for the reservation. * Offering Type - Offering type for the reservation. * Amount - Recurring price charged to run this reserved database instance. * Currency - Currency of the amount. * Frequency - The frequency at which the amount is charged to run this reserved database instance.
OUTPUT EXAMPLES
Output with column headers
SEE ALSO
http://docs.amazonwebservices.com/AmazonRDS/2012-09-17/CommandLineReference/ http://docs.amazonwebservices.com/AmazonRDS/latest/CommandLineReference RDS API command line tools 1.10.003 api=2RDS-PURCHASE-RESERVED-DB-INSTANCES-OFFERING(1)