@aws-sdk/client-rds 3.271.0 → 3.276.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-cjs/endpoint/ruleset.js +3 -3
- package/dist-es/endpoint/ruleset.js +3 -3
- package/dist-types/RDS.d.ts +78 -71
- package/dist-types/commands/CancelExportTaskCommand.d.ts +1 -1
- package/dist-types/commands/CopyDBClusterSnapshotCommand.d.ts +3 -3
- package/dist-types/commands/CreateDBClusterCommand.d.ts +6 -7
- package/dist-types/commands/CreateDBClusterParameterGroupCommand.d.ts +3 -3
- package/dist-types/commands/CreateDBClusterSnapshotCommand.d.ts +3 -3
- package/dist-types/commands/DeleteBlueGreenDeploymentCommand.d.ts +2 -2
- package/dist-types/commands/DeleteCustomDBEngineVersionCommand.d.ts +2 -2
- package/dist-types/commands/DeleteDBClusterCommand.d.ts +3 -3
- package/dist-types/commands/DeleteDBClusterParameterGroupCommand.d.ts +3 -3
- package/dist-types/commands/DeleteDBClusterSnapshotCommand.d.ts +3 -3
- package/dist-types/commands/DescribeDBClusterParameterGroupsCommand.d.ts +3 -3
- package/dist-types/commands/DescribeDBClusterParametersCommand.d.ts +3 -3
- package/dist-types/commands/DescribeDBClusterSnapshotsCommand.d.ts +3 -3
- package/dist-types/commands/DescribeDBClustersCommand.d.ts +3 -3
- package/dist-types/commands/DescribeExportTasksCommand.d.ts +1 -1
- package/dist-types/commands/FailoverDBClusterCommand.d.ts +3 -3
- package/dist-types/commands/ModifyActivityStreamCommand.d.ts +1 -1
- package/dist-types/commands/ModifyDBClusterCommand.d.ts +3 -3
- package/dist-types/commands/ModifyDBClusterParameterGroupCommand.d.ts +3 -3
- package/dist-types/commands/RebootDBClusterCommand.d.ts +3 -4
- package/dist-types/commands/RemoveRoleFromDBClusterCommand.d.ts +3 -3
- package/dist-types/commands/ResetDBClusterParameterGroupCommand.d.ts +3 -3
- package/dist-types/commands/RestoreDBClusterFromSnapshotCommand.d.ts +3 -3
- package/dist-types/commands/RestoreDBClusterToPointInTimeCommand.d.ts +3 -3
- package/dist-types/commands/StartExportTaskCommand.d.ts +11 -2
- package/dist-types/endpoint/EndpointParameters.d.ts +1 -1
- package/dist-types/models/models_0.d.ts +56 -22
- package/dist-types/models/models_1.d.ts +31 -31
- package/dist-types/ts3.4/endpoint/EndpointParameters.d.ts +1 -1
- package/package.json +32 -32
|
@@ -12,9 +12,9 @@ export interface DescribeDBClusterSnapshotsCommandOutput extends DBClusterSnapsh
|
|
|
12
12
|
* <p>For more information on Amazon Aurora DB clusters, see
|
|
13
13
|
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html">
|
|
14
14
|
* What is Amazon Aurora?</a> in the <i>Amazon Aurora User Guide</i>.</p>
|
|
15
|
-
* <p>For more information on Multi-AZ DB clusters, see
|
|
16
|
-
*
|
|
17
|
-
*
|
|
15
|
+
* <p>For more information on Multi-AZ DB clusters, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html"> Multi-AZ DB
|
|
16
|
+
* cluster deployments</a> in the <i>Amazon RDS User
|
|
17
|
+
* Guide</i>.</p>
|
|
18
18
|
* @example
|
|
19
19
|
* Use a bare-bones client and the command you need to make an API call.
|
|
20
20
|
* ```javascript
|
|
@@ -12,9 +12,9 @@ export interface DescribeDBClustersCommandOutput extends DBClusterMessage, __Met
|
|
|
12
12
|
* <p>For more information on Amazon Aurora DB clusters, see
|
|
13
13
|
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html">
|
|
14
14
|
* What is Amazon Aurora?</a> in the <i>Amazon Aurora User Guide</i>.</p>
|
|
15
|
-
* <p>For more information on Multi-AZ DB clusters, see
|
|
16
|
-
*
|
|
17
|
-
*
|
|
15
|
+
* <p>For more information on Multi-AZ DB clusters, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html"> Multi-AZ DB
|
|
16
|
+
* cluster deployments</a> in the <i>Amazon RDS User
|
|
17
|
+
* Guide</i>.</p>
|
|
18
18
|
* <p>This operation can also return information for Amazon Neptune DB instances and Amazon DocumentDB instances.</p>
|
|
19
19
|
* @example
|
|
20
20
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -8,7 +8,7 @@ export interface DescribeExportTasksCommandInput extends DescribeExportTasksMess
|
|
|
8
8
|
export interface DescribeExportTasksCommandOutput extends ExportTasksMessage, __MetadataBearer {
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
|
-
* <p>Returns information about a snapshot export to Amazon S3. This API operation supports
|
|
11
|
+
* <p>Returns information about a snapshot or cluster export to Amazon S3. This API operation supports
|
|
12
12
|
* pagination.</p>
|
|
13
13
|
* @example
|
|
14
14
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -22,9 +22,9 @@ export interface FailoverDBClusterCommandOutput extends FailoverDBClusterResult,
|
|
|
22
22
|
* <p>For more information on Amazon Aurora DB clusters, see
|
|
23
23
|
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html">
|
|
24
24
|
* What is Amazon Aurora?</a> in the <i>Amazon Aurora User Guide</i>.</p>
|
|
25
|
-
* <p>For more information on Multi-AZ DB clusters, see
|
|
26
|
-
*
|
|
27
|
-
*
|
|
25
|
+
* <p>For more information on Multi-AZ DB clusters, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html"> Multi-AZ DB
|
|
26
|
+
* cluster deployments</a> in the <i>Amazon RDS User
|
|
27
|
+
* Guide</i>.</p>
|
|
28
28
|
* @example
|
|
29
29
|
* Use a bare-bones client and the command you need to make an API call.
|
|
30
30
|
* ```javascript
|
|
@@ -12,7 +12,7 @@ export interface ModifyActivityStreamCommandOutput extends ModifyActivityStreamR
|
|
|
12
12
|
* whereas an unlocked policy is read/write. If your activity stream is started and locked, you can unlock it, customize your audit policy,
|
|
13
13
|
* and then lock your activity stream. Restarting the activity stream isn't required. For more information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/DBActivityStreams.Modifying.html"> Modifying a database activity stream</a> in the
|
|
14
14
|
* <i>Amazon RDS User Guide</i>. </p>
|
|
15
|
-
* <p>This operation is supported for RDS for Oracle
|
|
15
|
+
* <p>This operation is supported for RDS for Oracle and Microsoft SQL Server.</p>
|
|
16
16
|
* @example
|
|
17
17
|
* Use a bare-bones client and the command you need to make an API call.
|
|
18
18
|
* ```javascript
|
|
@@ -14,9 +14,9 @@ export interface ModifyDBClusterCommandOutput extends ModifyDBClusterResult, __M
|
|
|
14
14
|
* <p>For more information on Amazon Aurora DB clusters, see
|
|
15
15
|
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html">
|
|
16
16
|
* What is Amazon Aurora?</a> in the <i>Amazon Aurora User Guide</i>.</p>
|
|
17
|
-
* <p>For more information on Multi-AZ DB clusters, see
|
|
18
|
-
*
|
|
19
|
-
*
|
|
17
|
+
* <p>For more information on Multi-AZ DB clusters, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html"> Multi-AZ DB
|
|
18
|
+
* cluster deployments</a> in the <i>Amazon RDS User
|
|
19
|
+
* Guide</i>.</p>
|
|
20
20
|
* @example
|
|
21
21
|
* Use a bare-bones client and the command you need to make an API call.
|
|
22
22
|
* ```javascript
|
|
@@ -30,9 +30,9 @@ export interface ModifyDBClusterParameterGroupCommandOutput extends DBClusterPar
|
|
|
30
30
|
* <p>For more information on Amazon Aurora DB clusters, see
|
|
31
31
|
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html">
|
|
32
32
|
* What is Amazon Aurora?</a> in the <i>Amazon Aurora User Guide</i>.</p>
|
|
33
|
-
* <p>For more information on Multi-AZ DB clusters, see
|
|
34
|
-
*
|
|
35
|
-
*
|
|
33
|
+
* <p>For more information on Multi-AZ DB clusters, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html"> Multi-AZ DB
|
|
34
|
+
* cluster deployments</a> in the <i>Amazon RDS User
|
|
35
|
+
* Guide.</i>
|
|
36
36
|
* </p>
|
|
37
37
|
* @example
|
|
38
38
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -15,10 +15,9 @@ export interface RebootDBClusterCommandOutput extends RebootDBClusterResult, __M
|
|
|
15
15
|
* <p>Rebooting a DB cluster restarts the database engine service. Rebooting a DB
|
|
16
16
|
* cluster results in a momentary outage, during which the DB cluster status is set to rebooting.</p>
|
|
17
17
|
* <p>Use this operation only for a non-Aurora Multi-AZ DB cluster.</p>
|
|
18
|
-
* <p>For more information on Multi-AZ DB clusters, see
|
|
19
|
-
*
|
|
20
|
-
*
|
|
21
|
-
* <i>Amazon RDS User Guide.</i>
|
|
18
|
+
* <p>For more information on Multi-AZ DB clusters, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html"> Multi-AZ DB
|
|
19
|
+
* cluster deployments</a> in the <i>Amazon RDS User
|
|
20
|
+
* Guide.</i>
|
|
22
21
|
* </p>
|
|
23
22
|
* @example
|
|
24
23
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -13,9 +13,9 @@ export interface RemoveRoleFromDBClusterCommandOutput extends __MetadataBearer {
|
|
|
13
13
|
* <p>For more information on Amazon Aurora DB clusters, see
|
|
14
14
|
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html">
|
|
15
15
|
* What is Amazon Aurora?</a> in the <i>Amazon Aurora User Guide</i>.</p>
|
|
16
|
-
* <p>For more information on Multi-AZ DB clusters, see
|
|
17
|
-
*
|
|
18
|
-
*
|
|
16
|
+
* <p>For more information on Multi-AZ DB clusters, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html"> Multi-AZ DB
|
|
17
|
+
* cluster deployments</a> in the <i>Amazon RDS User
|
|
18
|
+
* Guide.</i>
|
|
19
19
|
* </p>
|
|
20
20
|
* @example
|
|
21
21
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -20,9 +20,9 @@ export interface ResetDBClusterParameterGroupCommandOutput extends DBClusterPara
|
|
|
20
20
|
* <p>For more information on Amazon Aurora DB clusters, see
|
|
21
21
|
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html">
|
|
22
22
|
* What is Amazon Aurora?</a> in the <i>Amazon Aurora User Guide</i>.</p>
|
|
23
|
-
* <p>For more information on Multi-AZ DB clusters, see
|
|
24
|
-
*
|
|
25
|
-
*
|
|
23
|
+
* <p>For more information on Multi-AZ DB clusters, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html"> Multi-AZ DB
|
|
24
|
+
* cluster deployments</a> in the <i>Amazon RDS User
|
|
25
|
+
* Guide.</i>
|
|
26
26
|
* </p>
|
|
27
27
|
* @example
|
|
28
28
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -23,9 +23,9 @@ export interface RestoreDBClusterFromSnapshotCommandOutput extends RestoreDBClus
|
|
|
23
23
|
* <p>For more information on Amazon Aurora DB clusters, see
|
|
24
24
|
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html">
|
|
25
25
|
* What is Amazon Aurora?</a> in the <i>Amazon Aurora User Guide</i>.</p>
|
|
26
|
-
* <p>For more information on Multi-AZ DB clusters, see
|
|
27
|
-
*
|
|
28
|
-
*
|
|
26
|
+
* <p>For more information on Multi-AZ DB clusters, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html"> Multi-AZ DB
|
|
27
|
+
* cluster deployments</a> in the <i>Amazon RDS User
|
|
28
|
+
* Guide.</i>
|
|
29
29
|
* </p>
|
|
30
30
|
* @example
|
|
31
31
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -24,9 +24,9 @@ export interface RestoreDBClusterToPointInTimeCommandOutput extends RestoreDBClu
|
|
|
24
24
|
* <p>For more information on Amazon Aurora DB clusters, see
|
|
25
25
|
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html">
|
|
26
26
|
* What is Amazon Aurora?</a> in the <i>Amazon Aurora User Guide</i>.</p>
|
|
27
|
-
* <p>For more information on Multi-AZ DB clusters, see
|
|
28
|
-
*
|
|
29
|
-
*
|
|
27
|
+
* <p>For more information on Multi-AZ DB clusters, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html"> Multi-AZ DB
|
|
28
|
+
* cluster deployments</a> in the <i>Amazon RDS User
|
|
29
|
+
* Guide.</i>
|
|
30
30
|
* </p>
|
|
31
31
|
* @example
|
|
32
32
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -9,9 +9,18 @@ export interface StartExportTaskCommandInput extends StartExportTaskMessage {
|
|
|
9
9
|
export interface StartExportTaskCommandOutput extends ExportTask, __MetadataBearer {
|
|
10
10
|
}
|
|
11
11
|
/**
|
|
12
|
-
* <p>Starts an export of
|
|
12
|
+
* <p>Starts an export of DB snapshot or DB cluster data to Amazon S3.
|
|
13
13
|
* The provided IAM role must have access to the S3 bucket.</p>
|
|
14
|
-
* <p>
|
|
14
|
+
* <p>You can't export snapshot data from RDS Custom DB instances.</p>
|
|
15
|
+
* <p>You can't export cluster data from Multi-AZ DB clusters.</p>
|
|
16
|
+
* <p>For more information on exporting DB snapshot data, see
|
|
17
|
+
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_ExportSnapshot.html">Exporting DB snapshot
|
|
18
|
+
* data to Amazon S3</a> in the <i>Amazon RDS User Guide</i>
|
|
19
|
+
* or <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/aurora-export-snapshot.html">Exporting DB
|
|
20
|
+
* cluster snapshot data to Amazon S3</a> in the <i>Amazon Aurora User Guide</i>.</p>
|
|
21
|
+
* <p>For more information on exporting DB cluster data, see
|
|
22
|
+
* <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/export-cluster-data.html">Exporting DB
|
|
23
|
+
* cluster data to Amazon S3</a> in the <i>Amazon Aurora User Guide</i>.</p>
|
|
15
24
|
* @example
|
|
16
25
|
* Use a bare-bones client and the command you need to make an API call.
|
|
17
26
|
* ```javascript
|
|
@@ -12,7 +12,7 @@ export declare const resolveClientEndpointParameters: <T>(options: T & ClientInp
|
|
|
12
12
|
defaultSigningName: string;
|
|
13
13
|
};
|
|
14
14
|
export interface EndpointParameters extends __EndpointParameters {
|
|
15
|
-
Region
|
|
15
|
+
Region?: string;
|
|
16
16
|
UseDualStack?: boolean;
|
|
17
17
|
UseFIPS?: boolean;
|
|
18
18
|
Endpoint?: string;
|
|
@@ -861,7 +861,7 @@ export interface DBClusterBacktrack {
|
|
|
861
861
|
}
|
|
862
862
|
export interface CancelExportTaskMessage {
|
|
863
863
|
/**
|
|
864
|
-
* <p>The identifier of the snapshot export task to cancel.</p>
|
|
864
|
+
* <p>The identifier of the snapshot or cluster export task to cancel.</p>
|
|
865
865
|
*/
|
|
866
866
|
ExportTaskIdentifier: string | undefined;
|
|
867
867
|
}
|
|
@@ -870,21 +870,21 @@ export declare enum ExportSourceType {
|
|
|
870
870
|
SNAPSHOT = "SNAPSHOT"
|
|
871
871
|
}
|
|
872
872
|
/**
|
|
873
|
-
* <p>Contains the details of a snapshot export to Amazon S3.</p>
|
|
873
|
+
* <p>Contains the details of a snapshot or cluster export to Amazon S3.</p>
|
|
874
874
|
* <p>This data type is used as a response element in the <code>DescribeExportTasks</code> action.</p>
|
|
875
875
|
*/
|
|
876
876
|
export interface ExportTask {
|
|
877
877
|
/**
|
|
878
|
-
* <p>A unique identifier for the snapshot export task. This ID isn't an identifier for
|
|
879
|
-
* the Amazon S3 bucket where the
|
|
878
|
+
* <p>A unique identifier for the snapshot or cluster export task. This ID isn't an identifier for
|
|
879
|
+
* the Amazon S3 bucket where the data is exported.</p>
|
|
880
880
|
*/
|
|
881
881
|
ExportTaskIdentifier?: string;
|
|
882
882
|
/**
|
|
883
|
-
* <p>The Amazon Resource Name (ARN) of the snapshot exported to Amazon S3.</p>
|
|
883
|
+
* <p>The Amazon Resource Name (ARN) of the snapshot or cluster exported to Amazon S3.</p>
|
|
884
884
|
*/
|
|
885
885
|
SourceArn?: string;
|
|
886
886
|
/**
|
|
887
|
-
* <p>The data exported from the snapshot. Valid values are the following:</p>
|
|
887
|
+
* <p>The data exported from the snapshot or cluster. Valid values are the following:</p>
|
|
888
888
|
* <ul>
|
|
889
889
|
* <li>
|
|
890
890
|
* <p>
|
|
@@ -894,12 +894,12 @@ export interface ExportTask {
|
|
|
894
894
|
* <p>
|
|
895
895
|
* <code>database.table</code>
|
|
896
896
|
* <i>table-name</i> -
|
|
897
|
-
*
|
|
897
|
+
* Export a table of the snapshot or cluster. This format is valid only for RDS for MySQL, RDS for MariaDB, and Aurora MySQL.</p>
|
|
898
898
|
* </li>
|
|
899
899
|
* <li>
|
|
900
900
|
* <p>
|
|
901
901
|
* <code>database.schema</code>
|
|
902
|
-
* <i>schema-name</i> - Export a database schema of the snapshot.
|
|
902
|
+
* <i>schema-name</i> - Export a database schema of the snapshot or cluster.
|
|
903
903
|
* This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.</p>
|
|
904
904
|
* </li>
|
|
905
905
|
* <li>
|
|
@@ -916,37 +916,69 @@ export interface ExportTask {
|
|
|
916
916
|
*/
|
|
917
917
|
SnapshotTime?: Date;
|
|
918
918
|
/**
|
|
919
|
-
* <p>The time that the snapshot export task started.</p>
|
|
919
|
+
* <p>The time that the snapshot or cluster export task started.</p>
|
|
920
920
|
*/
|
|
921
921
|
TaskStartTime?: Date;
|
|
922
922
|
/**
|
|
923
|
-
* <p>The time that the snapshot export task
|
|
923
|
+
* <p>The time that the snapshot or cluster export task ended.</p>
|
|
924
924
|
*/
|
|
925
925
|
TaskEndTime?: Date;
|
|
926
926
|
/**
|
|
927
|
-
* <p>The Amazon S3 bucket that the snapshot is exported to.</p>
|
|
927
|
+
* <p>The Amazon S3 bucket that the snapshot or cluster is exported to.</p>
|
|
928
928
|
*/
|
|
929
929
|
S3Bucket?: string;
|
|
930
930
|
/**
|
|
931
|
-
* <p>The Amazon S3 bucket prefix that is the file name and path of the exported
|
|
931
|
+
* <p>The Amazon S3 bucket prefix that is the file name and path of the exported data.</p>
|
|
932
932
|
*/
|
|
933
933
|
S3Prefix?: string;
|
|
934
934
|
/**
|
|
935
|
-
* <p>The name of the IAM role that is used to write to Amazon S3 when exporting a snapshot.</p>
|
|
935
|
+
* <p>The name of the IAM role that is used to write to Amazon S3 when exporting a snapshot or cluster.</p>
|
|
936
936
|
*/
|
|
937
937
|
IamRoleArn?: string;
|
|
938
938
|
/**
|
|
939
|
-
* <p>The key identifier of the Amazon Web Services KMS key that is used to encrypt the
|
|
940
|
-
*
|
|
939
|
+
* <p>The key identifier of the Amazon Web Services KMS key that is used to encrypt the data when it's exported to Amazon S3.
|
|
940
|
+
* The KMS key identifier is its key ARN, key ID, alias ARN, or alias name. The IAM role used for the export
|
|
941
941
|
* must have encryption and decryption permissions to use this KMS key.</p>
|
|
942
942
|
*/
|
|
943
943
|
KmsKeyId?: string;
|
|
944
944
|
/**
|
|
945
|
-
* <p>The progress status of the export task
|
|
945
|
+
* <p>The progress status of the export task. The status can be one of the following:</p>
|
|
946
|
+
* <ul>
|
|
947
|
+
* <li>
|
|
948
|
+
* <p>
|
|
949
|
+
* <code>CANCELED</code>
|
|
950
|
+
* </p>
|
|
951
|
+
* </li>
|
|
952
|
+
* <li>
|
|
953
|
+
* <p>
|
|
954
|
+
* <code>CANCELING</code>
|
|
955
|
+
* </p>
|
|
956
|
+
* </li>
|
|
957
|
+
* <li>
|
|
958
|
+
* <p>
|
|
959
|
+
* <code>COMPLETE</code>
|
|
960
|
+
* </p>
|
|
961
|
+
* </li>
|
|
962
|
+
* <li>
|
|
963
|
+
* <p>
|
|
964
|
+
* <code>FAILED</code>
|
|
965
|
+
* </p>
|
|
966
|
+
* </li>
|
|
967
|
+
* <li>
|
|
968
|
+
* <p>
|
|
969
|
+
* <code>IN_PROGRESS</code>
|
|
970
|
+
* </p>
|
|
971
|
+
* </li>
|
|
972
|
+
* <li>
|
|
973
|
+
* <p>
|
|
974
|
+
* <code>STARTING</code>
|
|
975
|
+
* </p>
|
|
976
|
+
* </li>
|
|
977
|
+
* </ul>
|
|
946
978
|
*/
|
|
947
979
|
Status?: string;
|
|
948
980
|
/**
|
|
949
|
-
* <p>The progress of the snapshot export task as a percentage.</p>
|
|
981
|
+
* <p>The progress of the snapshot or cluster export task as a percentage.</p>
|
|
950
982
|
*/
|
|
951
983
|
PercentProgress?: number;
|
|
952
984
|
/**
|
|
@@ -958,7 +990,7 @@ export interface ExportTask {
|
|
|
958
990
|
*/
|
|
959
991
|
FailureCause?: string;
|
|
960
992
|
/**
|
|
961
|
-
* <p>A warning about the snapshot export task.</p>
|
|
993
|
+
* <p>A warning about the snapshot or cluster export task.</p>
|
|
962
994
|
*/
|
|
963
995
|
WarningMessage?: string;
|
|
964
996
|
/**
|
|
@@ -3173,7 +3205,7 @@ export interface CreateDBClusterMessage {
|
|
|
3173
3205
|
/**
|
|
3174
3206
|
* <p>The Amazon Resource Name (ARN) of the source DB instance or DB cluster if this DB
|
|
3175
3207
|
* cluster is created as a read replica.</p>
|
|
3176
|
-
* <p>Valid for: Aurora DB clusters
|
|
3208
|
+
* <p>Valid for: Aurora DB clusters and RDS for PostgreSQL Multi-AZ DB clusters</p>
|
|
3177
3209
|
*/
|
|
3178
3210
|
ReplicationSourceIdentifier?: string;
|
|
3179
3211
|
/**
|
|
@@ -7341,8 +7373,8 @@ export interface CreateDBInstanceReadReplicaMessage {
|
|
|
7341
7373
|
* <p>The amount of storage (in gibibytes) to allocate initially for the read replica.
|
|
7342
7374
|
* Follow the allocation rules specified in <code>CreateDBInstance</code>.</p>
|
|
7343
7375
|
* <note>
|
|
7344
|
-
* <p>Be sure to allocate enough
|
|
7345
|
-
* You can also allocate additional
|
|
7376
|
+
* <p>Be sure to allocate enough storage for your read replica so that the create operation can succeed.
|
|
7377
|
+
* You can also allocate additional storage for future growth.</p>
|
|
7346
7378
|
* </note>
|
|
7347
7379
|
*/
|
|
7348
7380
|
AllocatedStorage?: number;
|
|
@@ -8560,7 +8592,9 @@ export interface DeleteBlueGreenDeploymentRequest {
|
|
|
8560
8592
|
*/
|
|
8561
8593
|
BlueGreenDeploymentIdentifier: string | undefined;
|
|
8562
8594
|
/**
|
|
8563
|
-
* <p>A value that indicates whether to delete the resources in the green environment
|
|
8595
|
+
* <p>A value that indicates whether to delete the resources in the green environment. You
|
|
8596
|
+
* can't specify this option if the blue/green deployment <a href="https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_BlueGreenDeployment.html">status</a>
|
|
8597
|
+
* is <code>SWITCHOVER_COMPLETED</code>.</p>
|
|
8564
8598
|
*/
|
|
8565
8599
|
DeleteTarget?: boolean;
|
|
8566
8600
|
}
|
|
@@ -1235,29 +1235,29 @@ export interface EventSubscriptionsMessage {
|
|
|
1235
1235
|
}
|
|
1236
1236
|
export interface DescribeExportTasksMessage {
|
|
1237
1237
|
/**
|
|
1238
|
-
* <p>The identifier of the snapshot export task to be described.</p>
|
|
1238
|
+
* <p>The identifier of the snapshot or cluster export task to be described.</p>
|
|
1239
1239
|
*/
|
|
1240
1240
|
ExportTaskIdentifier?: string;
|
|
1241
1241
|
/**
|
|
1242
|
-
* <p>The Amazon Resource Name (ARN) of the snapshot exported to Amazon S3.</p>
|
|
1242
|
+
* <p>The Amazon Resource Name (ARN) of the snapshot or cluster exported to Amazon S3.</p>
|
|
1243
1243
|
*/
|
|
1244
1244
|
SourceArn?: string;
|
|
1245
1245
|
/**
|
|
1246
|
-
* <p>Filters specify one or more snapshot exports to describe. The filters are specified as name-value pairs that define what to
|
|
1246
|
+
* <p>Filters specify one or more snapshot or cluster exports to describe. The filters are specified as name-value pairs that define what to
|
|
1247
1247
|
* include in the output. Filter names and values are case-sensitive.</p>
|
|
1248
1248
|
* <p>Supported filters include the following:</p>
|
|
1249
1249
|
* <ul>
|
|
1250
1250
|
* <li>
|
|
1251
1251
|
* <p>
|
|
1252
|
-
* <code>export-task-identifier</code> - An identifier for the snapshot export task.</p>
|
|
1252
|
+
* <code>export-task-identifier</code> - An identifier for the snapshot or cluster export task.</p>
|
|
1253
1253
|
* </li>
|
|
1254
1254
|
* <li>
|
|
1255
1255
|
* <p>
|
|
1256
|
-
* <code>s3-bucket</code> - The Amazon S3 bucket the
|
|
1256
|
+
* <code>s3-bucket</code> - The Amazon S3 bucket the data is exported to.</p>
|
|
1257
1257
|
* </li>
|
|
1258
1258
|
* <li>
|
|
1259
1259
|
* <p>
|
|
1260
|
-
* <code>source-arn</code> - The Amazon Resource Name (ARN) of the snapshot exported to Amazon S3
|
|
1260
|
+
* <code>source-arn</code> - The Amazon Resource Name (ARN) of the snapshot or cluster exported to Amazon S3.</p>
|
|
1261
1261
|
* </li>
|
|
1262
1262
|
* <li>
|
|
1263
1263
|
* <p>
|
|
@@ -1326,7 +1326,7 @@ export interface ExportTasksMessage {
|
|
|
1326
1326
|
*/
|
|
1327
1327
|
Marker?: string;
|
|
1328
1328
|
/**
|
|
1329
|
-
* <p>Information about an export of a snapshot to Amazon S3.</p>
|
|
1329
|
+
* <p>Information about an export of a snapshot or cluster to Amazon S3.</p>
|
|
1330
1330
|
*/
|
|
1331
1331
|
ExportTasks?: ExportTask[];
|
|
1332
1332
|
}
|
|
@@ -2797,8 +2797,8 @@ export declare enum AuditPolicyState {
|
|
|
2797
2797
|
}
|
|
2798
2798
|
export interface ModifyActivityStreamRequest {
|
|
2799
2799
|
/**
|
|
2800
|
-
* <p>The Amazon Resource Name (ARN) of the RDS for Oracle DB instance
|
|
2801
|
-
*
|
|
2800
|
+
* <p>The Amazon Resource Name (ARN) of the RDS for Oracle or Microsoft SQL Server DB instance.
|
|
2801
|
+
* For example, <code>arn:aws:rds:us-east-1:12345667890:instance:my-orcl-db</code>.</p>
|
|
2802
2802
|
*/
|
|
2803
2803
|
ResourceArn?: string;
|
|
2804
2804
|
/**
|
|
@@ -6902,9 +6902,9 @@ export interface RestoreDBInstanceFromDBSnapshotMessage {
|
|
|
6902
6902
|
StorageThroughput?: number;
|
|
6903
6903
|
/**
|
|
6904
6904
|
* <p>The identifier for the RDS for MySQL Multi-AZ DB cluster snapshot to restore from.</p>
|
|
6905
|
-
* <p>For more information on Multi-AZ DB clusters, see
|
|
6906
|
-
*
|
|
6907
|
-
*
|
|
6905
|
+
* <p>For more information on Multi-AZ DB clusters, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html"> Multi-AZ DB
|
|
6906
|
+
* cluster deployments</a> in the <i>Amazon RDS User
|
|
6907
|
+
* Guide</i>.</p>
|
|
6908
6908
|
* <p>Constraints:</p>
|
|
6909
6909
|
* <ul>
|
|
6910
6910
|
* <li>
|
|
@@ -6933,8 +6933,8 @@ export interface RestoreDBInstanceFromDBSnapshotMessage {
|
|
|
6933
6933
|
* <p>The amount of storage (in gibibytes) to allocate initially for the DB instance. Follow the allocation rules specified in
|
|
6934
6934
|
* CreateDBInstance.</p>
|
|
6935
6935
|
* <note>
|
|
6936
|
-
* <p>Be sure to allocate enough
|
|
6937
|
-
* allocate additional
|
|
6936
|
+
* <p>Be sure to allocate enough storage for your new DB instance so that the restore operation can succeed. You can also
|
|
6937
|
+
* allocate additional storage for future growth.</p>
|
|
6938
6938
|
* </note>
|
|
6939
6939
|
*/
|
|
6940
6940
|
AllocatedStorage?: number;
|
|
@@ -6978,8 +6978,8 @@ export interface RestoreDBInstanceFromS3Message {
|
|
|
6978
6978
|
* <p>The amount of storage (in gibibytes) to allocate initially for the DB instance.
|
|
6979
6979
|
* Follow the allocation rules specified in <code>CreateDBInstance</code>.</p>
|
|
6980
6980
|
* <note>
|
|
6981
|
-
* <p>Be sure to allocate enough
|
|
6982
|
-
* You can also allocate additional
|
|
6981
|
+
* <p>Be sure to allocate enough storage for your new DB instance so that the restore operation can succeed.
|
|
6982
|
+
* You can also allocate additional storage for future growth.</p>
|
|
6983
6983
|
* </note>
|
|
6984
6984
|
*/
|
|
6985
6985
|
AllocatedStorage?: number;
|
|
@@ -7845,8 +7845,8 @@ export interface RestoreDBInstanceToPointInTimeMessage {
|
|
|
7845
7845
|
* <p>The amount of storage (in gibibytes) to allocate initially for the DB instance.
|
|
7846
7846
|
* Follow the allocation rules specified in <code>CreateDBInstance</code>.</p>
|
|
7847
7847
|
* <note>
|
|
7848
|
-
* <p>Be sure to allocate enough
|
|
7849
|
-
* You can also allocate additional
|
|
7848
|
+
* <p>Be sure to allocate enough storage for your new DB instance so that the restore operation can succeed.
|
|
7849
|
+
* You can also allocate additional storage for future growth.</p>
|
|
7850
7850
|
* </note>
|
|
7851
7851
|
*/
|
|
7852
7852
|
AllocatedStorage?: number;
|
|
@@ -7929,8 +7929,8 @@ export interface StartActivityStreamRequest {
|
|
|
7929
7929
|
*/
|
|
7930
7930
|
ApplyImmediately?: boolean;
|
|
7931
7931
|
/**
|
|
7932
|
-
* <p>Specifies whether the database activity stream includes engine-native audit fields. This option
|
|
7933
|
-
* to an Oracle DB instance. By default, no engine-native audit fields are included.</p>
|
|
7932
|
+
* <p>Specifies whether the database activity stream includes engine-native audit fields. This option applies
|
|
7933
|
+
* to an Oracle or Microsoft SQL Server DB instance. By default, no engine-native audit fields are included.</p>
|
|
7934
7934
|
*/
|
|
7935
7935
|
EngineNativeAuditFieldsIncluded?: boolean;
|
|
7936
7936
|
}
|
|
@@ -8111,25 +8111,25 @@ export declare class InvalidExportSourceStateFault extends __BaseException {
|
|
|
8111
8111
|
}
|
|
8112
8112
|
export interface StartExportTaskMessage {
|
|
8113
8113
|
/**
|
|
8114
|
-
* <p>A unique identifier for the
|
|
8115
|
-
* the Amazon S3 bucket where the
|
|
8114
|
+
* <p>A unique identifier for the export task. This ID isn't an identifier for
|
|
8115
|
+
* the Amazon S3 bucket where the data is to be exported.</p>
|
|
8116
8116
|
*/
|
|
8117
8117
|
ExportTaskIdentifier: string | undefined;
|
|
8118
8118
|
/**
|
|
8119
|
-
* <p>The Amazon Resource Name (ARN) of the snapshot to export to Amazon S3.</p>
|
|
8119
|
+
* <p>The Amazon Resource Name (ARN) of the snapshot or cluster to export to Amazon S3.</p>
|
|
8120
8120
|
*/
|
|
8121
8121
|
SourceArn: string | undefined;
|
|
8122
8122
|
/**
|
|
8123
|
-
* <p>The name of the Amazon S3 bucket to export the snapshot to.</p>
|
|
8123
|
+
* <p>The name of the Amazon S3 bucket to export the snapshot or cluster data to.</p>
|
|
8124
8124
|
*/
|
|
8125
8125
|
S3BucketName: string | undefined;
|
|
8126
8126
|
/**
|
|
8127
8127
|
* <p>The name of the IAM role to use for writing to the Amazon S3 bucket
|
|
8128
|
-
* when exporting a snapshot.</p>
|
|
8128
|
+
* when exporting a snapshot or cluster.</p>
|
|
8129
8129
|
*/
|
|
8130
8130
|
IamRoleArn: string | undefined;
|
|
8131
8131
|
/**
|
|
8132
|
-
* <p>The ID of the Amazon Web Services KMS key to use to encrypt the
|
|
8132
|
+
* <p>The ID of the Amazon Web Services KMS key to use to encrypt the data exported to Amazon S3. The Amazon Web Services KMS
|
|
8133
8133
|
* key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
|
|
8134
8134
|
* The caller of this operation must be authorized to run the following operations.
|
|
8135
8135
|
* These can be set in the Amazon Web Services KMS key policy:</p>
|
|
@@ -8165,12 +8165,12 @@ export interface StartExportTaskMessage {
|
|
|
8165
8165
|
*/
|
|
8166
8166
|
KmsKeyId: string | undefined;
|
|
8167
8167
|
/**
|
|
8168
|
-
* <p>The Amazon S3 bucket prefix to use as the file name and path of the exported
|
|
8168
|
+
* <p>The Amazon S3 bucket prefix to use as the file name and path of the exported data.</p>
|
|
8169
8169
|
*/
|
|
8170
8170
|
S3Prefix?: string;
|
|
8171
8171
|
/**
|
|
8172
|
-
* <p>The data to be exported from the snapshot.
|
|
8173
|
-
* If this parameter is not provided, all the
|
|
8172
|
+
* <p>The data to be exported from the snapshot or cluster.
|
|
8173
|
+
* If this parameter is not provided, all of the data is exported.
|
|
8174
8174
|
* Valid values are the following:</p>
|
|
8175
8175
|
* <ul>
|
|
8176
8176
|
* <li>
|
|
@@ -8181,12 +8181,12 @@ export interface StartExportTaskMessage {
|
|
|
8181
8181
|
* <p>
|
|
8182
8182
|
* <code>database.table</code>
|
|
8183
8183
|
* <i>table-name</i> -
|
|
8184
|
-
*
|
|
8184
|
+
* Export a table of the snapshot or cluster. This format is valid only for RDS for MySQL, RDS for MariaDB, and Aurora MySQL.</p>
|
|
8185
8185
|
* </li>
|
|
8186
8186
|
* <li>
|
|
8187
8187
|
* <p>
|
|
8188
8188
|
* <code>database.schema</code>
|
|
8189
|
-
* <i>schema-name</i> - Export a database schema of the snapshot.
|
|
8189
|
+
* <i>schema-name</i> - Export a database schema of the snapshot or cluster.
|
|
8190
8190
|
* This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.</p>
|
|
8191
8191
|
* </li>
|
|
8192
8192
|
* <li>
|
|
@@ -27,7 +27,7 @@ export declare const resolveClientEndpointParameters: <T>(
|
|
|
27
27
|
defaultSigningName: string;
|
|
28
28
|
};
|
|
29
29
|
export interface EndpointParameters extends __EndpointParameters {
|
|
30
|
-
Region
|
|
30
|
+
Region?: string;
|
|
31
31
|
UseDualStack?: boolean;
|
|
32
32
|
UseFIPS?: boolean;
|
|
33
33
|
Endpoint?: string;
|