aws-sdk-rds 1.128.0 → 1.132.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -244,8 +244,7 @@ module Aws::RDS
244
244
  # identifier for the encrypted DB cluster.
245
245
  #
246
246
  # The Amazon Web Services KMS key identifier is the key ARN, key ID,
247
- # alias ARN, or alias name for the Amazon Web Services KMS customer
248
- # master key (CMK).
247
+ # alias ARN, or alias name for the KMS key.
249
248
  # @return [String]
250
249
  def kms_key_id
251
250
  data[:kms_key_id]
@@ -253,8 +252,7 @@ module Aws::RDS
253
252
 
254
253
  # The Amazon Web Services Region-unique, immutable identifier for the DB
255
254
  # cluster. This identifier is found in Amazon Web Services CloudTrail
256
- # log entries whenever the Amazon Web Services KMS CMK for the DB
257
- # cluster is accessed.
255
+ # log entries whenever the KMS key for the DB cluster is accessed.
258
256
  # @return [String]
259
257
  def db_cluster_resource_id
260
258
  data[:db_cluster_resource_id]
@@ -417,8 +415,7 @@ module Aws::RDS
417
415
  # messages in the database activity stream.
418
416
  #
419
417
  # The Amazon Web Services KMS key identifier is the key ARN, key ID,
420
- # alias ARN, or alias name for the Amazon Web Services KMS customer
421
- # master key (CMK).
418
+ # alias ARN, or alias name for the KMS key.
422
419
  # @return [String]
423
420
  def activity_stream_kms_key_id
424
421
  data[:activity_stream_kms_key_id]
@@ -489,6 +486,108 @@ module Aws::RDS
489
486
  data[:pending_modified_values]
490
487
  end
491
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
+
492
591
  # @!endgroup
493
592
 
494
593
  # @return [Client]
@@ -670,14 +769,29 @@ module Aws::RDS
670
769
  # domain: "String",
671
770
  # domain_iam_role_name: "String",
672
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,
673
783
  # source_region: "String",
674
784
  # })
675
785
  # @param [Hash] options ({})
676
786
  # @option options [Array<String>] :availability_zones
677
- # A list of Availability Zones (AZs) where instances in the DB cluster
678
- # can be created. For information on Amazon Web Services Regions and
679
- # Availability Zones, see [Choosing the Regions and Availability
680
- # Zones][1] in the *Amazon Aurora User Guide*.
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
681
795
  #
682
796
  #
683
797
  #
@@ -692,13 +806,19 @@ module Aws::RDS
692
806
  # * Must be a value from 1 to 35
693
807
  #
694
808
  # ^
809
+ #
810
+ # Valid for: Aurora DB clusters and Multi-AZ DB clusters
695
811
  # @option options [String] :character_set_name
696
812
  # A value that indicates that the DB cluster should be associated with
697
813
  # the specified CharacterSet.
814
+ #
815
+ # Valid for: Aurora DB clusters only
698
816
  # @option options [String] :database_name
699
817
  # The name for your database of up to 64 alphanumeric characters. If you
700
818
  # do not provide a name, Amazon RDS doesn't create a database in the DB
701
819
  # cluster you are creating.
820
+ #
821
+ # Valid for: Aurora DB clusters and Multi-AZ DB clusters
702
822
  # @option options [String] :db_cluster_parameter_group_name
703
823
  # The name of the DB cluster parameter group to associate with this DB
704
824
  # cluster. If you do not specify a value, then the default DB cluster
@@ -710,56 +830,117 @@ module Aws::RDS
710
830
  # group.
711
831
  #
712
832
  # ^
833
+ #
834
+ # Valid for: Aurora DB clusters and Multi-AZ DB clusters
713
835
  # @option options [Array<String>] :vpc_security_group_ids
714
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
715
839
  # @option options [String] :db_subnet_group_name
716
840
  # A DB subnet group to associate with this DB cluster.
717
841
  #
842
+ # This setting is required to create a Multi-AZ DB cluster.
843
+ #
718
844
  # Constraints: Must match the name of an existing DBSubnetGroup. Must
719
845
  # not be default.
720
846
  #
721
847
  # Example: `mySubnetgroup`
848
+ #
849
+ # Valid for: Aurora DB clusters and Multi-AZ DB clusters
722
850
  # @option options [required, String] :engine
723
851
  # The name of the database engine to be used for this DB cluster.
724
852
  #
725
- # Valid Values: `aurora` (for MySQL 5.6-compatible Aurora),
726
- # `aurora-mysql` (for MySQL 5.7-compatible Aurora), and
727
- # `aurora-postgresql`
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
728
866
  # @option options [String] :engine_version
729
867
  # The version number of the database engine to use.
730
868
  #
731
- # To list all of the available engine versions for `aurora` (for MySQL
732
- # 5.6-compatible Aurora), use the following command:
869
+ # To list all of the available engine versions for MySQL 5.6-compatible
870
+ # Aurora, use the following command:
733
871
  #
734
872
  # `aws rds describe-db-engine-versions --engine aurora --query
735
873
  # "DBEngineVersions[].EngineVersion"`
736
874
  #
737
- # To list all of the available engine versions for `aurora-mysql` (for
738
- # MySQL 5.7-compatible Aurora), use the following command:
875
+ # To list all of the available engine versions for MySQL 5.7-compatible
876
+ # Aurora, use the following command:
739
877
  #
