lib/aws-sdk-rds/resource.rb in aws-sdk-rds-1.55.0 vs lib/aws-sdk-rds/resource.rb in aws-sdk-rds-1.56.0

- old
+ new

@@ -214,11 +214,11 @@ # The Amazon Resource Name (ARN) of the source DB instance or DB cluster # if this DB cluster is created as a Read Replica. # @option options [Array<Types::Tag>] :tags # Tags to assign to the DB cluster. # @option options [Boolean] :storage_encrypted - # Specifies whether the DB cluster is encrypted. + # A value that indicates whether the DB cluster is encrypted. # @option options [String] :kms_key_id # The AWS KMS key identifier for an encrypted DB cluster. # # The KMS key identifier is the Amazon Resource Name (ARN) for the KMS # encryption key. If you are creating a DB cluster with the same AWS @@ -230,11 +230,11 @@ # # * If `ReplicationSourceIdentifier` identifies an encrypted source, # 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 true and + # * If the `StorageEncrypted` parameter is enabled and # `ReplicationSourceIdentifier` is not specified, then Amazon RDS will # use your default encryption key. # # AWS KMS creates the default encryption key for your AWS account. Your # AWS account has a different default encryption key for each AWS @@ -282,14 +282,13 @@ # # # [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 - # True to enable mapping of AWS Identity and Access Management (IAM) - # accounts to database accounts, and otherwise false. - # - # Default: `false` + # A value that indicates whether to enable mapping of AWS Identity and + # Access Management (IAM) accounts to database accounts. By default, + # mapping is disabled. # @option options [Integer] :backtrack_window # The target backtrack window, in seconds. To disable backtracking, set # this value to 0. # # Default: 0 @@ -314,19 +313,19 @@ # `serverless`, `parallelquery`, or `global`. # @option options [Types::ScalingConfiguration] :scaling_configuration # For DB clusters in `serverless` DB engine mode, the scaling properties # of the DB cluster. # @option options [Boolean] :deletion_protection - # 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. + # 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. # @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 - # True to copy all tags from the DB cluster to snapshots of the DB - # cluster, and otherwise false. The default is false. + # 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. # @option options [String] :destination_region # @option options [String] :source_region # The source region of the snapshot. This is only needed when the # shapshot is encrypted and in a different region. # @return [DBCluster] @@ -553,53 +552,53 @@ # # Constraints to the amount of storage for each storage type are the # following: # # * General Purpose (SSD) storage (gp2): Must be an integer from 20 to - # 32768. + # 65536. # # * Provisioned IOPS storage (io1): Must be an integer from 100 to - # 32768. + # 65536. # # * Magnetic storage (standard): Must be an integer from 5 to 3072. # # **MariaDB** # # Constraints to the amount of storage for each storage type are the # following: # # * General Purpose (SSD) storage (gp2): Must be an integer from 20 to - # 32768. + # 65536. # # * Provisioned IOPS storage (io1): Must be an integer from 100 to - # 32768. + # 65536. # # * Magnetic storage (standard): Must be an integer from 5 to 3072. # # **PostgreSQL** # # Constraints to the amount of storage for each storage type are the # following: # # * General Purpose (SSD) storage (gp2): Must be an integer from 20 to - # 32768. + # 65536. # # * Provisioned IOPS storage (io1): Must be an integer from 100 to - # 32768. + # 65536. # # * Magnetic storage (standard): Must be an integer from 5 to 3072. # # **Oracle** # # Constraints to the amount of storage for each storage type are the # following: # # * General Purpose (SSD) storage (gp2): Must be an integer from 20 to - # 32768. + # 65536. # # * Provisioned IOPS storage (io1): Must be an integer from 100 to - # 32768. + # 65536. # # * Magnetic storage (standard): Must be an integer from 10 to 3072. # # **SQL Server** # @@ -786,13 +785,13 @@ # Default: A random, system-chosen Availability Zone in the endpoint's # AWS Region. # # Example: `us-east-1d` # - # Constraint: The AvailabilityZone parameter can't be specified if the - # MultiAZ parameter is set to `true`. The specified Availability Zone - # must be in the same AWS Region as the current endpoint. + # Constraint: The `AvailabilityZone` parameter can't be specified if + # the DB instance is a Multi-AZ deployment. The specified Availability + # Zone must be in the same AWS Region as the current endpoint. # # # # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.RegionsAndAvailabilityZones.html # @option options [String] :db_subnet_group_name @@ -922,13 +921,13 @@ # # Valid Values: `1150-65535` # # Type: Integer # @option options [Boolean] :multi_az - # A value that specifies whether the DB instance is a Multi-AZ - # deployment. You can't set the AvailabilityZone parameter if the - # MultiAZ parameter is set to true. + # A value that indicates whether the DB instance is a Multi-AZ + # deployment. You can't set the `AvailabilityZone` parameter if the DB + # instance is a Multi-AZ deployment. # @option options [String] :engine_version # The version number of the database engine to use. # # For a list of valid engine versions, use the # `DescribeDBEngineVersions` action. @@ -972,14 +971,13 @@ # [2]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_SQLServer.html#SQLServer.Concepts.General.FeatureSupport # [3]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MySQL.html#MySQL.Concepts.VersionMgmt # [4]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Appendix.Oracle.PatchComposition.html # [5]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_PostgreSQL.html#PostgreSQL.Concepts.General.DBVersions # @option options [Boolean] :auto_minor_version_upgrade - # Indicates that minor engine upgrades are applied automatically to the - # DB instance during the maintenance window. - # - # Default: `true` + # A value that indicates whether minor engine upgrades are applied + # automatically to the DB instance during the maintenance window. By + # default, minor engine upgrades are applied automatically. # @option options [String] :license_model # License model information for this DB instance. # # Valid values: `license-included` \| `bring-your-own-license` \| # `general-public-license` @@ -1010,15 +1008,16 @@ # **Amazon Aurora** # # Not applicable. The character set is managed by the DB cluster. For # more information, see `CreateDBCluster`. # @option options [Boolean] :publicly_accessible - # Specifies the accessibility options for the DB instance. A value of - # true specifies an Internet-facing instance with a publicly resolvable - # DNS name, which resolves to a public IP address. A value of false - # specifies an internal instance with a DNS name that resolves to a - # private IP address. + # A value that indicates whether the DB instance is publicly accessible. + # When the DB instance is publicly accessible, it is an Internet-facing + # instance with a publicly resolvable DNS name, which resolves to a + # public IP address. When the DB instance is not publicly accessible, it + # is an internal instance with a DNS name that resolves to a private IP + # address. # # Default: The default behavior varies depending on whether # `DBSubnetGroupName` is specified. # # If `DBSubnetGroupName` is not specified, and `PubliclyAccessible` is @@ -1048,27 +1047,25 @@ # Valid values: `standard | gp2 | io1` # # If you specify `io1`, you must also include a value for the `Iops` # parameter. # - # Default: `io1` if the `Iops` parameter is specified, otherwise - # `standard` + # Default: `io1` if the `Iops` parameter is specified, otherwise `gp2` # @option options [String] :tde_credential_arn # The ARN from the key store with which to associate the instance for # TDE encryption. # @option options [String] :tde_credential_password # The password for the given ARN from the key store in order to access # the device. # @option options [Boolean] :storage_encrypted - # Specifies whether the DB instance is encrypted. + # A value that indicates whether the DB instance is encrypted. By + # default, it is not encrypted. # # **Amazon Aurora** # # Not applicable. The encryption for DB instances is managed by the DB # cluster. - # - # Default: false # @option options [String] :kms_key_id # The AWS KMS key identifier for an encrypted DB instance. # # The KMS key identifier is the Amazon Resource Name (ARN) for the KMS # encryption key. If you are creating a DB instance with the same AWS @@ -1079,15 +1076,15 @@ # **Amazon Aurora** # # Not applicable. The KMS key identifier is managed by the DB cluster. # For more information, see `CreateDBCluster`. # - # If the `StorageEncrypted` parameter is true, and you do not specify a - # value for the `KmsKeyId` parameter, then Amazon RDS will use your - # default encryption key. AWS KMS creates the default encryption key for - # your AWS account. Your AWS account has a different default encryption - # key for each AWS Region. + # If `StorageEncrypted` is enabled, and you do not specify a value for + # the `KmsKeyId` parameter, then Amazon RDS will use your default + # encryption key. AWS KMS creates the default encryption key for your + # AWS account. Your AWS account has a different default encryption key + # for each AWS Region. # @option options [String] :domain # For an Amazon RDS DB instance that's running Microsoft SQL Server, # this parameter specifies the Active Directory directory ID to create # the instance in. Amazon RDS uses Windows Authentication to # authenticate users that connect to the DB instance. For more @@ -1097,12 +1094,12 @@ # # # # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/DeveloperGuide/USER_SQLServerWinAuth.html # @option options [Boolean] :copy_tags_to_snapshot - # True to copy all tags from the DB instance to snapshots of the DB - # instance, and otherwise false. The default is false. + # A value that indicates whether to copy tags from the DB instance to + # snapshots of the DB instance. By default, tags are not copied. # # **Amazon Aurora** # # Not applicable. Copying tags to snapshots is managed by the DB # cluster. Setting this value for an Aurora DB instance has no effect on @@ -1151,12 +1148,13 @@ # # # # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_SQLServer.html#SQLServer.Concepts.General.TimeZone # @option options [Boolean] :enable_iam_database_authentication - # True to enable mapping of AWS Identity and Access Management (IAM) - # accounts to database accounts, and otherwise false. + # A value that indicates whether to enable mapping of AWS Identity and + # Access Management (IAM) accounts to database accounts. By default, + # mapping is disabled. # # You can enable IAM database authentication for the following database # engines: # # **Amazon Aurora** @@ -1167,15 +1165,13 @@ # **MySQL** # # * For MySQL 5.6, minor version 5.6.34 or higher # # * For MySQL 5.7, minor version 5.7.16 or higher - # - # Default: `false` # @option options [Boolean] :enable_performance_insights - # True to enable Performance Insights for the DB instance, and otherwise - # false. + # A value that indicates whether to enable Performance Insights for the + # DB instance. # # For more information, see [Using Amazon Performance Insights][1] in # the *Amazon Relational Database Service User Guide*. # # @@ -1183,10 +1179,15 @@ # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html # @option options [String] :performance_insights_kms_key_id # The AWS KMS key identifier for encryption of Performance Insights # data. The KMS key ID is the Amazon Resource Name (ARN), KMS key # identifier, or the KMS key alias for the KMS encryption key. + # + # If you do not specify a value for `PerformanceInsightsKMSKeyId`, then + # Amazon RDS uses your default encryption key. AWS KMS creates the + # default encryption key for your AWS account. Your AWS account has a + # different default encryption key for each AWS Region. # @option options [Integer] :performance_insights_retention_period # The amount of time, in days, to retain Performance Insights data. # Valid values are 7 or 731 (2 years). # @option options [Array<String>] :enable_cloudwatch_logs_exports # The list of log types that need to be enabled for exporting to @@ -1200,14 +1201,14 @@ # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch # @option options [Array<Types::ProcessorFeature>] :processor_features # The number of CPU cores and the number of threads per core for the DB # instance class of the DB instance. # @option options [Boolean] :deletion_protection - # Indicates if the DB instance should have deletion protection enabled. - # The database can't be deleted when this value is set to true. The - # default is false. For more information, see [ Deleting a DB - # Instance][1]. + # A value that indicates whether the DB instance has deletion protection + # enabled. The database can't be deleted when deletion protection is + # enabled. By default, deletion protection is disabled. For more + # information, see [ Deleting a DB Instance][1]. # # # # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_DeleteInstance.html # @return [DBInstance] @@ -1420,12 +1421,13 @@ # must be supplied. # # * If the source type is a DB snapshot, a `DBSnapshotIdentifier` must # be supplied. # @option options [Boolean] :enabled - # A Boolean value; set to **true** to activate the subscription, set to - # **false** to create the subscription but not active it. + # A value that indicates whether to activate the subscription. If the + # event notification subscription is not activated, the subscription is + # created but not active. # @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.* # # @@ -1757,23 +1759,30 @@ # # ^ # @option options [Array<Types::Filter>] :filters # This parameter is not currently supported. # @option options [Boolean] :default_only - # Indicates that only the default version of the specified engine or - # engine and major version combination is returned. + # A value that indicates whether only the default version of the + # specified engine or engine and major version combination is returned. # @option options [Boolean] :list_supported_character_sets - # If this parameter is specified and the requested engine supports the + # 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 # `CharacterSetName` parameter for `CreateDBInstance`, the response # includes a list of supported character sets for each engine version. # @option options [Boolean] :list_supported_timezones - # If this parameter is specified and the requested engine supports the + # 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 # `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. + # A value that indicates whether to include engine versions that aren't + # available in the list. The default is to list only available engine + # versions. # @return [DBEngineVersion::Collection] def db_engine_versions(options = {}) batches = Enumerator.new do |y| resp = @client.describe_db_engine_versions(options) resp.each_page do |page| @@ -2021,13 +2030,13 @@ # The `awsbackup` type does not apply to Aurora. # # If you don't specify a `SnapshotType` value, then both automated and # manual snapshots are returned. Shared and public DB snapshots are not # included in the returned results by default. You can include shared - # snapshots with these results by setting the `IncludeShared` parameter - # to `true`. You can include public snapshots with these results by - # setting the `IncludePublic` parameter to `true`. + # snapshots with these results by enabling the `IncludeShared` + # parameter. You can include public snapshots with these results by + # enabling the `IncludePublic` parameter. # # The `IncludeShared` and `IncludePublic` parameters don't apply for # `SnapshotType` values of `manual` or `automated`. The `IncludePublic` # parameter doesn't apply when `SnapshotType` is set to `shared`. The # `IncludeShared` parameter doesn't apply when `SnapshotType` is set to @@ -2037,24 +2046,25 @@ # # [1]: https://docs.aws.amazon.com/aws-backup/latest/devguide/whatisbackup.html # @option options [Array<Types::Filter>] :filters # This parameter is not currently supported. # @option options [Boolean] :include_shared - # True to include shared manual DB snapshots from other AWS accounts - # that this AWS account has been given permission to copy or restore, - # and otherwise false. The default is `false`. + # 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. # # You can give an AWS account permission to restore a manual DB snapshot # from another AWS account by using the `ModifyDBSnapshotAttribute` API # action. # @option options [Boolean] :include_public - # True to include manual DB snapshots that are public and can be copied - # or restored by any AWS account, and otherwise false. The default is - # false. + # 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. # # You can share a manual DB snapshot as public by using the - # `ModifyDBSnapshotAttribute` API. + # ModifyDBSnapshotAttribute API. # @option options [String] :dbi_resource_id # A specific DB resource ID to describe. # @return [DBSnapshot::Collection] def db_snapshots(options = {}) batches = Enumerator.new do |y| @@ -2414,12 +2424,12 @@ # The offering type filter value. Specify this parameter to show only # the available offerings matching the specified offering type. # # Valid Values: `"Partial Upfront" | "All Upfront" | "No Upfront" ` # @option options [Boolean] :multi_az - # The Multi-AZ filter value. Specify this parameter to show only those - # reservations matching the specified Multi-AZ parameter. + # A value that indicates whether to show only those reservations that + # support Multi-AZ. # @option options [Array<Types::Filter>] :filters # This parameter is not currently supported. # @return [ReservedDBInstance::Collection] def reserved_db_instances(options = {}) batches = Enumerator.new do |y| @@ -2491,11 +2501,11 @@ # The offering type filter value. Specify this parameter to show only # the available offerings matching the specified offering type. # # Valid Values: `"Partial Upfront" | "All Upfront" | "No Upfront" ` # @option options [Boolean] :multi_az - # The Multi-AZ filter value. Specify this parameter to show only the - # available offerings matching the specified Multi-AZ parameter. + # A value that indicates whether to show only those reservations that + # support Multi-AZ. # @option options [Array<Types::Filter>] :filters # This parameter is not currently supported. # @return [ReservedDBInstancesOffering::Collection] def reserved_db_instances_offerings(options = {}) batches = Enumerator.new do |y|