aws-sdk-rds 1.240.0 → 1.242.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -455,12 +455,16 @@ module Aws::RDS
455
455
  data[:domain_memberships]
456
456
  end
457
457
 
458
- # A list of tags. For more information, see [Tagging Amazon RDS
459
- # Resources][1] in the *Amazon RDS User Guide.*
458
+ # A list of tags.
459
+ #
460
+ # For more information, see [Tagging Amazon RDS resources][1] in the
461
+ # *Amazon RDS User Guide* or [Tagging Amazon Aurora and Amazon RDS
462
+ # resources][2] in the *Amazon Aurora User Guide*.
460
463
  #
461
464
  #
462
465
  #
463
466
  # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html
467
+ # [2]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Tagging.html
464
468
  # @return [Array<Types::Tag>]
465
469
  def tag_list
466
470
  data[:tag_list]
@@ -1822,23 +1826,23 @@ module Aws::RDS
1822
1826
  # @param [Hash] options ({})
1823
1827
  # @option options [Boolean] :skip_final_snapshot
1824
1828
  # Specifies whether to skip the creation of a final DB cluster snapshot
1825
- # before the DB cluster is deleted. If skip is specified, no DB cluster
1826
- # snapshot is created. If skip isn't specified, a DB cluster snapshot
1827
- # is created before the DB cluster is deleted. By default, skip isn't
1828
- # specified, and the DB cluster snapshot is created. By default, this
1829
- # parameter is disabled.
1829
+ # before RDS deletes the DB cluster. If you set this value to `true`,
1830
+ # RDS doesn't create a final DB cluster snapshot. If you set this value
1831
+ # to `false` or don't specify it, RDS creates a DB cluster snapshot
1832
+ # before it deletes the DB cluster. By default, this parameter is
1833
+ # disabled, so RDS creates a final DB cluster snapshot.
1830
1834
  #
1831
- # <note markdown="1"> You must specify a `FinalDBSnapshotIdentifier` parameter if
1832
- # `SkipFinalSnapshot` is disabled.
1835
+ # <note markdown="1"> If `SkipFinalSnapshot` is disabled, you must specify a value for the
1836
+ # `FinalDBSnapshotIdentifier` parameter.
1833
1837
  #
1834
1838
  # </note>
1835
1839
  # @option options [String] :final_db_snapshot_identifier
1836
1840
  # The DB cluster snapshot identifier of the new DB cluster snapshot
1837
1841
  # created when `SkipFinalSnapshot` is disabled.
1838
1842
  #
1839
- # <note markdown="1"> Specifying this parameter and also skipping the creation of a final DB
1840
- # cluster snapshot with the `SkipFinalShapshot` parameter results in an
1841
- # error.
1843
+ # <note markdown="1"> If you specify this parameter and also skip the creation of a final DB
1844
+ # cluster snapshot with the `SkipFinalShapshot` parameter, the request
1845
+ # results in an error.
1842
1846
  #
1843
1847
  # </note>
1844
1848
  #
@@ -1854,16 +1858,6 @@ module Aws::RDS
1854
1858
  # cluster is deleted. This parameter isn't case-sensitive. The default
1855
1859
  # is to remove automated backups immediately after the DB cluster is
1856
1860
  # deleted.
1857
- #
1858
- # <note markdown="1"> You must delete automated backups for Amazon RDS Multi-AZ DB clusters.
1859
- # For more information about managing automated backups for RDS Multi-AZ
1860
- # DB clusters, see [Managing automated backups][1].
1861
- #
1862
- # </note>
1863
- #
1864
- #
1865
- #
1866
- # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_ManagingAutomatedBackups.html
1867
1861
  # @return [DBCluster]
1868
1862
  def delete(options = {})
1869
1863
  options = options.merge(db_cluster_identifier: @id)
@@ -2755,12 +2749,16 @@ module Aws::RDS
2755
2749
  #