740
878
  # `aws rds describe-db-engine-versions --engine aurora-mysql --query
741
879
  # "DBEngineVersions[].EngineVersion"`
742
880
  #
743
- # To list all of the available engine versions for `aurora-postgresql`,
881
+ # To list all of the available engine versions for Aurora PostgreSQL,
744
882
  # use the following command:
745
883
  #
746
884
  # `aws rds describe-db-engine-versions --engine aurora-postgresql
747
885
  # --query "DBEngineVersions[].EngineVersion"`
748
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
+ #
749
899
  # **Aurora MySQL**
750
900
  #
751
- # Example: `5.6.10a`, `5.6.mysql_aurora.1.19.2`, `5.7.12`,
752
- # `5.7.mysql_aurora.2.04.5`
901
+ # For information, see [MySQL on Amazon RDS Versions][1] in the *Amazon
902
+ # Aurora User Guide.*
753
903
  #
754
904
  # **Aurora PostgreSQL**
755
905
  #
756
- # Example: `9.6.3`, `10.7`
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
757
927
  # @option options [Integer] :port
758
928
  # The port number on which the instances in the DB cluster accept
759
929
  # connections.
760
930
  #
761
- # Default: `3306` if engine is set as aurora or `5432` if set to
762
- # aurora-postgresql.
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
763
944
  # @option options [String] :master_username
764
945
  # The name of the master user for the DB cluster.
765
946
  #
@@ -770,18 +951,21 @@ module Aws::RDS
770
951
  # * First character must be a letter.
771
952
  #
772
953
  # * Can't be a reserved word for the chosen database engine.
954
+ #
955
+ # Valid for: Aurora DB clusters and Multi-AZ DB clusters
773
956
  # @option options [String] :master_user_password
774
957
  # The password for the master database user. This password can contain
775
958
  # any printable ASCII character except "/", """, or "@".
776
959
  #
777
960
  # Constraints: Must contain from 8 to 41 characters.
961
+ #
962
+ # Valid for: Aurora DB clusters and Multi-AZ DB clusters
778
963
  # @option options [String] :option_group_name
779
964
  # A value that indicates that the DB cluster should be associated with
780
965
  # the specified option group.
781
966
  #
782
- # Permanent options can't be removed from an option group. The option
783
- # group can't be removed from a DB cluster once it is associated with a
784
- # DB cluster.
967
+ # DB clusters are associated with a default option group that can't be
968
+ # modified.
785
969
  # @option options [String] :preferred_backup_window
786
970
  # The daily time range during which automated backups are created if
787
971
  # automated backups are enabled using the `BackupRetentionPeriod`
@@ -802,6 +986,8 @@ module Aws::RDS
802
986
  #
803
987
  # * Must be at least 30 minutes.
804
988
  #
989
+ # Valid for: Aurora DB clusters and Multi-AZ DB clusters
990
+ #
805
991
  #
806
992
  #
807
993
  # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Managing.Backups.html#Aurora.Managing.Backups.BackupWindow
@@ -821,50 +1007,60 @@ module Aws::RDS
821
1007
  #
822
1008
  # Constraints: Minimum 30-minute window.
823
1009
  #
1010
+ # Valid for: Aurora DB clusters and Multi-AZ DB clusters
1011
+ #
824
1012
  #
825
1013
  #
826
1014
  # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_UpgradeDBInstance.Maintenance.html#AdjustingTheMaintenanceWindow.Aurora
827
1015
  # @option options [String] :replication_source_identifier
828
1016
  # The Amazon Resource Name (ARN) of the source DB instance or DB cluster
829
1017
  # if this DB cluster is created as a read replica.
1018
+ #
1019
+ # Valid for: Aurora DB clusters only
830
1020
  # @option options [Array<Types::Tag>] :tags
831
1021
  # Tags to assign to the DB cluster.
1022
+ #
1023
+ # Valid for: Aurora DB clusters and Multi-AZ DB clusters
832
1024
  # @option options [Boolean] :storage_encrypted
833
1025
  # A value that indicates whether the DB cluster is encrypted.
1026
+ #
1027
+ # Valid for: Aurora DB clusters and Multi-AZ DB clusters
834
1028
  # @option options [String] :kms_key_id
835
1029
  # The Amazon Web Services KMS key identifier for an encrypted DB
836
1030
  # cluster.
837
1031
  #
838
1032
  # The Amazon Web Services KMS key identifier is the key ARN, key ID,
839
- # alias ARN, or alias name for the Amazon Web Services KMS customer
840
- # master key (CMK). To use a CMK in a different Amazon Web Services
841
- # account, specify the key ARN or alias ARN.
1033
+ # alias ARN, or alias name for the KMS key. To use a KMS key in a
1034
+ # different Amazon Web Services account, specify the key ARN or alias
1035
+ # ARN.
842
1036
  #
843
- # When a CMK isn't specified in `KmsKeyId`\:
1037
+ # When a KMS key isn't specified in `KmsKeyId`\:
844
1038
  #
845
1039
  # * If `ReplicationSourceIdentifier` identifies an encrypted source,
846
- # then Amazon RDS will use the CMK used to encrypt the source.
847
- # Otherwise, Amazon RDS will use your default CMK.
1040
+ # then Amazon RDS will use the KMS key used to encrypt the source.
1041
+ # Otherwise, Amazon RDS will use your default KMS key.
848
1042
  #
