lib/aws-sdk-rds/client.rb in aws-sdk-rds-1.173.0 vs lib/aws-sdk-rds/client.rb in aws-sdk-rds-1.174.0

- old
+ new

@@ -2137,17 +2137,17 @@ # Multi-AZ DB cluster, the request creates a writer and two reader DB # instances for you, each in a different Availability Zone. # # You can use the `ReplicationSourceIdentifier` parameter to create an # Amazon Aurora DB cluster as a read replica of another DB cluster or - # Amazon RDS MySQL or PostgreSQL DB instance. For more information about - # Amazon Aurora, see [What is Amazon Aurora?][2] in the *Amazon Aurora - # User Guide*. + # Amazon RDS for MySQL or PostgreSQL DB instance. For more information + # about Amazon Aurora, see [What is Amazon Aurora?][2] in the *Amazon + # Aurora User Guide*. # # You can also use the `ReplicationSourceIdentifier` parameter to create - # a Multi-AZ DB cluster read replica with an RDS for PostgreSQL DB - # instance as the source. For more information about Multi-AZ DB + # a Multi-AZ DB cluster read replica with an RDS for MySQL or PostgreSQL + # DB instance as the source. For more information about Multi-AZ DB # clusters, see [Multi-AZ DB cluster deployments][3] in the *Amazon RDS # User Guide*. # # # @@ -2417,12 +2417,11 @@ # # @option params [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. # - # Valid for: Aurora DB clusters and RDS for PostgreSQL Multi-AZ DB - # clusters + # Valid for: Aurora DB clusters and Multi-AZ DB clusters # # @option params [Array<Types::Tag>] :tags # Tags to assign to the DB cluster. # # Valid for: Aurora DB clusters and Multi-AZ DB clusters @@ -4975,10 +4974,11 @@ # resp.db_instance.master_user_secret.secret_arn #=> String # resp.db_instance.master_user_secret.secret_status #=> String # resp.db_instance.master_user_secret.kms_key_id #=> String # resp.db_instance.certificate_details.ca_identifier #=> String # resp.db_instance.certificate_details.valid_till #=> Time + # resp.db_instance.read_replica_source_db_cluster_identifier #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/CreateDBInstance AWS API Documentation # # @overload create_db_instance(params = {}) # @param [Hash] params ({}) @@ -4986,58 +4986,58 @@ req = build_request(:create_db_instance, params) req.send_request(options) end # Creates a new DB instance that acts as a read replica for an existing - # source DB instance. You can create a read replica for a DB instance - # running MySQL, MariaDB, Oracle, PostgreSQL, or SQL Server. For more - # information, see [Working with Read Replicas][1] in the *Amazon RDS - # User Guide*. + # source DB instance or Multi-AZ DB cluster. You can create a read + # replica for a DB instance running MySQL, MariaDB, Oracle, PostgreSQL, + # or SQL Server. You can create a read replica for a Multi-AZ DB cluster + # running MySQL or PostgreSQL. For more information, see [Working with + # read replicas][1] and [Migrating from a Multi-AZ DB cluster to a DB + # instance using a read replica][2] in the *Amazon RDS User Guide*. # # Amazon Aurora doesn't support this operation. Call the # `CreateDBInstance` operation to create a DB instance for an Aurora DB # cluster. # # All read replica DB instances are created with backups disabled. All - # other DB instance attributes (including DB security groups and DB - # parameter groups) are inherited from the source DB instance, except as - # specified. + # other attributes (including DB security groups and DB parameter + # groups) are inherited from the source DB instance or cluster, except + # as specified. # - # Your source DB instance must have backup retention enabled. + # Your source DB instance or cluster must have backup retention enabled. # # # # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_ReadRepl.html + # [2]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html#multi-az-db-clusters-migrating-to-instance-with-read-replica # # @option params [required, String] :db_instance_identifier # The DB instance identifier of the read replica. This identifier is the # unique key that identifies a DB instance. This parameter is stored as # a lowercase string. # - # @option params [required, String] :source_db_instance_identifier + # @option params [String] :source_db_instance_identifier # 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. + # read replica. Each DB instance can have up to 15 read replicas, with + # the exception of Oracle and SQL Server, which can have up to five. # # Constraints: # # * Must be the identifier of an existing MySQL, MariaDB, Oracle, # PostgreSQL, or SQL Server DB instance. # - # * Can specify a DB instance that is a MySQL read replica only if the - # source is running MySQL 5.6 or later. + # * Can't be specified if the `SourceDBClusterIdentifier` parameter is + # also specified. # - # * For the limitations of Oracle read replicas, see [Read Replica - # Limitations with Oracle][1] in the *Amazon RDS User Guide*. + # * For the limitations of Oracle read replicas, see [Version and + # licensing considerations for RDS for Oracle replicas][1] in the + # *Amazon RDS User Guide*. # - # * For the limitations of SQL Server read replicas, see [Read Replica - # Limitations with Microsoft SQL Server][2] in the *Amazon RDS User - # Guide*. + # * For the limitations of SQL Server read replicas, see [Read replica + # limitations with SQL Server][2] in the *Amazon RDS User Guide*. # - # * 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). - # # * The specified DB instance must have automatic backups enabled, that # is, its backup retention period must be greater than 0. # # * If the source DB instance is in the same Amazon Web Services Region # as the read replica, specify a valid DB instance identifier. @@ -5048,12 +5048,12 @@ # *Amazon RDS User Guide*. This doesn't apply to SQL Server or RDS # Custom, which don't support cross-Region replicas. # # # - # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-read-replicas.html - # [2]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/SQLServer.ReadReplicas.Limitations.html + # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-read-replicas.limitations.html#oracle-read-replicas.limitations.versions-and-licenses + # [2]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/SQLServer.ReadReplicas.html#SQLServer.ReadReplicas.Limitations # [3]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.ARN.html#USER_Tagging.ARN.Constructing # # @option params [String] :db_instance_class # The compute and memory capacity of the read replica, for example # db.m4.large. Not all DB instance classes are available in all Amazon @@ -5087,12 +5087,12 @@ # deployment. # # 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. + # instance is independent of whether the source is a Multi-AZ DB + # instance or a Multi-AZ DB cluster. # # This setting doesn't apply to RDS Custom. # # @option params [Boolean] :auto_minor_version_upgrade # A value that indicates whether minor engine upgrades are applied @@ -5106,14 +5106,14 @@ # The amount of Provisioned IOPS (input/output operations per second) to # be initially allocated for the DB instance. # # @option params [String] :option_group_name # The option group the DB instance is associated with. If omitted, the - # option group associated with the source instance is used. + # option group associated with the source instance or cluster is used. # # <note markdown="1"> For SQL Server, you must use the option group associated with the - # source instance. + # source. # # </note> # # This setting doesn't apply to RDS Custom. # @@ -5244,24 +5244,24 @@ # # The Amazon Web Services KMS key identifier is the key ARN, key ID, # alias ARN, or alias name for the KMS key. # # 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. + # Services Region as the source DB 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. # # 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. # # You can't create an encrypted read replica from an unencrypted DB - # instance. + # instance or Multi-AZ DB cluster. # # This setting doesn't apply to RDS Custom, which uses the same KMS key # as the primary replica. # # @option params [String] :pre_signed_url @@ -5274,10 +5274,14 @@ # # 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. # + # This setting applies only when replicating from a source DB + # *instance*. Source DB clusters aren't supported in Amazon Web + # Services GovCloud (US) Regions and China Amazon Web Services Regions. + # # 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 `PreSignedUrl` when you are creating an # encrypted read replica in the same Amazon Web Services Region. # @@ -5453,12 +5457,12 @@ # # # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/kerberos-authentication.html # # @option params [String] :domain_iam_role_name - # Specify the name of the IAM role to be used when making API calls to - # the Directory Service. + # The name of the IAM role to be used when making API calls to the + # Directory Service. # # This setting doesn't apply to RDS Custom. # # @option params [String] :replica_mode # The open mode of the replica database: mounted or read-only. @@ -5576,10 +5580,27 @@ # create operation can succeed. You can also allocate additional storage # for future growth. # # </note> # + # @option params [String] :source_db_cluster_identifier + # 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. + # + # Constraints: + # + # * Must be the identifier of an existing Multi-AZ DB cluster. + # + # * Can't be specified if the `SourceDBInstanceIdentifier` parameter is + # also specified. + # + # * The specified DB cluster must have automatic backups enabled, that + # is, its backup retention period must be greater than 0. + # + # * The source DB cluster must be in the same Amazon Web Services Region + # as the read replica. Cross-Region replication isn't supported. + # # @option params [String] :source_region # The source region of the snapshot. This is only needed when the # shapshot is encrypted and in a different region. # # @return [Types::CreateDBInstanceReadReplicaResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods: @@ -5615,11 +5636,11 @@ # # @example Request syntax with placeholder values # # resp = client.create_db_instance_read_replica({ # db_instance_identifier: "String", # required - # source_db_instance_identifier: "String", # required + # source_db_instance_identifier: "String", # db_instance_class: "String", # availability_zone: "String", # port: 1, # multi_az: false, # auto_minor_version_upgrade: false, @@ -5661,10 +5682,11 @@ # custom_iam_instance_profile: "String", # network_type: "String", # storage_throughput: 1, # enable_customer_owned_ip: false, # allocated_storage: 1, + # source_db_cluster_identifier: "String", # source_region: "String", # }) # # @example Response structure # @@ -5814,10 +5836,11 @@ # resp.db_instance.master_user_secret.secret_arn #=> String # resp.db_instance.master_user_secret.secret_status #=> String # resp.db_instance.master_user_secret.kms_key_id #=> String # resp.db_instance.certificate_details.ca_identifier #=> String # resp.db_instance.certificate_details.valid_till #=> Time + # resp.db_instance.read_replica_source_db_cluster_identifier #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/CreateDBInstanceReadReplica AWS API Documentation # # @overload create_db_instance_read_replica(params = {}) # @param [Hash] params ({}) @@ -7118,10 +7141,14 @@ # The DeleteDBCluster action deletes a previously provisioned DB # cluster. When you delete a DB cluster, all automated backups for that # DB cluster are deleted and can't be recovered. Manual DB cluster # snapshots of the specified DB cluster are not deleted. # + # If you're deleting a Multi-AZ DB cluster with read replicas, all + # cluster members are terminated and read replicas are promoted to + # standalone instances. + # # For more information on Amazon Aurora, see [ What is Amazon # Aurora?][1] in the *Amazon Aurora User Guide*. # # For more information on Multi-AZ DB clusters, see [ Multi-AZ DB # cluster deployments][2] in the *Amazon RDS User Guide*. @@ -7783,10 +7810,11 @@ # resp.db_instance.master_user_secret.secret_arn #=> String # resp.db_instance.master_user_secret.secret_status #=> String # resp.db_instance.master_user_secret.kms_key_id #=> String # resp.db_instance.certificate_details.ca_identifier #=> String # resp.db_instance.certificate_details.valid_till #=> Time + # resp.db_instance.read_replica_source_db_cluster_identifier #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DeleteDBInstance AWS API Documentation # # @overload delete_db_instance(params = {}) # @param [Hash] params ({}) @@ -10167,10 +10195,11 @@ # resp.db_instances[0].master_user_secret.secret_arn #=> String # resp.db_instances[0].master_user_secret.secret_status #=> String # resp.db_instances[0].master_user_secret.kms_key_id #=> String # resp.db_instances[0].certificate_details.ca_identifier #=> String # resp.db_instances[0].certificate_details.valid_till #=> Time + # resp.db_instances[0].read_replica_source_db_cluster_identifier #=> String # # # The following waiters are defined for this operation (see {Client#wait_until} for detailed usage): # # * db_instance_available @@ -14177,17 +14206,27 @@ # 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. # + # If the cluster that you're modifying has one or more read replicas, + # all replicas must be running an engine version that's the same or + # later than the version you specify. + # # To list all of the available engine versions for Aurora MySQL version # 2 (5.7-compatible) and version 3 (MySQL 8.0-compatible), use the # following command: # # `aws rds describe-db-engine-versions --engine aurora-mysql --query # "DBEngineVersions[].EngineVersion"` # + # To list all of the available engine versions for MySQL 5.6-compatible + # Aurora, use the following command: + # + # `aws rds describe-db-engine-versions --engine aurora --query + # "DBEngineVersions[].EngineVersion"` + # # To list all of the available engine versions for Aurora PostgreSQL, # use the following command: # # `aws rds describe-db-engine-versions --engine aurora-postgresql # --query "DBEngineVersions[].EngineVersion"` @@ -15384,10 +15423,14 @@ # If you specify only a major version, Amazon RDS will update the DB # instance to the default minor version if the current minor version is # lower. For information about valid engine versions, see # `CreateDBInstance`, or call `DescribeDBEngineVersions`. # + # If the instance that you're modifying is acting as a read replica, + # the engine version that you specify must be the same or later than the + # version that the source DB instance or cluster is running. + # # In RDS Custom for Oracle, this parameter is supported for read # replicas only if they are in the `PATCH_DB_FAILURE` lifecycle. # # @option params [Boolean] :allow_major_version_upgrade # A value that indicates whether major version upgrades are allowed. @@ -16256,10 +16299,11 @@ # resp.db_instance.master_user_secret.secret_arn #=> String # resp.db_instance.master_user_secret.secret_status #=> String # resp.db_instance.master_user_secret.kms_key_id #=> String # resp.db_instance.certificate_details.ca_identifier #=> String # resp.db_instance.certificate_details.valid_till #=> Time + # resp.db_instance.read_replica_source_db_cluster_identifier #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/ModifyDBInstance AWS API Documentation # # @overload modify_db_instance(params = {}) # @param [Hash] params ({}) @@ -17501,10 +17545,11 @@ # resp.db_instance.master_user_secret.secret_arn #=> String # resp.db_instance.master_user_secret.secret_status #=> String # resp.db_instance.master_user_secret.kms_key_id #=> String # resp.db_instance.certificate_details.ca_identifier #=> String # resp.db_instance.certificate_details.valid_till #=> Time + # resp.db_instance.read_replica_source_db_cluster_identifier #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/PromoteReadReplica AWS API Documentation # # @overload promote_read_replica(params = {}) # @param [Hash] params ({}) @@ -18121,10 +18166,11 @@ # resp.db_instance.master_user_secret.secret_arn #=> String # resp.db_instance.master_user_secret.secret_status #=> String # resp.db_instance.master_user_secret.kms_key_id #=> String # resp.db_instance.certificate_details.ca_identifier #=> String # resp.db_instance.certificate_details.valid_till #=> Time + # resp.db_instance.read_replica_source_db_cluster_identifier #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/RebootDBInstance AWS API Documentation # # @overload reboot_db_instance(params = {}) # @param [Hash] params ({}) @@ -21208,10 +21254,11 @@ # resp.db_instance.master_user_secret.secret_arn #=> String # resp.db_instance.master_user_secret.secret_status #=> String # resp.db_instance.master_user_secret.kms_key_id #=> String # resp.db_instance.certificate_details.ca_identifier #=> String # resp.db_instance.certificate_details.valid_till #=> Time + # resp.db_instance.read_replica_source_db_cluster_identifier #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/RestoreDBInstanceFromDBSnapshot AWS API Documentation # # @overload restore_db_instance_from_db_snapshot(params = {}) # @param [Hash] params ({}) @@ -21934,10 +21981,11 @@ # resp.db_instance.master_user_secret.secret_arn #=> String # resp.db_instance.master_user_secret.secret_status #=> String # resp.db_instance.master_user_secret.kms_key_id #=> String # resp.db_instance.certificate_details.ca_identifier #=> String # resp.db_instance.certificate_details.valid_till #=> Time + # resp.db_instance.read_replica_source_db_cluster_identifier #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/RestoreDBInstanceFromS3 AWS API Documentation # # @overload restore_db_instance_from_s3(params = {}) # @param [Hash] params ({}) @@ -22698,10 +22746,11 @@ # resp.db_instance.master_user_secret.secret_arn #=> String # resp.db_instance.master_user_secret.secret_status #=> String # resp.db_instance.master_user_secret.kms_key_id #=> String # resp.db_instance.certificate_details.ca_identifier #=> String # resp.db_instance.certificate_details.valid_till #=> Time + # resp.db_instance.read_replica_source_db_cluster_identifier #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/RestoreDBInstanceToPointInTime AWS API Documentation # # @overload restore_db_instance_to_point_in_time(params = {}) # @param [Hash] params ({}) @@ -23216,10 +23265,11 @@ # resp.db_instance.master_user_secret.secret_arn #=> String # resp.db_instance.master_user_secret.secret_status #=> String # resp.db_instance.master_user_secret.kms_key_id #=> String # resp.db_instance.certificate_details.ca_identifier #=> String # resp.db_instance.certificate_details.valid_till #=> Time + # resp.db_instance.read_replica_source_db_cluster_identifier #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/StartDBInstance AWS API Documentation # # @overload start_db_instance(params = {}) # @param [Hash] params ({}) @@ -23902,10 +23952,11 @@ # resp.db_instance.master_user_secret.secret_arn #=> String # resp.db_instance.master_user_secret.secret_status #=> String # resp.db_instance.master_user_secret.kms_key_id #=> String # resp.db_instance.certificate_details.ca_identifier #=> String # resp.db_instance.certificate_details.valid_till #=> Time + # resp.db_instance.read_replica_source_db_cluster_identifier #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/StopDBInstance AWS API Documentation # # @overload stop_db_instance(params = {}) # @param [Hash] params ({}) @@ -23926,11 +23977,11 @@ # # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_ReplicateBackups.html # # @option params [required, String] :source_db_instance_arn # The Amazon Resource Name (ARN) of the source DB instance for which to - # stop replicating automated backups, for example, + # stop replicating automate backups, for example, # `arn:aws:rds:us-west-2:123456789012:db:mydatabase`. # # @return [Types::StopDBInstanceAutomatedBackupsReplicationResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::StopDBInstanceAutomatedBackupsReplicationResult#db_instance_automated_backup #db_instance_automated_backup} => Types::DBInstanceAutomatedBackup @@ -24229,10 +24280,11 @@ # resp.db_instance.master_user_secret.secret_arn #=> String # resp.db_instance.master_user_secret.secret_status #=> String # resp.db_instance.master_user_secret.kms_key_id #=> String # resp.db_instance.certificate_details.ca_identifier #=> String # resp.db_instance.certificate_details.valid_till #=> Time + # resp.db_instance.read_replica_source_db_cluster_identifier #=> String # # @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/SwitchoverReadReplica AWS API Documentation # # @overload switchover_read_replica(params = {}) # @param [Hash] params ({}) @@ -24252,10 +24304,10 @@ operation: config.api.operation(operation_name), client: self, params: params, config: config) context[:gem_name] = 'aws-sdk-rds' - context[:gem_version] = '1.173.0' + context[:gem_version] = '1.174.0' Seahorse::Client::Request.new(handlers, context) end # Polls an API operation until a resource enters a desired state. #