aws-sdk-rds 1.120.0 → 1.121.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -208,15 +208,51 @@ module Aws::RDS
208
208
  # applied only to a DB instance running a database engine and engine
209
209
  # version compatible with that DB parameter group family.
210
210
  #
211
- # To list all of the available parameter group families, use the
212
- # following command:
211
+ # To list all of the available parameter group families for a DB engine,
212
+ # use the following command:
213
213
  #
214
214
  # `aws rds describe-db-engine-versions --query
215
- # "DBEngineVersions[].DBParameterGroupFamily"`
215
+ # "DBEngineVersions[].DBParameterGroupFamily" --engine <engine>`
216
+ #
217
+ # For example, to list all of the available parameter group families for
218
+ # the MySQL DB engine, use the following command:
219
+ #
220
+ # `aws rds describe-db-engine-versions --query
221
+ # "DBEngineVersions[].DBParameterGroupFamily" --engine mysql`
216
222
  #
217
223
  # <note markdown="1"> The output contains duplicates.
218
224
  #
219
225
  # </note>
226
+ #
227
+ # The following are the valid DB engine values:
228
+ #
229
+ # * `aurora` (for MySQL 5.6-compatible Aurora)
230
+ #
231
+ # * `aurora-mysql` (for MySQL 5.7-compatible Aurora)
232
+ #
233
+ # * `aurora-postgresql`
234
+ #
235
+ # * `mariadb`
236
+ #
237
+ # * `mysql`
238
+ #
239
+ # * `oracle-ee`
240
+ #
241
+ # * `oracle-ee-cdb`
242
+ #
243
+ # * `oracle-se2`
244
+ #
245
+ # * `oracle-se2-cdb`
246
+ #
247
+ # * `postgres`
248
+ #
249
+ # * `sqlserver-ee`
250
+ #
251
+ # * `sqlserver-se`
252
+ #
253
+ # * `sqlserver-ex`
254
+ #
255
+ # * `sqlserver-web`
220
256
  # @option options [required, String] :description
221
257
  # The description for the DB parameter group.
222
258
  # @option options [Array<Types::Tag>] :tags
@@ -311,18 +347,25 @@ module Aws::RDS
311
347
  # })
312
348
  # @param [Hash] options ({})
313
349
  # @option options [required, Array<Types::Parameter>] :parameters
314
- # An array of parameter names, values, and the apply method for the
315
- # parameter update. At least one parameter name, value, and apply method
316
- # must be supplied; later arguments are optional. A maximum of 20
317
- # parameters can be modified in a single request.
350
+ # An array of parameter names, values, and the application methods for
351
+ # the parameter update. At least one parameter name, value, and
352
+ # application method method must be supplied; later arguments are
353
+ # optional. A maximum of 20 parameters can be modified in a single
354
+ # request.
318
355
  #
319
356
  # Valid Values (for the application method): `immediate |
320
357
  # pending-reboot`
321
358
  #
322
- # <note markdown="1"> You can use the immediate value with dynamic parameters only. You can
323
- # use the pending-reboot value for both dynamic and static parameters,
324
- # and changes are applied when you reboot the DB instance without
325
- # failover.
359
+ # <note markdown="1"> You can use the `immediate` value with dynamic parameters only. You
360
+ # can use the `pending-reboot` value for both dynamic and static
361
+ # parameters.
362
+ #
363
+ # When the application method is `immediate`, changes to dynamic
364
+ # parameters are applied immediately to the DB instances associated with
365
+ # the parameter group. When the application method is `pending-reboot`,
366
+ # changes to dynamic and static parameters are applied after a reboot
367
+ # without failover to the DB instances associated with the parameter
368
+ # group.
326
369
  #
327
370
  # </note>
328
371
  # @return [DBParameterGroup]
@@ -35,7 +35,8 @@ module Aws::RDS
35
35
  end
36
36
  alias :db_security_group_name :name
37
37
 
38
- # Provides the AWS ID of the owner of a specific DB security group.
38
+ # Provides the Amazon Web Services ID of the owner of a specific DB
39
+ # security group.
39
40
  # @return [String]
