aws-sdk-rds 1.110.0 → 1.115.0

data/lib/aws-sdk-rds/types.rb

@@ -960,14 +960,7 @@ module Aws::RDS
     #
     #   * Must specify a valid DB cluster parameter group.
     #
-    #   * If the source DB cluster parameter group is in the same AWS Region
-    #     as the copy, specify a valid DB parameter group identifier, for
-    #     example `my-db-cluster-param-group`, or a valid ARN.
-    #
-    #   * If the source DB parameter group is in a different AWS Region than
-    #     the copy, specify a valid DB cluster parameter group ARN, for
-    #     example
-    #     `arn:aws:rds:us-east-1:123456789012:cluster-pg:custom-cluster-group1`.
+    #   ^
     #
     #
     #
@@ -1237,8 +1230,7 @@ module Aws::RDS
     #
     #   * Must specify a valid DB parameter group.
     #
-    #   * Must specify a valid DB parameter group identifier, for example
-    #     `my-db-param-group`, or a valid ARN.
+    #   ^
     #
     #
     #
@@ -2101,7 +2093,7 @@ module Aws::RDS
     #
     #   **Aurora PostgreSQL**
     #
-    #   Possible values are `postgresql` and `upgrade`.
+    #   Possible value is `postgresql`.
     #
     #
     #
@@ -2109,7 +2101,7 @@ module Aws::RDS
     #   @return [Array<String>]
     #
     # @!attribute [rw] engine_mode
-    #   The DB engine mode of the DB cluster, either `provisioned`
+    #   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
@@ -2205,12 +2197,19 @@ module Aws::RDS
     #   @return [String]
     #
     # @!attribute [rw] enable_global_write_forwarding
-    #   A value that indicates whether to enable write operations to be
-    #   forwarded from this cluster to the primary cluster in an Aurora
-    #   global database. The resulting changes are replicated back to this
-    #   cluster. This parameter only applies to DB clusters that are
-    #   secondary clusters in an Aurora global database. By default, Aurora
-    #   disallows write operations for secondary clusters.
+    #   A value that indicates whether to enable this DB cluster to forward
+    #   write operations to the primary cluster of an Aurora global database
+    #   (GlobalCluster). By default, write operations are not allowed on
+    #   Aurora DB clusters that are secondary clusters in an Aurora global
+    #   database.
+    #
+    #   You can set this value only on Aurora DB clusters that are members
+    #   of an Aurora global database. With this parameter enabled, a
+    #   secondary cluster can forward writes to the current primary cluster
+    #   and the resulting changes are replicated back to this cluster. For
+    #   the primary DB cluster of an Aurora global database, this value is
+    #   used immediately if the primary is demoted by the
+    #   FailoverGlobalCluster API operation, but it does nothing until then.
     #   @return [Boolean]
     #
     # @!attribute [rw] source_region
@@ -2525,8 +2524,8 @@ module Aws::RDS
     #   **PostgreSQL**
     #
     #   The name of the database to create when the DB instance is created.
-    #   If this parameter isn't specified, no database is created in the DB
-    #   instance.
+    #   If this parameter isn't specified, a database named `postgres` is
+    #   created in the DB instance.
     #
     #   Constraints:
     #
@@ -2555,17 +2554,34 @@ module Aws::RDS
     #
     #   Not applicable. Must be null.
     #
-    #   **Amazon Aurora**
+    #   **Amazon Aurora MySQL**
     #
-    #   The name of the database to create when the primary instance of the
-    #   DB cluster is created. If this parameter isn't specified, no
-    #   database is created in the DB instance.
+    #   The name of the database to create when the primary DB instance of
+    #   the Aurora MySQL DB cluster is created. If this parameter isn't
+    #   specified for an Aurora MySQL DB cluster, no database is created in
+    #   the DB cluster.
     #
     #   Constraints:
     #
-    #   * Must contain 1 to 64 letters or numbers.
+    #   * It must contain 1 to 64 alphanumeric characters.
     #
