aws-sdk-rds 1.54.0 → 1.55.0

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

@@ -1018,6 +1018,7 @@ module Aws::RDS
     DBEngineVersion.add_member(:supports_read_replica, Shapes::ShapeRef.new(shape: Boolean, location_name: "SupportsReadReplica"))
     DBEngineVersion.add_member(:supported_engine_modes, Shapes::ShapeRef.new(shape: EngineModeList, location_name: "SupportedEngineModes"))
     DBEngineVersion.add_member(:supported_feature_names, Shapes::ShapeRef.new(shape: FeatureNameList, location_name: "SupportedFeatureNames"))
+    DBEngineVersion.add_member(:status, Shapes::ShapeRef.new(shape: String, location_name: "Status"))
     DBEngineVersion.struct_class = Types::DBEngineVersion
 
     DBEngineVersionList.member = Shapes::ShapeRef.new(shape: DBEngineVersion, location_name: "DBEngineVersion")
@@ -1376,6 +1377,7 @@ module Aws::RDS
     DescribeDBEngineVersionsMessage.add_member(:default_only, Shapes::ShapeRef.new(shape: Boolean, location_name: "DefaultOnly"))
     DescribeDBEngineVersionsMessage.add_member(:list_supported_character_sets, Shapes::ShapeRef.new(shape: BooleanOptional, location_name: "ListSupportedCharacterSets"))
     DescribeDBEngineVersionsMessage.add_member(:list_supported_timezones, Shapes::ShapeRef.new(shape: BooleanOptional, location_name: "ListSupportedTimezones"))
+    DescribeDBEngineVersionsMessage.add_member(:include_all, Shapes::ShapeRef.new(shape: BooleanOptional, location_name: "IncludeAll"))
     DescribeDBEngineVersionsMessage.struct_class = Types::DescribeDBEngineVersionsMessage
 
     DescribeDBInstanceAutomatedBackupsMessage.add_member(:dbi_resource_id, Shapes::ShapeRef.new(shape: String, location_name: "DbiResourceId"))

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

@@ -231,7 +231,7 @@ module Aws::RDS
       data[:storage_encrypted]
     end
 
-    # If `StorageEncrypted` is enabled, the AWS KMS key identifier for the
+    # If `StorageEncrypted` is true, the AWS KMS key identifier for the
     # encrypted DB cluster.
     # @return [String]
     def kms_key_id
@@ -261,8 +261,8 @@ module Aws::RDS
       data[:associated_roles]
     end
 
-    # A value that indicates whether the mapping of AWS Identity and Access
-    # Management (IAM) accounts to database accounts is enabled.
+    # True if mapping of AWS Identity and Access Management (IAM) accounts
+    # to database accounts is enabled, and otherwise false.
     # @return [Boolean]
     def iam_database_authentication_enabled
       data[:iam_database_authentication_enabled]
@@ -352,7 +352,7 @@ module Aws::RDS
     end
 
     # Indicates if the DB cluster has deletion protection enabled. The
-    # database can't be deleted when deletion protection is enabled.
+    # database can't be deleted when this value is set to true.
     # @return [Boolean]
     def deletion_protection
       data[:deletion_protection]
@@ -363,8 +363,8 @@ module Aws::RDS
     #
     #  </note>
     #
-    # A value that indicates whether the HTTP endpoint for an Aurora
-    # Serverless DB cluster is enabled.
+    # Value that is `true` if the HTTP endpoint for an Aurora Serverless DB
+    # cluster is enabled and `false` otherwise.
     #
     # When enabled, the HTTP endpoint provides a connectionless web service
     # API for running SQL queries on the Aurora Serverless DB cluster. You
@@ -702,7 +702,7 @@ module Aws::RDS
     # @option options [Array<Types::Tag>] :tags
     #   Tags to assign to the DB cluster.
     # @option options [Boolean] :storage_encrypted
-    #   A value that indicates whether the DB cluster is encrypted.
+    #   Specifies whether the DB cluster is encrypted.
     # @option options [String] :kms_key_id
     #   The AWS KMS key identifier for an encrypted DB cluster.
     #
