- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
CreateDBInstanceCommand
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.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { RDSClient, CreateDBInstanceCommand } from "@aws-sdk/client-rds"; // ES Modules import
// const { RDSClient, CreateDBInstanceCommand } = require("@aws-sdk/client-rds"); // CommonJS import
const client = new RDSClient(config);
const input = { // CreateDBInstanceMessage
DBName: "STRING_VALUE",
DBInstanceIdentifier: "STRING_VALUE", // required
AllocatedStorage: Number("int"),
DBInstanceClass: "STRING_VALUE", // required
Engine: "STRING_VALUE", // required
MasterUsername: "STRING_VALUE",
MasterUserPassword: "STRING_VALUE",
DBSecurityGroups: [ // DBSecurityGroupNameList
"STRING_VALUE",
],
VpcSecurityGroupIds: [ // VpcSecurityGroupIdList
"STRING_VALUE",
],
AvailabilityZone: "STRING_VALUE",
DBSubnetGroupName: "STRING_VALUE",
PreferredMaintenanceWindow: "STRING_VALUE",
DBParameterGroupName: "STRING_VALUE",
BackupRetentionPeriod: Number("int"),
PreferredBackupWindow: "STRING_VALUE",
Port: Number("int"),
MultiAZ: true || false,
EngineVersion: "STRING_VALUE",
AutoMinorVersionUpgrade: true || false,
LicenseModel: "STRING_VALUE",
Iops: Number("int"),
OptionGroupName: "STRING_VALUE",
CharacterSetName: "STRING_VALUE",
NcharCharacterSetName: "STRING_VALUE",
PubliclyAccessible: true || false,
Tags: [ // TagList
{ // Tag
Key: "STRING_VALUE",
Value: "STRING_VALUE",
},
],
DBClusterIdentifier: "STRING_VALUE",
StorageType: "STRING_VALUE",
TdeCredentialArn: "STRING_VALUE",
TdeCredentialPassword: "STRING_VALUE",
StorageEncrypted: true || false,
KmsKeyId: "STRING_VALUE",
Domain: "STRING_VALUE",
DomainFqdn: "STRING_VALUE",
DomainOu: "STRING_VALUE",
DomainAuthSecretArn: "STRING_VALUE",
DomainDnsIps: [ // StringList
"STRING_VALUE",
],
CopyTagsToSnapshot: true || false,
MonitoringInterval: Number("int"),
MonitoringRoleArn: "STRING_VALUE",
DomainIAMRoleName: "STRING_VALUE",
PromotionTier: Number("int"),
Timezone: "STRING_VALUE",
EnableIAMDatabaseAuthentication: true || false,
DatabaseInsightsMode: "standard" || "advanced",
EnablePerformanceInsights: true || false,
PerformanceInsightsKMSKeyId: "STRING_VALUE",
PerformanceInsightsRetentionPeriod: Number("int"),
EnableCloudwatchLogsExports: [ // LogTypeList
"STRING_VALUE",
],
ProcessorFeatures: [ // ProcessorFeatureList
{ // ProcessorFeature
Name: "STRING_VALUE",
Value: "STRING_VALUE",
},
],
DeletionProtection: true || false,
MaxAllocatedStorage: Number("int"),
EnableCustomerOwnedIp: true || false,
CustomIamInstanceProfile: "STRING_VALUE",
BackupTarget: "STRING_VALUE",
NetworkType: "STRING_VALUE",
StorageThroughput: Number("int"),
ManageMasterUserPassword: true || false,
MasterUserSecretKmsKeyId: "STRING_VALUE",
CACertificateIdentifier: "STRING_VALUE",
DBSystemId: "STRING_VALUE",
DedicatedLogVolume: true || false,
MultiTenant: true || false,
EngineLifecycleSupport: "STRING_VALUE",
};
const command = new CreateDBInstanceCommand(input);
const response = await client.send(command);
// { // CreateDBInstanceResult
// DBInstance: { // DBInstance
// DBInstanceIdentifier: "STRING_VALUE",
// DBInstanceClass: "STRING_VALUE",
// Engine: "STRING_VALUE",
// DBInstanceStatus: "STRING_VALUE",
// AutomaticRestartTime: new Date("TIMESTAMP"),
// MasterUsername: "STRING_VALUE",
// DBName: "STRING_VALUE",
// Endpoint: { // Endpoint
// Address: "STRING_VALUE",
// Port: Number("int"),
// HostedZoneId: "STRING_VALUE",
// },
// AllocatedStorage: Number("int"),
// InstanceCreateTime: new Date("TIMESTAMP"),
// PreferredBackupWindow: "STRING_VALUE",
// BackupRetentionPeriod: Number("int"),
// DBSecurityGroups: [ // DBSecurityGroupMembershipList
// { // DBSecurityGroupMembership
// DBSecurityGroupName: "STRING_VALUE",
// Status: "STRING_VALUE",
// },
// ],
// VpcSecurityGroups: [ // VpcSecurityGroupMembershipList
// { // VpcSecurityGroupMembership
// VpcSecurityGroupId: "STRING_VALUE",
// Status: "STRING_VALUE",
// },
// ],
// DBParameterGroups: [ // DBParameterGroupStatusList
// { // DBParameterGroupStatus
// DBParameterGroupName: "STRING_VALUE",
// ParameterApplyStatus: "STRING_VALUE",
// },
// ],
// AvailabilityZone: "STRING_VALUE",
// DBSubnetGroup: { // DBSubnetGroup
// DBSubnetGroupName: "STRING_VALUE",
// DBSubnetGroupDescription: "STRING_VALUE",
// VpcId: "STRING_VALUE",
// SubnetGroupStatus: "STRING_VALUE",
// Subnets: [ // SubnetList
// { // Subnet
// SubnetIdentifier: "STRING_VALUE",
// SubnetAvailabilityZone: { // AvailabilityZone
// Name: "STRING_VALUE",
// },
// SubnetOutpost: { // Outpost
// Arn: "STRING_VALUE",
// },
// SubnetStatus: "STRING_VALUE",
// },
// ],
// DBSubnetGroupArn: "STRING_VALUE",
// SupportedNetworkTypes: [ // StringList
// "STRING_VALUE",
// ],
// },
// PreferredMaintenanceWindow: "STRING_VALUE",
// PendingModifiedValues: { // PendingModifiedValues
// DBInstanceClass: "STRING_VALUE",
// AllocatedStorage: Number("int"),
// MasterUserPassword: "STRING_VALUE",
// Port: Number("int"),
// BackupRetentionPeriod: Number("int"),
// MultiAZ: true || false,
// EngineVersion: "STRING_VALUE",
// LicenseModel: "STRING_VALUE",
// Iops: Number("int"),
// DBInstanceIdentifier: "STRING_VALUE",
// StorageType: "STRING_VALUE",
// CACertificateIdentifier: "STRING_VALUE",
// DBSubnetGroupName: "STRING_VALUE",
// PendingCloudwatchLogsExports: { // PendingCloudwatchLogsExports
// LogTypesToEnable: [ // LogTypeList
// "STRING_VALUE",
// ],
// LogTypesToDisable: [
// "STRING_VALUE",
// ],
// },
// ProcessorFeatures: [ // ProcessorFeatureList
// { // ProcessorFeature
// Name: "STRING_VALUE",
// Value: "STRING_VALUE",
// },
// ],
// IAMDatabaseAuthenticationEnabled: true || false,
// AutomationMode: "full" || "all-paused",
// ResumeFullAutomationModeTime: new Date("TIMESTAMP"),
// StorageThroughput: Number("int"),
// Engine: "STRING_VALUE",
// DedicatedLogVolume: true || false,
// MultiTenant: true || false,
// },
// LatestRestorableTime: new Date("TIMESTAMP"),
// MultiAZ: true || false,
// EngineVersion: "STRING_VALUE",
// AutoMinorVersionUpgrade: true || false,
// ReadReplicaSourceDBInstanceIdentifier: "STRING_VALUE",
// ReadReplicaDBInstanceIdentifiers: [ // ReadReplicaDBInstanceIdentifierList
// "STRING_VALUE",
// ],
// ReadReplicaDBClusterIdentifiers: [ // ReadReplicaDBClusterIdentifierList
// "STRING_VALUE",
// ],
// ReplicaMode: "open-read-only" || "mounted",
// LicenseModel: "STRING_VALUE",
// Iops: Number("int"),
// OptionGroupMemberships: [ // OptionGroupMembershipList
// { // OptionGroupMembership
// OptionGroupName: "STRING_VALUE",
// Status: "STRING_VALUE",
// },
// ],
// CharacterSetName: "STRING_VALUE",
// NcharCharacterSetName: "STRING_VALUE",
// SecondaryAvailabilityZone: "STRING_VALUE",
// PubliclyAccessible: true || false,
// StatusInfos: [ // DBInstanceStatusInfoList
// { // DBInstanceStatusInfo
// StatusType: "STRING_VALUE",
// Normal: true || false,
// Status: "STRING_VALUE",
// Message: "STRING_VALUE",
// },
// ],
// StorageType: "STRING_VALUE",
// TdeCredentialArn: "STRING_VALUE",
// DbInstancePort: Number("int"),
// DBClusterIdentifier: "STRING_VALUE",
// StorageEncrypted: true || false,
// KmsKeyId: "STRING_VALUE",
// DbiResourceId: "STRING_VALUE",
// CACertificateIdentifier: "STRING_VALUE",
// DomainMemberships: [ // DomainMembershipList
// { // DomainMembership
// Domain: "STRING_VALUE",
// Status: "STRING_VALUE",
// FQDN: "STRING_VALUE",
// IAMRoleName: "STRING_VALUE",
// OU: "STRING_VALUE",
// AuthSecretArn: "STRING_VALUE",
// DnsIps: [
// "STRING_VALUE",
// ],
// },
// ],
// CopyTagsToSnapshot: true || false,
// MonitoringInterval: Number("int"),
// EnhancedMonitoringResourceArn: "STRING_VALUE",
// MonitoringRoleArn: "STRING_VALUE",
// PromotionTier: Number("int"),
// DBInstanceArn: "STRING_VALUE",
// Timezone: "STRING_VALUE",
// IAMDatabaseAuthenticationEnabled: true || false,
// DatabaseInsightsMode: "standard" || "advanced",
// PerformanceInsightsEnabled: true || false,
// PerformanceInsightsKMSKeyId: "STRING_VALUE",
// PerformanceInsightsRetentionPeriod: Number("int"),
// EnabledCloudwatchLogsExports: [
// "STRING_VALUE",
// ],
// ProcessorFeatures: [
// {
// Name: "STRING_VALUE",
// Value: "STRING_VALUE",
// },
// ],
// DeletionProtection: true || false,
// AssociatedRoles: [ // DBInstanceRoles
// { // DBInstanceRole
// RoleArn: "STRING_VALUE",
// FeatureName: "STRING_VALUE",
// Status: "STRING_VALUE",
// },
// ],
// ListenerEndpoint: {
// Address: "STRING_VALUE",
// Port: Number("int"),
// HostedZoneId: "STRING_VALUE",
// },
// MaxAllocatedStorage: Number("int"),
// TagList: [ // TagList
// { // Tag
// Key: "STRING_VALUE",
// Value: "STRING_VALUE",
// },
// ],
// DBInstanceAutomatedBackupsReplications: [ // DBInstanceAutomatedBackupsReplicationList
// { // DBInstanceAutomatedBackupsReplication
// DBInstanceAutomatedBackupsArn: "STRING_VALUE",
// },
// ],
// CustomerOwnedIpEnabled: true || false,
// AwsBackupRecoveryPointArn: "STRING_VALUE",
// ActivityStreamStatus: "stopped" || "starting" || "started" || "stopping",
// ActivityStreamKmsKeyId: "STRING_VALUE",
// ActivityStreamKinesisStreamName: "STRING_VALUE",
// ActivityStreamMode: "sync" || "async",
// ActivityStreamEngineNativeAuditFieldsIncluded: true || false,
// AutomationMode: "full" || "all-paused",
// ResumeFullAutomationModeTime: new Date("TIMESTAMP"),
// CustomIamInstanceProfile: "STRING_VALUE",
// BackupTarget: "STRING_VALUE",
// NetworkType: "STRING_VALUE",
// ActivityStreamPolicyStatus: "locked" || "unlocked" || "locking-policy" || "unlocking-policy",
// StorageThroughput: Number("int"),
// DBSystemId: "STRING_VALUE",
// MasterUserSecret: { // MasterUserSecret
// SecretArn: "STRING_VALUE",
// SecretStatus: "STRING_VALUE",
// KmsKeyId: "STRING_VALUE",
// },
// CertificateDetails: { // CertificateDetails
// CAIdentifier: "STRING_VALUE",
// ValidTill: new Date("TIMESTAMP"),
// },
// ReadReplicaSourceDBClusterIdentifier: "STRING_VALUE",
// PercentProgress: "STRING_VALUE",
// DedicatedLogVolume: true || false,
// IsStorageConfigUpgradeAvailable: true || false,
// MultiTenant: true || false,
// EngineLifecycleSupport: "STRING_VALUE",
// },
// };
Example Usage
CreateDBInstanceCommand Input
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
DBInstanceClass Required | string | undefined | The compute and memory capacity of the DB instance, for example |
DBInstanceIdentifier Required | string | undefined | The identifier for this DB instance. This parameter is stored as a lowercase string. Constraints:
Example: |
Engine Required | string | undefined | The database engine to use for this DB instance. Not every database engine is available in every Amazon Web Services Region. Valid Values:
|
AllocatedStorage | number | undefined | The amount of storage in gibibytes (GiB) to allocate for the DB instance. This setting doesn't apply to Amazon Aurora DB instances. 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.
|
AutoMinorVersionUpgrade | boolean | undefined | Specifies 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 For more information about automatic minor version upgrades, see Automatically upgrading the minor engine version . |
AvailabilityZone | string | undefined | The Availability Zone (AZ) where the database will be created. For information on Amazon Web Services Regions and Availability Zones, see Regions and Availability Zones . For 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 Amazon Web Services Region. Constraints:
Example: |
BackupRetentionPeriod | number | undefined | The number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. Setting this parameter to This setting doesn't apply to Amazon Aurora DB instances. The retention period for automated backups is managed by the DB cluster. Default: Constraints:
|
BackupTarget | string | undefined | The location for storing automated backups and manual snapshots. Valid Values:
Default: For more information, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide. |
CACertificateIdentifier | string | undefined | The CA certificate identifier to use for the DB instance's server certificate. This setting doesn't apply to RDS Custom DB instances. For more information, see Using SSL/TLS to encrypt a connection to a DB instance in the Amazon RDS User Guide and Using SSL/TLS to encrypt a connection to a DB cluster in the Amazon Aurora User Guide. |
CharacterSetName | string | undefined | For supported engines, the character set ( This setting doesn't apply to the following DB instances:
|
CopyTagsToSnapshot | boolean | undefined | Specifies whether to copy tags from the DB instance to snapshots of the DB instance. By default, tags are not copied. This setting doesn't apply to Amazon Aurora DB instances. 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. |
CustomIamInstanceProfile | string | undefined | The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance. This setting is required for RDS Custom. Constraints:
For the list of permissions required for the IAM role, see Configure IAM and your VPC in the Amazon RDS User Guide. |
DBClusterIdentifier | string | undefined | The identifier of the DB cluster that this DB instance will belong to. This setting doesn't apply to RDS Custom DB instances. |
DBName | string | undefined | The meaning of this parameter differs according to the database engine you use.
|
DBParameterGroupName | string | undefined | The name of the DB parameter group to associate with this DB instance. If you don't specify a value, then Amazon RDS uses the default DB parameter group for the specified DB engine and version. This setting doesn't apply to RDS Custom DB instances. Constraints:
|
DBSecurityGroups | string[] | undefined | 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 |
DBSubnetGroupName | string | undefined | A DB subnet group to associate with this DB instance. Constraints:
Example: |
DBSystemId | string | undefined | The Oracle system identifier (SID), which is the name of the Oracle database instance that manages your database files. In this context, the term "Oracle database instance" refers exclusively to the system global area (SGA) and Oracle background processes. If you don't specify a SID, the value defaults to |
DatabaseInsightsMode | DatabaseInsightsMode | undefined | The mode of Database Insights to enable for the DB instance. Aurora DB instances inherit this value from the DB cluster, so you can't change this value. |
DedicatedLogVolume | boolean | undefined | Indicates whether the DB instance has a dedicated log volume (DLV) enabled. |
DeletionProtection | boolean | undefined | Specifies 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 . This setting doesn't apply to Amazon Aurora DB instances. You can enable or disable deletion protection for the DB cluster. For more information, see |
Domain | string | undefined | The Active Directory directory ID to create the DB instance in. Currently, you can create only Db2, MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances in an Active Directory Domain. For more information, see Kerberos Authentication in the Amazon RDS User Guide. This setting doesn't apply to the following DB instances:
|
DomainAuthSecretArn | string | undefined | The ARN for the Secrets Manager secret with the credentials for the user joining the domain. Example: |
DomainDnsIps | string[] | undefined | The IPv4 DNS IP addresses of your primary and secondary Active Directory domain controllers. Constraints:
Example: |
DomainFqdn | string | undefined | The fully qualified domain name (FQDN) of an Active Directory domain. Constraints:
Example: |
DomainIAMRoleName | string | undefined | The name of the IAM role to use when making API calls to the Directory Service. This setting doesn't apply to the following DB instances:
|
DomainOu | string | undefined | The Active Directory organizational unit for your DB instance to join. Constraints:
Example: |
EnableCloudwatchLogsExports | string[] | undefined | The list of log types to enable for exporting to CloudWatch Logs. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide. This setting doesn't apply to the following DB instances:
The following values are valid for each DB engine:
|
EnableCustomerOwnedIp | boolean | undefined | Specifies 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 Amazon Web Services Outposts in the Amazon RDS User Guide. For more information about CoIPs, see Customer-owned IP addresses in the Amazon Web Services Outposts User Guide. |
EnableIAMDatabaseAuthentication | boolean | undefined | Specifies whether to enable mapping of Amazon Web Services 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 the following DB instances:
|
EnablePerformanceInsights | boolean | undefined | Specifies 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 DB instances. |
EngineLifecycleSupport | string | undefined | The life cycle type for this DB instance. By default, this value is set to This setting applies only to RDS for MySQL and RDS for PostgreSQL. For Amazon Aurora DB instances, the life cycle type is managed by the DB cluster. You can use this setting to enroll your DB instance into Amazon RDS Extended Support. With RDS Extended Support, you can run the selected major engine version on your DB instance past the end of standard support for that engine version. For more information, see Amazon RDS Extended Support with Amazon RDS in the Amazon RDS User Guide. Valid Values: Default: |
EngineVersion | string | undefined | The version number of the database engine to use. This setting doesn't apply to Amazon Aurora DB instances. The version number of the database engine the DB instance uses is managed by the DB cluster. For a list of valid engine versions, use the 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 Amazon Web Services Region.
|
Iops | number | undefined | The amount of Provisioned IOPS (input/output operations per second) to initially allocate for the DB instance. For information about valid IOPS values, see Amazon RDS DB instance storage in the Amazon RDS User Guide. This setting doesn't apply to Amazon Aurora DB instances. Storage is managed by the DB cluster. Constraints:
|
KmsKeyId | string | undefined | The Amazon Web Services KMS key identifier for an encrypted DB instance. The Amazon Web Services 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 Amazon Web Services account, specify the key ARN or alias ARN. This setting doesn't apply to Amazon Aurora DB instances. The Amazon Web Services KMS key identifier is managed by the DB cluster. For more information, see If For Amazon RDS Custom, a KMS key is required for DB instances. For most RDS engines, if you leave this parameter empty while enabling |
LicenseModel | string | undefined | The license model information for this DB instance. License models for RDS for Db2 require additional configuration. The Bring Your Own License (BYOL) model requires a custom parameter group and an Amazon Web Services License Manager self-managed license. The Db2 license through Amazon Web Services Marketplace model requires an Amazon Web Services Marketplace subscription. For more information, see Amazon RDS for Db2 licensing options in the Amazon RDS User Guide. The default for RDS for Db2 is This setting doesn't apply to Amazon Aurora or RDS Custom DB instances. Valid Values:
|
ManageMasterUserPassword | boolean | undefined | Specifies whether to manage the master user password with Amazon Web Services Secrets Manager. For more information, see Password management with Amazon Web Services Secrets Manager in the Amazon RDS User Guide. Constraints:
|
MasterUserPassword | string | undefined | The password for the master user. This setting doesn't apply to Amazon Aurora DB instances. The password for the master user is managed by the DB cluster. Constraints:
Length Constraints:
|
MasterUserSecretKmsKeyId | string | undefined | The Amazon Web Services KMS key identifier to encrypt a secret that is automatically generated and managed in Amazon Web Services Secrets Manager. This setting is valid only if the master user password is managed by RDS in Amazon Web Services Secrets Manager for the DB instance. The Amazon Web Services 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 Amazon Web Services account, specify the key ARN or alias ARN. If you don't specify There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region. |
MasterUsername | string | undefined | The name for the master user. This setting doesn't apply to Amazon Aurora DB instances. The name for the master user is managed by the DB cluster. This setting is required for RDS DB instances. Constraints:
|
MaxAllocatedStorage | number | undefined | 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 the following DB instances:
|
MonitoringInterval | number | undefined | The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collection of Enhanced Monitoring metrics, specify If This setting doesn't apply to RDS Custom DB instances. Valid Values: Default: |
MonitoringRoleArn | string | undefined | The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For example, If This setting doesn't apply to RDS Custom DB instances. |
MultiAZ | boolean | undefined | Specifies whether the DB instance is a Multi-AZ deployment. You can't set the This setting doesn't apply to the following DB instances:
|
MultiTenant | boolean | undefined | Specifies whether to use the multi-tenant configuration or the single-tenant configuration (default). This parameter only applies to RDS for Oracle container database (CDB) engines. Note the following restrictions:
|
NcharCharacterSetName | string | undefined | The name of the NCHAR character set for the Oracle DB instance. This setting doesn't apply to RDS Custom DB instances. |
NetworkType | string | undefined | The network type of the DB instance. The network type is determined by the For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide. Valid Values: |
OptionGroupName | string | undefined | The option group to associate the DB instance with. 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 Amazon Aurora or RDS Custom DB instances. |
PerformanceInsightsKMSKeyId | string | undefined | The Amazon Web Services KMS key identifier for encryption of Performance Insights data. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. If you don't specify a value for This setting doesn't apply to RDS Custom DB instances. |
PerformanceInsightsRetentionPeriod | number | undefined | The number of days to retain Performance Insights data. This setting doesn't apply to RDS Custom DB instances. Valid Values:
Default: If you specify a retention period that isn't valid, such as |
Port | number | undefined | The port number on which the database accepts connections. This setting doesn't apply to Aurora DB instances. The port number is managed by the cluster. Valid Values: Default:
Constraints:
|
PreferredBackupWindow | string | undefined | The daily time range during which automated backups are created if automated backups are enabled, using the This setting doesn't apply to Amazon Aurora DB instances. The daily time range for creating automated backups is managed by the DB cluster. Constraints:
|
PreferredMaintenanceWindow | string | undefined | The time range each week during which system maintenance can occur. For more information, see Amazon RDS Maintenance Window in the Amazon RDS User Guide. The default is a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the week. Constraints:
|
ProcessorFeatures | ProcessorFeature[] | undefined | 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 Amazon Aurora or RDS Custom DB instances. |
PromotionTier | number | undefined | The order of priority 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 DB instances. Default: Valid Values: |
PubliclyAccessible | boolean | undefined | Specifies whether the DB instance is publicly accessible. When the DB instance is publicly accessible and you connect from outside of the DB instance's virtual private cloud (VPC), its Domain Name System (DNS) endpoint resolves to the public IP address. When you connect from within the same VPC as the DB instance, the endpoint resolves to the private IP address. 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 If
If
|
StorageEncrypted | boolean | undefined | Specifes whether the DB instance is encrypted. By default, it isn't encrypted. For RDS Custom DB instances, either enable this setting or leave it unset. Otherwise, Amazon RDS reports an error. This setting doesn't apply to Amazon Aurora DB instances. The encryption for DB instances is managed by the DB cluster. |
StorageThroughput | number | undefined | The storage throughput value, in mebibyte per second (MiBps), for the DB instance. This setting applies only to the This setting doesn't apply to Amazon Aurora or RDS Custom DB instances. |
StorageType | string | undefined | The storage type to associate with the DB instance. If you specify This setting doesn't apply to Amazon Aurora DB instances. Storage is managed by the DB cluster. Valid Values: Default: |
Tags | Tag[] | undefined | Tags to assign to the DB instance. |
TdeCredentialArn | string | undefined | The ARN from the key store with which to associate the instance for TDE encryption. This setting doesn't apply to Amazon Aurora or RDS Custom DB instances. |
TdeCredentialPassword | string | undefined | The password for the given ARN from the key store in order to access the device. This setting doesn't apply to RDS Custom DB instances. |
Timezone | string | undefined | The time zone of the DB instance. The time zone parameter is currently supported only by RDS for Db2 and RDS for SQL Server . |
VpcSecurityGroupIds | string[] | undefined | A list of Amazon EC2 VPC security groups to associate with this DB instance. This setting doesn't apply to Amazon Aurora DB instances. 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. |
CreateDBInstanceCommand Output
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
$metadata Required | ResponseMetadata | Metadata pertaining to this request. |
DBInstance | DBInstance | undefined | Contains the details of an Amazon RDS DB instance. This data type is used as a response element in the operations |
Throws
Name | Fault | Details |
---|
Name | Fault | Details |
---|---|---|
AuthorizationNotFoundFault | client | 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. |
BackupPolicyNotFoundFault | client | |
CertificateNotFoundFault | client | |
DBClusterNotFoundFault | client | |
DBInstanceAlreadyExistsFault | client | The user already has a DB instance with the given identifier. |
DBParameterGroupNotFoundFault | client | |
DBSecurityGroupNotFoundFault | client | |
DBSubnetGroupDoesNotCoverEnoughAZs | client | Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one Availability Zone. |
DBSubnetGroupNotFoundFault | client | |
DomainNotFoundFault | client | |
InstanceQuotaExceededFault | client | The request would result in the user exceeding the allowed number of DB instances. |
InsufficientDBInstanceCapacityFault | client | The specified DB instance class isn't available in the specified Availability Zone. |
InvalidDBClusterStateFault | client | The requested operation can't be performed while the cluster is in this state. |
InvalidSubnet | client | The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC. |
InvalidVPCNetworkStateFault | client | The DB subnet group doesn't cover all Availability Zones after it's created because of users' change. |
KMSKeyNotAccessibleFault | client | An error occurred accessing an Amazon Web Services KMS key. |
NetworkTypeNotSupported | client | The network type is invalid for the DB instance. Valid nework type values are |
OptionGroupNotFoundFault | client | The specified option group could not be found. |
ProvisionedIopsNotAvailableInAZFault | client | Provisioned IOPS not available in the specified Availability Zone. |
StorageQuotaExceededFault | client | The request would result in the user exceeding the allowed amount of storage available across all DB instances. |
StorageTypeNotSupportedFault | client | The specified |
TenantDatabaseQuotaExceededFault | client | You attempted to create more tenant databases than are permitted in your Amazon Web Services account. |
RDSServiceException | Base exception class for all service exceptions from RDS service. |