cdk-comprehend-s3olap 2.0.41 → 2.0.44
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/.jsii +3 -3
- package/lib/cdk-comprehend-s3olap.js +2 -2
- package/lib/comprehend-lambdas.js +2 -2
- package/lib/iam-roles.js +4 -4
- package/node_modules/aws-sdk/CHANGELOG.md +20 -1
- package/node_modules/aws-sdk/README.md +1 -1
- package/node_modules/aws-sdk/apis/athena-2017-05-18.min.json +117 -6
- package/node_modules/aws-sdk/apis/athena-2017-05-18.paginators.json +5 -0
- package/node_modules/aws-sdk/apis/devops-guru-2020-12-01.min.json +174 -35
- package/node_modules/aws-sdk/apis/devops-guru-2020-12-01.paginators.json +17 -0
- package/node_modules/aws-sdk/apis/docdb-2014-10-31.min.json +11 -0
- package/node_modules/aws-sdk/apis/frauddetector-2019-11-15.min.json +249 -94
- package/node_modules/aws-sdk/apis/iot-2015-05-28.min.json +56 -47
- package/node_modules/aws-sdk/apis/iotsitewise-2019-12-02.min.json +260 -59
- package/node_modules/aws-sdk/apis/iotsitewise-2019-12-02.paginators.json +6 -0
- package/node_modules/aws-sdk/apis/kendra-2019-02-03.min.json +73 -72
- package/node_modules/aws-sdk/apis/monitoring-2010-08-01.min.json +54 -29
- package/node_modules/aws-sdk/apis/network-firewall-2020-11-12.min.json +91 -48
- package/node_modules/aws-sdk/apis/sagemaker-2017-07-24.min.json +0 -3
- package/node_modules/aws-sdk/apis/sagemaker-edge-2020-09-23.min.json +84 -4
- package/node_modules/aws-sdk/clients/acmpca.d.ts +2 -2
- package/node_modules/aws-sdk/clients/athena.d.ts +127 -0
- package/node_modules/aws-sdk/clients/cloudwatch.d.ts +40 -1
- package/node_modules/aws-sdk/clients/devopsguru.d.ts +188 -0
- package/node_modules/aws-sdk/clients/dms.d.ts +2 -2
- package/node_modules/aws-sdk/clients/docdb.d.ts +20 -0
- package/node_modules/aws-sdk/clients/frauddetector.d.ts +176 -5
- package/node_modules/aws-sdk/clients/glue.d.ts +3 -3
- package/node_modules/aws-sdk/clients/iot.d.ts +14 -2
- package/node_modules/aws-sdk/clients/iotsitewise.d.ts +192 -0
- package/node_modules/aws-sdk/clients/kendra.d.ts +12 -7
- package/node_modules/aws-sdk/clients/networkfirewall.d.ts +53 -2
- package/node_modules/aws-sdk/clients/rds.d.ts +87 -87
- package/node_modules/aws-sdk/clients/sagemaker.d.ts +1 -1
- package/node_modules/aws-sdk/clients/sagemakeredge.d.ts +146 -0
- package/node_modules/aws-sdk/dist/aws-sdk-core-react-native.js +1 -1
- package/node_modules/aws-sdk/dist/aws-sdk-react-native.js +15 -15
- package/node_modules/aws-sdk/dist/aws-sdk.js +235 -85
- package/node_modules/aws-sdk/dist/aws-sdk.min.js +93 -93
- package/node_modules/aws-sdk/lib/core.js +1 -1
- package/node_modules/aws-sdk/package.json +1 -1
- package/package.json +5 -5
|
@@ -62,11 +62,11 @@ declare class RDS extends Service {
|
|
|
62
62
|
*/
|
|
63
63
|
authorizeDBSecurityGroupIngress(callback?: (err: AWSError, data: RDS.Types.AuthorizeDBSecurityGroupIngressResult) => void): Request<RDS.Types.AuthorizeDBSecurityGroupIngressResult, AWSError>;
|
|
64
64
|
/**
|
|
65
|
-
* Backtracks a DB cluster to a specific time, without creating a new DB cluster. For more information on backtracking, see Backtracking an Aurora DB Cluster in the Amazon Aurora User Guide. This action only
|
|
65
|
+
* Backtracks a DB cluster to a specific time, without creating a new DB cluster. For more information on backtracking, see Backtracking an Aurora DB Cluster in the Amazon Aurora User Guide. This action applies only to Aurora MySQL DB clusters.
|
|
66
66
|
*/
|
|
67
67
|
backtrackDBCluster(params: RDS.Types.BacktrackDBClusterMessage, callback?: (err: AWSError, data: RDS.Types.DBClusterBacktrack) => void): Request<RDS.Types.DBClusterBacktrack, AWSError>;
|
|
68
68
|
/**
|
|
69
|
-
* Backtracks a DB cluster to a specific time, without creating a new DB cluster. For more information on backtracking, see Backtracking an Aurora DB Cluster in the Amazon Aurora User Guide. This action only
|
|
69
|
+
* Backtracks a DB cluster to a specific time, without creating a new DB cluster. For more information on backtracking, see Backtracking an Aurora DB Cluster in the Amazon Aurora User Guide. This action applies only to Aurora MySQL DB clusters.
|
|
70
70
|
*/
|
|
71
71
|
backtrackDBCluster(callback?: (err: AWSError, data: RDS.Types.DBClusterBacktrack) => void): Request<RDS.Types.DBClusterBacktrack, AWSError>;
|
|
72
72
|
/**
|
|
@@ -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
|
|
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 operation 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. 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 presigned 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 Amazon Aurora 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 DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide. For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.
|
|
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
|
|
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 operation 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. 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 presigned 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 Amazon Aurora 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 DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide. For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.
|
|
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
|
|
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 operation 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
|
|
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 operation 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
|
/**
|
|
@@ -126,27 +126,27 @@ declare class RDS extends Service {
|
|
|
126
126
|
*/
|
|
127
127
|
createCustomDBEngineVersion(callback?: (err: AWSError, data: RDS.Types.DBEngineVersion) => void): Request<RDS.Types.DBEngineVersion, AWSError>;
|
|
128
128
|
/**
|
|
129
|
-
* Creates a new Amazon Aurora DB cluster or Multi-AZ DB cluster. You can use the ReplicationSourceIdentifier parameter to create an Amazon Aurora DB cluster as a read replica of another DB cluster or Amazon RDS MySQL or PostgreSQL DB instance. For
|
|
129
|
+
* Creates a new Amazon Aurora DB cluster or Multi-AZ DB cluster. You can use the ReplicationSourceIdentifier parameter to create an Amazon Aurora DB cluster as a read replica of another DB cluster or Amazon RDS MySQL or PostgreSQL DB instance. For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide. For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.
|
|
130
130
|
*/
|
|
131
131
|
createDBCluster(params: RDS.Types.CreateDBClusterMessage, callback?: (err: AWSError, data: RDS.Types.CreateDBClusterResult) => void): Request<RDS.Types.CreateDBClusterResult, AWSError>;
|
|
132
132
|
/**
|
|
133
|
-
* Creates a new Amazon Aurora DB cluster or Multi-AZ DB cluster. You can use the ReplicationSourceIdentifier parameter to create an Amazon Aurora DB cluster as a read replica of another DB cluster or Amazon RDS MySQL or PostgreSQL DB instance. For
|
|
133
|
+
* Creates a new Amazon Aurora DB cluster or Multi-AZ DB cluster. You can use the ReplicationSourceIdentifier parameter to create an Amazon Aurora DB cluster as a read replica of another DB cluster or Amazon RDS MySQL or PostgreSQL DB instance. For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide. For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.
|
|
134
134
|
*/
|
|
135
135
|
createDBCluster(callback?: (err: AWSError, data: RDS.Types.CreateDBClusterResult) => void): Request<RDS.Types.CreateDBClusterResult, AWSError>;
|
|
136
136
|
/**
|
|
137
|
-
* Creates a new custom endpoint and associates it with an Amazon Aurora DB cluster. This action only
|
|
137
|
+
* Creates a new custom endpoint and associates it with an Amazon Aurora DB cluster. This action applies only to Aurora DB clusters.
|
|
138
138
|
*/
|
|
139
139
|
createDBClusterEndpoint(params: RDS.Types.CreateDBClusterEndpointMessage, callback?: (err: AWSError, data: RDS.Types.DBClusterEndpoint) => void): Request<RDS.Types.DBClusterEndpoint, AWSError>;
|
|
140
140
|
/**
|
|
141
|
-
* Creates a new custom endpoint and associates it with an Amazon Aurora DB cluster. This action only
|
|
141
|
+
* Creates a new custom endpoint and associates it with an Amazon Aurora DB cluster. This action applies only to Aurora DB clusters.
|
|
142
142
|
*/
|
|
143
143
|
createDBClusterEndpoint(callback?: (err: AWSError, data: RDS.Types.DBClusterEndpoint) => void): Request<RDS.Types.DBClusterEndpoint, AWSError>;
|
|
144
144
|
/**
|
|
145
|
-
* Creates a new DB cluster parameter group. Parameters in a DB cluster parameter group apply to all of the instances in a DB cluster. A DB cluster parameter group is initially created with the default parameters for the database engine used by instances in the DB cluster. To provide custom values for any of the parameters, you must modify the group after creating it using ModifyDBClusterParameterGroup. Once you've created a DB cluster parameter group, you need to associate it with your DB cluster using ModifyDBCluster. When you associate a new DB cluster parameter group with a running Aurora DB cluster, reboot the DB instances in the DB cluster without failover for the new DB cluster parameter group and associated settings to take effect. When you associate a new DB cluster parameter group with a running Multi-AZ DB cluster, reboot the DB cluster without failover for the new DB cluster parameter group and associated settings to take effect. After you create a DB cluster parameter group, you should wait at least 5 minutes before creating your first DB cluster that uses that DB cluster parameter group as the default parameter group. This allows Amazon RDS to fully complete the create action before the DB cluster parameter group is used as the default for a new DB cluster. This is especially important for parameters that are critical when creating the default database for a DB cluster, 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 DescribeDBClusterParameters
|
|
145
|
+
* Creates a new DB cluster parameter group. Parameters in a DB cluster parameter group apply to all of the instances in a DB cluster. A DB cluster parameter group is initially created with the default parameters for the database engine used by instances in the DB cluster. To provide custom values for any of the parameters, you must modify the group after creating it using ModifyDBClusterParameterGroup. Once you've created a DB cluster parameter group, you need to associate it with your DB cluster using ModifyDBCluster. When you associate a new DB cluster parameter group with a running Aurora DB cluster, reboot the DB instances in the DB cluster without failover for the new DB cluster parameter group and associated settings to take effect. When you associate a new DB cluster parameter group with a running Multi-AZ DB cluster, reboot the DB cluster without failover for the new DB cluster parameter group and associated settings to take effect. After you create a DB cluster parameter group, you should wait at least 5 minutes before creating your first DB cluster that uses that DB cluster parameter group as the default parameter group. This allows Amazon RDS to fully complete the create action before the DB cluster parameter group is used as the default for a new DB cluster. This is especially important for parameters that are critical when creating the default database for a DB cluster, 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 DescribeDBClusterParameters operation to verify that your DB cluster parameter group has been created or modified. For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide. For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.
|
|
146
146
|
*/
|
|
147
147
|
createDBClusterParameterGroup(params: RDS.Types.CreateDBClusterParameterGroupMessage, callback?: (err: AWSError, data: RDS.Types.CreateDBClusterParameterGroupResult) => void): Request<RDS.Types.CreateDBClusterParameterGroupResult, AWSError>;
|
|
148
148
|
/**
|
|
149
|
-
* Creates a new DB cluster parameter group. Parameters in a DB cluster parameter group apply to all of the instances in a DB cluster. A DB cluster parameter group is initially created with the default parameters for the database engine used by instances in the DB cluster. To provide custom values for any of the parameters, you must modify the group after creating it using ModifyDBClusterParameterGroup. Once you've created a DB cluster parameter group, you need to associate it with your DB cluster using ModifyDBCluster. When you associate a new DB cluster parameter group with a running Aurora DB cluster, reboot the DB instances in the DB cluster without failover for the new DB cluster parameter group and associated settings to take effect. When you associate a new DB cluster parameter group with a running Multi-AZ DB cluster, reboot the DB cluster without failover for the new DB cluster parameter group and associated settings to take effect. After you create a DB cluster parameter group, you should wait at least 5 minutes before creating your first DB cluster that uses that DB cluster parameter group as the default parameter group. This allows Amazon RDS to fully complete the create action before the DB cluster parameter group is used as the default for a new DB cluster. This is especially important for parameters that are critical when creating the default database for a DB cluster, 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 DescribeDBClusterParameters
|
|
149
|
+
* Creates a new DB cluster parameter group. Parameters in a DB cluster parameter group apply to all of the instances in a DB cluster. A DB cluster parameter group is initially created with the default parameters for the database engine used by instances in the DB cluster. To provide custom values for any of the parameters, you must modify the group after creating it using ModifyDBClusterParameterGroup. Once you've created a DB cluster parameter group, you need to associate it with your DB cluster using ModifyDBCluster. When you associate a new DB cluster parameter group with a running Aurora DB cluster, reboot the DB instances in the DB cluster without failover for the new DB cluster parameter group and associated settings to take effect. When you associate a new DB cluster parameter group with a running Multi-AZ DB cluster, reboot the DB cluster without failover for the new DB cluster parameter group and associated settings to take effect. After you create a DB cluster parameter group, you should wait at least 5 minutes before creating your first DB cluster that uses that DB cluster parameter group as the default parameter group. This allows Amazon RDS to fully complete the create action before the DB cluster parameter group is used as the default for a new DB cluster. This is especially important for parameters that are critical when creating the default database for a DB cluster, 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 DescribeDBClusterParameters operation to verify that your DB cluster parameter group has been created or modified. For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide. For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.
|
|
150
150
|
*/
|
|
151
151
|
createDBClusterParameterGroup(callback?: (err: AWSError, data: RDS.Types.CreateDBClusterParameterGroupResult) => void): Request<RDS.Types.CreateDBClusterParameterGroupResult, AWSError>;
|
|
152
152
|
/**
|
|
@@ -158,19 +158,19 @@ declare class RDS extends Service {
|
|
|
158
158
|
*/
|
|
159
159
|
createDBClusterSnapshot(callback?: (err: AWSError, data: RDS.Types.CreateDBClusterSnapshotResult) => void): Request<RDS.Types.CreateDBClusterSnapshotResult, AWSError>;
|
|
160
160
|
/**
|
|
161
|
-
* Creates a new DB instance.
|
|
161
|
+
* Creates a new DB instance. The new DB instance can be an RDS DB instance, or it can be a DB instance in an Aurora DB cluster. For an Aurora DB cluster, you can call this operation multiple times to add more than one DB instance to the cluster. For more information about creating an RDS DB instance, see Creating an Amazon RDS DB instance in the Amazon RDS User Guide. For more information about creating a DB instance in an Aurora DB cluster, see Creating an Amazon Aurora DB cluster in the Amazon Aurora User Guide.
|
|
162
162
|
*/
|
|
163
163
|
createDBInstance(params: RDS.Types.CreateDBInstanceMessage, callback?: (err: AWSError, data: RDS.Types.CreateDBInstanceResult) => void): Request<RDS.Types.CreateDBInstanceResult, AWSError>;
|
|
164
164
|
/**
|
|
165
|
-
* Creates a new DB instance.
|
|
165
|
+
* Creates a new DB instance. The new DB instance can be an RDS DB instance, or it can be a DB instance in an Aurora DB cluster. For an Aurora DB cluster, you can call this operation multiple times to add more than one DB instance to the cluster. For more information about creating an RDS DB instance, see Creating an Amazon RDS DB instance in the Amazon RDS User Guide. For more information about creating a DB instance in an Aurora DB cluster, see Creating an Amazon Aurora DB cluster in the Amazon Aurora User Guide.
|
|
166
166
|
*/
|
|
167
167
|
createDBInstance(callback?: (err: AWSError, data: RDS.Types.CreateDBInstanceResult) => void): Request<RDS.Types.CreateDBInstanceResult, AWSError>;
|
|
168
168
|
/**
|
|
169
|
-
* Creates a new DB instance that acts as a read replica for an existing source DB instance. You can create a read replica for a DB instance running MySQL, MariaDB, Oracle, PostgreSQL, or SQL Server. For more information, see Working with Read Replicas in the Amazon RDS User Guide. Amazon Aurora doesn't support this
|
|
169
|
+
* Creates a new DB instance that acts as a read replica for an existing source DB instance. You can create a read replica for a DB instance running MySQL, MariaDB, Oracle, PostgreSQL, or SQL Server. For more information, see Working with Read Replicas in the Amazon RDS User Guide. Amazon Aurora doesn't support this operation. Call the CreateDBInstance operation to create a DB instance for an Aurora DB cluster. All read replica DB instances are created with backups disabled. All other DB instance attributes (including DB security groups and DB parameter groups) are inherited from the source DB instance, except as specified. Your source DB instance must have backup retention enabled.
|
|
170
170
|
*/
|
|
171
171
|
createDBInstanceReadReplica(params: RDS.Types.CreateDBInstanceReadReplicaMessage, callback?: (err: AWSError, data: RDS.Types.CreateDBInstanceReadReplicaResult) => void): Request<RDS.Types.CreateDBInstanceReadReplicaResult, AWSError>;
|
|
172
172
|
/**
|
|
173
|
-
* Creates a new DB instance that acts as a read replica for an existing source DB instance. You can create a read replica for a DB instance running MySQL, MariaDB, Oracle, PostgreSQL, or SQL Server. For more information, see Working with Read Replicas in the Amazon RDS User Guide. Amazon Aurora doesn't support this
|
|
173
|
+
* Creates a new DB instance that acts as a read replica for an existing source DB instance. You can create a read replica for a DB instance running MySQL, MariaDB, Oracle, PostgreSQL, or SQL Server. For more information, see Working with Read Replicas in the Amazon RDS User Guide. Amazon Aurora doesn't support this operation. Call the CreateDBInstance operation to create a DB instance for an Aurora DB cluster. All read replica DB instances are created with backups disabled. All other DB instance attributes (including DB security groups and DB parameter groups) are inherited from the source DB instance, except as specified. Your source DB instance must have backup retention enabled.
|
|
174
174
|
*/
|
|
175
175
|
createDBInstanceReadReplica(callback?: (err: AWSError, data: RDS.Types.CreateDBInstanceReadReplicaResult) => void): Request<RDS.Types.CreateDBInstanceReadReplicaResult, AWSError>;
|
|
176
176
|
/**
|
|
@@ -222,19 +222,19 @@ declare class RDS extends Service {
|
|
|
222
222
|
*/
|
|
223
223
|
createDBSubnetGroup(callback?: (err: AWSError, data: RDS.Types.CreateDBSubnetGroupResult) => void): Request<RDS.Types.CreateDBSubnetGroupResult, AWSError>;
|
|
224
224
|
/**
|
|
225
|
-
* Creates an RDS event notification subscription. This
|
|
225
|
+
* Creates an RDS event notification subscription. This operation requires a topic Amazon Resource Name (ARN) created by either the RDS console, the SNS console, or the SNS API. To obtain an ARN with SNS, you must create a topic in Amazon SNS and subscribe to the topic. The ARN is displayed in the SNS console. You can specify the type of source (SourceType) that you want to be notified of and provide a list of RDS sources (SourceIds) that triggers the events. You can also provide a list of event categories (EventCategories) for events that you want to be notified of. For example, you can specify SourceType = db-instance, SourceIds = mydbinstance1, mydbinstance2 and EventCategories = Availability, Backup. If you specify both the SourceType and SourceIds, such as SourceType = db-instance and SourceIds = myDBInstance1, you are notified of all the db-instance events for the specified source. If you specify a SourceType but do not specify SourceIds, you receive notice of the events for that source type for all your RDS sources. If you don't specify either the SourceType or the SourceIds, you are notified of events generated from all RDS sources belonging to your customer account. RDS event notification is only available for unencrypted SNS topics. If you specify an encrypted SNS topic, event notifications aren't sent for the topic.
|
|
226
226
|
*/
|
|
227
227
|
createEventSubscription(params: RDS.Types.CreateEventSubscriptionMessage, callback?: (err: AWSError, data: RDS.Types.CreateEventSubscriptionResult) => void): Request<RDS.Types.CreateEventSubscriptionResult, AWSError>;
|
|
228
228
|
/**
|
|
229
|
-
* Creates an RDS event notification subscription. This
|
|
229
|
+
* Creates an RDS event notification subscription. This operation requires a topic Amazon Resource Name (ARN) created by either the RDS console, the SNS console, or the SNS API. To obtain an ARN with SNS, you must create a topic in Amazon SNS and subscribe to the topic. The ARN is displayed in the SNS console. You can specify the type of source (SourceType) that you want to be notified of and provide a list of RDS sources (SourceIds) that triggers the events. You can also provide a list of event categories (EventCategories) for events that you want to be notified of. For example, you can specify SourceType = db-instance, SourceIds = mydbinstance1, mydbinstance2 and EventCategories = Availability, Backup. If you specify both the SourceType and SourceIds, such as SourceType = db-instance and SourceIds = myDBInstance1, you are notified of all the db-instance events for the specified source. If you specify a SourceType but do not specify SourceIds, you receive notice of the events for that source type for all your RDS sources. If you don't specify either the SourceType or the SourceIds, you are notified of events generated from all RDS sources belonging to your customer account. RDS event notification is only available for unencrypted SNS topics. If you specify an encrypted SNS topic, event notifications aren't sent for the topic.
|
|
230
230
|
*/
|
|
231
231
|
createEventSubscription(callback?: (err: AWSError, data: RDS.Types.CreateEventSubscriptionResult) => void): Request<RDS.Types.CreateEventSubscriptionResult, AWSError>;
|
|
232
232
|
/**
|
|
233
|
-
* Creates an Aurora global database spread across multiple Amazon Web Services Regions. The global database contains a single primary cluster with read-write capability, and a read-only secondary cluster that receives data from the primary cluster through high-speed replication performed by the Aurora storage subsystem. You can create a global database that is initially empty, and then add a primary cluster and a secondary cluster to it. Or you can specify an existing Aurora cluster during the create operation, and this cluster becomes the primary cluster of the global database. This action only
|
|
233
|
+
* Creates an Aurora global database spread across multiple Amazon Web Services Regions. The global database contains a single primary cluster with read-write capability, and a read-only secondary cluster that receives data from the primary cluster through high-speed replication performed by the Aurora storage subsystem. You can create a global database that is initially empty, and then add a primary cluster and a secondary cluster to it. Or you can specify an existing Aurora cluster during the create operation, and this cluster becomes the primary cluster of the global database. This action applies only to Aurora DB clusters.
|
|
234
234
|
*/
|
|
235
235
|
createGlobalCluster(params: RDS.Types.CreateGlobalClusterMessage, callback?: (err: AWSError, data: RDS.Types.CreateGlobalClusterResult) => void): Request<RDS.Types.CreateGlobalClusterResult, AWSError>;
|
|
236
236
|
/**
|
|
237
|
-
* Creates an Aurora global database spread across multiple Amazon Web Services Regions. The global database contains a single primary cluster with read-write capability, and a read-only secondary cluster that receives data from the primary cluster through high-speed replication performed by the Aurora storage subsystem. You can create a global database that is initially empty, and then add a primary cluster and a secondary cluster to it. Or you can specify an existing Aurora cluster during the create operation, and this cluster becomes the primary cluster of the global database. This action only
|
|
237
|
+
* Creates an Aurora global database spread across multiple Amazon Web Services Regions. The global database contains a single primary cluster with read-write capability, and a read-only secondary cluster that receives data from the primary cluster through high-speed replication performed by the Aurora storage subsystem. You can create a global database that is initially empty, and then add a primary cluster and a secondary cluster to it. Or you can specify an existing Aurora cluster during the create operation, and this cluster becomes the primary cluster of the global database. This action applies only to Aurora DB clusters.
|
|
238
238
|
*/
|
|
239
239
|
createGlobalCluster(callback?: (err: AWSError, data: RDS.Types.CreateGlobalClusterResult) => void): Request<RDS.Types.CreateGlobalClusterResult, AWSError>;
|
|
240
240
|
/**
|
|
@@ -598,11 +598,11 @@ declare class RDS extends Service {
|
|
|
598
598
|
*/
|
|
599
599
|
describeEventSubscriptions(callback?: (err: AWSError, data: RDS.Types.EventSubscriptionsMessage) => void): Request<RDS.Types.EventSubscriptionsMessage, AWSError>;
|
|
600
600
|
/**
|
|
601
|
-
* Returns events related to DB instances, DB clusters, DB parameter groups, DB security groups, DB snapshots, DB cluster snapshots, and RDS Proxies for the past 14 days. Events specific to a particular DB instance, DB cluster, DB parameter group, DB security group, DB snapshot, DB cluster snapshot group, or RDS Proxy can be obtained by providing the name as a parameter. By default, RDS returns events that were generated in the past hour.
|
|
601
|
+
* Returns events related to DB instances, DB clusters, DB parameter groups, DB security groups, DB snapshots, DB cluster snapshots, and RDS Proxies for the past 14 days. Events specific to a particular DB instance, DB cluster, DB parameter group, DB security group, DB snapshot, DB cluster snapshot group, or RDS Proxy can be obtained by providing the name as a parameter. For more information on working with events, see Monitoring Amazon RDS events in the Amazon RDS User Guide and Monitoring Amazon Aurora events in the Amazon Aurora User Guide. By default, RDS returns events that were generated in the past hour.
|
|
602
602
|
*/
|
|
603
603
|
describeEvents(params: RDS.Types.DescribeEventsMessage, callback?: (err: AWSError, data: RDS.Types.EventsMessage) => void): Request<RDS.Types.EventsMessage, AWSError>;
|
|
604
604
|
/**
|
|
605
|
-
* Returns events related to DB instances, DB clusters, DB parameter groups, DB security groups, DB snapshots, DB cluster snapshots, and RDS Proxies for the past 14 days. Events specific to a particular DB instance, DB cluster, DB parameter group, DB security group, DB snapshot, DB cluster snapshot group, or RDS Proxy can be obtained by providing the name as a parameter. By default, RDS returns events that were generated in the past hour.
|
|
605
|
+
* Returns events related to DB instances, DB clusters, DB parameter groups, DB security groups, DB snapshots, DB cluster snapshots, and RDS Proxies for the past 14 days. Events specific to a particular DB instance, DB cluster, DB parameter group, DB security group, DB snapshot, DB cluster snapshot group, or RDS Proxy can be obtained by providing the name as a parameter. For more information on working with events, see Monitoring Amazon RDS events in the Amazon RDS User Guide and Monitoring Amazon Aurora events in the Amazon Aurora User Guide. By default, RDS returns events that were generated in the past hour.
|
|
606
606
|
*/
|
|
607
607
|
describeEvents(callback?: (err: AWSError, data: RDS.Types.EventsMessage) => void): Request<RDS.Types.EventsMessage, AWSError>;
|
|
608
608
|
/**
|
|
@@ -694,11 +694,11 @@ declare class RDS extends Service {
|
|
|
694
694
|
*/
|
|
695
695
|
downloadDBLogFilePortion(callback?: (err: AWSError, data: RDS.Types.DownloadDBLogFilePortionDetails) => void): Request<RDS.Types.DownloadDBLogFilePortionDetails, AWSError>;
|
|
696
696
|
/**
|
|
697
|
-
* Forces a failover for a DB cluster. For an Aurora DB cluster, failover for a DB cluster promotes one of the Aurora Replicas (read-only instances) in the DB cluster to be the primary DB instance (the cluster writer). For a Multi-AZ DB cluster, failover for a DB cluster promotes one of the readable standby DB instances (read-only instances) in the DB cluster to be the primary DB instance (the cluster writer). An Amazon Aurora DB cluster automatically fails over to an Aurora Replica, if one exists, when the primary DB instance fails. A Multi-AZ DB cluster automatically fails over to a
|
|
697
|
+
* Forces a failover for a DB cluster. For an Aurora DB cluster, failover for a DB cluster promotes one of the Aurora Replicas (read-only instances) in the DB cluster to be the primary DB instance (the cluster writer). For a Multi-AZ DB cluster, failover for a DB cluster promotes one of the readable standby DB instances (read-only instances) in the DB cluster to be the primary DB instance (the cluster writer). An Amazon Aurora DB cluster automatically fails over to an Aurora Replica, if one exists, when the primary DB instance fails. A Multi-AZ DB cluster automatically fails over to a readable standby DB instance when the primary DB instance fails. To simulate a failure of a primary instance for testing, you can force a failover. Because each instance in a DB cluster has its own endpoint address, make sure to clean up and re-establish any existing connections that use those endpoint addresses when the failover is complete. For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide. For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.
|
|
698
698
|
*/
|
|
699
699
|
failoverDBCluster(params: RDS.Types.FailoverDBClusterMessage, callback?: (err: AWSError, data: RDS.Types.FailoverDBClusterResult) => void): Request<RDS.Types.FailoverDBClusterResult, AWSError>;
|
|
700
700
|
/**
|
|
701
|
-
* Forces a failover for a DB cluster. For an Aurora DB cluster, failover for a DB cluster promotes one of the Aurora Replicas (read-only instances) in the DB cluster to be the primary DB instance (the cluster writer). For a Multi-AZ DB cluster, failover for a DB cluster promotes one of the readable standby DB instances (read-only instances) in the DB cluster to be the primary DB instance (the cluster writer). An Amazon Aurora DB cluster automatically fails over to an Aurora Replica, if one exists, when the primary DB instance fails. A Multi-AZ DB cluster automatically fails over to a
|
|
701
|
+
* Forces a failover for a DB cluster. For an Aurora DB cluster, failover for a DB cluster promotes one of the Aurora Replicas (read-only instances) in the DB cluster to be the primary DB instance (the cluster writer). For a Multi-AZ DB cluster, failover for a DB cluster promotes one of the readable standby DB instances (read-only instances) in the DB cluster to be the primary DB instance (the cluster writer). An Amazon Aurora DB cluster automatically fails over to an Aurora Replica, if one exists, when the primary DB instance fails. A Multi-AZ DB cluster automatically fails over to a readable standby DB instance when the primary DB instance fails. To simulate a failure of a primary instance for testing, you can force a failover. Because each instance in a DB cluster has its own endpoint address, make sure to clean up and re-establish any existing connections that use those endpoint addresses when the failover is complete. For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide. For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.
|
|
702
702
|
*/
|
|
703
703
|
failoverDBCluster(callback?: (err: AWSError, data: RDS.Types.FailoverDBClusterResult) => void): Request<RDS.Types.FailoverDBClusterResult, AWSError>;
|
|
704
704
|
/**
|
|
@@ -758,19 +758,19 @@ declare class RDS extends Service {
|
|
|
758
758
|
*/
|
|
759
759
|
modifyDBClusterEndpoint(callback?: (err: AWSError, data: RDS.Types.DBClusterEndpoint) => void): Request<RDS.Types.DBClusterEndpoint, AWSError>;
|
|
760
760
|
/**
|
|
761
|
-
* Modifies the parameters of a DB cluster parameter group. To modify more than one parameter, submit a list of the following: ParameterName, ParameterValue, and ApplyMethod. A maximum of 20 parameters can be modified in a single request. After you create a DB cluster parameter group, you should wait at least 5 minutes before creating your first DB cluster that uses that DB cluster 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 cluster. This is especially important for parameters that are critical when creating the default database for a DB cluster, 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 DescribeDBClusterParameters
|
|
761
|
+
* Modifies the parameters of a DB cluster parameter group. To modify more than one parameter, submit a list of the following: ParameterName, ParameterValue, and ApplyMethod. A maximum of 20 parameters can be modified in a single request. After you create a DB cluster parameter group, you should wait at least 5 minutes before creating your first DB cluster that uses that DB cluster 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 cluster. This is especially important for parameters that are critical when creating the default database for a DB cluster, 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 DescribeDBClusterParameters operation to verify that your DB cluster parameter group has been created or modified. If the modified DB cluster parameter group is used by an Aurora Serverless v1 cluster, Aurora applies the update immediately. The cluster restart might interrupt your workload. In that case, your application must reopen any connections and retry any transactions that were active when the parameter changes took effect. For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide. For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.
|
|
762
762
|
*/
|
|
763
763
|
modifyDBClusterParameterGroup(params: RDS.Types.ModifyDBClusterParameterGroupMessage, callback?: (err: AWSError, data: RDS.Types.DBClusterParameterGroupNameMessage) => void): Request<RDS.Types.DBClusterParameterGroupNameMessage, AWSError>;
|
|
764
764
|
/**
|
|
765
|
-
* Modifies the parameters of a DB cluster parameter group. To modify more than one parameter, submit a list of the following: ParameterName, ParameterValue, and ApplyMethod. A maximum of 20 parameters can be modified in a single request. After you create a DB cluster parameter group, you should wait at least 5 minutes before creating your first DB cluster that uses that DB cluster 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 cluster. This is especially important for parameters that are critical when creating the default database for a DB cluster, 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 DescribeDBClusterParameters
|
|
765
|
+
* Modifies the parameters of a DB cluster parameter group. To modify more than one parameter, submit a list of the following: ParameterName, ParameterValue, and ApplyMethod. A maximum of 20 parameters can be modified in a single request. After you create a DB cluster parameter group, you should wait at least 5 minutes before creating your first DB cluster that uses that DB cluster 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 cluster. This is especially important for parameters that are critical when creating the default database for a DB cluster, 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 DescribeDBClusterParameters operation to verify that your DB cluster parameter group has been created or modified. If the modified DB cluster parameter group is used by an Aurora Serverless v1 cluster, Aurora applies the update immediately. The cluster restart might interrupt your workload. In that case, your application must reopen any connections and retry any transactions that were active when the parameter changes took effect. For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide. For more information on Multi-AZ DB clusters, see Multi-AZ deployments with two readable standby DB instances in the Amazon RDS User Guide.
|
|
766
766
|
*/
|
|
767
767
|
modifyDBClusterParameterGroup(callback?: (err: AWSError, data: RDS.Types.DBClusterParameterGroupNameMessage) => void): Request<RDS.Types.DBClusterParameterGroupNameMessage, AWSError>;
|
|
768
768
|
/**
|
|
769
|
-
* Adds an attribute and values to, or removes an attribute and values from, a manual DB cluster snapshot. To share a manual DB cluster snapshot with other Amazon Web Services accounts, specify restore as the AttributeName and use the ValuesToAdd parameter to add a list of IDs of the Amazon Web Services accounts that are authorized to restore the manual DB cluster snapshot. Use the value all to make the manual DB cluster snapshot public, which means that it can be copied or restored by all Amazon Web Services accounts. Don't add the all value for any manual DB cluster snapshots that contain private information that you don't want available to all Amazon Web Services accounts. If a manual DB cluster snapshot is encrypted, it can be shared, but only by specifying a list of authorized Amazon Web Services account IDs for the ValuesToAdd parameter. You can't use all as a value for that parameter in this case. To view which Amazon Web Services accounts have access to copy or restore a manual DB cluster snapshot, or whether a manual DB cluster snapshot is public or private, use the DescribeDBClusterSnapshotAttributes API
|
|
769
|
+
* Adds an attribute and values to, or removes an attribute and values from, a manual DB cluster snapshot. To share a manual DB cluster snapshot with other Amazon Web Services accounts, specify restore as the AttributeName and use the ValuesToAdd parameter to add a list of IDs of the Amazon Web Services accounts that are authorized to restore the manual DB cluster snapshot. Use the value all to make the manual DB cluster snapshot public, which means that it can be copied or restored by all Amazon Web Services accounts. Don't add the all value for any manual DB cluster snapshots that contain private information that you don't want available to all Amazon Web Services accounts. If a manual DB cluster snapshot is encrypted, it can be shared, but only by specifying a list of authorized Amazon Web Services account IDs for the ValuesToAdd parameter. You can't use all as a value for that parameter in this case. To view which Amazon Web Services accounts have access to copy or restore a manual DB cluster snapshot, or whether a manual DB cluster snapshot is public or private, use the DescribeDBClusterSnapshotAttributes API operation. The accounts are returned as values for the restore attribute.
|
|
770
770
|
*/
|
|
771
771
|
modifyDBClusterSnapshotAttribute(params: RDS.Types.ModifyDBClusterSnapshotAttributeMessage, callback?: (err: AWSError, data: RDS.Types.ModifyDBClusterSnapshotAttributeResult) => void): Request<RDS.Types.ModifyDBClusterSnapshotAttributeResult, AWSError>;
|
|
772
772
|
/**
|
|
773
|
-
* Adds an attribute and values to, or removes an attribute and values from, a manual DB cluster snapshot. To share a manual DB cluster snapshot with other Amazon Web Services accounts, specify restore as the AttributeName and use the ValuesToAdd parameter to add a list of IDs of the Amazon Web Services accounts that are authorized to restore the manual DB cluster snapshot. Use the value all to make the manual DB cluster snapshot public, which means that it can be copied or restored by all Amazon Web Services accounts. Don't add the all value for any manual DB cluster snapshots that contain private information that you don't want available to all Amazon Web Services accounts. If a manual DB cluster snapshot is encrypted, it can be shared, but only by specifying a list of authorized Amazon Web Services account IDs for the ValuesToAdd parameter. You can't use all as a value for that parameter in this case. To view which Amazon Web Services accounts have access to copy or restore a manual DB cluster snapshot, or whether a manual DB cluster snapshot is public or private, use the DescribeDBClusterSnapshotAttributes API
|
|
773
|
+
* Adds an attribute and values to, or removes an attribute and values from, a manual DB cluster snapshot. To share a manual DB cluster snapshot with other Amazon Web Services accounts, specify restore as the AttributeName and use the ValuesToAdd parameter to add a list of IDs of the Amazon Web Services accounts that are authorized to restore the manual DB cluster snapshot. Use the value all to make the manual DB cluster snapshot public, which means that it can be copied or restored by all Amazon Web Services accounts. Don't add the all value for any manual DB cluster snapshots that contain private information that you don't want available to all Amazon Web Services accounts. If a manual DB cluster snapshot is encrypted, it can be shared, but only by specifying a list of authorized Amazon Web Services account IDs for the ValuesToAdd parameter. You can't use all as a value for that parameter in this case. To view which Amazon Web Services accounts have access to copy or restore a manual DB cluster snapshot, or whether a manual DB cluster snapshot is public or private, use the DescribeDBClusterSnapshotAttributes API operation. The accounts are returned as values for the restore attribute.
|
|
774
774
|
*/
|
|
775
775
|
modifyDBClusterSnapshotAttribute(callback?: (err: AWSError, data: RDS.Types.ModifyDBClusterSnapshotAttributeResult) => void): Request<RDS.Types.ModifyDBClusterSnapshotAttributeResult, AWSError>;
|
|
776
776
|
/**
|
|
@@ -822,11 +822,11 @@ declare class RDS extends Service {
|
|
|
822
822
|
*/
|
|
823
823
|
modifyDBSnapshot(callback?: (err: AWSError, data: RDS.Types.ModifyDBSnapshotResult) => void): Request<RDS.Types.ModifyDBSnapshotResult, AWSError>;
|
|
824
824
|
/**
|
|
825
|
-
* Adds an attribute and values to, or removes an attribute and values from, a manual DB snapshot. To share a manual DB snapshot with other Amazon Web Services accounts, specify restore as the AttributeName and use the ValuesToAdd parameter to add a list of IDs of the Amazon Web Services accounts that are authorized to restore the manual DB snapshot. Uses the value all to make the manual DB snapshot public, which means it can be copied or restored by all Amazon Web Services accounts. Don't add the all value for any manual DB snapshots that contain private information that you don't want available to all Amazon Web Services accounts. If the manual DB snapshot is encrypted, it can be shared, but only by specifying a list of authorized Amazon Web Services account IDs for the ValuesToAdd parameter. You can't use all as a value for that parameter in this case. To view which Amazon Web Services accounts have access to copy or restore a manual DB snapshot, or whether a manual DB snapshot public or private, use the DescribeDBSnapshotAttributes API
|
|
825
|
+
* Adds an attribute and values to, or removes an attribute and values from, a manual DB snapshot. To share a manual DB snapshot with other Amazon Web Services accounts, specify restore as the AttributeName and use the ValuesToAdd parameter to add a list of IDs of the Amazon Web Services accounts that are authorized to restore the manual DB snapshot. Uses the value all to make the manual DB snapshot public, which means it can be copied or restored by all Amazon Web Services accounts. Don't add the all value for any manual DB snapshots that contain private information that you don't want available to all Amazon Web Services accounts. If the manual DB snapshot is encrypted, it can be shared, but only by specifying a list of authorized Amazon Web Services account IDs for the ValuesToAdd parameter. You can't use all as a value for that parameter in this case. To view which Amazon Web Services accounts have access to copy or restore a manual DB snapshot, or whether a manual DB snapshot public or private, use the DescribeDBSnapshotAttributes API operation. The accounts are returned as values for the restore attribute.
|
|
826
826
|
*/
|
|
827
827
|
modifyDBSnapshotAttribute(params: RDS.Types.ModifyDBSnapshotAttributeMessage, callback?: (err: AWSError, data: RDS.Types.ModifyDBSnapshotAttributeResult) => void): Request<RDS.Types.ModifyDBSnapshotAttributeResult, AWSError>;
|
|
828
828
|
/**
|
|
829
|
-
* Adds an attribute and values to, or removes an attribute and values from, a manual DB snapshot. To share a manual DB snapshot with other Amazon Web Services accounts, specify restore as the AttributeName and use the ValuesToAdd parameter to add a list of IDs of the Amazon Web Services accounts that are authorized to restore the manual DB snapshot. Uses the value all to make the manual DB snapshot public, which means it can be copied or restored by all Amazon Web Services accounts. Don't add the all value for any manual DB snapshots that contain private information that you don't want available to all Amazon Web Services accounts. If the manual DB snapshot is encrypted, it can be shared, but only by specifying a list of authorized Amazon Web Services account IDs for the ValuesToAdd parameter. You can't use all as a value for that parameter in this case. To view which Amazon Web Services accounts have access to copy or restore a manual DB snapshot, or whether a manual DB snapshot public or private, use the DescribeDBSnapshotAttributes API
|
|
829
|
+
* Adds an attribute and values to, or removes an attribute and values from, a manual DB snapshot. To share a manual DB snapshot with other Amazon Web Services accounts, specify restore as the AttributeName and use the ValuesToAdd parameter to add a list of IDs of the Amazon Web Services accounts that are authorized to restore the manual DB snapshot. Uses the value all to make the manual DB snapshot public, which means it can be copied or restored by all Amazon Web Services accounts. Don't add the all value for any manual DB snapshots that contain private information that you don't want available to all Amazon Web Services accounts. If the manual DB snapshot is encrypted, it can be shared, but only by specifying a list of authorized Amazon Web Services account IDs for the ValuesToAdd parameter. You can't use all as a value for that parameter in this case. To view which Amazon Web Services accounts have access to copy or restore a manual DB snapshot, or whether a manual DB snapshot public or private, use the DescribeDBSnapshotAttributes API operation. The accounts are returned as values for the restore attribute.
|
|
830
830
|
*/
|
|
831
831
|
modifyDBSnapshotAttribute(callback?: (err: AWSError, data: RDS.Types.ModifyDBSnapshotAttributeResult) => void): Request<RDS.Types.ModifyDBSnapshotAttributeResult, AWSError>;
|
|
832
832
|
/**
|
|
@@ -894,11 +894,11 @@ declare class RDS extends Service {
|
|
|
894
894
|
*/
|
|
895
895
|
rebootDBCluster(callback?: (err: AWSError, data: RDS.Types.RebootDBClusterResult) => void): Request<RDS.Types.RebootDBClusterResult, AWSError>;
|
|
896
896
|
/**
|
|
897
|
-
* 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.
|
|
897
|
+
* 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. If your DB instance is part of a Multi-AZ DB cluster, you can reboot the DB cluster with the RebootDBCluster operation.
|
|
898
898
|
*/
|
|
899
899
|
rebootDBInstance(params: RDS.Types.RebootDBInstanceMessage, callback?: (err: AWSError, data: RDS.Types.RebootDBInstanceResult) => void): Request<RDS.Types.RebootDBInstanceResult, AWSError>;
|
|
900
900
|
/**
|
|
901
|
-
* 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.
|
|
901
|
+
* 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. If your DB instance is part of a Multi-AZ DB cluster, you can reboot the DB cluster with the RebootDBCluster operation.
|
|
902
902
|
*/
|
|
903
903
|
rebootDBInstance(callback?: (err: AWSError, data: RDS.Types.RebootDBInstanceResult) => void): Request<RDS.Types.RebootDBInstanceResult, AWSError>;
|
|
904
904
|
/**
|
|
@@ -1086,11 +1086,11 @@ declare class RDS extends Service {
|
|
|
1086
1086
|
*/
|
|
1087
1087
|
stopDBInstance(callback?: (err: AWSError, data: RDS.Types.StopDBInstanceResult) => void): Request<RDS.Types.StopDBInstanceResult, AWSError>;
|
|
1088
1088
|
/**
|
|
1089
|
-
* 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.
|
|
1089
|
+
* Stops automated backup replication for a DB instance. This command doesn't apply to RDS Custom, Aurora MySQL, and Aurora PostgreSQL. For more information, see Replicating Automated Backups to Another Amazon Web Services Region in the Amazon RDS User Guide.
|
|
1090
1090
|
*/
|
|
1091
1091
|
stopDBInstanceAutomatedBackupsReplication(params: RDS.Types.StopDBInstanceAutomatedBackupsReplicationMessage, callback?: (err: AWSError, data: RDS.Types.StopDBInstanceAutomatedBackupsReplicationResult) => void): Request<RDS.Types.StopDBInstanceAutomatedBackupsReplicationResult, AWSError>;
|
|
1092
1092
|
/**
|
|
1093
|
-
* 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.
|
|
1093
|
+
* Stops automated backup replication for a DB instance. This command doesn't apply to RDS Custom, Aurora MySQL, and Aurora PostgreSQL. For more information, see Replicating Automated Backups to Another Amazon Web Services Region in the Amazon RDS User Guide.
|
|
1094
1094
|
*/
|
|
1095
1095
|
stopDBInstanceAutomatedBackupsReplication(callback?: (err: AWSError, data: RDS.Types.StopDBInstanceAutomatedBackupsReplicationResult) => void): Request<RDS.Types.StopDBInstanceAutomatedBackupsReplicationResult, AWSError>;
|
|
1096
1096
|
/**
|
|
@@ -1494,7 +1494,7 @@ declare namespace RDS {
|
|
|
1494
1494
|
*/
|
|
1495
1495
|
KmsKeyId?: String;
|
|
1496
1496
|
/**
|
|
1497
|
-
*
|
|
1497
|
+
* When you are copying a DB cluster snapshot from one Amazon Web Services GovCloud (US) Region to another, the URL that contains a Signature Version 4 signed request for the CopyDBClusterSnapshot API operation in the Amazon Web Services Region that contains the source DB cluster snapshot to copy. Use the PreSignedUrl parameter when copying an encrypted DB cluster snapshot from another Amazon Web Services Region. Don't specify PreSignedUrl when copying an encrypted DB cluster snapshot in the same Amazon Web Services Region. This setting applies only to Amazon Web Services GovCloud (US) Regions. It's ignored in other Amazon Web Services Regions. The presigned URL must be a valid request for the CopyDBClusterSnapshot API operation that can run in the source Amazon Web Services Region that contains the encrypted DB cluster snapshot to copy. The presigned URL request must contain the following parameter values: KmsKeyId - The 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 operation that is called in the destination Amazon Web Services Region, and the operation contained in the presigned 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 presigned URL that is a valid request for the operation that can run 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.
|
|
1498
1498
|
*/
|
|
1499
1499
|
PreSignedUrl?: String;
|
|
1500
1500
|
/**
|
|
@@ -1530,7 +1530,7 @@ declare namespace RDS {
|
|
|
1530
1530
|
}
|
|
1531
1531
|
export interface CopyDBSnapshotMessage {
|
|
1532
1532
|
/**
|
|
1533
|
-
* The identifier for the source DB snapshot. If the source snapshot is in the same Amazon Web Services Region as the copy, specify a valid DB snapshot identifier. For example, you might specify rds:mysql-instance1-snapshot-20130805. If the source snapshot is in a different Amazon Web Services Region than the copy, specify a valid DB snapshot ARN. For example, you might specify arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20130805. If you are copying from a shared manual DB snapshot, this parameter must be the Amazon Resource Name (ARN) of the shared DB snapshot. If you are copying an encrypted snapshot this parameter must be in the ARN format for the source Amazon Web Services Region
|
|
1533
|
+
* The identifier for the source DB snapshot. If the source snapshot is in the same Amazon Web Services Region as the copy, specify a valid DB snapshot identifier. For example, you might specify rds:mysql-instance1-snapshot-20130805. If the source snapshot is in a different Amazon Web Services Region than the copy, specify a valid DB snapshot ARN. For example, you might specify arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20130805. If you are copying from a shared manual DB snapshot, this parameter must be the Amazon Resource Name (ARN) of the shared DB snapshot. If you are copying an encrypted snapshot this parameter must be in the ARN format for the source Amazon Web Services Region. Constraints: Must specify a valid system snapshot in the "available" state. Example: rds:mydb-2012-04-02-00-01 Example: arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20130805
|
|
1534
1534
|
*/
|
|
1535
1535
|
SourceDBSnapshotIdentifier: String;
|
|
1536
1536
|
/**
|
|
@@ -1547,7 +1547,7 @@ declare namespace RDS {
|
|
|
1547
1547
|
*/
|
|
1548
1548
|
CopyTags?: BooleanOptional;
|
|
1549
1549
|
/**
|
|
1550
|
-
*
|
|
1550
|
+
* When you are copying a snapshot from one Amazon Web Services GovCloud (US) Region to another, the URL that contains a Signature Version 4 signed request for the CopyDBSnapshot API operation in the source Amazon Web Services Region that contains the source DB snapshot to copy. This setting applies only to Amazon Web Services GovCloud (US) Regions. It's ignored in other Amazon Web Services Regions. 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 CopyDBClusterSnapshot API operation that can run in the source Amazon Web Services Region that contains the encrypted DB cluster snapshot to copy. 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 operation 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 operation in the us-east-1 Amazon Web Services Region and provide a presigned URL that contains a call to the CopyDBSnapshot operation 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 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 operation that is called in the destination Amazon Web Services Region, and the operation 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 presigned URL that is a valid request for the operation that can run 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.
|
|
1551
1551
|
*/
|
|
1552
1552
|
PreSignedUrl?: String;
|
|
1553
1553
|
/**
|
|
@@ -1723,11 +1723,11 @@ declare namespace RDS {
|
|
|
1723
1723
|
*/
|
|
1724
1724
|
KmsKeyId?: String;
|
|
1725
1725
|
/**
|
|
1726
|
-
*
|
|
1726
|
+
* When you are replicating a DB cluster from one Amazon Web Services GovCloud (US) Region to another, an URL that contains a Signature Version 4 signed request for the CreateDBCluster operation to be called in the source Amazon Web Services Region where the DB cluster is replicated from. Specify PreSignedUrl only when you are performing cross-Region replication from an encrypted DB cluster. The presigned URL must be a valid request for the CreateDBCluster API operation that can run in the source Amazon Web Services Region that contains the encrypted DB cluster to copy. The presigned URL request must contain the following parameter values: KmsKeyId - The 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 operation that is called in the destination Amazon Web Services Region, and the operation contained in the presigned 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 presigned URL that is a valid request for the operation that can run in the source Amazon Web Services Region. Valid for: Aurora DB clusters onlyIf you supply a value for this operation's SourceRegion parameter, a pre-signed URL will be calculated on your behalf.
|
|
1727
1727
|
*/
|
|
1728
1728
|
PreSignedUrl?: String;
|
|
1729
1729
|
/**
|
|
1730
|
-
* A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn't enabled. For more information, see IAM Database Authentication in the Amazon Aurora User Guide
|
|
1730
|
+
* A value that indicates whether to enable mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts. By default, mapping isn't enabled. For more information, see IAM Database Authentication in the Amazon Aurora User Guide. Valid for: Aurora DB clusters only
|
|
1731
1731
|
*/
|
|
1732
1732
|
EnableIAMDatabaseAuthentication?: BooleanOptional;
|
|
1733
1733
|
/**
|
|
@@ -1739,7 +1739,7 @@ declare namespace RDS {
|
|
|
1739
1739
|
*/
|
|
1740
1740
|
EnableCloudwatchLogsExports?: LogTypeList;
|
|
1741
1741
|
/**
|
|
1742
|
-
* The DB engine mode of the DB cluster, either provisioned, serverless, parallelquery, global, or multimaster. The parallelquery engine mode isn't required for Aurora MySQL version 1.23 and higher 1.x versions, and version 2.09 and higher 2.x versions. The global engine mode isn't required for Aurora MySQL version 1.22 and higher 1.x versions, and global engine mode isn't required for any 2.x versions. The multimaster engine mode only applies for DB clusters created with Aurora MySQL version 5.6.10a. For Aurora PostgreSQL, the global engine mode isn't required, and both the parallelquery and the multimaster engine modes currently aren't supported. Limitations and requirements apply to some DB engine modes. For more information, see the following sections in the Amazon Aurora User Guide:
|
|
1742
|
+
* The DB engine mode of the DB cluster, either provisioned, serverless, parallelquery, global, or multimaster. The parallelquery engine mode isn't required for Aurora MySQL version 1.23 and higher 1.x versions, and version 2.09 and higher 2.x versions. The global engine mode isn't required for Aurora MySQL version 1.22 and higher 1.x versions, and global engine mode isn't required for any 2.x versions. The multimaster engine mode only applies for DB clusters created with Aurora MySQL version 5.6.10a. The serverless engine mode only applies for Aurora Serverless v1 DB clusters. For Aurora PostgreSQL, the global engine mode isn't required, and both the parallelquery and the multimaster engine modes currently aren't supported. Limitations and requirements apply to some DB engine modes. For more information, see the following sections in the Amazon Aurora User Guide: Limitations of Aurora Serverless v1 Requirements for Aurora Serverless v2 Limitations of Parallel Query Limitations of Aurora Global Databases Limitations of Multi-Master Clusters Valid for: Aurora DB clusters only
|
|
1743
1743
|
*/
|
|
1744
1744
|
EngineMode?: String;
|
|
1745
1745
|
/**
|
|
@@ -1815,7 +1815,7 @@ declare namespace RDS {
|
|
|
1815
1815
|
*/
|
|
1816
1816
|
PerformanceInsightsKMSKeyId?: String;
|
|
1817
1817
|
/**
|
|
1818
|
-
* The
|
|
1818
|
+
* The number of days to retain Performance Insights data. The default is 7 days. The following values are valid: 7 month * 31, where month is a number of months from 1-23 731 For example, the following values are valid: 93 (3 months * 31) 341 (11 months * 31) 589 (19 months * 31) 731 If you specify a retention period such as 94, which isn't a valid value, RDS issues an error. Valid for: Multi-AZ DB clusters only
|
|
1819
1819
|
*/
|
|
1820
1820
|
PerformanceInsightsRetentionPeriod?: IntegerOptional;
|
|
1821
1821
|
ServerlessV2ScalingConfiguration?: ServerlessV2ScalingConfiguration;
|
|
@@ -1879,7 +1879,7 @@ declare namespace RDS {
|
|
|
1879
1879
|
*/
|
|
1880
1880
|
AllocatedStorage?: IntegerOptional;
|
|
1881
1881
|
/**
|
|
1882
|
-
* The compute and memory capacity of the DB instance, for example db.
|
|
1882
|
+
* The compute and memory capacity of the DB instance, for example db.m5.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 classes in the Amazon RDS User Guide or Aurora DB instance classes in the Amazon Aurora User Guide.
|
|
1883
1883
|
*/
|
|
1884
1884
|
DBInstanceClass: String;
|
|
1885
1885
|
/**
|
|
@@ -1895,7 +1895,7 @@ declare namespace RDS {
|
|
|
1895
1895
|
*/
|
|
1896
1896
|
MasterUserPassword?: String;
|
|
1897
1897
|
/**
|
|
1898
|
-
* A list of DB security groups to associate with this DB instance.
|
|
1898
|
+
* A list of DB security groups to associate with this DB instance. This setting applies to the legacy EC2-Classic platform, which is no longer used to create new DB instances. Use the VpcSecurityGroupIds setting instead.
|
|
1899
1899
|
*/
|
|
1900
1900
|
DBSecurityGroups?: DBSecurityGroupNameList;
|
|
1901
1901
|
/**
|
|
@@ -1919,7 +1919,7 @@ declare namespace RDS {
|
|
|
1919
1919
|
*/
|
|
1920
1920
|
DBParameterGroupName?: String;
|
|
1921
1921
|
/**
|
|
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
|
|
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 for an RDS Custom for Oracle DB instance
|
|
1923
1923
|
*/
|
|
1924
1924
|
BackupRetentionPeriod?: IntegerOptional;
|
|
1925
1925
|
/**
|
|
@@ -1931,11 +1931,11 @@ declare namespace RDS {
|
|
|
1931
1931
|
*/
|
|
1932
1932
|
Port?: IntegerOptional;
|
|
1933
1933
|
/**
|
|
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.
|
|
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. Amazon Aurora Not applicable. DB instance Availability Zones (AZs) are managed by the DB cluster.
|
|
1935
1935
|
*/
|
|
1936
1936
|
MultiAZ?: BooleanOptional;
|
|
1937
1937
|
/**
|
|
1938
|
-
* The version number of the database engine to use. For a list of valid engine versions, use the DescribeDBEngineVersions
|
|
1938
|
+
* The version number of the database engine to use. For a list of valid engine versions, use the DescribeDBEngineVersions operation. 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 for Oracle A custom engine version (CEV) that you have previously created. This setting is required for RDS Custom for Oracle. 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 for Oracle DB instance in the Amazon RDS User Guide. Amazon RDS Custom for SQL Server See RDS Custom for SQL Server general requirements in the Amazon RDS User Guide. MariaDB For information, see MariaDB on Amazon RDS Versions in the Amazon RDS User Guide. Microsoft SQL Server For information, see Microsoft SQL Server Versions on Amazon RDS in the Amazon RDS User Guide. MySQL For information, see MySQL on Amazon RDS Versions in the Amazon RDS User Guide. Oracle For information, see Oracle Database Engine Release Notes in the Amazon RDS User Guide. PostgreSQL For information, see Amazon RDS for PostgreSQL versions and extensions in the Amazon RDS User Guide.
|
|
1939
1939
|
*/
|
|
1940
1940
|
EngineVersion?: String;
|
|
1941
1941
|
/**
|
|
@@ -1943,15 +1943,15 @@ declare namespace RDS {
|
|
|
1943
1943
|
*/
|
|
1944
1944
|
AutoMinorVersionUpgrade?: BooleanOptional;
|
|
1945
1945
|
/**
|
|
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.
|
|
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. Amazon Aurora Not applicable.
|
|
1947
1947
|
*/
|
|
1948
1948
|
LicenseModel?: String;
|
|
1949
1949
|
/**
|
|
1950
|
-
* The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance. For information about valid Iops values, see Amazon RDS Provisioned IOPS storage to improve performance in the Amazon RDS User Guide. Constraints: For MariaDB, MySQL, Oracle, and PostgreSQL DB instances, must be a multiple between .5 and 50 of the storage amount for the DB instance. For SQL Server DB instances, must be a multiple between 1 and 50 of the storage amount for the DB instance.
|
|
1950
|
+
* The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for the DB instance. For information about valid Iops values, see Amazon RDS Provisioned IOPS storage to improve performance in the Amazon RDS User Guide. Constraints: For MariaDB, MySQL, Oracle, and PostgreSQL DB instances, must be a multiple between .5 and 50 of the storage amount for the DB instance. For SQL Server DB instances, must be a multiple between 1 and 50 of the storage amount for the DB instance. Amazon Aurora Not applicable. Storage is managed by the DB cluster.
|
|
1951
1951
|
*/
|
|
1952
1952
|
Iops?: IntegerOptional;
|
|
1953
1953
|
/**
|
|
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.
|
|
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. Amazon Aurora Not applicable.
|
|
1955
1955
|
*/
|
|
1956
1956
|
OptionGroupName?: String;
|
|
1957
1957
|
/**
|
|
@@ -1975,11 +1975,11 @@ declare namespace RDS {
|
|
|
1975
1975
|
*/
|
|
1976
1976
|
DBClusterIdentifier?: String;
|
|
1977
1977
|
/**
|
|
1978
|
-
* Specifies the storage type to be associated with the DB instance. Valid values: standard | gp2 | io1 If you specify io1, you must also include a value for the Iops parameter. Default: io1 if the Iops parameter is specified, otherwise gp2
|
|
1978
|
+
* Specifies the storage type to be associated with the DB instance. Valid values: standard | gp2 | io1 If you specify io1, you must also include a value for the Iops parameter. Default: io1 if the Iops parameter is specified, otherwise gp2 Amazon Aurora Not applicable. Storage is managed by the DB cluster.
|
|
1979
1979
|
*/
|
|
1980
1980
|
StorageType?: String;
|
|
1981
1981
|
/**
|
|
1982
|
-
* The ARN from the key store with which to associate the instance for TDE encryption. This setting doesn't apply to RDS Custom.
|
|
1982
|
+
* The ARN from the key store with which to associate the instance for TDE encryption. This setting doesn't apply to RDS Custom. Amazon Aurora Not applicable.
|
|
1983
1983
|
*/
|
|
1984
1984
|
TdeCredentialArn?: String;
|
|
1985
1985
|
/**
|
|
@@ -1995,7 +1995,7 @@ declare namespace RDS {
|
|
|
1995
1995
|
*/
|
|
1996
1996
|
KmsKeyId?: String;
|
|
1997
1997
|
/**
|
|
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.
|
|
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. Amazon Aurora Not applicable. The domain is managed by the DB cluster.
|
|
1999
1999
|
*/
|
|
2000
2000
|
Domain?: String;
|
|
2001
2001
|
/**
|
|
@@ -2011,7 +2011,7 @@ declare namespace RDS {
|
|
|
2011
2011
|
*/
|
|
2012
2012
|
MonitoringRoleArn?: String;
|
|
2013
2013
|
/**
|
|
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.
|
|
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. Amazon Aurora Not applicable. The domain is managed by the DB cluster.
|
|
2015
2015
|
*/
|
|
2016
2016
|
DomainIAMRoleName?: String;
|
|
2017
2017
|
/**
|
|
@@ -2023,7 +2023,7 @@ declare namespace RDS {
|
|
|
2023
2023
|
*/
|
|
2024
2024
|
Timezone?: String;
|
|
2025
2025
|
/**
|
|
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 isn't enabled. This setting doesn't apply to RDS Custom
|
|
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 isn't enabled. For more information, see IAM Database Authentication for MySQL and PostgreSQL in the Amazon RDS User Guide. This setting doesn't apply to RDS Custom. Amazon Aurora Not applicable. Mapping Amazon Web Services IAM accounts to database accounts is managed by the DB cluster.
|
|
2027
2027
|
*/
|
|
2028
2028
|
EnableIAMDatabaseAuthentication?: BooleanOptional;
|
|
2029
2029
|
/**
|
|
@@ -2035,7 +2035,7 @@ declare namespace RDS {
|
|
|
2035
2035
|
*/
|
|
2036
2036
|
PerformanceInsightsKMSKeyId?: String;
|
|
2037
2037
|
/**
|
|
2038
|
-
* The
|
|
2038
|
+
* The number of days to retain Performance Insights data. The default is 7 days. The following values are valid: 7 month * 31, where month is a number of months from 1-23 731 For example, the following values are valid: 93 (3 months * 31) 341 (11 months * 31) 589 (19 months * 31) 731 If you specify a retention period such as 94, which isn't a valid value, RDS issues an error. This setting doesn't apply to RDS Custom.
|
|
2039
2039
|
*/
|
|
2040
2040
|
PerformanceInsightsRetentionPeriod?: IntegerOptional;
|
|
2041
2041
|
/**
|
|
@@ -2043,7 +2043,7 @@ declare namespace RDS {
|
|
|
2043
2043
|
*/
|
|
2044
2044
|
EnableCloudwatchLogsExports?: LogTypeList;
|
|
2045
2045
|
/**
|
|
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.
|
|
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. Amazon Aurora Not applicable.
|
|
2047
2047
|
*/
|
|
2048
2048
|
ProcessorFeatures?: ProcessorFeatureList;
|
|
2049
2049
|
/**
|
|
@@ -2051,7 +2051,7 @@ declare namespace RDS {
|
|
|
2051
2051
|
*/
|
|
2052
2052
|
DeletionProtection?: BooleanOptional;
|
|
2053
2053
|
/**
|
|
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.
|
|
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. Amazon Aurora Not applicable. Storage is managed by the DB cluster.
|
|
2055
2055
|
*/
|
|
2056
2056
|
MaxAllocatedStorage?: IntegerOptional;
|
|
2057
2057
|
/**
|
|
@@ -2109,7 +2109,7 @@ declare namespace RDS {
|
|
|
2109
2109
|
*/
|
|
2110
2110
|
OptionGroupName?: String;
|
|
2111
2111
|
/**
|
|
2112
|
-
* 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
|
|
2112
|
+
* 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 MySQL and 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
|
|
2113
2113
|
*/
|
|
2114
2114
|
DBParameterGroupName?: String;
|
|
2115
2115
|
/**
|
|
@@ -2146,7 +2146,7 @@ declare namespace RDS {
|
|
|
2146
2146
|
*/
|
|
2147
2147
|
KmsKeyId?: String;
|
|
2148
2148
|
/**
|
|
2149
|
-
*
|
|
2149
|
+
* When you are creating a read replica from one Amazon Web Services GovCloud (US) Region to another or from one China Amazon Web Services Region to another, the URL that contains a Signature Version 4 signed request for the CreateDBInstanceReadReplica API operation in the source Amazon Web Services Region that contains the source DB instance. This setting applies only to Amazon Web Services GovCloud (US) Regions and China Amazon Web Services Regions. It's ignored in other Amazon Web Services Regions. 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 operation that can run 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 operation 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 operation in the us-east-1 Amazon Web Services Region and provide a presigned URL that contains a call to the CreateDBInstanceReadReplica operation 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 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 operation that is called in the destination Amazon Web Services Region, and the operation 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 run in the source Amazon Web Services Region. SourceRegion isn't supported for SQL Server, because Amazon RDS for SQL Server 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.
|
|
2150
2150
|
*/
|
|
2151
2151
|
PreSignedUrl?: String;
|
|
2152
2152
|
/**
|
|
@@ -2162,7 +2162,7 @@ declare namespace RDS {
|
|
|
2162
2162
|
*/
|
|
2163
2163
|
PerformanceInsightsKMSKeyId?: String;
|
|
2164
2164
|
/**
|
|
2165
|
-
* The
|
|
2165
|
+
* The number of days to retain Performance Insights data. The default is 7 days. The following values are valid: 7 month * 31, where month is a number of months from 1-23 731 For example, the following values are valid: 93 (3 months * 31) 341 (11 months * 31) 589 (19 months * 31) 731 If you specify a retention period such as 94, which isn't a valid value, RDS issues an error. This setting doesn't apply to RDS Custom.
|
|
2166
2166
|
*/
|
|
2167
2167
|
PerformanceInsightsRetentionPeriod?: IntegerOptional;
|
|
2168
2168
|
/**
|
|
@@ -2272,7 +2272,7 @@ declare namespace RDS {
|
|
|
2272
2272
|
*/
|
|
2273
2273
|
DBProxyName: String;
|
|
2274
2274
|
/**
|
|
2275
|
-
* The kinds of databases that the proxy can connect to. This value determines which database network protocol the proxy recognizes when it interprets network traffic to and from the database.
|
|
2275
|
+
* The kinds of databases that the proxy can connect to. This value determines which database network protocol the proxy recognizes when it interprets network traffic to and from the database. For Aurora MySQL, RDS for MariaDB, and RDS for MySQL databases, specify MYSQL. For Aurora PostgreSQL and RDS for PostgreSQL databases, specify POSTGRESQL.
|
|
2276
2276
|
*/
|
|
2277
2277
|
EngineFamily: EngineFamily;
|
|
2278
2278
|
/**
|
|
@@ -2418,7 +2418,7 @@ declare namespace RDS {
|
|
|
2418
2418
|
*/
|
|
2419
2419
|
DeletionProtection?: BooleanOptional;
|
|
2420
2420
|
/**
|
|
2421
|
-
* The name for your database of up to 64
|
|
2421
|
+
* The name for your database of up to 64 alphanumeric characters. If you do not provide a name, Amazon Aurora will not create a database in the global database cluster you are creating.
|
|
2422
2422
|
*/
|
|
2423
2423
|
DatabaseName?: String;
|
|
2424
2424
|
/**
|
|
@@ -2718,7 +2718,7 @@ declare namespace RDS {
|
|
|
2718
2718
|
*/
|
|
2719
2719
|
PerformanceInsightsKMSKeyId?: String;
|
|
2720
2720
|
/**
|
|
2721
|
-
* The
|
|
2721
|
+
* The number of days to retain Performance Insights data. The default is 7 days. The following values are valid: 7 month * 31, where month is a number of months from 1-23 731 For example, the following values are valid: 93 (3 months * 31) 341 (11 months * 31) 589 (19 months * 31) 731 This setting is only for non-Aurora Multi-AZ DB clusters.
|
|
2722
2722
|
*/
|
|
2723
2723
|
PerformanceInsightsRetentionPeriod?: IntegerOptional;
|
|
2724
2724
|
ServerlessV2ScalingConfiguration?: ServerlessV2ScalingConfigurationInfo;
|
|
@@ -3388,7 +3388,7 @@ declare namespace RDS {
|
|
|
3388
3388
|
*/
|
|
3389
3389
|
PerformanceInsightsKMSKeyId?: String;
|
|
3390
3390
|
/**
|
|
3391
|
-
* The
|
|
3391
|
+
* The number of days to retain Performance Insights data. The default is 7 days. The following values are valid: 7 month * 31, where month is a number of months from 1-23 731 For example, the following values are valid: 93 (3 months * 31) 341 (11 months * 31) 589 (19 months * 31) 731
|
|
3392
3392
|
*/
|
|
3393
3393
|
PerformanceInsightsRetentionPeriod?: IntegerOptional;
|
|
3394
3394
|
/**
|
|
@@ -3712,7 +3712,7 @@ declare namespace RDS {
|
|
|
3712
3712
|
*/
|
|
3713
3713
|
Status?: DBProxyStatus;
|
|
3714
3714
|
/**
|
|
3715
|
-
* The
|
|
3715
|
+
* The kinds of databases that the proxy can connect to. This value determines which database network protocol the proxy recognizes when it interprets network traffic to and from the database. MYSQL supports Aurora MySQL, RDS for MariaDB, and RDS for MySQL databases. POSTGRESQL supports Aurora PostgreSQL and RDS for PostgreSQL databases.
|
|
3716
3716
|
*/
|
|
3717
3717
|
EngineFamily?: String;
|
|
3718
3718
|
/**
|
|
@@ -4810,11 +4810,11 @@ declare namespace RDS {
|
|
|
4810
4810
|
}
|
|
4811
4811
|
export interface DescribeDBSnapshotsMessage {
|
|
4812
4812
|
/**
|
|
4813
|
-
* The ID of the DB instance to retrieve the list of DB snapshots for. This parameter
|
|
4813
|
+
* The ID of the DB instance to retrieve the list of DB snapshots for. This parameter isn't case-sensitive. Constraints: If supplied, must match the identifier of an existing DBInstance.
|
|
4814
4814
|
*/
|
|
4815
4815
|
DBInstanceIdentifier?: String;
|
|
4816
4816
|
/**
|
|
4817
|
-
* A specific DB snapshot identifier to describe. This
|
|
4817
|
+
* A specific DB snapshot identifier to describe. This value is stored as a lowercase string. Constraints: If supplied, must match the identifier of an existing DBSnapshot. If this identifier is for an automated snapshot, the SnapshotType parameter must also be specified.
|
|
4818
4818
|
*/
|
|
4819
4819
|
DBSnapshotIdentifier?: String;
|
|
4820
4820
|
/**
|
|
@@ -5090,7 +5090,7 @@ declare namespace RDS {
|
|
|
5090
5090
|
*/
|
|
5091
5091
|
Filters?: FilterList;
|
|
5092
5092
|
/**
|
|
5093
|
-
* The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results. Default: 100 Constraints: Minimum 20, maximum
|
|
5093
|
+
* The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results. Default: 100 Constraints: Minimum 20, maximum 10000.
|
|
5094
5094
|
*/
|
|
5095
5095
|
MaxRecords?: IntegerOptional;
|
|
5096
5096
|
/**
|
|
@@ -5895,7 +5895,7 @@ declare namespace RDS {
|
|
|
5895
5895
|
*/
|
|
5896
5896
|
PerformanceInsightsKMSKeyId?: String;
|
|
5897
5897
|
/**
|
|
5898
|
-
* The
|
|
5898
|
+
* The number of days to retain Performance Insights data. The default is 7 days. The following values are valid: 7 month * 31, where month is a number of months from 1-23 731 For example, the following values are valid: 93 (3 months * 31) 341 (11 months * 31) 589 (19 months * 31) 731 If you specify a retention period such as 94, which isn't a valid value, RDS issues an error. Valid for: Multi-AZ DB clusters only
|
|
5899
5899
|
*/
|
|
5900
5900
|
PerformanceInsightsRetentionPeriod?: IntegerOptional;
|
|
5901
5901
|
ServerlessV2ScalingConfiguration?: ServerlessV2ScalingConfiguration;
|
|
@@ -5919,7 +5919,7 @@ declare namespace RDS {
|
|
|
5919
5919
|
*/
|
|
5920
5920
|
DBClusterSnapshotIdentifier: String;
|
|
5921
5921
|
/**
|
|
5922
|
-
* The name of the DB cluster snapshot attribute to modify. To manage authorization for other Amazon Web Services accounts to copy or restore a manual DB cluster snapshot, set this value to restore. To view the list of attributes available to modify, use the DescribeDBClusterSnapshotAttributes API
|
|
5922
|
+
* The name of the DB cluster snapshot attribute to modify. To manage authorization for other Amazon Web Services accounts to copy or restore a manual DB cluster snapshot, set this value to restore. To view the list of attributes available to modify, use the DescribeDBClusterSnapshotAttributes API operation.
|
|
5923
5923
|
*/
|
|
5924
5924
|
AttributeName: String;
|
|
5925
5925
|
/**
|
|
@@ -5944,7 +5944,7 @@ declare namespace RDS {
|
|
|
5944
5944
|
*/
|
|
5945
5945
|
AllocatedStorage?: IntegerOptional;
|
|
5946
5946
|
/**
|
|
5947
|
-
* The new compute and memory capacity of the DB instance, for example db.
|
|
5947
|
+
* The new compute and memory capacity of the DB instance, for example db.m5.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 classes in the Amazon RDS User Guide or Aurora DB instance classes in the Amazon Aurora 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 for Oracle. Default: Uses existing setting
|
|
5948
5948
|
*/
|
|
5949
5949
|
DBInstanceClass?: String;
|
|
5950
5950
|
/**
|
|
@@ -5964,7 +5964,7 @@ declare namespace RDS {
|
|
|
5964
5964
|
*/
|
|
5965
5965
|
ApplyImmediately?: Boolean;
|
|
5966
5966
|
/**
|
|
5967
|
-
* 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
|
|
5967
|
+
* 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 operations 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.
|
|
5968
5968
|
*/
|
|
5969
5969
|
MasterUserPassword?: String;
|
|
5970
5970
|
/**
|
|
@@ -5972,7 +5972,7 @@ declare namespace RDS {
|
|
|
5972
5972
|
*/
|
|
5973
5973
|
DBParameterGroupName?: String;
|
|
5974
5974
|
/**
|
|
5975
|
-
* 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
|
|
5975
|
+
* 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 for an RDS Custom for Oracle 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.
|
|
5976
5976
|
*/
|
|
5977
5977
|
BackupRetentionPeriod?: IntegerOptional;
|
|
5978
5978
|
/**
|
|
@@ -6068,7 +6068,7 @@ declare namespace RDS {
|
|
|
6068
6068
|
*/
|
|
6069
6069
|
EnableIAMDatabaseAuthentication?: BooleanOptional;
|
|
6070
6070
|
/**
|
|
6071
|
-
* A value that indicates whether to enable Performance Insights for the DB instance. For more information, see Using Amazon Performance Insights in the Amazon RDS User Guide
|
|
6071
|
+
* A value that indicates whether to enable Performance Insights for the DB instance. For more information, see Using Amazon Performance Insights in the Amazon RDS User Guide. This setting doesn't apply to RDS Custom.
|
|
6072
6072
|
*/
|
|
6073
6073
|
EnablePerformanceInsights?: BooleanOptional;
|
|
6074
6074
|
/**
|
|
@@ -6076,7 +6076,7 @@ declare namespace RDS {
|
|
|
6076
6076
|
*/
|
|
6077
6077
|
PerformanceInsightsKMSKeyId?: String;
|
|
6078
6078
|
/**
|
|
6079
|
-
* The
|
|
6079
|
+
* The number of days to retain Performance Insights data. The default is 7 days. The following values are valid: 7 month * 31, where month is a number of months from 1-23 731 For example, the following values are valid: 93 (3 months * 31) 341 (11 months * 31) 589 (19 months * 31) 731 If you specify a retention period such as 94, which isn't a valid value, RDS issues an error. This setting doesn't apply to RDS Custom.
|
|
6080
6080
|
*/
|
|
6081
6081
|
PerformanceInsightsRetentionPeriod?: IntegerOptional;
|
|
6082
6082
|
/**
|
|
@@ -6203,11 +6203,11 @@ declare namespace RDS {
|
|
|
6203
6203
|
}
|
|
6204
6204
|
export interface ModifyDBProxyTargetGroupRequest {
|
|
6205
6205
|
/**
|
|
6206
|
-
* The name of the
|
|
6206
|
+
* The name of the target group to modify.
|
|
6207
6207
|
*/
|
|
6208
6208
|
TargetGroupName: String;
|
|
6209
6209
|
/**
|
|
6210
|
-
* The name of the
|
|
6210
|
+
* The name of the proxy.
|
|
6211
6211
|
*/
|
|
6212
6212
|
DBProxyName: String;
|
|
6213
6213
|
/**
|
|
@@ -6231,7 +6231,7 @@ declare namespace RDS {
|
|
|
6231
6231
|
*/
|
|
6232
6232
|
DBSnapshotIdentifier: String;
|
|
6233
6233
|
/**
|
|
6234
|
-
* The name of the DB snapshot attribute to modify. To manage authorization for other Amazon Web Services accounts to copy or restore a manual DB snapshot, set this value to restore. To view the list of attributes available to modify, use the DescribeDBSnapshotAttributes API
|
|
6234
|
+
* The name of the DB snapshot attribute to modify. To manage authorization for other Amazon Web Services accounts to copy or restore a manual DB snapshot, set this value to restore. To view the list of attributes available to modify, use the DescribeDBSnapshotAttributes API operation.
|
|
6235
6235
|
*/
|
|
6236
6236
|
AttributeName: String;
|
|
6237
6237
|
/**
|
|
@@ -7339,11 +7339,11 @@ declare namespace RDS {
|
|
|
7339
7339
|
*/
|
|
7340
7340
|
DBSubnetGroupName?: String;
|
|
7341
7341
|
/**
|
|
7342
|
-
* The name of the database engine to be used for this DB cluster. Valid Values: aurora (for MySQL 5.6-compatible Aurora)
|
|
7342
|
+
* The name of the database engine to be used for this DB cluster. Valid Values: aurora (for MySQL 5.6-compatible Aurora) and aurora-mysql (for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora)
|
|
7343
7343
|
*/
|
|
7344
7344
|
Engine: String;
|
|
7345
7345
|
/**
|
|
7346
|
-
* The version number of the database engine to use. To list all of the available engine versions for aurora (for MySQL 5.6-compatible Aurora), use the following command: aws rds describe-db-engine-versions --engine aurora --query "DBEngineVersions[].EngineVersion" To list all of the available engine versions for aurora-mysql (for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora), use the following command: aws rds describe-db-engine-versions --engine aurora-mysql --query "DBEngineVersions[].EngineVersion"
|
|
7346
|
+
* The version number of the database engine to use. To list all of the available engine versions for aurora (for MySQL 5.6-compatible Aurora), use the following command: aws rds describe-db-engine-versions --engine aurora --query "DBEngineVersions[].EngineVersion" To list all of the available engine versions for aurora-mysql (for MySQL 5.7-compatible and MySQL 8.0-compatible Aurora), use the following command: aws rds describe-db-engine-versions --engine aurora-mysql --query "DBEngineVersions[].EngineVersion" Aurora MySQL Example: 5.6.10a, 5.6.mysql_aurora.1.19.2, 5.7.mysql_aurora.2.07.1, 8.0.mysql_aurora.3.02.0
|
|
7347
7347
|
*/
|
|
7348
7348
|
EngineVersion?: String;
|
|
7349
7349
|
/**
|
|
@@ -7490,7 +7490,7 @@ declare namespace RDS {
|
|
|
7490
7490
|
*/
|
|
7491
7491
|
BacktrackWindow?: LongOptional;
|
|
7492
7492
|
/**
|
|
7493
|
-
* The list of logs that the restored DB cluster is to export to Amazon CloudWatch Logs. The values in the list depend on the DB engine being used. RDS for MySQL Possible values are error, general, and slowquery. RDS for PostgreSQL Possible values are postgresql and upgrade. Aurora MySQL Possible values are audit, error, general, and slowquery. Aurora PostgreSQL Possible value is postgresql. For more information about exporting CloudWatch Logs for Amazon RDS, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide
|
|
7493
|
+
* The list of logs that the restored DB cluster is to export to Amazon CloudWatch Logs. The values in the list depend on the DB engine being used. RDS for MySQL Possible values are error, general, and slowquery. RDS for PostgreSQL Possible values are postgresql and upgrade. Aurora MySQL Possible values are audit, error, general, and slowquery. Aurora PostgreSQL Possible value is postgresql. For more information about exporting CloudWatch Logs for Amazon RDS, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide. For more information about exporting CloudWatch Logs for Amazon Aurora, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide. Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
|
7494
7494
|
*/
|
|
7495
7495
|
EnableCloudwatchLogsExports?: LogTypeList;
|
|
7496
7496
|
/**
|
|
@@ -7593,7 +7593,7 @@ declare namespace RDS {
|
|
|
7593
7593
|
*/
|
|
7594
7594
|
BacktrackWindow?: LongOptional;
|
|
7595
7595
|
/**
|
|
7596
|
-
* The list of logs that the restored DB cluster is to export to CloudWatch Logs. The values in the list depend on the DB engine being used. RDS for MySQL Possible values are error, general, and slowquery. RDS for PostgreSQL Possible values are postgresql and upgrade. Aurora MySQL Possible values are audit, error, general, and slowquery. Aurora PostgreSQL Possible value is postgresql. For more information about exporting CloudWatch Logs for Amazon RDS, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide
|
|
7596
|
+
* The list of logs that the restored DB cluster is to export to CloudWatch Logs. The values in the list depend on the DB engine being used. RDS for MySQL Possible values are error, general, and slowquery. RDS for PostgreSQL Possible values are postgresql and upgrade. Aurora MySQL Possible values are audit, error, general, and slowquery. Aurora PostgreSQL Possible value is postgresql. For more information about exporting CloudWatch Logs for Amazon RDS, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon RDS User Guide. For more information about exporting CloudWatch Logs for Amazon Aurora, see Publishing Database Logs to Amazon CloudWatch Logs in the Amazon Aurora User Guide. Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
|
7597
7597
|
*/
|
|
7598
7598
|
EnableCloudwatchLogsExports?: LogTypeList;
|
|
7599
7599
|
/**
|
|
@@ -7921,7 +7921,7 @@ declare namespace RDS {
|
|
|
7921
7921
|
*/
|
|
7922
7922
|
S3IngestionRoleArn: String;
|
|
7923
7923
|
/**
|
|
7924
|
-
* A value that indicates whether to enable Performance Insights for the DB instance. For more information, see Using Amazon Performance Insights in the Amazon RDS User Guide
|
|
7924
|
+
* A value that indicates whether to enable Performance Insights for the DB instance. For more information, see Using Amazon Performance Insights in the Amazon RDS User Guide.
|
|
7925
7925
|
*/
|
|
7926
7926
|
EnablePerformanceInsights?: BooleanOptional;
|
|
7927
7927
|
/**
|
|
@@ -7929,7 +7929,7 @@ declare namespace RDS {
|
|
|
7929
7929
|
*/
|
|
7930
7930
|
PerformanceInsightsKMSKeyId?: String;
|
|
7931
7931
|
/**
|
|
7932
|
-
* The
|
|
7932
|
+
* The number of days to retain Performance Insights data. The default is 7 days. The following values are valid: 7 month * 31, where month is a number of months from 1-23 731 For example, the following values are valid: 93 (3 months * 31) 341 (11 months * 31) 589 (19 months * 31) 731 If you specify a retention period such as 94, which isn't a valid value, RDS issues an error.
|
|
7933
7933
|
*/
|
|
7934
7934
|
PerformanceInsightsRetentionPeriod?: IntegerOptional;
|
|
7935
7935
|
/**
|
|
@@ -8173,7 +8173,7 @@ declare namespace RDS {
|
|
|
8173
8173
|
}
|
|
8174
8174
|
export interface ScalingConfigurationInfo {
|
|
8175
8175
|
/**
|
|
8176
|
-
* The
|
|
8176
|
+
* The minimum capacity for an Aurora DB cluster in serverless DB engine mode.
|
|
8177
8177
|
*/
|
|
8178
8178
|
MinCapacity?: IntegerOptional;
|
|
8179
8179
|
/**
|
|
@@ -8319,7 +8319,7 @@ declare namespace RDS {
|
|
|
8319
8319
|
*/
|
|
8320
8320
|
KmsKeyId?: String;
|
|
8321
8321
|
/**
|
|
8322
|
-
*
|
|
8322
|
+
* In an Amazon Web Services GovCloud (US) Region, an URL that contains a Signature Version 4 signed request for the StartDBInstanceAutomatedBackupsReplication operation to call in the Amazon Web Services Region of the source DB instance. The presigned URL must be a valid request for the StartDBInstanceAutomatedBackupsReplication API operation that can run in the Amazon Web Services Region that contains the source DB instance. This setting applies only to Amazon Web Services GovCloud (US) Regions. It's ignored in other Amazon Web Services Regions. 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 run in the source Amazon Web Services Region.
|
|
8323
8323
|
*/
|
|
8324
8324
|
PreSignedUrl?: String;
|
|
8325
8325
|
}
|
|
@@ -8611,7 +8611,7 @@ declare namespace RDS {
|
|
|
8611
8611
|
*/
|
|
8612
8612
|
VpcSecurityGroupId?: String;
|
|
8613
8613
|
/**
|
|
8614
|
-
* The status of the VPC security group.
|
|
8614
|
+
* The membership status of the VPC security group. Currently, the only valid status is active.
|
|
8615
8615
|
*/
|
|
8616
8616
|
Status?: String;
|
|
8617
8617
|
}
|