@@ -718,7 +718,7 @@ module Aws::RDS
     #     then Amazon RDS will use the encryption key used to encrypt the
     #     source. Otherwise, Amazon RDS will use your default encryption key.
     #
-    #   * If the `StorageEncrypted` parameter is enabled and
+    #   * If the `StorageEncrypted` parameter is true and
     #     `ReplicationSourceIdentifier` is not specified, then Amazon RDS will
     #     use your default encryption key.
     #
@@ -770,9 +770,10 @@ module Aws::RDS
     #   [1]: https://docs.aws.amazon.com/AmazonS3/latest/API/sigv4-query-string-auth.html
     #   [2]: https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html
     # @option options [Boolean] :enable_iam_database_authentication
-    #   A value that indicates whether to enable mapping of AWS Identity and
-    #   Access Management (IAM) accounts to database accounts. By default,
-    #   mapping is disabled.
+    #   True to enable mapping of AWS Identity and Access Management (IAM)
+    #   accounts to database accounts, and otherwise false.
+    #
+    #   Default: `false`
     # @option options [Integer] :backtrack_window
     #   The target backtrack window, in seconds. To disable backtracking, set
     #   this value to 0.
@@ -801,15 +802,15 @@ module Aws::RDS
     #   For DB clusters in `serverless` DB engine mode, the scaling properties
     #   of the DB cluster.
     # @option options [Boolean] :deletion_protection
-    #   A value that indicates whether the DB cluster has deletion protection
-    #   enabled. The database can't be deleted when deletion protection is
-    #   enabled. By default, deletion protection is disabled.
+    #   Indicates whether the DB cluster should have deletion protection
+    #   enabled. The database can't be deleted when this value is set to
+    #   true. The default is false.
     # @option options [String] :global_cluster_identifier
     #   The global cluster ID of an Aurora cluster that becomes the primary
     #   cluster in the new global database cluster.
     # @option options [Boolean] :copy_tags_to_snapshot
-    #   A value that indicates whether to copy all tags from the DB cluster to
-    #   snapshots of the DB cluster. The default is not to copy them.
+    #   True to copy all tags from the DB cluster to snapshots of the DB
+    #   cluster, and otherwise false. The default is false.
     # @option options [String] :destination_region
     # @option options [String] :source_region
     #   The source region of the snapshot. This is only needed when the
@@ -872,24 +873,23 @@ module Aws::RDS
     #   })
     # @param [Hash] options ({})
     # @option options [Boolean] :skip_final_snapshot
-    #   A value that indicates whether to skip the creation of a final DB
-    #   cluster snapshot before the DB cluster is deleted. If skip is
-    #   specified, no DB cluster snapshot is created. If skip is not
-    #   specified, a DB cluster snapshot is created before the DB cluster is
-    #   deleted. By default, skip is not specified, and the DB cluster
-    #   snapshot is created. By default, this parameter is disabled.
+    #   Determines whether a final DB cluster snapshot is created before the
+    #   DB cluster is deleted. If `true` is specified, no DB cluster snapshot
+    #   is created. If `false` is specified, a DB cluster snapshot is created
+    #   before the DB cluster is deleted.
     #
     #   <note markdown="1"> You must specify a `FinalDBSnapshotIdentifier` parameter if
-    #   `SkipFinalSnapshot` is disabled.
+    #   `SkipFinalSnapshot` is `false`.
     #
     #    </note>
+    #
+    #   Default: `false`
     # @option options [String] :final_db_snapshot_identifier
     #   The DB cluster snapshot identifier of the new DB cluster snapshot
-    #   created when `SkipFinalSnapshot` is disabled.
+    #   created when `SkipFinalSnapshot` is set to `false`.
     #
