@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,23 @@ export interface AddSourceIdentifierToSubscriptionCommandOutput extends AddSourc
29
29
  * @see {@link AddSourceIdentifierToSubscriptionCommandOutput} for command's `response` shape.
30
30
  * @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape.
31
31
  *
32
+ * @example To add a source identifier to an event notification subscription
33
+ * ```javascript
34
+ * // This example add a source identifier to an event notification subscription.
35
+ * const input = {
36
+ * "SourceIdentifier": "mymysqlinstance",
37
+ * "SubscriptionName": "mymysqleventsubscription"
38
+ * };
39
+ * const command = new AddSourceIdentifierToSubscriptionCommand(input);
40
+ * const response = await client.send(command);
41
+ * /* response ==
42
+ * {
43
+ * "EventSubscription": {}
44
+ * }
45
+ * *\/
46
+ * // example id: add-source-identifier-to-subscription-93fb6a15-0a59-4577-a7b5-e12db9752c14
47
+ * ```
48
+ *
32
49
  */
33
50
  export declare class AddSourceIdentifierToSubscriptionCommand extends $Command<AddSourceIdentifierToSubscriptionCommandInput, AddSourceIdentifierToSubscriptionCommandOutput, RDSClientResolvedConfig> {
34
51
  readonly input: AddSourceIdentifierToSubscriptionCommandInput;
@@ -31,6 +31,23 @@ export interface AddTagsToResourceCommandOutput extends __MetadataBearer {
31
31
  * @see {@link AddTagsToResourceCommandOutput} for command's `response` shape.
32
32
  * @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape.
33
33
  *
34
+ * @example To add tags to a resource
35
+ * ```javascript
36
+ * // This example adds a tag to an option group.
37
+ * const input = {
38
+ * "ResourceName": "arn:aws:rds:us-east-1:992648334831:og:mymysqloptiongroup",
39
+ * "Tags": [
40
+ * {
41
+ * "Key": "Staging",
42
+ * "Value": "LocationDB"
43
+ * }
44
+ * ]
45
+ * };
46
+ * const command = new AddTagsToResourceCommand(input);
47
+ * await client.send(command);
48
+ * // example id: add-tags-to-resource-fa99ef50-228b-449d-b893-ca4d4e9768ab
49
+ * ```
50
+ *
34
51
  */
35
52
  export declare class AddTagsToResourceCommand extends $Command<AddTagsToResourceCommandInput, AddTagsToResourceCommandOutput, RDSClientResolvedConfig> {
36
53
  readonly input: AddTagsToResourceCommandInput;
@@ -29,6 +29,24 @@ export interface ApplyPendingMaintenanceActionCommandOutput extends ApplyPending
29
29
  * @see {@link ApplyPendingMaintenanceActionCommandOutput} for command's `response` shape.
30
30
  * @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape.
31
31
  *
32
+ * @example To apply a pending maintenance action
33
+ * ```javascript
34
+ * // This example immediately applies a pending system update to a DB instance.
35
+ * const input = {
36
+ * "ApplyAction": "system-update",
37
+ * "OptInType": "immediate",
38
+ * "ResourceIdentifier": "arn:aws:rds:us-east-1:992648334831:db:mymysqlinstance"
39
+ * };
40
+ * const command = new ApplyPendingMaintenanceActionCommand(input);
41
+ * const response = await client.send(command);
42
+ * /* response ==
43
+ * {
44
+ * "ResourcePendingMaintenanceActions": {}
45
+ * }
46
+ * *\/
47
+ * // example id: apply-pending-maintenance-action-2a026047-8bbb-47fc-b695-abad9f308c24
48
+ * ```
49
+ *
32
50
  */
33
51
  export declare class ApplyPendingMaintenanceActionCommand extends $Command<ApplyPendingMaintenanceActionCommandInput, ApplyPendingMaintenanceActionCommandOutput, RDSClientResolvedConfig> {
34
52
  readonly input: ApplyPendingMaintenanceActionCommandInput;
@@ -44,6 +44,23 @@ export interface AuthorizeDBSecurityGroupIngressCommandOutput extends AuthorizeD
44
44
  * @see {@link AuthorizeDBSecurityGroupIngressCommandOutput} for command's `response` shape.
45
45
  * @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape.
46
46
  *
47
+ * @example To authorize DB security group integress
48
+ * ```javascript
49
+ * // This example authorizes access to the specified security group by the specified CIDR block.
50
+ * const input = {
51
+ * "CIDRIP": "203.0.113.5/32",
52
+ * "DBSecurityGroupName": "mydbsecuritygroup"
53
+ * };
54
+ * const command = new AuthorizeDBSecurityGroupIngressCommand(input);
55
+ * const response = await client.send(command);
56
+ * /* response ==
57
+ * {
58
+ * "DBSecurityGroup": {}
59
+ * }
60
+ * *\/
61
+ * // example id: authorize-db-security-group-ingress-ebf9ab91-8912-4b07-a32e-ca150668164f
62
+ * ```
63
+ *
47
64
  */
48
65
  export declare class AuthorizeDBSecurityGroupIngressCommand extends $Command<AuthorizeDBSecurityGroupIngressCommandInput, AuthorizeDBSecurityGroupIngressCommandOutput, RDSClientResolvedConfig> {
49
66
  readonly input: AuthorizeDBSecurityGroupIngressCommandInput;
@@ -29,6 +29,24 @@ export interface CopyDBClusterParameterGroupCommandOutput extends CopyDBClusterP
29
29
  * @see {@link CopyDBClusterParameterGroupCommandOutput} for command's `response` shape.
30
30
  * @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape.
31
31
  *
32
+ * @example To copy a DB cluster parameter group
33
+ * ```javascript
34
+ * // This example copies a DB cluster parameter group.
35
+ * const input = {
36
+ * "SourceDBClusterParameterGroupIdentifier": "mydbclusterparametergroup",
37
+ * "TargetDBClusterParameterGroupDescription": "My DB cluster parameter group copy",
38
+ * "TargetDBClusterParameterGroupIdentifier": "mydbclusterparametergroup-copy"
39
+ * };
40
+ * const command = new CopyDBClusterParameterGroupCommand(input);
41
+ * const response = await client.send(command);
42
+ * /* response ==
43
+ * {
44
+ * "DBClusterParameterGroup": {}
45
+ * }
46
+ * *\/
47
+ * // example id: copy-db-cluster-parameter-group-6fefaffe-cde9-4dba-9f0b-d3f593572fe4
48
+ * ```
49
+ *
32
50
  */
33
51
  export declare class CopyDBClusterParameterGroupCommand extends $Command<CopyDBClusterParameterGroupCommandInput, CopyDBClusterParameterGroupCommandOutput, RDSClientResolvedConfig> {
34
52
  readonly input: CopyDBClusterParameterGroupCommandInput;
@@ -65,6 +65,23 @@ export interface CopyDBClusterSnapshotCommandOutput extends CopyDBClusterSnapsho
65
65
  * @see {@link CopyDBClusterSnapshotCommandOutput} for command's `response` shape.
66
66
  * @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape.
67
67
  *
68
+ * @example To copy a DB cluster snapshot
69
+ * ```javascript
70
+ * // The following example copies an automated snapshot of a DB cluster to a new DB cluster snapshot.
71
+ * const input = {
72
+ * "SourceDBClusterSnapshotIdentifier": "rds:sample-cluster-2016-09-14-10-38",
73
+ * "TargetDBClusterSnapshotIdentifier": "cluster-snapshot-copy-1"
74
+ * };
75
+ * const command = new CopyDBClusterSnapshotCommand(input);
76
+ * const response = await client.send(command);
77
+ * /* response ==
78
+ * {
79
+ * "DBClusterSnapshot": {}
80
+ * }
81
+ * *\/
82
+ * // example id: to-copy-a-db-cluster-snapshot-1473879770564
83
+ * ```
84
+ *
68
85
  */
69
86
  export declare class CopyDBClusterSnapshotCommand extends $Command<CopyDBClusterSnapshotCommandInput, CopyDBClusterSnapshotCommandOutput, RDSClientResolvedConfig> {
70
87
  readonly input: CopyDBClusterSnapshotCommandInput;
@@ -29,6 +29,24 @@ export interface CopyDBParameterGroupCommandOutput extends CopyDBParameterGroupR
29
29
  * @see {@link CopyDBParameterGroupCommandOutput} for command's `response` shape.
30
30
  * @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape.
31
31
  *
32
+ * @example To copy a DB parameter group
33
+ * ```javascript
34
+ * // This example copies a DB parameter group.
35
+ * const input = {
36
+ * "SourceDBParameterGroupIdentifier": "mymysqlparametergroup",
37
+ * "TargetDBParameterGroupDescription": "My MySQL parameter group copy",
38
+ * "TargetDBParameterGroupIdentifier": "mymysqlparametergroup-copy"
39
+ * };
40
+ * const command = new CopyDBParameterGroupCommand(input);
41
+ * const response = await client.send(command);
42
+ * /* response ==
43
+ * {
44
+ * "DBParameterGroup": {}
45
+ * }
46
+ * *\/
47
+ * // example id: copy-db-parameter-group-610d4dba-2c87-467f-ae5d-edd7f8e47349
48
+ * ```
49
+ *
32
50
  */
33
51
  export declare class CopyDBParameterGroupCommand extends $Command<CopyDBParameterGroupCommandInput, CopyDBParameterGroupCommandOutput, RDSClientResolvedConfig> {
34
52
  readonly input: CopyDBParameterGroupCommandInput;
@@ -35,6 +35,23 @@ export interface CopyDBSnapshotCommandOutput extends CopyDBSnapshotResult, __Met
35
35
  * @see {@link CopyDBSnapshotCommandOutput} for command's `response` shape.
36
36
  * @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape.
37
37
  *
38
+ * @example To copy a DB snapshot
39
+ * ```javascript
40
+ * // This example copies a DB snapshot.
41
+ * const input = {
42
+ * "SourceDBSnapshotIdentifier": "mydbsnapshot",
43
+ * "TargetDBSnapshotIdentifier": "mydbsnapshot-copy"
44
+ * };
45
+ * const command = new CopyDBSnapshotCommand(input);
46
+ * const response = await client.send(command);
47
+ * /* response ==
48
+ * {
49
+ * "DBSnapshot": {}
50
+ * }
51
+ * *\/
52
+ * // example id: copy-db-snapshot-1b2f0210-bc67-415d-9822-6eecf447dc86
53
+ * ```
54
+ *
38
55
  */
39
56
  export declare class CopyDBSnapshotCommand extends $Command<CopyDBSnapshotCommandInput, CopyDBSnapshotCommandOutput, RDSClientResolvedConfig> {
40
57
  readonly input: CopyDBSnapshotCommandInput;
@@ -29,6 +29,24 @@ export interface CopyOptionGroupCommandOutput extends CopyOptionGroupResult, __M
29
29
  * @see {@link CopyOptionGroupCommandOutput} for command's `response` shape.
30
30
  * @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape.
31
31
  *
32
+ * @example To copy an option group
33
+ * ```javascript
34
+ * // This example copies an option group.
35
+ * const input = {
36
+ * "SourceOptionGroupIdentifier": "mymysqloptiongroup",
37
+ * "TargetOptionGroupDescription": "My MySQL option group copy",
38
+ * "TargetOptionGroupIdentifier": "mymysqloptiongroup-copy"
39
+ * };
40
+ * const command = new CopyOptionGroupCommand(input);
41
+ * const response = await client.send(command);
42
+ * /* response ==
43
+ * {
44
+ * "OptionGroup": {}
45
+ * }
46
+ * *\/
47
+ * // example id: copy-option-group-8d5c01c3-8846-4e9c-a4b0-1b7237f7d0ec
48
+ * ```
49
+ *
32
50
  */
33
51
  export declare class CopyOptionGroupCommand extends $Command<CopyOptionGroupCommandInput, CopyOptionGroupCommandOutput, RDSClientResolvedConfig> {
34
52
  readonly input: CopyOptionGroupCommandInput;
@@ -37,6 +37,34 @@ export interface CreateDBClusterCommandOutput extends CreateDBClusterResult, __M
37
37
  * @see {@link CreateDBClusterCommandOutput} for command's `response` shape.
38
38
  * @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape.
39
39
  *
40
+ * @example To create a DB cluster
41
+ * ```javascript
42
+ * // This example creates a DB cluster.
43
+ * const input = {
44
+ * "AvailabilityZones": [
45
+ * "us-east-1a"
46
+ * ],
47
+ * "BackupRetentionPeriod": 1,
48
+ * "DBClusterIdentifier": "mydbcluster",
49
+ * "DBClusterParameterGroupName": "mydbclusterparametergroup",
50
+ * "DatabaseName": "myauroradb",
51
+ * "Engine": "aurora",
52
+ * "EngineVersion": "5.6.10a",
53
+ * "MasterUserPassword": "mypassword",
54
+ * "MasterUsername": "myuser",
55
+ * "Port": 3306,
56
+ * "StorageEncrypted": true
57
+ * };
58
+ * const command = new CreateDBClusterCommand(input);
59
+ * const response = await client.send(command);
60
+ * /* response ==
61
+ * {
62
+ * "DBCluster": {}
63
+ * }
64
+ * *\/
65
+ * // example id: create-db-cluster-423b998d-eba9-40dd-8e19-96c5b6e5f31d
66
+ * ```
67
+ *
40
68
  */
41
69
  export declare class CreateDBClusterCommand extends $Command<CreateDBClusterCommandInput, CreateDBClusterCommandOutput, RDSClientResolvedConfig> {
42
70
  readonly input: CreateDBClusterCommandInput;
@@ -58,6 +58,24 @@ export interface CreateDBClusterParameterGroupCommandOutput extends CreateDBClus
58
58
  * @see {@link CreateDBClusterParameterGroupCommandOutput} for command's `response` shape.
59
59
  * @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape.
60
60
  *
61
+ * @example To create a DB cluster parameter group
62
+ * ```javascript
63
+ * // This example creates a DB cluster parameter group.
64
+ * const input = {
65
+ * "DBClusterParameterGroupName": "mydbclusterparametergroup",
66
+ * "DBParameterGroupFamily": "aurora5.6",
67
+ * "Description": "My DB cluster parameter group"
68
+ * };
69
+ * const command = new CreateDBClusterParameterGroupCommand(input);
70
+ * const response = await client.send(command);
71
+ * /* response ==
72
+ * {
73
+ * "DBClusterParameterGroup": {}
74
+ * }
75
+ * *\/
76
+ * // example id: create-db-cluster-parameter-group-8eb1c3ae-1965-4262-afe3-ee134c4430b1
77
+ * ```
78
+ *
61
79
  */
62
80
  export declare class CreateDBClusterParameterGroupCommand extends $Command<CreateDBClusterParameterGroupCommandInput, CreateDBClusterParameterGroupCommandOutput, RDSClientResolvedConfig> {
63
81
  readonly input: CreateDBClusterParameterGroupCommandInput;
@@ -34,6 +34,23 @@ export interface CreateDBClusterSnapshotCommandOutput extends CreateDBClusterSna
34
34
  * @see {@link CreateDBClusterSnapshotCommandOutput} for command's `response` shape.
35
35
  * @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape.
36
36
  *
37
+ * @example To create a DB cluster snapshot
38
+ * ```javascript
39
+ * // This example creates a DB cluster snapshot.
40
+ * const input = {
41
+ * "DBClusterIdentifier": "mydbcluster",
42
+ * "DBClusterSnapshotIdentifier": "mydbclustersnapshot"
43
+ * };
44
+ * const command = new CreateDBClusterSnapshotCommand(input);
45
+ * const response = await client.send(command);
46
+ * /* response ==
47
+ * {
48
+ * "DBClusterSnapshot": {}
49
+ * }
50
+ * *\/
51
+ * // example id: create-db-cluster-snapshot-
52
+ * ```
53
+ *
37
54
  */
38
55
  export declare class CreateDBClusterSnapshotCommand extends $Command<CreateDBClusterSnapshotCommandInput, CreateDBClusterSnapshotCommandOutput, RDSClientResolvedConfig> {
39
56
  readonly input: CreateDBClusterSnapshotCommandInput;
@@ -37,6 +37,27 @@ export interface CreateDBInstanceCommandOutput extends CreateDBInstanceResult, _
37
37
  * @see {@link CreateDBInstanceCommandOutput} for command's `response` shape.
38
38
  * @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape.
39
39
  *
40
+ * @example To create a DB instance.
41
+ * ```javascript
42
+ * // This example creates a DB instance.
43
+ * const input = {
44
+ * "AllocatedStorage": 5,
45
+ * "DBInstanceClass": "db.t2.micro",
46
+ * "DBInstanceIdentifier": "mymysqlinstance",
47
+ * "Engine": "MySQL",
48
+ * "MasterUserPassword": "MyPassword",
49
+ * "MasterUsername": "MyUser"
50
+ * };
51
+ * const command = new CreateDBInstanceCommand(input);
52
+ * const response = await client.send(command);
53
+ * /* response ==
54
+ * {
55
+ * "DBInstance": {}
56
+ * }
57
+ * *\/
58
+ * // example id: create-db-instance-57eb5d16-8bf8-4c84-9709-1700322b37b9
59
+ * ```
60
+ *
40
61
  */
41
62
  export declare class CreateDBInstanceCommand extends $Command<CreateDBInstanceCommandInput, CreateDBInstanceCommandOutput, RDSClientResolvedConfig> {
42
63
  readonly input: CreateDBInstanceCommandInput;
@@ -40,6 +40,34 @@ export interface CreateDBInstanceReadReplicaCommandOutput extends CreateDBInstan
40
40
  * @see {@link CreateDBInstanceReadReplicaCommandOutput} for command's `response` shape.
41
41
  * @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape.
42
42
  *
43
+ * @example To create a DB instance read replica.
44
+ * ```javascript
45
+ * // This example creates a DB instance read replica.
46
+ * const input = {
47
+ * "AvailabilityZone": "us-east-1a",
48
+ * "CopyTagsToSnapshot": true,
49
+ * "DBInstanceClass": "db.t2.micro",
50
+ * "DBInstanceIdentifier": "mydbreadreplica",
51
+ * "PubliclyAccessible": true,
52
+ * "SourceDBInstanceIdentifier": "mymysqlinstance",
53
+ * "StorageType": "gp2",
54
+ * "Tags": [
55
+ * {
56
+ * "Key": "mydbreadreplicakey",
57
+ * "Value": "mydbreadreplicavalue"
58
+ * }
59
+ * ]
60
+ * };
61
+ * const command = new CreateDBInstanceReadReplicaCommand(input);
62
+ * const response = await client.send(command);
63
+ * /* response ==
64
+ * {
65
+ * "DBInstance": {}
66
+ * }
67
+ * *\/
68
+ * // example id: create-db-instance-read-replica-81b41cd5-2871-4dae-bc59-3e264449d5fe
69
+ * ```
70
+ *
43
71
  */
44
72
  export declare class CreateDBInstanceReadReplicaCommand extends $Command<CreateDBInstanceReadReplicaCommandInput, CreateDBInstanceReadReplicaCommandOutput, RDSClientResolvedConfig> {
45
73
  readonly input: CreateDBInstanceReadReplicaCommandInput;
@@ -48,6 +48,24 @@ export interface CreateDBParameterGroupCommandOutput extends CreateDBParameterGr
48
48
  * @see {@link CreateDBParameterGroupCommandOutput} for command's `response` shape.
49
49
  * @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape.
50
50
  *
51
+ * @example To create a DB parameter group.
52
+ * ```javascript
53
+ * // This example creates a DB parameter group.
54
+ * const input = {
55
+ * "DBParameterGroupFamily": "mysql5.6",
56
+ * "DBParameterGroupName": "mymysqlparametergroup",
57
+ * "Description": "My MySQL parameter group"
58
+ * };
59
+ * const command = new CreateDBParameterGroupCommand(input);
60
+ * const response = await client.send(command);
61
+ * /* response ==
62
+ * {
63
+ * "DBParameterGroup": {}
64
+ * }
65
+ * *\/
66
+ * // example id: create-db-parameter-group-42afcc37-12e9-4b6a-a55c-b8a141246e87
67
+ * ```
68
+ *
51
69
  */
52
70
  export declare class CreateDBParameterGroupCommand extends $Command<CreateDBParameterGroupCommandInput, CreateDBParameterGroupCommandOutput, RDSClientResolvedConfig> {
53
71
  readonly input: CreateDBParameterGroupCommandInput;
@@ -37,6 +37,23 @@ export interface CreateDBSecurityGroupCommandOutput extends CreateDBSecurityGrou
37
37
  * @see {@link CreateDBSecurityGroupCommandOutput} for command's `response` shape.
38
38
  * @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape.
39
39
  *
40
+ * @example To create a DB security group.
41
+ * ```javascript
42
+ * // This example creates a DB security group.
43
+ * const input = {
44
+ * "DBSecurityGroupDescription": "My DB security group",
45
+ * "DBSecurityGroupName": "mydbsecuritygroup"
46
+ * };
47
+ * const command = new CreateDBSecurityGroupCommand(input);
48
+ * const response = await client.send(command);
49
+ * /* response ==
50
+ * {
51
+ * "DBSecurityGroup": {}
52
+ * }
53
+ * *\/
54
+ * // example id: create-db-security-group-41b6786a-539e-42a5-a645-a8bc3cf99353
55
+ * ```
56
+ *
40
57
  */
41
58
  export declare class CreateDBSecurityGroupCommand extends $Command<CreateDBSecurityGroupCommandInput, CreateDBSecurityGroupCommandOutput, RDSClientResolvedConfig> {
42
59
  readonly input: CreateDBSecurityGroupCommandInput;
@@ -30,6 +30,23 @@ export interface CreateDBSnapshotCommandOutput extends CreateDBSnapshotResult, _
30
30
  * @see {@link CreateDBSnapshotCommandOutput} for command's `response` shape.
31
31
  * @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape.
32
32
  *
33
+ * @example To create a DB snapshot.
34
+ * ```javascript
35
+ * // This example creates a DB snapshot.
36
+ * const input = {
37
+ * "DBInstanceIdentifier": "mymysqlinstance",
38
+ * "DBSnapshotIdentifier": "mydbsnapshot"
39
+ * };
40
+ * const command = new CreateDBSnapshotCommand(input);
41
+ * const response = await client.send(command);
42
+ * /* response ==
43
+ * {
44
+ * "DBSnapshot": {}
45
+ * }
46
+ * *\/
47
+ * // example id: create-db-snapshot-e10e0e2c-9ac4-426d-9b17-6b6a3e382ce2
48
+ * ```
49
+ *
33
50
  */
34
51
  export declare class CreateDBSnapshotCommand extends $Command<CreateDBSnapshotCommandInput, CreateDBSnapshotCommandOutput, RDSClientResolvedConfig> {
35
52
  readonly input: CreateDBSnapshotCommandInput;
@@ -29,6 +29,27 @@ export interface CreateDBSubnetGroupCommandOutput extends CreateDBSubnetGroupRes
29
29
  * @see {@link CreateDBSubnetGroupCommandOutput} for command's `response` shape.
30
30
  * @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape.
31
31
  *
32
+ * @example To create a DB subnet group.
33
+ * ```javascript
34
+ * // This example creates a DB subnet group.
35
+ * const input = {
36
+ * "DBSubnetGroupDescription": "My DB subnet group",
37
+ * "DBSubnetGroupName": "mydbsubnetgroup",
38
+ * "SubnetIds": [
39
+ * "subnet-1fab8a69",
40
+ * "subnet-d43a468c"
41
+ * ]
42
+ * };
43
+ * const command = new CreateDBSubnetGroupCommand(input);
44
+ * const response = await client.send(command);
45
+ * /* response ==
46
+ * {
47
+ * "DBSubnetGroup": {}
48
+ * }
49
+ * *\/
50
+ * // example id: create-db-subnet-group-c3d162c2-0ec4-4955-ba89-18967615fdb8
51
+ * ```
52
+ *
32
53
  */
33
54
  export declare class CreateDBSubnetGroupCommand extends $Command<CreateDBSubnetGroupCommandInput, CreateDBSubnetGroupCommandOutput, RDSClientResolvedConfig> {
34
55
  readonly input: CreateDBSubnetGroupCommandInput;
@@ -52,6 +52,31 @@ export interface CreateEventSubscriptionCommandOutput extends CreateEventSubscri
52
52
  * @see {@link CreateEventSubscriptionCommandOutput} for command's `response` shape.
53
53
  * @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape.
54
54
  *
55
+ * @example To create an event notification subscription
56
+ * ```javascript
57
+ * // This example creates an event notification subscription.
58
+ * const input = {
59
+ * "Enabled": true,
60
+ * "EventCategories": [
61
+ * "availability"
62
+ * ],
63
+ * "SnsTopicArn": "arn:aws:sns:us-east-1:992648334831:MyDemoSNSTopic",
64
+ * "SourceIds": [
65
+ * "mymysqlinstance"
66
+ * ],
67
+ * "SourceType": "db-instance",
68
+ * "SubscriptionName": "mymysqleventsubscription"
69
+ * };
70
+ * const command = new CreateEventSubscriptionCommand(input);
71
+ * const response = await client.send(command);
72
+ * /* response ==
73
+ * {
74
+ * "EventSubscription": {}
75
+ * }
76
+ * *\/
77
+ * // example id: create-event-subscription-00dd0ee6-0e0f-4a38-ae83-e5f2ded5f69a
78
+ * ```
79
+ *
55
80
  */
56
81
  export declare class CreateEventSubscriptionCommand extends $Command<CreateEventSubscriptionCommandInput, CreateEventSubscriptionCommandOutput, RDSClientResolvedConfig> {
57
82
  readonly input: CreateEventSubscriptionCommandInput;
@@ -30,6 +30,25 @@ export interface CreateOptionGroupCommandOutput extends CreateOptionGroupResult,
30
30
  * @see {@link CreateOptionGroupCommandOutput} for command's `response` shape.
31
31
  * @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape.
32
32
  *
33
+ * @example To create an option group
34
+ * ```javascript
35
+ * // This example creates an option group.
36
+ * const input = {
37
+ * "EngineName": "MySQL",
38
+ * "MajorEngineVersion": "5.6",
39
+ * "OptionGroupDescription": "My MySQL 5.6 option group",
40
+ * "OptionGroupName": "mymysqloptiongroup"
41
+ * };
42
+ * const command = new CreateOptionGroupCommand(input);
43
+ * const response = await client.send(command);
44
+ * /* response ==
45
+ * {
46
+ * "OptionGroup": {}
47
+ * }
48
+ * *\/
49
+ * // example id: create-option-group-a7708c87-1b79-4a5e-a762-21cf8fc62b78
50
+ * ```
51
+ *
33
52
  */
34
53
  export declare class CreateOptionGroupCommand extends $Command<CreateOptionGroupCommandInput, CreateOptionGroupCommandOutput, RDSClientResolvedConfig> {
35
54
  readonly input: CreateOptionGroupCommandInput;
@@ -37,6 +37,23 @@ export interface DeleteDBClusterCommandOutput extends DeleteDBClusterResult, __M
37
37
  * @see {@link DeleteDBClusterCommandOutput} for command's `response` shape.
38
38
  * @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape.
39
39
  *
40
+ * @example To delete a DB cluster.
41
+ * ```javascript
42
+ * // This example deletes the specified DB cluster.
43
+ * const input = {
44
+ * "DBClusterIdentifier": "mydbcluster",
45
+ * "SkipFinalSnapshot": true
46
+ * };
47
+ * const command = new DeleteDBClusterCommand(input);
48
+ * const response = await client.send(command);
49
+ * /* response ==
50
+ * {
51
+ * "DBCluster": {}
52
+ * }
53
+ * *\/
54
+ * // example id: delete-db-cluster-927fc2c8-6c67-4075-b1ba-75490be0f7d6
55
+ * ```
56
+ *
40
57
  */
41
58
  export declare class DeleteDBClusterCommand extends $Command<DeleteDBClusterCommandInput, DeleteDBClusterCommandOutput, RDSClientResolvedConfig> {
42
59
  readonly input: DeleteDBClusterCommandInput;
@@ -35,6 +35,17 @@ export interface DeleteDBClusterParameterGroupCommandOutput extends __MetadataBe
35
35
  * @see {@link DeleteDBClusterParameterGroupCommandOutput} for command's `response` shape.
36
36
  * @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape.
37
37
  *
38
+ * @example To delete a DB cluster parameter group.
39
+ * ```javascript
40
+ * // This example deletes the specified DB cluster parameter group.
41
+ * const input = {
42
+ * "DBClusterParameterGroupName": "mydbclusterparametergroup"
43
+ * };
44
+ * const command = new DeleteDBClusterParameterGroupCommand(input);
45
+ * await client.send(command);
46
+ * // example id: delete-db-cluster-parameter-group-364f5555-ba0a-4cc8-979c-e769098924fc
47
+ * ```
48
+ *
38
49
  */
39
50
  export declare class DeleteDBClusterParameterGroupCommand extends $Command<DeleteDBClusterParameterGroupCommandInput, DeleteDBClusterParameterGroupCommandOutput, RDSClientResolvedConfig> {
40
51
  readonly input: DeleteDBClusterParameterGroupCommandInput;
@@ -39,6 +39,22 @@ export interface DeleteDBClusterSnapshotCommandOutput extends DeleteDBClusterSna
39
39
  * @see {@link DeleteDBClusterSnapshotCommandOutput} for command's `response` shape.
40
40
  * @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape.
41
41
  *
42
+ * @example To delete a DB cluster snapshot.
43
+ * ```javascript
44
+ * // This example deletes the specified DB cluster snapshot.
45
+ * const input = {
46
+ * "DBClusterSnapshotIdentifier": "mydbclustersnapshot"
47
+ * };
48
+ * const command = new DeleteDBClusterSnapshotCommand(input);
49
+ * const response = await client.send(command);
50
+ * /* response ==
51
+ * {
52
+ * "DBClusterSnapshot": {}
53
+ * }
54
+ * *\/
55
+ * // example id: delete-db-cluster-snapshot-c67e0d95-670e-4fb5-af90-6d9a70a91b07
56
+ * ```
57
+ *
42
58
  */
43
59
  export declare class DeleteDBClusterSnapshotCommand extends $Command<DeleteDBClusterSnapshotCommandInput, DeleteDBClusterSnapshotCommandOutput, RDSClientResolvedConfig> {
44
60
  readonly input: DeleteDBClusterSnapshotCommandInput;
@@ -51,6 +51,23 @@ export interface DeleteDBInstanceCommandOutput extends DeleteDBInstanceResult, _
51
51
  * @see {@link DeleteDBInstanceCommandOutput} for command's `response` shape.
52
52
  * @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape.
53
53
  *
54
+ * @example To delete a DB instance.
55
+ * ```javascript
56
+ * // This example deletes the specified DB instance.
57
+ * const input = {
58
+ * "DBInstanceIdentifier": "mymysqlinstance",
59
+ * "SkipFinalSnapshot": true
60
+ * };
61
+ * const command = new DeleteDBInstanceCommand(input);
62
+ * const response = await client.send(command);
63
+ * /* response ==
64
+ * {
65
+ * "DBInstance": {}
66
+ * }
67
+ * *\/
68
+ * // example id: delete-db-instance-4412e650-949c-488a-b32a-7d3038ebccc4
69
+ * ```
70
+ *
54
71
  */
55
72
  export declare class DeleteDBInstanceCommand extends $Command<DeleteDBInstanceCommandInput, DeleteDBInstanceCommandOutput, RDSClientResolvedConfig> {
56
73
  readonly input: DeleteDBInstanceCommandInput;
@@ -29,6 +29,17 @@ export interface DeleteDBParameterGroupCommandOutput extends __MetadataBearer {
29
29
  * @see {@link DeleteDBParameterGroupCommandOutput} for command's `response` shape.
30
30
  * @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape.
31
31
  *
32
+ * @example To delete a DB parameter group
33
+ * ```javascript
34
+ * // The following example deletes a DB parameter group.
35
+ * const input = {
36
+ * "DBParameterGroupName": "mydbparamgroup3"
37
+ * };
38
+ * const command = new DeleteDBParameterGroupCommand(input);
39
+ * await client.send(command);
40
+ * // example id: to-delete-a-db-parameter-group-1473888796509
41
+ * ```
42
+ *
32
43
  */
33
44
  export declare class DeleteDBParameterGroupCommand extends $Command<DeleteDBParameterGroupCommandInput, DeleteDBParameterGroupCommandOutput, RDSClientResolvedConfig> {
34
45
  readonly input: DeleteDBParameterGroupCommandInput;