@aws-sdk/client-rds 3.288.0 → 3.289.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.
Files changed (83) hide show
  1. package/dist-types/commands/AddSourceIdentifierToSubscriptionCommand.d.ts +17 -0
  2. package/dist-types/commands/AddTagsToResourceCommand.d.ts +17 -0
  3. package/dist-types/commands/ApplyPendingMaintenanceActionCommand.d.ts +18 -0
  4. package/dist-types/commands/AuthorizeDBSecurityGroupIngressCommand.d.ts +17 -0
  5. package/dist-types/commands/CopyDBClusterParameterGroupCommand.d.ts +18 -0
  6. package/dist-types/commands/CopyDBClusterSnapshotCommand.d.ts +17 -0
  7. package/dist-types/commands/CopyDBParameterGroupCommand.d.ts +18 -0
  8. package/dist-types/commands/CopyDBSnapshotCommand.d.ts +17 -0
  9. package/dist-types/commands/CopyOptionGroupCommand.d.ts +18 -0
  10. package/dist-types/commands/CreateDBClusterCommand.d.ts +28 -0
  11. package/dist-types/commands/CreateDBClusterParameterGroupCommand.d.ts +18 -0
  12. package/dist-types/commands/CreateDBClusterSnapshotCommand.d.ts +17 -0
  13. package/dist-types/commands/CreateDBInstanceCommand.d.ts +21 -0
  14. package/dist-types/commands/CreateDBInstanceReadReplicaCommand.d.ts +28 -0
  15. package/dist-types/commands/CreateDBParameterGroupCommand.d.ts +18 -0
  16. package/dist-types/commands/CreateDBSecurityGroupCommand.d.ts +17 -0
  17. package/dist-types/commands/CreateDBSnapshotCommand.d.ts +17 -0
  18. package/dist-types/commands/CreateDBSubnetGroupCommand.d.ts +21 -0
  19. package/dist-types/commands/CreateEventSubscriptionCommand.d.ts +25 -0
  20. package/dist-types/commands/CreateOptionGroupCommand.d.ts +19 -0
  21. package/dist-types/commands/DeleteDBClusterCommand.d.ts +17 -0
  22. package/dist-types/commands/DeleteDBClusterParameterGroupCommand.d.ts +11 -0
  23. package/dist-types/commands/DeleteDBClusterSnapshotCommand.d.ts +16 -0
  24. package/dist-types/commands/DeleteDBInstanceCommand.d.ts +17 -0
  25. package/dist-types/commands/DeleteDBParameterGroupCommand.d.ts +11 -0
  26. package/dist-types/commands/DeleteDBSecurityGroupCommand.d.ts +11 -0
  27. package/dist-types/commands/DeleteDBSnapshotCommand.d.ts +16 -0
  28. package/dist-types/commands/DeleteDBSubnetGroupCommand.d.ts +11 -0
  29. package/dist-types/commands/DeleteEventSubscriptionCommand.d.ts +16 -0
  30. package/dist-types/commands/DeleteOptionGroupCommand.d.ts +11 -0
  31. package/dist-types/commands/DescribeAccountAttributesCommand.d.ts +9 -0
  32. package/dist-types/commands/DescribeCertificatesCommand.d.ts +12 -0
  33. package/dist-types/commands/DescribeDBClusterParameterGroupsCommand.d.ts +11 -0
  34. package/dist-types/commands/DescribeDBClusterParametersCommand.d.ts +12 -0
  35. package/dist-types/commands/DescribeDBClusterSnapshotAttributesCommand.d.ts +16 -0
  36. package/dist-types/commands/DescribeDBClusterSnapshotsCommand.d.ts +12 -0
  37. package/dist-types/commands/DescribeDBClustersCommand.d.ts +11 -0
  38. package/dist-types/commands/DescribeDBEngineVersionsCommand.d.ts +15 -0
  39. package/dist-types/commands/DescribeDBInstancesCommand.d.ts +11 -0
  40. package/dist-types/commands/DescribeDBLogFilesCommand.d.ts +14 -0
  41. package/dist-types/commands/DescribeDBParameterGroupsCommand.d.ts +11 -0
  42. package/dist-types/commands/DescribeDBParametersCommand.d.ts +13 -0
  43. package/dist-types/commands/DescribeDBSecurityGroupsCommand.d.ts +11 -0
  44. package/dist-types/commands/DescribeDBSnapshotAttributesCommand.d.ts +16 -0
  45. package/dist-types/commands/DescribeDBSnapshotsCommand.d.ts +14 -0
  46. package/dist-types/commands/DescribeDBSubnetGroupsCommand.d.ts +11 -0
  47. package/dist-types/commands/DescribeEngineDefaultClusterParametersCommand.d.ts +16 -0
  48. package/dist-types/commands/DescribeEngineDefaultParametersCommand.d.ts +16 -0
  49. package/dist-types/commands/DescribeEventCategoriesCommand.d.ts +11 -0
  50. package/dist-types/commands/DescribeEventSubscriptionsCommand.d.ts +11 -0
  51. package/dist-types/commands/DescribeEventsCommand.d.ts +16 -0
  52. package/dist-types/commands/DescribeOptionGroupOptionsCommand.d.ts +12 -0
  53. package/dist-types/commands/DescribeOptionGroupsCommand.d.ts +12 -0
  54. package/dist-types/commands/DescribeOrderableDBInstanceOptionsCommand.d.ts +15 -0
  55. package/dist-types/commands/DescribePendingMaintenanceActionsCommand.d.ts +11 -0
  56. package/dist-types/commands/DescribeReservedDBInstancesCommand.d.ts +15 -0
  57. package/dist-types/commands/DescribeReservedDBInstancesOfferingsCommand.d.ts +15 -0
  58. package/dist-types/commands/DescribeSourceRegionsCommand.d.ts +65 -0
  59. package/dist-types/commands/DownloadDBLogFilePortionCommand.d.ts +12 -0
  60. package/dist-types/commands/FailoverDBClusterCommand.d.ts +17 -0
  61. package/dist-types/commands/ListTagsForResourceCommand.d.ts +11 -0
  62. package/dist-types/commands/ModifyDBClusterCommand.d.ts +21 -0
  63. package/dist-types/commands/ModifyDBClusterParameterGroupCommand.d.ts +18 -0
  64. package/dist-types/commands/ModifyDBClusterSnapshotAttributeCommand.d.ts +24 -0
  65. package/dist-types/commands/ModifyDBInstanceCommand.d.ts +23 -0
  66. package/dist-types/commands/ModifyDBParameterGroupCommand.d.ts +18 -0
  67. package/dist-types/commands/ModifyDBSnapshotAttributeCommand.d.ts +20 -0
  68. package/dist-types/commands/ModifyDBSubnetGroupCommand.d.ts +20 -0
  69. package/dist-types/commands/ModifyEventSubscriptionCommand.d.ts +22 -0
  70. package/dist-types/commands/ModifyOptionGroupCommand.d.ts +25 -0
  71. package/dist-types/commands/PromoteReadReplicaCommand.d.ts +18 -0
  72. package/dist-types/commands/PurchaseReservedDBInstancesOfferingCommand.d.ts +17 -0
  73. package/dist-types/commands/RebootDBInstanceCommand.d.ts +17 -0
  74. package/dist-types/commands/RemoveSourceIdentifierFromSubscriptionCommand.d.ts +17 -0
  75. package/dist-types/commands/RemoveTagsFromResourceCommand.d.ts +14 -0
  76. package/dist-types/commands/ResetDBClusterParameterGroupCommand.d.ts +12 -0
  77. package/dist-types/commands/ResetDBParameterGroupCommand.d.ts +12 -0
  78. package/dist-types/commands/RestoreDBClusterFromSnapshotCommand.d.ts +18 -0
  79. package/dist-types/commands/RestoreDBClusterToPointInTimeCommand.d.ts +18 -0
  80. package/dist-types/commands/RestoreDBInstanceFromDBSnapshotCommand.d.ts +93 -0
  81. package/dist-types/commands/RestoreDBInstanceToPointInTimeCommand.d.ts +94 -0
  82. package/dist-types/commands/RevokeDBSecurityGroupIngressCommand.d.ts +17 -0
  83. package/package.json +31 -31