-    #   <note markdown="1"> Specifying this parameter and also skipping the creation of a final DB
-    #   cluster snapshot with the `SkipFinalShapshot` parameter results in an
-    #   error.
+    #   <note markdown="1"> Specifying this parameter and also setting the `SkipFinalShapshot`
+    #   parameter to true results in an error.
     #
     #    </note>
     #
@@ -979,22 +979,22 @@ module Aws::RDS
     #
     #   Example: `my-cluster2`
     # @option options [Boolean] :apply_immediately
-    #   A value that indicates whether the modifications in this request and
+    #   A value that specifies whether the modifications in this request and
     #   any pending modifications are asynchronously applied as soon as
     #   possible, regardless of the `PreferredMaintenanceWindow` setting for
-    #   the DB cluster. If this parameter is disabled, changes to the DB
+    #   the DB cluster. If this parameter is set to `false`, changes to the DB
     #   cluster are applied during the next maintenance window.
     #
     #   The `ApplyImmediately` parameter only affects the
     #   `EnableIAMDatabaseAuthentication`, `MasterUserPassword`, and
-    #   `NewDBClusterIdentifier` values. If the `ApplyImmediately` parameter
-    #   is disabled, then changes to the `EnableIAMDatabaseAuthentication`,
-    #   `MasterUserPassword`, and `NewDBClusterIdentifier` values are applied
-    #   during the next maintenance window. All other changes are applied
-    #   immediately, regardless of the value of the `ApplyImmediately`
-    #   parameter.
+    #   `NewDBClusterIdentifier` values. If you set the `ApplyImmediately`
+    #   parameter value to false, then changes to the
+    #   `EnableIAMDatabaseAuthentication`, `MasterUserPassword`, and
+    #   `NewDBClusterIdentifier` values are applied during the next
+    #   maintenance window. All other changes are applied immediately,
+    #   regardless of the value of the `ApplyImmediately` parameter.
     #
-    #   By default, this parameter is disabled.
+    #   Default: `false`
     # @option options [Integer] :backup_retention_period
     #   The number of days for which automated backups are retained. You must
     #   specify a minimum value of 1.
@@ -1025,11 +1025,11 @@ module Aws::RDS
     #   A value that indicates that the DB cluster should be associated with
     #   the specified option group. Changing this parameter doesn't result in
     #   an outage except in the following case, and the change is applied
-    #   during the next maintenance window unless the `ApplyImmediately` is
-    #   enabled for this request. If the parameter change results in an option
-    #   group that enables OEM, this change can cause a brief (sub-second)
-    #   period during which new connections are rejected but existing
-    #   connections are not interrupted.
+    #   during the next maintenance window unless the `ApplyImmediately`
+    #   parameter is set to `true` for this request. If the parameter change
+    #   results in an option group that enables OEM, this change can cause a
+    #   brief (sub-second) period during which new connections are rejected
+    #   but existing connections are not interrupted.
     #
     #   Permanent options can't be removed from an option group. The option
     #   group can't be removed from a DB cluster once it is associated with a
@@ -1076,9 +1076,10 @@ module Aws::RDS
     #
     #   [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_UpgradeDBInstance.Maintenance.html#AdjustingTheMaintenanceWindow.Aurora
     # @option options [Boolean] :enable_iam_database_authentication
-    #   A value that indicates whether to enable mapping of AWS Identity and
-    #   Access Management (IAM) accounts to database accounts. By default,
-    #   mapping is disabled.
+    #   True to enable mapping of AWS Identity and Access Management (IAM)
+    #   accounts to database accounts, and otherwise false.
+    #
+    #   Default: `false`
     # @option options [Integer] :backtrack_window
     #   The target backtrack window, in seconds. To disable backtracking, set
     #   this value to 0.
@@ -1097,17 +1098,17 @@ module Aws::RDS
     # @option options [String] :engine_version
     #   The version number of the database engine to which you want to
     #   upgrade. Changing this parameter results in an outage. The change is
-    #   applied during the next maintenance window unless `ApplyImmediately`
-    #   is enabled.
+    #   applied during the next maintenance window unless the ApplyImmediately
+    #   parameter is set to true.
     #
