Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

r/aws_rds_cluster: Conflict snapshot_identifier and global_cluster_identifier #30158

Merged
merged 4 commits into from
Mar 22, 2023
Merged

r/aws_rds_cluster: Conflict snapshot_identifier and global_cluster_identifier #30158

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
b44420a
r/aws_rds_cluster: snapshot_identifier conflicts with global_cluster_…
jar-b Mar 20, 2023
156a804
r/aws_rds_cluster: document snapshot and global cluster id conflict
jar-b Mar 20, 2023
5a78f69
chore: changelog
jar-b Mar 21, 2023
736d002
r/aws_rds_cluster: add global cluster restored from snapshot example
jar-b Mar 22, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .changelog/30158.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
```release-note:enhancement
resource/aws_rds_cluster: Conflict `snapshot_identifier` and `global_cluster_identifier` attributes, preventing misleading results on restore
```
7 changes: 7 additions & 0 deletions internal/service/rds/cluster.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -432,6 +432,13 @@ func ResourceCluster() *schema.Resource {
"snapshot_identifier": {
Type: schema.TypeString,
Optional: true,
ConflictsWith: []string{
// Clusters cannot be joined to an existing global cluster as part of
// the "restore from snapshot" operation. Trigger an error during plan
// to prevent an apply with unexpected results (ie. a regional
// cluster which is not joined to the provided global cluster).
"global_cluster_identifier",
},
},
"source_region": {
Type: schema.TypeString,
Expand Down
32 changes: 31 additions & 1 deletion website/docs/r/rds_cluster.html.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -145,6 +145,36 @@ resource "aws_rds_cluster_instance" "example" {
}
```

### Global Cluster Restored From Snapshot

```terraform
data "aws_db_cluster_snapshot" "example" {
db_cluster_identifier = "example-original-cluster"
most_recent = true
}

resource "aws_rds_cluster" "example" {
# Because the global cluster is sourced from this cluster, the initial
# engine and engine_version values are defined here and automatically
# inherited by the global cluster.
engine = "aurora"
engine_version = "5.6.mysql_aurora.1.22.4"

cluster_identifier = "example"
snapshot_identifier = data.aws_db_cluster_snapshot.example.id

lifecycle {
ignore_changes = [snapshot_identifier, global_cluster_identifier]
}
}

resource "aws_rds_global_cluster" "example" {
global_cluster_identifier = "example"
source_db_cluster_identifier = aws_rds_cluster.example.arn
force_destroy = true
}
```

## Argument Reference

For more detailed documentation about each argument, refer to
Expand Down Expand Up @@ -191,7 +221,7 @@ The following arguments are supported:
* `scaling_configuration` - (Optional) Nested attribute with scaling properties. Only valid when `engine_mode` is set to `serverless`. More details below.
* `serverlessv2_scaling_configuration`- (Optional) Nested attribute with scaling properties for ServerlessV2. Only valid when `engine_mode` is set to `provisioned`. More details below.
* `skip_final_snapshot` - (Optional) Determines whether a final DB snapshot is created before the DB cluster is deleted. If true is specified, no DB snapshot is created. If false is specified, a DB snapshot is created before the DB cluster is deleted, using the value from `final_snapshot_identifier`. Default is `false`.
* `snapshot_identifier` - (Optional) Specifies whether or not to create this cluster from a snapshot. You can use either the name or ARN when specifying a DB cluster snapshot, or the ARN when specifying a DB snapshot.
* `snapshot_identifier` - (Optional) Specifies whether or not to create this cluster from a snapshot. You can use either the name or ARN when specifying a DB cluster snapshot, or the ARN when specifying a DB snapshot. Conflicts with `global_cluster_identifier`. Clusters cannot be restored from snapshot **and** joined to an existing global cluster in a single operation. See the [AWS documentation](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-global-database-getting-started.html#aurora-global-database.use-snapshot) or the [Global Cluster Restored From Snapshot example](#global-cluster-restored-from-snapshot) for instructions on building a global cluster starting with a snapshot.
* `source_region` - (Optional) The source region for an encrypted replica DB cluster.
* `allocated_storage` - (Optional) The amount of storage in gibibytes (GiB) to allocate to each DB instance in the Multi-AZ DB cluster. (This setting is required to create a Multi-AZ DB cluster).
* `storage_type` - (Optional) Specifies the storage type to be associated with the DB cluster. (This setting is required to create a Multi-AZ DB cluster). Valid values: `io1`, Default: `io1`.
Expand Down