40
41
  def owner_id
41
42
  data[:owner_id]
@@ -227,11 +228,12 @@ module Aws::RDS
227
228
  # `EC2SecurityGroupOwnerId` and either `EC2SecurityGroupName` or
228
229
  # `EC2SecurityGroupId` must be provided.
229
230
  # @option options [String] :ec2_security_group_owner_id
230
- # AWS account number of the owner of the EC2 security group specified in
231
- # the `EC2SecurityGroupName` parameter. The AWS access key ID isn't an
232
- # acceptable value. For VPC DB security groups, `EC2SecurityGroupId`
233
- # must be provided. Otherwise, `EC2SecurityGroupOwnerId` and either
234
- # `EC2SecurityGroupName` or `EC2SecurityGroupId` must be provided.
231
+ # Amazon Web Services account number of the owner of the EC2 security
232
+ # group specified in the `EC2SecurityGroupName` parameter. The Amazon
233
+ # Web Services access key ID isn't an acceptable value. For VPC DB
234
+ # security groups, `EC2SecurityGroupId` must be provided. Otherwise,
235
+ # `EC2SecurityGroupOwnerId` and either `EC2SecurityGroupName` or
236
+ # `EC2SecurityGroupId` must be provided.
235
237
  # @return [DBSecurityGroup]
236
238
  def authorize_ingress(options = {})
237
239
  options = options.merge(db_security_group_name: @name)
@@ -305,10 +307,10 @@ module Aws::RDS
305
307
  # EC2SecurityGroupOwnerId and either `EC2SecurityGroupName` or
306
308
  # `EC2SecurityGroupId` must be provided.
307
309
  # @option options [String] :ec2_security_group_owner_id
308
- # The AWS account number of the owner of the EC2 security group
309
- # specified in the `EC2SecurityGroupName` parameter. The AWS access key
310
- # ID isn't an acceptable value. For VPC DB security groups,
311
- # `EC2SecurityGroupId` must be provided. Otherwise,
310
+ # The Amazon Web Services account number of the owner of the EC2
311
+ # security group specified in the `EC2SecurityGroupName` parameter. The
312
+ # Amazon Web Services access key ID isn't an acceptable value. For VPC
313
+ # DB security groups, `EC2SecurityGroupId` must be provided. Otherwise,
312
314
  # EC2SecurityGroupOwnerId and either `EC2SecurityGroupName` or
313
315
  # `EC2SecurityGroupId` must be provided.
314
316
  # @return [DBSecurityGroup]
@@ -139,7 +139,8 @@ module Aws::RDS
139
139
  data[:percent_progress]
140
140
  end
141
141
 
142
- # The AWS Region that the DB snapshot was created in or copied from.
142
+ # The Amazon Web Services Region that the DB snapshot was created in or
143
+ # copied from.
143
144
  # @return [String]
144
145
  def source_region
145
146
  data[:source_region]
@@ -172,11 +173,12 @@ module Aws::RDS
172
173
  data[:encrypted]
173
174
  end
174
175
 
175
- # If `Encrypted` is true, the AWS KMS key identifier for the encrypted
176
- # DB snapshot.
176
+ # If `Encrypted` is true, the Amazon Web Services KMS key identifier for
177
+ # the encrypted DB snapshot.
177
178
  #
178
- # The AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias
179
- # name for the AWS KMS customer master key (CMK).
179
+ # The Amazon Web Services KMS key identifier is the key ARN, key ID,
180
+ # alias ARN, or alias name for the Amazon Web Services KMS customer
181
+ # master key (CMK).
180
182
  # @return [String]
181
183
  def kms_key_id
182
184
  data[:kms_key_id]
@@ -197,8 +199,8 @@ module Aws::RDS
197
199
  data[:timezone]
198
200
  end
199
201
 
200
- # True if mapping of AWS Identity and Access Management (IAM) accounts
201
- # to database accounts is enabled, and otherwise false.
202
+ # True if mapping of Amazon Web Services Identity and Access Management
203
+ # (IAM) accounts to database accounts is enabled, and otherwise false.
202
204
  # @return [Boolean]
