aws-sdk-rds 1.290.0 → 1.300.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.
- checksums.yaml +4 -4
- data/CHANGELOG.md +50 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-rds/client.rb +1558 -1397
- data/lib/aws-sdk-rds/client_api.rb +238 -159
- data/lib/aws-sdk-rds/customizations.rb +0 -1
- data/lib/aws-sdk-rds/db_cluster.rb +383 -345
- data/lib/aws-sdk-rds/db_cluster_parameter_group.rb +2 -2
- data/lib/aws-sdk-rds/db_cluster_snapshot.rb +25 -25
- data/lib/aws-sdk-rds/db_engine_version.rb +55 -55
- data/lib/aws-sdk-rds/db_instance.rb +351 -318
- data/lib/aws-sdk-rds/db_parameter_group.rb +2 -2
- data/lib/aws-sdk-rds/db_snapshot.rb +74 -74
- data/lib/aws-sdk-rds/endpoint_parameters.rb +4 -4
- data/lib/aws-sdk-rds/errors.rb +11 -0
- data/lib/aws-sdk-rds/option_group.rb +1 -1
- data/lib/aws-sdk-rds/resource.rb +239 -227
- data/lib/aws-sdk-rds/types.rb +1296 -1066
- data/lib/aws-sdk-rds.rb +1 -1
- data/sig/client.rbs +113 -104
- data/sig/db_cluster.rbs +69 -64
- data/sig/db_cluster_snapshot.rbs +6 -6
- data/sig/db_engine_version.rbs +21 -21
- data/sig/db_instance.rbs +50 -45
- data/sig/db_snapshot.rbs +14 -14
- data/sig/errors.rbs +2 -0
- data/sig/event.rbs +1 -1
- data/sig/resource.rbs +23 -21
- data/sig/types.rbs +136 -118
- metadata +3 -3
|
@@ -90,12 +90,6 @@ module Aws::RDS
|
|
|
90
90
|
data[:status]
|
|
91
91
|
end
|
|
92
92
|
|
|
93
|
-
# The time when a stopped DB cluster is restarted automatically.
|
|
94
|
-
# @return [Time]
|
|
95
|
-
def automatic_restart_time
|
|
96
|
-
data[:automatic_restart_time]
|
|
97
|
-
end
|
|
98
|
-
|
|
99
93
|
# The progress of the operation as a percentage.
|
|
100
94
|
# @return [String]
|
|
101
95
|
def percent_progress
|
|
@@ -196,6 +190,20 @@ module Aws::RDS
|
|
|
196
190
|
data[:preferred_maintenance_window]
|
|
197
191
|
end
|
|
198
192
|
|
|
193
|
+
# This data type represents the order in which the clusters are
|
|
194
|
+
# upgraded.
|
|
195
|
+
#
|
|
196
|
+
# * \[first\] - Typically used for development or testing environments.
|
|
197
|
+
#
|
|
198
|
+
# * \[second\] - Default order for resources not specifically
|
|
199
|
+
# configured.
|
|
200
|
+
#
|
|
201
|
+
# * \[last\] - Usually reserved for production environments.
|
|
202
|
+
# @return [String]
|
|
203
|
+
def upgrade_rollout_order
|
|
204
|
+
data[:upgrade_rollout_order]
|
|
205
|
+
end
|
|
206
|
+
|
|
199
207
|
# The identifier of the source DB cluster if this DB cluster is a read
|
|
200
208
|
# replica.
|
|
201
209
|
# @return [String]
|
|
@@ -353,6 +361,14 @@ module Aws::RDS
|
|
|
353
361
|
data[:capacity]
|
|
354
362
|
end
|
|
355
363
|
|
|
364
|
+
# Information about pending changes to the DB cluster. This information
|
|
365
|
+
# is returned only when there are pending changes. Specific changes are
|
|
366
|
+
# identified by subelements.
|
|
367
|
+
# @return [Types::ClusterPendingModifiedValues]
|
|
368
|
+
def pending_modified_values
|
|
369
|
+
data[:pending_modified_values]
|
|
370
|
+
end
|
|
371
|
+
|
|
356
372
|
# The DB engine mode of the DB cluster, either `provisioned` or
|
|
357
373
|
# `serverless`.
|
|
358
374
|
#
|
|
@@ -386,6 +402,84 @@ module Aws::RDS
|
|
|
386
402
|
data[:rds_custom_cluster_configuration]
|
|
387
403
|
end
|
|
388
404
|
|
|
405
|
+
# The name of the compute and memory capacity class of the DB instance.
|
|
406
|
+
#
|
|
407
|
+
# This setting is only for non-Aurora Multi-AZ DB clusters.
|
|
408
|
+
# @return [String]
|
|
409
|
+
def db_cluster_instance_class
|
|
410
|
+
data[:db_cluster_instance_class]
|
|
411
|
+
end
|
|
412
|
+
|
|
413
|
+
# The storage type associated with the DB cluster.
|
|
414
|
+
# @return [String]
|
|
415
|
+
def storage_type
|
|
416
|
+
data[:storage_type]
|
|
417
|
+
end
|
|
418
|
+
|
|
419
|
+
# The Provisioned IOPS (I/O operations per second) value.
|
|
420
|
+
#
|
|
421
|
+
# This setting is only for non-Aurora Multi-AZ DB clusters.
|
|
422
|
+
# @return [Integer]
|
|
423
|
+
def iops
|
|
424
|
+
data[:iops]
|
|
425
|
+
end
|
|
426
|
+
|
|
427
|
+
# The storage throughput for the DB cluster. The throughput is
|
|
428
|
+
# automatically set based on the IOPS that you provision, and is not
|
|
429
|
+
# configurable.
|
|
430
|
+
#
|
|
431
|
+
# This setting is only for non-Aurora Multi-AZ DB clusters.
|
|
432
|
+
# @return [Integer]
|
|
433
|
+
def storage_throughput
|
|
434
|
+
data[:storage_throughput]
|
|
435
|
+
end
|
|
436
|
+
|
|
437
|
+
# The next time you can modify the DB cluster to use the `aurora-iopt1`
|
|
438
|
+
# storage type.
|
|
439
|
+
#
|
|
440
|
+
# This setting is only for Aurora DB clusters.
|
|
441
|
+
# @return [Time]
|
|
442
|
+
def io_optimized_next_allowed_modification_time
|
|
443
|
+
data[:io_optimized_next_allowed_modification_time]
|
|
444
|
+
end
|
|
445
|
+
|
|
446
|
+
# Indicates whether the DB cluster is publicly accessible.
|
|
447
|
+
#
|
|
448
|
+
# When the DB cluster is publicly accessible and you connect from
|
|
449
|
+
# outside of the DB cluster's virtual private cloud (VPC), its Domain
|
|
450
|
+
# Name System (DNS) endpoint resolves to the public IP address. When you
|
|
451
|
+
# connect from within the same VPC as the DB cluster, the endpoint
|
|
452
|
+
# resolves to the private IP address. Access to the DB cluster is
|
|
453
|
+
# ultimately controlled by the security group it uses. That public
|
|
454
|
+
# access isn't permitted if the security group assigned to the DB
|
|
455
|
+
# cluster doesn't permit it.
|
|
456
|
+
#
|
|
457
|
+
# When the DB cluster isn't publicly accessible, it is an internal DB
|
|
458
|
+
# cluster with a DNS name that resolves to a private IP address.
|
|
459
|
+
#
|
|
460
|
+
# For more information, see CreateDBCluster.
|
|
461
|
+
#
|
|
462
|
+
# This setting is only for non-Aurora Multi-AZ DB clusters.
|
|
463
|
+
# @return [Boolean]
|
|
464
|
+
def publicly_accessible
|
|
465
|
+
data[:publicly_accessible]
|
|
466
|
+
end
|
|
467
|
+
|
|
468
|
+
# Indicates whether minor version patches are applied automatically.
|
|
469
|
+
#
|
|
470
|
+
# This setting is for Aurora DB clusters and Multi-AZ DB clusters.
|
|
471
|
+
#
|
|
472
|
+
# For more information about automatic minor version upgrades, see
|
|
473
|
+
# [Automatically upgrading the minor engine version][1].
|
|
474
|
+
#
|
|
475
|
+
#
|
|
476
|
+
#
|
|
477
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.Upgrading.html#USER_UpgradeDBInstance.Upgrading.AutoMinorVersionUpgrades
|
|
478
|
+
# @return [Boolean]
|
|
479
|
+
def auto_minor_version_upgrade
|
|
480
|
+
data[:auto_minor_version_upgrade]
|
|
481
|
+
end
|
|
482
|
+
|
|
389
483
|
# Indicates whether the DB cluster has deletion protection enabled. The
|
|
390
484
|
# database can't be deleted when deletion protection is enabled.
|
|
391
485
|
# @return [Boolean]
|
|
@@ -505,71 +599,56 @@ module Aws::RDS
|
|
|
505
599
|
data[:global_write_forwarding_requested]
|
|
506
600
|
end
|
|
507
601
|
|
|
508
|
-
#
|
|
509
|
-
# is returned only when there are pending changes. Specific changes are
|
|
510
|
-
# identified by subelements.
|
|
511
|
-
# @return [Types::ClusterPendingModifiedValues]
|
|
512
|
-
def pending_modified_values
|
|
513
|
-
data[:pending_modified_values]
|
|
514
|
-
end
|
|
515
|
-
|
|
516
|
-
# The name of the compute and memory capacity class of the DB instance.
|
|
602
|
+
# The network type of the DB instance.
|
|
517
603
|
#
|
|
518
|
-
#
|
|
519
|
-
#
|
|
520
|
-
|
|
521
|
-
|
|
522
|
-
|
|
523
|
-
|
|
524
|
-
#
|
|
604
|
+
# The network type is determined by the `DBSubnetGroup` specified for
|
|
605
|
+
# the DB cluster. A `DBSubnetGroup` can support only the IPv4 protocol
|
|
606
|
+
# or the IPv4 and the IPv6 protocols (`DUAL`).
|
|
607
|
+
#
|
|
608
|
+
# For more information, see [ Working with a DB instance in a VPC][1] in
|
|
609
|
+
# the *Amazon Aurora User Guide.*
|
|
610
|
+
#
|
|
611
|
+
# This setting is only for Aurora DB clusters.
|
|
612
|
+
#
|
|
613
|
+
# Valid Values: `IPV4 | DUAL`
|
|
614
|
+
#
|
|
615
|
+
#
|
|
616
|
+
#
|
|
617
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html
|
|
525
618
|
# @return [String]
|
|
526
|
-
def
|
|
527
|
-
data[:
|
|
619
|
+
def network_type
|
|
620
|
+
data[:network_type]
|
|
528
621
|
end
|
|
529
622
|
|
|
530
|
-
# The
|
|
531
|
-
#
|
|
532
|
-
|
|
533
|
-
|
|
534
|
-
def iops
|
|
535
|
-
data[:iops]
|
|
623
|
+
# The time when a stopped DB cluster is restarted automatically.
|
|
624
|
+
# @return [Time]
|
|
625
|
+
def automatic_restart_time
|
|
626
|
+
data[:automatic_restart_time]
|
|
536
627
|
end
|
|
537
628
|
|
|
538
|
-
#
|
|
629
|
+
# The scaling configuration for an Aurora Serverless v2 DB cluster.
|
|
539
630
|
#
|
|
540
|
-
#
|
|
541
|
-
#
|
|
542
|
-
# Name System (DNS) endpoint resolves to the public IP address. When you
|
|
543
|
-
# connect from within the same VPC as the DB cluster, the endpoint
|
|
544
|
-
# resolves to the private IP address. Access to the DB cluster is
|
|
545
|
-
# ultimately controlled by the security group it uses. That public
|
|
546
|
-
# access isn't permitted if the security group assigned to the DB
|
|
547
|
-
# cluster doesn't permit it.
|
|
631
|
+
# For more information, see [Using Amazon Aurora Serverless v2][1] in
|
|
632
|
+
# the *Amazon Aurora User Guide*.
|
|
548
633
|
#
|
|
549
|
-
# When the DB cluster isn't publicly accessible, it is an internal DB
|
|
550
|
-
# cluster with a DNS name that resolves to a private IP address.
|
|
551
634
|
#
|
|
552
|
-
# For more information, see CreateDBCluster.
|
|
553
635
|
#
|
|
554
|
-
#
|
|
555
|
-
# @return [
|
|
556
|
-
def
|
|
557
|
-
data[:
|
|
636
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless-v2.html
|
|
637
|
+
# @return [Types::ServerlessV2ScalingConfigurationInfo]
|
|
638
|
+
def serverless_v2_scaling_configuration
|
|
639
|
+
data[:serverless_v2_scaling_configuration]
|
|
558
640
|
end
|
|
559
641
|
|
|
560
|
-
#
|
|
561
|
-
#
|
|
562
|
-
#
|
|
563
|
-
#
|
|
564
|
-
# For more information about automatic minor version upgrades, see
|
|
565
|
-
# [Automatically upgrading the minor engine version][1].
|
|
642
|
+
# The version of the Aurora Serverless V2 platform used by the DB
|
|
643
|
+
# cluster. For more information, see [Using Aurora Serverless v2][1] in
|
|
644
|
+
# the *Amazon Aurora User Guide*.
|
|
566
645
|
#
|
|
567
646
|
#
|
|
568
647
|
#
|
|
569
|
-
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/
|
|
570
|
-
# @return [
|
|
571
|
-
def
|
|
572
|
-
data[:
|
|
648
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless-v2.html
|
|
649
|
+
# @return [String]
|
|
650
|
+
def serverless_v2_platform_version
|
|
651
|
+
data[:serverless_v2_platform_version]
|
|
573
652
|
end
|
|
574
653
|
|
|
575
654
|
# The interval, in seconds, between points when Enhanced Monitoring
|
|
@@ -636,52 +715,6 @@ module Aws::RDS
|
|
|
636
715
|
data[:performance_insights_retention_period]
|
|
637
716
|
end
|
|
638
717
|
|
|
639
|
-
# The scaling configuration for an Aurora Serverless v2 DB cluster.
|
|
640
|
-
#
|
|
641
|
-
# For more information, see [Using Amazon Aurora Serverless v2][1] in
|
|
642
|
-
# the *Amazon Aurora User Guide*.
|
|
643
|
-
#
|
|
644
|
-
#
|
|
645
|
-
#
|
|
646
|
-
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless-v2.html
|
|
647
|
-
# @return [Types::ServerlessV2ScalingConfigurationInfo]
|
|
648
|
-
def serverless_v2_scaling_configuration
|
|
649
|
-
data[:serverless_v2_scaling_configuration]
|
|
650
|
-
end
|
|
651
|
-
|
|
652
|
-
# The version of the Aurora Serverless V2 platform used by the DB
|
|
653
|
-
# cluster. For more information, see [Using Aurora Serverless v2][1] in
|
|
654
|
-
# the *Amazon Aurora User Guide*.
|
|
655
|
-
#
|
|
656
|
-
#
|
|
657
|
-
#
|
|
658
|
-
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless-v2.html
|
|
659
|
-
# @return [String]
|
|
660
|
-
def serverless_v2_platform_version
|
|
661
|
-
data[:serverless_v2_platform_version]
|
|
662
|
-
end
|
|
663
|
-
|
|
664
|
-
# The network type of the DB instance.
|
|
665
|
-
#
|
|
666
|
-
# The network type is determined by the `DBSubnetGroup` specified for
|
|
667
|
-
# the DB cluster. A `DBSubnetGroup` can support only the IPv4 protocol
|
|
668
|
-
# or the IPv4 and the IPv6 protocols (`DUAL`).
|
|
669
|
-
#
|
|
670
|
-
# For more information, see [ Working with a DB instance in a VPC][1] in
|
|
671
|
-
# the *Amazon Aurora User Guide.*
|
|
672
|
-
#
|
|
673
|
-
# This setting is only for Aurora DB clusters.
|
|
674
|
-
#
|
|
675
|
-
# Valid Values: `IPV4 | DUAL`
|
|
676
|
-
#
|
|
677
|
-
#
|
|
678
|
-
#
|
|
679
|
-
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html
|
|
680
|
-
# @return [String]
|
|
681
|
-
def network_type
|
|
682
|
-
data[:network_type]
|
|
683
|
-
end
|
|
684
|
-
|
|
685
718
|
# Reserved for future use.
|
|
686
719
|
# @return [String]
|
|
687
720
|
def db_system_id
|
|
@@ -705,15 +738,6 @@ module Aws::RDS
|
|
|
705
738
|
data[:master_user_secret]
|
|
706
739
|
end
|
|
707
740
|
|
|
708
|
-
# The next time you can modify the DB cluster to use the `aurora-iopt1`
|
|
709
|
-
# storage type.
|
|
710
|
-
#
|
|
711
|
-
# This setting is only for Aurora DB clusters.
|
|
712
|
-
# @return [Time]
|
|
713
|
-
def io_optimized_next_allowed_modification_time
|
|
714
|
-
data[:io_optimized_next_allowed_modification_time]
|
|
715
|
-
end
|
|
716
|
-
|
|
717
741
|
# Indicates whether an Aurora DB cluster has in-cluster write forwarding
|
|
718
742
|
# enabled, not enabled, requested, or is in the process of enabling it.
|
|
719
743
|
# @return [String]
|
|
@@ -734,16 +758,6 @@ module Aws::RDS
|
|
|
734
758
|
data[:limitless_database]
|
|
735
759
|
end
|
|
736
760
|
|
|
737
|
-
# The storage throughput for the DB cluster. The throughput is
|
|
738
|
-
# automatically set based on the IOPS that you provision, and is not
|
|
739
|
-
# configurable.
|
|
740
|
-
#
|
|
741
|
-
# This setting is only for non-Aurora Multi-AZ DB clusters.
|
|
742
|
-
# @return [Integer]
|
|
743
|
-
def storage_throughput
|
|
744
|
-
data[:storage_throughput]
|
|
745
|
-
end
|
|
746
|
-
|
|
747
761
|
# The scalability mode of the Aurora DB cluster. When set to
|
|
748
762
|
# `limitless`, the cluster operates as an Aurora Limitless Database.
|
|
749
763
|
# When set to `standard` (the default), the cluster uses normal DB
|
|
@@ -929,7 +943,7 @@ module Aws::RDS
|
|
|
929
943
|
# engine_version: "String",
|
|
930
944
|
# port: 1,
|
|
931
945
|
# master_username: "String",
|
|
932
|
-
# master_user_password: "
|
|
946
|
+
# master_user_password: "SensitiveString",
|
|
933
947
|
# option_group_name: "String",
|
|
934
948
|
# preferred_backup_window: "String",
|
|
935
949
|
# preferred_maintenance_window: "String",
|
|
@@ -942,7 +956,7 @@ module Aws::RDS
|
|
|
942
956
|
# ],
|
|
943
957
|
# storage_encrypted: false,
|
|
944
958
|
# kms_key_id: "String",
|
|
945
|
-
# pre_signed_url: "
|
|
959
|
+
# pre_signed_url: "SensitiveString",
|
|
946
960
|
# enable_iam_database_authentication: false,
|
|
947
961
|
# backtrack_window: 1,
|
|
948
962
|
# enable_cloudwatch_logs_exports: ["String"],
|
|
@@ -960,19 +974,25 @@ module Aws::RDS
|
|
|
960
974
|
# transit_gateway_multicast_domain_id: "String",
|
|
961
975
|
# replica_mode: "open-read-only", # accepts open-read-only, mounted
|
|
962
976
|
# },
|
|
963
|
-
# deletion_protection: false,
|
|
964
|
-
# global_cluster_identifier: "String",
|
|
965
|
-
# enable_http_endpoint: false,
|
|
966
|
-
# copy_tags_to_snapshot: false,
|
|
967
|
-
# domain: "String",
|
|
968
|
-
# domain_iam_role_name: "String",
|
|
969
|
-
# enable_global_write_forwarding: false,
|
|
970
977
|
# db_cluster_instance_class: "String",
|
|
971
978
|
# allocated_storage: 1,
|
|
972
979
|
# storage_type: "String",
|
|
973
980
|
# iops: 1,
|
|
974
981
|
# publicly_accessible: false,
|
|
975
982
|
# auto_minor_version_upgrade: false,
|
|
983
|
+
# deletion_protection: false,
|
|
984
|
+
# global_cluster_identifier: "GlobalClusterIdentifier",
|
|
985
|
+
# enable_http_endpoint: false,
|
|
986
|
+
# copy_tags_to_snapshot: false,
|
|
987
|
+
# domain: "String",
|
|
988
|
+
# domain_iam_role_name: "String",
|
|
989
|
+
# enable_global_write_forwarding: false,
|
|
990
|
+
# network_type: "String",
|
|
991
|
+
# serverless_v2_scaling_configuration: {
|
|
992
|
+
# min_capacity: 1.0,
|
|
993
|
+
# max_capacity: 1.0,
|
|
994
|
+
# seconds_until_auto_pause: 1,
|
|
995
|
+
# },
|
|
976
996
|
# monitoring_interval: 1,
|
|
977
997
|
# monitoring_role_arn: "String",
|
|
978
998
|
# database_insights_mode: "standard", # accepts standard, advanced
|
|
@@ -980,19 +1000,14 @@ module Aws::RDS
|
|
|
980
1000
|
# performance_insights_kms_key_id: "String",
|
|
981
1001
|
# performance_insights_retention_period: 1,
|
|
982
1002
|
# enable_limitless_database: false,
|
|
983
|
-
# serverless_v2_scaling_configuration: {
|
|
984
|
-
# min_capacity: 1.0,
|
|
985
|
-
# max_capacity: 1.0,
|
|
986
|
-
# seconds_until_auto_pause: 1,
|
|
987
|
-
# },
|
|
988
|
-
# network_type: "String",
|
|
989
1003
|
# cluster_scalability_type: "standard", # accepts standard, limitless
|
|
990
1004
|
# db_system_id: "String",
|
|
991
1005
|
# manage_master_user_password: false,
|
|
992
|
-
# master_user_secret_kms_key_id: "String",
|
|
993
1006
|
# enable_local_write_forwarding: false,
|
|
1007
|
+
# master_user_secret_kms_key_id: "String",
|
|
994
1008
|
# ca_certificate_identifier: "String",
|
|
995
1009
|
# engine_lifecycle_support: "String",
|
|
1010
|
+
# master_user_authentication_type: "password", # accepts password, iam-db-auth
|
|
996
1011
|
# source_region: "String",
|
|
997
1012
|
# })
|
|
998
1013
|
# @param [Hash] options ({})
|
|
@@ -1426,73 +1441,6 @@ module Aws::RDS
|
|
|
1426
1441
|
# Valid for Cluster Type: Aurora DB clusters only
|
|
1427
1442
|
# @option options [Types::RdsCustomClusterConfiguration] :rds_custom_cluster_configuration
|
|
1428
1443
|
# Reserved for future use.
|
|
1429
|
-
# @option options [Boolean] :deletion_protection
|
|
1430
|
-
# Specifies whether the DB cluster has deletion protection enabled. The
|
|
1431
|
-
# database can't be deleted when deletion protection is enabled. By
|
|
1432
|
-
# default, deletion protection isn't enabled.
|
|
1433
|
-
#
|
|
1434
|
-
# Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
|
|
1435
|
-
# @option options [String] :global_cluster_identifier
|
|
1436
|
-
# The global cluster ID of an Aurora cluster that becomes the primary
|
|
1437
|
-
# cluster in the new global database cluster.
|
|
1438
|
-
#
|
|
1439
|
-
# Valid for Cluster Type: Aurora DB clusters only
|
|
1440
|
-
# @option options [Boolean] :enable_http_endpoint
|
|
1441
|
-
# Specifies whether to enable the HTTP endpoint for the DB cluster. By
|
|
1442
|
-
# default, the HTTP endpoint isn't enabled.
|
|
1443
|
-
#
|
|
1444
|
-
# When enabled, the HTTP endpoint provides a connectionless web service
|
|
1445
|
-
# API (RDS Data API) for running SQL queries on the DB cluster. You can
|
|
1446
|
-
# also query your database from inside the RDS console with the RDS
|
|
1447
|
-
# query editor.
|
|
1448
|
-
#
|
|
1449
|
-
# For more information, see [Using RDS Data API][1] in the *Amazon
|
|
1450
|
-
# Aurora User Guide*.
|
|
1451
|
-
#
|
|
1452
|
-
# Valid for Cluster Type: Aurora DB clusters only
|
|
1453
|
-
#
|
|
1454
|
-
#
|
|
1455
|
-
#
|
|
1456
|
-
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/data-api.html
|
|
1457
|
-
# @option options [Boolean] :copy_tags_to_snapshot
|
|
1458
|
-
# Specifies whether to copy all tags from the DB cluster to snapshots of
|
|
1459
|
-
# the DB cluster. The default is not to copy them.
|
|
1460
|
-
#
|
|
1461
|
-
# Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
|
|
1462
|
-
# @option options [String] :domain
|
|
1463
|
-
# The Active Directory directory ID to create the DB cluster in.
|
|
1464
|
-
#
|
|
1465
|
-
# For Amazon Aurora DB clusters, Amazon RDS can use Kerberos
|
|
1466
|
-
# authentication to authenticate users that connect to the DB cluster.
|
|
1467
|
-
#
|
|
1468
|
-
# For more information, see [Kerberos authentication][1] in the *Amazon
|
|
1469
|
-
# Aurora User Guide*.
|
|
1470
|
-
#
|
|
1471
|
-
# Valid for Cluster Type: Aurora DB clusters only
|
|
1472
|
-
#
|
|
1473
|
-
#
|
|
1474
|
-
#
|
|
1475
|
-
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/kerberos-authentication.html
|
|
1476
|
-
# @option options [String] :domain_iam_role_name
|
|
1477
|
-
# The name of the IAM role to use when making API calls to the Directory
|
|
1478
|
-
# Service.
|
|
1479
|
-
#
|
|
1480
|
-
# Valid for Cluster Type: Aurora DB clusters only
|
|
1481
|
-
# @option options [Boolean] :enable_global_write_forwarding
|
|
1482
|
-
# Specifies whether to enable this DB cluster to forward write
|
|
1483
|
-
# operations to the primary cluster of a global cluster (Aurora global
|
|
1484
|
-
# database). By default, write operations are not allowed on Aurora DB
|
|
1485
|
-
# clusters that are secondary clusters in an Aurora global database.
|
|
1486
|
-
#
|
|
1487
|
-
# You can set this value only on Aurora DB clusters that are members of
|
|
1488
|
-
# an Aurora global database. With this parameter enabled, a secondary
|
|
1489
|
-
# cluster can forward writes to the current primary cluster, and the
|
|
1490
|
-
# resulting changes are replicated back to this cluster. For the primary
|
|
1491
|
-
# DB cluster of an Aurora global database, this value is used
|
|
1492
|
-
# immediately if the primary is demoted by a global cluster API
|
|
1493
|
-
# operation, but it does nothing until then.
|
|
1494
|
-
#
|
|
1495
|
-
# Valid for Cluster Type: Aurora DB clusters only
|
|
1496
1444
|
# @option options [String] :db_cluster_instance_class
|
|
1497
1445
|
# The compute and memory capacity of each DB instance in the Multi-AZ DB
|
|
1498
1446
|
# cluster, for example `db.m6gd.xlarge`. Not all DB instance classes are
|
|
@@ -1578,53 +1526,138 @@ module Aws::RDS
|
|
|
1578
1526
|
# @option options [Boolean] :publicly_accessible
|
|
1579
1527
|
# Specifies whether the DB cluster is publicly accessible.
|
|
1580
1528
|
#
|
|
1529
|
+
# Valid for Cluster Type: Multi-AZ DB clusters only
|
|
1530
|
+
#
|
|
1581
1531
|
# When the DB cluster is publicly accessible and you connect from
|
|
1582
|
-
# outside of the DB cluster's virtual private cloud (VPC), its
|
|
1583
|
-
#
|
|
1532
|
+
# outside of the DB cluster's virtual private cloud (VPC), its domain
|
|
1533
|
+
# name system (DNS) endpoint resolves to the public IP address. When you
|
|
1584
1534
|
# connect from within the same VPC as the DB cluster, the endpoint
|
|
1585
1535
|
# resolves to the private IP address. Access to the DB cluster is
|
|
1586
|
-
#
|
|
1587
|
-
# access isn't permitted if the security group assigned to the DB
|
|
1588
|
-
# cluster doesn't permit it.
|
|
1536
|
+
# controlled by its security group settings.
|
|
1589
1537
|
#
|
|
1590
1538
|
# When the DB cluster isn't publicly accessible, it is an internal DB
|
|
1591
1539
|
# cluster with a DNS name that resolves to a private IP address.
|
|
1592
1540
|
#
|
|
1593
|
-
#
|
|
1541
|
+
# The default behavior when `PubliclyAccessible` is not specified
|
|
1542
|
+
# depends on whether a `DBSubnetGroup` is specified.
|
|
1543
|
+
#
|
|
1544
|
+
# If `DBSubnetGroup` isn't specified, `PubliclyAccessible` defaults to
|
|
1545
|
+
# `true`.
|
|
1546
|
+
#
|
|
1547
|
+
# If `DBSubnetGroup` is specified, `PubliclyAccessible` defaults to
|
|
1548
|
+
# `false` unless the value of `DBSubnetGroup` is `default`, in which
|
|
1549
|
+
# case `PubliclyAccessible` defaults to `true`.
|
|
1550
|
+
#
|
|
1551
|
+
# If `PubliclyAccessible` is true and the VPC that the `DBSubnetGroup`
|
|
1552
|
+
# is in doesn't have an internet gateway attached to it, Amazon RDS
|
|
1553
|
+
# returns an error.
|
|
1554
|
+
# @option options [Boolean] :auto_minor_version_upgrade
|
|
1555
|
+
# Specifies whether minor engine upgrades are applied automatically to
|
|
1556
|
+
# the DB cluster during the maintenance window. By default, minor engine
|
|
1557
|
+
# upgrades are applied automatically.
|
|
1558
|
+
#
|
|
1559
|
+
# Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB cluster.
|
|
1560
|
+
#
|
|
1561
|
+
# For more information about automatic minor version upgrades, see
|
|
1562
|
+
# [Automatically upgrading the minor engine version][1].
|
|
1563
|
+
#
|
|
1564
|
+
#
|
|
1565
|
+
#
|
|
1566
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.Upgrading.html#USER_UpgradeDBInstance.Upgrading.AutoMinorVersionUpgrades
|
|
1567
|
+
# @option options [Boolean] :deletion_protection
|
|
1568
|
+
# Specifies whether the DB cluster has deletion protection enabled. The
|
|
1569
|
+
# database can't be deleted when deletion protection is enabled. By
|
|
1570
|
+
# default, deletion protection isn't enabled.
|
|
1571
|
+
#
|
|
1572
|
+
# Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
|
|
1573
|
+
# @option options [String] :global_cluster_identifier
|
|
1574
|
+
# The global cluster ID of an Aurora cluster that becomes the primary
|
|
1575
|
+
# cluster in the new global database cluster.
|
|
1576
|
+
#
|
|
1577
|
+
# Valid for Cluster Type: Aurora DB clusters only
|
|
1578
|
+
# @option options [Boolean] :enable_http_endpoint
|
|
1579
|
+
# Specifies whether to enable the HTTP endpoint for the DB cluster. By
|
|
1580
|
+
# default, the HTTP endpoint isn't enabled.
|
|
1581
|
+
#
|
|
1582
|
+
# When enabled, the HTTP endpoint provides a connectionless web service
|
|
1583
|
+
# API (RDS Data API) for running SQL queries on the DB cluster. You can
|
|
1584
|
+
# also query your database from inside the RDS console with the RDS
|
|
1585
|
+
# query editor.
|
|
1586
|
+
#
|
|
1587
|
+
# For more information, see [Using RDS Data API][1] in the *Amazon
|
|
1588
|
+
# Aurora User Guide*.
|
|
1589
|
+
#
|
|
1590
|
+
# Valid for Cluster Type: Aurora DB clusters only
|
|
1591
|
+
#
|
|
1592
|
+
#
|
|
1593
|
+
#
|
|
1594
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/data-api.html
|
|
1595
|
+
# @option options [Boolean] :copy_tags_to_snapshot
|
|
1596
|
+
# Specifies whether to copy all tags from the DB cluster to snapshots of
|
|
1597
|
+
# the DB cluster. The default is not to copy them.
|
|
1598
|
+
#
|
|
1599
|
+
# Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
|
|
1600
|
+
# @option options [String] :domain
|
|
1601
|
+
# The Active Directory directory ID to create the DB cluster in.
|
|
1602
|
+
#
|
|
1603
|
+
# For Amazon Aurora DB clusters, Amazon RDS can use Kerberos
|
|
1604
|
+
# authentication to authenticate users that connect to the DB cluster.
|
|
1605
|
+
#
|
|
1606
|
+
# For more information, see [Kerberos authentication][1] in the *Amazon
|
|
1607
|
+
# Aurora User Guide*.
|
|
1608
|
+
#
|
|
1609
|
+
# Valid for Cluster Type: Aurora DB clusters only
|
|
1610
|
+
#
|
|
1611
|
+
#
|
|
1612
|
+
#
|
|
1613
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/kerberos-authentication.html
|
|
1614
|
+
# @option options [String] :domain_iam_role_name
|
|
1615
|
+
# The name of the IAM role to use when making API calls to the Directory
|
|
1616
|
+
# Service.
|
|
1617
|
+
#
|
|
1618
|
+
# Valid for Cluster Type: Aurora DB clusters only
|
|
1619
|
+
# @option options [Boolean] :enable_global_write_forwarding
|
|
1620
|
+
# Specifies whether to enable this DB cluster to forward write
|
|
1621
|
+
# operations to the primary cluster of a global cluster (Aurora global
|
|
1622
|
+
# database). By default, write operations are not allowed on Aurora DB
|
|
1623
|
+
# clusters that are secondary clusters in an Aurora global database.
|
|
1624
|
+
#
|
|
1625
|
+
# You can set this value only on Aurora DB clusters that are members of
|
|
1626
|
+
# an Aurora global database. With this parameter enabled, a secondary
|
|
1627
|
+
# cluster can forward writes to the current primary cluster, and the
|
|
1628
|
+
# resulting changes are replicated back to this cluster. For the primary
|
|
1629
|
+
# DB cluster of an Aurora global database, this value is used
|
|
1630
|
+
# immediately if the primary is demoted by a global cluster API
|
|
1631
|
+
# operation, but it does nothing until then.
|
|
1594
1632
|
#
|
|
1595
|
-
#
|
|
1596
|
-
#
|
|
1633
|
+
# Valid for Cluster Type: Aurora DB clusters only
|
|
1634
|
+
# @option options [String] :network_type
|
|
1635
|
+
# The network type of the DB cluster.
|
|
1597
1636
|
#
|
|
1598
|
-
#
|
|
1599
|
-
#
|
|
1637
|
+
# The network type is determined by the `DBSubnetGroup` specified for
|
|
1638
|
+
# the DB cluster. A `DBSubnetGroup` can support only the IPv4 protocol
|
|
1639
|
+
# or the IPv4 and the IPv6 protocols (`DUAL`).
|
|
1600
1640
|
#
|
|
1601
|
-
#
|
|
1602
|
-
#
|
|
1641
|
+
# For more information, see [ Working with a DB instance in a VPC][1] in
|
|
1642
|
+
# the *Amazon Aurora User Guide.*
|
|
1603
1643
|
#
|
|
1604
|
-
#
|
|
1605
|
-
# attached to it, the DB cluster is public.
|
|
1644
|
+
# Valid for Cluster Type: Aurora DB clusters only
|
|
1606
1645
|
#
|
|
1607
|
-
#
|
|
1608
|
-
# specified, the following applies:
|
|
1646
|
+
# Valid Values: `IPV4 | DUAL`
|
|
1609
1647
|
#
|
|
1610
|
-
# * If the subnets are part of a VPC that doesn’t have an internet
|
|
1611
|
-
# gateway attached to it, the DB cluster is private.
|
|
1612
1648
|
#
|
|
1613
|
-
# * If the subnets are part of a VPC that has an internet gateway
|
|
1614
|
-
# attached to it, the DB cluster is public.
|
|
1615
|
-
# @option options [Boolean] :auto_minor_version_upgrade
|
|
1616
|
-
# Specifies whether minor engine upgrades are applied automatically to
|
|
1617
|
-
# the DB cluster during the maintenance window. By default, minor engine
|
|
1618
|
-
# upgrades are applied automatically.
|
|
1619
1649
|
#
|
|
1620
|
-
#
|
|
1650
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html
|
|
1651
|
+
# @option options [Types::ServerlessV2ScalingConfiguration] :serverless_v2_scaling_configuration
|
|
1652
|
+
# Contains the scaling configuration of an Aurora Serverless v2 DB
|
|
1653
|
+
# cluster.
|
|
1621
1654
|
#
|
|
1622
|
-
# For more information
|
|
1623
|
-
#
|
|
1655
|
+
# For more information, see [Using Amazon Aurora Serverless v2][1] in
|
|
1656
|
+
# the *Amazon Aurora User Guide*.
|
|
1624
1657
|
#
|
|
1625
1658
|
#
|
|
1626
1659
|
#
|
|
1627
|
-
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/
|
|
1660
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless-v2.html
|
|
1628
1661
|
# @option options [Integer] :monitoring_interval
|
|
1629
1662
|
# The interval, in seconds, between points when Enhanced Monitoring
|
|
1630
1663
|
# metrics are collected for the DB cluster. To turn off collecting
|
|
@@ -1714,33 +1747,6 @@ module Aws::RDS
|
|
|
1714
1747
|
# `ClusterScalabilityType` setting.
|
|
1715
1748
|
#
|
|
1716
1749
|
# </note>
|
|
1717
|
-
# @option options [Types::ServerlessV2ScalingConfiguration] :serverless_v2_scaling_configuration
|
|
1718
|
-
# Contains the scaling configuration of an Aurora Serverless v2 DB
|
|
1719
|
-
# cluster.
|
|
1720
|
-
#
|
|
1721
|
-
# For more information, see [Using Amazon Aurora Serverless v2][1] in
|
|
1722
|
-
# the *Amazon Aurora User Guide*.
|
|
1723
|
-
#
|
|
1724
|
-
#
|
|
1725
|
-
#
|
|
1726
|
-
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless-v2.html
|
|
1727
|
-
# @option options [String] :network_type
|
|
1728
|
-
# The network type of the DB cluster.
|
|
1729
|
-
#
|
|
1730
|
-
# The network type is determined by the `DBSubnetGroup` specified for
|
|
1731
|
-
# the DB cluster. A `DBSubnetGroup` can support only the IPv4 protocol
|
|
1732
|
-
# or the IPv4 and the IPv6 protocols (`DUAL`).
|
|
1733
|
-
#
|
|
1734
|
-
# For more information, see [ Working with a DB instance in a VPC][1] in
|
|
1735
|
-
# the *Amazon Aurora User Guide.*
|
|
1736
|
-
#
|
|
1737
|
-
# Valid for Cluster Type: Aurora DB clusters only
|
|
1738
|
-
#
|
|
1739
|
-
# Valid Values: `IPV4 | DUAL`
|
|
1740
|
-
#
|
|
1741
|
-
#
|
|
1742
|
-
#
|
|
1743
|
-
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html
|
|
1744
1750
|
# @option options [String] :cluster_scalability_type
|
|
1745
1751
|
# Specifies the scalability mode of the Aurora DB cluster. When set to
|
|
1746
1752
|
# `limitless`, the cluster operates as an Aurora Limitless Database.
|
|
@@ -1776,6 +1782,12 @@ module Aws::RDS
|
|
|
1776
1782
|
#
|
|
1777
1783
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html
|
|
1778
1784
|
# [2]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/rds-secrets-manager.html
|
|
1785
|
+
# @option options [Boolean] :enable_local_write_forwarding
|
|
1786
|
+
# Specifies whether read replicas can forward write operations to the
|
|
1787
|
+
# writer DB instance in the DB cluster. By default, write operations
|
|
1788
|
+
# aren't allowed on reader DB instances.
|
|
1789
|
+
#
|
|
1790
|
+
# Valid for: Aurora DB clusters only
|
|
1779
1791
|
# @option options [String] :master_user_secret_kms_key_id
|
|
1780
1792
|
# The Amazon Web Services KMS key identifier to encrypt a secret that is
|
|
1781
1793
|
# automatically generated and managed in Amazon Web Services Secrets
|
|
@@ -1800,12 +1812,6 @@ module Aws::RDS
|
|
|
1800
1812
|
# Amazon Web Services Region.
|
|
1801
1813
|
#
|
|
1802
1814
|
# Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
|
|
1803
|
-
# @option options [Boolean] :enable_local_write_forwarding
|
|
1804
|
-
# Specifies whether read replicas can forward write operations to the
|
|
1805
|
-
# writer DB instance in the DB cluster. By default, write operations
|
|
1806
|
-
# aren't allowed on reader DB instances.
|
|
1807
|
-
#
|
|
1808
|
-
# Valid for: Aurora DB clusters only
|
|
1809
1815
|
# @option options [String] :ca_certificate_identifier
|
|
1810
1816
|
# The CA certificate identifier to use for the DB cluster's server
|
|
1811
1817
|
# certificate.
|
|
@@ -1853,6 +1859,21 @@ module Aws::RDS
|
|
|
1853
1859
|
#
|
|
1854
1860
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/extended-support.html
|
|
1855
1861
|
# [2]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/extended-support.html
|
|
1862
|
+
# @option options [String] :master_user_authentication_type
|
|
1863
|
+
# Specifies the authentication type for the master user. With IAM master
|
|
1864
|
+
# user authentication, you can configure the master DB user with IAM
|
|
1865
|
+
# database authentication when you create a DB cluster.
|
|
1866
|
+
#
|
|
1867
|
+
# You can specify one of the following values:
|
|
1868
|
+
#
|
|
1869
|
+
# * `password` - Use standard database authentication with a password.
|
|
1870
|
+
#
|
|
1871
|
+
# * `iam-db-auth` - Use IAM database authentication for the master user.
|
|
1872
|
+
#
|
|
1873
|
+
# Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
|
|
1874
|
+
#
|
|
1875
|
+
# This option is only valid for RDS for PostgreSQL and Aurora PostgreSQL
|
|
1876
|
+
# engines.
|
|
1856
1877
|
# @option options [String] :source_region
|
|
1857
1878
|
# The source region of the snapshot. This is only needed when the
|
|
1858
1879
|
# shapshot is encrypted and in a different region.
|
|
@@ -2002,7 +2023,7 @@ module Aws::RDS
|
|
|
2002
2023
|
# db_cluster_parameter_group_name: "String",
|
|
2003
2024
|
# vpc_security_group_ids: ["String"],
|
|
2004
2025
|
# port: 1,
|
|
2005
|
-
# master_user_password: "
|
|
2026
|
+
# master_user_password: "SensitiveString",
|
|
2006
2027
|
# option_group_name: "String",
|
|
2007
2028
|
# preferred_backup_window: "String",
|
|
2008
2029
|
# preferred_maintenance_window: "String",
|
|
@@ -2034,27 +2055,28 @@ module Aws::RDS
|
|
|
2034
2055
|
# storage_type: "String",
|
|
2035
2056
|
# iops: 1,
|
|
2036
2057
|
# auto_minor_version_upgrade: false,
|
|
2058
|
+
# network_type: "String",
|
|
2059
|
+
# serverless_v2_scaling_configuration: {
|
|
2060
|
+
# min_capacity: 1.0,
|
|
2061
|
+
# max_capacity: 1.0,
|
|
2062
|
+
# seconds_until_auto_pause: 1,
|
|
2063
|
+
# },
|
|
2037
2064
|
# monitoring_interval: 1,
|
|
2038
2065
|
# monitoring_role_arn: "String",
|
|
2039
2066
|
# database_insights_mode: "standard", # accepts standard, advanced
|
|
2040
2067
|
# enable_performance_insights: false,
|
|
2041
2068
|
# performance_insights_kms_key_id: "String",
|
|
2042
2069
|
# performance_insights_retention_period: 1,
|
|
2043
|
-
# serverless_v2_scaling_configuration: {
|
|
2044
|
-
# min_capacity: 1.0,
|
|
2045
|
-
# max_capacity: 1.0,
|
|
2046
|
-
# seconds_until_auto_pause: 1,
|
|
2047
|
-
# },
|
|
2048
|
-
# network_type: "String",
|
|
2049
2070
|
# manage_master_user_password: false,
|
|
2050
2071
|
# rotate_master_user_password: false,
|
|
2072
|
+
# enable_local_write_forwarding: false,
|
|
2051
2073
|
# master_user_secret_kms_key_id: "String",
|
|
2052
2074
|
# engine_mode: "String",
|
|
2053
2075
|
# allow_engine_mode_change: false,
|
|
2054
|
-
# enable_local_write_forwarding: false,
|
|
2055
2076
|
# aws_backup_recovery_point_arn: "AwsBackupRecoveryPointArn",
|
|
2056
2077
|
# enable_limitless_database: false,
|
|
2057
2078
|
# ca_certificate_identifier: "String",
|
|
2079
|
+
# master_user_authentication_type: "password", # accepts password, iam-db-auth
|
|
2058
2080
|
# })
|
|
2059
2081
|
# @param [Hash] options ({})
|
|
2060
2082
|
# @option options [String] :new_db_cluster_identifier
|
|
@@ -2466,6 +2488,33 @@ module Aws::RDS
|
|
|
2466
2488
|
#
|
|
2467
2489
|
#
|
|
2468
2490
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.Upgrading.html#USER_UpgradeDBInstance.Upgrading.AutoMinorVersionUpgrades
|
|
2491
|
+
# @option options [String] :network_type
|
|
2492
|
+
# The network type of the DB cluster.
|
|
2493
|
+
#
|
|
2494
|
+
# The network type is determined by the `DBSubnetGroup` specified for
|
|
2495
|
+
# the DB cluster. A `DBSubnetGroup` can support only the IPv4 protocol
|
|
2496
|
+
# or the IPv4 and the IPv6 protocols (`DUAL`).
|
|
2497
|
+
#
|
|
2498
|
+
# For more information, see [ Working with a DB instance in a VPC][1] in
|
|
2499
|
+
# the *Amazon Aurora User Guide.*
|
|
2500
|
+
#
|
|
2501
|
+
# Valid for Cluster Type: Aurora DB clusters only
|
|
2502
|
+
#
|
|
2503
|
+
# Valid Values: `IPV4 | DUAL`
|
|
2504
|
+
#
|
|
2505
|
+
#
|
|
2506
|
+
#
|
|
2507
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html
|
|
2508
|
+
# @option options [Types::ServerlessV2ScalingConfiguration] :serverless_v2_scaling_configuration
|
|
2509
|
+
# Contains the scaling configuration of an Aurora Serverless v2 DB
|
|
2510
|
+
# cluster.
|
|
2511
|
+
#
|
|
2512
|
+
# For more information, see [Using Amazon Aurora Serverless v2][1] in
|
|
2513
|
+
# the *Amazon Aurora User Guide*.
|
|
2514
|
+
#
|
|
2515
|
+
#
|
|
2516
|
+
#
|
|
2517
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless-v2.html
|
|
2469
2518
|
# @option options [Integer] :monitoring_interval
|
|
2470
2519
|
# The interval, in seconds, between points when Enhanced Monitoring
|
|
2471
2520
|
# metrics are collected for the DB cluster. To turn off collecting
|
|
@@ -2501,8 +2550,9 @@ module Aws::RDS
|
|
|
2501
2550
|
# the `PerformanceInsightsEnabled` parameter to `true` and the
|
|
2502
2551
|
# `PerformanceInsightsRetentionPeriod` parameter to 465.
|
|
2503
2552
|
#
|
|
2504
|
-
# If you change the value from `advanced` to `standard`, you
|
|
2505
|
-
#
|
|
2553
|
+
# If you change the value from `advanced` to `standard`, you can set the
|
|
2554
|
+
# `PerformanceInsightsEnabled` parameter to `true` to collect detailed
|
|
2555
|
+
# database counter and per-query metrics.
|
|
2506
2556
|
#
|
|
2507
2557
|
# Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
|
|
2508
2558
|
# @option options [Boolean] :enable_performance_insights
|
|
@@ -2548,33 +2598,6 @@ module Aws::RDS
|
|
|
2548
2598
|
#
|
|
2549
2599
|
# If you specify a retention period that isn't valid, such as `94`,
|
|
2550
2600
|
# Amazon RDS issues an error.
|
|
2551
|
-
# @option options [Types::ServerlessV2ScalingConfiguration] :serverless_v2_scaling_configuration
|
|
2552
|
-
# Contains the scaling configuration of an Aurora Serverless v2 DB
|
|
2553
|
-
# cluster.
|
|
2554
|
-
#
|
|
2555
|
-
# For more information, see [Using Amazon Aurora Serverless v2][1] in
|
|
2556
|
-
# the *Amazon Aurora User Guide*.
|
|
2557
|
-
#
|
|
2558
|
-
#
|
|
2559
|
-
#
|
|
2560
|
-
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless-v2.html
|
|
2561
|
-
# @option options [String] :network_type
|
|
2562
|
-
# The network type of the DB cluster.
|
|
2563
|
-
#
|
|
2564
|
-
# The network type is determined by the `DBSubnetGroup` specified for
|
|
2565
|
-
# the DB cluster. A `DBSubnetGroup` can support only the IPv4 protocol
|
|
2566
|
-
# or the IPv4 and the IPv6 protocols (`DUAL`).
|
|
2567
|
-
#
|
|
2568
|
-
# For more information, see [ Working with a DB instance in a VPC][1] in
|
|
2569
|
-
# the *Amazon Aurora User Guide.*
|
|
2570
|
-
#
|
|
2571
|
-
# Valid for Cluster Type: Aurora DB clusters only
|
|
2572
|
-
#
|
|
2573
|
-
# Valid Values: `IPV4 | DUAL`
|
|
2574
|
-
#
|
|
2575
|
-
#
|
|
2576
|
-
#
|
|
2577
|
-
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html
|
|
2578
2601
|
# @option options [Boolean] :manage_master_user_password
|
|
2579
2602
|
# Specifies whether to manage the master user password with Amazon Web
|
|
2580
2603
|
# Services Secrets Manager.
|
|
@@ -2627,6 +2650,12 @@ module Aws::RDS
|
|
|
2627
2650
|
#
|
|
2628
2651
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html
|
|
2629
2652
|
# [2]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/rds-secrets-manager.html
|
|
2653
|
+
# @option options [Boolean] :enable_local_write_forwarding
|
|
2654
|
+
# Specifies whether read replicas can forward write operations to the
|
|
2655
|
+
# writer DB instance in the DB cluster. By default, write operations
|
|
2656
|
+
# aren't allowed on reader DB instances.
|
|
2657
|
+
#
|
|
2658
|
+
# Valid for: Aurora DB clusters only
|
|
2630
2659
|
# @option options [String] :master_user_secret_kms_key_id
|
|
2631
2660
|
# The Amazon Web Services KMS key identifier to encrypt a secret that is
|
|
2632
2661
|
# automatically generated and managed in Amazon Web Services Secrets
|
|
@@ -2691,12 +2720,6 @@ module Aws::RDS
|
|
|
2691
2720
|
# mode.
|
|
2692
2721
|
#
|
|
2693
2722
|
# ^
|
|
2694
|
-
# @option options [Boolean] :enable_local_write_forwarding
|
|
2695
|
-
# Specifies whether read replicas can forward write operations to the
|
|
2696
|
-
# writer DB instance in the DB cluster. By default, write operations
|
|
2697
|
-
# aren't allowed on reader DB instances.
|
|
2698
|
-
#
|
|
2699
|
-
# Valid for: Aurora DB clusters only
|
|
2700
2723
|
# @option options [String] :aws_backup_recovery_point_arn
|
|
2701
2724
|
# The Amazon Resource Name (ARN) of the recovery point in Amazon Web
|
|
2702
2725
|
# Services Backup.
|
|
@@ -2723,6 +2746,21 @@ module Aws::RDS
|
|
|
2723
2746
|
#
|
|
2724
2747
|
#
|
|
2725
2748
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL.html
|
|
2749
|
+
# @option options [String] :master_user_authentication_type
|
|
2750
|
+
# Specifies the authentication type for the master user. With IAM master
|
|
2751
|
+
# user authentication, you can change the master DB user to use IAM
|
|
2752
|
+
# database authentication.
|
|
2753
|
+
#
|
|
2754
|
+
# You can specify one of the following values:
|
|
2755
|
+
#
|
|
2756
|
+
# * `password` - Use standard database authentication with a password.
|
|
2757
|
+
#
|
|
2758
|
+
# * `iam-db-auth` - Use IAM database authentication for the master user.
|
|
2759
|
+
#
|
|
2760
|
+
# Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
|
|
2761
|
+
#
|
|
2762
|
+
# This option is only valid for RDS for PostgreSQL and Aurora PostgreSQL
|
|
2763
|
+
# engines.
|
|
2726
2764
|
# @return [DBCluster]
|
|
2727
2765
|
def modify(options = {})
|
|
2728
2766
|
options = options.merge(db_cluster_identifier: @id)
|
|
@@ -2762,26 +2800,26 @@ module Aws::RDS
|
|
|
2762
2800
|
# copy_tags_to_snapshot: false,
|
|
2763
2801
|
# domain: "String",
|
|
2764
2802
|
# domain_iam_role_name: "String",
|
|
2765
|
-
# scaling_configuration: {
|
|
2766
|
-
# min_capacity: 1,
|
|
2767
|
-
# max_capacity: 1,
|
|
2768
|
-
# auto_pause: false,
|
|
2769
|
-
# seconds_until_auto_pause: 1,
|
|
2770
|
-
# timeout_action: "String",
|
|
2771
|
-
# seconds_before_timeout: 1,
|
|
2772
|
-
# },
|
|
2773
|
-
# engine_mode: "String",
|
|
2774
2803
|
# db_cluster_instance_class: "String",
|
|
2775
2804
|
# storage_type: "String",
|
|
2776
2805
|
# publicly_accessible: false,
|
|
2777
2806
|
# iops: 1,
|
|
2807
|
+
# network_type: "String",
|
|
2808
|
+
# source_db_cluster_resource_id: "String",
|
|
2778
2809
|
# serverless_v2_scaling_configuration: {
|
|
2779
2810
|
# min_capacity: 1.0,
|
|
2780
2811
|
# max_capacity: 1.0,
|
|
2781
2812
|
# seconds_until_auto_pause: 1,
|
|
2782
2813
|
# },
|
|
2783
|
-
#
|
|
2784
|
-
#
|
|
2814
|
+
# scaling_configuration: {
|
|
2815
|
+
# min_capacity: 1,
|
|
2816
|
+
# max_capacity: 1,
|
|
2817
|
+
# auto_pause: false,
|
|
2818
|
+
# seconds_until_auto_pause: 1,
|
|
2819
|
+
# timeout_action: "String",
|
|
2820
|
+
# seconds_before_timeout: 1,
|
|
2821
|
+
# },
|
|
2822
|
+
# engine_mode: "String",
|
|
2785
2823
|
# rds_custom_cluster_configuration: {
|
|
2786
2824
|
# interconnect_subnet_id: "String",
|
|
2787
2825
|
# transit_gateway_multicast_domain_id: "String",
|
|
@@ -3032,22 +3070,6 @@ module Aws::RDS
|
|
|
3032
3070
|
# Directory Service.
|
|
3033
3071
|
#
|
|
3034
3072
|
# Valid for: Aurora DB clusters only
|
|
3035
|
-
# @option options [Types::ScalingConfiguration] :scaling_configuration
|
|
3036
|
-
# For DB clusters in `serverless` DB engine mode, the scaling properties
|
|
3037
|
-
# of the DB cluster.
|
|
3038
|
-
#
|
|
3039
|
-
# Valid for: Aurora DB clusters only
|
|
3040
|
-
# @option options [String] :engine_mode
|
|
3041
|
-
# The engine mode of the new cluster. Specify `provisioned` or
|
|
3042
|
-
# `serverless`, depending on the type of the cluster you are creating.
|
|
3043
|
-
# You can create an Aurora Serverless v1 clone from a provisioned
|
|
3044
|
-
# cluster, or a provisioned clone from an Aurora Serverless v1 cluster.
|
|
3045
|
-
# To create a clone that is an Aurora Serverless v1 cluster, the
|
|
3046
|
-
# original cluster must be an Aurora Serverless v1 cluster or an
|
|
3047
|
-
# encrypted provisioned cluster. To create a full copy that is an Aurora
|
|
3048
|
-
# Serverless v1 cluster, specify the engine mode `serverless`.
|
|
3049
|
-
#
|
|
3050
|
-
# Valid for: Aurora DB clusters only
|
|
3051
3073
|
# @option options [String] :db_cluster_instance_class
|
|
3052
3074
|
# The compute and memory capacity of the each DB instance in the
|
|
3053
3075
|
# Multi-AZ DB cluster, for example db.m6gd.xlarge. Not all DB instance
|
|
@@ -3126,16 +3148,6 @@ module Aws::RDS
|
|
|
3126
3148
|
#
|
|
3127
3149
|
#
|
|
3128
3150
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html#USER_PIOPS
|
|
3129
|
-
# @option options [Types::ServerlessV2ScalingConfiguration] :serverless_v2_scaling_configuration
|
|
3130
|
-
# Contains the scaling configuration of an Aurora Serverless v2 DB
|
|
3131
|
-
# cluster.
|
|
3132
|
-
#
|
|
3133
|
-
# For more information, see [Using Amazon Aurora Serverless v2][1] in
|
|
3134
|
-
# the *Amazon Aurora User Guide*.
|
|
3135
|
-
#
|
|
3136
|
-
#
|
|
3137
|
-
#
|
|
3138
|
-
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless-v2.html
|
|
3139
3151
|
# @option options [String] :network_type
|
|
3140
3152
|
# The network type of the DB cluster.
|
|
3141
3153
|
#
|
|
@@ -3159,6 +3171,32 @@ module Aws::RDS
|
|
|
3159
3171
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html
|
|
3160
3172
|
# @option options [String] :source_db_cluster_resource_id
|
|
3161
3173
|
# The resource ID of the source DB cluster from which to restore.
|
|
3174
|
+
# @option options [Types::ServerlessV2ScalingConfiguration] :serverless_v2_scaling_configuration
|
|
3175
|
+
# Contains the scaling configuration of an Aurora Serverless v2 DB
|
|
3176
|
+
# cluster.
|
|
3177
|
+
#
|
|
3178
|
+
# For more information, see [Using Amazon Aurora Serverless v2][1] in
|
|
3179
|
+
# the *Amazon Aurora User Guide*.
|
|
3180
|
+
#
|
|
3181
|
+
#
|
|
3182
|
+
#
|
|
3183
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless-v2.html
|
|
3184
|
+
# @option options [Types::ScalingConfiguration] :scaling_configuration
|
|
3185
|
+
# For DB clusters in `serverless` DB engine mode, the scaling properties
|
|
3186
|
+
# of the DB cluster.
|
|
3187
|
+
#
|
|
3188
|
+
# Valid for: Aurora DB clusters only
|
|
3189
|
+
# @option options [String] :engine_mode
|
|
3190
|
+
# The engine mode of the new cluster. Specify `provisioned` or
|
|
3191
|
+
# `serverless`, depending on the type of the cluster you are creating.
|
|
3192
|
+
# You can create an Aurora Serverless v1 clone from a provisioned
|
|
3193
|
+
# cluster, or a provisioned clone from an Aurora Serverless v1 cluster.
|
|
3194
|
+
# To create a clone that is an Aurora Serverless v1 cluster, the
|
|
3195
|
+
# original cluster must be an Aurora Serverless v1 cluster or an
|
|
3196
|
+
# encrypted provisioned cluster. To create a full copy that is an Aurora
|
|
3197
|
+
# Serverless v1 cluster, specify the engine mode `serverless`.
|
|
3198
|
+
#
|
|
3199
|
+
# Valid for: Aurora DB clusters only
|
|
3162
3200
|
# @option options [Types::RdsCustomClusterConfiguration] :rds_custom_cluster_configuration
|
|
3163
3201
|
# Reserved for future use.
|
|
3164
3202
|
# @option options [Integer] :monitoring_interval
|