aws-sdk-rds 1.290.0 → 1.302.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 +60 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-rds/client.rb +2281 -1392
- data/lib/aws-sdk-rds/client_api.rb +346 -159
- data/lib/aws-sdk-rds/customizations.rb +0 -1
- data/lib/aws-sdk-rds/db_cluster.rb +421 -345
- data/lib/aws-sdk-rds/db_cluster_parameter_group.rb +2 -2
- data/lib/aws-sdk-rds/db_cluster_snapshot.rb +44 -25
- data/lib/aws-sdk-rds/db_engine_version.rb +71 -55
- data/lib/aws-sdk-rds/db_instance.rb +518 -308
- data/lib/aws-sdk-rds/db_parameter_group.rb +2 -2
- data/lib/aws-sdk-rds/db_snapshot.rb +117 -74
- data/lib/aws-sdk-rds/endpoint_parameters.rb +4 -4
- data/lib/aws-sdk-rds/errors.rb +11 -0
- data/lib/aws-sdk-rds/option_group.rb +1 -1
- data/lib/aws-sdk-rds/resource.rb +295 -227
- data/lib/aws-sdk-rds/types.rb +1945 -1061
- data/lib/aws-sdk-rds.rb +1 -1
- data/sig/client.rbs +314 -110
- data/sig/db_cluster.rbs +92 -65
- data/sig/db_cluster_snapshot.rbs +18 -7
- data/sig/db_engine_version.rbs +27 -21
- data/sig/db_instance.rbs +154 -47
- data/sig/db_snapshot.rbs +39 -15
- data/sig/errors.rbs +2 -0
- data/sig/event.rbs +1 -1
- data/sig/resource.rbs +55 -21
- data/sig/types.rbs +233 -118
- metadata +3 -3
|
@@ -60,12 +60,6 @@ module Aws::RDS
|
|
|
60
60
|
data[:db_instance_status]
|
|
61
61
|
end
|
|
62
62
|
|
|
63
|
-
# The time when a stopped DB instance is restarted automatically.
|
|
64
|
-
# @return [Time]
|
|
65
|
-
def automatic_restart_time
|
|
66
|
-
data[:automatic_restart_time]
|
|
67
|
-
end
|
|
68
|
-
|
|
69
63
|
# The master username for the DB instance.
|
|
70
64
|
# @return [String]
|
|
71
65
|
def master_username
|
|
@@ -159,6 +153,20 @@ module Aws::RDS
|
|
|
159
153
|
data[:preferred_maintenance_window]
|
|
160
154
|
end
|
|
161
155
|
|
|
156
|
+
# This data type represents the order in which the instances are
|
|
157
|
+
# upgraded.
|
|
158
|
+
#
|
|
159
|
+
# * \[first\] - Typically used for development or testing environments.
|
|
160
|
+
#
|
|
161
|
+
# * \[second\] - Default order for resources not specifically
|
|
162
|
+
# configured.
|
|
163
|
+
#
|
|
164
|
+
# * \[last\] - Usually reserved for production environments.
|
|
165
|
+
# @return [String]
|
|
166
|
+
def upgrade_rollout_order
|
|
167
|
+
data[:upgrade_rollout_order]
|
|
168
|
+
end
|
|
169
|
+
|
|
162
170
|
# Information about pending changes to the DB instance. This information
|
|
163
171
|
# is returned only when there are pending changes. Specific changes are
|
|
164
172
|
# identified by subelements.
|
|
@@ -260,6 +268,14 @@ module Aws::RDS
|
|
|
260
268
|
data[:iops]
|
|
261
269
|
end
|
|
262
270
|
|
|
271
|
+
# The storage throughput for the DB instance.
|
|
272
|
+
#
|
|
273
|
+
# This setting applies only to the `gp3` storage type.
|
|
274
|
+
# @return [Integer]
|
|
275
|
+
def storage_throughput
|
|
276
|
+
data[:storage_throughput]
|
|
277
|
+
end
|
|
278
|
+
|
|
263
279
|
# The list of option group memberships for this DB instance.
|
|
264
280
|
# @return [Array<Types::OptionGroupMembership>]
|
|
265
281
|
def option_group_memberships
|
|
@@ -580,11 +596,21 @@ module Aws::RDS
|
|
|
580
596
|
data[:tag_list]
|
|
581
597
|
end
|
|
582
598
|
|
|
583
|
-
# The
|
|
584
|
-
# instance
|
|
585
|
-
#
|
|
586
|
-
|
|
587
|
-
|
|
599
|
+
# The automation mode of the RDS Custom DB instance: `full` or `all
|
|
600
|
+
# paused`. If `full`, the DB instance automates monitoring and instance
|
|
601
|
+
# recovery. If `all paused`, the instance pauses automation for the
|
|
602
|
+
# duration set by `--resume-full-automation-mode-minutes`.
|
|
603
|
+
# @return [String]
|
|
604
|
+
def automation_mode
|
|
605
|
+
data[:automation_mode]
|
|
606
|
+
end
|
|
607
|
+
|
|
608
|
+
# The number of minutes to pause the automation. When the time period
|
|
609
|
+
# ends, RDS Custom resumes full automation. The minimum value is 60
|
|
610
|
+
# (default). The maximum value is 1,440.
|
|
611
|
+
# @return [Time]
|
|
612
|
+
def resume_full_automation_mode_time
|
|
613
|
+
data[:resume_full_automation_mode_time]
|
|
588
614
|
end
|
|
589
615
|
|
|
590
616
|
# Indicates whether a customer-owned IP address (CoIP) is enabled for an
|
|
@@ -612,11 +638,25 @@ module Aws::RDS
|
|
|
612
638
|
data[:customer_owned_ip_enabled]
|
|
613
639
|
end
|
|
614
640
|
|
|
615
|
-
# The
|
|
616
|
-
#
|
|
641
|
+
# The network type of the DB instance.
|
|
642
|
+
#
|
|
643
|
+
# The network type is determined by the `DBSubnetGroup` specified for
|
|
644
|
+
# the DB instance. A `DBSubnetGroup` can support only the IPv4 protocol
|
|
645
|
+
# or the IPv4 and the IPv6 protocols (`DUAL`).
|
|
646
|
+
#
|
|
647
|
+
# For more information, see [ Working with a DB instance in a VPC][1] in
|
|
648
|
+
# the *Amazon RDS User Guide* and [ Working with a DB instance in a
|
|
649
|
+
# VPC][2] in the *Amazon Aurora User Guide.*
|
|
650
|
+
#
|
|
651
|
+
# Valid Values: `IPV4 | DUAL`
|
|
652
|
+
#
|
|
653
|
+
#
|
|
654
|
+
#
|
|
655
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html
|
|
656
|
+
# [2]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html
|
|
617
657
|
# @return [String]
|
|
618
|
-
def
|
|
619
|
-
data[:
|
|
658
|
+
def network_type
|
|
659
|
+
data[:network_type]
|
|
620
660
|
end
|
|
621
661
|
|
|
622
662
|
# The status of the database activity stream.
|
|
@@ -656,21 +696,32 @@ module Aws::RDS
|
|
|
656
696
|
data[:activity_stream_engine_native_audit_fields_included]
|
|
657
697
|
end
|
|
658
698
|
|
|
659
|
-
# The
|
|
660
|
-
#
|
|
661
|
-
# recovery. If `all paused`, the instance pauses automation for the
|
|
662
|
-
# duration set by `--resume-full-automation-mode-minutes`.
|
|
699
|
+
# The Amazon Resource Name (ARN) of the recovery point in Amazon Web
|
|
700
|
+
# Services Backup.
|
|
663
701
|
# @return [String]
|
|
664
|
-
def
|
|
665
|
-
data[:
|
|
702
|
+
def aws_backup_recovery_point_arn
|
|
703
|
+
data[:aws_backup_recovery_point_arn]
|
|
666
704
|
end
|
|
667
705
|
|
|
668
|
-
# The
|
|
669
|
-
#
|
|
670
|
-
#
|
|
706
|
+
# The list of replicated automated backups associated with the DB
|
|
707
|
+
# instance.
|
|
708
|
+
# @return [Array<Types::DBInstanceAutomatedBackupsReplication>]
|
|
709
|
+
def db_instance_automated_backups_replications
|
|
710
|
+
data[:db_instance_automated_backups_replications]
|
|
711
|
+
end
|
|
712
|
+
|
|
713
|
+
# The location where automated backups and manual snapshots are stored:
|
|
714
|
+
# Dedicated Local Zones, Amazon Web Services Outposts or the Amazon Web
|
|
715
|
+
# Services Region.
|
|
716
|
+
# @return [String]
|
|
717
|
+
def backup_target
|
|
718
|
+
data[:backup_target]
|
|
719
|
+
end
|
|
720
|
+
|
|
721
|
+
# The time when a stopped DB instance is restarted automatically.
|
|
671
722
|
# @return [Time]
|
|
672
|
-
def
|
|
673
|
-
data[:
|
|
723
|
+
def automatic_restart_time
|
|
724
|
+
data[:automatic_restart_time]
|
|
674
725
|
end
|
|
675
726
|
|
|
676
727
|
# The instance profile associated with the underlying Amazon EC2
|
|
@@ -696,47 +747,16 @@ module Aws::RDS
|
|
|
696
747
|
data[:custom_iam_instance_profile]
|
|
697
748
|
end
|
|
698
749
|
|
|
699
|
-
# The location where automated backups and manual snapshots are stored:
|
|
700
|
-
# Dedicated Local Zones, Amazon Web Services Outposts or the Amazon Web
|
|
701
|
-
# Services Region.
|
|
702
|
-
# @return [String]
|
|
703
|
-
def backup_target
|
|
704
|
-
data[:backup_target]
|
|
705
|
-
end
|
|
706
|
-
|
|
707
|
-
# The network type of the DB instance.
|
|
708
|
-
#
|
|
709
|
-
# The network type is determined by the `DBSubnetGroup` specified for
|
|
710
|
-
# the DB instance. A `DBSubnetGroup` can support only the IPv4 protocol
|
|
711
|
-
# or the IPv4 and the IPv6 protocols (`DUAL`).
|
|
712
|
-
#
|
|
713
|
-
# For more information, see [ Working with a DB instance in a VPC][1] in
|
|
714
|
-
# the *Amazon RDS User Guide* and [ Working with a DB instance in a
|
|
715
|
-
# VPC][2] in the *Amazon Aurora User Guide.*
|
|
716
|
-
#
|
|
717
|
-
# Valid Values: `IPV4 | DUAL`
|
|
718
|
-
#
|
|
719
|
-
#
|
|
720
|
-
#
|
|
721
|
-
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html
|
|
722
|
-
# [2]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html
|
|
723
|
-
# @return [String]
|
|
724
|
-
def network_type
|
|
725
|
-
data[:network_type]
|
|
726
|
-
end
|
|
727
|
-
|
|
728
750
|
# The status of the policy state of the activity stream.
|
|
729
751
|
# @return [String]
|
|
730
752
|
def activity_stream_policy_status
|
|
731
753
|
data[:activity_stream_policy_status]
|
|
732
754
|
end
|
|
733
755
|
|
|
734
|
-
# The
|
|
735
|
-
#
|
|
736
|
-
|
|
737
|
-
|
|
738
|
-
def storage_throughput
|
|
739
|
-
data[:storage_throughput]
|
|
756
|
+
# The details of the DB instance's server certificate.
|
|
757
|
+
# @return [Types::CertificateDetails]
|
|
758
|
+
def certificate_details
|
|
759
|
+
data[:certificate_details]
|
|
740
760
|
end
|
|
741
761
|
|
|
742
762
|
# The Oracle system ID (Oracle SID) for a container database (CDB). The
|
|
@@ -761,12 +781,6 @@ module Aws::RDS
|
|
|
761
781
|
data[:master_user_secret]
|
|
762
782
|
end
|
|
763
783
|
|
|
764
|
-
# The details of the DB instance's server certificate.
|
|
765
|
-
# @return [Types::CertificateDetails]
|
|
766
|
-
def certificate_details
|
|
767
|
-
data[:certificate_details]
|
|
768
|
-
end
|
|
769
|
-
|
|
770
784
|
# The identifier of the source DB cluster if this DB instance is a read
|
|
771
785
|
# replica.
|
|
772
786
|
# @return [String]
|
|
@@ -780,6 +794,13 @@ module Aws::RDS
|
|
|
780
794
|
data[:percent_progress]
|
|
781
795
|
end
|
|
782
796
|
|
|
797
|
+
# Specifies whether the DB instance is in the multi-tenant configuration
|
|
798
|
+
# (TRUE) or the single-tenant configuration (FALSE).
|
|
799
|
+
# @return [Boolean]
|
|
800
|
+
def multi_tenant
|
|
801
|
+
data[:multi_tenant]
|
|
802
|
+
end
|
|
803
|
+
|
|
783
804
|
# Indicates whether the DB instance has a dedicated log volume (DLV)
|
|
784
805
|
# enabled.
|
|
785
806
|
# @return [Boolean]
|
|
@@ -801,13 +822,6 @@ module Aws::RDS
|
|
|
801
822
|
data[:is_storage_config_upgrade_available]
|
|
802
823
|
end
|
|
803
824
|
|
|
804
|
-
# Specifies whether the DB instance is in the multi-tenant configuration
|
|
805
|
-
# (TRUE) or the single-tenant configuration (FALSE).
|
|
806
|
-
# @return [Boolean]
|
|
807
|
-
def multi_tenant
|
|
808
|
-
data[:multi_tenant]
|
|
809
|
-
end
|
|
810
|
-
|
|
811
825
|
# The lifecycle type for the DB instance.
|
|
812
826
|
#
|
|
813
827
|
# For more information, see CreateDBInstance.
|
|
@@ -816,6 +830,22 @@ module Aws::RDS
|
|
|
816
830
|
data[:engine_lifecycle_support]
|
|
817
831
|
end
|
|
818
832
|
|
|
833
|
+
# The additional storage volumes associated with the DB instance. RDS
|
|
834
|
+
# supports additional storage volumes for RDS for Oracle and RDS for SQL
|
|
835
|
+
# Server.
|
|
836
|
+
# @return [Array<Types::AdditionalStorageVolumeOutput>]
|
|
837
|
+
def additional_storage_volumes
|
|
838
|
+
data[:additional_storage_volumes]
|
|
839
|
+
end
|
|
840
|
+
|
|
841
|
+
# The detailed status information for storage volumes associated with
|
|
842
|
+
# the DB instance. This information helps identify which specific volume
|
|
843
|
+
# is causing the instance to be in a storage-full state.
|
|
844
|
+
# @return [String]
|
|
845
|
+
def storage_volume_status
|
|
846
|
+
data[:storage_volume_status]
|
|
847
|
+
end
|
|
848
|
+
|
|
819
849
|
# @!endgroup
|
|
820
850
|
|
|
821
851
|
# @return [Client]
|
|
@@ -962,7 +992,7 @@ module Aws::RDS
|
|
|
962
992
|
# db_instance_class: "String", # required
|
|
963
993
|
# engine: "String", # required
|
|
964
994
|
# master_username: "String",
|
|
965
|
-
# master_user_password: "
|
|
995
|
+
# master_user_password: "SensitiveString",
|
|
966
996
|
# db_security_groups: ["String"],
|
|
967
997
|
# vpc_security_group_ids: ["String"],
|
|
968
998
|
# availability_zone: "String",
|
|
@@ -977,6 +1007,7 @@ module Aws::RDS
|
|
|
977
1007
|
# auto_minor_version_upgrade: false,
|
|
978
1008
|
# license_model: "String",
|
|
979
1009
|
# iops: 1,
|
|
1010
|
+
# storage_throughput: 1,
|
|
980
1011
|
# option_group_name: "String",
|
|
981
1012
|
# character_set_name: "String",
|
|
982
1013
|
# nchar_character_set_name: "String",
|
|
@@ -990,7 +1021,7 @@ module Aws::RDS
|
|
|
990
1021
|
# db_cluster_identifier: "String",
|
|
991
1022
|
# storage_type: "String",
|
|
992
1023
|
# tde_credential_arn: "String",
|
|
993
|
-
# tde_credential_password: "
|
|
1024
|
+
# tde_credential_password: "SensitiveString",
|
|
994
1025
|
# storage_encrypted: false,
|
|
995
1026
|
# kms_key_id: "String",
|
|
996
1027
|
# domain: "String",
|
|
@@ -1019,17 +1050,38 @@ module Aws::RDS
|
|
|
1019
1050
|
# deletion_protection: false,
|
|
1020
1051
|
# max_allocated_storage: 1,
|
|
1021
1052
|
# enable_customer_owned_ip: false,
|
|
1022
|
-
# custom_iam_instance_profile: "String",
|
|
1023
|
-
# backup_target: "String",
|
|
1024
1053
|
# network_type: "String",
|
|
1025
|
-
#
|
|
1054
|
+
# backup_target: "String",
|
|
1055
|
+
# custom_iam_instance_profile: "String",
|
|
1056
|
+
# db_system_id: "String",
|
|
1057
|
+
# ca_certificate_identifier: "String",
|
|
1026
1058
|
# manage_master_user_password: false,
|
|
1027
1059
|
# master_user_secret_kms_key_id: "String",
|
|
1028
|
-
# ca_certificate_identifier: "String",
|
|
1029
|
-
# db_system_id: "String",
|
|
1030
|
-
# dedicated_log_volume: false,
|
|
1031
1060
|
# multi_tenant: false,
|
|
1061
|
+
# dedicated_log_volume: false,
|
|
1032
1062
|
# engine_lifecycle_support: "String",
|
|
1063
|
+
# tag_specifications: [
|
|
1064
|
+
# {
|
|
1065
|
+
# resource_type: "String",
|
|
1066
|
+
# tags: [
|
|
1067
|
+
# {
|
|
1068
|
+
# key: "String",
|
|
1069
|
+
# value: "String",
|
|
1070
|
+
# },
|
|
1071
|
+
# ],
|
|
1072
|
+
# },
|
|
1073
|
+
# ],
|
|
1074
|
+
# master_user_authentication_type: "password", # accepts password, iam-db-auth
|
|
1075
|
+
# additional_storage_volumes: [
|
|
1076
|
+
# {
|
|
1077
|
+
# volume_name: "String", # required
|
|
1078
|
+
# allocated_storage: 1,
|
|
1079
|
+
# iops: 1,
|
|
1080
|
+
# max_allocated_storage: 1,
|
|
1081
|
+
# storage_throughput: 1,
|
|
1082
|
+
# storage_type: "String",
|
|
1083
|
+
# },
|
|
1084
|
+
# ],
|
|
1033
1085
|
# })
|
|
1034
1086
|
# @param [Hash] options ({})
|
|
1035
1087
|
# @option options [String] :db_name
|
|
@@ -1337,6 +1389,8 @@ module Aws::RDS
|
|
|
1337
1389
|
#
|
|
1338
1390
|
# * `postgres`
|
|
1339
1391
|
#
|
|
1392
|
+
# * `sqlserver-dev-ee`
|
|
1393
|
+
#
|
|
1340
1394
|
# * `sqlserver-ee`
|
|
1341
1395
|
#
|
|
1342
1396
|
# * `sqlserver-se`
|
|
@@ -1691,6 +1745,14 @@ module Aws::RDS
|
|
|
1691
1745
|
#
|
|
1692
1746
|
#
|
|
1693
1747
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html
|
|
1748
|
+
# @option options [Integer] :storage_throughput
|
|
1749
|
+
# The storage throughput value, in mebibyte per second (MiBps), for the
|
|
1750
|
+
# DB instance.
|
|
1751
|
+
#
|
|
1752
|
+
# This setting applies only to the `gp3` storage type.
|
|
1753
|
+
#
|
|
1754
|
+
# This setting doesn't apply to Amazon Aurora or RDS Custom DB
|
|
1755
|
+
# instances.
|
|
1694
1756
|
# @option options [String] :option_group_name
|
|
1695
1757
|
# The option group to associate the DB instance with.
|
|
1696
1758
|
#
|
|
@@ -1720,37 +1782,28 @@ module Aws::RDS
|
|
|
1720
1782
|
# Specifies whether the DB instance is publicly accessible.
|
|
1721
1783
|
#
|
|
1722
1784
|
# When the DB instance is publicly accessible and you connect from
|
|
1723
|
-
# outside of the DB instance's virtual private cloud (VPC), its
|
|
1724
|
-
#
|
|
1785
|
+
# outside of the DB instance's virtual private cloud (VPC), its domain
|
|
1786
|
+
# name system (DNS) endpoint resolves to the public IP address. When you
|
|
1725
1787
|
# connect from within the same VPC as the DB instance, the endpoint
|
|
1726
1788
|
# resolves to the private IP address. Access to the DB instance is
|
|
1727
|
-
#
|
|
1728
|
-
# access is not permitted if the security group assigned to the DB
|
|
1729
|
-
# instance doesn't permit it.
|
|
1789
|
+
# controlled by its security group settings.
|
|
1730
1790
|
#
|
|
1731
1791
|
# When the DB instance isn't publicly accessible, it is an internal DB
|
|
1732
1792
|
# instance with a DNS name that resolves to a private IP address.
|
|
1733
1793
|
#
|
|
1734
|
-
#
|
|
1735
|
-
# `
|
|
1736
|
-
#
|
|
1737
|
-
# If `DBSubnetGroupName` isn't specified, and `PubliclyAccessible`
|
|
1738
|
-
# isn't specified, the following applies:
|
|
1739
|
-
#
|
|
1740
|
-
# * If the default VPC in the target Region doesn’t have an internet
|
|
1741
|
-
# gateway attached to it, the DB instance is private.
|
|
1794
|
+
# The default behavior when `PubliclyAccessible` is not specified
|
|
1795
|
+
# depends on whether a `DBSubnetGroup` is specified.
|
|
1742
1796
|
#
|
|
1743
|
-
#
|
|
1744
|
-
#
|
|
1797
|
+
# If `DBSubnetGroup` isn't specified, `PubliclyAccessible` defaults to
|
|
1798
|
+
# `false` for Aurora instances and `true` for non-Aurora instances.
|
|
1745
1799
|
#
|
|
1746
|
-
# If `
|
|
1747
|
-
#
|
|
1800
|
+
# If `DBSubnetGroup` is specified, `PubliclyAccessible` defaults to
|
|
1801
|
+
# `false` unless the value of `DBSubnetGroup` is `default`, in which
|
|
1802
|
+
# case `PubliclyAccessible` defaults to `true`.
|
|
1748
1803
|
#
|
|
1749
|
-
#
|
|
1750
|
-
#
|
|
1751
|
-
#
|
|
1752
|
-
# * If the subnets are part of a VPC that has an internet gateway
|
|
1753
|
-
# attached to it, the DB instance is public.
|
|
1804
|
+
# If `PubliclyAccessible` is true and the VPC that the `DBSubnetGroup`
|
|
1805
|
+
# is in doesn't have an internet gateway attached to it, Amazon RDS
|
|
1806
|
+
# returns an error.
|
|
1754
1807
|
# @option options [Array<Types::Tag>] :tags
|
|
1755
1808
|
# Tags to assign to the DB instance.
|
|
1756
1809
|
# @option options [String] :db_cluster_identifier
|
|
@@ -2094,28 +2147,21 @@ module Aws::RDS
|
|
|
2094
2147
|
#
|
|
2095
2148
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html
|
|
2096
2149
|
# [2]: https://docs.aws.amazon.com/outposts/latest/userguide/routing.html#ip-addressing
|
|
2097
|
-
# @option options [String] :
|
|
2098
|
-
# The
|
|
2099
|
-
# instance of an RDS Custom DB instance.
|
|
2100
|
-
#
|
|
2101
|
-
# This setting is required for RDS Custom.
|
|
2102
|
-
#
|
|
2103
|
-
# Constraints:
|
|
2104
|
-
#
|
|
2105
|
-
# * The profile must exist in your account.
|
|
2150
|
+
# @option options [String] :network_type
|
|
2151
|
+
# The network type of the DB instance.
|
|
2106
2152
|
#
|
|
2107
|
-
#
|
|
2108
|
-
#
|
|
2153
|
+
# The network type is determined by the `DBSubnetGroup` specified for
|
|
2154
|
+
# the DB instance. A `DBSubnetGroup` can support only the IPv4 protocol
|
|
2155
|
+
# or the IPv4 and the IPv6 protocols (`DUAL`).
|
|
2109
2156
|
#
|
|
2110
|
-
#
|
|
2111
|
-
#
|
|
2157
|
+
# For more information, see [ Working with a DB instance in a VPC][1] in
|
|
2158
|
+
# the *Amazon RDS User Guide.*
|
|
2112
2159
|
#
|
|
2113
|
-
#
|
|
2114
|
-
# IAM and your VPC][1] in the *Amazon RDS User Guide*.
|
|
2160
|
+
# Valid Values: `IPV4 | DUAL`
|
|
2115
2161
|
#
|
|
2116
2162
|
#
|
|
2117
2163
|
#
|
|
2118
|
-
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/
|
|
2164
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html
|
|
2119
2165
|
# @option options [String] :backup_target
|
|
2120
2166
|
# The location for storing automated backups and manual snapshots.
|
|
2121
2167
|
#
|
|
@@ -2135,29 +2181,50 @@ module Aws::RDS
|
|
|
2135
2181
|
#
|
|
2136
2182
|
#
|
|
2137
2183
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html
|
|
2138
|
-
# @option options [String] :
|
|
2139
|
-
# The
|
|
2184
|
+
# @option options [String] :custom_iam_instance_profile
|
|
2185
|
+
# The instance profile associated with the underlying Amazon EC2
|
|
2186
|
+
# instance of an RDS Custom DB instance.
|
|
2140
2187
|
#
|
|
2141
|
-
#
|
|
2142
|
-
# the DB instance. A `DBSubnetGroup` can support only the IPv4 protocol
|
|
2143
|
-
# or the IPv4 and the IPv6 protocols (`DUAL`).
|
|
2188
|
+
# This setting is required for RDS Custom.
|
|
2144
2189
|
#
|
|
2145
|
-
#
|
|
2146
|
-
# the *Amazon RDS User Guide.*
|
|
2190
|
+
# Constraints:
|
|
2147
2191
|
#
|
|
2148
|
-
#
|
|
2192
|
+
# * The profile must exist in your account.
|
|
2149
2193
|
#
|
|
2194
|
+
# * The profile must have an IAM role that Amazon EC2 has permissions to
|
|
2195
|
+
# assume.
|
|
2150
2196
|
#
|
|
2197
|
+
# * The instance profile name and the associated IAM role name must
|
|
2198
|
+
# start with the prefix `AWSRDSCustom`.
|
|
2151
2199
|
#
|
|
2152
|
-
# [
|
|
2153
|
-
#
|
|
2154
|
-
# The storage throughput value, in mebibyte per second (MiBps), for the
|
|
2155
|
-
# DB instance.
|
|
2200
|
+
# For the list of permissions required for the IAM role, see [ Configure
|
|
2201
|
+
# IAM and your VPC][1] in the *Amazon RDS User Guide*.
|
|
2156
2202
|
#
|
|
2157
|
-
# This setting applies only to the `gp3` storage type.
|
|
2158
2203
|
#
|
|
2159
|
-
#
|
|
2160
|
-
#
|
|
2204
|
+
#
|
|
2205
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-setup-orcl.html#custom-setup-orcl.iam-vpc
|
|
2206
|
+
# @option options [String] :db_system_id
|
|
2207
|
+
# The Oracle system identifier (SID), which is the name of the Oracle
|
|
2208
|
+
# database instance that manages your database files. In this context,
|
|
2209
|
+
# the term "Oracle database instance" refers exclusively to the system
|
|
2210
|
+
# global area (SGA) and Oracle background processes. If you don't
|
|
2211
|
+
# specify a SID, the value defaults to `RDSCDB`. The Oracle SID is also
|
|
2212
|
+
# the name of your CDB.
|
|
2213
|
+
# @option options [String] :ca_certificate_identifier
|
|
2214
|
+
# The CA certificate identifier to use for the DB instance's server
|
|
2215
|
+
# certificate.
|
|
2216
|
+
#
|
|
2217
|
+
# This setting doesn't apply to RDS Custom DB instances.
|
|
2218
|
+
#
|
|
2219
|
+
# For more information, see [Using SSL/TLS to encrypt a connection to a
|
|
2220
|
+
# DB instance][1] in the *Amazon RDS User Guide* and [ Using SSL/TLS to
|
|
2221
|
+
# encrypt a connection to a DB cluster][2] in the *Amazon Aurora User
|
|
2222
|
+
# Guide*.
|
|
2223
|
+
#
|
|
2224
|
+
#
|
|
2225
|
+
#
|
|
2226
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL.html
|
|
2227
|
+
# [2]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL.html
|
|
2161
2228
|
# @option options [Boolean] :manage_master_user_password
|
|
2162
2229
|
# Specifies whether to manage the master user password with Amazon Web
|
|
2163
2230
|
# Services Secrets Manager.
|
|
@@ -2197,31 +2264,6 @@ module Aws::RDS
|
|
|
2197
2264
|
# There is a default KMS key for your Amazon Web Services account. Your
|
|
2198
2265
|
# Amazon Web Services account has a different default KMS key for each
|
|
2199
2266
|
# Amazon Web Services Region.
|
|
2200
|
-
# @option options [String] :ca_certificate_identifier
|
|
2201
|
-
# The CA certificate identifier to use for the DB instance's server
|
|
2202
|
-
# certificate.
|
|
2203
|
-
#
|
|
2204
|
-
# This setting doesn't apply to RDS Custom DB instances.
|
|
2205
|
-
#
|
|
2206
|
-
# For more information, see [Using SSL/TLS to encrypt a connection to a
|
|
2207
|
-
# DB instance][1] in the *Amazon RDS User Guide* and [ Using SSL/TLS to
|
|
2208
|
-
# encrypt a connection to a DB cluster][2] in the *Amazon Aurora User
|
|
2209
|
-
# Guide*.
|
|
2210
|
-
#
|
|
2211
|
-
#
|
|
2212
|
-
#
|
|
2213
|
-
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL.html
|
|
2214
|
-
# [2]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL.html
|
|
2215
|
-
# @option options [String] :db_system_id
|
|
2216
|
-
# The Oracle system identifier (SID), which is the name of the Oracle
|
|
2217
|
-
# database instance that manages your database files. In this context,
|
|
2218
|
-
# the term "Oracle database instance" refers exclusively to the system
|
|
2219
|
-
# global area (SGA) and Oracle background processes. If you don't
|
|
2220
|
-
# specify a SID, the value defaults to `RDSCDB`. The Oracle SID is also
|
|
2221
|
-
# the name of your CDB.
|
|
2222
|
-
# @option options [Boolean] :dedicated_log_volume
|
|
2223
|
-
# Indicates whether the DB instance has a dedicated log volume (DLV)
|
|
2224
|
-
# enabled.
|
|
2225
2267
|
# @option options [Boolean] :multi_tenant
|
|
2226
2268
|
# Specifies whether to use the multi-tenant configuration or the
|
|
2227
2269
|
# single-tenant configuration (default). This parameter only applies to
|
|
@@ -2237,6 +2279,9 @@ module Aws::RDS
|
|
|
2237
2279
|
# * If you specify the multi-tenant configuration when you create your
|
|
2238
2280
|
# DB instance, you can't later modify this DB instance to use the
|
|
2239
2281
|
# single-tenant configuration.
|
|
2282
|
+
# @option options [Boolean] :dedicated_log_volume
|
|
2283
|
+
# Indicates whether the DB instance has a dedicated log volume (DLV)
|
|
2284
|
+
# enabled.
|
|
2240
2285
|
# @option options [String] :engine_lifecycle_support
|
|
2241
2286
|
# The life cycle type for this DB instance.
|
|
2242
2287
|
#
|
|
@@ -2268,6 +2313,33 @@ module Aws::RDS
|
|
|
2268
2313
|
#
|
|
2269
2314
|
#
|
|
2270
2315
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/extended-support.html
|
|
2316
|
+
# @option options [Array<Types::TagSpecification>] :tag_specifications
|
|
2317
|
+
# Tags to assign to resources associated with the DB instance.
|
|
2318
|
+
#
|
|
2319
|
+
# Valid Values:
|
|
2320
|
+
#
|
|
2321
|
+
# * `auto-backup` - The DB instance's automated backup.
|
|
2322
|
+
#
|
|
2323
|
+
# ^
|
|
2324
|
+
# @option options [String] :master_user_authentication_type
|
|
2325
|
+
# Specifies the authentication type for the master user. With IAM master
|
|
2326
|
+
# user authentication, you can configure the master DB user with IAM
|
|
2327
|
+
# database authentication when you create a DB instance.
|
|
2328
|
+
#
|
|
2329
|
+
# You can specify one of the following values:
|
|
2330
|
+
#
|
|
2331
|
+
# * `password` - Use standard database authentication with a password.
|
|
2332
|
+
#
|
|
2333
|
+
# * `iam-db-auth` - Use IAM database authentication for the master user.
|
|
2334
|
+
#
|
|
2335
|
+
# This option is only valid for RDS for PostgreSQL and Aurora PostgreSQL
|
|
2336
|
+
# engines.
|
|
2337
|
+
# @option options [Array<Types::AdditionalStorageVolume>] :additional_storage_volumes
|
|
2338
|
+
# A list of additional storage volumes to create for the DB instance.
|
|
2339
|
+
# You can create up to three additional storage volumes using the names
|
|
2340
|
+
# `rdsdbdata2`, `rdsdbdata3`, and `rdsdbdata4`. Additional storage
|
|
2341
|
+
# volumes are supported for RDS for Oracle and RDS for SQL Server DB
|
|
2342
|
+
# instances only.
|
|
2271
2343
|
# @return [DBInstance]
|
|
2272
2344
|
def create(options = {})
|
|
2273
2345
|
options = options.merge(db_instance_identifier: @id)
|
|
@@ -2291,6 +2363,7 @@ module Aws::RDS
|
|
|
2291
2363
|
# multi_az: false,
|
|
2292
2364
|
# auto_minor_version_upgrade: false,
|
|
2293
2365
|
# iops: 1,
|
|
2366
|
+
# storage_throughput: 1,
|
|
2294
2367
|
# option_group_name: "String",
|
|
2295
2368
|
# db_parameter_group_name: "String",
|
|
2296
2369
|
# publicly_accessible: false,
|
|
@@ -2307,7 +2380,7 @@ module Aws::RDS
|
|
|
2307
2380
|
# monitoring_interval: 1,
|
|
2308
2381
|
# monitoring_role_arn: "String",
|
|
2309
2382
|
# kms_key_id: "String",
|
|
2310
|
-
# pre_signed_url: "
|
|
2383
|
+
# pre_signed_url: "SensitiveString",
|
|
2311
2384
|
# enable_iam_database_authentication: false,
|
|
2312
2385
|
# database_insights_mode: "standard", # accepts standard, advanced
|
|
2313
2386
|
# enable_performance_insights: false,
|
|
@@ -2329,17 +2402,37 @@ module Aws::RDS
|
|
|
2329
2402
|
# domain_auth_secret_arn: "String",
|
|
2330
2403
|
# domain_dns_ips: ["String"],
|
|
2331
2404
|
# replica_mode: "open-read-only", # accepts open-read-only, mounted
|
|
2332
|
-
# max_allocated_storage: 1,
|
|
2333
|
-
# custom_iam_instance_profile: "String",
|
|
2334
|
-
# network_type: "String",
|
|
2335
|
-
# storage_throughput: 1,
|
|
2336
2405
|
# enable_customer_owned_ip: false,
|
|
2406
|
+
# network_type: "String",
|
|
2407
|
+
# max_allocated_storage: 1,
|
|
2337
2408
|
# backup_target: "String",
|
|
2409
|
+
# custom_iam_instance_profile: "String",
|
|
2338
2410
|
# allocated_storage: 1,
|
|
2339
2411
|
# source_db_cluster_identifier: "String",
|
|
2340
2412
|
# dedicated_log_volume: false,
|
|
2341
2413
|
# upgrade_storage_config: false,
|
|
2342
2414
|
# ca_certificate_identifier: "String",
|
|
2415
|
+
# tag_specifications: [
|
|
2416
|
+
# {
|
|
2417
|
+
# resource_type: "String",
|
|
2418
|
+
# tags: [
|
|
2419
|
+
# {
|
|
2420
|
+
# key: "String",
|
|
2421
|
+
# value: "String",
|
|
2422
|
+
# },
|
|
2423
|
+
# ],
|
|
2424
|
+
# },
|
|
2425
|
+
# ],
|
|
2426
|
+
# additional_storage_volumes: [
|
|
2427
|
+
# {
|
|
2428
|
+
# volume_name: "String", # required
|
|
2429
|
+
# allocated_storage: 1,
|
|
2430
|
+
# iops: 1,
|
|
2431
|
+
# max_allocated_storage: 1,
|
|
2432
|
+
# storage_throughput: 1,
|
|
2433
|
+
# storage_type: "String",
|
|
2434
|
+
# },
|
|
2435
|
+
# ],
|
|
2343
2436
|
# source_region: "String",
|
|
2344
2437
|
# })
|
|
2345
2438
|
# @param [Hash] options ({})
|
|
@@ -2399,6 +2492,11 @@ module Aws::RDS
|
|
|
2399
2492
|
# @option options [Integer] :iops
|
|
2400
2493
|
# The amount of Provisioned IOPS (input/output operations per second) to
|
|
2401
2494
|
# initially allocate for the DB instance.
|
|
2495
|
+
# @option options [Integer] :storage_throughput
|
|
2496
|
+
# Specifies the storage throughput value for the read replica.
|
|
2497
|
+
#
|
|
2498
|
+
# This setting doesn't apply to RDS Custom or Amazon Aurora DB
|
|
2499
|
+
# instances.
|
|
2402
2500
|
# @option options [String] :option_group_name
|
|
2403
2501
|
# The option group to associate the DB instance with. If not specified,
|
|
2404
2502
|
# RDS uses the option group associated with the source DB instance or
|
|
@@ -2841,38 +2939,26 @@ module Aws::RDS
|
|
|
2841
2939
|
#
|
|
2842
2940
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/db2-replication.html
|
|
2843
2941
|
# [2]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-read-replicas.html
|
|
2844
|
-
# @option options [
|
|
2845
|
-
#
|
|
2846
|
-
#
|
|
2847
|
-
#
|
|
2848
|
-
# For more information about this setting, including limitations that
|
|
2849
|
-
# apply to it, see [ Managing capacity automatically with Amazon RDS
|
|
2850
|
-
# storage autoscaling][1] in the *Amazon RDS User Guide*.
|
|
2851
|
-
#
|
|
2852
|
-
#
|
|
2853
|
-
#
|
|
2854
|
-
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIOPS.StorageTypes.html#USER_PIOPS.Autoscaling
|
|
2855
|
-
# @option options [String] :custom_iam_instance_profile
|
|
2856
|
-
# The instance profile associated with the underlying Amazon EC2
|
|
2857
|
-
# instance of an RDS Custom DB instance. The instance profile must meet
|
|
2858
|
-
# the following requirements:
|
|
2859
|
-
#
|
|
2860
|
-
# * The profile must exist in your account.
|
|
2861
|
-
#
|
|
2862
|
-
# * The profile must have an IAM role that Amazon EC2 has permissions to
|
|
2863
|
-
# assume.
|
|
2942
|
+
# @option options [Boolean] :enable_customer_owned_ip
|
|
2943
|
+
# Specifies whether to enable a customer-owned IP address (CoIP) for an
|
|
2944
|
+
# RDS on Outposts read replica.
|
|
2864
2945
|
#
|
|
2865
|
-
# *
|
|
2866
|
-
#
|
|
2946
|
+
# A *CoIP* provides local or external connectivity to resources in your
|
|
2947
|
+
# Outpost subnets through your on-premises network. For some use cases,
|
|
2948
|
+
# a CoIP can provide lower latency for connections to the read replica
|
|
2949
|
+
# from outside of its virtual private cloud (VPC) on your local network.
|
|
2867
2950
|
#
|
|
2868
|
-
# For
|
|
2869
|
-
#
|
|
2951
|
+
# For more information about RDS on Outposts, see [Working with Amazon
|
|
2952
|
+
# RDS on Amazon Web Services Outposts][1] in the *Amazon RDS User
|
|
2953
|
+
# Guide*.
|
|
2870
2954
|
#
|
|
2871
|
-
#
|
|
2955
|
+
# For more information about CoIPs, see [Customer-owned IP addresses][2]
|
|
2956
|
+
# in the *Amazon Web Services Outposts User Guide*.
|
|
2872
2957
|
#
|
|
2873
2958
|
#
|
|
2874
2959
|
#
|
|
2875
|
-
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/
|
|
2960
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html
|
|
2961
|
+
# [2]: https://docs.aws.amazon.com/outposts/latest/userguide/routing.html#ip-addressing
|
|
2876
2962
|
# @option options [String] :network_type
|
|
2877
2963
|
# The network type of the DB instance.
|
|
2878
2964
|
#
|
|
@@ -2891,32 +2977,18 @@ module Aws::RDS
|
|
|
2891
2977
|
#
|
|
2892
2978
|
#
|
|
2893
2979
|
#
|
|
2894
|
-
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html
|
|
2895
|
-
# @option options [Integer] :
|
|
2896
|
-
#
|
|
2897
|
-
#
|
|
2898
|
-
# This setting doesn't apply to RDS Custom or Amazon Aurora DB
|
|
2899
|
-
# instances.
|
|
2900
|
-
# @option options [Boolean] :enable_customer_owned_ip
|
|
2901
|
-
# Specifies whether to enable a customer-owned IP address (CoIP) for an
|
|
2902
|
-
# RDS on Outposts read replica.
|
|
2903
|
-
#
|
|
2904
|
-
# A *CoIP* provides local or external connectivity to resources in your
|
|
2905
|
-
# Outpost subnets through your on-premises network. For some use cases,
|
|
2906
|
-
# a CoIP can provide lower latency for connections to the read replica
|
|
2907
|
-
# from outside of its virtual private cloud (VPC) on your local network.
|
|
2908
|
-
#
|
|
2909
|
-
# For more information about RDS on Outposts, see [Working with Amazon
|
|
2910
|
-
# RDS on Amazon Web Services Outposts][1] in the *Amazon RDS User
|
|
2911
|
-
# Guide*.
|
|
2980
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html
|
|
2981
|
+
# @option options [Integer] :max_allocated_storage
|
|
2982
|
+
# The upper limit in gibibytes (GiB) to which Amazon RDS can
|
|
2983
|
+
# automatically scale the storage of the DB instance.
|
|
2912
2984
|
#
|
|
2913
|
-
# For more information about
|
|
2914
|
-
#
|
|
2985
|
+
# For more information about this setting, including limitations that
|
|
2986
|
+
# apply to it, see [ Managing capacity automatically with Amazon RDS
|
|
2987
|
+
# storage autoscaling][1] in the *Amazon RDS User Guide*.
|
|
2915
2988
|
#
|
|
2916
2989
|
#
|
|
2917
2990
|
#
|
|
2918
|
-
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/
|
|
2919
|
-
# [2]: https://docs.aws.amazon.com/outposts/latest/userguide/routing.html#ip-addressing
|
|
2991
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIOPS.StorageTypes.html#USER_PIOPS.Autoscaling
|
|
2920
2992
|
# @option options [String] :backup_target
|
|
2921
2993
|
# The location where RDS stores automated backups and manual snapshots.
|
|
2922
2994
|
#
|
|
@@ -2925,6 +2997,27 @@ module Aws::RDS
|
|
|
2925
2997
|
# * `local` for Dedicated Local Zones
|
|
2926
2998
|
#
|
|
2927
2999
|
# * `region` for Amazon Web Services Region
|
|
3000
|
+
# @option options [String] :custom_iam_instance_profile
|
|
3001
|
+
# The instance profile associated with the underlying Amazon EC2
|
|
3002
|
+
# instance of an RDS Custom DB instance. The instance profile must meet
|
|
3003
|
+
# the following requirements:
|
|
3004
|
+
#
|
|
3005
|
+
# * The profile must exist in your account.
|
|
3006
|
+
#
|
|
3007
|
+
# * The profile must have an IAM role that Amazon EC2 has permissions to
|
|
3008
|
+
# assume.
|
|
3009
|
+
#
|
|
3010
|
+
# * The instance profile name and the associated IAM role name must
|
|
3011
|
+
# start with the prefix `AWSRDSCustom`.
|
|
3012
|
+
#
|
|
3013
|
+
# For the list of permissions required for the IAM role, see [ Configure
|
|
3014
|
+
# IAM and your VPC][1] in the *Amazon RDS User Guide*.
|
|
3015
|
+
#
|
|
3016
|
+
# This setting is required for RDS Custom DB instances.
|
|
3017
|
+
#
|
|
3018
|
+
#
|
|
3019
|
+
#
|
|
3020
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-setup-orcl.html#custom-setup-orcl.iam-vpc
|
|
2928
3021
|
# @option options [Integer] :allocated_storage
|
|
2929
3022
|
# The amount of storage (in gibibytes) to allocate initially for the
|
|
2930
3023
|
# read replica. Follow the allocation rules specified in
|
|
@@ -2975,6 +3068,20 @@ module Aws::RDS
|
|
|
2975
3068
|
#
|
|
2976
3069
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL.html
|
|
2977
3070
|
# [2]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL.html
|
|
3071
|
+
# @option options [Array<Types::TagSpecification>] :tag_specifications
|
|
3072
|
+
# Tags to assign to resources associated with the DB instance.
|
|
3073
|
+
#
|
|
3074
|
+
# Valid Values:
|
|
3075
|
+
#
|
|
3076
|
+
# * `auto-backup` - The DB instance's automated backup.
|
|
3077
|
+
#
|
|
3078
|
+
# ^
|
|
3079
|
+
# @option options [Array<Types::AdditionalStorageVolume>] :additional_storage_volumes
|
|
3080
|
+
# A list of additional storage volumes to create for the DB instance.
|
|
3081
|
+
# You can create up to three additional storage volumes using the names
|
|
3082
|
+
# `rdsdbdata2`, `rdsdbdata3`, and `rdsdbdata4`. Additional storage
|
|
3083
|
+
# volumes are supported for RDS for Oracle and RDS for SQL Server DB
|
|
3084
|
+
# instances only.
|
|
2978
3085
|
# @option options [String] :source_region
|
|
2979
3086
|
# The source region of the snapshot. This is only needed when the
|
|
2980
3087
|
# shapshot is encrypted and in a different region.
|
|
@@ -3117,7 +3224,7 @@ module Aws::RDS
|
|
|
3117
3224
|
# db_security_groups: ["String"],
|
|
3118
3225
|
# vpc_security_group_ids: ["String"],
|
|
3119
3226
|
# apply_immediately: false,
|
|
3120
|
-
# master_user_password: "
|
|
3227
|
+
# master_user_password: "SensitiveString",
|
|
3121
3228
|
# db_parameter_group_name: "String",
|
|
3122
3229
|
# backup_retention_period: 1,
|
|
3123
3230
|
# preferred_backup_window: "String",
|
|
@@ -3128,24 +3235,25 @@ module Aws::RDS
|
|
|
3128
3235
|
# auto_minor_version_upgrade: false,
|
|
3129
3236
|
# license_model: "String",
|
|
3130
3237
|
# iops: 1,
|
|
3238
|
+
# storage_throughput: 1,
|
|
3131
3239
|
# option_group_name: "String",
|
|
3132
3240
|
# new_db_instance_identifier: "String",
|
|
3133
3241
|
# storage_type: "String",
|
|
3134
3242
|
# tde_credential_arn: "String",
|
|
3135
|
-
# tde_credential_password: "
|
|
3243
|
+
# tde_credential_password: "SensitiveString",
|
|
3136
3244
|
# ca_certificate_identifier: "String",
|
|
3137
3245
|
# domain: "String",
|
|
3138
3246
|
# domain_fqdn: "String",
|
|
3139
3247
|
# domain_ou: "String",
|
|
3140
3248
|
# domain_auth_secret_arn: "String",
|
|
3141
3249
|
# domain_dns_ips: ["String"],
|
|
3250
|
+
# disable_domain: false,
|
|
3142
3251
|
# copy_tags_to_snapshot: false,
|
|
3143
3252
|
# monitoring_interval: 1,
|
|
3144
3253
|
# db_port_number: 1,
|
|
3145
3254
|
# publicly_accessible: false,
|
|
3146
3255
|
# monitoring_role_arn: "String",
|
|
3147
3256
|
# domain_iam_role_name: "String",
|
|
3148
|
-
# disable_domain: false,
|
|
3149
3257
|
# promotion_tier: 1,
|
|
3150
3258
|
# enable_iam_database_authentication: false,
|
|
3151
3259
|
# database_insights_mode: "standard", # accepts standard, advanced
|
|
@@ -3167,18 +3275,40 @@ module Aws::RDS
|
|
|
3167
3275
|
# max_allocated_storage: 1,
|
|
3168
3276
|
# certificate_rotation_restart: false,
|
|
3169
3277
|
# replica_mode: "open-read-only", # accepts open-read-only, mounted
|
|
3170
|
-
# enable_customer_owned_ip: false,
|
|
3171
|
-
# aws_backup_recovery_point_arn: "AwsBackupRecoveryPointArn",
|
|
3172
3278
|
# automation_mode: "full", # accepts full, all-paused
|
|
3173
3279
|
# resume_full_automation_mode_minutes: 1,
|
|
3280
|
+
# enable_customer_owned_ip: false,
|
|
3174
3281
|
# network_type: "String",
|
|
3175
|
-
#
|
|
3282
|
+
# aws_backup_recovery_point_arn: "AwsBackupRecoveryPointArn",
|
|
3176
3283
|
# manage_master_user_password: false,
|
|
3177
3284
|
# rotate_master_user_password: false,
|
|
3178
3285
|
# master_user_secret_kms_key_id: "String",
|
|
3179
|
-
# engine: "String",
|
|
3180
|
-
# dedicated_log_volume: false,
|
|
3181
3286
|
# multi_tenant: false,
|
|
3287
|
+
# dedicated_log_volume: false,
|
|
3288
|
+
# engine: "String",
|
|
3289
|
+
# tag_specifications: [
|
|
3290
|
+
# {
|
|
3291
|
+
# resource_type: "String",
|
|
3292
|
+
# tags: [
|
|
3293
|
+
# {
|
|
3294
|
+
# key: "String",
|
|
3295
|
+
# value: "String",
|
|
3296
|
+
# },
|
|
3297
|
+
# ],
|
|
3298
|
+
# },
|
|
3299
|
+
# ],
|
|
3300
|
+
# master_user_authentication_type: "password", # accepts password, iam-db-auth
|
|
3301
|
+
# additional_storage_volumes: [
|
|
3302
|
+
# {
|
|
3303
|
+
# volume_name: "String", # required
|
|
3304
|
+
# allocated_storage: 1,
|
|
3305
|
+
# iops: 1,
|
|
3306
|
+
# max_allocated_storage: 1,
|
|
3307
|
+
# storage_throughput: 1,
|
|
3308
|
+
# storage_type: "String",
|
|
3309
|
+
# set_for_delete: false,
|
|
3310
|
+
# },
|
|
3311
|
+
# ],
|
|
3182
3312
|
# })
|
|
3183
3313
|
# @param [Hash] options ({})
|
|
3184
3314
|
# @option options [Integer] :allocated_storage
|
|
@@ -3602,6 +3732,13 @@ module Aws::RDS
|
|
|
3602
3732
|
# `AllocatedStorage`.
|
|
3603
3733
|
#
|
|
3604
3734
|
# Default: Uses existing setting
|
|
3735
|
+
# @option options [Integer] :storage_throughput
|
|
3736
|
+
# The storage throughput value for the DB instance.
|
|
3737
|
+
#
|
|
3738
|
+
# This setting applies only to the `gp3` storage type.
|
|
3739
|
+
#
|
|
3740
|
+
# This setting doesn't apply to Amazon Aurora or RDS Custom DB
|
|
3741
|
+
# instances.
|
|
3605
3742
|
# @option options [String] :option_group_name
|
|
3606
3743
|
# The option group to associate the DB instance with.
|
|
3607
3744
|
#
|
|
@@ -3720,7 +3857,7 @@ module Aws::RDS
|
|
|
3720
3857
|
#
|
|
3721
3858
|
# * Must be in the distinguished name format.
|
|
3722
3859
|
#
|
|
3723
|
-
#
|
|
3860
|
+
# ^
|
|
3724
3861
|
#
|
|
3725
3862
|
# Example:
|
|
3726
3863
|
# `OU=mymanagedADtestOU,DC=mymanagedADtest,DC=mymanagedAD,DC=mydomain`
|
|
@@ -3743,6 +3880,9 @@ module Aws::RDS
|
|
|
3743
3880
|
# ^
|
|
3744
3881
|
#
|
|
3745
3882
|
# Example: `123.124.125.126,234.235.236.237`
|
|
3883
|
+
# @option options [Boolean] :disable_domain
|
|
3884
|
+
# Specifies whether to remove the DB instance from the Active Directory
|
|
3885
|
+
# domain.
|
|
3746
3886
|
# @option options [Boolean] :copy_tags_to_snapshot
|
|
3747
3887
|
# Specifies whether to copy all tags from the DB instance to snapshots
|
|
3748
3888
|
# of the DB instance. By default, tags aren't copied.
|
|
@@ -3841,9 +3981,6 @@ module Aws::RDS
|
|
|
3841
3981
|
# Service.
|
|
3842
3982
|
#
|
|
3843
3983
|
# This setting doesn't apply to RDS Custom DB instances.
|
|
3844
|
-
# @option options [Boolean] :disable_domain
|
|
3845
|
-
# Specifies whether to remove the DB instance from the Active Directory
|
|
3846
|
-
# domain.
|
|
3847
3984
|
# @option options [Integer] :promotion_tier
|
|
3848
3985
|
# The order of priority in which an Aurora Replica is promoted to the
|
|
3849
3986
|
# primary instance after a failure of the existing primary instance. For
|
|
@@ -4070,6 +4207,22 @@ module Aws::RDS
|
|
|
4070
4207
|
#
|
|
4071
4208
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/db2-replication.html
|
|
4072
4209
|
# [2]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-read-replicas.html
|
|
4210
|
+
# @option options [String] :automation_mode
|
|
4211
|
+
# The automation mode of the RDS Custom DB instance. If `full`, the DB
|
|
4212
|
+
# instance automates monitoring and instance recovery. If `all paused`,
|
|
4213
|
+
# the instance pauses automation for the duration set by
|
|
4214
|
+
# `ResumeFullAutomationModeMinutes`.
|
|
4215
|
+
# @option options [Integer] :resume_full_automation_mode_minutes
|
|
4216
|
+
# The number of minutes to pause the automation. When the time period
|
|
4217
|
+
# ends, RDS Custom resumes full automation.
|
|
4218
|
+
#
|
|
4219
|
+
# Default: `60`
|
|
4220
|
+
#
|
|
4221
|
+
# Constraints:
|
|
4222
|
+
#
|
|
4223
|
+
# * Must be at least 60.
|
|
4224
|
+
#
|
|
4225
|
+
# * Must be no more than 1,440.
|
|
4073
4226
|
# @option options [Boolean] :enable_customer_owned_ip
|
|
4074
4227
|
# Specifies whether to enable a customer-owned IP address (CoIP) for an
|
|
4075
4228
|
# RDS on Outposts DB instance.
|
|
@@ -4090,27 +4243,6 @@ module Aws::RDS
|
|
|
4090
4243
|
#
|
|
4091
4244
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html
|
|
4092
4245
|
# [2]: https://docs.aws.amazon.com/outposts/latest/userguide/routing.html#ip-addressing
|
|
4093
|
-
# @option options [String] :aws_backup_recovery_point_arn
|
|
4094
|
-
# The Amazon Resource Name (ARN) of the recovery point in Amazon Web
|
|
4095
|
-
# Services Backup.
|
|
4096
|
-
#
|
|
4097
|
-
# This setting doesn't apply to RDS Custom DB instances.
|
|
4098
|
-
# @option options [String] :automation_mode
|
|
4099
|
-
# The automation mode of the RDS Custom DB instance. If `full`, the DB
|
|
4100
|
-
# instance automates monitoring and instance recovery. If `all paused`,
|
|
4101
|
-
# the instance pauses automation for the duration set by
|
|
4102
|
-
# `ResumeFullAutomationModeMinutes`.
|
|
4103
|
-
# @option options [Integer] :resume_full_automation_mode_minutes
|
|
4104
|
-
# The number of minutes to pause the automation. When the time period
|
|
4105
|
-
# ends, RDS Custom resumes full automation.
|
|
4106
|
-
#
|
|
4107
|
-
# Default: `60`
|
|
4108
|
-
#
|
|
4109
|
-
# Constraints:
|
|
4110
|
-
#
|
|
4111
|
-
# * Must be at least 60.
|
|
4112
|
-
#
|
|
4113
|
-
# * Must be no more than 1,440.
|
|
4114
4246
|
# @option options [String] :network_type
|
|
4115
4247
|
# The network type of the DB instance.
|
|
4116
4248
|
#
|
|
@@ -4126,13 +4258,11 @@ module Aws::RDS
|
|
|
4126
4258
|
#
|
|
4127
4259
|
#
|
|
4128
4260
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html
|
|
4129
|
-
# @option options [
|
|
4130
|
-
# The
|
|
4131
|
-
#
|
|
4132
|
-
# This setting applies only to the `gp3` storage type.
|
|
4261
|
+
# @option options [String] :aws_backup_recovery_point_arn
|
|
4262
|
+
# The Amazon Resource Name (ARN) of the recovery point in Amazon Web
|
|
4263
|
+
# Services Backup.
|
|
4133
4264
|
#
|
|
4134
|
-
# This setting doesn't apply to
|
|
4135
|
-
# instances.
|
|
4265
|
+
# This setting doesn't apply to RDS Custom DB instances.
|
|
4136
4266
|
# @option options [Boolean] :manage_master_user_password
|
|
4137
4267
|
# Specifies whether to manage the master user password with Amazon Web
|
|
4138
4268
|
# Services Secrets Manager.
|
|
@@ -4219,6 +4349,25 @@ module Aws::RDS
|
|
|
4219
4349
|
# There is a default KMS key for your Amazon Web Services account. Your
|
|
4220
4350
|
# Amazon Web Services account has a different default KMS key for each
|
|
4221
4351
|
# Amazon Web Services Region.
|
|
4352
|
+
# @option options [Boolean] :multi_tenant
|
|
4353
|
+
# Specifies whether the to convert your DB instance from the
|
|
4354
|
+
# single-tenant configuration to the multi-tenant configuration. This
|
|
4355
|
+
# parameter is supported only for RDS for Oracle CDB instances.
|
|
4356
|
+
#
|
|
4357
|
+
# During the conversion, RDS creates an initial tenant database and
|
|
4358
|
+
# associates the DB name, master user name, character set, and national
|
|
4359
|
+
# character set metadata with this database. The tags associated with
|
|
4360
|
+
# the instance also propagate to the initial tenant database. You can
|
|
4361
|
+
# add more tenant databases to your DB instance by using the
|
|
4362
|
+
# `CreateTenantDatabase` operation.
|
|
4363
|
+
#
|
|
4364
|
+
# The conversion to the multi-tenant configuration is permanent and
|
|
4365
|
+
# irreversible, so you can't later convert back to the single-tenant
|
|
4366
|
+
# configuration. When you specify this parameter, you must also specify
|
|
4367
|
+
# `ApplyImmediately`.
|
|
4368
|
+
# @option options [Boolean] :dedicated_log_volume
|
|
4369
|
+
# Indicates whether the DB instance has a dedicated log volume (DLV)
|
|
4370
|
+
# enabled.
|
|
4222
4371
|
# @option options [String] :engine
|
|
4223
4372
|
# The target Oracle DB engine when you convert a non-CDB to a CDB. This
|
|
4224
4373
|
# intermediate step is necessary to upgrade an Oracle Database 19c
|
|
@@ -4246,25 +4395,32 @@ module Aws::RDS
|
|
|
4246
4395
|
# parameter group. To avoid reverting to the default, specify a new
|
|
4247
4396
|
# parameter group with `--db-parameter-group-name` and a new option
|
|
4248
4397
|
# group with `--option-group-name`.
|
|
4249
|
-
# @option options [
|
|
4250
|
-
#
|
|
4251
|
-
# enabled.
|
|
4252
|
-
# @option options [Boolean] :multi_tenant
|
|
4253
|
-
# Specifies whether the to convert your DB instance from the
|
|
4254
|
-
# single-tenant configuration to the multi-tenant configuration. This
|
|
4255
|
-
# parameter is supported only for RDS for Oracle CDB instances.
|
|
4398
|
+
# @option options [Array<Types::TagSpecification>] :tag_specifications
|
|
4399
|
+
# Tags to assign to resources associated with the DB instance.
|
|
4256
4400
|
#
|
|
4257
|
-
#
|
|
4258
|
-
# associates the DB name, master user name, character set, and national
|
|
4259
|
-
# character set metadata with this database. The tags associated with
|
|
4260
|
-
# the instance also propagate to the initial tenant database. You can
|
|
4261
|
-
# add more tenant databases to your DB instance by using the
|
|
4262
|
-
# `CreateTenantDatabase` operation.
|
|
4401
|
+
# Valid Values:
|
|
4263
4402
|
#
|
|
4264
|
-
#
|
|
4265
|
-
#
|
|
4266
|
-
#
|
|
4267
|
-
#
|
|
4403
|
+
# * `auto-backup` - The DB instance's automated backup.
|
|
4404
|
+
#
|
|
4405
|
+
# ^
|
|
4406
|
+
# @option options [String] :master_user_authentication_type
|
|
4407
|
+
# Specifies the authentication type for the master user. With IAM master
|
|
4408
|
+
# user authentication, you can change the master DB user to use IAM
|
|
4409
|
+
# database authentication.
|
|
4410
|
+
#
|
|
4411
|
+
# You can specify one of the following values:
|
|
4412
|
+
#
|
|
4413
|
+
# * `password` - Use standard database authentication with a password.
|
|
4414
|
+
#
|
|
4415
|
+
# * `iam-db-auth` - Use IAM database authentication for the master user.
|
|
4416
|
+
#
|
|
4417
|
+
# This option is only valid for RDS for PostgreSQL and Aurora PostgreSQL
|
|
4418
|
+
# engines.
|
|
4419
|
+
# @option options [Array<Types::ModifyAdditionalStorageVolume>] :additional_storage_volumes
|
|
4420
|
+
# A list of additional storage volumes to modify or delete for the DB
|
|
4421
|
+
# instance. You can create up to 3 additional storage volumes.
|
|
4422
|
+
# Additional storage volumes are supported for RDS for Oracle and RDS
|
|
4423
|
+
# for SQL Server DB instances only.
|
|
4268
4424
|
# @return [DBInstance]
|
|
4269
4425
|
def modify(options = {})
|
|
4270
4426
|
options = options.merge(db_instance_identifier: @id)
|
|
@@ -4283,6 +4439,17 @@ module Aws::RDS
|
|
|
4283
4439
|
# dbinstance = db_instance.promote({
|
|
4284
4440
|
# backup_retention_period: 1,
|
|
4285
4441
|
# preferred_backup_window: "String",
|
|
4442
|
+
# tag_specifications: [
|
|
4443
|
+
# {
|
|
4444
|
+
# resource_type: "String",
|
|
4445
|
+
# tags: [
|
|
4446
|
+
# {
|
|
4447
|
+
# key: "String",
|
|
4448
|
+
# value: "String",
|
|
4449
|
+
# },
|
|
4450
|
+
# ],
|
|
4451
|
+
# },
|
|
4452
|
+
# ],
|
|
4286
4453
|
# })
|
|
4287
4454
|
# @param [Hash] options ({})
|
|
4288
4455
|
# @option options [Integer] :backup_retention_period
|
|
@@ -4320,6 +4487,14 @@ module Aws::RDS
|
|
|
4320
4487
|
#
|
|
4321
4488
|
#
|
|
4322
4489
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/AdjustingTheMaintenanceWindow.html
|
|
4490
|
+
# @option options [Array<Types::TagSpecification>] :tag_specifications
|
|
4491
|
+
# Tags to assign to resources associated with the DB instance.
|
|
4492
|
+
#
|
|
4493
|
+
# Valid Values:
|
|
4494
|
+
#
|
|
4495
|
+
# * `auto-backup` - The DB instance's automated backup.
|
|
4496
|
+
#
|
|
4497
|
+
# ^
|
|
4323
4498
|
# @return [DBInstance]
|
|
4324
4499
|
def promote(options = {})
|
|
4325
4500
|
options = options.merge(db_instance_identifier: @id)
|
|
@@ -4374,6 +4549,7 @@ module Aws::RDS
|
|
|
4374
4549
|
# db_name: "String",
|
|
4375
4550
|
# engine: "String",
|
|
4376
4551
|
# iops: 1,
|
|
4552
|
+
# storage_throughput: 1,
|
|
4377
4553
|
# option_group_name: "String",
|
|
4378
4554
|
# copy_tags_to_snapshot: false,
|
|
4379
4555
|
# tags: [
|
|
@@ -4384,7 +4560,7 @@ module Aws::RDS
|
|
|
4384
4560
|
# ],
|
|
4385
4561
|
# storage_type: "String",
|
|
4386
4562
|
# tde_credential_arn: "String",
|
|
4387
|
-
# tde_credential_password: "
|
|
4563
|
+
# tde_credential_password: "SensitiveString",
|
|
4388
4564
|
# vpc_security_group_ids: ["String"],
|
|
4389
4565
|
# domain: "String",
|
|
4390
4566
|
# domain_iam_role_name: "String",
|
|
@@ -4405,18 +4581,38 @@ module Aws::RDS
|
|
|
4405
4581
|
# deletion_protection: false,
|
|
4406
4582
|
# source_dbi_resource_id: "String",
|
|
4407
4583
|
# max_allocated_storage: 1,
|
|
4408
|
-
# source_db_instance_automated_backups_arn: "String",
|
|
4409
4584
|
# enable_customer_owned_ip: false,
|
|
4410
|
-
# custom_iam_instance_profile: "String",
|
|
4411
|
-
# backup_target: "String",
|
|
4412
4585
|
# network_type: "String",
|
|
4413
|
-
#
|
|
4586
|
+
# source_db_instance_automated_backups_arn: "String",
|
|
4587
|
+
# backup_target: "String",
|
|
4588
|
+
# custom_iam_instance_profile: "String",
|
|
4414
4589
|
# allocated_storage: 1,
|
|
4415
4590
|
# dedicated_log_volume: false,
|
|
4416
4591
|
# ca_certificate_identifier: "String",
|
|
4417
4592
|
# engine_lifecycle_support: "String",
|
|
4593
|
+
# tag_specifications: [
|
|
4594
|
+
# {
|
|
4595
|
+
# resource_type: "String",
|
|
4596
|
+
# tags: [
|
|
4597
|
+
# {
|
|
4598
|
+
# key: "String",
|
|
4599
|
+
# value: "String",
|
|
4600
|
+
# },
|
|
4601
|
+
# ],
|
|
4602
|
+
# },
|
|
4603
|
+
# ],
|
|
4418
4604
|
# manage_master_user_password: false,
|
|
4419
4605
|
# master_user_secret_kms_key_id: "String",
|
|
4606
|
+
# additional_storage_volumes: [
|
|
4607
|
+
# {
|
|
4608
|
+
# volume_name: "String", # required
|
|
4609
|
+
# allocated_storage: 1,
|
|
4610
|
+
# iops: 1,
|
|
4611
|
+
# max_allocated_storage: 1,
|
|
4612
|
+
# storage_throughput: 1,
|
|
4613
|
+
# storage_type: "String",
|
|
4614
|
+
# },
|
|
4615
|
+
# ],
|
|
4420
4616
|
# })
|
|
4421
4617
|
# @param [Hash] options ({})
|
|
4422
4618
|
# @option options [required, String] :target_db_instance_identifier
|
|
@@ -4633,6 +4829,10 @@ module Aws::RDS
|
|
|
4633
4829
|
# * Must be an integer greater than 1000.
|
|
4634
4830
|
#
|
|
4635
4831
|
# ^
|
|
4832
|
+
# @option options [Integer] :storage_throughput
|
|
4833
|
+
# The storage throughput value for the DB instance.
|
|
4834
|
+
#
|
|
4835
|
+
# This setting doesn't apply to RDS Custom or Amazon Aurora.
|
|
4636
4836
|
# @option options [String] :option_group_name
|
|
4637
4837
|
# The name of the option group to use for the restored DB instance.
|
|
4638
4838
|
#
|
|
@@ -4826,12 +5026,6 @@ module Aws::RDS
|
|
|
4826
5026
|
#
|
|
4827
5027
|
#
|
|
4828
5028
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIOPS.StorageTypes.html#USER_PIOPS.Autoscaling
|
|
4829
|
-
# @option options [String] :source_db_instance_automated_backups_arn
|
|
4830
|
-
# The Amazon Resource Name (ARN) of the replicated automated backups
|
|
4831
|
-
# from which to restore, for example,
|
|
4832
|
-
# `arn:aws:rds:us-east-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE`.
|
|
4833
|
-
#
|
|
4834
|
-
# This setting doesn't apply to RDS Custom.
|
|
4835
5029
|
# @option options [Boolean] :enable_customer_owned_ip
|
|
4836
5030
|
# Specifies whether to enable a customer-owned IP address (CoIP) for an
|
|
4837
5031
|
# RDS on Outposts DB instance.
|
|
@@ -4854,27 +5048,31 @@ module Aws::RDS
|
|
|
4854
5048
|
#
|
|
4855
5049
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html
|
|
4856
5050
|
# [2]: https://docs.aws.amazon.com/outposts/latest/userguide/routing.html#ip-addressing
|
|
4857
|
-
# @option options [String] :
|
|
4858
|
-
# The
|
|
4859
|
-
# instance of an RDS Custom DB instance. The instance profile must meet
|
|
4860
|
-
# the following requirements:
|
|
5051
|
+
# @option options [String] :network_type
|
|
5052
|
+
# The network type of the DB instance.
|
|
4861
5053
|
#
|
|
4862
|
-
#
|
|
5054
|
+
# The network type is determined by the `DBSubnetGroup` specified for
|
|
5055
|
+
# the DB instance. A `DBSubnetGroup` can support only the IPv4 protocol
|
|
5056
|
+
# or the IPv4 and the IPv6 protocols (`DUAL`).
|
|
4863
5057
|
#
|
|
4864
|
-
#
|
|
4865
|
-
#
|
|
5058
|
+
# For more information, see [ Working with a DB instance in a VPC][1] in
|
|
5059
|
+
# the *Amazon RDS User Guide.*
|
|
4866
5060
|
#
|
|
4867
|
-
#
|
|
4868
|
-
# start with the prefix `AWSRDSCustom`.
|
|
5061
|
+
# Valid Values:
|
|
4869
5062
|
#
|
|
4870
|
-
#
|
|
4871
|
-
# IAM and your VPC][1] in the *Amazon RDS User Guide*.
|
|
5063
|
+
# * `IPV4`
|
|
4872
5064
|
#
|
|
4873
|
-
#
|
|
5065
|
+
# * `DUAL`
|
|
4874
5066
|
#
|
|
4875
5067
|
#
|
|
4876
5068
|
#
|
|
4877
|
-
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/
|
|
5069
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html
|
|
5070
|
+
# @option options [String] :source_db_instance_automated_backups_arn
|
|
5071
|
+
# The Amazon Resource Name (ARN) of the replicated automated backups
|
|
5072
|
+
# from which to restore, for example,
|
|
5073
|
+
# `arn:aws:rds:us-east-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE`.
|
|
5074
|
+
#
|
|
5075
|
+
# This setting doesn't apply to RDS Custom.
|
|
4878
5076
|
# @option options [String] :backup_target
|
|
4879
5077
|
# The location for storing automated backups and manual snapshots for
|
|
4880
5078
|
# the restored DB instance.
|
|
@@ -4895,29 +5093,27 @@ module Aws::RDS
|
|
|
4895
5093
|
#
|
|
4896
5094
|
#
|
|
4897
5095
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html
|
|
4898
|
-
# @option options [String] :
|
|
4899
|
-
# The
|
|
4900
|
-
#
|
|
4901
|
-
#
|
|
4902
|
-
# the DB instance. A `DBSubnetGroup` can support only the IPv4 protocol
|
|
4903
|
-
# or the IPv4 and the IPv6 protocols (`DUAL`).
|
|
5096
|
+
# @option options [String] :custom_iam_instance_profile
|
|
5097
|
+
# The instance profile associated with the underlying Amazon EC2
|
|
5098
|
+
# instance of an RDS Custom DB instance. The instance profile must meet
|
|
5099
|
+
# the following requirements:
|
|
4904
5100
|
#
|
|
4905
|
-
#
|
|
4906
|
-
# the *Amazon RDS User Guide.*
|
|
5101
|
+
# * The profile must exist in your account.
|
|
4907
5102
|
#
|
|
4908
|
-
#
|
|
5103
|
+
# * The profile must have an IAM role that Amazon EC2 has permissions to
|
|
5104
|
+
# assume.
|
|
4909
5105
|
#
|
|
4910
|
-
# *
|
|
5106
|
+
# * The instance profile name and the associated IAM role name must
|
|
5107
|
+
# start with the prefix `AWSRDSCustom`.
|
|
4911
5108
|
#
|
|
4912
|
-
#
|
|
5109
|
+
# For the list of permissions required for the IAM role, see [ Configure
|
|
5110
|
+
# IAM and your VPC][1] in the *Amazon RDS User Guide*.
|
|
4913
5111
|
#
|
|
5112
|
+
# This setting is required for RDS Custom.
|
|
4914
5113
|
#
|
|
4915
5114
|
#
|
|
4916
|
-
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html
|
|
4917
|
-
# @option options [Integer] :storage_throughput
|
|
4918
|
-
# The storage throughput value for the DB instance.
|
|
4919
5115
|
#
|
|
4920
|
-
#
|
|
5116
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-setup-orcl.html#custom-setup-orcl.iam-vpc
|
|
4921
5117
|
# @option options [Integer] :allocated_storage
|
|
4922
5118
|
# The amount of storage (in gibibytes) to allocate initially for the DB
|
|
4923
5119
|
# instance. Follow the allocation rules specified in `CreateDBInstance`.
|
|
@@ -4979,6 +5175,14 @@ module Aws::RDS
|
|
|
4979
5175
|
#
|
|
4980
5176
|
#
|
|
4981
5177
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/extended-support.html
|
|
5178
|
+
# @option options [Array<Types::TagSpecification>] :tag_specifications
|
|
5179
|
+
# Tags to assign to resources associated with the DB instance.
|
|
5180
|
+
#
|
|
5181
|
+
# Valid Values:
|
|
5182
|
+
#
|
|
5183
|
+
# * `auto-backup` - The DB instance's automated backup.
|
|
5184
|
+
#
|
|
5185
|
+
# ^
|
|
4982
5186
|
# @option options [Boolean] :manage_master_user_password
|
|
4983
5187
|
# Specifies whether to manage the master user password with Amazon Web
|
|
4984
5188
|
# Services Secrets Manager in the restored DB instance.
|
|
@@ -5017,6 +5221,12 @@ module Aws::RDS
|
|
|
5017
5221
|
# There is a default KMS key for your Amazon Web Services account. Your
|
|
5018
5222
|
# Amazon Web Services account has a different default KMS key for each
|
|
5019
5223
|
# Amazon Web Services Region.
|
|
5224
|
+
# @option options [Array<Types::AdditionalStorageVolume>] :additional_storage_volumes
|
|
5225
|
+
# A list of additional storage volumes to restore to the DB instance.
|
|
5226
|
+
# You can restore up to three additional storage volumes using the names
|
|
5227
|
+
# `rdsdbdata2`, `rdsdbdata3`, and `rdsdbdata4`. Additional storage
|
|
5228
|
+
# volumes are supported for RDS for Oracle and RDS for SQL Server DB
|
|
5229
|
+
# instances only.
|
|
5020
5230
|
# @return [DBInstance]
|
|
5021
5231
|
def restore(options = {})
|
|
5022
5232
|
options = options.merge(source_db_instance_identifier: @id)
|