lib/aws-sdk-rds/client.rb in aws-sdk-rds-1.7.0 vs lib/aws-sdk-rds/client.rb in aws-sdk-rds-1.8.0

- old
+ new

@@ -335,11 +335,11 @@ # # Valid values: `system-update`, `db-upgrade` # # @option params [required, String] :opt_in_type # A value that specifies the type of opt-in request, or undoes an opt-in - # request. An opt-in request of type `immediate` cannot be undone. + # request. An opt-in request of type `immediate` can't be undone. # # Valid values: # # * `immediate` - Apply the maintenance action immediately. # @@ -405,12 +405,12 @@ # application accessing your database is running on the Internet. # Required parameters for this API are one of CIDR range, # EC2SecurityGroupId for VPC, or (EC2SecurityGroupOwnerId and either # EC2SecurityGroupName or EC2SecurityGroupId for non-VPC). # - # <note markdown="1"> You cannot authorize ingress from an EC2 security group in one AWS - # Region to an Amazon RDS DB instance in another. You cannot authorize + # <note markdown="1"> You can't authorize ingress from an EC2 security group in one AWS + # Region to an Amazon RDS DB instance in another. You can't authorize # ingress from a VPC security group in one VPC to an Amazon RDS DB # instance in another. # # </note> # @@ -541,12 +541,17 @@ # # @option params [required, String] :target_db_cluster_parameter_group_description # A description for the copied DB cluster parameter group. # # @option params [Array<Types::Tag>] :tags - # A list of tags. + # A list of tags. For more information, see [Tagging Amazon RDS + # Resources][1]. # + # + # + # [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html + # # @return [Types::CopyDBClusterParameterGroupResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::CopyDBClusterParameterGroupResult#db_cluster_parameter_group #db_cluster_parameter_group} => Types::DBClusterParameterGroup # # @@ -607,13 +612,13 @@ # `CopyDBClusterSnapshot` action is the destination AWS Region for the # encrypted DB cluster snapshot to be copied to. To copy an encrypted DB # cluster snapshot from another AWS Region, you must provide the # following values: # - # * `KmsKeyId` - The AWS Key Management System (KMS) key identifier for - # the key to use to encrypt the copy of the DB cluster snapshot in the - # destination AWS Region. + # * `KmsKeyId` - The AWS Key Management System (AWS KMS) key identifier + # for the key to use to encrypt the copy of the DB cluster snapshot in + # the destination AWS Region. # # * `PreSignedUrl` - A URL that contains a Signature Version 4 signed # request for the `CopyDBClusterSnapshot` action to be called in the # source AWS Region where the DB cluster snapshot is copied from. The # pre-signed URL must be a valid request for the @@ -635,12 +640,12 @@ # # * `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 AWS Region. For example, if you are copying an - # encrypted DB cluster snapshot from the us-west-2 region, then your - # `SourceDBClusterSnapshotIdentifier` looks like the following + # encrypted DB cluster snapshot from the us-west-2 AWS 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 (AWS Signature @@ -676,11 +681,11 @@ # # @option params [required, String] :source_db_cluster_snapshot_identifier # The identifier of the DB cluster snapshot to copy. This parameter is # not case-sensitive. # - # You cannot copy an encrypted, shared DB cluster snapshot from one AWS + # You can't copy an encrypted, shared DB cluster snapshot from one AWS # Region to another. # # Constraints: # # * Must specify a valid system snapshot in the "available" state. @@ -711,13 +716,13 @@ # * Cannot end with a hyphen or contain two consecutive hyphens. # # Example: `my-cluster-snapshot2` # # @option params [String] :kms_key_id - # The AWS KMS key ID for an encrypted DB cluster snapshot. The KMS key - # ID is the Amazon Resource Name (ARN), KMS key identifier, or the KMS - # key alias for the KMS encryption key. + # The AWS AWS KMS key ID for an encrypted DB cluster snapshot. 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 copy an unencrypted DB cluster snapshot and specify a value for # the `KmsKeyId` parameter, Amazon RDS encrypts the target DB cluster # snapshot using the specified KMS encryption key. # @@ -732,11 +737,11 @@ # # To copy an encrypted DB cluster snapshot to another AWS Region, you # must set `KmsKeyId` to the KMS key ID you want to use to encrypt the # copy of the DB cluster snapshot in the destination AWS Region. KMS # encryption keys are specific to the AWS Region that they are created - # in, and you cannot use encryption keys from one AWS Region in another + # in, and you can't use encryption keys from one AWS Region in another # AWS Region. # # @option params [String] :pre_signed_url # The URL that contains a Signature Version 4 signed request for the # `CopyDBClusterSnapshot` API action in the AWS Region that contains the @@ -748,24 +753,24 @@ # `CopyDBSClusterSnapshot` 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 KMS key identifier for the key to use to encrypt - # the copy of the DB cluster snapshot in the destination AWS Region. - # This is the same identifier for both the `CopyDBClusterSnapshot` - # action that is called in the destination AWS Region, and the action - # contained in the pre-signed URL. + # * `KmsKeyId` - The AWS KMS key identifier for the key to use to + # encrypt the copy of the DB cluster snapshot in the destination AWS + # Region. This is the same identifier for both the + # `CopyDBClusterSnapshot` 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 the DB cluster # snapshot will 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 AWS Region. For example, if you are copying an encrypted DB - # cluster snapshot from the us-west-2 region, then your + # cluster snapshot from the us-west-2 AWS 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 [ @@ -777,15 +782,20 @@ # [1]: http://docs.aws.amazon.com/AmazonS3/latest/API/sigv4-query-string-auth.html # [2]: http://docs.aws.amazon.com/general/latest/gr/signature-version-4.html # # @option params [Boolean] :copy_tags # True to copy all tags from the source DB cluster snapshot to the - # target DB cluster snapshot; otherwise false. The default is false. + # target DB cluster snapshot, and otherwise false. The default is false. # # @option params [Array<Types::Tag>] :tags - # A list of tags. + # A list of tags. For more information, see [Tagging Amazon RDS + # Resources][1]. # + # + # + # [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.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::CopyDBClusterSnapshotResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods: @@ -893,12 +903,17 @@ # # @option params [required, String] :target_db_parameter_group_description # A description for the copied DB parameter group. # # @option params [Array<Types::Tag>] :tags - # A list of tags. + # A list of tags. For more information, see [Tagging Amazon RDS + # Resources][1]. # + # + # + # [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html + # # @return [Types::CopyDBParameterGroupResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::CopyDBParameterGroupResult#db_parameter_group #db_parameter_group} => Types::DBParameterGroup # # @@ -953,11 +968,11 @@ # # You can copy a snapshot from one AWS Region to another. In that case, # the AWS Region where you call the `CopyDBSnapshot` action is the # destination AWS Region for the DB snapshot copy. # - # You cannot copy an encrypted, shared DB snapshot from one AWS Region + # You can't copy an encrypted, shared DB snapshot from one AWS Region # to another. # # For more information about copying snapshots, see [Copying a DB # Snapshot][1] in the Amazon RDS User Guide. # @@ -1027,28 +1042,33 @@ # the copy is encrypted. # # If you copy an encrypted snapshot to 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 - # cannot use encryption keys from one AWS Region in another AWS Region. + # can't use encryption keys from one AWS Region in another AWS Region. # # @option params [Array<Types::Tag>] :tags - # A list of tags. + # A list of tags. For more information, see [Tagging Amazon RDS + # Resources][1]. # + # + # + # [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html + # # @option params [Boolean] :copy_tags # True to copy all tags from the source DB snapshot to the target DB - # snapshot; otherwise false. The default is false. + # snapshot, and otherwise false. The default is false. # # @option params [String] :pre_signed_url # The URL that contains a Signature Version 4 signed request for the # `CopyDBSnapshot` API action in the source AWS Region that contains the # source DB snapshot to copy. # # You must specify this parameter when you copy an encrypted DB snapshot # from another AWS Region by using the Amazon RDS API. You can specify - # the source region option instead of this parameter when you copy an - # encrypted DB snapshot from another AWS Region by using the AWS CLI. + # the `--source-region` option instead of this parameter when you copy + # an encrypted DB snapshot from another AWS Region by using the AWS CLI. # # The presigned URL must be a valid request for the `CopyDBSnapshot` API # action that can be executed in the source AWS Region that contains the # encrypted DB snapshot to be copied. The presigned URL request must # contain the following parameter values: @@ -1056,28 +1076,28 @@ # * `DestinationRegion` - The AWS Region that the encrypted DB snapshot # is copied to. This AWS Region is the same one where the # `CopyDBSnapshot` action is called that contains this presigned URL. # # For example, if you copy an encrypted DB snapshot from the us-west-2 - # region to the us-east-1 region, then you call the `CopyDBSnapshot` - # action in the us-east-1 region and provide a presigned URL that - # contains a call to the `CopyDBSnapshot` action in the us-west-2 - # region. For this example, the `DestinationRegion` in the presigned - # URL must be set to the us-east-1 region. + # AWS Region to the us-east-1 AWS Region, then you call the + # `CopyDBSnapshot` action in the us-east-1 AWS Region and provide a + # presigned URL that contains a call to the `CopyDBSnapshot` 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 KMS key identifier for the key to use to encrypt - # the copy of the DB snapshot in the destination AWS Region. This is - # the same identifier for both the `CopyDBSnapshot` action that is - # called in the destination AWS Region, and the action contained in - # the presigned URL. + # * `KmsKeyId` - The AWS KMS key identifier for the key to use to + # encrypt the copy of the DB snapshot in the destination AWS Region. + # This is the same identifier for both the `CopyDBSnapshot` action + # that is called in the destination AWS Region, and the action + # 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 AWS Region. For # example, if you are copying an encrypted DB snapshot from the - # us-west-2 region, then your `SourceDBSnapshotIdentifier` looks like - # the following example: + # us-west-2 AWS Region, then your `SourceDBSnapshotIdentifier` looks + # like the following example: # `arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20161115`. # # To learn how to generate a Signature Version 4 signed request, see # [Authenticating Requests: Using Query Parameters (AWS Signature # Version 4)][1] and [Signature Version 4 Signing Process][2]. @@ -1093,11 +1113,12 @@ # # Specify this option if you are copying a snapshot from one AWS Region # to another, and your DB instance uses a nondefault option group. If # your source DB instance uses Transparent Data Encryption for Oracle or # Microsoft SQL Server, you must specify this option when copying across - # regions. For more information, see [Option Group Considerations][1]. + # AWS Regions. For more information, see [Option Group + # Considerations][1]. # # # # [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_CopySnapshot.html#USER_CopySnapshot.Options # @@ -1221,12 +1242,17 @@ # # @option params [required, String] :target_option_group_description # The description for the copied option group. # # @option params [Array<Types::Tag>] :tags - # A list of tags. + # A list of tags. For more information, see [Tagging Amazon RDS + # Resources][1]. # + # + # + # [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html + # # @return [Types::CopyOptionGroupResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::CopyOptionGroupResult#option_group #option_group} => Types::OptionGroup # # @@ -1317,12 +1343,12 @@ # # [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Aurora.html # # @option params [Array<String>] :availability_zones # A list of EC2 Availability Zones that instances in the DB cluster can - # be created in. For information on regions and Availability Zones, see - # [Regions and Availability Zones][1]. + # be created in. For information on AWS Regions and Availability Zones, + # see [Regions and Availability Zones][1]. # # # # [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.RegionsAndAvailabilityZones.html # @@ -1384,11 +1410,11 @@ # Example: `mySubnetgroup` # # @option params [required, String] :engine # The name of the database engine to be used for this DB cluster. # - # Valid Values: `aurora` + # Valid Values: `aurora`, `aurora-postgresql` # # @option params [String] :engine_version # The version number of the database engine to use. # # **Aurora** @@ -1420,28 +1446,29 @@ # # @option params [String] :option_group_name # A value that indicates that the DB cluster should be associated with # the specified option group. # - # Permanent options cannot be removed from an option group. The option - # group cannot be removed from a DB cluster once it is associated with a + # Permanent options can't be removed from an option group. The option + # group can't be removed from a DB cluster once it is associated with a # DB cluster. # # @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. # - # Default: A 30-minute window selected at random from an 8-hour block of - # time per AWS Region. To see the time blocks available, see [ Adjusting - # the Preferred Maintenance Window][1] in the *Amazon RDS User Guide.* + # The default is a 30-minute window selected at random from an 8-hour + # block of time for each AWS Region. To see the time blocks available, + # see [ Adjusting the Preferred Maintenance Window][1] in the *Amazon + # RDS User Guide.* # # Constraints: # # * Must be in the format `hh24:mi-hh24:mi`. # - # * Times should be in Universal Coordinated Time (UTC). + # * Must be in Universal Coordinated Time (UTC). # # * Must not conflict with the preferred maintenance window. # # * Must be at least 30 minutes. # @@ -1453,16 +1480,16 @@ # The weekly time range during which system maintenance can occur, in # Universal Coordinated Time (UTC). # # Format: `ddd:hh24:mi-ddd:hh24:mi` # - # Default: A 30-minute window selected at random from an 8-hour block of - # time per AWS Region, occurring on a random day of the week. To see the - # time blocks available, see [ Adjusting the Preferred Maintenance - # Window][1] in the *Amazon RDS User Guide.* + # The default is a 30-minute window selected at random from an 8-hour + # block of time for each AWS Region, occurring on a random day of the + # week. To see the time blocks available, see [ Adjusting the Preferred + # Maintenance Window][1] in the *Amazon RDS User Guide.* # - # Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun + # Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun. # # Constraints: Minimum 30-minute window. # # # @@ -1471,17 +1498,22 @@ # @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. # # @option params [Array<Types::Tag>] :tags - # A list of tags. + # A list of tags. For more information, see [Tagging Amazon RDS + # Resources][1]. # + # + # + # [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html + # # @option params [Boolean] :storage_encrypted # Specifies whether the DB cluster is encrypted. # # @option params [String] :kms_key_id - # The KMS key identifier for an encrypted DB cluster. + # The AWS KMS key identifier for an encrypted DB cluster. # # The KMS key identifier is the Amazon Resource Name (ARN) for the KMS # encryption key. If you are creating a DB cluster with the same AWS # account that owns the KMS encryption key used to encrypt the new DB # cluster, then you can use the KMS key alias instead of the ARN for the @@ -1518,25 +1550,25 @@ # the encrypted DB cluster to be copied. # # The pre-signed URL request must contain the following parameter # values: # - # * `KmsKeyId` - The KMS key identifier for the key to use to encrypt - # the copy of the DB cluster in the destination AWS Region. This - # should refer to the same KMS key for both the `CreateDBCluster` + # * `KmsKeyId` - The AWS KMS key identifier for the key to use to + # 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. # # * `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 - # us-west-2 region, then your `ReplicationSourceIdentifier` would look - # like Example: + # us-west-2 AWS Region, then your `ReplicationSourceIdentifier` would + # look like Example: # `arn:aws:rds:us-west-2:123456789012:cluster:aurora-cluster1`. # # To learn how to generate a Signature Version 4 signed request, see [ # Authenticating Requests: Using Query Parameters (AWS Signature Version # 4)][1] and [ Signature Version 4 Signing Process][2]. @@ -1545,13 +1577,12 @@ # # [1]: http://docs.aws.amazon.com/AmazonS3/latest/API/sigv4-query-string-auth.html # [2]: http://docs.aws.amazon.com/general/latest/gr/signature-version-4.html # # @option params [Boolean] :enable_iam_database_authentication - # A Boolean value that is true to enable mapping of AWS Identity and - # Access Management (IAM) accounts to database accounts, and otherwise - # false. + # True to enable mapping of AWS Identity and Access Management (IAM) + # accounts to database accounts, and otherwise false. # # Default: `false` # # @option params [String] :source_region # The source region of the snapshot. This is only needed when the @@ -1738,12 +1769,17 @@ # # @option params [required, String] :description # The description for the DB cluster parameter group. # # @option params [Array<Types::Tag>] :tags - # A list of tags. + # A list of tags. For more information, see [Tagging Amazon RDS + # Resources][1]. # + # + # + # [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html + # # @return [Types::CreateDBClusterParameterGroupResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::CreateDBClusterParameterGroupResult#db_cluster_parameter_group #db_cluster_parameter_group} => Types::DBClusterParameterGroup # # @@ -1986,11 +2022,11 @@ # # Example: `mydbinstance` # # @option params [Integer] :allocated_storage # The amount of storage (in gigabytes) to be initially allocated for the - # database instance. + # DB instance. # # Type: Integer # # **Amazon Aurora** # @@ -2072,12 +2108,12 @@ # # * 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 - # regions, or for all database engines. For the full list of DB instance + # `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. # # # @@ -2090,10 +2126,12 @@ # # Valid Values: # # * `aurora` # + # * `aurora-postgresql` + # # * `mariadb` # # * `mysql` # # * `oracle-ee` @@ -2179,12 +2217,12 @@ # * First character must be a letter. # # * Cannot be a reserved word for the chosen database engine. # # @option params [String] :master_user_password - # The password for the master user. Can be any printable ASCII character - # except "/", """, or "@". + # The password for the master user. The password can include any + # printable ASCII character except "/", """, or "@". # # **Amazon Aurora** # # Not applicable. The password for the master user is managed by the DB # cluster. For more information, see CreateDBCluster. @@ -2224,20 +2262,20 @@ # # Default: The default EC2 VPC security group for the DB subnet group's # VPC. # # @option params [String] :availability_zone - # The EC2 Availability Zone that the database instance is created in. - # For information on regions and Availability Zones, see [Regions and + # The EC2 Availability Zone that the DB instance is created in. For + # information on AWS Regions and Availability Zones, see [Regions and # Availability Zones][1]. # # Default: A random, system-chosen Availability Zone in the endpoint's # AWS Region. # # Example: `us-east-1d` # - # Constraint: The AvailabilityZone parameter cannot be specified if the + # Constraint: The AvailabilityZone parameter can't be specified if the # MultiAZ parameter is set to `true`. The specified Availability Zone # must be in the same AWS Region as the current endpoint. # # # @@ -2247,29 +2285,27 @@ # A DB subnet group to associate with this DB instance. # # If there is no DB subnet group, then it is a non-VPC DB instance. # # @option params [String] :preferred_maintenance_window - # The weekly time range during which system maintenance can occur, in - # Universal Coordinated Time (UTC). For more information, see [DB - # Instance Maintenance][1]. + # The time range each week during which system maintenance can occur, in + # Universal Coordinated Time (UTC). For more information, see [Amazon + # RDS Maintenance Window][1]. # # Format: `ddd:hh24:mi-ddd:hh24:mi` # - # Default: A 30-minute window selected at random from an 8-hour block of - # time per AWS Region, occurring on a random day of the week. To see the - # time blocks available, see [ Adjusting the Preferred Maintenance - # Window][2] in the *Amazon RDS User Guide.* + # The default is a 30-minute window selected at random from an 8-hour + # block of time for each AWS Region, occurring on a random day of the + # week. # - # Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun + # Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun. # # Constraints: Minimum 30-minute window. # # # - # [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBMaintenance.html - # [2]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/AdjustingTheMaintenanceWindow.html + # [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.Maintenance.html#Concepts.DBMaintenance # # @option params [String] :db_parameter_group_name # The name of the DB parameter group to associate with this DB instance. # If this argument is omitted, the default DBParameterGroup for the # specified engine is used. @@ -2301,34 +2337,34 @@ # * Cannot 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 [DB Instance Backups][1]. + # parameter. For more information, see [The Backup Window][1]. # # **Amazon Aurora** # # Not applicable. The daily time range for creating automated backups is # managed by the DB cluster. For more information, see CreateDBCluster. # - # Default: A 30-minute window selected at random from an 8-hour block of - # time per AWS Region. To see the time blocks available, see [ Adjusting - # the Preferred DB Instance Maintenance Window][2]. + # The default is a 30-minute window selected at random from an 8-hour + # block of time for each AWS Region. To see the time blocks available, + # see [ Adjusting the Preferred DB Instance Maintenance Window][2]. # # Constraints: # # * Must be in the format `hh24:mi-hh24:mi`. # - # * Times should be in Universal Coordinated Time (UTC). + # * Must be in Universal Coordinated Time (UTC). # # * Must not conflict with the preferred maintenance window. # # * Must be at least 30 minutes. # # # - # [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Overview.BackingUpAndRestoringAmazonRDSInstances.html + # [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithAutomatedBackups.html#USER_WorkingWithAutomatedBackups.BackupWindow # [2]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.Maintenance.html#AdjustingTheMaintenanceWindow # # @option params [Integer] :port # The port number on which the database accepts connections. # @@ -2376,11 +2412,11 @@ # Valid Values: `1150-65535` # # Type: Integer # # @option params [Boolean] :multi_az - # Specifies if the DB instance is a Multi-AZ deployment. You cannot set + # Specifies if the DB instance is a Multi-AZ deployment. You can't set # the AvailabilityZone parameter if the MultiAZ parameter is set to # true. # # @option params [String] :engine_version # The version number of the database engine to use. @@ -2395,98 +2431,96 @@ # by the DB instance is managed by the DB cluster. For more information, # see CreateDBCluster. # # **MariaDB** # - # * `10.1.23` (supported in all AWS regions) + # * `10.1.23` (supported in all AWS Regions) # - # * `10.1.19` (supported in all AWS regions) + # * `10.1.19` (supported in all AWS Regions) # - # * `10.1.14` (supported in all regions except us-east-2) + # * `10.1.14` (supported in all AWS Regions except us-east-2) # # # - # * `10.0.31` (supported in all AWS regions) + # * `10.0.31` (supported in all AWS Regions) # - # * `10.0.28` (supported in all AWS regions) + # * `10.0.28` (supported in all AWS Regions) # - # * `10.0.24` (supported in all AWS regions) + # * `10.0.24` (supported in all AWS Regions) # - # * `10.0.17` (supported in all regions except us-east-2, ca-central-1, - # eu-west-2) + # * `10.0.17` (supported in all AWS Regions except us-east-2, + # ca-central-1, eu-west-2) # # **Microsoft SQL Server 2016** # - # * `13.00.4422.0.v1` (supported for all editions, and all AWS regions) + # * `13.00.4422.0.v1` (supported for all editions, and all AWS Regions) # - # * `13.00.2164.0.v1` (supported for all editions, and all AWS regions) + # * `13.00.2164.0.v1` (supported for all editions, and all AWS Regions) # # **Microsoft SQL Server 2014** # - # * `12.00.5546.0.v1` (supported for all editions, and all AWS regions) + # * `12.00.5546.0.v1` (supported for all editions, and all AWS Regions) # - # * `12.00.5000.0.v1` (supported for all editions, and all AWS regions) + # * `12.00.5000.0.v1` (supported for all editions, and all AWS Regions) # # * `12.00.4422.0.v1` (supported for all editions except Enterprise - # Edition, and all AWS regions except ca-central-1 and eu-west-2) + # Edition, and all AWS Regions except ca-central-1 and eu-west-2) # # **Microsoft SQL Server 2012** # - # * `11.00.6594.0.v1` (supported for all editions, and all AWS regions) + # * `11.00.6594.0.v1` (supported for all editions, and all AWS Regions) # - # * `11.00.6020.0.v1` (supported for all editions, and all AWS regions) + # * `11.00.6020.0.v1` (supported for all editions, and all AWS Regions) # - # * `11.00.5058.0.v1` (supported for all editions, and all AWS regions + # * `11.00.5058.0.v1` (supported for all editions, and all AWS Regions # except us-east-2, ca-central-1, and eu-west-2) # - # * `11.00.2100.60.v1` (supported for all editions, and all AWS regions + # * `11.00.2100.60.v1` (supported for all editions, and all AWS Regions # except us-east-2, ca-central-1, and eu-west-2) # # **Microsoft SQL Server 2008 R2** # - # * `10.50.6529.0.v1` (supported for all editions, and all AWS regions + # * `10.50.6529.0.v1` (supported for all editions, and all AWS Regions # except us-east-2, ca-central-1, and eu-west-2) # - # * `10.50.6000.34.v1` (supported for all editions, and all AWS regions + # * `10.50.6000.34.v1` (supported for all editions, and all AWS Regions # except us-east-2, ca-central-1, and eu-west-2) # - # * `10.50.2789.0.v1` (supported for all editions, and all AWS regions + # * `10.50.2789.0.v1` (supported for all editions, and all AWS Regions # except us-east-2, ca-central-1, and eu-west-2) # # **MySQL** # # * `5.7.19` (supported in all AWS regions) # # * `5.7.17` (supported in all AWS regions) # # * `5.7.16` (supported in all AWS regions) # - # * `5.7.11` (supported in all AWS regions) # # + # * `5.6.37` (supported in all AWS Regions) # - # * `5.6.37` (supported in all AWS regions) + # * `5.6.35` (supported in all AWS Regions) # - # * `5.6.35` (supported in all AWS regions) + # * `5.6.34` (supported in all AWS Regions) # - # * `5.6.34` (supported in all AWS regions) + # * `5.6.29` (supported in all AWS Regions) # - # * `5.6.29` (supported in all AWS regions) + # * `5.6.27` (supported in all AWS Regions except us-east-2, + # ca-central-1, eu-west-2) # - # * `5.6.27` (supported in all regions except us-east-2, ca-central-1, - # eu-west-2) # # + # * `5.5.57` (supported in all AWS Regions) # - # * `5.5.57` (supported in all AWS regions) + # * `5.5.54` (supported in all AWS Regions) # - # * `5.5.54` (supported in all AWS regions) + # * `5.5.53` (supported in all AWS Regions) # - # * `5.5.53` (supported in all AWS regions) + # * `5.5.46` (supported in all AWS Regions) # - # * `5.5.46` (supported in all AWS regions) - # # **Oracle 12c** # # * `12.1.0.2.v9` (supported for EE in all AWS regions, and SE2 in all # AWS regions except us-gov-west-1) # @@ -2562,24 +2596,30 @@ # Valid values: `license-included` \| `bring-your-own-license` \| # `general-public-license` # # @option params [Integer] :iops # The amount of Provisioned IOPS (input/output operations per second) to - # be initially allocated for the DB instance. + # be initially allocated for the DB instance. For information about + # valid Iops values, see see [Amazon RDS Provisioned IOPS Storage to + # Improve Performance][1]. # # Constraints: Must be a multiple between 3 and 10 of the storage amount # for the DB instance. Must also be an integer multiple of 1000. For # example, if the size of your DB instance is 500 GB, then your `Iops` # value can be 2000, 3000, 4000, or 5000. # + # + # + # [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html#USER_PIOPS + # # @option params [String] :option_group_name # Indicates that the DB instance should be associated with the specified # option group. # # Permanent options, such as the TDE option for Oracle Advanced Security - # TDE, cannot be removed from an option group, and that option group - # cannot be removed from a DB instance once it is associated with a DB + # TDE, can't be removed from an option group, and that option group + # can't be removed from a DB instance once it is associated with a DB # instance # # @option params [String] :character_set_name # For supported engines, indicates that the DB instance should be # associated with the specified CharacterSet. @@ -2609,12 +2649,17 @@ # publicly accessible. If a specific DB subnet group has been specified # as part of the request and the PubliclyAccessible value has not been # set, the DB instance is private. # # @option params [Array<Types::Tag>] :tags - # A list of tags. + # A list of tags. For more information, see [Tagging Amazon RDS + # Resources][1]. # + # + # + # [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html + # # @option params [String] :db_cluster_identifier # The identifier of the DB cluster that the instance will belong to. # # For information on creating a DB cluster, see CreateDBCluster. # @@ -2626,19 +2671,19 @@ # 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 + # Default: `io1` if the `Iops` parameter is specified, otherwise # `standard` # # @option params [String] :tde_credential_arn - # The ARN from the Key Store with which to associate the instance for + # The ARN from the key store with which to associate the instance for # TDE encryption. # # @option params [String] :tde_credential_password - # The password for the given ARN from the Key Store in order to access + # The password for the given ARN from the key store in order to access # the device. # # @option params [Boolean] :storage_encrypted # Specifies whether the DB instance is encrypted. # @@ -2648,11 +2693,11 @@ # cluster. For more information, see CreateDBCluster. # # Default: false # # @option params [String] :kms_key_id - # The KMS key identifier for an encrypted DB instance. + # The AWS KMS key identifier for an encrypted DB instance. # # The KMS key identifier is the Amazon Resource Name (ARN) for the KMS # encryption key. If you are creating a DB instance with the same AWS # account that owns the KMS encryption key used to encrypt the new DB # instance, then you can use the KMS key alias instead of the ARN for @@ -2672,11 +2717,11 @@ # @option params [String] :domain # Specify the Active Directory Domain to create the instance in. # # @option params [Boolean] :copy_tags_to_snapshot # True to copy all tags from the DB instance to snapshots of the DB - # instance; otherwise false. The default is false. + # instance, and otherwise false. The default is false. # # @option params [Integer] :monitoring_interval # The interval, in seconds, between points when Enhanced Monitoring # metrics are collected for the DB instance. To disable collecting # Enhanced Monitoring metrics, specify 0. The default is 0. @@ -2686,11 +2731,11 @@ # # Valid Values: `0, 1, 5, 10, 15, 30, 60` # # @option params [String] :monitoring_role_arn # The ARN for the IAM role that permits RDS to send enhanced monitoring - # metrics to CloudWatch Logs. For example, + # metrics to Amazon CloudWatch Logs. For example, # `arn:aws:iam:123456789012:role/emaccess`. For information on creating # a monitoring role, go to [Setting Up and Enabling Enhanced # Monitoring][1]. # # If `MonitoringInterval` is set to a value other than 0, then you must @@ -2726,11 +2771,11 @@ # # [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_SQLServer.html#SQLServer.Concepts.General.TimeZone # # @option params [Boolean] :enable_iam_database_authentication # True to enable mapping of AWS Identity and Access Management (IAM) - # accounts to database accounts; otherwise false. + # accounts to database accounts, and otherwise false. # # You can enable IAM database authentication for the following database # engines: # # **Amazon Aurora** @@ -2745,17 +2790,17 @@ # * For MySQL 5.7, minor version 5.7.16 or higher # # Default: `false` # # @option params [Boolean] :enable_performance_insights - # True to enable Performance Insights for the DB instance; otherwise + # True to enable Performance Insights for the DB instance, and otherwise # false. # # @option params [String] :performance_insights_kms_key_id - # The KMS key identifier for encryption of Performance Insights data. - # The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, - # or the KMS key alias for the KMS encryption key. + # The AWS KMS key identifier for encryption of Performance Insights + # data. The KMS key ID is the Amazon Resource Name (ARN), KMS key + # identifier, or the KMS key alias for the KMS encryption key. # # @return [Types::CreateDBInstanceResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::CreateDBInstanceResult#db_instance #db_instance} => Types::DBInstance # @@ -2974,11 +3019,11 @@ # * Can specify a DB instance that is a MySQL Read Replica only if the # source is running MySQL 5.6. # # * 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 cross-region replication). # # * The specified DB instance must have automatic backups enabled, its # backup retention period must be greater than 0. # # * If the source DB instance is in the same AWS Region as the Read @@ -2992,12 +3037,12 @@ # # [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.ARN.html#USER_Tagging.ARN.Constructing # # @option params [String] :db_instance_class # The compute and memory capacity of the Read Replica, for example, - # `db.m4.large`. Not all DB instance classes are available in all - # regions, or for all database engines. For the full list of DB instance + # `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. # # Default: Inherits from the source DB instance. # @@ -3054,12 +3099,17 @@ # publicly accessible. If a specific DB subnet group has been specified # as part of the request and the PubliclyAccessible value has not been # set, the DB instance is private. # # @option params [Array<Types::Tag>] :tags - # A list of tags. + # A list of tags. For more information, see [Tagging Amazon RDS + # Resources][1]. # + # + # + # [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html + # # @option params [String] :db_subnet_group_name # Specifies a DB subnet group for the DB instance. The new DB instance # is created in the VPC associated with the DB subnet group. If no DB # subnet group is specified, then the new DB instance is not created in # a VPC. @@ -3091,16 +3141,16 @@ # 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 + # Default: `io1` if the `Iops` parameter is specified, otherwise # `standard` # # @option params [Boolean] :copy_tags_to_snapshot # True to copy all tags from the Read Replica to snapshots of the Read - # Replica; otherwise false. The default is false. + # Replica, and otherwise false. The default is false. # # @option params [Integer] :monitoring_interval # The interval, in seconds, between points when Enhanced Monitoring # metrics are collected for the Read Replica. To disable collecting # Enhanced Monitoring metrics, specify 0. The default is 0. @@ -3110,11 +3160,11 @@ # # Valid Values: `0, 1, 5, 10, 15, 30, 60` # # @option params [String] :monitoring_role_arn # The ARN for the IAM role that permits RDS to send enhanced monitoring - # metrics to CloudWatch Logs. For example, + # metrics to Amazon CloudWatch Logs. For example, # `arn:aws:iam:123456789012:role/emaccess`. For information on creating # a monitoring role, go to [To create an IAM role for Amazon RDS # Enhanced Monitoring][1]. # # If `MonitoringInterval` is set to a value other than 0, then you must @@ -3138,23 +3188,23 @@ # source DB instance. # # 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 cannot use encryption keys from one AWS Region in another + # in, and you can't use encryption keys from one AWS Region in another # AWS Region. # # @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. You can - # specify the source region option instead of this parameter when you - # create an encrypted Read Replica from another AWS Region by using the - # AWS CLI. + # specify the `--source-region` option instead of this parameter when + # you create an encrypted Read Replica from another AWS Region by using + # the AWS CLI. # # 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: @@ -3163,28 +3213,28 @@ # 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 - # region, from a source DB instance in the us-east-2 region, then you - # call the `CreateDBInstanceReadReplica` action in the us-east-1 - # region and provide a presigned URL that contains a call to the - # `CreateDBInstanceReadReplica` action in the us-west-2 region. For - # this example, the `DestinationRegion` in the presigned URL must be - # set to the us-east-1 region. + # AWS Region, from a source DB instance in the us-east-2 AWS Region, + # then you call the `CreateDBInstanceReadReplica` action in the + # us-east-1 AWS Region and provide a presigned URL that contains a + # 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 KMS key identifier for the key to use to 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. + # * `KmsKeyId` - The AWS KMS key identifier for the key to use to + # 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 - # instance in the us-west-2 region, then your + # 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 # [Authenticating Requests: Using Query Parameters (AWS Signature @@ -3195,11 +3245,11 @@ # [1]: http://docs.aws.amazon.com/AmazonS3/latest/API/sigv4-query-string-auth.html # [2]: http://docs.aws.amazon.com/general/latest/gr/signature-version-4.html # # @option params [Boolean] :enable_iam_database_authentication # True to enable mapping of AWS Identity and Access Management (IAM) - # accounts to database accounts; otherwise false. + # accounts to database accounts, and otherwise false. # # You can enable IAM database authentication for the following database # engines # # * For MySQL 5.6, minor version 5.6.34 or higher @@ -3209,17 +3259,17 @@ # * Aurora 5.6 or higher. # # Default: `false` # # @option params [Boolean] :enable_performance_insights - # True to enable Performance Insights for the read replica; otherwise - # false. + # True to enable Performance Insights for the read replica, and + # otherwise false. # # @option params [String] :performance_insights_kms_key_id - # The KMS key identifier for encryption of Performance Insights data. - # The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, - # or the KMS key alias for the KMS encryption key. + # The AWS KMS key identifier for encryption of Performance Insights + # data. The KMS key ID is the Amazon Resource Name (ARN), KMS key + # identifier, or the KMS key alias for the KMS encryption key. # # @option params [String] :source_region # The source region of the snapshot. This is only needed when the # shapshot is encrypted and in a different region. # @@ -3439,12 +3489,17 @@ # # @option params [required, String] :description # The description for the DB parameter group. # # @option params [Array<Types::Tag>] :tags - # A list of tags. + # A list of tags. For more information, see [Tagging Amazon RDS + # Resources][1]. # + # + # + # [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html + # # @return [Types::CreateDBParameterGroupResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::CreateDBParameterGroupResult#db_parameter_group #db_parameter_group} => Types::DBParameterGroup # # @@ -3515,12 +3570,17 @@ # # @option params [required, String] :db_security_group_description # The description for the DB security group. # # @option params [Array<Types::Tag>] :tags - # A list of tags. + # A list of tags. For more information, see [Tagging Amazon RDS + # Resources][1]. # + # + # + # [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html + # # @return [Types::CreateDBSecurityGroupResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::CreateDBSecurityGroupResult#db_security_group #db_security_group} => Types::DBSecurityGroup # # @@ -3604,12 +3664,17 @@ # * Must match the identifier of an existing DBInstance. # # ^ # # @option params [Array<Types::Tag>] :tags - # A list of tags. + # A list of tags. For more information, see [Tagging Amazon RDS + # Resources][1]. # + # + # + # [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html + # # @return [Types::CreateDBSnapshotResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::CreateDBSnapshotResult#db_snapshot #db_snapshot} => Types::DBSnapshot # # @@ -3696,12 +3761,17 @@ # # @option params [required, Array<String>] :subnet_ids # The EC2 Subnet IDs for the DB subnet group. # # @option params [Array<Types::Tag>] :tags - # A list of tags. + # A list of tags. For more information, see [Tagging Amazon RDS + # Resources][1]. # + # + # + # [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html + # # @return [Types::CreateDBSubnetGroupResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::CreateDBSubnetGroupResult#db_subnet_group #db_subnet_group} => Types::DBSubnetGroup # # @@ -3812,11 +3882,11 @@ # # @option params [Array<String>] :source_ids # The list of identifiers of the event sources for which events are # returned. If not specified, then all sources are included in the # response. An identifier must begin with a letter and must contain only - # ASCII letters, digits, and hyphens; it cannot end with a hyphen or + # ASCII letters, digits, and hyphens; it can't end with a hyphen or # contain two consecutive hyphens. # # Constraints: # # * If SourceIds are supplied, SourceType must also be provided. @@ -3836,12 +3906,17 @@ # @option params [Boolean] :enabled # A Boolean value; set to **true** to activate the subscription, set to # **false** to create the subscription but not active it. # # @option params [Array<Types::Tag>] :tags - # A list of tags. + # A list of tags. For more information, see [Tagging Amazon RDS + # Resources][1]. # + # + # + # [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html + # # @return [Types::CreateEventSubscriptionResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::CreateEventSubscriptionResult#event_subscription #event_subscription} => Types::EventSubscription # # @@ -3934,12 +4009,17 @@ # # @option params [required, String] :option_group_description # The description of the option group. # # @option params [Array<Types::Tag>] :tags - # A list of tags. + # A list of tags. For more information, see [Tagging Amazon RDS + # Resources][1]. # + # + # + # [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html + # # @return [Types::CreateOptionGroupResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::CreateOptionGroupResult#option_group #option_group} => Types::OptionGroup # # @@ -4017,11 +4097,11 @@ req.send_request(options) end # The DeleteDBCluster action deletes a previously provisioned DB # cluster. When you delete a DB cluster, all automated backups for that - # DB cluster are deleted and cannot be recovered. Manual DB cluster + # DB cluster are deleted and can't be recovered. Manual DB cluster # snapshots of the specified DB cluster are not deleted. # # # # For more information on Amazon Aurora, see [Aurora on Amazon RDS][1] @@ -4157,11 +4237,11 @@ req = build_request(:delete_db_cluster, params) req.send_request(options) end # Deletes a specified DB cluster parameter group. The DB cluster - # parameter group to be deleted cannot be associated with any DB + # parameter group to be deleted can't be associated with any DB # clusters. # # For more information on Amazon Aurora, see [Aurora on Amazon RDS][1] # in the *Amazon RDS User Guide.* # @@ -4174,11 +4254,11 @@ # # Constraints: # # * Must be the name of an existing DB cluster parameter group. # - # * You cannot delete a default DB cluster parameter group. + # * You can't delete a default DB cluster parameter group. # # * Cannot be associated with any DB clusters. # # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # @@ -4285,26 +4365,26 @@ req.send_request(options) end # The DeleteDBInstance action deletes a previously provisioned DB # instance. When you delete a DB instance, all automated backups for - # that instance are deleted and cannot be recovered. Manual DB snapshots + # that instance are deleted and can't be recovered. Manual DB snapshots # of the DB instance to be deleted by `DeleteDBInstance` are not # deleted. # # If you request a final DB snapshot the status of the Amazon RDS DB # instance is `deleting` until the DB snapshot is created. The API # action `DescribeDBInstance` is used to monitor the status of this - # operation. The action cannot be canceled or reverted once submitted. + # operation. The action can't be canceled or reverted once submitted. # # Note that when a DB instance is in a failure state and has a status of # `failed`, `incompatible-restore`, or `incompatible-network`, you can # only delete it when the `SkipFinalSnapshot` parameter is set to # `true`. # # If the specified DB instance is part of an Amazon Aurora DB cluster, - # you cannot delete the DB instance if both of the following conditions + # 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 # cluster. # @@ -4495,20 +4575,20 @@ req = build_request(:delete_db_instance, params) req.send_request(options) end # Deletes a specified DBParameterGroup. The DBParameterGroup to be - # deleted cannot be associated with any DB instances. + # deleted can't be associated with any DB instances. # # @option params [required, String] :db_parameter_group_name # The name of the DB parameter group. # # Constraints: # # * Must be the name of an existing DB parameter group # - # * You cannot delete a default DB parameter group + # * You can't delete a default DB parameter group # # * Cannot be associated with any DB instances # # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # @@ -4544,11 +4624,11 @@ # </note> # # @option params [required, String] :db_security_group_name # The name of the DB security group to delete. # - # <note markdown="1"> You cannot delete the default DB security group. + # <note markdown="1"> You can't delete the default DB security group. # # </note> # # Constraints: # @@ -4670,11 +4750,11 @@ # </note> # # @option params [required, String] :db_subnet_group_name # The name of the database subnet group to delete. # - # <note markdown="1"> You cannot delete the default subnet group. + # <note markdown="1"> You can't delete the default subnet group. # # </note> # # Constraints: # @@ -4767,11 +4847,11 @@ # Deletes an existing option group. # # @option params [required, String] :option_group_name # The name of the option group to be deleted. # - # <note markdown="1"> You cannot delete default option groups. + # <note markdown="1"> You can't delete default option groups. # # </note> # # @return [Struct] Returns an empty {Seahorse::Client::Response response}. # @@ -5188,11 +5268,11 @@ # # [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Aurora.html # # @option params [String] :db_cluster_identifier # The ID of the DB cluster to retrieve the list of DB cluster snapshots - # for. This parameter cannot be used in conjunction with the + # for. This parameter can't be used in conjunction with the # `DBClusterSnapshotIdentifier` parameter. This parameter is not # case-sensitive. # # Constraints: # @@ -5200,11 +5280,11 @@ # # ^ # # @option params [String] :db_cluster_snapshot_identifier # A specific DB cluster snapshot identifier to describe. This parameter - # cannot be used in conjunction with the `DBClusterIdentifier` + # can't be used in conjunction with the `DBClusterIdentifier` # parameter. This value is stored as a lowercase string. # # Constraints: # # * If supplied, must match the identifier of an existing @@ -5259,24 +5339,22 @@ # `DescribeDBClusterSnapshots` request. If this parameter is specified, # the response includes only records beyond the marker, up to the value # specified by `MaxRecords`. # # @option params [Boolean] :include_shared - # Set this value to `true` to include shared manual DB cluster snapshots - # from other AWS accounts that this AWS account has been given - # permission to copy or restore, otherwise set this value to `false`. - # The default is `false`. + # True to include shared manual DB cluster snapshots from other AWS + # accounts that this AWS account has been given permission to copy or + # restore, and otherwise false. The default is `false`. # # You can give an AWS account permission to restore a manual DB cluster # snapshot from another AWS account by the # ModifyDBClusterSnapshotAttribute API action. # # @option params [Boolean] :include_public - # Set this value to `true` to include manual DB cluster snapshots that - # are public and can be copied or restored by any AWS account, otherwise - # set this value to `false`. The default is `false`. The default is - # false. + # True to include manual DB cluster snapshots that are public and can be + # copied or restored by any AWS account, and otherwise false. The + # default is `false`. The default is false. # # You can share a manual DB cluster snapshot as public by using the # ModifyDBClusterSnapshotAttribute API action. # # @return [Types::DBClusterSnapshotMessage] Returns a {Seahorse::Client::Response response} object which responds to the following methods: @@ -5635,11 +5713,11 @@ # # Supported filters: # # * `db-cluster-id` - Accepts DB cluster identifiers and DB cluster # Amazon Resource Names (ARNs). The results list will only include - # information about the DB instances associated with the DB Clusters + # information about the DB instances associated with the DB clusters # identified by these ARNs. # # * `db-instance-id` - Accepts DB instance identifiers and DB instance # Amazon Resource Names (ARNs). The results list will only include # information about the DB instances identified by these ARNs. @@ -6218,21 +6296,21 @@ # Returns information about DB snapshots. This API action supports # pagination. # # @option params [String] :db_instance_identifier # The ID of the DB instance to retrieve the list of DB snapshots for. - # This parameter cannot be used in conjunction with + # This parameter can't be used in conjunction with # `DBSnapshotIdentifier`. This parameter is not case-sensitive. # # Constraints: # # * If supplied, must match the identifier of an existing DBInstance. # # ^ # # @option params [String] :db_snapshot_identifier - # A specific DB snapshot identifier to describe. This parameter cannot + # A specific DB snapshot identifier to describe. This parameter can't # be used in conjunction with `DBInstanceIdentifier`. This value is # stored as a lowercase string. # # Constraints: # @@ -6287,23 +6365,22 @@ # `DescribeDBSnapshots` request. If this parameter is specified, the # response includes only records beyond the marker, up to the value # specified by `MaxRecords`. # # @option params [Boolean] :include_shared - # Set this value to `true` to include shared manual DB snapshots from - # other AWS accounts that this AWS account has been given permission to - # copy or restore, otherwise set this value to `false`. The default is - # `false`. + # True to include shared manual DB snapshots from other AWS accounts + # that this AWS account has been given permission to copy or restore, + # and otherwise false. The default is `false`. # # You can give an AWS account permission to restore a manual DB snapshot # from another AWS account by using the ModifyDBSnapshotAttribute API # action. # # @option params [Boolean] :include_public - # Set this value to `true` to include manual DB snapshots that are - # public and can be copied or restored by any AWS account, otherwise set - # this value to `false`. The default is `false`. + # True to include manual DB snapshots that are public and can be copied + # or restored by any AWS account, and otherwise false. The default is + # false. # # You can share a manual DB snapshot as public by using the # ModifyDBSnapshotAttribute API. # # @return [Types::DBSnapshotMessage] Returns a {Seahorse::Client::Response response} object which responds to the following methods: @@ -7611,11 +7688,11 @@ def describe_reserved_db_instances_offerings(params = {}, options = {}) 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 + # 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 # supports pagination. # # @option params [String] :region_name # The source AWS Region name. For example, `us-east-1`. @@ -8155,28 +8232,29 @@ # parameter is set to `true` for this request. If the parameter change # results in an option group that enables OEM, this change can cause a # brief (sub-second) period during which new connections are rejected # but existing connections are not interrupted. # - # Permanent options cannot be removed from an option group. The option - # group cannot be removed from a DB cluster once it is associated with a + # Permanent options can't be removed from an option group. The option + # group can't be removed from a DB cluster once it is associated with a # DB cluster. # # @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. # - # Default: A 30-minute window selected at random from an 8-hour block of - # time per AWS Region. To see the time blocks available, see [ Adjusting - # the Preferred Maintenance Window][1] in the *Amazon RDS User Guide.* + # The default is a 30-minute window selected at random from an 8-hour + # block of time for each AWS Region. To see the time blocks available, + # see [ Adjusting the Preferred Maintenance Window][1] in the *Amazon + # RDS User Guide.* # # Constraints: # # * Must be in the format `hh24:mi-hh24:mi`. # - # * Times should be in Universal Coordinated Time (UTC). + # * Must be in Universal Coordinated Time (UTC). # # * Must not conflict with the preferred maintenance window. # # * Must be at least 30 minutes. # @@ -8188,27 +8266,26 @@ # The weekly time range during which system maintenance can occur, in # Universal Coordinated Time (UTC). # # Format: `ddd:hh24:mi-ddd:hh24:mi` # - # Default: A 30-minute window selected at random from an 8-hour block of - # time per AWS Region, occurring on a random day of the week. To see the - # time blocks available, see [ Adjusting the Preferred Maintenance - # Window][1] in the *Amazon RDS User Guide.* + # The default is a 30-minute window selected at random from an 8-hour + # block of time for each AWS Region, occurring on a random day of the + # week. To see the time blocks available, see [ Adjusting the Preferred + # Maintenance Window][1] in the *Amazon RDS User Guide.* # - # Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun + # Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun. # # Constraints: Minimum 30-minute window. # # # # [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/AdjustingTheMaintenanceWindow.html # # @option params [Boolean] :enable_iam_database_authentication - # A Boolean value that is true to enable mapping of AWS Identity and - # Access Management (IAM) accounts to database accounts, and otherwise - # false. + # True to enable mapping of AWS Identity and Access Management (IAM) + # accounts to database accounts, and otherwise false. # # Default: `false` # # @return [Types::ModifyDBClusterResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # @@ -8601,12 +8678,12 @@ # rebooting the instance, deleting the instance, creating a Read Replica # for the instance, and creating a DB snapshot of the instance. # # @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 - # regions, or for all database engines. For the full list of DB instance + # `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. # # If you modify the DB instance class, an outage occurs during the # change. The change is applied during the next maintenance window, @@ -8684,12 +8761,12 @@ # # # [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Overview.DBInstance.Modifying.html # # @option params [String] :master_user_password - # The new password for the master user. Can be any printable ASCII - # character except "/", """, or "@". + # The new password for the master user. The password can include any + # printable ASCII character except "/", """, or "@". # # Changing this parameter does not result in an outage and the change is # asynchronously applied as soon as possible. Between the time of the # request and the completion of the request, the `MasterUserPassword` # element exists in the `PendingModifiedValues` element of the operation @@ -8788,11 +8865,11 @@ # # Constraints: # # * Must be in the format hh24:mi-hh24:mi # - # * Times should be in Universal Time Coordinated (UTC) + # * Must be in Universal Time Coordinated (UTC) # # * Must not conflict with the preferred maintenance window # # * Must be at least 30 minutes # @@ -8906,12 +8983,12 @@ # group that enables OEM, this change can cause a brief (sub-second) # period during which new connections are rejected but existing # connections are not interrupted. # # Permanent options, such as the TDE option for Oracle Advanced Security - # TDE, cannot be removed from an option group, and that option group - # cannot be removed from a DB instance once it is associated with a DB + # TDE, can't be removed from an option group, and that option group + # can't be removed from a DB instance once it is associated with a DB # instance # # @option params [String] :new_db_instance_identifier # The new DB instance identifier for the DB instance when renaming a DB # instance. When you change the DB instance identifier, an instance @@ -8935,19 +9012,19 @@ # 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 + # Default: `io1` if the `Iops` parameter is specified, otherwise # `standard` # # @option params [String] :tde_credential_arn - # The ARN from the Key Store with which to associate the instance for + # The ARN from the key store with which to associate the instance for # TDE encryption. # # @option params [String] :tde_credential_password - # The password for the given ARN from the Key Store in order to access + # The password for the given ARN from the key store in order to access # the device. # # @option params [String] :ca_certificate_identifier # Indicates the certificate that needs to be associated with the # instance. @@ -8958,11 +9035,11 @@ # created prior to this operation. Currently only a Microsoft SQL Server # instance can be created in a Active Directory Domain. # # @option params [Boolean] :copy_tags_to_snapshot # True to copy all tags from the DB instance to snapshots of the DB - # instance; otherwise false. The default is false. + # instance, and otherwise false. The default is false. # # @option params [Integer] :monitoring_interval # The interval, in seconds, between points when Enhanced Monitoring # metrics are collected for the DB instance. To disable collecting # Enhanced Monitoring metrics, specify 0. The default is 0. @@ -9037,11 +9114,11 @@ # # Default: false # # @option params [String] :monitoring_role_arn # The ARN for the IAM role that permits RDS to send enhanced monitoring - # metrics to CloudWatch Logs. For example, + # metrics to Amazon CloudWatch Logs. For example, # `arn:aws:iam:123456789012:role/emaccess`. For information on creating # a monitoring role, go to [To create an IAM role for Amazon RDS # Enhanced Monitoring][1]. # # If `MonitoringInterval` is set to a value other than 0, then you must @@ -9069,11 +9146,11 @@ # # [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Aurora.Managing.html#Aurora.Managing.FaultTolerance # # @option params [Boolean] :enable_iam_database_authentication # True to enable mapping of AWS Identity and Access Management (IAM) - # accounts to database accounts; otherwise false. + # accounts to database accounts, and otherwise false. # # You can enable IAM database authentication for the following database # engines # # **Amazon Aurora** @@ -9088,17 +9165,17 @@ # * For MySQL 5.7, minor version 5.7.16 or higher # # Default: `false` # # @option params [Boolean] :enable_performance_insights - # True to enable Performance Insights for the DB instance; otherwise + # True to enable Performance Insights for the DB instance, and otherwise # false. # # @option params [String] :performance_insights_kms_key_id - # The KMS key identifier for encryption of Performance Insights data. - # The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier, - # or the KMS key alias for the KMS encryption key. + # The AWS KMS key identifier for encryption of Performance Insights + # data. The KMS key ID is the Amazon Resource Name (ARN), KMS key + # identifier, or the KMS key alias for the KMS encryption key. # # @return [Types::ModifyDBInstanceResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::ModifyDBInstanceResult#db_instance #db_instance} => Types::DBInstance # @@ -9633,11 +9710,11 @@ req = build_request(:modify_db_subnet_group, params) req.send_request(options) end # Modifies an existing RDS event notification subscription. Note that - # you cannot modify the source identifiers using this call; to change + # you can't modify the source identifiers using this call; to change # source identifiers for a subscription, use the # AddSourceIdentifierToSubscription and # RemoveSourceIdentifierFromSubscription calls. # # You can see a list of the event categories for a given SourceType in @@ -9741,12 +9818,12 @@ # # @option params [required, String] :option_group_name # The name of the option group to be modified. # # Permanent options, such as the TDE option for Oracle Advanced Security - # TDE, cannot be removed from an option group, and that option group - # cannot be removed from a DB instance once it is associated with a DB + # TDE, can't be removed from an option group, and that option group + # can't be removed from a DB instance once it is associated with a DB # instance # # @option params [Array<Types::OptionConfiguration>] :options_to_include # Options in this list are added to the option group or, if already # present, the specified configuration is used to update the existing @@ -9897,19 +9974,20 @@ # @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. # - # Default: A 30-minute window selected at random from an 8-hour block of - # time per AWS Region. To see the time blocks available, see [ Adjusting - # the Preferred Maintenance Window][1] in the *Amazon RDS User Guide.* + # The default is a 30-minute window selected at random from an 8-hour + # block of time for each AWS Region. To see the time blocks available, + # see [ Adjusting the Preferred Maintenance Window][1] in the *Amazon + # RDS User Guide.* # # Constraints: # # * Must be in the format `hh24:mi-hh24:mi`. # - # * Times should be in Universal Coordinated Time (UTC). + # * Must be in Universal Coordinated Time (UTC). # # * Must not conflict with the preferred maintenance window. # # * Must be at least 30 minutes. # @@ -10148,12 +10226,17 @@ # The number of instances to reserve. # # Default: `1` # # @option params [Array<Types::Tag>] :tags - # A list of tags. + # A list of tags. For more information, see [Tagging Amazon RDS + # Resources][1]. # + # + # + # [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html + # # @return [Types::PurchaseReservedDBInstancesOfferingResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::PurchaseReservedDBInstancesOfferingResult#reserved_db_instance #reserved_db_instance} => Types::ReservedDBInstance # # @@ -10246,11 +10329,11 @@ # ^ # # @option params [Boolean] :force_failover # When `true`, the reboot is conducted through a MultiAZ failover. # - # Constraint: You cannot specify `true` if the instance is not + # Constraint: You can't specify `true` if the instance is not # configured for MultiAZ. # # @return [Types::RebootDBInstanceResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::RebootDBInstanceResult#db_instance #db_instance} => Types::DBInstance @@ -10552,16 +10635,16 @@ # The name of the DB cluster parameter group to reset. # # @option params [Boolean] :reset_all_parameters # A value that is set to `true` to reset all parameters in the DB # cluster parameter group to their default values, and `false` - # otherwise. You cannot use this parameter if there is a list of + # otherwise. You can't use this parameter if there is a list of # parameter names specified for the `Parameters` parameter. # # @option params [Array<Types::Parameter>] :parameters # A list of parameter names in the DB cluster parameter group to reset - # to the default values. You cannot use this parameter if the + # to the default values. You can't use this parameter if the # `ResetAllParameters` parameter is set to `true`. # # @return [Types::DBClusterParameterGroupNameMessage] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # # * {Types::DBClusterParameterGroupNameMessage#db_cluster_parameter_group_name #db_cluster_parameter_group_name} => String @@ -10749,12 +10832,12 @@ # # @option params [String] :database_name # The database name for the restored DB cluster. # # @option params [required, String] :db_cluster_identifier - # The name of the DB cluster to create from the source data in the S3 - # bucket. This parameter is isn't case-sensitive. + # The name of the DB cluster to create from the source data in the + # Amazon S3 bucket. This parameter is isn't case-sensitive. # # Constraints: # # * Must contain from 1 to 63 letters, numbers, or hyphens. # @@ -10790,11 +10873,11 @@ # # @option params [required, String] :engine # The name of the database engine to be used for the restored DB # cluster. # - # Valid Values: `aurora` + # Valid Values: `aurora`, `aurora-postgresql` # # @option params [String] :engine_version # The version number of the database engine to use. # # **Aurora** @@ -10826,28 +10909,29 @@ # # @option params [String] :option_group_name # A value that indicates that the restored DB cluster should be # associated with the specified option group. # - # Permanent options cannot be removed from an option group. An option - # group cannot be removed from a DB cluster once it is associated with a + # Permanent options can't be removed from an option group. An option + # group can't be removed from a DB cluster once it is associated with a # DB cluster. # # @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. # - # Default: A 30-minute window selected at random from an 8-hour block of - # time per AWS Region. To see the time blocks available, see [ Adjusting - # the Preferred Maintenance Window][1] in the *Amazon RDS User Guide.* + # The default is a 30-minute window selected at random from an 8-hour + # block of time for each AWS Region. To see the time blocks available, + # see [ Adjusting the Preferred Maintenance Window][1] in the *Amazon + # RDS User Guide.* # # Constraints: # # * Must be in the format `hh24:mi-hh24:mi`. # - # * Times should be in Universal Coordinated Time (UTC). + # * Must be in Universal Coordinated Time (UTC). # # * Must not conflict with the preferred maintenance window. # # * Must be at least 30 minutes. # @@ -10859,31 +10943,36 @@ # The weekly time range during which system maintenance can occur, in # Universal Coordinated Time (UTC). # # Format: `ddd:hh24:mi-ddd:hh24:mi` # - # Default: A 30-minute window selected at random from an 8-hour block of - # time per AWS Region, occurring on a random day of the week. To see the - # time blocks available, see [ Adjusting the Preferred Maintenance - # Window][1] in the *Amazon RDS User Guide.* + # The default is a 30-minute window selected at random from an 8-hour + # block of time for each AWS Region, occurring on a random day of the + # week. To see the time blocks available, see [ Adjusting the Preferred + # Maintenance Window][1] in the *Amazon RDS User Guide.* # - # Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun + # Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun. # # Constraints: Minimum 30-minute window. # # # # [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/AdjustingTheMaintenanceWindow.html # # @option params [Array<Types::Tag>] :tags - # A list of tags. + # A list of tags. For more information, see [Tagging Amazon RDS + # Resources][1]. # + # + # + # [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html + # # @option params [Boolean] :storage_encrypted # Specifies whether the restored DB cluster is encrypted. # # @option params [String] :kms_key_id - # The KMS key identifier for an encrypted DB cluster. + # The AWS KMS key identifier for an encrypted DB cluster. # # The KMS key identifier is the Amazon Resource Name (ARN) for the KMS # encryption key. If you are creating a DB cluster with the same AWS # account that owns the KMS encryption key used to encrypt the new DB # cluster, then you can use the KMS key alias instead of the ARN for the @@ -10894,13 +10983,12 @@ # default encryption key. AWS KMS creates the default encryption key for # your AWS account. Your AWS account has a different default encryption # key for each AWS Region. # # @option params [Boolean] :enable_iam_database_authentication - # A Boolean value that is true to enable mapping of AWS Identity and - # Access Management (IAM) accounts to database accounts, and otherwise - # false. + # True to enable mapping of AWS Identity and Access Management (IAM) + # accounts to database accounts, and otherwise false. # # Default: `false` # # @option params [required, String] :source_engine # The identifier for the database engine that was backed up to create @@ -11114,12 +11202,12 @@ # # @option params [Array<Types::Tag>] :tags # The tags to be assigned to the restored DB cluster. # # @option params [String] :kms_key_id - # The KMS key identifier to use when restoring an encrypted DB cluster - # from a DB snapshot or DB cluster snapshot. + # The AWS KMS key identifier to use when restoring an encrypted DB + # cluster from a DB snapshot or DB cluster snapshot. # # The KMS key identifier is the Amazon Resource Name (ARN) for the KMS # encryption key. If you are restoring a DB cluster with the same AWS # account that owns the KMS encryption key used to encrypt the new DB # cluster, then you can use the KMS key alias instead of the ARN for the @@ -11134,13 +11222,12 @@ # # * If the DB snapshot or DB cluster snapshot in `SnapshotIdentifier` is # not encrypted, then the restored DB cluster is not encrypted. # # @option params [Boolean] :enable_iam_database_authentication - # A Boolean value that is true to enable mapping of AWS Identity and - # Access Management (IAM) accounts to database accounts, and otherwise - # false. + # True to enable mapping of AWS Identity and Access Management (IAM) + # accounts to database accounts, and otherwise false. # # Default: `false` # # @return [Types::RestoreDBClusterFromSnapshotResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # @@ -11287,11 +11374,11 @@ # source DB cluster. # # * `copy-on-write` - The new DB cluster is restored as a clone of the # source DB cluster. # - # Constraints: You cannot specify `copy-on-write` if the engine version + # Constraints: You can't specify `copy-on-write` if the engine version # of the source DB cluster is earlier than 1.11. # # If you don't specify a `RestoreType` value, then the new DB cluster # is restored as a full copy of the source DB cluster. # @@ -11352,15 +11439,20 @@ # # @option params [Array<String>] :vpc_security_group_ids # A list of VPC security groups that the new DB cluster belongs to. # # @option params [Array<Types::Tag>] :tags - # A list of tags. + # A list of tags. For more information, see [Tagging Amazon RDS + # Resources][1]. # + # + # + # [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html + # # @option params [String] :kms_key_id - # The KMS key identifier to use when restoring an encrypted DB cluster - # from an encrypted DB cluster. + # The AWS KMS key identifier to use when restoring an encrypted DB + # cluster from an encrypted DB cluster. # # The KMS key identifier is the Amazon Resource Name (ARN) for the KMS # encryption key. If you are restoring a DB cluster with the same AWS # account that owns the KMS encryption key used to encrypt the new DB # cluster, then you can use the KMS key alias instead of the ARN for the @@ -11383,13 +11475,12 @@ # # If `DBClusterIdentifier` refers to a DB cluster that is not encrypted, # then the restore request is rejected. # # @option params [Boolean] :enable_iam_database_authentication - # A Boolean value that is true to enable mapping of AWS Identity and - # Access Management (IAM) accounts to database accounts, and otherwise - # false. + # True to enable mapping of AWS Identity and Access Management (IAM) + # accounts to database accounts, and otherwise false. # # Default: `false` # # @return [Types::RestoreDBClusterToPointInTimeResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods: # @@ -11540,11 +11631,11 @@ # `DBSnapshotIdentifier` must be the ARN of the shared DB snapshot. # # @option params [String] :db_instance_class # The compute and memory capacity of the Amazon RDS DB instance, for # example, `db.m4.large`. Not all DB instance classes are available in - # all regions, or for all database engines. For the full list of DB + # 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. # # Default: The same DBInstanceClass as the original DB instance. # @@ -11558,15 +11649,15 @@ # Default: The same port as the original DB instance # # Constraints: Value must be `1150-65535` # # @option params [String] :availability_zone - # The EC2 Availability Zone that the database instance is created in. + # The EC2 Availability Zone that the DB instance is created in. # # Default: A random, system-chosen Availability Zone. # - # Constraint: You cannot specify the AvailabilityZone parameter if the + # Constraint: You can't specify the AvailabilityZone parameter if the # MultiAZ parameter is set to `true`. # # Example: `us-east-1a` # # @option params [String] :db_subnet_group_name @@ -11578,11 +11669,11 @@ # Example: `mySubnetgroup` # # @option params [Boolean] :multi_az # Specifies if the DB instance is a Multi-AZ deployment. # - # Constraint: You cannot specify the AvailabilityZone parameter if the + # Constraint: You can't specify the AvailabilityZone parameter if the # MultiAZ parameter is set to `true`. # # @option params [Boolean] :publicly_accessible # Specifies the accessibility options for the DB instance. A value of # true specifies an Internet-facing instance with a publicly resolvable @@ -11634,10 +11725,12 @@ # # Valid Values: # # * `aurora` # + # * `aurora-postgresql` + # # * `mariadb` # # * `mysql` # # * `oracle-ee` @@ -11678,50 +11771,55 @@ # # @option params [String] :option_group_name # The name of the option group to be used for the restored DB instance. # # Permanent options, such as the TDE option for Oracle Advanced Security - # TDE, cannot be removed from an option group, and that option group - # cannot be removed from a DB instance once it is associated with a DB + # TDE, can't be removed from an option group, and that option group + # can't be removed from a DB instance once it is associated with a DB # instance # # @option params [Array<Types::Tag>] :tags - # A list of tags. + # A list of tags. For more information, see [Tagging Amazon RDS + # Resources][1]. # + # + # + # [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html + # # @option params [String] :storage_type # Specifies the storage type to be associated with the DB instance. # # 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 + # Default: `io1` if the `Iops` parameter is specified, otherwise # `standard` # # @option params [String] :tde_credential_arn - # The ARN from the Key Store with which to associate the instance for + # The ARN from the key store with which to associate the instance for # TDE encryption. # # @option params [String] :tde_credential_password - # The password for the given ARN from the Key Store in order to access + # The password for the given ARN from the key store in order to access # the device. # # @option params [String] :domain # Specify the Active Directory Domain to restore the instance in. # # @option params [Boolean] :copy_tags_to_snapshot # True to copy all tags from the restored DB instance to snapshots of - # the DB instance; otherwise false. The default is false. + # the DB instance, and otherwise false. The default is false. # # @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. # # @option params [Boolean] :enable_iam_database_authentication # True to enable mapping of AWS Identity and Access Management (IAM) - # accounts to database accounts; otherwise false. + # accounts to database accounts, and otherwise false. # # You can enable IAM database authentication for the following database # engines # # * For MySQL 5.6, minor version 5.6.34 or higher @@ -11964,10 +12062,470 @@ def restore_db_instance_from_db_snapshot(params = {}, options = {}) req = build_request(:restore_db_instance_from_db_snapshot, params) req.send_request(options) end + # Amazon Relational Database Service (Amazon RDS) supports importing + # MySQL databases by using backup files. You can create a backup of your + # on-premises database, store it on Amazon Simple Storage Service + # (Amazon S3), and then restore the backup file onto a new Amazon RDS DB + # instance running MySQL. For more information, see [Importing Data into + # an Amazon RDS MySQL DB Instance][1]. + # + # + # + # [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/MySQL.Procedural.Importing.html + # + # @option params [String] :db_name + # The name of the database to create when the DB instance is created. + # Follow the naming rules specified in CreateDBInstance. + # + # @option params [required, String] :db_instance_identifier + # The DB instance identifier. This parameter is stored as a lowercase + # string. + # + # Constraints: + # + # * Must contain from 1 to 63 letters, numbers, or hyphens. + # + # * First character must be a letter. + # + # * Cannot end with a hyphen or contain two consecutive hyphens. + # + # Example: `mydbinstance` + # + # @option params [Integer] :allocated_storage + # The amount of storage (in gigabytes) to allocate initially for the DB + # instance. Follow the allocation rules specified in CreateDBInstance. + # + # <note markdown="1"> Be sure to allocate enough memory for your new DB instance so that the + # restore operation can succeed. You can also allocate additional memory + # for future growth. + # + # </note> + # + # @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 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. + # + # Importing from Amazon S3 is not supported on the db.t2.micro DB + # instance class. + # + # + # + # [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html + # + # @option params [required, String] :engine + # The name of the database engine to be used for this instance. + # + # Valid Values: `mysql` + # + # @option params [String] :master_username + # The name for the master user. + # + # Constraints: + # + # * Must be 1 to 16 letters or numbers. + # + # * First character must be a letter. + # + # * Cannot be a reserved word for the chosen database engine. + # + # @option params [String] :master_user_password + # The password for the master user. The password can include any + # printable ASCII character except "/", """, or "@". + # + # Constraints: Must contain from 8 to 41 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. + # + # @option params [Array<String>] :vpc_security_group_ids + # A list of VPC security groups to associate with this DB instance. + # + # @option params [String] :availability_zone + # The Availability Zone that the DB instance is created in. For + # information about AWS Regions and Availability Zones, see [Regions and + # Availability Zones][1]. + # + # Default: A random, system-chosen Availability Zone in the endpoint's + # AWS Region. + # + # Example: `us-east-1d` + # + # Constraint: The AvailabilityZone parameter can't be specified if the + # MultiAZ parameter is set to `true`. The specified Availability Zone + # must be in the same AWS Region as the current endpoint. + # + # + # + # [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.RegionsAndAvailabilityZones.html + # + # @option params [String] :db_subnet_group_name + # A DB subnet group to associate with this DB instance. + # + # @option params [String] :preferred_maintenance_window + # The time range each week during which system maintenance can occur, in + # Universal Coordinated Time (UTC). For more information, see [Amazon + # RDS Maintenance Window][1]. + # + # Constraints: + # + # * Must be in the format `ddd:hh24:mi-ddd:hh24:mi`. + # + # * Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun. + # + # * Must be in Universal Coordinated Time (UTC). + # + # * Must not conflict with the preferred backup window. + # + # * Must be at least 30 minutes. + # + # + # + # [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.Maintenance.html#Concepts.DBMaintenance + # + # @option params [String] :db_parameter_group_name + # The name of the DB parameter group to associate with this DB instance. + # If this argument is omitted, the default parameter group for the + # specified engine is used. + # + # @option params [Integer] :backup_retention_period + # The number of days for which automated backups are retained. Setting + # this parameter to a positive number enables backups. For more + # information, see CreateDBInstance. + # + # @option params [String] :preferred_backup_window + # The time range each day during which automated backups are created if + # automated backups are enabled. For more information, see [The Backup + # Window][1]. + # + # Constraints: + # + # * Must be in the format `hh24:mi-hh24:mi`. + # + # * Must be in Universal Coordinated Time (UTC). + # + # * Must not conflict with the preferred maintenance window. + # + # * Must be at least 30 minutes. + # + # + # + # [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithAutomatedBackups.html#USER_WorkingWithAutomatedBackups.BackupWindow + # + # @option params [Integer] :port + # The port number on which the database accepts connections. + # + # Type: Integer + # + # Valid Values: `1150`-`65535` + # + # Default: `3306` + # + # @option params [Boolean] :multi_az + # Specifies whether the DB instance is a Multi-AZ deployment. If MultiAZ + # is set to `true`, you can't set the AvailabilityZone parameter. + # + # @option params [String] :engine_version + # The version number of the database engine to use. Choose the latest + # minor version of your database engine as specified in + # CreateDBInstance. + # + # @option params [Boolean] :auto_minor_version_upgrade + # True to indicate that minor engine upgrades are applied automatically + # to the DB instance during the maintenance window, and otherwise false. + # + # Default: `true` + # + # @option params [String] :license_model + # The license model for this DB instance. Use `general-public-license`. + # + # @option params [Integer] :iops + # The amount of Provisioned IOPS (input/output operations per second) to + # allocate initially for the DB instance. For information about valid + # Iops values, see see [Amazon RDS Provisioned IOPS Storage to Improve + # Performance][1]. + # + # + # + # [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html#USER_PIOPS + # + # @option params [String] :option_group_name + # The name of the option group to associate with this DB instance. If + # this argument is omitted, the default option group for the specified + # engine is used. + # + # @option params [Boolean] :publicly_accessible + # Specifies whether the DB instance is publicly accessible or not. For + # more information, see CreateDBInstance. + # + # @option params [Array<Types::Tag>] :tags + # A list of tags to associate with this DB instance. For more + # information, see [Tagging Amazon RDS Resources][1]. + # + # + # + # [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html + # + # @option params [String] :storage_type + # Specifies the storage type to be associated with the DB instance. + # + # Valid values: `standard` \| `gp2` \| `io1` + # + # If you specify `io1`, you must also include a value for the `Iops` + # parameter. + # + # Default: `io1` if the `Iops` parameter is specified; otherwise + # `standard` + # + # @option params [Boolean] :storage_encrypted + # Specifies whether the new DB instance is encrypted or not. + # + # @option params [String] :kms_key_id + # The AWS KMS key identifier for an encrypted DB instance. + # + # The KMS key identifier is the Amazon Resource Name (ARN) for the KMS + # encryption key. If you are creating a DB instance with the same AWS + # account that owns the KMS encryption key used to encrypt the new DB + # instance, then you can use the KMS key alias instead of the ARN for + # the KM encryption key. + # + # If the `StorageEncrypted` parameter is true, and you do not specify a + # value for the `KmsKeyId` parameter, then Amazon RDS will use your + # default encryption key. AWS KMS creates the default encryption key for + # your AWS account. Your AWS account has a different default encryption + # key for each AWS Region. + # + # @option params [Boolean] :copy_tags_to_snapshot + # True to copy all tags from the DB instance to snapshots of the DB + # instance, and otherwise false. + # + # Default: false. + # + # @option params [Integer] :monitoring_interval + # The interval, in seconds, between points when Enhanced Monitoring + # metrics are collected for the DB instance. To disable collecting + # Enhanced Monitoring metrics, specify 0. + # + # If `MonitoringRoleArn` is specified, then you must also set + # `MonitoringInterval` to a value other than 0. + # + # Valid Values: 0, 1, 5, 10, 15, 30, 60 + # + # Default: `0` + # + # @option params [String] :monitoring_role_arn + # The ARN for the IAM role that permits RDS to send enhanced monitoring + # metrics to Amazon CloudWatch Logs. For example, + # `arn:aws:iam:123456789012:role/emaccess`. For information on creating + # a monitoring role, see [Setting Up and Enabling Enhanced + # Monitoring][1]. + # + # If `MonitoringInterval` is set to a value other than 0, then you must + # supply a `MonitoringRoleArn` value. + # + # + # + # [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Monitoring.OS.html#USER_Monitoring.OS.Enabling + # + # @option params [Boolean] :enable_iam_database_authentication + # True to enable mapping of AWS Identity and Access Management (IAM) + # accounts to database accounts, and otherwise false. + # + # Default: `false` + # + # @option params [required, String] :source_engine + # The name of the engine of your source database. + # + # Valid Values: `mysql` + # + # @option params [required, String] :source_engine_version + # The engine version of your source database. + # + # Valid Values: `5.6` + # + # @option params [required, String] :s3_bucket_name + # The name of your Amazon S3 bucket that contains your database backup + # file. + # + # @option params [String] :s3_prefix + # The prefix of your Amazon S3 bucket. + # + # @option params [required, String] :s3_ingestion_role_arn + # An AWS Identity and Access Management (IAM) role to allow Amazon RDS + # to access your Amazon S3 bucket. + # + # @option params [Boolean] :enable_performance_insights + # True to enable Performance Insights for the DB instance, and otherwise + # false. + # + # @option params [String] :performance_insights_kms_key_id + # The AWS KMS key identifier for encryption of Performance Insights + # data. The KMS key ID is the Amazon Resource Name (ARN), the KMS key + # identifier, or the KMS key alias for the KMS encryption key. + # + # @return [Types::RestoreDBInstanceFromS3Result] Returns a {Seahorse::Client::Response response} object which responds to the following methods: + # + # * {Types::RestoreDBInstanceFromS3Result#db_instance #db_instance} => Types::DBInstance + # + # @example Request syntax with placeholder values + # + # resp = client.restore_db_instance_from_s3({ + # db_name: "String", + # db_instance_identifier: "String", # required + # allocated_storage: 1, + # db_instance_class: "String", # required + # engine: "String", # required + # master_username: "String", + # master_user_password: "String", + # db_security_groups: ["String"], + # vpc_security_group_ids: ["String"], + # availability_zone: "String", + # db_subnet_group_name: "String", + # preferred_maintenance_window: "String", + # db_parameter_group_name: "String", + # backup_retention_period: 1, + # preferred_backup_window: "String", + # port: 1, + # multi_az: false, + # engine_version: "String", + # auto_minor_version_upgrade: false, + # license_model: "String", + # iops: 1, + # option_group_name: "String", + # publicly_accessible: false, + # tags: [ + # { + # key: "String", + # value: "String", + # }, + # ], + # storage_type: "String", + # storage_encrypted: false, + # kms_key_id: "String", + # copy_tags_to_snapshot: false, + # monitoring_interval: 1, + # monitoring_role_arn: "String", + # enable_iam_database_authentication: false, + # source_engine: "String", # required + # source_engine_version: "String", # required + # s3_bucket_name: "String", # required + # s3_prefix: "String", + # s3_ingestion_role_arn: "String", # required + # enable_performance_insights: false, + # performance_insights_kms_key_id: "String", + # }) + # + # @example Response structure + # + # resp.db_instance.db_instance_identifier #=> String + # resp.db_instance.db_instance_class #=> String + # resp.db_instance.engine #=> String + # resp.db_instance.db_instance_status #=> String + # resp.db_instance.master_username #=> String + # resp.db_instance.db_name #=> String + # resp.db_instance.endpoint.address #=> String + # resp.db_instance.endpoint.port #=> Integer + # resp.db_instance.endpoint.hosted_zone_id #=> String + # resp.db_instance.allocated_storage #=> Integer + # resp.db_instance.instance_create_time #=> Time + # resp.db_instance.preferred_backup_window #=> String + # resp.db_instance.backup_retention_period #=> Integer + # resp.db_instance.db_security_groups #=> Array + # resp.db_instance.db_security_groups[0].db_security_group_name #=> String + # resp.db_instance.db_security_groups[0].status #=> String + # resp.db_instance.vpc_security_groups #=> Array + # resp.db_instance.vpc_security_groups[0].vpc_security_group_id #=> String + # resp.db_instance.vpc_security_groups[0].status #=> String + # resp.db_instance.db_parameter_groups #=> Array + # resp.db_instance.db_parameter_groups[0].db_parameter_group_name #=> String + # resp.db_instance.db_parameter_groups[0].parameter_apply_status #=> String + # resp.db_instance.availability_zone #=> String + # resp.db_instance.db_subnet_group.db_subnet_group_name #=> String + # resp.db_instance.db_subnet_group.db_subnet_group_description #=> String + # resp.db_instance.db_subnet_group.vpc_id #=> String + # resp.db_instance.db_subnet_group.subnet_group_status #=> String + # resp.db_instance.db_subnet_group.subnets #=> Array + # resp.db_instance.db_subnet_group.subnets[0].subnet_identifier #=> String + # resp.db_instance.db_subnet_group.subnets[0].subnet_availability_zone.name #=> String + # resp.db_instance.db_subnet_group.subnets[0].subnet_status #=> String + # resp.db_instance.db_subnet_group.db_subnet_group_arn #=> String + # resp.db_instance.preferred_maintenance_window #=> String + # resp.db_instance.pending_modified_values.db_instance_class #=> String + # resp.db_instance.pending_modified_values.allocated_storage #=> Integer + # resp.db_instance.pending_modified_values.master_user_password #=> String + # resp.db_instance.pending_modified_values.port #=> Integer + # resp.db_instance.pending_modified_values.backup_retention_period #=> Integer + # resp.db_instance.pending_modified_values.multi_az #=> Boolean + # resp.db_instance.pending_modified_values.engine_version #=> String + # resp.db_instance.pending_modified_values.license_model #=> String + # resp.db_instance.pending_modified_values.iops #=> Integer + # resp.db_instance.pending_modified_values.db_instance_identifier #=> String + # resp.db_instance.pending_modified_values.storage_type #=> String + # resp.db_instance.pending_modified_values.ca_certificate_identifier #=> String + # resp.db_instance.pending_modified_values.db_subnet_group_name #=> String + # resp.db_instance.latest_restorable_time #=> Time + # resp.db_instance.multi_az #=> Boolean + # resp.db_instance.engine_version #=> String + # resp.db_instance.auto_minor_version_upgrade #=> Boolean + # resp.db_instance.read_replica_source_db_instance_identifier #=> String + # resp.db_instance.read_replica_db_instance_identifiers #=> Array + # resp.db_instance.read_replica_db_instance_identifiers[0] #=> String + # resp.db_instance.read_replica_db_cluster_identifiers #=> Array + # resp.db_instance.read_replica_db_cluster_identifiers[0] #=> String + # resp.db_instance.license_model #=> String + # resp.db_instance.iops #=> Integer + # resp.db_instance.option_group_memberships #=> Array + # resp.db_instance.option_group_memberships[0].option_group_name #=> String + # resp.db_instance.option_group_memberships[0].status #=> String + # resp.db_instance.character_set_name #=> String + # resp.db_instance.secondary_availability_zone #=> String + # resp.db_instance.publicly_accessible #=> Boolean + # resp.db_instance.status_infos #=> Array + # resp.db_instance.status_infos[0].status_type #=> String + # resp.db_instance.status_infos[0].normal #=> Boolean + # resp.db_instance.status_infos[0].status #=> String + # resp.db_instance.status_infos[0].message #=> String + # resp.db_instance.storage_type #=> String + # resp.db_instance.tde_credential_arn #=> String + # resp.db_instance.db_instance_port #=> Integer + # resp.db_instance.db_cluster_identifier #=> String + # resp.db_instance.storage_encrypted #=> Boolean + # resp.db_instance.kms_key_id #=> String + # resp.db_instance.dbi_resource_id #=> String + # resp.db_instance.ca_certificate_identifier #=> String + # resp.db_instance.domain_memberships #=> Array + # resp.db_instance.domain_memberships[0].domain #=> String + # resp.db_instance.domain_memberships[0].status #=> String + # resp.db_instance.domain_memberships[0].fqdn #=> String + # resp.db_instance.domain_memberships[0].iam_role_name #=> String + # resp.db_instance.copy_tags_to_snapshot #=> Boolean + # resp.db_instance.monitoring_interval #=> Integer + # resp.db_instance.enhanced_monitoring_resource_arn #=> String + # resp.db_instance.monitoring_role_arn #=> String + # resp.db_instance.promotion_tier #=> Integer + # resp.db_instance.db_instance_arn #=> String + # resp.db_instance.timezone #=> String + # resp.db_instance.iam_database_authentication_enabled #=> Boolean + # resp.db_instance.performance_insights_enabled #=> Boolean + # resp.db_instance.performance_insights_kms_key_id #=> String + # + # @see http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/RestoreDBInstanceFromS3 AWS API Documentation + # + # @overload restore_db_instance_from_s3(params = {}) + # @param [Hash] params ({}) + def restore_db_instance_from_s3(params = {}, options = {}) + req = build_request(:restore_db_instance_from_s3, params) + req.send_request(options) + end + # Restores a DB instance to an arbitrary point in time. You can restore # to any point in time before the time identified by the # LatestRestorableTime property. You can restore to a point up to the # number of days specified by the BackupRetentionPeriod property. # @@ -11988,11 +12546,11 @@ # * Must match the identifier of an existing DBInstance. # # ^ # # @option params [required, String] :target_db_instance_identifier - # The name of the new database instance to be created. + # The name of the new DB instance to be created. # # Constraints: # # * Must contain from 1 to 63 letters, numbers, or hyphens # @@ -12023,11 +12581,11 @@ # Constraints: Cannot be specified if RestoreTime parameter is provided. # # @option params [String] :db_instance_class # The compute and memory capacity of the Amazon RDS DB instance, for # example, `db.m4.large`. Not all DB instance classes are available in - # all regions, or for all database engines. For the full list of DB + # 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. # # Default: The same DBInstanceClass as the original DB instance. # @@ -12041,15 +12599,15 @@ # Constraints: Value must be `1150-65535` # # Default: The same port as the original DB instance. # # @option params [String] :availability_zone - # The EC2 Availability Zone that the database instance is created in. + # The EC2 Availability Zone that the DB instance is created in. # # Default: A random, system-chosen Availability Zone. # - # Constraint: You cannot specify the AvailabilityZone parameter if the + # Constraint: You can't specify the AvailabilityZone parameter if the # MultiAZ parameter is set to true. # # Example: `us-east-1a` # # @option params [String] :db_subnet_group_name @@ -12061,11 +12619,11 @@ # Example: `mySubnetgroup` # # @option params [Boolean] :multi_az # Specifies if the DB instance is a Multi-AZ deployment. # - # Constraint: You cannot specify the AvailabilityZone parameter if the + # Constraint: You can't specify the AvailabilityZone parameter if the # MultiAZ parameter is set to `true`. # # @option params [Boolean] :publicly_accessible # Specifies the accessibility options for the DB instance. A value of # true specifies an Internet-facing instance with a publicly resolvable @@ -12115,10 +12673,12 @@ # # Valid Values: # # * `aurora` # + # * `aurora-postgresql` + # # * `mariadb` # # * `mysql` # # * `oracle-ee` @@ -12152,38 +12712,43 @@ # # @option params [String] :option_group_name # The name of the option group to be used for the restored DB instance. # # Permanent options, such as the TDE option for Oracle Advanced Security - # TDE, cannot be removed from an option group, and that option group - # cannot be removed from a DB instance once it is associated with a DB + # TDE, can't be removed from an option group, and that option group + # can't be removed from a DB instance once it is associated with a DB # instance # # @option params [Boolean] :copy_tags_to_snapshot # True to copy all tags from the restored DB instance to snapshots of - # the DB instance; otherwise false. The default is false. + # the DB instance, and otherwise false. The default is false. # # @option params [Array<Types::Tag>] :tags - # A list of tags. + # A list of tags. For more information, see [Tagging Amazon RDS + # Resources][1]. # + # + # + # [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html + # # @option params [String] :storage_type # Specifies the storage type to be associated with the DB instance. # # 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 + # Default: `io1` if the `Iops` parameter is specified, otherwise # `standard` # # @option params [String] :tde_credential_arn - # The ARN from the Key Store with which to associate the instance for + # The ARN from the key store with which to associate the instance for # TDE encryption. # # @option params [String] :tde_credential_password - # The password for the given ARN from the Key Store in order to access + # The password for the given ARN from the key store in order to access # the device. # # @option params [String] :domain # Specify the Active Directory Domain to restore the instance in. # @@ -12191,11 +12756,11 @@ # Specify the name of the IAM role to be used when making API calls to # the Directory Service. # # @option params [Boolean] :enable_iam_database_authentication # True to enable mapping of AWS Identity and Access Management (IAM) - # accounts to database accounts; otherwise false. + # accounts to database accounts, and otherwise false. # # You can enable IAM database authentication for the following database # engines # # * For MySQL 5.6, minor version 5.6.34 or higher @@ -12453,11 +13018,11 @@ # The name of the DB security group to revoke ingress from. # # @option params [String] :cidrip # The IP range to revoke access from. Must be a valid CIDR range. If # `CIDRIP` is specified, `EC2SecurityGroupName`, `EC2SecurityGroupId` - # and `EC2SecurityGroupOwnerId` cannot be provided. + # and `EC2SecurityGroupOwnerId` can't be provided. # # @option params [String] :ec2_security_group_name # The name of the EC2 security group to revoke access from. For VPC DB # security groups, `EC2SecurityGroupId` must be provided. Otherwise, # EC2SecurityGroupOwnerId and either `EC2SecurityGroupName` or @@ -12792,10 +13357,10 @@ operation: config.api.operation(operation_name), client: self, params: params, config: config) context[:gem_name] = 'aws-sdk-rds' - context[:gem_version] = '1.7.0' + context[:gem_version] = '1.8.0' Seahorse::Client::Request.new(handlers, context) end # Polls an API operation until a resource enters a desired state. #