849
1043
  # * If the `StorageEncrypted` parameter is enabled and
850
1044
  # `ReplicationSourceIdentifier` isn't specified, then Amazon RDS will
851
- # use your default CMK.
1045
+ # use your default KMS key.
852
1046
  #
853
- # There is a default CMK for your Amazon Web Services account. Your
854
- # Amazon Web Services account has a different default CMK for each
1047
+ # There is a default KMS key for your Amazon Web Services account. Your
1048
+ # Amazon Web Services account has a different default KMS key for each
855
1049
  # Amazon Web Services Region.
856
1050
  #
857
1051
  # If you create a read replica of an encrypted DB cluster in another
858
- # Amazon Web Services Region, you must set `KmsKeyId` to a Amazon Web
859
- # Services KMS key identifier that is valid in the destination Amazon
860
- # Web Services Region. This CMK is used to encrypt the read replica in
861
- # that Amazon Web Services Region.
1052
+ # Amazon Web Services Region, you must set `KmsKeyId` to a KMS key
1053
+ # identifier that is valid in the destination Amazon Web Services
1054
+ # Region. This KMS key is used to encrypt the read replica in that
1055
+ # Amazon Web Services Region.
1056
+ #
1057
+ # Valid for: Aurora DB clusters and Multi-AZ DB clusters
862
1058
  # @option options [String] :pre_signed_url
863
1059
  # A URL that contains a Signature Version 4 signed request for the
864
1060
  # `CreateDBCluster` action to be called in the source Amazon Web
865
- # Services Region where the DB cluster is replicated from. You only need
866
- # to specify `PreSignedUrl` when you are performing cross-region
867
- # replication from an encrypted DB cluster.
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.
868
1064
  #
869
1065
  # The pre-signed URL must be a valid request for the `CreateDBCluster`
870
1066
  # API action that can be executed in the source Amazon Web Services
@@ -873,12 +1069,12 @@ module Aws::RDS
873
1069
  # The pre-signed URL request must contain the following parameter
874
1070
  # values:
875
1071
  #
876
- # * `KmsKeyId` - The Amazon Web Services KMS key identifier for the key
877
- # to use to encrypt the copy of the DB cluster in the destination
878
- # Amazon Web Services Region. This should refer to the same Amazon Web
879
- # Services KMS CMK for both the `CreateDBCluster` action that is
880
- # called in the destination Amazon Web Services Region, and the action
881
- # contained in the pre-signed URL.
1072
+ # * `KmsKeyId` - The Amazon Web Services KMS key identifier for the KMS
1073
+ # key to use to encrypt the copy of the DB cluster in the destination
1074
+ # Amazon Web Services Region. This should refer to the same KMS key
1075
+ # for both the `CreateDBCluster` action that is called in the
1076
+ # destination Amazon Web Services Region, and the action contained in
1077
+ # the pre-signed URL.
882
1078
  #
883
1079
  # * `DestinationRegion` - The name of the Amazon Web Services Region
884
1080
  # that Aurora read replica will be created in.
@@ -905,6 +1101,8 @@ module Aws::RDS
905
1101
  #
906
1102
  # </note>
907
1103
  #
1104
+ # Valid for: Aurora DB clusters only
1105
+ #
908
1106
  #
909
1107
  #
910
1108
  # [1]: https://docs.aws.amazon.com/AmazonS3/latest/API/sigv4-query-string-auth.html
@@ -912,11 +1110,13 @@ module Aws::RDS
912
1110
  # @option options [Boolean] :enable_iam_database_authentication
913
1111
  # A value that indicates whether to enable mapping of Amazon Web
914
1112
  # Services Identity and Access Management (IAM) accounts to database
915
- # accounts. By default, mapping is disabled.
1113
+ # accounts. By default, mapping isn't enabled.
916
1114
  #
917
1115
  # For more information, see [ IAM Database Authentication][1] in the
918
1116
  # *Amazon Aurora User Guide.*
919
1117
  #
1118
+ # Valid for: Aurora DB clusters only
1119
+ #
920
1120
  #
921
1121
  #
922
1122
  # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.IAMDBAuth.html
@@ -924,10 +1124,6 @@ module Aws::RDS
924
1124
  # The target backtrack window, in seconds. To disable backtracking, set
925
1125
  # this value to 0.
926
1126
  #
927
- # <note markdown="1"> Currently, Backtrack is only supported for Aurora MySQL DB clusters.
928
- #
929
- # </note>
930
- #
931
1127
  # Default: 0
932
1128
  #
933
1129
  # Constraints:
@@ -936,6 +1132,8 @@ module Aws::RDS
936
1132
  # (72 hours).
937
1133
  #
938
1134
  # ^
1135
+ #
1136
+ # Valid for: Aurora MySQL DB clusters only
939
1137
  # @option options [Array<String>] :enable_cloudwatch_logs_exports
940
1138
  # The list of log types that need to be enabled for exporting to
941
1139
  # CloudWatch Logs. The values in the list depend on the DB engine being
@@ -950,6 +1148,8 @@ module Aws::RDS
950
1148
  #
951
1149
  # Possible value is `postgresql`.
952
1150
  #
1151
+ # Valid for: Aurora DB clusters only
1152
+ #
953
1153
  #
954
1154
  #
955
1155
  # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch
@@ -984,6 +1184,8 @@ module Aws::RDS
984
1184
  #
