aws-sdk-rds 1.129.0 → 1.133.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 +20 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-rds/client.rb +1518 -358
- data/lib/aws-sdk-rds/client_api.rb +65 -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 +113 -118
- data/lib/aws-sdk-rds/db_snapshot.rb +33 -11
- data/lib/aws-sdk-rds/plugins/cross_region_copying.rb +5 -1
- data/lib/aws-sdk-rds/resource.rb +361 -106
- data/lib/aws-sdk-rds/types.rb +1731 -313
- data/lib/aws-sdk-rds.rb +1 -1
- metadata +4 -4
@@ -217,6 +217,14 @@ module Aws::RDS
|
|
217
217
|
#
|
218
218
|
# Example: `aurora-postgresql9.6`
|
219
219
|
#
|
220
|
+
# **RDS for MySQL**
|
221
|
+
#
|
222
|
+
# Example: `mysql8.0`
|
223
|
+
#
|
224
|
+
# **RDS for PostgreSQL**
|
225
|
+
#
|
226
|
+
# Example: `postgres12`
|
227
|
+
#
|
220
228
|
# To list all of the available parameter group families for a DB engine,
|
221
229
|
# use the following command:
|
222
230
|
#
|
@@ -241,6 +249,10 @@ module Aws::RDS
|
|
241
249
|
# * `aurora-mysql` (for MySQL 5.7-compatible Aurora)
|
242
250
|
#
|
243
251
|
# * `aurora-postgresql`
|
252
|
+
#
|
253
|
+
# * `mysql`
|
254
|
+
#
|
255
|
+
# * `postgres`
|
244
256
|
# @option options [required, String] :description
|
245
257
|
# The description for the DB cluster parameter group.
|
246
258
|
# @option options [Array<Types::Tag>] :tags
|
@@ -530,11 +530,17 @@ module Aws::RDS
|
|
530
530
|
# copy_tags_to_snapshot: false,
|
531
531
|
# domain: "String",
|
532
532
|
# domain_iam_role_name: "String",
|
533
|
+
# db_cluster_instance_class: "String",
|
534
|
+
# storage_type: "String",
|
535
|
+
# iops: 1,
|
536
|
+
# publicly_accessible: false,
|
533
537
|
# })
|
534
538
|
# @param [Hash] options ({})
|
535
539
|
# @option options [Array<String>] :availability_zones
|
536
540
|
# Provides the list of Availability Zones (AZs) where instances in the
|
537
541
|
# restored DB cluster can be created.
|
542
|
+
#
|
543
|
+
# Valid for: Aurora DB clusters only
|
538
544
|
# @option options [required, String] :db_cluster_identifier
|
539
545
|
# The name of the DB cluster to create from the DB snapshot or DB
|
540
546
|
# cluster snapshot. This parameter isn't case-sensitive.
|
@@ -548,52 +554,84 @@ module Aws::RDS
|
|
548
554
|
# * Can't end with a hyphen or contain two consecutive hyphens
|
549
555
|
#
|
550
556
|
# Example: `my-snapshot-id`
|
557
|
+
#
|
558
|
+
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
551
559
|
# @option options [required, String] :engine
|
552
560
|
# The database engine to use for the new DB cluster.
|
553
561
|
#
|
554
562
|
# Default: The same as source
|
555
563
|
#
|
556
564
|
# Constraint: Must be compatible with the engine of the source
|
565
|
+
#
|
566
|
+
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
557
567
|
# @option options [String] :engine_version
|
558
568
|
# The version of the database engine to use for the new DB cluster.
|
559
569
|
#
|
560
|
-
# To list all of the available engine versions for
|
561
|
-
#
|
570
|
+
# To list all of the available engine versions for MySQL 5.6-compatible
|
571
|
+
# Aurora, use the following command:
|
562
572
|
#
|
563
573
|
# `aws rds describe-db-engine-versions --engine aurora --query
|
564
574
|
# "DBEngineVersions[].EngineVersion"`
|
565
575
|
#
|
566
|
-
# To list all of the available engine versions for
|
567
|
-
#
|
576
|
+
# To list all of the available engine versions for MySQL 5.7-compatible
|
577
|
+
# Aurora, use the following command:
|
568
578
|
#
|
569
579
|
# `aws rds describe-db-engine-versions --engine aurora-mysql --query
|
570
580
|
# "DBEngineVersions[].EngineVersion"`
|
571
581
|
#
|
572
|
-
# To list all of the available engine versions for
|
582
|
+
# To list all of the available engine versions for Aurora PostgreSQL,
|
573
583
|
# use the following command:
|
574
584
|
#
|
575
585
|
# `aws rds describe-db-engine-versions --engine aurora-postgresql
|
576
586
|
# --query "DBEngineVersions[].EngineVersion"`
|
577
587
|
#
|
578
|
-
#
|
579
|
-
# the
|
588
|
+
# To list all of the available engine versions for RDS for MySQL, use
|
589
|
+
# the following command:
|
580
590
|
#
|
581
|
-
#
|
591
|
+
# `aws rds describe-db-engine-versions --engine mysql --query
|
592
|
+
# "DBEngineVersions[].EngineVersion"`
|
593
|
+
#
|
594
|
+
# To list all of the available engine versions for RDS for PostgreSQL,
|
595
|
+
# use the following command:
|
596
|
+
#
|
597
|
+
# `aws rds describe-db-engine-versions --engine postgres --query
|
598
|
+
# "DBEngineVersions[].EngineVersion"`
|
582
599
|
#
|
583
600
|
# **Aurora MySQL**
|
584
601
|
#
|
585
|
-
#
|
586
|
-
#
|
602
|
+
# See [MySQL on Amazon RDS Versions][1] in the *Amazon Aurora User
|
603
|
+
# Guide.*
|
587
604
|
#
|
588
605
|
# **Aurora PostgreSQL**
|
589
606
|
#
|
590
|
-
#
|
607
|
+
# See [Amazon Aurora PostgreSQL releases and engine versions][2] in the
|
608
|
+
# *Amazon Aurora User Guide.*
|
609
|
+
#
|
610
|
+
# **MySQL**
|
611
|
+
#
|
612
|
+
# See [MySQL on Amazon RDS Versions][3] in the *Amazon RDS User Guide.*
|
613
|
+
#
|
614
|
+
# **PostgreSQL**
|
615
|
+
#
|
616
|
+
# See [Amazon RDS for PostgreSQL versions and extensions][4] in the
|
617
|
+
# *Amazon RDS User Guide.*
|
618
|
+
#
|
619
|
+
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
620
|
+
#
|
621
|
+
#
|
622
|
+
#
|
623
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraMySQL.Updates.html
|
624
|
+
# [2]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraPostgreSQL.Updates.20180305.html
|
625
|
+
# [3]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MySQL.html#MySQL.Concepts.VersionMgmt
|
626
|
+
# [4]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_PostgreSQL.html#PostgreSQL.Concepts
|
591
627
|
# @option options [Integer] :port
|
592
628
|
# The port number on which the new DB cluster accepts connections.
|
593
629
|
#
|
594
630
|
# Constraints: This value must be `1150-65535`
|
595
631
|
#
|
596
632
|
# Default: The same port as the original DB cluster.
|
633
|
+
#
|
634
|
+
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
597
635
|
# @option options [String] :db_subnet_group_name
|
598
636
|
# The name of the DB subnet group to use for the new DB cluster.
|
599
637
|
#
|
@@ -601,14 +639,25 @@ module Aws::RDS
|
|
601
639
|
# group.
|
602
640
|
#
|
603
641
|
# Example: `mySubnetgroup`
|
642
|
+
#
|
643
|
+
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
604
644
|
# @option options [String] :database_name
|
605
645
|
# The database name for the restored DB cluster.
|
646
|
+
#
|
647
|
+
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
606
648
|
# @option options [String] :option_group_name
|
607
649
|
# The name of the option group to use for the restored DB cluster.
|
650
|
+
#
|
651
|
+
# DB clusters are associated with a default option group that can't be
|
652
|
+
# modified.
|
608
653
|
# @option options [Array<String>] :vpc_security_group_ids
|
609
654
|
# A list of VPC security groups that the new DB cluster will belong to.
|
655
|
+
#
|
656
|
+
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
610
657
|
# @option options [Array<Types::Tag>] :tags
|
611
658
|
# The tags to be assigned to the restored DB cluster.
|
659
|
+
#
|
660
|
+
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
612
661
|
# @option options [String] :kms_key_id
|
613
662
|
# The Amazon Web Services KMS key identifier to use when restoring an
|
614
663
|
# encrypted DB cluster from a DB snapshot or DB cluster snapshot.
|
@@ -627,14 +676,18 @@ module Aws::RDS
|
|
627
676
|
#
|
628
677
|
# * If the DB snapshot or DB cluster snapshot in `SnapshotIdentifier`
|
629
678
|
# isn't encrypted, then the restored DB cluster isn't encrypted.
|
679
|
+
#
|
680
|
+
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
630
681
|
# @option options [Boolean] :enable_iam_database_authentication
|
631
682
|
# A value that indicates whether to enable mapping of Amazon Web
|
632
683
|
# Services Identity and Access Management (IAM) accounts to database
|
633
|
-
# accounts. By default, mapping
|
684
|
+
# accounts. By default, mapping isn't enabled.
|
634
685
|
#
|
635
686
|
# For more information, see [ IAM Database Authentication][1] in the
|
636
687
|
# *Amazon Aurora User Guide.*
|
637
688
|
#
|
689
|
+
# Valid for: Aurora DB clusters only
|
690
|
+
#
|
638
691
|
#
|
639
692
|
#
|
640
693
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.IAMDBAuth.html
|
@@ -654,12 +707,18 @@ module Aws::RDS
|
|
654
707
|
# (72 hours).
|
655
708
|
#
|
656
709
|
# ^
|
710
|
+
#
|
711
|
+
# Valid for: Aurora DB clusters only
|
657
712
|
# @option options [Array<String>] :enable_cloudwatch_logs_exports
|
658
713
|
# The list of logs that the restored DB cluster is to export to Amazon
|
659
714
|
# CloudWatch Logs. The values in the list depend on the DB engine being
|
660
|
-
# used.
|
715
|
+
# used.
|
716
|
+
#
|
717
|
+
# For more information, see [Publishing Database Logs to Amazon
|
661
718
|
# CloudWatch Logs ][1] in the *Amazon Aurora User Guide*.
|
662
719
|
#
|
720
|
+
# Valid for: Aurora DB clusters only
|
721
|
+
#
|
663
722
|
#
|
664
723
|
#
|
665
724
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch
|
@@ -669,12 +728,16 @@ module Aws::RDS
|
|
669
728
|
#
|
670
729
|
# For more information, see [ CreateDBCluster][1].
|
671
730
|
#
|
731
|
+
# Valid for: Aurora DB clusters only
|
732
|
+
#
|
672
733
|
#
|
673
734
|
#
|
674
735
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBCluster.html
|
675
736
|
# @option options [Types::ScalingConfiguration] :scaling_configuration
|
676
737
|
# For DB clusters in `serverless` DB engine mode, the scaling properties
|
677
738
|
# of the DB cluster.
|
739
|
+
#
|
740
|
+
# Valid for: Aurora DB clusters only
|
678
741
|
# @option options [String] :db_cluster_parameter_group_name
|
679
742
|
# The name of the DB cluster parameter group to associate with this DB
|
680
743
|
# cluster. If this argument is omitted, the default DB cluster parameter
|
@@ -690,14 +753,20 @@ module Aws::RDS
|
|
690
753
|
# * First character must be a letter.
|
691
754
|
#
|
692
755
|
# * Can't end with a hyphen or contain two consecutive hyphens.
|
756
|
+
#
|
757
|
+
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
693
758
|
# @option options [Boolean] :deletion_protection
|
694
759
|
# A value that indicates whether the DB cluster has deletion protection
|
695
760
|
# enabled. The database can't be deleted when deletion protection is
|
696
|
-
# enabled. By default, deletion protection
|
761
|
+
# enabled. By default, deletion protection isn't enabled.
|
762
|
+
#
|
763
|
+
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
697
764
|
# @option options [Boolean] :copy_tags_to_snapshot
|
698
765
|
# A value that indicates whether to copy all tags from the restored DB
|
699
766
|
# cluster to snapshots of the restored DB cluster. The default is not to
|
700
767
|
# copy them.
|
768
|
+
#
|
769
|
+
# Valid for: Aurora DB clusters only
|
701
770
|
# @option options [String] :domain
|
702
771
|
# Specify the Active Directory directory ID to restore the DB cluster
|
703
772
|
# in. The domain must be created prior to this operation. Currently,
|
@@ -707,12 +776,95 @@ module Aws::RDS
|
|
707
776
|
# For more information, see [ Kerberos Authentication][1] in the *Amazon
|
708
777
|
# RDS User Guide*.
|
709
778
|
#
|
779
|
+
# Valid for: Aurora DB clusters only
|
780
|
+
#
|
710
781
|
#
|
711
782
|
#
|
712
783
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/kerberos-authentication.html
|
713
784
|
# @option options [String] :domain_iam_role_name
|
714
785
|
# Specify the name of the IAM role to be used when making API calls to
|
715
786
|
# the Directory Service.
|
787
|
+
#
|
788
|
+
# Valid for: Aurora DB clusters only
|
789
|
+
# @option options [String] :db_cluster_instance_class
|
790
|
+
# The compute and memory capacity of the each DB instance in the
|
791
|
+
# Multi-AZ DB cluster, for example db.m6g.xlarge. Not all DB instance
|
792
|
+
# classes are available in all Amazon Web Services Regions, or for all
|
793
|
+
# database engines.
|
794
|
+
#
|
795
|
+
# For the full list of DB instance classes, and availability for your
|
796
|
+
# engine, see [DB Instance Class][1] in the *Amazon RDS User Guide.*
|
797
|
+
#
|
798
|
+
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
799
|
+
#
|
800
|
+
#
|
801
|
+
#
|
802
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html
|
803
|
+
# @option options [String] :storage_type
|
804
|
+
# Specifies the storage type to be associated with the each DB instance
|
805
|
+
# in the Multi-AZ DB cluster.
|
806
|
+
#
|
807
|
+
# Valid values: `standard | gp2 | io1`
|
808
|
+
#
|
809
|
+
# If you specify `io1`, you must also include a value for the `Iops`
|
810
|
+
# parameter.
|
811
|
+
#
|
812
|
+
# Default: `io1` if the `Iops` parameter is specified, otherwise `gp2`
|
813
|
+
#
|
814
|
+
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
815
|
+
# @option options [Integer] :iops
|
816
|
+
# The amount of Provisioned IOPS (input/output operations per second) to
|
817
|
+
# be initially allocated for each DB instance in the Multi-AZ DB
|
818
|
+
# cluster.
|
819
|
+
#
|
820
|
+
# For information about valid Iops values, see [Amazon RDS Provisioned
|
821
|
+
# IOPS Storage to Improve Performance][1] in the *Amazon RDS User
|
822
|
+
# Guide*.
|
823
|
+
#
|
824
|
+
# Constraints: Must be a multiple between .5 and 50 of the storage
|
825
|
+
# amount for the DB instance.
|
826
|
+
#
|
827
|
+
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
828
|
+
#
|
829
|
+
#
|
830
|
+
#
|
831
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html#USER_PIOPS
|
832
|
+
# @option options [Boolean] :publicly_accessible
|
833
|
+
# A value that indicates whether the DB cluster is publicly accessible.
|
834
|
+
#
|
835
|
+
# When the DB cluster is publicly accessible, its Domain Name System
|
836
|
+
# (DNS) endpoint resolves to the private IP address from within the DB
|
837
|
+
# cluster's virtual private cloud (VPC). It resolves to the public IP
|
838
|
+
# address from outside of the DB cluster's VPC. Access to the DB
|
839
|
+
# cluster is ultimately controlled by the security group it uses. That
|
840
|
+
# public access is not permitted if the security group assigned to the
|
841
|
+
# DB cluster doesn't permit it.
|
842
|
+
#
|
843
|
+
# When the DB cluster isn't publicly accessible, it is an internal DB
|
844
|
+
# cluster with a DNS name that resolves to a private IP address.
|
845
|
+
#
|
846
|
+
# Default: The default behavior varies depending on whether
|
847
|
+
# `DBSubnetGroupName` is specified.
|
848
|
+
#
|
849
|
+
# If `DBSubnetGroupName` isn't specified, and `PubliclyAccessible`
|
850
|
+
# isn't specified, the following applies:
|
851
|
+
#
|
852
|
+
# * If the default VPC in the target Region doesn’t have an internet
|
853
|
+
# gateway attached to it, the DB cluster is private.
|
854
|
+
#
|
855
|
+
# * If the default VPC in the target Region has an internet gateway
|
856
|
+
# attached to it, the DB cluster is public.
|
857
|
+
#
|
858
|
+
# If `DBSubnetGroupName` is specified, and `PubliclyAccessible` isn't
|
859
|
+
# specified, the following applies:
|
860
|
+
#
|
861
|
+
# * If the subnets are part of a VPC that doesn’t have an internet
|
862
|
+
# gateway attached to it, the DB cluster is private.
|
863
|
+
#
|
864
|
+
# * If the subnets are part of a VPC that has an internet gateway
|
865
|
+
# attached to it, the DB cluster is public.
|
866
|
+
#
|
867
|
+
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
716
868
|
# @return [DBCluster]
|
717
869
|
def restore(options = {})
|
718
870
|
options = options.merge(snapshot_identifier: @snapshot_id)
|