203
205
  def iam_database_authentication_enabled
204
206
  data[:iam_database_authentication_enabled]
@@ -212,7 +214,7 @@ module Aws::RDS
212
214
  end
213
215
 
214
216
  # The identifier for the source DB instance, which can't be changed and
215
- # which is unique to an AWS Region.
217
+ # which is unique to an Amazon Web Services Region.
216
218
  # @return [String]
217
219
  def dbi_resource_id
218
220
  data[:dbi_resource_id]
@@ -429,26 +431,31 @@ module Aws::RDS
429
431
  #
430
432
  # Example: `my-db-snapshot`
431
433
  # @option options [String] :kms_key_id
432
- # The AWS KMS key identifier for an encrypted DB snapshot. The AWS KMS
433
- # key identifier is the key ARN, key ID, alias ARN, or alias name for
434
- # the AWS KMS customer master key (CMK).
435
- #
436
- # If you copy an encrypted DB snapshot from your AWS account, you can
437
- # specify a value for this parameter to encrypt the copy with a new AWS
438
- # KMS CMK. If you don't specify a value for this parameter, then the
439
- # copy of the DB snapshot is encrypted with the same AWS KMS key as the
440
- # source DB snapshot.
434
+ # The Amazon Web Services KMS key identifier for an encrypted DB
435
+ # snapshot. The Amazon Web Services KMS key identifier is the key ARN,
436
+ # key ID, alias ARN, or alias name for the Amazon Web Services KMS
437
+ # customer master key (CMK).
438
+ #
439
+ # If you copy an encrypted DB snapshot from your Amazon Web Services
440
+ # account, you can specify a value for this parameter to encrypt the
441
+ # copy with a new Amazon Web Services KMS CMK. If you don't specify a
442
+ # value for this parameter, then the copy of the DB snapshot is
443
+ # encrypted with the same Amazon Web Services KMS key as the source DB
444
+ # snapshot.
441
445
  #
442
- # If you copy an encrypted DB snapshot that is shared from another AWS
443
- # account, then you must specify a value for this parameter.
446
+ # If you copy an encrypted DB snapshot that is shared from another
447
+ # Amazon Web Services account, then you must specify a value for this
448
+ # parameter.
444
449
  #
445
450
  # If you specify this parameter when you copy an unencrypted snapshot,
446
451
  # the copy is encrypted.
447
452
  #
448
- # If you copy an encrypted snapshot to a different AWS Region, then you
449
- # must specify a AWS KMS key identifier for the destination AWS Region.
450
- # AWS KMS CMKs are specific to the AWS Region that they are created in,
451
- # and you can't use CMKs from one AWS Region in another AWS Region.
453
+ # If you copy an encrypted snapshot to a different Amazon Web Services
454
+ # Region, then you must specify a Amazon Web Services KMS key identifier
455
+ # for the destination Amazon Web Services Region. Amazon Web Services
456
+ # KMS CMKs are specific to the Amazon Web Services Region that they are
457
+ # created in, and you can't use CMKs from one Amazon Web Services
458
+ # Region in another Amazon Web Services Region.
452
459
  # @option options [Array<Types::Tag>] :tags
453
460
  # A list of tags. For more information, see [Tagging Amazon RDS
454
461
  # Resources][1] in the *Amazon RDS User Guide.*
@@ -461,53 +468,58 @@ module Aws::RDS
461
468
  # snapshot to the target DB snapshot. By default, tags are not copied.
462
469
  # @option options [String] :pre_signed_url
463
470
  # The URL that contains a Signature Version 4 signed request for the
464
- # `CopyDBSnapshot` API action in the source AWS Region that contains the
465
- # source DB snapshot to copy.
471
+ # `CopyDBSnapshot` API action in the source Amazon Web Services Region
472
+ # that contains the source DB snapshot to copy.
466
473
  #
467
474
  # You must specify this parameter when you copy an encrypted DB snapshot