2756
2750
  # Valid for: Aurora DB clusters and Multi-AZ DB clusters
2757
2751
  # @option options [Array<Types::Tag>] :tags
2758
- # A list of tags. For more information, see [Tagging Amazon RDS
2759
- # Resources][1] in the *Amazon RDS User Guide.*
2752
+ # A list of tags.
2753
+ #
2754
+ # For more information, see [Tagging Amazon RDS resources][1] in the
2755
+ # *Amazon RDS User Guide* or [Tagging Amazon Aurora and Amazon RDS
2756
+ # resources][2] in the *Amazon Aurora User Guide*.
2760
2757
  #
2761
2758
  #
2762
2759
  #
2763
2760
  # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html
2761
+ # [2]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Tagging.html
2764
2762
  # @option options [String] :kms_key_id
2765
2763
  # The Amazon Web Services KMS key identifier to use when restoring an
2766
2764
  # encrypted DB cluster from an encrypted DB cluster.
@@ -177,12 +177,16 @@ module Aws::RDS
177
177
  data[:iam_database_authentication_enabled]
178
178
  end
179
179
 
180
- # A list of tags. For more information, see [Tagging Amazon RDS
181
- # Resources][1] in the *Amazon RDS User Guide.*
180
+ # A list of tags.
181
+ #
182
+ # For more information, see [Tagging Amazon RDS resources][1] in the
183
+ # *Amazon RDS User Guide* or [Tagging Amazon Aurora and Amazon RDS
184
+ # resources][2] in the *Amazon Aurora User Guide*.
182
185
  #
183
186
  #
184
187
  #
185
188
  # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html
189
+ # [2]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Tagging.html
186
190
  # @return [Array<Types::Tag>]
187
191
  def tag_list
188
192
  data[:tag_list]
@@ -500,12 +504,16 @@ module Aws::RDS
500
504
  # Specifies whether to copy all tags from the source DB cluster snapshot
501
505
  # to the target DB cluster snapshot. By default, tags are not copied.
502
506
  # @option options [Array<Types::Tag>] :tags
503
- # A list of tags. For more information, see [Tagging Amazon RDS
504
- # Resources][1] in the *Amazon RDS User Guide.*
507
+ # A list of tags.
508
+ #
509
+ # For more information, see [Tagging Amazon RDS resources][1] in the
510
+ # *Amazon RDS User Guide* or [Tagging Amazon Aurora and Amazon RDS
511
+ # resources][2] in the *Amazon Aurora User Guide*.
505
512
  #
506
513
  #
507
514
  #
508
515
  # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html
516
+ # [2]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Tagging.html
509
517
  # @option options [String] :source_region
510
518
  # The source region of the snapshot. This is only needed when the
511
519
  # shapshot is encrypted and in a different region.
@@ -220,12 +220,16 @@ module Aws::RDS
220
220
  data[:create_time]
221
221
  end
222
222
 
223
- # A list of tags. For more information, see [Tagging Amazon RDS
224
- # Resources][1] in the *Amazon RDS User Guide.*
223
+ # A list of tags.
224
+ #
225
+ # For more information, see [Tagging Amazon RDS resources][1] in the
226
+ # *Amazon RDS User Guide* or [Tagging Amazon Aurora and Amazon RDS
227
+ # resources][2] in the *Amazon Aurora User Guide*.
225
228
  #
226
229
  #
227
230
  #
228
231
  # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html
232
+ # [2]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Tagging.html
229
233
  # @return [Array<Types::Tag>]
230
234
  def tag_list
231
235
  data[:tag_list]
@@ -549,12 +549,16 @@ module Aws::RDS
549
549
  data[:max_allocated_storage]
550
550
  end
551
551
 
