@aws-sdk/client-rds 3.301.0 → 3.303.0

package/dist-types/models/models_0.d.ts

@@ -140,29 +140,44 @@ export interface AccountAttributesMessage {
 }
 /**
  * @public
+ * @enum
  */
-export declare enum ActivityStreamMode {
-    async = "async",
-    sync = "sync"
-}
+export declare const ActivityStreamMode: {
+    readonly async: "async";
+    readonly sync: "sync";
+};
 /**
  * @public
  */
-export declare enum ActivityStreamPolicyStatus {
-    locked = "locked",
-    locking_policy = "locking-policy",
-    unlocked = "unlocked",
-    unlocking_policy = "unlocking-policy"
-}
+export type ActivityStreamMode = (typeof ActivityStreamMode)[keyof typeof ActivityStreamMode];
 /**
  * @public
+ * @enum
  */
-export declare enum ActivityStreamStatus {
-    started = "started",
-    starting = "starting",
-    stopped = "stopped",
-    stopping = "stopping"
-}
+export declare const ActivityStreamPolicyStatus: {
+    readonly locked: "locked";
+    readonly locking_policy: "locking-policy";
+    readonly unlocked: "unlocked";
+    readonly unlocking_policy: "unlocking-policy";
+};
+/**
+ * @public
+ */
+export type ActivityStreamPolicyStatus = (typeof ActivityStreamPolicyStatus)[keyof typeof ActivityStreamPolicyStatus];
+/**
+ * @public
+ * @enum
+ */
+export declare const ActivityStreamStatus: {
+    readonly started: "started";
+    readonly starting: "starting";
+    readonly stopped: "stopped";
+    readonly stopping: "stopping";
+};
+/**
+ * @public
+ */
+export type ActivityStreamStatus = (typeof ActivityStreamStatus)[keyof typeof ActivityStreamStatus];
 /**
  * @public
  */
@@ -928,11 +943,16 @@ export interface CancelExportTaskMessage {
 }
 /**
  * @public
+ * @enum
  */
-export declare enum ExportSourceType {
-    CLUSTER = "CLUSTER",
-    SNAPSHOT = "SNAPSHOT"
-}
+export declare const ExportSourceType: {
+    readonly CLUSTER: "CLUSTER";
+    readonly SNAPSHOT: "SNAPSHOT";
+};
+/**
+ * @public
+ */
+export type ExportSourceType = (typeof ExportSourceType)[keyof typeof ExportSourceType];
 /**
  * @public
  * <p>Contains the details of a snapshot or cluster export to Amazon S3.</p>
@@ -3364,7 +3384,7 @@ export interface CreateDBClusterMessage {
     /**
      * <p>The Amazon Resource Name (ARN) of the source DB instance or DB cluster if this DB
      *             cluster is created as a read replica.</p>
-     *          <p>Valid for: Aurora DB clusters and RDS for PostgreSQL Multi-AZ DB clusters</p>
+     *          <p>Valid for: Aurora DB clusters and Multi-AZ DB clusters</p>
      */
     ReplicationSourceIdentifier?: string;
     /**
@@ -3895,14 +3915,19 @@ export interface DomainMembership {
 }
 /**
  * @public
+ * @enum
  */
-export declare enum WriteForwardingStatus {
-    DISABLED = "disabled",
-    DISABLING = "disabling",
-    ENABLED = "enabled",
-    ENABLING = "enabling",
-    UNKNOWN = "unknown"
-}
+export declare const WriteForwardingStatus: {
+    readonly DISABLED: "disabled";
+    readonly DISABLING: "disabling";
+    readonly ENABLED: "enabled";
+    readonly ENABLING: "enabling";
+    readonly UNKNOWN: "unknown";
+};
+/**
+ * @public
+ */
+export type WriteForwardingStatus = (typeof WriteForwardingStatus)[keyof typeof WriteForwardingStatus];
 /**
  * @public
  * <p>Contains the secret managed by RDS in Amazon Web Services Secrets Manager for the master user password.</p>
@@ -6156,11 +6181,16 @@ export interface DBInstanceRole {
 }
 /**
  * @public
+ * @enum
  */
-export declare enum AutomationMode {
-    ALL_PAUSED = "all-paused",
-    FULL = "full"
-}
+export declare const AutomationMode: {
+    readonly ALL_PAUSED: "all-paused";
+    readonly FULL: "full";
+};
+/**
+ * @public
+ */
+export type AutomationMode = (typeof AutomationMode)[keyof typeof AutomationMode];
 /**
  * @public
  * <p>Returns the details of the DB instance’s server certificate.</p>
@@ -6502,11 +6532,16 @@ export interface PendingModifiedValues {
 }
 /**
  * @public
+ * @enum
  */
