Skip to content

Commit 0341681

Browse files
author
awstools
committed
feat(client-rds): Global clusters now expose the Endpoint attribute as one of its fields. It is a Read/Write endpoint for the global cluster which resolves to the Global Cluster writer instance.
1 parent e2fcaab commit 0341681

11 files changed

+38
-4
lines changed

clients/client-rds/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ from the user guide.</p>
6363

6464
## Installing
6565

66-
To install the this package, simply type add or install @aws-sdk/client-rds
66+
To install this package, simply type add or install @aws-sdk/client-rds
6767
using your favorite package manager:
6868

6969
- `npm install @aws-sdk/client-rds`

clients/client-rds/src/commands/CreateGlobalClusterCommand.ts

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -88,6 +88,7 @@ export interface CreateGlobalClusterCommandOutput extends CreateGlobalClusterRes
8888
* // SynchronizationStatus: "connected" || "pending-resync",
8989
* // },
9090
* // ],
91+
* // Endpoint: "STRING_VALUE",
9192
* // FailoverState: { // FailoverState
9293
* // Status: "pending" || "failing-over" || "cancelling",
9394
* // FromDbClusterArn: "STRING_VALUE",
@@ -116,7 +117,8 @@ export interface CreateGlobalClusterCommandOutput extends CreateGlobalClusterRes
116117
* <code>DBClusterIdentifier</code> doesn't refer to an existing DB cluster.</p>
117118
*
118119
* @throws {@link GlobalClusterAlreadyExistsFault} (client fault)
119-
* <p>The <code>GlobalClusterIdentifier</code> already exists. Choose a new global database identifier (unique name) to create a new global database cluster.</p>
120+
* <p>The <code>GlobalClusterIdentifier</code> already exists. Specify a new global database identifier
121+
* (unique name) to create a new global database cluster or to rename an existing one.</p>
120122
*
121123
* @throws {@link GlobalClusterQuotaExceededFault} (client fault)
122124
* <p>The number of global database clusters for this account is already at the maximum allowed.</p>

clients/client-rds/src/commands/DeleteGlobalClusterCommand.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -67,6 +67,7 @@ export interface DeleteGlobalClusterCommandOutput extends DeleteGlobalClusterRes
6767
* // SynchronizationStatus: "connected" || "pending-resync",
6868
* // },
6969
* // ],
70+
* // Endpoint: "STRING_VALUE",
7071
* // FailoverState: { // FailoverState
7172
* // Status: "pending" || "failing-over" || "cancelling",
7273
* // FromDbClusterArn: "STRING_VALUE",

clients/client-rds/src/commands/DescribeGlobalClustersCommand.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -80,6 +80,7 @@ export interface DescribeGlobalClustersCommandOutput extends GlobalClustersMessa
8080
* // SynchronizationStatus: "connected" || "pending-resync",
8181
* // },
8282
* // ],
83+
* // Endpoint: "STRING_VALUE",
8384
* // FailoverState: { // FailoverState
8485
* // Status: "pending" || "failing-over" || "cancelling",
8586
* // FromDbClusterArn: "STRING_VALUE",

clients/client-rds/src/commands/FailoverGlobalClusterCommand.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -101,6 +101,7 @@ export interface FailoverGlobalClusterCommandOutput extends FailoverGlobalCluste
101101
* // SynchronizationStatus: "connected" || "pending-resync",
102102
* // },
103103
* // ],
104+
* // Endpoint: "STRING_VALUE",
104105
* // FailoverState: { // FailoverState
105106
* // Status: "pending" || "failing-over" || "cancelling",
106107
* // FromDbClusterArn: "STRING_VALUE",

clients/client-rds/src/commands/ModifyGlobalClusterCommand.ts

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,7 @@ export interface ModifyGlobalClusterCommandOutput extends ModifyGlobalClusterRes
7373
* // SynchronizationStatus: "connected" || "pending-resync",
7474
* // },
7575
* // ],
76+
* // Endpoint: "STRING_VALUE",
7677
* // FailoverState: { // FailoverState
7778
* // Status: "pending" || "failing-over" || "cancelling",
7879
* // FromDbClusterArn: "STRING_VALUE",
@@ -96,6 +97,10 @@ export interface ModifyGlobalClusterCommandOutput extends ModifyGlobalClusterRes
9697
* @see {@link ModifyGlobalClusterCommandOutput} for command's `response` shape.
9798
* @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape.
9899
*
100+
* @throws {@link GlobalClusterAlreadyExistsFault} (client fault)
101+
* <p>The <code>GlobalClusterIdentifier</code> already exists. Specify a new global database identifier
102+
* (unique name) to create a new global database cluster or to rename an existing one.</p>
103+
*
99104
* @throws {@link GlobalClusterNotFoundFault} (client fault)
100105
* <p>The <code>GlobalClusterIdentifier</code> doesn't refer to an existing global database cluster.</p>
101106
*

