rds-modify-db-instance - Online in the Cloud

PROGRAM:

NAME

rds-modify-db-instance - Modify settings for an existing database instance

SYNOPSIS

rds-modify-db-instance
DBInstanceIdentifier [--allocated-storage value ]
[--allow-major-version-upgrade value ] [--apply-immediately ]
[--auto-minor-version-upgrade value ] [--backup-retention-period value
] [--db-instance-class value ] [--db-parameter-group-name value ]
[--db-security-groups value[,value...] ] [--engine-version value ]
[--iops value ] [--master-user-password value ] [--multi-az value ]
[--option-group value ] [--preferred-backup-window value ]
[--preferred-maintenance-window value ] [General Options]

DESCRIPTION

Changes the settings on an existing database instance. Any combination of
optional parameters may be included in call to this API.

ARGUMENTS

DBInstanceIdentifier
User-supplied database instance identifier, this is the unique key that
identifies a database instance. The identifier must be 1 to 63
alphanumeric characters or hyphens, is case insensitive, and is not case
preserving. You can also set this value using "--db-instance-identifier".
Required.

SPECIFIC OPTIONS

-a, --db-security-groups VALUE1,VALUE2,VALUE3...
Comma-separated list of database security group name(s) with which to
associate the database.

--allow-major-version-upgrade VALUE
Must be set to true when specifying a value for --engine-version which
has a major version which is different from the DB instance's current
major version.

--apply-immediately
If this option is included, the modifications will be applied
immediately. If this option is omitted, the modifications will be
applied during the preferred maintenance window. The default value is
'false'.

-au, --auto-minor-version-upgrade VALUE
Whether minor version upgrades will automatically be applied to the
database instance during its maintenance window.

-b, --preferred-backup-window VALUE
Preferred backup window specified as a range hh24:mi-hh24:mi (24H Clock
UTC). Not meaningful if backup retention period is set to zero.

-c, --db-instance-class VALUE
The compute and memory capacity of the database instance. Valid values:
db.m1.small, db.m1.large, db.m1.xlarge, db.m2.2xlarge, db.m2.4xlarge.

-g, --db-parameter-group-name VALUE
The database parameter group name with which the database instance will
be associated.

--iops VALUE
The new provisioned storage I/O operations per second for the database
instance. The option can only be specified if the database instance was
created with the iops option. The iops and allocated-storage options
cannot be both specified in the request. To set or unset the iops option
or to change the iops-to-storage ratio, create a new database instance,
restore a database instance from a snapshot or to point-in-time.

-m, --multi-az VALUE
Configure the database instance to run as a Multi-AZ deployment by
setting this option to 'true'.

-og, --option-group VALUE
The name of the option group that should be associated with this
instance.

-p, --master-user-password VALUE
Change the password for the database instance. To be prompted for a
password rather than entering it on the command line, specify this option
with a value of "-".

-r, --backup-retention-period VALUE
The number of days to retain system snapshots. If set to zero, all
existing system snapshots will be deleted and no more will be created.

-s, --allocated-storage VALUE
The desired new total storage size available to the database instance.
This amount must be specified in whole GB increments. The new size must
be equal to or at least 10% greater than your database instance's current
allocated storage size.

-v, --engine-version VALUE
The version number of the database engine.

-w, --preferred-maintenance-window VALUE
Preferred Maintenance Window specifies the weekly time range during which
maintenance on the database instance is performed. It is specified as a
range ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance
window is a four hour period.

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

This shows how to associate the MyCoworkers security group with this
database instance:

$PROMPT>rds-modify-db-instance mydbinstance --db-security-groups mycoworkers

This shows how to immediately upgrade the compute power of an existing
database (assuming the DB was originally created with a 'db.m1.small'
compute class)

$PROMPT>rds-modify-db-instance mydbinstance -c db.m1.large --apply-immediately

This shows how to change the weekly preferred maintenance window for the db
to be the minimum four hour window starting Sundays at 11:15 PM, and ending
Mondays at 3:15 AM.