-export declare enum ReplicaMode {
-    MOUNTED = "mounted",
-    OPEN_READ_ONLY = "open-read-only"
-}
+export declare const ReplicaMode: {
+    readonly MOUNTED: "mounted";
+    readonly OPEN_READ_ONLY: "open-read-only";
+};
+/**
+ * @public
+ */
+export type ReplicaMode = (typeof ReplicaMode)[keyof typeof ReplicaMode];
 /**
  * @public
  * <p>Provides a list of status information for a DB instance.</p>
@@ -7031,6 +7066,11 @@ export interface DBInstance {
      * <p>The details of the DB instance's server certificate.</p>
      */
     CertificateDetails?: CertificateDetails;
+    /**
+     * <p>Contains the identifier of the source DB cluster if this DB instance is a read
+     *             replica.</p>
+     */
+    ReadReplicaSourceDBClusterIdentifier?: string;
 }
 /**
  * @public
@@ -7119,7 +7159,8 @@ export interface CreateDBInstanceReadReplicaMessage {
     DBInstanceIdentifier: string | undefined;
     /**
      * <p>The identifier of the DB instance that will act as the source for the read replica.
-     *             Each DB instance can have up to five read replicas.</p>
+     *             Each DB instance can have up to 15 read replicas, with the exception of Oracle and SQL
+     *             Server, which can have up to five.</p>
      *          <p>Constraints:</p>
      *          <ul>
      *             <li>
@@ -7127,20 +7168,15 @@ export interface CreateDBInstanceReadReplicaMessage {
      *                     instance.</p>
      *             </li>
      *             <li>
-     *                <p>Can specify a DB instance that is a MySQL read replica only if the source is running MySQL
-     *                     5.6 or later.</p>
+     *                <p>Can't be specified if the <code>SourceDBClusterIdentifier</code> parameter is
+     *                     also specified.</p>
      *             </li>
      *             <li>
-     *                <p>For the limitations of Oracle read replicas, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-read-replicas.html">Read Replica Limitations with Oracle</a> in the
+     *                <p>For the limitations of Oracle read replicas, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-read-replicas.limitations.html#oracle-read-replicas.limitations.versions-and-licenses">Version and licensing considerations for RDS for Oracle replicas</a> in the
      *                   <i>Amazon RDS User Guide</i>.</p>
      *             </li>
      *             <li>
-     *                <p>For the limitations of SQL Server read replicas, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/SQLServer.ReadReplicas.Limitations.html">Read Replica
-     *                         Limitations with Microsoft SQL Server</a> in the <i>Amazon RDS User Guide</i>.</p>
-     *             </li>
-     *             <li>
-     *                <p>Can specify a PostgreSQL DB instance only if the source is running PostgreSQL 9.3.5 or
-     *                     later (9.4.7 and higher for cross-Region replication).</p>
+     *                <p>For the limitations of SQL Server read replicas, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/SQLServer.ReadReplicas.html#SQLServer.ReadReplicas.Limitations">Read replica limitations with SQL Server</a> in the <i>Amazon RDS User Guide</i>.</p>
      *             </li>
      *             <li>
      *                <p>The specified DB instance must have automatic backups enabled, that is, its backup
@@ -7151,14 +7187,14 @@ export interface CreateDBInstanceReadReplicaMessage {
      *                     instance identifier.</p>
      *             </li>
      *             <li>
-     *                <p>If the source DB instance is in a different Amazon Web Services Region from the read replica, specify a valid DB instance ARN.
-     *              For more information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.ARN.html#USER_Tagging.ARN.Constructing">Constructing an ARN for Amazon RDS</a>
-     *              in the <i>Amazon RDS User Guide</i>. This doesn't apply to SQL Server or RDS Custom, which don't support
-     *              cross-Region replicas.</p>
+     *                <p>If the source DB instance is in a different Amazon Web Services Region from the read
+     *                     replica, specify a valid DB instance ARN. For more information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.ARN.html#USER_Tagging.ARN.Constructing">Constructing an ARN for Amazon RDS</a> in the <i>Amazon RDS User
+     *                         Guide</i>. This doesn't apply to SQL Server or RDS Custom, which
+     *                     don't support cross-Region replicas.</p>
      *             </li>
      *          </ul>
      */