-    #   For a list of valid engine versions, use DescribeDBEngineVersions.
+    #   For a list of valid engine versions, use the
+    #   `DescribeDBEngineVersions` action.
     # @option options [Types::ScalingConfiguration] :scaling_configuration
     #   The scaling properties of the DB cluster. You can only modify scaling
     #   properties for DB clusters in `serverless` DB engine mode.
     # @option options [Boolean] :deletion_protection
-    #   A value that indicates whether the DB cluster has deletion protection
-    #   enabled. The database can't be deleted when deletion protection is
-    #   enabled. By default, deletion protection is disabled.
+    #   Indicates if the DB cluster has deletion protection enabled. The
+    #   database can't be deleted when this value is set to true.
     # @option options [Boolean] :enable_http_endpoint
     #   <note markdown="1"> HTTP endpoint functionality is in beta for Aurora Serverless and is
     #   subject to change.
@@ -1130,8 +1131,8 @@ module Aws::RDS
     #
     #   [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless.html
     # @option options [Boolean] :copy_tags_to_snapshot
-    #   A value that indicates whether to copy all tags from the DB cluster to
-    #   snapshots of the DB cluster. The default is not to copy them.
+    #   True to copy all tags from the DB cluster to snapshots of the DB
+    #   cluster, and otherwise false. The default is false.
     # @return [DBCluster]
     def modify(options = {})
       options = options.merge(db_cluster_identifier: @id)
@@ -1207,17 +1208,16 @@ module Aws::RDS
     #   * Must be specified if `UseLatestRestorableTime` parameter is not
     #     provided
     #
-    #   * Can't be specified if the `UseLatestRestorableTime` parameter is
-    #     enabled
+    #   * Can't be specified if `UseLatestRestorableTime` parameter is true
     #
-    #   * Can't be specified if the `RestoreType` parameter is
-    #     `copy-on-write`
+    #   * Can't be specified if `RestoreType` parameter is `copy-on-write`
     #
     #   Example: `2015-03-07T23:45:00Z`
     # @option options [Boolean] :use_latest_restorable_time
-    #   A value that indicates whether to restore the DB cluster to the latest
-    #   restorable backup time. By default, the DB cluster is not restored to
-    #   the latest restorable backup time.
+    #   A value that is set to `true` to restore the DB cluster to the latest
+    #   restorable backup time, and `false` otherwise.
+    #
+    #   Default: `false`
     #
     #   Constraints: Can't be specified if `RestoreToTime` parameter is
     #   provided.
@@ -1273,9 +1273,10 @@ module Aws::RDS
     #   If `DBClusterIdentifier` refers to a DB cluster that is not encrypted,
     #   then the restore request is rejected.
     # @option options [Boolean] :enable_iam_database_authentication
-    #   A value that indicates whether to enable mapping of AWS Identity and
-    #   Access Management (IAM) accounts to database accounts. By default,
-    #   mapping is disabled.
+    #   True to enable mapping of AWS Identity and Access Management (IAM)
+    #   accounts to database accounts, and otherwise false.
+    #
+    #   Default: `false`
     # @option options [Integer] :backtrack_window
     #   The target backtrack window, in seconds. To disable backtracking, set
     #   this value to 0.
@@ -1313,13 +1314,12 @@ module Aws::RDS
     #
     #   * Can't end with a hyphen or contain two consecutive hyphens.
     # @option options [Boolean] :deletion_protection
-    #   A value that indicates whether the DB cluster has deletion protection
-    #   enabled. The database can't be deleted when deletion protection is
-    #   enabled. By default, deletion protection is disabled.
+    #   Indicates if the DB cluster should have deletion protection enabled.
+    #   The database can't be deleted when this value is set to true. The
+    #   default is false.
     # @option options [Boolean] :copy_tags_to_snapshot
