@aws-sdk/client-rds 3.826.0 → 3.830.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -29,12 +29,16 @@ declare const CreateDBInstanceReadReplicaCommand_base: {
29
29
  /**
30
30
  * <p>Creates a new DB instance that acts as a read replica for an existing source DB
31
31
  * instance or Multi-AZ DB cluster. You can create a read replica for a DB instance running
32
- * Db2, MariaDB, MySQL, Oracle, PostgreSQL, or SQL Server. You can create a read replica for a
32
+ * MariaDB, MySQL, Oracle, PostgreSQL, or SQL Server. You can create a read replica for a
33
33
  * Multi-AZ DB cluster running MySQL or PostgreSQL. For more information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_ReadRepl.html">Working
34
- * with read replicas</a> and <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html#multi-az-db-clusters-migrating-to-instance-with-read-replica">Migrating from a Multi-AZ DB cluster to a DB instance using a read replica</a> in the <i>Amazon RDS User Guide</i>.</p>
34
+ * with read replicas</a> and <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html#multi-az-db-clusters-migrating-to-instance-with-read-replica">Migrating from a Multi-AZ DB cluster to a DB instance using a read replica</a>
35
+ * in the <i>Amazon RDS User Guide</i>.</p>
36
+ * <p>Amazon RDS for Db2 supports this operation for standby replicas. To create a standby
37
+ * replica for a DB instance running Db2, you must set <code>ReplicaMode</code> to
38
+ * <code>mounted</code>.</p>
35
39
  * <p>Amazon Aurora doesn't support this operation. To create a DB instance for an Aurora DB cluster, use the <code>CreateDBInstance</code>
36
40
  * operation.</p>
37
- * <p>All read replica DB instances are created with backups disabled. All other attributes
41
+ * <p>RDS creates read replicas with backups disabled. All other attributes
38
42
  * (including DB security groups and DB parameter groups) are inherited from the source DB
39
43
  * instance or cluster, except as specified.</p>
40
44
  * <important>
@@ -3,9 +3,9 @@ import { Endpoint, EndpointParameters as __EndpointParameters, EndpointV2, Provi
3
3
  * @public
4
4
  */
5
5
  export interface ClientInputEndpointParameters {
6
- region?: string | Provider<string>;
7
- useDualstackEndpoint?: boolean | Provider<boolean>;
8
- useFipsEndpoint?: boolean | Provider<boolean>;
6
+ region?: string | undefined | Provider<string | undefined>;
7
+ useDualstackEndpoint?: boolean | undefined | Provider<boolean | undefined>;
8
+ useFipsEndpoint?: boolean | undefined | Provider<boolean | undefined>;
9
9
  endpoint?: string | Provider<string> | Endpoint | Provider<Endpoint> | EndpointV2 | Provider<EndpointV2>;
10
10
  }
11
11
  export type ClientResolvedEndpointParameters = ClientInputEndpointParameters & {
@@ -31,8 +31,8 @@ export declare const commonParams: {
31
31
  };
32
32
  };
33
33
  export interface EndpointParameters extends __EndpointParameters {
34
- Region?: string;
35
- UseDualStack?: boolean;
36
- UseFIPS?: boolean;
37
- Endpoint?: string;
34
+ Region?: string | undefined;
35
+ UseDualStack?: boolean | undefined;
36
+ UseFIPS?: boolean | undefined;
37
+ Endpoint?: string | undefined;
38
38
  }
@@ -8233,11 +8233,13 @@ export interface DBInstance {
8233
8233
  */
8234
8234
  ReadReplicaDBClusterIdentifiers?: string[] | undefined;
8235
8235
  /**
8236
- * <p>The open mode of an Oracle read replica. The default is <code>open-read-only</code>.
8237
- * For more information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-read-replicas.html">Working with Oracle Read Replicas for Amazon RDS</a>
8238
- * in the <i>Amazon RDS User Guide</i>.</p>
8236
+ * <p>The open mode of a Db2 or an Oracle read replica. The default is
8237
+ * <code>open-read-only</code>. For more information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/db2-replication.html">Working with read replicas for
8238
+ * Amazon RDS for Db2</a> and <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-read-replicas.html">Working with read replicas
8239
+ * for Amazon RDS for Oracle</a> in the <i>Amazon RDS User Guide</i>. </p>
8239
8240
  * <note>
8240
- * <p>This attribute is only supported in RDS for Oracle.</p>
8241
+ * <p>This attribute is only supported in RDS for Db2, RDS for Oracle, and RDS Custom
8242
+ * for Oracle.</p>
8241
8243
  * </note>
8242
8244
  * @public
8243
8245
  */
@@ -8745,8 +8747,19 @@ export interface CreateDBInstanceReadReplicaMessage {
8745
8747
  DBInstanceIdentifier: string | undefined;
8746
8748
  /**
8747
8749
  * <p>The identifier of the DB instance that will act as the source for the read replica.
8748
- * Each DB instance can have up to 15 read replicas, with the exception of Oracle and SQL
8749
- * Server, which can have up to five.</p>
8750
+ * Each DB instance can have up to 15 read replicas, except for the following
8751
+ * engines:</p>
8752
+ * <ul>
8753
+ * <li>
8754
+ * <p>Db2 - Can have up to three replicas.</p>
8755
+ * </li>
8756
+ * <li>
8757
+ * <p>Oracle - Can have up to five read replicas.</p>
8758
+ * </li>
8759
+ * <li>
8760
+ * <p>SQL Server - Can have up to five read replicas.</p>
8761
+ * </li>
8762
+ * </ul>
8750
8763
  * <p>Constraints:</p>
8751
8764
  * <ul>
8752
8765
  * <li>
@@ -8844,6 +8857,14 @@ export interface CreateDBInstanceReadReplicaMessage {
8844
8857
  /**
8845
8858
  * <p>The name of the DB parameter group to associate with this read replica DB
8846
8859
  * instance.</p>
8860
+ * <p>For the Db2 DB engine, if your source DB instance uses the Bring Your Own License
8861
+ * model, then a custom parameter group must be associated with the replica. For a same
8862
+ * Amazon Web Services Region replica, if you don't specify a custom parameter group, Amazon RDS
8863
+ * associates the custom parameter group associated with the source DB instance. For a
8864
+ * cross-Region replica, you must specify a custom parameter group. This custom parameter
8865
+ * group must include your IBM Site ID and IBM Customer ID. For more information, see
8866
+ * <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/db2-licensing.html#db2-prereqs-ibm-info"> IBM IDs
8867
+ * for Bring Your Own License for Db2</a>. </p>
8847
8868
  * <p>For Single-AZ or Multi-AZ DB instance read replica instances, if you don't specify a
8848
8869
  * value for <code>DBParameterGroupName</code>, then Amazon RDS uses the
8849
8870
  * <code>DBParameterGroup</code> of the source DB instance for a same Region read
@@ -8854,8 +8875,8 @@ export interface CreateDBInstanceReadReplicaMessage {
8854
8875
  * <code>DBParameterGroup</code>.</p>
8855
8876
  * <p>Specifying a parameter group for this operation is only supported for MySQL DB
8856
8877
  * instances for cross-Region read replicas, for Multi-AZ DB cluster read replica
8857
- * instances, and for Oracle DB instances. It isn't supported for MySQL DB instances for
8858
- * same Region read replicas or for RDS Custom.</p>
8878
+ * instances, for Db2 DB instances, and for Oracle DB instances. It isn't supported for
8879
+ * MySQL DB instances for same Region read replicas or for RDS Custom.</p>
8859
8880
  * <p>Constraints:</p>
8860
8881
  * <ul>
8861
8882
  * <li>
@@ -9214,19 +9235,39 @@ export interface CreateDBInstanceReadReplicaMessage {
9214
9235
  */
9215
9236
  DomainDnsIps?: string[] | undefined;
9216
9237
  /**
9217
- * <p>The open mode of the replica database: mounted or read-only.</p>
9238
+ * <p>The open mode of the replica database.</p>
9218
9239
  * <note>
9219
- * <p>This parameter is only supported for Oracle DB instances.</p>
9240
+ * <p>This parameter is only supported for Db2 DB instances and Oracle DB
9241
+ * instances.</p>
9220
9242
  * </note>
9221
- * <p>Mounted DB replicas are included in Oracle Database Enterprise Edition. The main use case for
9222
- * mounted replicas is cross-Region disaster recovery. The primary database doesn't use Active
9223
- * Data Guard to transmit information to the mounted replica. Because it doesn't accept
9224
- * user connections, a mounted replica can't serve a read-only workload.</p>
9225
- * <p>You can create a combination of mounted and read-only DB replicas for the same primary DB instance.
9226
- * For more information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-read-replicas.html">Working with Oracle Read Replicas for Amazon RDS</a>
9227
- * in the <i>Amazon RDS User Guide</i>.</p>
9228
- * <p>For RDS Custom, you must specify this parameter and set it to <code>mounted</code>. The value won't be set by default.
9229
- * After replica creation, you can manage the open mode manually.</p>
9243
+ * <dl>
9244
+ * <dt>Db2</dt>
9245
+ * <dd>
9246
+ * <p>Standby DB replicas are included in Db2 Advanced Edition (AE) and Db2
9247
+ * Standard Edition (SE). The main use case for standby replicas is
9248
+ * cross-Region disaster recovery. Because it doesn't accept user
9249
+ * connections, a standby replica can't serve a read-only workload.</p>
9250
+ * <p>You can create a combination of standby and read-only DB replicas for the
9251
+ * same primary DB instance. For more information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/db2-replication.html">Working with read
9252
+ * replicas for Amazon RDS for Db2</a> in the <i>Amazon RDS User
9253
+ * Guide</i>.</p>
9254
+ * <p>To create standby DB replicas for RDS for Db2, set this parameter to
9255
+ * <code>mounted</code>.</p>
9256
+ * </dd>
9257
+ * <dt>Oracle</dt>
9258
+ * <dd>
9259
+ * <p>Mounted DB replicas are included in Oracle Database Enterprise Edition. The main use case for
9260
+ * mounted replicas is cross-Region disaster recovery. The primary database doesn't use Active
9261
+ * Data Guard to transmit information to the mounted replica. Because it doesn't accept
9262
+ * user connections, a mounted replica can't serve a read-only workload.</p>
9263
+ * <p>You can create a combination of mounted and read-only DB replicas for the same primary DB instance.
9264
+ * For more information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-read-replicas.html">Working with read replicas for Amazon RDS for Oracle</a>
9265
+ * in the <i>Amazon RDS User Guide</i>.</p>
9266
+ * <p>For RDS Custom, you must specify this parameter and set it to
9267
+ * <code>mounted</code>. The value won't be set by default. After replica
9268
+ * creation, you can manage the open mode manually.</p>
9269
+ * </dd>
9270
+ * </dl>
9230
9271
  * @public
9231
9272
  */
9232
9273
  ReplicaMode?: ReplicaMode | undefined;
@@ -2279,6 +2279,11 @@ export interface ConnectionPoolConfigurationInfo {
2279
2279
  * This is an optional field.</p>
2280
2280
  * <p>For example: <code>SET variable1=value1, variable2=value2</code>
2281
2281
  * </p>
2282
+ * <important>
2283
+ * <p>Since you can access initialization query as part of target group configuration, it is not protected by authentication or cryptographic methods.
2284
+ * Anyone with access to view or manage your proxy target group configuration can view the initialization query.
2285
+ * You should not add sensitive data, such as passwords or long-lived encryption keys, to this option.</p>
2286
+ * </important>
2282
2287
  * @public
2283
2288
  */
2284
2289
  InitQuery?: string | undefined;
@@ -8629,17 +8634,40 @@ export interface ModifyDBInstanceMessage {
8629
8634
  */
8630
8635
  CertificateRotationRestart?: boolean | undefined;
8631
8636
  /**
8632
- * <p>A value that sets the open mode of a replica database to either mounted or read-only.</p>
8637
+ * <p>The open mode of a replica database.</p>
8633
8638
  * <note>
8634
- * <p>Currently, this parameter is only supported for Oracle DB instances.</p>
8639
+ * <p>This parameter is only supported for Db2 DB instances and Oracle DB
8640
+ * instances.</p>
8635
8641
  * </note>
8636
- * <p>Mounted DB replicas are included in Oracle Enterprise Edition. The main use case for
8637
- * mounted replicas is cross-Region disaster recovery. The primary database doesn't use
8638
- * Active Data Guard to transmit information to the mounted replica. Because it doesn't
8639
- * accept user connections, a mounted replica can't serve a read-only workload.
8640
- * For more information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-read-replicas.html">Working with Oracle Read Replicas for Amazon RDS</a>
8641
- * in the <i>Amazon RDS User Guide</i>.</p>
8642
- * <p>This setting doesn't apply to RDS Custom DB instances.</p>
8642
+ * <dl>
8643
+ * <dt>Db2</dt>
8644
+ * <dd>
8645
+ * <p>Standby DB replicas are included in Db2 Advanced Edition (AE) and Db2
8646
+ * Standard Edition (SE). The main use case for standby replicas is
8647
+ * cross-Region disaster recovery. Because it doesn't accept user
8648
+ * connections, a standby replica can't serve a read-only workload.</p>
8649
+ * <p>You can create a combination of standby and read-only DB replicas for the
8650
+ * same primary DB instance. For more information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/db2-replication.html">Working with read
8651
+ * replicas for Amazon RDS for Db2</a> in the <i>Amazon RDS User
8652
+ * Guide</i>.</p>
8653
+ * <p>To create standby DB replicas for RDS for Db2, set this parameter to
8654
+ * <code>mounted</code>.</p>
8655
+ * </dd>
8656
+ * <dt>Oracle</dt>
8657
+ * <dd>
8658
+ * <p>Mounted DB replicas are included in Oracle Database Enterprise Edition. The main use case for
8659
+ * mounted replicas is cross-Region disaster recovery. The primary database doesn't use Active
8660
+ * Data Guard to transmit information to the mounted replica. Because it doesn't accept
8661
+ * user connections, a mounted replica can't serve a read-only workload.</p>
8662
+ * <p>You can create a combination of mounted and read-only DB replicas for the
8663
+ * same primary DB instance. For more information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-read-replicas.html">Working with
8664
+ * read replicas for Amazon RDS for Oracle</a> in the <i>Amazon
8665
+ * RDS User Guide</i>.</p>
8666
+ * <p>For RDS Custom, you must specify this parameter and set it to
8667
+ * <code>mounted</code>. The value won't be set by default. After replica
8668
+ * creation, you can manage the open mode manually.</p>
8669
+ * </dd>
8670
+ * </dl>
8643
8671
  * @public
8644
8672
  */
8645
8673
  ReplicaMode?: ReplicaMode | undefined;
@@ -9066,6 +9094,11 @@ export interface ConnectionPoolConfiguration {
9066
9094
  * <p>For example: <code>SET variable1=value1, variable2=value2</code>
9067
9095
  * </p>
9068
9096
  * <p>Default: no initialization query</p>
9097
+ * <important>
9098
+ * <p>Since you can access initialization query as part of target group configuration, it is not protected by authentication or cryptographic methods.
9099
+ * Anyone with access to view or manage your proxy target group configuration can view the initialization query.
9100
+ * You should not add sensitive data, such as passwords or long-lived encryption keys, to this option.</p>
9101
+ * </important>
9069
9102
  * @public
9070
9103
  */
9071
9104
  InitQuery?: string | undefined;
@@ -15,8 +15,8 @@ export declare const getRuntimeConfig: (config: RDSClientConfig) => {
15
15
  retryMode: string | import("@smithy/types").Provider<string>;
16
16
  sha256: import("@smithy/types").HashConstructor;
17
17
  streamCollector: import("@smithy/types").StreamCollector;
18
- useDualstackEndpoint: boolean | import("@smithy/types").Provider<boolean>;
19
- useFipsEndpoint: boolean | import("@smithy/types").Provider<boolean>;
18
+ useDualstackEndpoint: (boolean | import("@smithy/types").Provider<boolean>) & (boolean | import("@smithy/types").Provider<boolean | undefined>);
19
+ useFipsEndpoint: (boolean | import("@smithy/types").Provider<boolean>) & (boolean | import("@smithy/types").Provider<boolean | undefined>);
20
20
  apiVersion: string;
21
21
  cacheMiddleware?: boolean | undefined;
22
22
  urlParser: import("@smithy/types").UrlParser;
@@ -17,8 +17,8 @@ export declare const getRuntimeConfig: (config: RDSClientConfig) => {
17
17
  utf8Encoder: (input: Uint8Array | string) => string;
18
18
  disableHostPrefix: boolean;
19
19
  serviceId: string;
20
- useDualstackEndpoint: boolean | import("@smithy/types").Provider<boolean>;
21
- useFipsEndpoint: boolean | import("@smithy/types").Provider<boolean>;
20
+ useDualstackEndpoint: (boolean | import("@smithy/types").Provider<boolean>) & (boolean | import("@smithy/types").Provider<boolean | undefined>);
21
+ useFipsEndpoint: (boolean | import("@smithy/types").Provider<boolean>) & (boolean | import("@smithy/types").Provider<boolean | undefined>);
22
22
  region: string | import("@smithy/types").Provider<any>;
23
23
  profile?: string;
24
24
  defaultUserAgentProvider: (config?: import("@aws-sdk/util-user-agent-browser").PreviouslyResolved) => Promise<import("@smithy/types").UserAgent>;
@@ -5,9 +5,9 @@ import {
5
5
  Provider,
6
6
  } from "@smithy/types";
7
7
  export interface ClientInputEndpointParameters {
8
- region?: string | Provider<string>;
9
- useDualstackEndpoint?: boolean | Provider<boolean>;
10
- useFipsEndpoint?: boolean | Provider<boolean>;
8
+ region?: string | undefined | Provider<string | undefined>;
9
+ useDualstackEndpoint?: boolean | undefined | Provider<boolean | undefined>;
10
+ useFipsEndpoint?: boolean | undefined | Provider<boolean | undefined>;
11
11
  endpoint?:
12
12
  | string
13
13
  | Provider<string>
@@ -41,8 +41,8 @@ export declare const commonParams: {
41
41
  };
42
42
  };
43
43
  export interface EndpointParameters extends __EndpointParameters {
44
- Region?: string;
45
- UseDualStack?: boolean;
46
- UseFIPS?: boolean;
47
- Endpoint?: string;
44
+ Region?: string | undefined;
45
+ UseDualStack?: boolean | undefined;
46
+ UseFIPS?: boolean | undefined;
47
+ Endpoint?: string | undefined;
48
48
  }
@@ -22,8 +22,10 @@ export declare const getRuntimeConfig: (config: RDSClientConfig) => {
22
22
  retryMode: string | import("@smithy/types").Provider<string>;
23
23
  sha256: import("@smithy/types").HashConstructor;
24
24
  streamCollector: import("@smithy/types").StreamCollector;
25
- useDualstackEndpoint: boolean | import("@smithy/types").Provider<boolean>;
26
- useFipsEndpoint: boolean | import("@smithy/types").Provider<boolean>;
25
+ useDualstackEndpoint: (boolean | import("@smithy/types").Provider<boolean>) &
26
+ (boolean | import("@smithy/types").Provider<boolean | undefined>);
27
+ useFipsEndpoint: (boolean | import("@smithy/types").Provider<boolean>) &
28
+ (boolean | import("@smithy/types").Provider<boolean | undefined>);
27
29
  apiVersion: string;
28
30
  cacheMiddleware?: boolean | undefined;
29
31
  urlParser: import("@smithy/types").UrlParser;
@@ -19,8 +19,10 @@ export declare const getRuntimeConfig: (config: RDSClientConfig) => {
19
19
  utf8Encoder: (input: Uint8Array | string) => string;
20
20
  disableHostPrefix: boolean;
21
21
  serviceId: string;
22
- useDualstackEndpoint: boolean | import("@smithy/types").Provider<boolean>;
23
- useFipsEndpoint: boolean | import("@smithy/types").Provider<boolean>;
22
+ useDualstackEndpoint: (boolean | import("@smithy/types").Provider<boolean>) &
23
+ (boolean | import("@smithy/types").Provider<boolean | undefined>);
24
+ useFipsEndpoint: (boolean | import("@smithy/types").Provider<boolean>) &
25
+ (boolean | import("@smithy/types").Provider<boolean | undefined>);
24
26
  region: string | import("@smithy/types").Provider<any>;
25
27
  profile?: string;
26
28
  defaultUserAgentProvider: (
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-rds",
3
3
  "description": "AWS SDK for JavaScript Rds Client for Node.js, Browser and React Native",
4
- "version": "3.826.0",
4
+ "version": "3.830.0",
5
5
  "scripts": {
6
6
  "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
7
7
  "build:cjs": "node ../../scripts/compilation/inline client-rds",
@@ -21,17 +21,17 @@
21
21
  "@aws-crypto/sha256-browser": "5.2.0",
22
22
  "@aws-crypto/sha256-js": "5.2.0",
23
23
  "@aws-sdk/core": "3.826.0",
24
- "@aws-sdk/credential-provider-node": "3.826.0",
24
+ "@aws-sdk/credential-provider-node": "3.830.0",
25
25
  "@aws-sdk/middleware-host-header": "3.821.0",
26
26
  "@aws-sdk/middleware-logger": "3.821.0",
27
27
  "@aws-sdk/middleware-recursion-detection": "3.821.0",
28
28
  "@aws-sdk/middleware-sdk-rds": "3.826.0",
29
- "@aws-sdk/middleware-user-agent": "3.826.0",
29
+ "@aws-sdk/middleware-user-agent": "3.828.0",
30
30
  "@aws-sdk/region-config-resolver": "3.821.0",
31
31
  "@aws-sdk/types": "3.821.0",
32
- "@aws-sdk/util-endpoints": "3.821.0",
32
+ "@aws-sdk/util-endpoints": "3.828.0",
33
33
  "@aws-sdk/util-user-agent-browser": "3.821.0",
34
- "@aws-sdk/util-user-agent-node": "3.826.0",
34
+ "@aws-sdk/util-user-agent-node": "3.828.0",
35
35
  "@smithy/config-resolver": "^4.1.4",
36
36
  "@smithy/core": "^3.5.3",
37
37
  "@smithy/fetch-http-handler": "^5.0.4",