@aws-sdk/client-rds 3.321.1 → 3.326.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/dist-types/commands/AddRoleToDBClusterCommand.d.ts +4 -0
- package/dist-types/commands/AddRoleToDBInstanceCommand.d.ts +4 -0
- package/dist-types/commands/AddSourceIdentifierToSubscriptionCommand.d.ts +21 -0
- package/dist-types/commands/AddTagsToResourceCommand.d.ts +4 -0
- package/dist-types/commands/ApplyPendingMaintenanceActionCommand.d.ts +18 -0
- package/dist-types/commands/AuthorizeDBSecurityGroupIngressCommand.d.ts +26 -0
- package/dist-types/commands/BacktrackDBClusterCommand.d.ts +11 -0
- package/dist-types/commands/CancelExportTaskCommand.d.ts +23 -0
- package/dist-types/commands/CopyDBClusterParameterGroupCommand.d.ts +11 -0
- package/dist-types/commands/CopyDBClusterSnapshotCommand.d.ts +37 -0
- package/dist-types/commands/CopyDBParameterGroupCommand.d.ts +11 -0
- package/dist-types/commands/CopyDBSnapshotCommand.d.ts +50 -0
- package/dist-types/commands/CopyOptionGroupCommand.d.ts +52 -0
- package/dist-types/commands/CreateBlueGreenDeploymentCommand.d.ts +34 -0
- package/dist-types/commands/CreateCustomDBEngineVersionCommand.d.ts +83 -0
- package/dist-types/commands/CreateDBClusterCommand.d.ts +151 -127
- package/dist-types/commands/CreateDBClusterEndpointCommand.d.ts +19 -0
- package/dist-types/commands/CreateDBClusterParameterGroupCommand.d.ts +11 -0
- package/dist-types/commands/CreateDBClusterSnapshotCommand.d.ts +37 -0
- package/dist-types/commands/CreateDBInstanceCommand.d.ts +216 -0
- package/dist-types/commands/CreateDBInstanceReadReplicaCommand.d.ts +216 -0
- package/dist-types/commands/CreateDBParameterGroupCommand.d.ts +11 -0
- package/dist-types/commands/CreateDBProxyCommand.d.ts +35 -0
- package/dist-types/commands/CreateDBProxyEndpointCommand.d.ts +22 -0
- package/dist-types/commands/CreateDBSecurityGroupCommand.d.ts +26 -0
- package/dist-types/commands/CreateDBSnapshotCommand.d.ts +50 -0
- package/dist-types/commands/CreateDBSubnetGroupCommand.d.ts +27 -0
- package/dist-types/commands/CreateEventSubscriptionCommand.d.ts +21 -0
- package/dist-types/commands/CreateGlobalClusterCommand.d.ts +31 -0
- package/dist-types/commands/CreateOptionGroupCommand.d.ts +52 -0
- package/dist-types/commands/DeleteBlueGreenDeploymentCommand.d.ts +34 -0
- package/dist-types/commands/DeleteCustomDBEngineVersionCommand.d.ts +83 -0
- package/dist-types/commands/DeleteDBClusterCommand.d.ts +151 -0
- package/dist-types/commands/DeleteDBClusterEndpointCommand.d.ts +19 -0
- package/dist-types/commands/DeleteDBClusterParameterGroupCommand.d.ts +4 -0
- package/dist-types/commands/DeleteDBClusterSnapshotCommand.d.ts +37 -0
- package/dist-types/commands/DeleteDBInstanceAutomatedBackupCommand.d.ts +42 -0
- package/dist-types/commands/DeleteDBInstanceCommand.d.ts +216 -0
- package/dist-types/commands/DeleteDBParameterGroupCommand.d.ts +4 -0
- package/dist-types/commands/DeleteDBProxyCommand.d.ts +35 -0
- package/dist-types/commands/DeleteDBProxyEndpointCommand.d.ts +22 -0
- package/dist-types/commands/DeleteDBSecurityGroupCommand.d.ts +4 -0
- package/dist-types/commands/DeleteDBSnapshotCommand.d.ts +50 -0
- package/dist-types/commands/DeleteDBSubnetGroupCommand.d.ts +4 -0
- package/dist-types/commands/DeleteEventSubscriptionCommand.d.ts +21 -0
- package/dist-types/commands/DeleteGlobalClusterCommand.d.ts +31 -0
- package/dist-types/commands/DeleteOptionGroupCommand.d.ts +4 -0
- package/dist-types/commands/DeregisterDBProxyTargetsCommand.d.ts +4 -0
- package/dist-types/commands/DescribeAccountAttributesCommand.d.ts +12 -0
- package/dist-types/commands/DescribeBlueGreenDeploymentsCommand.d.ts +37 -0
- package/dist-types/commands/DescribeCertificatesCommand.d.ts +18 -0
- package/dist-types/commands/DescribeDBClusterBacktracksCommand.d.ts +16 -0
- package/dist-types/commands/DescribeDBClusterEndpointsCommand.d.ts +24 -0
- package/dist-types/commands/DescribeDBClusterParameterGroupsCommand.d.ts +14 -0
- package/dist-types/commands/DescribeDBClusterParametersCommand.d.ts +23 -0
- package/dist-types/commands/DescribeDBClusterSnapshotAttributesCommand.d.ts +16 -0
- package/dist-types/commands/DescribeDBClusterSnapshotsCommand.d.ts +40 -0
- package/dist-types/commands/DescribeDBClustersCommand.d.ts +154 -0
- package/dist-types/commands/DescribeDBEngineVersionsCommand.d.ts +88 -0
- package/dist-types/commands/DescribeDBInstanceAutomatedBackupsCommand.d.ts +45 -0
- package/dist-types/commands/DescribeDBInstancesCommand.d.ts +219 -0
- package/dist-types/commands/DescribeDBLogFilesCommand.d.ts +13 -0
- package/dist-types/commands/DescribeDBParameterGroupsCommand.d.ts +14 -0
- package/dist-types/commands/DescribeDBParametersCommand.d.ts +23 -0
- package/dist-types/commands/DescribeDBProxiesCommand.d.ts +38 -0
- package/dist-types/commands/DescribeDBProxyEndpointsCommand.d.ts +25 -0
- package/dist-types/commands/DescribeDBProxyTargetGroupsCommand.d.ts +26 -0
- package/dist-types/commands/DescribeDBProxyTargetsCommand.d.ts +22 -0
- package/dist-types/commands/DescribeDBSecurityGroupsCommand.d.ts +29 -0
- package/dist-types/commands/DescribeDBSnapshotAttributesCommand.d.ts +16 -0
- package/dist-types/commands/DescribeDBSnapshotsCommand.d.ts +53 -0
- package/dist-types/commands/DescribeDBSubnetGroupsCommand.d.ts +30 -0
- package/dist-types/commands/DescribeEngineDefaultClusterParametersCommand.d.ts +26 -0
- package/dist-types/commands/DescribeEngineDefaultParametersCommand.d.ts +26 -0
- package/dist-types/commands/DescribeEventCategoriesCommand.d.ts +13 -0
- package/dist-types/commands/DescribeEventSubscriptionsCommand.d.ts +24 -0
- package/dist-types/commands/DescribeEventsCommand.d.ts +18 -0
- package/dist-types/commands/DescribeExportTasksCommand.d.ts +28 -0
- package/dist-types/commands/DescribeGlobalClustersCommand.d.ts +34 -0
- package/dist-types/commands/DescribeOptionGroupOptionsCommand.d.ts +52 -0
- package/dist-types/commands/DescribeOptionGroupsCommand.d.ts +55 -0
- package/dist-types/commands/DescribeOrderableDBInstanceOptionsCommand.d.ts +61 -0
- package/dist-types/commands/DescribePendingMaintenanceActionsCommand.d.ts +21 -0
- package/dist-types/commands/DescribeReservedDBInstancesCommand.d.ts +31 -0
- package/dist-types/commands/DescribeReservedDBInstancesOfferingsCommand.d.ts +25 -0
- package/dist-types/commands/DescribeSourceRegionsCommand.d.ts +14 -0
- package/dist-types/commands/DescribeValidDBInstanceModificationsCommand.d.ts +53 -0
- package/dist-types/commands/DownloadDBLogFilePortionCommand.d.ts +8 -0
- package/dist-types/commands/FailoverDBClusterCommand.d.ts +151 -0
- package/dist-types/commands/FailoverGlobalClusterCommand.d.ts +31 -0
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +11 -0
- package/dist-types/commands/ModifyActivityStreamCommand.d.ts +11 -0
- package/dist-types/commands/ModifyCertificatesCommand.d.ts +15 -0
- package/dist-types/commands/ModifyCurrentDBClusterCapacityCommand.d.ts +10 -0
- package/dist-types/commands/ModifyCustomDBEngineVersionCommand.d.ts +83 -0
- package/dist-types/commands/ModifyDBClusterCommand.d.ts +151 -0
- package/dist-types/commands/ModifyDBClusterEndpointCommand.d.ts +19 -0
- package/dist-types/commands/ModifyDBClusterParameterGroupCommand.d.ts +6 -0
- package/dist-types/commands/ModifyDBClusterSnapshotAttributeCommand.d.ts +16 -0
- package/dist-types/commands/ModifyDBInstanceCommand.d.ts +216 -49
- package/dist-types/commands/ModifyDBParameterGroupCommand.d.ts +6 -0
- package/dist-types/commands/ModifyDBProxyCommand.d.ts +35 -0
- package/dist-types/commands/ModifyDBProxyEndpointCommand.d.ts +22 -0
- package/dist-types/commands/ModifyDBProxyTargetGroupCommand.d.ts +23 -0
- package/dist-types/commands/ModifyDBSnapshotAttributeCommand.d.ts +16 -0
- package/dist-types/commands/ModifyDBSnapshotCommand.d.ts +50 -0
- package/dist-types/commands/ModifyDBSubnetGroupCommand.d.ts +27 -0
- package/dist-types/commands/ModifyEventSubscriptionCommand.d.ts +21 -0
- package/dist-types/commands/ModifyGlobalClusterCommand.d.ts +31 -0
- package/dist-types/commands/ModifyOptionGroupCommand.d.ts +52 -0
- package/dist-types/commands/PromoteReadReplicaCommand.d.ts +216 -0
- package/dist-types/commands/PromoteReadReplicaDBClusterCommand.d.ts +151 -0
- package/dist-types/commands/PurchaseReservedDBInstancesOfferingCommand.d.ts +28 -0
- package/dist-types/commands/RebootDBClusterCommand.d.ts +151 -0
- package/dist-types/commands/RebootDBInstanceCommand.d.ts +216 -0
- package/dist-types/commands/RegisterDBProxyTargetsCommand.d.ts +21 -0
- package/dist-types/commands/RemoveFromGlobalClusterCommand.d.ts +31 -0
- package/dist-types/commands/RemoveRoleFromDBClusterCommand.d.ts +4 -0
- package/dist-types/commands/RemoveRoleFromDBInstanceCommand.d.ts +4 -0
- package/dist-types/commands/RemoveSourceIdentifierFromSubscriptionCommand.d.ts +21 -0
- package/dist-types/commands/RemoveTagsFromResourceCommand.d.ts +4 -0
- package/dist-types/commands/ResetDBClusterParameterGroupCommand.d.ts +6 -0
- package/dist-types/commands/ResetDBParameterGroupCommand.d.ts +6 -0
- package/dist-types/commands/RestoreDBClusterFromS3Command.d.ts +151 -0
- package/dist-types/commands/RestoreDBClusterFromSnapshotCommand.d.ts +151 -0
- package/dist-types/commands/RestoreDBClusterToPointInTimeCommand.d.ts +151 -0
- package/dist-types/commands/RestoreDBInstanceFromDBSnapshotCommand.d.ts +216 -0
- package/dist-types/commands/RestoreDBInstanceFromS3Command.d.ts +216 -0
- package/dist-types/commands/RestoreDBInstanceToPointInTimeCommand.d.ts +216 -0
- package/dist-types/commands/RevokeDBSecurityGroupIngressCommand.d.ts +26 -0
- package/dist-types/commands/StartActivityStreamCommand.d.ts +11 -0
- package/dist-types/commands/StartDBClusterCommand.d.ts +151 -0
- package/dist-types/commands/StartDBInstanceAutomatedBackupsReplicationCommand.d.ts +42 -0
- package/dist-types/commands/StartDBInstanceCommand.d.ts +216 -0
- package/dist-types/commands/StartExportTaskCommand.d.ts +23 -0
- package/dist-types/commands/StopActivityStreamCommand.d.ts +8 -0
- package/dist-types/commands/StopDBClusterCommand.d.ts +151 -0
- package/dist-types/commands/StopDBInstanceAutomatedBackupsReplicationCommand.d.ts +42 -0
- package/dist-types/commands/StopDBInstanceCommand.d.ts +216 -0
- package/dist-types/commands/SwitchoverBlueGreenDeploymentCommand.d.ts +34 -0
- package/dist-types/commands/SwitchoverReadReplicaCommand.d.ts +216 -0
- package/package.json +17 -17
|
@@ -48,6 +48,18 @@ export interface DescribeSourceRegionsCommandOutput extends SourceRegionMessage,
|
|
|
48
48
|
* };
|
|
49
49
|
* const command = new DescribeSourceRegionsCommand(input);
|
|
50
50
|
* const response = await client.send(command);
|
|
51
|
+
* // { // SourceRegionMessage
|
|
52
|
+
* // Marker: "STRING_VALUE",
|
|
53
|
+
* // SourceRegions: [ // SourceRegionList
|
|
54
|
+
* // { // SourceRegion
|
|
55
|
+
* // RegionName: "STRING_VALUE",
|
|
56
|
+
* // Endpoint: "STRING_VALUE",
|
|
57
|
+
* // Status: "STRING_VALUE",
|
|
58
|
+
* // SupportsDBInstanceAutomatedBackupsReplication: true || false,
|
|
59
|
+
* // },
|
|
60
|
+
* // ],
|
|
61
|
+
* // };
|
|
62
|
+
*
|
|
51
63
|
* ```
|
|
52
64
|
*
|
|
53
65
|
* @param DescribeSourceRegionsCommandInput - {@link DescribeSourceRegionsCommandInput}
|
|
@@ -56,6 +68,8 @@ export interface DescribeSourceRegionsCommandOutput extends SourceRegionMessage,
|
|
|
56
68
|
* @see {@link DescribeSourceRegionsCommandOutput} for command's `response` shape.
|
|
57
69
|
* @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape.
|
|
58
70
|
*
|
|
71
|
+
* @throws {@link RDSServiceException}
|
|
72
|
+
* <p>Base exception class for all service exceptions from RDS service.</p>
|
|
59
73
|
*
|
|
60
74
|
* @example To describe source Regions
|
|
61
75
|
* ```javascript
|
|
@@ -33,6 +33,57 @@ export interface DescribeValidDBInstanceModificationsCommandOutput extends Descr
|
|
|
33
33
|
* };
|
|
34
34
|
* const command = new DescribeValidDBInstanceModificationsCommand(input);
|
|
35
35
|
* const response = await client.send(command);
|
|
36
|
+
* // { // DescribeValidDBInstanceModificationsResult
|
|
37
|
+
* // ValidDBInstanceModificationsMessage: { // ValidDBInstanceModificationsMessage
|
|
38
|
+
* // Storage: [ // ValidStorageOptionsList
|
|
39
|
+
* // { // ValidStorageOptions
|
|
40
|
+
* // StorageType: "STRING_VALUE",
|
|
41
|
+
* // StorageSize: [ // RangeList
|
|
42
|
+
* // { // Range
|
|
43
|
+
* // From: Number("int"),
|
|
44
|
+
* // To: Number("int"),
|
|
45
|
+
* // Step: Number("int"),
|
|
46
|
+
* // },
|
|
47
|
+
* // ],
|
|
48
|
+
* // ProvisionedIops: [
|
|
49
|
+
* // {
|
|
50
|
+
* // From: Number("int"),
|
|
51
|
+
* // To: Number("int"),
|
|
52
|
+
* // Step: Number("int"),
|
|
53
|
+
* // },
|
|
54
|
+
* // ],
|
|
55
|
+
* // IopsToStorageRatio: [ // DoubleRangeList
|
|
56
|
+
* // { // DoubleRange
|
|
57
|
+
* // From: Number("double"),
|
|
58
|
+
* // To: Number("double"),
|
|
59
|
+
* // },
|
|
60
|
+
* // ],
|
|
61
|
+
* // SupportsStorageAutoscaling: true || false,
|
|
62
|
+
* // ProvisionedStorageThroughput: [
|
|
63
|
+
* // {
|
|
64
|
+
* // From: Number("int"),
|
|
65
|
+
* // To: Number("int"),
|
|
66
|
+
* // Step: Number("int"),
|
|
67
|
+
* // },
|
|
68
|
+
* // ],
|
|
69
|
+
* // StorageThroughputToIopsRatio: [
|
|
70
|
+
* // {
|
|
71
|
+
* // From: Number("double"),
|
|
72
|
+
* // To: Number("double"),
|
|
73
|
+
* // },
|
|
74
|
+
* // ],
|
|
75
|
+
* // },
|
|
76
|
+
* // ],
|
|
77
|
+
* // ValidProcessorFeatures: [ // AvailableProcessorFeatureList
|
|
78
|
+
* // { // AvailableProcessorFeature
|
|
79
|
+
* // Name: "STRING_VALUE",
|
|
80
|
+
* // DefaultValue: "STRING_VALUE",
|
|
81
|
+
* // AllowedValues: "STRING_VALUE",
|
|
82
|
+
* // },
|
|
83
|
+
* // ],
|
|
84
|
+
* // },
|
|
85
|
+
* // };
|
|
86
|
+
*
|
|
36
87
|
* ```
|
|
37
88
|
*
|
|
38
89
|
* @param DescribeValidDBInstanceModificationsCommandInput - {@link DescribeValidDBInstanceModificationsCommandInput}
|
|
@@ -48,6 +99,8 @@ export interface DescribeValidDBInstanceModificationsCommandOutput extends Descr
|
|
|
48
99
|
* @throws {@link InvalidDBInstanceStateFault} (client fault)
|
|
49
100
|
* <p>The DB instance isn't in a valid state.</p>
|
|
50
101
|
*
|
|
102
|
+
* @throws {@link RDSServiceException}
|
|
103
|
+
* <p>Base exception class for all service exceptions from RDS service.</p>
|
|
51
104
|
*
|
|
52
105
|
* @example To describe valid modifications for a DB instance
|
|
53
106
|
* ```javascript
|
|
@@ -35,6 +35,12 @@ export interface DownloadDBLogFilePortionCommandOutput extends DownloadDBLogFile
|
|
|
35
35
|
* };
|
|
36
36
|
* const command = new DownloadDBLogFilePortionCommand(input);
|
|
37
37
|
* const response = await client.send(command);
|
|
38
|
+
* // { // DownloadDBLogFilePortionDetails
|
|
39
|
+
* // LogFileData: "STRING_VALUE",
|
|
40
|
+
* // Marker: "STRING_VALUE",
|
|
41
|
+
* // AdditionalDataPending: true || false,
|
|
42
|
+
* // };
|
|
43
|
+
*
|
|
38
44
|
* ```
|
|
39
45
|
*
|
|
40
46
|
* @param DownloadDBLogFilePortionCommandInput - {@link DownloadDBLogFilePortionCommandInput}
|
|
@@ -51,6 +57,8 @@ export interface DownloadDBLogFilePortionCommandOutput extends DownloadDBLogFile
|
|
|
51
57
|
* <p>
|
|
52
58
|
* <code>LogFileName</code> doesn't refer to an existing DB log file.</p>
|
|
53
59
|
*
|
|
60
|
+
* @throws {@link RDSServiceException}
|
|
61
|
+
* <p>Base exception class for all service exceptions from RDS service.</p>
|
|
54
62
|
*
|
|
55
63
|
* @example To download a DB log file
|
|
56
64
|
* ```javascript
|
|
@@ -48,6 +48,155 @@ export interface FailoverDBClusterCommandOutput extends FailoverDBClusterResult,
|
|
|
48
48
|
* };
|
|
49
49
|
* const command = new FailoverDBClusterCommand(input);
|
|
50
50
|
* const response = await client.send(command);
|
|
51
|
+
* // { // FailoverDBClusterResult
|
|
52
|
+
* // DBCluster: { // DBCluster
|
|
53
|
+
* // AllocatedStorage: Number("int"),
|
|
54
|
+
* // AvailabilityZones: [ // AvailabilityZones
|
|
55
|
+
* // "STRING_VALUE",
|
|
56
|
+
* // ],
|
|
57
|
+
* // BackupRetentionPeriod: Number("int"),
|
|
58
|
+
* // CharacterSetName: "STRING_VALUE",
|
|
59
|
+
* // DatabaseName: "STRING_VALUE",
|
|
60
|
+
* // DBClusterIdentifier: "STRING_VALUE",
|
|
61
|
+
* // DBClusterParameterGroup: "STRING_VALUE",
|
|
62
|
+
* // DBSubnetGroup: "STRING_VALUE",
|
|
63
|
+
* // Status: "STRING_VALUE",
|
|
64
|
+
* // AutomaticRestartTime: new Date("TIMESTAMP"),
|
|
65
|
+
* // PercentProgress: "STRING_VALUE",
|
|
66
|
+
* // EarliestRestorableTime: new Date("TIMESTAMP"),
|
|
67
|
+
* // Endpoint: "STRING_VALUE",
|
|
68
|
+
* // ReaderEndpoint: "STRING_VALUE",
|
|
69
|
+
* // CustomEndpoints: [ // StringList
|
|
70
|
+
* // "STRING_VALUE",
|
|
71
|
+
* // ],
|
|
72
|
+
* // MultiAZ: true || false,
|
|
73
|
+
* // Engine: "STRING_VALUE",
|
|
74
|
+
* // EngineVersion: "STRING_VALUE",
|
|
75
|
+
* // LatestRestorableTime: new Date("TIMESTAMP"),
|
|
76
|
+
* // Port: Number("int"),
|
|
77
|
+
* // MasterUsername: "STRING_VALUE",
|
|
78
|
+
* // DBClusterOptionGroupMemberships: [ // DBClusterOptionGroupMemberships
|
|
79
|
+
* // { // DBClusterOptionGroupStatus
|
|
80
|
+
* // DBClusterOptionGroupName: "STRING_VALUE",
|
|
81
|
+
* // Status: "STRING_VALUE",
|
|
82
|
+
* // },
|
|
83
|
+
* // ],
|
|
84
|
+
* // PreferredBackupWindow: "STRING_VALUE",
|
|
85
|
+
* // PreferredMaintenanceWindow: "STRING_VALUE",
|
|
86
|
+
* // ReplicationSourceIdentifier: "STRING_VALUE",
|
|
87
|
+
* // ReadReplicaIdentifiers: [ // ReadReplicaIdentifierList
|
|
88
|
+
* // "STRING_VALUE",
|
|
89
|
+
* // ],
|
|
90
|
+
* // DBClusterMembers: [ // DBClusterMemberList
|
|
91
|
+
* // { // DBClusterMember
|
|
92
|
+
* // DBInstanceIdentifier: "STRING_VALUE",
|
|
93
|
+
* // IsClusterWriter: true || false,
|
|
94
|
+
* // DBClusterParameterGroupStatus: "STRING_VALUE",
|
|
95
|
+
* // PromotionTier: Number("int"),
|
|
96
|
+
* // },
|
|
97
|
+
* // ],
|
|
98
|
+
* // VpcSecurityGroups: [ // VpcSecurityGroupMembershipList
|
|
99
|
+
* // { // VpcSecurityGroupMembership
|
|
100
|
+
* // VpcSecurityGroupId: "STRING_VALUE",
|
|
101
|
+
* // Status: "STRING_VALUE",
|
|
102
|
+
* // },
|
|
103
|
+
* // ],
|
|
104
|
+
* // HostedZoneId: "STRING_VALUE",
|
|
105
|
+
* // StorageEncrypted: true || false,
|
|
106
|
+
* // KmsKeyId: "STRING_VALUE",
|
|
107
|
+
* // DbClusterResourceId: "STRING_VALUE",
|
|
108
|
+
* // DBClusterArn: "STRING_VALUE",
|
|
109
|
+
* // AssociatedRoles: [ // DBClusterRoles
|
|
110
|
+
* // { // DBClusterRole
|
|
111
|
+
* // RoleArn: "STRING_VALUE",
|
|
112
|
+
* // Status: "STRING_VALUE",
|
|
113
|
+
* // FeatureName: "STRING_VALUE",
|
|
114
|
+
* // },
|
|
115
|
+
* // ],
|
|
116
|
+
* // IAMDatabaseAuthenticationEnabled: true || false,
|
|
117
|
+
* // CloneGroupId: "STRING_VALUE",
|
|
118
|
+
* // ClusterCreateTime: new Date("TIMESTAMP"),
|
|
119
|
+
* // EarliestBacktrackTime: new Date("TIMESTAMP"),
|
|
120
|
+
* // BacktrackWindow: Number("long"),
|
|
121
|
+
* // BacktrackConsumedChangeRecords: Number("long"),
|
|
122
|
+
* // EnabledCloudwatchLogsExports: [ // LogTypeList
|
|
123
|
+
* // "STRING_VALUE",
|
|
124
|
+
* // ],
|
|
125
|
+
* // Capacity: Number("int"),
|
|
126
|
+
* // EngineMode: "STRING_VALUE",
|
|
127
|
+
* // ScalingConfigurationInfo: { // ScalingConfigurationInfo
|
|
128
|
+
* // MinCapacity: Number("int"),
|
|
129
|
+
* // MaxCapacity: Number("int"),
|
|
130
|
+
* // AutoPause: true || false,
|
|
131
|
+
* // SecondsUntilAutoPause: Number("int"),
|
|
132
|
+
* // TimeoutAction: "STRING_VALUE",
|
|
133
|
+
* // SecondsBeforeTimeout: Number("int"),
|
|
134
|
+
* // },
|
|
135
|
+
* // DeletionProtection: true || false,
|
|
136
|
+
* // HttpEndpointEnabled: true || false,
|
|
137
|
+
* // ActivityStreamMode: "sync" || "async",
|
|
138
|
+
* // ActivityStreamStatus: "stopped" || "starting" || "started" || "stopping",
|
|
139
|
+
* // ActivityStreamKmsKeyId: "STRING_VALUE",
|
|
140
|
+
* // ActivityStreamKinesisStreamName: "STRING_VALUE",
|
|
141
|
+
* // CopyTagsToSnapshot: true || false,
|
|
142
|
+
* // CrossAccountClone: true || false,
|
|
143
|
+
* // DomainMemberships: [ // DomainMembershipList
|
|
144
|
+
* // { // DomainMembership
|
|
145
|
+
* // Domain: "STRING_VALUE",
|
|
146
|
+
* // Status: "STRING_VALUE",
|
|
147
|
+
* // FQDN: "STRING_VALUE",
|
|
148
|
+
* // IAMRoleName: "STRING_VALUE",
|
|
149
|
+
* // },
|
|
150
|
+
* // ],
|
|
151
|
+
* // TagList: [ // TagList
|
|
152
|
+
* // { // Tag
|
|
153
|
+
* // Key: "STRING_VALUE",
|
|
154
|
+
* // Value: "STRING_VALUE",
|
|
155
|
+
* // },
|
|
156
|
+
* // ],
|
|
157
|
+
* // GlobalWriteForwardingStatus: "enabled" || "disabled" || "enabling" || "disabling" || "unknown",
|
|
158
|
+
* // GlobalWriteForwardingRequested: true || false,
|
|
159
|
+
* // PendingModifiedValues: { // ClusterPendingModifiedValues
|
|
160
|
+
* // PendingCloudwatchLogsExports: { // PendingCloudwatchLogsExports
|
|
161
|
+
* // LogTypesToEnable: [
|
|
162
|
+
* // "STRING_VALUE",
|
|
163
|
+
* // ],
|
|
164
|
+
* // LogTypesToDisable: [
|
|
165
|
+
* // "STRING_VALUE",
|
|
166
|
+
* // ],
|
|
167
|
+
* // },
|
|
168
|
+
* // DBClusterIdentifier: "STRING_VALUE",
|
|
169
|
+
* // MasterUserPassword: "STRING_VALUE",
|
|
170
|
+
* // IAMDatabaseAuthenticationEnabled: true || false,
|
|
171
|
+
* // EngineVersion: "STRING_VALUE",
|
|
172
|
+
* // BackupRetentionPeriod: Number("int"),
|
|
173
|
+
* // AllocatedStorage: Number("int"),
|
|
174
|
+
* // Iops: Number("int"),
|
|
175
|
+
* // },
|
|
176
|
+
* // DBClusterInstanceClass: "STRING_VALUE",
|
|
177
|
+
* // StorageType: "STRING_VALUE",
|
|
178
|
+
* // Iops: Number("int"),
|
|
179
|
+
* // PubliclyAccessible: true || false,
|
|
180
|
+
* // AutoMinorVersionUpgrade: true || false,
|
|
181
|
+
* // MonitoringInterval: Number("int"),
|
|
182
|
+
* // MonitoringRoleArn: "STRING_VALUE",
|
|
183
|
+
* // PerformanceInsightsEnabled: true || false,
|
|
184
|
+
* // PerformanceInsightsKMSKeyId: "STRING_VALUE",
|
|
185
|
+
* // PerformanceInsightsRetentionPeriod: Number("int"),
|
|
186
|
+
* // ServerlessV2ScalingConfiguration: { // ServerlessV2ScalingConfigurationInfo
|
|
187
|
+
* // MinCapacity: Number("double"),
|
|
188
|
+
* // MaxCapacity: Number("double"),
|
|
189
|
+
* // },
|
|
190
|
+
* // NetworkType: "STRING_VALUE",
|
|
191
|
+
* // DBSystemId: "STRING_VALUE",
|
|
192
|
+
* // MasterUserSecret: { // MasterUserSecret
|
|
193
|
+
* // SecretArn: "STRING_VALUE",
|
|
194
|
+
* // SecretStatus: "STRING_VALUE",
|
|
195
|
+
* // KmsKeyId: "STRING_VALUE",
|
|
196
|
+
* // },
|
|
197
|
+
* // },
|
|
198
|
+
* // };
|
|
199
|
+
*
|
|
51
200
|
* ```
|
|
52
201
|
*
|
|
53
202
|
* @param FailoverDBClusterCommandInput - {@link FailoverDBClusterCommandInput}
|
|
@@ -66,6 +215,8 @@ export interface FailoverDBClusterCommandOutput extends FailoverDBClusterResult,
|
|
|
66
215
|
* @throws {@link InvalidDBInstanceStateFault} (client fault)
|
|
67
216
|
* <p>The DB instance isn't in a valid state.</p>
|
|
68
217
|
*
|
|
218
|
+
* @throws {@link RDSServiceException}
|
|
219
|
+
* <p>Base exception class for all service exceptions from RDS service.</p>
|
|
69
220
|
*
|
|
70
221
|
* @example To perform a failover for a DB cluster
|
|
71
222
|
* ```javascript
|
|
@@ -44,6 +44,35 @@ export interface FailoverGlobalClusterCommandOutput extends FailoverGlobalCluste
|
|
|
44
44
|
* };
|
|
45
45
|
* const command = new FailoverGlobalClusterCommand(input);
|
|
46
46
|
* const response = await client.send(command);
|
|
47
|
+
* // { // FailoverGlobalClusterResult
|
|
48
|
+
* // GlobalCluster: { // GlobalCluster
|
|
49
|
+
* // GlobalClusterIdentifier: "STRING_VALUE",
|
|
50
|
+
* // GlobalClusterResourceId: "STRING_VALUE",
|
|
51
|
+
* // GlobalClusterArn: "STRING_VALUE",
|
|
52
|
+
* // Status: "STRING_VALUE",
|
|
53
|
+
* // Engine: "STRING_VALUE",
|
|
54
|
+
* // EngineVersion: "STRING_VALUE",
|
|
55
|
+
* // DatabaseName: "STRING_VALUE",
|
|
56
|
+
* // StorageEncrypted: true || false,
|
|
57
|
+
* // DeletionProtection: true || false,
|
|
58
|
+
* // GlobalClusterMembers: [ // GlobalClusterMemberList
|
|
59
|
+
* // { // GlobalClusterMember
|
|
60
|
+
* // DBClusterArn: "STRING_VALUE",
|
|
61
|
+
* // Readers: [ // ReadersArnList
|
|
62
|
+
* // "STRING_VALUE",
|
|
63
|
+
* // ],
|
|
64
|
+
* // IsWriter: true || false,
|
|
65
|
+
* // GlobalWriteForwardingStatus: "enabled" || "disabled" || "enabling" || "disabling" || "unknown",
|
|
66
|
+
* // },
|
|
67
|
+
* // ],
|
|
68
|
+
* // FailoverState: { // FailoverState
|
|
69
|
+
* // Status: "pending" || "failing-over" || "cancelling",
|
|
70
|
+
* // FromDbClusterArn: "STRING_VALUE",
|
|
71
|
+
* // ToDbClusterArn: "STRING_VALUE",
|
|
72
|
+
* // },
|
|
73
|
+
* // },
|
|
74
|
+
* // };
|
|
75
|
+
*
|
|
47
76
|
* ```
|
|
48
77
|
*
|
|
49
78
|
* @param FailoverGlobalClusterCommandInput - {@link FailoverGlobalClusterCommandInput}
|
|
@@ -65,6 +94,8 @@ export interface FailoverGlobalClusterCommandOutput extends FailoverGlobalCluste
|
|
|
65
94
|
* @throws {@link InvalidGlobalClusterStateFault} (client fault)
|
|
66
95
|
* <p>The global cluster is in an invalid state and can't perform the requested operation.</p>
|
|
67
96
|
*
|
|
97
|
+
* @throws {@link RDSServiceException}
|
|
98
|
+
* <p>Base exception class for all service exceptions from RDS service.</p>
|
|
68
99
|
*
|
|
69
100
|
*/
|
|
70
101
|
export declare class FailoverGlobalClusterCommand extends $Command<FailoverGlobalClusterCommandInput, FailoverGlobalClusterCommandOutput, RDSClientResolvedConfig> {
|
|
@@ -42,6 +42,15 @@ export interface ListTagsForResourceCommandOutput extends TagListMessage, __Meta
|
|
|
42
42
|
* };
|
|
43
43
|
* const command = new ListTagsForResourceCommand(input);
|
|
44
44
|
* const response = await client.send(command);
|
|
45
|
+
* // { // TagListMessage
|
|
46
|
+
* // TagList: [ // TagList
|
|
47
|
+
* // { // Tag
|
|
48
|
+
* // Key: "STRING_VALUE",
|
|
49
|
+
* // Value: "STRING_VALUE",
|
|
50
|
+
* // },
|
|
51
|
+
* // ],
|
|
52
|
+
* // };
|
|
53
|
+
*
|
|
45
54
|
* ```
|
|
46
55
|
*
|
|
47
56
|
* @param ListTagsForResourceCommandInput - {@link ListTagsForResourceCommandInput}
|
|
@@ -72,6 +81,8 @@ export interface ListTagsForResourceCommandOutput extends TagListMessage, __Meta
|
|
|
72
81
|
* <p>
|
|
73
82
|
* <code>DBSnapshotIdentifier</code> doesn't refer to an existing DB snapshot.</p>
|
|
74
83
|
*
|
|
84
|
+
* @throws {@link RDSServiceException}
|
|
85
|
+
* <p>Base exception class for all service exceptions from RDS service.</p>
|
|
75
86
|
*
|
|
76
87
|
* @example To list tags on an Amazon RDS resource
|
|
77
88
|
* ```javascript
|
|
@@ -36,6 +36,15 @@ export interface ModifyActivityStreamCommandOutput extends ModifyActivityStreamR
|
|
|
36
36
|
* };
|
|
37
37
|
* const command = new ModifyActivityStreamCommand(input);
|
|
38
38
|
* const response = await client.send(command);
|
|
39
|
+
* // { // ModifyActivityStreamResponse
|
|
40
|
+
* // KmsKeyId: "STRING_VALUE",
|
|
41
|
+
* // KinesisStreamName: "STRING_VALUE",
|
|
42
|
+
* // Status: "stopped" || "starting" || "started" || "stopping",
|
|
43
|
+
* // Mode: "sync" || "async",
|
|
44
|
+
* // EngineNativeAuditFieldsIncluded: true || false,
|
|
45
|
+
* // PolicyStatus: "locked" || "unlocked" || "locking-policy" || "unlocking-policy",
|
|
46
|
+
* // };
|
|
47
|
+
*
|
|
39
48
|
* ```
|
|
40
49
|
*
|
|
41
50
|
* @param ModifyActivityStreamCommandInput - {@link ModifyActivityStreamCommandInput}
|
|
@@ -54,6 +63,8 @@ export interface ModifyActivityStreamCommandOutput extends ModifyActivityStreamR
|
|
|
54
63
|
* @throws {@link ResourceNotFoundFault} (client fault)
|
|
55
64
|
* <p>The specified resource ID was not found.</p>
|
|
56
65
|
*
|
|
66
|
+
* @throws {@link RDSServiceException}
|
|
67
|
+
* <p>Base exception class for all service exceptions from RDS service.</p>
|
|
57
68
|
*
|
|
58
69
|
*/
|
|
59
70
|
export declare class ModifyActivityStreamCommand extends $Command<ModifyActivityStreamCommandInput, ModifyActivityStreamCommandOutput, RDSClientResolvedConfig> {
|
|
@@ -56,6 +56,19 @@ export interface ModifyCertificatesCommandOutput extends ModifyCertificatesResul
|
|
|
56
56
|
* };
|
|
57
57
|
* const command = new ModifyCertificatesCommand(input);
|
|
58
58
|
* const response = await client.send(command);
|
|
59
|
+
* // { // ModifyCertificatesResult
|
|
60
|
+
* // Certificate: { // Certificate
|
|
61
|
+
* // CertificateIdentifier: "STRING_VALUE",
|
|
62
|
+
* // CertificateType: "STRING_VALUE",
|
|
63
|
+
* // Thumbprint: "STRING_VALUE",
|
|
64
|
+
* // ValidFrom: new Date("TIMESTAMP"),
|
|
65
|
+
* // ValidTill: new Date("TIMESTAMP"),
|
|
66
|
+
* // CertificateArn: "STRING_VALUE",
|
|
67
|
+
* // CustomerOverride: true || false,
|
|
68
|
+
* // CustomerOverrideValidTill: new Date("TIMESTAMP"),
|
|
69
|
+
* // },
|
|
70
|
+
* // };
|
|
71
|
+
*
|
|
59
72
|
* ```
|
|
60
73
|
*
|
|
61
74
|
* @param ModifyCertificatesCommandInput - {@link ModifyCertificatesCommandInput}
|
|
@@ -69,6 +82,8 @@ export interface ModifyCertificatesCommandOutput extends ModifyCertificatesResul
|
|
|
69
82
|
* <code>CertificateIdentifier</code> doesn't refer to an
|
|
70
83
|
* existing certificate.</p>
|
|
71
84
|
*
|
|
85
|
+
* @throws {@link RDSServiceException}
|
|
86
|
+
* <p>Base exception class for all service exceptions from RDS service.</p>
|
|
72
87
|
*
|
|
73
88
|
* @example To temporarily override the system-default SSL/TLS certificate for new DB instances
|
|
74
89
|
* ```javascript
|
|
@@ -51,6 +51,14 @@ export interface ModifyCurrentDBClusterCapacityCommandOutput extends DBClusterCa
|
|
|
51
51
|
* };
|
|
52
52
|
* const command = new ModifyCurrentDBClusterCapacityCommand(input);
|
|
53
53
|
* const response = await client.send(command);
|
|
54
|
+
* // { // DBClusterCapacityInfo
|
|
55
|
+
* // DBClusterIdentifier: "STRING_VALUE",
|
|
56
|
+
* // PendingCapacity: Number("int"),
|
|
57
|
+
* // CurrentCapacity: Number("int"),
|
|
58
|
+
* // SecondsBeforeTimeout: Number("int"),
|
|
59
|
+
* // TimeoutAction: "STRING_VALUE",
|
|
60
|
+
* // };
|
|
61
|
+
*
|
|
54
62
|
* ```
|
|
55
63
|
*
|
|
56
64
|
* @param ModifyCurrentDBClusterCapacityCommandInput - {@link ModifyCurrentDBClusterCapacityCommandInput}
|
|
@@ -72,6 +80,8 @@ export interface ModifyCurrentDBClusterCapacityCommandOutput extends DBClusterCa
|
|
|
72
80
|
* @throws {@link InvalidDBClusterStateFault} (client fault)
|
|
73
81
|
* <p>The requested operation can't be performed while the cluster is in this state.</p>
|
|
74
82
|
*
|
|
83
|
+
* @throws {@link RDSServiceException}
|
|
84
|
+
* <p>Base exception class for all service exceptions from RDS service.</p>
|
|
75
85
|
*
|
|
76
86
|
* @example To scale the capacity of an Aurora Serverless DB cluster
|
|
77
87
|
* ```javascript
|
|
@@ -45,6 +45,87 @@ export interface ModifyCustomDBEngineVersionCommandOutput extends DBEngineVersio
|
|
|
45
45
|
* };
|
|
46
46
|
* const command = new ModifyCustomDBEngineVersionCommand(input);
|
|
47
47
|
* const response = await client.send(command);
|
|
48
|
+
* // { // DBEngineVersion
|
|
49
|
+
* // Engine: "STRING_VALUE",
|
|
50
|
+
* // EngineVersion: "STRING_VALUE",
|
|
51
|
+
* // DBParameterGroupFamily: "STRING_VALUE",
|
|
52
|
+
* // DBEngineDescription: "STRING_VALUE",
|
|
53
|
+
* // DBEngineVersionDescription: "STRING_VALUE",
|
|
54
|
+
* // DefaultCharacterSet: { // CharacterSet
|
|
55
|
+
* // CharacterSetName: "STRING_VALUE",
|
|
56
|
+
* // CharacterSetDescription: "STRING_VALUE",
|
|
57
|
+
* // },
|
|
58
|
+
* // Image: { // CustomDBEngineVersionAMI
|
|
59
|
+
* // ImageId: "STRING_VALUE",
|
|
60
|
+
* // Status: "STRING_VALUE",
|
|
61
|
+
* // },
|
|
62
|
+
* // DBEngineMediaType: "STRING_VALUE",
|
|
63
|
+
* // SupportedCharacterSets: [ // SupportedCharacterSetsList
|
|
64
|
+
* // {
|
|
65
|
+
* // CharacterSetName: "STRING_VALUE",
|
|
66
|
+
* // CharacterSetDescription: "STRING_VALUE",
|
|
67
|
+
* // },
|
|
68
|
+
* // ],
|
|
69
|
+
* // SupportedNcharCharacterSets: [
|
|
70
|
+
* // {
|
|
71
|
+
* // CharacterSetName: "STRING_VALUE",
|
|
72
|
+
* // CharacterSetDescription: "STRING_VALUE",
|
|
73
|
+
* // },
|
|
74
|
+
* // ],
|
|
75
|
+
* // ValidUpgradeTarget: [ // ValidUpgradeTargetList
|
|
76
|
+
* // { // UpgradeTarget
|
|
77
|
+
* // Engine: "STRING_VALUE",
|
|
78
|
+
* // EngineVersion: "STRING_VALUE",
|
|
79
|
+
* // Description: "STRING_VALUE",
|
|
80
|
+
* // AutoUpgrade: true || false,
|
|
81
|
+
* // IsMajorVersionUpgrade: true || false,
|
|
82
|
+
* // SupportedEngineModes: [ // EngineModeList
|
|
83
|
+
* // "STRING_VALUE",
|
|
84
|
+
* // ],
|
|
85
|
+
* // SupportsParallelQuery: true || false,
|
|
86
|
+
* // SupportsGlobalDatabases: true || false,
|
|
87
|
+
* // SupportsBabelfish: true || false,
|
|
88
|
+
* // },
|
|
89
|
+
* // ],
|
|
90
|
+
* // SupportedTimezones: [ // SupportedTimezonesList
|
|
91
|
+
* // { // Timezone
|
|
92
|
+
* // TimezoneName: "STRING_VALUE",
|
|
93
|
+
* // },
|
|
94
|
+
* // ],
|
|
95
|
+
* // ExportableLogTypes: [ // LogTypeList
|
|
96
|
+
* // "STRING_VALUE",
|
|
97
|
+
* // ],
|
|
98
|
+
* // SupportsLogExportsToCloudwatchLogs: true || false,
|
|
99
|
+
* // SupportsReadReplica: true || false,
|
|
100
|
+
* // SupportedEngineModes: [
|
|
101
|
+
* // "STRING_VALUE",
|
|
102
|
+
* // ],
|
|
103
|
+
* // SupportedFeatureNames: [ // FeatureNameList
|
|
104
|
+
* // "STRING_VALUE",
|
|
105
|
+
* // ],
|
|
106
|
+
* // Status: "STRING_VALUE",
|
|
107
|
+
* // SupportsParallelQuery: true || false,
|
|
108
|
+
* // SupportsGlobalDatabases: true || false,
|
|
109
|
+
* // MajorEngineVersion: "STRING_VALUE",
|
|
110
|
+
* // DatabaseInstallationFilesS3BucketName: "STRING_VALUE",
|
|
111
|
+
* // DatabaseInstallationFilesS3Prefix: "STRING_VALUE",
|
|
112
|
+
* // DBEngineVersionArn: "STRING_VALUE",
|
|
113
|
+
* // KMSKeyId: "STRING_VALUE",
|
|
114
|
+
* // CreateTime: new Date("TIMESTAMP"),
|
|
115
|
+
* // TagList: [ // TagList
|
|
116
|
+
* // { // Tag
|
|
117
|
+
* // Key: "STRING_VALUE",
|
|
118
|
+
* // Value: "STRING_VALUE",
|
|
119
|
+
* // },
|
|
120
|
+
* // ],
|
|
121
|
+
* // SupportsBabelfish: true || false,
|
|
122
|
+
* // CustomDBEngineVersionManifest: "STRING_VALUE",
|
|
123
|
+
* // SupportsCertificateRotationWithoutRestart: true || false,
|
|
124
|
+
* // SupportedCACertificateIdentifiers: [ // CACertificateIdentifiersList
|
|
125
|
+
* // "STRING_VALUE",
|
|
126
|
+
* // ],
|
|
127
|
+
* // };
|
|
128
|
+
*
|
|
48
129
|
* ```
|
|
49
130
|
*
|
|
50
131
|
* @param ModifyCustomDBEngineVersionCommandInput - {@link ModifyCustomDBEngineVersionCommandInput}
|
|
@@ -59,6 +140,8 @@ export interface ModifyCustomDBEngineVersionCommandOutput extends DBEngineVersio
|
|
|
59
140
|
* @throws {@link InvalidCustomDBEngineVersionStateFault} (client fault)
|
|
60
141
|
* <p>You can't delete the CEV.</p>
|
|
61
142
|
*
|
|
143
|
+
* @throws {@link RDSServiceException}
|
|
144
|
+
* <p>Base exception class for all service exceptions from RDS service.</p>
|
|
62
145
|
*
|
|
63
146
|
*/
|
|
64
147
|
export declare class ModifyCustomDBEngineVersionCommand extends $Command<ModifyCustomDBEngineVersionCommandInput, ModifyCustomDBEngineVersionCommandOutput, RDSClientResolvedConfig> {
|