985
1185
  # * [ Limitations of Multi-Master Clusters][4]
986
1186
  #
1187
+ # Valid for: Aurora DB clusters only
1188
+ #
987
1189
  #
988
1190
  #
989
1191
  # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless.html#aurora-serverless.limitations
@@ -993,13 +1195,19 @@ module Aws::RDS
993
1195
  # @option options [Types::ScalingConfiguration] :scaling_configuration
994
1196
  # For DB clusters in `serverless` DB engine mode, the scaling properties
995
1197
  # of the DB cluster.
1198
+ #
1199
+ # Valid for: Aurora DB clusters only
996
1200
  # @option options [Boolean] :deletion_protection
997
1201
  # A value that indicates whether the DB cluster has deletion protection
998
1202
  # enabled. The database can't be deleted when deletion protection is
999
- # enabled. By default, deletion protection is disabled.
1203
+ # enabled. By default, deletion protection isn't enabled.
1204
+ #
1205
+ # Valid for: Aurora DB clusters and Multi-AZ DB clusters
1000
1206
  # @option options [String] :global_cluster_identifier
1001
1207
  # The global cluster ID of an Aurora cluster that becomes the primary
1002
1208
  # cluster in the new global database cluster.
1209
+ #
1210
+ # Valid for: Aurora DB clusters only
1003
1211
  # @option options [Boolean] :enable_http_endpoint
1004
1212
  # A value that indicates whether to enable the HTTP endpoint for an
1005
1213
  # Aurora Serverless DB cluster. By default, the HTTP endpoint is
@@ -1013,26 +1221,35 @@ module Aws::RDS
1013
1221
  # For more information, see [Using the Data API for Aurora
1014
1222
  # Serverless][1] in the *Amazon Aurora User Guide*.
1015
1223
  #
1224
+ # Valid for: Aurora DB clusters only
1225
+ #
1016
1226
  #
1017
1227
  #
1018
1228
  # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/data-api.html
1019
1229
  # @option options [Boolean] :copy_tags_to_snapshot
1020
1230
  # A value that indicates whether to copy all tags from the DB cluster to
1021
1231
  # snapshots of the DB cluster. The default is not to copy them.
1232
+ #
1233
+ # Valid for: Aurora DB clusters only
1022
1234
  # @option options [String] :domain
1023
1235
  # The Active Directory directory ID to create the DB cluster in.
1024
1236
  #
1025
1237
  # For Amazon Aurora DB clusters, Amazon RDS can use Kerberos
1026
- # Authentication to authenticate users that connect to the DB cluster.
1027
- # For more information, see [Kerberos Authentication][1] in the *Amazon
1238
+ # authentication to authenticate users that connect to the DB cluster.
1239
+ #
1240
+ # For more information, see [Kerberos authentication][1] in the *Amazon
1028
1241
  # Aurora User Guide*.
1029
1242
  #
1243
+ # Valid for: Aurora DB clusters only
1244
+ #
1030
1245
  #
1031
1246
  #
1032
1247
  # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/kerberos-authentication.html
1033
1248
  # @option options [String] :domain_iam_role_name
1034
1249
  # Specify the name of the IAM role to be used when making API calls to
1035
1250
  # the Directory Service.
1251
+ #
1252
+ # Valid for: Aurora DB clusters only
1036
1253
  # @option options [Boolean] :enable_global_write_forwarding
1037
1254
  # A value that indicates whether to enable this DB cluster to forward
1038
1255
  # write operations to the primary cluster of an Aurora global database
@@ -1047,6 +1264,160 @@ module Aws::RDS
1047
1264
  # DB cluster of an Aurora global database, this value is used
1048
1265
  # immediately if the primary is demoted by the FailoverGlobalCluster API
1049
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
1050
1421
  # @option options [String] :source_region
1051
1422
  # The source region of the snapshot. This is only needed when the
1052
1423
  # shapshot is encrypted and in a different region.
@@ -1154,10 +1525,13 @@ module Aws::RDS
1154
1525
  # })
1155
1526
  # @param [Hash] options ({})
1156
1527
  # @option options [String] :target_db_instance_identifier
1157
- # 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.
1158
1529
  #
1159
- # You must specify the instance identifier for an Aurora Replica in the
1160
- # DB cluster. For example, `mydbcluster-replica1`.
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.
1161
1535
  # @return [DBCluster]
1162
1536
  def failover(options = {})
1163
1537
  options = options.merge(db_cluster_identifier: @id)
@@ -1205,6 +1579,16 @@ module Aws::RDS
1205
1579
  # enable_http_endpoint: false,
1206
1580
  # copy_tags_to_snapshot: false,
1207
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,
1208
1592
  # })
1209
1593
  # @param [Hash] options ({})
1210
1594
  # @option options [String] :new_db_cluster_identifier
@@ -1220,6 +1604,8 @@ module Aws::RDS
1220
1604
  # * Can't end with a hyphen or contain two consecutive hyphens
1221
1605
  #
1222
1606
  # Example: `my-cluster2`
1607
+ #
1608
+ # Valid for: Aurora DB clusters only
1223
1609
  # @option options [Boolean] :apply_immediately
1224
1610
  # A value that indicates whether the modifications in this request and
1225
1611
  # any pending modifications are asynchronously applied as soon as
@@ -1237,9 +1623,11 @@ module Aws::RDS
1237
1623
  # parameter.