552
- # A list of tags. For more information, see [Tagging Amazon RDS
553
- # Resources][1] in the *Amazon RDS User Guide.*
552
+ # A list of tags.
553
+ #
554
+ # For more information, see [Tagging Amazon RDS resources][1] in the
555
+ # *Amazon RDS User Guide* or [Tagging Amazon Aurora and Amazon RDS
556
+ # resources][2] in the *Amazon Aurora User Guide*.
554
557
  #
555
558
  #
556
559
  #
557
560
  # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html
561
+ # [2]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Tagging.html
558
562
  # @return [Array<Types::Tag>]
559
563
  def tag_list
560
564
  data[:tag_list]
@@ -2395,12 +2399,16 @@ module Aws::RDS
2395
2399
  #
2396
2400
  # For more information, see CreateDBInstance.
2397
2401
  # @option options [Array<Types::Tag>] :tags
2398
- # A list of tags. For more information, see [Tagging Amazon RDS
2399
- # Resources][1] in the *Amazon RDS User Guide.*
2402
+ # A list of tags.
2403
+ #
2404
+ # For more information, see [Tagging Amazon RDS resources][1] in the
2405
+ # *Amazon RDS User Guide* or [Tagging Amazon Aurora and Amazon RDS
2406
+ # resources][2] in the *Amazon Aurora User Guide*.
2400
2407
  #
2401
2408
  #
2402
2409
  #
2403
2410
  # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html
2411
+ # [2]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Tagging.html
2404
2412
  # @option options [String] :db_subnet_group_name
2405
2413
  # A DB subnet group for the DB instance. The new DB instance is created
2406
2414
  # in the VPC associated with the DB subnet group. If no DB subnet group
@@ -2912,12 +2920,16 @@ module Aws::RDS
2912
2920
  #
2913
2921
  # Example: `my-snapshot-id`
2914
2922
  # @option options [Array<Types::Tag>] :tags
2915
- # A list of tags. For more information, see [Tagging Amazon RDS
2916
- # Resources][1] in the *Amazon RDS User Guide.*
2923
+ # A list of tags.
2924
+ #
2925
+ # For more information, see [Tagging Amazon RDS resources][1] in the
2926
+ # *Amazon RDS User Guide* or [Tagging Amazon Aurora and Amazon RDS
2927
+ # resources][2] in the *Amazon Aurora User Guide*.
2917
2928
  #
2918
2929
  #
2919
2930
  #
2920
2931
  # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html
2932
+ # [2]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Tagging.html
2921
2933
  # @return [DBSnapshot]
2922
2934
  def create_snapshot(options = {})
2923
2935
  options = options.merge(db_instance_identifier: @id)
@@ -4452,12 +4464,16 @@ module Aws::RDS
4452
4464
  # Specifies whether to copy all tags from the restored DB instance to
4453
4465
  # snapshots of the DB instance. By default, tags are not copied.
4454
4466
  # @option options [Array<Types::Tag>] :tags
4455
- # A list of tags. For more information, see [Tagging Amazon RDS
4456
- # Resources][1] in the *Amazon RDS User Guide.*
4467
+ # A list of tags.
4468
+ #
4469
+ # For more information, see [Tagging Amazon RDS resources][1] in the
4470
+ # *Amazon RDS User Guide* or [Tagging Amazon Aurora and Amazon RDS
4471
+ # resources][2] in the *Amazon Aurora User Guide*.
4457
4472
  #
4458
4473
  #
4459
4474
  #
4460
4475
  # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html
4476
+ # [2]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Tagging.html
4461
4477
  # @option options [String] :storage_type
4462
4478
  # The storage type to associate with the DB instance.
4463
4479
  #
@@ -304,12 +304,16 @@ module Aws::RDS
304
304
  # @option options [required, String] :target_db_parameter_group_description
305
305
  # A description for the copied DB parameter group.
306
306
  # @option options [Array<Types::Tag>] :tags
