|
28 | 28 | namespace Amazon.PowerShell.Cmdlets.DSQL |
29 | 29 | { |
30 | 30 | /// <summary> |
31 | | - /// This operation creates a cluster in Amazon Aurora DSQL. You need the following permissions |
32 | | - /// to use this operation. |
| 31 | + /// The CreateCluster API allows you to create both single-region clusters and multi-Region |
| 32 | + /// clusters. With the addition of the <i>multiRegionProperties</i> parameter, you can |
| 33 | + /// create a cluster with witness Region support and establish peer relationships with |
| 34 | + /// clusters in other Regions during creation. |
33 | 35 | /// |
34 | | - /// |
35 | | - /// <para> |
36 | | - /// Permission to create a cluster. |
37 | | - /// </para><dl><dt>dsql:CreateCluster</dt><dd><para> |
38 | | - /// Resources: arn:aws:dsql:<i>region</i>:<i>account-id</i>:cluster/* |
39 | | - /// </para></dd></dl><para> |
40 | | - /// Permission to add tags to a resource. |
41 | | - /// </para><dl><dt>dsql:TagResource</dt><dd><para> |
42 | | - /// Resources: arn:aws:dsql:<i>region</i>:<i>account-id</i>:cluster/* |
43 | | - /// </para></dd></dl><para> |
| 36 | + /// <note><para> |
| 37 | + /// Creating multi-Region clusters requires additional IAM permissions beyond those needed |
| 38 | + /// for single-Region clusters, as detailed in the <b>Required permissions</b> section |
| 39 | + /// below. |
| 40 | + /// </para></note><para><b>Required permissions</b></para><dl><dt>dsql:CreateCluster</dt><dd><para> |
| 41 | + /// Required to create a cluster. |
| 42 | + /// </para><para> |
| 43 | + /// Resources: <c>arn:aws:dsql:region:account-id:cluster/*</c></para></dd><dt>dsql:TagResource</dt><dd><para> |
| 44 | + /// Permission to add tags to a resource. |
| 45 | + /// </para><para> |
| 46 | + /// Resources: <c>arn:aws:dsql:region:account-id:cluster/*</c></para></dd><dt>dsql:PutMultiRegionProperties</dt><dd><para> |
44 | 47 | /// Permission to configure multi-region properties for a cluster. |
45 | | - /// </para><dl><dt>dsql:PutMultiRegionProperties</dt><dd><para> |
46 | | - /// Resources: arn:aws:dsql:<i>region</i>:<i>account-id</i>:cluster/* |
47 | | - /// </para></dd></dl><para> |
48 | | - /// When specifying multiRegionProperties.clusters. |
49 | | - /// </para><dl><dt>dsql:AddPeerCluster</dt><dd><para> |
50 | | - /// Permission to add peer clusters. |
| 48 | + /// </para><para> |
| 49 | + /// Resources: <c>arn:aws:dsql:region:account-id:cluster/*</c></para></dd><dt>dsql:AddPeerCluster</dt><dd><para> |
| 50 | + /// When specifying <c>multiRegionProperties.clusters</c>, permission to add peer clusters. |
51 | 51 | /// </para><para> |
52 | 52 | /// Resources: |
53 | 53 | /// </para><ul><li><para> |
54 | | - /// Local cluster: arn:aws:dsql:<i>region</i>:<i>account-id</i>:cluster/* |
55 | | - /// </para></li><li><para> |
| 54 | + /// Local cluster: <c>arn:aws:dsql:region:account-id:cluster/*</c></para></li><li><para> |
56 | 55 | /// Each peer cluster: exact ARN of each specified peer cluster |
57 | | - /// </para></li></ul></dd></dl><para> |
58 | | - /// When specifying multiRegionProperties.witnessRegion. |
59 | | - /// </para><dl><dt>dsql:PutWitnessRegion</dt><dd><para> |
60 | | - /// Permission to set a witness region. |
61 | | - /// </para><para> |
62 | | - /// Resources: arn:aws:dsql:<i>region</i>:<i>account-id</i>:cluster/* |
| 56 | + /// </para></li></ul></dd><dt>dsql:PutWitnessRegion</dt><dd><para> |
| 57 | + /// When specifying <c>multiRegionProperties.witnessRegion</c>, permission to set a witness |
| 58 | + /// Region. This permission is checked both in the cluster Region and in the witness Region. |
63 | 59 | /// </para><para> |
| 60 | + /// Resources: <c>arn:aws:dsql:region:account-id:cluster/*</c></para><para> |
64 | 61 | /// Condition Keys: <c>dsql:WitnessRegion</c> (matching the specified witness region) |
65 | | - /// </para><note><para> |
66 | | - /// This permission is checked both in the cluster Region and in the witness Region. |
67 | | - /// </para></note></dd></dl><important><para><b>Important Notes for Multi-Region Operations</b></para><ul><li><para> |
68 | | - /// The witness region specified in <c>multiRegionProperties.witnessRegion</c> cannot |
| 62 | + /// </para></dd></dl><important><ul><li><para> |
| 63 | + /// The witness Region specified in <c>multiRegionProperties.witnessRegion</c> cannot |
69 | 64 | /// be the same as the cluster's Region. |
70 | | - /// </para></li><li><para> |
71 | | - /// When updating clusters with peer relationships, permissions are checked for both adding |
72 | | - /// and removing peers. |
73 | 65 | /// </para></li></ul></important> |
74 | 66 | /// </summary> |
75 | 67 | [Cmdlet("New", "DSQLCluster", SupportsShouldProcess = true, ConfirmImpact = ConfirmImpact.Medium)] |
|
0 commit comments