$PROMPT>rds-modify-db-instance mydbinstance -w Sun:23:15-Mon:03:15

This shows how to change the master password.

$PROMPT>rds-modify-db-instance mydbinstance -p a1b2c3d4

This shows how to increase the storage size of an instance by the minimum
amount, 10%. This example assumes the current instance has 10 GB of
storage, so the minimum amount we can increase by is 1GB (ie, 10% of 10GB).
In this example we specify a new size of 11GB.

$PROMPT>rds-modify-db-instance mydbinstance -s 11

This shows how to configure an instance to run as a Multi-AZ deployment.

$PROMPT>rds-modify-db-instance mydbinstance -m true

OUTPUT

This command returns a table that contains the following:
* DBInstanceId - User-supplied database identifier, this is the unique key
that identifies a database instance.
* Created - When the instance was created, in UTC.
* Class - The compute and memory capacity of the database instance.
* Engine - Name of the database engine to be used for this database
instance.
* Storage - Initially allocated storage size specified in GBs. Limited to
200GB.
* Iops - Provisioned storage I/O operations per second.
* Master Username - The master username for the instance.
* Status - The current status of the instance.
* Endpoint Address - Address of the database instance.
* Port - Port used to connect to the database instance.
* AZ - The instance's availability zone.
* Backup Retention - The number of days for which automated backups and
point-in-time restore are available.
* PendingBackupRetention - Indicates a pending or in-progress change in the
number of days for which automated backups and point-in-time restore are
available.
* PendingClass - The class to which the instance will be scaled during the
next maintenance window, or to which it is currently being scaled if the
--apply-immediately option was specified.
* PendingCredentials - Indicates a pending or in-progress change of the
master user password for the database instance. Always displayed as "****"
for security reasons.
* PendingStorage - The storage size to which the instance will be scaled
during the next maintenance window, or to which it is currently being scaled
if the --apply-immediately option was specified.
* PendingIops - The storage I/O operations per second to which the instance
will be provisioned during the next maintenance window, or to which it is
currently being provisioned if the --apply-immediately option was specified.
* PendingMulti-AZ - If true, the instance will be converted to run as a
Multi-AZ deployment. If false, it will be converted to run as a standard
(Single-AZ) deployment.
* PendingVersion - Version of the database engine which will be deployed
during the next maintenance window, or which is currently being deployed if
the --apply-immediately option was specified.
* DB Name - Name of the initial database created when the instance was
created. This column appears only in the --show-long view.
* Maintenance Window - The window during which patching and instance
modifications will be performed. This column appears only in the --show-long
view.
* Backup Window - The window of time during which daily automated backups
are taken. This column appears only in the --show-long view.
* Latest Restorable Time - The latest time to which a database can be
restored with point-in-time restore. This column appears only in the
--show-long view.
* Multi-AZ - Whether the instance is running as a Multi-AZ deployment.
* Version - The database engine's version number.
* Auto Minor Version Upgrade - Whether minor version upgrades will
automatically be applied to the database instance during its maintenance
window. This column appears only in the --show-long view.
* Read Replica Source ID - The DB Instance which this DB Instance
replicates.
* License - No description available for this column.
* Character Set - The character set that this DB Instance was created with,
if applicable.
* Name - Security Group name.
* Status - Status of authorization.
* Name - Subnet Group name.
* Description - Subnet Group description.
* Status - Status of the DB Subnet Group.
* VpcId - Vpc Id of the Subnet Group.
* Subnet Identifier - Subnet Group Identifier.
* Subnet Availability Zone - Subnet Availability Zone.
* Status - Status of Subnet.
* Group Name - Name of database parameter group applied to.
* Apply Status - Status of applying the parameter group. It can be either
in-sync or pending-reboot.
* Name - The name of the associated option group.
* Status - The status of the option group membership (e.g. in-sync,
applying, pending, pending-maintenance).
* Read Replica ID - The identifier of a DB Instance which acts as a read
replica of this DB Instance.

OUTPUT EXAMPLES

Output with column headers

Use rds-modify-db-instance online using onworks.net services