468
- # from another AWS Region by using the Amazon RDS API. Don't specify
469
- # `PreSignedUrl` when you are copying an encrypted DB snapshot in the
470
- # same AWS Region.
475
+ # from another Amazon Web Services Region by using the Amazon RDS API.
476
+ # Don't specify `PreSignedUrl` when you are copying an encrypted DB
477
+ # snapshot in the same Amazon Web Services Region.
471
478
  #
472
479
  # The presigned URL must be a valid request for the `CopyDBSnapshot` API
473
- # action that can be executed in the source AWS Region that contains the
474
- # encrypted DB snapshot to be copied. The presigned URL request must
475
- # contain the following parameter values:
480
+ # action that can be executed in the source Amazon Web Services Region
481
+ # that contains the encrypted DB snapshot to be copied. The presigned
482
+ # URL request must contain the following parameter values:
476
483
  #
477
- # * `DestinationRegion` - The AWS Region that the encrypted DB snapshot
478
- # is copied to. This AWS Region is the same one where the
479
- # `CopyDBSnapshot` action is called that contains this presigned URL.
484
+ # * `DestinationRegion` - The Amazon Web Services Region that the
485
+ # encrypted DB snapshot is copied to. This Amazon Web Services Region
486
+ # is the same one where the `CopyDBSnapshot` action is called that
487
+ # contains this presigned URL.
480
488
  #
481
489
  # For example, if you copy an encrypted DB snapshot from the us-west-2
482
- # AWS Region to the us-east-1 AWS Region, then you call the
483
- # `CopyDBSnapshot` action in the us-east-1 AWS Region and provide a
484
- # presigned URL that contains a call to the `CopyDBSnapshot` action in
485
- # the us-west-2 AWS Region. For this example, the `DestinationRegion`
486
- # in the presigned URL must be set to the us-east-1 AWS Region.
487
- #
488
- # * `KmsKeyId` - The AWS KMS key identifier for the customer master key
489
- # (CMK) to use to encrypt the copy of the DB snapshot in the
490
- # destination AWS Region. This is the same identifier for both the
491
- # `CopyDBSnapshot` action that is called in the destination AWS
492
- # Region, and the action contained in the presigned URL.
490
+ # Amazon Web Services Region to the us-east-1 Amazon Web Services
491
+ # Region, then you call the `CopyDBSnapshot` action in the us-east-1
492
+ # Amazon Web Services Region and provide a presigned URL that contains
493
+ # a call to the `CopyDBSnapshot` action in the us-west-2 Amazon Web
494
+ # Services Region. For this example, the `DestinationRegion` in the
495
+ # presigned URL must be set to the us-east-1 Amazon Web Services
496
+ # Region.
497
+ #
498
+ # * `KmsKeyId` - The Amazon Web Services KMS key identifier for the
499
+ # customer master key (CMK) to use to encrypt the copy of the DB
500
+ # snapshot in the destination Amazon Web Services Region. This is the
501
+ # same identifier for both the `CopyDBSnapshot` action that is called
502
+ # in the destination Amazon Web Services Region, and the action
503
+ # contained in the presigned URL.
493
504
  #
494
505
  # * `SourceDBSnapshotIdentifier` - The DB snapshot identifier for the
495
506
  # encrypted snapshot to be copied. This identifier must be in the
496
- # Amazon Resource Name (ARN) format for the source AWS Region. For
497
- # example, if you are copying an encrypted DB snapshot from the
498
- # us-west-2 AWS Region, then your `SourceDBSnapshotIdentifier` looks
499
- # like the following example:
507
+ # Amazon Resource Name (ARN) format for the source Amazon Web Services
508
+ # Region. For example, if you are copying an encrypted DB snapshot
509
+ # from the us-west-2 Amazon Web Services Region, then your
510
+ # `SourceDBSnapshotIdentifier` looks like the following example:
500
511
  # `arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20161115`.
501
512
  #
502
513
  # To learn how to generate a Signature Version 4 signed request, see
503
- # [Authenticating Requests: Using Query Parameters (AWS Signature
504
- # Version 4)][1] and [Signature Version 4 Signing Process][2].
514
+ # [Authenticating Requests: Using Query Parameters (Amazon Web Services
515
+ # Signature Version 4)][1] and [Signature Version 4 Signing Process][2].
505
516
  #
