lib/aws-sdk-rds/resource.rb in aws-sdk-rds-1.43.0 vs lib/aws-sdk-rds/resource.rb in aws-sdk-rds-1.44.0
- old
+ new
@@ -60,10 +60,11 @@
# auto_pause: false,
# seconds_until_auto_pause: 1,
# },
# deletion_protection: false,
# global_cluster_identifier: "String",
+ # copy_tags_to_snapshot: false,
# source_region: "String",
# })
# @param [Hash] options ({})
# @option options [Array<String>] :availability_zones
# A list of EC2 Availability Zones that instances in the DB cluster can
@@ -71,11 +72,11 @@
# see [Choosing the Regions and Availability Zones][1] in the *Amazon
# Aurora User Guide*.
#
#
#
- # [1]: http://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Concepts.RegionsAndAvailabilityZones.html
+ # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Concepts.RegionsAndAvailabilityZones.html
# @option options [Integer] :backup_retention_period
# The number of days for which automated backups are retained. You must
# specify a minimum value of 1.
#
# Default: 1
@@ -188,11 +189,11 @@
#
# * Must be at least 30 minutes.
#
#
#
- # [1]: http://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_UpgradeDBInstance.Maintenance.html#AdjustingTheMaintenanceWindow.Aurora
+ # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_UpgradeDBInstance.Maintenance.html#AdjustingTheMaintenanceWindow.Aurora
# @option options [String] :preferred_maintenance_window
# The weekly time range during which system maintenance can occur, in
# Universal Coordinated Time (UTC).
#
# Format: `ddd:hh24:mi-ddd:hh24:mi`
@@ -206,21 +207,21 @@
#
# Constraints: Minimum 30-minute window.
#
#
#
- # [1]: http://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_UpgradeDBInstance.Maintenance.html#AdjustingTheMaintenanceWindow.Aurora
+ # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_UpgradeDBInstance.Maintenance.html#AdjustingTheMaintenanceWindow.Aurora
# @option options [String] :replication_source_identifier
# 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
# A list of tags. For more information, see [Tagging Amazon RDS
# Resources][1] in the *Amazon RDS User Guide.*
#
#
#
- # [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html
+ # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html
# @option options [Boolean] :storage_encrypted
# Specifies whether the DB cluster is encrypted.
# @option options [String] :kms_key_id
# The AWS KMS key identifier for an encrypted DB cluster.
#
@@ -283,12 +284,12 @@
# Authenticating Requests: Using Query Parameters (AWS Signature Version
# 4)][1] and [ Signature Version 4 Signing Process][2].
#
#
#
- # [1]: http://docs.aws.amazon.com/AmazonS3/latest/API/sigv4-query-string-auth.html
- # [2]: http://docs.aws.amazon.com/general/latest/gr/signature-version-4.html
+ # [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`
@@ -310,11 +311,11 @@
# used. For more information, see [Publishing Database Logs to Amazon
# CloudWatch Logs][1] in the *Amazon Aurora User Guide*.
#
#
#
- # [1]: http://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch
+ # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch
# @option options [String] :engine_mode
# The DB engine mode of the DB cluster, either `provisioned`,
# `serverless`, `parallelquery`, or `global`.
# @option options [Types::ScalingConfiguration] :scaling_configuration
# For DB clusters in `serverless` DB engine mode, the scaling properties
@@ -324,10 +325,13 @@
# 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
+ # 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
# shapshot is encrypted and in a different region.
# @return [DBCluster]
@@ -386,11 +390,11 @@
# A list of tags. For more information, see [Tagging Amazon RDS
# Resources][1] in the *Amazon RDS User Guide.*
#
#
#
- # [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html
+ # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html
# @return [DBClusterParameterGroup]
def create_db_cluster_parameter_group(options = {})
resp = @client.create_db_cluster_parameter_group(options)
DBClusterParameterGroup.new(
name: resp.data.db_cluster_parameter_group.db_cluster_parameter_group_name,
@@ -561,40 +565,40 @@
#
# 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
- # 16384.
+ # 32768.
#
# * Provisioned IOPS storage (io1): Must be an integer from 100 to
- # 16384.
+ # 32768.
#
# * 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
- # 16384.
+ # 32768.
#
# * Provisioned IOPS storage (io1): Must be an integer from 100 to
- # 16384.
+ # 32768.
#
# * 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
- # 16384.
+ # 32768.
#
# * Provisioned IOPS storage (io1): Must be an integer from 100 to
- # 16384.
+ # 32768.
#
# * Magnetic storage (standard): Must be an integer from 5 to 3072.
#
# **Oracle**
#
@@ -641,11 +645,11 @@
# classes, and availability for your engine, see [DB Instance Class][1]
# in the *Amazon RDS User Guide.*
#
#
#
- # [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html
+ # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html
# @option options [required, String] :engine
# The name of the database engine to be used for this instance.
#
# Not every database engine is available for every AWS Region.
#
@@ -800,11 +804,11 @@
# MultiAZ parameter is set to `true`. The specified Availability Zone
# must be in the same AWS Region as the current endpoint.
#
#
#
- # [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.RegionsAndAvailabilityZones.html
+ # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.RegionsAndAvailabilityZones.html
# @option options [String] :db_subnet_group_name
# A DB subnet group to associate with this DB instance.
#
# If there is no DB subnet group, then it is a non-VPC DB instance.
# @option options [String] :preferred_maintenance_window
@@ -822,11 +826,11 @@
#
# Constraints: Minimum 30-minute window.
#
#
#
- # [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.Maintenance.html#Concepts.DBMaintenance
+ # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.Maintenance.html#Concepts.DBMaintenance
# @option options [String] :db_parameter_group_name
# The name of the DB parameter group to associate with this DB instance.
# If this argument is omitted, the default DBParameterGroup for the
# specified engine is used.
#
@@ -880,12 +884,12 @@
#
# * Must be at least 30 minutes.
#
#
#
- # [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithAutomatedBackups.html#USER_WorkingWithAutomatedBackups.BackupWindow
- # [2]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.Maintenance.html#AdjustingTheMaintenanceWindow
+ # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithAutomatedBackups.html#USER_WorkingWithAutomatedBackups.BackupWindow
+ # [2]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.Maintenance.html#AdjustingTheMaintenanceWindow
# @option options [Integer] :port
# The port number on which the database accepts connections.
#
# **MySQL**
#
@@ -974,15 +978,15 @@
# See [Supported PostgreSQL Database Versions][5] in the *Amazon RDS
# User Guide.*
#
#
#
- # [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MariaDB.html#MariaDB.Concepts.VersionMgmt
- # [2]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_SQLServer.html#SQLServer.Concepts.General.FeatureSupport
- # [3]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MySQL.html#MySQL.Concepts.VersionMgmt
- # [4]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Appendix.Oracle.PatchComposition.html
- # [5]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_PostgreSQL.html#PostgreSQL.Concepts.General.DBVersions
+ # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MariaDB.html#MariaDB.Concepts.VersionMgmt
+ # [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`
@@ -1000,11 +1004,11 @@
# Constraints: Must be a multiple between 1 and 50 of the storage amount
# for the DB instance.
#
#
#
- # [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html#USER_PIOPS
+ # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html#USER_PIOPS
# @option options [String] :option_group_name
# Indicates that the DB instance should be associated with the specified
# option group.
#
# Permanent options, such as the TDE option for Oracle Advanced Security
@@ -1050,11 +1054,11 @@
# A list of tags. For more information, see [Tagging Amazon RDS
# Resources][1] in the *Amazon RDS User Guide.*
#
#
#
- # [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html
+ # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html
# @option options [String] :db_cluster_identifier
# The identifier of the DB cluster that the instance will belong to.
#
# For information on creating a DB cluster, see CreateDBCluster.
#
@@ -1106,10 +1110,16 @@
# @option options [String] :domain
# Specify the Active Directory Domain to create the instance in.
# @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.
+ #
+ # **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
+ # the DB cluster setting. For more information, see CreateDBCluster.
# @option options [Integer] :monitoring_interval
# The interval, in seconds, between points when Enhanced Monitoring
# metrics are collected for the DB instance. To disable collecting
# Enhanced Monitoring metrics, specify 0. The default is 0.
#
@@ -1127,11 +1137,11 @@
# If `MonitoringInterval` is set to a value other than 0, then you must
# supply a `MonitoringRoleArn` value.
#
#
#
- # [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Monitoring.OS.html#USER_Monitoring.OS.Enabling
+ # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Monitoring.OS.html#USER_Monitoring.OS.Enabling
# @option options [String] :domain_iam_role_name
# Specify the name of the IAM role to be used when making API calls to
# the Directory Service.
# @option options [Integer] :promotion_tier
# A value that specifies the order in which an Aurora Replica is
@@ -1143,18 +1153,18 @@
#
# Valid Values: 0 - 15
#
#
#
- # [1]: http://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Managing.Backups.html#Aurora.Managing.FaultTolerance
+ # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Managing.Backups.html#Aurora.Managing.FaultTolerance
# @option options [String] :timezone
# The time zone of the DB instance. The time zone parameter is currently
# supported only by [Microsoft SQL Server][1].
#
#
#
- # [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_SQLServer.html#SQLServer.Concepts.General.TimeZone
+ # [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.
#
# You can enable IAM database authentication for the following database
@@ -1179,11 +1189,11 @@
# For more information, see [Using Amazon Performance Insights][1] in
# the *Amazon Relational Database Service User Guide*.
#
#
#
- # [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html
+ # [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.
# @option options [Integer] :performance_insights_retention_period
@@ -1196,11 +1206,11 @@
# CloudWatch Logs ][1] in the *Amazon Relational Database Service User
# Guide*.
#
#
#
- # [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch
+ # [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.
@@ -1208,11 +1218,11 @@
# default is false. For more information, see [ Deleting a DB
# Instance][1].
#
#
#
- # [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_DeleteInstance.html
+ # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_DeleteInstance.html
# @return [DBInstance]
def create_db_instance(options = {})
resp = @client.create_db_instance(options)
DBInstance.new(
id: resp.data.db_instance.db_instance_identifier,
@@ -1270,11 +1280,11 @@
# A list of tags. For more information, see [Tagging Amazon RDS
# Resources][1] in the *Amazon RDS User Guide.*
#
#
#
- # [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html
+ # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html
# @return [DBParameterGroup]
def create_db_parameter_group(options = {})
resp = @client.create_db_parameter_group(options)
DBParameterGroup.new(
name: resp.data.db_parameter_group.db_parameter_group_name,
@@ -1317,11 +1327,11 @@
# A list of tags. For more information, see [Tagging Amazon RDS
# Resources][1] in the *Amazon RDS User Guide.*
#
#
#
- # [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html
+ # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html
# @return [DBSecurityGroup]
def create_db_security_group(options = {})
resp = @client.create_db_security_group(options)
DBSecurityGroup.new(
name: resp.data.db_security_group.db_security_group_name,
@@ -1360,11 +1370,11 @@
# A list of tags. For more information, see [Tagging Amazon RDS
# Resources][1] in the *Amazon RDS User Guide.*
#
#
#
- # [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html
+ # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html
# @return [DBSubnetGroup]
def create_db_subnet_group(options = {})
resp = @client.create_db_subnet_group(options)
DBSubnetGroup.new(
name: resp.data.db_subnet_group.db_subnet_group_name,
@@ -1412,11 +1422,11 @@
# [Events][1] topic in the *Amazon RDS User Guide* or by using the
# **DescribeEventCategories** action.
#
#
#
- # [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Events.html
+ # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Events.html
# @option options [Array<String>] :source_ids
# The list of identifiers of the event sources for which events are
# returned. If not specified, then all sources are included in the
# response. An identifier must begin with a letter and must contain only
# ASCII letters, digits, and hyphens; it can't end with a hyphen or
@@ -1444,11 +1454,11 @@
# A list of tags. For more information, see [Tagging Amazon RDS
# Resources][1] in the *Amazon RDS User Guide.*
#
#
#
- # [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html
+ # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html
# @return [EventSubscription]
def create_event_subscription(options = {})
resp = @client.create_event_subscription(options)
EventSubscription.new(
name: resp.data.event_subscription.cust_subscription_id,
@@ -1496,11 +1506,11 @@
# A list of tags. For more information, see [Tagging Amazon RDS
# Resources][1] in the *Amazon RDS User Guide.*
#
#
#
- # [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html
+ # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html
# @return [OptionGroup]
def create_option_group(options = {})
resp = @client.create_option_group(options)
OptionGroup.new(
name: resp.data.option_group.option_group_name,
@@ -2027,10 +2037,18 @@
# * `shared` - Return all manual DB snapshots that have been shared to
# my AWS account.
#
# * `public` - Return all DB snapshots that have been marked as public.
#
+ # * `awsbackup` - Return the DB snapshots managed by the AWS Backup
+ # service.
+ #
+ # For information about AWS Backup, see the [ *AWS Backup Developer
+ # Guide.* ][1]
+ #
+ # 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
@@ -2039,9 +2057,13 @@
# 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
# `public`.
+ #
+ #
+ #
+ # [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,