AWS SDK for .NET Documentation
CreateDBInstanceRequest Class
AmazonAmazon.RDS.ModelCreateDBInstanceRequest Did this page help you?   Yes   No    Tell us about it...
Container for the parameters to the CreateDBInstance operation.

Creates a new DB instance.

Declaration Syntax
C#
public class CreateDBInstanceRequest : AmazonWebServiceRequest
Members
All MembersConstructorsMethodsProperties



IconMemberDescription
CreateDBInstanceRequest()()()()
Initializes a new instance of the CreateDBInstanceRequest class

AllocatedStorage
The amount of storage (in gigabytes) to be initially allocated for the database instance. MySQL Constraints: Must be an integer from 5 to 1024. Type: Integer Oracle Constraints: Must be an integer from 10 to 1024. SQL Server Constraints: Must be an integer from 200 to 1024 (Standard Edition and Enterprise Edition) or from 30 to 1024 (Express Edition and Web Edition)

AutoMinorVersionUpgrade
Indicates that minor engine upgrades will be applied automatically to the DB instance during the maintenance window. Default: true

AvailabilityZone
The EC2 Availability Zone that the database instance will be created in. Default: A random, system-chosen Availability Zone in the endpoint's region. Example: us-east-1d Constraint: The AvailabilityZone parameter cannot be specified if the MultiAZ parameter is set to true. The specified Availability Zone must be in the same region as the current endpoint.

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:
  • Must be a value from 0 to 35
  • Cannot be set to 0 if the DB instance is a source to read replicas

CharacterSetName
For supported engines, indicates that the DB instance should be associated with the specified CharacterSet.

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

DBInstanceIdentifier
The DB instance identifier. This parameter is stored as a lowercase string. Constraints:
  • Must contain from 1 to 63 alphanumeric characters or hyphens (1 to 15 for SQL Server).
  • First character must be a letter.
  • Cannot end with a hyphen or contain two consecutive hyphens.
Example: mydbinstance

DBName
The meaning of this parameter differs according to the database engine you use. 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:
  • Must contain 1 to 64 alphanumeric characters
  • Cannot be a word reserved by the specified database engine
Type: String Oracle The Oracle System ID (SID) of the created DB instance. Default: ORCL Constraints:
  • Cannot be longer than 8 characters
SQL Server Not applicable. Must be null.

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:
  • Must be 1 to 255 alphanumeric characters
  • First character must be a letter
  • Cannot end with a hyphen or contain two consecutive hyphens

DBSecurityGroups
A list of DB security groups to associate with this DB instance. Default: The default DB security group for the database engine.

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
The name of the database engine to be used for this instance. Valid Values: MySQL | oracle-se1 | oracle-se | oracle-ee | sqlserver-ee | sqlserver-se | sqlserver-ex | sqlserver-web

EngineVersion
The version number of the database engine to use. MySQL Example: 5.1.42 Type: String Oracle Example: 11.2.0.2.v2 Type: String SQL Server Example: 10.50.2789.0.v1

Equals(Object)
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
GetHashCode()()()()
Serves as a hash function for a particular type.
(Inherited from Object.)
GetType()()()()
Gets the type of the current instance.
(Inherited from Object.)
Iops
The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance. Constraints: Must be an integer greater than 1000.

LicenseModel
License model information for this DB instance. Valid values: license-included | bring-your-own-license | general-public-license

MasterUsername
The name of master user for the client DB instance. MySQL Constraints:
  • Must be 1 to 16 alphanumeric characters.
  • First character must be a letter.
  • Cannot be a reserved word for the chosen database engine.
Type: String Oracle Constraints:
  • Must be 1 to 30 alphanumeric characters.
  • First character must be a letter.
  • Cannot be a reserved word for the chosen database engine.
