AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
Namespace: Amazon.RDS.Model
Assembly: AWSSDK.dll
Version: (assembly version)
public class CreateDBInstanceRequest : AmazonRDSRequest IRequestEvents
The CreateDBInstanceRequest type exposes the following members
Name | Description | |
---|---|---|
CreateDBInstanceRequest() | Empty constructor used to set properties independently even when a simple constructor is available | |
CreateDBInstanceRequest(string, int, string, string, string, string) | Instantiates CreateDBInstanceRequest with the parameterized properties |
Name | Type | Description | |
---|---|---|---|
AllocatedStorage | System.Int32 |
Gets and sets the property AllocatedStorage.
The amount of storage (in gigabytes) to be initially allocated for the database instance. Type: Integer MySQL Constraints: Must be an integer from 5 to 6144. MariaDB Constraints: Must be an integer from 5 to 6144. PostgreSQL Constraints: Must be an integer from 5 to 6144. Oracle Constraints: Must be an integer from 10 to 6144. SQL Server Constraints: Must be an integer from 200 to 4096 (Standard Edition and Enterprise Edition) or from 20 to 4096 (Express Edition and Web Edition) |
|
AutoMinorVersionUpgrade | System.Boolean |
Gets and sets the property AutoMinorVersionUpgrade.
Indicates that minor engine upgrades will be applied automatically to the DB instance during the maintenance window.
Default: |
|
AvailabilityZone | System.String |
Gets and sets the property AvailabilityZone.
The EC2 Availability Zone that the database instance will be created in. For information on regions and Availability Zones, see Regions and Availability Zones. Default: A random, system-chosen Availability Zone in the endpoint's region.
Example:
Constraint: The AvailabilityZone parameter cannot be specified if the MultiAZ parameter
is set to |
|
BackupRetentionPeriod | System.Int32 |
Gets and sets the property BackupRetentionPeriod.
The number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups. Default: 1 Constraints:
|
|
CharacterSetName | System.String |
Gets and sets the property CharacterSetName.
For supported engines, indicates that the DB instance should be associated with the specified CharacterSet. |
|
CopyTagsToSnapshot | System.Boolean |
Gets and sets the property CopyTagsToSnapshot.
True to copy all tags from the DB instance to snapshots of the DB instance; otherwise false. The default is false. |
|
DBClusterIdentifier | System.String |
Gets and sets the property DBClusterIdentifier.
The identifier of the DB cluster that the instance will belong to. For information on creating a DB cluster, see CreateDBCluster. Type: String |
|
DBInstanceClass | System.String |
Gets and sets the property DBInstanceClass.
The compute and memory capacity of the DB instance. Valid Values: db.t1.micro | db.m1.small | db.m1.medium | db.m1.large | db.m1.xlarge | db.m2.xlarge |db.m2.2xlarge | db.m2.4xlarge | db.m3.medium | db.m3.large | db.m3.xlarge | db.m3.2xlarge | db.m4.large | db.m4.xlarge | db.m4.2xlarge | db.m4.4xlarge | db.m4.10xlarge | db.r3.large | db.r3.xlarge | db.r3.2xlarge | db.r3.4xlarge | db.r3.8xlarge | db.t2.micro | db.t2.small | db.t2.medium | db.t2.large |
|
DBInstanceIdentifier | System.String |
Gets and sets the property DBInstanceIdentifier.
The DB instance identifier. This parameter is stored as a lowercase string. Constraints:
Example: |
|
DBName | System.String |
Gets and sets the property DBName.
The meaning of this parameter differs according to the database engine you use. Type: String MySQL The name of the database to create when the DB instance is created. If this parameter is not specified, no database is created in the DB instance. Constraints:
MariaDB The name of the database to create when the DB instance is created. If this parameter is not specified, no database is created in the DB instance. Constraints:
PostgreSQL The name of the database to create when the DB instance is created. If this parameter is not specified, the default "postgres" database is created in the DB instance. Constraints:
Oracle The Oracle System ID (SID) of the created DB instance.
Default: Constraints:
SQL Server Not applicable. Must be null. Amazon Aurora The name of the database to create when the primary instance of the DB cluster is created. If this parameter is not specified, no database is created in the DB instance. Constraints:
|
|
DBParameterGroupName | System.String |
Gets and sets the property DBParameterGroupName.
The 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. Constraints:
|
|
DBSecurityGroups | System.Collections.Generic.List<System.String> |
Gets and sets the property DBSecurityGroups.
A list of DB security groups to associate with this DB instance. Default: The default DB security group for the database engine. |
|
DBSubnetGroupName | System.String |
Gets and sets the property DBSubnetGroupName.
A DB subnet group to associate with this DB instance. If there is no DB subnet group, then it is a non-VPC DB instance. |
|
Engine | System.String |
Gets and sets the property Engine.
The name of the database engine to be used for this instance.
Valid Values: Not every database engine is available for every AWS region. |
|
EngineVersion | System.String |
Gets and sets the property EngineVersion.
The version number of the database engine to use. The following are the database engines and major and minor versions that are available with Amazon RDS. Not every database engine is available for every AWS region. MySQL
MariaDB
Oracle Database Enterprise Edition (oracle-ee)
Oracle Database Standard Edition (oracle-se)
Oracle Database Standard Edition One (oracle-se1)
PostgreSQL
Microsoft SQL Server Enterprise Edition (sqlserver-ee)
Microsoft SQL Server Express Edition (sqlserver-ex)
Microsoft SQL Server Standard Edition (sqlserver-se)
Microsoft SQL Server Web Edition (sqlserver-web)
|
|
Iops | System.Int32 |
Gets and sets the property Iops.
The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance.
Constraints: Must be a multiple between 3 and 10 of the storage amount for the DB
instance. Must also be an integer multiple of 1000. For example, if the size of your
DB instance is 500 GB, then your |
|
KmsKeyId | System.String |
Gets and sets the property KmsKeyId.
The KMS key identifier for an encrypted DB instance. The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a DB instance with the same AWS account that owns the KMS encryption key used to encrypt the new DB instance, then you can use the KMS key alias instead of the ARN for the KM encryption key.
If the |
|
LicenseModel | System.String |
Gets and sets the property LicenseModel.
License model information for this DB instance.
Valid values: |
|
MasterUsername | System.String |
Gets and sets the property MasterUsername.
The name of master user for the client DB instance. MySQL Constraints:
MariaDB Constraints:
Type: String Oracle Constraints:
SQL Server Constraints:
PostgreSQL Constraints:
|
|
MasterUserPassword | System.String |
Gets and sets the property MasterUserPassword.
The password for the master database user. Can be any printable ASCII character except "/", """, or "@". Type: String MySQL Constraints: Must contain from 8 to 41 characters. MariaDB Constraints: Must contain from 8 to 41 characters. Oracle Constraints: Must contain from 8 to 30 characters. SQL Server Constraints: Must contain from 8 to 128 characters. PostgreSQL Constraints: Must contain from 8 to 128 characters. Amazon Aurora Constraints: Must contain from 8 to 41 characters. |
|
MonitoringInterval | System.Int32 |
Gets and sets the property MonitoringInterval.
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 60.
If
Valid Values: |
|
MonitoringRoleArn | System.String |
Gets and sets the property MonitoringRoleArn.
The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to CloudWatch
Logs. For example,
If |
|
MultiAZ | System.Boolean |
Gets and sets the property MultiAZ.
Specifies if the DB instance is a Multi-AZ deployment. You cannot set the AvailabilityZone parameter if the MultiAZ parameter is set to true. Do not set this value if you want a Multi-AZ deployment for a SQL Server DB instance. Multi-AZ for SQL Server is set using the Mirroring option in an option group. |
|
OptionGroupName | System.String |
Gets and sets the property OptionGroupName.
Indicates that the DB instance should be associated with the specified option group. Permanent options, such as the TDE option for Oracle Advanced Security TDE, cannot 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 |
|
Port | System.Int32 |
Gets and sets the property Port.
The port number on which the database accepts connections. MySQL
Default:
Valid Values: Type: Integer MariaDB
Default:
Valid Values: Type: Integer PostgreSQL
Default:
Valid Values: Type: Integer Oracle
Default:
Valid Values: SQL Server
Default:
Valid Values: Amazon Aurora
Default:
Valid Values: Type: Integer |
|
PreferredBackupWindow | System.String |
Gets and sets the property PreferredBackupWindow.
The daily time range during which automated backups are created if automated backups
are enabled, using the Default: A 30-minute window selected at random from an 8-hour block of time per region. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide. Constraints:
|
|
PreferredMaintenanceWindow | System.String |
Gets and sets the property PreferredMaintenanceWindow.
The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). For more information, see DB Instance Maintenance.
Format: 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. To see the time blocks available, see Adjusting the Preferred Maintenance Window in the Amazon RDS User Guide. Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun Constraints: Minimum 30-minute window. |
|
PubliclyAccessible | System.Boolean |
Gets and sets the property PubliclyAccessible.
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. Default: The default behavior varies depending on whether a VPC has been requested or not. The following list shows the default behavior in each case.
If no DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be publicly accessible. If a specific DB subnet group has been specified as part of the request and the PubliclyAccessible value has not been set, the DB instance will be private. |
|
StorageEncrypted | System.Boolean |
Gets and sets the property StorageEncrypted.
Specifies whether the DB instance is encrypted. Default: false |
|
StorageType | System.String |
Gets and sets the property StorageType.
Specifies the storage type to be associated with the DB instance.
Valid values:
If you specify
Default: |
|
Tags | System.Collections.Generic.List<Amazon.RDS.Model.Tag> | Gets and sets the property Tags. | |
TdeCredentialArn | System.String |
Gets and sets the property TdeCredentialArn.
The ARN from the Key Store with which to associate the instance for TDE encryption. |
|
TdeCredentialPassword | System.String |
Gets and sets the property TdeCredentialPassword.
The password for the given ARN from the Key Store in order to access the device. |
|
VpcSecurityGroupIds | System.Collections.Generic.List<System.String> |
Gets and sets the property VpcSecurityGroupIds.
A list of EC2 VPC security groups to associate with this DB instance. Default: The default EC2 VPC security group for the DB subnet group's VPC. |
.NET Framework:
Supported in: 4.5, 4.0, 3.5
.NET for Windows Store apps:
Supported in: Windows 8.1, Windows 8
.NET for Windows Phone:
Supported in: Windows Phone 8.1