307
- # A list of tags. For more information, see [Tagging Amazon RDS
308
- # Resources][1] in the *Amazon RDS User Guide.*
307
+ # A list of tags.
308
+ #
309
+ # For more information, see [Tagging Amazon RDS resources][1] in the
310
+ # *Amazon RDS User Guide* or [Tagging Amazon Aurora and Amazon RDS
311
+ # resources][2] in the *Amazon Aurora User Guide*.
309
312
  #
310
313
  #
311
314
  #
312
315
  # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html
316
+ # [2]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Tagging.html
313
317
  # @return [DBParameterGroup]
314
318
  def copy(options = {})
315
319
  options = options.merge(source_db_parameter_group_identifier: @name)
@@ -219,12 +219,16 @@ module Aws::RDS
219
219
  data[:dbi_resource_id]
220
220
  end
221
221
 
222
- # A list of tags. For more information, see [Tagging Amazon RDS
223
- # Resources][1] in the *Amazon RDS User Guide.*
222
+ # A list of tags.
223
+ #
224
+ # For more information, see [Tagging Amazon RDS resources][1] in the
225
+ # *Amazon RDS User Guide* or [Tagging Amazon Aurora and Amazon RDS
226
+ # resources][2] in the *Amazon Aurora User Guide*.
224
227
  #
225
228
  #
226
229
  #
227
230
  # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html
231
+ # [2]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Tagging.html
228
232
  # @return [Array<Types::Tag>]
229
233
  def tag_list
230
234
  data[:tag_list]
@@ -438,12 +442,16 @@ module Aws::RDS
438
442
  # })
439
443
  # @param [Hash] options ({})
440
444
  # @option options [Array<Types::Tag>] :tags
441
- # A list of tags. For more information, see [Tagging Amazon RDS
442
- # Resources][1] in the *Amazon RDS User Guide.*
445
+ # A list of tags.
446
+ #
447
+ # For more information, see [Tagging Amazon RDS resources][1] in the
448
+ # *Amazon RDS User Guide* or [Tagging Amazon Aurora and Amazon RDS
449
+ # resources][2] in the *Amazon Aurora User Guide*.
443
450
  #
444
451
  #
445
452
  #
446
453
  # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html
454
+ # [2]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Tagging.html
447
455
  # @return [DBSnapshot]
448
456
  def create(options = {})