SQL Server Constraints:
  • Must be 1 to 128 alphanumeric characters.
  • First character must be a letter.
  • Cannot be a reserved word for the chosen database engine.

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. Oracle Constraints: Must contain from 8 to 30 characters. SQL Server Constraints: Must contain from 8 to 128 characters.

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.

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
The port number on which the database accepts connections. MySQL Default: 3306 Valid Values: 1150-65535 Type: Integer Oracle Default: 1521 Valid Values: 1150-65535SQL Server Default: 1433 Valid Values: 1150-65535 except for 1434 and 3389.

PreferredBackupWindow
The daily time range during which automated backups are created if automated backups are enabled, using the BackupRetentionPeriod parameter. Default: A 30-minute window selected at random from an 8-hour block of time per region. See the Amazon RDS User Guide for the time blocks for each region from which the default backup windows are assigned. Constraints: Must be in the format hh24:mi-hh24:mi. Times should be Universal Time Coordinated (UTC). Must not conflict with the preferred maintenance window. Must be at least 30 minutes.

PreferredMaintenanceWindow
The weekly time range (in UTC) during which system maintenance can occur. Format: ddd:hh24:mi-ddd:hh24:mi 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
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.
  • Default VPC:true
  • VPC:false
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.

Tags
A list of tags.

ToString()()()()
Returns a string that represents the current object.
(Inherited from Object.)
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.

WithAllocatedStorage(Int32) Obsolete.
Sets the AllocatedStorage property

WithAutoMinorVersionUpgrade(Boolean) Obsolete.
Sets the AutoMinorVersionUpgrade property

WithAvailabilityZone(String) Obsolete.
Sets the AvailabilityZone property

WithBackupRetentionPeriod(Int32) Obsolete.
Sets the BackupRetentionPeriod property

WithCharacterSetName(String) Obsolete.
Sets the CharacterSetName property

WithDBInstanceClass(String) Obsolete.
Sets the DBInstanceClass property

WithDBInstanceIdentifier(String) Obsolete.
Sets the DBInstanceIdentifier property

WithDBName(String) Obsolete.
Sets the DBName property

WithDBParameterGroupName(String) Obsolete.
Sets the DBParameterGroupName property

WithDBSecurityGroups(array<String>[]()[][]) Obsolete.
Adds elements to the DBSecurityGroups collection

WithDBSecurityGroups(IEnumerable<(Of <<'(String>)>>)) Obsolete.
Adds elements to the DBSecurityGroups collection

WithDBSubnetGroupName(String) Obsolete.
Sets the DBSubnetGroupName property

WithEngine(String) Obsolete.
Sets the Engine property

WithEngineVersion(String) Obsolete.
Sets the EngineVersion property

WithIops(Int32) Obsolete.
Sets the Iops property

WithLicenseModel(String) Obsolete.
Sets the LicenseModel property

WithMasterUsername(String) Obsolete.
Sets the MasterUsername property

WithMasterUserPassword(String) Obsolete.
Sets the MasterUserPassword property

WithMultiAZ(Boolean) Obsolete.
Sets the MultiAZ property

WithOptionGroupName(String) Obsolete.
Sets the OptionGroupName property

WithPort(Int32) Obsolete.
Sets the Port property

WithPreferredBackupWindow(String) Obsolete.
Sets the PreferredBackupWindow property

WithPreferredMaintenanceWindow(String) Obsolete.
Sets the PreferredMaintenanceWindow property

WithPubliclyAccessible(Boolean) Obsolete.
Sets the PubliclyAccessible property

WithTags(array<Tag>[]()[][]) Obsolete.
Adds elements to the Tags collection

WithTags(IEnumerable<(Of <<'(Tag>)>>)) Obsolete.
Adds elements to the Tags collection

WithVpcSecurityGroupIds(array<String>[]()[][]) Obsolete.
Adds elements to the VpcSecurityGroupIds collection

WithVpcSecurityGroupIds(IEnumerable<(Of <<'(String>)>>)) Obsolete.
Adds elements to the VpcSecurityGroupIds collection

Inheritance Hierarchy
Object
AmazonWebServiceRequest
 CreateDBInstanceRequest
See Also

Assembly: AWSSDK (Module: AWSSDK) Version: 1.5.60.0 (1.5.60.0)