-    #   * Can't be a word reserved by the specified database engine
+    #   * It can't be a word reserved by the database engine.
+    #
+    #   **Amazon Aurora PostgreSQL**
+    #
+    #   The name of the database to create when the primary DB instance of
+    #   the Aurora PostgreSQL DB cluster is created. If this parameter
+    #   isn't specified for an Aurora PostgreSQL DB cluster, a database
+    #   named `postgres` is created in the DB cluster.
+    #
+    #   Constraints:
+    #
+    #   * It must contain 1 to 63 alphanumeric characters.
+    #
+    #   * It must begin with a letter or an underscore. Subsequent
+    #     characters can be letters, underscores, or digits (0 to 9).
+    #
+    #   * It can't be a word reserved by the database engine.
     #   @return [String]
     #
     # @!attribute [rw] db_instance_identifier
@@ -3397,6 +3413,14 @@ module Aws::RDS
     # @!attribute [rw] max_allocated_storage
     #   The upper limit 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][1] in the *Amazon RDS User Guide*.
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIOPS.StorageTypes.html#USER_PIOPS.Autoscaling
     #   @return [Integer]
     #
     # @!attribute [rw] enable_customer_owned_ip
@@ -3972,6 +3996,14 @@ module Aws::RDS
     # @!attribute [rw] max_allocated_storage
     #   The upper limit 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][1] in the *Amazon RDS User Guide*.
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIOPS.StorageTypes.html#USER_PIOPS.Autoscaling
     #   @return [Integer]
     #
     # @!attribute [rw] source_region
@@ -4681,6 +4713,30 @@ module Aws::RDS
     # @!attribute [rw] engine_name
     #   Specifies the name of the engine that this option group should be
     #   associated with.
+    #
+    #   Valid Values:
+    #
+    #   * `mariadb`
+    #
+    #   * `mysql`
+    #
+    #   * `oracle-ee`
+    #
+    #   * `oracle-se2`
+    #
+    #   * `oracle-se1`
+    #
+    #   * `oracle-se`
+    #
+    #   * `postgres`
+    #
+    #   * `sqlserver-ee`
+    #
+    #   * `sqlserver-se`
+    #
+    #   * `sqlserver-ex`
+    #
+    #   * `sqlserver-web`
     #   @return [String]
     #
     # @!attribute [rw] major_engine_version
@@ -5744,7 +5800,13 @@ module Aws::RDS
     #   @return [Time]
     #
     # @!attribute [rw] engine
-    #   Specifies the name of the database engine.
+    #   Specifies the name of the database engine for this DB cluster
+    #   snapshot.
+    #   @return [String]
+    #
+    # @!attribute [rw] engine_mode
+    #   Provides the engine mode of the database engine for this DB cluster
+    #   snapshot.
     #   @return [String]
     #
     # @!attribute [rw] allocated_storage
@@ -5770,7 +5832,7 @@ module Aws::RDS
     #   @return [Time]
     #
     # @!attribute [rw] master_username
-    #   Provides the master username for the DB cluster snapshot.
+    #   Provides the master username for this DB cluster snapshot.
     #   @return [String]
     #
     # @!attribute [rw] engine_version
@@ -5835,6 +5897,7 @@ module Aws::RDS
       :db_cluster_identifier,
       :snapshot_create_time,
       :engine,
+      :engine_mode,
       :allocated_storage,
       :status,
       :port,
@@ -6517,6 +6580,10 @@ module Aws::RDS
     #   [2]: https://docs.aws.amazon.com/outposts/latest/userguide/outposts-networking-components.html#ip-addressing
     #   @return [Boolean]
     #
+    # @!attribute [rw] aws_backup_recovery_point_arn
+    #   The Amazon Resource Name (ARN) of the recovery point in AWS Backup.
+    #   @return [String]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DBInstance AWS API Documentation
     #
     class DBInstance < Struct.new(
@@ -6582,7 +6649,8 @@ module Aws::RDS
       :max_allocated_storage,
       :tag_list,
       :db_instance_automated_backups_replications,
-      :customer_owned_ip_enabled)
+      :customer_owned_ip_enabled,
+      :aws_backup_recovery_point_arn)
       SENSITIVE = []
       include Aws::Structure
     end
@@ -9211,6 +9279,36 @@ module Aws::RDS
     #
     # @!attribute [rw] engine
     #   The database engine to return.
