@aws-sdk/client-rds 3.306.0 → 3.309.0

package/dist-types/commands/AddRoleToDBClusterCommand.d.ts

@@ -55,6 +55,18 @@ export interface AddRoleToDBClusterCommandOutput extends __MetadataBearer {
  *  <p>The requested operation can't be performed while the cluster is in this state.</p>
  *
  *
+ * @example To associate an AWS Identity and Access Management (IAM) role with a DB cluster
+ * ```javascript
+ * // The following example associates a role with a DB cluster.
+ * const input = {
+ *   "DBClusterIdentifier": "mydbcluster",
+ *   "RoleArn": "arn:aws:iam::123456789012:role/RDSLoadFromS3"
+ * };
+ * const command = new AddRoleToDBClusterCommand(input);
+ * await client.send(command);
+ * // example id: to-associate-an-aws-identity-and-access-management-iam-role-with-a-db-cluster-1679691203006
+ * ```
+ *
  */
 export declare class AddRoleToDBClusterCommand extends $Command<AddRoleToDBClusterCommandInput, AddRoleToDBClusterCommandOutput, RDSClientResolvedConfig> {
     readonly input: AddRoleToDBClusterCommandInput;

package/dist-types/commands/AddRoleToDBInstanceCommand.d.ts

@@ -59,6 +59,19 @@ export interface AddRoleToDBInstanceCommandOutput extends __MetadataBearer {
  *  <p>The DB instance isn't in a valid state.</p>
  *
  *
+ * @example To associate an AWS Identity and Access Management (IAM) role with a DB instance
+ * ```javascript
+ * // The following example adds the role to a DB instance named test-instance.
+ * const input = {
+ *   "DBInstanceIdentifier": "test-instance",
+ *   "FeatureName": "S3_INTEGRATION",
+ *   "RoleArn": "arn:aws:iam::111122223333:role/rds-s3-integration-role"
+ * };
+ * const command = new AddRoleToDBInstanceCommand(input);
+ * await client.send(command);
+ * // example id: to-associate-an-aws-identity-and-access-management-iam-role-with-a-db-instance-1679691512295
+ * ```
+ *
  */
 export declare class AddRoleToDBInstanceCommand extends $Command<AddRoleToDBInstanceCommandInput, AddRoleToDBInstanceCommandOutput, RDSClientResolvedConfig> {
     readonly input: AddRoleToDBInstanceCommandInput;

package/dist-types/commands/AddSourceIdentifierToSubscriptionCommand.d.ts

@@ -47,21 +47,38 @@ export interface AddSourceIdentifierToSubscriptionCommandOutput extends AddSourc
  *  <p>The subscription name does not exist.</p>
  *
  *
- * @example To add a source identifier to an event notification subscription
+ * @example To add a source identifier to a subscription
  * ```javascript
- * // This example add a source identifier to an event notification subscription.
+ * // The following example adds another source identifier to an existing subscription.
  * const input = {
- *   "SourceIdentifier": "mymysqlinstance",
- *   "SubscriptionName": "mymysqleventsubscription"
+ *   "SourceIdentifier": "test-instance-repl",
+ *   "SubscriptionName": "my-instance-events"
  * };
  * const command = new AddSourceIdentifierToSubscriptionCommand(input);
  * const response = await client.send(command);
  * /* response ==
  * {
- *   "EventSubscription": {}
+ *   "EventSubscription": {
+ *     "CustSubscriptionId": "my-instance-events",
+ *     "CustomerAwsId": "123456789012",
+ *     "Enabled": false,
+ *     "EventCategoriesList": [
+ *       "backup",
+ *       "recovery"
+ *     ],
+ *     "EventSubscriptionArn": "arn:aws:rds:us-east-1:123456789012:es:my-instance-events",
+ *     "SnsTopicArn": "arn:aws:sns:us-east-1:123456789012:interesting-events",
+ *     "SourceIdsList": [
+ *       "test-instance",
+ *       "test-instance-repl"
+ *     ],
+ *     "SourceType": "db-instance",
+ *     "Status": "modifying",
+ *     "SubscriptionCreationTime": "Tue Jul 31 23:22:01 UTC 2018"
+ *   }
  * }
  * *\/
- * // example id: add-source-identifier-to-subscription-93fb6a15-0a59-4577-a7b5-e12db9752c14
+ * // example id: to-add-a-source-identifier-to-a-subscription-1679691771786
  * ```
  *
  */

package/dist-types/commands/ApplyPendingMaintenanceActionCommand.d.ts

@@ -51,22 +51,32 @@ export interface ApplyPendingMaintenanceActionCommandOutput extends ApplyPending
  *  <p>The specified resource ID was not found.</p>
  *
  *
- * @example To apply a pending maintenance action
+ * @example To apply pending maintenance actions
  * ```javascript
- * // This example immediately applies a pending system update to a DB instance.
+ * // The following example applies the pending maintenance actions for a DB cluster.
  * const input = {
  *   "ApplyAction": "system-update",
  *   "OptInType": "immediate",
- *   "ResourceIdentifier": "arn:aws:rds:us-east-1:992648334831:db:mymysqlinstance"
+ *   "ResourceIdentifier": "arn:aws:rds:us-east-1:123456789012:cluster:my-db-cluster"
  * };
  * const command = new ApplyPendingMaintenanceActionCommand(input);
  * const response = await client.send(command);
  * /* response ==
  * {
- *   "ResourcePendingMaintenanceActions": {}
+ *   "ResourcePendingMaintenanceActions": {
+ *     "PendingMaintenanceActionDetails": [
+ *       {
+ *         "Action": "system-update",
+ *         "CurrentApplyDate": "2021-01-23T01:07:36.100Z",
+ *         "Description": "Upgrade to Aurora PostgreSQL 3.3.2",
+ *         "OptInStatus": "immediate"
+ *       }
+ *     ],
+ *     "ResourceIdentifier": "arn:aws:rds:us-east-1:123456789012:cluster:my-db-cluster"
+ *   }
  * }
  * *\/
- * // example id: apply-pending-maintenance-action-2a026047-8bbb-47fc-b695-abad9f308c24
+ * // example id: to-apply-pending-maintenance-actions-1679692228896
  * ```
  *
  */

package/dist-types/commands/CancelExportTaskCommand.d.ts

@@ -47,6 +47,31 @@ export interface CancelExportTaskCommandOutput extends ExportTask, __MetadataBea
  *  <p>You can't cancel an export task that has completed.</p>
  *
  *
+ * @example To cancel a snapshot export to Amazon S3
+ * ```javascript
+ * // The following example cancels an export task in progress that is exporting a snapshot to Amazon S3.
+ * const input = {
+ *   "ExportTaskIdentifier": "my-s3-export-1"
+ * };
+ * const command = new CancelExportTaskCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "ExportTaskIdentifier": "my-s3-export-1",
+ *   "IamRoleArn": "arn:aws:iam::123456789012:role/service-role/export-snap-S3-role",
+ *   "KmsKeyId": "arn:aws:kms:us-east-1:123456789012:key/abcd0000-7bfd-4594-af38-aabbccddeeff",
+ *   "PercentProgress": 0,
+ *   "S3Bucket": "mybucket",
+ *   "S3Prefix": "",
+ *   "SnapshotTime": "2019-03-24T20:01:09.815Z",
+ *   "SourceArn": "arn:aws:rds:us-east-1:123456789012:snapshot:publisher-final-snapshot",
+ *   "Status": "CANCELING",
+ *   "TotalExtractedDataInGB": 0
+ * }
+ * *\/
+ * // example id: to-cancel-a-snapshot-export-to-amazon-s3-1679694286587
+ * ```
+ *
  */
 export declare class CancelExportTaskCommand extends $Command<CancelExportTaskCommandInput, CancelExportTaskCommandOutput, RDSClientResolvedConfig> {
     readonly input: CancelExportTaskCommandInput;

package/dist-types/commands/CopyDBClusterParameterGroupCommand.d.ts

@@ -72,7 +72,12 @@ export interface CopyDBClusterParameterGroupCommandOutput extends CopyDBClusterP
  * const response = await client.send(command);
  * /* response ==
  * {
- *   "DBClusterParameterGroup": {}
+ *   "DBClusterParameterGroup": {
+ *     "DBClusterParameterGroupArn": "arn:aws:rds:us-east-1:123456789012:cluster-pg:mydbclusterparametergroup-copy",
+ *     "DBClusterParameterGroupName": "mydbclusterparametergroup-copy",
+ *     "DBParameterGroupFamily": "aurora-mysql5.7",
+ *     "Description": "My DB cluster parameter group copy"
+ *   }
  * }
  * *\/
  * // example id: copy-db-cluster-parameter-group-6fefaffe-cde9-4dba-9f0b-d3f593572fe4

package/dist-types/commands/CopyDBClusterSnapshotCommand.d.ts

@@ -108,19 +108,44 @@ export interface CopyDBClusterSnapshotCommandOutput extends CopyDBClusterSnapsho
  *
  * @example To copy a DB cluster snapshot
  * ```javascript
- * // The following example copies an automated snapshot of a DB cluster to a new DB cluster snapshot.
+ * // The following example creates a copy of a DB cluster snapshot, including its tags.
  * const input = {
- *   "SourceDBClusterSnapshotIdentifier": "rds:sample-cluster-2016-09-14-10-38",
- *   "TargetDBClusterSnapshotIdentifier": "cluster-snapshot-copy-1"
+ *   "CopyTags": true,
+ *   "SourceDBClusterSnapshotIdentifier": "arn:aws:rds:us-east-1:123456789012:cluster-snapshot:rds:myaurora-2019-06-04-09-16",
+ *   "TargetDBClusterSnapshotIdentifier": "myclustersnapshotcopy"
  * };
  * const command = new CopyDBClusterSnapshotCommand(input);
  * const response = await client.send(command);
  * /* response ==
  * {
- *   "DBClusterSnapshot": {}
+ *   "DBClusterSnapshot": {
+ *     "AllocatedStorage": 0,
+ *     "AvailabilityZones": [
+ *       "us-east-1a",
+ *       "us-east-1b",
+ *       "us-east-1e"
+ *     ],
+ *     "ClusterCreateTime": "2019-04-15T14:18:42.785Z",
+ *     "DBClusterIdentifier": "myaurora",
+ *     "DBClusterSnapshotArn": "arn:aws:rds:us-east-1:123456789012:cluster-snapshot:myclustersnapshotcopy",
+ *     "DBClusterSnapshotIdentifier": "myclustersnapshotcopy",
+ *     "Engine": "aurora-mysql",
+ *     "EngineVersion": "5.7.mysql_aurora.2.04.2",
+ *     "IAMDatabaseAuthenticationEnabled": false,
+ *     "KmsKeyId": "arn:aws:kms:us-east-1:123456789012:key/AKIAIOSFODNN7EXAMPLE",
+ *     "LicenseModel": "aurora-mysql",
+ *     "MasterUsername": "myadmin",
+ *     "PercentProgress": 100,
+ *     "Port": 0,
+ *     "SnapshotCreateTime": "2019-06-04T09:16:42.649Z",
+ *     "SnapshotType": "manual",
+ *     "Status": "available",
+ *     "StorageEncrypted": true,
+ *     "VpcId": "vpc-123example"
+ *   }
  * }
  * *\/
- * // example id: to-copy-a-db-cluster-snapshot-1473879770564
+ * // example id: to-copy-a-db-cluster-snapshot-1679695109979
  * ```
  *
  */

package/dist-types/commands/CopyDBParameterGroupCommand.d.ts

@@ -62,20 +62,25 @@ export interface CopyDBParameterGroupCommandOutput extends CopyDBParameterGroupR
  *
  * @example To copy a DB parameter group
  * ```javascript
- * // This example copies a DB parameter group.
+ * // The following example makes a copy of a DB parameter group.
  * const input = {
- *   "SourceDBParameterGroupIdentifier": "mymysqlparametergroup",
- *   "TargetDBParameterGroupDescription": "My MySQL parameter group copy",
- *   "TargetDBParameterGroupIdentifier": "mymysqlparametergroup-copy"
+ *   "SourceDBParameterGroupIdentifier": "mydbpg",
+ *   "TargetDBParameterGroupDescription": "Copy of mydbpg parameter group",
+ *   "TargetDBParameterGroupIdentifier": "mydbpgcopy"
  * };
  * const command = new CopyDBParameterGroupCommand(input);
  * const response = await client.send(command);
  * /* response ==
  * {
- *   "DBParameterGroup": {}
+ *   "DBParameterGroup": {
+ *     "DBParameterGroupArn": "arn:aws:rds:us-east-1:814387698303:pg:mydbpgcopy",
+ *     "DBParameterGroupFamily": "mysql5.7",
+ *     "DBParameterGroupName": "mydbpgcopy",
+ *     "Description": "Copy of mydbpg parameter group"
+ *   }
  * }
  * *\/
- * // example id: copy-db-parameter-group-610d4dba-2c87-467f-ae5d-edd7f8e47349
+ * // example id: to-copy-a-db-parameter-group-1679695426993
  * ```
  *
  */

package/dist-types/commands/CopyDBSnapshotCommand.d.ts

@@ -84,19 +84,45 @@ export interface CopyDBSnapshotCommandOutput extends CopyDBSnapshotResult, __Met
  *
  * @example To copy a DB snapshot
  * ```javascript
- * // This example copies a DB snapshot.
+ * // The following example creates a copy of a DB snapshot.
  * const input = {
- *   "SourceDBSnapshotIdentifier": "mydbsnapshot",
- *   "TargetDBSnapshotIdentifier": "mydbsnapshot-copy"
+ *   "SourceDBSnapshotIdentifier": "rds:database-mysql-2019-06-06-08-38",
+ *   "TargetDBSnapshotIdentifier": "mydbsnapshotcopy"
  * };
  * const command = new CopyDBSnapshotCommand(input);
  * const response = await client.send(command);
  * /* response ==
  * {
- *   "DBSnapshot": {}
+ *   "DBSnapshot": {
+ *     "AllocatedStorage": 100,
+ *     "AvailabilityZone": "us-east-1f",
+ *     "DBInstanceIdentifier": "database-mysql",
+ *     "DBSnapshotArn": "arn:aws:rds:us-east-1:123456789012:snapshot:mydbsnapshotcopy",
+ *     "DBSnapshotIdentifier": "mydbsnapshotcopy",
+ *     "DbiResourceId": "db-ZI7UJ5BLKMBYFGX7FDENCKADC4",
+ *     "Encrypted": true,
+ *     "Engine": "mysql",
+ *     "EngineVersion": "5.6.40",
+ *     "IAMDatabaseAuthenticationEnabled": false,
+ *     "InstanceCreateTime": "2019-04-30T15:45:53.663Z",
+ *     "Iops": 1000,
+ *     "KmsKeyId": "arn:aws:kms:us-east-1:123456789012:key/AKIAIOSFODNN7EXAMPLE",
+ *     "LicenseModel": "general-public-license",
+ *     "MasterUsername": "admin",
+ *     "OptionGroupName": "default:mysql-5-6",
+ *     "PercentProgress": 0,
+ *     "Port": 3306,
+ *     "ProcessorFeatures": [],
+ *     "SnapshotType": "manual",
+ *     "SourceDBSnapshotIdentifier": "arn:aws:rds:us-east-1:123456789012:snapshot:rds:database-mysql-2019-06-06-08-38",
+ *     "SourceRegion": "us-east-1",
+ *     "Status": "creating",
+ *     "StorageType": "io1",
+ *     "VpcId": "vpc-6594f31c"
+ *   }
  * }
  * *\/
- * // example id: copy-db-snapshot-1b2f0210-bc67-415d-9822-6eecf447dc86
+ * // example id: to-copy-a-db-snapshot-1679695661487
  * ```
  *
  */

package/dist-types/commands/CopyOptionGroupCommand.d.ts

@@ -59,20 +59,28 @@ export interface CopyOptionGroupCommandOutput extends CopyOptionGroupResult, __M
  *
  * @example To copy an option group
  * ```javascript
- * // This example copies an option group.
+ * // The following example makes a copy of an option group.
  * const input = {
- *   "SourceOptionGroupIdentifier": "mymysqloptiongroup",
- *   "TargetOptionGroupDescription": "My MySQL option group copy",
- *   "TargetOptionGroupIdentifier": "mymysqloptiongroup-copy"
+ *   "SourceOptionGroupIdentifier": "myoptiongroup",
+ *   "TargetOptionGroupDescription": "My option group copy",
+ *   "TargetOptionGroupIdentifier": "new-option-group"
  * };
  * const command = new CopyOptionGroupCommand(input);
  * const response = await client.send(command);
  * /* response ==
  * {
- *   "OptionGroup": {}
+ *   "OptionGroup": {
+ *     "AllowsVpcAndNonVpcInstanceMemberships": true,
+ *     "EngineName": "oracle-ee",
+ *     "MajorEngineVersion": "11.2",
+ *     "OptionGroupArn": "arn:aws:rds:us-east-1:123456789012:og:new-option-group",
+ *     "OptionGroupDescription": "My option group copy",
+ *     "OptionGroupName": "new-option-group",
+ *     "Options": []
+ *   }
  * }
  * *\/
- * // example id: copy-option-group-8d5c01c3-8846-4e9c-a4b0-1b7237f7d0ec
+ * // example id: to-copy-an-option-group-1679695800102
  * ```
  *
  */

package/dist-types/commands/CreateBlueGreenDeploymentCommand.d.ts

@@ -105,6 +105,133 @@ export interface CreateBlueGreenDeploymentCommandOutput extends CreateBlueGreenD
  *  <p>The source DB instance isn't supported for a blue/green deployment.</p>
  *
  *
+ * @example To create a blue/green deployment for an RDS for MySQL DB instance
+ * ```javascript
+ * // The following example creates a blue/green deployment for a MySQL DB instance.
+ * const input = {
+ *   "BlueGreenDeploymentName": "bgd-test-instance",
+ *   "Source": "arn:aws:rds:us-east-1:123456789012:db:my-db-instance",
+ *   "TargetDBParameterGroupName": "mysql-80-group",
+ *   "TargetEngineVersion": "8.0"
+ * };
+ * const command = new CreateBlueGreenDeploymentCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "BlueGreenDeployment": {
+ *     "BlueGreenDeploymentIdentifier": "bgd-v53303651eexfake",
+ *     "BlueGreenDeploymentName": "bgd-cli-test-instance",
+ *     "CreateTime": "2022-02-25T21:18:51.183000+00:00",
+ *     "Source": "arn:aws:rds:us-east-1:123456789012:db:my-db-instance",
+ *     "Status": "PROVISIONING",
+ *     "SwitchoverDetails": [
+ *       {
+ *         "SourceMember": "arn:aws:rds:us-east-1:123456789012:db:my-db-instance"
+ *       },
+ *       {
+ *         "SourceMember": "arn:aws:rds:us-east-1:123456789012:db:my-db-instance-replica-1"
+ *       },
+ *       {
+ *         "SourceMember": "arn:aws:rds:us-east-1:123456789012:db:my-db-instance-replica-2"
+ *       },
+ *       {
+ *         "SourceMember": "arn:aws:rds:us-east-1:123456789012:db:my-db-instance-replica-3"
+ *       }
+ *     ],
+ *     "Tasks": [
+ *       {
+ *         "Name": "CREATING_READ_REPLICA_OF_SOURCE",
+ *         "Status": "PENDING"
+ *       },
+ *       {
+ *         "Name": "DB_ENGINE_VERSION_UPGRADE",
+ *         "Status": "PENDING"
+ *       },
+ *       {
+ *         "Name": "CONFIGURE_BACKUPS",
+ *         "Status": "PENDING"
+ *       },
+ *       {
+ *         "Name": "CREATING_TOPOLOGY_OF_SOURCE",
+ *         "Status": "PENDING"
+ *       }
+ *     ]
+ *   }
+ * }
+ * *\/
+ * // example id: to-create-a-bluegreen-deployment-for-an-rds-for-mysql-db-instance-1679688377231
+ * ```
+ *
+ * @example To create a blue/green deployment for an Aurora MySQL DB cluster
+ * ```javascript
+ * // The following example creates a blue/green deployment for an Aurora MySQL DB cluster.
+ * const input = {
+ *   "BlueGreenDeploymentName": "my-blue-green-deployment",
+ *   "Source": "arn:aws:rds:us-east-1:123456789012:cluster:my-aurora-mysql-cluster",
+ *   "TargetDBClusterParameterGroupName": "mysql-80-cluster-group",
+ *   "TargetDBParameterGroupName": "ams-80-binlog-enabled",
+ *   "TargetEngineVersion": "8.0"
+ * };
+ * const command = new CreateBlueGreenDeploymentCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "BlueGreenDeployment": {
+ *     "BlueGreenDeploymentIdentifier": "bgd-wi89nwzglccsfake",
+ *     "BlueGreenDeploymentName": "my-blue-green-deployment",
+ *     "CreateTime": "2022-02-25T21:12:00.288000+00:00",
+ *     "Source": "arn:aws:rds:us-east-1:123456789012:cluster:my-aurora-mysql-cluster",
+ *     "Status": "PROVISIONING",
+ *     "SwitchoverDetails": [
+ *       {
+ *         "SourceMember": "arn:aws:rds:us-east-1:123456789012:cluster:my-aurora-mysql-cluster",
+ *         "Status": "PROVISIONING"
+ *       },
+ *       {
+ *         "SourceMember": "arn:aws:rds:us-east-1:123456789012:db:my-aurora-mysql-cluster-1",
+ *         "Status": "PROVISIONING"
+ *       },
+ *       {
+ *         "SourceMember": "arn:aws:rds:us-east-1:123456789012:db:my-aurora-mysql-cluster-2",
+ *         "Status": "PROVISIONING"
+ *       },
+ *       {
+ *         "SourceMember": "arn:aws:rds:us-east-1:123456789012:db:my-aurora-mysql-cluster-3",
+ *         "Status": "PROVISIONING"
+ *       },
+ *       {
+ *         "SourceMember": "arn:aws:rds:us-east-1:123456789012:cluster-endpoint:my-excluded-member-endpoint",
+ *         "Status": "PROVISIONING"
+ *       },
+ *       {
+ *         "SourceMember": "arn:aws:rds:us-east-1:123456789012:cluster-endpoint:my-reader-endpoint",
+ *         "Status": "PROVISIONING"
+ *       }
+ *     ],
+ *     "Tasks": [
+ *       {
+ *         "Name": "CREATING_READ_REPLICA_OF_SOURCE",
+ *         "Status": "PENDING"
+ *       },
+ *       {
+ *         "Name": "DB_ENGINE_VERSION_UPGRADE",
+ *         "Status": "PENDING"
+ *       },
+ *       {
+ *         "Name": "CREATE_DB_INSTANCES_FOR_CLUSTER",
+ *         "Status": "PENDING"
+ *       },
+ *       {
+ *         "Name": "CREATE_CUSTOM_ENDPOINTS",
+ *         "Status": "PENDING"
+ *       }
+ *     ]
+ *   }
+ * }
+ * *\/
+ * // example id: to-create-a-bluegreen-deployment-for-an-aurora-mysql-db-cluster-1679703605487
+ * ```
+ *
  */
 export declare class CreateBlueGreenDeploymentCommand extends $Command<CreateBlueGreenDeploymentCommandInput, CreateBlueGreenDeploymentCommandOutput, RDSClientResolvedConfig> {
     readonly input: CreateBlueGreenDeploymentCommandInput;

package/dist-types/commands/CreateDBClusterCommand.d.ts

@@ -187,32 +187,131 @@ export interface CreateDBClusterCommandOutput extends CreateDBClusterResult, __M
  *             available across all DB instances.</p>
  *
  *
- * @example To create a DB cluster
+ * @example To create a MySQL 5.7--compatible DB cluster
  * ```javascript
- * // This example creates a DB cluster.
+ * // The following example create a MySQL 5.7-compatible DB cluster.
  * const input = {
- *   "AvailabilityZones": [
- *     "us-east-1a"
- *   ],
- *   "BackupRetentionPeriod": 1,
- *   "DBClusterIdentifier": "mydbcluster",
- *   "DBClusterParameterGroupName": "mydbclusterparametergroup",
- *   "DatabaseName": "myauroradb",
- *   "Engine": "aurora",
- *   "EngineVersion": "5.6.10a",
+ *   "DBClusterIdentifier": "sample-cluster",
+ *   "DBSubnetGroupName": "default",
+ *   "Engine": "aurora-mysql",
+ *   "EngineVersion": "5.7.12",
+ *   "MasterUserPassword": "mypassword",
+ *   "MasterUsername": "admin",
+ *   "VpcSecurityGroupIds": [
+ *     "sg-0b91305example"
+ *   ]
+ * };
+ * const command = new CreateDBClusterCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "DBCluster": {
+ *     "AllocatedStorage": 1,
+ *     "AssociatedRoles": [],
+ *     "AvailabilityZones": [
+ *       "us-east-1a",
+ *       "us-east-1b",
+ *       "us-east-1e"
+ *     ],
+ *     "BackupRetentionPeriod": 1,
+ *     "ClusterCreateTime": "2019-06-07T23:21:33.048Z",
+ *     "CopyTagsToSnapshot": false,
+ *     "DBClusterArn": "arn:aws:rds:us-east-1:123456789012:cluster:sample-cluster",
+ *     "DBClusterIdentifier": "sample-cluster",
+ *     "DBClusterMembers": [],
+ *     "DBClusterParameterGroup": "default.aurora-mysql5.7",
+ *     "DBSubnetGroup": "default",
+ *     "DbClusterResourceId": "cluster-ANPAJ4AE5446DAEXAMPLE",
+ *     "DeletionProtection": false,
+ *     "Endpoint": "sample-cluster.cluster-cnpexample.us-east-1.rds.amazonaws.com",
+ *     "Engine": "aurora-mysql",
+ *     "EngineMode": "provisioned",
+ *     "EngineVersion": "5.7.12",
+ *     "HostedZoneId": "Z2R2ITUGPM61AM",
+ *     "HttpEndpointEnabled": false,
+ *     "IAMDatabaseAuthenticationEnabled": false,
+ *     "MasterUsername": "master",
+ *     "MultiAZ": false,
+ *     "Port": 3306,
+ *     "PreferredBackupWindow": "09:12-09:42",
+ *     "PreferredMaintenanceWindow": "mon:04:31-mon:05:01",
+ *     "ReadReplicaIdentifiers": [],
+ *     "ReaderEndpoint": "sample-cluster.cluster-ro-cnpexample.us-east-1.rds.amazonaws.com",
+ *     "Status": "creating",
+ *     "StorageEncrypted": false,
+ *     "VpcSecurityGroups": [
+ *       {
+ *         "Status": "active",
+ *         "VpcSecurityGroupId": "sg-0b91305example"
+ *       }
+ *     ]
+ *   }
+ * }
+ * *\/
+ * // example id: to-create-a-mysql-57--compatible-db-cluster-1679699416154
+ * ```
+ *
+ * @example To create a PostgreSQL--compatible DB cluster
+ * ```javascript
+ * // The following creates a PostgreSQL-compatible DB cluster.
+ * const input = {
+ *   "DBClusterIdentifier": "sample-pg-cluster",
+ *   "DBSubnetGroupName": "default",
+ *   "Engine": "aurora-postgresql",
  *   "MasterUserPassword": "mypassword",
- *   "MasterUsername": "myuser",
- *   "Port": 3306,
- *   "StorageEncrypted": true
+ *   "MasterUsername": "admin",
+ *   "VpcSecurityGroupIds": [
+ *     "sg-0b91305example"
+ *   ]
  * };
  * const command = new CreateDBClusterCommand(input);
  * const response = await client.send(command);
  * /* response ==
  * {
- *   "DBCluster": {}
+ *   "DBCluster": {
+ *     "AllocatedStorage": 1,
+ *     "AssociatedRoles": [],
+ *     "AvailabilityZones": [
+ *       "us-east-1a",
+ *       "us-east-1b",
+ *       "us-east-1c"
+ *     ],
+ *     "BackupRetentionPeriod": 1,
+ *     "ClusterCreateTime": "2019-06-07T23:26:08.371Z",
+ *     "CopyTagsToSnapshot": false,
+ *     "DBClusterArn": "arn:aws:rds:us-east-1:123456789012:cluster:sample-pg-cluster",
+ *     "DBClusterIdentifier": "sample-pg-cluster",
+ *     "DBClusterMembers": [],
+ *     "DBClusterParameterGroup": "default.aurora-postgresql9.6",
+ *     "DBSubnetGroup": "default",
+ *     "DbClusterResourceId": "cluster-ANPAJ4AE5446DAEXAMPLE",
+ *     "DeletionProtection": false,
+ *     "Endpoint": "sample-pg-cluster.cluster-cnpexample.us-east-1.rds.amazonaws.com",
+ *     "Engine": "aurora-postgresql",
+ *     "EngineMode": "provisioned",
+ *     "EngineVersion": "9.6.9",
+ *     "HostedZoneId": "Z2R2ITUGPM61AM",
+ *     "HttpEndpointEnabled": false,
+ *     "IAMDatabaseAuthenticationEnabled": false,
+ *     "MasterUsername": "master",
+ *     "MultiAZ": false,
+ *     "Port": 5432,
+ *     "PreferredBackupWindow": "09:56-10:26",
+ *     "PreferredMaintenanceWindow": "wed:03:33-wed:04:03",
+ *     "ReadReplicaIdentifiers": [],
+ *     "ReaderEndpoint": "sample-pg-cluster.cluster-ro-cnpexample.us-east-1.rds.amazonaws.com",
+ *     "Status": "creating",
+ *     "StorageEncrypted": false,
+ *     "VpcSecurityGroups": [
+ *       {
+ *         "Status": "active",
+ *         "VpcSecurityGroupId": "sg-0b91305example"
+ *       }
+ *     ]
+ *   }
  * }
  * *\/
- * // example id: create-db-cluster-423b998d-eba9-40dd-8e19-96c5b6e5f31d
+ * // example id: to-create-a-postgresql--compatible-db-cluster-1679700161087
  * ```
  *
  */