@aws-sdk/client-rds 3.776.0 → 3.777.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 +8 -5
- package/dist-types/commands/AddRoleToDBInstanceCommand.d.ts +9 -6
- package/dist-types/commands/AddSourceIdentifierToSubscriptionCommand.d.ts +16 -16
- package/dist-types/commands/AddTagsToResourceCommand.d.ts +10 -7
- package/dist-types/commands/ApplyPendingMaintenanceActionCommand.d.ts +13 -13
- package/dist-types/commands/AuthorizeDBSecurityGroupIngressCommand.d.ts +6 -6
- package/dist-types/commands/BacktrackDBClusterCommand.d.ts +1 -0
- package/dist-types/commands/CancelExportTaskCommand.d.ts +14 -14
- package/dist-types/commands/CopyDBClusterParameterGroupCommand.d.ts +11 -11
- package/dist-types/commands/CopyDBClusterSnapshotCommand.d.ts +26 -26
- package/dist-types/commands/CopyDBParameterGroupCommand.d.ts +11 -11
- package/dist-types/commands/CopyDBSnapshotCommand.d.ts +31 -31
- package/dist-types/commands/CopyOptionGroupCommand.d.ts +14 -14
- package/dist-types/commands/CreateBlueGreenDeploymentCommand.d.ts +1 -127
- package/dist-types/commands/CreateCustomDBEngineVersionCommand.d.ts +1 -0
- package/dist-types/commands/CreateDBClusterCommand.d.ts +83 -84
- package/dist-types/commands/CreateDBClusterEndpointCommand.d.ts +17 -17
- package/dist-types/commands/CreateDBClusterParameterGroupCommand.d.ts +11 -11
- package/dist-types/commands/CreateDBClusterSnapshotCommand.d.ts +25 -25
- package/dist-types/commands/CreateDBInstanceCommand.d.ts +72 -72
- package/dist-types/commands/CreateDBInstanceReadReplicaCommand.d.ts +11 -11
- package/dist-types/commands/CreateDBParameterGroupCommand.d.ts +11 -11
- package/dist-types/commands/CreateDBProxyCommand.d.ts +1 -0
- package/dist-types/commands/CreateDBProxyEndpointCommand.d.ts +1 -0
- package/dist-types/commands/CreateDBSecurityGroupCommand.d.ts +6 -6
- package/dist-types/commands/CreateDBShardGroupCommand.d.ts +1 -0
- package/dist-types/commands/CreateDBSnapshotCommand.d.ts +29 -29
- package/dist-types/commands/CreateDBSubnetGroupCommand.d.ts +25 -25
- package/dist-types/commands/CreateEventSubscriptionCommand.d.ts +17 -17
- package/dist-types/commands/CreateGlobalClusterCommand.d.ts +15 -15
- package/dist-types/commands/CreateIntegrationCommand.d.ts +14 -14
- package/dist-types/commands/CreateOptionGroupCommand.d.ts +15 -15
- package/dist-types/commands/CreateTenantDatabaseCommand.d.ts +1 -0
- package/dist-types/commands/DeleteBlueGreenDeploymentCommand.d.ts +1 -140
- package/dist-types/commands/DeleteCustomDBEngineVersionCommand.d.ts +1 -0
- package/dist-types/commands/DeleteDBClusterAutomatedBackupCommand.d.ts +1 -0
- package/dist-types/commands/DeleteDBClusterCommand.d.ts +14 -14
- package/dist-types/commands/DeleteDBClusterEndpointCommand.d.ts +14 -14
- package/dist-types/commands/DeleteDBClusterParameterGroupCommand.d.ts +7 -4
- package/dist-types/commands/DeleteDBClusterSnapshotCommand.d.ts +24 -24
- package/dist-types/commands/DeleteDBInstanceAutomatedBackupCommand.d.ts +26 -26
- package/dist-types/commands/DeleteDBInstanceCommand.d.ts +9 -9
- package/dist-types/commands/DeleteDBParameterGroupCommand.d.ts +7 -4
- package/dist-types/commands/DeleteDBProxyCommand.d.ts +1 -0
- package/dist-types/commands/DeleteDBProxyEndpointCommand.d.ts +1 -0
- package/dist-types/commands/DeleteDBSecurityGroupCommand.d.ts +7 -4
- package/dist-types/commands/DeleteDBShardGroupCommand.d.ts +1 -0
- package/dist-types/commands/DeleteDBSnapshotCommand.d.ts +29 -29
- package/dist-types/commands/DeleteDBSubnetGroupCommand.d.ts +7 -4
- package/dist-types/commands/DeleteEventSubscriptionCommand.d.ts +15 -15
- package/dist-types/commands/DeleteGlobalClusterCommand.d.ts +14 -14
- package/dist-types/commands/DeleteIntegrationCommand.d.ts +12 -12
- package/dist-types/commands/DeleteOptionGroupCommand.d.ts +7 -4
- package/dist-types/commands/DeleteTenantDatabaseCommand.d.ts +1 -0
- package/dist-types/commands/DeregisterDBProxyTargetsCommand.d.ts +1 -0
- package/dist-types/commands/DescribeAccountAttributesCommand.d.ts +50 -50
- package/dist-types/commands/DescribeBlueGreenDeploymentsCommand.d.ts +1 -215
- package/dist-types/commands/DescribeCertificatesCommand.d.ts +1 -52
- package/dist-types/commands/DescribeDBClusterAutomatedBackupsCommand.d.ts +1 -0
- package/dist-types/commands/DescribeDBClusterBacktracksCommand.d.ts +17 -17
- package/dist-types/commands/DescribeDBClusterEndpointsCommand.d.ts +28 -29
- package/dist-types/commands/DescribeDBClusterParameterGroupsCommand.d.ts +25 -25
- package/dist-types/commands/DescribeDBClusterParametersCommand.d.ts +24 -24
- package/dist-types/commands/DescribeDBClusterSnapshotAttributesCommand.d.ts +9 -9
- package/dist-types/commands/DescribeDBClusterSnapshotsCommand.d.ts +43 -43
- package/dist-types/commands/DescribeDBClustersCommand.d.ts +64 -64
- package/dist-types/commands/DescribeDBEngineVersionsCommand.d.ts +21 -21
- package/dist-types/commands/DescribeDBInstanceAutomatedBackupsCommand.d.ts +26 -26
- package/dist-types/commands/DescribeDBInstancesCommand.d.ts +14 -14
- package/dist-types/commands/DescribeDBLogFilesCommand.d.ts +23 -23
- package/dist-types/commands/DescribeDBParameterGroupsCommand.d.ts +21 -21
- package/dist-types/commands/DescribeDBParametersCommand.d.ts +21 -21
- package/dist-types/commands/DescribeDBProxiesCommand.d.ts +1 -0
- package/dist-types/commands/DescribeDBProxyEndpointsCommand.d.ts +1 -0
- package/dist-types/commands/DescribeDBProxyTargetGroupsCommand.d.ts +1 -0
- package/dist-types/commands/DescribeDBProxyTargetsCommand.d.ts +1 -0
- package/dist-types/commands/DescribeDBRecommendationsCommand.d.ts +1 -0
- package/dist-types/commands/DescribeDBSecurityGroupsCommand.d.ts +7 -4
- package/dist-types/commands/DescribeDBShardGroupsCommand.d.ts +1 -0
- package/dist-types/commands/DescribeDBSnapshotAttributesCommand.d.ts +9 -9
- package/dist-types/commands/DescribeDBSnapshotTenantDatabasesCommand.d.ts +1 -0
- package/dist-types/commands/DescribeDBSnapshotsCommand.d.ts +27 -27
- package/dist-types/commands/DescribeDBSubnetGroupsCommand.d.ts +27 -27
- package/dist-types/commands/DescribeEngineDefaultClusterParametersCommand.d.ts +13 -13
- package/dist-types/commands/DescribeEngineDefaultParametersCommand.d.ts +13 -13
- package/dist-types/commands/DescribeEventCategoriesCommand.d.ts +18 -18
- package/dist-types/commands/DescribeEventSubscriptionsCommand.d.ts +14 -14
- package/dist-types/commands/DescribeEventsCommand.d.ts +18 -18
- package/dist-types/commands/DescribeExportTasksCommand.d.ts +27 -27
- package/dist-types/commands/DescribeGlobalClustersCommand.d.ts +14 -14
- package/dist-types/commands/DescribeIntegrationsCommand.d.ts +13 -13
- package/dist-types/commands/DescribeOptionGroupOptionsCommand.d.ts +31 -31
- package/dist-types/commands/DescribeOptionGroupsCommand.d.ts +13 -13
- package/dist-types/commands/DescribeOrderableDBInstanceOptionsCommand.d.ts +21 -21
- package/dist-types/commands/DescribePendingMaintenanceActionsCommand.d.ts +9 -9
- package/dist-types/commands/DescribeReservedDBInstancesCommand.d.ts +23 -23
- package/dist-types/commands/DescribeReservedDBInstancesOfferingsCommand.d.ts +17 -17
- package/dist-types/commands/DescribeSourceRegionsCommand.d.ts +89 -89
- package/dist-types/commands/DescribeTenantDatabasesCommand.d.ts +1 -0
- package/dist-types/commands/DescribeValidDBInstanceModificationsCommand.d.ts +14 -14
- package/dist-types/commands/DisableHttpEndpointCommand.d.ts +1 -0
- package/dist-types/commands/DownloadDBLogFilePortionCommand.d.ts +8 -5
- package/dist-types/commands/EnableHttpEndpointCommand.d.ts +1 -0
- package/dist-types/commands/FailoverDBClusterCommand.d.ts +6 -6
- package/dist-types/commands/FailoverGlobalClusterCommand.d.ts +1 -0
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +9 -9
- package/dist-types/commands/ModifyActivityStreamCommand.d.ts +1 -0
- package/dist-types/commands/ModifyCertificatesCommand.d.ts +13 -13
- package/dist-types/commands/ModifyCurrentDBClusterCapacityCommand.d.ts +10 -10
- package/dist-types/commands/ModifyCustomDBEngineVersionCommand.d.ts +1 -0
- package/dist-types/commands/ModifyDBClusterCommand.d.ts +50 -50
- package/dist-types/commands/ModifyDBClusterEndpointCommand.d.ts +15 -15
- package/dist-types/commands/ModifyDBClusterParameterGroupCommand.d.ts +12 -12
- package/dist-types/commands/ModifyDBClusterSnapshotAttributeCommand.d.ts +11 -11
- package/dist-types/commands/ModifyDBInstanceCommand.d.ts +31 -31
- package/dist-types/commands/ModifyDBParameterGroupCommand.d.ts +9 -9
- package/dist-types/commands/ModifyDBProxyCommand.d.ts +1 -0
- package/dist-types/commands/ModifyDBProxyEndpointCommand.d.ts +1 -0
- package/dist-types/commands/ModifyDBProxyTargetGroupCommand.d.ts +1 -0
- package/dist-types/commands/ModifyDBRecommendationCommand.d.ts +1 -0
- package/dist-types/commands/ModifyDBShardGroupCommand.d.ts +1 -0
- package/dist-types/commands/ModifyDBSnapshotAttributeCommand.d.ts +20 -21
- package/dist-types/commands/ModifyDBSnapshotCommand.d.ts +28 -28
- package/dist-types/commands/ModifyDBSubnetGroupCommand.d.ts +29 -29
- package/dist-types/commands/ModifyEventSubscriptionCommand.d.ts +15 -15
- package/dist-types/commands/ModifyGlobalClusterCommand.d.ts +15 -15
- package/dist-types/commands/ModifyIntegrationCommand.d.ts +14 -14
- package/dist-types/commands/ModifyOptionGroupCommand.d.ts +9 -9
- package/dist-types/commands/ModifyTenantDatabaseCommand.d.ts +1 -0
- package/dist-types/commands/PromoteReadReplicaCommand.d.ts +9 -9
- package/dist-types/commands/PromoteReadReplicaDBClusterCommand.d.ts +1 -0
- package/dist-types/commands/PurchaseReservedDBInstancesOfferingCommand.d.ts +23 -23
- package/dist-types/commands/RebootDBClusterCommand.d.ts +1 -0
- package/dist-types/commands/RebootDBInstanceCommand.d.ts +14 -14
- package/dist-types/commands/RebootDBShardGroupCommand.d.ts +1 -0
- package/dist-types/commands/RegisterDBProxyTargetsCommand.d.ts +1 -0
- package/dist-types/commands/RemoveFromGlobalClusterCommand.d.ts +22 -22
- package/dist-types/commands/RemoveRoleFromDBClusterCommand.d.ts +8 -5
- package/dist-types/commands/RemoveRoleFromDBInstanceCommand.d.ts +1 -0
- package/dist-types/commands/RemoveSourceIdentifierFromSubscriptionCommand.d.ts +16 -16
- package/dist-types/commands/RemoveTagsFromResourceCommand.d.ts +8 -5
- package/dist-types/commands/ResetDBClusterParameterGroupCommand.d.ts +6 -6
- package/dist-types/commands/ResetDBParameterGroupCommand.d.ts +6 -6
- package/dist-types/commands/RestoreDBClusterFromS3Command.d.ts +47 -47
- package/dist-types/commands/RestoreDBClusterFromSnapshotCommand.d.ts +44 -44
- package/dist-types/commands/RestoreDBClusterToPointInTimeCommand.d.ts +44 -44
- package/dist-types/commands/RestoreDBInstanceFromDBSnapshotCommand.d.ts +23 -23
- package/dist-types/commands/RestoreDBInstanceFromS3Command.d.ts +1 -0
- package/dist-types/commands/RestoreDBInstanceToPointInTimeCommand.d.ts +62 -62
- package/dist-types/commands/RevokeDBSecurityGroupIngressCommand.d.ts +6 -6
- package/dist-types/commands/StartActivityStreamCommand.d.ts +12 -12
- package/dist-types/commands/StartDBClusterCommand.d.ts +10 -10
- package/dist-types/commands/StartDBInstanceAutomatedBackupsReplicationCommand.d.ts +25 -25
- package/dist-types/commands/StartDBInstanceCommand.d.ts +6 -6
- package/dist-types/commands/StartExportTaskCommand.d.ts +17 -17
- package/dist-types/commands/StopActivityStreamCommand.d.ts +8 -8
- package/dist-types/commands/StopDBClusterCommand.d.ts +10 -10
- package/dist-types/commands/StopDBInstanceAutomatedBackupsReplicationCommand.d.ts +26 -26
- package/dist-types/commands/StopDBInstanceCommand.d.ts +6 -6
- package/dist-types/commands/SwitchoverBlueGreenDeploymentCommand.d.ts +1 -138
- package/dist-types/commands/SwitchoverGlobalClusterCommand.d.ts +1 -0
- package/dist-types/commands/SwitchoverReadReplicaCommand.d.ts +1 -0
- package/package.json +2 -2
|
@@ -96,14 +96,14 @@ declare const ModifyDBSubnetGroupCommand_base: {
|
|
|
96
96
|
* @throws {@link RDSServiceException}
|
|
97
97
|
* <p>Base exception class for all service exceptions from RDS service.</p>
|
|
98
98
|
*
|
|
99
|
-
*
|
|
99
|
+
*
|
|
100
100
|
* @example To modify a DB subnet group
|
|
101
101
|
* ```javascript
|
|
102
102
|
* // The following example adds a subnet with the ID subnet-08e41f9e230222222 to the DB subnet group named mysubnetgroup. To keep the existing subnets in the subnet group, include their IDs as values in the --subnet-ids option. Make sure to have subnets with at least two different Availability Zones in the DB subnet group.
|
|
103
103
|
* const input = {
|
|
104
|
-
*
|
|
105
|
-
*
|
|
106
|
-
*
|
|
104
|
+
* DBSubnetGroupDescription: "",
|
|
105
|
+
* DBSubnetGroupName: "mysubnetgroup",
|
|
106
|
+
* SubnetIds: [
|
|
107
107
|
* "subnet-0a1dc4e1a6f123456",
|
|
108
108
|
* "subnet-070dd7ecb3aaaaaaa",
|
|
109
109
|
* "subnet-00f5b198bc0abcdef",
|
|
@@ -112,50 +112,50 @@ declare const ModifyDBSubnetGroupCommand_base: {
|
|
|
112
112
|
* };
|
|
113
113
|
* const command = new ModifyDBSubnetGroupCommand(input);
|
|
114
114
|
* const response = await client.send(command);
|
|
115
|
-
* /* response
|
|
115
|
+
* /* response is
|
|
116
116
|
* {
|
|
117
|
-
*
|
|
118
|
-
*
|
|
119
|
-
*
|
|
120
|
-
*
|
|
121
|
-
*
|
|
122
|
-
*
|
|
117
|
+
* DBSubnetGroup: {
|
|
118
|
+
* DBSubnetGroupArn: "arn:aws:rds:us-west-2:123456789012:subgrp:mysubnetgroup",
|
|
119
|
+
* DBSubnetGroupDescription: "test DB subnet group",
|
|
120
|
+
* DBSubnetGroupName: "mysubnetgroup",
|
|
121
|
+
* SubnetGroupStatus: "Complete",
|
|
122
|
+
* Subnets: [
|
|
123
123
|
* {
|
|
124
|
-
*
|
|
125
|
-
*
|
|
124
|
+
* SubnetAvailabilityZone: {
|
|
125
|
+
* Name: "us-west-2a"
|
|
126
126
|
* },
|
|
127
|
-
*
|
|
128
|
-
*
|
|
127
|
+
* SubnetIdentifier: "subnet-08e41f9e230222222",
|
|
128
|
+
* SubnetStatus: "Active"
|
|
129
129
|
* },
|
|
130
130
|
* {
|
|
131
|
-
*
|
|
132
|
-
*
|
|
131
|
+
* SubnetAvailabilityZone: {
|
|
132
|
+
* Name: "us-west-2b"
|
|
133
133
|
* },
|
|
134
|
-
*
|
|
135
|
-
*
|
|
134
|
+
* SubnetIdentifier: "subnet-070dd7ecb3aaaaaaa",
|
|
135
|
+
* SubnetStatus: "Active"
|
|
136
136
|
* },
|
|
137
137
|
* {
|
|
138
|
-
*
|
|
139
|
-
*
|
|
138
|
+
* SubnetAvailabilityZone: {
|
|
139
|
+
* Name: "us-west-2d"
|
|
140
140
|
* },
|
|
141
|
-
*
|
|
142
|
-
*
|
|
141
|
+
* SubnetIdentifier: "subnet-00f5b198bc0abcdef",
|
|
142
|
+
* SubnetStatus: "Active"
|
|
143
143
|
* },
|
|
144
144
|
* {
|
|
145
|
-
*
|
|
146
|
-
*
|
|
145
|
+
* SubnetAvailabilityZone: {
|
|
146
|
+
* Name: "us-west-2b"
|
|
147
147
|
* },
|
|
148
|
-
*
|
|
149
|
-
*
|
|
148
|
+
* SubnetIdentifier: "subnet-0a1dc4e1a6f123456",
|
|
149
|
+
* SubnetStatus: "Active"
|
|
150
150
|
* }
|
|
151
151
|
* ],
|
|
152
|
-
*
|
|
152
|
+
* VpcId: "vpc-0f08e7610a1b2c3d4"
|
|
153
153
|
* }
|
|
154
154
|
* }
|
|
155
155
|
* *\/
|
|
156
|
-
* // example id: to-modify-a-db-subnet-group-1680383300785
|
|
157
156
|
* ```
|
|
158
157
|
*
|
|
158
|
+
* @public
|
|
159
159
|
*/
|
|
160
160
|
export declare class ModifyDBSubnetGroupCommand extends ModifyDBSubnetGroupCommand_base {
|
|
161
161
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -97,37 +97,37 @@ declare const ModifyEventSubscriptionCommand_base: {
|
|
|
97
97
|
* @throws {@link RDSServiceException}
|
|
98
98
|
* <p>Base exception class for all service exceptions from RDS service.</p>
|
|
99
99
|
*
|
|
100
|
-
*
|
|
100
|
+
*
|
|
101
101
|
* @example To modify an event subscription
|
|
102
102
|
* ```javascript
|
|
103
103
|
* // The following example turns off the specified event subscription, so that it no longer publishes notifications to the specified Amazon Simple Notification Service topic.
|
|
104
104
|
* const input = {
|
|
105
|
-
*
|
|
106
|
-
*
|
|
105
|
+
* Enabled: false,
|
|
106
|
+
* SubscriptionName: "my-instance-events"
|
|
107
107
|
* };
|
|
108
108
|
* const command = new ModifyEventSubscriptionCommand(input);
|
|
109
109
|
* const response = await client.send(command);
|
|
110
|
-
* /* response
|
|
110
|
+
* /* response is
|
|
111
111
|
* {
|
|
112
|
-
*
|
|
113
|
-
*
|
|
114
|
-
*
|
|
115
|
-
*
|
|
116
|
-
*
|
|
112
|
+
* EventSubscription: {
|
|
113
|
+
* CustSubscriptionId: "my-instance-events",
|
|
114
|
+
* CustomerAwsId: "123456789012",
|
|
115
|
+
* Enabled: false,
|
|
116
|
+
* EventCategoriesList: [
|
|
117
117
|
* "backup",
|
|
118
118
|
* "recovery"
|
|
119
119
|
* ],
|
|
120
|
-
*
|
|
121
|
-
*
|
|
122
|
-
*
|
|
123
|
-
*
|
|
124
|
-
*
|
|
120
|
+
* EventSubscriptionArn: "arn:aws:rds:us-east-1:123456789012:es:my-instance-events",
|
|
121
|
+
* SnsTopicArn: "arn:aws:sns:us-east-1:123456789012:interesting-events",
|
|
122
|
+
* SourceType: "db-instance",
|
|
123
|
+
* Status: "modifying",
|
|
124
|
+
* SubscriptionCreationTime: "Tue Jul 31 23:22:01 UTC 2018"
|
|
125
125
|
* }
|
|
126
126
|
* }
|
|
127
127
|
* *\/
|
|
128
|
-
* // example id: to-modify-an-event-subscription-1680383930434
|
|
129
128
|
* ```
|
|
130
129
|
*
|
|
130
|
+
* @public
|
|
131
131
|
*/
|
|
132
132
|
export declare class ModifyEventSubscriptionCommand extends ModifyEventSubscriptionCommand_base {
|
|
133
133
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -115,34 +115,34 @@ declare const ModifyGlobalClusterCommand_base: {
|
|
|
115
115
|
* @throws {@link RDSServiceException}
|
|
116
116
|
* <p>Base exception class for all service exceptions from RDS service.</p>
|
|
117
117
|
*
|
|
118
|
-
*
|
|
118
|
+
*
|
|
119
119
|
* @example To modify a global database cluster
|
|
120
120
|
* ```javascript
|
|
121
121
|
* // The following example enables deletion protection for an Aurora MySQL-based global database cluster.
|
|
122
122
|
* const input = {
|
|
123
|
-
*
|
|
124
|
-
*
|
|
123
|
+
* DeletionProtection: true,
|
|
124
|
+
* GlobalClusterIdentifier: "myglobalcluster"
|
|
125
125
|
* };
|
|
126
126
|
* const command = new ModifyGlobalClusterCommand(input);
|
|
127
127
|
* const response = await client.send(command);
|
|
128
|
-
* /* response
|
|
128
|
+
* /* response is
|
|
129
129
|
* {
|
|
130
|
-
*
|
|
131
|
-
*
|
|
132
|
-
*
|
|
133
|
-
*
|
|
134
|
-
*
|
|
135
|
-
*
|
|
136
|
-
*
|
|
137
|
-
*
|
|
138
|
-
*
|
|
139
|
-
*
|
|
130
|
+
* GlobalCluster: {
|
|
131
|
+
* DeletionProtection: true,
|
|
132
|
+
* Engine: "aurora-mysql",
|
|
133
|
+
* EngineVersion: "5.7.mysql_aurora.2.07.2",
|
|
134
|
+
* GlobalClusterArn: "arn:aws:rds::123456789012:global-cluster:myglobalcluster",
|
|
135
|
+
* GlobalClusterIdentifier: "myglobalcluster",
|
|
136
|
+
* GlobalClusterMembers: [],
|
|
137
|
+
* GlobalClusterResourceId: "cluster-f0e523bfe07aabb",
|
|
138
|
+
* Status: "available",
|
|
139
|
+
* StorageEncrypted: false
|
|
140
140
|
* }
|
|
141
141
|
* }
|
|
142
142
|
* *\/
|
|
143
|
-
* // example id: to-modify-a-global-database-cluster-1680385137511
|
|
144
143
|
* ```
|
|
145
144
|
*
|
|
145
|
+
* @public
|
|
146
146
|
*/
|
|
147
147
|
export declare class ModifyGlobalClusterCommand extends ModifyGlobalClusterCommand_base {
|
|
148
148
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -92,32 +92,32 @@ declare const ModifyIntegrationCommand_base: {
|
|
|
92
92
|
* @throws {@link RDSServiceException}
|
|
93
93
|
* <p>Base exception class for all service exceptions from RDS service.</p>
|
|
94
94
|
*
|
|
95
|
-
*
|
|
95
|
+
*
|
|
96
96
|
* @example To modify a zero-ETL integration
|
|
97
97
|
* ```javascript
|
|
98
98
|
* // The following example modifies the name of an existing zero-ETL integration.
|
|
99
99
|
* const input = {
|
|
100
|
-
*
|
|
101
|
-
*
|
|
100
|
+
* IntegrationIdentifier: "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
|
|
101
|
+
* IntegrationName: "my-renamed-integration"
|
|
102
102
|
* };
|
|
103
103
|
* const command = new ModifyIntegrationCommand(input);
|
|
104
104
|
* const response = await client.send(command);
|
|
105
|
-
* /* response
|
|
105
|
+
* /* response is
|
|
106
106
|
* {
|
|
107
|
-
*
|
|
108
|
-
*
|
|
109
|
-
*
|
|
110
|
-
*
|
|
111
|
-
*
|
|
112
|
-
*
|
|
113
|
-
*
|
|
114
|
-
*
|
|
115
|
-
*
|
|
107
|
+
* CreateTime: "2023-12-28T17:20:20.629Z",
|
|
108
|
+
* DataFilter: "include: *.*",
|
|
109
|
+
* IntegrationArn: "arn:aws:rds:us-east-1:123456789012:integration:5b9f3d79-7392-4a3e-896c-58eaa1b53231",
|
|
110
|
+
* IntegrationName: "my-renamed-integration",
|
|
111
|
+
* KMSKeyId: "arn:aws:kms:us-east-1:123456789012:key/a1b2c3d4-5678-90ab-cdef-EXAMPLEaaaaa",
|
|
112
|
+
* SourceArn: "arn:aws:rds:us-east-1:123456789012:cluster:my-cluster",
|
|
113
|
+
* Status: "active",
|
|
114
|
+
* Tags: [],
|
|
115
|
+
* TargetArn: "arn:aws:redshift-serverless:us-east-1:123456789012:namespace/62c70612-0302-4db7-8414-b5e3e049f0d8"
|
|
116
116
|
* }
|
|
117
117
|
* *\/
|
|
118
|
-
* // example id: to-modify-a-zero-etl-integration-1680407173998
|
|
119
118
|
* ```
|
|
120
119
|
*
|
|
120
|
+
* @public
|
|
121
121
|
*/
|
|
122
122
|
export declare class ModifyIntegrationCommand extends ModifyIntegrationCommand_base {
|
|
123
123
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -136,32 +136,32 @@ declare const ModifyOptionGroupCommand_base: {
|
|
|
136
136
|
* @throws {@link RDSServiceException}
|
|
137
137
|
* <p>Base exception class for all service exceptions from RDS service.</p>
|
|
138
138
|
*
|
|
139
|
-
*
|
|
139
|
+
*
|
|
140
140
|
* @example To modify an option group
|
|
141
141
|
* ```javascript
|
|
142
142
|
* // The following example adds an option to an option group.
|
|
143
143
|
* const input = {
|
|
144
|
-
*
|
|
145
|
-
*
|
|
146
|
-
*
|
|
144
|
+
* ApplyImmediately: true,
|
|
145
|
+
* OptionGroupName: "myawsuser-og02",
|
|
146
|
+
* OptionsToInclude: [
|
|
147
147
|
* {
|
|
148
|
-
*
|
|
148
|
+
* DBSecurityGroupMemberships: [
|
|
149
149
|
* "default"
|
|
150
150
|
* ],
|
|
151
|
-
*
|
|
151
|
+
* OptionName: "MEMCACHED"
|
|
152
152
|
* }
|
|
153
153
|
* ]
|
|
154
154
|
* };
|
|
155
155
|
* const command = new ModifyOptionGroupCommand(input);
|
|
156
156
|
* const response = await client.send(command);
|
|
157
|
-
* /* response
|
|
157
|
+
* /* response is
|
|
158
158
|
* {
|
|
159
|
-
*
|
|
159
|
+
* OptionGroup: { /* empty *\/ }
|
|
160
160
|
* }
|
|
161
161
|
* *\/
|
|
162
|
-
* // example id: to-modify-an-option-group-1473890247875
|
|
163
162
|
* ```
|
|
164
163
|
*
|
|
164
|
+
* @public
|
|
165
165
|
*/
|
|
166
166
|
export declare class ModifyOptionGroupCommand extends ModifyOptionGroupCommand_base {
|
|
167
167
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -95,6 +95,7 @@ declare const ModifyTenantDatabaseCommand_base: {
|
|
|
95
95
|
* @throws {@link RDSServiceException}
|
|
96
96
|
* <p>Base exception class for all service exceptions from RDS service.</p>
|
|
97
97
|
*
|
|
98
|
+
*
|
|
98
99
|
* @public
|
|
99
100
|
*/
|
|
100
101
|
export declare class ModifyTenantDatabaseCommand extends ModifyTenantDatabaseCommand_base {
|
|
@@ -304,28 +304,28 @@ declare const PromoteReadReplicaCommand_base: {
|
|
|
304
304
|
* @throws {@link RDSServiceException}
|
|
305
305
|
* <p>Base exception class for all service exceptions from RDS service.</p>
|
|
306
306
|
*
|
|
307
|
-
*
|
|
307
|
+
*
|
|
308
308
|
* @example To promote a read replica
|
|
309
309
|
* ```javascript
|
|
310
310
|
* // The following example promotes the specified read replica to become a standalone DB instance.
|
|
311
311
|
* const input = {
|
|
312
|
-
*
|
|
312
|
+
* DBInstanceIdentifier: "test-instance-repl"
|
|
313
313
|
* };
|
|
314
314
|
* const command = new PromoteReadReplicaCommand(input);
|
|
315
315
|
* const response = await client.send(command);
|
|
316
|
-
* /* response
|
|
316
|
+
* /* response is
|
|
317
317
|
* {
|
|
318
|
-
*
|
|
319
|
-
*
|
|
320
|
-
*
|
|
321
|
-
*
|
|
322
|
-
*
|
|
318
|
+
* DBInstance: {
|
|
319
|
+
* DBInstanceArn: "arn:aws:rds:us-east-1:123456789012:db:test-instance-repl",
|
|
320
|
+
* DBInstanceStatus: "modifying",
|
|
321
|
+
* ReadReplicaSourceDBInstanceIdentifier: "test-instance",
|
|
322
|
+
* StorageType: "standard"
|
|
323
323
|
* }
|
|
324
324
|
* }
|
|
325
325
|
* *\/
|
|
326
|
-
* // example id: to-promote-a-read-replica-1680263877808
|
|
327
326
|
* ```
|
|
328
327
|
*
|
|
328
|
+
* @public
|
|
329
329
|
*/
|
|
330
330
|
export declare class PromoteReadReplicaCommand extends PromoteReadReplicaCommand_base {
|
|
331
331
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -250,6 +250,7 @@ declare const PromoteReadReplicaDBClusterCommand_base: {
|
|
|
250
250
|
* @throws {@link RDSServiceException}
|
|
251
251
|
* <p>Base exception class for all service exceptions from RDS service.</p>
|
|
252
252
|
*
|
|
253
|
+
*
|
|
253
254
|
* @public
|
|
254
255
|
*/
|
|
255
256
|
export declare class PromoteReadReplicaDBClusterCommand extends PromoteReadReplicaDBClusterCommand_base {
|
|
@@ -93,45 +93,45 @@ declare const PurchaseReservedDBInstancesOfferingCommand_base: {
|
|
|
93
93
|
* @throws {@link RDSServiceException}
|
|
94
94
|
* <p>Base exception class for all service exceptions from RDS service.</p>
|
|
95
95
|
*
|
|
96
|
-
*
|
|
96
|
+
*
|
|
97
97
|
* @example To purchase a reserved DB instance
|
|
98
98
|
* ```javascript
|
|
99
99
|
* // The following example shows how to buy the reserved DB instance offering from the previous example.
|
|
100
100
|
* const input = {
|
|
101
|
-
*
|
|
102
|
-
*
|
|
101
|
+
* ReservedDBInstanceId: "8ba30be1-b9ec-447f-8f23-6114e3f4c7b4",
|
|
102
|
+
* ReservedDBInstancesOfferingId: ""
|
|
103
103
|
* };
|
|
104
104
|
* const command = new PurchaseReservedDBInstancesOfferingCommand(input);
|
|
105
105
|
* const response = await client.send(command);
|
|
106
|
-
* /* response
|
|
106
|
+
* /* response is
|
|
107
107
|
* {
|
|
108
|
-
*
|
|
109
|
-
*
|
|
110
|
-
*
|
|
111
|
-
*
|
|
112
|
-
*
|
|
113
|
-
*
|
|
114
|
-
*
|
|
115
|
-
*
|
|
116
|
-
*
|
|
117
|
-
*
|
|
108
|
+
* ReservedDBInstance: {
|
|
109
|
+
* CurrencyCode: "USD",
|
|
110
|
+
* DBInstanceClass: "db.t2.micro",
|
|
111
|
+
* DBInstanceCount: 1,
|
|
112
|
+
* Duration: 31536000,
|
|
113
|
+
* FixedPrice: 51,
|
|
114
|
+
* MultiAZ: false,
|
|
115
|
+
* OfferingType: "Partial Upfront",
|
|
116
|
+
* ProductDescription: "mysql",
|
|
117
|
+
* RecurringCharges: [
|
|
118
118
|
* {
|
|
119
|
-
*
|
|
120
|
-
*
|
|
119
|
+
* RecurringChargeAmount: 0.006,
|
|
120
|
+
* RecurringChargeFrequency: "Hourly"
|
|
121
121
|
* }
|
|
122
122
|
* ],
|
|
123
|
-
*
|
|
124
|
-
*
|
|
125
|
-
*
|
|
126
|
-
*
|
|
127
|
-
*
|
|
128
|
-
*
|
|
123
|
+
* ReservedDBInstanceArn: "arn:aws:rds:us-west-2:123456789012:ri:ri-2020-06-29-16-54-57-670",
|
|
124
|
+
* ReservedDBInstanceId: "ri-2020-06-29-16-54-57-670",
|
|
125
|
+
* ReservedDBInstancesOfferingId: "8ba30be1-b9ec-447f-8f23-6114e3f4c7b4",
|
|
126
|
+
* StartTime: "2020-06-29T16:54:57.670Z",
|
|
127
|
+
* State: "payment-pending",
|
|
128
|
+
* UsagePrice: 0
|
|
129
129
|
* }
|
|
130
130
|
* }
|
|
131
131
|
* *\/
|
|
132
|
-
* // example id: to-purchase-a-reserved-db-instance-1680263732858
|
|
133
132
|
* ```
|
|
134
133
|
*
|
|
134
|
+
* @public
|
|
135
135
|
*/
|
|
136
136
|
export declare class PurchaseReservedDBInstancesOfferingCommand extends PurchaseReservedDBInstancesOfferingCommand_base {
|
|
137
137
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -263,6 +263,7 @@ declare const RebootDBClusterCommand_base: {
|
|
|
263
263
|
* @throws {@link RDSServiceException}
|
|
264
264
|
* <p>Base exception class for all service exceptions from RDS service.</p>
|
|
265
265
|
*
|
|
266
|
+
*
|
|
266
267
|
* @public
|
|
267
268
|
*/
|
|
268
269
|
export declare class RebootDBClusterCommand extends RebootDBClusterCommand_base {
|
|
@@ -295,34 +295,34 @@ declare const RebootDBInstanceCommand_base: {
|
|
|
295
295
|
* @throws {@link RDSServiceException}
|
|
296
296
|
* <p>Base exception class for all service exceptions from RDS service.</p>
|
|
297
297
|
*
|
|
298
|
-
*
|
|
298
|
+
*
|
|
299
299
|
* @example To reboot a DB instance
|
|
300
300
|
* ```javascript
|
|
301
301
|
* // The following example starts a reboot of the specified DB instance.
|
|
302
302
|
* const input = {
|
|
303
|
-
*
|
|
303
|
+
* DBInstanceIdentifier: "test-mysql-instance"
|
|
304
304
|
* };
|
|
305
305
|
* const command = new RebootDBInstanceCommand(input);
|
|
306
306
|
* const response = await client.send(command);
|
|
307
|
-
* /* response
|
|
307
|
+
* /* response is
|
|
308
308
|
* {
|
|
309
|
-
*
|
|
310
|
-
*
|
|
311
|
-
*
|
|
312
|
-
*
|
|
313
|
-
*
|
|
314
|
-
*
|
|
315
|
-
*
|
|
316
|
-
*
|
|
309
|
+
* DBInstance: {
|
|
310
|
+
* DBInstanceClass: "db.t3.micro",
|
|
311
|
+
* DBInstanceIdentifier: "test-mysql-instance",
|
|
312
|
+
* DBInstanceStatus: "rebooting",
|
|
313
|
+
* Endpoint: {
|
|
314
|
+
* Address: "test-mysql-instance.############.us-west-2.rds.amazonaws.com",
|
|
315
|
+
* HostedZoneId: "Z1PVIF0EXAMPLE",
|
|
316
|
+
* Port: 3306
|
|
317
317
|
* },
|
|
318
|
-
*
|
|
319
|
-
*
|
|
318
|
+
* Engine: "mysql",
|
|
319
|
+
* MasterUsername: "admin"
|
|
320
320
|
* }
|
|
321
321
|
* }
|
|
322
322
|
* *\/
|
|
323
|
-
* // example id: to-reboot-a-db-instance-1680072870190
|
|
324
323
|
* ```
|
|
325
324
|
*
|
|
325
|
+
* @public
|
|
326
326
|
*/
|
|
327
327
|
export declare class RebootDBInstanceCommand extends RebootDBInstanceCommand_base {
|
|
328
328
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -78,6 +78,7 @@ declare const RebootDBShardGroupCommand_base: {
|
|
|
78
78
|
* @throws {@link RDSServiceException}
|
|
79
79
|
* <p>Base exception class for all service exceptions from RDS service.</p>
|
|
80
80
|
*
|
|
81
|
+
*
|
|
81
82
|
* @public
|
|
82
83
|
*/
|
|
83
84
|
export declare class RebootDBShardGroupCommand extends RebootDBShardGroupCommand_base {
|
|
@@ -107,6 +107,7 @@ declare const RegisterDBProxyTargetsCommand_base: {
|
|
|
107
107
|
* @throws {@link RDSServiceException}
|
|
108
108
|
* <p>Base exception class for all service exceptions from RDS service.</p>
|
|
109
109
|
*
|
|
110
|
+
*
|
|
110
111
|
* @public
|
|
111
112
|
*/
|
|
112
113
|
export declare class RegisterDBProxyTargetsCommand extends RegisterDBProxyTargetsCommand_base {
|
|
@@ -105,48 +105,48 @@ declare const RemoveFromGlobalClusterCommand_base: {
|
|
|
105
105
|
* @throws {@link RDSServiceException}
|
|
106
106
|
* <p>Base exception class for all service exceptions from RDS service.</p>
|
|
107
107
|
*
|
|
108
|
-
*
|
|
108
|
+
*
|
|
109
109
|
* @example To detach an Aurora secondary cluster from an Aurora global database cluster
|
|
110
110
|
* ```javascript
|
|
111
111
|
* // The following example detaches an Aurora secondary cluster from an Aurora global database cluster. The cluster changes from being read-only to a standalone cluster with read-write capability.
|
|
112
112
|
* const input = {
|
|
113
|
-
*
|
|
114
|
-
*
|
|
113
|
+
* DbClusterIdentifier: "arn:aws:rds:us-west-2:123456789012:cluster:DB-1",
|
|
114
|
+
* GlobalClusterIdentifier: "myglobalcluster"
|
|
115
115
|
* };
|
|
116
116
|
* const command = new RemoveFromGlobalClusterCommand(input);
|
|
117
117
|
* const response = await client.send(command);
|
|
118
|
-
* /* response
|
|
118
|
+
* /* response is
|
|
119
119
|
* {
|
|
120
|
-
*
|
|
121
|
-
*
|
|
122
|
-
*
|
|
123
|
-
*
|
|
124
|
-
*
|
|
125
|
-
*
|
|
126
|
-
*
|
|
120
|
+
* GlobalCluster: {
|
|
121
|
+
* DeletionProtection: false,
|
|
122
|
+
* Engine: "aurora-postgresql",
|
|
123
|
+
* EngineVersion: "10.11",
|
|
124
|
+
* GlobalClusterArn: "arn:aws:rds::123456789012:global-cluster:myglobalcluster",
|
|
125
|
+
* GlobalClusterIdentifier: "myglobalcluster",
|
|
126
|
+
* GlobalClusterMembers: [
|
|
127
127
|
* {
|
|
128
|
-
*
|
|
129
|
-
*
|
|
130
|
-
*
|
|
128
|
+
* DBClusterArn: "arn:aws:rds:us-east-1:123456789012:cluster:js-global-cluster",
|
|
129
|
+
* IsWriter: true,
|
|
130
|
+
* Readers: [
|
|
131
131
|
* "arn:aws:rds:us-west-2:123456789012:cluster:DB-1"
|
|
132
132
|
* ]
|
|
133
133
|
* },
|
|
134
134
|
* {
|
|
135
|
-
*
|
|
136
|
-
*
|
|
137
|
-
*
|
|
138
|
-
*
|
|
135
|
+
* DBClusterArn: "arn:aws:rds:us-west-2:123456789012:cluster:DB-1",
|
|
136
|
+
* GlobalWriteForwardingStatus: "disabled",
|
|
137
|
+
* IsWriter: false,
|
|
138
|
+
* Readers: []
|
|
139
139
|
* }
|
|
140
140
|
* ],
|
|
141
|
-
*
|
|
142
|
-
*
|
|
143
|
-
*
|
|
141
|
+
* GlobalClusterResourceId: "cluster-abc123def456gh",
|
|
142
|
+
* Status: "available",
|
|
143
|
+
* StorageEncrypted: true
|
|
144
144
|
* }
|
|
145
145
|
* }
|
|
146
146
|
* *\/
|
|
147
|
-
* // example id: to-detach-an-aurora-secondary-cluster-from-an-aurora-global-database-cluster-1680072605847
|
|
148
147
|
* ```
|
|
149
148
|
*
|
|
149
|
+
* @public
|
|
150
150
|
*/
|
|
151
151
|
export declare class RemoveFromGlobalClusterCommand extends RemoveFromGlobalClusterCommand_base {
|
|
152
152
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -72,19 +72,22 @@ declare const RemoveRoleFromDBClusterCommand_base: {
|
|
|
72
72
|
* @throws {@link RDSServiceException}
|
|
73
73
|
* <p>Base exception class for all service exceptions from RDS service.</p>
|
|
74
74
|
*
|
|
75
|
-
*
|
|
75
|
+
*
|
|
76
76
|
* @example To disassociate an Identity and Access Management (IAM) role from a DB cluster
|
|
77
77
|
* ```javascript
|
|
78
78
|
* // The following example removes a role from a DB cluster.
|
|
79
79
|
* const input = {
|
|
80
|
-
*
|
|
81
|
-
*
|
|
80
|
+
* DBClusterIdentifier: "mydbcluster",
|
|
81
|
+
* RoleArn: "arn:aws:iam::123456789012:role/RDSLoadFromS3"
|
|
82
82
|
* };
|
|
83
83
|
* const command = new RemoveRoleFromDBClusterCommand(input);
|
|
84
|
-
* await client.send(command);
|
|
85
|
-
*
|
|
84
|
+
* const response = await client.send(command);
|
|
85
|
+
* /* response is
|
|
86
|
+
* { /* metadata only *\/ }
|
|
87
|
+
* *\/
|
|
86
88
|
* ```
|
|
87
89
|
*
|
|
90
|
+
* @public
|
|
88
91
|
*/
|
|
89
92
|
export declare class RemoveRoleFromDBClusterCommand extends RemoveRoleFromDBClusterCommand_base {
|
|
90
93
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -65,6 +65,7 @@ declare const RemoveRoleFromDBInstanceCommand_base: {
|
|
|
65
65
|
* @throws {@link RDSServiceException}
|
|
66
66
|
* <p>Base exception class for all service exceptions from RDS service.</p>
|
|
67
67
|
*
|
|
68
|
+
*
|
|
68
69
|
* @public
|
|
69
70
|
*/
|
|
70
71
|
export declare class RemoveRoleFromDBInstanceCommand extends RemoveRoleFromDBInstanceCommand_base {
|