506
- # <note markdown="1"> If you are using an AWS SDK tool or the AWS CLI, you can specify
507
- # `SourceRegion` (or `--source-region` for the AWS CLI) instead of
517
+ # <note markdown="1"> If you are using an Amazon Web Services SDK tool or the CLI, you can
518
+ # specify `SourceRegion` (or `--source-region` for the CLI) instead of
508
519
  # specifying `PreSignedUrl` manually. Specifying `SourceRegion`
509
520
  # autogenerates a pre-signed URL that is a valid request for the
510
- # operation that can be executed in the source AWS Region.
521
+ # operation that can be executed in the source Amazon Web Services
522
+ # Region.
511
523
  #
512
524
  # </note>
513
525
  #
@@ -519,12 +531,13 @@ module Aws::RDS
519
531
  # The name of an option group to associate with the copy of the
520
532
  # snapshot.
521
533
  #
522
- # Specify this option if you are copying a snapshot from one AWS Region
523
- # to another, and your DB instance uses a nondefault option group. If
524
- # your source DB instance uses Transparent Data Encryption for Oracle or
525
- # Microsoft SQL Server, you must specify this option when copying across
526
- # AWS Regions. For more information, see [Option group
527
- # considerations][1] in the *Amazon RDS User Guide.*
534
+ # Specify this option if you are copying a snapshot from one Amazon Web
535
+ # Services Region to another, and your DB instance uses a nondefault
536
+ # option group. If your source DB instance uses Transparent Data
537
+ # Encryption for Oracle or Microsoft SQL Server, you must specify this
538
+ # option when copying across Amazon Web Services Regions. For more
539
+ # information, see [Option group considerations][1] in the *Amazon RDS
540
+ # User Guide.*
528
541
  #
529
542
  #
530
543
  #
@@ -624,9 +637,9 @@ module Aws::RDS
624
637
  # @option options [String] :db_instance_class
625
638
  # The compute and memory capacity of the Amazon RDS DB instance, for
626
639
  # example, `db.m4.large`. Not all DB instance classes are available in
627
- # all AWS Regions, or for all database engines. For the full list of DB
628
- # instance classes, and availability for your engine, see [DB Instance
629
- # Class][1] in the *Amazon RDS User Guide.*
640
+ # all Amazon Web Services Regions, or for all database engines. For the
641
+ # full list of DB instance classes, and availability for your engine,
642
+ # see [DB Instance Class][1] in the *Amazon RDS User Guide.*
630
643
  #
631
644
  # Default: The same DBInstanceClass as the original DB instance.
632
645
  #
@@ -709,11 +722,11 @@ module Aws::RDS
709
722
  #
710
723
  # * `oracle-ee`
711
724
  #
712
- # * `oracle-se2`
725
+ # * `oracle-ee-cdb`
713
726
  #
714
- # * `oracle-se1`
727
+ # * `oracle-se2`
715
728
  #
716
- # * `oracle-se`
729
+ # * `oracle-se2-cdb`
717
730
  #
718
731
  # * `postgres`
719
732
  #
@@ -796,9 +809,9 @@ module Aws::RDS
796
809
  # Specify the name of the IAM role to be used when making API calls to
797
810
  # the Directory Service.
798
811
  # @option options [Boolean] :enable_iam_database_authentication
799
- # A value that indicates whether to enable mapping of AWS Identity and
800
- # Access Management (IAM) accounts to database accounts. By default,
801
- # mapping is disabled.
812
+ # A value that indicates whether to enable mapping of Amazon Web
813
+ # Services Identity and Access Management (IAM) accounts to database
814
+ # accounts. By default, mapping is disabled.
802
815
  #
803
816
  # For more information about IAM database authentication, see [ IAM
804
817
  # Database Authentication for MySQL and PostgreSQL][1] in the *Amazon
@@ -856,10 +869,11 @@ module Aws::RDS
856
869
  # from outside of its virtual private cloud (VPC) on your local network.
857
870
  #
858
871
  # For more information about RDS on Outposts, see [Working with Amazon