-    #   A value that indicates whether to copy all tags from the restored DB
-    #   cluster to snapshots of the restored DB cluster. The default is not to
-    #   copy them.
+    #   True to copy all tags from the restored DB cluster to snapshots of the
+    #   restored DB cluster, and otherwise false. The default is false.
     # @return [DBCluster]
     def restore(options = {})
       options = options.merge(source_db_cluster_identifier: @id)
@@ -1486,9 +1486,9 @@ module Aws::RDS
     #
     #   If you don't specify a `SnapshotType` value, then both automated and
     #   manual DB cluster snapshots are returned. You can include shared DB
-    #   cluster snapshots with these results by enabling the `IncludeShared`
-    #   parameter. You can include public DB cluster snapshots with these
-    #   results by enabling the `IncludePublic` parameter.
+    #   cluster snapshots with these results by setting the `IncludeShared`
+    #   parameter to `true`. You can include public DB cluster snapshots with
+    #   these results by setting the `IncludePublic` parameter to `true`.
     #
     #   The `IncludeShared` and `IncludePublic` parameters don't apply for
     #   `SnapshotType` values of `manual` or `automated`. The `IncludePublic`
@@ -1512,21 +1512,20 @@ module Aws::RDS
     #   the response includes only records beyond the marker, up to the value
     #   specified by `MaxRecords`.
     # @option options [Boolean] :include_shared
-    #   A value that indicates whether to include shared manual DB cluster
-    #   snapshots from other AWS accounts that this AWS account has been given
-    #   permission to copy or restore. By default, these snapshots are not
-    #   included.
+    #   True to include shared manual DB cluster snapshots from other AWS
+    #   accounts that this AWS account has been given permission to copy or
+    #   restore, and otherwise false. The default is `false`.
     #
     #   You can give an AWS account permission to restore a manual DB cluster
     #   snapshot from another AWS account by the
     #   `ModifyDBClusterSnapshotAttribute` API action.
     # @option options [Boolean] :include_public
-    #   A value that indicates whether to include manual DB cluster snapshots
-    #   that are public and can be copied or restored by any AWS account. By
-    #   default, the public snapshots are not included.
+    #   True to include manual DB cluster snapshots that are public and can be
+    #   copied or restored by any AWS account, and otherwise false. The
+    #   default is `false`. The default is false.
     #
     #   You can share a manual DB cluster snapshot as public by using the
-    #   ModifyDBClusterSnapshotAttribute API action.
+    #   `ModifyDBClusterSnapshotAttribute` API action.
     # @return [DBClusterSnapshot::Collection]
     def snapshots(options = {})
       batches = Enumerator.new do |y|

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

@@ -290,14 +290,14 @@ module Aws::RDS
     #   })
     # @param [Hash] options ({})
     # @option options [Boolean] :reset_all_parameters
-    #   A value that indicates whether to reset all parameters in the DB
-    #   cluster parameter group to their default values. You can't use this
-    #   parameter if there is a list of parameter names specified for the
-    #   `Parameters` parameter.
+    #   A value that is set to `true` to reset all parameters in the DB
+    #   cluster parameter group to their default values, and `false`
+    #   otherwise. You can't use this parameter if there is a list of
+    #   parameter names specified for the `Parameters` parameter.
     # @option options [Array<Types::Parameter>] :parameters
     #   A list of parameter names in the DB cluster parameter group to reset
     #   to the default values. You can't use this parameter if the
-    #   `ResetAllParameters` parameter is enabled.
+    #   `ResetAllParameters` parameter is set to `true`.
     # @return [DBClusterParameterGroup]
     def reset(options = {})
       options = options.merge(db_cluster_parameter_group_name: @name)

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

@@ -410,9 +410,8 @@ module Aws::RDS
     #   [1]: https://docs.aws.amazon.com/AmazonS3/latest/API/sigv4-query-string-auth.html
     #   [2]: https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html
     # @option options [Boolean] :copy_tags
