@aws-sdk/client-neptune 3.808.0 → 3.812.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +8 -0
- package/dist-cjs/index.js +98 -1
- package/dist-es/Neptune.js +2 -0
- package/dist-es/commands/SwitchoverGlobalClusterCommand.js +22 -0
- package/dist-es/commands/index.js +1 -0
- package/dist-es/models/models_0.js +5 -0
- package/dist-es/protocols/Aws_query.js +72 -0
- package/dist-types/Neptune.d.ts +7 -0
- package/dist-types/NeptuneClient.d.ts +3 -2
- package/dist-types/commands/CreateGlobalClusterCommand.d.ts +6 -0
- package/dist-types/commands/DeleteGlobalClusterCommand.d.ts +6 -0
- package/dist-types/commands/DescribeGlobalClustersCommand.d.ts +6 -0
- package/dist-types/commands/FailoverGlobalClusterCommand.d.ts +8 -0
- package/dist-types/commands/ModifyGlobalClusterCommand.d.ts +6 -0
- package/dist-types/commands/RemoveFromGlobalClusterCommand.d.ts +6 -0
- package/dist-types/commands/SwitchoverGlobalClusterCommand.d.ts +120 -0
- package/dist-types/commands/index.d.ts +1 -0
- package/dist-types/models/models_0.d.ts +204 -45
- package/dist-types/protocols/Aws_query.d.ts +9 -0
- package/dist-types/ts3.4/Neptune.d.ts +17 -0
- package/dist-types/ts3.4/NeptuneClient.d.ts +8 -2
- package/dist-types/ts3.4/commands/SwitchoverGlobalClusterCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/index.d.ts +1 -0
- package/dist-types/ts3.4/models/models_0.d.ts +23 -0
- package/dist-types/ts3.4/protocols/Aws_query.d.ts +12 -0
- package/package.json +13 -13
|
@@ -0,0 +1,120 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import { SwitchoverGlobalClusterMessage, SwitchoverGlobalClusterResult } from "../models/models_0";
|
|
4
|
+
import { NeptuneClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../NeptuneClient";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link SwitchoverGlobalClusterCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface SwitchoverGlobalClusterCommandInput extends SwitchoverGlobalClusterMessage {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link SwitchoverGlobalClusterCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface SwitchoverGlobalClusterCommandOutput extends SwitchoverGlobalClusterResult, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const SwitchoverGlobalClusterCommand_base: {
|
|
25
|
+
new (input: SwitchoverGlobalClusterCommandInput): import("@smithy/smithy-client").CommandImpl<SwitchoverGlobalClusterCommandInput, SwitchoverGlobalClusterCommandOutput, NeptuneClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (input: SwitchoverGlobalClusterCommandInput): import("@smithy/smithy-client").CommandImpl<SwitchoverGlobalClusterCommandInput, SwitchoverGlobalClusterCommandOutput, NeptuneClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Switches over the specified secondary DB cluster to be the new primary DB cluster in the global
|
|
31
|
+
* database cluster. Switchover operations were previously called "managed planned failovers."</p>
|
|
32
|
+
* <p>Promotes the specified secondary cluster to assume full read/write capabilities and demotes the current
|
|
33
|
+
* primary cluster to a secondary (read-only) cluster, maintaining the original replication topology. All secondary
|
|
34
|
+
* clusters are synchronized with the primary at the beginning of the process so the new primary continues operations
|
|
35
|
+
* for the global database without losing any data. Your database is unavailable for a short time while the primary
|
|
36
|
+
* and selected secondary clusters are assuming their new roles.</p>
|
|
37
|
+
* <note>
|
|
38
|
+
* <p>This operation is intended for controlled environments, for operations such as "regional rotation" or
|
|
39
|
+
* to fall back to the original primary after a global database failover.</p>
|
|
40
|
+
* </note>
|
|
41
|
+
* @example
|
|
42
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
43
|
+
* ```javascript
|
|
44
|
+
* import { NeptuneClient, SwitchoverGlobalClusterCommand } from "@aws-sdk/client-neptune"; // ES Modules import
|
|
45
|
+
* // const { NeptuneClient, SwitchoverGlobalClusterCommand } = require("@aws-sdk/client-neptune"); // CommonJS import
|
|
46
|
+
* const client = new NeptuneClient(config);
|
|
47
|
+
* const input = { // SwitchoverGlobalClusterMessage
|
|
48
|
+
* GlobalClusterIdentifier: "STRING_VALUE", // required
|
|
49
|
+
* TargetDbClusterIdentifier: "STRING_VALUE", // required
|
|
50
|
+
* };
|
|
51
|
+
* const command = new SwitchoverGlobalClusterCommand(input);
|
|
52
|
+
* const response = await client.send(command);
|
|
53
|
+
* // { // SwitchoverGlobalClusterResult
|
|
54
|
+
* // GlobalCluster: { // GlobalCluster
|
|
55
|
+
* // GlobalClusterIdentifier: "STRING_VALUE",
|
|
56
|
+
* // GlobalClusterResourceId: "STRING_VALUE",
|
|
57
|
+
* // GlobalClusterArn: "STRING_VALUE",
|
|
58
|
+
* // Status: "STRING_VALUE",
|
|
59
|
+
* // Engine: "STRING_VALUE",
|
|
60
|
+
* // EngineVersion: "STRING_VALUE",
|
|
61
|
+
* // StorageEncrypted: true || false,
|
|
62
|
+
* // DeletionProtection: true || false,
|
|
63
|
+
* // GlobalClusterMembers: [ // GlobalClusterMemberList
|
|
64
|
+
* // { // GlobalClusterMember
|
|
65
|
+
* // DBClusterArn: "STRING_VALUE",
|
|
66
|
+
* // Readers: [ // ReadersArnList
|
|
67
|
+
* // "STRING_VALUE",
|
|
68
|
+
* // ],
|
|
69
|
+
* // IsWriter: true || false,
|
|
70
|
+
* // },
|
|
71
|
+
* // ],
|
|
72
|
+
* // FailoverState: { // FailoverState
|
|
73
|
+
* // Status: "pending" || "failing-over" || "cancelling",
|
|
74
|
+
* // FromDbClusterArn: "STRING_VALUE",
|
|
75
|
+
* // ToDbClusterArn: "STRING_VALUE",
|
|
76
|
+
* // IsDataLossAllowed: true || false,
|
|
77
|
+
* // },
|
|
78
|
+
* // },
|
|
79
|
+
* // };
|
|
80
|
+
*
|
|
81
|
+
* ```
|
|
82
|
+
*
|
|
83
|
+
* @param SwitchoverGlobalClusterCommandInput - {@link SwitchoverGlobalClusterCommandInput}
|
|
84
|
+
* @returns {@link SwitchoverGlobalClusterCommandOutput}
|
|
85
|
+
* @see {@link SwitchoverGlobalClusterCommandInput} for command's `input` shape.
|
|
86
|
+
* @see {@link SwitchoverGlobalClusterCommandOutput} for command's `response` shape.
|
|
87
|
+
* @see {@link NeptuneClientResolvedConfig | config} for NeptuneClient's `config` shape.
|
|
88
|
+
*
|
|
89
|
+
* @throws {@link DBClusterNotFoundFault} (client fault)
|
|
90
|
+
* <p>
|
|
91
|
+
* <i>DBClusterIdentifier</i> does not refer to an existing DB cluster.</p>
|
|
92
|
+
*
|
|
93
|
+
* @throws {@link GlobalClusterNotFoundFault} (client fault)
|
|
94
|
+
* <p>The <code>GlobalClusterIdentifier</code> doesn't refer to an existing global database cluster. </p>
|
|
95
|
+
*
|
|
96
|
+
* @throws {@link InvalidDBClusterStateFault} (client fault)
|
|
97
|
+
* <p>The DB cluster is not in a valid state.</p>
|
|
98
|
+
*
|
|
99
|
+
* @throws {@link InvalidGlobalClusterStateFault} (client fault)
|
|
100
|
+
* <p>The global cluster is in an invalid state and can't perform the requested operation. </p>
|
|
101
|
+
*
|
|
102
|
+
* @throws {@link NeptuneServiceException}
|
|
103
|
+
* <p>Base exception class for all service exceptions from Neptune service.</p>
|
|
104
|
+
*
|
|
105
|
+
*
|
|
106
|
+
* @public
|
|
107
|
+
*/
|
|
108
|
+
export declare class SwitchoverGlobalClusterCommand extends SwitchoverGlobalClusterCommand_base {
|
|
109
|
+
/** @internal type navigation helper, not in runtime. */
|
|
110
|
+
protected static __types: {
|
|
111
|
+
api: {
|
|
112
|
+
input: SwitchoverGlobalClusterMessage;
|
|
113
|
+
output: SwitchoverGlobalClusterResult;
|
|
114
|
+
};
|
|
115
|
+
sdk: {
|
|
116
|
+
input: SwitchoverGlobalClusterCommandInput;
|
|
117
|
+
output: SwitchoverGlobalClusterCommandOutput;
|
|
118
|
+
};
|
|
119
|
+
};
|
|
120
|
+
}
|
|
@@ -1018,7 +1018,7 @@ export interface CreateDBClusterMessage {
|
|
|
1018
1018
|
Engine: string | undefined;
|
|
1019
1019
|
/**
|
|
1020
1020
|
* <p>The version number of the database engine to use for the new DB cluster.</p>
|
|
1021
|
-
* <p>Example: <code>1.
|
|
1021
|
+
* <p>Example: <code>1.2.1.0</code>
|
|
1022
1022
|
* </p>
|
|
1023
1023
|
* @public
|
|
1024
1024
|
*/
|
|
@@ -1171,27 +1171,29 @@ export interface CreateDBClusterMessage {
|
|
|
1171
1171
|
*/
|
|
1172
1172
|
GlobalClusterIdentifier?: string | undefined;
|
|
1173
1173
|
/**
|
|
1174
|
-
* <p>The storage type
|
|
1174
|
+
* <p>The storage type for the new DB cluster.</p>
|
|
1175
1175
|
* <p>Valid Values:</p>
|
|
1176
1176
|
* <ul>
|
|
1177
1177
|
* <li>
|
|
1178
1178
|
* <p>
|
|
1179
|
-
* <
|
|
1180
|
-
*
|
|
1179
|
+
* <b>
|
|
1180
|
+
* <code>standard</code>
|
|
1181
|
+
* </b> –
|
|
1182
|
+
* ( <i>the default</i> ) Configures cost-effective database storage for applications
|
|
1183
|
+
* with moderate to small I/O usage. When set to <code>standard</code>, the storage type
|
|
1184
|
+
* is not returned in the response.</p>
|
|
1181
1185
|
* </li>
|
|
1182
|
-
* </ul>
|
|
1183
|
-
* <p>Default:</p>
|
|
1184
|
-
* <ul>
|
|
1185
1186
|
* <li>
|
|
1186
1187
|
* <p>
|
|
1187
|
-
* <
|
|
1188
|
-
*
|
|
1188
|
+
* <b>
|
|
1189
|
+
* <code>iopt1</code>
|
|
1190
|
+
* </b> –
|
|
1191
|
+
* Enables <a href="https://docs.aws.amazon.com/neptune/latest/userguide/storage-types.html#provisioned-iops-storage">I/O-Optimized storage</a>
|
|
1192
|
+
* that's designed to meet the needs of I/O-intensive graph workloads that
|
|
1193
|
+
* require predictable pricing with low I/O latency and consistent I/O throughput.</p>
|
|
1194
|
+
* <p>Neptune I/O-Optimized storage is only available starting with engine release 1.3.0.0.</p>
|
|
1189
1195
|
* </li>
|
|
1190
1196
|
* </ul>
|
|
1191
|
-
* <note>
|
|
1192
|
-
* <p>When you create a Neptune cluster with the storage type set to <code>iopt1</code>, the storage type is returned
|
|
1193
|
-
* in the response. The storage type isn't returned when you set it to <code>standard</code>.</p>
|
|
1194
|
-
* </note>
|
|
1195
1197
|
* @public
|
|
1196
1198
|
*/
|
|
1197
1199
|
StorageType?: string | undefined;
|
|
@@ -1340,7 +1342,27 @@ export interface ClusterPendingModifiedValues {
|
|
|
1340
1342
|
*/
|
|
1341
1343
|
BackupRetentionPeriod?: number | undefined;
|
|
1342
1344
|
/**
|
|
1343
|
-
* <p>The storage type for the DB cluster
|
|
1345
|
+
* <p>The pending change in storage type for the DB cluster. Valid Values:</p>
|
|
1346
|
+
* <ul>
|
|
1347
|
+
* <li>
|
|
1348
|
+
* <p>
|
|
1349
|
+
* <b>
|
|
1350
|
+
* <code>standard</code>
|
|
1351
|
+
* </b> –
|
|
1352
|
+
* ( <i>the default</i> ) Configures cost-effective database storage for applications
|
|
1353
|
+
* with moderate to small I/O usage.</p>
|
|
1354
|
+
* </li>
|
|
1355
|
+
* <li>
|
|
1356
|
+
* <p>
|
|
1357
|
+
* <b>
|
|
1358
|
+
* <code>iopt1</code>
|
|
1359
|
+
* </b> –
|
|
1360
|
+
* Enables <a href="https://docs.aws.amazon.com/neptune/latest/userguide/storage-types.html#provisioned-iops-storage">I/O-Optimized storage</a>
|
|
1361
|
+
* that's designed to meet the needs of I/O-intensive graph workloads that
|
|
1362
|
+
* require predictable pricing with low I/O latency and consistent I/O throughput.</p>
|
|
1363
|
+
* <p>Neptune I/O-Optimized storage is only available starting with engine release 1.3.0.0.</p>
|
|
1364
|
+
* </li>
|
|
1365
|
+
* </ul>
|
|
1344
1366
|
* @public
|
|
1345
1367
|
*/
|
|
1346
1368
|
StorageType?: string | undefined;
|
|
@@ -1352,7 +1374,7 @@ export interface ClusterPendingModifiedValues {
|
|
|
1352
1374
|
*/
|
|
1353
1375
|
AllocatedStorage?: number | undefined;
|
|
1354
1376
|
/**
|
|
1355
|
-
* <p>The Provisioned IOPS (I/O operations per second) value. This setting is only for
|
|
1377
|
+
* <p>The Provisioned IOPS (I/O operations per second) value. This setting is only for Multi-AZ DB clusters.</p>
|
|
1356
1378
|
* @public
|
|
1357
1379
|
*/
|
|
1358
1380
|
Iops?: number | undefined;
|
|
@@ -1657,7 +1679,28 @@ export interface DBCluster {
|
|
|
1657
1679
|
*/
|
|
1658
1680
|
IOOptimizedNextAllowedModificationTime?: Date | undefined;
|
|
1659
1681
|
/**
|
|
1660
|
-
* <p>The storage type
|
|
1682
|
+
* <p>The storage type used by the DB cluster.</p>
|
|
1683
|
+
* <p>Valid Values:</p>
|
|
1684
|
+
* <ul>
|
|
1685
|
+
* <li>
|
|
1686
|
+
* <p>
|
|
1687
|
+
* <b>
|
|
1688
|
+
* <code>standard</code>
|
|
1689
|
+
* </b> –
|
|
1690
|
+
* ( <i>the default</i> ) Provides cost-effective database storage for applications
|
|
1691
|
+
* with moderate to small I/O usage.</p>
|
|
1692
|
+
* </li>
|
|
1693
|
+
* <li>
|
|
1694
|
+
* <p>
|
|
1695
|
+
* <b>
|
|
1696
|
+
* <code>iopt1</code>
|
|
1697
|
+
* </b> –
|
|
1698
|
+
* Enables <a href="https://docs.aws.amazon.com/neptune/latest/userguide/storage-types.html#provisioned-iops-storage">I/O-Optimized storage</a>
|
|
1699
|
+
* that's designed to meet the needs of I/O-intensive graph workloads that
|
|
1700
|
+
* require predictable pricing with low I/O latency and consistent I/O throughput.</p>
|
|
1701
|
+
* <p>Neptune I/O-Optimized storage is only available starting with engine release 1.3.0.0.</p>
|
|
1702
|
+
* </li>
|
|
1703
|
+
* </ul>
|
|
1661
1704
|
* @public
|
|
1662
1705
|
*/
|
|
1663
1706
|
StorageType?: string | undefined;
|
|
@@ -2321,8 +2364,7 @@ export interface CreateDBInstanceMessage {
|
|
|
2321
2364
|
*/
|
|
2322
2365
|
DBClusterIdentifier: string | undefined;
|
|
2323
2366
|
/**
|
|
2324
|
-
* <p>
|
|
2325
|
-
* <p>Not applicable. Storage is managed by the DB Cluster.</p>
|
|
2367
|
+
* <p>Not applicable. In Neptune the storage type is managed at the DB Cluster level.</p>
|
|
2326
2368
|
* @public
|
|
2327
2369
|
*/
|
|
2328
2370
|
StorageType?: string | undefined;
|
|
@@ -2697,7 +2739,7 @@ export interface PendingModifiedValues {
|
|
|
2697
2739
|
*/
|
|
2698
2740
|
DBInstanceIdentifier?: string | undefined;
|
|
2699
2741
|
/**
|
|
2700
|
-
* <p>
|
|
2742
|
+
* <p>Not applicable. In Neptune the storage type is managed at the DB Cluster level.</p>
|
|
2701
2743
|
* @public
|
|
2702
2744
|
*/
|
|
2703
2745
|
StorageType?: string | undefined;
|
|
@@ -2931,7 +2973,7 @@ export interface DBInstance {
|
|
|
2931
2973
|
*/
|
|
2932
2974
|
StatusInfos?: DBInstanceStatusInfo[] | undefined;
|
|
2933
2975
|
/**
|
|
2934
|
-
* <p>Specifies the storage type associated with DB instance.</p>
|
|
2976
|
+
* <p>Specifies the storage type associated with the DB instance.</p>
|
|
2935
2977
|
* @public
|
|
2936
2978
|
*/
|
|
2937
2979
|
StorageType?: string | undefined;
|
|
@@ -3497,6 +3539,68 @@ export interface CreateGlobalClusterMessage {
|
|
|
3497
3539
|
*/
|
|
3498
3540
|
StorageEncrypted?: boolean | undefined;
|
|
3499
3541
|
}
|
|
3542
|
+
/**
|
|
3543
|
+
* @public
|
|
3544
|
+
* @enum
|
|
3545
|
+
*/
|
|
3546
|
+
export declare const FailoverStatus: {
|
|
3547
|
+
readonly CANCELLING: "cancelling";
|
|
3548
|
+
readonly FAILING_OVER: "failing-over";
|
|
3549
|
+
readonly PENDING: "pending";
|
|
3550
|
+
};
|
|
3551
|
+
/**
|
|
3552
|
+
* @public
|
|
3553
|
+
*/
|
|
3554
|
+
export type FailoverStatus = (typeof FailoverStatus)[keyof typeof FailoverStatus];
|
|
3555
|
+
/**
|
|
3556
|
+
* <p>Contains the state of scheduled or in-process operations on a
|
|
3557
|
+
* global cluster (Neptune global database). This data type is empty unless a switchover
|
|
3558
|
+
* or failover operation is scheduled or is in progress on the Neptune global database.</p>
|
|
3559
|
+
* @public
|
|
3560
|
+
*/
|
|
3561
|
+
export interface FailoverState {
|
|
3562
|
+
/**
|
|
3563
|
+
* <p>The current status of the global cluster. Possible values are as follows:</p>
|
|
3564
|
+
* <ul>
|
|
3565
|
+
* <li>
|
|
3566
|
+
* <p>pending The service received a request to switch over or fail over the global cluster. The
|
|
3567
|
+
* global cluster's primary DB cluster and the specified secondary DB cluster are being verified before the operation
|
|
3568
|
+
* starts.</p>
|
|
3569
|
+
* </li>
|
|
3570
|
+
* <li>
|
|
3571
|
+
* <p>failing-over Neptune is promoting the chosen secondary Neptune DB cluster to become the new primary DB cluster to fail over the global cluster.</p>
|
|
3572
|
+
* </li>
|
|
3573
|
+
* <li>
|
|
3574
|
+
* <p>cancelling The request to switch over or fail over the global cluster was cancelled and the primary
|
|
3575
|
+
* Neptune DB cluster and the selected secondary Neptune DB cluster are returning to their previous states.</p>
|
|
3576
|
+
* </li>
|
|
3577
|
+
* <li>
|
|
3578
|
+
* <p>switching-over This status covers the range of Neptune internal operations that take place during the switchover process, such
|
|
3579
|
+
* as demoting the primary Neptune DB cluster, promoting the secondary Neptune DB cluster, and synchronizing replicas.</p>
|
|
3580
|
+
* </li>
|
|
3581
|
+
* </ul>
|
|
3582
|
+
* @public
|
|
3583
|
+
*/
|
|
3584
|
+
Status?: FailoverStatus | undefined;
|
|
3585
|
+
/**
|
|
3586
|
+
* <p>The Amazon Resource Name (ARN) of the Neptune DB cluster that is currently being demoted, and which is associated with this
|
|
3587
|
+
* state.</p>
|
|
3588
|
+
* @public
|
|
3589
|
+
*/
|
|
3590
|
+
FromDbClusterArn?: string | undefined;
|
|
3591
|
+
/**
|
|
3592
|
+
* <p>The Amazon Resource Name (ARN) of the Neptune DB cluster that is currently being promoted, and which is associated
|
|
3593
|
+
* with this state.</p>
|
|
3594
|
+
* @public
|
|
3595
|
+
*/
|
|
3596
|
+
ToDbClusterArn?: string | undefined;
|
|
3597
|
+
/**
|
|
3598
|
+
* <p>Indicates whether the operation is a global switchover or a global failover. If data loss is allowed, then the operation is a global failover.
|
|
3599
|
+
* Otherwise, it's a switchover.</p>
|
|
3600
|
+
* @public
|
|
3601
|
+
*/
|
|
3602
|
+
IsDataLossAllowed?: boolean | undefined;
|
|
3603
|
+
}
|
|
3500
3604
|
/**
|
|
3501
3605
|
* <p>
|
|
3502
3606
|
* A data structure with information about any primary and
|
|
@@ -3592,6 +3696,12 @@ export interface GlobalCluster {
|
|
|
3592
3696
|
* @public
|
|
3593
3697
|
*/
|
|
3594
3698
|
GlobalClusterMembers?: GlobalClusterMember[] | undefined;
|
|
3699
|
+
/**
|
|
3700
|
+
* <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 (Neptune global database).
|
|
3701
|
+
* This object is empty unless the <code>SwitchoverGlobalCluster</code> or <code>FailoverGlobalCluster</code> operation was called on this global cluster.</p>
|
|
3702
|
+
* @public
|
|
3703
|
+
*/
|
|
3704
|
+
FailoverState?: FailoverState | undefined;
|
|
3595
3705
|
}
|
|
3596
3706
|
/**
|
|
3597
3707
|
* @public
|
|
@@ -4160,12 +4270,11 @@ export interface DBClusterEndpoint {
|
|
|
4160
4270
|
*/
|
|
4161
4271
|
export interface DBClusterEndpointMessage {
|
|
4162
4272
|
/**
|
|
4163
|
-
* <p>
|
|
4273
|
+
* <p> n optional pagination token provided by a previous
|
|
4164
4274
|
* <code>DescribeDBClusterEndpoints</code> request.
|
|
4165
4275
|
* If this parameter is specified, the response includes
|
|
4166
4276
|
* only records beyond the marker,
|
|
4167
|
-
* up to the value specified by <code>MaxRecords</code
|
|
4168
|
-
* </p>
|
|
4277
|
+
* up to the value specified by <code>MaxRecords</code>.</p>
|
|
4169
4278
|
* @public
|
|
4170
4279
|
*/
|
|
4171
4280
|
Marker?: string | undefined;
|
|
@@ -4222,20 +4331,19 @@ export interface DescribeDBClusterEndpointsMessage {
|
|
|
4222
4331
|
/**
|
|
4223
4332
|
* <p>The maximum number of records to include in the response.
|
|
4224
4333
|
* If more records exist than the specified <code>MaxRecords</code> value,
|
|
4225
|
-
* a pagination token called a marker is included in the response
|
|
4226
|
-
*
|
|
4334
|
+
* a pagination token called a marker is included in the response
|
|
4335
|
+
* so you can retrieve the remaining results.</p>
|
|
4227
4336
|
* <p>Default: 100</p>
|
|
4228
4337
|
* <p>Constraints: Minimum 20, maximum 100.</p>
|
|
4229
4338
|
* @public
|
|
4230
4339
|
*/
|
|
4231
4340
|
MaxRecords?: number | undefined;
|
|
4232
4341
|
/**
|
|
4233
|
-
* <p>
|
|
4342
|
+
* <p>An optional pagination token provided by a previous
|
|
4234
4343
|
* <code>DescribeDBClusterEndpoints</code> request.
|
|
4235
4344
|
* If this parameter is specified, the response includes
|
|
4236
4345
|
* only records beyond the marker,
|
|
4237
|
-
* up to the value specified by <code>MaxRecords</code
|
|
4238
|
-
* </p>
|
|
4346
|
+
* up to the value specified by <code>MaxRecords</code>.</p>
|
|
4239
4347
|
* @public
|
|
4240
4348
|
*/
|
|
4241
4349
|
Marker?: string | undefined;
|
|
@@ -5669,7 +5777,7 @@ export interface OrderableDBInstanceOption {
|
|
|
5669
5777
|
*/
|
|
5670
5778
|
SupportsStorageEncryption?: boolean | undefined;
|
|
5671
5779
|
/**
|
|
5672
|
-
* <p>
|
|
5780
|
+
* <p>Not applicable. In Neptune the storage type is managed at the DB Cluster level.</p>
|
|
5673
5781
|
* @public
|
|
5674
5782
|
*/
|
|
5675
5783
|
StorageType?: string | undefined;
|
|
@@ -5867,30 +5975,27 @@ export interface Range {
|
|
|
5867
5975
|
Step?: number | undefined;
|
|
5868
5976
|
}
|
|
5869
5977
|
/**
|
|
5870
|
-
* <p>
|
|
5871
|
-
* instance.</p>
|
|
5872
|
-
* <p>Contains the result of a successful call to the <a>DescribeValidDBInstanceModifications</a> action.</p>
|
|
5978
|
+
* <p>Not applicable. In Neptune the storage type is managed at the DB Cluster level.</p>
|
|
5873
5979
|
* @public
|
|
5874
5980
|
*/
|
|
5875
5981
|
export interface ValidStorageOptions {
|
|
5876
5982
|
/**
|
|
5877
|
-
* <p>
|
|
5983
|
+
* <p>Not applicable. In Neptune the storage type is managed at the DB Cluster level.</p>
|
|
5878
5984
|
* @public
|
|
5879
5985
|
*/
|
|
5880
5986
|
StorageType?: string | undefined;
|
|
5881
5987
|
/**
|
|
5882
|
-
* <p>
|
|
5988
|
+
* <p>Not applicable. In Neptune the storage type is managed at the DB Cluster level.</p>
|
|
5883
5989
|
* @public
|
|
5884
5990
|
*/
|
|
5885
5991
|
StorageSize?: Range[] | undefined;
|
|
5886
5992
|
/**
|
|
5887
|
-
* <p>
|
|
5993
|
+
* <p>Not applicable. In Neptune the storage type is managed at the DB Cluster level.</p>
|
|
5888
5994
|
* @public
|
|
5889
5995
|
*/
|
|
5890
5996
|
ProvisionedIops?: Range[] | undefined;
|
|
5891
5997
|
/**
|
|
5892
|
-
* <p>
|
|
5893
|
-
* which means that provisioned IOPS can be between 3 and 10 times storage.</p>
|
|
5998
|
+
* <p>Not applicable. In Neptune the storage type is managed at the DB Cluster level.</p>
|
|
5894
5999
|
* @public
|
|
5895
6000
|
*/
|
|
5896
6001
|
IopsToStorageRatio?: DoubleRange[] | undefined;
|
|
@@ -5977,6 +6082,21 @@ export interface FailoverGlobalClusterMessage {
|
|
|
5977
6082
|
* @public
|
|
5978
6083
|
*/
|
|
5979
6084
|
TargetDbClusterIdentifier: string | undefined;
|
|
6085
|
+
/**
|
|
6086
|
+
* <p>Specifies whether to allow data loss for this global database cluster operation.
|
|
6087
|
+
* Allowing data loss triggers a global failover operation.</p>
|
|
6088
|
+
* <p>If you don't specify <code>AllowDataLoss</code>, the global database cluster operation
|
|
6089
|
+
* defaults to a switchover.</p>
|
|
6090
|
+
* <p>Constraints:Can't be specified together with the <code>Switchover</code> parameter.</p>
|
|
6091
|
+
* @public
|
|
6092
|
+
*/
|
|
6093
|
+
AllowDataLoss?: boolean | undefined;
|
|
6094
|
+
/**
|
|
6095
|
+
* <p>Specifies whether to switch over this global database cluster.</p>
|
|
6096
|
+
* <p>Constraints:Can't be specified together with the <code>AllowDataLoss</code> parameter.</p>
|
|
6097
|
+
* @public
|
|
6098
|
+
*/
|
|
6099
|
+
Switchover?: boolean | undefined;
|
|
5980
6100
|
}
|
|
5981
6101
|
/**
|
|
5982
6102
|
* @public
|
|
@@ -6269,16 +6389,21 @@ export interface ModifyDBClusterMessage {
|
|
|
6269
6389
|
* <ul>
|
|
6270
6390
|
* <li>
|
|
6271
6391
|
* <p>
|
|
6272
|
-
* <
|
|
6273
|
-
*
|
|
6392
|
+
* <b>
|
|
6393
|
+
* <code>standard</code>
|
|
6394
|
+
* </b> –
|
|
6395
|
+
* ( <i>the default</i> ) Configures cost-effective database storage for applications
|
|
6396
|
+
* with moderate to small I/O usage.</p>
|
|
6274
6397
|
* </li>
|
|
6275
|
-
* </ul>
|
|
6276
|
-
* <p>Default:</p>
|
|
6277
|
-
* <ul>
|
|
6278
6398
|
* <li>
|
|
6279
6399
|
* <p>
|
|
6280
|
-
* <
|
|
6281
|
-
*
|
|
6400
|
+
* <b>
|
|
6401
|
+
* <code>iopt1</code>
|
|
6402
|
+
* </b> –
|
|
6403
|
+
* Enables <a href="https://docs.aws.amazon.com/neptune/latest/userguide/storage-types.html#provisioned-iops-storage">I/O-Optimized storage</a>
|
|
6404
|
+
* that's designed to meet the needs of I/O-intensive graph workloads that
|
|
6405
|
+
* require predictable pricing with low I/O latency and consistent I/O throughput.</p>
|
|
6406
|
+
* <p>Neptune I/O-Optimized storage is only available starting with engine release 1.3.0.0.</p>
|
|
6282
6407
|
* </li>
|
|
6283
6408
|
* </ul>
|
|
6284
6409
|
* @public
|
|
@@ -6756,7 +6881,7 @@ export interface ModifyDBInstanceMessage {
|
|
|
6756
6881
|
*/
|
|
6757
6882
|
NewDBInstanceIdentifier?: string | undefined;
|
|
6758
6883
|
/**
|
|
6759
|
-
* <p>Not
|
|
6884
|
+
* <p>Not applicable. In Neptune the storage type is managed at the DB Cluster level.</p>
|
|
6760
6885
|
* @public
|
|
6761
6886
|
*/
|
|
6762
6887
|
StorageType?: string | undefined;
|
|
@@ -7794,6 +7919,40 @@ export interface StopDBClusterResult {
|
|
|
7794
7919
|
*/
|
|
7795
7920
|
DBCluster?: DBCluster | undefined;
|
|
7796
7921
|
}
|
|
7922
|
+
/**
|
|
7923
|
+
* @public
|
|
7924
|
+
*/
|
|
7925
|
+
export interface SwitchoverGlobalClusterMessage {
|
|
7926
|
+
/**
|
|
7927
|
+
* <p>The identifier of the global database cluster to switch over. This parameter isn't case-sensitive.</p>
|
|
7928
|
+
* <p>Constraints: Must match the identifier of an existing global database cluster.</p>
|
|
7929
|
+
* @public
|
|
7930
|
+
*/
|
|
7931
|
+
GlobalClusterIdentifier: string | undefined;
|
|
7932
|
+
/**
|
|
7933
|
+
* <p>The Amazon Resource Name (ARN) of the secondary Neptune DB cluster that you want to promote to primary for
|
|
7934
|
+
* the global database.</p>
|
|
7935
|
+
* @public
|
|
7936
|
+
*/
|
|
7937
|
+
TargetDbClusterIdentifier: string | undefined;
|
|
7938
|
+
}
|
|
7939
|
+
/**
|
|
7940
|
+
* @public
|
|
7941
|
+
*/
|
|
7942
|
+
export interface SwitchoverGlobalClusterResult {
|
|
7943
|
+
/**
|
|
7944
|
+
* <p>Contains the details of an Amazon Neptune global database.</p>
|
|
7945
|
+
* <p>This data type is used as a response element for the
|
|
7946
|
+
* <a>CreateGlobalCluster</a>,
|
|
7947
|
+
* <a>DescribeGlobalClusters</a>,
|
|
7948
|
+
* <a>ModifyGlobalCluster</a>,
|
|
7949
|
+
* <a>DeleteGlobalCluster</a>,
|
|
7950
|
+
* <a>FailoverGlobalCluster</a>, and
|
|
7951
|
+
* <a>RemoveFromGlobalCluster</a> actions.</p>
|
|
7952
|
+
* @public
|
|
7953
|
+
*/
|
|
7954
|
+
GlobalCluster?: GlobalCluster | undefined;
|
|
7955
|
+
}
|
|
7797
7956
|
/**
|
|
7798
7957
|
* @internal
|
|
7799
7958
|
*/
|
|
@@ -69,6 +69,7 @@ import { RestoreDBClusterFromSnapshotCommandInput, RestoreDBClusterFromSnapshotC
|
|
|
69
69
|
import { RestoreDBClusterToPointInTimeCommandInput, RestoreDBClusterToPointInTimeCommandOutput } from "../commands/RestoreDBClusterToPointInTimeCommand";
|
|
70
70
|
import { StartDBClusterCommandInput, StartDBClusterCommandOutput } from "../commands/StartDBClusterCommand";
|
|
71
71
|
import { StopDBClusterCommandInput, StopDBClusterCommandOutput } from "../commands/StopDBClusterCommand";
|
|
72
|
+
import { SwitchoverGlobalClusterCommandInput, SwitchoverGlobalClusterCommandOutput } from "../commands/SwitchoverGlobalClusterCommand";
|
|
72
73
|
/**
|
|
73
74
|
* serializeAws_queryAddRoleToDBClusterCommand
|
|
74
75
|
*/
|
|
@@ -345,6 +346,10 @@ export declare const se_StartDBClusterCommand: (input: StartDBClusterCommandInpu
|
|
|
345
346
|
* serializeAws_queryStopDBClusterCommand
|
|
346
347
|
*/
|
|
347
348
|
export declare const se_StopDBClusterCommand: (input: StopDBClusterCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
|
|
349
|
+
/**
|
|
350
|
+
* serializeAws_querySwitchoverGlobalClusterCommand
|
|
351
|
+
*/
|
|
352
|
+
export declare const se_SwitchoverGlobalClusterCommand: (input: SwitchoverGlobalClusterCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
|
|
348
353
|
/**
|
|
349
354
|
* deserializeAws_queryAddRoleToDBClusterCommand
|
|
350
355
|
*/
|
|
@@ -621,3 +626,7 @@ export declare const de_StartDBClusterCommand: (output: __HttpResponse, context:
|
|
|
621
626
|
* deserializeAws_queryStopDBClusterCommand
|
|
622
627
|
*/
|
|
623
628
|
export declare const de_StopDBClusterCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<StopDBClusterCommandOutput>;
|
|
629
|
+
/**
|
|
630
|
+
* deserializeAws_querySwitchoverGlobalClusterCommand
|
|
631
|
+
*/
|
|
632
|
+
export declare const de_SwitchoverGlobalClusterCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<SwitchoverGlobalClusterCommandOutput>;
|
|
@@ -275,6 +275,10 @@ import {
|
|
|
275
275
|
StopDBClusterCommandInput,
|
|
276
276
|
StopDBClusterCommandOutput,
|
|
277
277
|
} from "./commands/StopDBClusterCommand";
|
|
278
|
+
import {
|
|
279
|
+
SwitchoverGlobalClusterCommandInput,
|
|
280
|
+
SwitchoverGlobalClusterCommandOutput,
|
|
281
|
+
} from "./commands/SwitchoverGlobalClusterCommand";
|
|
278
282
|
import { NeptuneClient } from "./NeptuneClient";
|
|
279
283
|
export interface Neptune {
|
|
280
284
|
addRoleToDBCluster(
|
|
@@ -1230,5 +1234,18 @@ export interface Neptune {
|
|
|
1230
1234
|
options: __HttpHandlerOptions,
|
|
1231
1235
|
cb: (err: any, data?: StopDBClusterCommandOutput) => void
|
|
1232
1236
|
): void;
|
|
1237
|
+
switchoverGlobalCluster(
|
|
1238
|
+
args: SwitchoverGlobalClusterCommandInput,
|
|
1239
|
+
options?: __HttpHandlerOptions
|
|
1240
|
+
): Promise<SwitchoverGlobalClusterCommandOutput>;
|
|
1241
|
+
switchoverGlobalCluster(
|
|
1242
|
+
args: SwitchoverGlobalClusterCommandInput,
|
|
1243
|
+
cb: (err: any, data?: SwitchoverGlobalClusterCommandOutput) => void
|
|
1244
|
+
): void;
|
|
1245
|
+
switchoverGlobalCluster(
|
|
1246
|
+
args: SwitchoverGlobalClusterCommandInput,
|
|
1247
|
+
options: __HttpHandlerOptions,
|
|
1248
|
+
cb: (err: any, data?: SwitchoverGlobalClusterCommandOutput) => void
|
|
1249
|
+
): void;
|
|
1233
1250
|
}
|
|
1234
1251
|
export declare class Neptune extends NeptuneClient implements Neptune {}
|
|
@@ -321,6 +321,10 @@ import {
|
|
|
321
321
|
StopDBClusterCommandInput,
|
|
322
322
|
StopDBClusterCommandOutput,
|
|
323
323
|
} from "./commands/StopDBClusterCommand";
|
|
324
|
+
import {
|
|
325
|
+
SwitchoverGlobalClusterCommandInput,
|
|
326
|
+
SwitchoverGlobalClusterCommandOutput,
|
|
327
|
+
} from "./commands/SwitchoverGlobalClusterCommand";
|
|
324
328
|
import {
|
|
325
329
|
ClientInputEndpointParameters,
|
|
326
330
|
ClientResolvedEndpointParameters,
|
|
@@ -397,7 +401,8 @@ export type ServiceInputTypes =
|
|
|
397
401
|
| RestoreDBClusterFromSnapshotCommandInput
|
|
398
402
|
| RestoreDBClusterToPointInTimeCommandInput
|
|
399
403
|
| StartDBClusterCommandInput
|
|
400
|
-
| StopDBClusterCommandInput
|
|
404
|
+
| StopDBClusterCommandInput
|
|
405
|
+
| SwitchoverGlobalClusterCommandInput;
|
|
401
406
|
export type ServiceOutputTypes =
|
|
402
407
|
| AddRoleToDBClusterCommandOutput
|
|
403
408
|
| AddSourceIdentifierToSubscriptionCommandOutput
|
|
@@ -467,7 +472,8 @@ export type ServiceOutputTypes =
|
|
|
467
472
|
| RestoreDBClusterFromSnapshotCommandOutput
|
|
468
473
|
| RestoreDBClusterToPointInTimeCommandOutput
|
|
469
474
|
| StartDBClusterCommandOutput
|
|
470
|
-
| StopDBClusterCommandOutput
|
|
475
|
+
| StopDBClusterCommandOutput
|
|
476
|
+
| SwitchoverGlobalClusterCommandOutput;
|
|
471
477
|
export interface ClientDefaults
|
|
472
478
|
extends Partial<__SmithyConfiguration<__HttpHandlerOptions>> {
|
|
473
479
|
requestHandler?: __HttpHandlerUserInput;
|