Skip to content

Commit 4a7f837

Browse files
author
AWS
committed
Amazon Aurora DSQL Update: CreateMultiRegionCluster and DeleteMultiRegionCluster APIs removed
1 parent 7e8a69e commit 4a7f837

File tree

2 files changed

+10
-181
lines changed

2 files changed

+10
-181
lines changed

‎.changes/next-release/feature-AmazonAuroraDSQL-c22f44a.json

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"type": "feature",
3+
"category": "Amazon Aurora DSQL",
4+
"contributor": "",
5+
"description": "CreateMultiRegionCluster and DeleteMultiRegionCluster APIs removed"
6+
}

‎services/dsql/src/main/resources/codegen-resources/service-2.json

Lines changed: 4 additions & 181 deletions
Original file line numberDiff line numberDiff line change
@@ -30,29 +30,7 @@
3030
{"shape":"InternalServerException"},
3131
{"shape":"ConflictException"}
3232
],
33-
"documentation":"<p>This operation creates a cluster in Amazon Aurora DSQL. You need the following permissions to use this operation.</p> <p>Permission to create a cluster.</p> <dl> <dt>dsql:CreateCluster</dt> <dd> <p>Resources: arn:aws:dsql:<i>region</i>:<i>account-id</i>:cluster/*</p> </dd> </dl> <p> Permission to add tags to a resource.</p> <dl> <dt>dsql:TagResource</dt> <dd> <p>Resources: arn:aws:dsql:<i>region</i>:<i>account-id</i>:cluster/*</p> </dd> </dl> <p>Permission to configure multi-region properties for a cluster.</p> <dl> <dt>dsql:PutMultiRegionProperties</dt> <dd> <p>Resources: arn:aws:dsql:<i>region</i>:<i>account-id</i>:cluster/*</p> </dd> </dl> <p>When specifying multiRegionProperties.clusters.</p> <dl> <dt>dsql:AddPeerCluster</dt> <dd> <p>Permission to add peer clusters.</p> <p>Resources:</p> <ul> <li> <p>Local cluster: arn:aws:dsql:<i>region</i>:<i>account-id</i>:cluster/*</p> </li> <li> <p>Each peer cluster: exact ARN of each specified peer cluster</p> </li> </ul> </dd> </dl> <p>When specifying multiRegionProperties.witnessRegion.</p> <dl> <dt>dsql:PutWitnessRegion</dt> <dd> <p>Permission to set a witness region.</p> <p>Resources: arn:aws:dsql:<i>region</i>:<i>account-id</i>:cluster/*</p> <p>Condition Keys: <code>dsql:WitnessRegion</code> (matching the specified witness region)</p> <note> <p>This permission is checked both in the cluster Region and in the witness Region.</p> </note> </dd> </dl> <important> <p> <b>Important Notes for Multi-Region Operations</b> </p> <ul> <li> <p>The witness region specified in <code>multiRegionProperties.witnessRegion</code> cannot be the same as the cluster's Region.</p> </li> <li> <p>When updating clusters with peer relationships, permissions are checked for both adding and removing peers.</p> </li> </ul> </important>"
34-
},
35-
"CreateMultiRegionClusters":{
36-
"name":"CreateMultiRegionClusters",
37-
"http":{
38-
"method":"POST",
39-
"requestUri":"/multi-region-clusters",
40-
"responseCode":200
41-
},
42-
"input":{"shape":"CreateMultiRegionClustersInput"},
43-
"output":{"shape":"CreateMultiRegionClustersOutput"},
44-
"errors":[
45-
{"shape":"ServiceQuotaExceededException"},
46-
{"shape":"ThrottlingException"},
47-
{"shape":"AccessDeniedException"},
48-
{"shape":"ValidationException"},
49-
{"shape":"InternalServerException"},
50-
{"shape":"ConflictException"}
51-
],
52-
"documentation":"<p>Creates multi-Region clusters in Amazon Aurora DSQL. Multi-Region clusters require a linked Region list, which is an array of the Regions in which you want to create linked clusters. Multi-Region clusters require a witness Region, which participates in quorum in failure scenarios.</p>",
53-
"deprecated":true,
54-
"deprecatedMessage":"The CreateMultiRegionClusters API is deprecated. Use the CreateCluster API with multi-Region properties to create a multi-Region cluster.",
55-
"deprecatedSince":"5/13/2025"
33+
"documentation":"<p>The CreateCluster API allows you to create both single-region clusters and multi-Region clusters. With the addition of the <i>multiRegionProperties</i> parameter, you can create a cluster with witness Region support and establish peer relationships with clusters in other Regions during creation.</p> <note> <p>Creating multi-Region clusters requires additional IAM permissions beyond those needed for single-Region clusters, as detailed in the <b>Required permissions</b> section below.</p> </note> <p> <b>Required permissions</b> </p> <dl> <dt>dsql:CreateCluster</dt> <dd> <p>Required to create a cluster.</p> <p>Resources: <code>arn:aws:dsql:region:account-id:cluster/*</code> </p> </dd> <dt>dsql:TagResource</dt> <dd> <p>Permission to add tags to a resource.</p> <p>Resources: <code>arn:aws:dsql:region:account-id:cluster/*</code> </p> </dd> <dt>dsql:PutMultiRegionProperties</dt> <dd> <p>Permission to configure multi-region properties for a cluster.</p> <p>Resources: <code>arn:aws:dsql:region:account-id:cluster/*</code> </p> </dd> <dt>dsql:AddPeerCluster</dt> <dd> <p>When specifying <code>multiRegionProperties.clusters</code>, permission to add peer clusters.</p> <p>Resources:</p> <ul> <li> <p>Local cluster: <code>arn:aws:dsql:region:account-id:cluster/*</code> </p> </li> <li> <p>Each peer cluster: exact ARN of each specified peer cluster</p> </li> </ul> </dd> <dt>dsql:PutWitnessRegion</dt> <dd> <p>When specifying <code>multiRegionProperties.witnessRegion</code>, permission to set a witness Region. This permission is checked both in the cluster Region and in the witness Region.</p> <p>Resources: <code>arn:aws:dsql:region:account-id:cluster/*</code> </p> <p>Condition Keys: <code>dsql:WitnessRegion</code> (matching the specified witness region)</p> </dd> </dl> <important> <ul> <li> <p>The witness Region specified in <code>multiRegionProperties.witnessRegion</code> cannot be the same as the cluster's Region.</p> </li> </ul> </important>"
5634
},
5735
"DeleteCluster":{
5836
"name":"DeleteCluster",
@@ -74,28 +52,6 @@
7452
"documentation":"<p>Deletes a cluster in Amazon Aurora DSQL.</p>",
7553
"idempotent":true
7654
},
77-
"DeleteMultiRegionClusters":{
78-
"name":"DeleteMultiRegionClusters",
79-
"http":{
80-
"method":"DELETE",
81-
"requestUri":"/multi-region-clusters",
82-
"responseCode":200
83-
},
84-
"input":{"shape":"DeleteMultiRegionClustersInput"},
85-
"errors":[
86-
{"shape":"ThrottlingException"},
87-
{"shape":"AccessDeniedException"},
88-
{"shape":"ValidationException"},
89-
{"shape":"InternalServerException"},
90-
{"shape":"ResourceNotFoundException"},
91-
{"shape":"ConflictException"}
92-
],
93-
"documentation":"<p>Deletes a multi-Region cluster in Amazon Aurora DSQL.</p>",
94-
"deprecated":true,
95-
"deprecatedMessage":"The DeleteMultiRegionClusters API is deprecated. To delete a multi-Region cluster, use the DeleteCluster API instead.",
96-
"deprecatedSince":"5/13/2025",
97-
"idempotent":true
98-
},
9955
"GetCluster":{
10056
"name":"GetCluster",
10157
"http":{
@@ -222,7 +178,7 @@
222178
{"shape":"ResourceNotFoundException"},
223179
{"shape":"ConflictException"}
224180
],
225-
"documentation":"<p>Updates a cluster.</p> <p> <b>Example IAM Policy for Multi-Region Operations</b> </p> <p>The following IAM policy grants permissions for multi-Region operations.</p> <p>The <code>dsql:RemovePeerCluster</code> permission uses a wildcard ARN pattern to simplify permission management during updates.</p> <important> <p> <b>Important Notes for Multi-Region Operations</b> </p> <ul> <li> <p>The witness region specified in <code>multiRegionProperties.witnessRegion</code> cannot be the same as the cluster's Region.</p> </li> <li> <p>When updating clusters with peer relationships, permissions are checked for both adding and removing peers.</p> </li> <li> <p>The <code>dsql:RemovePeerCluster</code> permission uses a wildcard ARN pattern to simplify permission management during updates.</p> </li> </ul> </important>"
181+
"documentation":"<p>The <i>UpdateCluster</i> API allows you to modify both single-Region and multi-Region cluster configurations. With the <i>multiRegionProperties</i> parameter, you can add or modify witness Region support and manage peer relationships with clusters in other Regions.</p> <note> <p>Note that updating multi-region clusters requires additional IAM permissions beyond those needed for standard cluster updates, as detailed in the Permissions section.</p> </note> <p> <b>Required permissions</b> </p> <dl> <dt>dsql:UpdateCluster</dt> <dd> <p>Permission to update a DSQL cluster.</p> <p>Resources: <code>arn:aws:dsql:<i>region</i>:<i>account-id</i>:cluster/<i>cluster-id</i> </code> </p> </dd> </dl> <dl> <dt>dsql:PutMultiRegionProperties</dt> <dd> <p>Permission to configure multi-Region properties for a cluster.</p> <p>Resources: <code>arn:aws:dsql:<i>region</i>:<i>account-id</i>:cluster/<i>cluster-id</i> </code> </p> </dd> </dl> <dl> <dt>dsql:GetCluster</dt> <dd> <p>Permission to retrieve cluster information.</p> <p>Resources: <code>arn:aws:dsql:<i>region</i>:<i>account-id</i>:cluster/<i>cluster-id</i> </code> </p> </dd> <dt>dsql:AddPeerCluster</dt> <dd> <p>Permission to add peer clusters.</p> <p>Resources:</p> <ul> <li> <p>Local cluster: <code>arn:aws:dsql:<i>region</i>:<i>account-id</i>:cluster/<i>cluster-id</i> </code> </p> </li> <li> <p>Each peer cluster: exact ARN of each specified peer cluster</p> </li> </ul> </dd> <dt>dsql:RemovePeerCluster</dt> <dd> <p>Permission to remove peer clusters. The <i>dsql:RemovePeerCluster</i> permission uses a wildcard ARN pattern to simplify permission management during updates.</p> <p>Resources: <code>arn:aws:dsql:*:<i>account-id</i>:cluster/*</code> </p> </dd> </dl> <dl> <dt>dsql:PutWitnessRegion</dt> <dd> <p>Permission to set a witness Region.</p> <p>Resources: <code>arn:aws:dsql:<i>region</i>:<i>account-id</i>:cluster/<i>cluster-id</i> </code> </p> <p>Condition Keys: dsql:WitnessRegion (matching the specified witness Region)</p> <p> <b>This permission is checked both in the cluster Region and in the witness Region.</b> </p> </dd> </dl> <important> <ul> <li> <p>The witness region specified in <code>multiRegionProperties.witnessRegion</code> cannot be the same as the cluster's Region.</p> </li> <li> <p>When updating clusters with peer relationships, permissions are checked for both adding and removing peers.</p> </li> <li> <p>The <code>dsql:RemovePeerCluster</code> permission uses a wildcard ARN pattern to simplify permission management during updates.</p> </li> </ul> </important>"
226182
}
227183
},
228184
"shapes":{
@@ -277,15 +233,6 @@
277233
"member":{"shape":"ClusterSummary"},
278234
"documentation":"<p>The list of clusters.</p>"
279235
},
280-
"ClusterPropertyMap":{
281-
"type":"map",
282-
"key":{"shape":"Region"},
283-
"value":{"shape":"LinkedClusterProperties"},
284-
"documentation":"<p>A map of properties for a cluster.</p>",
285-
"deprecated":true,
286-
"deprecatedMessage":"The CreateMultiRegionClusters API is deprecated. To create a multi-Region cluster, use the CreateCluster API with multi-Region properties instead.",
287-
"deprecatedSince":"5/13/2025"
288-
},
289236
"ClusterStatus":{
290237
"type":"string",
291238
"documentation":"<p>The current status of a cluster.</p>",
@@ -400,42 +347,6 @@
400347
},
401348
"documentation":"<p>The output of a created cluster.</p>"
402349
},
403-
"CreateMultiRegionClustersInput":{
404-
"type":"structure",
405-
"required":[
406-
"linkedRegionList",
407-
"witnessRegion"
408-
],
409-
"members":{
410-
"linkedRegionList":{
411-
"shape":"RegionList",
412-
"documentation":"<p>An array of the Regions in which you want to create additional clusters.</p>"
413-
},
414-
"clusterProperties":{
415-
"shape":"ClusterPropertyMap",
416-
"documentation":"<p>A mapping of properties to use when creating linked clusters.</p>"
417-
},
418-
"witnessRegion":{
419-
"shape":"Region",
420-
"documentation":"<p>The witness Region of multi-Region clusters.</p>"
421-
},
422-
"clientToken":{
423-
"shape":"ClientToken",
424-
"documentation":"<p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully. The subsequent retries with the same client token return the result from the original successful request and they have no additional effect.</p> <p>If you don't specify a client token, the Amazon Web Services SDK automatically generates one.</p>",
425-
"idempotencyToken":true
426-
}
427-
}
428-
},
429-
"CreateMultiRegionClustersOutput":{
430-
"type":"structure",
431-
"required":["linkedClusterArns"],
432-
"members":{
433-
"linkedClusterArns":{
434-
"shape":"ClusterArnList",
435-
"documentation":"<p>An array that contains the ARNs of all linked clusters.</p>"
436-
}
437-
}
438-
},
439350
"DeleteClusterInput":{
440351
"type":"structure",
441352
"required":["identifier"],
@@ -461,8 +372,7 @@
461372
"identifier",
462373
"arn",
463374
"status",
464-
"creationTime",
465-
"deletionProtectionEnabled"
375+
"creationTime"
466376
],
467377
"members":{
468378
"identifier":{
@@ -480,36 +390,10 @@
480390
"creationTime":{
481391
"shape":"ClusterCreationTime",
482392
"documentation":"<p>The time of when the cluster was created.</p>"
483-
},
484-
"deletionProtectionEnabled":{
485-
"shape":"DeletionProtectionEnabled",
486-
"documentation":"<p>Specifies whether deletion protection was enabled on the cluster.</p>",
487-
"deprecated":true,
488-
"deprecatedMessage":"The deletionProtectionEnabled field is deprecated in the DeleteCluster API. To check deletion protection status, use the GetCluster API instead.",
489-
"deprecatedSince":"5/13/2025"
490393
}
491394
},
492395
"documentation":"<p>The output from a deleted cluster.</p>"
493396
},
494-
"DeleteMultiRegionClustersInput":{
495-
"type":"structure",
496-
"required":["linkedClusterArns"],
497-
"members":{
498-
"linkedClusterArns":{
499-
"shape":"ClusterArnList",
500-
"documentation":"<p>The ARNs of the clusters linked to the cluster you want to delete. also deletes these clusters as part of the operation.</p>",
501-
"location":"querystring",
502-
"locationName":"linked-cluster-arns"
503-
},
504-
"clientToken":{
505-
"shape":"ClientToken",
506-
"documentation":"<p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully. The subsequent retries with the same client token return the result from the original successful request and they have no additional effect.</p> <p>If you don't specify a client token, the Amazon Web Services SDK automatically generates one.</p>",
507-
"idempotencyToken":true,
508-
"location":"querystring",
509-
"locationName":"client-token"
510-
}
511-
}
512-
},
513397
"DeletionProtectionEnabled":{
514398
"type":"boolean",
515399
"documentation":"<p>Indicates whether deletion protection is enabled for a cluster.</p>",
@@ -553,20 +437,6 @@
553437
"shape":"ClusterCreationTime",
554438
"documentation":"<p>The time of when the cluster was created.</p>"
555439
},
556-
"witnessRegion":{
557-
"shape":"Region",
558-
"documentation":"<p>The witness Region of the cluster. Applicable only for multi-Region clusters.</p>",
559-
"deprecated":true,
560-
"deprecatedMessage":"The witnessRegion field is deprecated. To see the witnessRegion, use multiRegionProperties.witnessRegion instead.",
561-
"deprecatedSince":"5/13/2025"
562-
},
563-
"linkedClusterArns":{
564-
"shape":"ClusterArnList",
565-
"documentation":"<p>The ARNs of the clusters linked to the retrieved cluster.</p>",
566-
"deprecated":true,
567-
"deprecatedMessage":"The linkedClusterArns field is deprecated. To see the peered cluster Arns, use multiRegionProperties.cluster instead.",
568-
"deprecatedSince":"5/13/2025"
569-
},
570440
"deletionProtectionEnabled":{
571441
"shape":"DeletionProtectionEnabled",
572442
"documentation":"<p>Whether deletion protection is enabled in this cluster.</p>"
@@ -623,23 +493,6 @@
623493
"fault":true,
624494
"retryable":{"throttling":false}
625495
},
626-
"LinkedClusterProperties":{
627-
"type":"structure",
628-
"members":{
629-
"deletionProtectionEnabled":{
630-
"shape":"DeletionProtectionEnabled",
631-
"documentation":"<p>Whether deletion protection is enabled.</p>"
632-
},
633-
"tags":{
634-
"shape":"TagMap",
635-
"documentation":"<p>A map of key and value pairs the linked cluster is tagged with.</p>"
636-
}
637-
},
638-
"documentation":"<p>Properties of linked clusters.</p>",
639-
"deprecated":true,
640-
"deprecatedMessage":"The CreateMultiRegionClusters API is deprecated. To create a multi-Region cluster, use the CreateCluster API with multi-Region properties instead.",
641-
"deprecatedSince":"5/13/2025"
642-
},
643496
"ListClustersInput":{
644497
"type":"structure",
645498
"members":{
@@ -723,14 +576,6 @@
723576
"max":50,
724577
"min":0
725578
},
726-
"RegionList":{
727-
"type":"list",
728-
"member":{"shape":"Region"},
729-
"documentation":"<p>List of Regions.</p>",
730-
"deprecated":true,
731-
"deprecatedMessage":"The CreateMultiRegionClusters API is deprecated. Use the CreateCluster API with multi-Region properties to create a multi-Region cluster.",
732-
"deprecatedSince":"5/13/2025"
733-
},
734579
"ResourceNotFoundException":{
735580
"type":"structure",
736581
"required":[
@@ -933,8 +778,7 @@
933778
"identifier",
934779
"arn",
935780
"status",
936-
"creationTime",
937-
"deletionProtectionEnabled"
781+
"creationTime"
938782
],
939783
"members":{
940784
"identifier":{
@@ -952,27 +796,6 @@
952796
"creationTime":{
953797
"shape":"ClusterCreationTime",
954798
"documentation":"<p>The time of when the cluster was created.</p>"
955-
},
956-
"witnessRegion":{
957-
"shape":"Region",
958-
"documentation":"<p>The Region that receives all data you write to linked clusters.</p>",
959-
"deprecated":true,
960-
"deprecatedMessage":"The witnessRegion field is deprecated in the UpdateCluster API. To check witnessRegion, use the GetCluster API instead.",
961-
"deprecatedSince":"5/13/2025"
962-
},
963-
"linkedClusterArns":{
964-
"shape":"ClusterArnList",
965-
"documentation":"<p>The ARNs of the clusters linked to the updated cluster. Applicable only for multi-Region clusters.</p>",
966-
"deprecated":true,
967-
"deprecatedMessage":"The linkedClusterArns field is deprecated in the UpdateCluster API. To check peer cluster, use the GetCluster API instead.",
968-
"deprecatedSince":"5/13/2025"
969-
},
970-
"deletionProtectionEnabled":{
971-
"shape":"DeletionProtectionEnabled",
972-
"documentation":"<p>Whether deletion protection is enabled for the updated cluster.</p>",
973-
"deprecated":true,
974-
"deprecatedMessage":"The deletionProtectionEnabled field is deprecated in the UpdateCluster API. To check deletion protection status, use the GetCluster API instead.",
975-
"deprecatedSince":"5/13/2025"
976799
}
977800
},
978801
"documentation":"<p>The details of the cluster after it has been updated.</p>"

0 commit comments

Comments
 (0)