@@ -29,6 +29,21 @@ export interface DescribeReservedDBInstancesOfferingsCommandOutput extends Reser
29
29
  * @see {@link DescribeReservedDBInstancesOfferingsCommandOutput} for command's `response` shape.
30
30
  * @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape.
31
31
  *
32
+ * @example To list information about reserved DB instance offerings
33
+ * ```javascript
34
+ * // This example lists information for all reserved DB instance offerings for the specified DB instance class, duration, product, offering type, and availability zone settings.
35
+ * const input = {
36
+ * "DBInstanceClass": "db.t2.micro",
37
+ * "Duration": "1y",
38
+ * "MultiAZ": false,
39
+ * "OfferingType": "No Upfront",
40
+ * "ProductDescription": "mysql"
41
+ * };
42
+ * const command = new DescribeReservedDBInstancesOfferingsCommand(input);
43
+ * await client.send(command);
44
+ * // example id: describe-reserved-db-instances-offerings-9de7d1fd-d6a6-4a72-84ae-b2ef58d47d8d
45
+ * ```
46
+ *
32
47
  */
33
48
  export declare class DescribeReservedDBInstancesOfferingsCommand extends $Command<DescribeReservedDBInstancesOfferingsCommandInput, DescribeReservedDBInstancesOfferingsCommandOutput, RDSClientResolvedConfig> {
34
49
  readonly input: DescribeReservedDBInstancesOfferingsCommandInput;
@@ -36,6 +36,71 @@ export interface DescribeSourceRegionsCommandOutput extends SourceRegionMessage,
36
36
  * @see {@link DescribeSourceRegionsCommandOutput} for command's `response` shape.
37
37
  * @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape.
38
38
  *
39
+ * @example To describe source regions
40
+ * ```javascript
41
+ * // To list the AWS regions where a Read Replica can be created.
42
+ * const input = {};
43
+ * const command = new DescribeSourceRegionsCommand(input);
44
+ * const response = await client.send(command);
45
+ * /* response ==
46
+ * {
47
+ * "SourceRegions": [
48
+ * {
49
+ * "Endpoint": "https://rds.ap-northeast-1.amazonaws.com",
50
+ * "RegionName": "ap-northeast-1",
51
+ * "Status": "available"
52
+ * },
53
+ * {
54
+ * "Endpoint": "https://rds.ap-northeast-2.amazonaws.com",
55
+ * "RegionName": "ap-northeast-2",
56
+ * "Status": "available"
57
+ * },
58
+ * {
59
+ * "Endpoint": "https://rds.ap-south-1.amazonaws.com",
60
+ * "RegionName": "ap-south-1",
61
+ * "Status": "available"
62
+ * },
63
+ * {
64
+ * "Endpoint": "https://rds.ap-southeast-1.amazonaws.com",
65
+ * "RegionName": "ap-southeast-1",
66
+ * "Status": "available"
67
+ * },
68
+ * {
69
+ * "Endpoint": "https://rds.ap-southeast-2.amazonaws.com",
70
+ * "RegionName": "ap-southeast-2",
71
+ * "Status": "available"
72
+ * },
73
+ * {
74
+ * "Endpoint": "https://rds.eu-central-1.amazonaws.com",
75
+ * "RegionName": "eu-central-1",
76
+ * "Status": "available"
77
+ * },
78
+ * {
79
+ * "Endpoint": "https://rds.eu-west-1.amazonaws.com",
80
+ * "RegionName": "eu-west-1",
81
+ * "Status": "available"
82
+ * },
83
+ * {
84
+ * "Endpoint": "https://rds.sa-east-1.amazonaws.com",
85
+ * "RegionName": "sa-east-1",
86
+ * "Status": "available"
87
+ * },
88
+ * {
89
+ * "Endpoint": "https://rds.us-west-1.amazonaws.com",
90
+ * "RegionName": "us-west-1",
91
+ * "Status": "available"
92
+ * },
93
+ * {
94
+ * "Endpoint": "https://rds.us-west-2.amazonaws.com",
95
+ * "RegionName": "us-west-2",
96
+ * "Status": "available"
97
+ * }
98
+ * ]
99
+ * }
100
+ * *\/
101
+ * // example id: to-describe-source-regions-1473457722410
102
+ * ```
103
+ *
39
104
  */
40
105
  export declare class DescribeSourceRegionsCommand extends $Command<DescribeSourceRegionsCommandInput, DescribeSourceRegionsCommandOutput, RDSClientResolvedConfig> {
41
106
  readonly input: DescribeSourceRegionsCommandInput;
@@ -30,6 +30,18 @@ export interface DownloadDBLogFilePortionCommandOutput extends DownloadDBLogFile
30
30
  * @see {@link DownloadDBLogFilePortionCommandOutput} for command's `response` shape.
31
31
  * @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape.
32
32
  *
33
+ * @example To list information about DB log files
34
+ * ```javascript
35
+ * // This example lists information for the specified log file for the specified DB instance.
36
+ * const input = {
37
+ * "DBInstanceIdentifier": "mymysqlinstance",
38
+ * "LogFileName": "mysqlUpgrade"
39
+ * };
40
+ * const command = new DownloadDBLogFilePortionCommand(input);
41
+ * await client.send(command);
42
+ * // example id: download-db-log-file-portion-54a82731-a441-4fc7-a010-8eccae6fa202
43
+ * ```
44
+ *
33
45
  */
34
46
  export declare class DownloadDBLogFilePortionCommand extends $Command<DownloadDBLogFilePortionCommandInput, DownloadDBLogFilePortionCommandOutput, RDSClientResolvedConfig> {
35
47
  readonly input: DownloadDBLogFilePortionCommandInput;
@@ -45,6 +45,23 @@ export interface FailoverDBClusterCommandOutput extends FailoverDBClusterResult,
45
45
  * @see {@link FailoverDBClusterCommandOutput} for command's `response` shape.
46
46
  * @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape.
47
47
  *
48
+ * @example To perform a failover for a DB cluster
49
+ * ```javascript
50
+ * // This example performs a failover for the specified DB cluster to the specified DB instance.
51
+ * const input = {
52
+ * "DBClusterIdentifier": "myaurorainstance-cluster",
53
+ * "TargetDBInstanceIdentifier": "myaurorareplica"
54
+ * };
55
+ * const command = new FailoverDBClusterCommand(input);
56
+ * const response = await client.send(command);
57
+ * /* response ==
58
+ * {
59
+ * "DBCluster": {}
60
+ * }
61
+ * *\/
62
+ * // example id: failover-db-cluster-9e7f2f93-d98c-42c7-bb0e-d6c485c096d6
63
+ * ```
64
+ *
48
65
  */
49
66
  export declare class FailoverDBClusterCommand extends $Command<FailoverDBClusterCommandInput, FailoverDBClusterCommandOutput, RDSClientResolvedConfig> {
50
67
  readonly input: FailoverDBClusterCommandInput;
@@ -32,6 +32,17 @@ export interface ListTagsForResourceCommandOutput extends TagListMessage, __Meta
32
32
  * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape.
33
33
  * @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape.
34
34
  *
35
+ * @example To list information about tags associated with a resource
36
+ * ```javascript
37
+ * // This example lists information about all tags associated with the specified DB option group.
38
+ * const input = {
39
+ * "ResourceName": "arn:aws:rds:us-east-1:992648334831:og:mymysqloptiongroup"
40
+ * };
41
+ * const command = new ListTagsForResourceCommand(input);
42
+ * await client.send(command);
43
+ * // example id: list-tags-for-resource-8401f3c2-77cd-4f90-bfd5-b523f0adcc2f
44
+ * ```
45
+ *
35
46
  */
36
47
  export declare class ListTagsForResourceCommand extends $Command<ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput, RDSClientResolvedConfig> {
37
48
  readonly input: ListTagsForResourceCommandInput;
@@ -37,6 +37,27 @@ export interface ModifyDBClusterCommandOutput extends ModifyDBClusterResult, __M
37
37
  * @see {@link ModifyDBClusterCommandOutput} for command's `response` shape.
38
38
  * @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape.
39
39
  *
40
+ * @example To change DB cluster settings
41
+ * ```javascript
42
+ * // This example changes the specified settings for the specified DB cluster.
43
+ * const input = {
44
+ * "ApplyImmediately": true,
45
+ * "DBClusterIdentifier": "mydbcluster",
46
+ * "MasterUserPassword": "mynewpassword",
47
+ * "NewDBClusterIdentifier": "mynewdbcluster",
48
+ * "PreferredBackupWindow": "04:00-04:30",
49
+ * "PreferredMaintenanceWindow": "Tue:05:00-Tue:05:30"
50
+ * };
51
+ * const command = new ModifyDBClusterCommand(input);
52
+ * const response = await client.send(command);
53
+ * /* response ==
54
+ * {
55
+ * "DBCluster": {}
56
+ * }
57
+ * *\/
58
+ * // example id: modify-db-cluster-a370ee1b-768d-450a-853b-707cb1ab663d
59
+ * ```
60
+ *
40
61
  */
41
62
  export declare class ModifyDBClusterCommand extends $Command<ModifyDBClusterCommandInput, ModifyDBClusterCommandOutput, RDSClientResolvedConfig> {
42
63
  readonly input: ModifyDBClusterCommandInput;
@@ -54,6 +54,24 @@ export interface ModifyDBClusterParameterGroupCommandOutput extends DBClusterPar
54
54
  * @see {@link ModifyDBClusterParameterGroupCommandOutput} for command's `response` shape.
55
55
  * @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape.
56
56
  *
57
+ * @example To change DB cluster parameter group settings
58
+ * ```javascript
59
+ * // This example immediately changes the specified setting for the specified DB cluster parameter group.
60
+ * const input = {
61
+ * "DBClusterParameterGroupName": "mydbclusterparametergroup",
62
+ * "Parameters": [
63
+ * {
64
+ * "ApplyMethod": "immediate",
65
+ * "ParameterName": "time_zone",
66
+ * "ParameterValue": "America/Phoenix"
67
+ * }
68
+ * ]
69
+ * };
70
+ * const command = new ModifyDBClusterParameterGroupCommand(input);
71
+ * await client.send(command);
72
+ * // example id: modify-db-cluster-parameter-group-f9156bc9-082a-442e-8d12-239542c1a113
73
+ * ```
74
+ *
57
75
  */
58
76
  export declare class ModifyDBClusterParameterGroupCommand extends $Command<ModifyDBClusterParameterGroupCommandInput, ModifyDBClusterParameterGroupCommandOutput, RDSClientResolvedConfig> {
59
77
  readonly input: ModifyDBClusterParameterGroupCommandInput;
@@ -47,6 +47,30 @@ export interface ModifyDBClusterSnapshotAttributeCommandOutput extends ModifyDBC
47
47
  * @see {@link ModifyDBClusterSnapshotAttributeCommandOutput} for command's `response` shape.
48
48
  * @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape.
49
49
  *
50
+ * @example To add or remove access to a manual DB cluster snapshot
51
+ * ```javascript
52
+ * // The following example gives two AWS accounts access to a manual DB cluster snapshot and ensures that the DB cluster snapshot is private by removing the value "all".
53
+ * const input = {
54
+ * "AttributeName": "restore",
55
+ * "DBClusterSnapshotIdentifier": "manual-cluster-snapshot1",
56
+ * "ValuesToAdd": [
57
+ * "123451234512",
58
+ * "123456789012"
59
+ * ],
60
+ * "ValuesToRemove": [
61
+ * "all"
62
+ * ]
63
+ * };
64
+ * const command = new ModifyDBClusterSnapshotAttributeCommand(input);
65
+ * const response = await client.send(command);
66
+ * /* response ==
67
+ * {
68
+ * "DBClusterSnapshotAttributesResult": {}
69
+ * }
70
+ * *\/
71
+ * // example id: to-add-or-remove-access-to-a-manual-db-cluster-snapshot-1473889426431
72
+ * ```
73
+ *
50
74
  */
51
75
  export declare class ModifyDBClusterSnapshotAttributeCommand extends $Command<ModifyDBClusterSnapshotAttributeCommandInput, ModifyDBClusterSnapshotAttributeCommandOutput, RDSClientResolvedConfig> {
52
76
  readonly input: ModifyDBClusterSnapshotAttributeCommandInput;
@@ -33,6 +33,29 @@ export interface ModifyDBInstanceCommandOutput extends ModifyDBInstanceResult, _
33
33
  * @see {@link ModifyDBInstanceCommandOutput} for command's `response` shape.
34
34
  * @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape.
35
35
  *
36
+ * @example To change DB instance settings
37
+ * ```javascript
38
+ * // This example immediately changes the specified settings for the specified DB instance.
39
+ * const input = {
40
+ * "AllocatedStorage": 10,
41
+ * "ApplyImmediately": true,
42
+ * "BackupRetentionPeriod": 1,
43
+ * "DBInstanceClass": "db.t2.small",
44
+ * "DBInstanceIdentifier": "mymysqlinstance",
45
+ * "MasterUserPassword": "mynewpassword",
46
+ * "PreferredBackupWindow": "04:00-04:30",
47
+ * "PreferredMaintenanceWindow": "Tue:05:00-Tue:05:30"
48
+ * };
49
+ * const command = new ModifyDBInstanceCommand(input);
50
+ * const response = await client.send(command);
51
+ * /* response ==
52
+ * {
53
+ * "DBInstance": {}
54
+ * }
55
+ * *\/
56
+ * // example id: modify-db-instance-6979a368-6254-467b-8a8d-61103f4fcde9
57
+ * ```
58
+ *
36
59
  */
37
60
  export declare class ModifyDBInstanceCommand extends $Command<ModifyDBInstanceCommandInput, ModifyDBInstanceCommandOutput, RDSClientResolvedConfig> {
38
61
  readonly input: ModifyDBInstanceCommandInput;
@@ -42,6 +42,24 @@ export interface ModifyDBParameterGroupCommandOutput extends DBParameterGroupNam
42
42
  * @see {@link ModifyDBParameterGroupCommandOutput} for command's `response` shape.
43
43
  * @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape.
44
44
  *
45
+ * @example To change DB parameter group settings
46
+ * ```javascript
47
+ * // This example immediately changes the specified setting for the specified DB parameter group.
48
+ * const input = {
49
+ * "DBParameterGroupName": "mymysqlparametergroup",
50
+ * "Parameters": [
51
+ * {
52
+ * "ApplyMethod": "immediate",
53
+ * "ParameterName": "time_zone",
54
+ * "ParameterValue": "America/Phoenix"
55
+ * }
56
+ * ]
57
+ * };
58
+ * const command = new ModifyDBParameterGroupCommand(input);
59
+ * await client.send(command);
60
+ * // example id: modify-db-parameter-group-f3a4e52a-68e4-4b88-b559-f912d34c457a
61
+ * ```
62
+ *
45
63
  */
46
64
  export declare class ModifyDBParameterGroupCommand extends $Command<ModifyDBParameterGroupCommandInput, ModifyDBParameterGroupCommandOutput, RDSClientResolvedConfig> {
47
65
  readonly input: ModifyDBParameterGroupCommandInput;
@@ -45,6 +45,26 @@ export interface ModifyDBSnapshotAttributeCommandOutput extends ModifyDBSnapshot
45
45
  * @see {@link ModifyDBSnapshotAttributeCommandOutput} for command's `response` shape.
46
46
  * @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape.
47
47
  *
48
+ * @example To change DB snapshot attributes
49
+ * ```javascript
50
+ * // This example adds the specified attribute for the specified DB snapshot.
51
+ * const input = {
52
+ * "AttributeName": "restore",
53
+ * "DBSnapshotIdentifier": "mydbsnapshot",
54
+ * "ValuesToAdd": [
55
+ * "all"
56
+ * ]
57
+ * };
58
+ * const command = new ModifyDBSnapshotAttributeCommand(input);
59
+ * const response = await client.send(command);
60
+ * /* response ==
61
+ * {
62
+ * "DBSnapshotAttributesResult": {}
63
+ * }
64
+ * *\/
65
+ * // example id: modify-db-snapshot-attribute-2e66f120-2b21-4a7c-890b-4474da88bde6
66
+ * ```
67
+ *
48
68
  */
49
69
  export declare class ModifyDBSnapshotAttributeCommand extends $Command<ModifyDBSnapshotAttributeCommandInput, ModifyDBSnapshotAttributeCommandOutput, RDSClientResolvedConfig> {
50
70
  readonly input: ModifyDBSnapshotAttributeCommandInput;
@@ -29,6 +29,26 @@ export interface ModifyDBSubnetGroupCommandOutput extends ModifyDBSubnetGroupRes
29
29
  * @see {@link ModifyDBSubnetGroupCommandOutput} for command's `response` shape.
30
30
  * @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape.
31
31
  *
32
+ * @example To change DB subnet group settings
33
+ * ```javascript
34
+ * // This example changes the specified setting for the specified DB subnet group.
35
+ * const input = {
36
+ * "DBSubnetGroupName": "mydbsubnetgroup",
37
+ * "SubnetIds": [
38
+ * "subnet-70e1975a",
39
+ * "subnet-747a5c49"
40
+ * ]
41
+ * };
42
+ * const command = new ModifyDBSubnetGroupCommand(input);
43
+ * const response = await client.send(command);
44
+ * /* response ==
45
+ * {
46
+ * "DBSubnetGroup": {}
47
+ * }
48
+ * *\/
49
+ * // example id: modify-db-subnet-group-e34a97d9-8fe6-4239-a4ed-ad6e73a956b0
50
+ * ```
51
+ *
32
52
  */
33
53
  export declare class ModifyDBSubnetGroupCommand extends $Command<ModifyDBSubnetGroupCommandInput, ModifyDBSubnetGroupCommandOutput, RDSClientResolvedConfig> {
34
54
  readonly input: ModifyDBSubnetGroupCommandInput;
@@ -33,6 +33,28 @@ export interface ModifyEventSubscriptionCommandOutput extends ModifyEventSubscri
33
33
  * @see {@link ModifyEventSubscriptionCommandOutput} for command's `response` shape.
34
34
  * @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape.
35
35
  *
36
+ * @example To change event notification subscription settings
37
+ * ```javascript
38
+ * // This example changes the specified setting for the specified event notification subscription.
39
+ * const input = {
40
+ * "Enabled": true,
41
+ * "EventCategories": [
42
+ * "deletion",
43
+ * "low storage"
44
+ * ],
45
+ * "SourceType": "db-instance",
46
+ * "SubscriptionName": "mymysqleventsubscription"
47
+ * };
48
+ * const command = new ModifyEventSubscriptionCommand(input);
49
+ * const response = await client.send(command);
50
+ * /* response ==
51
+ * {
52
+ * "EventSubscription": {}
53
+ * }
54
+ * *\/
55
+ * // example id: modify-event-subscription-405ac869-1f02-42cd-b8f4-6950a435f30e
56
+ * ```
57
+ *
36
58
  */
37
59
  export declare class ModifyEventSubscriptionCommand extends $Command<ModifyEventSubscriptionCommandInput, ModifyEventSubscriptionCommandOutput, RDSClientResolvedConfig> {
38
60
  readonly input: ModifyEventSubscriptionCommandInput;
@@ -29,6 +29,31 @@ export interface ModifyOptionGroupCommandOutput extends ModifyOptionGroupResult,
29
29
  * @see {@link ModifyOptionGroupCommandOutput} for command's `response` shape.
30
30
  * @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape.
31
31
  *
32
+ * @example To modify an option group
33
+ * ```javascript
34
+ * // The following example adds an option to an option group.
35
+ * const input = {
36
+ * "ApplyImmediately": true,
37
+ * "OptionGroupName": "myawsuser-og02",
38
+ * "OptionsToInclude": [
39
+ * {
40
+ * "DBSecurityGroupMemberships": [
41
+ * "default"
42
+ * ],
43
+ * "OptionName": "MEMCACHED"
44
+ * }
45
+ * ]
46
+ * };
47
+ * const command = new ModifyOptionGroupCommand(input);
48
+ * const response = await client.send(command);
49
+ * /* response ==
50
+ * {
51
+ * "OptionGroup": {}
52
+ * }
53
+ * *\/
54
+ * // example id: to-modify-an-option-group-1473890247875
55
+ * ```
56
+ *
32
57
  */
33
58
  export declare class ModifyOptionGroupCommand extends $Command<ModifyOptionGroupCommandInput, ModifyOptionGroupCommandOutput, RDSClientResolvedConfig> {
34
59
  readonly input: ModifyOptionGroupCommandInput;
@@ -46,6 +46,24 @@ export interface PromoteReadReplicaCommandOutput extends PromoteReadReplicaResul
46
46
  * @see {@link PromoteReadReplicaCommandOutput} for command's `response` shape.
47
47
  * @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape.
48
48
  *
49
+ * @example To promote a read replica
50
+ * ```javascript
51
+ * // This example promotes the specified read replica and sets its backup retention period and preferred backup window.
52
+ * const input = {
53
+ * "BackupRetentionPeriod": 1,
54
+ * "DBInstanceIdentifier": "mydbreadreplica",
55
+ * "PreferredBackupWindow": "03:30-04:00"
56
+ * };
57
+ * const command = new PromoteReadReplicaCommand(input);
58
+ * const response = await client.send(command);
59
+ * /* response ==
60
+ * {
61
+ * "DBInstance": {}
62
+ * }
63
+ * *\/
64
+ * // example id: promote-read-replica-cc580039-c55d-4035-838a-def4a1ae4181
65
+ * ```
66
+ *
49
67
  */
50
68
  export declare class PromoteReadReplicaCommand extends $Command<PromoteReadReplicaCommandInput, PromoteReadReplicaCommandOutput, RDSClientResolvedConfig> {
51
69
  readonly input: PromoteReadReplicaCommandInput;
@@ -29,6 +29,23 @@ export interface PurchaseReservedDBInstancesOfferingCommandOutput extends Purcha
29
29
  * @see {@link PurchaseReservedDBInstancesOfferingCommandOutput} for command's `response` shape.
30
30
  * @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape.
31
31
  *
32
+ * @example To purchase a reserved DB instance offering
33
+ * ```javascript
34
+ * // This example purchases a reserved DB instance offering that matches the specified settings.
35
+ * const input = {
36
+ * "ReservedDBInstanceId": "myreservationid",
37
+ * "ReservedDBInstancesOfferingId": "fb29428a-646d-4390-850e-5fe89926e727"
38
+ * };
39
+ * const command = new PurchaseReservedDBInstancesOfferingCommand(input);
40
+ * const response = await client.send(command);
41
+ * /* response ==
42
+ * {
43
+ * "ReservedDBInstance": {}
44
+ * }
45
+ * *\/
46
+ * // example id: purchase-reserved-db-instances-offfering-f423c736-8413-429b-ba13-850fd4fa4dcd
47
+ * ```
48
+ *
32
49
  */
33
50
  export declare class PurchaseReservedDBInstancesOfferingCommand extends $Command<PurchaseReservedDBInstancesOfferingCommandInput, PurchaseReservedDBInstancesOfferingCommandOutput, RDSClientResolvedConfig> {
34
51
  readonly input: PurchaseReservedDBInstancesOfferingCommandInput;
@@ -38,6 +38,23 @@ export interface RebootDBInstanceCommandOutput extends RebootDBInstanceResult, _
38
38
  * @see {@link RebootDBInstanceCommandOutput} for command's `response` shape.
39
39
  * @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape.
40
40
  *
41
+ * @example To reboot a DB instance
42
+ * ```javascript
43
+ * // This example reboots the specified DB instance without forcing a failover.
44
+ * const input = {
45
+ * "DBInstanceIdentifier": "mymysqlinstance",
46
+ * "ForceFailover": false
47
+ * };
48
+ * const command = new RebootDBInstanceCommand(input);
49
+ * const response = await client.send(command);
50
+ * /* response ==
51
+ * {
52
+ * "DBInstance": {}
53
+ * }
54
+ * *\/
55
+ * // example id: reboot-db-instance-b9ce8a0a-2920-451d-a1f3-01d288aa7366
56
+ * ```
57
+ *
41
58
  */
42
59
  export declare class RebootDBInstanceCommand extends $Command<RebootDBInstanceCommandInput, RebootDBInstanceCommandOutput, RDSClientResolvedConfig> {
43
60
  readonly input: RebootDBInstanceCommandInput;
@@ -29,6 +29,23 @@ export interface RemoveSourceIdentifierFromSubscriptionCommandOutput extends Rem
29
29
  * @see {@link RemoveSourceIdentifierFromSubscriptionCommandOutput} for command's `response` shape.
30
30
  * @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape.
31
31
  *
32
+ * @example To remove a source identifier from a DB event subscription
33
+ * ```javascript
34
+ * // This example removes the specified source identifier from the specified DB event subscription.
35
+ * const input = {
36
+ * "SourceIdentifier": "mymysqlinstance",
37
+ * "SubscriptionName": "myeventsubscription"
38
+ * };
39
+ * const command = new RemoveSourceIdentifierFromSubscriptionCommand(input);
40
+ * const response = await client.send(command);
41
+ * /* response ==
42
+ * {
43
+ * "EventSubscription": {}
44
+ * }
45
+ * *\/
46
+ * // example id: remove-source-identifier-from-subscription-30d25493-c19d-4cf7-b4e5-68371d0d8770
47
+ * ```
48
+ *
32
49
  */
33
50
  export declare class RemoveSourceIdentifierFromSubscriptionCommand extends $Command<RemoveSourceIdentifierFromSubscriptionCommandInput, RemoveSourceIdentifierFromSubscriptionCommandOutput, RDSClientResolvedConfig> {
34
51
  readonly input: RemoveSourceIdentifierFromSubscriptionCommandInput;
@@ -33,6 +33,20 @@ export interface RemoveTagsFromResourceCommandOutput extends __MetadataBearer {
33
33
  * @see {@link RemoveTagsFromResourceCommandOutput} for command's `response` shape.
34
34
  * @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape.
35
35
  *
36
+ * @example To remove tags from a resource
37
+ * ```javascript
38
+ * // This example removes the specified tag associated with the specified DB option group.
39
+ * const input = {
40
+ * "ResourceName": "arn:aws:rds:us-east-1:992648334831:og:mydboptiongroup",
41
+ * "TagKeys": [
42
+ * "MyKey"
43
+ * ]
44
+ * };
45
+ * const command = new RemoveTagsFromResourceCommand(input);
46
+ * await client.send(command);
47
+ * // example id: remove-tags-from-resource-49f00574-38f6-4d01-ac89-d3c668449ce3
48
+ * ```
49
+ *
36
50
  */
37
51
  export declare class RemoveTagsFromResourceCommand extends $Command<RemoveTagsFromResourceCommandInput, RemoveTagsFromResourceCommandOutput, RDSClientResolvedConfig> {
38
52
  readonly input: RemoveTagsFromResourceCommandInput;
@@ -44,6 +44,18 @@ export interface ResetDBClusterParameterGroupCommandOutput extends DBClusterPara
44
44
  * @see {@link ResetDBClusterParameterGroupCommandOutput} for command's `response` shape.
45
45
  * @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape.
46
46
  *
47
+ * @example To reset the values of a DB cluster parameter group
48
+ * ```javascript
49
+ * // This example resets all parameters for the specified DB cluster parameter group to their default values.
50
+ * const input = {
51
+ * "DBClusterParameterGroupName": "mydbclusterparametergroup",
52
+ * "ResetAllParameters": true
53
+ * };
54
+ * const command = new ResetDBClusterParameterGroupCommand(input);
55
+ * await client.send(command);
56
+ * // example id: reset-db-cluster-parameter-group-b04aeaf7-7f73-49e1-9bb4-857573ea3ee4
57
+ * ```
58
+ *
47
59
  */
48
60
  export declare class ResetDBClusterParameterGroupCommand extends $Command<ResetDBClusterParameterGroupCommandInput, ResetDBClusterParameterGroupCommandOutput, RDSClientResolvedConfig> {
49
61
  readonly input: ResetDBClusterParameterGroupCommandInput;
@@ -36,6 +36,18 @@ export interface ResetDBParameterGroupCommandOutput extends DBParameterGroupName
36
36
  * @see {@link ResetDBParameterGroupCommandOutput} for command's `response` shape.
37
37
  * @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape.
38
38
  *
39
+ * @example To reset the values of a DB parameter group
40
+ * ```javascript
41
+ * // This example resets all parameters for the specified DB parameter group to their default values.
42
+ * const input = {
43
+ * "DBParameterGroupName": "mydbparametergroup",
44
+ * "ResetAllParameters": true
45
+ * };
46
+ * const command = new ResetDBParameterGroupCommand(input);
47
+ * await client.send(command);
48
+ * // example id: reset-db-parameter-group-ed2ed723-de0d-4824-8af5-3c65fa130abf
49
+ * ```
50
+ *
39
51
  */
40
52
  export declare class ResetDBParameterGroupCommand extends $Command<ResetDBParameterGroupCommandInput, ResetDBParameterGroupCommandOutput, RDSClientResolvedConfig> {
41
53
  readonly input: ResetDBParameterGroupCommandInput;
@@ -47,6 +47,24 @@ export interface RestoreDBClusterFromSnapshotCommandOutput extends RestoreDBClus
47
47
  * @see {@link RestoreDBClusterFromSnapshotCommandOutput} for command's `response` shape.
48
48
  * @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape.
49
49
  *
50
+ * @example To restore an Amazon Aurora DB cluster from a DB cluster snapshot
51
+ * ```javascript
52
+ * // The following example restores an Amazon Aurora DB cluster from a DB cluster snapshot.
53
+ * const input = {
54
+ * "DBClusterIdentifier": "restored-cluster1",
55
+ * "Engine": "aurora",
56
+ * "SnapshotIdentifier": "sample-cluster-snapshot1"
57
+ * };
58
+ * const command = new RestoreDBClusterFromSnapshotCommand(input);
59
+ * const response = await client.send(command);
60
+ * /* response ==
61
+ * {
62
+ * "DBCluster": {}
63
+ * }
64
+ * *\/
65
+ * // example id: to-restore-an-amazon-aurora-db-cluster-from-a-db-cluster-snapshot-1473958144325
66
+ * ```
67
+ *
50
68
  */
51
69
  export declare class RestoreDBClusterFromSnapshotCommand extends $Command<RestoreDBClusterFromSnapshotCommandInput, RestoreDBClusterFromSnapshotCommandOutput, RDSClientResolvedConfig> {
52
70
  readonly input: RestoreDBClusterFromSnapshotCommandInput;
@@ -48,6 +48,24 @@ export interface RestoreDBClusterToPointInTimeCommandOutput extends RestoreDBClu
48
48
  * @see {@link RestoreDBClusterToPointInTimeCommandOutput} for command's `response` shape.
49
49
  * @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape.
50
50
  *
51
+ * @example To restore a DB cluster to a point in time.
52
+ * ```javascript
53
+ * // The following example restores a DB cluster to a new DB cluster at a point in time from the source DB cluster.
54
+ * const input = {
55
+ * "DBClusterIdentifier": "sample-restored-cluster1",
56
+ * "RestoreToTime": "2016-09-13T18:45:00Z",
57
+ * "SourceDBClusterIdentifier": "sample-cluster1"
58
+ * };
59
+ * const command = new RestoreDBClusterToPointInTimeCommand(input);
60
+ * const response = await client.send(command);
61
+ * /* response ==
62
+ * {
63
+ * "DBCluster": {}
64
+ * }
65
+ * *\/
66
+ * // example id: to-restore-a-db-cluster-to-a-point-in-time-1473962082214
67
+ * ```
68
+ *
51
69
  */
52
70
  export declare class RestoreDBClusterToPointInTimeCommand extends $Command<RestoreDBClusterToPointInTimeCommandInput, RestoreDBClusterToPointInTimeCommandOutput, RDSClientResolvedConfig> {
53
71
  readonly input: RestoreDBClusterToPointInTimeCommandInput;