lib/aws-sdk-rds/client.rb in aws-sdk-rds-1.80.0 vs lib/aws-sdk-rds/client.rb in aws-sdk-rds-1.81.0

- old
+ new

@@ -269,12 +269,11 @@ # seconds to wait when opening a HTTP session before raising a # `Timeout::Error`. # # @option options [Integer] :http_read_timeout (60) The default # number of seconds to wait for response data. This value can - # safely be set - # per-request on the session yielded by {#session_for}. + # safely be set per-request on the session. # # @option options [Float] :http_idle_timeout (5) The number of # seconds a connection is allowed to sit idle before it is # considered stale. Stale connections are closed and removed # from the pool before making a request. @@ -282,11 +281,11 @@ # @option options [Float] :http_continue_timeout (1) The number of # seconds to wait for a 100-continue response before sending the # request body. This option has no effect unless the request has # "Expect" header set to "100-continue". Defaults to `nil` which # disables this behaviour. This value can safely be set per - # request on the session yielded by {#session_for}. + # request on the session. # # @option options [Boolean] :http_wire_trace (false) When `true`, # HTTP debug output will be sent to the `:logger`. # # @option options [Boolean] :ssl_verify_peer (true) When `true`, @@ -1138,11 +1137,11 @@ # be used when copying an encrypted DB cluster snapshot from another AWS # Region. Don't specify `PreSignedUrl` when you are copying an # encrypted DB cluster snapshot in the same AWS Region. # # The pre-signed URL must be a valid request for the - # `CopyDBSClusterSnapshot` API action that can be executed in the source + # `CopyDBClusterSnapshot` API action that can be executed in the source # AWS Region that contains the encrypted DB cluster snapshot to be # copied. The pre-signed URL request must contain the following # parameter values: # # * `KmsKeyId` - The AWS KMS key identifier for the key to use to @@ -1802,11 +1801,11 @@ end # Creates a new Amazon Aurora DB cluster. # # You can use the `ReplicationSourceIdentifier` parameter to create the - # DB cluster as a Read Replica of another DB cluster or Amazon RDS MySQL + # DB cluster as a read replica of another DB cluster or Amazon RDS MySQL # DB instance. For cross-region replication where the DB cluster # identified by `ReplicationSourceIdentifier` is encrypted, you must # also specify the `PreSignedUrl` parameter. # # For more information on Amazon Aurora, see [ What Is Amazon @@ -1999,11 +1998,11 @@ # # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_UpgradeDBInstance.Maintenance.html#AdjustingTheMaintenanceWindow.Aurora # # @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. + # if this DB cluster is created as a read replica. # # @option params [Array<Types::Tag>] :tags # Tags to assign to the DB cluster. # # @option params [Boolean] :storage_encrypted @@ -2030,13 +2029,13 @@ # # 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 you create a Read Replica of an encrypted DB cluster in another AWS + # If you create a read replica of an encrypted DB cluster in another AWS # Region, you must set `KmsKeyId` to a KMS key ID that is valid in the - # destination AWS Region. This key is used to encrypt the Read Replica + # destination AWS Region. This key is used to encrypt the read replica # in that AWS Region. # # @option params [String] :pre_signed_url # A URL that contains a Signature Version 4 signed request for the # `CreateDBCluster` action to be called in the source AWS Region where @@ -2055,12 +2054,12 @@ # encrypt the copy of the DB cluster in the destination AWS Region. # This should refer to the same KMS key for both the `CreateDBCluster` # action that is called in the destination AWS Region, and the action # contained in the pre-signed URL. # - # * `DestinationRegion` - The name of the AWS Region that Aurora Read - # Replica will be created in. + # * `DestinationRegion` - The name of the AWS Region that Aurora read + # replica will be created in. # # * `ReplicationSourceIdentifier` - The DB cluster identifier for the # encrypted DB cluster to be copied. This identifier must be in the # Amazon Resource Name (ARN) format for the source AWS Region. For # example, if you are copying an encrypted DB cluster from the @@ -2122,10 +2121,16 @@ # # @option params [String] :engine_mode # The DB engine mode of the DB cluster, either `provisioned`, # `serverless`, `parallelquery`, `global`, or `multimaster`. # + # <note markdown="1"> `global` engine mode only applies for global database clusters created + # with Aurora MySQL version 5.6.10a. For higher Aurora MySQL versions, + # the clusters in a global database use `provisioned` engine mode. + # + # </note> + # # Limitations and requirements apply to some DB engine modes. For more # information, see the following sections in the *Amazon Aurora User # Guide*\: # # * [ Limitations of Aurora Serverless][1] @@ -2180,16 +2185,16 @@ # @option params [String] :domain # The Active Directory directory ID to create the DB cluster in. # # For Amazon Aurora DB clusters, Amazon RDS can use Kerberos # Authentication to authenticate users that connect to the DB cluster. - # For more information, see [Using Kerberos Authentication for Aurora - # MySQL][1] in the *Amazon Aurora User Guide*. + # For more information, see [Kerberos Authentication][1] in the *Amazon + # Aurora User Guide*. # # # - # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurmysql-kerberos.html + # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/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. # @@ -3094,11 +3099,11 @@ # # Constraints: # # * Must be a value from 0 to 35 # - # * Can't be set to 0 if the DB instance is a source to Read Replicas + # * Can't be set to 0 if the DB instance is a source to read replicas # # @option params [String] :preferred_backup_window # The daily time range during which automated backups are created if # automated backups are enabled, using the `BackupRetentionPeriod` # parameter. For more information, see [The Backup Window][1] in the @@ -3134,48 +3139,48 @@ # # **MySQL** # # Default: `3306` # - # Valid Values: `1150-65535` + # Valid values: `1150-65535` # # Type: Integer # # **MariaDB** # # Default: `3306` # - # Valid Values: `1150-65535` + # Valid values: `1150-65535` # # Type: Integer # # **PostgreSQL** # # Default: `5432` # - # Valid Values: `1150-65535` + # Valid values: `1150-65535` # # Type: Integer # # **Oracle** # # Default: `1521` # - # Valid Values: `1150-65535` + # Valid values: `1150-65535` # # **SQL Server** # # Default: `1433` # - # Valid Values: `1150-65535` except for `1434`, `3389`, `47001`, - # `49152`, and `49152` through `49156`. + # Valid values: `1150-65535` except `1234`, `1434`, `3260`, `3343`, + # `3389`, `47001`, and `49152-49156`. # # **Amazon Aurora** # # Default: `3306` # - # Valid Values: `1150-65535` + # Valid values: `1150-65535` # # Type: Integer # # @option params [Boolean] :multi_az # A value that indicates whether the DB instance is a Multi-AZ @@ -3364,19 +3369,17 @@ # Authentication to authenticate users that connect to the DB instance. # For more information, see [ Using Windows Authentication with an # Amazon RDS DB Instance Running Microsoft SQL Server][1] in the *Amazon # RDS User Guide*. # - # For Oracle DB instance, Amazon RDS can use Kerberos Authentication to + # For Oracle DB instances, Amazon RDS can use Kerberos Authentication to # authenticate users that connect to the DB instance. For more # information, see [ Using Kerberos Authentication with Amazon RDS for # Oracle][2] in the *Amazon RDS User Guide*. # # # - # - # # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_SQLServerWinAuth.html # [2]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-kerberos.html # # @option params [Boolean] :copy_tags_to_snapshot # A value that indicates whether to copy tags from the DB instance to @@ -3743,72 +3746,79 @@ def create_db_instance(params = {}, options = {}) 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, or PostgreSQL. For more information, - # see [Working with Read Replicas][1] in the *Amazon RDS User Guide*. + # 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*. # - # Amazon Aurora doesn't support this action. You must call the + # Amazon Aurora doesn't support this action. Call the # `CreateDBInstance` action to create a DB instance for an Aurora DB # cluster. # - # All Read Replica DB instances are created with backups disabled. All + # 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 following. + # specified. # # Your source DB instance must have backup retention enabled. # # # # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_ReadRepl.html # # @option params [required, String] :db_instance_identifier - # The DB instance identifier of the Read Replica. This identifier is the + # 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 # 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 five read replicas. # # Constraints: # - # * Must be the identifier of an existing MySQL, MariaDB, Oracle, or - # PostgreSQL DB instance. + # * 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 + # * Can specify a DB instance that is a MySQL read replica only if the # source is running MySQL 5.6 or later. # - # * For the limitations of Oracle Read Replicas, see [Read Replica + # * For the limitations of Oracle read replicas, see [Read Replica # Limitations with Oracle][1] in the *Amazon RDS User Guide*. # - # * Can specify a DB instance that is 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). + # * For the limitations of SQL Server read replicas, see [Read Replica + # Limitations with Microsoft SQL Server][2] in the *Amazon RDS User + # Guide*. # - # * The specified DB instance must have automatic backups enabled, its - # backup retention period must be greater than 0. + # * 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). # - # * If the source DB instance is in the same AWS Region as the Read - # Replica, specify a valid DB instance identifier. + # * 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 a different AWS Region than the Read - # Replica, specify a valid DB instance ARN. For more information, go - # to [ Constructing an ARN for Amazon RDS][2] in the *Amazon RDS User - # Guide*. + # * If the source DB instance is in the same AWS Region as the read + # replica, specify a valid DB instance identifier. # + # * If the source DB instance is in a different AWS Region from the read + # replica, specify a valid DB instance ARN. For more information, see + # [Constructing an ARN for Amazon RDS][3] in the *Amazon RDS User + # Guide*. This doesn't apply to SQL Server, which doesn'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/USER_Tagging.ARN.html#USER_Tagging.ARN.Constructing + # [2]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/SQLServer.ReadReplicas.Limitations.html + # [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, + # The compute and memory capacity of the read replica, for example, # `db.m4.large`. Not all DB instance classes are available in all AWS # Regions, or for all database engines. For the full list of DB instance # classes, and availability for your engine, see [DB Instance Class][1] # in the *Amazon RDS User Guide.* # @@ -3817,11 +3827,11 @@ # # # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html # # @option params [String] :availability_zone - # The Availability Zone (AZ) where the Read Replica will be created. + # The Availability Zone (AZ) where the read replica will be created. # # Default: A random, system-chosen Availability Zone in the endpoint's # AWS Region. # # Example: `us-east-1d` @@ -3832,22 +3842,22 @@ # Default: Inherits from the source DB instance # # Valid Values: `1150-65535` # # @option params [Boolean] :multi_az - # A value that indicates whether the Read Replica is in a Multi-AZ + # A value that indicates whether the read replica is in a Multi-AZ # deployment. # - # You can create a Read Replica as a Multi-AZ DB instance. RDS creates a + # 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 + # 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. # # @option params [Boolean] :auto_minor_version_upgrade # A value that indicates whether minor engine upgrades are applied - # automatically to the Read Replica during the maintenance window. + # automatically to the read replica during the maintenance window. # # Default: Inherits from the source DB instance # # @option params [Integer] :iops # The amount of Provisioned IOPS (input/output operations per second) to @@ -3855,17 +3865,22 @@ # # @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. # + # <note markdown="1"> For SQL Server, you must use the option group associated with the + # source instance. + # + # </note> + # # @option params [String] :db_parameter_group_name # The name of the DB parameter group to associate with this DB instance. # # If you do not specify a value for `DBParameterGroupName`, then Amazon # RDS uses the `DBParameterGroup` of source DB instance for a same - # region Read Replica, or the default `DBParameterGroup` for the - # specified DB engine for a cross region Read Replica. + # region read replica, or the default `DBParameterGroup` for the + # specified DB engine for a cross region read replica. # # <note markdown="1"> Currently, specifying a parameter group for this operation is only # supported for Oracle DB instances. # # </note> @@ -3908,44 +3923,44 @@ # * If supplied, must match the name of an existing DBSubnetGroup. # # * The specified DB subnet group must be in the same AWS Region in # which the operation is running. # - # * All Read Replicas in one AWS Region that are created from the same + # * All read replicas in one AWS Region that are created from the same # source DB instance must either:&gt; # - # * Specify DB subnet groups from the same VPC. All these Read - # Replicas are created in the same VPC. + # * Specify DB subnet groups from the same VPC. All these read + # replicas are created in the same VPC. # - # * Not specify a DB subnet group. All these Read Replicas are created + # * Not specify a DB subnet group. All these read replicas are created # outside of any VPC. # # Example: `mySubnetgroup` # # @option params [Array<String>] :vpc_security_group_ids - # A list of EC2 VPC security groups to associate with the Read Replica. + # A list of EC2 VPC security groups to associate with the read replica. # # Default: The default EC2 VPC security group for the DB subnet group's # VPC. # # @option params [String] :storage_type - # Specifies the storage type to be associated with the Read Replica. + # Specifies the storage type to be associated with the read replica. # # 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 `gp2` # # @option params [Boolean] :copy_tags_to_snapshot - # A value that indicates whether to copy all tags from the Read Replica - # to snapshots of the Read Replica. By default, tags are not copied. + # A value that indicates whether to copy all tags from the read replica + # to snapshots of the read replica. By default, tags are not copied. # # @option params [Integer] :monitoring_interval # The interval, in seconds, between points when Enhanced Monitoring - # metrics are collected for the Read Replica. To disable collecting + # metrics are collected for the read replica. To disable collecting # Enhanced Monitoring metrics, specify 0. The default is 0. # # If `MonitoringRoleArn` is specified, then you must also set # `MonitoringInterval` to a value other than 0. # @@ -3964,44 +3979,44 @@ # # # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Monitoring.html#USER_Monitoring.OS.IAMRole # # @option params [String] :kms_key_id - # The AWS KMS key ID for an encrypted Read Replica. The KMS key ID is + # The AWS KMS key ID for an encrypted read replica. 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 create an encrypted Read Replica in the same AWS Region as the + # If you create an encrypted read replica in the same AWS Region as the # source DB instance, then you do not have to specify a value for this - # parameter. The Read Replica is encrypted with the same KMS key as the + # parameter. The read replica is encrypted with the same KMS key as the # source DB instance. # - # If you create an encrypted Read Replica in a different AWS Region, + # If you create an encrypted read replica in a different AWS Region, # then you must specify a KMS key for the destination AWS Region. KMS # encryption keys are specific to the AWS Region that they are created # in, and you can't use encryption keys from one AWS Region in another # AWS Region. # - # You can't create an encrypted Read Replica from an unencrypted DB + # You can't create an encrypted read replica from an unencrypted DB # instance. # # @option params [String] :pre_signed_url # The URL that contains a Signature Version 4 signed request for the # `CreateDBInstanceReadReplica` API action in the source AWS Region that # contains the source DB instance. # - # You must specify this parameter when you create an encrypted Read - # Replica from another AWS Region by using the Amazon RDS API. Don't - # specify `PreSignedUrl` when you are creating an encrypted Read Replica + # You must specify this parameter when you create an encrypted read + # replica from another AWS Region by using the Amazon RDS API. Don't + # specify `PreSignedUrl` when you are creating an encrypted read replica # in the same AWS Region. # # The presigned URL must be a valid request for the # `CreateDBInstanceReadReplica` API action that can be executed in the # source AWS Region that contains the encrypted source DB instance. The # presigned URL request must contain the following parameter values: # - # * `DestinationRegion` - The AWS Region that the encrypted Read Replica + # * `DestinationRegion` - The AWS Region that the encrypted read replica # is created in. This AWS Region is the same one where the # `CreateDBInstanceReadReplica` action is called that contains this # presigned URL. # # For example, if you create an encrypted DB instance in the us-west-1 @@ -4011,19 +4026,19 @@ # call to the `CreateDBInstanceReadReplica` action in the us-west-2 # AWS Region. For this example, the `DestinationRegion` in the # presigned URL must be set to the us-east-1 AWS Region. # # * `KmsKeyId` - The AWS KMS key identifier for the key to use to - # encrypt the Read Replica in the destination AWS Region. This is the + # encrypt the read replica in the destination AWS Region. This is the # same identifier for both the `CreateDBInstanceReadReplica` action # that is called in the destination AWS Region, and the action # contained in the presigned URL. # # * `SourceDBInstanceIdentifier` - The DB instance identifier for the # encrypted DB instance to be replicated. This identifier must be in # the Amazon Resource Name (ARN) format for the source AWS Region. For - # example, if you are creating an encrypted Read Replica from a DB + # example, if you are creating an encrypted read replica from a DB # instance in the us-west-2 AWS Region, then your # `SourceDBInstanceIdentifier` looks like the following example: # `arn:aws:rds:us-west-2:123456789012:instance:mysql-instance1-20161115`. # # To learn how to generate a Signature Version 4 signed request, see @@ -4031,13 +4046,16 @@ # Version 4)][1] and [Signature Version 4 Signing Process][2]. # # <note markdown="1"> If you are using an AWS SDK tool or the AWS CLI, you can specify # `SourceRegion` (or `--source-region` for the AWS CLI) instead of # specifying `PreSignedUrl` manually. Specifying `SourceRegion` - # autogenerates a pre-signed URL that is a valid request for the + # autogenerates a presigned URL that is a valid request for the # operation that can be executed in the source AWS Region. # + # `SourceRegion` isn't supported for SQL Server, because SQL Server on + # Amazon RDS doesn't support cross-region read replicas. + # # </note> # # # # [1]: https://docs.aws.amazon.com/AmazonS3/latest/API/sigv4-query-string-auth.html @@ -4057,11 +4075,11 @@ # # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.html # # @option params [Boolean] :enable_performance_insights # A value that indicates whether to enable Performance Insights for the - # Read Replica. + # read replica. # # For more information, see [Using Amazon Performance Insights][1] in # the *Amazon RDS User Guide*. # # @@ -4116,13 +4134,20 @@ # For Oracle DB instances, Amazon RDS can use Kerberos Authentication to # authenticate users that connect to the DB instance. For more # information, see [ Using Kerberos Authentication with Amazon RDS for # Oracle][1] in the *Amazon RDS User Guide*. # + # For Microsoft SQL Server DB instances, Amazon RDS can use Windows + # Authentication to authenticate users that connect to the DB instance. + # For more information, see [ Using Windows Authentication with an + # Amazon RDS DB Instance Running Microsoft SQL Server][2] in the *Amazon + # RDS User Guide*. # # + # # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-kerberos.html + # [2]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_SQLServerWinAuth.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. # @@ -5629,18 +5654,18 @@ # # If the specified DB instance is part of an Amazon Aurora DB cluster, # you can't delete the DB instance if both of the following conditions # are true: # - # * The DB cluster is a Read Replica of another Amazon Aurora DB + # * The DB cluster is a read replica of another Amazon Aurora DB # cluster. # # * The DB instance is the only instance in the DB cluster. # # To delete a DB instance in this case, first call the # `PromoteReadReplicaDBCluster` API action to promote the DB cluster so - # it's no longer a Read Replica. After the promotion completes, then + # it's no longer a read replica. After the promotion completes, then # call the `DeleteDBInstance` API action to delete the final instance in # the DB cluster. # # @option params [required, String] :db_instance_identifier # The DB instance identifier for the DB instance to be deleted. This @@ -5661,11 +5686,11 @@ # # When a DB instance is in a failure state and has a status of # 'failed', 'incompatible-restore', or 'incompatible-network', it # can only be deleted when skip is specified. # - # Specify skip when deleting a Read Replica. + # Specify skip when deleting a read replica. # # <note markdown="1"> The FinalDBSnapshotIdentifier parameter must be specified if skip # isn't specified. # # </note> @@ -5685,11 +5710,11 @@ # # * First character must be a letter. # # * Can't end with a hyphen or contain two consecutive hyphens. # - # * Can't be specified when deleting a Read Replica. + # * Can't be specified when deleting a read replica. # # @option params [Boolean] :delete_automated_backups # A value that indicates whether to remove automated backups immediately # after the DB instance is deleted. This parameter isn't # case-sensitive. The default is to remove automated backups immediately @@ -6557,10 +6582,12 @@ # @return [Types::CustomAvailabilityZoneMessage] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::CustomAvailabilityZoneMessage#marker #marker} => String # * {Types::CustomAvailabilityZoneMessage#custom_availability_zones #custom_availability_zones} => Array&lt;Types::CustomAvailabilityZone&gt; # + # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}. + # # @example Request syntax with placeholder values # # resp = client.describe_custom_availability_zones({ # custom_availability_zone_id: "String", # filters: [ @@ -7252,10 +7279,16 @@ # resp.db_cluster_snapshots[0].kms_key_id #=> String # resp.db_cluster_snapshots[0].db_cluster_snapshot_arn #=> String # resp.db_cluster_snapshots[0].source_db_cluster_snapshot_arn #=> String # resp.db_cluster_snapshots[0].iam_database_authentication_enabled #=> Boolean # + # + # The following waiters are defined for this operation (see {Client#wait_until} for detailed usage): + # + # * db_cluster_snapshot_available + # * db_cluster_snapshot_deleted + # # @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DescribeDBClusterSnapshots AWS API Documentation # # @overload describe_db_cluster_snapshots(params = {}) # @param [Hash] params ({}) def describe_db_cluster_snapshots(params = {}, options = {}) @@ -7323,11 +7356,13 @@ # @return [Types::DBClusterMessage] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::DBClusterMessage#marker #marker} => String # * {Types::DBClusterMessage#db_clusters #db_clusters} => Array&lt;Types::DBCluster&gt; # + # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}. # + # # @example Example: To list DB clusters # # # This example lists settings for the specified DB cluster. # # resp = client.describe_db_clusters({ @@ -7508,11 +7543,13 @@ # @return [Types::DBEngineVersionMessage] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::DBEngineVersionMessage#marker #marker} => String # * {Types::DBEngineVersionMessage#db_engine_versions #db_engine_versions} => Array&lt;Types::DBEngineVersion&gt; # + # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}. # + # # @example Example: To list DB engine version settings # # # This example lists settings for the specified DB engine version. # # resp = client.describe_db_engine_versions({ @@ -7648,10 +7685,12 @@ # @return [Types::DBInstanceAutomatedBackupMessage] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::DBInstanceAutomatedBackupMessage#marker #marker} => String # * {Types::DBInstanceAutomatedBackupMessage#db_instance_automated_backups #db_instance_automated_backups} => Array&lt;Types::DBInstanceAutomatedBackup&gt; # + # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}. + # # @example Request syntax with placeholder values # # resp = client.describe_db_instance_automated_backups({ # dbi_resource_id: "String", # db_instance_identifier: "String", @@ -7766,11 +7805,13 @@ # @return [Types::DBInstanceMessage] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::DBInstanceMessage#marker #marker} => String # * {Types::DBInstanceMessage#db_instances #db_instances} => Array&lt;Types::DBInstance&gt; # + # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}. # + # # @example Example: To list DB instance settings # # # This example lists settings for the specified DB instance. # # resp = client.describe_db_instances({ @@ -7911,10 +7952,16 @@ # resp.db_instances[0].listener_endpoint.address #=> String # resp.db_instances[0].listener_endpoint.port #=> Integer # resp.db_instances[0].listener_endpoint.hosted_zone_id #=> String # resp.db_instances[0].max_allocated_storage #=> Integer # + # + # The following waiters are defined for this operation (see {Client#wait_until} for detailed usage): + # + # * db_instance_available + # * db_instance_deleted + # # @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DescribeDBInstances AWS API Documentation # # @overload describe_db_instances(params = {}) # @param [Hash] params ({}) def describe_db_instances(params = {}, options = {}) @@ -7963,11 +8010,13 @@ # @return [Types::DescribeDBLogFilesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::DescribeDBLogFilesResponse#describe_db_log_files #describe_db_log_files} => Array&lt;Types::DescribeDBLogFilesDetails&gt; # * {Types::DescribeDBLogFilesResponse#marker #marker} => String # + # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}. # + # # @example Example: To list DB log file names # # # This example lists matching log file names for the specified DB instance, file name pattern, last write date in POSIX # # time with milleseconds, and minimum file size. # @@ -8052,11 +8101,13 @@ # @return [Types::DBParameterGroupsMessage] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::DBParameterGroupsMessage#marker #marker} => String # * {Types::DBParameterGroupsMessage#db_parameter_groups #db_parameter_groups} => Array&lt;Types::DBParameterGroup&gt; # + # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}. # + # # @example Example: To list information about DB parameter groups # # # This example lists information about the specified DB parameter group. # # resp = client.describe_db_parameter_groups({ @@ -8140,11 +8191,13 @@ # @return [Types::DBParameterGroupDetails] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::DBParameterGroupDetails#parameters #parameters} => Array&lt;Types::Parameter&gt; # * {Types::DBParameterGroupDetails#marker #marker} => String # + # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}. # + # # @example Example: To list information about DB parameters # # # This example lists information for up to the first 20 system parameters for the specified DB parameter group. # # resp = client.describe_db_parameters({ @@ -8229,10 +8282,12 @@ # @return [Types::DescribeDBProxiesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::DescribeDBProxiesResponse#db_proxies #db_proxies} => Array&lt;Types::DBProxy&gt; # * {Types::DescribeDBProxiesResponse#marker #marker} => String # + # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}. + # # @example Request syntax with placeholder values # # resp = client.describe_db_proxies({ # db_proxy_name: "String", # filters: [ @@ -8315,10 +8370,12 @@ # @return [Types::DescribeDBProxyTargetGroupsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::DescribeDBProxyTargetGroupsResponse#target_groups #target_groups} => Array&lt;Types::DBProxyTargetGroup&gt; # * {Types::DescribeDBProxyTargetGroupsResponse#marker #marker} => String # + # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}. + # # @example Request syntax with placeholder values # # resp = client.describe_db_proxy_target_groups({ # db_proxy_name: "String", # required # target_group_name: "String", @@ -8394,10 +8451,12 @@ # @return [Types::DescribeDBProxyTargetsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::DescribeDBProxyTargetsResponse#targets #targets} => Array&lt;Types::DBProxyTarget&gt; # * {Types::DescribeDBProxyTargetsResponse#marker #marker} => String # + # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}. + # # @example Request syntax with placeholder values # # resp = client.describe_db_proxy_targets({ # db_proxy_name: "String", # required # target_group_name: "String", @@ -8460,11 +8519,13 @@ # @return [Types::DBSecurityGroupMessage] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::DBSecurityGroupMessage#marker #marker} => String # * {Types::DBSecurityGroupMessage#db_security_groups #db_security_groups} => Array&lt;Types::DBSecurityGroup&gt; # + # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}. # + # # @example Example: To list DB security group settings # # # This example lists settings for the specified security group. # # resp = client.describe_db_security_groups({ @@ -8697,11 +8758,13 @@ # @return [Types::DBSnapshotMessage] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::DBSnapshotMessage#marker #marker} => String # * {Types::DBSnapshotMessage#db_snapshots #db_snapshots} => Array&lt;Types::DBSnapshot&gt; # + # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}. # + # # @example Example: To list DB snapshot attributes # # # This example lists all manually-created, shared snapshots for the specified DB instance. # # resp = client.describe_db_snapshots({ @@ -8767,10 +8830,16 @@ # resp.db_snapshots[0].processor_features #=> Array # resp.db_snapshots[0].processor_features[0].name #=> String # resp.db_snapshots[0].processor_features[0].value #=> String # resp.db_snapshots[0].dbi_resource_id #=> String # + # + # The following waiters are defined for this operation (see {Client#wait_until} for detailed usage): + # + # * db_snapshot_available + # * db_snapshot_deleted + # # @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DescribeDBSnapshots AWS API Documentation # # @overload describe_db_snapshots(params = {}) # @param [Hash] params ({}) def describe_db_snapshots(params = {}, options = {}) @@ -8813,11 +8882,13 @@ # @return [Types::DBSubnetGroupMessage] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::DBSubnetGroupMessage#marker #marker} => String # * {Types::DBSubnetGroupMessage#db_subnet_groups #db_subnet_groups} => Array&lt;Types::DBSubnetGroup&gt; # + # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}. # + # # @example Example: To list information about DB subnet groups # # # This example lists information about the specified DB subnet group. # # resp = client.describe_db_subnet_groups({ @@ -8985,11 +9056,13 @@ # # @return [Types::DescribeEngineDefaultParametersResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::DescribeEngineDefaultParametersResult#engine_defaults #engine_defaults} => Types::EngineDefaults # + # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}. # + # # @example Example: To list default parameters for a DB engine # # # This example lists default parameters for the specified DB engine. # # resp = client.describe_engine_default_parameters({ @@ -9139,11 +9212,13 @@ # @return [Types::EventSubscriptionsMessage] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::EventSubscriptionsMessage#marker #marker} => String # * {Types::EventSubscriptionsMessage#event_subscriptions_list #event_subscriptions_list} => Array&lt;Types::EventSubscription&gt; # + # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}. # + # # @example Example: To list information about DB event notification subscriptions # # # This example lists information for the specified DB event notification subscription. # # resp = client.describe_event_subscriptions({ @@ -9278,11 +9353,13 @@ # @return [Types::EventsMessage] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::EventsMessage#marker #marker} => String # * {Types::EventsMessage#events #events} => Array&lt;Types::Event&gt; # + # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}. # + # # @example Example: To list information about events # # # This example lists information for all backup-related events for the specified DB instance for the past 7 days (7 days * # # 24 hours * 60 minutes = 10,080 minutes). # @@ -9384,10 +9461,12 @@ # @return [Types::ExportTasksMessage] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::ExportTasksMessage#marker #marker} => String # * {Types::ExportTasksMessage#export_tasks #export_tasks} => Array&lt;Types::ExportTask&gt; # + # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}. + # # @example Request syntax with placeholder values # # resp = client.describe_export_tasks({ # export_task_identifier: "String", # source_arn: "String", @@ -9486,10 +9565,12 @@ # @return [Types::GlobalClustersMessage] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::GlobalClustersMessage#marker #marker} => String # * {Types::GlobalClustersMessage#global_clusters #global_clusters} => Array&lt;Types::GlobalCluster&gt; # + # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}. + # # @example Request syntax with placeholder values # # resp = client.describe_global_clusters({ # global_cluster_identifier: "String", # filters: [ @@ -9566,10 +9647,12 @@ # @return [Types::InstallationMediaMessage] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::InstallationMediaMessage#marker #marker} => String # * {Types::InstallationMediaMessage#installation_media #installation_media} => Array&lt;Types::InstallationMedia&gt; # + # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}. + # # @example Request syntax with placeholder values # # resp = client.describe_installation_media({ # installation_media_id: "String", # filters: [ @@ -9635,11 +9718,13 @@ # @return [Types::OptionGroupOptionsMessage] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::OptionGroupOptionsMessage#option_group_options #option_group_options} => Array&lt;Types::OptionGroupOption&gt; # * {Types::OptionGroupOptionsMessage#marker #marker} => String # + # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}. # + # # @example Example: To list information about DB option group options # # # This example lists information for all option group options for the specified DB engine. # # resp = client.describe_option_group_options({ @@ -9747,11 +9832,13 @@ # @return [Types::OptionGroups] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::OptionGroups#option_groups_list #option_groups_list} => Array&lt;Types::OptionGroup&gt; # * {Types::OptionGroups#marker #marker} => String # + # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}. # + # # @example Example: To list information about DB option groups # # # This example lists information for all option groups for the specified DB engine. # # resp = client.describe_option_groups({ @@ -9866,11 +9953,13 @@ # @return [Types::OrderableDBInstanceOptionsMessage] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::OrderableDBInstanceOptionsMessage#orderable_db_instance_options #orderable_db_instance_options} => Array&lt;Types::OrderableDBInstanceOption&gt; # * {Types::OrderableDBInstanceOptionsMessage#marker #marker} => String # + # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}. # + # # @example Example: To list information about orderable DB instance options # # # This example lists information for all orderable DB instance options for the specified DB engine, engine version, DB # # instance class, license model, and VPC settings. # @@ -10105,11 +10194,13 @@ # @return [Types::ReservedDBInstanceMessage] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::ReservedDBInstanceMessage#marker #marker} => String # * {Types::ReservedDBInstanceMessage#reserved_db_instances #reserved_db_instances} => Array&lt;Types::ReservedDBInstance&gt; # + # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}. # + # # @example Example: To list information about reserved DB instances # # # This example lists information for all reserved DB instances for the specified DB instance class, duration, product, # # offering type, and availability zone settings. # @@ -10237,11 +10328,13 @@ # @return [Types::ReservedDBInstancesOfferingMessage] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::ReservedDBInstancesOfferingMessage#marker #marker} => String # * {Types::ReservedDBInstancesOfferingMessage#reserved_db_instances_offerings #reserved_db_instances_offerings} => Array&lt;Types::ReservedDBInstancesOffering&gt; # + # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}. # + # # @example Example: To list information about reserved DB instance offerings # # # This example lists information for all reserved DB instance offerings for the specified DB instance class, duration, # # product, offering type, and availability zone settings. # @@ -10301,11 +10394,11 @@ req = build_request(:describe_reserved_db_instances_offerings, params) req.send_request(options) end # Returns a list of the source AWS Regions where the current AWS Region - # can create a Read Replica or copy a DB snapshot from. This API action + # can create a read replica or copy a DB snapshot from. This API action # supports pagination. # # @option params [String] :region_name # The source AWS Region name. For example, `us-east-1`. # @@ -10532,11 +10625,13 @@ # # * {Types::DownloadDBLogFilePortionDetails#log_file_data #log_file_data} => String # * {Types::DownloadDBLogFilePortionDetails#marker #marker} => String # * {Types::DownloadDBLogFilePortionDetails#additional_data_pending #additional_data_pending} => Boolean # + # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}. # + # # @example Example: To list information about DB log files # # # This example lists information for the specified log file for the specified DB instance. # # resp = client.download_db_log_file_portion({ @@ -11954,17 +12049,17 @@ # # Constraints: # # * Must be a value from 0 to 35 # - # * Can be specified for a MySQL Read Replica only if the source is + # * Can be specified for a MySQL read replica only if the source is # running MySQL 5.6 or later # - # * Can be specified for a PostgreSQL Read Replica only if the source is + # * Can be specified for a PostgreSQL read replica only if the source is # running PostgreSQL 9.3.5 # - # * Can't be set to 0 if the DB instance is a source to Read Replicas + # * Can't be set to 0 if the DB instance is a source to read replicas # # @option params [String] :preferred_backup_window # The daily time range during which automated backups are created if # automated backups are enabled, as determined by the # `BackupRetentionPeriod` parameter. Changing this parameter doesn't @@ -12071,11 +12166,11 @@ # process can take up to several days in some cases. During the # migration, the DB instance is available for use, but might experience # performance degradation. While the migration takes place, nightly # backups for the instance are suspended. No other Amazon RDS operations # can take place for the instance, including modifying the instance, - # rebooting the instance, deleting the instance, creating a Read Replica + # rebooting the instance, deleting the instance, creating a read replica # for the instance, and creating a DB snapshot of the instance. # # Constraints: For MariaDB, MySQL, Oracle, and PostgreSQL, the value # supplied must be at least 10% greater than the current value. Values # that are not at least 10% greater than the existing value are rounded @@ -12131,11 +12226,11 @@ # process can take up to several days in some cases. During the # migration, the DB instance is available for use, but might experience # performance degradation. While the migration takes place, nightly # backups for the instance are suspended. No other Amazon RDS operations # can take place for the instance, including modifying the instance, - # rebooting the instance, deleting the instance, creating a Read Replica + # rebooting the instance, deleting the instance, creating a read replica # for the instance, and creating a DB snapshot of the instance. # # Valid values: `standard | gp2 | io1` # # Default: `io1` if the `Iops` parameter is specified, otherwise `gp2` @@ -12207,44 +12302,44 @@ # # **MySQL** # # Default: `3306` # - # Valid Values: `1150-65535` + # Valid values: `1150-65535` # # **MariaDB** # # Default: `3306` # - # Valid Values: `1150-65535` + # Valid values: `1150-65535` # # **PostgreSQL** # # Default: `5432` # - # Valid Values: `1150-65535` + # Valid values: `1150-65535` # # Type: Integer # # **Oracle** # # Default: `1521` # - # Valid Values: `1150-65535` + # Valid values: `1150-65535` # # **SQL Server** # # Default: `1433` # - # Valid Values: `1150-65535` except for `1434`, `3389`, `47001`, - # `49152`, and `49152` through `49156`. + # Valid values: `1150-65535` except `1234`, `1434`, `3260`, `3343`, + # `3389`, `47001`, and `49152-49156`. # # **Amazon Aurora** # # Default: `3306` # - # Valid Values: `1150-65535` + # Valid values: `1150-65535` # # @option params [Boolean] :publicly_accessible # 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 @@ -12872,12 +12967,12 @@ def modify_db_proxy_target_group(params = {}, options = {}) req = build_request(:modify_db_proxy_target_group, params) req.send_request(options) end - # Updates a manual DB snapshot, which can be encrypted or not encrypted, - # with a new engine version. + # Updates a manual DB snapshot with a new engine version. The snapshot + # can be encrypted or unencrypted, but not shared or public. # # Amazon RDS supports upgrading DB snapshots for MySQL, Oracle, and # PostgreSQL. # # @option params [required, String] :db_snapshot_identifier @@ -13452,20 +13547,20 @@ def modify_option_group(params = {}, options = {}) req = build_request(:modify_option_group, params) req.send_request(options) end - # Promotes a Read Replica DB instance to a standalone DB instance. + # Promotes a read replica DB instance to a standalone DB instance. # # <note markdown="1"> * Backup duration is a function of the amount of changes to the - # database since the previous backup. If you plan to promote a Read - # Replica to a standalone instance, we recommend that you enable + # database since the previous backup. If you plan to promote a read + # replica to a standalone instance, we recommend that you enable # backups and complete at least one backup prior to promotion. In - # addition, a Read Replica cannot be promoted to a standalone instance + # addition, a read replica cannot be promoted to a standalone instance # when it is in the `backing-up` status. If you have enabled backups - # on your Read Replica, configure the automated backup window so that - # daily backups do not interfere with Read Replica promotion. + # on your read replica, configure the automated backup window so that + # daily backups do not interfere with read replica promotion. # # * This command doesn't apply to Aurora MySQL and Aurora PostgreSQL. # # </note> # @@ -13473,11 +13568,11 @@ # The DB instance identifier. This value is stored as a lowercase # string. # # Constraints: # - # * Must match the identifier of an existing Read Replica DB instance. + # * Must match the identifier of an existing read replica DB instance. # # ^ # # Example: `mydbinstance` # @@ -13490,11 +13585,11 @@ # # Constraints: # # * Must be a value from 0 to 35. # - # * Can't be set to 0 if the DB instance is a source to Read Replicas. + # * Can't be set to 0 if the DB instance is a source to read replicas. # # @option params [String] :preferred_backup_window # The daily time range during which automated backups are created if # automated backups are enabled, using the `BackupRetentionPeriod` # parameter. @@ -13670,23 +13765,23 @@ def promote_read_replica(params = {}, options = {}) req = build_request(:promote_read_replica, params) req.send_request(options) end - # Promotes a Read Replica DB cluster to a standalone DB cluster. + # Promotes a read replica DB cluster to a standalone DB cluster. # # <note markdown="1"> This action only applies to Aurora DB clusters. # # </note> # # @option params [required, String] :db_cluster_identifier - # The identifier of the DB cluster Read Replica to promote. This + # The identifier of the DB cluster read replica to promote. This # parameter isn't case-sensitive. # # Constraints: # - # * Must match the identifier of an existing DBCluster Read Replica. + # * Must match the identifier of an existing DB cluster read replica. # # ^ # # Example: `my-cluster-replica1` # @@ -14844,16 +14939,16 @@ # Specify the Active Directory directory ID to restore the DB cluster # in. The domain must be created prior to this operation. # # For Amazon Aurora DB clusters, Amazon RDS can use Kerberos # Authentication to authenticate users that connect to the DB cluster. - # For more information, see [Using Kerberos Authentication for Aurora - # MySQL][1] in the *Amazon Aurora User Guide*. + # For more information, see [Kerberos Authentication][1] in the *Amazon + # Aurora User Guide*. # # # - # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurmysql-kerberos.html + # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/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. # @@ -14988,30 +15083,30 @@ req = build_request(:restore_db_cluster_from_s3, params) req.send_request(options) end # Creates a new DB cluster from a DB snapshot or DB cluster snapshot. + # This action only applies to Aurora DB clusters. # - # If a DB snapshot is specified, the target DB cluster is created from - # the source DB snapshot with a default configuration and default - # security group. + # The target DB cluster is created from the source snapshot with a + # default configuration. If you don't specify a security group, the new + # DB cluster is associated with the default security group. # - # If a DB cluster snapshot is specified, the target DB cluster is - # created from the source DB cluster restore point with the same - # configuration as the original source DB cluster. If you don't specify - # a security group, the new DB cluster is associated with the default - # security group. + # <note markdown="1"> This action only restores the DB cluster, not the DB instances for + # that DB cluster. You must invoke the `CreateDBInstance` action to + # create DB instances for the restored DB cluster, specifying the + # identifier of the restored DB cluster in `DBClusterIdentifier`. You + # can create DB instances only after the `RestoreDBClusterFromSnapshot` + # action has completed and the DB cluster is available. # + # </note> + # # For more information on Amazon Aurora, see [ What Is Amazon # Aurora?][1] in the *Amazon Aurora User Guide.* # - # <note markdown="1"> This action only applies to Aurora DB clusters. # - # </note> # - # - # # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html # # @option params [Array<String>] :availability_zones # Provides the list of Availability Zones (AZs) where instances in the # restored DB cluster can be created. @@ -15570,16 +15665,16 @@ # Specify the Active Directory directory ID to restore the DB cluster # in. The domain must be created prior to this operation. # # For Amazon Aurora DB clusters, Amazon RDS can use Kerberos # Authentication to authenticate users that connect to the DB cluster. - # For more information, see [Using Kerberos Authentication for Aurora - # MySQL][1] in the *Amazon Aurora User Guide*. + # For more information, see [Kerberos Authentication][1] in the *Amazon + # Aurora User Guide*. # # # - # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurmysql-kerberos.html + # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/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. # @@ -18282,11 +18377,11 @@ operation: config.api.operation(operation_name), client: self, params: params, config: config) context[:gem_name] = 'aws-sdk-rds' - context[:gem_version] = '1.80.0' + context[:gem_version] = '1.81.0' Seahorse::Client::Request.new(handlers, context) end # Polls an API operation until a resource enters a desired state. # @@ -18348,17 +18443,17 @@ # ## Valid Waiters # # The following table lists the valid waiter names, the operations they call, # and the default `:delay` and `:max_attempts` values. # - # | waiter_name | params | :delay | :max_attempts | - # | ----------------------------- | -------------------------------- | -------- | ------------- | - # | db_cluster_snapshot_available | {#describe_db_cluster_snapshots} | 30 | 60 | - # | db_cluster_snapshot_deleted | {#describe_db_cluster_snapshots} | 30 | 60 | - # | db_instance_available | {#describe_db_instances} | 30 | 60 | - # | db_instance_deleted | {#describe_db_instances} | 30 | 60 | - # | db_snapshot_available | {#describe_db_snapshots} | 30 | 60 | - # | db_snapshot_deleted | {#describe_db_snapshots} | 30 | 60 | + # | waiter_name | params | :delay | :max_attempts | + # | ----------------------------- | -------------------------------------- | -------- | ------------- | + # | db_cluster_snapshot_available | {Client#describe_db_cluster_snapshots} | 30 | 60 | + # | db_cluster_snapshot_deleted | {Client#describe_db_cluster_snapshots} | 30 | 60 | + # | db_instance_available | {Client#describe_db_instances} | 30 | 60 | + # | db_instance_deleted | {Client#describe_db_instances} | 30 | 60 | + # | db_snapshot_available | {Client#describe_db_snapshots} | 30 | 60 | + # | db_snapshot_deleted | {Client#describe_db_snapshots} | 30 | 60 | # # @raise [Errors::FailureStateError] Raised when the waiter terminates # because the waiter has entered a state that it will not transition # out of, preventing success. #