| « PreviousNext » | |
  | Did this page help you? Yes | No | Tell us about it... |
rds-create-db-instance
Description
Creates a new DB Instance.
Syntax
rds-create-db-instance
DBInstanceIdentifier
[-a (--db-security-groups) value[,value...]
]value[,value...] ]value ] value ]valuevalue ] -e (--engine)
valuevalue] value ] -lm (--license model)
value [-m (--multi-az)
value] value ] value ] -p (--master-user-password)
valuevalue ] value ]value [-sn
(--db-subnet-group-name) value ] valuevalue ] value]value ] value ]
Options
| Name | Description | Required | ||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
|
DB Instance identifier. This is the unique key that
identifies a DB Instance. This parameter is stored as a
lowercase string. This can also be passed as a named parameter
using Type: String Default: None Constraints: Must contain from 1 to 63 (1 to 15 for SQL Server) alphanumeric characters or hyphens. First character must be a letter. Cannot end with a hyphen or contain two consecutive hyphens. Example: myinstance |
Yes | ||||||||||||||||||||||||||||||||||||||||
|
|
Contains the compute and memory capacity of the DB
Instance. Different instance classes are available for different database engines.
For information about valid values for a particular engine, use the
Type: String Default: None Valid values: Example: Note Amazon RDS does not support db.t1.micro instances in a virtual private cloud (VPC). |
Yes | ||||||||||||||||||||||||||||||||||||||||
|
|
The meaning of this parameter differs according to the database engine you use. MySQL Name of a database to create when the DB Instance is created. If this parameter is not specified, no database is created in the instance. Constraints:
Type: String Example: Oracle The Oracle System ID (SID) of the created DB Instance. Constraints:
Type: String Example: SQL Server Not applicable. |
No | ||||||||||||||||||||||||||||||||||||||||
|
|
Name of the database engine to be used for this instance. Type: String Default: None Valid values: |
Yes | ||||||||||||||||||||||||||||||||||||||||
|
|
Version number of the database engine to use. Type: String MySQL Example: Oracle Example: SQL Server Example: |
No | ||||||||||||||||||||||||||||||||||||||||
|
|
Name of the DB Parameter Group to associate with this DB Instance. If this argument is omitted, the default DBParameterGroup for the specified engine will be used. Type: String Example: |
No | ||||||||||||||||||||||||||||||||||||||||
|
|
License model for this DB Instance. Type: String Default: None Valid values: Example: |
No | ||||||||||||||||||||||||||||||||||||||||
|
|
Specifies if this is a Multi-AZ deployment. Note At this time, multi-AZ deployments are not supported for the Microsoft SQL Server database engine. Type: Boolean Default: Constraints: The Valid values: |
No | ||||||||||||||||||||||||||||||||||||||||
|
|
Specifies the amount of provisioned IOPS for the DB Instance, expressed in I/O operations per second. Constraints: Must be an integer greater than 1000. |
No | ||||||||||||||||||||||||||||||||||||||||
|
|
A list of one or more DB security groups to associate with this DB Instance. Type: String[] Example: |
No | ||||||||||||||||||||||||||||||||||||||||
|
|
A list of the IDs of one or more VPC security groups to associate with this DB Instance. Type: String[] Example: |
No | ||||||||||||||||||||||||||||||||||||||||
|
|
Port number that the DB Instance uses for connections. Type: Integer MySQL Default: 3306 Valid Values: 1150-65535 Type: Integer Oracle Default: 1521 Valid Values: 1150-65535 Type: Integer Example: SQL Server Default:
Valid Values: Type: Integer |
No | ||||||||||||||||||||||||||||||||||||||||
|
|
Amount of storage to be initially allocated for the DB Instance, in gigabytes. Type: String MySQL Constraints: Must be an integer between 5 and 1024. Oracle Constraints: Must be an integer between 10 and 1024. SQL Server Constraints: Must be an integer from 200 to 1024 (sqlserver-se and sqlserver-ee) or from 30 to 1024 (sqlserver-ex and sqlserver-web). Example: |
Yes | ||||||||||||||||||||||||||||||||||||||||
|
|
Indicates that minor version upgrades will be applied automatically to the DB Instance during the maintenance window. Type: Boolean Default: true Example: |
No | ||||||||||||||||||||||||||||||||||||||||
|
|
The name of the master database user. Type: String MySQL Constraints:
Oracle Constraints:
SQL Server Constraints:
Example: |
Yes | ||||||||||||||||||||||||||||||||||||||||
|
|
The name of the option group to be associated with this instance. If this parameter is not provided, the default option group for the engine specified is used. Permanent options, such as the TDE option for Oracle Advanced Security TDE, can never be removed from an option group, and that option group cannot be removed from a DB instance once it is associated with a DB instance. |
No | ||||||||||||||||||||||||||||||||||||||||
|
|
Password for the master DB Instance user. Can be any printable ASCII character except "/", "\", or "@". If this parameter is not provided, the user will be prompted to enter a password. MySQL Constraints: Must contain from 8 to 41 characters. Type: String Oracle Constraints: Must contain from 8 to 30 characters. Type: String SQL Server Constraints: Must contain from 8 to 128 characters. Example: |
No | ||||||||||||||||||||||||||||||||||||||||
|
|
Weekly time range (in UTC) during which system maintenance can occur. Type: String Default: A 30-minute window selected at random from an 8-hour block of time per region, occurring on a random day of the week. The following list shows the time blocks for each region from which the default maintenance windows are assigned.
Default: Depends on the Region the database was created in. The following table lists the default maintenance window for each Region.
Constraints:
Example: |
No | ||||||||||||||||||||||||||||||||||||||||
|
|
The daily time range (in UTC) during which automated
backups are created if backups are enabled (using the
Type: String Default: A 30-minute window selected at random from an 8-hour block of time per region. The following table lists the time blocks for each region from which the default backup windows are assigned.
Default: Depends on the Region the database was created in. The following table lists the default backup window for each Region.
Constraints:
|
No | ||||||||||||||||||||||||||||||||||||||||
|
|
The number of days automated backups are retained. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables backups. Type: Integer Default: 1 Constraints: Must be a value from 0 to 35. |
No | ||||||||||||||||||||||||||||||||||||||||
|
|
The EC2 Availability Zone that the DB Instance will be created in. Type: String Default: A random, system-chosen Availability Zone in the same region as the current endpoint. Constraints: The Example: |
No | ||||||||||||||||||||||||||||||||||||||||
|
|
The DB Subnet Group to associate with this DB Instance. Specifying a DB Subnet Group will create this DB Instance in a VPC. Type: String Default: none Constraints: Must be the name of an existing DB Subnet Group. Example: |
No | ||||||||||||||||||||||||||||||||||||||||
|
|
Specifies the accessibility options for the DB Instance. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address. | |||||||||||||||||||||||||||||||||||||||||
|
|
Specifies the Oracle character set that the DB Instance will use. For a list of supported character sets, go to Appendix: Oracle Character Sets Supported in Amazon RDS. Oracle only. |
Output
The command returns a table that contains the following information:
DBInstanceID—The user-supplied DB Instance identifier
Created—The data and time the instance was created, in 24-hour UTC
Class—The compute and memory capacity of the instance
Engine—Name of the database engine to be used for this DB Instance
License Model—The license model used for this DB Instance
Storage—Initially allocated storage size specified in gigabytes (GBs)
Master Username—The master username for the DB Instance
Status—The current status of the DB Instance. Valid values:
available|backing-up|creating|deleted|deleting|failed|modifying|rebooting|resetting-master-credentials|storage-full|incompatible-parameters|incompatible-restoreEndpoint Address—Address of the DB Instance
Port—Port used to connect to the DB Instance
AZ—The instance's Availability Zone
Backup Retention—The number of days that automated backups are retained before deletion
PendingBackupRetention—The backup retention period which will be applied at the next maintenance window, or which is currently being applied if the
--apply-immediatelyoption was specifiedPendingClass—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-immediatelyoption was specifiedPendingCredentials—The (hidden) master user password that will be applied to the DB Instance
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-immediatelyoption was specifiedPendingMulti-AZ—If true, indicates the instance will be converted to run as a Multi-AZ deployment; if false, the instance will be converted to run as a standard (Single-AZ) deployment.
PendingVersion—The engine version of the pending database instance.
SecondaryAvailabilityZone—If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support.
Iops—The provisioned IOPS allocated, expressed as I/O operations per second.
DB Name—Name of the initial database created when the instance was created (for the MySQL engine) or the Oracle System ID (SID) of the created DB Instance (for the Oracle engine). For SQL Server, will always be null. This column appears only in the
--show-longviewMaintenance Window—The period during which patching and instance modifications will be performed. This column appears only in the
--show-longviewBackup Window—The period during which automated backups are created. This column appears only in the
--show-longviewLatest Restorable Time—The latest time to which a database can be restored using point-in-time restore. This column appears only in the
--show-longview.Multi-AZ—Indicates if this is a Multi-AZ DB Instance.
Publicly Accessible—Indicates the accessibility option of the instance. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address.
EngineVersion—The version number of the database engine.
Auto Minor Version Upgrade—Indicates that minor version upgrades will be applied to the DB Instance during the maintenance window. This column appears only in the
--show-longview.Name—The DB Security Group name
Group Name—Name of DB Parameter Group applied to
Apply Status—Status of applying the parameter group. It can be either
in-syncorpending-rebootRead Replica ID—The identifier of a DB Instance which acts as a read replica of this DB Instance
Name—Subnet group name
Description—Subnet group description
VpcId—Identifier of the VPC associated with the subnet group
VPC Security Group Ids—Identifier of the VPC security groups associated with the instance.
Subnet identifier—Subnet group identifier
Subnet Availability Zone—Availability Zone of the subnet
Examples
Create a Database Instance with Minimal Parameters
This example creates a DB Instance with the minimal set of parameters.
PROMPT> rds-create-db-instance SimCoProd01 -s 10 -c db.m1.large -e mysql -u master -p Kew2401Sd
Create an Oracle Database Instance
This example creates a DB Instance with the minimal set of parameters.
PROMPT> rds-create-db-instance SimCoProd01 -s 10 -c db.m1.large -e oracle-se --db-name MYORACLE -lm bring-your-own-license -u master -p Kew2401Sd
Create a Database Instance and Prompt for a Password
This example creates a database, prompting for the master user password.
PROMPT> rds-create-db-instance SimCoProd02 -s 10 -c db.m1.large -e mysql -u master -p