+    #
+    #   Valid Values:
+    #
+    #   * `aurora` (for MySQL 5.6-compatible Aurora)
+    #
+    #   * `aurora-mysql` (for MySQL 5.7-compatible Aurora)
+    #
+    #   * `aurora-postgresql`
+    #
+    #   * `mariadb`
+    #
+    #   * `mysql`
+    #
+    #   * `oracle-ee`
+    #
+    #   * `oracle-se2`
+    #
+    #   * `oracle-se1`
+    #
+    #   * `oracle-se`
+    #
+    #   * `postgres`
+    #
+    #   * `sqlserver-ee`
+    #
+    #   * `sqlserver-se`
+    #
+    #   * `sqlserver-ex`
+    #
+    #   * `sqlserver-web`
     #   @return [String]
     #
     # @!attribute [rw] engine_version
@@ -10809,6 +10907,30 @@ module Aws::RDS
     # @!attribute [rw] engine_name
     #   A required parameter. Options available for the given engine name
     #   are described.
+    #
+    #   Valid Values:
+    #
+    #   * `mariadb`
+    #
+    #   * `mysql`
+    #
+    #   * `oracle-ee`
+    #
+    #   * `oracle-se2`
+    #
+    #   * `oracle-se1`
+    #
+    #   * `oracle-se`
+    #
+    #   * `postgres`
+    #
+    #   * `sqlserver-ee`
+    #
+    #   * `sqlserver-se`
+    #
+    #   * `sqlserver-ex`
+    #
+    #   * `sqlserver-web`
     #   @return [String]
     #
     # @!attribute [rw] major_engine_version
@@ -10896,6 +11018,30 @@ module Aws::RDS
     # @!attribute [rw] engine_name
     #   Filters the list of option groups to only include groups associated
     #   with a specific database engine.
+    #
+    #   Valid Values:
+    #
+    #   * `mariadb`
+    #
+    #   * `mysql`
+    #
+    #   * `oracle-ee`
+    #
+    #   * `oracle-se2`
+    #
+    #   * `oracle-se1`
+    #
+    #   * `oracle-se`
+    #
+    #   * `postgres`
+    #
+    #   * `sqlserver-ee`
+    #
+    #   * `sqlserver-se`
+    #
+    #   * `sqlserver-ex`
+    #
+    #   * `sqlserver-web`
     #   @return [String]
     #
     # @!attribute [rw] major_engine_version
@@ -10939,6 +11085,36 @@ module Aws::RDS
     #
     # @!attribute [rw] engine
     #   The name of the engine to retrieve DB instance options for.
+    #
+    #   Valid Values:
+    #
+    #   * `aurora` (for MySQL 5.6-compatible Aurora)
+    #
+    #   * `aurora-mysql` (for MySQL 5.7-compatible Aurora)
+    #
+    #   * `aurora-postgresql`
+    #
+    #   * `mariadb`
+    #
+    #   * `mysql`
+    #
+    #   * `oracle-ee`
+    #
+    #   * `oracle-se2`
+    #
+    #   * `oracle-se1`
+    #
+    #   * `oracle-se`
+    #
+    #   * `postgres`
+    #
+    #   * `sqlserver-ee`
+    #
+    #   * `sqlserver-se`
+    #
+    #   * `sqlserver-ex`
+    #
+    #   * `sqlserver-web`
     #   @return [String]
     #
     # @!attribute [rw] engine_version
@@ -12021,6 +12197,103 @@ module Aws::RDS
       include Aws::Structure
     end
 