1238
1624
  #
1239
1625
  # By default, this parameter is disabled.
1626
+ #
1627
+ # Valid for: Aurora DB clusters and Multi-AZ DB clusters
1240
1628
  # @option options [Integer] :backup_retention_period
1241
- # The number of days for which automated backups are retained. You must
1242
- # specify a minimum value of 1.
1629
+ # The number of days for which automated backups are retained. Specify a
1630
+ # minimum value of 1.
1243
1631
  #
1244
1632
  # Default: 1
1245
1633
  #
@@ -1248,34 +1636,37 @@ module Aws::RDS
1248
1636
  # * Must be a value from 1 to 35
1249
1637
  #
1250
1638
  # ^
1639
+ #
1640
+ # Valid for: Aurora DB clusters and Multi-AZ DB clusters
1251
1641
  # @option options [String] :db_cluster_parameter_group_name
1252
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
1253
1645
  # @option options [Array<String>] :vpc_security_group_ids
1254
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
1255
1649
  # @option options [Integer] :port
1256
1650
  # The port number on which the DB cluster accepts connections.
1257
1651
  #
1258
1652
  # Constraints: Value must be `1150-65535`
1259
1653
  #
1260
1654
  # Default: The same port as the original DB cluster.
1655
+ #
1656
+ # Valid for: Aurora DB clusters only
1261
1657
  # @option options [String] :master_user_password
1262
1658
  # The new password for the master database user. This password can
1263
1659
  # contain any printable ASCII character except "/", """, or "@".
1264
1660
  #
1265
1661
  # Constraints: Must contain from 8 to 41 characters.
1662
+ #
1663
+ # Valid for: Aurora DB clusters and Multi-AZ DB clusters
1266
1664
  # @option options [String] :option_group_name
1267
1665
  # A value that indicates that the DB cluster should be associated with
1268
- # the specified option group. Changing this parameter doesn't result in
1269
- # an outage except in the following case, and the change is applied
1270
- # during the next maintenance window unless the `ApplyImmediately` is
1271
- # enabled for this request. If the parameter change results in an option
1272
- # group that enables OEM, this change can cause a brief (sub-second)
1273
- # period during which new connections are rejected but existing
1274
- # connections are not interrupted.
1275
- #
1276
- # Permanent options can't be removed from an option group. The option
1277
- # group can't be removed from a DB cluster once it is associated with a
1278
- # DB cluster.
1666
+ # the specified option group.
1667
+ #
1668
+ # DB clusters are associated with a default option group that can't be
1669
+ # modified.
1279
1670
  # @option options [String] :preferred_backup_window
1280
1671
  # The daily time range during which automated backups are created if
1281
1672
  # automated backups are enabled, using the `BackupRetentionPeriod`
@@ -1296,6 +1687,8 @@ module Aws::RDS
1296
1687
  #
1297
1688
  # * Must be at least 30 minutes.
1298
1689
  #
1690
+ # Valid for: Aurora DB clusters and Multi-AZ DB clusters
1691
+ #
1299
1692
  #
1300
1693
  #
1301
1694
  # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Managing.Backups.html#Aurora.Managing.Backups.BackupWindow
@@ -1315,17 +1708,21 @@ module Aws::RDS
1315
1708
  #
1316
1709
  # Constraints: Minimum 30-minute window.
1317
1710
  #
1711
+ # Valid for: Aurora DB clusters and Multi-AZ DB clusters
1712
+ #
1318
1713
  #
1319
1714
  #
1320
1715
  # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_UpgradeDBInstance.Maintenance.html#AdjustingTheMaintenanceWindow.Aurora
1321
1716
  # @option options [Boolean] :enable_iam_database_authentication
1322
1717
  # A value that indicates whether to enable mapping of Amazon Web
1323
1718
  # Services Identity and Access Management (IAM) accounts to database
1324
- # accounts. By default, mapping is disabled.
1719
+ # accounts. By default, mapping isn't enabled.
1325
1720
  #
1326
1721
  # For more information, see [ IAM Database Authentication][1] in the
1327
1722
  # *Amazon Aurora User Guide.*
1328
1723
  #
1724
+ # Valid for: Aurora DB clusters only
1725
+ #
1329
1726
  #
1330
1727
  #
1331
1728
  # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.IAMDBAuth.html
@@ -1333,10 +1730,6 @@ module Aws::RDS
1333
1730
  # The target backtrack window, in seconds. To disable backtracking, set
1334
1731
  # this value to 0.
1335
1732
  #
1336
- # <note markdown="1"> Currently, Backtrack is only supported for Aurora MySQL DB clusters.
1337
- #
1338
- # </note>
1339
- #
1340
1733
  # Default: 0
1341
1734
  #
1342
1735
  # Constraints:
@@ -1345,38 +1738,58 @@ module Aws::RDS
1345
1738
  # (72 hours).
1346
1739
  #
1347
1740
  # ^
1741
+ #
1742
+ # Valid for: Aurora MySQL DB clusters only
1348
1743
  # @option options [Types::CloudwatchLogsExportConfiguration] :cloudwatch_logs_export_configuration
1349
1744
  # The configuration setting for the log types to be enabled for export
1350
1745
  # to CloudWatch Logs for a specific DB cluster.
1746
+ #
1747
+ # Valid for: Aurora DB clusters only
1351
1748
  # @option options [String] :engine_version