-    #   A value that indicates whether to copy all tags from the source DB
-    #   cluster snapshot to the target DB cluster snapshot. By default, tags
-    #   are not copied.
+    #   True to copy all tags from the source DB cluster snapshot to the
+    #   target DB cluster snapshot, and otherwise false. The default is false.
     # @option options [Array<Types::Tag>] :tags
     #   A list of tags. For more information, see [Tagging Amazon RDS
     #   Resources][1] in the *Amazon RDS User Guide.*
@@ -552,9 +551,10 @@ module Aws::RDS
     #   * If the DB snapshot or DB cluster snapshot in `SnapshotIdentifier` is
     #     not encrypted, then the restored DB cluster is not encrypted.
     # @option options [Boolean] :enable_iam_database_authentication
-    #   A value that indicates whether to enable mapping of AWS Identity and
-    #   Access Management (IAM) accounts to database accounts. By default,
-    #   mapping is disabled.
+    #   True to enable mapping of AWS Identity and Access Management (IAM)
+    #   accounts to database accounts, and otherwise false.
+    #
+    #   Default: `false`
     # @option options [Integer] :backtrack_window
     #   The target backtrack window, in seconds. To disable backtracking, set
     #   this value to 0.
@@ -598,13 +598,12 @@ module Aws::RDS
     #
     #   * Can't end with a hyphen or contain two consecutive hyphens.
     # @option options [Boolean] :deletion_protection
-    #   A value that indicates whether the DB cluster has deletion protection
-    #   enabled. The database can't be deleted when deletion protection is
-    #   enabled. By default, deletion protection is disabled.
+    #   Indicates if the DB cluster should have deletion protection enabled.
+    #   The database can't be deleted when this value is set to true. The
+    #   default is false.
     # @option options [Boolean] :copy_tags_to_snapshot
-    #   A value that indicates whether to copy all tags from the restored DB
-    #   cluster to snapshots of the restored DB cluster. The default is not to
-    #   copy them.
+    #   True to copy all tags from the restored DB cluster to snapshots of the
+    #   restored DB cluster, and otherwise false. The default is false.
     # @return [DBCluster]
     def restore(options = {})
       options = options.merge(snapshot_identifier: @snapshot_id)

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

@@ -258,6 +258,7 @@ module Aws::RDS
     #     default_only: false,
     #     list_supported_character_sets: false,
     #     list_supported_timezones: false,
+    #     include_all: false,
     #   })
     # @param [Hash] options ({})
     # @option options [String] :engine_version
@@ -276,22 +277,19 @@ module Aws::RDS
     # @option options [Array<Types::Filter>] :filters
     #   This parameter is not currently supported.
     # @option options [Boolean] :default_only
-    #   A value that indicates whether only the default version of the
-    #   specified engine or engine and major version combination is returned.
+    #   Indicates that only the default version of the specified engine or
+    #   engine and major version combination is returned.
     # @option options [Boolean] :list_supported_character_sets
-    #   A value that indicates whether to list the supported character sets
-    #   for each engine version.
-    #
-    #   If this parameter is enabled and the requested engine supports the
+    #   If this parameter is specified and the requested engine supports the
     #   `CharacterSetName` parameter for `CreateDBInstance`, the response
     #   includes a list of supported character sets for each engine version.
     # @option options [Boolean] :list_supported_timezones
-    #   A value that indicates whether to list the supported time zones for
-    #   each engine version.
-    #
-    #   If this parameter is enabled and the requested engine supports the
+    #   If this parameter is specified and the requested engine supports the
     #   `TimeZone` parameter for `CreateDBInstance`, the response includes a
     #   list of supported time zones for each engine version.
+    # @option options [Boolean] :include_all
+    #   Whether to include non-available engine versions in the list. The
+    #   default is to list only available engine versions.
     # @return [DBEngineVersion::Collection]
     def versions(options = {})
       batches = Enumerator.new do |y|

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

@@ -124,6 +124,13 @@ module Aws::RDS
       data[:supported_feature_names]
     end
 
+    # The status of the DB engine version, either `available` or
+    # `deprecated`.
+    # @return [String]
+    def status
+      data[:status]
+    end
+
     # @!endgroup
 
     # @return [Client]