449
457
  options = options.merge(
@@ -519,12 +527,16 @@ module Aws::RDS
519
527
  # in, and you can't use KMS keys from one Amazon Web Services Region in
520
528
  # another Amazon Web Services Region.
521
529
  # @option options [Array<Types::Tag>] :tags
522
- # A list of tags. For more information, see [Tagging Amazon RDS
523
- # Resources][1] in the *Amazon RDS User Guide.*
530
+ # A list of tags.
531
+ #
532
+ # For more information, see [Tagging Amazon RDS resources][1] in the
533
+ # *Amazon RDS User Guide* or [Tagging Amazon Aurora and Amazon RDS
534
+ # resources][2] in the *Amazon Aurora User Guide*.
524
535
  #
525
536
  #
526
537
  #
527
538
  # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html
539
+ # [2]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Tagging.html
528
540
  # @option options [Boolean] :copy_tags
529
541
  # Specifies whether to copy all tags from the source DB snapshot to the
530
542
  # target DB snapshot. By default, tags aren't copied.
@@ -892,12 +904,16 @@ module Aws::RDS
892
904
  #
893
905
  # This setting doesn't apply to RDS Custom.
894
906
  # @option options [Array<Types::Tag>] :tags
895
- # A list of tags. For more information, see [Tagging Amazon RDS
896
- # Resources][1] in the *Amazon RDS User Guide.*
907
+ # A list of tags.
908
+ #
909
+ # For more information, see [Tagging Amazon RDS resources][1] in the
910
+ # *Amazon RDS User Guide* or [Tagging Amazon Aurora and Amazon RDS
911
+ # resources][2] in the *Amazon Aurora User Guide*.
897
912
  #
898
913
  #
899
914
  #
900
915
  # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html
916
+ # [2]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Tagging.html
901
917
  # @option options [String] :storage_type
902
918
  # Specifies the storage type to be associated with the DB instance.
903
919
  #
@@ -371,12 +371,16 @@ module Aws::RDS
371
371
  # notification subscription isn't activated, the subscription is
372
372
  # created but not active.
373
373
  # @option options [Array<Types::Tag>] :tags
374
- # A list of tags. For more information, see [Tagging Amazon RDS
375
- # Resources][1] in the *Amazon RDS User Guide.*
374
+ # A list of tags.
375
+ #
376
+ # For more information, see [Tagging Amazon RDS resources][1] in the
377
+ # *Amazon RDS User Guide* or [Tagging Amazon Aurora and Amazon RDS
378
+ # resources][2] in the *Amazon Aurora User Guide*.
376
379
  #
377
380
  #
378
381
  #
379
382
  # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html
383
+ # [2]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Tagging.html
380
384
  # @return [EventSubscription]
381
385
  def create(options = {})
382
386
  options = options.merge(subscription_name: @name)
@@ -337,12 +337,16 @@ module Aws::RDS
337
337
  # @option options [required, String] :target_option_group_description
338
338
  # The description for the copied option group.
339
339
  # @option options [Array<Types::Tag>] :tags
340
- # A list of tags. For more information, see [Tagging Amazon RDS
341
- # Resources][1] in the *Amazon RDS User Guide.*
340
+ # A list of tags.
341
+ #
342
+ # For more information, see [Tagging Amazon RDS resources][1] in the
343
+ # *Amazon RDS User Guide* or [Tagging Amazon Aurora and Amazon RDS
344
+ # resources][2] in the *Amazon Aurora User Guide*.
342
345
  #
343
346
  #
344
347
  #
345
348
  # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html
349
+ # [2]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Tagging.html
346
350
  # @return [OptionGroup]
347
351
  def copy(options = {})
348
352
  options = options.merge(source_option_group_identifier: @name)
@@ -249,12 +249,16 @@ module Aws::RDS
249
249
  #
250
250
  # Default: `1`
251
251
  # @option options [Array<Types::Tag>] :tags
252
- # A list of tags. For more information, see [Tagging Amazon RDS
253
- # Resources][1] in the *Amazon RDS User Guide.*
252
+ # A list of tags.
253
+ #
254
+ # For more information, see [Tagging Amazon RDS resources][1] in the
255
+ # *Amazon RDS User Guide* or [Tagging Amazon Aurora and Amazon RDS
256
+ # resources][2] in the *Amazon Aurora User Guide*.
254
257
  #
255
258
  #
256
259
  #
257
260
  # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html
261
+ # [2]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Tagging.html
258
262
  # @return [ReservedDBInstance]
259
263
  def purchase(options = {})
260
264
  options = options.merge(reserved_db_instances_offering_id: @id)
@@ -2650,12 +2650,16 @@ module Aws::RDS
2650
2650
  # notification subscription isn't activated, the subscription is
2651
2651
  # created but not active.
2652
2652
  # @option options [Array<Types::Tag>] :tags
2653
- # A list of tags. For more information, see [Tagging Amazon RDS
2654
- # Resources][1] in the *Amazon RDS User Guide.*
2653
+ # A list of tags.
2654
+ #
2655
+ # For more information, see [Tagging Amazon RDS resources][1] in the
2656
+ # *Amazon RDS User Guide* or [Tagging Amazon Aurora and Amazon RDS
2657
+ # resources][2] in the *Amazon Aurora User Guide*.
2655
2658
  #
2656
2659
  #
2657
2660
  #
2658
2661
  # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html
2662
+ # [2]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Tagging.html
2659
2663
  # @return [EventSubscription]
2660
2664
  def create_event_subscription(options = {})
2661
2665
  resp = Aws::Plugins::UserAgent.metric('RESOURCE_MODEL') do