lib/aws-sdk-rds/client.rb in aws-sdk-rds-1.146.0 vs lib/aws-sdk-rds/client.rb in aws-sdk-rds-1.147.0

- old
+ new

@@ -763,11 +763,11 @@ # cluster. # # For more information on backtracking, see [ Backtracking an Aurora DB # Cluster][1] in the *Amazon Aurora User Guide*. # - # <note markdown="1"> This action only applies to Aurora MySQL DB clusters. + # <note markdown="1"> This action applies only to Aurora MySQL DB clusters. # # </note> # # # @@ -1018,96 +1018,50 @@ # snapshot, `SourceDBClusterSnapshotIdentifier` must be the Amazon # Resource Name (ARN) of the shared DB cluster snapshot. # # You can copy an encrypted DB cluster snapshot from another Amazon Web # Services Region. In that case, the Amazon Web Services Region where - # you call the `CopyDBClusterSnapshot` action is the destination Amazon - # Web Services Region for the encrypted DB cluster snapshot to be copied - # to. To copy an encrypted DB cluster snapshot from another Amazon Web - # Services Region, you must provide the following values: + # you call the `CopyDBClusterSnapshot` operation is the destination + # Amazon Web Services Region for the encrypted DB cluster snapshot to be + # copied to. To copy an encrypted DB cluster snapshot from another + # Amazon Web Services Region, you must provide the following values: # # * `KmsKeyId` - The Amazon Web Services Key Management System (Amazon # Web Services KMS) key identifier for the key to use to encrypt the # copy of the DB cluster snapshot in the destination Amazon Web # Services Region. # - # * `PreSignedUrl` - A URL that contains a Signature Version 4 signed - # request for the `CopyDBClusterSnapshot` action to be called in the - # source Amazon Web Services Region where the DB cluster snapshot is - # copied from. The pre-signed URL must be a valid request for the - # `CopyDBClusterSnapshot` API action that can be executed in the - # source Amazon Web Services Region that contains the encrypted DB - # cluster snapshot to be copied. - # - # The pre-signed URL request must contain the following parameter - # values: - # - # * `KmsKeyId` - The Amazon Web Services KMS key identifier for the - # KMS key to use to encrypt the copy of the DB cluster snapshot in - # the destination Amazon Web Services Region. This is the same - # identifier for both the `CopyDBClusterSnapshot` action that is - # called in the destination Amazon Web Services Region, and the - # action contained in the pre-signed URL. - # - # * `DestinationRegion` - The name of the Amazon Web Services Region - # that the DB cluster snapshot is to be created in. - # - # * `SourceDBClusterSnapshotIdentifier` - The DB cluster snapshot - # identifier for the encrypted DB cluster snapshot to be copied. - # This identifier must be in the Amazon Resource Name (ARN) format - # for the source Amazon Web Services Region. For example, if you are - # copying an encrypted DB cluster snapshot from the us-west-2 Amazon - # Web Services Region, then your `SourceDBClusterSnapshotIdentifier` - # looks like the following example: - # `arn:aws:rds:us-west-2:123456789012:cluster-snapshot:aurora-cluster1-snapshot-20161115`. - # - # To learn how to generate a Signature Version 4 signed request, see [ - # Authenticating Requests: Using Query Parameters (Amazon Web Services - # Signature Version 4)][1] and [ Signature Version 4 Signing - # Process][2]. - # - # <note markdown="1"> If you are using an Amazon Web Services SDK tool or the CLI, you can - # specify `SourceRegion` (or `--source-region` for the CLI) instead of - # specifying `PreSignedUrl` manually. Specifying `SourceRegion` - # autogenerates a pre-signed URL that is a valid request for the - # operation that can be executed in the source Amazon Web Services - # Region. - # - # </note> - # # * `TargetDBClusterSnapshotIdentifier` - The identifier for the new # copy of the DB cluster snapshot in the destination Amazon Web # Services Region. # # * `SourceDBClusterSnapshotIdentifier` - The DB cluster snapshot # identifier for the encrypted DB cluster snapshot to be copied. This # identifier must be in the ARN format for the source Amazon Web # Services Region and is the same value as the - # `SourceDBClusterSnapshotIdentifier` in the pre-signed URL. + # `SourceDBClusterSnapshotIdentifier` in the presigned URL. # # To cancel the copy operation once it is in progress, delete the target # DB cluster snapshot identified by `TargetDBClusterSnapshotIdentifier` # while that DB cluster snapshot is in "copying" status. # # For more information on copying encrypted Amazon Aurora DB cluster # snapshots from one Amazon Web Services Region to another, see [ - # Copying a Snapshot][3] in the *Amazon Aurora User Guide*. + # Copying a Snapshot][1] in the *Amazon Aurora User Guide*. # # For more information on Amazon Aurora DB clusters, see [ What is - # Amazon Aurora?][4] in the *Amazon Aurora User Guide*. + # Amazon Aurora?][2] in the *Amazon Aurora User Guide*. # # For more information on Multi-AZ DB clusters, see [ Multi-AZ - # deployments with two readable standby DB instances][5] in the *Amazon + # deployments with two readable standby DB instances][3] in the *Amazon # RDS User Guide*. # # # - # [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 - # [3]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_CopySnapshot.html - # [4]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html - # [5]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html + # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_CopySnapshot.html + # [2]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html + # [3]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html # # @option params [required, String] :source_db_cluster_snapshot_identifier # The identifier of the DB cluster snapshot to copy. This parameter # isn't case-sensitive. # @@ -1171,30 +1125,34 @@ # # If you copy an unencrypted DB cluster snapshot and specify a value for # the `KmsKeyId` parameter, an error is returned. # # @option params [String] :pre_signed_url - # The URL that contains a Signature Version 4 signed request for the - # `CopyDBClusterSnapshot` API action in the Amazon Web Services Region - # that contains the source DB cluster snapshot to copy. The - # `PreSignedUrl` parameter must be used when copying an encrypted DB - # cluster snapshot from another Amazon Web Services Region. Don't - # specify `PreSignedUrl` when you are copying an encrypted DB cluster - # snapshot in the same Amazon Web Services Region. + # When you are copying a DB cluster snapshot from one Amazon Web + # Services GovCloud (US) Region to another, the URL that contains a + # Signature Version 4 signed request for the `CopyDBClusterSnapshot` API + # operation in the Amazon Web Services Region that contains the source + # DB cluster snapshot to copy. Use the `PreSignedUrl` parameter when + # copying an encrypted DB cluster snapshot from another Amazon Web + # Services Region. Don't specify `PreSignedUrl` when copying an + # encrypted DB cluster snapshot in the same Amazon Web Services Region. # - # The pre-signed URL must be a valid request for the - # `CopyDBClusterSnapshot` API action that can be executed in the source + # This setting applies only to Amazon Web Services GovCloud (US) + # Regions. It's ignored in other Amazon Web Services Regions. + # + # The presigned URL must be a valid request for the + # `CopyDBClusterSnapshot` API operation that can run in the source # Amazon Web Services Region that contains the encrypted DB cluster - # snapshot to be copied. The pre-signed URL request must contain the - # following parameter values: + # snapshot to copy. The presigned URL request must contain the following + # parameter values: # - # * `KmsKeyId` - The Amazon Web Services KMS key identifier for the KMS - # key to use to encrypt the copy of the DB cluster snapshot in the - # destination Amazon Web Services Region. This is the same identifier - # for both the `CopyDBClusterSnapshot` action that is called in the - # destination Amazon Web Services Region, and the action contained in - # the pre-signed URL. + # * `KmsKeyId` - The KMS key identifier for the KMS key to use to + # encrypt the copy of the DB cluster snapshot in the destination + # Amazon Web Services Region. This is the same identifier for both the + # `CopyDBClusterSnapshot` operation that is called in the destination + # Amazon Web Services Region, and the operation contained in the + # presigned URL. # # * `DestinationRegion` - The name of the Amazon Web Services Region # that the DB cluster snapshot is to be created in. # # * `SourceDBClusterSnapshotIdentifier` - The DB cluster snapshot @@ -1212,13 +1170,12 @@ # Process][2]. # # <note markdown="1"> If you are using an Amazon Web Services SDK tool or the CLI, you can # specify `SourceRegion` (or `--source-region` for the CLI) instead of # specifying `PreSignedUrl` manually. Specifying `SourceRegion` - # autogenerates a pre-signed URL that is a valid request for the - # operation that can be executed in the source Amazon Web Services - # Region. + # autogenerates a presigned URL that is a valid request for the + # operation that can run in the source Amazon Web Services Region. # # </note> # # # @@ -1413,11 +1370,11 @@ # Copies the specified DB snapshot. The source DB snapshot must be in # the `available` state. # # You can copy a snapshot from one Amazon Web Services Region to # another. In that case, the Amazon Web Services Region where you call - # the `CopyDBSnapshot` action is the destination Amazon Web Services + # the `CopyDBSnapshot` operation is the destination Amazon Web Services # Region for the DB snapshot copy. # # This command doesn't apply to RDS Custom. # # For more information about copying snapshots, see [Copying a DB @@ -1441,12 +1398,11 @@ # # If you are copying from a shared manual DB snapshot, this parameter # must be the Amazon Resource Name (ARN) of the shared DB snapshot. # # If you are copying an encrypted snapshot this parameter must be in the - # ARN format for the source Amazon Web Services Region, and must match - # the `SourceDBSnapshotIdentifier` in the `PreSignedUrl` parameter. + # ARN format for the source Amazon Web Services Region. # # Constraints: # # * Must specify a valid system snapshot in the "available" state. # @@ -1508,43 +1464,50 @@ # @option params [Boolean] :copy_tags # A value that indicates whether to copy all tags from the source DB # snapshot to the target DB snapshot. By default, tags are not copied. # # @option params [String] :pre_signed_url - # The URL that contains a Signature Version 4 signed request for the - # `CopyDBSnapshot` API action in the source Amazon Web Services Region - # that contains the source DB snapshot to copy. + # When you are copying a snapshot from one Amazon Web Services GovCloud + # (US) Region to another, the URL that contains a Signature Version 4 + # signed request for the `CopyDBSnapshot` API operation in the source + # Amazon Web Services Region that contains the source DB snapshot to + # copy. # + # This setting applies only to Amazon Web Services GovCloud (US) + # Regions. It's ignored in other Amazon Web Services Regions. + # # You must specify this parameter when you copy an encrypted DB snapshot # from another Amazon Web Services Region by using the Amazon RDS API. # Don't specify `PreSignedUrl` when you are copying an encrypted DB # snapshot in the same Amazon Web Services Region. # - # The presigned URL must be a valid request for the `CopyDBSnapshot` API - # action that can be executed in the source Amazon Web Services Region - # that contains the encrypted DB snapshot to be copied. The presigned - # URL request must contain the following parameter values: + # The presigned URL must be a valid request for the + # `CopyDBClusterSnapshot` API operation that can run in the source + # Amazon Web Services Region that contains the encrypted DB cluster + # snapshot to copy. The presigned URL request must contain the following + # parameter values: # # * `DestinationRegion` - The Amazon Web Services Region that the # encrypted DB snapshot is copied to. This Amazon Web Services Region - # is the same one where the `CopyDBSnapshot` action is called that + # is the same one where the `CopyDBSnapshot` operation is called that # contains this presigned URL. # # For example, if you copy an encrypted DB snapshot from the us-west-2 # Amazon Web Services Region to the us-east-1 Amazon Web Services - # Region, then you call the `CopyDBSnapshot` action in the us-east-1 - # Amazon Web Services Region and provide a presigned URL that contains - # a call to the `CopyDBSnapshot` action in the us-west-2 Amazon Web - # Services Region. For this example, the `DestinationRegion` in the - # presigned URL must be set to the us-east-1 Amazon Web Services - # Region. + # Region, then you call the `CopyDBSnapshot` operation in the + # us-east-1 Amazon Web Services Region and provide a presigned URL + # that contains a call to the `CopyDBSnapshot` operation in the + # us-west-2 Amazon Web Services Region. For this example, the + # `DestinationRegion` in the presigned URL must be set to the + # us-east-1 Amazon Web Services Region. # - # * `KmsKeyId` - The Amazon Web Services KMS key identifier for the KMS - # key to use to encrypt the copy of the DB snapshot in the destination - # Amazon Web Services Region. This is the same identifier for both the - # `CopyDBSnapshot` action that is called in the destination Amazon Web - # Services Region, and the action contained in the presigned URL. + # * `KmsKeyId` - The KMS key identifier for the KMS key to use to + # encrypt the copy of the DB snapshot in the destination Amazon Web + # Services Region. This is the same identifier for both the + # `CopyDBSnapshot` operation that is called in the destination Amazon + # Web Services Region, and the operation contained in the presigned + # URL. # # * `SourceDBSnapshotIdentifier` - The DB snapshot identifier for the # encrypted snapshot to be copied. This identifier must be in the # Amazon Resource Name (ARN) format for the source Amazon Web Services # Region. For example, if you are copying an encrypted DB snapshot @@ -1557,13 +1520,12 @@ # Signature Version 4)][1] and [Signature Version 4 Signing Process][2]. # # <note markdown="1"> If you are using an Amazon Web Services SDK tool or the CLI, you can # specify `SourceRegion` (or `--source-region` for the CLI) instead of # specifying `PreSignedUrl` manually. Specifying `SourceRegion` - # autogenerates a pre-signed URL that is a valid request for the - # operation that can be executed in the source Amazon Web Services - # Region. + # autogenerates a presigned URL that is a valid request for the + # operation that can run in the source Amazon Web Services Region. # # </note> # # # @@ -2038,14 +2000,11 @@ # Creates a new Amazon Aurora DB cluster or Multi-AZ DB cluster. # # 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 cross-Region - # replication where the DB cluster identified by - # `ReplicationSourceIdentifier` is encrypted, also specify the - # `PreSignedUrl` parameter. + # Amazon RDS MySQL or PostgreSQL DB instance. # # 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 @@ -2364,29 +2323,29 @@ # Amazon Web Services Region. # # Valid for: Aurora DB clusters and Multi-AZ DB clusters # # @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 Amazon Web - # Services Region where the DB cluster is replicated from. Specify - # `PreSignedUrl` only when you are performing cross-Region replication - # from an encrypted DB cluster. + # When you are replicating a DB cluster from one Amazon Web Services + # GovCloud (US) Region to another, an URL that contains a Signature + # Version 4 signed request for the `CreateDBCluster` operation to be + # called in the source Amazon Web Services Region where the DB cluster + # is replicated from. Specify `PreSignedUrl` only when you are + # performing cross-Region replication from an encrypted DB cluster. # - # The pre-signed URL must be a valid request for the `CreateDBCluster` - # API action that can be executed in the source Amazon Web Services - # Region that contains the encrypted DB cluster to be copied. + # The presigned URL must be a valid request for the `CreateDBCluster` + # API operation that can run in the source Amazon Web Services Region + # that contains the encrypted DB cluster to copy. # - # The pre-signed URL request must contain the following parameter - # values: + # The presigned URL request must contain the following parameter values: # - # * `KmsKeyId` - The Amazon Web Services KMS key identifier for the KMS - # key to use to encrypt the copy of the DB cluster in the destination - # Amazon Web Services Region. This should refer to the same KMS key - # for both the `CreateDBCluster` action that is called in the - # destination Amazon Web Services Region, and the action contained in - # the pre-signed URL. + # * `KmsKeyId` - The KMS key identifier for the KMS key to use to + # encrypt the copy of the DB cluster in the destination Amazon Web + # Services Region. This should refer to the same KMS key for both the + # `CreateDBCluster` operation that is called in the destination Amazon + # Web Services Region, and the operation contained in the presigned + # URL. # # * `DestinationRegion` - The name of the Amazon Web Services Region # that Aurora read replica will be created in. # # * `ReplicationSourceIdentifier` - The DB cluster identifier for the @@ -2403,13 +2362,12 @@ # Process][2]. # # <note markdown="1"> If you are using an Amazon Web Services SDK tool or the CLI, you can # specify `SourceRegion` (or `--source-region` for the CLI) instead of # specifying `PreSignedUrl` manually. Specifying `SourceRegion` - # autogenerates a pre-signed URL that is a valid request for the - # operation that can be executed in the source Amazon Web Services - # Region. + # autogenerates a presigned URL that is a valid request for the + # operation that can run in the source Amazon Web Services Region. # # </note> # # Valid for: Aurora DB clusters only # @@ -2422,11 +2380,11 @@ # A value that indicates whether to enable mapping of Amazon Web # Services Identity and Access Management (IAM) accounts to database # accounts. By default, mapping isn't enabled. # # For more information, see [ IAM Database Authentication][1] in the - # *Amazon Aurora User Guide.*. + # *Amazon Aurora User Guide*. # # Valid for: Aurora DB clusters only # # # @@ -2496,34 +2454,40 @@ # any 2.x versions. # # The `multimaster` engine mode only applies for DB clusters created # with Aurora MySQL version 5.6.10a. # + # The `serverless` engine mode only applies for Aurora Serverless v1 DB + # clusters. + # # For Aurora PostgreSQL, the `global` engine mode isn't required, and # both the `parallelquery` and the `multimaster` engine modes currently # aren't supported. # # 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 v1][1] + # * [Limitations of Aurora Serverless v1][1] # - # * [ Limitations of Parallel Query][2] + # * [Requirements for Aurora Serverless v2][2] # - # * [ Limitations of Aurora Global Databases][3] + # * [Limitations of Parallel Query][3] # - # * [ Limitations of Multi-Master Clusters][4] + # * [Limitations of Aurora Global Databases][4] # + # * [Limitations of Multi-Master Clusters][5] + # # Valid for: Aurora DB clusters only # # # # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless.html#aurora-serverless.limitations - # [2]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-mysql-parallel-query.html#aurora-mysql-parallel-query-limitations - # [3]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-global-database.html#aurora-global-database.limitations - # [4]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-multi-master.html#aurora-multi-master-limitations + # [2]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless-v2.requirements.html + # [3]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-mysql-parallel-query.html#aurora-mysql-parallel-query-limitations + # [4]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-global-database.html#aurora-global-database.limitations + # [5]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-multi-master.html#aurora-multi-master-limitations # # @option params [Types::ScalingConfiguration] :scaling_configuration # For DB clusters in `serverless` DB engine mode, the scaling properties # of the DB cluster. # @@ -2761,13 +2725,32 @@ # a different default KMS key for each Amazon Web Services Region. # # Valid for: Multi-AZ DB clusters only # # @option params [Integer] :performance_insights_retention_period - # The amount of time, in days, to retain Performance Insights data. - # Valid values are 7 or 731 (2 years). + # The number of days to retain Performance Insights data. The default is + # 7 days. The following values are valid: # + # * 7 + # + # * *month* * 31, where *month* is a number of months from 1-23 + # + # * 731 + # + # For example, the following values are valid: + # + # * 93 (3 months * 31) + # + # * 341 (11 months * 31) + # + # * 589 (19 months * 31) + # + # * 731 + # + # If you specify a retention period such as 94, which isn't a valid + # value, RDS issues an error. + # # Valid for: Multi-AZ DB clusters only # # @option params [Types::ServerlessV2ScalingConfiguration] :serverless_v2_scaling_configuration # Contains the scaling configuration of an Aurora Serverless v2 DB # cluster. @@ -2995,11 +2978,11 @@ end # Creates a new custom endpoint and associates it with an Amazon Aurora # DB cluster. # - # <note markdown="1"> This action only applies to Aurora DB clusters. + # <note markdown="1"> This action applies only to Aurora DB clusters. # # </note> # # @option params [required, String] :db_cluster_identifier # The DB cluster identifier of the DB cluster associated with the @@ -3107,12 +3090,13 @@ # parameter group is used as the default for a new DB cluster. This is # especially important for parameters that are critical when creating # the default database for a DB cluster, such as the character set for # the default database defined by the `character_set_database` # parameter. You can use the *Parameter Groups* option of the [Amazon - # RDS console][1] or the `DescribeDBClusterParameters` action to verify - # that your DB cluster parameter group has been created or modified. + # RDS console][1] or the `DescribeDBClusterParameters` operation to + # verify that your DB cluster parameter group has been created or + # modified. # # For more information on Amazon Aurora, see [ What is Amazon # Aurora?][2] in the *Amazon Aurora User Guide*. # # For more information on Multi-AZ DB clusters, see [ Multi-AZ @@ -3361,10 +3345,27 @@ req.send_request(options) end # Creates a new DB instance. # + # The new DB instance can be an RDS DB instance, or it can be a DB + # instance in an Aurora DB cluster. For an Aurora DB cluster, you can + # call this operation multiple times to add more than one DB instance to + # the cluster. + # + # For more information about creating an RDS DB instance, see [ Creating + # an Amazon RDS DB instance][1] in the *Amazon RDS User Guide*. + # + # For more information about creating a DB instance in an Aurora DB + # cluster, see [ Creating an Amazon Aurora DB cluster][2] in the *Amazon + # Aurora User Guide*. + # + # + # + # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_CreateDBInstance.html + # [2]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.CreateInstance.html + # # @option params [String] :db_name # The meaning of this parameter differs according to the database engine # you use. # # **MySQL** @@ -3594,18 +3595,20 @@ # # * Web and Express editions: Must be an integer from 20 to 1024. # # @option params [required, String] :db_instance_class # The compute and memory capacity of the DB instance, for example - # db.m4.large. Not all DB instance classes are available in all Amazon + # db.m5.large. Not all DB instance classes are available in all Amazon # Web Services 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*. + # instance classes][1] in the *Amazon RDS User Guide* or [Aurora DB + # instance classes][2] in the *Amazon Aurora User Guide*. # # # # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html + # [2]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Concepts.DBInstanceClass.html # # @option params [required, String] :engine # The name of the database engine to be used for this instance. # # Not every database engine is available for every Amazon Web Services @@ -3700,11 +3703,13 @@ # Constraints: Must contain from 8 to 128 characters. # # @option params [Array<String>] :db_security_groups # A list of DB security groups to associate with this DB instance. # - # Default: The default DB security group for the database engine. + # This setting applies to the legacy EC2-Classic platform, which is no + # longer used to create new DB instances. Use the `VpcSecurityGroupIds` + # setting instead. # # @option params [Array<String>] :vpc_security_group_ids # A list of Amazon EC2 VPC security groups to associate with this DB # instance. # @@ -3800,11 +3805,11 @@ # # * 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 or 35 for an RDS Custom for Oracle DB instance + # * Can't be set to 0 for an RDS Custom for Oracle DB instance # # @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. The default is a 30-minute window selected at random from @@ -3883,15 +3888,20 @@ # deployment. You can't set the `AvailabilityZone` parameter if the DB # instance is a Multi-AZ deployment. # # This setting doesn't apply to RDS Custom. # + # **Amazon Aurora** + # + # Not applicable. DB instance Availability Zones (AZs) are managed by + # the DB cluster. + # # @option params [String] :engine_version # The version number of the database engine to use. # # For a list of valid engine versions, use the - # `DescribeDBEngineVersions` action. + # `DescribeDBEngineVersions` operation. # # The following are the database engines and links to information about # the major and minor versions that are available with Amazon RDS. Not # every database engine is available for every Amazon Web Services # Region. @@ -3963,10 +3973,14 @@ # Valid values: `license-included` \| `bring-your-own-license` \| # `general-public-license` # # This setting doesn't apply to RDS Custom. # + # **Amazon Aurora** + # + # Not applicable. + # # @option params [Integer] :iops # The amount of Provisioned IOPS (input/output operations per second) to # be initially allocated for the DB instance. For information about # valid `Iops` values, see [Amazon RDS Provisioned IOPS storage to # improve performance][1] in the *Amazon RDS User Guide*. @@ -3974,12 +3988,16 @@ # Constraints: For MariaDB, MySQL, Oracle, and PostgreSQL DB instances, # must be a multiple between .5 and 50 of the storage amount for the DB # instance. For SQL Server DB instances, must be a multiple between 1 # and 50 of the storage amount for the DB instance. # + # **Amazon Aurora** # + # Not applicable. Storage is managed by the DB cluster. # + # + # # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html#USER_PIOPS # # @option params [String] :option_group_name # A value that indicates that the DB instance should be associated with # the specified option group. @@ -3989,10 +4007,14 @@ # can't be removed from a DB instance after it is associated with a DB # instance. # # This setting doesn't apply to RDS Custom. # + # **Amazon Aurora** + # + # Not applicable. + # # @option params [String] :character_set_name # For supported engines, this value indicates that the DB instance # should be associated with the specified `CharacterSet`. # # This setting doesn't apply to RDS Custom. However, if you need to @@ -4059,16 +4081,24 @@ # If you specify `io1`, you must also include a value for the `Iops` # parameter. # # Default: `io1` if the `Iops` parameter is specified, otherwise `gp2` # + # **Amazon Aurora** + # + # Not applicable. Storage is managed by the DB cluster. + # # @option params [String] :tde_credential_arn # The ARN from the key store with which to associate the instance for # TDE encryption. # # This setting doesn't apply to RDS Custom. # + # **Amazon Aurora** + # + # Not applicable. + # # @option params [String] :tde_credential_password # The password for the given ARN from the key store in order to access # the device. # # This setting doesn't apply to RDS Custom. @@ -4121,12 +4151,16 @@ # For more information, see [ Kerberos Authentication][1] in the *Amazon # RDS User Guide*. # # This setting doesn't apply to RDS Custom. # + # **Amazon Aurora** # + # Not applicable. The domain is managed by the DB cluster. # + # + # # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/kerberos-authentication.html # # @option params [Boolean] :copy_tags_to_snapshot # A value that indicates whether to copy tags from the DB instance to # snapshots of the DB instance. By default, tags are not copied. @@ -4169,10 +4203,14 @@ # Specify 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. # + # **Amazon Aurora** + # + # Not applicable. The domain is managed by the DB cluster. + # # @option params [Integer] :promotion_tier # A value that specifies the order in which an Aurora Replica is # promoted to the primary instance after a failure of the existing # primary instance. For more information, see [ Fault Tolerance for an # Aurora DB Cluster][1] in the *Amazon Aurora User Guide*. @@ -4198,19 +4236,22 @@ # @option params [Boolean] :enable_iam_database_authentication # A value that indicates whether to enable mapping of Amazon Web # Services Identity and Access Management (IAM) accounts to database # accounts. By default, mapping isn't enabled. # - # This setting doesn't apply to RDS Custom or Amazon Aurora. In Aurora, - # mapping Amazon Web Services IAM accounts to database accounts is - # managed by the DB cluster. - # # For more information, see [ IAM Database Authentication for MySQL and # PostgreSQL][1] in the *Amazon RDS User Guide*. # + # This setting doesn't apply to RDS Custom. # + # **Amazon Aurora** # + # Not applicable. Mapping Amazon Web Services IAM accounts to database + # accounts is managed by the DB cluster. + # + # + # # [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 # DB instance. For more information, see [Using Amazon Performance @@ -4235,13 +4276,32 @@ # a different default KMS key for each Amazon Web Services Region. # # This setting doesn't apply to RDS Custom. # # @option params [Integer] :performance_insights_retention_period - # The amount of time, in days, to retain Performance Insights data. - # Valid values are 7 or 731 (2 years). + # The number of days to retain Performance Insights data. The default is + # 7 days. The following values are valid: # + # * 7 + # + # * *month* * 31, where *month* is a number of months from 1-23 + # + # * 731 + # + # For example, the following values are valid: + # + # * 93 (3 months * 31) + # + # * 341 (11 months * 31) + # + # * 589 (19 months * 31) + # + # * 731 + # + # If you specify a retention period such as 94, which isn't a valid + # value, RDS issues an error. + # # This setting doesn't apply to RDS Custom. # # @option params [Array<String>] :enable_cloudwatch_logs_exports # The list of log types that need to be enabled for exporting to # CloudWatch Logs. The values in the list depend on the DB engine. For @@ -4285,10 +4345,14 @@ # The number of CPU cores and the number of threads per core for the DB # instance class of the DB instance. # # This setting doesn't apply to RDS Custom. # + # **Amazon Aurora** + # + # Not applicable. + # # @option params [Boolean] :deletion_protection # A value that indicates whether the DB instance has deletion protection # enabled. The database can't be deleted when deletion protection is # enabled. By default, deletion protection isn't enabled. For more # information, see [ Deleting a DB Instance][1]. @@ -4312,12 +4376,16 @@ # apply to it, see [ Managing capacity automatically with Amazon RDS # storage autoscaling][1] in the *Amazon RDS User Guide*. # # This setting doesn't apply to RDS Custom. # + # **Amazon Aurora** # + # Not applicable. Storage is managed by the DB cluster. # + # + # # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIOPS.StorageTypes.html#USER_PIOPS.Autoscaling # # @option params [Boolean] :enable_customer_owned_ip # A value that indicates whether to enable a customer-owned IP address # (CoIP) for an RDS on Outposts DB instance. @@ -4639,12 +4707,12 @@ # 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. Call the - # `CreateDBInstance` action to create a DB instance for an Aurora DB + # 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 @@ -4772,11 +4840,11 @@ # 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. # # Specifying a parameter group for this operation is only supported for - # Oracle DB instances. It isn't supported for RDS Custom. + # MySQL and Oracle DB instances. It isn't supported for RDS Custom. # # Constraints: # # * Must be 1 to 255 letters, numbers, or hyphens. # @@ -4911,46 +4979,52 @@ # # This setting doesn't apply to RDS Custom, which uses the same KMS key # as the primary replica. # # @option params [String] :pre_signed_url - # The URL that contains a Signature Version 4 signed request for the - # `CreateDBInstanceReadReplica` API action in the source Amazon Web - # Services Region that contains the source DB instance. + # When you are creating a read replica from one Amazon Web Services + # GovCloud (US) Region to another or from one China Amazon Web Services + # Region to another, the URL that contains a Signature Version 4 signed + # request for the `CreateDBInstanceReadReplica` API operation in the + # source Amazon Web Services Region that contains the source DB + # instance. # + # 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. + # # 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. # # The presigned URL must be a valid request for the - # `CreateDBInstanceReadReplica` API action that can be executed in the - # source Amazon Web Services Region that contains the encrypted source - # DB instance. The presigned URL request must contain the following + # `CreateDBInstanceReadReplica` API operation that can run in the source + # Amazon Web Services Region that contains the encrypted source DB + # instance. The presigned URL request must contain the following # parameter values: # # * `DestinationRegion` - The Amazon Web Services Region that the # encrypted read replica is created in. This Amazon Web Services # Region is the same one where the `CreateDBInstanceReadReplica` - # action is called that contains this presigned URL. + # operation is called that contains this presigned URL. # # For example, if you create an encrypted DB instance in the us-west-1 # Amazon Web Services Region, from a source DB instance in the # us-east-2 Amazon Web Services Region, then you call the - # `CreateDBInstanceReadReplica` action in the us-east-1 Amazon Web + # `CreateDBInstanceReadReplica` operation in the us-east-1 Amazon Web # Services Region and provide a presigned URL that contains a call to - # the `CreateDBInstanceReadReplica` action in the us-west-2 Amazon Web - # Services Region. For this example, the `DestinationRegion` in the - # presigned URL must be set to the us-east-1 Amazon Web Services + # the `CreateDBInstanceReadReplica` operation in the us-west-2 Amazon + # Web Services Region. For this example, the `DestinationRegion` in + # the presigned URL must be set to the us-east-1 Amazon Web Services # Region. # - # * `KmsKeyId` - The Amazon Web Services KMS key identifier for the key - # to use to encrypt the read replica in the destination Amazon Web - # Services Region. This is the same identifier for both the - # `CreateDBInstanceReadReplica` action that is called in the - # destination Amazon Web Services Region, and the action contained in - # the presigned URL. + # * `KmsKeyId` - The KMS key identifier for the key to use to encrypt + # the read replica in the destination Amazon Web Services Region. This + # is the same identifier for both the `CreateDBInstanceReadReplica` + # operation that is called in the destination Amazon Web Services + # Region, and the operation 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 Amazon Web # Services Region. For example, if you are creating an encrypted read @@ -4965,15 +5039,14 @@ # # <note markdown="1"> If you are using an Amazon Web Services SDK tool or the CLI, you can # specify `SourceRegion` (or `--source-region` for the CLI) instead of # specifying `PreSignedUrl` manually. Specifying `SourceRegion` # autogenerates a presigned URL that is a valid request for the - # operation that can be executed in the source Amazon Web Services - # Region. + # operation that can run in the source Amazon Web Services Region. # - # `SourceRegion` isn't supported for SQL Server, because SQL Server on - # Amazon RDS doesn't support cross-Region read replicas. + # `SourceRegion` isn't supported for SQL Server, because Amazon RDS for + # SQL Server doesn't support cross-Region read replicas. # # </note> # # This setting doesn't apply to RDS Custom. # @@ -5023,13 +5096,32 @@ # a different default KMS key for each Amazon Web Services Region. # # This setting doesn't apply to RDS Custom. # # @option params [Integer] :performance_insights_retention_period - # The amount of time, in days, to retain Performance Insights data. - # Valid values are 7 or 731 (2 years). + # The number of days to retain Performance Insights data. The default is + # 7 days. The following values are valid: # + # * 7 + # + # * *month* * 31, where *month* is a number of months from 1-23 + # + # * 731 + # + # For example, the following values are valid: + # + # * 93 (3 months * 31) + # + # * 341 (11 months * 31) + # + # * 589 (19 months * 31) + # + # * 731 + # + # If you specify a retention period such as 94, which isn't a valid + # value, RDS issues an error. + # # This setting doesn't apply to RDS Custom. # # @option params [Array<String>] :enable_cloudwatch_logs_exports # The list of logs that the new DB instance is to export to CloudWatch # Logs. The values in the list depend on the DB engine being used. For @@ -6044,15 +6136,15 @@ def create_db_subnet_group(params = {}, options = {}) req = build_request(:create_db_subnet_group, params) req.send_request(options) end - # Creates an RDS event notification subscription. This action requires a - # topic Amazon Resource Name (ARN) created by either the RDS console, - # the SNS console, or the SNS API. To obtain an ARN with SNS, you must - # create a topic in Amazon SNS and subscribe to the topic. The ARN is - # displayed in the SNS console. + # Creates an RDS event notification subscription. This operation + # requires a topic Amazon Resource Name (ARN) created by either the RDS + # console, the SNS console, or the SNS API. To obtain an ARN with SNS, + # you must create a topic in Amazon SNS and subscribe to the topic. The + # ARN is displayed in the SNS console. # # You can specify the type of source (`SourceType`) that you want to be # notified of and provide a list of RDS sources (`SourceIds`) that # triggers the events. You can also provide a list of event categories # (`EventCategories`) for events that you want to be notified of. For @@ -6231,11 +6323,11 @@ # You can create a global database that is initially empty, and then add # a primary cluster and a secondary cluster to it. Or you can specify an # existing Aurora cluster during the create operation, and this cluster # becomes the primary cluster of the global database. # - # <note markdown="1"> This action only applies to Aurora DB clusters. + # <note markdown="1"> This action applies only to Aurora DB clusters. # # </note> # # @option params [String] :global_cluster_identifier # The cluster identifier of the new global database cluster. @@ -6253,13 +6345,13 @@ # @option params [Boolean] :deletion_protection # The deletion protection setting for the new global database. The # global database can't be deleted when deletion protection is enabled. # # @option params [String] :database_name - # The name for your database of up to 64 alpha-numeric characters. If - # you do not provide a name, Amazon Aurora will not create a database in - # the global database cluster you are creating. + # The name for your database of up to 64 alphanumeric characters. If you + # do not provide a name, Amazon Aurora will not create a database in the + # global database cluster you are creating. # # @option params [Boolean] :storage_encrypted # The storage encryption setting for the new global database cluster. # # @return [Types::CreateGlobalClusterResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods: @@ -10935,14 +11027,23 @@ # RDS Proxies for the past 14 days. Events specific to a particular DB # instance, DB cluster, DB parameter group, DB security group, DB # snapshot, DB cluster snapshot group, or RDS Proxy can be obtained by # providing the name as a parameter. # + # For more information on working with events, see [Monitoring Amazon + # RDS events][1] in the *Amazon RDS User Guide* and [Monitoring Amazon + # Aurora events][2] in the *Amazon Aurora User Guide*. + # # <note markdown="1"> By default, RDS returns events that were generated in the past hour. # # </note> # + # + # + # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/working-with-events.html + # [2]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/working-with-events.html + # # @option params [String] :source_identifier # The identifier of the event source for which events are returned. If # not specified, then all sources are included in the response. # # Constraints: @@ -12399,11 +12500,11 @@ # the readable standby DB instances (read-only instances) in the DB # cluster to be the primary DB instance (the cluster writer). # # An Amazon Aurora DB cluster automatically fails over to an Aurora # Replica, if one exists, when the primary DB instance fails. A Multi-AZ - # DB cluster automatically fails over to a readbable standby DB instance + # DB cluster automatically fails over to a readable standby DB instance # when the primary DB instance fails. # # To simulate a failure of a primary instance for testing, you can force # a failover. Because each instance in a DB cluster has its own endpoint # address, make sure to clean up and re-establish any existing @@ -13552,13 +13653,32 @@ # a different default KMS key for each Amazon Web Services Region. # # Valid for: Multi-AZ DB clusters only # # @option params [Integer] :performance_insights_retention_period - # The amount of time, in days, to retain Performance Insights data. - # Valid values are 7 or 731 (2 years). + # The number of days to retain Performance Insights data. The default is + # 7 days. The following values are valid: # + # * 7 + # + # * *month* * 31, where *month* is a number of months from 1-23 + # + # * 731 + # + # For example, the following values are valid: + # + # * 93 (3 months * 31) + # + # * 341 (11 months * 31) + # + # * 589 (19 months * 31) + # + # * 731 + # + # If you specify a retention period such as 94, which isn't a valid + # value, RDS issues an error. + # # Valid for: Multi-AZ DB clusters only # # @option params [Types::ServerlessV2ScalingConfiguration] :serverless_v2_scaling_configuration # Contains the scaling configuration of an Aurora Serverless v2 DB # cluster. @@ -13841,11 +13961,11 @@ # group is used as the default for a new DB cluster. This is especially # important for parameters that are critical when creating the default # database for a DB cluster, such as the character set for the default # database defined by the `character_set_database` parameter. You can # use the *Parameter Groups* option of the [Amazon RDS console][1] or - # the `DescribeDBClusterParameters` action to verify that your DB + # the `DescribeDBClusterParameters` operation to verify that your DB # cluster parameter group has been created or modified. # # If the modified DB cluster parameter group is used by an Aurora # Serverless v1 cluster, Aurora applies the update immediately. The # cluster restart might interrupt your workload. In that case, your @@ -13968,11 +14088,11 @@ # for that parameter in this case. # # To view which Amazon Web Services accounts have access to copy or # restore a manual DB cluster snapshot, or whether a manual DB cluster # snapshot is public or private, use the - # DescribeDBClusterSnapshotAttributes API action. The accounts are + # DescribeDBClusterSnapshotAttributes API operation. The accounts are # returned as values for the `restore` attribute. # # @option params [required, String] :db_cluster_snapshot_identifier # The identifier for the DB cluster snapshot to modify the attributes # for. @@ -13982,11 +14102,11 @@ # # To manage authorization for other Amazon Web Services accounts to copy # or restore a manual DB cluster snapshot, set this value to `restore`. # # <note markdown="1"> To view the list of attributes available to modify, use the - # DescribeDBClusterSnapshotAttributes API action. + # DescribeDBClusterSnapshotAttributes API operation. # # </note> # # @option params [Array<String>] :values_to_add # A list of DB cluster snapshot attributes to add to the attribute @@ -14094,14 +14214,15 @@ # For the valid values for allocated storage for each engine, see # `CreateDBInstance`. # # @option params [String] :db_instance_class # The new compute and memory capacity of the DB instance, for example - # db.m4.large. Not all DB instance classes are available in all Amazon + # db.m5.large. Not all DB instance classes are available in all Amazon # Web Services 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*. + # instance classes][1] in the *Amazon RDS User Guide* or [Aurora DB + # instance classes][2] in the *Amazon Aurora User Guide*. # # If you modify the DB instance class, an outage occurs during the # change. The change is applied during the next maintenance window, # unless `ApplyImmediately` is enabled for this request. # @@ -14110,10 +14231,11 @@ # Default: Uses existing setting # # # # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html + # [2]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Concepts.DBInstanceClass.html # # @option params [String] :db_subnet_group_name # The new DB subnet group for the DB instance. You can use this # parameter to move your DB instance to a different VPC. If your DB # instance isn't in a VPC, you can also use this parameter to move your @@ -14221,11 +14343,11 @@ # # **PostgreSQL** # # Constraints: Must contain from 8 to 128 characters. # - # <note markdown="1"> Amazon RDS API actions never return the password, so this action + # <note markdown="1"> Amazon RDS API operations never return the password, so this action # provides a way to regain access to a primary instance user if the # password is lost. This includes restoring privileges that might have # been accidentally revoked. # # </note> @@ -14273,12 +14395,12 @@ # Default: Uses existing setting # # Constraints: # # * It must be a value from 0 to 35. It can't be set to 0 if the DB - # instance is a source to read replicas. It can't be set to 0 or 35 - # for an RDS Custom for Oracle DB instance. + # instance is a source to read replicas. It can't be set to 0 for an + # RDS Custom for Oracle DB instance. # # * It can be specified for a MySQL read replica only if the source is # running MySQL 5.6 or later. # # * It can be specified for a PostgreSQL read replica only if the source @@ -14686,11 +14808,11 @@ # @option params [Boolean] :enable_performance_insights # A value that indicates whether to enable Performance Insights for the # DB instance. # # For more information, see [Using Amazon Performance Insights][1] in - # the *Amazon RDS User Guide.*. + # the *Amazon RDS User Guide*. # # This setting doesn't apply to RDS Custom. # # # @@ -14709,13 +14831,32 @@ # a different default KMS key for each Amazon Web Services Region. # # This setting doesn't apply to RDS Custom. # # @option params [Integer] :performance_insights_retention_period - # The amount of time, in days, to retain Performance Insights data. - # Valid values are 7 or 731 (2 years). + # The number of days to retain Performance Insights data. The default is + # 7 days. The following values are valid: # + # * 7 + # + # * *month* * 31, where *month* is a number of months from 1-23 + # + # * 731 + # + # For example, the following values are valid: + # + # * 93 (3 months * 31) + # + # * 341 (11 months * 31) + # + # * 589 (19 months * 31) + # + # * 731 + # + # If you specify a retention period such as 94, which isn't a valid + # value, RDS issues an error. + # # This setting doesn't apply to RDS Custom. # # @option params [Types::CloudwatchLogsExportConfiguration] :cloudwatch_logs_export_configuration # The configuration setting for the log types to be enabled for export # to CloudWatch Logs for a specific DB instance. @@ -15386,14 +15527,14 @@ end # Modifies the properties of a `DBProxyTargetGroup`. # # @option params [required, String] :target_group_name - # The name of the new target group to assign to the proxy. + # The name of the target group to modify. # # @option params [required, String] :db_proxy_name - # The name of the new proxy to which to assign the target group. + # The name of the proxy. # # @option params [Types::ConnectionPoolConfiguration] :connection_pool_config # The settings that determine the size and behavior of the connection # pool for the target group. # @@ -15577,11 +15718,11 @@ # the `ValuesToAdd` parameter. You can't use `all` as a value for that # parameter in this case. # # To view which Amazon Web Services accounts have access to copy or # restore a manual DB snapshot, or whether a manual DB snapshot public - # or private, use the DescribeDBSnapshotAttributes API action. The + # or private, use the DescribeDBSnapshotAttributes API operation. The # accounts are returned as values for the `restore` attribute. # # @option params [required, String] :db_snapshot_identifier # The identifier for the DB snapshot to modify the attributes for. # @@ -15590,11 +15731,11 @@ # # To manage authorization for other Amazon Web Services accounts to copy # or restore a manual DB snapshot, set this value to `restore`. # # <note markdown="1"> To view the list of attributes available to modify, use the - # DescribeDBSnapshotAttributes API action. + # DescribeDBSnapshotAttributes API operation. # # </note> # # @option params [Array<String>] :values_to_add # A list of DB snapshot attributes to add to the attribute specified by @@ -17523,13 +17664,13 @@ # Example: `mydbsubnetgroup` # # @option params [required, String] :engine # The name of the database engine to be used for this DB cluster. # - # Valid Values: `aurora` (for MySQL 5.6-compatible Aurora), + # Valid Values: `aurora` (for MySQL 5.6-compatible Aurora) and # `aurora-mysql` (for MySQL 5.7-compatible and MySQL 8.0-compatible - # Aurora), and `aurora-postgresql` + # Aurora) # # @option params [String] :engine_version # The version number of the database engine to use. # # To list all of the available engine versions for `aurora` (for MySQL @@ -17543,25 +17684,15 @@ # following command: # # `aws rds describe-db-engine-versions --engine aurora-mysql --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"` - # # **Aurora MySQL** # - # Example: `5.6.10a`, `5.6.mysql_aurora.1.19.2`, `5.7.12`, - # `5.7.mysql_aurora.2.04.5`, `8.0.mysql_aurora.3.01.0` + # Example: `5.6.10a`, `5.6.mysql_aurora.1.19.2`, + # `5.7.mysql_aurora.2.07.1`, `8.0.mysql_aurora.3.02.0` # - # **Aurora PostgreSQL** - # - # Example: `9.6.3`, `10.7` - # # @option params [Integer] :port # The port number on which the instances in the restored DB cluster # accept connections. # # Default: `3306` @@ -18190,11 +18321,11 @@ # # Possible value is `postgresql`. # # For more information about exporting CloudWatch Logs for Amazon RDS, # see [Publishing Database Logs to Amazon CloudWatch Logs][1] in the - # *Amazon RDS User Guide.*. + # *Amazon RDS User Guide*. # # For more information about exporting CloudWatch Logs for Amazon # Aurora, see [Publishing Database Logs to Amazon CloudWatch Logs][2] in # the *Amazon Aurora User Guide*. # @@ -18772,11 +18903,11 @@ # # Possible value is `postgresql`. # # For more information about exporting CloudWatch Logs for Amazon RDS, # see [Publishing Database Logs to Amazon CloudWatch Logs][1] in the - # *Amazon RDS User Guide.*. + # *Amazon RDS User Guide*. # # For more information about exporting CloudWatch Logs for Amazon # Aurora, see [Publishing Database Logs to Amazon CloudWatch Logs][2] in # the *Amazon Aurora User Guide*. # @@ -20179,11 +20310,11 @@ # @option params [Boolean] :enable_performance_insights # A value that indicates whether to enable Performance Insights for the # DB instance. # # For more information, see [Using Amazon Performance Insights][1] in - # the *Amazon RDS User Guide.*. + # the *Amazon RDS User Guide*. # # # # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html # @@ -20198,13 +20329,32 @@ # Amazon RDS uses your default KMS key. There is a default KMS key for # your Amazon Web Services account. Your Amazon Web Services account has # a different default KMS key for each Amazon Web Services Region. # # @option params [Integer] :performance_insights_retention_period - # The amount of time, in days, to retain Performance Insights data. - # Valid values are 7 or 731 (2 years). + # The number of days to retain Performance Insights data. The default is + # 7 days. The following values are valid: # + # * 7 + # + # * *month* * 31, where *month* is a number of months from 1-23 + # + # * 731 + # + # For example, the following values are valid: + # + # * 93 (3 months * 31) + # + # * 341 (11 months * 31) + # + # * 589 (19 months * 31) + # + # * 731 + # + # If you specify a retention period such as 94, which isn't a valid + # value, RDS issues an error. + # # @option params [Array<String>] :enable_cloudwatch_logs_exports # The list of logs that the restored DB instance is to export to # CloudWatch Logs. The values in the list depend on the DB engine being # used. For more information, see [Publishing Database Logs to Amazon # CloudWatch Logs][1] in the *Amazon RDS User Guide*. @@ -21725,18 +21875,40 @@ # Name (ARN) for the KMS encryption key in the destination Amazon Web # Services Region, for example, # `arn:aws:kms:us-east-1:123456789012:key/AKIAIOSFODNN7EXAMPLE`. # # @option params [String] :pre_signed_url - # A URL that contains a Signature Version 4 signed request for the - # StartDBInstanceAutomatedBackupsReplication action to be called in the + # In an Amazon Web Services GovCloud (US) Region, an URL that contains a + # Signature Version 4 signed request for the + # `StartDBInstanceAutomatedBackupsReplication` operation to call in the # Amazon Web Services Region of the source DB instance. The presigned # URL must be a valid request for the - # StartDBInstanceAutomatedBackupsReplication API action that can be - # executed in the Amazon Web Services Region that contains the source DB + # `StartDBInstanceAutomatedBackupsReplication` API operation that can + # run in the Amazon Web Services Region that contains the source DB # instance. # + # This setting applies only to Amazon Web Services GovCloud (US) + # Regions. It's ignored in other Amazon Web Services Regions. + # + # To learn how to generate a Signature Version 4 signed request, see [ + # Authenticating Requests: Using Query Parameters (Amazon Web Services + # Signature Version 4)][1] and [ Signature Version 4 Signing + # Process][2]. + # + # <note markdown="1"> If you are using an Amazon Web Services SDK tool or the CLI, you can + # specify `SourceRegion` (or `--source-region` for the CLI) instead of + # specifying `PreSignedUrl` manually. Specifying `SourceRegion` + # autogenerates a presigned URL that is a valid request for the + # operation that can run in the source Amazon Web Services Region. + # + # </note> + # + # + # + # [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 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::StartDBInstanceAutomatedBackupsReplicationResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods: @@ -22301,11 +22473,12 @@ req.send_request(options) end # Stops automated backup replication for a DB instance. # - # This command doesn't apply to RDS Custom. + # This command doesn't apply to RDS Custom, Aurora MySQL, and Aurora + # PostgreSQL. # # For more information, see [ Replicating Automated Backups to Another # Amazon Web Services Region][1] in the *Amazon RDS User Guide.* # # @@ -22379,10 +22552,10 @@ operation: config.api.operation(operation_name), client: self, params: params, config: config) context[:gem_name] = 'aws-sdk-rds' - context[:gem_version] = '1.146.0' + context[:gem_version] = '1.147.0' Seahorse::Client::Request.new(handlers, context) end # Polls an API operation until a resource enters a desired state. #