1352
1749
  # The version number of the database engine to which you want to
1353
1750
  # upgrade. Changing this parameter results in an outage. The change is
1354
1751
  # applied during the next maintenance window unless `ApplyImmediately`
1355
1752
  # is enabled.
1356
1753
  #
1357
- # To list all of the available engine versions for `aurora` (for MySQL
1358
- # 5.6-compatible Aurora), use the following command:
1754
+ # To list all of the available engine versions for MySQL 5.6-compatible
1755
+ # Aurora, use the following command:
1359
1756
  #
1360
1757
  # `aws rds describe-db-engine-versions --engine aurora --query
1361
1758
  # "DBEngineVersions[].EngineVersion"`
1362
1759
  #
1363
- # To list all of the available engine versions for `aurora-mysql` (for
1364
- # MySQL 5.7-compatible Aurora), use the following command:
1760
+ # To list all of the available engine versions for MySQL 5.7-compatible
1761
+ # Aurora, use the following command:
1365
1762
  #
1366
1763
  # `aws rds describe-db-engine-versions --engine aurora-mysql --query
1367
1764
  # "DBEngineVersions[].EngineVersion"`
1368
1765
  #
1369
- # To list all of the available engine versions for `aurora-postgresql`,
1766
+ # To list all of the available engine versions for Aurora PostgreSQL,
1370
1767
  # use the following command:
1371
1768
  #
1372
1769
  # `aws rds describe-db-engine-versions --engine aurora-postgresql
1373
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
1374
1785
  # @option options [Boolean] :allow_major_version_upgrade
1375
1786
  # A value that indicates whether major version upgrades are allowed.
1376
1787
  #
1377
1788
  # Constraints: You must allow major version upgrades when specifying a
1378
1789
  # value for the `EngineVersion` parameter that is a different major
1379
1790
  # version than the DB cluster's current version.
1791
+ #
1792
+ # Valid for: Aurora DB clusters only
1380
1793
  # @option options [String] :db_instance_parameter_group_name
1381
1794
  # The name of the DB parameter group to apply to all instances of the DB
1382
1795
  # cluster.
@@ -1397,6 +1810,8 @@ module Aws::RDS
1397
1810
  #
1398
1811
  # * The `DBInstanceParameterGroupName` parameter is only valid in
1399
1812
  # combination with the `AllowMajorVersionUpgrade` parameter.
1813
+ #
1814
+ # Valid for: Aurora DB clusters only
1400
1815
  # @option options [String] :domain
1401
1816
  # The Active Directory directory ID to move the DB cluster to. Specify
1402
1817
  # `none` to remove the cluster from its current domain. The domain must
@@ -1405,19 +1820,27 @@ module Aws::RDS
1405
1820
  # For more information, see [Kerberos Authentication][1] in the *Amazon
1406
1821
  # Aurora User Guide*.
1407
1822
  #
1823
+ # Valid for: Aurora DB clusters only
1824
+ #
1408
1825
  #
1409
1826
  #
1410
1827
  # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/kerberos-authentication.html
1411
1828
  # @option options [String] :domain_iam_role_name
1412
1829
  # Specify the name of the IAM role to be used when making API calls to
1413
1830
  # the Directory Service.
1831
+ #
1832
+ # Valid for: Aurora DB clusters only
1414
1833
  # @option options [Types::ScalingConfiguration] :scaling_configuration
1415
1834
  # The scaling properties of the DB cluster. You can only modify scaling
1416
1835
  # properties for DB clusters in `serverless` DB engine mode.
1836
+ #
1837
+ # Valid for: Aurora DB clusters only
1417
1838
  # @option options [Boolean] :deletion_protection
1418
1839
  # A value that indicates whether the DB cluster has deletion protection
1419
1840
  # enabled. The database can't be deleted when deletion protection is
1420
- # enabled. By default, deletion protection is disabled.
1841
+ # enabled. By default, deletion protection isn't enabled.
1842
+ #
1843
+ # Valid for: Aurora DB clusters and Multi-AZ DB clusters
1421
1844
  # @option options [Boolean] :enable_http_endpoint
1422
1845
  # A value that indicates whether to enable the HTTP endpoint for an
1423
1846
  # Aurora Serverless DB cluster. By default, the HTTP endpoint is
@@ -1431,12 +1854,16 @@ module Aws::RDS
1431
1854
  # For more information, see [Using the Data API for Aurora
1432
1855
  # Serverless][1] in the *Amazon Aurora User Guide*.
1433
1856
  #
1857
+ # Valid for: Aurora DB clusters only
1858
+ #
1434
1859
  #
1435
1860
  #
1436
1861
  # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/data-api.html
1437
1862
  # @option options [Boolean] :copy_tags_to_snapshot
1438
1863
  # A value that indicates whether to copy all tags from the DB cluster to
1439
1864
  # snapshots of the DB cluster. The default is not to copy them.
1865
+ #
1866
+ # Valid for: Aurora DB clusters only
1440
1867
  # @option options [Boolean] :enable_global_write_forwarding
1441
1868
  # A value that indicates whether to enable this DB cluster to forward
1442
1869
  # write operations to the primary cluster of an Aurora global database
@@ -1451,6 +1878,119 @@ module Aws::RDS
1451
1878
  # DB cluster of an Aurora global database, this value is used
1452
1879
  # immediately if the primary is demoted by the FailoverGlobalCluster API
