aws-sdk 2.1012.0 → 2.1016.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 +27 -1
- package/README.md +1 -1
- package/apis/auditmanager-2017-07-25.min.json +168 -12
- package/apis/auditmanager-2017-07-25.paginators.json +5 -0
- package/apis/autoscaling-2011-01-01.min.json +240 -94
- package/apis/chime-2018-05-01.min.json +4 -2
- package/apis/chime-sdk-identity-2021-04-20.min.json +362 -13
- package/apis/chime-sdk-identity-2021-04-20.paginators.json +5 -0
- package/apis/chime-sdk-messaging-2021-05-15.min.json +180 -29
- package/apis/ec2-2016-11-15.min.json +1331 -800
- package/apis/ec2-2016-11-15.paginators.json +12 -0
- package/apis/emr-containers-2020-10-01.min.json +18 -6
- package/apis/quicksight-2018-04-01.min.json +27 -21
- package/apis/rds-2014-10-31.min.json +412 -317
- package/apis/route53resolver-2018-04-01.min.json +85 -13
- package/apis/route53resolver-2018-04-01.paginators.json +6 -0
- package/apis/sagemaker-2017-07-24.min.json +924 -792
- package/apis/textract-2018-06-27.min.json +107 -43
- package/clients/auditmanager.d.ts +486 -305
- package/clients/autoscaling.d.ts +217 -15
- package/clients/chime.d.ts +8 -0
- package/clients/chimesdkidentity.d.ts +314 -2
- package/clients/chimesdkmessaging.d.ts +146 -15
- package/clients/connect.d.ts +11 -11
- package/clients/ec2.d.ts +548 -4
- package/clients/eks.d.ts +1 -1
- package/clients/emrcontainers.d.ts +18 -3
- package/clients/finspace.js +0 -1
- package/clients/finspacedata.js +0 -1
- package/clients/lexmodelsv2.js +0 -1
- package/clients/lookoutmetrics.js +0 -1
- package/clients/quicksight.d.ts +12 -2
- package/clients/rds.d.ts +361 -200
- package/clients/route53resolver.d.ts +94 -0
- package/clients/sagemaker.d.ts +152 -8
- package/clients/textract.d.ts +98 -6
- package/dist/aws-sdk-core-react-native.js +57 -22
- package/dist/aws-sdk-react-native.js +299 -340
- package/dist/aws-sdk.js +2134 -1234
- package/dist/aws-sdk.min.js +87 -87
- package/lib/core.js +1 -1
- package/lib/protocol/rest_json.js +6 -12
- package/lib/region_config.js +44 -1
- package/lib/region_config_data.json +81 -0
- package/lib/request.js +4 -6
- package/lib/service.js +1 -1
- package/package.json +2 -2
- package/scripts/region-checker/allowlist.js +4 -0
- package/lib/services/finspace.js +0 -23
- package/lib/services/finspacedata.js +0 -23
- package/lib/services/lexmodelsv2.js +0 -23
- package/lib/services/lookoutmetrics.js +0 -22
package/clients/rds.d.ts
CHANGED
|
@@ -22,11 +22,11 @@ declare class RDS extends Service {
|
|
|
22
22
|
*/
|
|
23
23
|
addRoleToDBCluster(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
24
24
|
/**
|
|
25
|
-
* Associates an Amazon Web Services Identity and Access Management (IAM) role with a DB instance. To add a role to a DB instance, the status of the DB instance must be available.
|
|
25
|
+
* Associates an Amazon Web Services Identity and Access Management (IAM) role with a DB instance. To add a role to a DB instance, the status of the DB instance must be available. This command doesn't apply to RDS Custom.
|
|
26
26
|
*/
|
|
27
27
|
addRoleToDBInstance(params: RDS.Types.AddRoleToDBInstanceMessage, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
28
28
|
/**
|
|
29
|
-
* Associates an Amazon Web Services Identity and Access Management (IAM) role with a DB instance. To add a role to a DB instance, the status of the DB instance must be available.
|
|
29
|
+
* Associates an Amazon Web Services Identity and Access Management (IAM) role with a DB instance. To add a role to a DB instance, the status of the DB instance must be available. This command doesn't apply to RDS Custom.
|
|
30
30
|
*/
|
|
31
31
|
addRoleToDBInstance(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
|
|
32
32
|
/**
|
|
@@ -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 Amazon Web Services Region. In that case, the Amazon Web Services Region where you call the CopyDBClusterSnapshot action is the destination Amazon Web Services Region for the encrypted DB cluster snapshot to be copied to. To copy an encrypted DB cluster snapshot from another Amazon Web Services Region, you must provide the following values: KmsKeyId - The Amazon Web Services Key Management System (Amazon Web Services KMS) key identifier for the key to use to encrypt the copy of the DB cluster snapshot in the destination Amazon Web Services Region. PreSignedUrl - A URL that contains a Signature Version 4 signed request for the CopyDBClusterSnapshot action to be called in the source Amazon Web Services 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 Amazon Web Services Region that contains the encrypted DB cluster snapshot to be copied. The pre-signed URL request must contain the following parameter values: KmsKeyId - The Amazon Web Services KMS key identifier for the
|
|
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 Amazon Web Services Region. In that case, the Amazon Web Services Region where you call the CopyDBClusterSnapshot action is the destination Amazon Web Services Region for the encrypted DB cluster snapshot to be copied to. To copy an encrypted DB cluster snapshot from another Amazon Web Services Region, you must provide the following values: KmsKeyId - The Amazon Web Services Key Management System (Amazon Web Services KMS) key identifier for the key to use to encrypt the copy of the DB cluster snapshot in the destination Amazon Web Services Region. PreSignedUrl - A URL that contains a Signature Version 4 signed request for the CopyDBClusterSnapshot action to be called in the source Amazon Web Services 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 Amazon Web Services Region that contains the encrypted DB cluster snapshot to be copied. The pre-signed URL request must contain the following parameter values: KmsKeyId - The Amazon Web Services KMS key identifier for the KMS key to use to encrypt the copy of the DB cluster snapshot in the destination Amazon Web Services Region. This is the same identifier for both the CopyDBClusterSnapshot action that is called in the destination Amazon Web Services Region, and the action contained in the pre-signed URL. DestinationRegion - The name of the Amazon Web Services 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 Amazon Web Services Region. For example, if you are copying an encrypted DB cluster snapshot from the us-west-2 Amazon Web Services 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 (Amazon Web Services Signature Version 4) and Signature Version 4 Signing Process. If you are using an Amazon Web Services SDK tool or the CLI, you can specify SourceRegion (or --source-region for the 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 Amazon Web Services Region. TargetDBClusterSnapshotIdentifier - The identifier for the new copy of the DB cluster snapshot in the destination Amazon Web Services 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 Amazon Web Services 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 Amazon Web Services 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 Amazon Web Services Region. In that case, the Amazon Web Services Region where you call the CopyDBClusterSnapshot action is the destination Amazon Web Services Region for the encrypted DB cluster snapshot to be copied to. To copy an encrypted DB cluster snapshot from another Amazon Web Services Region, you must provide the following values: KmsKeyId - The Amazon Web Services Key Management System (Amazon Web Services KMS) key identifier for the key to use to encrypt the copy of the DB cluster snapshot in the destination Amazon Web Services Region. PreSignedUrl - A URL that contains a Signature Version 4 signed request for the CopyDBClusterSnapshot action to be called in the source Amazon Web Services 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 Amazon Web Services Region that contains the encrypted DB cluster snapshot to be copied. The pre-signed URL request must contain the following parameter values: KmsKeyId - The Amazon Web Services KMS key identifier for the
|
|
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 Amazon Web Services Region. In that case, the Amazon Web Services Region where you call the CopyDBClusterSnapshot action is the destination Amazon Web Services Region for the encrypted DB cluster snapshot to be copied to. To copy an encrypted DB cluster snapshot from another Amazon Web Services Region, you must provide the following values: KmsKeyId - The Amazon Web Services Key Management System (Amazon Web Services KMS) key identifier for the key to use to encrypt the copy of the DB cluster snapshot in the destination Amazon Web Services Region. PreSignedUrl - A URL that contains a Signature Version 4 signed request for the CopyDBClusterSnapshot action to be called in the source Amazon Web Services 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 Amazon Web Services Region that contains the encrypted DB cluster snapshot to be copied. The pre-signed URL request must contain the following parameter values: KmsKeyId - The Amazon Web Services KMS key identifier for the KMS key to use to encrypt the copy of the DB cluster snapshot in the destination Amazon Web Services Region. This is the same identifier for both the CopyDBClusterSnapshot action that is called in the destination Amazon Web Services Region, and the action contained in the pre-signed URL. DestinationRegion - The name of the Amazon Web Services 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 Amazon Web Services Region. For example, if you are copying an encrypted DB cluster snapshot from the us-west-2 Amazon Web Services 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 (Amazon Web Services Signature Version 4) and Signature Version 4 Signing Process. If you are using an Amazon Web Services SDK tool or the CLI, you can specify SourceRegion (or --source-region for the 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 Amazon Web Services Region. TargetDBClusterSnapshotIdentifier - The identifier for the new copy of the DB cluster snapshot in the destination Amazon Web Services 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 Amazon Web Services 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 Amazon Web Services 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
|
/**
|
|
@@ -102,11 +102,11 @@ declare class RDS extends Service {
|
|
|
102
102
|
*/
|
|
103
103
|
copyDBParameterGroup(callback?: (err: AWSError, data: RDS.Types.CopyDBParameterGroupResult) => void): Request<RDS.Types.CopyDBParameterGroupResult, AWSError>;
|
|
104
104
|
/**
|
|
105
|
-
* Copies the specified DB snapshot. The source DB snapshot must be in the available state. You can copy a snapshot from one Amazon Web Services Region to another. In that case, the Amazon Web Services Region where you call the CopyDBSnapshot action is the destination Amazon Web Services Region for the DB snapshot copy. For more information about copying snapshots, see Copying a DB Snapshot in the Amazon RDS User Guide.
|
|
105
|
+
* Copies the specified DB snapshot. The source DB snapshot must be in the available state. You can copy a snapshot from one Amazon Web Services Region to another. In that case, the Amazon Web Services Region where you call the CopyDBSnapshot action is the destination Amazon Web Services Region for the DB snapshot copy. This command doesn't apply to RDS Custom. For more information about copying snapshots, see Copying a DB Snapshot in the Amazon RDS User Guide.
|
|
106
106
|
*/
|
|
107
107
|
copyDBSnapshot(params: RDS.Types.CopyDBSnapshotMessage, callback?: (err: AWSError, data: RDS.Types.CopyDBSnapshotResult) => void): Request<RDS.Types.CopyDBSnapshotResult, AWSError>;
|
|
108
108
|
/**
|
|
109
|
-
* Copies the specified DB snapshot. The source DB snapshot must be in the available state. You can copy a snapshot from one Amazon Web Services Region to another. In that case, the Amazon Web Services Region where you call the CopyDBSnapshot action is the destination Amazon Web Services Region for the DB snapshot copy. For more information about copying snapshots, see Copying a DB Snapshot in the Amazon RDS User Guide.
|
|
109
|
+
* Copies the specified DB snapshot. The source DB snapshot must be in the available state. You can copy a snapshot from one Amazon Web Services Region to another. In that case, the Amazon Web Services Region where you call the CopyDBSnapshot action is the destination Amazon Web Services Region for the DB snapshot copy. This command doesn't apply to RDS Custom. For more information about copying snapshots, see Copying a DB Snapshot in the Amazon RDS User Guide.
|
|
110
110
|
*/
|
|
111
111
|
copyDBSnapshot(callback?: (err: AWSError, data: RDS.Types.CopyDBSnapshotResult) => void): Request<RDS.Types.CopyDBSnapshotResult, AWSError>;
|
|
112
112
|
/**
|
|
@@ -125,6 +125,14 @@ declare class RDS extends Service {
|
|
|
125
125
|
* Creates a custom Availability Zone (AZ). A custom AZ is an on-premises AZ that is integrated with a VMware vSphere cluster. For more information about RDS on VMware, see the RDS on VMware User Guide.
|
|
126
126
|
*/
|
|
127
127
|
createCustomAvailabilityZone(callback?: (err: AWSError, data: RDS.Types.CreateCustomAvailabilityZoneResult) => void): Request<RDS.Types.CreateCustomAvailabilityZoneResult, AWSError>;
|
|
128
|
+
/**
|
|
129
|
+
* Creates a custom DB engine version (CEV). A CEV is a binary volume snapshot of a database engine and specific AMI. The only supported engine is Oracle Database 19c Enterprise Edition with the January 2021 or later RU/RUR. For more information, see Amazon RDS Custom requirements and limitations in the Amazon RDS User Guide. Amazon RDS, which is a fully managed service, supplies the Amazon Machine Image (AMI) and database software. The Amazon RDS database software is preinstalled, so you need only select a DB engine and version, and create your database. With Amazon RDS Custom, you upload your database installation files in Amazon S3. For more information, see Preparing to create a CEV in the Amazon RDS User Guide. When you create a custom engine version, you specify the files in a JSON document called a CEV manifest. This document describes installation .zip files stored in Amazon S3. RDS Custom creates your CEV from the installation files that you provided. This service model is called Bring Your Own Media (BYOM). Creation takes approximately two hours. If creation fails, RDS Custom issues RDS-EVENT-0196 with the message Creation failed for custom engine version, and includes details about the failure. For example, the event prints missing files. After you create the CEV, it is available for use. You can create multiple CEVs, and create multiple RDS Custom instances from any CEV. You can also change the status of a CEV to make it available or inactive. The MediaImport service that imports files from Amazon S3 to create CEVs isn't integrated with Amazon Web Services CloudTrail. If you turn on data logging for Amazon RDS in CloudTrail, calls to the CreateCustomDbEngineVersion event aren't logged. However, you might see calls from the API gateway that accesses your Amazon S3 bucket. These calls originate from the MediaImport service for the CreateCustomDbEngineVersion event. For more information, see Creating a CEV in the Amazon RDS User Guide.
|
|
130
|
+
*/
|
|
131
|
+
createCustomDBEngineVersion(params: RDS.Types.CreateCustomDBEngineVersionMessage, callback?: (err: AWSError, data: RDS.Types.DBEngineVersion) => void): Request<RDS.Types.DBEngineVersion, AWSError>;
|
|
132
|
+
/**
|
|
133
|
+
* Creates a custom DB engine version (CEV). A CEV is a binary volume snapshot of a database engine and specific AMI. The only supported engine is Oracle Database 19c Enterprise Edition with the January 2021 or later RU/RUR. For more information, see Amazon RDS Custom requirements and limitations in the Amazon RDS User Guide. Amazon RDS, which is a fully managed service, supplies the Amazon Machine Image (AMI) and database software. The Amazon RDS database software is preinstalled, so you need only select a DB engine and version, and create your database. With Amazon RDS Custom, you upload your database installation files in Amazon S3. For more information, see Preparing to create a CEV in the Amazon RDS User Guide. When you create a custom engine version, you specify the files in a JSON document called a CEV manifest. This document describes installation .zip files stored in Amazon S3. RDS Custom creates your CEV from the installation files that you provided. This service model is called Bring Your Own Media (BYOM). Creation takes approximately two hours. If creation fails, RDS Custom issues RDS-EVENT-0196 with the message Creation failed for custom engine version, and includes details about the failure. For example, the event prints missing files. After you create the CEV, it is available for use. You can create multiple CEVs, and create multiple RDS Custom instances from any CEV. You can also change the status of a CEV to make it available or inactive. The MediaImport service that imports files from Amazon S3 to create CEVs isn't integrated with Amazon Web Services CloudTrail. If you turn on data logging for Amazon RDS in CloudTrail, calls to the CreateCustomDbEngineVersion event aren't logged. However, you might see calls from the API gateway that accesses your Amazon S3 bucket. These calls originate from the MediaImport service for the CreateCustomDbEngineVersion event. For more information, see Creating a CEV in the Amazon RDS User Guide.
|
|
134
|
+
*/
|
|
135
|
+
createCustomDBEngineVersion(callback?: (err: AWSError, data: RDS.Types.DBEngineVersion) => void): Request<RDS.Types.DBEngineVersion, AWSError>;
|
|
128
136
|
/**
|
|
129
137
|
* Creates a new Amazon Aurora DB cluster. You can use the ReplicationSourceIdentifier parameter to create the DB cluster as a read replica of another DB cluster or Amazon RDS MySQL or PostgreSQL DB instance. For cross-region replication where the DB cluster identified by ReplicationSourceIdentifier is encrypted, you must also specify the PreSignedUrl parameter. 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.
|
|
130
138
|
*/
|
|
@@ -174,11 +182,11 @@ declare class RDS extends Service {
|
|
|
174
182
|
*/
|
|
175
183
|
createDBInstanceReadReplica(callback?: (err: AWSError, data: RDS.Types.CreateDBInstanceReadReplicaResult) => void): Request<RDS.Types.CreateDBInstanceReadReplicaResult, AWSError>;
|
|
176
184
|
/**
|
|
177
|
-
* Creates a new DB parameter group. A DB parameter group is initially created with the default parameters for the database engine used by the DB instance. To provide custom values for any of the parameters, you must modify the group after creating it using ModifyDBParameterGroup. Once you've created a DB parameter group, you need to associate it with your DB instance using ModifyDBInstance. When you associate a new DB parameter group with a running DB instance, you need to reboot the DB instance without failover for the new DB parameter group and associated settings to take effect.
|
|
185
|
+
* Creates a new DB parameter group. A DB parameter group is initially created with the default parameters for the database engine used by the DB instance. To provide custom values for any of the parameters, you must modify the group after creating it using ModifyDBParameterGroup. Once you've created a DB parameter group, you need to associate it with your DB instance using ModifyDBInstance. When you associate a new DB parameter group with a running DB instance, you need to reboot the DB instance without failover for the new DB parameter group and associated settings to take effect. This command doesn't apply to RDS Custom. After you create a DB parameter group, you should wait at least 5 minutes before creating your first DB instance that uses that DB parameter group as the default parameter group. This allows Amazon RDS to fully complete the create action before the parameter group is used as the default for a new DB instance. This is especially important for parameters that are critical when creating the default database for a DB instance, such as the character set for the default database defined by the character_set_database parameter. You can use the Parameter Groups option of the Amazon RDS console or the DescribeDBParameters command to verify that your DB parameter group has been created or modified.
|
|
178
186
|
*/
|
|
179
187
|
createDBParameterGroup(params: RDS.Types.CreateDBParameterGroupMessage, callback?: (err: AWSError, data: RDS.Types.CreateDBParameterGroupResult) => void): Request<RDS.Types.CreateDBParameterGroupResult, AWSError>;
|
|
180
188
|
/**
|
|
181
|
-
* Creates a new DB parameter group. A DB parameter group is initially created with the default parameters for the database engine used by the DB instance. To provide custom values for any of the parameters, you must modify the group after creating it using ModifyDBParameterGroup. Once you've created a DB parameter group, you need to associate it with your DB instance using ModifyDBInstance. When you associate a new DB parameter group with a running DB instance, you need to reboot the DB instance without failover for the new DB parameter group and associated settings to take effect.
|
|
189
|
+
* Creates a new DB parameter group. A DB parameter group is initially created with the default parameters for the database engine used by the DB instance. To provide custom values for any of the parameters, you must modify the group after creating it using ModifyDBParameterGroup. Once you've created a DB parameter group, you need to associate it with your DB instance using ModifyDBInstance. When you associate a new DB parameter group with a running DB instance, you need to reboot the DB instance without failover for the new DB parameter group and associated settings to take effect. This command doesn't apply to RDS Custom. After you create a DB parameter group, you should wait at least 5 minutes before creating your first DB instance that uses that DB parameter group as the default parameter group. This allows Amazon RDS to fully complete the create action before the parameter group is used as the default for a new DB instance. This is especially important for parameters that are critical when creating the default database for a DB instance, such as the character set for the default database defined by the character_set_database parameter. You can use the Parameter Groups option of the Amazon RDS console or the DescribeDBParameters command to verify that your DB parameter group has been created or modified.
|
|
182
190
|
*/
|
|
183
191
|
createDBParameterGroup(callback?: (err: AWSError, data: RDS.Types.CreateDBParameterGroupResult) => void): Request<RDS.Types.CreateDBParameterGroupResult, AWSError>;
|
|
184
192
|
/**
|
|
@@ -238,11 +246,11 @@ declare class RDS extends Service {
|
|
|
238
246
|
*/
|
|
239
247
|
createGlobalCluster(callback?: (err: AWSError, data: RDS.Types.CreateGlobalClusterResult) => void): Request<RDS.Types.CreateGlobalClusterResult, AWSError>;
|
|
240
248
|
/**
|
|
241
|
-
* Creates a new option group. You can create up to 20 option groups.
|
|
249
|
+
* Creates a new option group. You can create up to 20 option groups. This command doesn't apply to RDS Custom.
|
|
242
250
|
*/
|
|
243
251
|
createOptionGroup(params: RDS.Types.CreateOptionGroupMessage, callback?: (err: AWSError, data: RDS.Types.CreateOptionGroupResult) => void): Request<RDS.Types.CreateOptionGroupResult, AWSError>;
|
|
244
252
|
/**
|
|
245
|
-
* Creates a new option group. You can create up to 20 option groups.
|
|
253
|
+
* Creates a new option group. You can create up to 20 option groups. This command doesn't apply to RDS Custom.
|
|
246
254
|
*/
|
|
247
255
|
createOptionGroup(callback?: (err: AWSError, data: RDS.Types.CreateOptionGroupResult) => void): Request<RDS.Types.CreateOptionGroupResult, AWSError>;
|
|
248
256
|
/**
|
|
@@ -253,6 +261,14 @@ declare class RDS extends Service {
|
|
|
253
261
|
* Deletes a custom Availability Zone (AZ). A custom AZ is an on-premises AZ that is integrated with a VMware vSphere cluster. For more information about RDS on VMware, see the RDS on VMware User Guide.
|
|
254
262
|
*/
|
|
255
263
|
deleteCustomAvailabilityZone(callback?: (err: AWSError, data: RDS.Types.DeleteCustomAvailabilityZoneResult) => void): Request<RDS.Types.DeleteCustomAvailabilityZoneResult, AWSError>;
|
|
264
|
+
/**
|
|
265
|
+
* Deletes a custom engine version. To run this command, make sure you meet the following prerequisites: The CEV must not be the default for RDS Custom. If it is, change the default before running this command. The CEV must not be associated with an RDS Custom DB instance, RDS Custom instance snapshot, or automated backup of your RDS Custom instance. Typically, deletion takes a few minutes. The MediaImport service that imports files from Amazon S3 to create CEVs isn't integrated with Amazon Web Services CloudTrail. If you turn on data logging for Amazon RDS in CloudTrail, calls to the DeleteCustomDbEngineVersion event aren't logged. However, you might see calls from the API gateway that accesses your Amazon S3 bucket. These calls originate from the MediaImport service for the DeleteCustomDbEngineVersion event. For more information, see Deleting a CEV in the Amazon RDS User Guide.
|
|
266
|
+
*/
|
|
267
|
+
deleteCustomDBEngineVersion(params: RDS.Types.DeleteCustomDBEngineVersionMessage, callback?: (err: AWSError, data: RDS.Types.DBEngineVersion) => void): Request<RDS.Types.DBEngineVersion, AWSError>;
|
|
268
|
+
/**
|
|
269
|
+
* Deletes a custom engine version. To run this command, make sure you meet the following prerequisites: The CEV must not be the default for RDS Custom. If it is, change the default before running this command. The CEV must not be associated with an RDS Custom DB instance, RDS Custom instance snapshot, or automated backup of your RDS Custom instance. Typically, deletion takes a few minutes. The MediaImport service that imports files from Amazon S3 to create CEVs isn't integrated with Amazon Web Services CloudTrail. If you turn on data logging for Amazon RDS in CloudTrail, calls to the DeleteCustomDbEngineVersion event aren't logged. However, you might see calls from the API gateway that accesses your Amazon S3 bucket. These calls originate from the MediaImport service for the DeleteCustomDbEngineVersion event. For more information, see Deleting a CEV in the Amazon RDS User Guide.
|
|
270
|
+
*/
|
|
271
|
+
deleteCustomDBEngineVersion(callback?: (err: AWSError, data: RDS.Types.DBEngineVersion) => void): Request<RDS.Types.DBEngineVersion, AWSError>;
|
|
256
272
|
/**
|
|
257
273
|
* The DeleteDBCluster action deletes a previously provisioned DB cluster. When you delete a DB cluster, all automated backups for that DB cluster are deleted and can't be recovered. Manual DB cluster snapshots of the specified DB cluster are not deleted. 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.
|
|
258
274
|
*/
|
|
@@ -494,11 +510,11 @@ declare class RDS extends Service {
|
|
|
494
510
|
*/
|
|
495
511
|
describeDBInstances(callback?: (err: AWSError, data: RDS.Types.DBInstanceMessage) => void): Request<RDS.Types.DBInstanceMessage, AWSError>;
|
|
496
512
|
/**
|
|
497
|
-
* Returns a list of DB log files for the DB instance.
|
|
513
|
+
* Returns a list of DB log files for the DB instance. This command doesn't apply to RDS Custom.
|
|
498
514
|
*/
|
|
499
515
|
describeDBLogFiles(params: RDS.Types.DescribeDBLogFilesMessage, callback?: (err: AWSError, data: RDS.Types.DescribeDBLogFilesResponse) => void): Request<RDS.Types.DescribeDBLogFilesResponse, AWSError>;
|
|
500
516
|
/**
|
|
501
|
-
* Returns a list of DB log files for the DB instance.
|
|
517
|
+
* Returns a list of DB log files for the DB instance. This command doesn't apply to RDS Custom.
|
|
502
518
|
*/
|
|
503
519
|
describeDBLogFiles(callback?: (err: AWSError, data: RDS.Types.DescribeDBLogFilesResponse) => void): Request<RDS.Types.DescribeDBLogFilesResponse, AWSError>;
|
|
504
520
|
/**
|
|
@@ -702,19 +718,19 @@ declare class RDS extends Service {
|
|
|
702
718
|
*/
|
|
703
719
|
describeSourceRegions(callback?: (err: AWSError, data: RDS.Types.SourceRegionMessage) => void): Request<RDS.Types.SourceRegionMessage, AWSError>;
|
|
704
720
|
/**
|
|
705
|
-
* You can call DescribeValidDBInstanceModifications to learn what modifications you can make to your DB instance. You can use this information when you call ModifyDBInstance.
|
|
721
|
+
* You can call DescribeValidDBInstanceModifications to learn what modifications you can make to your DB instance. You can use this information when you call ModifyDBInstance. This command doesn't apply to RDS Custom.
|
|
706
722
|
*/
|
|
707
723
|
describeValidDBInstanceModifications(params: RDS.Types.DescribeValidDBInstanceModificationsMessage, callback?: (err: AWSError, data: RDS.Types.DescribeValidDBInstanceModificationsResult) => void): Request<RDS.Types.DescribeValidDBInstanceModificationsResult, AWSError>;
|
|
708
724
|
/**
|
|
709
|
-
* You can call DescribeValidDBInstanceModifications to learn what modifications you can make to your DB instance. You can use this information when you call ModifyDBInstance.
|
|
725
|
+
* You can call DescribeValidDBInstanceModifications to learn what modifications you can make to your DB instance. You can use this information when you call ModifyDBInstance. This command doesn't apply to RDS Custom.
|
|
710
726
|
*/
|
|
711
727
|
describeValidDBInstanceModifications(callback?: (err: AWSError, data: RDS.Types.DescribeValidDBInstanceModificationsResult) => void): Request<RDS.Types.DescribeValidDBInstanceModificationsResult, AWSError>;
|
|
712
728
|
/**
|
|
713
|
-
* Downloads all or a portion of the specified log file, up to 1 MB in size.
|
|
729
|
+
* Downloads all or a portion of the specified log file, up to 1 MB in size. This command doesn't apply to RDS Custom.
|
|
714
730
|
*/
|
|
715
731
|
downloadDBLogFilePortion(params: RDS.Types.DownloadDBLogFilePortionMessage, callback?: (err: AWSError, data: RDS.Types.DownloadDBLogFilePortionDetails) => void): Request<RDS.Types.DownloadDBLogFilePortionDetails, AWSError>;
|
|
716
732
|
/**
|
|
717
|
-
* Downloads all or a portion of the specified log file, up to 1 MB in size.
|
|
733
|
+
* Downloads all or a portion of the specified log file, up to 1 MB in size. This command doesn't apply to RDS Custom.
|
|
718
734
|
*/
|
|
719
735
|
downloadDBLogFilePortion(callback?: (err: AWSError, data: RDS.Types.DownloadDBLogFilePortionDetails) => void): Request<RDS.Types.DownloadDBLogFilePortionDetails, AWSError>;
|
|
720
736
|
/**
|
|
@@ -765,6 +781,14 @@ declare class RDS extends Service {
|
|
|
765
781
|
* Set the capacity of an Aurora Serverless DB cluster to a specific value. Aurora Serverless scales seamlessly based on the workload on the DB cluster. In some cases, the capacity might not scale fast enough to meet a sudden change in workload, such as a large number of new transactions. Call ModifyCurrentDBClusterCapacity to set the capacity explicitly. After this call sets the DB cluster capacity, Aurora Serverless can automatically scale the DB cluster based on the cooldown period for scaling up and the cooldown period for scaling down. For more information about Aurora Serverless, see Using Amazon Aurora Serverless in the Amazon Aurora User Guide. If you call ModifyCurrentDBClusterCapacity with the default TimeoutAction, connections that prevent Aurora Serverless from finding a scaling point might be dropped. For more information about scaling points, see Autoscaling for Aurora Serverless in the Amazon Aurora User Guide. This action only applies to Aurora Serverless DB clusters.
|
|
766
782
|
*/
|
|
767
783
|
modifyCurrentDBClusterCapacity(callback?: (err: AWSError, data: RDS.Types.DBClusterCapacityInfo) => void): Request<RDS.Types.DBClusterCapacityInfo, AWSError>;
|
|
784
|
+
/**
|
|
785
|
+
* Modifies the status of a custom engine version (CEV). You can find CEVs to modify by calling DescribeDBEngineVersions. The MediaImport service that imports files from Amazon S3 to create CEVs isn't integrated with Amazon Web Services CloudTrail. If you turn on data logging for Amazon RDS in CloudTrail, calls to the ModifyCustomDbEngineVersion event aren't logged. However, you might see calls from the API gateway that accesses your Amazon S3 bucket. These calls originate from the MediaImport service for the ModifyCustomDbEngineVersion event. For more information, see Modifying CEV status in the Amazon RDS User Guide.
|
|
786
|
+
*/
|
|
787
|
+
modifyCustomDBEngineVersion(params: RDS.Types.ModifyCustomDBEngineVersionMessage, callback?: (err: AWSError, data: RDS.Types.DBEngineVersion) => void): Request<RDS.Types.DBEngineVersion, AWSError>;
|
|
788
|
+
/**
|
|
789
|
+
* Modifies the status of a custom engine version (CEV). You can find CEVs to modify by calling DescribeDBEngineVersions. The MediaImport service that imports files from Amazon S3 to create CEVs isn't integrated with Amazon Web Services CloudTrail. If you turn on data logging for Amazon RDS in CloudTrail, calls to the ModifyCustomDbEngineVersion event aren't logged. However, you might see calls from the API gateway that accesses your Amazon S3 bucket. These calls originate from the MediaImport service for the ModifyCustomDbEngineVersion event. For more information, see Modifying CEV status in the Amazon RDS User Guide.
|
|
790
|
+
*/
|
|
791
|
+
modifyCustomDBEngineVersion(callback?: (err: AWSError, data: RDS.Types.DBEngineVersion) => void): Request<RDS.Types.DBEngineVersion, AWSError>;
|
|
768
792
|
/**
|
|
769
793
|
* Modify a setting for an Amazon Aurora DB cluster. You can change one or more database configuration parameters by specifying these parameters and the new values in the request. 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.
|
|
770
794
|
*/
|
|
@@ -838,11 +862,11 @@ declare class RDS extends Service {
|
|
|
838
862
|
*/
|
|
839
863
|
modifyDBProxyTargetGroup(callback?: (err: AWSError, data: RDS.Types.ModifyDBProxyTargetGroupResponse) => void): Request<RDS.Types.ModifyDBProxyTargetGroupResponse, AWSError>;
|
|
840
864
|
/**
|
|
841
|
-
* Updates a manual DB snapshot with a new engine version. The snapshot can be encrypted or unencrypted, but not shared or public. Amazon RDS supports upgrading DB snapshots for MySQL,
|
|
865
|
+
* Updates a manual DB snapshot with a new engine version. The snapshot can be encrypted or unencrypted, but not shared or public. Amazon RDS supports upgrading DB snapshots for MySQL, PostgreSQL, and Oracle. This command doesn't apply to RDS Custom.
|
|
842
866
|
*/
|
|
843
867
|
modifyDBSnapshot(params: RDS.Types.ModifyDBSnapshotMessage, callback?: (err: AWSError, data: RDS.Types.ModifyDBSnapshotResult) => void): Request<RDS.Types.ModifyDBSnapshotResult, AWSError>;
|
|
844
868
|
/**
|
|
845
|
-
* Updates a manual DB snapshot with a new engine version. The snapshot can be encrypted or unencrypted, but not shared or public. Amazon RDS supports upgrading DB snapshots for MySQL,
|
|
869
|
+
* Updates a manual DB snapshot with a new engine version. The snapshot can be encrypted or unencrypted, but not shared or public. Amazon RDS supports upgrading DB snapshots for MySQL, PostgreSQL, and Oracle. This command doesn't apply to RDS Custom.
|
|
846
870
|
*/
|
|
847
871
|
modifyDBSnapshot(callback?: (err: AWSError, data: RDS.Types.ModifyDBSnapshotResult) => void): Request<RDS.Types.ModifyDBSnapshotResult, AWSError>;
|
|
848
872
|
/**
|
|
@@ -886,11 +910,11 @@ declare class RDS extends Service {
|
|
|
886
910
|
*/
|
|
887
911
|
modifyOptionGroup(callback?: (err: AWSError, data: RDS.Types.ModifyOptionGroupResult) => void): Request<RDS.Types.ModifyOptionGroupResult, AWSError>;
|
|
888
912
|
/**
|
|
889
|
-
* Promotes a read replica DB instance to a standalone DB instance. Backup duration is a function of the amount of changes to the database since the previous backup. If you plan to promote a read replica to a standalone instance, we recommend that you enable backups and complete at least one backup prior to promotion. In addition, a read replica cannot be promoted to a standalone instance when it is in the backing-up status. If you have enabled backups on your read replica, configure the automated backup window so that daily backups do not interfere with read replica promotion. This command doesn't apply to Aurora MySQL
|
|
913
|
+
* Promotes a read replica DB instance to a standalone DB instance. Backup duration is a function of the amount of changes to the database since the previous backup. If you plan to promote a read replica to a standalone instance, we recommend that you enable backups and complete at least one backup prior to promotion. In addition, a read replica cannot be promoted to a standalone instance when it is in the backing-up status. If you have enabled backups on your read replica, configure the automated backup window so that daily backups do not interfere with read replica promotion. This command doesn't apply to Aurora MySQL, Aurora PostgreSQL, or RDS Custom.
|
|
890
914
|
*/
|
|
891
915
|
promoteReadReplica(params: RDS.Types.PromoteReadReplicaMessage, callback?: (err: AWSError, data: RDS.Types.PromoteReadReplicaResult) => void): Request<RDS.Types.PromoteReadReplicaResult, AWSError>;
|
|
892
916
|
/**
|
|
893
|
-
* Promotes a read replica DB instance to a standalone DB instance. Backup duration is a function of the amount of changes to the database since the previous backup. If you plan to promote a read replica to a standalone instance, we recommend that you enable backups and complete at least one backup prior to promotion. In addition, a read replica cannot be promoted to a standalone instance when it is in the backing-up status. If you have enabled backups on your read replica, configure the automated backup window so that daily backups do not interfere with read replica promotion. This command doesn't apply to Aurora MySQL
|
|
917
|
+
* Promotes a read replica DB instance to a standalone DB instance. Backup duration is a function of the amount of changes to the database since the previous backup. If you plan to promote a read replica to a standalone instance, we recommend that you enable backups and complete at least one backup prior to promotion. In addition, a read replica cannot be promoted to a standalone instance when it is in the backing-up status. If you have enabled backups on your read replica, configure the automated backup window so that daily backups do not interfere with read replica promotion. This command doesn't apply to Aurora MySQL, Aurora PostgreSQL, or RDS Custom.
|
|
894
918
|
*/
|
|
895
919
|
promoteReadReplica(callback?: (err: AWSError, data: RDS.Types.PromoteReadReplicaResult) => void): Request<RDS.Types.PromoteReadReplicaResult, AWSError>;
|
|
896
920
|
/**
|
|
@@ -910,11 +934,11 @@ declare class RDS extends Service {
|
|
|
910
934
|
*/
|
|
911
935
|
purchaseReservedDBInstancesOffering(callback?: (err: AWSError, data: RDS.Types.PurchaseReservedDBInstancesOfferingResult) => void): Request<RDS.Types.PurchaseReservedDBInstancesOfferingResult, AWSError>;
|
|
912
936
|
/**
|
|
913
|
-
* You might need to reboot your DB instance, usually for maintenance reasons. For example, if you make certain modifications, or if you change the DB parameter group associated with the DB instance, you must reboot the instance for the changes to take effect. Rebooting a DB instance restarts the database engine service. Rebooting a DB instance results in a momentary outage, during which the DB instance status is set to rebooting. For more information about rebooting, see Rebooting a DB Instance in the Amazon RDS User Guide.
|
|
937
|
+
* You might need to reboot your DB instance, usually for maintenance reasons. For example, if you make certain modifications, or if you change the DB parameter group associated with the DB instance, you must reboot the instance for the changes to take effect. Rebooting a DB instance restarts the database engine service. Rebooting a DB instance results in a momentary outage, during which the DB instance status is set to rebooting. For more information about rebooting, see Rebooting a DB Instance in the Amazon RDS User Guide. This command doesn't apply to RDS Custom.
|
|
914
938
|
*/
|
|
915
939
|
rebootDBInstance(params: RDS.Types.RebootDBInstanceMessage, callback?: (err: AWSError, data: RDS.Types.RebootDBInstanceResult) => void): Request<RDS.Types.RebootDBInstanceResult, AWSError>;
|
|
916
940
|
/**
|
|
917
|
-
* You might need to reboot your DB instance, usually for maintenance reasons. For example, if you make certain modifications, or if you change the DB parameter group associated with the DB instance, you must reboot the instance for the changes to take effect. Rebooting a DB instance restarts the database engine service. Rebooting a DB instance results in a momentary outage, during which the DB instance status is set to rebooting. For more information about rebooting, see Rebooting a DB Instance in the Amazon RDS User Guide.
|
|
941
|
+
* You might need to reboot your DB instance, usually for maintenance reasons. For example, if you make certain modifications, or if you change the DB parameter group associated with the DB instance, you must reboot the instance for the changes to take effect. Rebooting a DB instance restarts the database engine service. Rebooting a DB instance results in a momentary outage, during which the DB instance status is set to rebooting. For more information about rebooting, see Rebooting a DB Instance in the Amazon RDS User Guide. This command doesn't apply to RDS Custom.
|
|
918
942
|
*/
|
|
919
943
|
rebootDBInstance(callback?: (err: AWSError, data: RDS.Types.RebootDBInstanceResult) => void): Request<RDS.Types.RebootDBInstanceResult, AWSError>;
|
|
920
944
|
/**
|
|
@@ -1014,11 +1038,11 @@ declare class RDS extends Service {
|
|
|
1014
1038
|
*/
|
|
1015
1039
|
restoreDBInstanceFromDBSnapshot(callback?: (err: AWSError, data: RDS.Types.RestoreDBInstanceFromDBSnapshotResult) => void): Request<RDS.Types.RestoreDBInstanceFromDBSnapshotResult, AWSError>;
|
|
1016
1040
|
/**
|
|
1017
|
-
* Amazon Relational Database Service (Amazon RDS) supports importing MySQL databases by using backup files. You can create a backup of your on-premises database, store it on Amazon Simple Storage Service (Amazon S3), and then restore the backup file onto a new Amazon RDS DB instance running MySQL. For more information, see Importing Data into an Amazon RDS MySQL DB Instance in the Amazon RDS User Guide.
|
|
1041
|
+
* Amazon Relational Database Service (Amazon RDS) supports importing MySQL databases by using backup files. You can create a backup of your on-premises database, store it on Amazon Simple Storage Service (Amazon S3), and then restore the backup file onto a new Amazon RDS DB instance running MySQL. For more information, see Importing Data into an Amazon RDS MySQL DB Instance in the Amazon RDS User Guide. This command doesn't apply to RDS Custom.
|
|
1018
1042
|
*/
|
|
1019
1043
|
restoreDBInstanceFromS3(params: RDS.Types.RestoreDBInstanceFromS3Message, callback?: (err: AWSError, data: RDS.Types.RestoreDBInstanceFromS3Result) => void): Request<RDS.Types.RestoreDBInstanceFromS3Result, AWSError>;
|
|
1020
1044
|
/**
|
|
1021
|
-
* Amazon Relational Database Service (Amazon RDS) supports importing MySQL databases by using backup files. You can create a backup of your on-premises database, store it on Amazon Simple Storage Service (Amazon S3), and then restore the backup file onto a new Amazon RDS DB instance running MySQL. For more information, see Importing Data into an Amazon RDS MySQL DB Instance in the Amazon RDS User Guide.
|
|
1045
|
+
* Amazon Relational Database Service (Amazon RDS) supports importing MySQL databases by using backup files. You can create a backup of your on-premises database, store it on Amazon Simple Storage Service (Amazon S3), and then restore the backup file onto a new Amazon RDS DB instance running MySQL. For more information, see Importing Data into an Amazon RDS MySQL DB Instance in the Amazon RDS User Guide. This command doesn't apply to RDS Custom.
|
|
1022
1046
|
*/
|
|
1023
1047
|
restoreDBInstanceFromS3(callback?: (err: AWSError, data: RDS.Types.RestoreDBInstanceFromS3Result) => void): Request<RDS.Types.RestoreDBInstanceFromS3Result, AWSError>;
|
|
1024
1048
|
/**
|
|
@@ -1054,27 +1078,27 @@ declare class RDS extends Service {
|
|
|
1054
1078
|
*/
|
|
1055
1079
|
startDBCluster(callback?: (err: AWSError, data: RDS.Types.StartDBClusterResult) => void): Request<RDS.Types.StartDBClusterResult, AWSError>;
|
|
1056
1080
|
/**
|
|
1057
|
-
* Starts an Amazon RDS DB instance that was stopped using the Amazon Web Services console, the stop-db-instance 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.
|
|
1081
|
+
* Starts an Amazon RDS DB instance that was stopped using the Amazon Web Services console, the stop-db-instance 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 RDS Custom, Aurora MySQL, and Aurora PostgreSQL. For Aurora DB clusters, use StartDBCluster instead.
|
|
1058
1082
|
*/
|
|
1059
1083
|
startDBInstance(params: RDS.Types.StartDBInstanceMessage, callback?: (err: AWSError, data: RDS.Types.StartDBInstanceResult) => void): Request<RDS.Types.StartDBInstanceResult, AWSError>;
|
|
1060
1084
|
/**
|
|
1061
|
-
* Starts an Amazon RDS DB instance that was stopped using the Amazon Web Services console, the stop-db-instance 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.
|
|
1085
|
+
* Starts an Amazon RDS DB instance that was stopped using the Amazon Web Services console, the stop-db-instance 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 RDS Custom, Aurora MySQL, and Aurora PostgreSQL. For Aurora DB clusters, use StartDBCluster instead.
|
|
1062
1086
|
*/
|
|
1063
1087
|
startDBInstance(callback?: (err: AWSError, data: RDS.Types.StartDBInstanceResult) => void): Request<RDS.Types.StartDBInstanceResult, AWSError>;
|
|
1064
1088
|
/**
|
|
1065
|
-
* Enables replication of automated backups to a different Amazon Web Services Region. For more information, see Replicating Automated Backups to Another Amazon Web Services Region in the Amazon RDS User Guide.
|
|
1089
|
+
* Enables replication of automated backups to a different Amazon Web Services Region. This command doesn't apply to RDS Custom. For more information, see Replicating Automated Backups to Another Amazon Web Services Region in the Amazon RDS User Guide.
|
|
1066
1090
|
*/
|
|
1067
1091
|
startDBInstanceAutomatedBackupsReplication(params: RDS.Types.StartDBInstanceAutomatedBackupsReplicationMessage, callback?: (err: AWSError, data: RDS.Types.StartDBInstanceAutomatedBackupsReplicationResult) => void): Request<RDS.Types.StartDBInstanceAutomatedBackupsReplicationResult, AWSError>;
|
|
1068
1092
|
/**
|
|
1069
|
-
* Enables replication of automated backups to a different Amazon Web Services Region. For more information, see Replicating Automated Backups to Another Amazon Web Services Region in the Amazon RDS User Guide.
|
|
1093
|
+
* Enables replication of automated backups to a different Amazon Web Services Region. This command doesn't apply to RDS Custom. For more information, see Replicating Automated Backups to Another Amazon Web Services Region in the Amazon RDS User Guide.
|
|
1070
1094
|
*/
|
|
1071
1095
|
startDBInstanceAutomatedBackupsReplication(callback?: (err: AWSError, data: RDS.Types.StartDBInstanceAutomatedBackupsReplicationResult) => void): Request<RDS.Types.StartDBInstanceAutomatedBackupsReplicationResult, AWSError>;
|
|
1072
1096
|
/**
|
|
1073
|
-
* Starts an export of a snapshot to Amazon S3. The provided IAM role must have access to the S3 bucket.
|
|
1097
|
+
* Starts an export of a snapshot to Amazon S3. The provided IAM role must have access to the S3 bucket. This command doesn't apply to RDS Custom.
|
|
1074
1098
|
*/
|
|
1075
1099
|
startExportTask(params: RDS.Types.StartExportTaskMessage, callback?: (err: AWSError, data: RDS.Types.ExportTask) => void): Request<RDS.Types.ExportTask, AWSError>;
|
|
1076
1100
|
/**
|
|
1077
|
-
* Starts an export of a snapshot to Amazon S3. The provided IAM role must have access to the S3 bucket.
|
|
1101
|
+
* Starts an export of a snapshot to Amazon S3. The provided IAM role must have access to the S3 bucket. This command doesn't apply to RDS Custom.
|
|
1078
1102
|
*/
|
|
1079
1103
|
startExportTask(callback?: (err: AWSError, data: RDS.Types.ExportTask) => void): Request<RDS.Types.ExportTask, AWSError>;
|
|
1080
1104
|
/**
|
|
@@ -1094,19 +1118,19 @@ declare class RDS extends Service {
|
|
|
1094
1118
|
*/
|
|
1095
1119
|
stopDBCluster(callback?: (err: AWSError, data: RDS.Types.StopDBClusterResult) => void): Request<RDS.Types.StopDBClusterResult, AWSError>;
|
|
1096
1120
|
/**
|
|
1097
|
-
* 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.
|
|
1121
|
+
* 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 RDS Custom, Aurora MySQL, and Aurora PostgreSQL. For Aurora clusters, use StopDBCluster instead.
|
|
1098
1122
|
*/
|
|
1099
1123
|
stopDBInstance(params: RDS.Types.StopDBInstanceMessage, callback?: (err: AWSError, data: RDS.Types.StopDBInstanceResult) => void): Request<RDS.Types.StopDBInstanceResult, AWSError>;
|
|
1100
1124
|
/**
|
|
1101
|
-
* 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.
|
|
1125
|
+
* 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 RDS Custom, Aurora MySQL, and Aurora PostgreSQL. For Aurora clusters, use StopDBCluster instead.
|
|
1102
1126
|
*/
|
|
1103
1127
|
stopDBInstance(callback?: (err: AWSError, data: RDS.Types.StopDBInstanceResult) => void): Request<RDS.Types.StopDBInstanceResult, AWSError>;
|
|
1104
1128
|
/**
|
|
1105
|
-
* Stops automated backup replication for a DB instance. For more information, see Replicating Automated Backups to Another Amazon Web Services Region in the Amazon RDS User Guide.
|
|
1129
|
+
* Stops automated backup replication for a DB instance. This command doesn't apply to RDS Custom. For more information, see Replicating Automated Backups to Another Amazon Web Services Region in the Amazon RDS User Guide.
|
|
1106
1130
|
*/
|
|
1107
1131
|
stopDBInstanceAutomatedBackupsReplication(params: RDS.Types.StopDBInstanceAutomatedBackupsReplicationMessage, callback?: (err: AWSError, data: RDS.Types.StopDBInstanceAutomatedBackupsReplicationResult) => void): Request<RDS.Types.StopDBInstanceAutomatedBackupsReplicationResult, AWSError>;
|
|
1108
1132
|
/**
|
|
1109
|
-
* Stops automated backup replication for a DB instance. For more information, see Replicating Automated Backups to Another Amazon Web Services Region in the Amazon RDS User Guide.
|
|
1133
|
+
* Stops automated backup replication for a DB instance. This command doesn't apply to RDS Custom. For more information, see Replicating Automated Backups to Another Amazon Web Services Region in the Amazon RDS User Guide.
|
|
1110
1134
|
*/
|
|
1111
1135
|
stopDBInstanceAutomatedBackupsReplication(callback?: (err: AWSError, data: RDS.Types.StopDBInstanceAutomatedBackupsReplicationResult) => void): Request<RDS.Types.StopDBInstanceAutomatedBackupsReplicationResult, AWSError>;
|
|
1112
1136
|
/**
|
|
@@ -1196,7 +1220,7 @@ declare namespace RDS {
|
|
|
1196
1220
|
*/
|
|
1197
1221
|
RoleArn: String;
|
|
1198
1222
|
/**
|
|
1199
|
-
* The name of the feature for the DB cluster that the IAM role is to be associated with. For
|
|
1223
|
+
* The name of the feature for the DB cluster that the IAM role is to be associated with. For information about supported feature names, see DBEngineVersion.
|
|
1200
1224
|
*/
|
|
1201
1225
|
FeatureName?: String;
|
|
1202
1226
|
}
|
|
@@ -1210,7 +1234,7 @@ declare namespace RDS {
|
|
|
1210
1234
|
*/
|
|
1211
1235
|
RoleArn: String;
|
|
1212
1236
|
/**
|
|
1213
|
-
* The name of the feature for the DB instance that the IAM role is to be associated with. For
|
|
1237
|
+
* The name of the feature for the DB instance that the IAM role is to be associated with. For information about supported feature names, see DBEngineVersion.
|
|
1214
1238
|
*/
|
|
1215
1239
|
FeatureName: String;
|
|
1216
1240
|
}
|
|
@@ -1282,6 +1306,7 @@ declare namespace RDS {
|
|
|
1282
1306
|
export interface AuthorizeDBSecurityGroupIngressResult {
|
|
1283
1307
|
DBSecurityGroup?: DBSecurityGroup;
|
|
1284
1308
|
}
|
|
1309
|
+
export type AutomationMode = "full"|"all-paused"|string;
|
|
1285
1310
|
export interface AvailabilityZone {
|
|
1286
1311
|
/**
|
|
1287
1312
|
* The name of the Availability Zone.
|
|
@@ -1326,6 +1351,7 @@ declare namespace RDS {
|
|
|
1326
1351
|
}
|
|
1327
1352
|
export type Boolean = boolean;
|
|
1328
1353
|
export type BooleanOptional = boolean;
|
|
1354
|
+
export type BucketName = string;
|
|
1329
1355
|
export interface CancelExportTaskMessage {
|
|
1330
1356
|
/**
|
|
1331
1357
|
* The identifier of the snapshot export task to cancel.
|
|
@@ -1488,11 +1514,11 @@ declare namespace RDS {
|
|
|
1488
1514
|
*/
|
|
1489
1515
|
TargetDBClusterSnapshotIdentifier: String;
|
|
1490
1516
|
/**
|
|
1491
|
-
* The Amazon Web Services KMS key identifier for an encrypted DB cluster snapshot. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the Amazon Web Services KMS
|
|
1517
|
+
* The Amazon Web Services KMS key identifier for an encrypted DB cluster snapshot. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the Amazon Web Services KMS key. If you copy an encrypted DB cluster snapshot from your Amazon Web Services account, you can specify a value for KmsKeyId to encrypt the copy with a new KMS key. If you don't specify a value for KmsKeyId, then the copy of the DB cluster snapshot is encrypted with the same KMS key as the source DB cluster snapshot. If you copy an encrypted DB cluster snapshot that is shared from another Amazon Web Services account, then you must specify a value for KmsKeyId. To copy an encrypted DB cluster snapshot to another Amazon Web Services Region, you must set KmsKeyId to the Amazon Web Services KMS key identifier you want to use to encrypt the copy of the DB cluster snapshot in the destination Amazon Web Services Region. KMS keys are specific to the Amazon Web Services Region that they are created in, and you can't use KMS keys from one Amazon Web Services Region in another Amazon Web Services Region. If you copy an unencrypted DB cluster snapshot and specify a value for the KmsKeyId parameter, an error is returned.
|
|
1492
1518
|
*/
|
|
1493
1519
|
KmsKeyId?: String;
|
|
1494
1520
|
/**
|
|
1495
|
-
* The URL that contains a Signature Version 4 signed request for the CopyDBClusterSnapshot API action in the Amazon Web Services 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 Amazon Web Services Region. Don't specify PreSignedUrl when you are copying an encrypted DB cluster snapshot in the same Amazon Web Services Region. The pre-signed URL must be a valid request for the CopyDBClusterSnapshot API action that can be executed in the source Amazon Web Services Region that contains the encrypted DB cluster snapshot to be copied. The pre-signed URL request must contain the following parameter values: KmsKeyId - The Amazon Web Services KMS key identifier for the
|
|
1521
|
+
* The URL that contains a Signature Version 4 signed request for the CopyDBClusterSnapshot API action in the Amazon Web Services 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 Amazon Web Services Region. Don't specify PreSignedUrl when you are copying an encrypted DB cluster snapshot in the same Amazon Web Services Region. The pre-signed URL must be a valid request for the CopyDBClusterSnapshot API action that can be executed in the source Amazon Web Services Region that contains the encrypted DB cluster snapshot to be copied. The pre-signed URL request must contain the following parameter values: KmsKeyId - The Amazon Web Services KMS key identifier for the KMS key to use to encrypt the copy of the DB cluster snapshot in the destination Amazon Web Services Region. This is the same identifier for both the CopyDBClusterSnapshot action that is called in the destination Amazon Web Services Region, and the action contained in the pre-signed URL. DestinationRegion - The name of the Amazon Web Services 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 Amazon Web Services Region. For example, if you are copying an encrypted DB cluster snapshot from the us-west-2 Amazon Web Services 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 (Amazon Web Services Signature Version 4) and Signature Version 4 Signing Process. If you are using an Amazon Web Services SDK tool or the CLI, you can specify SourceRegion (or --source-region for the 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 Amazon Web Services Region. If you supply a value for this operation's SourceRegion parameter, a pre-signed URL will be calculated on your behalf.
|
|
1496
1522
|
*/
|
|
1497
1523
|
PreSignedUrl?: String;
|
|
1498
1524
|
/**
|
|
@@ -1536,7 +1562,7 @@ declare namespace RDS {
|
|
|
1536
1562
|
*/
|
|
1537
1563
|
TargetDBSnapshotIdentifier: String;
|
|
1538
1564
|
/**
|
|
1539
|
-
* The Amazon Web Services KMS key identifier for an encrypted DB snapshot. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the
|
|
1565
|
+
* The Amazon Web Services KMS key identifier for an encrypted DB snapshot. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. If you copy an encrypted DB snapshot from your Amazon Web Services account, you can specify a value for this parameter to encrypt the copy with a new KMS key. If you don't specify a value for this parameter, then the copy of the DB snapshot is encrypted with the same Amazon Web Services KMS key as the source DB snapshot. If you copy an encrypted DB snapshot that is shared from another Amazon Web Services 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 Amazon Web Services Region, then you must specify an Amazon Web Services KMS key identifier for the destination Amazon Web Services Region. KMS keys are specific to the Amazon Web Services Region that they are created in, and you can't use KMS keys from one Amazon Web Services Region in another Amazon Web Services Region.
|
|
1540
1566
|
*/
|
|
1541
1567
|
KmsKeyId?: String;
|
|
1542
1568
|
Tags?: TagList;
|
|
@@ -1545,7 +1571,7 @@ declare namespace RDS {
|
|
|
1545
1571
|
*/
|
|
1546
1572
|
CopyTags?: BooleanOptional;
|
|
1547
1573
|
/**
|
|
1548
|
-
* The URL that contains a Signature Version 4 signed request for the CopyDBSnapshot API action in the source Amazon Web Services Region that contains the source DB snapshot to copy. You must specify this parameter when you copy an encrypted DB snapshot from another Amazon Web Services Region by using the Amazon RDS API. Don't specify PreSignedUrl when you are copying an encrypted DB snapshot in the same Amazon Web Services Region. The presigned URL must be a valid request for the CopyDBSnapshot API action that can be executed in the source Amazon Web Services Region that contains the encrypted DB snapshot to be copied. The presigned URL request must contain the following parameter values: DestinationRegion - The Amazon Web Services Region that the encrypted DB snapshot is copied to. This Amazon Web Services 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 Amazon Web Services Region to the us-east-1 Amazon Web Services Region, then you call the CopyDBSnapshot action in the us-east-1 Amazon Web Services Region and provide a presigned URL that contains a call to the CopyDBSnapshot action in the us-west-2 Amazon Web Services Region. For this example, the DestinationRegion in the presigned URL must be set to the us-east-1 Amazon Web Services Region. KmsKeyId - The Amazon Web Services KMS key identifier for the
|
|
1574
|
+
* The URL that contains a Signature Version 4 signed request for the CopyDBSnapshot API action in the source Amazon Web Services Region that contains the source DB snapshot to copy. You must specify this parameter when you copy an encrypted DB snapshot from another Amazon Web Services Region by using the Amazon RDS API. Don't specify PreSignedUrl when you are copying an encrypted DB snapshot in the same Amazon Web Services Region. The presigned URL must be a valid request for the CopyDBSnapshot API action that can be executed in the source Amazon Web Services Region that contains the encrypted DB snapshot to be copied. The presigned URL request must contain the following parameter values: DestinationRegion - The Amazon Web Services Region that the encrypted DB snapshot is copied to. This Amazon Web Services 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 Amazon Web Services Region to the us-east-1 Amazon Web Services Region, then you call the CopyDBSnapshot action in the us-east-1 Amazon Web Services Region and provide a presigned URL that contains a call to the CopyDBSnapshot action in the us-west-2 Amazon Web Services Region. For this example, the DestinationRegion in the presigned URL must be set to the us-east-1 Amazon Web Services Region. KmsKeyId - The Amazon Web Services KMS key identifier for the KMS key to use to encrypt the copy of the DB snapshot in the destination Amazon Web Services Region. This is the same identifier for both the CopyDBSnapshot action that is called in the destination Amazon Web Services 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 Amazon Web Services Region. For example, if you are copying an encrypted DB snapshot from the us-west-2 Amazon Web Services 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 (Amazon Web Services Signature Version 4) and Signature Version 4 Signing Process. If you are using an Amazon Web Services SDK tool or the CLI, you can specify SourceRegion (or --source-region for the 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 Amazon Web Services Region. If you supply a value for this operation's SourceRegion parameter, a pre-signed URL will be calculated on your behalf.
|
|
1549
1575
|
*/
|
|
1550
1576
|
PreSignedUrl?: String;
|
|
1551
1577
|
/**
|
|
@@ -1603,6 +1629,37 @@ declare namespace RDS {
|
|
|
1603
1629
|
export interface CreateCustomAvailabilityZoneResult {
|
|
1604
1630
|
CustomAvailabilityZone?: CustomAvailabilityZone;
|
|
1605
1631
|
}
|
|
1632
|
+
export interface CreateCustomDBEngineVersionMessage {
|
|
1633
|
+
/**
|
|
1634
|
+
* The database engine to use for your custom engine version (CEV). The only supported value is custom-oracle-ee.
|
|
1635
|
+
*/
|
|
1636
|
+
Engine: CustomEngineName;
|
|
1637
|
+
/**
|
|
1638
|
+
* The name of your CEV. The name format is 19.customized_string . For example, a valid name is 19.my_cev1. This setting is required for RDS Custom, but optional for Amazon RDS. The combination of Engine and EngineVersion is unique per customer per Region.
|
|
1639
|
+
*/
|
|
1640
|
+
EngineVersion: CustomEngineVersion;
|
|
1641
|
+
/**
|
|
1642
|
+
* The name of an Amazon S3 bucket that contains database installation files for your CEV. For example, a valid bucket name is my-custom-installation-files.
|
|
1643
|
+
*/
|
|
1644
|
+
DatabaseInstallationFilesS3BucketName: BucketName;
|
|
1645
|
+
/**
|
|
1646
|
+
* The Amazon S3 directory that contains the database installation files for your CEV. For example, a valid bucket name is 123456789012/cev1. If this setting isn't specified, no prefix is assumed.
|
|
1647
|
+
*/
|
|
1648
|
+
DatabaseInstallationFilesS3Prefix?: String255;
|
|
1649
|
+
/**
|
|
1650
|
+
* The Amazon Web Services KMS key identifier for an encrypted CEV. A symmetric KMS key is required for RDS Custom, but optional for Amazon RDS. If you have an existing symmetric KMS key in your account, you can use it with RDS Custom. No further action is necessary. If you don't already have a symmetric KMS key in your account, follow the instructions in Creating symmetric KMS keys in the Amazon Web Services Key Management Service Developer Guide. You can choose the same symmetric key when you create a CEV and a DB instance, or choose different keys.
|
|
1651
|
+
*/
|
|
1652
|
+
KMSKeyId: KmsKeyIdOrArn;
|
|
1653
|
+
/**
|
|
1654
|
+
* An optional description of your CEV.
|
|
1655
|
+
*/
|
|
1656
|
+
Description?: Description;
|
|
1657
|
+
/**
|
|
1658
|
+
* The CEV manifest, which is a JSON document that describes the installation .zip files stored in Amazon S3. Specify the name/value pairs in a file or a quoted string. RDS Custom applies the patches in the order in which they are listed. The following JSON fields are valid: MediaImportTemplateVersion Version of the CEV manifest. The date is in the format YYYY-MM-DD. databaseInstallationFileNames Ordered list of installation files for the CEV. opatchFileNames Ordered list of OPatch installers used for the Oracle DB engine. psuRuPatchFileNames The PSU and RU patches for this CEV. OtherPatchFileNames The patches that are not in the list of PSU and RU patches. Amazon RDS applies these patches after applying the PSU and RU patches. For more information, see Creating the CEV manifest in the Amazon RDS User Guide.
|
|
1659
|
+
*/
|
|
1660
|
+
Manifest: CustomDBEngineVersionManifest;
|
|
1661
|
+
Tags?: TagList;
|
|
1662
|
+
}
|
|
1606
1663
|
export interface CreateDBClusterEndpointMessage {
|
|
1607
1664
|
/**
|
|
1608
1665
|
* The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is stored as a lowercase string.
|
|
@@ -1707,11 +1764,11 @@ declare namespace RDS {
|
|
|
1707
1764
|
*/
|
|
1708
1765
|
StorageEncrypted?: BooleanOptional;
|
|
1709
1766
|
/**
|
|
1710
|
-
* The Amazon Web Services KMS key identifier for an encrypted DB cluster. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the
|
|
1767
|
+
* The Amazon Web Services KMS key identifier for an encrypted DB cluster. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN. When a KMS key isn't specified in KmsKeyId: If ReplicationSourceIdentifier identifies an encrypted source, then Amazon RDS will use the KMS key used to encrypt the source. Otherwise, Amazon RDS will use your default KMS key. If the StorageEncrypted parameter is enabled and ReplicationSourceIdentifier isn't specified, then Amazon RDS will use your default KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region. If you create a read replica of an encrypted DB cluster in another Amazon Web Services Region, you must set KmsKeyId to a KMS key identifier that is valid in the destination Amazon Web Services Region. This KMS key is used to encrypt the read replica in that Amazon Web Services Region.
|
|
1711
1768
|
*/
|
|
1712
1769
|
KmsKeyId?: String;
|
|
1713
1770
|
/**
|
|
1714
|
-
* A URL that contains a Signature Version 4 signed request for the CreateDBCluster action to be called in the source Amazon Web Services 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 Amazon Web Services Region that contains the encrypted DB cluster to be copied. The pre-signed URL request must contain the following parameter values: KmsKeyId - The Amazon Web Services KMS key identifier for the key to use to encrypt the copy of the DB cluster in the destination Amazon Web Services Region. This should refer to the same
|
|
1771
|
+
* A URL that contains a Signature Version 4 signed request for the CreateDBCluster action to be called in the source Amazon Web Services 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 Amazon Web Services Region that contains the encrypted DB cluster to be copied. The pre-signed URL request must contain the following parameter values: KmsKeyId - The Amazon Web Services KMS key identifier for the KMS key to use to encrypt the copy of the DB cluster in the destination Amazon Web Services Region. This should refer to the same KMS key for both the CreateDBCluster action that is called in the destination Amazon Web Services Region, and the action contained in the pre-signed URL. DestinationRegion - The name of the Amazon Web Services 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 Amazon Web Services Region. For example, if you are copying an encrypted DB cluster from the us-west-2 Amazon Web Services 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 (Amazon Web Services Signature Version 4) and Signature Version 4 Signing Process. If you are using an Amazon Web Services SDK tool or the CLI, you can specify SourceRegion (or --source-region for the 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 Amazon Web Services Region. If you supply a value for this operation's SourceRegion parameter, a pre-signed URL will be calculated on your behalf.
|
|
1715
1772
|
*/
|
|
1716
1773
|
PreSignedUrl?: String;
|
|
1717
1774
|
/**
|
|
@@ -1810,7 +1867,7 @@ declare namespace RDS {
|
|
|
1810
1867
|
}
|
|
1811
1868
|
export interface CreateDBInstanceMessage {
|
|
1812
1869
|
/**
|
|
1813
|
-
* The meaning of this parameter differs according to the database engine you use. MySQL The name of the database to create when the DB instance is created. If this parameter isn't specified, no database is created in the DB instance. Constraints: Must contain 1 to 64 letters or numbers. Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9). Can't be a word reserved by the specified database engine MariaDB The name of the database to create when the DB instance is created. If this parameter isn't specified, no database is created in the DB instance. Constraints: Must contain 1 to 64 letters or numbers. Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9). Can't be a word reserved by the specified database engine PostgreSQL The name of the database to create when the DB instance is created. If this parameter isn't specified, a database named postgres is created in the DB instance. Constraints: Must contain 1 to 63 letters, numbers, or underscores. Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9). Can't be a word reserved by the specified database engine Oracle The Oracle System ID (SID) of the created DB instance. If you specify null, the default value ORCL is used. You can't specify the string NULL, or any other reserved word, for DBName. Default: ORCL Constraints: Can't be longer than 8 characters SQL Server Not applicable. Must be null. Amazon Aurora MySQL The name of the database to create when the primary DB instance of the Aurora MySQL DB cluster is created. If this parameter isn't specified for an Aurora MySQL DB cluster, no database is created in the DB cluster. Constraints: It must contain 1 to 64 alphanumeric characters. It can't be a word reserved by the database engine. Amazon Aurora PostgreSQL The name of the database to create when the primary DB instance of the Aurora PostgreSQL DB cluster is created. If this parameter isn't specified for an Aurora PostgreSQL DB cluster, a database named postgres is created in the DB cluster. Constraints: It must contain 1 to 63 alphanumeric characters. It must begin with a letter or an underscore. Subsequent characters can be letters, underscores, or digits (0 to 9). It can't be a word reserved by the database engine.
|
|
1870
|
+
* The meaning of this parameter differs according to the database engine you use. MySQL The name of the database to create when the DB instance is created. If this parameter isn't specified, no database is created in the DB instance. Constraints: Must contain 1 to 64 letters or numbers. Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9). Can't be a word reserved by the specified database engine MariaDB The name of the database to create when the DB instance is created. If this parameter isn't specified, no database is created in the DB instance. Constraints: Must contain 1 to 64 letters or numbers. Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9). Can't be a word reserved by the specified database engine PostgreSQL The name of the database to create when the DB instance is created. If this parameter isn't specified, a database named postgres is created in the DB instance. Constraints: Must contain 1 to 63 letters, numbers, or underscores. Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9). Can't be a word reserved by the specified database engine Oracle The Oracle System ID (SID) of the created DB instance. If you specify null, the default value ORCL is used. You can't specify the string NULL, or any other reserved word, for DBName. Default: ORCL Constraints: Can't be longer than 8 characters Amazon RDS Custom The Oracle System ID (SID) of the created RDS Custom DB instance. If you don't specify a value, the default value is ORCL. Default: ORCL Constraints: It must contain 1 to 8 alphanumeric characters. It must contain a letter. It can't be a word reserved by the database engine. SQL Server Not applicable. Must be null. Amazon Aurora MySQL The name of the database to create when the primary DB instance of the Aurora MySQL DB cluster is created. If this parameter isn't specified for an Aurora MySQL DB cluster, no database is created in the DB cluster. Constraints: It must contain 1 to 64 alphanumeric characters. It can't be a word reserved by the database engine. Amazon Aurora PostgreSQL The name of the database to create when the primary DB instance of the Aurora PostgreSQL DB cluster is created. If this parameter isn't specified for an Aurora PostgreSQL DB cluster, a database named postgres is created in the DB cluster. Constraints: It must contain 1 to 63 alphanumeric characters. It must begin with a letter or an underscore. Subsequent characters can be letters, underscores, or digits (0 to 9). It can't be a word reserved by the database engine.
|
|
1814
1871
|
*/
|
|
1815
1872
|
DBName?: String;
|
|
1816
1873
|
/**
|
|
@@ -1818,7 +1875,7 @@ declare namespace RDS {
|
|
|
1818
1875
|
*/
|
|
1819
1876
|
DBInstanceIdentifier: String;
|
|
1820
1877
|
/**
|
|
1821
|
-
* The amount of storage in gibibytes (GiB) to allocate for the DB instance. Type: Integer Amazon Aurora Not applicable. Aurora cluster volumes automatically grow as the amount of data in your database increases, though you are only charged for the space that you use in an Aurora cluster volume. MySQL Constraints to the amount of storage for each storage type are the following: General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536. Provisioned IOPS storage (io1): Must be an integer from 100 to 65536. Magnetic storage (standard): Must be an integer from 5 to 3072. MariaDB Constraints to the amount of storage for each storage type are the following: General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536. Provisioned IOPS storage (io1): Must be an integer from 100 to 65536. Magnetic storage (standard): Must be an integer from 5 to 3072. PostgreSQL Constraints to the amount of storage for each storage type are the following: General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536. Provisioned IOPS storage (io1): Must be an integer from 100 to 65536. Magnetic storage (standard): Must be an integer from 5 to 3072. Oracle Constraints to the amount of storage for each storage type are the following: General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536. Provisioned IOPS storage (io1): Must be an integer from 100 to 65536. Magnetic storage (standard): Must be an integer from 10 to 3072. SQL Server Constraints to the amount of storage for each storage type are the following: General Purpose (SSD) storage (gp2): Enterprise and Standard editions: Must be an integer from 200 to 16384. Web and Express editions: Must be an integer from 20 to 16384. Provisioned IOPS storage (io1): Enterprise and Standard editions: Must be an integer from 200 to 16384. Web and Express editions: Must be an integer from 100 to 16384. Magnetic storage (standard): Enterprise and Standard editions: Must be an integer from 200 to 1024. Web and Express editions: Must be an integer from 20 to 1024.
|
|
1878
|
+
* The amount of storage in gibibytes (GiB) to allocate for the DB instance. Type: Integer Amazon Aurora Not applicable. Aurora cluster volumes automatically grow as the amount of data in your database increases, though you are only charged for the space that you use in an Aurora cluster volume. Amazon RDS Custom Constraints to the amount of storage for each storage type are the following: General Purpose (SSD) storage (gp2): Must be an integer from 40 to 65536. Provisioned IOPS storage (io1): Must be an integer from 40 to 65536. MySQL Constraints to the amount of storage for each storage type are the following: General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536. Provisioned IOPS storage (io1): Must be an integer from 100 to 65536. Magnetic storage (standard): Must be an integer from 5 to 3072. MariaDB Constraints to the amount of storage for each storage type are the following: General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536. Provisioned IOPS storage (io1): Must be an integer from 100 to 65536. Magnetic storage (standard): Must be an integer from 5 to 3072. PostgreSQL Constraints to the amount of storage for each storage type are the following: General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536. Provisioned IOPS storage (io1): Must be an integer from 100 to 65536. Magnetic storage (standard): Must be an integer from 5 to 3072. Oracle Constraints to the amount of storage for each storage type are the following: General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536. Provisioned IOPS storage (io1): Must be an integer from 100 to 65536. Magnetic storage (standard): Must be an integer from 10 to 3072. SQL Server Constraints to the amount of storage for each storage type are the following: General Purpose (SSD) storage (gp2): Enterprise and Standard editions: Must be an integer from 200 to 16384. Web and Express editions: Must be an integer from 20 to 16384. Provisioned IOPS storage (io1): Enterprise and Standard editions: Must be an integer from 200 to 16384. Web and Express editions: Must be an integer from 100 to 16384. Magnetic storage (standard): Enterprise and Standard editions: Must be an integer from 200 to 1024. Web and Express editions: Must be an integer from 20 to 1024.
|
|
1822
1879
|
*/
|
|
1823
1880
|
AllocatedStorage?: IntegerOptional;
|
|
1824
1881
|
/**
|
|
@@ -1826,7 +1883,7 @@ declare namespace RDS {
|
|
|
1826
1883
|
*/
|
|
1827
1884
|
DBInstanceClass: String;
|
|
1828
1885
|
/**
|
|
1829
|
-
* The name of the database engine to be used for this instance. Not every database engine is available for every Amazon Web Services Region. Valid Values: aurora (for MySQL 5.6-compatible Aurora) aurora-mysql (for MySQL 5.7-compatible Aurora) aurora-postgresql mariadb mysql oracle-ee oracle-ee-cdb oracle-se2 oracle-se2-cdb postgres sqlserver-ee sqlserver-se sqlserver-ex sqlserver-web
|
|
1886
|
+
* The name of the database engine to be used for this instance. Not every database engine is available for every Amazon Web Services Region. Valid Values: aurora (for MySQL 5.6-compatible Aurora) aurora-mysql (for MySQL 5.7-compatible Aurora) aurora-postgresql custom-oracle-ee (for RDS Custom instances) mariadb mysql oracle-ee oracle-ee-cdb oracle-se2 oracle-se2-cdb postgres sqlserver-ee sqlserver-se sqlserver-ex sqlserver-web
|
|
1830
1887
|
*/
|
|
1831
1888
|
Engine: String;
|
|
1832
1889
|
/**
|
|
@@ -1858,11 +1915,11 @@ declare namespace RDS {
|
|
|
1858
1915
|
*/
|
|
1859
1916
|
PreferredMaintenanceWindow?: String;
|
|
1860
1917
|
/**
|
|
1861
|
-
* The name of the DB parameter group to associate with this DB instance. If you do not specify a value, then the default DB parameter group for the specified DB engine and version is used. Constraints: Must be 1 to 255 letters, numbers, or hyphens. First character must be a letter Can't end with a hyphen or contain two consecutive hyphens
|
|
1918
|
+
* The name of the DB parameter group to associate with this DB instance. If you do not specify a value, then the default DB parameter group for the specified DB engine and version is used. This setting doesn't apply to RDS Custom. Constraints: Must be 1 to 255 letters, numbers, or hyphens. First character must be a letter Can't end with a hyphen or contain two consecutive hyphens
|
|
1862
1919
|
*/
|
|
1863
1920
|
DBParameterGroupName?: String;
|
|
1864
1921
|
/**
|
|
1865
|
-
* The number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups. Amazon Aurora Not applicable. The retention period for automated backups is managed by the DB cluster. Default: 1 Constraints: Must be a value from 0 to 35 Can't be set to 0 if the DB instance is a source to read replicas
|
|
1922
|
+
* The number of days for which automated backups are retained. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups. Amazon Aurora Not applicable. The retention period for automated backups is managed by the DB cluster. Default: 1 Constraints: Must be a value from 0 to 35 Can't be set to 0 if the DB instance is a source to read replicas Can't be set to 0 or 35 for an RDS Custom DB instance
|
|
1866
1923
|
*/
|
|
1867
1924
|
BackupRetentionPeriod?: IntegerOptional;
|
|
1868
1925
|
/**
|
|
@@ -1874,19 +1931,19 @@ declare namespace RDS {
|
|
|
1874
1931
|
*/
|
|
1875
1932
|
Port?: IntegerOptional;
|
|
1876
1933
|
/**
|
|
1877
|
-
* A value that indicates whether the DB instance is a Multi-AZ deployment. You can't set the AvailabilityZone parameter if the DB instance is a Multi-AZ deployment.
|
|
1934
|
+
* A value that indicates whether the DB instance is a Multi-AZ deployment. You can't set the AvailabilityZone parameter if the DB instance is a Multi-AZ deployment. This setting doesn't apply to RDS Custom.
|
|
1878
1935
|
*/
|
|
1879
1936
|
MultiAZ?: BooleanOptional;
|
|
1880
1937
|
/**
|
|
1881
|
-
* The version number of the database engine to use. For a list of valid engine versions, use the DescribeDBEngineVersions action. The following are the database engines and links to information about the major and minor versions that are available with Amazon RDS. Not every database engine is available for every Amazon Web Services Region. Amazon Aurora Not applicable. The version number of the database engine to be used by the DB instance is managed by the DB cluster. MariaDB See MariaDB on Amazon RDS Versions in the Amazon RDS User Guide. Microsoft SQL Server See Microsoft SQL Server Versions on Amazon RDS in the Amazon RDS User Guide. MySQL See MySQL on Amazon RDS Versions in the Amazon RDS User Guide. Oracle See Oracle Database Engine Release Notes in the Amazon RDS User Guide. PostgreSQL See Amazon RDS for PostgreSQL versions and extensions in the Amazon RDS User Guide.
|
|
1938
|
+
* The version number of the database engine to use. For a list of valid engine versions, use the DescribeDBEngineVersions action. The following are the database engines and links to information about the major and minor versions that are available with Amazon RDS. Not every database engine is available for every Amazon Web Services Region. Amazon Aurora Not applicable. The version number of the database engine to be used by the DB instance is managed by the DB cluster. Amazon RDS Custom A custom engine version (CEV) that you have previously created. This setting is required for RDS Custom. The CEV name has the following format: 19.customized_string . An example identifier is 19.my_cev1. For more information, see Creating an RDS Custom DB instance in the Amazon RDS User Guide.. MariaDB See MariaDB on Amazon RDS Versions in the Amazon RDS User Guide. Microsoft SQL Server See Microsoft SQL Server Versions on Amazon RDS in the Amazon RDS User Guide. MySQL See MySQL on Amazon RDS Versions in the Amazon RDS User Guide. Oracle See Oracle Database Engine Release Notes in the Amazon RDS User Guide. PostgreSQL See Amazon RDS for PostgreSQL versions and extensions in the Amazon RDS User Guide.
|
|
1882
1939
|
*/
|
|
1883
1940
|
EngineVersion?: String;
|
|
1884
1941
|
/**
|
|
1885
|
-
* A value that indicates whether minor engine upgrades are applied automatically to the DB instance during the maintenance window. By default, minor engine upgrades are applied automatically.
|
|
1942
|
+
* A value that indicates whether minor engine upgrades are applied automatically to the DB instance during the maintenance window. By default, minor engine upgrades are applied automatically. If you create an RDS Custom DB instance, you must set AutoMinorVersionUpgrade to false.
|
|
1886
1943
|
*/
|
|
1887
1944
|
AutoMinorVersionUpgrade?: BooleanOptional;
|
|
1888
1945
|
/**
|
|
1889
|
-
* License model information for this DB instance. Valid values: license-included | bring-your-own-license | general-public-license
|
|
1946
|
+
* License model information for this DB instance. Valid values: license-included | bring-your-own-license | general-public-license This setting doesn't apply to RDS Custom.
|
|
1890
1947
|
*/
|
|
1891
1948
|
LicenseModel?: String;
|
|
1892
1949
|
/**
|
|
@@ -1894,15 +1951,15 @@ declare namespace RDS {
|
|
|
1894
1951
|
*/
|
|
1895
1952
|
Iops?: IntegerOptional;
|
|
1896
1953
|
/**
|
|
1897
|
-
* A value that indicates that the DB instance should be associated with the specified option group. Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group. Also, that option group can't be removed from a DB instance
|
|
1954
|
+
* A value that indicates that the DB instance should be associated with the specified option group. Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group. Also, that option group can't be removed from a DB instance after it is associated with a DB instance. This setting doesn't apply to RDS Custom.
|
|
1898
1955
|
*/
|
|
1899
1956
|
OptionGroupName?: String;
|
|
1900
1957
|
/**
|
|
1901
|
-
* For supported engines, indicates that the DB instance should be associated with the specified CharacterSet. Amazon Aurora Not applicable. The character set is managed by the DB cluster. For more information, see CreateDBCluster.
|
|
1958
|
+
* For supported engines, this value indicates that the DB instance should be associated with the specified CharacterSet. This setting doesn't apply to RDS Custom. However, if you need to change the character set, you can change it on the database itself. Amazon Aurora Not applicable. The character set is managed by the DB cluster. For more information, see CreateDBCluster.
|
|
1902
1959
|
*/
|
|
1903
1960
|
CharacterSetName?: String;
|
|
1904
1961
|
/**
|
|
1905
|
-
* The name of the NCHAR character set for the Oracle DB instance.
|
|
1962
|
+
* The name of the NCHAR character set for the Oracle DB instance. This parameter doesn't apply to RDS Custom.
|
|
1906
1963
|
*/
|
|
1907
1964
|
NcharCharacterSetName?: String;
|
|
1908
1965
|
/**
|
|
@@ -1914,7 +1971,7 @@ declare namespace RDS {
|
|
|
1914
1971
|
*/
|
|
1915
1972
|
Tags?: TagList;
|
|
1916
1973
|
/**
|
|
1917
|
-
* The identifier of the DB cluster that the instance will belong to.
|
|
1974
|
+
* The identifier of the DB cluster that the instance will belong to. This setting doesn't apply to RDS Custom.
|
|
1918
1975
|
*/
|
|
1919
1976
|
DBClusterIdentifier?: String;
|
|
1920
1977
|
/**
|
|
@@ -1922,23 +1979,23 @@ declare namespace RDS {
|
|
|
1922
1979
|
*/
|
|
1923
1980
|
StorageType?: String;
|
|
1924
1981
|
/**
|
|
1925
|
-
* The ARN from the key store with which to associate the instance for TDE encryption.
|
|
1982
|
+
* The ARN from the key store with which to associate the instance for TDE encryption. This setting doesn't apply to RDS Custom.
|
|
1926
1983
|
*/
|
|
1927
1984
|
TdeCredentialArn?: String;
|
|
1928
1985
|
/**
|
|
1929
|
-
* The password for the given ARN from the key store in order to access the device.
|
|
1986
|
+
* The password for the given ARN from the key store in order to access the device. This setting doesn't apply to RDS Custom.
|
|
1930
1987
|
*/
|
|
1931
1988
|
TdeCredentialPassword?: String;
|
|
1932
1989
|
/**
|
|
1933
|
-
* A value that indicates whether the DB instance is encrypted. By default, it isn't encrypted. Amazon Aurora Not applicable. The encryption for DB instances is managed by the DB cluster.
|
|
1990
|
+
* A value that indicates whether the DB instance is encrypted. By default, it isn't encrypted. For RDS Custom Oracle instances, either set this parameter to true or leave it unset. If you set this parameter to false, RDS reports an error. Amazon Aurora Not applicable. The encryption for DB instances is managed by the DB cluster.
|
|
1934
1991
|
*/
|
|
1935
1992
|
StorageEncrypted?: BooleanOptional;
|
|
1936
1993
|
/**
|
|
1937
|
-
* The Amazon Web Services KMS key identifier for an encrypted DB instance. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the
|
|
1994
|
+
* The Amazon Web Services KMS key identifier for an encrypted DB instance. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN. Amazon Aurora Not applicable. The Amazon Web Services 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 KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region. Amazon RDS Custom A KMS key is required for RDS Custom Oracle instances. For most RDS engines, if you leave this parameter empty while enabling StorageEncrypted, the engine uses the default KMS key. However, RDS Custom for Oracle doesn't use the default key when this parameter is empty. You must explicitly specify a key.
|
|
1938
1995
|
*/
|
|
1939
1996
|
KmsKeyId?: String;
|
|
1940
1997
|
/**
|
|
1941
|
-
* The Active Directory directory ID to create the DB instance in. Currently, only MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain. For more information, see Kerberos Authentication in the Amazon RDS User Guide.
|
|
1998
|
+
* The Active Directory directory ID to create the DB instance in. Currently, only MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain. For more information, see Kerberos Authentication in the Amazon RDS User Guide. This setting doesn't apply to RDS Custom.
|
|
1942
1999
|
*/
|
|
1943
2000
|
Domain?: String;
|
|
1944
2001
|
/**
|
|
@@ -1946,19 +2003,19 @@ declare namespace RDS {
|
|
|
1946
2003
|
*/
|
|
1947
2004
|
CopyTagsToSnapshot?: BooleanOptional;
|
|
1948
2005
|
/**
|
|
1949
|
-
* The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable
|
|
2006
|
+
* The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collection of Enhanced Monitoring metrics, specify 0. The default is 0. If MonitoringRoleArn is specified, then you must set MonitoringInterval to a value other than 0. This setting doesn't apply to RDS Custom. Valid Values: 0, 1, 5, 10, 15, 30, 60
|
|
1950
2007
|
*/
|
|
1951
2008
|
MonitoringInterval?: IntegerOptional;
|
|
1952
2009
|
/**
|
|
1953
|
-
* The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For example, arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role,
|
|
2010
|
+
* The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For example, arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role, see Setting Up and Enabling Enhanced Monitoring in the Amazon RDS User Guide. If MonitoringInterval is set to a value other than 0, then you must supply a MonitoringRoleArn value. This setting doesn't apply to RDS Custom.
|
|
1954
2011
|
*/
|
|
1955
2012
|
MonitoringRoleArn?: String;
|
|
1956
2013
|
/**
|
|
1957
|
-
* Specify the name of the IAM role to be used when making API calls to the Directory Service.
|
|
2014
|
+
* Specify the name of the IAM role to be used when making API calls to the Directory Service. This setting doesn't apply to RDS Custom.
|
|
1958
2015
|
*/
|
|
1959
2016
|
DomainIAMRoleName?: String;
|
|
1960
2017
|
/**
|
|
1961
|
-
* A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide. Default: 1 Valid Values: 0 - 15
|
|
2018
|
+
* A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide. This setting doesn't apply to RDS Custom. Default: 1 Valid Values: 0 - 15
|
|
1962
2019
|
*/
|
|
1963
2020
|
PromotionTier?: IntegerOptional;
|
|
1964
2021
|
/**
|
|
@@ -1966,27 +2023,27 @@ declare namespace RDS {
|
|
|
1966
2023
|
*/
|
|
1967
2024
|
Timezone?: String;
|
|
1968
2025
|
/**
|
|
1969
|
-
* A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled. This setting doesn't apply to Amazon Aurora.
|
|
2026
|
+
* A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled. This setting doesn't apply to RDS Custom or Amazon Aurora. In Aurora, mapping Amazon Web Services IAM accounts to database accounts is managed by the DB cluster. For more information, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.
|
|
1970
2027
|
*/
|
|
1971
2028
|
EnableIAMDatabaseAuthentication?: BooleanOptional;
|
|
1972
2029
|
/**
|
|
1973
|
-
* A value that indicates whether to enable Performance Insights for the DB instance.
|
|
2030
|
+
* A value that indicates whether to enable Performance Insights for the DB instance. For more information, see Using Amazon Performance Insights in the Amazon Relational Database Service User Guide. This setting doesn't apply to RDS Custom.
|
|
1974
2031
|
*/
|
|
1975
2032
|
EnablePerformanceInsights?: BooleanOptional;
|
|
1976
2033
|
/**
|
|
1977
|
-
* The Amazon Web Services KMS key identifier for encryption of Performance Insights data. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the
|
|
2034
|
+
* The Amazon Web Services KMS key identifier for encryption of Performance Insights data. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS uses your default KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region. This setting doesn't apply to RDS Custom.
|
|
1978
2035
|
*/
|
|
1979
2036
|
PerformanceInsightsKMSKeyId?: String;
|
|
1980
2037
|
/**
|
|
1981
|
-
* The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).
|
|
2038
|
+
* The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years). This setting doesn't apply to RDS Custom.
|
|
1982
2039
|
*/
|
|
1983
2040
|
PerformanceInsightsRetentionPeriod?: IntegerOptional;
|
|
1984
2041
|
/**
|
|
1985
|
-
* The list of log types that need to be enabled for exporting to CloudWatch Logs. The values in the list depend on the DB engine
|
|
2042
|
+
* The list of log types that need to be enabled for exporting to CloudWatch Logs. The values in the list depend on the DB engine. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Relational Database Service User Guide. Amazon Aurora Not applicable. CloudWatch Logs exports are managed by the DB cluster. RDS Custom Not applicable. MariaDB Possible values are audit, error, general, and slowquery. Microsoft SQL Server Possible values are agent and error. MySQL Possible values are audit, error, general, and slowquery. Oracle Possible values are alert, audit, listener, trace, and oemagent. PostgreSQL Possible values are postgresql and upgrade.
|
|
1986
2043
|
*/
|
|
1987
2044
|
EnableCloudwatchLogsExports?: LogTypeList;
|
|
1988
2045
|
/**
|
|
1989
|
-
* The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
|
|
2046
|
+
* The number of CPU cores and the number of threads per core for the DB instance class of the DB instance. This setting doesn't apply to RDS Custom.
|
|
1990
2047
|
*/
|
|
1991
2048
|
ProcessorFeatures?: ProcessorFeatureList;
|
|
1992
2049
|
/**
|
|
@@ -1994,13 +2051,17 @@ declare namespace RDS {
|
|
|
1994
2051
|
*/
|
|
1995
2052
|
DeletionProtection?: BooleanOptional;
|
|
1996
2053
|
/**
|
|
1997
|
-
* The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance. For more information about this setting, including limitations that apply to it, see Managing capacity automatically with Amazon RDS storage autoscaling in the Amazon RDS User Guide.
|
|
2054
|
+
* The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance. For more information about this setting, including limitations that apply to it, see Managing capacity automatically with Amazon RDS storage autoscaling in the Amazon RDS User Guide. This setting doesn't apply to RDS Custom.
|
|
1998
2055
|
*/
|
|
1999
2056
|
MaxAllocatedStorage?: IntegerOptional;
|
|
2000
2057
|
/**
|
|
2001
2058
|
* A value that indicates whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB instance. A CoIP provides local or external connectivity to resources in your Outpost subnets through your on-premises network. For some use cases, a CoIP can provide lower latency for connections to the DB instance from outside of its virtual private cloud (VPC) on your local network. For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide. For more information about CoIPs, see Customer-owned IP addresses in the Amazon Web Services Outposts User Guide.
|
|
2002
2059
|
*/
|
|
2003
2060
|
EnableCustomerOwnedIp?: BooleanOptional;
|
|
2061
|
+
/**
|
|
2062
|
+
* The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance. The instance profile must meet the following requirements: The profile must exist in your account. The profile must have an IAM role that Amazon EC2 has permissions to assume. The instance profile name and the associated IAM role name must start with the prefix AWSRDSCustom. For the list of permissions required for the IAM role, see Configure IAM and your VPC in the Amazon Relational Database Service User Guide. This setting is required for RDS Custom.
|
|
2063
|
+
*/
|
|
2064
|
+
CustomIamInstanceProfile?: String;
|
|
2004
2065
|
}
|
|
2005
2066
|
export interface CreateDBInstanceReadReplicaMessage {
|
|
2006
2067
|
/**
|
|
@@ -2008,7 +2069,7 @@ declare namespace RDS {
|
|
|
2008
2069
|
*/
|
|
2009
2070
|
DBInstanceIdentifier: String;
|
|
2010
2071
|
/**
|
|
2011
|
-
* The identifier of the DB instance that will act as the source for the read replica. Each DB instance can have up to five read replicas. Constraints: Must be the identifier of an existing MySQL, MariaDB, Oracle, PostgreSQL, or SQL Server DB instance. Can specify a DB instance that is a MySQL read replica only if the source is running MySQL 5.6 or later. For the limitations of Oracle read replicas, see Read Replica Limitations with Oracle in the Amazon RDS User Guide. For the limitations of SQL Server read replicas, see Read Replica Limitations with Microsoft SQL Server in the Amazon RDS User Guide. Can specify a PostgreSQL DB instance only if the source is running PostgreSQL 9.3.5 or later (9.4.7 and higher for cross-region replication). The specified DB instance must have automatic backups enabled, that is, its backup retention period must be greater than 0. If the source DB instance is in the same Amazon Web Services Region as the read replica, specify a valid DB instance identifier. If the source DB instance is in a different Amazon Web Services Region from the read replica, specify a valid DB instance ARN. For more information, see Constructing an ARN for Amazon RDS in the Amazon RDS User Guide. This doesn't apply to SQL Server, which
|
|
2072
|
+
* The identifier of the DB instance that will act as the source for the read replica. Each DB instance can have up to five read replicas. Constraints: Must be the identifier of an existing MySQL, MariaDB, Oracle, PostgreSQL, or SQL Server DB instance. Can specify a DB instance that is a MySQL read replica only if the source is running MySQL 5.6 or later. For the limitations of Oracle read replicas, see Read Replica Limitations with Oracle in the Amazon RDS User Guide. For the limitations of SQL Server read replicas, see Read Replica Limitations with Microsoft SQL Server in the Amazon RDS User Guide. Can specify a PostgreSQL DB instance only if the source is running PostgreSQL 9.3.5 or later (9.4.7 and higher for cross-region replication). The specified DB instance must have automatic backups enabled, that is, its backup retention period must be greater than 0. If the source DB instance is in the same Amazon Web Services Region as the read replica, specify a valid DB instance identifier. If the source DB instance is in a different Amazon Web Services Region from the read replica, specify a valid DB instance ARN. For more information, see Constructing an ARN for Amazon RDS in the Amazon RDS User Guide. This doesn't apply to SQL Server or RDS Custom, which don't support cross-Region replicas.
|
|
2012
2073
|
*/
|
|
2013
2074
|
SourceDBInstanceIdentifier: String;
|
|
2014
2075
|
/**
|
|
@@ -2024,11 +2085,11 @@ declare namespace RDS {
|
|
|
2024
2085
|
*/
|
|
2025
2086
|
Port?: IntegerOptional;
|
|
2026
2087
|
/**
|
|
2027
|
-
* A value that indicates whether the read replica is in a Multi-AZ deployment. You can create a read replica as a Multi-AZ DB instance. RDS creates a standby of your replica in another Availability Zone for failover support for the replica. Creating your read replica as a Multi-AZ DB instance is independent of whether the source database is a Multi-AZ DB instance.
|
|
2088
|
+
* A value that indicates whether the read replica is in a Multi-AZ deployment. You can create a read replica as a Multi-AZ DB instance. RDS creates a standby of your replica in another Availability Zone for failover support for the replica. Creating your read replica as a Multi-AZ DB instance is independent of whether the source database is a Multi-AZ DB instance. This setting doesn't apply to RDS Custom.
|
|
2028
2089
|
*/
|
|
2029
2090
|
MultiAZ?: BooleanOptional;
|
|
2030
2091
|
/**
|
|
2031
|
-
* A value that indicates whether minor engine upgrades are applied automatically to the read replica during the maintenance window. Default: Inherits from the source DB instance
|
|
2092
|
+
* A value that indicates whether minor engine upgrades are applied automatically to the read replica during the maintenance window. This setting doesn't apply to RDS Custom. Default: Inherits from the source DB instance
|
|
2032
2093
|
*/
|
|
2033
2094
|
AutoMinorVersionUpgrade?: BooleanOptional;
|
|
2034
2095
|
/**
|
|
@@ -2036,11 +2097,11 @@ declare namespace RDS {
|
|
|
2036
2097
|
*/
|
|
2037
2098
|
Iops?: IntegerOptional;
|
|
2038
2099
|
/**
|
|
2039
|
-
* The option group the DB instance is associated with. If omitted, the option group associated with the source instance is used. For SQL Server, you must use the option group associated with the source instance.
|
|
2100
|
+
* The option group the DB instance is associated with. If omitted, the option group associated with the source instance is used. For SQL Server, you must use the option group associated with the source instance. This setting doesn't apply to RDS Custom.
|
|
2040
2101
|
*/
|
|
2041
2102
|
OptionGroupName?: String;
|
|
2042
2103
|
/**
|
|
2043
|
-
* The name of the DB parameter group to associate with this DB instance. If you do not specify a value for DBParameterGroupName, then Amazon RDS uses the DBParameterGroup of source DB instance for a same region read replica, or the default DBParameterGroup for the specified DB engine for a cross region read replica.
|
|
2104
|
+
* The name of the DB parameter group to associate with this DB instance. If you do not specify a value for DBParameterGroupName, then Amazon RDS uses the DBParameterGroup of source DB instance for a same region read replica, or the default DBParameterGroup for the specified DB engine for a cross region read replica. Specifying a parameter group for this operation is only supported for Oracle DB instances. It isn't supported for RDS Custom. Constraints: Must be 1 to 255 letters, numbers, or hyphens. First character must be a letter Can't end with a hyphen or contain two consecutive hyphens
|
|
2044
2105
|
*/
|
|
2045
2106
|
DBParameterGroupName?: String;
|
|
2046
2107
|
/**
|
|
@@ -2053,7 +2114,7 @@ declare namespace RDS {
|
|
|
2053
2114
|
*/
|
|
2054
2115
|
DBSubnetGroupName?: String;
|
|
2055
2116
|
/**
|
|
2056
|
-
* A list of EC2 VPC security groups to associate with the read replica.
|
|
2117
|
+
* A list of Amazon EC2 VPC security groups to associate with the read replica. This setting doesn't apply to RDS Custom. Default: The default EC2 VPC security group for the DB subnet group's VPC.
|
|
2057
2118
|
*/
|
|
2058
2119
|
VpcSecurityGroupIds?: VpcSecurityGroupIdList;
|
|
2059
2120
|
/**
|
|
@@ -2065,47 +2126,47 @@ declare namespace RDS {
|
|
|
2065
2126
|
*/
|
|
2066
2127
|
CopyTagsToSnapshot?: BooleanOptional;
|
|
2067
2128
|
/**
|
|
2068
|
-
* The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the read replica. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0. If MonitoringRoleArn is specified, then you must also set MonitoringInterval to a value other than 0. Valid Values: 0, 1, 5, 10, 15, 30, 60
|
|
2129
|
+
* The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the read replica. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0. If MonitoringRoleArn is specified, then you must also set MonitoringInterval to a value other than 0. This setting doesn't apply to RDS Custom. Valid Values: 0, 1, 5, 10, 15, 30, 60
|
|
2069
2130
|
*/
|
|
2070
2131
|
MonitoringInterval?: IntegerOptional;
|
|
2071
2132
|
/**
|
|
2072
|
-
* The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For example, arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role, go to To create an IAM role for Amazon RDS Enhanced Monitoring in the Amazon RDS User Guide. If MonitoringInterval is set to a value other than 0, then you must supply a MonitoringRoleArn value.
|
|
2133
|
+
* The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For example, arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role, go to To create an IAM role for Amazon RDS Enhanced Monitoring in the Amazon RDS User Guide. If MonitoringInterval is set to a value other than 0, then you must supply a MonitoringRoleArn value. This setting doesn't apply to RDS Custom.
|
|
2073
2134
|
*/
|
|
2074
2135
|
MonitoringRoleArn?: String;
|
|
2075
2136
|
/**
|
|
2076
|
-
* The Amazon Web Services KMS key identifier for an encrypted read replica. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the
|
|
2137
|
+
* The Amazon Web Services KMS key identifier for an encrypted read replica. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. If you create an encrypted read replica in the same Amazon Web Services Region as the source DB instance, then do not specify a value for this parameter. A read replica in the same Amazon Web Services Region is always encrypted with the same KMS key as the source DB instance. If you create an encrypted read replica in a different Amazon Web Services Region, then you must specify a KMS key identifier for the destination Amazon Web Services Region. KMS keys are specific to the Amazon Web Services Region that they are created in, and you can't use KMS keys from one Amazon Web Services Region in another Amazon Web Services Region. You can't create an encrypted read replica from an unencrypted DB instance. This setting doesn't apply to RDS Custom, which uses the same KMS key as the primary replica.
|
|
2077
2138
|
*/
|
|
2078
2139
|
KmsKeyId?: String;
|
|
2079
2140
|
/**
|
|
2080
|
-
* The URL that contains a Signature Version 4 signed request for the CreateDBInstanceReadReplica API action in the source Amazon Web Services Region that contains the source DB instance. You must specify this parameter when you create an encrypted read replica from another Amazon Web Services Region by using the Amazon RDS API. Don't specify PreSignedUrl when you are creating an encrypted read replica in the same Amazon Web Services Region. The presigned URL must be a valid request for the CreateDBInstanceReadReplica API action that can be executed in the source Amazon Web Services Region that contains the encrypted source DB instance. The presigned URL request must contain the following parameter values: DestinationRegion - The Amazon Web Services Region that the encrypted read replica is created in. This Amazon Web Services Region is the same one where the CreateDBInstanceReadReplica action is called that contains this presigned URL. For example, if you create an encrypted DB instance in the us-west-1 Amazon Web Services Region, from a source DB instance in the us-east-2 Amazon Web Services Region, then you call the CreateDBInstanceReadReplica action in the us-east-1 Amazon Web Services Region and provide a presigned URL that contains a call to the CreateDBInstanceReadReplica action in the us-west-2 Amazon Web Services Region. For this example, the DestinationRegion in the presigned URL must be set to the us-east-1 Amazon Web Services Region. KmsKeyId - The Amazon Web Services KMS key identifier for the key to use to encrypt the read replica in the destination Amazon Web Services Region. This is the same identifier for both the CreateDBInstanceReadReplica action that is called in the destination Amazon Web Services Region, and the action contained in the presigned URL. SourceDBInstanceIdentifier - The DB instance identifier for the encrypted DB instance to be replicated. This identifier must be in the Amazon Resource Name (ARN) format for the source Amazon Web Services Region. For example, if you are creating an encrypted read replica from a DB instance in the us-west-2 Amazon Web Services Region, then your SourceDBInstanceIdentifier looks like the following example: arn:aws:rds:us-west-2:123456789012:instance:mysql-instance1-20161115. To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) and Signature Version 4 Signing Process. If you are using an Amazon Web Services SDK tool or the CLI, you can specify SourceRegion (or --source-region for the CLI) instead of specifying PreSignedUrl manually. Specifying SourceRegion autogenerates a presigned URL that is a valid request for the operation that can be executed in the source Amazon Web Services Region. SourceRegion isn't supported for SQL Server, because SQL Server on Amazon RDS doesn't support cross-region read replicas. If you supply a value for this operation's SourceRegion parameter, a pre-signed URL will be calculated on your behalf.
|
|
2141
|
+
* The URL that contains a Signature Version 4 signed request for the CreateDBInstanceReadReplica API action in the source Amazon Web Services Region that contains the source DB instance. You must specify this parameter when you create an encrypted read replica from another Amazon Web Services Region by using the Amazon RDS API. Don't specify PreSignedUrl when you are creating an encrypted read replica in the same Amazon Web Services Region. The presigned URL must be a valid request for the CreateDBInstanceReadReplica API action that can be executed in the source Amazon Web Services Region that contains the encrypted source DB instance. The presigned URL request must contain the following parameter values: DestinationRegion - The Amazon Web Services Region that the encrypted read replica is created in. This Amazon Web Services Region is the same one where the CreateDBInstanceReadReplica action is called that contains this presigned URL. For example, if you create an encrypted DB instance in the us-west-1 Amazon Web Services Region, from a source DB instance in the us-east-2 Amazon Web Services Region, then you call the CreateDBInstanceReadReplica action in the us-east-1 Amazon Web Services Region and provide a presigned URL that contains a call to the CreateDBInstanceReadReplica action in the us-west-2 Amazon Web Services Region. For this example, the DestinationRegion in the presigned URL must be set to the us-east-1 Amazon Web Services Region. KmsKeyId - The Amazon Web Services KMS key identifier for the key to use to encrypt the read replica in the destination Amazon Web Services Region. This is the same identifier for both the CreateDBInstanceReadReplica action that is called in the destination Amazon Web Services Region, and the action contained in the presigned URL. SourceDBInstanceIdentifier - The DB instance identifier for the encrypted DB instance to be replicated. This identifier must be in the Amazon Resource Name (ARN) format for the source Amazon Web Services Region. For example, if you are creating an encrypted read replica from a DB instance in the us-west-2 Amazon Web Services Region, then your SourceDBInstanceIdentifier looks like the following example: arn:aws:rds:us-west-2:123456789012:instance:mysql-instance1-20161115. To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) and Signature Version 4 Signing Process. If you are using an Amazon Web Services SDK tool or the CLI, you can specify SourceRegion (or --source-region for the CLI) instead of specifying PreSignedUrl manually. Specifying SourceRegion autogenerates a presigned URL that is a valid request for the operation that can be executed in the source Amazon Web Services Region. SourceRegion isn't supported for SQL Server, because SQL Server on Amazon RDS doesn't support cross-region read replicas. This setting doesn't apply to RDS Custom.If you supply a value for this operation's SourceRegion parameter, a pre-signed URL will be calculated on your behalf.
|
|
2081
2142
|
*/
|
|
2082
2143
|
PreSignedUrl?: String;
|
|
2083
2144
|
/**
|
|
2084
|
-
* A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled. For more information about IAM database authentication, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.
|
|
2145
|
+
* A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled. For more information about IAM database authentication, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide. This setting doesn't apply to RDS Custom.
|
|
2085
2146
|
*/
|
|
2086
2147
|
EnableIAMDatabaseAuthentication?: BooleanOptional;
|
|
2087
2148
|
/**
|
|
2088
|
-
* A value that indicates whether to enable Performance Insights for the read replica.
|
|
2149
|
+
* A value that indicates whether to enable Performance Insights for the read replica. For more information, see Using Amazon Performance Insights in the Amazon RDS User Guide. This setting doesn't apply to RDS Custom.
|
|
2089
2150
|
*/
|
|
2090
2151
|
EnablePerformanceInsights?: BooleanOptional;
|
|
2091
2152
|
/**
|
|
2092
|
-
* The Amazon Web Services KMS key identifier for encryption of Performance Insights data. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the
|
|
2153
|
+
* The Amazon Web Services KMS key identifier for encryption of Performance Insights data. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS uses your default KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region. This setting doesn't apply to RDS Custom.
|
|
2093
2154
|
*/
|
|
2094
2155
|
PerformanceInsightsKMSKeyId?: String;
|
|
2095
2156
|
/**
|
|
2096
|
-
* The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).
|
|
2157
|
+
* The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years). This setting doesn't apply to RDS Custom.
|
|
2097
2158
|
*/
|
|
2098
2159
|
PerformanceInsightsRetentionPeriod?: IntegerOptional;
|
|
2099
2160
|
/**
|
|
2100
|
-
* The list of logs that the new DB instance is to export to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.
|
|
2161
|
+
* The list of logs that the new DB instance is to export to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide. This setting doesn't apply to RDS Custom.
|
|
2101
2162
|
*/
|
|
2102
2163
|
EnableCloudwatchLogsExports?: LogTypeList;
|
|
2103
2164
|
/**
|
|
2104
|
-
* The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
|
|
2165
|
+
* The number of CPU cores and the number of threads per core for the DB instance class of the DB instance. This setting doesn't apply to RDS Custom.
|
|
2105
2166
|
*/
|
|
2106
2167
|
ProcessorFeatures?: ProcessorFeatureList;
|
|
2107
2168
|
/**
|
|
2108
|
-
* A value that indicates whether the DB instance class of the DB instance uses its default processor features.
|
|
2169
|
+
* A value that indicates whether the DB instance class of the DB instance uses its default processor features. This setting doesn't apply to RDS Custom.
|
|
2109
2170
|
*/
|
|
2110
2171
|
UseDefaultProcessorFeatures?: BooleanOptional;
|
|
2111
2172
|
/**
|
|
@@ -2113,21 +2174,25 @@ declare namespace RDS {
|
|
|
2113
2174
|
*/
|
|
2114
2175
|
DeletionProtection?: BooleanOptional;
|
|
2115
2176
|
/**
|
|
2116
|
-
* The Active Directory directory ID to create the DB instance in. Currently, only MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain. For more information, see Kerberos Authentication in the Amazon RDS User Guide.
|
|
2177
|
+
* The Active Directory directory ID to create the DB instance in. Currently, only MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain. For more information, see Kerberos Authentication in the Amazon RDS User Guide. This setting doesn't apply to RDS Custom.
|
|
2117
2178
|
*/
|
|
2118
2179
|
Domain?: String;
|
|
2119
2180
|
/**
|
|
2120
|
-
* Specify the name of the IAM role to be used when making API calls to the Directory Service.
|
|
2181
|
+
* Specify the name of the IAM role to be used when making API calls to the Directory Service. This setting doesn't apply to RDS Custom.
|
|
2121
2182
|
*/
|
|
2122
2183
|
DomainIAMRoleName?: String;
|
|
2123
2184
|
/**
|
|
2124
|
-
* The open mode of the replica database: mounted or read-only. This parameter is only supported for Oracle DB instances. Mounted DB replicas are included in Oracle Enterprise Edition. The main use case for mounted replicas is cross-Region disaster recovery. The primary database doesn't use Active Data Guard to transmit information to the mounted replica. Because it doesn't accept user connections, a mounted replica can't serve a read-only workload. You can create a combination of mounted and read-only DB replicas for the same primary DB instance. For more information, see Working with Oracle Read Replicas for Amazon RDS in the Amazon RDS User Guide.
|
|
2185
|
+
* The open mode of the replica database: mounted or read-only. This parameter is only supported for Oracle DB instances. Mounted DB replicas are included in Oracle Database Enterprise Edition. The main use case for mounted replicas is cross-Region disaster recovery. The primary database doesn't use Active Data Guard to transmit information to the mounted replica. Because it doesn't accept user connections, a mounted replica can't serve a read-only workload. You can create a combination of mounted and read-only DB replicas for the same primary DB instance. For more information, see Working with Oracle Read Replicas for Amazon RDS in the Amazon RDS User Guide. For RDS Custom, you must specify this parameter and set it to mounted. The value won't be set by default. After replica creation, you can manage the open mode manually.
|
|
2125
2186
|
*/
|
|
2126
2187
|
ReplicaMode?: ReplicaMode;
|
|
2127
2188
|
/**
|
|
2128
2189
|
* The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance. For more information about this setting, including limitations that apply to it, see Managing capacity automatically with Amazon RDS storage autoscaling in the Amazon RDS User Guide.
|
|
2129
2190
|
*/
|
|
2130
2191
|
MaxAllocatedStorage?: IntegerOptional;
|
|
2192
|
+
/**
|
|
2193
|
+
* The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance. The instance profile must meet the following requirements: The profile must exist in your account. The profile must have an IAM role that Amazon EC2 has permissions to assume. The instance profile name and the associated IAM role name must start with the prefix AWSRDSCustom. For the list of permissions required for the IAM role, see Configure IAM and your VPC in the Amazon Relational Database Service User Guide. This setting is required for RDS Custom.
|
|
2194
|
+
*/
|
|
2195
|
+
CustomIamInstanceProfile?: String;
|
|
2131
2196
|
/**
|
|
2132
2197
|
* The ID of the region that contains the source for the read replica.
|
|
2133
2198
|
*/
|
|
@@ -2406,6 +2471,10 @@ declare namespace RDS {
|
|
|
2406
2471
|
*/
|
|
2407
2472
|
CustomAvailabilityZones?: CustomAvailabilityZoneList;
|
|
2408
2473
|
}
|
|
2474
|
+
export type CustomDBEngineVersionManifest = string;
|
|
2475
|
+
export type CustomEngineName = string;
|
|
2476
|
+
export type CustomEngineVersion = string;
|
|
2477
|
+
export type CustomEngineVersionStatus = "available"|"inactive"|"inactive-except-restore"|string;
|
|
2409
2478
|
export interface DBCluster {
|
|
2410
2479
|
/**
|
|
2411
2480
|
* For all database engines except Amazon Aurora, AllocatedStorage specifies the allocated storage size in gibibytes (GiB). For Aurora, AllocatedStorage always returns 1, because Aurora DB cluster storage size isn't fixed, but instead automatically adjusts as needed.
|
|
@@ -2528,11 +2597,11 @@ declare namespace RDS {
|
|
|
2528
2597
|
*/
|
|
2529
2598
|
StorageEncrypted?: Boolean;
|
|
2530
2599
|
/**
|
|
2531
|
-
* If StorageEncrypted is enabled, the Amazon Web Services KMS key identifier for the encrypted DB cluster. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the
|
|
2600
|
+
* If StorageEncrypted is enabled, the Amazon Web Services KMS key identifier for the encrypted DB cluster. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
|
|
2532
2601
|
*/
|
|
2533
2602
|
KmsKeyId?: String;
|
|
2534
2603
|
/**
|
|
2535
|
-
* The Amazon Web Services Region-unique, immutable identifier for the DB cluster. This identifier is found in Amazon Web Services CloudTrail log entries whenever the
|
|
2604
|
+
* The Amazon Web Services Region-unique, immutable identifier for the DB cluster. This identifier is found in Amazon Web Services CloudTrail log entries whenever the KMS key for the DB cluster is accessed.
|
|
2536
2605
|
*/
|
|
2537
2606
|
DbClusterResourceId?: String;
|
|
2538
2607
|
/**
|
|
@@ -2597,7 +2666,7 @@ declare namespace RDS {
|
|
|
2597
2666
|
*/
|
|
2598
2667
|
ActivityStreamStatus?: ActivityStreamStatus;
|
|
2599
2668
|
/**
|
|
2600
|
-
* The Amazon Web Services KMS key identifier used for encrypting messages in the database activity stream. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the
|
|
2669
|
+
* The Amazon Web Services KMS key identifier used for encrypting messages in the database activity stream. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
|
|
2601
2670
|
*/
|
|
2602
2671
|
ActivityStreamKmsKeyId?: String;
|
|
2603
2672
|
/**
|
|
@@ -2839,7 +2908,7 @@ declare namespace RDS {
|
|
|
2839
2908
|
*/
|
|
2840
2909
|
Status?: String;
|
|
2841
2910
|
/**
|
|
2842
|
-
* The name of the feature associated with the Amazon Web Services Identity and Access Management (IAM) role. For
|
|
2911
|
+
* The name of the feature associated with the Amazon Web Services Identity and Access Management (IAM) role. For information about supported feature names, see DBEngineVersion.
|
|
2843
2912
|
*/
|
|
2844
2913
|
FeatureName?: String;
|
|
2845
2914
|
}
|
|
@@ -2914,7 +2983,7 @@ declare namespace RDS {
|
|
|
2914
2983
|
*/
|
|
2915
2984
|
StorageEncrypted?: Boolean;
|
|
2916
2985
|
/**
|
|
2917
|
-
* If StorageEncrypted is true, the Amazon Web Services KMS key identifier for the encrypted DB cluster snapshot. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the
|
|
2986
|
+
* If StorageEncrypted is true, the Amazon Web Services KMS key identifier for the encrypted DB cluster snapshot. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
|
|
2918
2987
|
*/
|
|
2919
2988
|
KmsKeyId?: String;
|
|
2920
2989
|
/**
|
|
@@ -3021,7 +3090,7 @@ declare namespace RDS {
|
|
|
3021
3090
|
*/
|
|
3022
3091
|
SupportedEngineModes?: EngineModeList;
|
|
3023
3092
|
/**
|
|
3024
|
-
* A list of features supported by the DB engine.
|
|
3093
|
+
* A list of features supported by the DB engine. The supported features vary by DB engine and DB engine version. To determine the supported features for a specific DB engine and DB engine version using the CLI, use the following command: aws rds describe-db-engine-versions --engine <engine_name> --engine-version <engine_version> For example, to determine the supported features for RDS for PostgreSQL version 13.3 using the CLI, use the following command: aws rds describe-db-engine-versions --engine postgres --engine-version 13.3 The supported features are listed under SupportedFeatureNames in the output.
|
|
3025
3094
|
*/
|
|
3026
3095
|
SupportedFeatureNames?: FeatureNameList;
|
|
3027
3096
|
/**
|
|
@@ -3036,6 +3105,31 @@ declare namespace RDS {
|
|
|
3036
3105
|
* A value that indicates whether you can use Aurora global databases with a specific DB engine version.
|
|
3037
3106
|
*/
|
|
3038
3107
|
SupportsGlobalDatabases?: Boolean;
|
|
3108
|
+
/**
|
|
3109
|
+
* The major engine version of the CEV.
|
|
3110
|
+
*/
|
|
3111
|
+
MajorEngineVersion?: String;
|
|
3112
|
+
/**
|
|
3113
|
+
* The name of the Amazon S3 bucket that contains your database installation files.
|
|
3114
|
+
*/
|
|
3115
|
+
DatabaseInstallationFilesS3BucketName?: String;
|
|
3116
|
+
/**
|
|
3117
|
+
* The Amazon S3 directory that contains the database installation files. If not specified, then no prefix is assumed.
|
|
3118
|
+
*/
|
|
3119
|
+
DatabaseInstallationFilesS3Prefix?: String;
|
|
3120
|
+
/**
|
|
3121
|
+
* The ARN of the custom engine version.
|
|
3122
|
+
*/
|
|
3123
|
+
DBEngineVersionArn?: String;
|
|
3124
|
+
/**
|
|
3125
|
+
* The Amazon Web Services KMS key identifier for an encrypted CEV. This parameter is required for RDS Custom, but optional for Amazon RDS.
|
|
3126
|
+
*/
|
|
3127
|
+
KMSKeyId?: String;
|
|
3128
|
+
/**
|
|
3129
|
+
* The creation time of the DB engine version.
|
|
3130
|
+
*/
|
|
3131
|
+
CreateTime?: TStamp;
|
|
3132
|
+
TagList?: TagList;
|
|
3039
3133
|
}
|
|
3040
3134
|
export type DBEngineVersionList = DBEngineVersion[];
|
|
3041
3135
|
export interface DBEngineVersionMessage {
|
|
@@ -3130,7 +3224,7 @@ declare namespace RDS {
|
|
|
3130
3224
|
*/
|
|
3131
3225
|
LatestRestorableTime?: TStamp;
|
|
3132
3226
|
/**
|
|
3133
|
-
* Specifies if the DB instance is a Multi-AZ deployment.
|
|
3227
|
+
* Specifies if the DB instance is a Multi-AZ deployment. This setting doesn't apply to RDS Custom.
|
|
3134
3228
|
*/
|
|
3135
3229
|
MultiAZ?: Boolean;
|
|
3136
3230
|
/**
|
|
@@ -3158,7 +3252,7 @@ declare namespace RDS {
|
|
|
3158
3252
|
*/
|
|
3159
3253
|
ReplicaMode?: ReplicaMode;
|
|
3160
3254
|
/**
|
|
3161
|
-
* License model information for this DB instance.
|
|
3255
|
+
* License model information for this DB instance. This setting doesn't apply to RDS Custom.
|
|
3162
3256
|
*/
|
|
3163
3257
|
LicenseModel?: String;
|
|
3164
3258
|
/**
|
|
@@ -3210,11 +3304,11 @@ declare namespace RDS {
|
|
|
3210
3304
|
*/
|
|
3211
3305
|
StorageEncrypted?: Boolean;
|
|
3212
3306
|
/**
|
|
3213
|
-
* If StorageEncrypted is true, the Amazon Web Services KMS key identifier for the encrypted DB instance. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the
|
|
3307
|
+
* If StorageEncrypted is true, the Amazon Web Services KMS key identifier for the encrypted DB instance. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
|
|
3214
3308
|
*/
|
|
3215
3309
|
KmsKeyId?: String;
|
|
3216
3310
|
/**
|
|
3217
|
-
* The Amazon Web Services Region-unique, immutable identifier for the DB instance. This identifier is found in Amazon Web Services CloudTrail log entries whenever the Amazon Web Services KMS
|
|
3311
|
+
* The Amazon Web Services Region-unique, immutable identifier for the DB instance. This identifier is found in Amazon Web Services CloudTrail log entries whenever the Amazon Web Services KMS key for the DB instance is accessed.
|
|
3218
3312
|
*/
|
|
3219
3313
|
DbiResourceId?: String;
|
|
3220
3314
|
/**
|
|
@@ -3262,7 +3356,7 @@ declare namespace RDS {
|
|
|
3262
3356
|
*/
|
|
3263
3357
|
PerformanceInsightsEnabled?: BooleanOptional;
|
|
3264
3358
|
/**
|
|
3265
|
-
* The Amazon Web Services KMS key identifier for encryption of Performance Insights data. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the
|
|
3359
|
+
* The Amazon Web Services KMS key identifier for encryption of Performance Insights data. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
|
|
3266
3360
|
*/
|
|
3267
3361
|
PerformanceInsightsKMSKeyId?: String;
|
|
3268
3362
|
/**
|
|
@@ -3311,7 +3405,7 @@ declare namespace RDS {
|
|
|
3311
3405
|
*/
|
|
3312
3406
|
ActivityStreamStatus?: ActivityStreamStatus;
|
|
3313
3407
|
/**
|
|
3314
|
-
* The Amazon Web Services KMS key identifier used for encrypting messages in the database activity stream. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the
|
|
3408
|
+
* The Amazon Web Services KMS key identifier used for encrypting messages in the database activity stream. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
|
|
3315
3409
|
*/
|
|
3316
3410
|
ActivityStreamKmsKeyId?: String;
|
|
3317
3411
|
/**
|
|
@@ -3326,6 +3420,18 @@ declare namespace RDS {
|
|
|
3326
3420
|
* Indicates whether engine-native audit fields are included in the database activity stream.
|
|
3327
3421
|
*/
|
|
3328
3422
|
ActivityStreamEngineNativeAuditFieldsIncluded?: BooleanOptional;
|
|
3423
|
+
/**
|
|
3424
|
+
* The automation mode of the RDS Custom DB instance: full or all paused. If full, the DB instance automates monitoring and instance recovery. If all paused, the instance pauses automation for the duration set by --resume-full-automation-mode-minutes.
|
|
3425
|
+
*/
|
|
3426
|
+
AutomationMode?: AutomationMode;
|
|
3427
|
+
/**
|
|
3428
|
+
* The number of minutes to pause the automation. When the time period ends, RDS Custom resumes full automation. The minimum value is 60 (default). The maximum value is 1,440.
|
|
3429
|
+
*/
|
|
3430
|
+
ResumeFullAutomationModeTime?: TStamp;
|
|
3431
|
+
/**
|
|
3432
|
+
* The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance. The instance profile must meet the following requirements: The profile must exist in your account. The profile must have an IAM role that Amazon EC2 has permissions to assume. The instance profile name and the associated IAM role name must start with the prefix AWSRDSCustom. For the list of permissions required for the IAM role, see Configure IAM and your VPC in the Amazon Relational Database Service User Guide.
|
|
3433
|
+
*/
|
|
3434
|
+
CustomIamInstanceProfile?: String;
|
|
3329
3435
|
}
|
|
3330
3436
|
export interface DBInstanceAutomatedBackup {
|
|
3331
3437
|
/**
|
|
@@ -3409,7 +3515,7 @@ declare namespace RDS {
|
|
|
3409
3515
|
*/
|
|
3410
3516
|
StorageType?: String;
|
|
3411
3517
|
/**
|
|
3412
|
-
* The Amazon Web Services KMS key ID for an automated backup. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the
|
|
3518
|
+
* The Amazon Web Services KMS key ID for an automated backup. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
|
|
3413
3519
|
*/
|
|
3414
3520
|
KmsKeyId?: String;
|
|
3415
3521
|
/**
|
|
@@ -3468,7 +3574,7 @@ declare namespace RDS {
|
|
|
3468
3574
|
*/
|
|
3469
3575
|
RoleArn?: String;
|
|
3470
3576
|
/**
|
|
3471
|
-
* The name of the feature associated with the Amazon Web Services Identity and Access Management (IAM) role. For
|
|
3577
|
+
* The name of the feature associated with the Amazon Web Services Identity and Access Management (IAM) role. For information about supported feature names, see DBEngineVersion.
|
|
3472
3578
|
*/
|
|
3473
3579
|
FeatureName?: String;
|
|
3474
3580
|
/**
|
|
@@ -3878,7 +3984,7 @@ declare namespace RDS {
|
|
|
3878
3984
|
*/
|
|
3879
3985
|
Encrypted?: Boolean;
|
|
3880
3986
|
/**
|
|
3881
|
-
* If Encrypted is true, the Amazon Web Services KMS key identifier for the encrypted DB snapshot. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the
|
|
3987
|
+
* If Encrypted is true, the Amazon Web Services KMS key identifier for the encrypted DB snapshot. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
|
|
3882
3988
|
*/
|
|
3883
3989
|
KmsKeyId?: String;
|
|
3884
3990
|
/**
|
|
@@ -3985,6 +4091,16 @@ declare namespace RDS {
|
|
|
3985
4091
|
export interface DeleteCustomAvailabilityZoneResult {
|
|
3986
4092
|
CustomAvailabilityZone?: CustomAvailabilityZone;
|
|
3987
4093
|
}
|
|
4094
|
+
export interface DeleteCustomDBEngineVersionMessage {
|
|
4095
|
+
/**
|
|
4096
|
+
* The database engine. The only supported engine is custom-oracle-ee.
|
|
4097
|
+
*/
|
|
4098
|
+
Engine: CustomEngineName;
|
|
4099
|
+
/**
|
|
4100
|
+
* The custom engine version (CEV) for your DB instance. This option is required for RDS Custom, but optional for Amazon RDS. The combination of Engine and EngineVersion is unique per customer per Amazon Web Services Region.
|
|
4101
|
+
*/
|
|
4102
|
+
EngineVersion: CustomEngineVersion;
|
|
4103
|
+
}
|
|
3988
4104
|
export interface DeleteDBClusterEndpointMessage {
|
|
3989
4105
|
/**
|
|
3990
4106
|
* The identifier associated with the custom endpoint. This parameter is stored as a lowercase string.
|
|
@@ -4029,7 +4145,7 @@ declare namespace RDS {
|
|
|
4029
4145
|
*/
|
|
4030
4146
|
DbiResourceId?: String;
|
|
4031
4147
|
/**
|
|
4032
|
-
* The Amazon Resource Name (ARN) of the automated backups to delete, for example, arn:aws:rds:us-east-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE.
|
|
4148
|
+
* The Amazon Resource Name (ARN) of the automated backups to delete, for example, arn:aws:rds:us-east-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE. This setting doesn't apply to RDS Custom.
|
|
4033
4149
|
*/
|
|
4034
4150
|
DBInstanceAutomatedBackupsArn?: String;
|
|
4035
4151
|
}
|
|
@@ -4042,11 +4158,11 @@ declare namespace RDS {
|
|
|
4042
4158
|
*/
|
|
4043
4159
|
DBInstanceIdentifier: String;
|
|
4044
4160
|
/**
|
|
4045
|
-
* A value that indicates whether to skip the creation of a final DB snapshot before the
|
|
4161
|
+
* A value that indicates whether to skip the creation of a final DB snapshot before deleting the instance. If you enable this parameter, RDS doesn't create a DB snapshot. If you don't enable this parameter, RDS creates a DB snapshot before the DB instance is deleted. By default, skip isn't enabled, and the DB snapshot is created. If you don't enable this parameter, you must specify the FinalDBSnapshotIdentifier parameter. When a DB instance is in a failure state and has a status of failed, incompatible-restore, or incompatible-network, RDS can delete the instance only if you enable this parameter. If you delete a read replica or an RDS Custom instance, you must enable this setting. This setting is required for RDS Custom.
|
|
4046
4162
|
*/
|
|
4047
4163
|
SkipFinalSnapshot?: Boolean;
|
|
4048
4164
|
/**
|
|
4049
|
-
* The DBSnapshotIdentifier of the new DBSnapshot created when the SkipFinalSnapshot parameter is disabled.
|
|
4165
|
+
* The DBSnapshotIdentifier of the new DBSnapshot created when the SkipFinalSnapshot parameter is disabled. If you enable this parameter and also enable SkipFinalShapshot, the command results in an error. This setting doesn't apply to RDS Custom. Constraints: Must be 1 to 255 letters or numbers. First character must be a letter. Can't end with a hyphen or contain two consecutive hyphens. Can't be specified when deleting a read replica.
|
|
4050
4166
|
*/
|
|
4051
4167
|
FinalDBSnapshotIdentifier?: String;
|
|
4052
4168
|
/**
|
|
@@ -4375,11 +4491,11 @@ declare namespace RDS {
|
|
|
4375
4491
|
*/
|
|
4376
4492
|
DefaultOnly?: Boolean;
|
|
4377
4493
|
/**
|
|
4378
|
-
* A value that indicates whether to list the supported character sets for each engine version. If this parameter is enabled and the requested engine supports the CharacterSetName parameter for CreateDBInstance, the response includes a list of supported character sets for each engine version.
|
|
4494
|
+
* A value that indicates whether to list the supported character sets for each engine version. If this parameter is enabled and the requested engine supports the CharacterSetName parameter for CreateDBInstance, the response includes a list of supported character sets for each engine version. For RDS Custom, the default is not to list supported character sets. If you set ListSupportedCharacterSets to true, RDS Custom returns no results.
|
|
4379
4495
|
*/
|
|
4380
4496
|
ListSupportedCharacterSets?: BooleanOptional;
|
|
4381
4497
|
/**
|
|
4382
|
-
* A value that indicates whether to list the supported time zones for each engine version. If this parameter is enabled and the requested engine supports the TimeZone parameter for CreateDBInstance, the response includes a list of supported time zones for each engine version.
|
|
4498
|
+
* A value that indicates whether to list the supported time zones for each engine version. If this parameter is enabled and the requested engine supports the TimeZone parameter for CreateDBInstance, the response includes a list of supported time zones for each engine version. For RDS Custom, the default is not to list supported time zones. If you set ListSupportedTimezones to true, RDS Custom returns no results.
|
|
4383
4499
|
*/
|
|
4384
4500
|
ListSupportedTimezones?: BooleanOptional;
|
|
4385
4501
|
/**
|
|
@@ -4409,7 +4525,7 @@ declare namespace RDS {
|
|
|
4409
4525
|
*/
|
|
4410
4526
|
Marker?: String;
|
|
4411
4527
|
/**
|
|
4412
|
-
* The Amazon Resource Name (ARN) of the replicated automated backups, for example, arn:aws:rds:us-east-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE.
|
|
4528
|
+
* The Amazon Resource Name (ARN) of the replicated automated backups, for example, arn:aws:rds:us-east-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE. This setting doesn't apply to RDS Custom.
|
|
4413
4529
|
*/
|
|
4414
4530
|
DBInstanceAutomatedBackupsArn?: String;
|
|
4415
4531
|
}
|
|
@@ -4703,11 +4819,11 @@ declare namespace RDS {
|
|
|
4703
4819
|
*/
|
|
4704
4820
|
Marker?: String;
|
|
4705
4821
|
/**
|
|
4706
|
-
* A value that indicates whether to include shared manual DB cluster snapshots from other Amazon Web Services accounts that this Amazon Web Services account has been given permission to copy or restore. By default, these snapshots are not included. You can give an Amazon Web Services account permission to restore a manual DB snapshot from another Amazon Web Services account by using the ModifyDBSnapshotAttribute API action.
|
|
4822
|
+
* A value that indicates whether to include shared manual DB cluster snapshots from other Amazon Web Services accounts that this Amazon Web Services account has been given permission to copy or restore. By default, these snapshots are not included. You can give an Amazon Web Services account permission to restore a manual DB snapshot from another Amazon Web Services account by using the ModifyDBSnapshotAttribute API action. This setting doesn't apply to RDS Custom.
|
|
4707
4823
|
*/
|
|
4708
4824
|
IncludeShared?: Boolean;
|
|
4709
4825
|
/**
|
|
4710
|
-
* A value that indicates whether to include manual DB cluster snapshots that are public and can be copied or restored by any Amazon Web Services account. By default, the public snapshots are not included. You can share a manual DB snapshot as public by using the ModifyDBSnapshotAttribute API.
|
|
4826
|
+
* A value that indicates whether to include manual DB cluster snapshots that are public and can be copied or restored by any Amazon Web Services account. By default, the public snapshots are not included. You can share a manual DB snapshot as public by using the ModifyDBSnapshotAttribute API. This setting doesn't apply to RDS Custom.
|
|
4711
4827
|
*/
|
|
4712
4828
|
IncludePublic?: Boolean;
|
|
4713
4829
|
/**
|
|
@@ -4851,7 +4967,7 @@ declare namespace RDS {
|
|
|
4851
4967
|
*/
|
|
4852
4968
|
SourceArn?: String;
|
|
4853
4969
|
/**
|
|
4854
|
-
* Filters specify one or more snapshot exports to describe. The filters are specified as name-value pairs that define what to include in the output. Filter names and values are case-sensitive. Supported filters include the following: export-task-identifier - An identifier for the snapshot export task. s3-bucket - The Amazon S3 bucket the snapshot is exported to. source-arn - The Amazon Resource Name (ARN) of the snapshot exported to Amazon S3 status - The status of the export task. Must be lowercase
|
|
4970
|
+
* Filters specify one or more snapshot exports to describe. The filters are specified as name-value pairs that define what to include in the output. Filter names and values are case-sensitive. Supported filters include the following: export-task-identifier - An identifier for the snapshot export task. s3-bucket - The Amazon S3 bucket the snapshot is exported to. source-arn - The Amazon Resource Name (ARN) of the snapshot exported to Amazon S3 status - The status of the export task. Must be lowercase. Valid statuses are the following: canceled canceling complete failed starting
|
|
4855
4971
|
*/
|
|
4856
4972
|
Filters?: FilterList;
|
|
4857
4973
|
/**
|
|
@@ -4961,15 +5077,15 @@ declare namespace RDS {
|
|
|
4961
5077
|
*/
|
|
4962
5078
|
DBInstanceClass?: String;
|
|
4963
5079
|
/**
|
|
4964
|
-
* The license model filter value. Specify this parameter to show only the available offerings matching the specified license model.
|
|
5080
|
+
* The license model filter value. Specify this parameter to show only the available offerings matching the specified license model. RDS Custom supports only the BYOL licensing model.
|
|
4965
5081
|
*/
|
|
4966
5082
|
LicenseModel?: String;
|
|
4967
5083
|
/**
|
|
4968
|
-
* The Availability Zone group associated with a Local Zone. Specify this parameter to retrieve available offerings for the Local Zones in the group. Omit this parameter to show the available offerings in the specified Amazon Web Services Region.
|
|
5084
|
+
* The Availability Zone group associated with a Local Zone. Specify this parameter to retrieve available offerings for the Local Zones in the group. Omit this parameter to show the available offerings in the specified Amazon Web Services Region. This setting doesn't apply to RDS Custom.
|
|
4969
5085
|
*/
|
|
4970
5086
|
AvailabilityZoneGroup?: String;
|
|
4971
5087
|
/**
|
|
4972
|
-
* A value that indicates whether to show only VPC or non-VPC offerings.
|
|
5088
|
+
* A value that indicates whether to show only VPC or non-VPC offerings. RDS Custom supports only VPC offerings. RDS Custom supports only VPC offerings. If you describe non-VPC offerings for RDS Custom, the output shows VPC offerings.
|
|
4973
5089
|
*/
|
|
4974
5090
|
Vpc?: BooleanOptional;
|
|
4975
5091
|
/**
|
|
@@ -5114,6 +5230,7 @@ declare namespace RDS {
|
|
|
5114
5230
|
export interface DescribeValidDBInstanceModificationsResult {
|
|
5115
5231
|
ValidDBInstanceModificationsMessage?: ValidDBInstanceModificationsMessage;
|
|
5116
5232
|
}
|
|
5233
|
+
export type Description = string;
|
|
5117
5234
|
export interface DomainMembership {
|
|
5118
5235
|
/**
|
|
5119
5236
|
* The identifier of the Active Directory Domain.
|
|
@@ -5373,7 +5490,7 @@ declare namespace RDS {
|
|
|
5373
5490
|
*/
|
|
5374
5491
|
IamRoleArn?: String;
|
|
5375
5492
|
/**
|
|
5376
|
-
* The key identifier of the Amazon Web Services KMS
|
|
5493
|
+
* The key identifier of the Amazon Web Services KMS key that is used to encrypt the snapshot when it's exported to Amazon S3. The KMS key 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 KMS key.
|
|
5377
5494
|
*/
|
|
5378
5495
|
KmsKeyId?: String;
|
|
5379
5496
|
/**
|
|
@@ -5468,7 +5585,7 @@ declare namespace RDS {
|
|
|
5468
5585
|
*/
|
|
5469
5586
|
GlobalClusterIdentifier?: String;
|
|
5470
5587
|
/**
|
|
5471
|
-
* The Amazon Web Services Region-unique, immutable identifier for the global database cluster. This identifier is found in Amazon Web Services CloudTrail log entries whenever the Amazon Web Services KMS
|
|
5588
|
+
* The Amazon Web Services Region-unique, immutable identifier for the global database cluster. This identifier is found in Amazon Web Services CloudTrail log entries whenever the Amazon Web Services KMS key for the DB cluster is accessed.
|
|
5472
5589
|
*/
|
|
5473
5590
|
GlobalClusterResourceId?: String;
|
|
5474
5591
|
/**
|
|
@@ -5627,6 +5744,7 @@ declare namespace RDS {
|
|
|
5627
5744
|
export type Integer = number;
|
|
5628
5745
|
export type IntegerOptional = number;
|
|
5629
5746
|
export type KeyList = String[];
|
|
5747
|
+
export type KmsKeyIdOrArn = string;
|
|
5630
5748
|
export interface ListTagsForResourceMessage {
|
|
5631
5749
|
/**
|
|
5632
5750
|
* The Amazon RDS resource with tags to be listed. This value is an Amazon Resource Name (ARN). For information about creating an ARN, see Constructing an ARN for Amazon RDS in the Amazon RDS User Guide.
|
|
@@ -5683,6 +5801,24 @@ declare namespace RDS {
|
|
|
5683
5801
|
*/
|
|
5684
5802
|
TimeoutAction?: String;
|
|
5685
5803
|
}
|
|
5804
|
+
export interface ModifyCustomDBEngineVersionMessage {
|
|
5805
|
+
/**
|
|
5806
|
+
* The DB engine. The only supported value is custom-oracle-ee.
|
|
5807
|
+
*/
|
|
5808
|
+
Engine: CustomEngineName;
|
|
5809
|
+
/**
|
|
5810
|
+
* The custom engine version (CEV) that you want to modify. This option is required for RDS Custom, but optional for Amazon RDS. The combination of Engine and EngineVersion is unique per customer per Amazon Web Services Region.
|
|
5811
|
+
*/
|
|
5812
|
+
EngineVersion: CustomEngineVersion;
|
|
5813
|
+
/**
|
|
5814
|
+
* An optional description of your CEV.
|
|
5815
|
+
*/
|
|
5816
|
+
Description?: Description;
|
|
5817
|
+
/**
|
|
5818
|
+
* The availability status to be assigned to the CEV. Valid values are as follows: available You can use this CEV to create a new RDS Custom DB instance. inactive You can create a new RDS Custom instance by restoring a DB snapshot with this CEV. You can't patch or create new instances with this CEV. You can change any status to any status. A typical reason to change status is to prevent the accidental use of a CEV, or to make a deprecated CEV eligible for use again. For example, you might change the status of your CEV from available to inactive, and from inactive back to available. To change the availability status of the CEV, it must not currently be in use by an RDS Custom instance, snapshot, or automated backup.
|
|
5819
|
+
*/
|
|
5820
|
+
Status?: CustomEngineVersionStatus;
|
|
5821
|
+
}
|
|
5686
5822
|
export interface ModifyDBClusterEndpointMessage {
|
|
5687
5823
|
/**
|
|
5688
5824
|
* The identifier of the endpoint to modify. This parameter is stored as a lowercase string.
|
|
@@ -5843,19 +5979,19 @@ declare namespace RDS {
|
|
|
5843
5979
|
*/
|
|
5844
5980
|
AllocatedStorage?: IntegerOptional;
|
|
5845
5981
|
/**
|
|
5846
|
-
* The new compute and memory capacity of the DB instance, for example, db.m4.large. Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB Instance Class in the Amazon RDS User Guide. If you modify the DB instance class, an outage occurs during the change. The change is applied during the next maintenance window, unless ApplyImmediately is enabled for this request. Default: Uses existing setting
|
|
5982
|
+
* The new compute and memory capacity of the DB instance, for example, db.m4.large. Not all DB instance classes are available in all Amazon Web Services Regions, or for all database engines. For the full list of DB instance classes, and availability for your engine, see DB Instance Class in the Amazon RDS User Guide. If you modify the DB instance class, an outage occurs during the change. The change is applied during the next maintenance window, unless ApplyImmediately is enabled for this request. This setting doesn't apply to RDS Custom. Default: Uses existing setting
|
|
5847
5983
|
*/
|
|
5848
5984
|
DBInstanceClass?: String;
|
|
5849
5985
|
/**
|
|
5850
|
-
* The new DB subnet group for the DB instance. You can use this parameter to move your DB instance to a different VPC. If your DB instance isn't in a VPC, you can also use this parameter to move your DB instance into a VPC. For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide. Changing the subnet group causes an outage during the change. The change is applied during the next maintenance window, unless you enable ApplyImmediately. Constraints: If supplied, must match the name of an existing DBSubnetGroup. Example: mySubnetGroup
|
|
5986
|
+
* The new DB subnet group for the DB instance. You can use this parameter to move your DB instance to a different VPC. If your DB instance isn't in a VPC, you can also use this parameter to move your DB instance into a VPC. For more information, see Working with a DB instance in a VPC in the Amazon RDS User Guide. Changing the subnet group causes an outage during the change. The change is applied during the next maintenance window, unless you enable ApplyImmediately. This parameter doesn't apply to RDS Custom. Constraints: If supplied, must match the name of an existing DBSubnetGroup. Example: mySubnetGroup
|
|
5851
5987
|
*/
|
|
5852
5988
|
DBSubnetGroupName?: String;
|
|
5853
5989
|
/**
|
|
5854
|
-
* A list of DB security groups to authorize on this DB instance. Changing this setting doesn't result in an outage and the change is asynchronously applied as soon as possible. Constraints: If supplied, must match existing DBSecurityGroups.
|
|
5990
|
+
* A list of DB security groups to authorize on this DB instance. Changing this setting doesn't result in an outage and the change is asynchronously applied as soon as possible. This setting doesn't apply to RDS Custom. Constraints: If supplied, must match existing DBSecurityGroups.
|
|
5855
5991
|
*/
|
|
5856
5992
|
DBSecurityGroups?: DBSecurityGroupNameList;
|
|
5857
5993
|
/**
|
|
5858
|
-
* A list of EC2 VPC security groups to authorize on this DB instance. This change is asynchronously applied as soon as possible. Amazon Aurora Not applicable. The associated list of EC2 VPC security groups is managed by the DB cluster. For more information, see ModifyDBCluster. Constraints: If supplied, must match existing VpcSecurityGroupIds.
|
|
5994
|
+
* A list of Amazon EC2 VPC security groups to authorize on this DB instance. This change is asynchronously applied as soon as possible. This setting doesn't apply to RDS Custom. Amazon Aurora Not applicable. The associated list of EC2 VPC security groups is managed by the DB cluster. For more information, see ModifyDBCluster. Constraints: If supplied, must match existing VpcSecurityGroupIds.
|
|
5859
5995
|
*/
|
|
5860
5996
|
VpcSecurityGroupIds?: VpcSecurityGroupIdList;
|
|
5861
5997
|
/**
|
|
@@ -5863,15 +5999,15 @@ declare namespace RDS {
|
|
|
5863
5999
|
*/
|
|
5864
6000
|
ApplyImmediately?: Boolean;
|
|
5865
6001
|
/**
|
|
5866
|
-
* The new password for the master user. The password can include any printable ASCII character except "/", """, or "@". Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible. Between the time of the request and the completion of the request, the MasterUserPassword element exists in the PendingModifiedValues element of the operation response.
|
|
6002
|
+
* The new password for the master user. The password can include any printable ASCII character except "/", """, or "@". Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible. Between the time of the request and the completion of the request, the MasterUserPassword element exists in the PendingModifiedValues element of the operation response. This setting doesn't apply to RDS Custom. Amazon Aurora Not applicable. The password for the master user is managed by the DB cluster. For more information, see ModifyDBCluster. Default: Uses existing setting MariaDB Constraints: Must contain from 8 to 41 characters. Microsoft SQL Server Constraints: Must contain from 8 to 128 characters. MySQL Constraints: Must contain from 8 to 41 characters. Oracle Constraints: Must contain from 8 to 30 characters. PostgreSQL Constraints: Must contain from 8 to 128 characters. Amazon RDS API actions never return the password, so this action provides a way to regain access to a primary instance user if the password is lost. This includes restoring privileges that might have been accidentally revoked.
|
|
5867
6003
|
*/
|
|
5868
6004
|
MasterUserPassword?: String;
|
|
5869
6005
|
/**
|
|
5870
|
-
* The name of the DB parameter group to apply to the DB instance. Changing this setting doesn't result in an outage. The parameter group name itself is changed immediately, but the actual parameter changes are not applied until you reboot the instance without failover. In this case, the DB instance isn't rebooted automatically and the parameter changes
|
|
6006
|
+
* The name of the DB parameter group to apply to the DB instance. Changing this setting doesn't result in an outage. The parameter group name itself is changed immediately, but the actual parameter changes are not applied until you reboot the instance without failover. In this case, the DB instance isn't rebooted automatically, and the parameter changes aren't applied during the next maintenance window. However, if you modify dynamic parameters in the newly associated DB parameter group, these changes are applied immediately without a reboot. This setting doesn't apply to RDS Custom. Default: Uses existing setting Constraints: The DB parameter group must be in the same DB parameter group family as the DB instance.
|
|
5871
6007
|
*/
|
|
5872
6008
|
DBParameterGroupName?: String;
|
|
5873
6009
|
/**
|
|
5874
|
-
* The number of days to retain automated backups. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups. Enabling and disabling backups can result in a brief I/O suspension that lasts from a few seconds to a few minutes, depending on the size and class of your DB instance. These changes are applied during the next maintenance window unless the ApplyImmediately parameter is enabled for this request. If you change the parameter from one non-zero value to another non-zero value, the change is asynchronously applied as soon as possible. Amazon Aurora Not applicable. The retention period for automated backups is managed by the DB cluster. For more information, see ModifyDBCluster. Default: Uses existing setting Constraints:
|
|
6010
|
+
* The number of days to retain automated backups. Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups. Enabling and disabling backups can result in a brief I/O suspension that lasts from a few seconds to a few minutes, depending on the size and class of your DB instance. These changes are applied during the next maintenance window unless the ApplyImmediately parameter is enabled for this request. If you change the parameter from one non-zero value to another non-zero value, the change is asynchronously applied as soon as possible. Amazon Aurora Not applicable. The retention period for automated backups is managed by the DB cluster. For more information, see ModifyDBCluster. Default: Uses existing setting Constraints: It must be a value from 0 to 35. It can't be set to 0 if the DB instance is a source to read replicas. It can't be set to 0 or 35 for an RDS Custom DB instance. It can be specified for a MySQL read replica only if the source is running MySQL 5.6 or later. It can be specified for a PostgreSQL read replica only if the source is running PostgreSQL 9.3.5.
|
|
5875
6011
|
*/
|
|
5876
6012
|
BackupRetentionPeriod?: IntegerOptional;
|
|
5877
6013
|
/**
|
|
@@ -5883,23 +6019,23 @@ declare namespace RDS {
|
|
|
5883
6019
|
*/
|
|
5884
6020
|
PreferredMaintenanceWindow?: String;
|
|
5885
6021
|
/**
|
|
5886
|
-
* A value that indicates whether the DB instance is a Multi-AZ deployment. Changing this parameter doesn't result in an outage
|
|
6022
|
+
* A value that indicates whether the DB instance is a Multi-AZ deployment. Changing this parameter doesn't result in an outage. The change is applied during the next maintenance window unless the ApplyImmediately parameter is enabled for this request. This setting doesn't apply to RDS Custom.
|
|
5887
6023
|
*/
|
|
5888
6024
|
MultiAZ?: BooleanOptional;
|
|
5889
6025
|
/**
|
|
5890
|
-
* The version number of the database engine to upgrade to. Changing this parameter results in an outage and the change is applied during the next maintenance window unless the ApplyImmediately parameter is enabled for this request. For major version upgrades, if a nondefault DB parameter group is currently in use, a new DB parameter group in the DB parameter group family for the new engine version must be specified. The new DB parameter group can be the default for that DB parameter group family. If you specify only a major version, Amazon RDS will update the DB instance to the default minor version if the current minor version is lower. For information about valid engine versions, see CreateDBInstance, or call DescribeDBEngineVersions.
|
|
6026
|
+
* The version number of the database engine to upgrade to. Changing this parameter results in an outage and the change is applied during the next maintenance window unless the ApplyImmediately parameter is enabled for this request. For major version upgrades, if a nondefault DB parameter group is currently in use, a new DB parameter group in the DB parameter group family for the new engine version must be specified. The new DB parameter group can be the default for that DB parameter group family. If you specify only a major version, Amazon RDS will update the DB instance to the default minor version if the current minor version is lower. For information about valid engine versions, see CreateDBInstance, or call DescribeDBEngineVersions. In RDS Custom, this parameter is supported for read replicas only if they are in the PATCH_DB_FAILURE lifecycle.
|
|
5891
6027
|
*/
|
|
5892
6028
|
EngineVersion?: String;
|
|
5893
6029
|
/**
|
|
5894
|
-
* A value that indicates whether major version upgrades are allowed. Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible. Constraints: Major version upgrades must be allowed when specifying a value for the EngineVersion parameter that is a different major version than the DB instance's current version.
|
|
6030
|
+
* A value that indicates whether major version upgrades are allowed. Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible. This setting doesn't apply to RDS Custom. Constraints: Major version upgrades must be allowed when specifying a value for the EngineVersion parameter that is a different major version than the DB instance's current version.
|
|
5895
6031
|
*/
|
|
5896
6032
|
AllowMajorVersionUpgrade?: Boolean;
|
|
5897
6033
|
/**
|
|
5898
|
-
*
|
|
6034
|
+
* A value that indicates whether minor version upgrades are applied automatically to the DB instance during the maintenance window. An outage occurs when all the following conditions are met: The automatic upgrade is enabled for the maintenance window. A newer minor version is available. RDS has enabled automatic patching for the engine version. If any of the preceding conditions isn't met, RDS applies the change as soon as possible and doesn't cause an outage. For an RDS Custom DB instance, set AutoMinorVersionUpgrade to false. Otherwise, the operation returns an error.
|
|
5899
6035
|
*/
|
|
5900
6036
|
AutoMinorVersionUpgrade?: BooleanOptional;
|
|
5901
6037
|
/**
|
|
5902
|
-
* The license model for the DB instance. Valid values: license-included | bring-your-own-license | general-public-license
|
|
6038
|
+
* The license model for the DB instance. This setting doesn't apply to RDS Custom. Valid values: license-included | bring-your-own-license | general-public-license
|
|
5903
6039
|
*/
|
|
5904
6040
|
LicenseModel?: String;
|
|
5905
6041
|
/**
|
|
@@ -5907,11 +6043,11 @@ declare namespace RDS {
|
|
|
5907
6043
|
*/
|
|
5908
6044
|
Iops?: IntegerOptional;
|
|
5909
6045
|
/**
|
|
5910
|
-
*
|
|
6046
|
+
* A value that indicates the DB instance should be associated with the specified option group. Changing this parameter doesn't result in an outage, with one exception. If the parameter change results in an option group that enables OEM, it can cause a brief period, lasting less than a second, during which new connections are rejected but existing connections aren't interrupted. The change is applied during the next maintenance window unless the ApplyImmediately parameter is enabled for this request. Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group, and that option group can't be removed from a DB instance after it is associated with a DB instance. This setting doesn't apply to RDS Custom.
|
|
5911
6047
|
*/
|
|
5912
6048
|
OptionGroupName?: String;
|
|
5913
6049
|
/**
|
|
5914
|
-
*
|
|
6050
|
+
* The new DB instance identifier for the DB instance when renaming a DB instance. When you change the DB instance identifier, an instance reboot occurs immediately if you enable ApplyImmediately, or will occur during the next maintenance window if you disable Apply Immediately. This value is stored as a lowercase string. This setting doesn't apply to RDS Custom. Constraints: Must contain from 1 to 63 letters, numbers, or hyphens. The first character must be a letter. Can't end with a hyphen or contain two consecutive hyphens. Example: mydbinstance
|
|
5915
6051
|
*/
|
|
5916
6052
|
NewDBInstanceIdentifier?: String;
|
|
5917
6053
|
/**
|
|
@@ -5919,19 +6055,19 @@ declare namespace RDS {
|
|
|
5919
6055
|
*/
|
|
5920
6056
|
StorageType?: String;
|
|
5921
6057
|
/**
|
|
5922
|
-
* The ARN from the key store with which to associate the instance for TDE encryption.
|
|
6058
|
+
* The ARN from the key store with which to associate the instance for TDE encryption. This setting doesn't apply to RDS Custom.
|
|
5923
6059
|
*/
|
|
5924
6060
|
TdeCredentialArn?: String;
|
|
5925
6061
|
/**
|
|
5926
|
-
* The password for the given ARN from the key store in order to access the device.
|
|
6062
|
+
* The password for the given ARN from the key store in order to access the device. This setting doesn't apply to RDS Custom.
|
|
5927
6063
|
*/
|
|
5928
6064
|
TdeCredentialPassword?: String;
|
|
5929
6065
|
/**
|
|
5930
|
-
*
|
|
6066
|
+
* Specifies the certificate to associate with the DB instance. This setting doesn't apply to RDS Custom.
|
|
5931
6067
|
*/
|
|
5932
6068
|
CACertificateIdentifier?: String;
|
|
5933
6069
|
/**
|
|
5934
|
-
* The Active Directory directory ID to move the DB instance to. Specify none to remove the instance from its current domain.
|
|
6070
|
+
* The Active Directory directory ID to move the DB instance to. Specify none to remove the instance from its current domain. You must create the domain before this operation. Currently, you can create only MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances in an Active Directory Domain. For more information, see Kerberos Authentication in the Amazon RDS User Guide. This setting doesn't apply to RDS Custom.
|
|
5935
6071
|
*/
|
|
5936
6072
|
Domain?: String;
|
|
5937
6073
|
/**
|
|
@@ -5939,55 +6075,55 @@ declare namespace RDS {
|
|
|
5939
6075
|
*/
|
|
5940
6076
|
CopyTagsToSnapshot?: BooleanOptional;
|
|
5941
6077
|
/**
|
|
5942
|
-
* The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0
|
|
6078
|
+
* The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0, which is the default. If MonitoringRoleArn is specified, set MonitoringInterval to a value other than 0. This setting doesn't apply to RDS Custom. Valid Values: 0, 1, 5, 10, 15, 30, 60
|
|
5943
6079
|
*/
|
|
5944
6080
|
MonitoringInterval?: IntegerOptional;
|
|
5945
6081
|
/**
|
|
5946
|
-
* The port number on which the database accepts connections. The value of the DBPortNumber parameter must not match any of the port values specified for options in the option group for the DB instance.
|
|
6082
|
+
* The port number on which the database accepts connections. The value of the DBPortNumber parameter must not match any of the port values specified for options in the option group for the DB instance. If you change the DBPortNumber value, your database restarts regardless of the value of the ApplyImmediately parameter. This setting doesn't apply to RDS Custom. MySQL Default: 3306 Valid values: 1150-65535 MariaDB Default: 3306 Valid values: 1150-65535 PostgreSQL Default: 5432 Valid values: 1150-65535 Type: Integer Oracle Default: 1521 Valid values: 1150-65535 SQL Server Default: 1433 Valid values: 1150-65535 except 1234, 1434, 3260, 3343, 3389, 47001, and 49152-49156. Amazon Aurora Default: 3306 Valid values: 1150-65535
|
|
5947
6083
|
*/
|
|
5948
6084
|
DBPortNumber?: IntegerOptional;
|
|
5949
6085
|
/**
|
|
5950
|
-
* A value that indicates whether the DB instance is publicly accessible. When the DB instance is publicly accessible, its DNS endpoint resolves to the private IP address from within the DB instance's VPC, and to the public IP address from outside of the DB instance's VPC. Access to the DB instance is ultimately controlled by the security group it uses, and that public access is not permitted if the security group assigned to the DB instance doesn't permit it. When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address. PubliclyAccessible only applies to DB instances in a VPC. The DB instance must be part of a public subnet and PubliclyAccessible must be enabled for it to be publicly accessible. Changes to the PubliclyAccessible parameter are applied immediately regardless of the value of the ApplyImmediately parameter.
|
|
6086
|
+
* A value that indicates whether the DB instance is publicly accessible. When the DB instance is publicly accessible, its DNS endpoint resolves to the private IP address from within the DB instance's VPC, and to the public IP address from outside of the DB instance's VPC. Access to the DB instance is ultimately controlled by the security group it uses, and that public access is not permitted if the security group assigned to the DB instance doesn't permit it. When the DB instance isn't publicly accessible, it is an internal DB instance with a DNS name that resolves to a private IP address. PubliclyAccessible only applies to DB instances in a VPC. The DB instance must be part of a public subnet and PubliclyAccessible must be enabled for it to be publicly accessible. Changes to the PubliclyAccessible parameter are applied immediately regardless of the value of the ApplyImmediately parameter. This setting doesn't apply to RDS Custom.
|
|
5951
6087
|
*/
|
|
5952
6088
|
PubliclyAccessible?: BooleanOptional;
|
|
5953
6089
|
/**
|
|
5954
|
-
* The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For example, arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role,
|
|
6090
|
+
* The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs. For example, arn:aws:iam:123456789012:role/emaccess. For information on creating a monitoring role, see To create an IAM role for Amazon RDS Enhanced Monitoring in the Amazon RDS User Guide. If MonitoringInterval is set to a value other than 0, supply a MonitoringRoleArn value. This setting doesn't apply to RDS Custom.
|
|
5955
6091
|
*/
|
|
5956
6092
|
MonitoringRoleArn?: String;
|
|
5957
6093
|
/**
|
|
5958
|
-
* The name of the IAM role to use when making API calls to the Directory Service.
|
|
6094
|
+
* The name of the IAM role to use when making API calls to the Directory Service. This setting doesn't apply to RDS Custom.
|
|
5959
6095
|
*/
|
|
5960
6096
|
DomainIAMRoleName?: String;
|
|
5961
6097
|
/**
|
|
5962
|
-
* A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide. Default: 1 Valid Values: 0 - 15
|
|
6098
|
+
* A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance. For more information, see Fault Tolerance for an Aurora DB Cluster in the Amazon Aurora User Guide. This setting doesn't apply to RDS Custom. Default: 1 Valid Values: 0 - 15
|
|
5963
6099
|
*/
|
|
5964
6100
|
PromotionTier?: IntegerOptional;
|
|
5965
6101
|
/**
|
|
5966
|
-
* A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled. This setting doesn't apply to Amazon Aurora. Mapping Amazon Web Services IAM accounts to database accounts is managed by the DB cluster. For more information about IAM database authentication, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.
|
|
6102
|
+
* A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled. This setting doesn't apply to Amazon Aurora. Mapping Amazon Web Services IAM accounts to database accounts is managed by the DB cluster. For more information about IAM database authentication, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide. This setting doesn't apply to RDS Custom.
|
|
5967
6103
|
*/
|
|
5968
6104
|
EnableIAMDatabaseAuthentication?: BooleanOptional;
|
|
5969
6105
|
/**
|
|
5970
|
-
* A value that indicates whether to enable Performance Insights for the DB instance. For more information, see Using Amazon Performance Insights in the Amazon Relational Database Service User Guide.
|
|
6106
|
+
* A value that indicates whether to enable Performance Insights for the DB instance. For more information, see Using Amazon Performance Insights in the Amazon Relational Database Service User Guide. This setting doesn't apply to RDS Custom.
|
|
5971
6107
|
*/
|
|
5972
6108
|
EnablePerformanceInsights?: BooleanOptional;
|
|
5973
6109
|
/**
|
|
5974
|
-
* The Amazon Web Services KMS key identifier for encryption of Performance Insights data. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the
|
|
6110
|
+
* The Amazon Web Services KMS key identifier for encryption of Performance Insights data. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS uses your default KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region. This setting doesn't apply to RDS Custom.
|
|
5975
6111
|
*/
|
|
5976
6112
|
PerformanceInsightsKMSKeyId?: String;
|
|
5977
6113
|
/**
|
|
5978
|
-
* The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years).
|
|
6114
|
+
* The amount of time, in days, to retain Performance Insights data. Valid values are 7 or 731 (2 years). This setting doesn't apply to RDS Custom.
|
|
5979
6115
|
*/
|
|
5980
6116
|
PerformanceInsightsRetentionPeriod?: IntegerOptional;
|
|
5981
6117
|
/**
|
|
5982
|
-
* The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB instance. A change to the CloudwatchLogsExportConfiguration parameter is always applied to the DB instance immediately. Therefore, the ApplyImmediately parameter has no effect.
|
|
6118
|
+
* The configuration setting for the log types to be enabled for export to CloudWatch Logs for a specific DB instance. A change to the CloudwatchLogsExportConfiguration parameter is always applied to the DB instance immediately. Therefore, the ApplyImmediately parameter has no effect. This setting doesn't apply to RDS Custom.
|
|
5983
6119
|
*/
|
|
5984
6120
|
CloudwatchLogsExportConfiguration?: CloudwatchLogsExportConfiguration;
|
|
5985
6121
|
/**
|
|
5986
|
-
* The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
|
|
6122
|
+
* The number of CPU cores and the number of threads per core for the DB instance class of the DB instance. This setting doesn't apply to RDS Custom.
|
|
5987
6123
|
*/
|
|
5988
6124
|
ProcessorFeatures?: ProcessorFeatureList;
|
|
5989
6125
|
/**
|
|
5990
|
-
* A value that indicates whether the DB instance class of the DB instance uses its default processor features.
|
|
6126
|
+
* A value that indicates whether the DB instance class of the DB instance uses its default processor features. This setting doesn't apply to RDS Custom.
|
|
5991
6127
|
*/
|
|
5992
6128
|
UseDefaultProcessorFeatures?: BooleanOptional;
|
|
5993
6129
|
/**
|
|
@@ -5995,15 +6131,15 @@ declare namespace RDS {
|
|
|
5995
6131
|
*/
|
|
5996
6132
|
DeletionProtection?: BooleanOptional;
|
|
5997
6133
|
/**
|
|
5998
|
-
* The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance. For more information about this setting, including limitations that apply to it, see Managing capacity automatically with Amazon RDS storage autoscaling in the Amazon RDS User Guide.
|
|
6134
|
+
* The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance. For more information about this setting, including limitations that apply to it, see Managing capacity automatically with Amazon RDS storage autoscaling in the Amazon RDS User Guide. This setting doesn't apply to RDS Custom.
|
|
5999
6135
|
*/
|
|
6000
6136
|
MaxAllocatedStorage?: IntegerOptional;
|
|
6001
6137
|
/**
|
|
6002
|
-
* A value that indicates whether the DB instance is restarted when you rotate your SSL/TLS certificate. By default, the DB instance is restarted when you rotate your SSL/TLS certificate. The certificate is not updated until the DB instance is restarted. Set this parameter only if you are not using SSL/TLS to connect to the DB instance. If you are using SSL/TLS to connect to the DB instance, follow the appropriate instructions for your DB engine to rotate your SSL/TLS certificate: For more information about rotating your SSL/TLS certificate for RDS DB engines, see Rotating Your SSL/TLS Certificate. in the Amazon RDS User Guide. For more information about rotating your SSL/TLS certificate for Aurora DB engines, see Rotating Your SSL/TLS Certificate in the Amazon Aurora User Guide.
|
|
6138
|
+
* A value that indicates whether the DB instance is restarted when you rotate your SSL/TLS certificate. By default, the DB instance is restarted when you rotate your SSL/TLS certificate. The certificate is not updated until the DB instance is restarted. Set this parameter only if you are not using SSL/TLS to connect to the DB instance. If you are using SSL/TLS to connect to the DB instance, follow the appropriate instructions for your DB engine to rotate your SSL/TLS certificate: For more information about rotating your SSL/TLS certificate for RDS DB engines, see Rotating Your SSL/TLS Certificate. in the Amazon RDS User Guide. For more information about rotating your SSL/TLS certificate for Aurora DB engines, see Rotating Your SSL/TLS Certificate in the Amazon Aurora User Guide. This setting doesn't apply to RDS Custom.
|
|
6003
6139
|
*/
|
|
6004
6140
|
CertificateRotationRestart?: BooleanOptional;
|
|
6005
6141
|
/**
|
|
6006
|
-
* A value that sets the open mode of a replica database to either mounted or read-only. Currently, this parameter is only supported for Oracle DB instances. Mounted DB replicas are included in Oracle Enterprise Edition. The main use case for mounted replicas is cross-Region disaster recovery. The primary database doesn't use Active Data Guard to transmit information to the mounted replica. Because it doesn't accept user connections, a mounted replica can't serve a read-only workload. For more information, see Working with Oracle Read Replicas for Amazon RDS in the Amazon RDS User Guide.
|
|
6142
|
+
* A value that sets the open mode of a replica database to either mounted or read-only. Currently, this parameter is only supported for Oracle DB instances. Mounted DB replicas are included in Oracle Enterprise Edition. The main use case for mounted replicas is cross-Region disaster recovery. The primary database doesn't use Active Data Guard to transmit information to the mounted replica. Because it doesn't accept user connections, a mounted replica can't serve a read-only workload. For more information, see Working with Oracle Read Replicas for Amazon RDS in the Amazon RDS User Guide. This setting doesn't apply to RDS Custom.
|
|
6007
6143
|
*/
|
|
6008
6144
|
ReplicaMode?: ReplicaMode;
|
|
6009
6145
|
/**
|
|
@@ -6011,9 +6147,17 @@ declare namespace RDS {
|
|
|
6011
6147
|
*/
|
|
6012
6148
|
EnableCustomerOwnedIp?: BooleanOptional;
|
|
6013
6149
|
/**
|
|
6014
|
-
* The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup.
|
|
6150
|
+
* The Amazon Resource Name (ARN) of the recovery point in Amazon Web Services Backup. This setting doesn't apply to RDS Custom.
|
|
6015
6151
|
*/
|
|
6016
6152
|
AwsBackupRecoveryPointArn?: AwsBackupRecoveryPointArn;
|
|
6153
|
+
/**
|
|
6154
|
+
* The automation mode of the RDS Custom DB instance: full or all paused. If full, the DB instance automates monitoring and instance recovery. If all paused, the instance pauses automation for the duration set by ResumeFullAutomationModeMinutes.
|
|
6155
|
+
*/
|
|
6156
|
+
AutomationMode?: AutomationMode;
|
|
6157
|
+
/**
|
|
6158
|
+
* The number of minutes to pause the automation. When the time period ends, RDS Custom resumes full automation. The minimum value is 60 (default). The maximum value is 1,440.
|
|
6159
|
+
*/
|
|
6160
|
+
ResumeFullAutomationModeMinutes?: IntegerOptional;
|
|
6017
6161
|
}
|
|
6018
6162
|
export interface ModifyDBInstanceResult {
|
|
6019
6163
|
DBInstance?: DBInstance;
|
|
@@ -6811,6 +6955,14 @@ declare namespace RDS {
|
|
|
6811
6955
|
* Whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.
|
|
6812
6956
|
*/
|
|
6813
6957
|
IAMDatabaseAuthenticationEnabled?: BooleanOptional;
|
|
6958
|
+
/**
|
|
6959
|
+
* The automation mode of the RDS Custom DB instance: full or all-paused. If full, the DB instance automates monitoring and instance recovery. If all-paused, the instance pauses automation for the duration set by --resume-full-automation-mode-minutes.
|
|
6960
|
+
*/
|
|
6961
|
+
AutomationMode?: AutomationMode;
|
|
6962
|
+
/**
|
|
6963
|
+
* The number of minutes to pause the automation. When the time period ends, RDS Custom resumes full automation. The minimum value is 60 (default). The maximum value is 1,440.
|
|
6964
|
+
*/
|
|
6965
|
+
ResumeFullAutomationModeTime?: TStamp;
|
|
6814
6966
|
}
|
|
6815
6967
|
export interface ProcessorFeature {
|
|
6816
6968
|
/**
|
|
@@ -6957,7 +7109,7 @@ declare namespace RDS {
|
|
|
6957
7109
|
*/
|
|
6958
7110
|
RoleArn: String;
|
|
6959
7111
|
/**
|
|
6960
|
-
* The name of the feature for the DB cluster that the IAM role is to be disassociated from. For
|
|
7112
|
+
* The name of the feature for the DB cluster that the IAM role is to be disassociated from. For information about supported feature names, see DBEngineVersion.
|
|
6961
7113
|
*/
|
|
6962
7114
|
FeatureName?: String;
|
|
6963
7115
|
}
|
|
@@ -6971,7 +7123,7 @@ declare namespace RDS {
|
|
|
6971
7123
|
*/
|
|
6972
7124
|
RoleArn: String;
|
|
6973
7125
|
/**
|
|
6974
|
-
* The name of the feature for the DB instance that the IAM role is to be disassociated from. For
|
|
7126
|
+
* The name of the feature for the DB instance that the IAM role is to be disassociated from. For information about supported feature names, see DBEngineVersion.
|
|
6975
7127
|
*/
|
|
6976
7128
|
FeatureName: String;
|
|
6977
7129
|
}
|
|
@@ -7238,7 +7390,7 @@ declare namespace RDS {
|
|
|
7238
7390
|
*/
|
|
7239
7391
|
StorageEncrypted?: BooleanOptional;
|
|
7240
7392
|
/**
|
|
7241
|
-
* The Amazon Web Services KMS key identifier for an encrypted DB cluster. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the
|
|
7393
|
+
* The Amazon Web Services KMS key identifier for an encrypted DB cluster. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services 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 KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
|
|
7242
7394
|
*/
|
|
7243
7395
|
KmsKeyId?: String;
|
|
7244
7396
|
/**
|
|
@@ -7339,7 +7491,7 @@ declare namespace RDS {
|
|
|
7339
7491
|
*/
|
|
7340
7492
|
Tags?: TagList;
|
|
7341
7493
|
/**
|
|
7342
|
-
* The Amazon Web Services KMS key identifier to use when restoring an encrypted DB cluster from a DB snapshot or DB cluster snapshot. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the
|
|
7494
|
+
* The Amazon Web Services KMS key identifier to use when restoring an encrypted DB cluster from a DB snapshot or DB cluster snapshot. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services 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 KMS key 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.
|
|
7343
7495
|
*/
|
|
7344
7496
|
KmsKeyId?: String;
|
|
7345
7497
|
/**
|
|
@@ -7425,7 +7577,7 @@ declare namespace RDS {
|
|
|
7425
7577
|
VpcSecurityGroupIds?: VpcSecurityGroupIdList;
|
|
7426
7578
|
Tags?: TagList;
|
|
7427
7579
|
/**
|
|
7428
|
-
* The Amazon Web Services KMS key identifier to use when restoring an encrypted DB cluster from an encrypted DB cluster. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the
|
|
7580
|
+
* The Amazon Web Services KMS key identifier to use when restoring an encrypted DB cluster from an encrypted DB cluster. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN. You can restore to a new DB cluster and encrypt the new DB cluster with a KMS key that is different from the KMS key used to encrypt the source DB cluster. The new DB cluster is encrypted with the KMS key 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 KMS key 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.
|
|
7429
7581
|
*/
|
|
7430
7582
|
KmsKeyId?: String;
|
|
7431
7583
|
/**
|
|
@@ -7498,7 +7650,7 @@ declare namespace RDS {
|
|
|
7498
7650
|
*/
|
|
7499
7651
|
DBSubnetGroupName?: String;
|
|
7500
7652
|
/**
|
|
7501
|
-
* A value that indicates whether the DB instance is a Multi-AZ deployment. Constraint: You can't specify the AvailabilityZone parameter if the DB instance is a Multi-AZ deployment.
|
|
7653
|
+
* A value that indicates whether the DB instance is a Multi-AZ deployment. This setting doesn't apply to RDS Custom. Constraint: You can't specify the AvailabilityZone parameter if the DB instance is a Multi-AZ deployment.
|
|
7502
7654
|
*/
|
|
7503
7655
|
MultiAZ?: BooleanOptional;
|
|
7504
7656
|
/**
|
|
@@ -7506,19 +7658,19 @@ declare namespace RDS {
|
|
|
7506
7658
|
*/
|
|
7507
7659
|
PubliclyAccessible?: BooleanOptional;
|
|
7508
7660
|
/**
|
|
7509
|
-
* A value that indicates whether minor version upgrades are applied automatically to the DB instance during the maintenance window.
|
|
7661
|
+
* A value that indicates whether minor version upgrades are applied automatically to the DB instance during the maintenance window. If you restore an RDS Custom DB instance, you must disable this parameter.
|
|
7510
7662
|
*/
|
|
7511
7663
|
AutoMinorVersionUpgrade?: BooleanOptional;
|
|
7512
7664
|
/**
|
|
7513
|
-
* License model information for the restored DB instance. Default: Same as source. Valid values: license-included | bring-your-own-license | general-public-license
|
|
7665
|
+
* License model information for the restored DB instance. This setting doesn't apply to RDS Custom. Default: Same as source. Valid values: license-included | bring-your-own-license | general-public-license
|
|
7514
7666
|
*/
|
|
7515
7667
|
LicenseModel?: String;
|
|
7516
7668
|
/**
|
|
7517
|
-
* The database name for the restored DB instance.
|
|
7669
|
+
* The database name for the restored DB instance. This parameter doesn't apply to the MySQL, PostgreSQL, or MariaDB engines. It also doesn't apply to RDS Custom DB instances.
|
|
7518
7670
|
*/
|
|
7519
7671
|
DBName?: String;
|
|
7520
7672
|
/**
|
|
7521
|
-
* The database engine to use for the new instance. Default: The same as source Constraint: Must be compatible with the engine of the source. For example, you can restore a MariaDB 10.1 DB instance from a MySQL 5.6 snapshot. Valid Values: mariadb mysql oracle-ee oracle-ee-cdb oracle-se2 oracle-se2-cdb postgres sqlserver-ee sqlserver-se sqlserver-ex sqlserver-web
|
|
7673
|
+
* The database engine to use for the new instance. This setting doesn't apply to RDS Custom. Default: The same as source Constraint: Must be compatible with the engine of the source. For example, you can restore a MariaDB 10.1 DB instance from a MySQL 5.6 snapshot. Valid Values: mariadb mysql oracle-ee oracle-ee-cdb oracle-se2 oracle-se2-cdb postgres sqlserver-ee sqlserver-se sqlserver-ex sqlserver-web
|
|
7522
7674
|
*/
|
|
7523
7675
|
Engine?: String;
|
|
7524
7676
|
/**
|
|
@@ -7526,7 +7678,7 @@ declare namespace RDS {
|
|
|
7526
7678
|
*/
|
|
7527
7679
|
Iops?: IntegerOptional;
|
|
7528
7680
|
/**
|
|
7529
|
-
* The name of the option group to be used for the restored DB instance. Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group, and that option group can't be removed from a DB instance
|
|
7681
|
+
* The name of the option group to be used for the restored DB instance. Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group, and that option group can't be removed from a DB instance after it is associated with a DB instance. This setting doesn't apply to RDS Custom.
|
|
7530
7682
|
*/
|
|
7531
7683
|
OptionGroupName?: String;
|
|
7532
7684
|
Tags?: TagList;
|
|
@@ -7535,11 +7687,11 @@ declare namespace RDS {
|
|
|
7535
7687
|
*/
|
|
7536
7688
|
StorageType?: String;
|
|
7537
7689
|
/**
|
|
7538
|
-
* The ARN from the key store with which to associate the instance for TDE encryption.
|
|
7690
|
+
* The ARN from the key store with which to associate the instance for TDE encryption. This setting doesn't apply to RDS Custom.
|
|
7539
7691
|
*/
|
|
7540
7692
|
TdeCredentialArn?: String;
|
|
7541
7693
|
/**
|
|
7542
|
-
* The password for the given ARN from the key store in order to access the device.
|
|
7694
|
+
* The password for the given ARN from the key store in order to access the device. This setting doesn't apply to RDS Custom.
|
|
7543
7695
|
*/
|
|
7544
7696
|
TdeCredentialPassword?: String;
|
|
7545
7697
|
/**
|
|
@@ -7547,7 +7699,7 @@ declare namespace RDS {
|
|
|
7547
7699
|
*/
|
|
7548
7700
|
VpcSecurityGroupIds?: VpcSecurityGroupIdList;
|
|
7549
7701
|
/**
|
|
7550
|
-
* Specify the Active Directory directory ID to restore the DB instance in. The domain must be created prior to this operation. Currently, only MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances
|
|
7702
|
+
* Specify the Active Directory directory ID to restore the DB instance in. The domain/ must be created prior to this operation. Currently, you can create only MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances in an Active Directory Domain. For more information, see Kerberos Authentication in the Amazon RDS User Guide. This setting doesn't apply to RDS Custom.
|
|
7551
7703
|
*/
|
|
7552
7704
|
Domain?: String;
|
|
7553
7705
|
/**
|
|
@@ -7555,27 +7707,27 @@ declare namespace RDS {
|
|
|
7555
7707
|
*/
|
|
7556
7708
|
CopyTagsToSnapshot?: BooleanOptional;
|
|
7557
7709
|
/**
|
|
7558
|
-
* Specify the name of the IAM role to be used when making API calls to the Directory Service.
|
|
7710
|
+
* Specify the name of the IAM role to be used when making API calls to the Directory Service. This setting doesn't apply to RDS Custom.
|
|
7559
7711
|
*/
|
|
7560
7712
|
DomainIAMRoleName?: String;
|
|
7561
7713
|
/**
|
|
7562
|
-
* A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled. For more information about IAM database authentication, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.
|
|
7714
|
+
* A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled. For more information about IAM database authentication, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide. This setting doesn't apply to RDS Custom.
|
|
7563
7715
|
*/
|
|
7564
7716
|
EnableIAMDatabaseAuthentication?: BooleanOptional;
|
|
7565
7717
|
/**
|
|
7566
|
-
* The list of logs that the restored DB instance is to export to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.
|
|
7718
|
+
* The list of logs that the restored DB instance is to export to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide. This setting doesn't apply to RDS Custom.
|
|
7567
7719
|
*/
|
|
7568
7720
|
EnableCloudwatchLogsExports?: LogTypeList;
|
|
7569
7721
|
/**
|
|
7570
|
-
* The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
|
|
7722
|
+
* The number of CPU cores and the number of threads per core for the DB instance class of the DB instance. This setting doesn't apply to RDS Custom.
|
|
7571
7723
|
*/
|
|
7572
7724
|
ProcessorFeatures?: ProcessorFeatureList;
|
|
7573
7725
|
/**
|
|
7574
|
-
* A value that indicates whether the DB instance class of the DB instance uses its default processor features.
|
|
7726
|
+
* A value that indicates whether the DB instance class of the DB instance uses its default processor features. This setting doesn't apply to RDS Custom.
|
|
7575
7727
|
*/
|
|
7576
7728
|
UseDefaultProcessorFeatures?: BooleanOptional;
|
|
7577
7729
|
/**
|
|
7578
|
-
* The name of the DB parameter group to associate with this DB instance. If you
|
|
7730
|
+
* The name of the DB parameter group to associate with this DB instance. If you don't specify a value for DBParameterGroupName, then RDS uses the default DBParameterGroup for the specified DB engine. This setting doesn't apply to RDS Custom. Constraints: If supplied, must match the name of an existing DBParameterGroup. Must be 1 to 255 letters, numbers, or hyphens. First character must be a letter. Can't end with a hyphen or contain two consecutive hyphens.
|
|
7579
7731
|
*/
|
|
7580
7732
|
DBParameterGroupName?: String;
|
|
7581
7733
|
/**
|
|
@@ -7583,9 +7735,13 @@ declare namespace RDS {
|
|
|
7583
7735
|
*/
|
|
7584
7736
|
DeletionProtection?: BooleanOptional;
|
|
7585
7737
|
/**
|
|
7586
|
-
* A value that indicates whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB instance. A CoIP provides local or external connectivity to resources in your Outpost subnets through your on-premises network. For some use cases, a CoIP can provide lower latency for connections to the DB instance from outside of its virtual private cloud (VPC) on your local network. For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide. For more information about CoIPs, see Customer-owned IP addresses in the Amazon Web Services Outposts User Guide.
|
|
7738
|
+
* A value that indicates whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB instance. A CoIP provides local or external connectivity to resources in your Outpost subnets through your on-premises network. For some use cases, a CoIP can provide lower latency for connections to the DB instance from outside of its virtual private cloud (VPC) on your local network. This setting doesn't apply to RDS Custom. For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide. For more information about CoIPs, see Customer-owned IP addresses in the Amazon Web Services Outposts User Guide.
|
|
7587
7739
|
*/
|
|
7588
7740
|
EnableCustomerOwnedIp?: BooleanOptional;
|
|
7741
|
+
/**
|
|
7742
|
+
* The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance. The instance profile must meet the following requirements: The profile must exist in your account. The profile must have an IAM role that Amazon EC2 has permissions to assume. The instance profile name and the associated IAM role name must start with the prefix AWSRDSCustom. For the list of permissions required for the IAM role, see Configure IAM and your VPC in the Amazon Relational Database Service User Guide. This setting is required for RDS Custom.
|
|
7743
|
+
*/
|
|
7744
|
+
CustomIamInstanceProfile?: String;
|
|
7589
7745
|
}
|
|
7590
7746
|
export interface RestoreDBInstanceFromDBSnapshotResult {
|
|
7591
7747
|
DBInstance?: DBInstance;
|
|
@@ -7696,7 +7852,7 @@ declare namespace RDS {
|
|
|
7696
7852
|
*/
|
|
7697
7853
|
StorageEncrypted?: BooleanOptional;
|
|
7698
7854
|
/**
|
|
7699
|
-
* The Amazon Web Services KMS key identifier for an encrypted DB instance. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the
|
|
7855
|
+
* The Amazon Web Services KMS key identifier for an encrypted DB instance. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. To use a KMS key in a different Amazon Web Services 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 KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
|
|
7700
7856
|
*/
|
|
7701
7857
|
KmsKeyId?: String;
|
|
7702
7858
|
/**
|
|
@@ -7740,7 +7896,7 @@ declare namespace RDS {
|
|
|
7740
7896
|
*/
|
|
7741
7897
|
EnablePerformanceInsights?: BooleanOptional;
|
|
7742
7898
|
/**
|
|
7743
|
-
* The Amazon Web Services KMS key identifier for encryption of Performance Insights data. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the
|
|
7899
|
+
* The Amazon Web Services KMS key identifier for encryption of Performance Insights data. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. If you do not specify a value for PerformanceInsightsKMSKeyId, then Amazon RDS uses your default KMS key. There is a default KMS key for your Amazon Web Services account. Your Amazon Web Services account has a different default KMS key for each Amazon Web Services Region.
|
|
7744
7900
|
*/
|
|
7745
7901
|
PerformanceInsightsKMSKeyId?: String;
|
|
7746
7902
|
/**
|
|
@@ -7805,7 +7961,7 @@ declare namespace RDS {
|
|
|
7805
7961
|
*/
|
|
7806
7962
|
DBSubnetGroupName?: String;
|
|
7807
7963
|
/**
|
|
7808
|
-
* A value that indicates whether the DB instance is a Multi-AZ deployment. Constraint: You can't specify the AvailabilityZone parameter if the DB instance is a Multi-AZ deployment.
|
|
7964
|
+
* A value that indicates whether the DB instance is a Multi-AZ deployment. This setting doesn't apply to RDS Custom. Constraint: You can't specify the AvailabilityZone parameter if the DB instance is a Multi-AZ deployment.
|
|
7809
7965
|
*/
|
|
7810
7966
|
MultiAZ?: BooleanOptional;
|
|
7811
7967
|
/**
|
|
@@ -7813,19 +7969,19 @@ declare namespace RDS {
|
|
|
7813
7969
|
*/
|
|
7814
7970
|
PubliclyAccessible?: BooleanOptional;
|
|
7815
7971
|
/**
|
|
7816
|
-
* A value that indicates whether minor version upgrades are applied automatically to the DB instance during the maintenance window.
|
|
7972
|
+
* A value that indicates whether minor version upgrades are applied automatically to the DB instance during the maintenance window. This setting doesn't apply to RDS Custom.
|
|
7817
7973
|
*/
|
|
7818
7974
|
AutoMinorVersionUpgrade?: BooleanOptional;
|
|
7819
7975
|
/**
|
|
7820
|
-
* License model information for the restored DB instance. Default: Same as source. Valid values: license-included | bring-your-own-license | general-public-license
|
|
7976
|
+
* License model information for the restored DB instance. This setting doesn't apply to RDS Custom. Default: Same as source. Valid values: license-included | bring-your-own-license | general-public-license
|
|
7821
7977
|
*/
|
|
7822
7978
|
LicenseModel?: String;
|
|
7823
7979
|
/**
|
|
7824
|
-
* The database name for the restored DB instance. This parameter isn't
|
|
7980
|
+
* The database name for the restored DB instance. This parameter isn't supported for the MySQL or MariaDB engines. It also doesn't apply to RDS Custom.
|
|
7825
7981
|
*/
|
|
7826
7982
|
DBName?: String;
|
|
7827
7983
|
/**
|
|
7828
|
-
* The database engine to use for the new instance. Default: The same as source Constraint: Must be compatible with the engine of the source Valid Values: mariadb mysql oracle-ee oracle-ee-cdb oracle-se2 oracle-se2-cdb postgres sqlserver-ee sqlserver-se sqlserver-ex sqlserver-web
|
|
7984
|
+
* The database engine to use for the new instance. This setting doesn't apply to RDS Custom. Default: The same as source Constraint: Must be compatible with the engine of the source Valid Values: mariadb mysql oracle-ee oracle-ee-cdb oracle-se2 oracle-se2-cdb postgres sqlserver-ee sqlserver-se sqlserver-ex sqlserver-web
|
|
7829
7985
|
*/
|
|
7830
7986
|
Engine?: String;
|
|
7831
7987
|
/**
|
|
@@ -7833,7 +7989,7 @@ declare namespace RDS {
|
|
|
7833
7989
|
*/
|
|
7834
7990
|
Iops?: IntegerOptional;
|
|
7835
7991
|
/**
|
|
7836
|
-
* The name of the option group to be used for the restored DB instance. Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group, and that option group can't be removed from a DB instance
|
|
7992
|
+
* The name of the option group to be used for the restored DB instance. Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group, and that option group can't be removed from a DB instance after it is associated with a DB instance This setting doesn't apply to RDS Custom.
|
|
7837
7993
|
*/
|
|
7838
7994
|
OptionGroupName?: String;
|
|
7839
7995
|
/**
|
|
@@ -7846,11 +8002,11 @@ declare namespace RDS {
|
|
|
7846
8002
|
*/
|
|
7847
8003
|
StorageType?: String;
|
|
7848
8004
|
/**
|
|
7849
|
-
* The ARN from the key store with which to associate the instance for TDE encryption.
|
|
8005
|
+
* The ARN from the key store with which to associate the instance for TDE encryption. This setting doesn't apply to RDS Custom.
|
|
7850
8006
|
*/
|
|
7851
8007
|
TdeCredentialArn?: String;
|
|
7852
8008
|
/**
|
|
7853
|
-
* The password for the given ARN from the key store in order to access the device.
|
|
8009
|
+
* The password for the given ARN from the key store in order to access the device. This setting doesn't apply to RDS Custom.
|
|
7854
8010
|
*/
|
|
7855
8011
|
TdeCredentialPassword?: String;
|
|
7856
8012
|
/**
|
|
@@ -7858,31 +8014,31 @@ declare namespace RDS {
|
|
|
7858
8014
|
*/
|
|
7859
8015
|
VpcSecurityGroupIds?: VpcSecurityGroupIdList;
|
|
7860
8016
|
/**
|
|
7861
|
-
* Specify the Active Directory directory ID to restore the DB instance in.
|
|
8017
|
+
* Specify the Active Directory directory ID to restore the DB instance in. Create the domain before running this command. Currently, you can create only the MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances in an Active Directory Domain. This setting doesn't apply to RDS Custom. For more information, see Kerberos Authentication in the Amazon RDS User Guide.
|
|
7862
8018
|
*/
|
|
7863
8019
|
Domain?: String;
|
|
7864
8020
|
/**
|
|
7865
|
-
* Specify the name of the IAM role to be used when making API calls to the Directory Service.
|
|
8021
|
+
* Specify the name of the IAM role to be used when making API calls to the Directory Service. This setting doesn't apply to RDS Custom.
|
|
7866
8022
|
*/
|
|
7867
8023
|
DomainIAMRoleName?: String;
|
|
7868
8024
|
/**
|
|
7869
|
-
* A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled. For more information about IAM database authentication, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.
|
|
8025
|
+
* A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping is disabled. This setting doesn't apply to RDS Custom. For more information about IAM database authentication, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide.
|
|
7870
8026
|
*/
|
|
7871
8027
|
EnableIAMDatabaseAuthentication?: BooleanOptional;
|
|
7872
8028
|
/**
|
|
7873
|
-
* The list of logs that the restored DB instance is to export to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide.
|
|
8029
|
+
* The list of logs that the restored DB instance is to export to CloudWatch Logs. The values in the list depend on the DB engine being used. For more information, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide. This setting doesn't apply to RDS Custom.
|
|
7874
8030
|
*/
|
|
7875
8031
|
EnableCloudwatchLogsExports?: LogTypeList;
|
|
7876
8032
|
/**
|
|
7877
|
-
* The number of CPU cores and the number of threads per core for the DB instance class of the DB instance.
|
|
8033
|
+
* The number of CPU cores and the number of threads per core for the DB instance class of the DB instance. This setting doesn't apply to RDS Custom.
|
|
7878
8034
|
*/
|
|
7879
8035
|
ProcessorFeatures?: ProcessorFeatureList;
|
|
7880
8036
|
/**
|
|
7881
|
-
* A value that indicates whether the DB instance class of the DB instance uses its default processor features.
|
|
8037
|
+
* A value that indicates whether the DB instance class of the DB instance uses its default processor features. This setting doesn't apply to RDS Custom.
|
|
7882
8038
|
*/
|
|
7883
8039
|
UseDefaultProcessorFeatures?: BooleanOptional;
|
|
7884
8040
|
/**
|
|
7885
|
-
* The name of the DB parameter group to associate with this DB instance. If you do not specify a value for DBParameterGroupName, then the default DBParameterGroup for the specified DB engine is used. Constraints: If supplied, must match the name of an existing DBParameterGroup. Must be 1 to 255 letters, numbers, or hyphens. First character must be a letter. Can't end with a hyphen or contain two consecutive hyphens.
|
|
8041
|
+
* The name of the DB parameter group to associate with this DB instance. If you do not specify a value for DBParameterGroupName, then the default DBParameterGroup for the specified DB engine is used. This setting doesn't apply to RDS Custom. Constraints: If supplied, must match the name of an existing DBParameterGroup. Must be 1 to 255 letters, numbers, or hyphens. First character must be a letter. Can't end with a hyphen or contain two consecutive hyphens.
|
|
7886
8042
|
*/
|
|
7887
8043
|
DBParameterGroupName?: String;
|
|
7888
8044
|
/**
|
|
@@ -7894,17 +8050,21 @@ declare namespace RDS {
|
|
|
7894
8050
|
*/
|
|
7895
8051
|
SourceDbiResourceId?: String;
|
|
7896
8052
|
/**
|
|
7897
|
-
* The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance. For more information about this setting, including limitations that apply to it, see Managing capacity automatically with Amazon RDS storage autoscaling in the Amazon RDS User Guide.
|
|
8053
|
+
* The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance. For more information about this setting, including limitations that apply to it, see Managing capacity automatically with Amazon RDS storage autoscaling in the Amazon RDS User Guide. This setting doesn't apply to RDS Custom.
|
|
7898
8054
|
*/
|
|
7899
8055
|
MaxAllocatedStorage?: IntegerOptional;
|
|
7900
8056
|
/**
|
|
7901
|
-
* 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.
|
|
8057
|
+
* 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. This setting doesn't apply to RDS Custom.
|
|
7902
8058
|
*/
|
|
7903
8059
|
SourceDBInstanceAutomatedBackupsArn?: String;
|
|
7904
8060
|
/**
|
|
7905
|
-
* A value that indicates whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB instance. A CoIP provides local or external connectivity to resources in your Outpost subnets through your on-premises network. For some use cases, a CoIP can provide lower latency for connections to the DB instance from outside of its virtual private cloud (VPC) on your local network. For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide. For more information about CoIPs, see Customer-owned IP addresses in the Amazon Web Services Outposts User Guide.
|
|
8061
|
+
* A value that indicates whether to enable a customer-owned IP address (CoIP) for an RDS on Outposts DB instance. A CoIP provides local or external connectivity to resources in your Outpost subnets through your on-premises network. For some use cases, a CoIP can provide lower latency for connections to the DB instance from outside of its virtual private cloud (VPC) on your local network. This setting doesn't apply to RDS Custom. For more information about RDS on Outposts, see Working with Amazon RDS on Amazon Web Services Outposts in the Amazon RDS User Guide. For more information about CoIPs, see Customer-owned IP addresses in the Amazon Web Services Outposts User Guide.
|
|
7906
8062
|
*/
|
|
7907
8063
|
EnableCustomerOwnedIp?: BooleanOptional;
|
|
8064
|
+
/**
|
|
8065
|
+
* The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance. The instance profile must meet the following requirements: The profile must exist in your account. The profile must have an IAM role that Amazon EC2 has permissions to assume. The instance profile name and the associated IAM role name must start with the prefix AWSRDSCustom. For the list of permissions required for the IAM role, see Configure IAM and your VPC in the Amazon Relational Database Service User Guide. This setting is required for RDS Custom.
|
|
8066
|
+
*/
|
|
8067
|
+
CustomIamInstanceProfile?: String;
|
|
7908
8068
|
}
|
|
7909
8069
|
export interface RestoreDBInstanceToPointInTimeResult {
|
|
7910
8070
|
DBInstance?: DBInstance;
|
|
@@ -8026,7 +8186,7 @@ declare namespace RDS {
|
|
|
8026
8186
|
*/
|
|
8027
8187
|
SourceRegions?: SourceRegionList;
|
|
8028
8188
|
}
|
|
8029
|
-
export type SourceType = "db-instance"|"db-parameter-group"|"db-security-group"|"db-snapshot"|"db-cluster"|"db-cluster-snapshot"|string;
|
|
8189
|
+
export type SourceType = "db-instance"|"db-parameter-group"|"db-security-group"|"db-snapshot"|"db-cluster"|"db-cluster-snapshot"|"custom-engine-version"|string;
|
|
8030
8190
|
export interface StartActivityStreamRequest {
|
|
8031
8191
|
/**
|
|
8032
8192
|
* The Amazon Resource Name (ARN) of the DB cluster, for example, arn:aws:rds:us-east-1:12345667890:cluster:das-cluster.
|
|
@@ -8037,7 +8197,7 @@ declare namespace RDS {
|
|
|
8037
8197
|
*/
|
|
8038
8198
|
Mode: ActivityStreamMode;
|
|
8039
8199
|
/**
|
|
8040
|
-
* The Amazon Web Services KMS key identifier for encrypting messages in the database activity stream. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the
|
|
8200
|
+
* The Amazon Web Services KMS key identifier for encrypting messages in the database activity stream. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
|
|
8041
8201
|
*/
|
|
8042
8202
|
KmsKeyId: String;
|
|
8043
8203
|
/**
|
|
@@ -8132,7 +8292,7 @@ declare namespace RDS {
|
|
|
8132
8292
|
*/
|
|
8133
8293
|
IamRoleArn: String;
|
|
8134
8294
|
/**
|
|
8135
|
-
* The ID of the Amazon Web Services KMS
|
|
8295
|
+
* The ID of the Amazon Web Services KMS key to use to encrypt the snapshot exported to Amazon S3. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. The caller of this operation must be authorized to execute the following operations. These can be set in the Amazon Web Services KMS key policy: GrantOperation.Encrypt GrantOperation.Decrypt GrantOperation.GenerateDataKey GrantOperation.GenerateDataKeyWithoutPlaintext GrantOperation.ReEncryptFrom GrantOperation.ReEncryptTo GrantOperation.CreateGrant GrantOperation.DescribeKey GrantOperation.RetireGrant
|
|
8136
8296
|
*/
|
|
8137
8297
|
KmsKeyId: String;
|
|
8138
8298
|
/**
|
|
@@ -8156,7 +8316,7 @@ declare namespace RDS {
|
|
|
8156
8316
|
}
|
|
8157
8317
|
export interface StopActivityStreamResponse {
|
|
8158
8318
|
/**
|
|
8159
|
-
* The Amazon Web Services KMS key identifier used for encrypting messages in the database activity stream. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the
|
|
8319
|
+
* The Amazon Web Services KMS key identifier used for encrypting messages in the database activity stream. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
|
|
8160
8320
|
*/
|
|
8161
8321
|
KmsKeyId?: String;
|
|
8162
8322
|
/**
|
|
@@ -8200,6 +8360,7 @@ declare namespace RDS {
|
|
|
8200
8360
|
DBInstance?: DBInstance;
|
|
8201
8361
|
}
|
|
8202
8362
|
export type String = string;
|
|
8363
|
+
export type String255 = string;
|
|
8203
8364
|
export type StringList = String[];
|
|
8204
8365
|
export type StringSensitive = string;
|
|
8205
8366
|
export interface Subnet {
|