clients/client-rds/src/commands/RemoveFromGlobalClusterCommand.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,7 @@ export interface RemoveFromGlobalClusterCommandOutput extends RemoveFromGlobalCl
6969
* // SynchronizationStatus: "connected" || "pending-resync",
7070
* // },
7171
* // ],
72+
* // Endpoint: "STRING_VALUE",
7273
* // FailoverState: { // FailoverState
7374
* // Status: "pending" || "failing-over" || "cancelling",
7475
* // FromDbClusterArn: "STRING_VALUE",

clients/client-rds/src/commands/SwitchoverGlobalClusterCommand.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -74,6 +74,7 @@ export interface SwitchoverGlobalClusterCommandOutput extends SwitchoverGlobalCl
7474
* // SynchronizationStatus: "connected" || "pending-resync",
7575
* // },
7676
* // ],
77+
* // Endpoint: "STRING_VALUE",
7778
* // FailoverState: { // FailoverState
7879
* // Status: "pending" || "failing-over" || "cancelling",
7980
* // FromDbClusterArn: "STRING_VALUE",

clients/client-rds/src/models/models_0.ts

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12433,6 +12433,15 @@ export interface GlobalCluster {
1243312433
*/
1243412434
GlobalClusterMembers?: GlobalClusterMember[];
1243512435

12436+
/**
12437+
* <p>
12438+
* The writer endpoint for the new global database cluster. This endpoint always
12439+
* points to the writer DB instance in the current primary cluster.
12440+
* </p>
12441+
* @public
12442+
*/
12443+
Endpoint?: string;
12444+
1243612445
/**
1243712446
* <p>A data object containing all properties for the current state of an in-process or pending switchover or failover process for this global cluster (Aurora global database).
1243812447
* This object is empty unless the <code>SwitchoverGlobalCluster</code> or <code>FailoverGlobalCluster</code> operation was called on this global cluster.</p>
@@ -12463,7 +12472,8 @@ export interface CreateGlobalClusterResult {
1246312472
}
1246412473

1246512474
/**
12466-
* <p>The <code>GlobalClusterIdentifier</code> already exists. Choose a new global database identifier (unique name) to create a new global database cluster.</p>
12475+
* <p>The <code>GlobalClusterIdentifier</code> already exists. Specify a new global database identifier
12476+
* (unique name) to create a new global database cluster or to rename an existing one.</p>
1246712477
* @public
1246812478
*/
1246912479
export class GlobalClusterAlreadyExistsFault extends __BaseException {

clients/client-rds/src/protocols/Aws_query.ts

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21306,6 +21306,9 @@ const de_GlobalCluster = (output: any, context: __SerdeContext): GlobalCluster =
2130621306
} else if (output[_GCM] != null && output[_GCM][_GCMl] != null) {
2130721307
contents[_GCM] = de_GlobalClusterMemberList(__getArrayIfSingleItem(output[_GCM][_GCMl]), context);
2130821308
}
21309+
if (output[_End] != null) {
21310+
contents[_End] = __expectString(output[_End]);
21311+
}
2130921312
if (output[_FSa] != null) {
2131021313
contents[_FSa] = de_FailoverState(output[_FSa], context);
2131121314
}

codegen/sdk-codegen/aws-models/rds.json

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19418,6 +19418,12 @@
1941819418
"smithy.api#documentation": "<p>The list of primary and secondary clusters within the global database cluster.</p>"
1941919419
}
1942019420
},
19421+
"Endpoint": {
19422+
"target": "com.amazonaws.rds#String",
19423+
"traits": {
19424+
"smithy.api#documentation": "<p>\n The writer endpoint for the new global database cluster. This endpoint always \n points to the writer DB instance in the current primary cluster.\n </p>"
19425+
}
19426+
},
1942119427
"FailoverState": {
1942219428
"target": "com.amazonaws.rds#FailoverState",
1942319429
"traits": {
@@ -19444,7 +19450,7 @@
1944419450
"code": "GlobalClusterAlreadyExistsFault",
1944519451
"httpResponseCode": 400
1944619452
},
19447-
"smithy.api#documentation": "<p>The <code>GlobalClusterIdentifier</code> already exists. Choose a new global database identifier (unique name) to create a new global database cluster.</p>",
19453+
"smithy.api#documentation": "<p>The <code>GlobalClusterIdentifier</code> already exists. Specify a new global database identifier \n (unique name) to create a new global database cluster or to rename an existing one.</p>",
1944819454
"smithy.api#error": "client",
1944919455
"smithy.api#httpError": 400
1945019456
}
@@ -23264,6 +23270,9 @@
2326423270
"target": "com.amazonaws.rds#ModifyGlobalClusterResult"
2326523271
},
2326623272
"errors": [
23273+
{
23274+
"target": "com.amazonaws.rds#GlobalClusterAlreadyExistsFault"
23275+
},
2326723276
{
2326823277
"target": "com.amazonaws.rds#GlobalClusterNotFoundFault"
2326923278
},

0 commit comments

Comments
 (0)