AWS Amazon RDS Cluster Snapshot

This page shows how to write Terraform and CloudFormation for Amazon RDS Cluster Snapshot and write them securely.

aws_db_cluster_snapshot (Terraform)

The Cluster Snapshot in Amazon RDS can be configured in Terraform with the resource name aws_db_cluster_snapshot. The following sections describe 5 examples of how to use the resource and its parameters.

Example Usage from GitHub

main.tf#L1
resource "aws_db_cluster_snapshot" "main" {
  db_cluster_identifier          = var.cluster_identifier
  db_cluster_snapshot_identifier = var.cluster_snapshot_identifier
cluster_snapshot.tf#L13
resource "aws_db_cluster_snapshot" "test_resource_exposure" {
  db_cluster_identifier          = aws_rds_cluster.test_resource_exposure.id
  db_cluster_snapshot_identifier = "test-resource-exposure-cluster"
cluster_snapshot.tf#L13
resource "aws_db_cluster_snapshot" "test_resource_exposure" {
  db_cluster_identifier          = aws_rds_cluster.test_resource_exposure.id
  db_cluster_snapshot_identifier = "test-resource-exposure-cluster"
cluster_snapshot.tf#L13
resource "aws_db_cluster_snapshot" "test_resource_exposure" {
  db_cluster_identifier          = aws_rds_cluster.test_resource_exposure.id
  db_cluster_snapshot_identifier = "test-resource-exposure-cluster"
main.tf#L1
resource "aws_db_cluster_snapshot" "cluster_snapshot" {
  count                          = length(var.cluster_snapshot)
  db_cluster_identifier          = element(var.db_cluster_identifier, lookup(var.cluster_snapshot[count.index], "cluster_id"))
  db_cluster_snapshot_identifier = lookup(var.cluster_snapshot[count.index], "db_cluster_snapshot_identifier")
  tags                           = var.tags

Parameters

Explanation in Terraform Registry

Manages an RDS database cluster snapshot for Aurora clusters. For managing RDS database instance snapshots, see the aws_db_snapshot resource.

AWS::RDS::DBCluster (CloudFormation)

The DBCluster in RDS can be configured in CloudFormation with the resource name AWS::RDS::DBCluster. The following sections describe 10 examples of how to use the resource and its parameters.

Example Usage from GitHub

deploy.yml#L4
    Type: 'AWS::RDS::DBCluster'
    Properties:
      MasterUsername: !Ref DBUsername
      MasterUserPassword: !Ref DBPassword
      DBClusterIdentifier: aurora-postgresql-cluster
      Engine: aurora-postgresql
deploy.yml#L4
    Type: 'AWS::RDS::DBCluster'
    Properties:
      MasterUsername: !Ref DBUsername
      MasterUserPassword: !Ref DBPassword
      DBClusterIdentifier: aurora-postgresql-cluster
      Engine: aurora-postgresql
deploy.yml#L4
    Type: 'AWS::RDS::DBCluster'
    Properties:
      MasterUsername: !Ref DBUsername
      MasterUserPassword: !Ref DBPassword
      DBClusterIdentifier: aurora-postgresql-cluster
      Engine: aurora-postgresql
aurora.yml#L3
    Type: AWS::RDS::DBCluster
    Properties:
      DatabaseName: ${self:custom.environments.DB_DATABASE}
      Engine: aurora-mysql
      EngineMode: serverless
      MasterUsername: ${self:custom.environments.DB_USER_NAME}
RDS.yml#L3
    Type: 'AWS::RDS::DBClusterParameterGroup'
    Properties:
      Description: 'Aurora PostgreSQL 10 Parameter Group'
      Family: aurora-postgresql10
      Parameters:
        rds.force_ssl: 1
config.ListDiscoveredResources_1.json#L6
                "resourceType": "AWS::RDS::DBClusterSnapshot",
                "resourceId": "rds:database-1-2020-05-19-05-58",
                "resourceName": "rds:database-1-2020-05-19-05-58"
            },
            {
                "resourceType": "AWS::RDS::DBClusterSnapshot",
config.ListDiscoveredResources_1.json#L6
                "resourceType": "AWS::RDS::DBClusterSnapshot",
                "resourceId": "rds:database-1-2020-05-19-05-58",
                "resourceName": "rds:database-1-2020-05-19-05-58"
            },
            {
                "resourceType": "AWS::RDS::DBClusterSnapshot",
config.ListDiscoveredResources_1.json#L6
                "resourceType": "AWS::RDS::DBClusterSnapshot",
                "resourceId": "rds:database-1-2020-05-19-05-58",
                "resourceName": "rds:database-1-2020-05-19-05-58"
            },
            {
                "resourceType": "AWS::RDS::DBClusterSnapshot",
cloudformation-list-stack-resources.aurora.json#L5
            "ResourceType": "AWS::RDS::DBCluster",
            "ResourceStatus": "CREATE_COMPLETE"
        },
        {
            "PhysicalResourceId": "auroraClusterParameterGroup",
            "ResourceType": "AWS::RDS::DBClusterParameterGroup",
aurora-postgresql.json#L18
      "Type": "AWS::RDS::DBCluster",
      "Properties": {
        "Engine": "aurora-postgresql",
        "EngineMode": "provisioned",
        "EngineVersion": {
          "Ref": "EngineVersion"

Parameters

Explanation in CloudFormation Registry

The AWS::RDS::DBCluster resource creates an Amazon Aurora DB cluster. For more information, see Managing an Amazon Aurora DB Cluster in the Amazon Aurora User Guide.

Note You can only create this resource in AWS Regions where Amazon Aurora is supported.

Updating DB clustersWhen 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.

Important 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: Deactivate any applications that are using the DB cluster so that there's no activity on the DB instance.

Create a snapshot of the DB cluster. For more information about creating DB snapshots, see Creating a DB Cluster Snapshot.

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.

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](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_ModifyDBCluster.html). For more information about updating stacks, see AWS CloudFormation Stacks Updates.

Deleting DB clustersThe default DeletionPolicy for AWS::RDS::DBCluster resources is Snapshot. For more information about how AWS CloudFormation deletes resources, see DeletionPolicy Attribute.

Frequently asked questions

What is AWS Amazon RDS Cluster Snapshot?

AWS Amazon RDS Cluster Snapshot is a resource for Amazon RDS of Amazon Web Service. Settings can be wrote in Terraform and CloudFormation.

Where can I find the example code for the AWS Amazon RDS Cluster Snapshot?

For Terraform, the EmmanuelFelipe/terraform-modules, gpetrousov/endgame and shankarb01/endgame source code examples are useful. See the Terraform Example section for further details.

For CloudFormation, the iactest/kaimonkey_customized, jcroall/kaimonkey-demo and mallik-user1/TestRepo source code examples are useful. See the CloudFormation Example section for further details.