1453
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
1454
1994
  # @return [DBCluster]
1455
1995
  def modify(options = {})
1456
1996
  options = options.merge(db_cluster_identifier: @id)
@@ -1497,6 +2037,10 @@ module Aws::RDS
1497
2037
  # seconds_before_timeout: 1,
1498
2038
  # },
1499
2039
  # engine_mode: "String",
2040
+ # db_cluster_instance_class: "String",
2041
+ # storage_type: "String",
2042
+ # publicly_accessible: false,
2043
+ # iops: 1,
1500
2044
  # })
1501
2045
  # @param [Hash] options ({})
1502
2046
  # @option options [required, String] :db_cluster_identifier
@@ -1509,6 +2053,8 @@ module Aws::RDS
1509
2053
  # * First character must be a letter
1510
2054
  #
1511
2055
  # * Can't end with a hyphen or contain two consecutive hyphens
2056
+ #
2057
+ # Valid for: Aurora DB clusters and Multi-AZ DB clusters
1512
2058
  # @option options [String] :restore_type
1513
2059
  # The type of restore to be performed. You can specify one of the
1514
2060
  # following values:
@@ -1524,6 +2070,8 @@ module Aws::RDS
1524
2070
  #
1525
2071
  # If you don't specify a `RestoreType` value, then the new DB cluster
1526
2072
  # is restored as a full copy of the source DB cluster.
2073
+ #
2074
+ # Valid for: Aurora DB clusters and Multi-AZ DB clusters
1527
2075
  # @option options [Time,DateTime,Date,Integer,String] :restore_to_time
1528
2076
  # The date and time to restore the DB cluster to.
1529
2077
  #
@@ -1544,6 +2092,8 @@ module Aws::RDS
1544
2092
  # `copy-on-write`
1545
2093
  #
1546
2094
  # Example: `2015-03-07T23:45:00Z`
2095
+ #
2096
+ # Valid for: Aurora DB clusters and Multi-AZ DB clusters
1547
2097
  # @option options [Boolean] :use_latest_restorable_time
1548
2098
  # A value that indicates whether to restore the DB cluster to the latest
1549
2099
  # restorable backup time. By default, the DB cluster isn't restored to
@@ -1551,12 +2101,16 @@ module Aws::RDS
1551
2101
  #
1552
2102
  # Constraints: Can't be specified if `RestoreToTime` parameter is
1553
2103
  # provided.
2104
+ #
2105
+ # Valid for: Aurora DB clusters and Multi-AZ DB clusters
1554
2106
  # @option options [Integer] :port
1555
2107
  # The port number on which the new DB cluster accepts connections.
1556
2108
  #
1557
2109
  # Constraints: A value from `1150-65535`.
1558
2110
  #
1559
2111
  # Default: The default port for the engine.
2112
+ #
2113
+ # Valid for: Aurora DB clusters and Multi-AZ DB clusters
1560
2114
  # @option options [String] :db_subnet_group_name
1561
2115
  # The DB subnet group name to use for the new DB cluster.
1562
2116
  #
@@ -1564,10 +2118,17 @@ module Aws::RDS
1564
2118
  # DBSubnetGroup.
1565
2119
  #
1566
2120
  # Example: `mySubnetgroup`
2121
+ #
2122
+ # Valid for: Aurora DB clusters and Multi-AZ DB clusters
1567
2123
  # @option options [String] :option_group_name
1568
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.
1569
2128
  # @option options [Array<String>] :vpc_security_group_ids
1570
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
1571
2132
  # @option options [Array<Types::Tag>] :tags
1572
2133
  # A list of tags. For more information, see [Tagging Amazon RDS
1573
2134
  # Resources][1] in the *Amazon RDS User Guide.*
@@ -1580,36 +2141,39 @@ module Aws::RDS
1580
2141
  # encrypted DB cluster from an encrypted DB cluster.
1581
2142
  #
1582
2143
  # The Amazon Web Services KMS key identifier is the key ARN, key ID,
1583
- # alias ARN, or alias name for the Amazon Web Services KMS customer
1584
- # master key (CMK). To use a CMK in a different Amazon Web Services
1585
- # account, specify the key ARN or alias ARN.
2144
+ # alias ARN, or alias name for the KMS key. To use a KMS key in a
2145
+ # different Amazon Web Services account, specify the key ARN or alias
2146
+ # ARN.
1586
2147
  #
1587
2148
  # You can restore to a new DB cluster and encrypt the new DB cluster
1588
- # with a Amazon Web Services KMS CMK that is different than the Amazon
1589
- # Web Services KMS key used to encrypt the source DB cluster. The new DB
1590
- # cluster is encrypted with the Amazon Web Services KMS CMK identified
1591
- # by the `KmsKeyId` parameter.
2149
+ # with a KMS key that is different from the KMS key used to encrypt the
2150
+ # source DB cluster. The new DB cluster is encrypted with the KMS key
2151
+ # identified by the `KmsKeyId` parameter.
1592
2152
  #
1593
2153
  # If you don't specify a value for the `KmsKeyId` parameter, then the
1594
2154
  # following occurs:
1595
2155
  #
1596
2156
  # * If the DB cluster is encrypted, then the restored DB cluster is
1597
- # encrypted using the Amazon Web Services KMS CMK that was used to
1598
- # encrypt the source DB cluster.
2157
+ # encrypted using the KMS key that was used to encrypt the source DB
2158
+ # cluster.
1599
2159
  #