859
- # RDS on AWS Outposts][1] in the *Amazon RDS User Guide*.
872
+ # RDS on Amazon Web Services Outposts][1] in the *Amazon RDS User
873
+ # Guide*.
860
874
  #
861
875
  # For more information about CoIPs, see [Customer-owned IP addresses][2]
862
- # in the *AWS Outposts User Guide*.
876
+ # in the *Amazon Web Services Outposts User Guide*.
863
877
  #
864
878
  #
865
879
  #
@@ -46,10 +46,10 @@ module Aws::RDS
46
46
  # The value or values for the manual DB snapshot attribute.
47
47
  #
48
48
  # If the `AttributeName` field is set to `restore`, then this element
49
- # returns a list of IDs of the AWS accounts that are authorized to copy
50
- # or restore the manual DB snapshot. If a value of `all` is in the list,
51
- # then the manual DB snapshot is public and available for any AWS
52
- # account to copy or restore.
49
+ # returns a list of IDs of the Amazon Web Services accounts that are
50
+ # authorized to copy or restore the manual DB snapshot. If a value of
51
+ # `all` is in the list, then the manual DB snapshot is public and
52
+ # available for any Amazon Web Services account to copy or restore.
53
53
  # @return [Array<String>]
54
54
  def attribute_values
55
55
  data[:attribute_values]
@@ -195,19 +195,21 @@ module Aws::RDS
195
195
  # A list of DB snapshot attributes to add to the attribute specified by
196
196
  # `AttributeName`.
197
197
  #
198
- # To authorize other AWS accounts to copy or restore a manual snapshot,
199
- # set this list to include one or more AWS account IDs, or `all` to make
200
- # the manual DB snapshot restorable by any AWS account. Do not add the
201
- # `all` value for any manual DB snapshots that contain private
202
- # information that you don't want available to all AWS accounts.
198
+ # To authorize other Amazon Web Services accounts to copy or restore a
199
+ # manual snapshot, set this list to include one or more Amazon Web
200
+ # Services account IDs, or `all` to make the manual DB snapshot
201
+ # restorable by any Amazon Web Services account. Do not add the `all`
202
+ # value for any manual DB snapshots that contain private information
203
+ # that you don't want available to all Amazon Web Services accounts.
203
204
  # @option options [Array<String>] :values_to_remove
204
205
  # A list of DB snapshot attributes to remove from the attribute
205
206
  # specified by `AttributeName`.
206
207
  #
207
- # To remove authorization for other AWS accounts to copy or restore a
208
- # manual snapshot, set this list to include one or more AWS account
209
- # identifiers, or `all` to remove authorization for any AWS account to
210
- # copy or restore the DB snapshot. If you specify `all`, an AWS account
208
+ # To remove authorization for other Amazon Web Services accounts to copy
209
+ # or restore a manual snapshot, set this list to include one or more
210
+ # Amazon Web Services account identifiers, or `all` to remove
211
+ # authorization for any Amazon Web Services account to copy or restore
212
+ # the DB snapshot. If you specify `all`, an Amazon Web Services account
211
213
  # whose account ID is explicitly added to the `restore` attribute can
212
214
  # still copy or restore the manual DB snapshot.
213
215
  # @return [Types::ModifyDBSnapshotAttributeResult]
@@ -35,8 +35,8 @@ module Aws::RDS
35
35
  end
36
36
  alias :cust_subscription_id :name
37
37
 
38
- # The AWS customer account associated with the RDS event notification
39
- # subscription.
38
+ # The Amazon Web Services customer account associated with the RDS event
39
+ # notification subscription.
40
40
  # @return [String]
41
41
  def customer_aws_id
42
42
  data[:customer_aws_id]
@@ -245,11 +245,11 @@ module Aws::RDS
245
245
  #
246
246
  # * `oracle-ee`
247
247
  #
248
- # * `oracle-se2`
248
+ # * `oracle-ee-cdb`
249
249
  #
250
- # * `oracle-se1`
250
+ # * `oracle-se2`
251
251
  #
252
- # * `oracle-se`
252
+ # * `oracle-se2-cdb`
253
253
  #
254
254
  # * `postgres`
255
255
  #