+    # @note When making an API call, you may pass FailoverGlobalClusterMessage
+    #   data as a hash:
+    #
+    #       {
+    #         global_cluster_identifier: "GlobalClusterIdentifier", # required
+    #         target_db_cluster_identifier: "DBClusterIdentifier", # required
+    #       }
+    #
+    # @!attribute [rw] global_cluster_identifier
+    #   Identifier of the Aurora global database (GlobalCluster) that should
+    #   be failed over. The identifier is the unique key assigned by the
+    #   user when the Aurora global database was created. In other words,
+    #   it's the name of the Aurora global database that you want to fail
+    #   over.
+    #
+    #   Constraints:
+    #
+    #   * Must match the identifier of an existing GlobalCluster (Aurora
+    #     global database).
+    #
+    #   ^
+    #   @return [String]
+    #
+    # @!attribute [rw] target_db_cluster_identifier
+    #   Identifier of the secondary Aurora DB cluster that you want to
+    #   promote to primary for the Aurora global database (GlobalCluster.)
+    #   Use the Amazon Resource Name (ARN) for the identifier so that Aurora
+    #   can locate the cluster in its AWS Region.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/FailoverGlobalClusterMessage AWS API Documentation
+    #
+    class FailoverGlobalClusterMessage < Struct.new(
+      :global_cluster_identifier,
+      :target_db_cluster_identifier)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] global_cluster
+    #   A data type representing an Aurora global database.
+    #   @return [Types::GlobalCluster]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/FailoverGlobalClusterResult AWS API Documentation
+    #
+    class FailoverGlobalClusterResult < Struct.new(
+      :global_cluster)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # Contains the state of scheduled or in-process failover operations on
+    # an Aurora global database (GlobalCluster). This Data type is empty
+    # unless a failover operation is scheduled or is currently underway on
+    # the Aurora global database.
+    #
+    # @!attribute [rw] status
+    #   The current status of the Aurora global database (GlobalCluster).
+    #   Possible values are as follows:
+    #
+    #   * pending – A request to fail over the Aurora global database
+    #     (GlobalCluster) has been received by the service. The
+    #     `GlobalCluster`'s primary DB cluster and the specified secondary
+    #     DB cluster are being verified before the failover process can
+    #     start.
+    #
+    #   * failing-over – This status covers the range of Aurora internal
+    #     operations that take place during the failover process, such as
+    #     demoting the primary Aurora DB cluster, promoting the secondary
+    #     Aurora DB, and synchronizing replicas.
+    #
+    #   * cancelling – The request to fail over the Aurora global database
+    #     (GlobalCluster) was cancelled and the primary Aurora DB cluster
+    #     and the selected secondary Aurora DB cluster are returning to
+    #     their previous states.
+    #   @return [String]
+    #
+    # @!attribute [rw] from_db_cluster_arn
+    #   The Amazon Resource Name (ARN) of the Aurora DB cluster that is
+    #   currently being demoted, and which is associated with this state.
+    #   @return [String]
+    #
+    # @!attribute [rw] to_db_cluster_arn
+    #   The Amazon Resource Name (ARN) of the Aurora DB cluster that is
+    #   currently being promoted, and which is associated with this state.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/FailoverState AWS API Documentation
+    #
+    class FailoverState < Struct.new(
+      :status,
+      :from_db_cluster_arn,
+      :to_db_cluster_arn)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # A filter name and value pair that is used to return a more specific
     # list of results from a describe operation. Filters can be used to
     # match a set of resources by specific criteria, such as IDs. The
@@ -12116,6 +12389,14 @@ module Aws::RDS
     #   database cluster. Currently limited to 1 item.
     #   @return [Array<Types::GlobalClusterMember>]
     #
+    # @!attribute [rw] failover_state
+    #   A data object containing all properties for the current state of an
+    #   in-process or pending failover process for this Aurora global
+    #   database. This object is empty unless the FailoverGlobalCluster API
+    #   operation has been called on this Aurora global database
+    #   (GlobalCluster).
+    #   @return [Types::FailoverState]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/GlobalCluster AWS API Documentation
     #
     class GlobalCluster < Struct.new(
@@ -12128,7 +12409,8 @@ module Aws::RDS
       :database_name,
       :storage_encrypted,
       :deletion_protection,
-      :global_cluster_members)
+      :global_cluster_members,
+      :failover_state)
       SENSITIVE = []
       include Aws::Structure
     end
@@ -13156,12 +13438,19 @@ module Aws::RDS
     #   @return [Boolean]
     #
     # @!attribute [rw] enable_global_write_forwarding
-    #   A value that indicates whether to enable write operations to be
-    #   forwarded from this cluster to the primary cluster in an Aurora
-    #   global database. The resulting changes are replicated back to this
-    #   cluster. This parameter only applies to DB clusters that are
-    #   secondary clusters in an Aurora global database. By default, Aurora
-    #   disallows write operations for secondary clusters.
+    #   A value that indicates whether to enable this DB cluster to forward
+    #   write operations to the primary cluster of an Aurora global database
+    #   (GlobalCluster). By default, write operations are not allowed on
+    #   Aurora DB clusters that are secondary clusters in an Aurora global
+    #   database.
+    #
+    #   You can set this value only on Aurora DB clusters that are members
+    #   of an Aurora global database. With this parameter enabled, a
+    #   secondary cluster can forward writes to the current primary cluster
+    #   and the resulting changes are replicated back to this cluster. For
+    #   the primary DB cluster of an Aurora global database, this value is
+    #   used immediately if the primary is demoted by the
+    #   FailoverGlobalCluster API operation, but it does nothing until then.
     #   @return [Boolean]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/ModifyDBClusterMessage AWS API Documentation
