aws-sdk-rds 1.277.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 +115 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-rds/client.rb +1790 -1463
- data/lib/aws-sdk-rds/client_api.rb +244 -156
- data/lib/aws-sdk-rds/customizations.rb +0 -1
- data/lib/aws-sdk-rds/db_cluster.rb +404 -335
- 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 +452 -353
- data/lib/aws-sdk-rds/db_parameter_group.rb +2 -2
- data/lib/aws-sdk-rds/db_snapshot.rb +91 -66
- data/lib/aws-sdk-rds/db_subnet_group.rb +4 -1
- data/lib/aws-sdk-rds/endpoint_parameters.rb +4 -4
- data/lib/aws-sdk-rds/errors.rb +11 -1
- data/lib/aws-sdk-rds/option_group.rb +1 -1
- data/lib/aws-sdk-rds/resource.rb +257 -236
- data/lib/aws-sdk-rds/types.rb +1559 -1153
- data/lib/aws-sdk-rds.rb +1 -1
- data/sig/client.rbs +115 -102
- data/sig/db_cluster.rbs +72 -61
- data/sig/db_cluster_snapshot.rbs +6 -6
- data/sig/db_engine_version.rbs +21 -21
- data/sig/db_instance.rbs +50 -44
- data/sig/db_snapshot.rbs +17 -12
- data/sig/errors.rbs +2 -0
- data/sig/event.rbs +1 -1
- data/sig/resource.rbs +24 -21
- data/sig/types.rbs +140 -115
- metadata +4 -4
|
@@ -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]
|
|
@@ -480,6 +574,14 @@ module Aws::RDS
|
|
|
480
574
|
data[:tag_list]
|
|
481
575
|
end
|
|
482
576
|
|
|
577
|
+
# Contains a user-supplied global database cluster identifier. This
|
|
578
|
+
# identifier is the unique key that identifies a global database
|
|
579
|
+
# cluster.
|
|
580
|
+
# @return [String]
|
|
581
|
+
def global_cluster_identifier
|
|
582
|
+
data[:global_cluster_identifier]
|
|
583
|
+
end
|
|
584
|
+
|
|
483
585
|
# The status of write forwarding for a secondary cluster in an Aurora
|
|
484
586
|
# global database.
|
|
485
587
|
# @return [String]
|
|
@@ -497,71 +599,56 @@ module Aws::RDS
|
|
|
497
599
|
data[:global_write_forwarding_requested]
|
|
498
600
|
end
|
|
499
601
|
|
|
500
|
-
#
|
|
501
|
-
# is returned only when there are pending changes. Specific changes are
|
|
502
|
-
# identified by subelements.
|
|
503
|
-
# @return [Types::ClusterPendingModifiedValues]
|
|
504
|
-
def pending_modified_values
|
|
505
|
-
data[:pending_modified_values]
|
|
506
|
-
end
|
|
507
|
-
|
|
508
|
-
# The name of the compute and memory capacity class of the DB instance.
|
|
602
|
+
# The network type of the DB instance.
|
|
509
603
|
#
|
|
510
|
-
#
|
|
511
|
-
#
|
|
512
|
-
|
|
513
|
-
|
|
514
|
-
|
|
515
|
-
|
|
516
|
-
#
|
|
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
|
|
517
618
|
# @return [String]
|
|
518
|
-
def
|
|
519
|
-
data[:
|
|
619
|
+
def network_type
|
|
620
|
+
data[:network_type]
|
|
520
621
|
end
|
|
521
622
|
|
|
522
|
-
# The
|
|
523
|
-
#
|
|
524
|
-
|
|
525
|
-
|
|
526
|
-
def iops
|
|
527
|
-
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]
|
|
528
627
|
end
|
|
529
628
|
|
|
530
|
-
#
|
|
629
|
+
# The scaling configuration for an Aurora Serverless v2 DB cluster.
|
|
531
630
|
#
|
|
532
|
-
#
|
|
533
|
-
#
|
|
534
|
-
# Name System (DNS) endpoint resolves to the public IP address. When you
|
|
535
|
-
# connect from within the same VPC as the DB cluster, the endpoint
|
|
536
|
-
# resolves to the private IP address. Access to the DB cluster is
|
|
537
|
-
# ultimately controlled by the security group it uses. That public
|
|
538
|
-
# access isn't permitted if the security group assigned to the DB
|
|
539
|
-
# cluster doesn't permit it.
|
|
631
|
+
# For more information, see [Using Amazon Aurora Serverless v2][1] in
|
|
632
|
+
# the *Amazon Aurora User Guide*.
|
|
540
633
|
#
|
|
541
|
-
# When the DB cluster isn't publicly accessible, it is an internal DB
|
|
542
|
-
# cluster with a DNS name that resolves to a private IP address.
|
|
543
634
|
#
|
|
544
|
-
# For more information, see CreateDBCluster.
|
|
545
635
|
#
|
|
546
|
-
#
|
|
547
|
-
# @return [
|
|
548
|
-
def
|
|
549
|
-
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]
|
|
550
640
|
end
|
|
551
641
|
|
|
552
|
-
#
|
|
553
|
-
#
|
|
554
|
-
#
|
|
555
|
-
#
|
|
556
|
-
# For more information about automatic minor version upgrades, see
|
|
557
|
-
# [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*.
|
|
558
645
|
#
|
|
559
646
|
#
|
|
560
647
|
#
|
|
561
|
-
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/
|
|
562
|
-
# @return [
|
|
563
|
-
def
|
|
564
|
-
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]
|
|
565
652
|
end
|
|
566
653
|
|
|
567
654
|
# The interval, in seconds, between points when Enhanced Monitoring
|
|
@@ -628,40 +715,6 @@ module Aws::RDS
|
|
|
628
715
|
data[:performance_insights_retention_period]
|
|
629
716
|
end
|
|
630
717
|
|
|
631
|
-
# The scaling configuration for an Aurora Serverless v2 DB cluster.
|
|
632
|
-
#
|
|
633
|
-
# For more information, see [Using Amazon Aurora Serverless v2][1] in
|
|
634
|
-
# the *Amazon Aurora User Guide*.
|
|
635
|
-
#
|
|
636
|
-
#
|
|
637
|
-
#
|
|
638
|
-
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless-v2.html
|
|
639
|
-
# @return [Types::ServerlessV2ScalingConfigurationInfo]
|
|
640
|
-
def serverless_v2_scaling_configuration
|
|
641
|
-
data[:serverless_v2_scaling_configuration]
|
|
642
|
-
end
|
|
643
|
-
|
|
644
|
-
# The network type of the DB instance.
|
|
645
|
-
#
|
|
646
|
-
# The network type is determined by the `DBSubnetGroup` specified for
|
|
647
|
-
# the DB cluster. A `DBSubnetGroup` can support only the IPv4 protocol
|
|
648
|
-
# or the IPv4 and the IPv6 protocols (`DUAL`).
|
|
649
|
-
#
|
|
650
|
-
# For more information, see [ Working with a DB instance in a VPC][1] in
|
|
651
|
-
# the *Amazon Aurora User Guide.*
|
|
652
|
-
#
|
|
653
|
-
# This setting is only for Aurora DB clusters.
|
|
654
|
-
#
|
|
655
|
-
# Valid Values: `IPV4 | DUAL`
|
|
656
|
-
#
|
|
657
|
-
#
|
|
658
|
-
#
|
|
659
|
-
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html
|
|
660
|
-
# @return [String]
|
|
661
|
-
def network_type
|
|
662
|
-
data[:network_type]
|
|
663
|
-
end
|
|
664
|
-
|
|
665
718
|
# Reserved for future use.
|
|
666
719
|
# @return [String]
|
|
667
720
|
def db_system_id
|
|
@@ -685,15 +738,6 @@ module Aws::RDS
|
|
|
685
738
|
data[:master_user_secret]
|
|
686
739
|
end
|
|
687
740
|
|
|
688
|
-
# The next time you can modify the DB cluster to use the `aurora-iopt1`
|
|
689
|
-
# storage type.
|
|
690
|
-
#
|
|
691
|
-
# This setting is only for Aurora DB clusters.
|
|
692
|
-
# @return [Time]
|
|
693
|
-
def io_optimized_next_allowed_modification_time
|
|
694
|
-
data[:io_optimized_next_allowed_modification_time]
|
|
695
|
-
end
|
|
696
|
-
|
|
697
741
|
# Indicates whether an Aurora DB cluster has in-cluster write forwarding
|
|
698
742
|
# enabled, not enabled, requested, or is in the process of enabling it.
|
|
699
743
|
# @return [String]
|
|
@@ -714,16 +758,6 @@ module Aws::RDS
|
|
|
714
758
|
data[:limitless_database]
|
|
715
759
|
end
|
|
716
760
|
|
|
717
|
-
# The storage throughput for the DB cluster. The throughput is
|
|
718
|
-
# automatically set based on the IOPS that you provision, and is not
|
|
719
|
-
# configurable.
|
|
720
|
-
#
|
|
721
|
-
# This setting is only for non-Aurora Multi-AZ DB clusters.
|
|
722
|
-
# @return [Integer]
|
|
723
|
-
def storage_throughput
|
|
724
|
-
data[:storage_throughput]
|
|
725
|
-
end
|
|
726
|
-
|
|
727
761
|
# The scalability mode of the Aurora DB cluster. When set to
|
|
728
762
|
# `limitless`, the cluster operates as an Aurora Limitless Database.
|
|
729
763
|
# When set to `standard` (the default), the cluster uses normal DB
|
|
@@ -909,7 +943,7 @@ module Aws::RDS
|
|
|
909
943
|
# engine_version: "String",
|
|
910
944
|
# port: 1,
|
|
911
945
|
# master_username: "String",
|
|
912
|
-
# master_user_password: "
|
|
946
|
+
# master_user_password: "SensitiveString",
|
|
913
947
|
# option_group_name: "String",
|
|
914
948
|
# preferred_backup_window: "String",
|
|
915
949
|
# preferred_maintenance_window: "String",
|
|
@@ -922,7 +956,7 @@ module Aws::RDS
|
|
|
922
956
|
# ],
|
|
923
957
|
# storage_encrypted: false,
|
|
924
958
|
# kms_key_id: "String",
|
|
925
|
-
# pre_signed_url: "
|
|
959
|
+
# pre_signed_url: "SensitiveString",
|
|
926
960
|
# enable_iam_database_authentication: false,
|
|
927
961
|
# backtrack_window: 1,
|
|
928
962
|
# enable_cloudwatch_logs_exports: ["String"],
|
|
@@ -940,19 +974,25 @@ module Aws::RDS
|
|
|
940
974
|
# transit_gateway_multicast_domain_id: "String",
|
|
941
975
|
# replica_mode: "open-read-only", # accepts open-read-only, mounted
|
|
942
976
|
# },
|
|
943
|
-
# deletion_protection: false,
|
|
944
|
-
# global_cluster_identifier: "String",
|
|
945
|
-
# enable_http_endpoint: false,
|
|
946
|
-
# copy_tags_to_snapshot: false,
|
|
947
|
-
# domain: "String",
|
|
948
|
-
# domain_iam_role_name: "String",
|
|
949
|
-
# enable_global_write_forwarding: false,
|
|
950
977
|
# db_cluster_instance_class: "String",
|
|
951
978
|
# allocated_storage: 1,
|
|
952
979
|
# storage_type: "String",
|
|
953
980
|
# iops: 1,
|
|
954
981
|
# publicly_accessible: false,
|
|
955
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
|
+
# },
|
|
956
996
|
# monitoring_interval: 1,
|
|
957
997
|
# monitoring_role_arn: "String",
|
|
958
998
|
# database_insights_mode: "standard", # accepts standard, advanced
|
|
@@ -960,19 +1000,14 @@ module Aws::RDS
|
|
|
960
1000
|
# performance_insights_kms_key_id: "String",
|
|
961
1001
|
# performance_insights_retention_period: 1,
|
|
962
1002
|
# enable_limitless_database: false,
|
|
963
|
-
# serverless_v2_scaling_configuration: {
|
|
964
|
-
# min_capacity: 1.0,
|
|
965
|
-
# max_capacity: 1.0,
|
|
966
|
-
# seconds_until_auto_pause: 1,
|
|
967
|
-
# },
|
|
968
|
-
# network_type: "String",
|
|
969
1003
|
# cluster_scalability_type: "standard", # accepts standard, limitless
|
|
970
1004
|
# db_system_id: "String",
|
|
971
1005
|
# manage_master_user_password: false,
|
|
972
|
-
# master_user_secret_kms_key_id: "String",
|
|
973
1006
|
# enable_local_write_forwarding: false,
|
|
1007
|
+
# master_user_secret_kms_key_id: "String",
|
|
974
1008
|
# ca_certificate_identifier: "String",
|
|
975
1009
|
# engine_lifecycle_support: "String",
|
|
1010
|
+
# master_user_authentication_type: "password", # accepts password, iam-db-auth
|
|
976
1011
|
# source_region: "String",
|
|
977
1012
|
# })
|
|
978
1013
|
# @param [Hash] options ({})
|
|
@@ -980,8 +1015,18 @@ module Aws::RDS
|
|
|
980
1015
|
# A list of Availability Zones (AZs) where you specifically want to
|
|
981
1016
|
# create DB instances in the DB cluster.
|
|
982
1017
|
#
|
|
983
|
-
# For
|
|
984
|
-
#
|
|
1018
|
+
# For the first three DB instances that you create, RDS distributes each
|
|
1019
|
+
# DB instance to a different AZ that you specify. For additional DB
|
|
1020
|
+
# instances that you create, RDS randomly distributes them to the AZs
|
|
1021
|
+
# that you specified. For example, if you create a DB cluster with one
|
|
1022
|
+
# writer instance and three reader instances, RDS might distribute the
|
|
1023
|
+
# writer instance to AZ 1, the first reader instance to AZ 2, the second
|
|
1024
|
+
# reader instance to AZ 3, and the third reader instance to either AZ 1,
|
|
1025
|
+
# AZ 2, or AZ 3.
|
|
1026
|
+
#
|
|
1027
|
+
# For more information, see [Availability Zones][1] and [High
|
|
1028
|
+
# availability for Aurora DB instances][2] in the *Amazon Aurora User
|
|
1029
|
+
# Guide*.
|
|
985
1030
|
#
|
|
986
1031
|
# Valid for Cluster Type: Aurora DB clusters only
|
|
987
1032
|
#
|
|
@@ -994,6 +1039,7 @@ module Aws::RDS
|
|
|
994
1039
|
#
|
|
995
1040
|
#
|
|
996
1041
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Concepts.RegionsAndAvailabilityZones.html#Concepts.RegionsAndAvailabilityZones.AvailabilityZones
|
|
1042
|
+
# [2]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Concepts.AuroraHighAvailability.html#Concepts.AuroraHighAvailability.Instances
|
|
997
1043
|
# @option options [Integer] :backup_retention_period
|
|
998
1044
|
# The number of days for which automated backups are retained.
|
|
999
1045
|
#
|
|
@@ -1395,73 +1441,6 @@ module Aws::RDS
|
|
|
1395
1441
|
# Valid for Cluster Type: Aurora DB clusters only
|
|
1396
1442
|
# @option options [Types::RdsCustomClusterConfiguration] :rds_custom_cluster_configuration
|
|
1397
1443
|
# Reserved for future use.
|
|
1398
|
-
# @option options [Boolean] :deletion_protection
|
|
1399
|
-
# Specifies whether the DB cluster has deletion protection enabled. The
|
|
1400
|
-
# database can't be deleted when deletion protection is enabled. By
|
|
1401
|
-
# default, deletion protection isn't enabled.
|
|
1402
|
-
#
|
|
1403
|
-
# Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
|
|
1404
|
-
# @option options [String] :global_cluster_identifier
|
|
1405
|
-
# The global cluster ID of an Aurora cluster that becomes the primary
|
|
1406
|
-
# cluster in the new global database cluster.
|
|
1407
|
-
#
|
|
1408
|
-
# Valid for Cluster Type: Aurora DB clusters only
|
|
1409
|
-
# @option options [Boolean] :enable_http_endpoint
|
|
1410
|
-
# Specifies whether to enable the HTTP endpoint for the DB cluster. By
|
|
1411
|
-
# default, the HTTP endpoint isn't enabled.
|
|
1412
|
-
#
|
|
1413
|
-
# When enabled, the HTTP endpoint provides a connectionless web service
|
|
1414
|
-
# API (RDS Data API) for running SQL queries on the DB cluster. You can
|
|
1415
|
-
# also query your database from inside the RDS console with the RDS
|
|
1416
|
-
# query editor.
|
|
1417
|
-
#
|
|
1418
|
-
# For more information, see [Using RDS Data API][1] in the *Amazon
|
|
1419
|
-
# Aurora User Guide*.
|
|
1420
|
-
#
|
|
1421
|
-
# Valid for Cluster Type: Aurora DB clusters only
|
|
1422
|
-
#
|
|
1423
|
-
#
|
|
1424
|
-
#
|
|
1425
|
-
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/data-api.html
|
|
1426
|
-
# @option options [Boolean] :copy_tags_to_snapshot
|
|
1427
|
-
# Specifies whether to copy all tags from the DB cluster to snapshots of
|
|
1428
|
-
# the DB cluster. The default is not to copy them.
|
|
1429
|
-
#
|
|
1430
|
-
# Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
|
|
1431
|
-
# @option options [String] :domain
|
|
1432
|
-
# The Active Directory directory ID to create the DB cluster in.
|
|
1433
|
-
#
|
|
1434
|
-
# For Amazon Aurora DB clusters, Amazon RDS can use Kerberos
|
|
1435
|
-
# authentication to authenticate users that connect to the DB cluster.
|
|
1436
|
-
#
|
|
1437
|
-
# For more information, see [Kerberos authentication][1] in the *Amazon
|
|
1438
|
-
# Aurora User Guide*.
|
|
1439
|
-
#
|
|
1440
|
-
# Valid for Cluster Type: Aurora DB clusters only
|
|
1441
|
-
#
|
|
1442
|
-
#
|
|
1443
|
-
#
|
|
1444
|
-
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/kerberos-authentication.html
|
|
1445
|
-
# @option options [String] :domain_iam_role_name
|
|
1446
|
-
# The name of the IAM role to use when making API calls to the Directory
|
|
1447
|
-
# Service.
|
|
1448
|
-
#
|
|
1449
|
-
# Valid for Cluster Type: Aurora DB clusters only
|
|
1450
|
-
# @option options [Boolean] :enable_global_write_forwarding
|
|
1451
|
-
# Specifies whether to enable this DB cluster to forward write
|
|
1452
|
-
# operations to the primary cluster of a global cluster (Aurora global
|
|
1453
|
-
# database). By default, write operations are not allowed on Aurora DB
|
|
1454
|
-
# clusters that are secondary clusters in an Aurora global database.
|
|
1455
|
-
#
|
|
1456
|
-
# You can set this value only on Aurora DB clusters that are members of
|
|
1457
|
-
# an Aurora global database. With this parameter enabled, a secondary
|
|
1458
|
-
# cluster can forward writes to the current primary cluster, and the
|
|
1459
|
-
# resulting changes are replicated back to this cluster. For the primary
|
|
1460
|
-
# DB cluster of an Aurora global database, this value is used
|
|
1461
|
-
# immediately if the primary is demoted by a global cluster API
|
|
1462
|
-
# operation, but it does nothing until then.
|
|
1463
|
-
#
|
|
1464
|
-
# Valid for Cluster Type: Aurora DB clusters only
|
|
1465
1444
|
# @option options [String] :db_cluster_instance_class
|
|
1466
1445
|
# The compute and memory capacity of each DB instance in the Multi-AZ DB
|
|
1467
1446
|
# cluster, for example `db.m6gd.xlarge`. Not all DB instance classes are
|
|
@@ -1547,53 +1526,138 @@ module Aws::RDS
|
|
|
1547
1526
|
# @option options [Boolean] :publicly_accessible
|
|
1548
1527
|
# Specifies whether the DB cluster is publicly accessible.
|
|
1549
1528
|
#
|
|
1529
|
+
# Valid for Cluster Type: Multi-AZ DB clusters only
|
|
1530
|
+
#
|
|
1550
1531
|
# When the DB cluster is publicly accessible and you connect from
|
|
1551
|
-
# outside of the DB cluster's virtual private cloud (VPC), its
|
|
1552
|
-
#
|
|
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
|
|
1553
1534
|
# connect from within the same VPC as the DB cluster, the endpoint
|
|
1554
1535
|
# resolves to the private IP address. Access to the DB cluster is
|
|
1555
|
-
#
|
|
1556
|
-
# access isn't permitted if the security group assigned to the DB
|
|
1557
|
-
# cluster doesn't permit it.
|
|
1536
|
+
# controlled by its security group settings.
|
|
1558
1537
|
#
|
|
1559
1538
|
# When the DB cluster isn't publicly accessible, it is an internal DB
|
|
1560
1539
|
# cluster with a DNS name that resolves to a private IP address.
|
|
1561
1540
|
#
|
|
1562
|
-
#
|
|
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.
|
|
1563
1632
|
#
|
|
1564
|
-
#
|
|
1565
|
-
#
|
|
1633
|
+
# Valid for Cluster Type: Aurora DB clusters only
|
|
1634
|
+
# @option options [String] :network_type
|
|
1635
|
+
# The network type of the DB cluster.
|
|
1566
1636
|
#
|
|
1567
|
-
#
|
|
1568
|
-
#
|
|
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`).
|
|
1569
1640
|
#
|
|
1570
|
-
#
|
|
1571
|
-
#
|
|
1641
|
+
# For more information, see [ Working with a DB instance in a VPC][1] in
|
|
1642
|
+
# the *Amazon Aurora User Guide.*
|
|
1572
1643
|
#
|
|
1573
|
-
#
|
|
1574
|
-
# attached to it, the DB cluster is public.
|
|
1644
|
+
# Valid for Cluster Type: Aurora DB clusters only
|
|
1575
1645
|
#
|
|
1576
|
-
#
|
|
1577
|
-
# specified, the following applies:
|
|
1646
|
+
# Valid Values: `IPV4 | DUAL`
|
|
1578
1647
|
#
|
|
1579
|
-
# * If the subnets are part of a VPC that doesn’t have an internet
|
|
1580
|
-
# gateway attached to it, the DB cluster is private.
|
|
1581
1648
|
#
|
|
1582
|
-
# * If the subnets are part of a VPC that has an internet gateway
|
|
1583
|
-
# attached to it, the DB cluster is public.
|
|
1584
|
-
# @option options [Boolean] :auto_minor_version_upgrade
|
|
1585
|
-
# Specifies whether minor engine upgrades are applied automatically to
|
|
1586
|
-
# the DB cluster during the maintenance window. By default, minor engine
|
|
1587
|
-
# upgrades are applied automatically.
|
|
1588
1649
|
#
|
|
1589
|
-
#
|
|
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.
|
|
1590
1654
|
#
|
|
1591
|
-
# For more information
|
|
1592
|
-
#
|
|
1655
|
+
# For more information, see [Using Amazon Aurora Serverless v2][1] in
|
|
1656
|
+
# the *Amazon Aurora User Guide*.
|
|
1593
1657
|
#
|
|
1594
1658
|
#
|
|
1595
1659
|
#
|
|
1596
|
-
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/
|
|
1660
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless-v2.html
|
|
1597
1661
|
# @option options [Integer] :monitoring_interval
|
|
1598
1662
|
# The interval, in seconds, between points when Enhanced Monitoring
|
|
1599
1663
|
# metrics are collected for the DB cluster. To turn off collecting
|
|
@@ -1683,33 +1747,6 @@ module Aws::RDS
|
|
|
1683
1747
|
# `ClusterScalabilityType` setting.
|
|
1684
1748
|
#
|
|
1685
1749
|
# </note>
|
|
1686
|
-
# @option options [Types::ServerlessV2ScalingConfiguration] :serverless_v2_scaling_configuration
|
|
1687
|
-
# Contains the scaling configuration of an Aurora Serverless v2 DB
|
|
1688
|
-
# cluster.
|
|
1689
|
-
#
|
|
1690
|
-
# For more information, see [Using Amazon Aurora Serverless v2][1] in
|
|
1691
|
-
# the *Amazon Aurora User Guide*.
|
|
1692
|
-
#
|
|
1693
|
-
#
|
|
1694
|
-
#
|
|
1695
|
-
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless-v2.html
|
|
1696
|
-
# @option options [String] :network_type
|
|
1697
|
-
# The network type of the DB cluster.
|
|
1698
|
-
#
|
|
1699
|
-
# The network type is determined by the `DBSubnetGroup` specified for
|
|
1700
|
-
# the DB cluster. A `DBSubnetGroup` can support only the IPv4 protocol
|
|
1701
|
-
# or the IPv4 and the IPv6 protocols (`DUAL`).
|
|
1702
|
-
#
|
|
1703
|
-
# For more information, see [ Working with a DB instance in a VPC][1] in
|
|
1704
|
-
# the *Amazon Aurora User Guide.*
|
|
1705
|
-
#
|
|
1706
|
-
# Valid for Cluster Type: Aurora DB clusters only
|
|
1707
|
-
#
|
|
1708
|
-
# Valid Values: `IPV4 | DUAL`
|
|
1709
|
-
#
|
|
1710
|
-
#
|
|
1711
|
-
#
|
|
1712
|
-
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html
|
|
1713
1750
|
# @option options [String] :cluster_scalability_type
|
|
1714
1751
|
# Specifies the scalability mode of the Aurora DB cluster. When set to
|
|
1715
1752
|
# `limitless`, the cluster operates as an Aurora Limitless Database.
|
|
@@ -1745,6 +1782,12 @@ module Aws::RDS
|
|
|
1745
1782
|
#
|
|
1746
1783
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html
|
|
1747
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
|
|
1748
1791
|
# @option options [String] :master_user_secret_kms_key_id
|
|
1749
1792
|
# The Amazon Web Services KMS key identifier to encrypt a secret that is
|
|
1750
1793
|
# automatically generated and managed in Amazon Web Services Secrets
|
|
@@ -1769,12 +1812,6 @@ module Aws::RDS
|
|
|
1769
1812
|
# Amazon Web Services Region.
|
|
1770
1813
|
#
|
|
1771
1814
|
# Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
|
|
1772
|
-
# @option options [Boolean] :enable_local_write_forwarding
|
|
1773
|
-
# Specifies whether read replicas can forward write operations to the
|
|
1774
|
-
# writer DB instance in the DB cluster. By default, write operations
|
|
1775
|
-
# aren't allowed on reader DB instances.
|
|
1776
|
-
#
|
|
1777
|
-
# Valid for: Aurora DB clusters only
|
|
1778
1815
|
# @option options [String] :ca_certificate_identifier
|
|
1779
1816
|
# The CA certificate identifier to use for the DB cluster's server
|
|
1780
1817
|
# certificate.
|
|
@@ -1822,6 +1859,21 @@ module Aws::RDS
|
|
|
1822
1859
|
#
|
|
1823
1860
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/extended-support.html
|
|
1824
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.
|
|
1825
1877
|
# @option options [String] :source_region
|
|
1826
1878
|
# The source region of the snapshot. This is only needed when the
|
|
1827
1879
|
# shapshot is encrypted and in a different region.
|
|
@@ -1971,7 +2023,7 @@ module Aws::RDS
|
|
|
1971
2023
|
# db_cluster_parameter_group_name: "String",
|
|
1972
2024
|
# vpc_security_group_ids: ["String"],
|
|
1973
2025
|
# port: 1,
|
|
1974
|
-
# master_user_password: "
|
|
2026
|
+
# master_user_password: "SensitiveString",
|
|
1975
2027
|
# option_group_name: "String",
|
|
1976
2028
|
# preferred_backup_window: "String",
|
|
1977
2029
|
# preferred_maintenance_window: "String",
|
|
@@ -2003,27 +2055,28 @@ module Aws::RDS
|
|
|
2003
2055
|
# storage_type: "String",
|
|
2004
2056
|
# iops: 1,
|
|
2005
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
|
+
# },
|
|
2006
2064
|
# monitoring_interval: 1,
|
|
2007
2065
|
# monitoring_role_arn: "String",
|
|
2008
2066
|
# database_insights_mode: "standard", # accepts standard, advanced
|
|
2009
2067
|
# enable_performance_insights: false,
|
|
2010
2068
|
# performance_insights_kms_key_id: "String",
|
|
2011
2069
|
# performance_insights_retention_period: 1,
|
|
2012
|
-
# serverless_v2_scaling_configuration: {
|
|
2013
|
-
# min_capacity: 1.0,
|
|
2014
|
-
# max_capacity: 1.0,
|
|
2015
|
-
# seconds_until_auto_pause: 1,
|
|
2016
|
-
# },
|
|
2017
|
-
# network_type: "String",
|
|
2018
2070
|
# manage_master_user_password: false,
|
|
2019
2071
|
# rotate_master_user_password: false,
|
|
2072
|
+
# enable_local_write_forwarding: false,
|
|
2020
2073
|
# master_user_secret_kms_key_id: "String",
|
|
2021
2074
|
# engine_mode: "String",
|
|
2022
2075
|
# allow_engine_mode_change: false,
|
|
2023
|
-
# enable_local_write_forwarding: false,
|
|
2024
2076
|
# aws_backup_recovery_point_arn: "AwsBackupRecoveryPointArn",
|
|
2025
2077
|
# enable_limitless_database: false,
|
|
2026
2078
|
# ca_certificate_identifier: "String",
|
|
2079
|
+
# master_user_authentication_type: "password", # accepts password, iam-db-auth
|
|
2027
2080
|
# })
|
|
2028
2081
|
# @param [Hash] options ({})
|
|
2029
2082
|
# @option options [String] :new_db_cluster_identifier
|
|
@@ -2435,6 +2488,33 @@ module Aws::RDS
|
|
|
2435
2488
|
#
|
|
2436
2489
|
#
|
|
2437
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
|
|
2438
2518
|
# @option options [Integer] :monitoring_interval
|
|
2439
2519
|
# The interval, in seconds, between points when Enhanced Monitoring
|
|
2440
2520
|
# metrics are collected for the DB cluster. To turn off collecting
|
|
@@ -2470,8 +2550,9 @@ module Aws::RDS
|
|
|
2470
2550
|
# the `PerformanceInsightsEnabled` parameter to `true` and the
|
|
2471
2551
|
# `PerformanceInsightsRetentionPeriod` parameter to 465.
|
|
2472
2552
|
#
|
|
2473
|
-
# If you change the value from `advanced` to `standard`, you
|
|
2474
|
-
#
|
|
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.
|
|
2475
2556
|
#
|
|
2476
2557
|
# Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
|
|
2477
2558
|
# @option options [Boolean] :enable_performance_insights
|
|
@@ -2517,33 +2598,6 @@ module Aws::RDS
|
|
|
2517
2598
|
#
|
|
2518
2599
|
# If you specify a retention period that isn't valid, such as `94`,
|
|
2519
2600
|
# Amazon RDS issues an error.
|
|
2520
|
-
# @option options [Types::ServerlessV2ScalingConfiguration] :serverless_v2_scaling_configuration
|
|
2521
|
-
# Contains the scaling configuration of an Aurora Serverless v2 DB
|
|
2522
|
-
# cluster.
|
|
2523
|
-
#
|
|
2524
|
-
# For more information, see [Using Amazon Aurora Serverless v2][1] in
|
|
2525
|
-
# the *Amazon Aurora User Guide*.
|
|
2526
|
-
#
|
|
2527
|
-
#
|
|
2528
|
-
#
|
|
2529
|
-
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless-v2.html
|
|
2530
|
-
# @option options [String] :network_type
|
|
2531
|
-
# The network type of the DB cluster.
|
|
2532
|
-
#
|
|
2533
|
-
# The network type is determined by the `DBSubnetGroup` specified for
|
|
2534
|
-
# the DB cluster. A `DBSubnetGroup` can support only the IPv4 protocol
|
|
2535
|
-
# or the IPv4 and the IPv6 protocols (`DUAL`).
|
|
2536
|
-
#
|
|
2537
|
-
# For more information, see [ Working with a DB instance in a VPC][1] in
|
|
2538
|
-
# the *Amazon Aurora User Guide.*
|
|
2539
|
-
#
|
|
2540
|
-
# Valid for Cluster Type: Aurora DB clusters only
|
|
2541
|
-
#
|
|
2542
|
-
# Valid Values: `IPV4 | DUAL`
|
|
2543
|
-
#
|
|
2544
|
-
#
|
|
2545
|
-
#
|
|
2546
|
-
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html
|
|
2547
2601
|
# @option options [Boolean] :manage_master_user_password
|
|
2548
2602
|
# Specifies whether to manage the master user password with Amazon Web
|
|
2549
2603
|
# Services Secrets Manager.
|
|
@@ -2596,6 +2650,12 @@ module Aws::RDS
|
|
|
2596
2650
|
#
|
|
2597
2651
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html
|
|
2598
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
|
|
2599
2659
|
# @option options [String] :master_user_secret_kms_key_id
|
|
2600
2660
|
# The Amazon Web Services KMS key identifier to encrypt a secret that is
|
|
2601
2661
|
# automatically generated and managed in Amazon Web Services Secrets
|
|
@@ -2660,12 +2720,6 @@ module Aws::RDS
|
|
|
2660
2720
|
# mode.
|
|
2661
2721
|
#
|
|
2662
2722
|
# ^
|
|
2663
|
-
# @option options [Boolean] :enable_local_write_forwarding
|
|
2664
|
-
# Specifies whether read replicas can forward write operations to the
|
|
2665
|
-
# writer DB instance in the DB cluster. By default, write operations
|
|
2666
|
-
# aren't allowed on reader DB instances.
|
|
2667
|
-
#
|
|
2668
|
-
# Valid for: Aurora DB clusters only
|
|
2669
2723
|
# @option options [String] :aws_backup_recovery_point_arn
|
|
2670
2724
|
# The Amazon Resource Name (ARN) of the recovery point in Amazon Web
|
|
2671
2725
|
# Services Backup.
|
|
@@ -2692,6 +2746,21 @@ module Aws::RDS
|
|
|
2692
2746
|
#
|
|
2693
2747
|
#
|
|
2694
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.
|
|
2695
2764
|
# @return [DBCluster]
|
|
2696
2765
|
def modify(options = {})
|
|
2697
2766
|
options = options.merge(db_cluster_identifier: @id)
|
|
@@ -2731,26 +2800,26 @@ module Aws::RDS
|
|
|
2731
2800
|
# copy_tags_to_snapshot: false,
|
|
2732
2801
|
# domain: "String",
|
|
2733
2802
|
# domain_iam_role_name: "String",
|
|
2734
|
-
# scaling_configuration: {
|
|
2735
|
-
# min_capacity: 1,
|
|
2736
|
-
# max_capacity: 1,
|
|
2737
|
-
# auto_pause: false,
|
|
2738
|
-
# seconds_until_auto_pause: 1,
|
|
2739
|
-
# timeout_action: "String",
|
|
2740
|
-
# seconds_before_timeout: 1,
|
|
2741
|
-
# },
|
|
2742
|
-
# engine_mode: "String",
|
|
2743
2803
|
# db_cluster_instance_class: "String",
|
|
2744
2804
|
# storage_type: "String",
|
|
2745
2805
|
# publicly_accessible: false,
|
|
2746
2806
|
# iops: 1,
|
|
2807
|
+
# network_type: "String",
|
|
2808
|
+
# source_db_cluster_resource_id: "String",
|
|
2747
2809
|
# serverless_v2_scaling_configuration: {
|
|
2748
2810
|
# min_capacity: 1.0,
|
|
2749
2811
|
# max_capacity: 1.0,
|
|
2750
2812
|
# seconds_until_auto_pause: 1,
|
|
2751
2813
|
# },
|
|
2752
|
-
#
|
|
2753
|
-
#
|
|
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",
|
|
2754
2823
|
# rds_custom_cluster_configuration: {
|
|
2755
2824
|
# interconnect_subnet_id: "String",
|
|
2756
2825
|
# transit_gateway_multicast_domain_id: "String",
|
|
@@ -3001,22 +3070,6 @@ module Aws::RDS
|
|
|
3001
3070
|
# Directory Service.
|
|
3002
3071
|
#
|
|
3003
3072
|
# Valid for: Aurora DB clusters only
|
|
3004
|
-
# @option options [Types::ScalingConfiguration] :scaling_configuration
|
|
3005
|
-
# For DB clusters in `serverless` DB engine mode, the scaling properties
|
|
3006
|
-
# of the DB cluster.
|
|
3007
|
-
#
|
|
3008
|
-
# Valid for: Aurora DB clusters only
|
|
3009
|
-
# @option options [String] :engine_mode
|
|
3010
|
-
# The engine mode of the new cluster. Specify `provisioned` or
|
|
3011
|
-
# `serverless`, depending on the type of the cluster you are creating.
|
|
3012
|
-
# You can create an Aurora Serverless v1 clone from a provisioned
|
|
3013
|
-
# cluster, or a provisioned clone from an Aurora Serverless v1 cluster.
|
|
3014
|
-
# To create a clone that is an Aurora Serverless v1 cluster, the
|
|
3015
|
-
# original cluster must be an Aurora Serverless v1 cluster or an
|
|
3016
|
-
# encrypted provisioned cluster. To create a full copy that is an Aurora
|
|
3017
|
-
# Serverless v1 cluster, specify the engine mode `serverless`.
|
|
3018
|
-
#
|
|
3019
|
-
# Valid for: Aurora DB clusters only
|
|
3020
3073
|
# @option options [String] :db_cluster_instance_class
|
|
3021
3074
|
# The compute and memory capacity of the each DB instance in the
|
|
3022
3075
|
# Multi-AZ DB cluster, for example db.m6gd.xlarge. Not all DB instance
|
|
@@ -3095,16 +3148,6 @@ module Aws::RDS
|
|
|
3095
3148
|
#
|
|
3096
3149
|
#
|
|
3097
3150
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html#USER_PIOPS
|
|
3098
|
-
# @option options [Types::ServerlessV2ScalingConfiguration] :serverless_v2_scaling_configuration
|
|
3099
|
-
# Contains the scaling configuration of an Aurora Serverless v2 DB
|
|
3100
|
-
# cluster.
|
|
3101
|
-
#
|
|
3102
|
-
# For more information, see [Using Amazon Aurora Serverless v2][1] in
|
|
3103
|
-
# the *Amazon Aurora User Guide*.
|
|
3104
|
-
#
|
|
3105
|
-
#
|
|
3106
|
-
#
|
|
3107
|
-
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless-v2.html
|
|
3108
3151
|
# @option options [String] :network_type
|
|
3109
3152
|
# The network type of the DB cluster.
|
|
3110
3153
|
#
|
|
@@ -3128,6 +3171,32 @@ module Aws::RDS
|
|
|
3128
3171
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html
|
|
3129
3172
|
# @option options [String] :source_db_cluster_resource_id
|
|
3130
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
|
|
3131
3200
|
# @option options [Types::RdsCustomClusterConfiguration] :rds_custom_cluster_configuration
|
|
3132
3201
|
# Reserved for future use.
|
|
3133
3202
|
# @option options [Integer] :monitoring_interval
|