aws-sdk-rds 1.131.0 → 1.132.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 +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-rds/client.rb +1429 -297
- data/lib/aws-sdk-rds/client_api.rb +59 -0
- data/lib/aws-sdk-rds/db_cluster.rb +727 -65
- data/lib/aws-sdk-rds/db_cluster_parameter_group.rb +12 -0
- data/lib/aws-sdk-rds/db_cluster_snapshot.rb +166 -14
- data/lib/aws-sdk-rds/db_instance.rb +76 -69
- data/lib/aws-sdk-rds/db_snapshot.rb +12 -11
- data/lib/aws-sdk-rds/resource.rb +345 -57
- data/lib/aws-sdk-rds/types.rb +1652 -258
- data/lib/aws-sdk-rds.rb +1 -1
- metadata +2 -2
@@ -486,6 +486,108 @@ module Aws::RDS
|
|
486
486
|
data[:pending_modified_values]
|
487
487
|
end
|
488
488
|
|
489
|
+
# The name of the compute and memory capacity class of the DB instance.
|
490
|
+
#
|
491
|
+
# This setting is only for non-Aurora Multi-AZ DB clusters.
|
492
|
+
# @return [String]
|
493
|
+
def db_cluster_instance_class
|
494
|
+
data[:db_cluster_instance_class]
|
495
|
+
end
|
496
|
+
|
497
|
+
# The storage type associated with DB instance.
|
498
|
+
#
|
499
|
+
# This setting is only for non-Aurora Multi-AZ DB clusters.
|
500
|
+
# @return [String]
|
501
|
+
def storage_type
|
502
|
+
data[:storage_type]
|
503
|
+
end
|
504
|
+
|
505
|
+
# The Provisioned IOPS (I/O operations per second) value.
|
506
|
+
#
|
507
|
+
# This setting is only for non-Aurora Multi-AZ DB clusters.
|
508
|
+
# @return [Integer]
|
509
|
+
def iops
|
510
|
+
data[:iops]
|
511
|
+
end
|
512
|
+
|
513
|
+
# Specifies the accessibility options for the DB instance.
|
514
|
+
#
|
515
|
+
# When the DB instance is publicly accessible, its Domain Name System
|
516
|
+
# (DNS) endpoint resolves to the private IP address from within the DB
|
517
|
+
# instance's virtual private cloud (VPC). It resolves to the public IP
|
518
|
+
# address from outside of the DB instance's VPC. Access to the DB
|
519
|
+
# instance is ultimately controlled by the security group it uses. That
|
520
|
+
# public access is not permitted if the security group assigned to the
|
521
|
+
# DB instance doesn't permit it.
|
522
|
+
#
|
523
|
+
# When the DB instance isn't publicly accessible, it is an internal DB
|
524
|
+
# instance with a DNS name that resolves to a private IP address.
|
525
|
+
#
|
526
|
+
# For more information, see CreateDBInstance.
|
527
|
+
#
|
528
|
+
# This setting is only for non-Aurora Multi-AZ DB clusters.
|
529
|
+
# @return [Boolean]
|
530
|
+
def publicly_accessible
|
531
|
+
data[:publicly_accessible]
|
532
|
+
end
|
533
|
+
|
534
|
+
# A value that indicates that minor version patches are applied
|
535
|
+
# automatically.
|
536
|
+
#
|
537
|
+
# This setting is only for non-Aurora Multi-AZ DB clusters.
|
538
|
+
# @return [Boolean]
|
539
|
+
def auto_minor_version_upgrade
|
540
|
+
data[:auto_minor_version_upgrade]
|
541
|
+
end
|
542
|
+
|
543
|
+
# The interval, in seconds, between points when Enhanced Monitoring
|
544
|
+
# metrics are collected for the DB cluster.
|
545
|
+
#
|
546
|
+
# This setting is only for non-Aurora Multi-AZ DB clusters.
|
547
|
+
# @return [Integer]
|
548
|
+
def monitoring_interval
|
549
|
+
data[:monitoring_interval]
|
550
|
+
end
|
551
|
+
|
552
|
+
# The ARN for the IAM role that permits RDS to send Enhanced Monitoring
|
553
|
+
# metrics to Amazon CloudWatch Logs.
|
554
|
+
#
|
555
|
+
# This setting is only for non-Aurora Multi-AZ DB clusters.
|
556
|
+
# @return [String]
|
557
|
+
def monitoring_role_arn
|
558
|
+
data[:monitoring_role_arn]
|
559
|
+
end
|
560
|
+
|
561
|
+
# True if Performance Insights is enabled for the DB cluster, and
|
562
|
+
# otherwise false.
|
563
|
+
#
|
564
|
+
# This setting is only for non-Aurora Multi-AZ DB clusters.
|
565
|
+
# @return [Boolean]
|
566
|
+
def performance_insights_enabled
|
567
|
+
data[:performance_insights_enabled]
|
568
|
+
end
|
569
|
+
|
570
|
+
# The Amazon Web Services KMS key identifier for encryption of
|
571
|
+
# Performance Insights data.
|
572
|
+
#
|
573
|
+
# The Amazon Web Services KMS key identifier is the key ARN, key ID,
|
574
|
+
# alias ARN, or alias name for the KMS key.
|
575
|
+
#
|
576
|
+
# This setting is only for non-Aurora Multi-AZ DB clusters.
|
577
|
+
# @return [String]
|
578
|
+
def performance_insights_kms_key_id
|
579
|
+
data[:performance_insights_kms_key_id]
|
580
|
+
end
|
581
|
+
|
582
|
+
# The amount of time, in days, to retain Performance Insights data.
|
583
|
+
# Valid values are 7 or 731 (2 years).
|
584
|
+
#
|
585
|
+
# This setting is only for non-Aurora Multi-AZ DB clusters.
|
586
|
+
# @return [Integer]
|
587
|
+
def performance_insights_retention_period
|
588
|
+
data[:performance_insights_retention_period]
|
589
|
+
end
|
590
|
+
|
489
591
|
# @!endgroup
|
490
592
|
|
491
593
|
# @return [Client]
|
@@ -667,14 +769,29 @@ module Aws::RDS
|
|
667
769
|
# domain: "String",
|
668
770
|
# domain_iam_role_name: "String",
|
669
771
|
# enable_global_write_forwarding: false,
|
772
|
+
# db_cluster_instance_class: "String",
|
773
|
+
# allocated_storage: 1,
|
774
|
+
# storage_type: "String",
|
775
|
+
# iops: 1,
|
776
|
+
# publicly_accessible: false,
|
777
|
+
# auto_minor_version_upgrade: false,
|
778
|
+
# monitoring_interval: 1,
|
779
|
+
# monitoring_role_arn: "String",
|
780
|
+
# enable_performance_insights: false,
|
781
|
+
# performance_insights_kms_key_id: "String",
|
782
|
+
# performance_insights_retention_period: 1,
|
670
783
|
# source_region: "String",
|
671
784
|
# })
|
672
785
|
# @param [Hash] options ({})
|
673
786
|
# @option options [Array<String>] :availability_zones
|
674
|
-
# A list of Availability Zones (AZs) where instances in the DB
|
675
|
-
# can be created.
|
676
|
-
#
|
677
|
-
#
|
787
|
+
# A list of Availability Zones (AZs) where DB instances in the DB
|
788
|
+
# cluster can be created.
|
789
|
+
#
|
790
|
+
# For information on Amazon Web Services Regions and Availability Zones,
|
791
|
+
# see [Choosing the Regions and Availability Zones][1] in the *Amazon
|
792
|
+
# Aurora User Guide*.
|
793
|
+
#
|
794
|
+
# Valid for: Aurora DB clusters only
|
678
795
|
#
|
679
796
|
#
|
680
797
|
#
|
@@ -689,13 +806,19 @@ module Aws::RDS
|
|
689
806
|
# * Must be a value from 1 to 35
|
690
807
|
#
|
691
808
|
# ^
|
809
|
+
#
|
810
|
+
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
692
811
|
# @option options [String] :character_set_name
|
693
812
|
# A value that indicates that the DB cluster should be associated with
|
694
813
|
# the specified CharacterSet.
|
814
|
+
#
|
815
|
+
# Valid for: Aurora DB clusters only
|
695
816
|
# @option options [String] :database_name
|
696
817
|
# The name for your database of up to 64 alphanumeric characters. If you
|
697
818
|
# do not provide a name, Amazon RDS doesn't create a database in the DB
|
698
819
|
# cluster you are creating.
|
820
|
+
#
|
821
|
+
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
699
822
|
# @option options [String] :db_cluster_parameter_group_name
|
700
823
|
# The name of the DB cluster parameter group to associate with this DB
|
701
824
|
# cluster. If you do not specify a value, then the default DB cluster
|
@@ -707,56 +830,117 @@ module Aws::RDS
|
|
707
830
|
# group.
|
708
831
|
#
|
709
832
|
# ^
|
833
|
+
#
|
834
|
+
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
710
835
|
# @option options [Array<String>] :vpc_security_group_ids
|
711
836
|
# A list of EC2 VPC security groups to associate with this DB cluster.
|
837
|
+
#
|
838
|
+
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
712
839
|
# @option options [String] :db_subnet_group_name
|
713
840
|
# A DB subnet group to associate with this DB cluster.
|
714
841
|
#
|
842
|
+
# This setting is required to create a Multi-AZ DB cluster.
|
843
|
+
#
|
715
844
|
# Constraints: Must match the name of an existing DBSubnetGroup. Must
|
716
845
|
# not be default.
|
717
846
|
#
|
718
847
|
# Example: `mySubnetgroup`
|
848
|
+
#
|
849
|
+
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
719
850
|
# @option options [required, String] :engine
|
720
851
|
# The name of the database engine to be used for this DB cluster.
|
721
852
|
#
|
722
|
-
# Valid Values:
|
723
|
-
#
|
724
|
-
# `aurora-
|
853
|
+
# Valid Values:
|
854
|
+
#
|
855
|
+
# * `aurora` (for MySQL 5.6-compatible Aurora)
|
856
|
+
#
|
857
|
+
# * `aurora-mysql` (for MySQL 5.7-compatible Aurora)
|
858
|
+
#
|
859
|
+
# * `aurora-postgresql`
|
860
|
+
#
|
861
|
+
# * `mysql`
|
862
|
+
#
|
863
|
+
# * `postgres`
|
864
|
+
#
|
865
|
+
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
725
866
|
# @option options [String] :engine_version
|
726
867
|
# The version number of the database engine to use.
|
727
868
|
#
|
728
|
-
# To list all of the available engine versions for
|
729
|
-
#
|
869
|
+
# To list all of the available engine versions for MySQL 5.6-compatible
|
870
|
+
# Aurora, use the following command:
|
730
871
|
#
|
731
872
|
# `aws rds describe-db-engine-versions --engine aurora --query
|
732
873
|
# "DBEngineVersions[].EngineVersion"`
|
733
874
|
#
|
734
|
-
# To list all of the available engine versions for
|
735
|
-
#
|
875
|
+
# To list all of the available engine versions for MySQL 5.7-compatible
|
876
|
+
# Aurora, use the following command:
|
736
877
|
#
|
737
878
|
# `aws rds describe-db-engine-versions --engine aurora-mysql --query
|
738
879
|
# "DBEngineVersions[].EngineVersion"`
|
739
880
|
#
|
740
|
-
# To list all of the available engine versions for
|
881
|
+
# To list all of the available engine versions for Aurora PostgreSQL,
|
741
882
|
# use the following command:
|
742
883
|
#
|
743
884
|
# `aws rds describe-db-engine-versions --engine aurora-postgresql
|
744
885
|
# --query "DBEngineVersions[].EngineVersion"`
|
745
886
|
#
|
887
|
+
# To list all of the available engine versions for RDS for MySQL, use
|
888
|
+
# the following command:
|
889
|
+
#
|
890
|
+
# `aws rds describe-db-engine-versions --engine mysql --query
|
891
|
+
# "DBEngineVersions[].EngineVersion"`
|
892
|
+
#
|
893
|
+
# To list all of the available engine versions for RDS for PostgreSQL,
|
894
|
+
# use the following command:
|
895
|
+
#
|
896
|
+
# `aws rds describe-db-engine-versions --engine postgres --query
|
897
|
+
# "DBEngineVersions[].EngineVersion"`
|
898
|
+
#
|
746
899
|
# **Aurora MySQL**
|
747
900
|
#
|
748
|
-
#
|
749
|
-
#
|
901
|
+
# For information, see [MySQL on Amazon RDS Versions][1] in the *Amazon
|
902
|
+
# Aurora User Guide.*
|
750
903
|
#
|
751
904
|
# **Aurora PostgreSQL**
|
752
905
|
#
|
753
|
-
#
|
906
|
+
# For information, see [Amazon Aurora PostgreSQL releases and engine
|
907
|
+
# versions][2] in the *Amazon Aurora User Guide.*
|
908
|
+
#
|
909
|
+
# **MySQL**
|
910
|
+
#
|
911
|
+
# For information, see [MySQL on Amazon RDS Versions][3] in the *Amazon
|
912
|
+
# RDS User Guide.*
|
913
|
+
#
|
914
|
+
# **PostgreSQL**
|
915
|
+
#
|
916
|
+
# For information, see [Amazon RDS for PostgreSQL versions and
|
917
|
+
# extensions][4] in the *Amazon RDS User Guide.*
|
918
|
+
#
|
919
|
+
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
920
|
+
#
|
921
|
+
#
|
922
|
+
#
|
923
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraMySQL.Updates.html
|
924
|
+
# [2]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraPostgreSQL.Updates.20180305.html
|
925
|
+
# [3]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MySQL.html#MySQL.Concepts.VersionMgmt
|
926
|
+
# [4]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_PostgreSQL.html#PostgreSQL.Concepts
|
754
927
|
# @option options [Integer] :port
|
755
928
|
# The port number on which the instances in the DB cluster accept
|
756
929
|
# connections.
|
757
930
|
#
|
758
|
-
#
|
759
|
-
#
|
931
|
+
# **RDS for MySQL and Aurora MySQL**
|
932
|
+
#
|
933
|
+
# Default: `3306`
|
934
|
+
#
|
935
|
+
# Valid values: `1150-65535`
|
936
|
+
#
|
937
|
+
# **RDS for PostgreSQL and Aurora PostgreSQL**
|
938
|
+
#
|
939
|
+
# Default: `5432`
|
940
|
+
#
|
941
|
+
# Valid values: `1150-65535`
|
942
|
+
#
|
943
|
+
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
760
944
|
# @option options [String] :master_username
|
761
945
|
# The name of the master user for the DB cluster.
|
762
946
|
#
|
@@ -767,18 +951,21 @@ module Aws::RDS
|
|
767
951
|
# * First character must be a letter.
|
768
952
|
#
|
769
953
|
# * Can't be a reserved word for the chosen database engine.
|
954
|
+
#
|
955
|
+
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
770
956
|
# @option options [String] :master_user_password
|
771
957
|
# The password for the master database user. This password can contain
|
772
958
|
# any printable ASCII character except "/", """, or "@".
|
773
959
|
#
|
774
960
|
# Constraints: Must contain from 8 to 41 characters.
|
961
|
+
#
|
962
|
+
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
775
963
|
# @option options [String] :option_group_name
|
776
964
|
# A value that indicates that the DB cluster should be associated with
|
777
965
|
# the specified option group.
|
778
966
|
#
|
779
|
-
#
|
780
|
-
#
|
781
|
-
# DB cluster.
|
967
|
+
# DB clusters are associated with a default option group that can't be
|
968
|
+
# modified.
|
782
969
|
# @option options [String] :preferred_backup_window
|
783
970
|
# The daily time range during which automated backups are created if
|
784
971
|
# automated backups are enabled using the `BackupRetentionPeriod`
|
@@ -799,6 +986,8 @@ module Aws::RDS
|
|
799
986
|
#
|
800
987
|
# * Must be at least 30 minutes.
|
801
988
|
#
|
989
|
+
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
990
|
+
#
|
802
991
|
#
|
803
992
|
#
|
804
993
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Managing.Backups.html#Aurora.Managing.Backups.BackupWindow
|
@@ -818,16 +1007,24 @@ module Aws::RDS
|
|
818
1007
|
#
|
819
1008
|
# Constraints: Minimum 30-minute window.
|
820
1009
|
#
|
1010
|
+
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
1011
|
+
#
|
821
1012
|
#
|
822
1013
|
#
|
823
1014
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_UpgradeDBInstance.Maintenance.html#AdjustingTheMaintenanceWindow.Aurora
|
824
1015
|
# @option options [String] :replication_source_identifier
|
825
1016
|
# The Amazon Resource Name (ARN) of the source DB instance or DB cluster
|
826
1017
|
# if this DB cluster is created as a read replica.
|
1018
|
+
#
|
1019
|
+
# Valid for: Aurora DB clusters only
|
827
1020
|
# @option options [Array<Types::Tag>] :tags
|
828
1021
|
# Tags to assign to the DB cluster.
|
1022
|
+
#
|
1023
|
+
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
829
1024
|
# @option options [Boolean] :storage_encrypted
|
830
1025
|
# A value that indicates whether the DB cluster is encrypted.
|
1026
|
+
#
|
1027
|
+
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
831
1028
|
# @option options [String] :kms_key_id
|
832
1029
|
# The Amazon Web Services KMS key identifier for an encrypted DB
|
833
1030
|
# cluster.
|
@@ -856,12 +1053,14 @@ module Aws::RDS
|
|
856
1053
|
# identifier that is valid in the destination Amazon Web Services
|
857
1054
|
# Region. This KMS key is used to encrypt the read replica in that
|
858
1055
|
# Amazon Web Services Region.
|
1056
|
+
#
|
1057
|
+
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
859
1058
|
# @option options [String] :pre_signed_url
|
860
1059
|
# A URL that contains a Signature Version 4 signed request for the
|
861
1060
|
# `CreateDBCluster` action to be called in the source Amazon Web
|
862
|
-
# Services Region where the DB cluster is replicated from.
|
863
|
-
#
|
864
|
-
#
|
1061
|
+
# Services Region where the DB cluster is replicated from. Specify
|
1062
|
+
# `PreSignedUrl` only when you are performing cross-Region replication
|
1063
|
+
# from an encrypted DB cluster.
|
865
1064
|
#
|
866
1065
|
# The pre-signed URL must be a valid request for the `CreateDBCluster`
|
867
1066
|
# API action that can be executed in the source Amazon Web Services
|
@@ -902,6 +1101,8 @@ module Aws::RDS
|
|
902
1101
|
#
|
903
1102
|
# </note>
|
904
1103
|
#
|
1104
|
+
# Valid for: Aurora DB clusters only
|
1105
|
+
#
|
905
1106
|
#
|
906
1107
|
#
|
907
1108
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/API/sigv4-query-string-auth.html
|
@@ -909,11 +1110,13 @@ module Aws::RDS
|
|
909
1110
|
# @option options [Boolean] :enable_iam_database_authentication
|
910
1111
|
# A value that indicates whether to enable mapping of Amazon Web
|
911
1112
|
# Services Identity and Access Management (IAM) accounts to database
|
912
|
-
# accounts. By default, mapping
|
1113
|
+
# accounts. By default, mapping isn't enabled.
|
913
1114
|
#
|
914
1115
|
# For more information, see [ IAM Database Authentication][1] in the
|
915
1116
|
# *Amazon Aurora User Guide.*
|
916
1117
|
#
|
1118
|
+
# Valid for: Aurora DB clusters only
|
1119
|
+
#
|
917
1120
|
#
|
918
1121
|
#
|
919
1122
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.IAMDBAuth.html
|
@@ -921,10 +1124,6 @@ module Aws::RDS
|
|
921
1124
|
# The target backtrack window, in seconds. To disable backtracking, set
|
922
1125
|
# this value to 0.
|
923
1126
|
#
|
924
|
-
# <note markdown="1"> Currently, Backtrack is only supported for Aurora MySQL DB clusters.
|
925
|
-
#
|
926
|
-
# </note>
|
927
|
-
#
|
928
1127
|
# Default: 0
|
929
1128
|
#
|
930
1129
|
# Constraints:
|
@@ -933,6 +1132,8 @@ module Aws::RDS
|
|
933
1132
|
# (72 hours).
|
934
1133
|
#
|
935
1134
|
# ^
|
1135
|
+
#
|
1136
|
+
# Valid for: Aurora MySQL DB clusters only
|
936
1137
|
# @option options [Array<String>] :enable_cloudwatch_logs_exports
|
937
1138
|
# The list of log types that need to be enabled for exporting to
|
938
1139
|
# CloudWatch Logs. The values in the list depend on the DB engine being
|
@@ -947,6 +1148,8 @@ module Aws::RDS
|
|
947
1148
|
#
|
948
1149
|
# Possible value is `postgresql`.
|
949
1150
|
#
|
1151
|
+
# Valid for: Aurora DB clusters only
|
1152
|
+
#
|
950
1153
|
#
|
951
1154
|
#
|
952
1155
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch
|
@@ -981,6 +1184,8 @@ module Aws::RDS
|
|
981
1184
|
#
|
982
1185
|
# * [ Limitations of Multi-Master Clusters][4]
|
983
1186
|
#
|
1187
|
+
# Valid for: Aurora DB clusters only
|
1188
|
+
#
|
984
1189
|
#
|
985
1190
|
#
|
986
1191
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless.html#aurora-serverless.limitations
|
@@ -990,13 +1195,19 @@ module Aws::RDS
|
|
990
1195
|
# @option options [Types::ScalingConfiguration] :scaling_configuration
|
991
1196
|
# For DB clusters in `serverless` DB engine mode, the scaling properties
|
992
1197
|
# of the DB cluster.
|
1198
|
+
#
|
1199
|
+
# Valid for: Aurora DB clusters only
|
993
1200
|
# @option options [Boolean] :deletion_protection
|
994
1201
|
# A value that indicates whether the DB cluster has deletion protection
|
995
1202
|
# enabled. The database can't be deleted when deletion protection is
|
996
|
-
# enabled. By default, deletion protection
|
1203
|
+
# enabled. By default, deletion protection isn't enabled.
|
1204
|
+
#
|
1205
|
+
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
997
1206
|
# @option options [String] :global_cluster_identifier
|
998
1207
|
# The global cluster ID of an Aurora cluster that becomes the primary
|
999
1208
|
# cluster in the new global database cluster.
|
1209
|
+
#
|
1210
|
+
# Valid for: Aurora DB clusters only
|
1000
1211
|
# @option options [Boolean] :enable_http_endpoint
|
1001
1212
|
# A value that indicates whether to enable the HTTP endpoint for an
|
1002
1213
|
# Aurora Serverless DB cluster. By default, the HTTP endpoint is
|
@@ -1010,26 +1221,35 @@ module Aws::RDS
|
|
1010
1221
|
# For more information, see [Using the Data API for Aurora
|
1011
1222
|
# Serverless][1] in the *Amazon Aurora User Guide*.
|
1012
1223
|
#
|
1224
|
+
# Valid for: Aurora DB clusters only
|
1225
|
+
#
|
1013
1226
|
#
|
1014
1227
|
#
|
1015
1228
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/data-api.html
|
1016
1229
|
# @option options [Boolean] :copy_tags_to_snapshot
|
1017
1230
|
# A value that indicates whether to copy all tags from the DB cluster to
|
1018
1231
|
# snapshots of the DB cluster. The default is not to copy them.
|
1232
|
+
#
|
1233
|
+
# Valid for: Aurora DB clusters only
|
1019
1234
|
# @option options [String] :domain
|
1020
1235
|
# The Active Directory directory ID to create the DB cluster in.
|
1021
1236
|
#
|
1022
1237
|
# For Amazon Aurora DB clusters, Amazon RDS can use Kerberos
|
1023
|
-
#
|
1024
|
-
#
|
1238
|
+
# authentication to authenticate users that connect to the DB cluster.
|
1239
|
+
#
|
1240
|
+
# For more information, see [Kerberos authentication][1] in the *Amazon
|
1025
1241
|
# Aurora User Guide*.
|
1026
1242
|
#
|
1243
|
+
# Valid for: Aurora DB clusters only
|
1244
|
+
#
|
1027
1245
|
#
|
1028
1246
|
#
|
1029
1247
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/kerberos-authentication.html
|
1030
1248
|
# @option options [String] :domain_iam_role_name
|
1031
1249
|
# Specify the name of the IAM role to be used when making API calls to
|
1032
1250
|
# the Directory Service.
|
1251
|
+
#
|
1252
|
+
# Valid for: Aurora DB clusters only
|
1033
1253
|
# @option options [Boolean] :enable_global_write_forwarding
|
1034
1254
|
# A value that indicates whether to enable this DB cluster to forward
|
1035
1255
|
# write operations to the primary cluster of an Aurora global database
|
@@ -1044,6 +1264,160 @@ module Aws::RDS
|
|
1044
1264
|
# DB cluster of an Aurora global database, this value is used
|
1045
1265
|
# immediately if the primary is demoted by the FailoverGlobalCluster API
|
1046
1266
|
# operation, but it does nothing until then.
|
1267
|
+
#
|
1268
|
+
# Valid for: Aurora DB clusters only
|
1269
|
+
# @option options [String] :db_cluster_instance_class
|
1270
|
+
# The compute and memory capacity of each DB instance in the Multi-AZ DB
|
1271
|
+
# cluster, for example db.m6g.xlarge. Not all DB instance classes are
|
1272
|
+
# available in all Amazon Web Services Regions, or for all database
|
1273
|
+
# engines.
|
1274
|
+
#
|
1275
|
+
# For the full list of DB instance classes and availability for your
|
1276
|
+
# engine, see [DB instance class][1] in the *Amazon RDS User Guide.*
|
1277
|
+
#
|
1278
|
+
# This setting is required to create a Multi-AZ DB cluster.
|
1279
|
+
#
|
1280
|
+
# Valid for: Multi-AZ DB clusters only
|
1281
|
+
#
|
1282
|
+
#
|
1283
|
+
#
|
1284
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html
|
1285
|
+
# @option options [Integer] :allocated_storage
|
1286
|
+
# The amount of storage in gibibytes (GiB) to allocate to each DB
|
1287
|
+
# instance in the Multi-AZ DB cluster.
|
1288
|
+
#
|
1289
|
+
# This setting is required to create a Multi-AZ DB cluster.
|
1290
|
+
#
|
1291
|
+
# Valid for: Multi-AZ DB clusters only
|
1292
|
+
# @option options [String] :storage_type
|
1293
|
+
# Specifies the storage type to be associated with the DB cluster.
|
1294
|
+
#
|
1295
|
+
# This setting is required to create a Multi-AZ DB cluster.
|
1296
|
+
#
|
1297
|
+
# Valid values: `standard | gp2 | io1`
|
1298
|
+
#
|
1299
|
+
# If you specify `io1`, also include a value for the `Iops` parameter.
|
1300
|
+
#
|
1301
|
+
# Default: `io1` if the `Iops` parameter is specified, otherwise `gp2`
|
1302
|
+
#
|
1303
|
+
# Valid for: Multi-AZ DB clusters only
|
1304
|
+
# @option options [Integer] :iops
|
1305
|
+
# The amount of Provisioned IOPS (input/output operations per second) to
|
1306
|
+
# be initially allocated for each DB instance in the Multi-AZ DB
|
1307
|
+
# cluster.
|
1308
|
+
#
|
1309
|
+
# For information about valid `Iops` values, see [Amazon RDS Provisioned
|
1310
|
+
# IOPS storage to improve performance][1] in the *Amazon RDS User
|
1311
|
+
# Guide*.
|
1312
|
+
#
|
1313
|
+
# This setting is required to create a Multi-AZ DB cluster.
|
1314
|
+
#
|
1315
|
+
# Constraints: Must be a multiple between .5 and 50 of the storage
|
1316
|
+
# amount for the DB cluster.
|
1317
|
+
#
|
1318
|
+
# Valid for: Multi-AZ DB clusters only
|
1319
|
+
#
|
1320
|
+
#
|
1321
|
+
#
|
1322
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html#USER_PIOPS
|
1323
|
+
# @option options [Boolean] :publicly_accessible
|
1324
|
+
# A value that indicates whether the DB cluster is publicly accessible.
|
1325
|
+
#
|
1326
|
+
# When the DB cluster is publicly accessible, its Domain Name System
|
1327
|
+
# (DNS) endpoint resolves to the private IP address from within the DB
|
1328
|
+
# cluster's virtual private cloud (VPC). It resolves to the public IP
|
1329
|
+
# address from outside of the DB cluster's VPC. Access to the DB
|
1330
|
+
# cluster is ultimately controlled by the security group it uses. That
|
1331
|
+
# public access isn't permitted if the security group assigned to the
|
1332
|
+
# DB cluster doesn't permit it.
|
1333
|
+
#
|
1334
|
+
# When the DB cluster isn't publicly accessible, it is an internal DB
|
1335
|
+
# cluster with a DNS name that resolves to a private IP address.
|
1336
|
+
#
|
1337
|
+
# Default: The default behavior varies depending on whether
|
1338
|
+
# `DBSubnetGroupName` is specified.
|
1339
|
+
#
|
1340
|
+
# If `DBSubnetGroupName` isn't specified, and `PubliclyAccessible`
|
1341
|
+
# isn't specified, the following applies:
|
1342
|
+
#
|
1343
|
+
# * If the default VPC in the target Region doesn’t have an internet
|
1344
|
+
# gateway attached to it, the DB cluster is private.
|
1345
|
+
#
|
1346
|
+
# * If the default VPC in the target Region has an internet gateway
|
1347
|
+
# attached to it, the DB cluster is public.
|
1348
|
+
#
|
1349
|
+
# If `DBSubnetGroupName` is specified, and `PubliclyAccessible` isn't
|
1350
|
+
# specified, the following applies:
|
1351
|
+
#
|
1352
|
+
# * If the subnets are part of a VPC that doesn’t have an internet
|
1353
|
+
# gateway attached to it, the DB cluster is private.
|
1354
|
+
#
|
1355
|
+
# * If the subnets are part of a VPC that has an internet gateway
|
1356
|
+
# attached to it, the DB cluster is public.
|
1357
|
+
#
|
1358
|
+
# Valid for: Multi-AZ DB clusters only
|
1359
|
+
# @option options [Boolean] :auto_minor_version_upgrade
|
1360
|
+
# A value that indicates whether minor engine upgrades are applied
|
1361
|
+
# automatically to the DB cluster during the maintenance window. By
|
1362
|
+
# default, minor engine upgrades are applied automatically.
|
1363
|
+
#
|
1364
|
+
# Valid for: Multi-AZ DB clusters only
|
1365
|
+
# @option options [Integer] :monitoring_interval
|
1366
|
+
# The interval, in seconds, between points when Enhanced Monitoring
|
1367
|
+
# metrics are collected for the DB cluster. To turn off collecting
|
1368
|
+
# Enhanced Monitoring metrics, specify 0. The default is 0.
|
1369
|
+
#
|
1370
|
+
# If `MonitoringRoleArn` is specified, also set `MonitoringInterval` to
|
1371
|
+
# a value other than 0.
|
1372
|
+
#
|
1373
|
+
# Valid Values: `0, 1, 5, 10, 15, 30, 60`
|
1374
|
+
#
|
1375
|
+
# Valid for: Multi-AZ DB clusters only
|
1376
|
+
# @option options [String] :monitoring_role_arn
|
1377
|
+
# The Amazon Resource Name (ARN) for the IAM role that permits RDS to
|
1378
|
+
# send Enhanced Monitoring metrics to Amazon CloudWatch Logs. An example
|
1379
|
+
# is `arn:aws:iam:123456789012:role/emaccess`. For information on
|
1380
|
+
# creating a monitoring role, see [Setting up and enabling Enhanced
|
1381
|
+
# Monitoring][1] in the *Amazon RDS User Guide*.
|
1382
|
+
#
|
1383
|
+
# If `MonitoringInterval` is set to a value other than 0, supply a
|
1384
|
+
# `MonitoringRoleArn` value.
|
1385
|
+
#
|
1386
|
+
# Valid for: Multi-AZ DB clusters only
|
1387
|
+
#
|
1388
|
+
#
|
1389
|
+
#
|
1390
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Monitoring.OS.html#USER_Monitoring.OS.Enabling
|
1391
|
+
# @option options [Boolean] :enable_performance_insights
|
1392
|
+
# A value that indicates whether to turn on Performance Insights for the
|
1393
|
+
# DB cluster.
|
1394
|
+
#
|
1395
|
+
# For more information, see [ Using Amazon Performance Insights][1] in
|
1396
|
+
# the *Amazon RDS User Guide*.
|
1397
|
+
#
|
1398
|
+
# Valid for: Multi-AZ DB clusters only
|
1399
|
+
#
|
1400
|
+
#
|
1401
|
+
#
|
1402
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html
|
1403
|
+
# @option options [String] :performance_insights_kms_key_id
|
1404
|
+
# The Amazon Web Services KMS key identifier for encryption of
|
1405
|
+
# Performance Insights data.
|
1406
|
+
#
|
1407
|
+
# The Amazon Web Services KMS key identifier is the key ARN, key ID,
|
1408
|
+
# alias ARN, or alias name for the KMS key.
|
1409
|
+
#
|
1410
|
+
# If you don't specify a value for `PerformanceInsightsKMSKeyId`, then
|
1411
|
+
# Amazon RDS uses your default KMS key. There is a default KMS key for
|
1412
|
+
# your Amazon Web Services account. Your Amazon Web Services account has
|
1413
|
+
# a different default KMS key for each Amazon Web Services Region.
|
1414
|
+
#
|
1415
|
+
# Valid for: Multi-AZ DB clusters only
|
1416
|
+
# @option options [Integer] :performance_insights_retention_period
|
1417
|
+
# The amount of time, in days, to retain Performance Insights data.
|
1418
|
+
# Valid values are 7 or 731 (2 years).
|
1419
|
+
#
|
1420
|
+
# Valid for: Multi-AZ DB clusters only
|
1047
1421
|
# @option options [String] :source_region
|
1048
1422
|
# The source region of the snapshot. This is only needed when the
|
1049
1423
|
# shapshot is encrypted and in a different region.
|
@@ -1151,10 +1525,13 @@ module Aws::RDS
|
|
1151
1525
|
# })
|
1152
1526
|
# @param [Hash] options ({})
|
1153
1527
|
# @option options [String] :target_db_instance_identifier
|
1154
|
-
# The name of the instance to promote to the primary instance.
|
1528
|
+
# The name of the DB instance to promote to the primary DB instance.
|
1155
1529
|
#
|
1156
|
-
#
|
1157
|
-
# DB cluster
|
1530
|
+
# Specify the DB instance identifier for an Aurora Replica or a Multi-AZ
|
1531
|
+
# readable standby in the DB cluster, for example
|
1532
|
+
# `mydbcluster-replica1`.
|
1533
|
+
#
|
1534
|
+
# This setting isn't supported for RDS for MySQL Multi-AZ DB clusters.
|
1158
1535
|
# @return [DBCluster]
|
1159
1536
|
def failover(options = {})
|
1160
1537
|
options = options.merge(db_cluster_identifier: @id)
|
@@ -1202,6 +1579,16 @@ module Aws::RDS
|
|
1202
1579
|
# enable_http_endpoint: false,
|
1203
1580
|
# copy_tags_to_snapshot: false,
|
1204
1581
|
# enable_global_write_forwarding: false,
|
1582
|
+
# db_cluster_instance_class: "String",
|
1583
|
+
# allocated_storage: 1,
|
1584
|
+
# storage_type: "String",
|
1585
|
+
# iops: 1,
|
1586
|
+
# auto_minor_version_upgrade: false,
|
1587
|
+
# monitoring_interval: 1,
|
1588
|
+
# monitoring_role_arn: "String",
|
1589
|
+
# enable_performance_insights: false,
|
1590
|
+
# performance_insights_kms_key_id: "String",
|
1591
|
+
# performance_insights_retention_period: 1,
|
1205
1592
|
# })
|
1206
1593
|
# @param [Hash] options ({})
|
1207
1594
|
# @option options [String] :new_db_cluster_identifier
|
@@ -1217,6 +1604,8 @@ module Aws::RDS
|
|
1217
1604
|
# * Can't end with a hyphen or contain two consecutive hyphens
|
1218
1605
|
#
|
1219
1606
|
# Example: `my-cluster2`
|
1607
|
+
#
|
1608
|
+
# Valid for: Aurora DB clusters only
|
1220
1609
|
# @option options [Boolean] :apply_immediately
|
1221
1610
|
# A value that indicates whether the modifications in this request and
|
1222
1611
|
# any pending modifications are asynchronously applied as soon as
|
@@ -1234,9 +1623,11 @@ module Aws::RDS
|
|
1234
1623
|
# parameter.
|
1235
1624
|
#
|
1236
1625
|
# By default, this parameter is disabled.
|
1626
|
+
#
|
1627
|
+
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
1237
1628
|
# @option options [Integer] :backup_retention_period
|
1238
|
-
# The number of days for which automated backups are retained.
|
1239
|
-
#
|
1629
|
+
# The number of days for which automated backups are retained. Specify a
|
1630
|
+
# minimum value of 1.
|
1240
1631
|
#
|
1241
1632
|
# Default: 1
|
1242
1633
|
#
|
@@ -1245,34 +1636,37 @@ module Aws::RDS
|
|
1245
1636
|
# * Must be a value from 1 to 35
|
1246
1637
|
#
|
1247
1638
|
# ^
|
1639
|
+
#
|
1640
|
+
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
1248
1641
|
# @option options [String] :db_cluster_parameter_group_name
|
1249
1642
|
# The name of the DB cluster parameter group to use for the DB cluster.
|
1643
|
+
#
|
1644
|
+
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
1250
1645
|
# @option options [Array<String>] :vpc_security_group_ids
|
1251
1646
|
# A list of VPC security groups that the DB cluster will belong to.
|
1647
|
+
#
|
1648
|
+
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
1252
1649
|
# @option options [Integer] :port
|
1253
1650
|
# The port number on which the DB cluster accepts connections.
|
1254
1651
|
#
|
1255
1652
|
# Constraints: Value must be `1150-65535`
|
1256
1653
|
#
|
1257
1654
|
# Default: The same port as the original DB cluster.
|
1655
|
+
#
|
1656
|
+
# Valid for: Aurora DB clusters only
|
1258
1657
|
# @option options [String] :master_user_password
|
1259
1658
|
# The new password for the master database user. This password can
|
1260
1659
|
# contain any printable ASCII character except "/", """, or "@".
|
1261
1660
|
#
|
1262
1661
|
# Constraints: Must contain from 8 to 41 characters.
|
1662
|
+
#
|
1663
|
+
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
1263
1664
|
# @option options [String] :option_group_name
|
1264
1665
|
# A value that indicates that the DB cluster should be associated with
|
1265
|
-
# the specified option group.
|
1266
|
-
#
|
1267
|
-
#
|
1268
|
-
#
|
1269
|
-
# group that enables OEM, this change can cause a brief (sub-second)
|
1270
|
-
# period during which new connections are rejected but existing
|
1271
|
-
# connections are not interrupted.
|
1272
|
-
#
|
1273
|
-
# Permanent options can't be removed from an option group. The option
|
1274
|
-
# group can't be removed from a DB cluster once it is associated with a
|
1275
|
-
# DB cluster.
|
1666
|
+
# the specified option group.
|
1667
|
+
#
|
1668
|
+
# DB clusters are associated with a default option group that can't be
|
1669
|
+
# modified.
|
1276
1670
|
# @option options [String] :preferred_backup_window
|
1277
1671
|
# The daily time range during which automated backups are created if
|
1278
1672
|
# automated backups are enabled, using the `BackupRetentionPeriod`
|
@@ -1293,6 +1687,8 @@ module Aws::RDS
|
|
1293
1687
|
#
|
1294
1688
|
# * Must be at least 30 minutes.
|
1295
1689
|
#
|
1690
|
+
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
1691
|
+
#
|
1296
1692
|
#
|
1297
1693
|
#
|
1298
1694
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Managing.Backups.html#Aurora.Managing.Backups.BackupWindow
|
@@ -1312,17 +1708,21 @@ module Aws::RDS
|
|
1312
1708
|
#
|
1313
1709
|
# Constraints: Minimum 30-minute window.
|
1314
1710
|
#
|
1711
|
+
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
1712
|
+
#
|
1315
1713
|
#
|
1316
1714
|
#
|
1317
1715
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_UpgradeDBInstance.Maintenance.html#AdjustingTheMaintenanceWindow.Aurora
|
1318
1716
|
# @option options [Boolean] :enable_iam_database_authentication
|
1319
1717
|
# A value that indicates whether to enable mapping of Amazon Web
|
1320
1718
|
# Services Identity and Access Management (IAM) accounts to database
|
1321
|
-
# accounts. By default, mapping
|
1719
|
+
# accounts. By default, mapping isn't enabled.
|
1322
1720
|
#
|
1323
1721
|
# For more information, see [ IAM Database Authentication][1] in the
|
1324
1722
|
# *Amazon Aurora User Guide.*
|
1325
1723
|
#
|
1724
|
+
# Valid for: Aurora DB clusters only
|
1725
|
+
#
|
1326
1726
|
#
|
1327
1727
|
#
|
1328
1728
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.IAMDBAuth.html
|
@@ -1330,10 +1730,6 @@ module Aws::RDS
|
|
1330
1730
|
# The target backtrack window, in seconds. To disable backtracking, set
|
1331
1731
|
# this value to 0.
|
1332
1732
|
#
|
1333
|
-
# <note markdown="1"> Currently, Backtrack is only supported for Aurora MySQL DB clusters.
|
1334
|
-
#
|
1335
|
-
# </note>
|
1336
|
-
#
|
1337
1733
|
# Default: 0
|
1338
1734
|
#
|
1339
1735
|
# Constraints:
|
@@ -1342,38 +1738,58 @@ module Aws::RDS
|
|
1342
1738
|
# (72 hours).
|
1343
1739
|
#
|
1344
1740
|
# ^
|
1741
|
+
#
|
1742
|
+
# Valid for: Aurora MySQL DB clusters only
|
1345
1743
|
# @option options [Types::CloudwatchLogsExportConfiguration] :cloudwatch_logs_export_configuration
|
1346
1744
|
# The configuration setting for the log types to be enabled for export
|
1347
1745
|
# to CloudWatch Logs for a specific DB cluster.
|
1746
|
+
#
|
1747
|
+
# Valid for: Aurora DB clusters only
|
1348
1748
|
# @option options [String] :engine_version
|
1349
1749
|
# The version number of the database engine to which you want to
|
1350
1750
|
# upgrade. Changing this parameter results in an outage. The change is
|
1351
1751
|
# applied during the next maintenance window unless `ApplyImmediately`
|
1352
1752
|
# is enabled.
|
1353
1753
|
#
|
1354
|
-
# To list all of the available engine versions for
|
1355
|
-
#
|
1754
|
+
# To list all of the available engine versions for MySQL 5.6-compatible
|
1755
|
+
# Aurora, use the following command:
|
1356
1756
|
#
|
1357
1757
|
# `aws rds describe-db-engine-versions --engine aurora --query
|
1358
1758
|
# "DBEngineVersions[].EngineVersion"`
|
1359
1759
|
#
|
1360
|
-
# To list all of the available engine versions for
|
1361
|
-
#
|
1760
|
+
# To list all of the available engine versions for MySQL 5.7-compatible
|
1761
|
+
# Aurora, use the following command:
|
1362
1762
|
#
|
1363
1763
|
# `aws rds describe-db-engine-versions --engine aurora-mysql --query
|
1364
1764
|
# "DBEngineVersions[].EngineVersion"`
|
1365
1765
|
#
|
1366
|
-
# To list all of the available engine versions for
|
1766
|
+
# To list all of the available engine versions for Aurora PostgreSQL,
|
1367
1767
|
# use the following command:
|
1368
1768
|
#
|
1369
1769
|
# `aws rds describe-db-engine-versions --engine aurora-postgresql
|
1370
1770
|
# --query "DBEngineVersions[].EngineVersion"`
|
1771
|
+
#
|
1772
|
+
# To list all of the available engine versions for RDS for MySQL, use
|
1773
|
+
# the following command:
|
1774
|
+
#
|
1775
|
+
# `aws rds describe-db-engine-versions --engine mysql --query
|
1776
|
+
# "DBEngineVersions[].EngineVersion"`
|
1777
|
+
#
|
1778
|
+
# To list all of the available engine versions for RDS for PostgreSQL,
|
1779
|
+
# use the following command:
|
1780
|
+
#
|
1781
|
+
# `aws rds describe-db-engine-versions --engine postgres --query
|
1782
|
+
# "DBEngineVersions[].EngineVersion"`
|
1783
|
+
#
|
1784
|
+
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
1371
1785
|
# @option options [Boolean] :allow_major_version_upgrade
|
1372
1786
|
# A value that indicates whether major version upgrades are allowed.
|
1373
1787
|
#
|
1374
1788
|
# Constraints: You must allow major version upgrades when specifying a
|
1375
1789
|
# value for the `EngineVersion` parameter that is a different major
|
1376
1790
|
# version than the DB cluster's current version.
|
1791
|
+
#
|
1792
|
+
# Valid for: Aurora DB clusters only
|
1377
1793
|
# @option options [String] :db_instance_parameter_group_name
|
1378
1794
|
# The name of the DB parameter group to apply to all instances of the DB
|
1379
1795
|
# cluster.
|
@@ -1394,6 +1810,8 @@ module Aws::RDS
|
|
1394
1810
|
#
|
1395
1811
|
# * The `DBInstanceParameterGroupName` parameter is only valid in
|
1396
1812
|
# combination with the `AllowMajorVersionUpgrade` parameter.
|
1813
|
+
#
|
1814
|
+
# Valid for: Aurora DB clusters only
|
1397
1815
|
# @option options [String] :domain
|
1398
1816
|
# The Active Directory directory ID to move the DB cluster to. Specify
|
1399
1817
|
# `none` to remove the cluster from its current domain. The domain must
|
@@ -1402,19 +1820,27 @@ module Aws::RDS
|
|
1402
1820
|
# For more information, see [Kerberos Authentication][1] in the *Amazon
|
1403
1821
|
# Aurora User Guide*.
|
1404
1822
|
#
|
1823
|
+
# Valid for: Aurora DB clusters only
|
1824
|
+
#
|
1405
1825
|
#
|
1406
1826
|
#
|
1407
1827
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/kerberos-authentication.html
|
1408
1828
|
# @option options [String] :domain_iam_role_name
|
1409
1829
|
# Specify the name of the IAM role to be used when making API calls to
|
1410
1830
|
# the Directory Service.
|
1831
|
+
#
|
1832
|
+
# Valid for: Aurora DB clusters only
|
1411
1833
|
# @option options [Types::ScalingConfiguration] :scaling_configuration
|
1412
1834
|
# The scaling properties of the DB cluster. You can only modify scaling
|
1413
1835
|
# properties for DB clusters in `serverless` DB engine mode.
|
1836
|
+
#
|
1837
|
+
# Valid for: Aurora DB clusters only
|
1414
1838
|
# @option options [Boolean] :deletion_protection
|
1415
1839
|
# A value that indicates whether the DB cluster has deletion protection
|
1416
1840
|
# enabled. The database can't be deleted when deletion protection is
|
1417
|
-
# enabled. By default, deletion protection
|
1841
|
+
# enabled. By default, deletion protection isn't enabled.
|
1842
|
+
#
|
1843
|
+
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
1418
1844
|
# @option options [Boolean] :enable_http_endpoint
|
1419
1845
|
# A value that indicates whether to enable the HTTP endpoint for an
|
1420
1846
|
# Aurora Serverless DB cluster. By default, the HTTP endpoint is
|
@@ -1428,12 +1854,16 @@ module Aws::RDS
|
|
1428
1854
|
# For more information, see [Using the Data API for Aurora
|
1429
1855
|
# Serverless][1] in the *Amazon Aurora User Guide*.
|
1430
1856
|
#
|
1857
|
+
# Valid for: Aurora DB clusters only
|
1858
|
+
#
|
1431
1859
|
#
|
1432
1860
|
#
|
1433
1861
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/data-api.html
|
1434
1862
|
# @option options [Boolean] :copy_tags_to_snapshot
|
1435
1863
|
# A value that indicates whether to copy all tags from the DB cluster to
|
1436
1864
|
# snapshots of the DB cluster. The default is not to copy them.
|
1865
|
+
#
|
1866
|
+
# Valid for: Aurora DB clusters only
|
1437
1867
|
# @option options [Boolean] :enable_global_write_forwarding
|
1438
1868
|
# A value that indicates whether to enable this DB cluster to forward
|
1439
1869
|
# write operations to the primary cluster of an Aurora global database
|
@@ -1448,6 +1878,119 @@ module Aws::RDS
|
|
1448
1878
|
# DB cluster of an Aurora global database, this value is used
|
1449
1879
|
# immediately if the primary is demoted by the FailoverGlobalCluster API
|
1450
1880
|
# operation, but it does nothing until then.
|
1881
|
+
#
|
1882
|
+
# Valid for: Aurora DB clusters only
|
1883
|
+
# @option options [String] :db_cluster_instance_class
|
1884
|
+
# The compute and memory capacity of each DB instance in the Multi-AZ DB
|
1885
|
+
# cluster, for example db.m6g.xlarge. Not all DB instance classes are
|
1886
|
+
# available in all Amazon Web Services Regions, or for all database
|
1887
|
+
# engines.
|
1888
|
+
#
|
1889
|
+
# For the full list of DB instance classes and availability for your
|
1890
|
+
# engine, see [DB Instance Class][1] in the *Amazon RDS User Guide.*
|
1891
|
+
#
|
1892
|
+
# Valid for: Multi-AZ DB clusters only
|
1893
|
+
#
|
1894
|
+
#
|
1895
|
+
#
|
1896
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html
|
1897
|
+
# @option options [Integer] :allocated_storage
|
1898
|
+
# The amount of storage in gibibytes (GiB) to allocate to each DB
|
1899
|
+
# instance in the Multi-AZ DB cluster.
|
1900
|
+
#
|
1901
|
+
# Type: Integer
|
1902
|
+
#
|
1903
|
+
# Valid for: Multi-AZ DB clusters only
|
1904
|
+
# @option options [String] :storage_type
|
1905
|
+
# Specifies the storage type to be associated with the DB cluster.
|
1906
|
+
#
|
1907
|
+
# Valid values: `standard | gp2 | io1`
|
1908
|
+
#
|
1909
|
+
# If you specify `io1`, you must also include a value for the `Iops`
|
1910
|
+
# parameter.
|
1911
|
+
#
|
1912
|
+
# Default: `io1` if the `Iops` parameter is specified, otherwise `gp2`
|
1913
|
+
#
|
1914
|
+
# Valid for: Multi-AZ DB clusters only
|
1915
|
+
# @option options [Integer] :iops
|
1916
|
+
# The amount of Provisioned IOPS (input/output operations per second) to
|
1917
|
+
# be initially allocated for each DB instance in the Multi-AZ DB
|
1918
|
+
# cluster.
|
1919
|
+
#
|
1920
|
+
# For information about valid Iops values, see [Amazon RDS Provisioned
|
1921
|
+
# IOPS Storage to Improve Performance][1] in the *Amazon RDS User
|
1922
|
+
# Guide*.
|
1923
|
+
#
|
1924
|
+
# Constraints: Must be a multiple between .5 and 50 of the storage
|
1925
|
+
# amount for the DB cluster.
|
1926
|
+
#
|
1927
|
+
# Valid for: Multi-AZ DB clusters only
|
1928
|
+
#
|
1929
|
+
#
|
1930
|
+
#
|
1931
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html#USER_PIOPS
|
1932
|
+
# @option options [Boolean] :auto_minor_version_upgrade
|
1933
|
+
# A value that indicates whether minor engine upgrades are applied
|
1934
|
+
# automatically to the DB cluster during the maintenance window. By
|
1935
|
+
# default, minor engine upgrades are applied automatically.
|
1936
|
+
#
|
1937
|
+
# Valid for: Multi-AZ DB clusters only
|
1938
|
+
# @option options [Integer] :monitoring_interval
|
1939
|
+
# The interval, in seconds, between points when Enhanced Monitoring
|
1940
|
+
# metrics are collected for the DB cluster. To turn off collecting
|
1941
|
+
# Enhanced Monitoring metrics, specify 0. The default is 0.
|
1942
|
+
#
|
1943
|
+
# If `MonitoringRoleArn` is specified, also set `MonitoringInterval` to
|
1944
|
+
# a value other than 0.
|
1945
|
+
#
|
1946
|
+
# Valid Values: `0, 1, 5, 10, 15, 30, 60`
|
1947
|
+
#
|
1948
|
+
# Valid for: Multi-AZ DB clusters only
|
1949
|
+
# @option options [String] :monitoring_role_arn
|
1950
|
+
# The Amazon Resource Name (ARN) for the IAM role that permits RDS to
|
1951
|
+
# send Enhanced Monitoring metrics to Amazon CloudWatch Logs. An example
|
1952
|
+
# is `arn:aws:iam:123456789012:role/emaccess`. For information on
|
1953
|
+
# creating a monitoring role, see [To create an IAM role for Amazon RDS
|
1954
|
+
# Enhanced Monitoring][1] in the *Amazon RDS User Guide.*
|
1955
|
+
#
|
1956
|
+
# If `MonitoringInterval` is set to a value other than 0, supply a
|
1957
|
+
# `MonitoringRoleArn` value.
|
1958
|
+
#
|
1959
|
+
# Valid for: Multi-AZ DB clusters only
|
1960
|
+
#
|
1961
|
+
#
|
1962
|
+
#
|
1963
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Monitoring.html#USER_Monitoring.OS.IAMRole
|
1964
|
+
# @option options [Boolean] :enable_performance_insights
|
1965
|
+
# A value that indicates whether to turn on Performance Insights for the
|
1966
|
+
# DB cluster.
|
1967
|
+
#
|
1968
|
+
# For more information, see [ Using Amazon Performance Insights][1] in
|
1969
|
+
# the *Amazon RDS User Guide*.
|
1970
|
+
#
|
1971
|
+
# Valid for: Multi-AZ DB clusters only
|
1972
|
+
#
|
1973
|
+
#
|
1974
|
+
#
|
1975
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html
|
1976
|
+
# @option options [String] :performance_insights_kms_key_id
|
1977
|
+
# The Amazon Web Services KMS key identifier for encryption of
|
1978
|
+
# Performance Insights data.
|
1979
|
+
#
|
1980
|
+
# The Amazon Web Services KMS key identifier is the key ARN, key ID,
|
1981
|
+
# alias ARN, or alias name for the KMS key.
|
1982
|
+
#
|
1983
|
+
# If you don't specify a value for `PerformanceInsightsKMSKeyId`, then
|
1984
|
+
# Amazon RDS uses your default KMS key. There is a default KMS key for
|
1985
|
+
# your Amazon Web Services account. Your Amazon Web Services account has
|
1986
|
+
# a different default KMS key for each Amazon Web Services Region.
|
1987
|
+
#
|
1988
|
+
# Valid for: Multi-AZ DB clusters only
|
1989
|
+
# @option options [Integer] :performance_insights_retention_period
|
1990
|
+
# The amount of time, in days, to retain Performance Insights data.
|
1991
|
+
# Valid values are 7 or 731 (2 years).
|
1992
|
+
#
|
1993
|
+
# Valid for: Multi-AZ DB clusters only
|
1451
1994
|
# @return [DBCluster]
|
1452
1995
|
def modify(options = {})
|
1453
1996
|
options = options.merge(db_cluster_identifier: @id)
|
@@ -1494,6 +2037,10 @@ module Aws::RDS
|
|
1494
2037
|
# seconds_before_timeout: 1,
|
1495
2038
|
# },
|
1496
2039
|
# engine_mode: "String",
|
2040
|
+
# db_cluster_instance_class: "String",
|
2041
|
+
# storage_type: "String",
|
2042
|
+
# publicly_accessible: false,
|
2043
|
+
# iops: 1,
|
1497
2044
|
# })
|
1498
2045
|
# @param [Hash] options ({})
|
1499
2046
|
# @option options [required, String] :db_cluster_identifier
|
@@ -1506,6 +2053,8 @@ module Aws::RDS
|
|
1506
2053
|
# * First character must be a letter
|
1507
2054
|
#
|
1508
2055
|
# * Can't end with a hyphen or contain two consecutive hyphens
|
2056
|
+
#
|
2057
|
+
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
1509
2058
|
# @option options [String] :restore_type
|
1510
2059
|
# The type of restore to be performed. You can specify one of the
|
1511
2060
|
# following values:
|
@@ -1521,6 +2070,8 @@ module Aws::RDS
|
|
1521
2070
|
#
|
1522
2071
|
# If you don't specify a `RestoreType` value, then the new DB cluster
|
1523
2072
|
# is restored as a full copy of the source DB cluster.
|
2073
|
+
#
|
2074
|
+
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
1524
2075
|
# @option options [Time,DateTime,Date,Integer,String] :restore_to_time
|
1525
2076
|
# The date and time to restore the DB cluster to.
|
1526
2077
|
#
|
@@ -1541,6 +2092,8 @@ module Aws::RDS
|
|
1541
2092
|
# `copy-on-write`
|
1542
2093
|
#
|
1543
2094
|
# Example: `2015-03-07T23:45:00Z`
|
2095
|
+
#
|
2096
|
+
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
1544
2097
|
# @option options [Boolean] :use_latest_restorable_time
|
1545
2098
|
# A value that indicates whether to restore the DB cluster to the latest
|
1546
2099
|
# restorable backup time. By default, the DB cluster isn't restored to
|
@@ -1548,12 +2101,16 @@ module Aws::RDS
|
|
1548
2101
|
#
|
1549
2102
|
# Constraints: Can't be specified if `RestoreToTime` parameter is
|
1550
2103
|
# provided.
|
2104
|
+
#
|
2105
|
+
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
1551
2106
|
# @option options [Integer] :port
|
1552
2107
|
# The port number on which the new DB cluster accepts connections.
|
1553
2108
|
#
|
1554
2109
|
# Constraints: A value from `1150-65535`.
|
1555
2110
|
#
|
1556
2111
|
# Default: The default port for the engine.
|
2112
|
+
#
|
2113
|
+
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
1557
2114
|
# @option options [String] :db_subnet_group_name
|
1558
2115
|
# The DB subnet group name to use for the new DB cluster.
|
1559
2116
|
#
|
@@ -1561,10 +2118,17 @@ module Aws::RDS
|
|
1561
2118
|
# DBSubnetGroup.
|
1562
2119
|
#
|
1563
2120
|
# Example: `mySubnetgroup`
|
2121
|
+
#
|
2122
|
+
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
1564
2123
|
# @option options [String] :option_group_name
|
1565
2124
|
# The name of the option group for the new DB cluster.
|
2125
|
+
#
|
2126
|
+
# DB clusters are associated with a default option group that can't be
|
2127
|
+
# modified.
|
1566
2128
|
# @option options [Array<String>] :vpc_security_group_ids
|
1567
2129
|
# A list of VPC security groups that the new DB cluster belongs to.
|
2130
|
+
#
|
2131
|
+
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
1568
2132
|
# @option options [Array<Types::Tag>] :tags
|
1569
2133
|
# A list of tags. For more information, see [Tagging Amazon RDS
|
1570
2134
|
# Resources][1] in the *Amazon RDS User Guide.*
|
@@ -1598,14 +2162,18 @@ module Aws::RDS
|
|
1598
2162
|
#
|
1599
2163
|
# If `DBClusterIdentifier` refers to a DB cluster that isn't encrypted,
|
1600
2164
|
# then the restore request is rejected.
|
2165
|
+
#
|
2166
|
+
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
1601
2167
|
# @option options [Boolean] :enable_iam_database_authentication
|
1602
2168
|
# A value that indicates whether to enable mapping of Amazon Web
|
1603
2169
|
# Services Identity and Access Management (IAM) accounts to database
|
1604
|
-
# accounts. By default, mapping
|
2170
|
+
# accounts. By default, mapping isn't enabled.
|
1605
2171
|
#
|
1606
2172
|
# For more information, see [ IAM Database Authentication][1] in the
|
1607
2173
|
# *Amazon Aurora User Guide.*
|
1608
2174
|
#
|
2175
|
+
# Valid for: Aurora DB clusters only
|
2176
|
+
#
|
1609
2177
|
#
|
1610
2178
|
#
|
1611
2179
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.IAMDBAuth.html
|
@@ -1613,10 +2181,6 @@ module Aws::RDS
|
|
1613
2181
|
# The target backtrack window, in seconds. To disable backtracking, set
|
1614
2182
|
# this value to 0.
|
1615
2183
|
#
|
1616
|
-
# <note markdown="1"> Currently, Backtrack is only supported for Aurora MySQL DB clusters.
|
1617
|
-
#
|
1618
|
-
# </note>
|
1619
|
-
#
|
1620
2184
|
# Default: 0
|
1621
2185
|
#
|
1622
2186
|
# Constraints:
|
@@ -1625,12 +2189,18 @@ module Aws::RDS
|
|
1625
2189
|
# (72 hours).
|
1626
2190
|
#
|
1627
2191
|
# ^
|
2192
|
+
#
|
2193
|
+
# Valid for: Aurora MySQL DB clusters only
|
1628
2194
|
# @option options [Array<String>] :enable_cloudwatch_logs_exports
|
1629
2195
|
# The list of logs that the restored DB cluster is to export to
|
1630
2196
|
# CloudWatch Logs. The values in the list depend on the DB engine being
|
1631
|
-
# used.
|
2197
|
+
# used.
|
2198
|
+
#
|
2199
|
+
# For more information, see [Publishing Database Logs to Amazon
|
1632
2200
|
# CloudWatch Logs][1] in the *Amazon Aurora User Guide*.
|
1633
2201
|
#
|
2202
|
+
# Valid for: Aurora DB clusters only
|
2203
|
+
#
|
1634
2204
|
#
|
1635
2205
|
#
|
1636
2206
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch
|
@@ -1649,14 +2219,20 @@ module Aws::RDS
|
|
1649
2219
|
# * First character must be a letter.
|
1650
2220
|
#
|
1651
2221
|
# * Can't end with a hyphen or contain two consecutive hyphens.
|
2222
|
+
#
|
2223
|
+
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
1652
2224
|
# @option options [Boolean] :deletion_protection
|
1653
2225
|
# A value that indicates whether the DB cluster has deletion protection
|
1654
2226
|
# enabled. The database can't be deleted when deletion protection is
|
1655
|
-
# enabled. By default, deletion protection
|
2227
|
+
# enabled. By default, deletion protection isn't enabled.
|
2228
|
+
#
|
2229
|
+
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
1656
2230
|
# @option options [Boolean] :copy_tags_to_snapshot
|
1657
2231
|
# A value that indicates whether to copy all tags from the restored DB
|
1658
2232
|
# cluster to snapshots of the restored DB cluster. The default is not to
|
1659
2233
|
# copy them.
|
2234
|
+
#
|
2235
|
+
# Valid for: Aurora DB clusters only
|
1660
2236
|
# @option options [String] :domain
|
1661
2237
|
# Specify the Active Directory directory ID to restore the DB cluster
|
1662
2238
|
# in. The domain must be created prior to this operation.
|
@@ -1666,15 +2242,21 @@ module Aws::RDS
|
|
1666
2242
|
# For more information, see [Kerberos Authentication][1] in the *Amazon
|
1667
2243
|
# Aurora User Guide*.
|
1668
2244
|
#
|
2245
|
+
# Valid for: Aurora DB clusters only
|
2246
|
+
#
|
1669
2247
|
#
|
1670
2248
|
#
|
1671
2249
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/kerberos-authentication.html
|
1672
2250
|
# @option options [String] :domain_iam_role_name
|
1673
2251
|
# Specify the name of the IAM role to be used when making API calls to
|
1674
2252
|
# the Directory Service.
|
2253
|
+
#
|
2254
|
+
# Valid for: Aurora DB clusters only
|
1675
2255
|
# @option options [Types::ScalingConfiguration] :scaling_configuration
|
1676
2256
|
# For DB clusters in `serverless` DB engine mode, the scaling properties
|
1677
2257
|
# of the DB cluster.
|
2258
|
+
#
|
2259
|
+
# Valid for: Aurora DB clusters only
|
1678
2260
|
# @option options [String] :engine_mode
|
1679
2261
|
# The engine mode of the new cluster. Specify `provisioned` or
|
1680
2262
|
# `serverless`, depending on the type of the cluster you are creating.
|
@@ -1682,6 +2264,86 @@ module Aws::RDS
|
|
1682
2264
|
# or a provisioned clone from an Aurora Serverless cluster. To create a
|
1683
2265
|
# clone that is an Aurora Serverless cluster, the original cluster must
|
1684
2266
|
# be an Aurora Serverless cluster or an encrypted provisioned cluster.
|
2267
|
+
#
|
2268
|
+
# Valid for: Aurora DB clusters only
|
2269
|
+
# @option options [String] :db_cluster_instance_class
|
2270
|
+
# The compute and memory capacity of the each DB instance in the
|
2271
|
+
# Multi-AZ DB cluster, for example db.m6g.xlarge. Not all DB instance
|
2272
|
+
# classes are available in all Amazon Web Services Regions, or for all
|
2273
|
+
# database engines.
|
2274
|
+
#
|
2275
|
+
# For the full list of DB instance classes, and availability for your
|
2276
|
+
# engine, see [DB instance class][1] in the *Amazon RDS User Guide.*
|
2277
|
+
#
|
2278
|
+
# Valid for: Multi-AZ DB clusters only
|
2279
|
+
#
|
2280
|
+
#
|
2281
|
+
#
|
2282
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html
|
2283
|
+
# @option options [String] :storage_type
|
2284
|
+
# Specifies the storage type to be associated with the each DB instance
|
2285
|
+
# in the Multi-AZ DB cluster.
|
2286
|
+
#
|
2287
|
+
# Valid values: `standard | gp2 | io1`
|
2288
|
+
#
|
2289
|
+
# If you specify `io1`, also include a value for the `Iops` parameter.
|
2290
|
+
#
|
2291
|
+
# Default: `io1` if the `Iops` parameter is specified, otherwise `gp2`
|
2292
|
+
#
|
2293
|
+
# Valid for: Multi-AZ DB clusters only
|
2294
|
+
# @option options [Boolean] :publicly_accessible
|
2295
|
+
# A value that indicates whether the DB cluster is publicly accessible.
|
2296
|
+
#
|
2297
|
+
# When the DB cluster is publicly accessible, its Domain Name System
|
2298
|
+
# (DNS) endpoint resolves to the private IP address from within the DB
|
2299
|
+
# cluster's virtual private cloud (VPC). It resolves to the public IP
|
2300
|
+
# address from outside of the DB cluster's VPC. Access to the DB
|
2301
|
+
# cluster is ultimately controlled by the security group it uses. That
|
2302
|
+
# public access is not permitted if the security group assigned to the
|
2303
|
+
# DB cluster doesn't permit it.
|
2304
|
+
#
|
2305
|
+
# When the DB cluster isn't publicly accessible, it is an internal DB
|
2306
|
+
# cluster with a DNS name that resolves to a private IP address.
|
2307
|
+
#
|
2308
|
+
# Default: The default behavior varies depending on whether
|
2309
|
+
# `DBSubnetGroupName` is specified.
|
2310
|
+
#
|
2311
|
+
# If `DBSubnetGroupName` isn't specified, and `PubliclyAccessible`
|
2312
|
+
# isn't specified, the following applies:
|
2313
|
+
#
|
2314
|
+
# * If the default VPC in the target Region doesn’t have an internet
|
2315
|
+
# gateway attached to it, the DB cluster is private.
|
2316
|
+
#
|
2317
|
+
# * If the default VPC in the target Region has an internet gateway
|
2318
|
+
# attached to it, the DB cluster is public.
|
2319
|
+
#
|
2320
|
+
# If `DBSubnetGroupName` is specified, and `PubliclyAccessible` isn't
|
2321
|
+
# specified, the following applies:
|
2322
|
+
#
|
2323
|
+
# * If the subnets are part of a VPC that doesn’t have an internet
|
2324
|
+
# gateway attached to it, the DB cluster is private.
|
2325
|
+
#
|
2326
|
+
# * If the subnets are part of a VPC that has an internet gateway
|
2327
|
+
# attached to it, the DB cluster is public.
|
2328
|
+
#
|
2329
|
+
# Valid for: Multi-AZ DB clusters only
|
2330
|
+
# @option options [Integer] :iops
|
2331
|
+
# The amount of Provisioned IOPS (input/output operations per second) to
|
2332
|
+
# be initially allocated for each DB instance in the Multi-AZ DB
|
2333
|
+
# cluster.
|
2334
|
+
#
|
2335
|
+
# For information about valid `Iops` values, see [Amazon RDS Provisioned
|
2336
|
+
# IOPS storage to improve performance][1] in the *Amazon RDS User
|
2337
|
+
# Guide*.
|
2338
|
+
#
|
2339
|
+
# Constraints: Must be a multiple between .5 and 50 of the storage
|
2340
|
+
# amount for the DB instance.
|
2341
|
+
#
|
2342
|
+
# Valid for: Multi-AZ DB clusters only
|
2343
|
+
#
|
2344
|
+
#
|
2345
|
+
#
|
2346
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html#USER_PIOPS
|
1685
2347
|
# @return [DBCluster]
|
1686
2348
|
def restore(options = {})
|
1687
2349
|
options = options.merge(source_db_cluster_identifier: @id)
|