docs.aws.amazon.com
Open in
urlscan Pro
13.225.78.32
Public Scan
Submitted URL: http://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBInstance.html
Effective URL: https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBInstance.html
Submission: On November 29 via manual from US — Scanned from DE
Effective URL: https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBInstance.html
Submission: On November 29 via manual from US — Scanned from DE
Form analysis 0 forms found in the DOM
Text Content
SELECT YOUR COOKIE PREFERENCES
We use essential cookies and similar tools that are necessary to provide our
site and services. We use performance cookies to collect anonymous statistics so
we can understand how customers use our site and make improvements. Essential
cookies cannot be deactivated, but you can click “Customize cookies” to decline
performance cookies.
If you agree, AWS and approved third parties will also use cookies to provide
useful site features, remember your preferences, and display relevant content,
including relevant advertising. To continue without accepting these cookies,
click “Continue without accepting.” To make more detailed choices or learn more,
click “Customize cookies.”
Accept all cookiesContinue without acceptingCustomize cookies
CUSTOMIZE COOKIE PREFERENCES
We use cookies and similar tools (collectively, "cookies") for the following
purposes.
ESSENTIAL
Essential cookies are necessary to provide our site and services and cannot be
deactivated. They are usually set in response to your actions on the site, such
as setting your privacy preferences, signing in, or filling in forms.
PERFORMANCE
Performance cookies provide anonymous statistics about how customers navigate
our site so we can improve site experience and performance. Approved third
parties may perform analytics on our behalf, but they cannot use the data for
their own purposes.
Allow performance category
Allowed
FUNCTIONAL
Functional cookies help us provide useful site features, remember your
preferences, and display relevant content. Approved third parties may set these
cookies to provide certain site features. If you do not allow these cookies,
then some or all of these services may not function properly.
Allow functional category
Allowed
ADVERTISING
Advertising cookies may be set through our site by us or our advertising
partners and help us deliver relevant marketing content. If you do not allow
these cookies, you will experience less relevant advertising.
Allow advertising category
Allowed
Blocking some types of cookies may impact your experience of our sites. You may
review and change your choices at any time by clicking Cookie preferences in the
footer of this site. We and selected third-parties use cookies or similar
technologies as specified in the AWS Cookie Notice
.
CancelSave preferences
UNABLE TO SAVE COOKIE PREFERENCES
We will only store essential cookies at this time, because we were unable to
save your cookie preferences.
If you want to change your cookie preferences, try again later using the link in
the AWS console footer, or contact support if the problem persists.
Dismiss
Contact Us
English
Create an AWS Account
1. AWS
2. ...
3. Documentation
4. Amazon Relational Database Service (RDS) Documentation
5. API Reference
Feedback
Preferences
AMAZON RELATIONAL DATABASE SERVICE
API REFERENCE
* Welcome
* Actions
* AddRoleToDBCluster
* AddRoleToDBInstance
* AddSourceIdentifierToSubscription
* AddTagsToResource
* ApplyPendingMaintenanceAction
* AuthorizeDBSecurityGroupIngress
* BacktrackDBCluster
* CancelExportTask
* CopyDBClusterParameterGroup
* CopyDBClusterSnapshot
* CopyDBParameterGroup
* CopyDBSnapshot
* CopyOptionGroup
* CreateBlueGreenDeployment
* CreateCustomDBEngineVersion
* CreateDBCluster
* CreateDBClusterEndpoint
* CreateDBClusterParameterGroup
* CreateDBClusterSnapshot
* CreateDBInstance
* CreateDBInstanceReadReplica
* CreateDBParameterGroup
* CreateDBProxy
* CreateDBProxyEndpoint
* CreateDBSecurityGroup
* CreateDBSnapshot
* CreateDBSubnetGroup
* CreateEventSubscription
* CreateGlobalCluster
* CreateOptionGroup
* DeleteBlueGreenDeployment
* DeleteCustomDBEngineVersion
* DeleteDBCluster
* DeleteDBClusterEndpoint
* DeleteDBClusterParameterGroup
* DeleteDBClusterSnapshot
* DeleteDBInstance
* DeleteDBInstanceAutomatedBackup
* DeleteDBParameterGroup
* DeleteDBProxy
* DeleteDBProxyEndpoint
* DeleteDBSecurityGroup
* DeleteDBSnapshot
* DeleteDBSubnetGroup
* DeleteEventSubscription
* DeleteGlobalCluster
* DeleteOptionGroup
* DeregisterDBProxyTargets
* DescribeAccountAttributes
* DescribeBlueGreenDeployments
* DescribeCertificates
* DescribeDBClusterBacktracks
* DescribeDBClusterEndpoints
* DescribeDBClusterParameterGroups
* DescribeDBClusterParameters
* DescribeDBClusters
* DescribeDBClusterSnapshotAttributes
* DescribeDBClusterSnapshots
* DescribeDBEngineVersions
* DescribeDBInstanceAutomatedBackups
* DescribeDBInstances
* DescribeDBLogFiles
* DescribeDBParameterGroups
* DescribeDBParameters
* DescribeDBProxies
* DescribeDBProxyEndpoints
* DescribeDBProxyTargetGroups
* DescribeDBProxyTargets
* DescribeDBSecurityGroups
* DescribeDBSnapshotAttributes
* DescribeDBSnapshots
* DescribeDBSubnetGroups
* DescribeEngineDefaultClusterParameters
* DescribeEngineDefaultParameters
* DescribeEventCategories
* DescribeEvents
* DescribeEventSubscriptions
* DescribeExportTasks
* DescribeGlobalClusters
* DescribeOptionGroupOptions
* DescribeOptionGroups
* DescribeOrderableDBInstanceOptions
* DescribePendingMaintenanceActions
* DescribeReservedDBInstances
* DescribeReservedDBInstancesOfferings
* DescribeSourceRegions
* DescribeValidDBInstanceModifications
* DownloadDBLogFilePortion
* FailoverDBCluster
* FailoverGlobalCluster
* ListTagsForResource
* ModifyActivityStream
* ModifyCertificates
* ModifyCurrentDBClusterCapacity
* ModifyCustomDBEngineVersion
* ModifyDBCluster
* ModifyDBClusterEndpoint
* ModifyDBClusterParameterGroup
* ModifyDBClusterSnapshotAttribute
* ModifyDBInstance
* ModifyDBParameterGroup
* ModifyDBProxy
* ModifyDBProxyEndpoint
* ModifyDBProxyTargetGroup
* ModifyDBSnapshot
* ModifyDBSnapshotAttribute
* ModifyDBSubnetGroup
* ModifyEventSubscription
* ModifyGlobalCluster
* ModifyOptionGroup
* PromoteReadReplica
* PromoteReadReplicaDBCluster
* PurchaseReservedDBInstancesOffering
* RebootDBCluster
* RebootDBInstance
* RegisterDBProxyTargets
* RemoveFromGlobalCluster
* RemoveRoleFromDBCluster
* RemoveRoleFromDBInstance
* RemoveSourceIdentifierFromSubscription
* RemoveTagsFromResource
* ResetDBClusterParameterGroup
* ResetDBParameterGroup
* RestoreDBClusterFromS3
* RestoreDBClusterFromSnapshot
* RestoreDBClusterToPointInTime
* RestoreDBInstanceFromDBSnapshot
* RestoreDBInstanceFromS3
* RestoreDBInstanceToPointInTime
* RevokeDBSecurityGroupIngress
* StartActivityStream
* StartDBCluster
* StartDBInstance
* StartDBInstanceAutomatedBackupsReplication
* StartExportTask
* StopActivityStream
* StopDBCluster
* StopDBInstance
* StopDBInstanceAutomatedBackupsReplication
* SwitchoverBlueGreenDeployment
* SwitchoverReadReplica
* Data Types
* AccountQuota
* AvailabilityZone
* AvailableProcessorFeature
* BlueGreenDeployment
* BlueGreenDeploymentTask
* Certificate
* CharacterSet
* CloudwatchLogsExportConfiguration
* ClusterPendingModifiedValues
* ConnectionPoolConfiguration
* ConnectionPoolConfigurationInfo
* DBCluster
* DBClusterBacktrack
* DBClusterEndpoint
* DBClusterMember
* DBClusterOptionGroupStatus
* DBClusterParameterGroup
* DBClusterRole
* DBClusterSnapshot
* DBClusterSnapshotAttribute
* DBClusterSnapshotAttributesResult
* DBEngineVersion
* DBInstance
* DBInstanceAutomatedBackup
* DBInstanceAutomatedBackupsReplication
* DBInstanceRole
* DBInstanceStatusInfo
* DBParameterGroup
* DBParameterGroupStatus
* DBProxy
* DBProxyEndpoint
* DBProxyTarget
* DBProxyTargetGroup
* DBSecurityGroup
* DBSecurityGroupMembership
* DBSnapshot
* DBSnapshotAttribute
* DBSnapshotAttributesResult
* DBSubnetGroup
* DescribeDBLogFilesDetails
* DomainMembership
* DoubleRange
* EC2SecurityGroup
* Endpoint
* EngineDefaults
* Event
* EventCategoriesMap
* EventSubscription
* ExportTask
* FailoverState
* Filter
* GlobalCluster
* GlobalClusterMember
* IPRange
* MinimumEngineVersionPerAllowedValue
* Option
* OptionConfiguration
* OptionGroup
* OptionGroupMembership
* OptionGroupOption
* OptionGroupOptionSetting
* OptionSetting
* OptionVersion
* OrderableDBInstanceOption
* Outpost
* Parameter
* PendingCloudwatchLogsExports
* PendingMaintenanceAction
* PendingModifiedValues
* ProcessorFeature
* Range
* RecurringCharge
* ReservedDBInstance
* ReservedDBInstancesOffering
* ResourcePendingMaintenanceActions
* RestoreWindow
* ScalingConfiguration
* ScalingConfigurationInfo
* ServerlessV2ScalingConfiguration
* ServerlessV2ScalingConfigurationInfo
* SourceRegion
* Subnet
* SwitchoverDetail
* Tag
* TargetHealth
* Timezone
* UpgradeTarget
* UserAuthConfig
* UserAuthConfigInfo
* ValidDBInstanceModificationsMessage
* ValidStorageOptions
* VpcSecurityGroupMembership
* Common Parameters
* Common Errors
CreateDBInstance - Amazon Relational Database Service
AWSDocumentationAmazon Relational Database Service (RDS) DocumentationAPI
Reference
Request ParametersResponse ElementsErrorsExamplesSee Also
CREATEDBINSTANCE
PDF
Creates a new DB instance.
The new DB instance can be an RDS DB instance, or it can be a DB instance in an
Aurora DB cluster. For an Aurora DB cluster, you can call this operation
multiple times to add more than one DB instance to the cluster.
For more information about creating an RDS DB instance, see Creating an Amazon
RDS DB instance in the Amazon RDS User Guide.
For more information about creating a DB instance in an Aurora DB cluster, see
Creating an Amazon Aurora DB cluster in the Amazon Aurora User Guide.
REQUEST PARAMETERS
For information about the parameters that are common to all actions, see Common
Parameters.
AllocatedStorage
The amount of storage in gibibytes (GiB) to allocate for the DB instance.
Type: Integer
Amazon Aurora
Not applicable. Aurora cluster volumes automatically grow as the amount of data
in your database increases, though you are only charged for the space that you
use in an Aurora cluster volume.
Amazon RDS Custom
Constraints to the amount of storage for each storage type are the following:
* General Purpose (SSD) storage (gp2, gp3): Must be an integer from 40 to 65536
for RDS Custom for Oracle, 16384 for RDS Custom for SQL Server.
* Provisioned IOPS storage (io1): Must be an integer from 40 to 65536 for RDS
Custom for Oracle, 16384 for RDS Custom for SQL Server.
MySQL
Constraints to the amount of storage for each storage type are the following:
* General Purpose (SSD) storage (gp2, gp3): Must be an integer from 20 to
65536.
* Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.
* Magnetic storage (standard): Must be an integer from 5 to 3072.
MariaDB
Constraints to the amount of storage for each storage type are the following:
* General Purpose (SSD) storage (gp2, gp3): Must be an integer from 20 to
65536.
* Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.
* Magnetic storage (standard): Must be an integer from 5 to 3072.
PostgreSQL
Constraints to the amount of storage for each storage type are the following:
* General Purpose (SSD) storage (gp2, gp3): Must be an integer from 20 to
65536.
* Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.
* Magnetic storage (standard): Must be an integer from 5 to 3072.
Oracle
Constraints to the amount of storage for each storage type are the following:
* General Purpose (SSD) storage (gp2, gp3): Must be an integer from 20 to
65536.
* Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.
* Magnetic storage (standard): Must be an integer from 10 to 3072.
SQL Server
Constraints to the amount of storage for each storage type are the following:
* General Purpose (SSD) storage (gp2, gp3):
* Enterprise and Standard editions: Must be an integer from 20 to 16384.
* Web and Express editions: Must be an integer from 20 to 16384.
* Provisioned IOPS storage (io1):
* Enterprise and Standard editions: Must be an integer from 100 to 16384.
* Web and Express editions: Must be an integer from 100 to 16384.
* Magnetic storage (standard):
* Enterprise and Standard editions: Must be an integer from 20 to 1024.
* Web and Express editions: Must be an integer from 20 to 1024.
Type: Integer
Required: No
AutoMinorVersionUpgrade
A value that indicates whether minor engine upgrades are applied automatically
to the DB instance during the maintenance window. By default, minor engine
upgrades are applied automatically.
If you create an RDS Custom DB instance, you must set AutoMinorVersionUpgrade to
false.
Type: Boolean
Required: No
AvailabilityZone
The Availability Zone (AZ) where the database will be created. For information
on AWS Regions and Availability Zones, see Regions and Availability Zones.
Amazon Aurora
Each Aurora DB cluster hosts copies of its storage in three separate
Availability Zones. Specify one of these Availability Zones. Aurora
automatically chooses an appropriate Availability Zone if you don't specify one.
Default: A random, system-chosen Availability Zone in the endpoint's AWS Region.
Example: us-east-1d
Constraint: The AvailabilityZone parameter can't be specified if the DB instance
is a Multi-AZ deployment. The specified Availability Zone must be in the same
AWS Region as the current endpoint.
Type: String
Required: No
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.
Amazon Aurora
Not applicable. The retention period for automated backups is managed by the DB
cluster.
Default: 1
Constraints:
* Must be a value from 0 to 35
* Can't be set to 0 if the DB instance is a source to read replicas
* Can't be set to 0 for an RDS Custom for Oracle DB instance
Type: Integer
Required: No
BackupTarget
Specifies where automated backups and manual snapshots are stored.
Possible values are outposts (AWS Outposts) and region (AWS Region). The default
is region.
For more information, see Working with Amazon RDS on AWS Outposts in the Amazon
RDS User Guide.
Type: String
Required: No
CharacterSetName
For supported engines, this value indicates that the DB instance should be
associated with the specified CharacterSet.
This setting doesn't apply to RDS Custom. However, if you need to change the
character set, you can change it on the database itself.
Amazon Aurora
Not applicable. The character set is managed by the DB cluster. For more
information, see CreateDBCluster.
Type: String
Required: No
CopyTagsToSnapshot
A value that indicates whether to copy tags from the DB instance to snapshots of
the DB instance. By default, tags are not copied.
Amazon Aurora
Not applicable. Copying tags to snapshots is managed by the DB cluster. Setting
this value for an Aurora DB instance has no effect on the DB cluster setting.
Type: Boolean
Required: No
CustomIamInstanceProfile
The instance profile associated with the underlying Amazon EC2 instance of an
RDS Custom DB instance. The instance profile must meet the following
requirements:
* The profile must exist in your account.
* The profile must have an IAM role that Amazon EC2 has permissions to assume.
* The instance profile name and the associated IAM role name must start with
the prefix AWSRDSCustom.
For the list of permissions required for the IAM role, see Configure IAM and
your VPC in the Amazon RDS User Guide.
This setting is required for RDS Custom.
Type: String
Required: No
DBClusterIdentifier
The identifier of the DB cluster that the instance will belong to.
This setting doesn't apply to RDS Custom.
Type: String
Required: No
DBInstanceClass
The compute and memory capacity of the DB instance, for example db.m5.large. Not
all DB instance classes are available in all AWS Regions, or for all database
engines. For the full list of DB instance classes, and availability for your
engine, see DB instance classes in the Amazon RDS User Guide or Aurora DB
instance classes in the Amazon Aurora User Guide.
Type: String
Required: Yes
DBInstanceIdentifier
The DB instance identifier. This parameter is stored as a lowercase string.
Constraints:
* Must contain from 1 to 63 letters, numbers, or hyphens.
* First character must be a letter.
* Can't end with a hyphen or contain two consecutive hyphens.
Example: mydbinstance
Type: String
Required: Yes
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 isn't specified, no database is created in the DB instance.
Constraints:
* Must contain 1 to 64 letters or numbers.
* Must begin with a letter. Subsequent characters can be letters, underscores,
or digits (0-9).
* Can't be a word reserved by the specified database engine
MariaDB
The name of the database to create when the DB instance is created. If this
parameter isn't specified, no database is created in the DB instance.
Constraints:
* Must contain 1 to 64 letters or numbers.
* Must begin with a letter. Subsequent characters can be letters, underscores,
or digits (0-9).
* Can't be a word reserved by the specified database engine
PostgreSQL
The name of the database to create when the DB instance is created. If this
parameter isn't specified, a database named postgres is created in the DB
instance.
Constraints:
* Must contain 1 to 63 letters, numbers, or underscores.
* Must begin with a letter. Subsequent characters can be letters, underscores,
or digits (0-9).
* Can't be a word reserved by the specified database engine
Oracle
The Oracle System ID (SID) of the created DB instance. If you specify null, the
default value ORCL is used. You can't specify the string NULL, or any other
reserved word, for DBName.
Default: ORCL
Constraints:
* Can't be longer than 8 characters
Amazon RDS Custom for Oracle
The Oracle System ID (SID) of the created RDS Custom DB instance. If you don't
specify a value, the default value is ORCL.
Default: ORCL
Constraints:
* It must contain 1 to 8 alphanumeric characters.
* It must contain a letter.
* It can't be a word reserved by the database engine.
Amazon RDS Custom for SQL Server
Not applicable. Must be null.
SQL Server
Not applicable. Must be null.
Amazon Aurora MySQL
The name of the database to create when the primary DB instance of the Aurora
MySQL DB cluster is created. If this parameter isn't specified for an Aurora
MySQL DB cluster, no database is created in the DB cluster.
Constraints:
* It must contain 1 to 64 alphanumeric characters.
* It can't be a word reserved by the database engine.
Amazon Aurora PostgreSQL
The name of the database to create when the primary DB instance of the Aurora
PostgreSQL DB cluster is created. If this parameter isn't specified for an
Aurora PostgreSQL DB cluster, a database named postgres is created in the DB
cluster.
Constraints:
* It must contain 1 to 63 alphanumeric characters.
* It must begin with a letter. Subsequent characters can be letters,
underscores, or digits (0 to 9).
* It can't be a word reserved by the database engine.
Type: String
Required: No
DBParameterGroupName
The name of the DB parameter group to associate with this DB instance. If you do
not specify a value, then the default DB parameter group for the specified DB
engine and version is used.
This setting doesn't apply to RDS Custom.
Constraints:
* It must be 1 to 255 letters, numbers, or hyphens.
* The first character must be a letter.
* It can't end with a hyphen or contain two consecutive hyphens.
Type: String
Required: No
DBSecurityGroups.DBSecurityGroupName.N
A list of DB security groups to associate with this DB instance.
This setting applies to the legacy EC2-Classic platform, which is no longer used
to create new DB instances. Use the VpcSecurityGroupIds setting instead.
Type: Array of strings
Required: No
DBSubnetGroupName
A DB subnet group to associate with this DB instance.
Constraints: Must match the name of an existing DBSubnetGroup. Must not be
default.
Example: mydbsubnetgroup
Type: String
Required: No
DeletionProtection
A value that indicates whether the DB instance has deletion protection enabled.
The database can't be deleted when deletion protection is enabled. By default,
deletion protection isn't enabled. For more information, see Deleting a DB
Instance.
Amazon Aurora
Not applicable. You can enable or disable deletion protection for the DB
cluster. For more information, see CreateDBCluster. DB instances in a DB cluster
can be deleted even when deletion protection is enabled for the DB cluster.
Type: Boolean
Required: No
Domain
The Active Directory directory ID to create the DB instance in. Currently, only
MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances can be created
in an Active Directory Domain.
For more information, see Kerberos Authentication in the Amazon RDS User Guide.
This setting doesn't apply to RDS Custom.
Amazon Aurora
Not applicable. The domain is managed by the DB cluster.
Type: String
Required: No
DomainIAMRoleName
Specify the name of the IAM role to be used when making API calls to the
Directory Service.
This setting doesn't apply to RDS Custom.
Amazon Aurora
Not applicable. The domain is managed by the DB cluster.
Type: String
Required: No
EnableCloudwatchLogsExports.member.N
The list of log types that need to be enabled for exporting to CloudWatch Logs.
The values in the list depend on the DB engine. For more information, see
Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.
Amazon Aurora
Not applicable. CloudWatch Logs exports are managed by the DB cluster.
RDS Custom
Not applicable.
MariaDB
Possible values are audit, error, general, and slowquery.
Microsoft SQL Server
Possible values are agent and error.
MySQL
Possible values are audit, error, general, and slowquery.
Oracle
Possible values are alert, audit, listener, trace, and oemagent.
PostgreSQL
Possible values are postgresql and upgrade.
Type: Array of strings
Required: No
EnableCustomerOwnedIp
A value that indicates whether to enable a customer-owned IP address (CoIP) for
an RDS on Outposts DB instance.
A CoIP provides local or external connectivity to resources in your Outpost
subnets through your on-premises network. For some use cases, a CoIP can provide
lower latency for connections to the DB instance from outside of its virtual
private cloud (VPC) on your local network.
For more information about RDS on Outposts, see Working with Amazon RDS on AWS
Outposts in the Amazon RDS User Guide.
For more information about CoIPs, see Customer-owned IP addresses in the AWS
Outposts User Guide.
Type: Boolean
Required: No
EnableIAMDatabaseAuthentication
A value that indicates whether to enable mapping of AWS Identity and Access
Management (IAM) accounts to database accounts. By default, mapping isn't
enabled.
For more information, see IAM Database Authentication for MySQL and PostgreSQL
in the Amazon RDS User Guide.
This setting doesn't apply to RDS Custom.
Amazon Aurora
Not applicable. Mapping AWS IAM accounts to database accounts is managed by the
DB cluster.
Type: Boolean
Required: No
EnablePerformanceInsights
A value that indicates whether to enable Performance Insights for the DB
instance. For more information, see Using Amazon Performance Insights in the
Amazon RDS User Guide.
This setting doesn't apply to RDS Custom.
Type: Boolean
Required: No
Engine
The name of the database engine to be used for this instance.
Not every database engine is available for every AWS Region.
Valid Values:
* aurora (for MySQL 5.6-compatible Aurora)
* aurora-mysql (for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora)
* aurora-postgresql
* custom-oracle-ee (for RDS Custom for Oracle instances)
* custom-sqlserver-ee (for RDS Custom for SQL Server instances)
* custom-sqlserver-se (for RDS Custom for SQL Server instances)
* custom-sqlserver-web (for RDS Custom for SQL Server instances)
* mariadb
* mysql
* oracle-ee
* oracle-ee-cdb
* oracle-se2
* oracle-se2-cdb
* postgres
* sqlserver-ee
* sqlserver-se
* sqlserver-ex
* sqlserver-web
Type: String
Required: Yes
EngineVersion
The version number of the database engine to use.
For a list of valid engine versions, use the DescribeDBEngineVersions operation.
The following are the database engines and links to information about the major
and minor versions that are available with Amazon RDS. Not every database engine
is available for every AWS Region.
Amazon Aurora
Not applicable. The version number of the database engine to be used by the DB
instance is managed by the DB cluster.
Amazon RDS Custom for Oracle
A custom engine version (CEV) that you have previously created. This setting is
required for RDS Custom for Oracle. The CEV name has the following format:
19.customized_string. A valid CEV name is 19.my_cev1. For more information, see
Creating an RDS Custom for Oracle DB instance in the Amazon RDS User Guide.
Amazon RDS Custom for SQL Server
See RDS Custom for SQL Server general requirements in the Amazon RDS User Guide.
MariaDB
For information, see MariaDB on Amazon RDS Versions in the Amazon RDS User
Guide.
Microsoft SQL Server
For information, see Microsoft SQL Server Versions on Amazon RDS in the Amazon
RDS User Guide.
MySQL
For information, see MySQL on Amazon RDS Versions in the Amazon RDS User Guide.
Oracle
For information, see Oracle Database Engine Release Notes in the Amazon RDS User
Guide.
PostgreSQL
For information, see Amazon RDS for PostgreSQL versions and extensions in the
Amazon RDS User Guide.
Type: String
Required: No
Iops
The amount of Provisioned IOPS (input/output operations per second) to be
initially allocated for the DB instance. For information about valid IOPS
values, see Amazon RDS DB instance storage in the Amazon RDS User Guide.
Constraints: For MariaDB, MySQL, Oracle, and PostgreSQL DB instances, must be a
multiple between .5 and 50 of the storage amount for the DB instance. For SQL
Server DB instances, must be a multiple between 1 and 50 of the storage amount
for the DB instance.
Amazon Aurora
Not applicable. Storage is managed by the DB cluster.
Type: Integer
Required: No
KmsKeyId
The AWS KMS key identifier for an encrypted DB instance.
The AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias name for
the KMS key. To use a KMS key in a different AWS account, specify the key ARN or
alias ARN.
Amazon Aurora
Not applicable. The AWS KMS key identifier is managed by the DB cluster. For
more information, see CreateDBCluster.
If StorageEncrypted is enabled, and you do not specify a value for the KmsKeyId
parameter, then Amazon RDS uses your default KMS key. There is a default KMS key
for your AWS account. Your AWS account has a different default KMS key for each
AWS Region.
Amazon RDS Custom
A KMS key is required for RDS Custom instances. For most RDS engines, if you
leave this parameter empty while enabling StorageEncrypted, the engine uses the
default KMS key. However, RDS Custom doesn't use the default key when this
parameter is empty. You must explicitly specify a key.
Type: String
Required: No
LicenseModel
License model information for this DB instance.
Valid values: license-included | bring-your-own-license | general-public-license
This setting doesn't apply to RDS Custom.
Amazon Aurora
Not applicable.
Type: String
Required: No
MasterUsername
The name for the master user.
Amazon Aurora
Not applicable. The name for the master user is managed by the DB cluster.
Amazon RDS
Constraints:
* Required.
* Must be 1 to 16 letters, numbers, or underscores.
* First character must be a letter.
* Can't be a reserved word for the chosen database engine.
Type: String
Required: No
MasterUserPassword
The password for the master user. The password can include any printable ASCII
character except "/", """, or "@".
Amazon Aurora
Not applicable. The password for the master user is managed by the DB cluster.
MariaDB
Constraints: Must contain from 8 to 41 characters.
Microsoft SQL Server
Constraints: Must contain from 8 to 128 characters.
MySQL
Constraints: Must contain from 8 to 41 characters.
Oracle
Constraints: Must contain from 8 to 30 characters.
PostgreSQL
Constraints: Must contain from 8 to 128 characters.
Type: String
Required: No
MaxAllocatedStorage
The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale
the storage of the DB instance.
For more information about this setting, including limitations that apply to it,
see Managing capacity automatically with Amazon RDS storage autoscaling in the
Amazon RDS User Guide.
This setting doesn't apply to RDS Custom.
Amazon Aurora
Not applicable. Storage is managed by the DB cluster.
Type: Integer
Required: No
MonitoringInterval
The interval, in seconds, between points when Enhanced Monitoring metrics are
collected for the DB instance. To disable collection of Enhanced Monitoring
metrics, specify 0. The default is 0.
If MonitoringRoleArn is specified, then you must set MonitoringInterval to a
value other than 0.
This setting doesn't apply to RDS Custom.
Valid Values: 0, 1, 5, 10, 15, 30, 60
Type: Integer
Required: No
MonitoringRoleArn
The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to
Amazon CloudWatch Logs. For example, arn:aws:iam:123456789012:role/emaccess. For
information on creating a monitoring role, see Setting Up and Enabling Enhanced
Monitoring in the Amazon RDS User Guide.
If MonitoringInterval is set to a value other than 0, then you must supply a
MonitoringRoleArn value.
This setting doesn't apply to RDS Custom.
Type: String
Required: No
MultiAZ
A value that indicates whether the DB instance is a Multi-AZ deployment. You
can't set the AvailabilityZone parameter if the DB instance is a Multi-AZ
deployment.
This setting doesn't apply to RDS Custom.
Amazon Aurora
Not applicable. DB instance Availability Zones (AZs) are managed by the DB
cluster.
Type: Boolean
Required: No
NcharCharacterSetName
The name of the NCHAR character set for the Oracle DB instance.
This parameter doesn't apply to RDS Custom.
Type: String
Required: No
NetworkType
The network type of the DB instance.
Valid values:
* IPV4
* DUAL
The network type is determined by the DBSubnetGroup specified for the DB
instance. A DBSubnetGroup can support only the IPv4 protocol or the IPv4 and the
IPv6 protocols (DUAL).
For more information, see Working with a DB instance in a VPC in the Amazon RDS
User Guide.
Type: String
Required: No
OptionGroupName
A value that 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,
can't be removed from an option group. Also, that option group can't be removed
from a DB instance after it is associated with a DB instance.
This setting doesn't apply to RDS Custom.
Amazon Aurora
Not applicable.
Type: String
Required: No
PerformanceInsightsKMSKeyId
The AWS KMS key identifier for encryption of Performance Insights data.
The AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias name for
the KMS key.
If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS
uses your default KMS key. There is a default KMS key for your AWS account. Your
AWS account has a different default KMS key for each AWS Region.
This setting doesn't apply to RDS Custom.
Type: String
Required: No
PerformanceInsightsRetentionPeriod
The number of days to retain Performance Insights data. The default is 7 days.
The following values are valid:
* 7
* month * 31, where month is a number of months from 1-23
* 731
For example, the following values are valid:
* 93 (3 months * 31)
* 341 (11 months * 31)
* 589 (19 months * 31)
* 731
If you specify a retention period such as 94, which isn't a valid value, RDS
issues an error.
This setting doesn't apply to RDS Custom.
Type: Integer
Required: No
Port
The port number on which the database accepts connections.
MySQL
Default: 3306
Valid values: 1150-65535
Type: Integer
MariaDB
Default: 3306
Valid values: 1150-65535
Type: Integer
PostgreSQL
Default: 5432
Valid values: 1150-65535
Type: Integer
Oracle
Default: 1521
Valid values: 1150-65535
SQL Server
Default: 1433
Valid values: 1150-65535 except 1234, 1434, 3260, 3343, 3389, 47001, and
49152-49156.
Amazon Aurora
Default: 3306
Valid values: 1150-65535
Type: Integer
Type: Integer
Required: No
PreferredBackupWindow
The daily time range during which automated backups are created if automated
backups are enabled, using the BackupRetentionPeriod parameter. The default is a
30-minute window selected at random from an 8-hour block of time for each AWS
Region. For more information, see Backup window in the Amazon RDS User Guide.
Amazon Aurora
Not applicable. The daily time range for creating automated backups is managed
by the DB cluster.
Constraints:
* Must be in the format hh24:mi-hh24:mi.
* Must be in Universal Coordinated Time (UTC).
* Must not conflict with the preferred maintenance window.
* Must be at least 30 minutes.
Type: String
Required: No
PreferredMaintenanceWindow
The time range each week during which system maintenance can occur, in Universal
Coordinated Time (UTC). For more information, see Amazon RDS Maintenance Window.
Format: ddd:hh24:mi-ddd:hh24:mi
The default is a 30-minute window selected at random from an 8-hour block of
time for each AWS Region, occurring on a random day of the week.
Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
Constraints: Minimum 30-minute window.
Type: String
Required: No
ProcessorFeatures.ProcessorFeature.N
The number of CPU cores and the number of threads per core for the DB instance
class of the DB instance.
This setting doesn't apply to RDS Custom.
Amazon Aurora
Not applicable.
Type: Array of ProcessorFeature objects
Required: No
PromotionTier
A value that specifies the order in which an Aurora Replica is promoted to the
primary instance after a failure of the existing primary instance. For more
information, see Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora
User Guide.
This setting doesn't apply to RDS Custom.
Default: 1
Valid Values: 0 - 15
Type: Integer
Required: No
PubliclyAccessible
A value that indicates whether the DB instance is publicly accessible.
When the DB instance is publicly accessible, its Domain Name System (DNS)
endpoint resolves to the private IP address from within the DB instance's
virtual private cloud (VPC). It resolves to the public IP address from outside
of the DB instance's VPC. Access to the DB instance is ultimately controlled by
the security group it uses. That public access is not permitted if the security
group assigned to the DB instance doesn't permit it.
When the DB instance isn't publicly accessible, it is an internal DB instance
with a DNS name that resolves to a private IP address.
Default: The default behavior varies depending on whether DBSubnetGroupName is
specified.
If DBSubnetGroupName isn't specified, and PubliclyAccessible isn't specified,
the following applies:
* If the default VPC in the target Region doesn’t have an internet gateway
attached to it, the DB instance is private.
* If the default VPC in the target Region has an internet gateway attached to
it, the DB instance is public.
If DBSubnetGroupName is specified, and PubliclyAccessible isn't specified, the
following applies:
* If the subnets are part of a VPC that doesn’t have an internet gateway
attached to it, the DB instance is private.
* If the subnets are part of a VPC that has an internet gateway attached to it,
the DB instance is public.
Type: Boolean
Required: No
StorageEncrypted
A value that indicates whether the DB instance is encrypted. By default, it
isn't encrypted.
For RDS Custom instances, either set this parameter to true or leave it unset.
If you set this parameter to false, RDS reports an error.
Amazon Aurora
Not applicable. The encryption for DB instances is managed by the DB cluster.
Type: Boolean
Required: No
StorageThroughput
Specifies the storage throughput value for the DB instance.
This setting applies only to the gp3 storage type.
This setting doesn't apply to RDS Custom or Amazon Aurora.
Type: Integer
Required: No
StorageType
Specifies the storage type to be associated with the DB instance.
Valid values: gp2 | gp3 | io1 | standard
If you specify io1 or gp3, you must also include a value for the Iops parameter.
Default: io1 if the Iops parameter is specified, otherwise gp2
Amazon Aurora
Not applicable. Storage is managed by the DB cluster.
Type: String
Required: No
Tags.Tag.N
Tags to assign to the DB instance.
Type: Array of Tag objects
Required: No
TdeCredentialArn
The ARN from the key store with which to associate the instance for TDE
encryption.
This setting doesn't apply to RDS Custom.
Amazon Aurora
Not applicable.
Type: String
Required: No
TdeCredentialPassword
The password for the given ARN from the key store in order to access the device.
This setting doesn't apply to RDS Custom.
Type: String
Required: No
Timezone
The time zone of the DB instance. The time zone parameter is currently supported
only by Microsoft SQL Server.
Type: String
Required: No
VpcSecurityGroupIds.VpcSecurityGroupId.N
A list of Amazon EC2 VPC security groups to associate with this DB instance.
Amazon Aurora
Not applicable. The associated list of EC2 VPC security groups is managed by the
DB cluster.
Default: The default EC2 VPC security group for the DB subnet group's VPC.
Type: Array of strings
Required: No
RESPONSE ELEMENTS
The following element is returned by the service.
DBInstance
Contains the details of an Amazon RDS DB instance.
This data type is used as a response element in the operations CreateDBInstance,
CreateDBInstanceReadReplica, DeleteDBInstance, DescribeDBInstances,
ModifyDBInstance, PromoteReadReplica, RebootDBInstance,
RestoreDBInstanceFromDBSnapshot, RestoreDBInstanceFromS3,
RestoreDBInstanceToPointInTime, StartDBInstance, and StopDBInstance.
Type: DBInstance object
ERRORS
For information about the errors that are common to all actions, see Common
Errors.
AuthorizationNotFound
The specified CIDR IP range or Amazon EC2 security group might not be authorized
for the specified DB security group.
Or, RDS might not be authorized to perform necessary actions using IAM on your
behalf.
HTTP Status Code: 404
BackupPolicyNotFoundFault
This error has been deprecated.
HTTP Status Code: 404
DBClusterNotFoundFault
DBClusterIdentifier doesn't refer to an existing DB cluster.
HTTP Status Code: 404
DBInstanceAlreadyExists
The user already has a DB instance with the given identifier.
HTTP Status Code: 400
DBParameterGroupNotFound
DBParameterGroupName doesn't refer to an existing DB parameter group.
HTTP Status Code: 404
DBSecurityGroupNotFound
DBSecurityGroupName doesn't refer to an existing DB security group.
HTTP Status Code: 404
DBSubnetGroupDoesNotCoverEnoughAZs
Subnets in the DB subnet group should cover at least two Availability Zones
unless there is only one Availability Zone.
HTTP Status Code: 400
DBSubnetGroupNotFoundFault
DBSubnetGroupName doesn't refer to an existing DB subnet group.
HTTP Status Code: 404
DomainNotFoundFault
Domain doesn't refer to an existing Active Directory domain.
HTTP Status Code: 404
InstanceQuotaExceeded
The request would result in the user exceeding the allowed number of DB
instances.
HTTP Status Code: 400
InsufficientDBInstanceCapacity
The specified DB instance class isn't available in the specified Availability
Zone.
HTTP Status Code: 400
InvalidDBClusterStateFault
The requested operation can't be performed while the cluster is in this state.
HTTP Status Code: 400
InvalidSubnet
The requested subnet is invalid, or multiple subnets were requested that are not
all in a common VPC.
HTTP Status Code: 400
InvalidVPCNetworkStateFault
The DB subnet group doesn't cover all Availability Zones after it's created
because of users' change.
HTTP Status Code: 400
KMSKeyNotAccessibleFault
An error occurred accessing an AWS KMS key.
HTTP Status Code: 400
NetworkTypeNotSupported
The network type is invalid for the DB instance. Valid nework type values are
IPV4 and DUAL.
HTTP Status Code: 400
OptionGroupNotFoundFault
The specified option group could not be found.
HTTP Status Code: 404
ProvisionedIopsNotAvailableInAZFault
Provisioned IOPS not available in the specified Availability Zone.
HTTP Status Code: 400
StorageQuotaExceeded
The request would result in the user exceeding the allowed amount of storage
available across all DB instances.
HTTP Status Code: 400
StorageTypeNotSupported
Storage of the StorageType specified can't be associated with the DB instance.
HTTP Status Code: 400
EXAMPLES
EXAMPLE
This example illustrates one usage of CreateDBInstance.
SAMPLE REQUEST
https://rds.us-east-1.amazonaws.com/
?Action=CreateDBInstance
&AllocatedStorage=15
&DBInstanceClass=db.m5.large
&DBInstanceIdentifier=myawsuser-dbi01
&Engine=MySQL
&MasterUserPassword=<password>
&MasterUsername=myawsuser
&SignatureMethod=HmacSHA256
&SignatureVersion=4
&Version=2014-09-01
&X-Amz-Algorithm=AWS4-HMAC-SHA256
&X-Amz-Credential=AKIADQKE4SARGYLE/20140424/us-east-1/rds/aws4_request
&X-Amz-Date=20140424T194844Z
&X-Amz-SignedHeaders=content-type;host;user-agent;x-amz-content-sha256;x-amz-date
&X-Amz-Signature=bee4aabc750bf7dad0cd9e22b952bd6089d91e2a16592c2293e532eeaab8bc77
SAMPLE RESPONSE
<CreateDBInstanceResponse xmlns="http://rds.amazonaws.com/doc/2014-09-01/">
<CreateDBInstanceResult>
<DBInstance>
<BackupRetentionPeriod>7</BackupRetentionPeriod>
<DBInstanceStatus>creating</DBInstanceStatus>
<MultiAZ>false</MultiAZ>
<VpcSecurityGroups/>
<DBInstanceIdentifier>myawsuser-dbi01</DBInstanceIdentifier>
<PreferredBackupWindow>03:50-04:20</PreferredBackupWindow>
<PreferredMaintenanceWindow>wed:06:38-wed:07:08</PreferredMaintenanceWindow>
<ReadReplicaDBInstanceIdentifiers/>
<Engine>mysql</Engine>
<PendingModifiedValues>
<MasterUserPassword>****</MasterUserPassword>
</PendingModifiedValues>
<LicenseModel>general-public-license</LicenseModel>
<EngineVersion>5.6.13</EngineVersion>
<DBParameterGroups>
<DBParameterGroup>
<ParameterApplyStatus>in-sync</ParameterApplyStatus>
<DBParameterGroupName>default.mysql5.6</DBParameterGroupName>
</DBParameterGroup>
</DBParameterGroups>
<OptionGroupMemberships>
<OptionGroupMembership>
<OptionGroupName>default:mysql-5-6</OptionGroupName>
<Status>in-sync</Status>
</OptionGroupMembership>
</OptionGroupMemberships>
<DBSecurityGroups>
<DBSecurityGroup>
<Status>active</Status>
<DBSecurityGroupName>default</DBSecurityGroupName>
</DBSecurityGroup>
</DBSecurityGroups>
<PubliclyAccessible>true</PubliclyAccessible>
<AutoMinorVersionUpgrade>true</AutoMinorVersionUpgrade>
<AllocatedStorage>15</AllocatedStorage>
<DBInstanceClass>db.m5.large</DBInstanceClass>
<MasterUsername>myawsuser</MasterUsername>
</DBInstance>
</CreateDBInstanceResult>
<ResponseMetadata>
<RequestId>523e3218-afc7-11c3-90f5-f90431260ab4</RequestId>
</ResponseMetadata>
</CreateDBInstanceResponse>
SEE ALSO
For more information about using this API in one of the language-specific AWS
SDKs, see the following:
* AWS Command Line Interface
* AWS SDK for .NET
* AWS SDK for C++
* AWS SDK for Go
* AWS SDK for Java V2
* AWS SDK for JavaScript
* AWS SDK for PHP V3
* AWS SDK for Python
* AWS SDK for Ruby V3
Javascript is disabled or is unavailable in your browser.
To use the Amazon Web Services Documentation, Javascript must be enabled. Please
refer to your browser's Help pages for instructions.
Document Conventions
CreateDBClusterSnapshot
CreateDBInstanceReadReplica
Did this page help you? - Yes
Thanks for letting us know we're doing a good job!
If you've got a moment, please tell us what we did right so we can do more of
it.
Did this page help you? - No
Thanks for letting us know this page needs work. We're sorry we let you down.
If you've got a moment, please tell us how we can make the documentation better.
Did this page help you?
Yes
No
Provide feedback
Next topic:CreateDBInstanceReadReplica
Previous topic:CreateDBClusterSnapshot
Need help?
* Try AWS re:Post
* Connect with an AWS IQ expert
PrivacySite termsCookie preferences
© 2022, Amazon Web Services, Inc. or its affiliates. All rights reserved.
On this page
--------------------------------------------------------------------------------
* Request Parameters
* Response Elements
* Errors
* Examples
* See Also
DID THIS PAGE HELP YOU? - NO
Thanks for letting us know this page needs work. We're sorry we let you down.
If you've got a moment, please tell us how we can make the documentation better.
Feedback