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

- old
+ new

@@ -54,12 +54,12 @@ # source_region: "String", # }) # @param [Hash] options ({}) # @option options [Array<String>] :availability_zones # A list of EC2 Availability Zones that instances in the DB cluster can - # 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 # @option options [Integer] :backup_retention_period @@ -113,11 +113,11 @@ # # Example: `mySubnetgroup` # @option options [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 options [String] :engine_version # The version number of the database engine to use. # # **Aurora** # @@ -144,27 +144,28 @@ # Constraints: Must contain from 8 to 41 characters. # @option options [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 options [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. # @@ -175,31 +176,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 options [String] :replication_source_identifier # The Amazon Resource Name (ARN) of the source DB instance or DB cluster # if this DB cluster is created as a Read Replica. # @option options [Array<Types::Tag>] :tags - # A list of tags. + # 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 options [Boolean] :storage_encrypted # Specifies whether the DB cluster is encrypted. # @option options [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 @@ -235,25 +241,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]. @@ -261,13 +267,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 options [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 options [String] :destination_region # @option options [String] :source_region # The source region of the snapshot. This is only needed when the @@ -315,11 +320,16 @@ # database engine and engine version compatible with that DB cluster # parameter group family. # @option options [required, String] :description # The description for the DB cluster parameter group. # @option options [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 [DBClusterParameterGroup] def create_db_cluster_parameter_group(options = {}) resp = @client.create_db_cluster_parameter_group(options) DBClusterParameterGroup.new( name: resp.data.db_cluster_parameter_group.db_cluster_parameter_group_name, @@ -466,11 +476,11 @@ # * Cannot end with a hyphen or contain two consecutive hyphens. # # Example: `mydbinstance` # @option options [Integer] :allocated_storage # The amount of storage (in gigabytes) to be initially allocated for the - # database instance. + # DB instance. # # Type: Integer # # **Amazon Aurora** # @@ -551,12 +561,12 @@ # 1024. # # * Web and Express editions: Must be an integer from 20 to 1024. # @option options [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. # # # @@ -568,10 +578,12 @@ # # Valid Values: # # * `aurora` # + # * `aurora-postgresql` + # # * `mariadb` # # * `mysql` # # * `oracle-ee` @@ -655,12 +667,12 @@ # # * First character must be a letter. # # * Cannot be a reserved word for the chosen database engine. # @option options [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. @@ -697,20 +709,20 @@ # managed by the DB cluster. For more information, see CreateDBCluster. # # Default: The default EC2 VPC security group for the DB subnet group's # VPC. # @option options [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. # # # @@ -718,29 +730,27 @@ # @option options [String] :db_subnet_group_name # A DB subnet group to associate with this DB instance. # # If there is no DB subnet group, then it is a non-VPC DB instance. # @option options [String] :preferred_maintenance_window - # 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 options [String] :db_parameter_group_name # The name of the DB parameter group to associate with this DB instance. # If this argument is omitted, the default DBParameterGroup for the # specified engine is used. # @@ -769,34 +779,34 @@ # # * Cannot be set to 0 if the DB instance is a source to Read Replicas # @option options [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 options [Integer] :port # The port number on which the database accepts connections. # # **MySQL** @@ -842,11 +852,11 @@ # # Valid Values: `1150-65535` # # Type: Integer # @option options [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 options [String] :engine_version # The version number of the database engine to use. # @@ -860,98 +870,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) # @@ -1024,23 +1032,29 @@ # # Valid values: `license-included` \| `bring-your-own-license` \| # `general-public-license` # @option options [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 options [String] :option_group_name # Indicates that the DB instance should be associated with the specified # option group. # # Permanent options, such as the TDE option for Oracle Advanced Security - # 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 options [String] :character_set_name # For supported engines, indicates that the DB instance should be # associated with the specified CharacterSet. # @@ -1067,11 +1081,16 @@ # the PubliclyAccessible value has not been set, the DB instance is # 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 options [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 options [String] :db_cluster_identifier # The identifier of the DB cluster that the instance will belong to. # # For information on creating a DB cluster, see CreateDBCluster. # @@ -1082,17 +1101,17 @@ # 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 options [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 options [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 options [Boolean] :storage_encrypted # Specifies whether the DB instance is encrypted. # # **Amazon Aurora** @@ -1100,11 +1119,11 @@ # Not applicable. The encryption for DB instances is managed by the DB # cluster. For more information, see CreateDBCluster. # # Default: false # @option options [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 @@ -1122,11 +1141,11 @@ # key for each AWS Region. # @option options [String] :domain # Specify the Active Directory Domain to create the instance in. # @option options [Boolean] :copy_tags_to_snapshot # True to copy all tags from the DB instance to snapshots of the DB - # instance; otherwise false. The default is false. + # instance, and otherwise false. The default is false. # @option options [Integer] :monitoring_interval # The interval, in seconds, between points when Enhanced Monitoring # metrics are collected for the DB instance. To disable collecting # Enhanced Monitoring metrics, specify 0. The default is 0. # @@ -1134,11 +1153,11 @@ # `MonitoringInterval` to a value other than 0. # # Valid Values: `0, 1, 5, 10, 15, 30, 60` # @option options [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 @@ -1170,11 +1189,11 @@ # # # [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_SQLServer.html#SQLServer.Concepts.General.TimeZone # @option options [Boolean] :enable_iam_database_authentication # True to enable mapping of AWS Identity and Access Management (IAM) - # accounts to database accounts; otherwise false. + # accounts to database accounts, and otherwise false. # # You can enable IAM database authentication for the following database # engines: # # **Amazon Aurora** @@ -1188,16 +1207,16 @@ # # * For MySQL 5.7, minor version 5.7.16 or higher # # Default: `false` # @option options [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 options [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 [DBInstance] def create_db_instance(options = {}) resp = @client.create_db_instance(options) DBInstance.new( id: resp.data.db_instance.db_instance_identifier, @@ -1240,11 +1259,16 @@ # applied only to a DB instance running a database engine and engine # version compatible with that DB parameter group family. # @option options [required, String] :description # The description for the DB parameter group. # @option options [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 [DBParameterGroup] def create_db_parameter_group(options = {}) resp = @client.create_db_parameter_group(options) DBParameterGroup.new( name: resp.data.db_parameter_group.db_parameter_group_name, @@ -1282,11 +1306,16 @@ # # Example: `mysecuritygroup` # @option options [required, String] :db_security_group_description # The description for the DB security group. # @option options [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 [DBSecurityGroup] def create_db_security_group(options = {}) resp = @client.create_db_security_group(options) DBSecurityGroup.new( name: resp.data.db_security_group.db_security_group_name, @@ -1320,11 +1349,16 @@ # @option options [required, String] :db_subnet_group_description # The description for the DB subnet group. # @option options [required, Array<String>] :subnet_ids # The EC2 Subnet IDs for the DB subnet group. # @option options [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 [DBSubnetGroup] def create_db_subnet_group(options = {}) resp = @client.create_db_subnet_group(options) DBSubnetGroup.new( name: resp.data.db_subnet_group.db_subnet_group_name, @@ -1377,11 +1411,11 @@ # [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Events.html # @option options [Array<String>] :source_ids # The list of identifiers of the event sources for which events are # returned. If not specified, then all sources are included in the # response. An identifier must begin with a letter and must contain only - # ASCII letters, digits, and hyphens; it 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. @@ -1399,11 +1433,16 @@ # be supplied. # @option options [Boolean] :enabled # A Boolean value; set to **true** to activate the subscription, set to # **false** to create the subscription but not active it. # @option options [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 [EventSubscription] def create_event_subscription(options = {}) resp = @client.create_event_subscription(options) EventSubscription.new( name: resp.data.event_subscription.cust_subscription_id, @@ -1446,11 +1485,16 @@ # Specifies the major version of the engine that this option group # should be associated with. # @option options [required, String] :option_group_description # The description of the option group. # @option options [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 [OptionGroup] def create_option_group(options = {}) resp = @client.create_option_group(options) OptionGroup.new( name: resp.data.option_group.option_group_name, @@ -1808,11 +1852,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. @@ -1955,20 +1999,20 @@ # include_public: false, # }) # @param [Hash] options ({}) # @option options [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 options [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: # @@ -2004,21 +2048,20 @@ # `IncludeShared` parameter doesn't apply when `SnapshotType` is set to # `public`. # @option options [Array<Types::Filter>] :filters # This parameter is not currently supported. # @option options [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 options [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 [DBSnapshot::Collection] def db_snapshots(options = {})