@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
|
@@ -441,101 +441,101 @@ declare const RestoreDBInstanceToPointInTimeCommand_base: {
|
|
|
441
441
|
* @throws {@link RDSServiceException}
|
|
442
442
|
* <p>Base exception class for all service exceptions from RDS service.</p>
|
|
443
443
|
*
|
|
444
|
-
*
|
|
444
|
+
*
|
|
445
445
|
* @example To restore a DB instance to a point in time
|
|
446
446
|
* ```javascript
|
|
447
447
|
* // The following example restores test-instance to a new DB instance named restored-test-instance, as of the specified time.
|
|
448
448
|
* const input = {
|
|
449
|
-
*
|
|
450
|
-
*
|
|
451
|
-
*
|
|
449
|
+
* RestoreTime: "2018-07-30T23:45:00.000Z",
|
|
450
|
+
* SourceDBInstanceIdentifier: "test-instance",
|
|
451
|
+
* TargetDBInstanceIdentifier: "restored-test-instance"
|
|
452
452
|
* };
|
|
453
453
|
* const command = new RestoreDBInstanceToPointInTimeCommand(input);
|
|
454
454
|
* const response = await client.send(command);
|
|
455
|
-
* /* response
|
|
455
|
+
* /* response is
|
|
456
456
|
* {
|
|
457
|
-
*
|
|
458
|
-
*
|
|
459
|
-
*
|
|
460
|
-
*
|
|
461
|
-
*
|
|
462
|
-
*
|
|
463
|
-
*
|
|
464
|
-
*
|
|
465
|
-
*
|
|
466
|
-
*
|
|
467
|
-
*
|
|
468
|
-
*
|
|
469
|
-
*
|
|
457
|
+
* DBInstance: {
|
|
458
|
+
* AllocatedStorage: 200,
|
|
459
|
+
* AutoMinorVersionUpgrade: true,
|
|
460
|
+
* AvailabilityZone: "us-west-2b",
|
|
461
|
+
* BackupRetentionPeriod: 7,
|
|
462
|
+
* CACertificateIdentifier: "rds-ca-2015",
|
|
463
|
+
* CopyTagsToSnapshot: false,
|
|
464
|
+
* DBInstanceArn: "arn:aws:rds:us-west-2:123456789012:db:restored-test-instance",
|
|
465
|
+
* DBInstanceClass: "db.t2.small",
|
|
466
|
+
* DBInstanceIdentifier: "restored-test-instance",
|
|
467
|
+
* DBInstanceStatus: "available",
|
|
468
|
+
* DBName: "sample",
|
|
469
|
+
* DBParameterGroups: [
|
|
470
470
|
* {
|
|
471
|
-
*
|
|
472
|
-
*
|
|
471
|
+
* DBParameterGroupName: "default.mysql5.6",
|
|
472
|
+
* ParameterApplyStatus: "in-sync"
|
|
473
473
|
* }
|
|
474
474
|
* ],
|
|
475
|
-
*
|
|
476
|
-
*
|
|
477
|
-
*
|
|
478
|
-
*
|
|
479
|
-
*
|
|
480
|
-
*
|
|
475
|
+
* DBSecurityGroups: [],
|
|
476
|
+
* DBSubnetGroup: {
|
|
477
|
+
* DBSubnetGroupDescription: "default",
|
|
478
|
+
* DBSubnetGroupName: "default",
|
|
479
|
+
* SubnetGroupStatus: "Complete",
|
|
480
|
+
* Subnets: [
|
|
481
481
|
* {
|
|
482
|
-
*
|
|
483
|
-
*
|
|
482
|
+
* SubnetAvailabilityZone: {
|
|
483
|
+
* Name: "us-west-2a"
|
|
484
484
|
* },
|
|
485
|
-
*
|
|
486
|
-
*
|
|
485
|
+
* SubnetIdentifier: "subnet-77e8db03",
|
|
486
|
+
* SubnetStatus: "Active"
|
|
487
487
|
* },
|
|
488
488
|
* {
|
|
489
|
-
*
|
|
490
|
-
*
|
|
489
|
+
* SubnetAvailabilityZone: {
|
|
490
|
+
* Name: "us-west-2b"
|
|
491
491
|
* },
|
|
492
|
-
*
|
|
493
|
-
*
|
|
492
|
+
* SubnetIdentifier: "subnet-c39989a1",
|
|
493
|
+
* SubnetStatus: "Active"
|
|
494
494
|
* },
|
|
495
495
|
* {
|
|
496
|
-
*
|
|
497
|
-
*
|
|
496
|
+
* SubnetAvailabilityZone: {
|
|
497
|
+
* Name: "us-west-2c"
|
|
498
498
|
* },
|
|
499
|
-
*
|
|
500
|
-
*
|
|
499
|
+
* SubnetIdentifier: "subnet-4b267b0d",
|
|
500
|
+
* SubnetStatus: "Active"
|
|
501
501
|
* }
|
|
502
502
|
* ],
|
|
503
|
-
*
|
|
503
|
+
* VpcId: "vpc-c1c5b3a3"
|
|
504
504
|
* },
|
|
505
|
-
*
|
|
506
|
-
*
|
|
507
|
-
*
|
|
508
|
-
*
|
|
509
|
-
*
|
|
510
|
-
*
|
|
511
|
-
*
|
|
512
|
-
*
|
|
513
|
-
*
|
|
514
|
-
*
|
|
505
|
+
* DbInstancePort: 0,
|
|
506
|
+
* DbiResourceId: "db-VNZUCCBTEDC4WR7THXNJO72HVQ",
|
|
507
|
+
* DomainMemberships: [],
|
|
508
|
+
* Engine: "mysql",
|
|
509
|
+
* EngineVersion: "5.6.27",
|
|
510
|
+
* LicenseModel: "general-public-license",
|
|
511
|
+
* MasterUsername: "mymasteruser",
|
|
512
|
+
* MonitoringInterval: 0,
|
|
513
|
+
* MultiAZ: false,
|
|
514
|
+
* OptionGroupMemberships: [
|
|
515
515
|
* {
|
|
516
|
-
*
|
|
517
|
-
*
|
|
516
|
+
* OptionGroupName: "default:mysql-5-6",
|
|
517
|
+
* Status: "in-sync"
|
|
518
518
|
* }
|
|
519
519
|
* ],
|
|
520
|
-
*
|
|
521
|
-
*
|
|
522
|
-
*
|
|
523
|
-
*
|
|
524
|
-
*
|
|
525
|
-
*
|
|
526
|
-
*
|
|
527
|
-
*
|
|
520
|
+
* PendingModifiedValues: { /* empty *\/ },
|
|
521
|
+
* PreferredBackupWindow: "12:58-13:28",
|
|
522
|
+
* PreferredMaintenanceWindow: "tue:10:16-tue:10:46",
|
|
523
|
+
* PubliclyAccessible: true,
|
|
524
|
+
* ReadReplicaDBInstanceIdentifiers: [],
|
|
525
|
+
* StorageEncrypted: false,
|
|
526
|
+
* StorageType: "gp2",
|
|
527
|
+
* VpcSecurityGroups: [
|
|
528
528
|
* {
|
|
529
|
-
*
|
|
530
|
-
*
|
|
529
|
+
* Status: "active",
|
|
530
|
+
* VpcSecurityGroupId: "sg-e5e5b0d2"
|
|
531
531
|
* }
|
|
532
532
|
* ]
|
|
533
533
|
* }
|
|
534
534
|
* }
|
|
535
535
|
* *\/
|
|
536
|
-
* // example id: to-restore-a-db-instance-to-a-point-in-time-1680036021951
|
|
537
536
|
* ```
|
|
538
537
|
*
|
|
538
|
+
* @public
|
|
539
539
|
*/
|
|
540
540
|
export declare class RestoreDBInstanceToPointInTimeCommand extends RestoreDBInstanceToPointInTimeCommand_base {
|
|
541
541
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -100,24 +100,24 @@ declare const RevokeDBSecurityGroupIngressCommand_base: {
|
|
|
100
100
|
* @throws {@link RDSServiceException}
|
|
101
101
|
* <p>Base exception class for all service exceptions from RDS service.</p>
|
|
102
102
|
*
|
|
103
|
-
*
|
|
103
|
+
*
|
|
104
104
|
* @example To revoke ingress for a DB security group
|
|
105
105
|
* ```javascript
|
|
106
106
|
* // This example revokes ingress for the specified CIDR block associated with the specified DB security group.
|
|
107
107
|
* const input = {
|
|
108
|
-
*
|
|
109
|
-
*
|
|
108
|
+
* CIDRIP: "203.0.113.5/32",
|
|
109
|
+
* DBSecurityGroupName: "mydbsecuritygroup"
|
|
110
110
|
* };
|
|
111
111
|
* const command = new RevokeDBSecurityGroupIngressCommand(input);
|
|
112
112
|
* const response = await client.send(command);
|
|
113
|
-
* /* response
|
|
113
|
+
* /* response is
|
|
114
114
|
* {
|
|
115
|
-
*
|
|
115
|
+
* DBSecurityGroup: { /* empty *\/ }
|
|
116
116
|
* }
|
|
117
117
|
* *\/
|
|
118
|
-
* // example id: revoke-db-security-group-ingress-ce5b2c1c-bd4e-4809-b04a-6d78ec448813
|
|
119
118
|
* ```
|
|
120
119
|
*
|
|
120
|
+
* @public
|
|
121
121
|
*/
|
|
122
122
|
export declare class RevokeDBSecurityGroupIngressCommand extends RevokeDBSecurityGroupIngressCommand_base {
|
|
123
123
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -90,30 +90,30 @@ declare const StartActivityStreamCommand_base: {
|
|
|
90
90
|
* @throws {@link RDSServiceException}
|
|
91
91
|
* <p>Base exception class for all service exceptions from RDS service.</p>
|
|
92
92
|
*
|
|
93
|
-
*
|
|
93
|
+
*
|
|
94
94
|
* @example To start a database activity stream
|
|
95
95
|
* ```javascript
|
|
96
96
|
* // The following example starts an asynchronous activity stream to monitor an Aurora cluster named my-pg-cluster.
|
|
97
97
|
* const input = {
|
|
98
|
-
*
|
|
99
|
-
*
|
|
100
|
-
*
|
|
101
|
-
*
|
|
98
|
+
* ApplyImmediately: true,
|
|
99
|
+
* KmsKeyId: "arn:aws:kms:us-east-1:1234567890123:key/a12c345d-6ef7-890g-h123-456i789jk0l1",
|
|
100
|
+
* Mode: "async",
|
|
101
|
+
* ResourceArn: "arn:aws:rds:us-east-1:1234567890123:cluster:my-pg-cluster"
|
|
102
102
|
* };
|
|
103
103
|
* const command = new StartActivityStreamCommand(input);
|
|
104
104
|
* const response = await client.send(command);
|
|
105
|
-
* /* response
|
|
105
|
+
* /* response is
|
|
106
106
|
* {
|
|
107
|
-
*
|
|
108
|
-
*
|
|
109
|
-
*
|
|
110
|
-
*
|
|
111
|
-
*
|
|
107
|
+
* ApplyImmediately: true,
|
|
108
|
+
* KinesisStreamName: "aws-rds-das-cluster-0ABCDEFGHI1JKLM2NOPQ3R4S",
|
|
109
|
+
* KmsKeyId: "arn:aws:kms:us-east-1:1234567890123:key/a12c345d-6ef7-890g-h123-456i789jk0l1",
|
|
110
|
+
* Mode: "async",
|
|
111
|
+
* Status: "starting"
|
|
112
112
|
* }
|
|
113
113
|
* *\/
|
|
114
|
-
* // example id: to-start-a-database-activity-stream-1680035656463
|
|
115
114
|
* ```
|
|
116
115
|
*
|
|
116
|
+
* @public
|
|
117
117
|
*/
|
|
118
118
|
export declare class StartActivityStreamCommand extends StartActivityStreamCommand_base {
|
|
119
119
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -260,33 +260,33 @@ declare const StartDBClusterCommand_base: {
|
|
|
260
260
|
* @throws {@link RDSServiceException}
|
|
261
261
|
* <p>Base exception class for all service exceptions from RDS service.</p>
|
|
262
262
|
*
|
|
263
|
-
*
|
|
263
|
+
*
|
|
264
264
|
* @example To start a DB cluster
|
|
265
265
|
* ```javascript
|
|
266
266
|
* // The following example starts a DB cluster and its DB instances.
|
|
267
267
|
* const input = {
|
|
268
|
-
*
|
|
268
|
+
* DBClusterIdentifier: "mydbcluster"
|
|
269
269
|
* };
|
|
270
270
|
* const command = new StartDBClusterCommand(input);
|
|
271
271
|
* const response = await client.send(command);
|
|
272
|
-
* /* response
|
|
272
|
+
* /* response is
|
|
273
273
|
* {
|
|
274
|
-
*
|
|
275
|
-
*
|
|
276
|
-
*
|
|
274
|
+
* DBCluster: {
|
|
275
|
+
* AllocatedStorage: 1,
|
|
276
|
+
* AvailabilityZones: [
|
|
277
277
|
* "us-east-1a",
|
|
278
278
|
* "us-east-1e",
|
|
279
279
|
* "us-east-1b"
|
|
280
280
|
* ],
|
|
281
|
-
*
|
|
282
|
-
*
|
|
283
|
-
*
|
|
281
|
+
* BackupRetentionPeriod: 1,
|
|
282
|
+
* DBClusterIdentifier: "mydbcluster",
|
|
283
|
+
* DatabaseName: "mydb"
|
|
284
284
|
* }
|
|
285
285
|
* }
|
|
286
286
|
* *\/
|
|
287
|
-
* // example id: to-start-a-db-cluster-1680035521632
|
|
288
287
|
* ```
|
|
289
288
|
*
|
|
289
|
+
* @public
|
|
290
290
|
*/
|
|
291
291
|
export declare class StartDBClusterCommand extends StartDBClusterCommand_base {
|
|
292
292
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -118,44 +118,44 @@ declare const StartDBInstanceAutomatedBackupsReplicationCommand_base: {
|
|
|
118
118
|
* @throws {@link RDSServiceException}
|
|
119
119
|
* <p>Base exception class for all service exceptions from RDS service.</p>
|
|
120
120
|
*
|
|
121
|
-
*
|
|
121
|
+
*
|
|
122
122
|
* @example To enable cross-Region automated backups
|
|
123
123
|
* ```javascript
|
|
124
124
|
* // The following example replicates automated backups from a DB instance in the US East (N. Virginia) Region. The backup retention period is 14 days.
|
|
125
125
|
* const input = {
|
|
126
|
-
*
|
|
127
|
-
*
|
|
126
|
+
* BackupRetentionPeriod: 14,
|
|
127
|
+
* SourceDBInstanceArn: "arn:aws:rds:us-east-1:123456789012:db:new-orcl-db"
|
|
128
128
|
* };
|
|
129
129
|
* const command = new StartDBInstanceAutomatedBackupsReplicationCommand(input);
|
|
130
130
|
* const response = await client.send(command);
|
|
131
|
-
* /* response
|
|
131
|
+
* /* response is
|
|
132
132
|
* {
|
|
133
|
-
*
|
|
134
|
-
*
|
|
135
|
-
*
|
|
136
|
-
*
|
|
137
|
-
*
|
|
138
|
-
*
|
|
139
|
-
*
|
|
140
|
-
*
|
|
141
|
-
*
|
|
142
|
-
*
|
|
143
|
-
*
|
|
144
|
-
*
|
|
145
|
-
*
|
|
146
|
-
*
|
|
147
|
-
*
|
|
148
|
-
*
|
|
149
|
-
*
|
|
150
|
-
*
|
|
151
|
-
*
|
|
152
|
-
*
|
|
133
|
+
* DBInstanceAutomatedBackup: {
|
|
134
|
+
* AllocatedStorage: 20,
|
|
135
|
+
* BackupRetentionPeriod: 14,
|
|
136
|
+
* DBInstanceArn: "arn:aws:rds:us-east-1:123456789012:db:new-orcl-db",
|
|
137
|
+
* DBInstanceAutomatedBackupsArn: "arn:aws:rds:us-west-2:123456789012:auto-backup:ab-jkib2gfq5rv7replzadausbrktni2bn4example",
|
|
138
|
+
* DBInstanceIdentifier: "new-orcl-db",
|
|
139
|
+
* DbiResourceId: "db-JKIB2GFQ5RV7REPLZA4EXAMPLE",
|
|
140
|
+
* Encrypted: false,
|
|
141
|
+
* Engine: "oracle-se2",
|
|
142
|
+
* EngineVersion: "12.1.0.2.v21",
|
|
143
|
+
* IAMDatabaseAuthenticationEnabled: false,
|
|
144
|
+
* InstanceCreateTime: "2020-12-04T15:28:31Z",
|
|
145
|
+
* LicenseModel: "bring-your-own-license",
|
|
146
|
+
* MasterUsername: "admin",
|
|
147
|
+
* OptionGroupName: "default:oracle-se2-12-1",
|
|
148
|
+
* Port: 1521,
|
|
149
|
+
* Region: "us-east-1",
|
|
150
|
+
* RestoreWindow: { /* empty *\/ },
|
|
151
|
+
* Status: "pending",
|
|
152
|
+
* StorageType: "gp2"
|
|
153
153
|
* }
|
|
154
154
|
* }
|
|
155
155
|
* *\/
|
|
156
|
-
* // example id: to-enable-cross-region-automated-backups-1680033438352
|
|
157
156
|
* ```
|
|
158
157
|
*
|
|
158
|
+
* @public
|
|
159
159
|
*/
|
|
160
160
|
export declare class StartDBInstanceAutomatedBackupsReplicationCommand extends StartDBInstanceAutomatedBackupsReplicationCommand_base {
|
|
161
161
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -328,25 +328,25 @@ declare const StartDBInstanceCommand_base: {
|
|
|
328
328
|
* @throws {@link RDSServiceException}
|
|
329
329
|
* <p>Base exception class for all service exceptions from RDS service.</p>
|
|
330
330
|
*
|
|
331
|
-
*
|
|
331
|
+
*
|
|
332
332
|
* @example To start a DB instance
|
|
333
333
|
* ```javascript
|
|
334
334
|
* // The following example starts the specified DB instance.
|
|
335
335
|
* const input = {
|
|
336
|
-
*
|
|
336
|
+
* DBInstanceIdentifier: "test-instance"
|
|
337
337
|
* };
|
|
338
338
|
* const command = new StartDBInstanceCommand(input);
|
|
339
339
|
* const response = await client.send(command);
|
|
340
|
-
* /* response
|
|
340
|
+
* /* response is
|
|
341
341
|
* {
|
|
342
|
-
*
|
|
343
|
-
*
|
|
342
|
+
* DBInstance: {
|
|
343
|
+
* DBInstanceStatus: "starting"
|
|
344
344
|
* }
|
|
345
345
|
* }
|
|
346
346
|
* *\/
|
|
347
|
-
* // example id: to-start-a-db-instance-1679951967681
|
|
348
347
|
* ```
|
|
349
348
|
*
|
|
349
|
+
* @public
|
|
350
350
|
*/
|
|
351
351
|
export declare class StartDBInstanceCommand extends StartDBInstanceCommand_base {
|
|
352
352
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -126,35 +126,35 @@ declare const StartExportTaskCommand_base: {
|
|
|
126
126
|
* @throws {@link RDSServiceException}
|
|
127
127
|
* <p>Base exception class for all service exceptions from RDS service.</p>
|
|
128
128
|
*
|
|
129
|
-
*
|
|
129
|
+
*
|
|
130
130
|
* @example To export a snapshot to Amazon S3
|
|
131
131
|
* ```javascript
|
|
132
132
|
* // The following example exports a DB snapshot named db5-snapshot-test to the Amazon S3 bucket named mybucket.
|
|
133
133
|
* const input = {
|
|
134
|
-
*
|
|
135
|
-
*
|
|
136
|
-
*
|
|
137
|
-
*
|
|
138
|
-
*
|
|
134
|
+
* ExportTaskIdentifier: "my-s3-export",
|
|
135
|
+
* IamRoleArn: "arn:aws:iam::123456789012:role/service-role/ExportRole",
|
|
136
|
+
* KmsKeyId: "arn:aws:kms:us-west-2:123456789012:key/abcd0000-7fca-4128-82f2-aabbccddeeff",
|
|
137
|
+
* S3BucketName: "mybucket",
|
|
138
|
+
* SourceArn: "arn:aws:rds:us-west-2:123456789012:snapshot:db5-snapshot-test"
|
|
139
139
|
* };
|
|
140
140
|
* const command = new StartExportTaskCommand(input);
|
|
141
141
|
* const response = await client.send(command);
|
|
142
|
-
* /* response
|
|
142
|
+
* /* response is
|
|
143
143
|
* {
|
|
144
|
-
*
|
|
145
|
-
*
|
|
146
|
-
*
|
|
147
|
-
*
|
|
148
|
-
*
|
|
149
|
-
*
|
|
150
|
-
*
|
|
151
|
-
*
|
|
152
|
-
*
|
|
144
|
+
* ExportTaskIdentifier: "my-s3-export",
|
|
145
|
+
* IamRoleArn: "arn:aws:iam::123456789012:role/service-role/ExportRole",
|
|
146
|
+
* KmsKeyId: "arn:aws:kms:us-west-2:123456789012:key/abcd0000-7fca-4128-82f2-aabbccddeeff",
|
|
147
|
+
* PercentProgress: 0,
|
|
148
|
+
* S3Bucket: "mybucket",
|
|
149
|
+
* SnapshotTime: "2020-03-27T20:48:42.023Z",
|
|
150
|
+
* SourceArn: "arn:aws:rds:us-west-2:123456789012:snapshot:db5-snapshot-test",
|
|
151
|
+
* Status: "STARTING",
|
|
152
|
+
* TotalExtractedDataInGB: 0
|
|
153
153
|
* }
|
|
154
154
|
* *\/
|
|
155
|
-
* // example id: to-export-a-snapshot-to-amazon-s3-1679950669718
|
|
156
155
|
* ```
|
|
157
156
|
*
|
|
157
|
+
* @public
|
|
158
158
|
*/
|
|
159
159
|
export declare class StartExportTaskCommand extends StartExportTaskCommand_base {
|
|
160
160
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -82,26 +82,26 @@ declare const StopActivityStreamCommand_base: {
|
|
|
82
82
|
* @throws {@link RDSServiceException}
|
|
83
83
|
* <p>Base exception class for all service exceptions from RDS service.</p>
|
|
84
84
|
*
|
|
85
|
-
*
|
|
85
|
+
*
|
|
86
86
|
* @example To stop a database activity stream
|
|
87
87
|
* ```javascript
|
|
88
88
|
* // The following example stops an activity stream in an Aurora cluster named my-pg-cluster.
|
|
89
89
|
* const input = {
|
|
90
|
-
*
|
|
91
|
-
*
|
|
90
|
+
* ApplyImmediately: true,
|
|
91
|
+
* ResourceArn: "arn:aws:rds:us-east-1:1234567890123:cluster:my-pg-cluster"
|
|
92
92
|
* };
|
|
93
93
|
* const command = new StopActivityStreamCommand(input);
|
|
94
94
|
* const response = await client.send(command);
|
|
95
|
-
* /* response
|
|
95
|
+
* /* response is
|
|
96
96
|
* {
|
|
97
|
-
*
|
|
98
|
-
*
|
|
99
|
-
*
|
|
97
|
+
* KinesisStreamName: "aws-rds-das-cluster-0ABCDEFGHI1JKLM2NOPQ3R4S",
|
|
98
|
+
* KmsKeyId: "arn:aws:kms:us-east-1:1234567890123:key/a12c345d-6ef7-890g-h123-456i789jk0l1",
|
|
99
|
+
* Status: "stopping"
|
|
100
100
|
* }
|
|
101
101
|
* *\/
|
|
102
|
-
* // example id: to-stop-a-database-activity-stream-1679945843823
|
|
103
102
|
* ```
|
|
104
103
|
*
|
|
104
|
+
* @public
|
|
105
105
|
*/
|
|
106
106
|
export declare class StopActivityStreamCommand extends StopActivityStreamCommand_base {
|
|
107
107
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -261,33 +261,33 @@ declare const StopDBClusterCommand_base: {
|
|
|
261
261
|
* @throws {@link RDSServiceException}
|
|
262
262
|
* <p>Base exception class for all service exceptions from RDS service.</p>
|
|
263
263
|
*
|
|
264
|
-
*
|
|
264
|
+
*
|
|
265
265
|
* @example To stop a DB cluster
|
|
266
266
|
* ```javascript
|
|
267
267
|
* // The following example stops a DB cluster and its DB instances.
|
|
268
268
|
* const input = {
|
|
269
|
-
*
|
|
269
|
+
* DBClusterIdentifier: "mydbcluster"
|
|
270
270
|
* };
|
|
271
271
|
* const command = new StopDBClusterCommand(input);
|
|
272
272
|
* const response = await client.send(command);
|
|
273
|
-
* /* response
|
|
273
|
+
* /* response is
|
|
274
274
|
* {
|
|
275
|
-
*
|
|
276
|
-
*
|
|
277
|
-
*
|
|
275
|
+
* DBCluster: {
|
|
276
|
+
* AllocatedStorage: 1,
|
|
277
|
+
* AvailabilityZones: [
|
|
278
278
|
* "us-east-1a",
|
|
279
279
|
* "us-east-1e",
|
|
280
280
|
* "us-east-1b"
|
|
281
281
|
* ],
|
|
282
|
-
*
|
|
283
|
-
*
|
|
284
|
-
*
|
|
282
|
+
* BackupRetentionPeriod: 1,
|
|
283
|
+
* DBClusterIdentifier: "mydbcluster",
|
|
284
|
+
* DatabaseName: "mydb"
|
|
285
285
|
* }
|
|
286
286
|
* }
|
|
287
287
|
* *\/
|
|
288
|
-
* // example id: to-stop-a-db-cluster-1679701988603
|
|
289
288
|
* ```
|
|
290
289
|
*
|
|
290
|
+
* @public
|
|
291
291
|
*/
|
|
292
292
|
export declare class StopDBClusterCommand extends StopDBClusterCommand_base {
|
|
293
293
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -104,46 +104,46 @@ declare const StopDBInstanceAutomatedBackupsReplicationCommand_base: {
|
|
|
104
104
|
* @throws {@link RDSServiceException}
|
|
105
105
|
* <p>Base exception class for all service exceptions from RDS service.</p>
|
|
106
106
|
*
|
|
107
|
-
*
|
|
107
|
+
*
|
|
108
108
|
* @example To stop replicating automated backups
|
|
109
109
|
* ```javascript
|
|
110
110
|
* // The following example ends replication of automated backups. Replicated backups are retained according to the set backup retention period.
|
|
111
111
|
* const input = {
|
|
112
|
-
*
|
|
112
|
+
* SourceDBInstanceArn: "arn:aws:rds:us-east-1:123456789012:db:new-orcl-db"
|
|
113
113
|
* };
|
|
114
114
|
* const command = new StopDBInstanceAutomatedBackupsReplicationCommand(input);
|
|
115
115
|
* const response = await client.send(command);
|
|
116
|
-
* /* response
|
|
116
|
+
* /* response is
|
|
117
117
|
* {
|
|
118
|
-
*
|
|
119
|
-
*
|
|
120
|
-
*
|
|
121
|
-
*
|
|
122
|
-
*
|
|
123
|
-
*
|
|
124
|
-
*
|
|
125
|
-
*
|
|
126
|
-
*
|
|
127
|
-
*
|
|
128
|
-
*
|
|
129
|
-
*
|
|
130
|
-
*
|
|
131
|
-
*
|
|
132
|
-
*
|
|
133
|
-
*
|
|
134
|
-
*
|
|
135
|
-
*
|
|
136
|
-
*
|
|
137
|
-
*
|
|
118
|
+
* DBInstanceAutomatedBackup: {
|
|
119
|
+
* AllocatedStorage: 20,
|
|
120
|
+
* BackupRetentionPeriod: 7,
|
|
121
|
+
* DBInstanceArn: "arn:aws:rds:us-east-1:123456789012:db:new-orcl-db",
|
|
122
|
+
* DBInstanceAutomatedBackupsArn: "arn:aws:rds:us-west-2:123456789012:auto-backup:ab-jkib2gfq5rv7replzadausbrktni2bn4example",
|
|
123
|
+
* DBInstanceIdentifier: "new-orcl-db",
|
|
124
|
+
* DbiResourceId: "db-JKIB2GFQ5RV7REPLZA4EXAMPLE",
|
|
125
|
+
* Encrypted: false,
|
|
126
|
+
* Engine: "oracle-se2",
|
|
127
|
+
* EngineVersion: "12.1.0.2.v21",
|
|
128
|
+
* IAMDatabaseAuthenticationEnabled: false,
|
|
129
|
+
* InstanceCreateTime: "2020-12-04T15:28:31Z",
|
|
130
|
+
* LicenseModel: "bring-your-own-license",
|
|
131
|
+
* MasterUsername: "admin",
|
|
132
|
+
* OptionGroupName: "default:oracle-se2-12-1",
|
|
133
|
+
* Port: 1521,
|
|
134
|
+
* Region: "us-east-1",
|
|
135
|
+
* RestoreWindow: {
|
|
136
|
+
* EarliestTime: "2020-12-04T23:13:21.030Z",
|
|
137
|
+
* LatestTime: "2020-12-07T19:59:57Z"
|
|
138
138
|
* },
|
|
139
|
-
*
|
|
140
|
-
*
|
|
139
|
+
* Status: "replicating",
|
|
140
|
+
* StorageType: "gp2"
|
|
141
141
|
* }
|
|
142
142
|
* }
|
|
143
143
|
* *\/
|
|
144
|
-
* // example id: to-stop-replicating-automated-backups-1679701787115
|
|
145
144
|
* ```
|
|
146
145
|
*
|
|
146
|
+
* @public
|
|
147
147
|
*/
|
|
148
148
|
export declare class StopDBInstanceAutomatedBackupsReplicationCommand extends StopDBInstanceAutomatedBackupsReplicationCommand_base {
|
|
149
149
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -309,25 +309,25 @@ declare const StopDBInstanceCommand_base: {
|
|
|
309
309
|
* @throws {@link RDSServiceException}
|
|
310
310
|
* <p>Base exception class for all service exceptions from RDS service.</p>
|
|
311
311
|
*
|
|
312
|
-
*
|
|
312
|
+
*
|
|
313
313
|
* @example To stop a DB instance
|
|
314
314
|
* ```javascript
|
|
315
315
|
* // The following example stops the specified DB instance.
|
|
316
316
|
* const input = {
|
|
317
|
-
*
|
|
317
|
+
* DBInstanceIdentifier: "test-instance"
|
|
318
318
|
* };
|
|
319
319
|
* const command = new StopDBInstanceCommand(input);
|
|
320
320
|
* const response = await client.send(command);
|
|
321
|
-
* /* response
|
|
321
|
+
* /* response is
|
|
322
322
|
* {
|
|
323
|
-
*
|
|
324
|
-
*
|
|
323
|
+
* DBInstance: {
|
|
324
|
+
* DBInstanceStatus: "stopping"
|
|
325
325
|
* }
|
|
326
326
|
* }
|
|
327
327
|
* *\/
|
|
328
|
-
* // example id: to-stop-a-db-instance-1679701630959
|
|
329
328
|
* ```
|
|
330
329
|
*
|
|
330
|
+
* @public
|
|
331
331
|
*/
|
|
332
332
|
export declare class StopDBInstanceCommand extends StopDBInstanceCommand_base {
|
|
333
333
|
/** @internal type navigation helper, not in runtime. */
|