aws-sdk 2.801.0 → 2.805.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/CHANGELOG.md +25 -1
- package/README.md +1 -1
- package/apis/amplifybackend-2020-08-11.min.json +0 -8
- package/apis/batch-2016-08-10.min.json +81 -21
- package/apis/compute-optimizer-2019-11-01.min.json +110 -0
- package/apis/{profile-2020-08-15.examples.json → customer-profiles-2020-08-15.examples.json} +0 -0
- package/apis/{profile-2020-08-15.min.json → customer-profiles-2020-08-15.min.json} +3 -3
- package/apis/{profile-2020-08-15.paginators.json → customer-profiles-2020-08-15.paginators.json} +0 -0
- package/apis/dms-2016-01-01.min.json +9 -1
- package/apis/ec2-2016-11-15.min.json +4 -0
- package/apis/lambda-2015-03-31.examples.json +6 -6
- package/apis/license-manager-2018-08-01.min.json +957 -51
- package/apis/medialive-2017-10-14.min.json +240 -158
- package/apis/metadata.json +4 -3
- package/apis/rds-2014-10-31.min.json +200 -132
- package/apis/servicecatalog-appregistry-2020-06-24.min.json +80 -0
- package/apis/ssm-2014-11-06.min.json +348 -203
- package/clients/all.d.ts +1 -1
- package/clients/all.js +2 -2
- package/clients/amplifybackend.d.ts +74 -74
- package/clients/batch.d.ts +200 -133
- package/clients/computeoptimizer.d.ts +179 -22
- package/clients/{profile.d.ts → customerprofiles.d.ts} +63 -63
- package/clients/customerprofiles.js +18 -0
- package/clients/directoryservice.d.ts +24 -21
- package/clients/dms.d.ts +16 -0
- package/clients/ec2.d.ts +6 -2
- package/clients/kafka.d.ts +4 -4
- package/clients/lambda.d.ts +10 -10
- package/clients/licensemanager.d.ts +1350 -72
- package/clients/medialive.d.ts +80 -1
- package/clients/rds.d.ts +128 -43
- package/clients/servicecatalogappregistry.d.ts +61 -0
- package/clients/ssm.d.ts +197 -10
- package/clients/workspaces.d.ts +10 -10
- package/dist/aws-sdk-core-react-native.js +2 -2
- package/dist/aws-sdk-react-native.js +31 -27
- package/dist/aws-sdk.js +565 -343
- package/dist/aws-sdk.min.js +60 -60
- package/lib/config_service_placeholders.d.ts +2 -2
- package/lib/core.js +1 -1
- package/lib/services/s3.js +6 -2
- package/package.json +1 -1
- package/clients/profile.js +0 -18
package/clients/rds.d.ts
CHANGED
|
@@ -86,11 +86,11 @@ declare class RDS extends Service {
|
|
|
86
86
|
*/
|
|
87
87
|
copyDBClusterParameterGroup(callback?: (err: AWSError, data: RDS.Types.CopyDBClusterParameterGroupResult) => void): Request<RDS.Types.CopyDBClusterParameterGroupResult, AWSError>;
|
|
88
88
|
/**
|
|
89
|
-
* Copies a snapshot of a DB cluster. To copy a DB cluster snapshot from a shared manual DB cluster snapshot, SourceDBClusterSnapshotIdentifier must be the Amazon Resource Name (ARN) of the shared DB cluster snapshot. You can copy an encrypted DB cluster snapshot from another AWS Region. In that case, the AWS Region where you call the CopyDBClusterSnapshot action is the destination AWS Region for the encrypted DB cluster snapshot to be copied to. To copy an encrypted DB cluster snapshot from another AWS Region, you must provide the following values: KmsKeyId - The AWS Key Management System (AWS KMS) key identifier for the key to use to encrypt the copy of the DB cluster snapshot in the destination AWS Region. PreSignedUrl - A URL that contains a Signature Version 4 signed request for the CopyDBClusterSnapshot action to be called in the source AWS Region where the DB cluster snapshot is copied from. The pre-signed URL must be a valid request for the CopyDBClusterSnapshot API action that can be executed in the source AWS Region that contains the encrypted DB cluster snapshot to be copied. The pre-signed URL request must contain the following parameter values: KmsKeyId - The KMS key identifier for the key to use to encrypt the copy of the DB cluster snapshot in the destination AWS Region. This is the same identifier for both the CopyDBClusterSnapshot action that is called in the destination AWS Region, and the action contained in the pre-signed URL. DestinationRegion - The name of the AWS Region that the DB cluster snapshot is to be created in. SourceDBClusterSnapshotIdentifier - The DB cluster snapshot identifier for the encrypted DB cluster snapshot to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source AWS Region. For example, if you are copying an encrypted DB cluster snapshot from the us-west-2 AWS Region, then your SourceDBClusterSnapshotIdentifier looks like the following example: arn:aws:rds:us-west-2:123456789012:cluster-snapshot:aurora-cluster1-snapshot-20161115. To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (AWS Signature Version 4) and Signature Version 4 Signing Process. If you are using an AWS SDK tool or the AWS CLI, you can specify SourceRegion (or --source-region for the AWS CLI) instead of specifying PreSignedUrl manually. Specifying SourceRegion autogenerates a pre-signed URL that is a valid request for the operation that can be executed in the source AWS Region. TargetDBClusterSnapshotIdentifier - The identifier for the new copy of the DB cluster snapshot in the destination AWS Region. SourceDBClusterSnapshotIdentifier - The DB cluster snapshot identifier for the encrypted DB cluster snapshot to be copied. This identifier must be in the ARN format for the source AWS Region and is the same value as the SourceDBClusterSnapshotIdentifier in the pre-signed URL. To cancel the copy operation once it is in progress, delete the target DB cluster snapshot identified by TargetDBClusterSnapshotIdentifier while that DB cluster snapshot is in "copying" status. For more information on copying encrypted DB cluster snapshots from one AWS Region to another, see Copying a Snapshot in the Amazon Aurora User Guide. For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide. This action only applies to Aurora DB clusters.
|
|
89
|
+
* Copies a snapshot of a DB cluster. To copy a DB cluster snapshot from a shared manual DB cluster snapshot, SourceDBClusterSnapshotIdentifier must be the Amazon Resource Name (ARN) of the shared DB cluster snapshot. You can copy an encrypted DB cluster snapshot from another AWS Region. In that case, the AWS Region where you call the CopyDBClusterSnapshot action is the destination AWS Region for the encrypted DB cluster snapshot to be copied to. To copy an encrypted DB cluster snapshot from another AWS Region, you must provide the following values: KmsKeyId - The AWS Key Management System (AWS KMS) key identifier for the key to use to encrypt the copy of the DB cluster snapshot in the destination AWS Region. PreSignedUrl - A URL that contains a Signature Version 4 signed request for the CopyDBClusterSnapshot action to be called in the source AWS Region where the DB cluster snapshot is copied from. The pre-signed URL must be a valid request for the CopyDBClusterSnapshot API action that can be executed in the source AWS Region that contains the encrypted DB cluster snapshot to be copied. The pre-signed URL request must contain the following parameter values: KmsKeyId - The AWS KMS key identifier for the customer master key (CMK) to use to encrypt the copy of the DB cluster snapshot in the destination AWS Region. This is the same identifier for both the CopyDBClusterSnapshot action that is called in the destination AWS Region, and the action contained in the pre-signed URL. DestinationRegion - The name of the AWS Region that the DB cluster snapshot is to be created in. SourceDBClusterSnapshotIdentifier - The DB cluster snapshot identifier for the encrypted DB cluster snapshot to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source AWS Region. For example, if you are copying an encrypted DB cluster snapshot from the us-west-2 AWS Region, then your SourceDBClusterSnapshotIdentifier looks like the following example: arn:aws:rds:us-west-2:123456789012:cluster-snapshot:aurora-cluster1-snapshot-20161115. To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (AWS Signature Version 4) and Signature Version 4 Signing Process. If you are using an AWS SDK tool or the AWS CLI, you can specify SourceRegion (or --source-region for the AWS CLI) instead of specifying PreSignedUrl manually. Specifying SourceRegion autogenerates a pre-signed URL that is a valid request for the operation that can be executed in the source AWS Region. TargetDBClusterSnapshotIdentifier - The identifier for the new copy of the DB cluster snapshot in the destination AWS Region. SourceDBClusterSnapshotIdentifier - The DB cluster snapshot identifier for the encrypted DB cluster snapshot to be copied. This identifier must be in the ARN format for the source AWS Region and is the same value as the SourceDBClusterSnapshotIdentifier in the pre-signed URL. To cancel the copy operation once it is in progress, delete the target DB cluster snapshot identified by TargetDBClusterSnapshotIdentifier while that DB cluster snapshot is in "copying" status. For more information on copying encrypted DB cluster snapshots from one AWS Region to another, see Copying a Snapshot in the Amazon Aurora User Guide. For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide. This action only applies to Aurora DB clusters.
|
|
90
90
|
*/
|
|
91
91
|
copyDBClusterSnapshot(params: RDS.Types.CopyDBClusterSnapshotMessage, callback?: (err: AWSError, data: RDS.Types.CopyDBClusterSnapshotResult) => void): Request<RDS.Types.CopyDBClusterSnapshotResult, AWSError>;
|
|
92
92
|
/**
|
|
93
|
-
* Copies a snapshot of a DB cluster. To copy a DB cluster snapshot from a shared manual DB cluster snapshot, SourceDBClusterSnapshotIdentifier must be the Amazon Resource Name (ARN) of the shared DB cluster snapshot. You can copy an encrypted DB cluster snapshot from another AWS Region. In that case, the AWS Region where you call the CopyDBClusterSnapshot action is the destination AWS Region for the encrypted DB cluster snapshot to be copied to. To copy an encrypted DB cluster snapshot from another AWS Region, you must provide the following values: KmsKeyId - The AWS Key Management System (AWS KMS) key identifier for the key to use to encrypt the copy of the DB cluster snapshot in the destination AWS Region. PreSignedUrl - A URL that contains a Signature Version 4 signed request for the CopyDBClusterSnapshot action to be called in the source AWS Region where the DB cluster snapshot is copied from. The pre-signed URL must be a valid request for the CopyDBClusterSnapshot API action that can be executed in the source AWS Region that contains the encrypted DB cluster snapshot to be copied. The pre-signed URL request must contain the following parameter values: KmsKeyId - The KMS key identifier for the key to use to encrypt the copy of the DB cluster snapshot in the destination AWS Region. This is the same identifier for both the CopyDBClusterSnapshot action that is called in the destination AWS Region, and the action contained in the pre-signed URL. DestinationRegion - The name of the AWS Region that the DB cluster snapshot is to be created in. SourceDBClusterSnapshotIdentifier - The DB cluster snapshot identifier for the encrypted DB cluster snapshot to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source AWS Region. For example, if you are copying an encrypted DB cluster snapshot from the us-west-2 AWS Region, then your SourceDBClusterSnapshotIdentifier looks like the following example: arn:aws:rds:us-west-2:123456789012:cluster-snapshot:aurora-cluster1-snapshot-20161115. To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (AWS Signature Version 4) and Signature Version 4 Signing Process. If you are using an AWS SDK tool or the AWS CLI, you can specify SourceRegion (or --source-region for the AWS CLI) instead of specifying PreSignedUrl manually. Specifying SourceRegion autogenerates a pre-signed URL that is a valid request for the operation that can be executed in the source AWS Region. TargetDBClusterSnapshotIdentifier - The identifier for the new copy of the DB cluster snapshot in the destination AWS Region. SourceDBClusterSnapshotIdentifier - The DB cluster snapshot identifier for the encrypted DB cluster snapshot to be copied. This identifier must be in the ARN format for the source AWS Region and is the same value as the SourceDBClusterSnapshotIdentifier in the pre-signed URL. To cancel the copy operation once it is in progress, delete the target DB cluster snapshot identified by TargetDBClusterSnapshotIdentifier while that DB cluster snapshot is in "copying" status. For more information on copying encrypted DB cluster snapshots from one AWS Region to another, see Copying a Snapshot in the Amazon Aurora User Guide. For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide. This action only applies to Aurora DB clusters.
|
|
93
|
+
* Copies a snapshot of a DB cluster. To copy a DB cluster snapshot from a shared manual DB cluster snapshot, SourceDBClusterSnapshotIdentifier must be the Amazon Resource Name (ARN) of the shared DB cluster snapshot. You can copy an encrypted DB cluster snapshot from another AWS Region. In that case, the AWS Region where you call the CopyDBClusterSnapshot action is the destination AWS Region for the encrypted DB cluster snapshot to be copied to. To copy an encrypted DB cluster snapshot from another AWS Region, you must provide the following values: KmsKeyId - The AWS Key Management System (AWS KMS) key identifier for the key to use to encrypt the copy of the DB cluster snapshot in the destination AWS Region. PreSignedUrl - A URL that contains a Signature Version 4 signed request for the CopyDBClusterSnapshot action to be called in the source AWS Region where the DB cluster snapshot is copied from. The pre-signed URL must be a valid request for the CopyDBClusterSnapshot API action that can be executed in the source AWS Region that contains the encrypted DB cluster snapshot to be copied. The pre-signed URL request must contain the following parameter values: KmsKeyId - The AWS KMS key identifier for the customer master key (CMK) to use to encrypt the copy of the DB cluster snapshot in the destination AWS Region. This is the same identifier for both the CopyDBClusterSnapshot action that is called in the destination AWS Region, and the action contained in the pre-signed URL. DestinationRegion - The name of the AWS Region that the DB cluster snapshot is to be created in. SourceDBClusterSnapshotIdentifier - The DB cluster snapshot identifier for the encrypted DB cluster snapshot to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source AWS Region. For example, if you are copying an encrypted DB cluster snapshot from the us-west-2 AWS Region, then your SourceDBClusterSnapshotIdentifier looks like the following example: arn:aws:rds:us-west-2:123456789012:cluster-snapshot:aurora-cluster1-snapshot-20161115. To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (AWS Signature Version 4) and Signature Version 4 Signing Process. If you are using an AWS SDK tool or the AWS CLI, you can specify SourceRegion (or --source-region for the AWS CLI) instead of specifying PreSignedUrl manually. Specifying SourceRegion autogenerates a pre-signed URL that is a valid request for the operation that can be executed in the source AWS Region. TargetDBClusterSnapshotIdentifier - The identifier for the new copy of the DB cluster snapshot in the destination AWS Region. SourceDBClusterSnapshotIdentifier - The DB cluster snapshot identifier for the encrypted DB cluster snapshot to be copied. This identifier must be in the ARN format for the source AWS Region and is the same value as the SourceDBClusterSnapshotIdentifier in the pre-signed URL. To cancel the copy operation once it is in progress, delete the target DB cluster snapshot identified by TargetDBClusterSnapshotIdentifier while that DB cluster snapshot is in "copying" status. For more information on copying encrypted DB cluster snapshots from one AWS Region to another, see Copying a Snapshot in the Amazon Aurora User Guide. For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide. This action only applies to Aurora DB clusters.
|
|
94
94
|
*/
|
|
95
95
|
copyDBClusterSnapshot(callback?: (err: AWSError, data: RDS.Types.CopyDBClusterSnapshotResult) => void): Request<RDS.Types.CopyDBClusterSnapshotResult, AWSError>;
|
|
96
96
|
/**
|
|
@@ -198,11 +198,11 @@ declare class RDS extends Service {
|
|
|
198
198
|
*/
|
|
199
199
|
createDBSecurityGroup(callback?: (err: AWSError, data: RDS.Types.CreateDBSecurityGroupResult) => void): Request<RDS.Types.CreateDBSecurityGroupResult, AWSError>;
|
|
200
200
|
/**
|
|
201
|
-
* Creates a snapshot of a DB instance. The source DB instance must be in the available or storage-
|
|
201
|
+
* Creates a snapshot of a DB instance. The source DB instance must be in the available or storage-optimization state.
|
|
202
202
|
*/
|
|
203
203
|
createDBSnapshot(params: RDS.Types.CreateDBSnapshotMessage, callback?: (err: AWSError, data: RDS.Types.CreateDBSnapshotResult) => void): Request<RDS.Types.CreateDBSnapshotResult, AWSError>;
|
|
204
204
|
/**
|
|
205
|
-
* Creates a snapshot of a DB instance. The source DB instance must be in the available or storage-
|
|
205
|
+
* Creates a snapshot of a DB instance. The source DB instance must be in the available or storage-optimization state.
|
|
206
206
|
*/
|
|
207
207
|
createDBSnapshot(callback?: (err: AWSError, data: RDS.Types.CreateDBSnapshotResult) => void): Request<RDS.Types.CreateDBSnapshotResult, AWSError>;
|
|
208
208
|
/**
|
|
@@ -286,11 +286,11 @@ declare class RDS extends Service {
|
|
|
286
286
|
*/
|
|
287
287
|
deleteDBInstance(callback?: (err: AWSError, data: RDS.Types.DeleteDBInstanceResult) => void): Request<RDS.Types.DeleteDBInstanceResult, AWSError>;
|
|
288
288
|
/**
|
|
289
|
-
* Deletes automated backups
|
|
289
|
+
* Deletes automated backups using the DbiResourceId value of the source DB instance or the Amazon Resource Name (ARN) of the automated backups.
|
|
290
290
|
*/
|
|
291
291
|
deleteDBInstanceAutomatedBackup(params: RDS.Types.DeleteDBInstanceAutomatedBackupMessage, callback?: (err: AWSError, data: RDS.Types.DeleteDBInstanceAutomatedBackupResult) => void): Request<RDS.Types.DeleteDBInstanceAutomatedBackupResult, AWSError>;
|
|
292
292
|
/**
|
|
293
|
-
* Deletes automated backups
|
|
293
|
+
* Deletes automated backups using the DbiResourceId value of the source DB instance or the Amazon Resource Name (ARN) of the automated backups.
|
|
294
294
|
*/
|
|
295
295
|
deleteDBInstanceAutomatedBackup(callback?: (err: AWSError, data: RDS.Types.DeleteDBInstanceAutomatedBackupResult) => void): Request<RDS.Types.DeleteDBInstanceAutomatedBackupResult, AWSError>;
|
|
296
296
|
/**
|
|
@@ -966,11 +966,11 @@ declare class RDS extends Service {
|
|
|
966
966
|
*/
|
|
967
967
|
restoreDBClusterToPointInTime(callback?: (err: AWSError, data: RDS.Types.RestoreDBClusterToPointInTimeResult) => void): Request<RDS.Types.RestoreDBClusterToPointInTimeResult, AWSError>;
|
|
968
968
|
/**
|
|
969
|
-
* Creates a new DB instance from a DB snapshot. The target database is created from the source database restore point with
|
|
969
|
+
* Creates a new DB instance from a DB snapshot. The target database is created from the source database restore point with most of the source's original configuration, including the default security group and DB parameter group. By default, the new DB instance is created as a Single-AZ deployment, except when the instance is a SQL Server instance that has an option group associated with mirroring. In this case, the instance becomes a Multi-AZ deployment, not a Single-AZ deployment. If you want to replace your original DB instance with the new, restored DB instance, then rename your original DB instance before you call the RestoreDBInstanceFromDBSnapshot action. RDS doesn't allow two DB instances with the same name. After you have renamed your original DB instance with a different identifier, then you can pass the original name of the DB instance as the DBInstanceIdentifier in the call to the RestoreDBInstanceFromDBSnapshot action. The result is that you replace the original DB instance with the DB instance created from the snapshot. If you are restoring from a shared manual DB snapshot, the DBSnapshotIdentifier must be the ARN of the shared DB snapshot. This command doesn't apply to Aurora MySQL and Aurora PostgreSQL. For Aurora, use RestoreDBClusterFromSnapshot.
|
|
970
970
|
*/
|
|
971
971
|
restoreDBInstanceFromDBSnapshot(params: RDS.Types.RestoreDBInstanceFromDBSnapshotMessage, callback?: (err: AWSError, data: RDS.Types.RestoreDBInstanceFromDBSnapshotResult) => void): Request<RDS.Types.RestoreDBInstanceFromDBSnapshotResult, AWSError>;
|
|
972
972
|
/**
|
|
973
|
-
* Creates a new DB instance from a DB snapshot. The target database is created from the source database restore point with
|
|
973
|
+
* Creates a new DB instance from a DB snapshot. The target database is created from the source database restore point with most of the source's original configuration, including the default security group and DB parameter group. By default, the new DB instance is created as a Single-AZ deployment, except when the instance is a SQL Server instance that has an option group associated with mirroring. In this case, the instance becomes a Multi-AZ deployment, not a Single-AZ deployment. If you want to replace your original DB instance with the new, restored DB instance, then rename your original DB instance before you call the RestoreDBInstanceFromDBSnapshot action. RDS doesn't allow two DB instances with the same name. After you have renamed your original DB instance with a different identifier, then you can pass the original name of the DB instance as the DBInstanceIdentifier in the call to the RestoreDBInstanceFromDBSnapshot action. The result is that you replace the original DB instance with the DB instance created from the snapshot. If you are restoring from a shared manual DB snapshot, the DBSnapshotIdentifier must be the ARN of the shared DB snapshot. This command doesn't apply to Aurora MySQL and Aurora PostgreSQL. For Aurora, use RestoreDBClusterFromSnapshot.
|
|
974
974
|
*/
|
|
975
975
|
restoreDBInstanceFromDBSnapshot(callback?: (err: AWSError, data: RDS.Types.RestoreDBInstanceFromDBSnapshotResult) => void): Request<RDS.Types.RestoreDBInstanceFromDBSnapshotResult, AWSError>;
|
|
976
976
|
/**
|
|
@@ -1021,6 +1021,14 @@ declare class RDS extends Service {
|
|
|
1021
1021
|
* Starts an Amazon RDS DB instance that was stopped using the AWS console, the stop-db-instance AWS CLI command, or the StopDBInstance action. For more information, see Starting an Amazon RDS DB instance That Was Previously Stopped in the Amazon RDS User Guide. This command doesn't apply to Aurora MySQL and Aurora PostgreSQL. For Aurora DB clusters, use StartDBCluster instead.
|
|
1022
1022
|
*/
|
|
1023
1023
|
startDBInstance(callback?: (err: AWSError, data: RDS.Types.StartDBInstanceResult) => void): Request<RDS.Types.StartDBInstanceResult, AWSError>;
|
|
1024
|
+
/**
|
|
1025
|
+
* Enables replication of automated backups to a different AWS Region. For more information, see Replicating Automated Backups to Another AWS Region in the Amazon RDS User Guide.
|
|
1026
|
+
*/
|
|
1027
|
+
startDBInstanceAutomatedBackupsReplication(params: RDS.Types.StartDBInstanceAutomatedBackupsReplicationMessage, callback?: (err: AWSError, data: RDS.Types.StartDBInstanceAutomatedBackupsReplicationResult) => void): Request<RDS.Types.StartDBInstanceAutomatedBackupsReplicationResult, AWSError>;
|
|
1028
|
+
/**
|
|
1029
|
+
* Enables replication of automated backups to a different AWS Region. For more information, see Replicating Automated Backups to Another AWS Region in the Amazon RDS User Guide.
|
|
1030
|
+
*/
|
|
1031
|
+
startDBInstanceAutomatedBackupsReplication(callback?: (err: AWSError, data: RDS.Types.StartDBInstanceAutomatedBackupsReplicationResult) => void): Request<RDS.Types.StartDBInstanceAutomatedBackupsReplicationResult, AWSError>;
|
|
1024
1032
|
/**
|
|
1025
1033
|
* Starts an export of a snapshot to Amazon S3. The provided IAM role must have access to the S3 bucket.
|
|
1026
1034
|
*/
|
|
@@ -1053,6 +1061,14 @@ declare class RDS extends Service {
|
|
|
1053
1061
|
* Stops an Amazon RDS DB instance. When you stop a DB instance, Amazon RDS retains the DB instance's metadata, including its endpoint, DB parameter group, and option group membership. Amazon RDS also retains the transaction logs so you can do a point-in-time restore if necessary. For more information, see Stopping an Amazon RDS DB Instance Temporarily in the Amazon RDS User Guide. This command doesn't apply to Aurora MySQL and Aurora PostgreSQL. For Aurora clusters, use StopDBCluster instead.
|
|
1054
1062
|
*/
|
|
1055
1063
|
stopDBInstance(callback?: (err: AWSError, data: RDS.Types.StopDBInstanceResult) => void): Request<RDS.Types.StopDBInstanceResult, AWSError>;
|
|
1064
|
+
/**
|
|
1065
|
+
* Stops automated backup replication for a DB instance. For more information, see Replicating Automated Backups to Another AWS Region in the Amazon RDS User Guide.
|
|
1066
|
+
*/
|
|
1067
|
+
stopDBInstanceAutomatedBackupsReplication(params: RDS.Types.StopDBInstanceAutomatedBackupsReplicationMessage, callback?: (err: AWSError, data: RDS.Types.StopDBInstanceAutomatedBackupsReplicationResult) => void): Request<RDS.Types.StopDBInstanceAutomatedBackupsReplicationResult, AWSError>;
|
|
1068
|
+
/**
|
|
1069
|
+
* Stops automated backup replication for a DB instance. For more information, see Replicating Automated Backups to Another AWS Region in the Amazon RDS User Guide.
|
|
1070
|
+
*/
|
|
1071
|
+
stopDBInstanceAutomatedBackupsReplication(callback?: (err: AWSError, data: RDS.Types.StopDBInstanceAutomatedBackupsReplicationResult) => void): Request<RDS.Types.StopDBInstanceAutomatedBackupsReplicationResult, AWSError>;
|
|
1056
1072
|
/**
|
|
1057
1073
|
* Waits for the dBInstanceAvailable state by periodically calling the underlying RDS.describeDBInstancesoperation every 30 seconds (at most 60 times).
|
|
1058
1074
|
*/
|
|
@@ -1135,7 +1151,7 @@ declare namespace RDS {
|
|
|
1135
1151
|
*/
|
|
1136
1152
|
DBClusterIdentifier: String;
|
|
1137
1153
|
/**
|
|
1138
|
-
* The Amazon Resource Name (ARN) of the IAM role to associate with the Aurora DB cluster, for example arn:aws:iam::123456789012:role/AuroraAccessRole.
|
|
1154
|
+
* The Amazon Resource Name (ARN) of the IAM role to associate with the Aurora DB cluster, for example, arn:aws:iam::123456789012:role/AuroraAccessRole.
|
|
1139
1155
|
*/
|
|
1140
1156
|
RoleArn: String;
|
|
1141
1157
|
/**
|
|
@@ -1411,11 +1427,11 @@ declare namespace RDS {
|
|
|
1411
1427
|
*/
|
|
1412
1428
|
TargetDBClusterSnapshotIdentifier: String;
|
|
1413
1429
|
/**
|
|
1414
|
-
* The AWS KMS key
|
|
1430
|
+
* The AWS KMS key identifier for an encrypted DB cluster snapshot. The AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the AWS KMS customer master key (CMK). If you copy an encrypted DB cluster snapshot from your AWS account, you can specify a value for KmsKeyId to encrypt the copy with a new AWS KMS CMK. If you don't specify a value for KmsKeyId, then the copy of the DB cluster snapshot is encrypted with the same AWS KMS key as the source DB cluster snapshot. If you copy an encrypted DB cluster snapshot that is shared from another AWS account, then you must specify a value for KmsKeyId. To copy an encrypted DB cluster snapshot to another AWS Region, you must set KmsKeyId to the AWS KMS key identifier you want to use to encrypt the copy of the DB cluster snapshot in the destination AWS Region. AWS KMS CMKs are specific to the AWS Region that they are created in, and you can't use CMKs from one AWS Region in another AWS Region. If you copy an unencrypted DB cluster snapshot and specify a value for the KmsKeyId parameter, an error is returned.
|
|
1415
1431
|
*/
|
|
1416
1432
|
KmsKeyId?: String;
|
|
1417
1433
|
/**
|
|
1418
|
-
* The URL that contains a Signature Version 4 signed request for the CopyDBClusterSnapshot API action in the AWS Region that contains the source DB cluster snapshot to copy. The PreSignedUrl parameter must be used when copying an encrypted DB cluster snapshot from another AWS Region. Don't specify PreSignedUrl when you are copying an encrypted DB cluster snapshot in the same AWS Region. The pre-signed URL must be a valid request for the CopyDBClusterSnapshot API action that can be executed in the source AWS Region that contains the encrypted DB cluster snapshot to be copied. The pre-signed URL request must contain the following parameter values: KmsKeyId - The AWS KMS key identifier for the key to use to encrypt the copy of the DB cluster snapshot in the destination AWS Region. This is the same identifier for both the CopyDBClusterSnapshot action that is called in the destination AWS Region, and the action contained in the pre-signed URL. DestinationRegion - The name of the AWS Region that the DB cluster snapshot is to be created in. SourceDBClusterSnapshotIdentifier - The DB cluster snapshot identifier for the encrypted DB cluster snapshot to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source AWS Region. For example, if you are copying an encrypted DB cluster snapshot from the us-west-2 AWS Region, then your SourceDBClusterSnapshotIdentifier looks like the following example: arn:aws:rds:us-west-2:123456789012:cluster-snapshot:aurora-cluster1-snapshot-20161115. To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (AWS Signature Version 4) and Signature Version 4 Signing Process. If you are using an AWS SDK tool or the AWS CLI, you can specify SourceRegion (or --source-region for the AWS CLI) instead of specifying PreSignedUrl manually. Specifying SourceRegion autogenerates a pre-signed URL that is a valid request for the operation that can be executed in the source AWS Region. If you supply a value for this operation's SourceRegion parameter, a pre-signed URL will be calculated on your behalf.
|
|
1434
|
+
* The URL that contains a Signature Version 4 signed request for the CopyDBClusterSnapshot API action in the AWS Region that contains the source DB cluster snapshot to copy. The PreSignedUrl parameter must be used when copying an encrypted DB cluster snapshot from another AWS Region. Don't specify PreSignedUrl when you are copying an encrypted DB cluster snapshot in the same AWS Region. The pre-signed URL must be a valid request for the CopyDBClusterSnapshot API action that can be executed in the source AWS Region that contains the encrypted DB cluster snapshot to be copied. The pre-signed URL request must contain the following parameter values: KmsKeyId - The AWS KMS key identifier for the customer master key (CMK) to use to encrypt the copy of the DB cluster snapshot in the destination AWS Region. This is the same identifier for both the CopyDBClusterSnapshot action that is called in the destination AWS Region, and the action contained in the pre-signed URL. DestinationRegion - The name of the AWS Region that the DB cluster snapshot is to be created in. SourceDBClusterSnapshotIdentifier - The DB cluster snapshot identifier for the encrypted DB cluster snapshot to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source AWS Region. For example, if you are copying an encrypted DB cluster snapshot from the us-west-2 AWS Region, then your SourceDBClusterSnapshotIdentifier looks like the following example: arn:aws:rds:us-west-2:123456789012:cluster-snapshot:aurora-cluster1-snapshot-20161115. To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (AWS Signature Version 4) and Signature Version 4 Signing Process. If you are using an AWS SDK tool or the AWS CLI, you can specify SourceRegion (or --source-region for the AWS CLI) instead of specifying PreSignedUrl manually. Specifying SourceRegion autogenerates a pre-signed URL that is a valid request for the operation that can be executed in the source AWS Region. If you supply a value for this operation's SourceRegion parameter, a pre-signed URL will be calculated on your behalf.
|
|
1419
1435
|
*/
|
|
1420
1436
|
PreSignedUrl?: String;
|
|
1421
1437
|
/**
|
|
@@ -1459,7 +1475,7 @@ declare namespace RDS {
|
|
|
1459
1475
|
*/
|
|
1460
1476
|
TargetDBSnapshotIdentifier: String;
|
|
1461
1477
|
/**
|
|
1462
|
-
* The AWS KMS key
|
|
1478
|
+
* The AWS KMS key identifier for an encrypted DB snapshot. The AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the AWS KMS customer master key (CMK). If you copy an encrypted DB snapshot from your AWS account, you can specify a value for this parameter to encrypt the copy with a new AWS KMS CMK. If you don't specify a value for this parameter, then the copy of the DB snapshot is encrypted with the same AWS KMS key as the source DB snapshot. If you copy an encrypted DB snapshot that is shared from another AWS account, then you must specify a value for this parameter. If you specify this parameter when you copy an unencrypted snapshot, the copy is encrypted. If you copy an encrypted snapshot to a different AWS Region, then you must specify a AWS KMS key identifier for the destination AWS Region. AWS KMS CMKs are specific to the AWS Region that they are created in, and you can't use CMKs from one AWS Region in another AWS Region.
|
|
1463
1479
|
*/
|
|
1464
1480
|
KmsKeyId?: String;
|
|
1465
1481
|
Tags?: TagList;
|
|
@@ -1468,7 +1484,7 @@ declare namespace RDS {
|
|
|
1468
1484
|
*/
|
|
1469
1485
|
CopyTags?: BooleanOptional;
|
|
1470
1486
|
/**
|
|
1471
|
-
* The URL that contains a Signature Version 4 signed request for the CopyDBSnapshot API action in the source AWS Region that contains the source DB snapshot to copy. You must specify this parameter when you copy an encrypted DB snapshot from another AWS Region by using the Amazon RDS API. Don't specify PreSignedUrl when you are copying an encrypted DB snapshot in the same AWS Region. The presigned URL must be a valid request for the CopyDBSnapshot API action that can be executed in the source AWS Region that contains the encrypted DB snapshot to be copied. The presigned URL request must contain the following parameter values: DestinationRegion - The AWS Region that the encrypted DB snapshot is copied to. This AWS Region is the same one where the CopyDBSnapshot action is called that contains this presigned URL. For example, if you copy an encrypted DB snapshot from the us-west-2 AWS Region to the us-east-1 AWS Region, then you call the CopyDBSnapshot action in the us-east-1 AWS Region and provide a presigned URL that contains a call to the CopyDBSnapshot action in the us-west-2 AWS Region. For this example, the DestinationRegion in the presigned URL must be set to the us-east-1 AWS Region. KmsKeyId - The AWS KMS key identifier for the key to use to encrypt the copy of the DB snapshot in the destination AWS Region. This is the same identifier for both the CopyDBSnapshot action that is called in the destination AWS Region, and the action contained in the presigned URL. SourceDBSnapshotIdentifier - The DB snapshot identifier for the encrypted snapshot to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source AWS Region. For example, if you are copying an encrypted DB snapshot from the us-west-2 AWS Region, then your SourceDBSnapshotIdentifier looks like the following example: arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20161115. To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (AWS Signature Version 4) and Signature Version 4 Signing Process. If you are using an AWS SDK tool or the AWS CLI, you can specify SourceRegion (or --source-region for the AWS CLI) instead of specifying PreSignedUrl manually. Specifying SourceRegion autogenerates a pre-signed URL that is a valid request for the operation that can be executed in the source AWS Region. If you supply a value for this operation's SourceRegion parameter, a pre-signed URL will be calculated on your behalf.
|
|
1487
|
+
* The URL that contains a Signature Version 4 signed request for the CopyDBSnapshot API action in the source AWS Region that contains the source DB snapshot to copy. You must specify this parameter when you copy an encrypted DB snapshot from another AWS Region by using the Amazon RDS API. Don't specify PreSignedUrl when you are copying an encrypted DB snapshot in the same AWS Region. The presigned URL must be a valid request for the CopyDBSnapshot API action that can be executed in the source AWS Region that contains the encrypted DB snapshot to be copied. The presigned URL request must contain the following parameter values: DestinationRegion - The AWS Region that the encrypted DB snapshot is copied to. This AWS Region is the same one where the CopyDBSnapshot action is called that contains this presigned URL. For example, if you copy an encrypted DB snapshot from the us-west-2 AWS Region to the us-east-1 AWS Region, then you call the CopyDBSnapshot action in the us-east-1 AWS Region and provide a presigned URL that contains a call to the CopyDBSnapshot action in the us-west-2 AWS Region. For this example, the DestinationRegion in the presigned URL must be set to the us-east-1 AWS Region. KmsKeyId - The AWS KMS key identifier for the customer master key (CMK) to use to encrypt the copy of the DB snapshot in the destination AWS Region. This is the same identifier for both the CopyDBSnapshot action that is called in the destination AWS Region, and the action contained in the presigned URL. SourceDBSnapshotIdentifier - The DB snapshot identifier for the encrypted snapshot to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source AWS Region. For example, if you are copying an encrypted DB snapshot from the us-west-2 AWS Region, then your SourceDBSnapshotIdentifier looks like the following example: arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20161115. To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (AWS Signature Version 4) and Signature Version 4 Signing Process. If you are using an AWS SDK tool or the AWS CLI, you can specify SourceRegion (or --source-region for the AWS CLI) instead of specifying PreSignedUrl manually. Specifying SourceRegion autogenerates a pre-signed URL that is a valid request for the operation that can be executed in the source AWS Region. If you supply a value for this operation's SourceRegion parameter, a pre-signed URL will be calculated on your behalf.
|
|
1472
1488
|
*/
|
|
1473
1489
|
PreSignedUrl?: String;
|
|
1474
1490
|
/**
|
|
@@ -1630,11 +1646,11 @@ declare namespace RDS {
|
|
|
1630
1646
|
*/
|
|
1631
1647
|
StorageEncrypted?: BooleanOptional;
|
|
1632
1648
|
/**
|
|
1633
|
-
* The AWS KMS key identifier for an encrypted DB cluster. The KMS key identifier is the
|
|
1649
|
+
* The AWS KMS key identifier for an encrypted DB cluster. The AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the AWS KMS customer master key (CMK). To use a CMK in a different AWS account, specify the key ARN or alias ARN. When a CMK isn't specified in KmsKeyId: If ReplicationSourceIdentifier identifies an encrypted source, then Amazon RDS will use the CMK used to encrypt the source. Otherwise, Amazon RDS will use your default CMK. If the StorageEncrypted parameter is enabled and ReplicationSourceIdentifier isn't specified, then Amazon RDS will use your default CMK. There is a default CMK for your AWS account. Your AWS account has a different default CMK for each AWS Region. If you create a read replica of an encrypted DB cluster in another AWS Region, you must set KmsKeyId to a AWS KMS key identifier that is valid in the destination AWS Region. This CMK is used to encrypt the read replica in that AWS Region.
|
|
1634
1650
|
*/
|
|
1635
1651
|
KmsKeyId?: String;
|
|
1636
1652
|
/**
|
|
1637
|
-
* A URL that contains a Signature Version 4 signed request for the CreateDBCluster action to be called in the source AWS Region where the DB cluster is replicated from. You only need to specify PreSignedUrl when you are performing cross-region replication from an encrypted DB cluster. The pre-signed URL must be a valid request for the CreateDBCluster API action that can be executed in the source AWS Region that contains the encrypted DB cluster to be copied. The pre-signed URL request must contain the following parameter values: KmsKeyId - The AWS KMS key identifier for the key to use to encrypt the copy of the DB cluster in the destination AWS Region. This should refer to the same KMS
|
|
1653
|
+
* A URL that contains a Signature Version 4 signed request for the CreateDBCluster action to be called in the source AWS Region where the DB cluster is replicated from. You only need to specify PreSignedUrl when you are performing cross-region replication from an encrypted DB cluster. The pre-signed URL must be a valid request for the CreateDBCluster API action that can be executed in the source AWS Region that contains the encrypted DB cluster to be copied. The pre-signed URL request must contain the following parameter values: KmsKeyId - The AWS KMS key identifier for the key to use to encrypt the copy of the DB cluster in the destination AWS Region. This should refer to the same AWS KMS CMK for both the CreateDBCluster action that is called in the destination AWS Region, and the action contained in the pre-signed URL. DestinationRegion - The name of the AWS Region that Aurora read replica will be created in. ReplicationSourceIdentifier - The DB cluster identifier for the encrypted DB cluster to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source AWS Region. For example, if you are copying an encrypted DB cluster from the us-west-2 AWS Region, then your ReplicationSourceIdentifier would look like Example: arn:aws:rds:us-west-2:123456789012:cluster:aurora-cluster1. To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (AWS Signature Version 4) and Signature Version 4 Signing Process. If you are using an AWS SDK tool or the AWS CLI, you can specify SourceRegion (or --source-region for the AWS CLI) instead of specifying PreSignedUrl manually. Specifying SourceRegion autogenerates a pre-signed URL that is a valid request for the operation that can be executed in the source AWS Region. If you supply a value for this operation's SourceRegion parameter, a pre-signed URL will be calculated on your behalf.
|
|
1638
1654
|
*/
|
|
1639
1655
|
PreSignedUrl?: String;
|
|
1640
1656
|
/**
|
|
@@ -1857,7 +1873,7 @@ declare namespace RDS {
|
|
|
1857
1873
|
*/
|
|
1858
1874
|
StorageEncrypted?: BooleanOptional;
|
|
1859
1875
|
/**
|
|
1860
|
-
* The AWS KMS key identifier for an encrypted DB instance. The KMS key identifier is the
|
|
1876
|
+
* The AWS KMS key identifier for an encrypted DB instance. The AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the AWS KMS customer master key (CMK). To use a CMK in a different AWS account, specify the key ARN or alias ARN. Amazon Aurora Not applicable. The AWS KMS key identifier is managed by the DB cluster. For more information, see CreateDBCluster. If StorageEncrypted is enabled, and you do not specify a value for the KmsKeyId parameter, then Amazon RDS uses your default CMK. There is a default CMK for your AWS account. Your AWS account has a different default CMK for each AWS Region.
|
|
1861
1877
|
*/
|
|
1862
1878
|
KmsKeyId?: String;
|
|
1863
1879
|
/**
|
|
@@ -1897,7 +1913,7 @@ declare namespace RDS {
|
|
|
1897
1913
|
*/
|
|
1898
1914
|
EnablePerformanceInsights?: BooleanOptional;
|
|
1899
1915
|
/**
|
|
1900
|
-
* The AWS KMS key identifier for encryption of Performance Insights data. The KMS key
|
|
1916
|
+
* The AWS KMS key identifier for encryption of Performance Insights data. The AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the AWS KMS customer master key (CMK). If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS uses your default CMK. There is a default CMK for your AWS account. Your AWS account has a different default CMK for each AWS Region.
|
|
1901
1917
|
*/
|
|
1902
1918
|
PerformanceInsightsKMSKeyId?: String;
|
|
1903
1919
|
/**
|
|
@@ -1992,7 +2008,7 @@ declare namespace RDS {
|
|
|
1992
2008
|
*/
|
|
1993
2009
|
MonitoringRoleArn?: String;
|
|
1994
2010
|
/**
|
|
1995
|
-
* The AWS KMS key
|
|
2011
|
+
* The AWS KMS key identifier for an encrypted read replica. The AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the AWS KMS CMK. If you create an encrypted read replica in the same AWS Region as the source DB instance, then you do not have to specify a value for this parameter. The read replica is encrypted with the same AWS KMS CMK as the source DB instance. If you create an encrypted read replica in a different AWS Region, then you must specify a AWS KMS key identifier for the destination AWS Region. AWS KMS CMKs are specific to the AWS Region that they are created in, and you can't use CMKs from one AWS Region in another AWS Region. You can't create an encrypted read replica from an unencrypted DB instance.
|
|
1996
2012
|
*/
|
|
1997
2013
|
KmsKeyId?: String;
|
|
1998
2014
|
/**
|
|
@@ -2008,7 +2024,7 @@ declare namespace RDS {
|
|
|
2008
2024
|
*/
|
|
2009
2025
|
EnablePerformanceInsights?: BooleanOptional;
|
|
2010
2026
|
/**
|
|
2011
|
-
* The AWS KMS key identifier for encryption of Performance Insights data. The KMS key
|
|
2027
|
+
* The AWS KMS key identifier for encryption of Performance Insights data. The AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the AWS KMS customer master key (CMK). If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS uses your default CMK. There is a default CMK for your AWS account. Your AWS account has a different default CMK for each AWS Region.
|
|
2012
2028
|
*/
|
|
2013
2029
|
PerformanceInsightsKMSKeyId?: String;
|
|
2014
2030
|
/**
|
|
@@ -2414,11 +2430,11 @@ declare namespace RDS {
|
|
|
2414
2430
|
*/
|
|
2415
2431
|
StorageEncrypted?: Boolean;
|
|
2416
2432
|
/**
|
|
2417
|
-
* If StorageEncrypted is enabled, the AWS KMS key identifier for the encrypted DB cluster.
|
|
2433
|
+
* If StorageEncrypted is enabled, the AWS KMS key identifier for the encrypted DB cluster. The AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the AWS KMS customer master key (CMK).
|
|
2418
2434
|
*/
|
|
2419
2435
|
KmsKeyId?: String;
|
|
2420
2436
|
/**
|
|
2421
|
-
* The AWS Region-unique, immutable identifier for the DB cluster. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS
|
|
2437
|
+
* The AWS Region-unique, immutable identifier for the DB cluster. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS CMK for the DB cluster is accessed.
|
|
2422
2438
|
*/
|
|
2423
2439
|
DbClusterResourceId?: String;
|
|
2424
2440
|
/**
|
|
@@ -2483,7 +2499,7 @@ declare namespace RDS {
|
|
|
2483
2499
|
*/
|
|
2484
2500
|
ActivityStreamStatus?: ActivityStreamStatus;
|
|
2485
2501
|
/**
|
|
2486
|
-
* The AWS KMS key identifier used for encrypting messages in the database activity stream.
|
|
2502
|
+
* The AWS KMS key identifier used for encrypting messages in the database activity stream. The AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the AWS KMS customer master key (CMK).
|
|
2487
2503
|
*/
|
|
2488
2504
|
ActivityStreamKmsKeyId?: String;
|
|
2489
2505
|
/**
|
|
@@ -2791,7 +2807,7 @@ declare namespace RDS {
|
|
|
2791
2807
|
*/
|
|
2792
2808
|
StorageEncrypted?: Boolean;
|
|
2793
2809
|
/**
|
|
2794
|
-
* If StorageEncrypted is true, the AWS KMS key identifier for the encrypted DB cluster snapshot.
|
|
2810
|
+
* If StorageEncrypted is true, the AWS KMS key identifier for the encrypted DB cluster snapshot. The AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the AWS KMS customer master key (CMK).
|
|
2795
2811
|
*/
|
|
2796
2812
|
KmsKeyId?: String;
|
|
2797
2813
|
/**
|
|
@@ -3083,11 +3099,11 @@ declare namespace RDS {
|
|
|
3083
3099
|
*/
|
|
3084
3100
|
StorageEncrypted?: Boolean;
|
|
3085
3101
|
/**
|
|
3086
|
-
* If StorageEncrypted is true, the AWS KMS key identifier for the encrypted DB instance.
|
|
3102
|
+
* If StorageEncrypted is true, the AWS KMS key identifier for the encrypted DB instance. The AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the AWS KMS customer master key (CMK).
|
|
3087
3103
|
*/
|
|
3088
3104
|
KmsKeyId?: String;
|
|
3089
3105
|
/**
|
|
3090
|
-
* The AWS Region-unique, immutable identifier for the DB instance. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS key for the DB instance is accessed.
|
|
3106
|
+
* The AWS Region-unique, immutable identifier for the DB instance. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS customer master key (CMK) for the DB instance is accessed.
|
|
3091
3107
|
*/
|
|
3092
3108
|
DbiResourceId?: String;
|
|
3093
3109
|
/**
|
|
@@ -3135,7 +3151,7 @@ declare namespace RDS {
|
|
|
3135
3151
|
*/
|
|
3136
3152
|
PerformanceInsightsEnabled?: BooleanOptional;
|
|
3137
3153
|
/**
|
|
3138
|
-
* The AWS KMS key identifier for encryption of Performance Insights data. The KMS key
|
|
3154
|
+
* The AWS KMS key identifier for encryption of Performance Insights data. The AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the AWS KMS customer master key (CMK).
|
|
3139
3155
|
*/
|
|
3140
3156
|
PerformanceInsightsKMSKeyId?: String;
|
|
3141
3157
|
/**
|
|
@@ -3167,10 +3183,14 @@ declare namespace RDS {
|
|
|
3167
3183
|
*/
|
|
3168
3184
|
MaxAllocatedStorage?: IntegerOptional;
|
|
3169
3185
|
TagList?: TagList;
|
|
3186
|
+
/**
|
|
3187
|
+
* The list of replicated automated backups associated with the DB instance.
|
|
3188
|
+
*/
|
|
3189
|
+
DBInstanceAutomatedBackupsReplications?: DBInstanceAutomatedBackupsReplicationList;
|
|
3170
3190
|
}
|
|
3171
3191
|
export interface DBInstanceAutomatedBackup {
|
|
3172
3192
|
/**
|
|
3173
|
-
* The Amazon Resource Name (ARN) for the automated
|
|
3193
|
+
* The Amazon Resource Name (ARN) for the automated backups.
|
|
3174
3194
|
*/
|
|
3175
3195
|
DBInstanceArn?: String;
|
|
3176
3196
|
/**
|
|
@@ -3250,7 +3270,7 @@ declare namespace RDS {
|
|
|
3250
3270
|
*/
|
|
3251
3271
|
StorageType?: String;
|
|
3252
3272
|
/**
|
|
3253
|
-
* The AWS KMS key ID for an automated backup. The KMS key
|
|
3273
|
+
* The AWS KMS key ID for an automated backup. The AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the AWS KMS customer master key (CMK).
|
|
3254
3274
|
*/
|
|
3255
3275
|
KmsKeyId?: String;
|
|
3256
3276
|
/**
|
|
@@ -3261,6 +3281,18 @@ declare namespace RDS {
|
|
|
3261
3281
|
* True if mapping of AWS Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.
|
|
3262
3282
|
*/
|
|
3263
3283
|
IAMDatabaseAuthenticationEnabled?: Boolean;
|
|
3284
|
+
/**
|
|
3285
|
+
* The retention period for the automated backups.
|
|
3286
|
+
*/
|
|
3287
|
+
BackupRetentionPeriod?: IntegerOptional;
|
|
3288
|
+
/**
|
|
3289
|
+
* The Amazon Resource Name (ARN) for the replicated automated backups.
|
|
3290
|
+
*/
|
|
3291
|
+
DBInstanceAutomatedBackupsArn?: String;
|
|
3292
|
+
/**
|
|
3293
|
+
* The list of replications to different AWS Regions associated with the automated backup.
|
|
3294
|
+
*/
|
|
3295
|
+
DBInstanceAutomatedBackupsReplications?: DBInstanceAutomatedBackupsReplicationList;
|
|
3264
3296
|
}
|
|
3265
3297
|
export type DBInstanceAutomatedBackupList = DBInstanceAutomatedBackup[];
|
|
3266
3298
|
export interface DBInstanceAutomatedBackupMessage {
|
|
@@ -3273,6 +3305,13 @@ declare namespace RDS {
|
|
|
3273
3305
|
*/
|
|
3274
3306
|
DBInstanceAutomatedBackups?: DBInstanceAutomatedBackupList;
|
|
3275
3307
|
}
|
|
3308
|
+
export interface DBInstanceAutomatedBackupsReplication {
|
|
3309
|
+
/**
|
|
3310
|
+
* The Amazon Resource Name (ARN) of the replicated automated backups.
|
|
3311
|
+
*/
|
|
3312
|
+
DBInstanceAutomatedBackupsArn?: String;
|
|
3313
|
+
}
|
|
3314
|
+
export type DBInstanceAutomatedBackupsReplicationList = DBInstanceAutomatedBackupsReplication[];
|
|
3276
3315
|
export type DBInstanceList = DBInstance[];
|
|
3277
3316
|
export interface DBInstanceMessage {
|
|
3278
3317
|
/**
|
|
@@ -3641,7 +3680,7 @@ declare namespace RDS {
|
|
|
3641
3680
|
*/
|
|
3642
3681
|
Encrypted?: Boolean;
|
|
3643
3682
|
/**
|
|
3644
|
-
* If Encrypted is true, the AWS KMS key identifier for the encrypted DB snapshot.
|
|
3683
|
+
* If Encrypted is true, the AWS KMS key identifier for the encrypted DB snapshot. The AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the AWS KMS customer master key (CMK).
|
|
3645
3684
|
*/
|
|
3646
3685
|
KmsKeyId?: String;
|
|
3647
3686
|
/**
|
|
@@ -3786,7 +3825,11 @@ declare namespace RDS {
|
|
|
3786
3825
|
/**
|
|
3787
3826
|
* The identifier for the source DB instance, which can't be changed and which is unique to an AWS Region.
|
|
3788
3827
|
*/
|
|
3789
|
-
DbiResourceId
|
|
3828
|
+
DbiResourceId?: String;
|
|
3829
|
+
/**
|
|
3830
|
+
* The Amazon Resource Name (ARN) of the automated backups to delete, for example, arn:aws:rds:us-east-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE.
|
|
3831
|
+
*/
|
|
3832
|
+
DBInstanceAutomatedBackupsArn?: String;
|
|
3790
3833
|
}
|
|
3791
3834
|
export interface DeleteDBInstanceAutomatedBackupResult {
|
|
3792
3835
|
DBInstanceAutomatedBackup?: DBInstanceAutomatedBackup;
|
|
@@ -4151,6 +4194,10 @@ declare namespace RDS {
|
|
|
4151
4194
|
* The pagination token provided in the previous request. If this parameter is specified the response includes only records beyond the marker, up to MaxRecords.
|
|
4152
4195
|
*/
|
|
4153
4196
|
Marker?: String;
|
|
4197
|
+
/**
|
|
4198
|
+
* The Amazon Resource Name (ARN) of the replicated automated backups, for example, arn:aws:rds:us-east-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE.
|
|
4199
|
+
*/
|
|
4200
|
+
DBInstanceAutomatedBackupsArn?: String;
|
|
4154
4201
|
}
|
|
4155
4202
|
export interface DescribeDBInstancesMessage {
|
|
4156
4203
|
/**
|
|
@@ -5080,7 +5127,7 @@ declare namespace RDS {
|
|
|
5080
5127
|
*/
|
|
5081
5128
|
IamRoleArn?: String;
|
|
5082
5129
|
/**
|
|
5083
|
-
* The
|
|
5130
|
+
* The key identifier of the AWS KMS customer master key (CMK) that is used to encrypt the snapshot when it's exported to Amazon S3. The AWS KMS CMK identifier is its key ARN, key ID, alias ARN, or alias name. The IAM role used for the snapshot export must have encryption and decryption permissions to use this AWS KMS CMK.
|
|
5084
5131
|
*/
|
|
5085
5132
|
KmsKeyId?: String;
|
|
5086
5133
|
/**
|
|
@@ -5147,7 +5194,7 @@ declare namespace RDS {
|
|
|
5147
5194
|
*/
|
|
5148
5195
|
GlobalClusterIdentifier?: String;
|
|
5149
5196
|
/**
|
|
5150
|
-
* The AWS Region-unique, immutable identifier for the global database cluster. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS key for the DB cluster is accessed.
|
|
5197
|
+
* The AWS Region-unique, immutable identifier for the global database cluster. This identifier is found in AWS CloudTrail log entries whenever the AWS KMS customer master key (CMK) for the DB cluster is accessed.
|
|
5151
5198
|
*/
|
|
5152
5199
|
GlobalClusterResourceId?: String;
|
|
5153
5200
|
/**
|
|
@@ -5645,7 +5692,7 @@ declare namespace RDS {
|
|
|
5645
5692
|
*/
|
|
5646
5693
|
EnablePerformanceInsights?: BooleanOptional;
|
|
5647
5694
|
/**
|
|
5648
|
-
* The AWS KMS key identifier for encryption of Performance Insights data. The KMS key
|
|
5695
|
+
* The AWS KMS key identifier for encryption of Performance Insights data. The AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the AWS KMS customer master key (CMK). If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS uses your default CMK. There is a default CMK for your AWS account. Your AWS account has a different default CMK for each AWS Region.
|
|
5649
5696
|
*/
|
|
5650
5697
|
PerformanceInsightsKMSKeyId?: String;
|
|
5651
5698
|
/**
|
|
@@ -6597,7 +6644,7 @@ declare namespace RDS {
|
|
|
6597
6644
|
*/
|
|
6598
6645
|
DBInstanceIdentifier: String;
|
|
6599
6646
|
/**
|
|
6600
|
-
* The Amazon Resource Name (ARN) of the IAM role to disassociate from the DB instance, for example arn:aws:iam::123456789012:role/AccessRole.
|
|
6647
|
+
* The Amazon Resource Name (ARN) of the IAM role to disassociate from the DB instance, for example, arn:aws:iam::123456789012:role/AccessRole.
|
|
6601
6648
|
*/
|
|
6602
6649
|
RoleArn: String;
|
|
6603
6650
|
/**
|
|
@@ -6868,7 +6915,7 @@ declare namespace RDS {
|
|
|
6868
6915
|
*/
|
|
6869
6916
|
StorageEncrypted?: BooleanOptional;
|
|
6870
6917
|
/**
|
|
6871
|
-
* The AWS KMS key identifier for an encrypted DB cluster. The KMS key identifier is the
|
|
6918
|
+
* The AWS KMS key identifier for an encrypted DB cluster. The AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the AWS KMS customer master key (CMK). To use a CMK in a different AWS account, specify the key ARN or alias ARN. If the StorageEncrypted parameter is enabled, and you do not specify a value for the KmsKeyId parameter, then Amazon RDS will use your default CMK. There is a default CMK for your AWS account. Your AWS account has a different default CMK for each AWS Region.
|
|
6872
6919
|
*/
|
|
6873
6920
|
KmsKeyId?: String;
|
|
6874
6921
|
/**
|
|
@@ -6969,7 +7016,7 @@ declare namespace RDS {
|
|
|
6969
7016
|
*/
|
|
6970
7017
|
Tags?: TagList;
|
|
6971
7018
|
/**
|
|
6972
|
-
* The AWS KMS key identifier to use when restoring an encrypted DB cluster from a DB snapshot or DB cluster snapshot. The KMS key identifier is the
|
|
7019
|
+
* The AWS KMS key identifier to use when restoring an encrypted DB cluster from a DB snapshot or DB cluster snapshot. The AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the AWS KMS customer master key (CMK). To use a CMK in a different AWS account, specify the key ARN or alias ARN. When you don't specify a value for the KmsKeyId parameter, then the following occurs: If the DB snapshot or DB cluster snapshot in SnapshotIdentifier is encrypted, then the restored DB cluster is encrypted using the AWS KMS CMK that was used to encrypt the DB snapshot or DB cluster snapshot. If the DB snapshot or DB cluster snapshot in SnapshotIdentifier isn't encrypted, then the restored DB cluster isn't encrypted.
|
|
6973
7020
|
*/
|
|
6974
7021
|
KmsKeyId?: String;
|
|
6975
7022
|
/**
|
|
@@ -7055,7 +7102,7 @@ declare namespace RDS {
|
|
|
7055
7102
|
VpcSecurityGroupIds?: VpcSecurityGroupIdList;
|
|
7056
7103
|
Tags?: TagList;
|
|
7057
7104
|
/**
|
|
7058
|
-
* The AWS KMS key identifier to use when restoring an encrypted DB cluster from an encrypted DB cluster. The KMS key identifier is the
|
|
7105
|
+
* The AWS KMS key identifier to use when restoring an encrypted DB cluster from an encrypted DB cluster. The AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the AWS KMS customer master key (CMK). To use a CMK in a different AWS account, specify the key ARN or alias ARN. You can restore to a new DB cluster and encrypt the new DB cluster with a AWS KMS CMK that is different than the AWS KMS key used to encrypt the source DB cluster. The new DB cluster is encrypted with the AWS KMS CMK identified by the KmsKeyId parameter. If you don't specify a value for the KmsKeyId parameter, then the following occurs: If the DB cluster is encrypted, then the restored DB cluster is encrypted using the AWS KMS CMK that was used to encrypt the source DB cluster. If the DB cluster isn't encrypted, then the restored DB cluster isn't encrypted. If DBClusterIdentifier refers to a DB cluster that isn't encrypted, then the restore request is rejected.
|
|
7059
7106
|
*/
|
|
7060
7107
|
KmsKeyId?: String;
|
|
7061
7108
|
/**
|
|
@@ -7314,7 +7361,7 @@ declare namespace RDS {
|
|
|
7314
7361
|
*/
|
|
7315
7362
|
StorageEncrypted?: BooleanOptional;
|
|
7316
7363
|
/**
|
|
7317
|
-
* The AWS KMS key identifier for an encrypted DB instance. The KMS key identifier is the
|
|
7364
|
+
* The AWS KMS key identifier for an encrypted DB instance. The AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the AWS KMS customer master key (CMK). To use a CMK in a different AWS account, specify the key ARN or alias ARN. If the StorageEncrypted parameter is enabled, and you do not specify a value for the KmsKeyId parameter, then Amazon RDS will use your default CMK. There is a default CMK for your AWS account. Your AWS account has a different default CMK for each AWS Region.
|
|
7318
7365
|
*/
|
|
7319
7366
|
KmsKeyId?: String;
|
|
7320
7367
|
/**
|
|
@@ -7358,7 +7405,7 @@ declare namespace RDS {
|
|
|
7358
7405
|
*/
|
|
7359
7406
|
EnablePerformanceInsights?: BooleanOptional;
|
|
7360
7407
|
/**
|
|
7361
|
-
* The AWS KMS key identifier for encryption of Performance Insights data. The KMS key
|
|
7408
|
+
* The AWS KMS key identifier for encryption of Performance Insights data. The AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the AWS KMS customer master key (CMK). If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS uses your default CMK. There is a default CMK for your AWS account. Your AWS account has a different default CMK for each AWS Region.
|
|
7362
7409
|
*/
|
|
7363
7410
|
PerformanceInsightsKMSKeyId?: String;
|
|
7364
7411
|
/**
|
|
@@ -7515,6 +7562,10 @@ declare namespace RDS {
|
|
|
7515
7562
|
* The upper limit to which Amazon RDS can automatically scale the storage of the DB instance.
|
|
7516
7563
|
*/
|
|
7517
7564
|
MaxAllocatedStorage?: IntegerOptional;
|
|
7565
|
+
/**
|
|
7566
|
+
* The Amazon Resource Name (ARN) of the replicated automated backups from which to restore, for example, arn:aws:rds:useast-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE.
|
|
7567
|
+
*/
|
|
7568
|
+
SourceDBInstanceAutomatedBackupsArn?: String;
|
|
7518
7569
|
}
|
|
7519
7570
|
export interface RestoreDBInstanceToPointInTimeResult {
|
|
7520
7571
|
DBInstance?: DBInstance;
|
|
@@ -7612,6 +7663,10 @@ declare namespace RDS {
|
|
|
7612
7663
|
* The status of the source AWS Region.
|
|
7613
7664
|
*/
|
|
7614
7665
|
Status?: String;
|
|
7666
|
+
/**
|
|
7667
|
+
* Whether the source AWS Region supports replicating automated backups to the current AWS Region.
|
|
7668
|
+
*/
|
|
7669
|
+
SupportsDBInstanceAutomatedBackupsReplication?: Boolean;
|
|
7615
7670
|
}
|
|
7616
7671
|
export type SourceRegionList = SourceRegion[];
|
|
7617
7672
|
export interface SourceRegionMessage {
|
|
@@ -7627,7 +7682,7 @@ declare namespace RDS {
|
|
|
7627
7682
|
export type SourceType = "db-instance"|"db-parameter-group"|"db-security-group"|"db-snapshot"|"db-cluster"|"db-cluster-snapshot"|string;
|
|
7628
7683
|
export interface StartActivityStreamRequest {
|
|
7629
7684
|
/**
|
|
7630
|
-
* The Amazon Resource Name (ARN) of the DB cluster, for example arn:aws:rds:us-east-1:12345667890:cluster:das-cluster.
|
|
7685
|
+
* The Amazon Resource Name (ARN) of the DB cluster, for example, arn:aws:rds:us-east-1:12345667890:cluster:das-cluster.
|
|
7631
7686
|
*/
|
|
7632
7687
|
ResourceArn: String;
|
|
7633
7688
|
/**
|
|
@@ -7635,7 +7690,7 @@ declare namespace RDS {
|
|
|
7635
7690
|
*/
|
|
7636
7691
|
Mode: ActivityStreamMode;
|
|
7637
7692
|
/**
|
|
7638
|
-
* The AWS KMS key identifier for encrypting messages in the database activity stream. The key identifier
|
|
7693
|
+
* The AWS KMS key identifier for encrypting messages in the database activity stream. The AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the AWS KMS customer master key (CMK).
|
|
7639
7694
|
*/
|
|
7640
7695
|
KmsKeyId: String;
|
|
7641
7696
|
/**
|
|
@@ -7674,6 +7729,27 @@ declare namespace RDS {
|
|
|
7674
7729
|
export interface StartDBClusterResult {
|
|
7675
7730
|
DBCluster?: DBCluster;
|
|
7676
7731
|
}
|
|
7732
|
+
export interface StartDBInstanceAutomatedBackupsReplicationMessage {
|
|
7733
|
+
/**
|
|
7734
|
+
* The Amazon Resource Name (ARN) of the source DB instance for the replicated automated backups, for example, arn:aws:rds:us-west-2:123456789012:db:mydatabase.
|
|
7735
|
+
*/
|
|
7736
|
+
SourceDBInstanceArn: String;
|
|
7737
|
+
/**
|
|
7738
|
+
* The retention period for the replicated automated backups.
|
|
7739
|
+
*/
|
|
7740
|
+
BackupRetentionPeriod?: IntegerOptional;
|
|
7741
|
+
/**
|
|
7742
|
+
* The AWS KMS key identifier for encryption of the replicated automated backups. The KMS key ID is the Amazon Resource Name (ARN) for the KMS encryption key in the destination AWS Region, for example, arn:aws:kms:us-east-1:123456789012:key/AKIAIOSFODNN7EXAMPLE.
|
|
7743
|
+
*/
|
|
7744
|
+
KmsKeyId?: String;
|
|
7745
|
+
/**
|
|
7746
|
+
* A URL that contains a Signature Version 4 signed request for the StartDBInstanceAutomatedBackupsReplication action to be called in the AWS Region of the source DB instance. The presigned URL must be a valid request for the StartDBInstanceAutomatedBackupsReplication API action that can be executed in the AWS Region that contains the source DB instance.
|
|
7747
|
+
*/
|
|
7748
|
+
PreSignedUrl?: String;
|
|
7749
|
+
}
|
|
7750
|
+
export interface StartDBInstanceAutomatedBackupsReplicationResult {
|
|
7751
|
+
DBInstanceAutomatedBackup?: DBInstanceAutomatedBackup;
|
|
7752
|
+
}
|
|
7677
7753
|
export interface StartDBInstanceMessage {
|
|
7678
7754
|
/**
|
|
7679
7755
|
* The user-supplied instance identifier.
|
|
@@ -7701,7 +7777,7 @@ declare namespace RDS {
|
|
|
7701
7777
|
*/
|
|
7702
7778
|
IamRoleArn: String;
|
|
7703
7779
|
/**
|
|
7704
|
-
* The ID of the AWS KMS key to use to encrypt the snapshot exported to Amazon S3. The KMS key
|
|
7780
|
+
* The ID of the AWS KMS customer master key (CMK) to use to encrypt the snapshot exported to Amazon S3. The AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the AWS KMS customer master key (CMK). The caller of this operation must be authorized to execute the following operations. These can be set in the AWS KMS key policy: GrantOperation.Encrypt GrantOperation.Decrypt GrantOperation.GenerateDataKey GrantOperation.GenerateDataKeyWithoutPlaintext GrantOperation.ReEncryptFrom GrantOperation.ReEncryptTo GrantOperation.CreateGrant GrantOperation.DescribeKey GrantOperation.RetireGrant
|
|
7705
7781
|
*/
|
|
7706
7782
|
KmsKeyId: String;
|
|
7707
7783
|
/**
|
|
@@ -7725,7 +7801,7 @@ declare namespace RDS {
|
|
|
7725
7801
|
}
|
|
7726
7802
|
export interface StopActivityStreamResponse {
|
|
7727
7803
|
/**
|
|
7728
|
-
* The AWS KMS key identifier used for encrypting messages in the database activity stream.
|
|
7804
|
+
* The AWS KMS key identifier used for encrypting messages in the database activity stream. The AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the AWS KMS customer master key (CMK).
|
|
7729
7805
|
*/
|
|
7730
7806
|
KmsKeyId?: String;
|
|
7731
7807
|
/**
|
|
@@ -7746,6 +7822,15 @@ declare namespace RDS {
|
|
|
7746
7822
|
export interface StopDBClusterResult {
|
|
7747
7823
|
DBCluster?: DBCluster;
|
|
7748
7824
|
}
|
|
7825
|
+
export interface StopDBInstanceAutomatedBackupsReplicationMessage {
|
|
7826
|
+
/**
|
|
7827
|
+
* The Amazon Resource Name (ARN) of the source DB instance for which to stop replicating automated backups, for example, arn:aws:rds:us-west-2:123456789012:db:mydatabase.
|
|
7828
|
+
*/
|
|
7829
|
+
SourceDBInstanceArn: String;
|
|
7830
|
+
}
|
|
7831
|
+
export interface StopDBInstanceAutomatedBackupsReplicationResult {
|
|
7832
|
+
DBInstanceAutomatedBackup?: DBInstanceAutomatedBackup;
|
|
7833
|
+
}
|
|
7749
7834
|
export interface StopDBInstanceMessage {
|
|
7750
7835
|
/**
|
|
7751
7836
|
* The user-supplied instance identifier.
|