@@ -13386,6 +13675,7 @@ module Aws::RDS
     #         certificate_rotation_restart: false,
     #         replica_mode: "open-read-only", # accepts open-read-only, mounted
     #         enable_customer_owned_ip: false,
+    #         aws_backup_recovery_point_arn: "AwsBackupRecoveryPointArn",
     #       }
     #
     # @!attribute [rw] db_instance_identifier
@@ -14026,6 +14316,14 @@ module Aws::RDS
     # @!attribute [rw] max_allocated_storage
     #   The upper limit 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][1] in the *Amazon RDS User Guide*.
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIOPS.StorageTypes.html#USER_PIOPS.Autoscaling
     #   @return [Integer]
     #
     # @!attribute [rw] certificate_rotation_restart
@@ -14100,6 +14398,10 @@ module Aws::RDS
     #   [2]: https://docs.aws.amazon.com/outposts/latest/userguide/outposts-networking-components.html#ip-addressing
     #   @return [Boolean]
     #
+    # @!attribute [rw] aws_backup_recovery_point_arn
+    #   The Amazon Resource Name (ARN) of the recovery point in AWS Backup.
+    #   @return [String]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/ModifyDBInstanceMessage AWS API Documentation
     #
     class ModifyDBInstanceMessage < Struct.new(
@@ -14146,7 +14448,8 @@ module Aws::RDS
       :max_allocated_storage,
       :certificate_rotation_restart,
       :replica_mode,
-      :enable_customer_owned_ip)
+      :enable_customer_owned_ip,
+      :aws_backup_recovery_point_arn)
       SENSITIVE = []
       include Aws::Structure
     end
@@ -18770,6 +19073,14 @@ module Aws::RDS
     # @!attribute [rw] max_allocated_storage
     #   The upper limit 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][1] in the *Amazon RDS User Guide*.
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIOPS.StorageTypes.html#USER_PIOPS.Autoscaling
     #   @return [Integer]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/RestoreDBInstanceFromS3Message AWS API Documentation
@@ -19212,6 +19523,14 @@ module Aws::RDS
     # @!attribute [rw] max_allocated_storage
     #   The upper limit 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][1] in the *Amazon RDS User Guide*.
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIOPS.StorageTypes.html#USER_PIOPS.Autoscaling
     #   @return [Integer]
     #
     # @!attribute [rw] source_db_instance_automated_backups_arn
@@ -20313,8 +20632,23 @@ module Aws::RDS
     #   @return [Boolean]
     #
     # @!attribute [rw] is_major_version_upgrade
-    #   A value that indicates whether a database engine is upgraded to a
-    #   major version.
+    #   A value that indicates whether upgrading to the target version
+    #   requires upgrading the major version of the database engine.
+    #   @return [Boolean]
+    #
+    # @!attribute [rw] supported_engine_modes
+    #   A list of the supported DB engine modes for the target engine
+    #   version.
+    #   @return [Array<String>]
+    #
+    # @!attribute [rw] supports_parallel_query
+    #   A value that indicates whether you can use Aurora parallel query
+    #   with the target engine version.
+    #   @return [Boolean]
+    #
+    # @!attribute [rw] supports_global_databases
+    #   A value that indicates whether you can use Aurora global databases
+    #   with the target engine version.
     #   @return [Boolean]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/UpgradeTarget AWS API Documentation
@@ -20324,7 +20658,10 @@ module Aws::RDS
       :engine_version,
       :description,
       :auto_upgrade,
-      :is_major_version_upgrade)
+      :is_major_version_upgrade,
+      :supported_engine_modes,
+      :supports_parallel_query,
+      :supports_global_databases)
       SENSITIVE = []
       include Aws::Structure
     end