-    SourceDBInstanceIdentifier: string | undefined;
+    SourceDBInstanceIdentifier?: string;
     /**
      * <p>The compute and memory capacity of the read replica, for example
      *                 db.m4.large. Not all DB instance classes are available in all Amazon Web Services
@@ -7184,10 +7220,10 @@ export interface CreateDBInstanceReadReplicaMessage {
     Port?: number;
     /**
      * <p>A value that indicates whether the read replica is in a Multi-AZ deployment.</p>
-     *          <p>You can create a read replica as a Multi-AZ DB instance. RDS creates a standby of
-     *             your replica in another Availability Zone for failover support for the replica. Creating
-     *             your read replica as a Multi-AZ DB instance is independent of whether the source
-     *             database is a Multi-AZ DB instance.</p>
+     *          <p>You can create a read replica as a Multi-AZ DB instance. RDS creates a standby of your
+     *             replica in another Availability Zone for failover support for the replica. Creating your
+     *             read replica as a Multi-AZ DB instance is independent of whether the source is a
+     *             Multi-AZ DB instance or a Multi-AZ DB cluster.</p>
      *          <p>This setting doesn't apply to RDS Custom.</p>
      */
     MultiAZ?: boolean;
@@ -7203,10 +7239,10 @@ export interface CreateDBInstanceReadReplicaMessage {
      */
     Iops?: number;
     /**
-     * <p>The option group the DB instance is associated with. If omitted, the option group associated with the source instance is used.</p>
+     * <p>The option group the DB instance is associated with. If omitted, the option group
+     *             associated with the source instance or cluster is used.</p>
      *          <note>
-     *             <p>For SQL Server, you must use the option group associated with the source
-     *                 instance.</p>
+     *             <p>For SQL Server, you must use the option group associated with the source.</p>
      *          </note>
      *          <p>This setting doesn't apply to RDS Custom.</p>
      */
@@ -7330,13 +7366,15 @@ export interface CreateDBInstanceReadReplicaMessage {
      * <p>The Amazon Web Services KMS key identifier for an encrypted read replica.</p>
      *          <p>The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.</p>
      *          <p>If you create an encrypted read replica in the same Amazon Web Services Region as the source DB
-     *             instance, then do not specify a value for this parameter. A read replica in the same Amazon Web Services Region
-     *             is always encrypted with the same KMS key as the source DB instance.</p>
+     *             instance or Multi-AZ DB cluster, don't specify a value for this parameter. A read
+     *             replica in the same Amazon Web Services Region is always encrypted with the same KMS key as the source
+     *             DB instance or cluster.</p>
      *          <p>If you create an encrypted read replica in a different Amazon Web Services Region, then you must
      *             specify a KMS key identifier for the destination Amazon Web Services Region. KMS keys are specific to
      *             the Amazon Web Services Region that they are created in, and you can't use KMS keys from one
      *             Amazon Web Services Region in another Amazon Web Services Region.</p>
-     *          <p>You can't create an encrypted read replica from an unencrypted DB instance.</p>
+     *          <p>You can't create an encrypted read replica from an unencrypted DB instance or
+     *             Multi-AZ DB cluster.</p>
      *          <p>This setting doesn't apply to RDS Custom, which uses the same KMS key as the primary
      *             replica.</p>
      */
@@ -7348,6 +7386,8 @@ export interface CreateDBInstanceReadReplicaMessage {
      *             source Amazon Web Services Region that contains the source DB instance.</p>
      *          <p>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.</p>
+     *          <p>This setting applies only when replicating from a source DB
+     *                 <i>instance</i>. Source DB clusters aren't supported in Amazon Web Services GovCloud (US) Regions and China Amazon Web Services Regions.</p>
      *          <p>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
      *                 <code>PreSignedUrl</code> when you are creating an encrypted read replica in the
@@ -7381,11 +7421,11 @@ export interface CreateDBInstanceReadReplicaMessage {
      *             </li>
      *             <li>
      *                <p>
-     *                   <code>SourceDBInstanceIdentifier</code> - 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 <code>SourceDBInstanceIdentifier</code> looks like the
+     *                   <code>SourceDBInstanceIdentifier</code> - 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 <code>SourceDBInstanceIdentifier</code> looks like the
      *                     following example:
      *                         <code>arn:aws:rds:us-west-2:123456789012:instance:mysql-instance1-20161115</code>.</p>
      *             </li>
@@ -7500,7 +7540,8 @@ export interface CreateDBInstanceReadReplicaMessage {
      */
     Domain?: string;
     /**
-     * <p>Specify the name of the IAM role to be used when making API calls to the Directory Service.</p>
+     * <p>The name of the IAM role to be used when making API calls to the Directory
+     *             Service.</p>
      *          <p>This setting doesn't apply to RDS Custom.</p>
      */
     DomainIAMRoleName?: string;
@@ -7599,6 +7640,29 @@ export interface CreateDBInstanceReadReplicaMessage {
      *          </note>
      */
     AllocatedStorage?: number;
+    /**
+     * <p>The identifier of the Multi-AZ DB cluster that will act as the source for the read
+     *             replica. Each DB cluster can have up to 15 read replicas.</p>
+     *          <p>Constraints:</p>
+     *          <ul>
+     *             <li>
+     *                <p>Must be the identifier of an existing Multi-AZ DB cluster.</p>
+     *             </li>
+     *             <li>
+     *                <p>Can't be specified if the <code>SourceDBInstanceIdentifier</code> parameter is
+     *                     also specified.</p>
+     *             </li>
+     *             <li>
+     *                <p>The specified DB cluster must have automatic backups enabled, that is, its
+     *                     backup retention period must be greater than 0.</p>
+     *             </li>
+     *             <li>
+     *                <p>The source DB cluster must be in the same Amazon Web Services Region as the read replica.
+     *                     Cross-Region replication isn't supported.</p>
+     *             </li>
+     *          </ul>
+     */
+    SourceDBClusterIdentifier?: string;
 }
 /**
  * @public
@@ -7771,27 +7835,42 @@ export interface CreateDBParameterGroupResult {
 }
 /**
  * @public
+ * @enum
  */
-export declare enum AuthScheme {
-    SECRETS = "SECRETS"
-}
+export declare const AuthScheme: {
+    readonly SECRETS: "SECRETS";
+};
 /**
  * @public
  */
-export declare enum ClientPasswordAuthType {
-    MYSQL_NATIVE_PASSWORD = "MYSQL_NATIVE_PASSWORD",
-    POSTGRES_MD5 = "POSTGRES_MD5",
-    POSTGRES_SCRAM_SHA_256 = "POSTGRES_SCRAM_SHA_256",
-    SQL_SERVER_AUTHENTICATION = "SQL_SERVER_AUTHENTICATION"
-}
+export type AuthScheme = (typeof AuthScheme)[keyof typeof AuthScheme];
 /**
  * @public
+ * @enum
  */
-export declare enum IAMAuthMode {
-    DISABLED = "DISABLED",
-    ENABLED = "ENABLED",
-    REQUIRED = "REQUIRED"
-}
+export declare const ClientPasswordAuthType: {
+    readonly MYSQL_NATIVE_PASSWORD: "MYSQL_NATIVE_PASSWORD";
+    readonly POSTGRES_MD5: "POSTGRES_MD5";
+    readonly POSTGRES_SCRAM_SHA_256: "POSTGRES_SCRAM_SHA_256";
+    readonly SQL_SERVER_AUTHENTICATION: "SQL_SERVER_AUTHENTICATION";
+};
+/**
+ * @public
+ */
+export type ClientPasswordAuthType = (typeof ClientPasswordAuthType)[keyof typeof ClientPasswordAuthType];
+/**
+ * @public
+ * @enum
+ */
+export declare const IAMAuthMode: {
+    readonly DISABLED: "DISABLED";
+    readonly ENABLED: "ENABLED";
+    readonly REQUIRED: "REQUIRED";
+};
+/**
+ * @public
+ */
+export type IAMAuthMode = (typeof IAMAuthMode)[keyof typeof IAMAuthMode];
 /**
  * @public
  * <p>Specifies the details of authentication used by a proxy to log in as a specific database user.</p>
@@ -7826,12 +7905,17 @@ export interface UserAuthConfig {
 }
 /**
  * @public
+ * @enum
  */
-export declare enum EngineFamily {
-    MYSQL = "MYSQL",
-    POSTGRESQL = "POSTGRESQL",
-    SQLSERVER = "SQLSERVER"
-}
+export declare const EngineFamily: {
+    readonly MYSQL: "MYSQL";
+    readonly POSTGRESQL: "POSTGRESQL";
+    readonly SQLSERVER: "SQLSERVER";
+};
+/**
+ * @public
+ */
+export type EngineFamily = (typeof EngineFamily)[keyof typeof EngineFamily];
 /**
  * @public
  */
@@ -7922,18 +8006,23 @@ export interface UserAuthConfigInfo {
 }
 /**
  * @public
+ * @enum
  */
-export declare enum DBProxyStatus {
-    AVAILABLE = "available",
-    CREATING = "creating",
-    DELETING = "deleting",
-    INCOMPATIBLE_NETWORK = "incompatible-network",
-    INSUFFICIENT_RESOURCE_LIMITS = "insufficient-resource-limits",
-    MODIFYING = "modifying",
-    REACTIVATING = "reactivating",
-    SUSPENDED = "suspended",
-    SUSPENDING = "suspending"
-}
+export declare const DBProxyStatus: {
+    readonly AVAILABLE: "available";
+    readonly CREATING: "creating";
+    readonly DELETING: "deleting";
+    readonly INCOMPATIBLE_NETWORK: "incompatible-network";
+    readonly INSUFFICIENT_RESOURCE_LIMITS: "insufficient-resource-limits";
+    readonly MODIFYING: "modifying";
+    readonly REACTIVATING: "reactivating";
+    readonly SUSPENDED: "suspended";
+    readonly SUSPENDING: "suspending";
+};
+/**
+ * @public
+ */
+export type DBProxyStatus = (typeof DBProxyStatus)[keyof typeof DBProxyStatus];
 /**
  * @public
  * <p>The data structure representing a proxy managed by the RDS Proxy.</p>
@@ -8052,11 +8141,16 @@ export declare class DBProxyQuotaExceededFault extends __BaseException {
 }
 /**
  * @public
+ * @enum
  */
-export declare enum DBProxyEndpointTargetRole {
-    READ_ONLY = "READ_ONLY",
-    READ_WRITE = "READ_WRITE"
-}
+export declare const DBProxyEndpointTargetRole: {
+    readonly READ_ONLY: "READ_ONLY";
+    readonly READ_WRITE: "READ_WRITE";
+};
+/**
+ * @public
+ */
+export type DBProxyEndpointTargetRole = (typeof DBProxyEndpointTargetRole)[keyof typeof DBProxyEndpointTargetRole];
 /**
  * @public
  */
@@ -8095,15 +8189,20 @@ export interface CreateDBProxyEndpointRequest {
 }
 /**
  * @public
+ * @enum
  */
-export declare enum DBProxyEndpointStatus {
-    AVAILABLE = "available",
-    CREATING = "creating",
-    DELETING = "deleting",
-    INCOMPATIBLE_NETWORK = "incompatible-network",
-    INSUFFICIENT_RESOURCE_LIMITS = "insufficient-resource-limits",
-    MODIFYING = "modifying"
-}
+export declare const DBProxyEndpointStatus: {
+    readonly AVAILABLE: "available";
+    readonly CREATING: "creating";
+    readonly DELETING: "deleting";
+    readonly INCOMPATIBLE_NETWORK: "incompatible-network";
+    readonly INSUFFICIENT_RESOURCE_LIMITS: "insufficient-resource-limits";
+    readonly MODIFYING: "modifying";
+};
+/**
+ * @public
+ */
+export type DBProxyEndpointStatus = (typeof DBProxyEndpointStatus)[keyof typeof DBProxyEndpointStatus];
 /**
  * @public
  * <p>The data structure representing an endpoint associated with a DB proxy. RDS automatically creates one
@@ -8633,12 +8732,17 @@ export interface CreateGlobalClusterMessage {
 }
 /**
  * @public
+ * @enum
  */
-export declare enum FailoverStatus {
-    CANCELLING = "cancelling",
-    FAILING_OVER = "failing-over",
-    PENDING = "pending"
-}
+export declare const FailoverStatus: {
+    readonly CANCELLING: "cancelling";
+    readonly FAILING_OVER: "failing-over";
+    readonly PENDING: "pending";
+};
+/**
+ * @public
+ */
+export type FailoverStatus = (typeof FailoverStatus)[keyof typeof FailoverStatus];
 /**
  * @public
  * <p>Contains the state of scheduled or in-process failover operations on an
@@ -10182,11 +10286,16 @@ export interface DescribeDBClusterParameterGroupsMessage {
 }
 /**
  * @public
+ * @enum
  */
-export declare enum ApplyMethod {
-    immediate = "immediate",
-    pending_reboot = "pending-reboot"
-}
+export declare const ApplyMethod: {
+    readonly immediate: "immediate";
+    readonly pending_reboot: "pending-reboot";
+};
+/**
+ * @public
+ */
+export type ApplyMethod = (typeof ApplyMethod)[keyof typeof ApplyMethod];
 /**
  * @public
  * <p>This data type is used as a request parameter in the