Navigation Guide
You 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

Loading code editor