pulumi-aws-native-kotlin/com.pulumi.awsnative.rds.kotlin/RdsFunctions/getDbCluster

getDbCluster

suspend fun getDbCluster(argument: GetDbClusterPlainArgs): GetDbClusterResult

The `AWS::RDS::DBCluster` resource creates an Amazon Aurora DB cluster or Multi-AZ DB cluster. For more information about creating an Aurora DB cluster, see Creating an Amazon Aurora DB cluster in the Amazon Aurora User Guide. For more information about creating a Multi-AZ DB cluster, see Creating a Multi-AZ DB cluster in the Amazon RDS User Guide. You can only create this resource in AWS Regions where Amazon Aurora or Multi-AZ DB clusters are supported. Updating DB clusters When properties labeled "Update requires:Replacement" are updated, AWS CloudFormation first creates a replacement DB cluster, then changes references from other dependent resources to point to the replacement DB cluster, and finally deletes the old DB cluster. We highly recommend that you take a snapshot of the database before updating the stack. If you don't, you lose the data when AWS CloudFormation replaces your DB cluster. To preserve your data, perform the following procedure:

  1. Deactivate any applications that are using the DB cluster so that there's no activity on the DB instance.

  2. Create a snapshot of the DB cluster. For more information, see Creating a DB cluster snapshot.

  3. If you want to restore your DB cluster using a DB cluster snapshot, modify the updated template with your DB cluster changes and add the `SnapshotIdentifier` property with the ID of the DB cluster snapshot that you want to use. After you restore a DB cluster with a `SnapshotIdentifier` property, you must specify the same `SnapshotIdentifier` property for any future updates to the DB cluster. When you specify this property for an update, the DB cluster is not restored from the DB cluster snapshot again, and the data in the database is not changed. However, if you don't specify the `SnapshotIdentifier` property, an empty DB cluster is created, and the original DB cluster is deleted. If you specify a property that is different from the previous snapshot restore property, a new DB cluster is restored from the specified `SnapshotIdentifier` property, and the original DB cluster is deleted.

  4. Update the stack. Currently, when you are updating the stack for an Aurora Serverless DB cluster, you can't include changes to any other properties when you specify one of the following properties: `PreferredBackupWindow`, `PreferredMaintenanceWindow`, and `Port`. This limitation doesn't apply to provisioned DB clusters. For more information about updating other properties of this resource, see `ModifyDBCluster`. For more information about updating stacks, see CloudFormation Stacks Updates. Deleting DB clusters The default `DeletionPolicy` for `AWS::RDS::DBCluster` resources is `Snapshot`. For more information about how AWS CloudFormation deletes resources, see DeletionPolicy Attribute.

Return

null

Parameters

argument

null

suspend fun getDbCluster(dbClusterIdentifier: String): GetDbClusterResult

Return

null

Parameters

dbClusterIdentifier

The DB cluster 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: `my-cluster1` Valid for: Aurora DB clusters and Multi-AZ DB clusters

See also

.

suspend fun getDbCluster(argument: suspend GetDbClusterPlainArgsBuilder.() -> Unit): GetDbClusterResult

Return

null

Parameters

argument

Builder for com.pulumi.awsnative.rds.kotlin.inputs.GetDbClusterPlainArgs.

See also

.