1600
2160
  # * If the DB cluster isn't encrypted, then the restored DB cluster
1601
2161
  # isn't encrypted.
1602
2162
  #
1603
2163
  # If `DBClusterIdentifier` refers to a DB cluster that isn't encrypted,
1604
2164
  # then the restore request is rejected.
2165
+ #
2166
+ # Valid for: Aurora DB clusters and Multi-AZ DB clusters
1605
2167
  # @option options [Boolean] :enable_iam_database_authentication
1606
2168
  # A value that indicates whether to enable mapping of Amazon Web
1607
2169
  # Services Identity and Access Management (IAM) accounts to database
1608
- # accounts. By default, mapping is disabled.
2170
+ # accounts. By default, mapping isn't enabled.
1609
2171
  #
1610
2172
  # For more information, see [ IAM Database Authentication][1] in the
1611
2173
  # *Amazon Aurora User Guide.*
1612
2174
  #
2175
+ # Valid for: Aurora DB clusters only
2176
+ #
1613
2177
  #
1614
2178
  #
1615
2179
  # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.IAMDBAuth.html
@@ -1617,10 +2181,6 @@ module Aws::RDS
1617
2181
  # The target backtrack window, in seconds. To disable backtracking, set
1618
2182
  # this value to 0.
1619
2183
  #
1620
- # <note markdown="1"> Currently, Backtrack is only supported for Aurora MySQL DB clusters.
1621
- #
1622
- # </note>
1623
- #
1624
2184
  # Default: 0
1625
2185
  #
1626
2186
  # Constraints:
@@ -1629,12 +2189,18 @@ module Aws::RDS
1629
2189
  # (72 hours).
1630
2190
  #
1631
2191
  # ^
2192
+ #
2193
+ # Valid for: Aurora MySQL DB clusters only
1632
2194
  # @option options [Array<String>] :enable_cloudwatch_logs_exports
1633
2195
  # The list of logs that the restored DB cluster is to export to
1634
2196
  # CloudWatch Logs. The values in the list depend on the DB engine being
1635
- # used. For more information, see [Publishing Database Logs to Amazon
2197
+ # used.
2198
+ #
2199
+ # For more information, see [Publishing Database Logs to Amazon
1636
2200
  # CloudWatch Logs][1] in the *Amazon Aurora User Guide*.
1637
2201
  #
2202
+ # Valid for: Aurora DB clusters only
2203
+ #
1638
2204
  #
1639
2205
  #
1640
2206
  # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch
@@ -1653,14 +2219,20 @@ module Aws::RDS
1653
2219
  # * First character must be a letter.
1654
2220
  #
1655
2221
  # * Can't end with a hyphen or contain two consecutive hyphens.
2222
+ #
2223
+ # Valid for: Aurora DB clusters and Multi-AZ DB clusters
1656
2224
  # @option options [Boolean] :deletion_protection
1657
2225
  # A value that indicates whether the DB cluster has deletion protection
1658
2226
  # enabled. The database can't be deleted when deletion protection is
1659
- # enabled. By default, deletion protection is disabled.
2227
+ # enabled. By default, deletion protection isn't enabled.
2228
+ #
2229
+ # Valid for: Aurora DB clusters and Multi-AZ DB clusters
1660
2230
  # @option options [Boolean] :copy_tags_to_snapshot
1661
2231
  # A value that indicates whether to copy all tags from the restored DB
1662
2232
  # cluster to snapshots of the restored DB cluster. The default is not to
1663
2233
  # copy them.
2234
+ #
2235
+ # Valid for: Aurora DB clusters only
1664
2236
  # @option options [String] :domain
1665
2237
  # Specify the Active Directory directory ID to restore the DB cluster
1666
2238
  # in. The domain must be created prior to this operation.
@@ -1670,15 +2242,21 @@ module Aws::RDS
1670
2242
  # For more information, see [Kerberos Authentication][1] in the *Amazon
1671
2243
  # Aurora User Guide*.
1672
2244
  #
2245
+ # Valid for: Aurora DB clusters only
2246
+ #
1673
2247
  #
1674
2248
  #
1675
2249
  # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/kerberos-authentication.html
1676
2250
  # @option options [String] :domain_iam_role_name
1677
2251
  # Specify the name of the IAM role to be used when making API calls to
1678
2252
  # the Directory Service.
2253
+ #
2254
+ # Valid for: Aurora DB clusters only
1679
2255
  # @option options [Types::ScalingConfiguration] :scaling_configuration
1680
2256
  # For DB clusters in `serverless` DB engine mode, the scaling properties
1681
2257
  # of the DB cluster.
2258
+ #
2259
+ # Valid for: Aurora DB clusters only
1682
2260
  # @option options [String] :engine_mode
1683
2261
  # The engine mode of the new cluster. Specify `provisioned` or
1684
2262
  # `serverless`, depending on the type of the cluster you are creating.
@@ -1686,6 +2264,86 @@ module Aws::RDS
1686
2264
  # or a provisioned clone from an Aurora Serverless cluster. To create a
1687
2265
  # clone that is an Aurora Serverless cluster, the original cluster must
1688
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
1689
2347
  # @return [DBCluster]
1690
2348
  def restore(options = {})
1691
2349
  options = options.merge(source_db_cluster_identifier: @id)