aws-sdk-rds 1.290.0 → 1.300.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +50 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-rds/client.rb +1558 -1397
- data/lib/aws-sdk-rds/client_api.rb +238 -159
- data/lib/aws-sdk-rds/customizations.rb +0 -1
- data/lib/aws-sdk-rds/db_cluster.rb +383 -345
- data/lib/aws-sdk-rds/db_cluster_parameter_group.rb +2 -2
- data/lib/aws-sdk-rds/db_cluster_snapshot.rb +25 -25
- data/lib/aws-sdk-rds/db_engine_version.rb +55 -55
- data/lib/aws-sdk-rds/db_instance.rb +351 -318
- data/lib/aws-sdk-rds/db_parameter_group.rb +2 -2
- data/lib/aws-sdk-rds/db_snapshot.rb +74 -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 +239 -227
- data/lib/aws-sdk-rds/types.rb +1296 -1066
- data/lib/aws-sdk-rds.rb +1 -1
- data/sig/client.rbs +113 -104
- data/sig/db_cluster.rbs +69 -64
- data/sig/db_cluster_snapshot.rbs +6 -6
- data/sig/db_engine_version.rbs +21 -21
- data/sig/db_instance.rbs +50 -45
- data/sig/db_snapshot.rbs +14 -14
- data/sig/errors.rbs +2 -0
- data/sig/event.rbs +1 -1
- data/sig/resource.rbs +23 -21
- data/sig/types.rbs +136 -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.
|
|
@@ -962,7 +976,7 @@ module Aws::RDS
|
|
|
962
976
|
# db_instance_class: "String", # required
|
|
963
977
|
# engine: "String", # required
|
|
964
978
|
# master_username: "String",
|
|
965
|
-
# master_user_password: "
|
|
979
|
+
# master_user_password: "SensitiveString",
|
|
966
980
|
# db_security_groups: ["String"],
|
|
967
981
|
# vpc_security_group_ids: ["String"],
|
|
968
982
|
# availability_zone: "String",
|
|
@@ -977,6 +991,7 @@ module Aws::RDS
|
|
|
977
991
|
# auto_minor_version_upgrade: false,
|
|
978
992
|
# license_model: "String",
|
|
979
993
|
# iops: 1,
|
|
994
|
+
# storage_throughput: 1,
|
|
980
995
|
# option_group_name: "String",
|
|
981
996
|
# character_set_name: "String",
|
|
982
997
|
# nchar_character_set_name: "String",
|
|
@@ -990,7 +1005,7 @@ module Aws::RDS
|
|
|
990
1005
|
# db_cluster_identifier: "String",
|
|
991
1006
|
# storage_type: "String",
|
|
992
1007
|
# tde_credential_arn: "String",
|
|
993
|
-
# tde_credential_password: "
|
|
1008
|
+
# tde_credential_password: "SensitiveString",
|
|
994
1009
|
# storage_encrypted: false,
|
|
995
1010
|
# kms_key_id: "String",
|
|
996
1011
|
# domain: "String",
|
|
@@ -1019,17 +1034,17 @@ module Aws::RDS
|
|
|
1019
1034
|
# deletion_protection: false,
|
|
1020
1035
|
# max_allocated_storage: 1,
|
|
1021
1036
|
# enable_customer_owned_ip: false,
|
|
1022
|
-
# custom_iam_instance_profile: "String",
|
|
1023
|
-
# backup_target: "String",
|
|
1024
1037
|
# network_type: "String",
|
|
1025
|
-
#
|
|
1038
|
+
# backup_target: "String",
|
|
1039
|
+
# custom_iam_instance_profile: "String",
|
|
1040
|
+
# db_system_id: "String",
|
|
1041
|
+
# ca_certificate_identifier: "String",
|
|
1026
1042
|
# manage_master_user_password: false,
|
|
1027
1043
|
# master_user_secret_kms_key_id: "String",
|
|
1028
|
-
# ca_certificate_identifier: "String",
|
|
1029
|
-
# db_system_id: "String",
|
|
1030
|
-
# dedicated_log_volume: false,
|
|
1031
1044
|
# multi_tenant: false,
|
|
1045
|
+
# dedicated_log_volume: false,
|
|
1032
1046
|
# engine_lifecycle_support: "String",
|
|
1047
|
+
# master_user_authentication_type: "password", # accepts password, iam-db-auth
|
|
1033
1048
|
# })
|
|
1034
1049
|
# @param [Hash] options ({})
|
|
1035
1050
|
# @option options [String] :db_name
|
|
@@ -1691,6 +1706,14 @@ module Aws::RDS
|
|
|
1691
1706
|
#
|
|
1692
1707
|
#
|
|
1693
1708
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html
|
|
1709
|
+
# @option options [Integer] :storage_throughput
|
|
1710
|
+
# The storage throughput value, in mebibyte per second (MiBps), for the
|
|
1711
|
+
# DB instance.
|
|
1712
|
+
#
|
|
1713
|
+
# This setting applies only to the `gp3` storage type.
|
|
1714
|
+
#
|
|
1715
|
+
# This setting doesn't apply to Amazon Aurora or RDS Custom DB
|
|
1716
|
+
# instances.
|
|
1694
1717
|
# @option options [String] :option_group_name
|
|
1695
1718
|
# The option group to associate the DB instance with.
|
|
1696
1719
|
#
|
|
@@ -1720,37 +1743,28 @@ module Aws::RDS
|
|
|
1720
1743
|
# Specifies whether the DB instance is publicly accessible.
|
|
1721
1744
|
#
|
|
1722
1745
|
# When the DB instance is publicly accessible and you connect from
|
|
1723
|
-
# outside of the DB instance's virtual private cloud (VPC), its
|
|
1724
|
-
#
|
|
1746
|
+
# outside of the DB instance's virtual private cloud (VPC), its domain
|
|
1747
|
+
# name system (DNS) endpoint resolves to the public IP address. When you
|
|
1725
1748
|
# connect from within the same VPC as the DB instance, the endpoint
|
|
1726
1749
|
# 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.
|
|
1750
|
+
# controlled by its security group settings.
|
|
1730
1751
|
#
|
|
1731
1752
|
# When the DB instance isn't publicly accessible, it is an internal DB
|
|
1732
1753
|
# instance with a DNS name that resolves to a private IP address.
|
|
1733
1754
|
#
|
|
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.
|
|
1755
|
+
# The default behavior when `PubliclyAccessible` is not specified
|
|
1756
|
+
# depends on whether a `DBSubnetGroup` is specified.
|
|
1742
1757
|
#
|
|
1743
|
-
#
|
|
1744
|
-
#
|
|
1758
|
+
# If `DBSubnetGroup` isn't specified, `PubliclyAccessible` defaults to
|
|
1759
|
+
# `false` for Aurora instances and `true` for non-Aurora instances.
|
|
1745
1760
|
#
|
|
1746
|
-
# If `
|
|
1747
|
-
#
|
|
1761
|
+
# If `DBSubnetGroup` is specified, `PubliclyAccessible` defaults to
|
|
1762
|
+
# `false` unless the value of `DBSubnetGroup` is `default`, in which
|
|
1763
|
+
# case `PubliclyAccessible` defaults to `true`.
|
|
1748
1764
|
#
|
|
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.
|
|
1765
|
+
# If `PubliclyAccessible` is true and the VPC that the `DBSubnetGroup`
|
|
1766
|
+
# is in doesn't have an internet gateway attached to it, Amazon RDS
|
|
1767
|
+
# returns an error.
|
|
1754
1768
|
# @option options [Array<Types::Tag>] :tags
|
|
1755
1769
|
# Tags to assign to the DB instance.
|
|
1756
1770
|
# @option options [String] :db_cluster_identifier
|
|
@@ -2094,28 +2108,21 @@ module Aws::RDS
|
|
|
2094
2108
|
#
|
|
2095
2109
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html
|
|
2096
2110
|
# [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.
|
|
2111
|
+
# @option options [String] :network_type
|
|
2112
|
+
# The network type of the DB instance.
|
|
2106
2113
|
#
|
|
2107
|
-
#
|
|
2108
|
-
#
|
|
2114
|
+
# The network type is determined by the `DBSubnetGroup` specified for
|
|
2115
|
+
# the DB instance. A `DBSubnetGroup` can support only the IPv4 protocol
|
|
2116
|
+
# or the IPv4 and the IPv6 protocols (`DUAL`).
|
|
2109
2117
|
#
|
|
2110
|
-
#
|
|
2111
|
-
#
|
|
2118
|
+
# For more information, see [ Working with a DB instance in a VPC][1] in
|
|
2119
|
+
# the *Amazon RDS User Guide.*
|
|
2112
2120
|
#
|
|
2113
|
-
#
|
|
2114
|
-
# IAM and your VPC][1] in the *Amazon RDS User Guide*.
|
|
2121
|
+
# Valid Values: `IPV4 | DUAL`
|
|
2115
2122
|
#
|
|
2116
2123
|
#
|
|
2117
2124
|
#
|
|
2118
|
-
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/
|
|
2125
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html
|
|
2119
2126
|
# @option options [String] :backup_target
|
|
2120
2127
|
# The location for storing automated backups and manual snapshots.
|
|
2121
2128
|
#
|
|
@@ -2135,42 +2142,63 @@ module Aws::RDS
|
|
|
2135
2142
|
#
|
|
2136
2143
|
#
|
|
2137
2144
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html
|
|
2138
|
-
# @option options [String] :
|
|
2139
|
-
# The
|
|
2140
|
-
#
|
|
2141
|
-
# The network type is determined by the `DBSubnetGroup` specified for
|
|
2142
|
-
# the DB instance. A `DBSubnetGroup` can support only the IPv4 protocol
|
|
2143
|
-
# or the IPv4 and the IPv6 protocols (`DUAL`).
|
|
2144
|
-
#
|
|
2145
|
-
# For more information, see [ Working with a DB instance in a VPC][1] in
|
|
2146
|
-
# the *Amazon RDS User Guide.*
|
|
2145
|
+
# @option options [String] :custom_iam_instance_profile
|
|
2146
|
+
# The instance profile associated with the underlying Amazon EC2
|
|
2147
|
+
# instance of an RDS Custom DB instance.
|
|
2147
2148
|
#
|
|
2148
|
-
#
|
|
2149
|
+
# This setting is required for RDS Custom.
|
|
2149
2150
|
#
|
|
2151
|
+
# Constraints:
|
|
2150
2152
|
#
|
|
2153
|
+
# * The profile must exist in your account.
|
|
2151
2154
|
#
|
|
2152
|
-
#
|
|
2153
|
-
#
|
|
2154
|
-
# The storage throughput value, in mebibyte per second (MiBps), for the
|
|
2155
|
-
# DB instance.
|
|
2155
|
+
# * The profile must have an IAM role that Amazon EC2 has permissions to
|
|
2156
|
+
# assume.
|
|
2156
2157
|
#
|
|
2157
|
-
#
|
|
2158
|
+
# * The instance profile name and the associated IAM role name must
|
|
2159
|
+
# start with the prefix `AWSRDSCustom`.
|
|
2158
2160
|
#
|
|
2159
|
-
#
|
|
2160
|
-
#
|
|
2161
|
-
# @option options [Boolean] :manage_master_user_password
|
|
2162
|
-
# Specifies whether to manage the master user password with Amazon Web
|
|
2163
|
-
# Services Secrets Manager.
|
|
2161
|
+
# For the list of permissions required for the IAM role, see [ Configure
|
|
2162
|
+
# IAM and your VPC][1] in the *Amazon RDS User Guide*.
|
|
2164
2163
|
#
|
|
2165
|
-
# For more information, see [Password management with Amazon Web
|
|
2166
|
-
# Services Secrets Manager][1] in the *Amazon RDS User Guide.*
|
|
2167
2164
|
#
|
|
2168
|
-
# Constraints:
|
|
2169
2165
|
#
|
|
2170
|
-
#
|
|
2171
|
-
#
|
|
2166
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-setup-orcl.html#custom-setup-orcl.iam-vpc
|
|
2167
|
+
# @option options [String] :db_system_id
|
|
2168
|
+
# The Oracle system identifier (SID), which is the name of the Oracle
|
|
2169
|
+
# database instance that manages your database files. In this context,
|
|
2170
|
+
# the term "Oracle database instance" refers exclusively to the system
|
|
2171
|
+
# global area (SGA) and Oracle background processes. If you don't
|
|
2172
|
+
# specify a SID, the value defaults to `RDSCDB`. The Oracle SID is also
|
|
2173
|
+
# the name of your CDB.
|
|
2174
|
+
# @option options [String] :ca_certificate_identifier
|
|
2175
|
+
# The CA certificate identifier to use for the DB instance's server
|
|
2176
|
+
# certificate.
|
|
2172
2177
|
#
|
|
2173
|
-
#
|
|
2178
|
+
# This setting doesn't apply to RDS Custom DB instances.
|
|
2179
|
+
#
|
|
2180
|
+
# For more information, see [Using SSL/TLS to encrypt a connection to a
|
|
2181
|
+
# DB instance][1] in the *Amazon RDS User Guide* and [ Using SSL/TLS to
|
|
2182
|
+
# encrypt a connection to a DB cluster][2] in the *Amazon Aurora User
|
|
2183
|
+
# Guide*.
|
|
2184
|
+
#
|
|
2185
|
+
#
|
|
2186
|
+
#
|
|
2187
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL.html
|
|
2188
|
+
# [2]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL.html
|
|
2189
|
+
# @option options [Boolean] :manage_master_user_password
|
|
2190
|
+
# Specifies whether to manage the master user password with Amazon Web
|
|
2191
|
+
# Services Secrets Manager.
|
|
2192
|
+
#
|
|
2193
|
+
# For more information, see [Password management with Amazon Web
|
|
2194
|
+
# Services Secrets Manager][1] in the *Amazon RDS User Guide.*
|
|
2195
|
+
#
|
|
2196
|
+
# Constraints:
|
|
2197
|
+
#
|
|
2198
|
+
# * Can't manage the master user password with Amazon Web Services
|
|
2199
|
+
# Secrets Manager if `MasterUserPassword` is specified.
|
|
2200
|
+
#
|
|
2201
|
+
# ^
|
|
2174
2202
|
#
|
|
2175
2203
|
#
|
|
2176
2204
|
#
|
|
@@ -2197,31 +2225,6 @@ module Aws::RDS
|
|
|
2197
2225
|
# There is a default KMS key for your Amazon Web Services account. Your
|
|
2198
2226
|
# Amazon Web Services account has a different default KMS key for each
|
|
2199
2227
|
# 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
2228
|
# @option options [Boolean] :multi_tenant
|
|
2226
2229
|
# Specifies whether to use the multi-tenant configuration or the
|
|
2227
2230
|
# single-tenant configuration (default). This parameter only applies to
|
|
@@ -2237,6 +2240,9 @@ module Aws::RDS
|
|
|
2237
2240
|
# * If you specify the multi-tenant configuration when you create your
|
|
2238
2241
|
# DB instance, you can't later modify this DB instance to use the
|
|
2239
2242
|
# single-tenant configuration.
|
|
2243
|
+
# @option options [Boolean] :dedicated_log_volume
|
|
2244
|
+
# Indicates whether the DB instance has a dedicated log volume (DLV)
|
|
2245
|
+
# enabled.
|
|
2240
2246
|
# @option options [String] :engine_lifecycle_support
|
|
2241
2247
|
# The life cycle type for this DB instance.
|
|
2242
2248
|
#
|
|
@@ -2268,6 +2274,19 @@ module Aws::RDS
|
|
|
2268
2274
|
#
|
|
2269
2275
|
#
|
|
2270
2276
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/extended-support.html
|
|
2277
|
+
# @option options [String] :master_user_authentication_type
|
|
2278
|
+
# Specifies the authentication type for the master user. With IAM master
|
|
2279
|
+
# user authentication, you can configure the master DB user with IAM
|
|
2280
|
+
# database authentication when you create a DB instance.
|
|
2281
|
+
#
|
|
2282
|
+
# You can specify one of the following values:
|
|
2283
|
+
#
|
|
2284
|
+
# * `password` - Use standard database authentication with a password.
|
|
2285
|
+
#
|
|
2286
|
+
# * `iam-db-auth` - Use IAM database authentication for the master user.
|
|
2287
|
+
#
|
|
2288
|
+
# This option is only valid for RDS for PostgreSQL and Aurora PostgreSQL
|
|
2289
|
+
# engines.
|
|
2271
2290
|
# @return [DBInstance]
|
|
2272
2291
|
def create(options = {})
|
|
2273
2292
|
options = options.merge(db_instance_identifier: @id)
|
|
@@ -2291,6 +2310,7 @@ module Aws::RDS
|
|
|
2291
2310
|
# multi_az: false,
|
|
2292
2311
|
# auto_minor_version_upgrade: false,
|
|
2293
2312
|
# iops: 1,
|
|
2313
|
+
# storage_throughput: 1,
|
|
2294
2314
|
# option_group_name: "String",
|
|
2295
2315
|
# db_parameter_group_name: "String",
|
|
2296
2316
|
# publicly_accessible: false,
|
|
@@ -2307,7 +2327,7 @@ module Aws::RDS
|
|
|
2307
2327
|
# monitoring_interval: 1,
|
|
2308
2328
|
# monitoring_role_arn: "String",
|
|
2309
2329
|
# kms_key_id: "String",
|
|
2310
|
-
# pre_signed_url: "
|
|
2330
|
+
# pre_signed_url: "SensitiveString",
|
|
2311
2331
|
# enable_iam_database_authentication: false,
|
|
2312
2332
|
# database_insights_mode: "standard", # accepts standard, advanced
|
|
2313
2333
|
# enable_performance_insights: false,
|
|
@@ -2329,12 +2349,11 @@ module Aws::RDS
|
|
|
2329
2349
|
# domain_auth_secret_arn: "String",
|
|
2330
2350
|
# domain_dns_ips: ["String"],
|
|
2331
2351
|
# 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
2352
|
# enable_customer_owned_ip: false,
|
|
2353
|
+
# network_type: "String",
|
|
2354
|
+
# max_allocated_storage: 1,
|
|
2337
2355
|
# backup_target: "String",
|
|
2356
|
+
# custom_iam_instance_profile: "String",
|
|
2338
2357
|
# allocated_storage: 1,
|
|
2339
2358
|
# source_db_cluster_identifier: "String",
|
|
2340
2359
|
# dedicated_log_volume: false,
|
|
@@ -2399,6 +2418,11 @@ module Aws::RDS
|
|
|
2399
2418
|
# @option options [Integer] :iops
|
|
2400
2419
|
# The amount of Provisioned IOPS (input/output operations per second) to
|
|
2401
2420
|
# initially allocate for the DB instance.
|
|
2421
|
+
# @option options [Integer] :storage_throughput
|
|
2422
|
+
# Specifies the storage throughput value for the read replica.
|
|
2423
|
+
#
|
|
2424
|
+
# This setting doesn't apply to RDS Custom or Amazon Aurora DB
|
|
2425
|
+
# instances.
|
|
2402
2426
|
# @option options [String] :option_group_name
|
|
2403
2427
|
# The option group to associate the DB instance with. If not specified,
|
|
2404
2428
|
# RDS uses the option group associated with the source DB instance or
|
|
@@ -2841,38 +2865,26 @@ module Aws::RDS
|
|
|
2841
2865
|
#
|
|
2842
2866
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/db2-replication.html
|
|
2843
2867
|
# [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.
|
|
2868
|
+
# @option options [Boolean] :enable_customer_owned_ip
|
|
2869
|
+
# Specifies whether to enable a customer-owned IP address (CoIP) for an
|
|
2870
|
+
# RDS on Outposts read replica.
|
|
2864
2871
|
#
|
|
2865
|
-
# *
|
|
2866
|
-
#
|
|
2872
|
+
# A *CoIP* provides local or external connectivity to resources in your
|
|
2873
|
+
# Outpost subnets through your on-premises network. For some use cases,
|
|
2874
|
+
# a CoIP can provide lower latency for connections to the read replica
|
|
2875
|
+
# from outside of its virtual private cloud (VPC) on your local network.
|
|
2867
2876
|
#
|
|
2868
|
-
# For
|
|
2869
|
-
#
|
|
2877
|
+
# For more information about RDS on Outposts, see [Working with Amazon
|
|
2878
|
+
# RDS on Amazon Web Services Outposts][1] in the *Amazon RDS User
|
|
2879
|
+
# Guide*.
|
|
2870
2880
|
#
|
|
2871
|
-
#
|
|
2881
|
+
# For more information about CoIPs, see [Customer-owned IP addresses][2]
|
|
2882
|
+
# in the *Amazon Web Services Outposts User Guide*.
|
|
2872
2883
|
#
|
|
2873
2884
|
#
|
|
2874
2885
|
#
|
|
2875
|
-
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/
|
|
2886
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html
|
|
2887
|
+
# [2]: https://docs.aws.amazon.com/outposts/latest/userguide/routing.html#ip-addressing
|
|
2876
2888
|
# @option options [String] :network_type
|
|
2877
2889
|
# The network type of the DB instance.
|
|
2878
2890
|
#
|
|
@@ -2892,31 +2904,17 @@ module Aws::RDS
|
|
|
2892
2904
|
#
|
|
2893
2905
|
#
|
|
2894
2906
|
# [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*.
|
|
2907
|
+
# @option options [Integer] :max_allocated_storage
|
|
2908
|
+
# The upper limit in gibibytes (GiB) to which Amazon RDS can
|
|
2909
|
+
# automatically scale the storage of the DB instance.
|
|
2912
2910
|
#
|
|
2913
|
-
# For more information about
|
|
2914
|
-
#
|
|
2911
|
+
# For more information about this setting, including limitations that
|
|
2912
|
+
# apply to it, see [ Managing capacity automatically with Amazon RDS
|
|
2913
|
+
# storage autoscaling][1] in the *Amazon RDS User Guide*.
|
|
2915
2914
|
#
|
|
2916
2915
|
#
|
|
2917
2916
|
#
|
|
2918
|
-
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/
|
|
2919
|
-
# [2]: https://docs.aws.amazon.com/outposts/latest/userguide/routing.html#ip-addressing
|
|
2917
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIOPS.StorageTypes.html#USER_PIOPS.Autoscaling
|
|
2920
2918
|
# @option options [String] :backup_target
|
|
2921
2919
|
# The location where RDS stores automated backups and manual snapshots.
|
|
2922
2920
|
#
|
|
@@ -2925,6 +2923,27 @@ module Aws::RDS
|
|
|
2925
2923
|
# * `local` for Dedicated Local Zones
|
|
2926
2924
|
#
|
|
2927
2925
|
# * `region` for Amazon Web Services Region
|
|
2926
|
+
# @option options [String] :custom_iam_instance_profile
|
|
2927
|
+
# The instance profile associated with the underlying Amazon EC2
|
|
2928
|
+
# instance of an RDS Custom DB instance. The instance profile must meet
|
|
2929
|
+
# the following requirements:
|
|
2930
|
+
#
|
|
2931
|
+
# * The profile must exist in your account.
|
|
2932
|
+
#
|
|
2933
|
+
# * The profile must have an IAM role that Amazon EC2 has permissions to
|
|
2934
|
+
# assume.
|
|
2935
|
+
#
|
|
2936
|
+
# * The instance profile name and the associated IAM role name must
|
|
2937
|
+
# start with the prefix `AWSRDSCustom`.
|
|
2938
|
+
#
|
|
2939
|
+
# For the list of permissions required for the IAM role, see [ Configure
|
|
2940
|
+
# IAM and your VPC][1] in the *Amazon RDS User Guide*.
|
|
2941
|
+
#
|
|
2942
|
+
# This setting is required for RDS Custom DB instances.
|
|
2943
|
+
#
|
|
2944
|
+
#
|
|
2945
|
+
#
|
|
2946
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-setup-orcl.html#custom-setup-orcl.iam-vpc
|
|
2928
2947
|
# @option options [Integer] :allocated_storage
|
|
2929
2948
|
# The amount of storage (in gibibytes) to allocate initially for the
|
|
2930
2949
|
# read replica. Follow the allocation rules specified in
|
|
@@ -3117,7 +3136,7 @@ module Aws::RDS
|
|
|
3117
3136
|
# db_security_groups: ["String"],
|
|
3118
3137
|
# vpc_security_group_ids: ["String"],
|
|
3119
3138
|
# apply_immediately: false,
|
|
3120
|
-
# master_user_password: "
|
|
3139
|
+
# master_user_password: "SensitiveString",
|
|
3121
3140
|
# db_parameter_group_name: "String",
|
|
3122
3141
|
# backup_retention_period: 1,
|
|
3123
3142
|
# preferred_backup_window: "String",
|
|
@@ -3128,24 +3147,25 @@ module Aws::RDS
|
|
|
3128
3147
|
# auto_minor_version_upgrade: false,
|
|
3129
3148
|
# license_model: "String",
|
|
3130
3149
|
# iops: 1,
|
|
3150
|
+
# storage_throughput: 1,
|
|
3131
3151
|
# option_group_name: "String",
|
|
3132
3152
|
# new_db_instance_identifier: "String",
|
|
3133
3153
|
# storage_type: "String",
|
|
3134
3154
|
# tde_credential_arn: "String",
|
|
3135
|
-
# tde_credential_password: "
|
|
3155
|
+
# tde_credential_password: "SensitiveString",
|
|
3136
3156
|
# ca_certificate_identifier: "String",
|
|
3137
3157
|
# domain: "String",
|
|
3138
3158
|
# domain_fqdn: "String",
|
|
3139
3159
|
# domain_ou: "String",
|
|
3140
3160
|
# domain_auth_secret_arn: "String",
|
|
3141
3161
|
# domain_dns_ips: ["String"],
|
|
3162
|
+
# disable_domain: false,
|
|
3142
3163
|
# copy_tags_to_snapshot: false,
|
|
3143
3164
|
# monitoring_interval: 1,
|
|
3144
3165
|
# db_port_number: 1,
|
|
3145
3166
|
# publicly_accessible: false,
|
|
3146
3167
|
# monitoring_role_arn: "String",
|
|
3147
3168
|
# domain_iam_role_name: "String",
|
|
3148
|
-
# disable_domain: false,
|
|
3149
3169
|
# promotion_tier: 1,
|
|
3150
3170
|
# enable_iam_database_authentication: false,
|
|
3151
3171
|
# database_insights_mode: "standard", # accepts standard, advanced
|
|
@@ -3167,18 +3187,18 @@ module Aws::RDS
|
|
|
3167
3187
|
# max_allocated_storage: 1,
|
|
3168
3188
|
# certificate_rotation_restart: false,
|
|
3169
3189
|
# replica_mode: "open-read-only", # accepts open-read-only, mounted
|
|
3170
|
-
# enable_customer_owned_ip: false,
|
|
3171
|
-
# aws_backup_recovery_point_arn: "AwsBackupRecoveryPointArn",
|
|
3172
3190
|
# automation_mode: "full", # accepts full, all-paused
|
|
3173
3191
|
# resume_full_automation_mode_minutes: 1,
|
|
3192
|
+
# enable_customer_owned_ip: false,
|
|
3174
3193
|
# network_type: "String",
|
|
3175
|
-
#
|
|
3194
|
+
# aws_backup_recovery_point_arn: "AwsBackupRecoveryPointArn",
|
|
3176
3195
|
# manage_master_user_password: false,
|
|
3177
3196
|
# rotate_master_user_password: false,
|
|
3178
3197
|
# master_user_secret_kms_key_id: "String",
|
|
3179
|
-
# engine: "String",
|
|
3180
|
-
# dedicated_log_volume: false,
|
|
3181
3198
|
# multi_tenant: false,
|
|
3199
|
+
# dedicated_log_volume: false,
|
|
3200
|
+
# engine: "String",
|
|
3201
|
+
# master_user_authentication_type: "password", # accepts password, iam-db-auth
|
|
3182
3202
|
# })
|
|
3183
3203
|
# @param [Hash] options ({})
|
|
3184
3204
|
# @option options [Integer] :allocated_storage
|
|
@@ -3602,6 +3622,13 @@ module Aws::RDS
|
|
|
3602
3622
|
# `AllocatedStorage`.
|
|
3603
3623
|
#
|
|
3604
3624
|
# Default: Uses existing setting
|
|
3625
|
+
# @option options [Integer] :storage_throughput
|
|
3626
|
+
# The storage throughput value for the DB instance.
|
|
3627
|
+
#
|
|
3628
|
+
# This setting applies only to the `gp3` storage type.
|
|
3629
|
+
#
|
|
3630
|
+
# This setting doesn't apply to Amazon Aurora or RDS Custom DB
|
|
3631
|
+
# instances.
|
|
3605
3632
|
# @option options [String] :option_group_name
|
|
3606
3633
|
# The option group to associate the DB instance with.
|
|
3607
3634
|
#
|
|
@@ -3720,7 +3747,7 @@ module Aws::RDS
|
|
|
3720
3747
|
#
|
|
3721
3748
|
# * Must be in the distinguished name format.
|
|
3722
3749
|
#
|
|
3723
|
-
#
|
|
3750
|
+
# ^
|
|
3724
3751
|
#
|
|
3725
3752
|
# Example:
|
|
3726
3753
|
# `OU=mymanagedADtestOU,DC=mymanagedADtest,DC=mymanagedAD,DC=mydomain`
|
|
@@ -3743,6 +3770,9 @@ module Aws::RDS
|
|
|
3743
3770
|
# ^
|
|
3744
3771
|
#
|
|
3745
3772
|
# Example: `123.124.125.126,234.235.236.237`
|
|
3773
|
+
# @option options [Boolean] :disable_domain
|
|
3774
|
+
# Specifies whether to remove the DB instance from the Active Directory
|
|
3775
|
+
# domain.
|
|
3746
3776
|
# @option options [Boolean] :copy_tags_to_snapshot
|
|
3747
3777
|
# Specifies whether to copy all tags from the DB instance to snapshots
|
|
3748
3778
|
# of the DB instance. By default, tags aren't copied.
|
|
@@ -3841,9 +3871,6 @@ module Aws::RDS
|
|
|
3841
3871
|
# Service.
|
|
3842
3872
|
#
|
|
3843
3873
|
# 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
3874
|
# @option options [Integer] :promotion_tier
|
|
3848
3875
|
# The order of priority in which an Aurora Replica is promoted to the
|
|
3849
3876
|
# primary instance after a failure of the existing primary instance. For
|
|
@@ -4070,6 +4097,22 @@ module Aws::RDS
|
|
|
4070
4097
|
#
|
|
4071
4098
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/db2-replication.html
|
|
4072
4099
|
# [2]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-read-replicas.html
|
|
4100
|
+
# @option options [String] :automation_mode
|
|
4101
|
+
# The automation mode of the RDS Custom DB instance. If `full`, the DB
|
|
4102
|
+
# instance automates monitoring and instance recovery. If `all paused`,
|
|
4103
|
+
# the instance pauses automation for the duration set by
|
|
4104
|
+
# `ResumeFullAutomationModeMinutes`.
|
|
4105
|
+
# @option options [Integer] :resume_full_automation_mode_minutes
|
|
4106
|
+
# The number of minutes to pause the automation. When the time period
|
|
4107
|
+
# ends, RDS Custom resumes full automation.
|
|
4108
|
+
#
|
|
4109
|
+
# Default: `60`
|
|
4110
|
+
#
|
|
4111
|
+
# Constraints:
|
|
4112
|
+
#
|
|
4113
|
+
# * Must be at least 60.
|
|
4114
|
+
#
|
|
4115
|
+
# * Must be no more than 1,440.
|
|
4073
4116
|
# @option options [Boolean] :enable_customer_owned_ip
|
|
4074
4117
|
# Specifies whether to enable a customer-owned IP address (CoIP) for an
|
|
4075
4118
|
# RDS on Outposts DB instance.
|
|
@@ -4090,27 +4133,6 @@ module Aws::RDS
|
|
|
4090
4133
|
#
|
|
4091
4134
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html
|
|
4092
4135
|
# [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
4136
|
# @option options [String] :network_type
|
|
4115
4137
|
# The network type of the DB instance.
|
|
4116
4138
|
#
|
|
@@ -4126,13 +4148,11 @@ module Aws::RDS
|
|
|
4126
4148
|
#
|
|
4127
4149
|
#
|
|
4128
4150
|
# [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.
|
|
4151
|
+
# @option options [String] :aws_backup_recovery_point_arn
|
|
4152
|
+
# The Amazon Resource Name (ARN) of the recovery point in Amazon Web
|
|
4153
|
+
# Services Backup.
|
|
4133
4154
|
#
|
|
4134
|
-
# This setting doesn't apply to
|
|
4135
|
-
# instances.
|
|
4155
|
+
# This setting doesn't apply to RDS Custom DB instances.
|
|
4136
4156
|
# @option options [Boolean] :manage_master_user_password
|
|
4137
4157
|
# Specifies whether to manage the master user password with Amazon Web
|
|
4138
4158
|
# Services Secrets Manager.
|
|
@@ -4219,6 +4239,25 @@ module Aws::RDS
|
|
|
4219
4239
|
# There is a default KMS key for your Amazon Web Services account. Your
|
|
4220
4240
|
# Amazon Web Services account has a different default KMS key for each
|
|
4221
4241
|
# Amazon Web Services Region.
|
|
4242
|
+
# @option options [Boolean] :multi_tenant
|
|
4243
|
+
# Specifies whether the to convert your DB instance from the
|
|
4244
|
+
# single-tenant configuration to the multi-tenant configuration. This
|
|
4245
|
+
# parameter is supported only for RDS for Oracle CDB instances.
|
|
4246
|
+
#
|
|
4247
|
+
# During the conversion, RDS creates an initial tenant database and
|
|
4248
|
+
# associates the DB name, master user name, character set, and national
|
|
4249
|
+
# character set metadata with this database. The tags associated with
|
|
4250
|
+
# the instance also propagate to the initial tenant database. You can
|
|
4251
|
+
# add more tenant databases to your DB instance by using the
|
|
4252
|
+
# `CreateTenantDatabase` operation.
|
|
4253
|
+
#
|
|
4254
|
+
# The conversion to the multi-tenant configuration is permanent and
|
|
4255
|
+
# irreversible, so you can't later convert back to the single-tenant
|
|
4256
|
+
# configuration. When you specify this parameter, you must also specify
|
|
4257
|
+
# `ApplyImmediately`.
|
|
4258
|
+
# @option options [Boolean] :dedicated_log_volume
|
|
4259
|
+
# Indicates whether the DB instance has a dedicated log volume (DLV)
|
|
4260
|
+
# enabled.
|
|
4222
4261
|
# @option options [String] :engine
|
|
4223
4262
|
# The target Oracle DB engine when you convert a non-CDB to a CDB. This
|
|
4224
4263
|
# intermediate step is necessary to upgrade an Oracle Database 19c
|
|
@@ -4246,25 +4285,19 @@ module Aws::RDS
|
|
|
4246
4285
|
# parameter group. To avoid reverting to the default, specify a new
|
|
4247
4286
|
# parameter group with `--db-parameter-group-name` and a new option
|
|
4248
4287
|
# group with `--option-group-name`.
|
|
4249
|
-
# @option options [
|
|
4250
|
-
#
|
|
4251
|
-
#
|
|
4252
|
-
#
|
|
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.
|
|
4288
|
+
# @option options [String] :master_user_authentication_type
|
|
4289
|
+
# Specifies the authentication type for the master user. With IAM master
|
|
4290
|
+
# user authentication, you can change the master DB user to use IAM
|
|
4291
|
+
# database authentication.
|
|
4256
4292
|
#
|
|
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.
|
|
4293
|
+
# You can specify one of the following values:
|
|
4263
4294
|
#
|
|
4264
|
-
#
|
|
4265
|
-
#
|
|
4266
|
-
#
|
|
4267
|
-
#
|
|
4295
|
+
# * `password` - Use standard database authentication with a password.
|
|
4296
|
+
#
|
|
4297
|
+
# * `iam-db-auth` - Use IAM database authentication for the master user.
|
|
4298
|
+
#
|
|
4299
|
+
# This option is only valid for RDS for PostgreSQL and Aurora PostgreSQL
|
|
4300
|
+
# engines.
|
|
4268
4301
|
# @return [DBInstance]
|
|
4269
4302
|
def modify(options = {})
|
|
4270
4303
|
options = options.merge(db_instance_identifier: @id)
|
|
@@ -4374,6 +4407,7 @@ module Aws::RDS
|
|
|
4374
4407
|
# db_name: "String",
|
|
4375
4408
|
# engine: "String",
|
|
4376
4409
|
# iops: 1,
|
|
4410
|
+
# storage_throughput: 1,
|
|
4377
4411
|
# option_group_name: "String",
|
|
4378
4412
|
# copy_tags_to_snapshot: false,
|
|
4379
4413
|
# tags: [
|
|
@@ -4384,7 +4418,7 @@ module Aws::RDS
|
|
|
4384
4418
|
# ],
|
|
4385
4419
|
# storage_type: "String",
|
|
4386
4420
|
# tde_credential_arn: "String",
|
|
4387
|
-
# tde_credential_password: "
|
|
4421
|
+
# tde_credential_password: "SensitiveString",
|
|
4388
4422
|
# vpc_security_group_ids: ["String"],
|
|
4389
4423
|
# domain: "String",
|
|
4390
4424
|
# domain_iam_role_name: "String",
|
|
@@ -4405,12 +4439,11 @@ module Aws::RDS
|
|
|
4405
4439
|
# deletion_protection: false,
|
|
4406
4440
|
# source_dbi_resource_id: "String",
|
|
4407
4441
|
# max_allocated_storage: 1,
|
|
4408
|
-
# source_db_instance_automated_backups_arn: "String",
|
|
4409
4442
|
# enable_customer_owned_ip: false,
|
|
4410
|
-
# custom_iam_instance_profile: "String",
|
|
4411
|
-
# backup_target: "String",
|
|
4412
4443
|
# network_type: "String",
|
|
4413
|
-
#
|
|
4444
|
+
# source_db_instance_automated_backups_arn: "String",
|
|
4445
|
+
# backup_target: "String",
|
|
4446
|
+
# custom_iam_instance_profile: "String",
|
|
4414
4447
|
# allocated_storage: 1,
|
|
4415
4448
|
# dedicated_log_volume: false,
|
|
4416
4449
|
# ca_certificate_identifier: "String",
|
|
@@ -4633,6 +4666,10 @@ module Aws::RDS
|
|
|
4633
4666
|
# * Must be an integer greater than 1000.
|
|
4634
4667
|
#
|
|
4635
4668
|
# ^
|
|
4669
|
+
# @option options [Integer] :storage_throughput
|
|
4670
|
+
# The storage throughput value for the DB instance.
|
|
4671
|
+
#
|
|
4672
|
+
# This setting doesn't apply to RDS Custom or Amazon Aurora.
|
|
4636
4673
|
# @option options [String] :option_group_name
|
|
4637
4674
|
# The name of the option group to use for the restored DB instance.
|
|
4638
4675
|
#
|
|
@@ -4826,12 +4863,6 @@ module Aws::RDS
|
|
|
4826
4863
|
#
|
|
4827
4864
|
#
|
|
4828
4865
|
# [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
4866
|
# @option options [Boolean] :enable_customer_owned_ip
|
|
4836
4867
|
# Specifies whether to enable a customer-owned IP address (CoIP) for an
|
|
4837
4868
|
# RDS on Outposts DB instance.
|
|
@@ -4854,27 +4885,31 @@ module Aws::RDS
|
|
|
4854
4885
|
#
|
|
4855
4886
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html
|
|
4856
4887
|
# [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:
|
|
4888
|
+
# @option options [String] :network_type
|
|
4889
|
+
# The network type of the DB instance.
|
|
4861
4890
|
#
|
|
4862
|
-
#
|
|
4891
|
+
# The network type is determined by the `DBSubnetGroup` specified for
|
|
4892
|
+
# the DB instance. A `DBSubnetGroup` can support only the IPv4 protocol
|
|
4893
|
+
# or the IPv4 and the IPv6 protocols (`DUAL`).
|
|
4863
4894
|
#
|
|
4864
|
-
#
|
|
4865
|
-
#
|
|
4895
|
+
# For more information, see [ Working with a DB instance in a VPC][1] in
|
|
4896
|
+
# the *Amazon RDS User Guide.*
|
|
4866
4897
|
#
|
|
4867
|
-
#
|
|
4868
|
-
# start with the prefix `AWSRDSCustom`.
|
|
4898
|
+
# Valid Values:
|
|
4869
4899
|
#
|
|
4870
|
-
#
|
|
4871
|
-
# IAM and your VPC][1] in the *Amazon RDS User Guide*.
|
|
4900
|
+
# * `IPV4`
|
|
4872
4901
|
#
|
|
4873
|
-
#
|
|
4902
|
+
# * `DUAL`
|
|
4874
4903
|
#
|
|
4875
4904
|
#
|
|
4876
4905
|
#
|
|
4877
|
-
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/
|
|
4906
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html
|
|
4907
|
+
# @option options [String] :source_db_instance_automated_backups_arn
|
|
4908
|
+
# The Amazon Resource Name (ARN) of the replicated automated backups
|
|
4909
|
+
# from which to restore, for example,
|
|
4910
|
+
# `arn:aws:rds:us-east-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE`.
|
|
4911
|
+
#
|
|
4912
|
+
# This setting doesn't apply to RDS Custom.
|
|
4878
4913
|
# @option options [String] :backup_target
|
|
4879
4914
|
# The location for storing automated backups and manual snapshots for
|
|
4880
4915
|
# the restored DB instance.
|
|
@@ -4895,29 +4930,27 @@ module Aws::RDS
|
|
|
4895
4930
|
#
|
|
4896
4931
|
#
|
|
4897
4932
|
# [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`).
|
|
4933
|
+
# @option options [String] :custom_iam_instance_profile
|
|
4934
|
+
# The instance profile associated with the underlying Amazon EC2
|
|
4935
|
+
# instance of an RDS Custom DB instance. The instance profile must meet
|
|
4936
|
+
# the following requirements:
|
|
4904
4937
|
#
|
|
4905
|
-
#
|
|
4906
|
-
# the *Amazon RDS User Guide.*
|
|
4938
|
+
# * The profile must exist in your account.
|
|
4907
4939
|
#
|
|
4908
|
-
#
|
|
4940
|
+
# * The profile must have an IAM role that Amazon EC2 has permissions to
|
|
4941
|
+
# assume.
|
|
4909
4942
|
#
|
|
4910
|
-
# *
|
|
4943
|
+
# * The instance profile name and the associated IAM role name must
|
|
4944
|
+
# start with the prefix `AWSRDSCustom`.
|
|
4911
4945
|
#
|
|
4912
|
-
#
|
|
4946
|
+
# For the list of permissions required for the IAM role, see [ Configure
|
|
4947
|
+
# IAM and your VPC][1] in the *Amazon RDS User Guide*.
|
|
4913
4948
|
#
|
|
4949
|
+
# This setting is required for RDS Custom.
|
|
4914
4950
|
#
|
|
4915
4951
|
#
|
|
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
4952
|
#
|
|
4920
|
-
#
|
|
4953
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-setup-orcl.html#custom-setup-orcl.iam-vpc
|
|
4921
4954
|
# @option options [Integer] :allocated_storage
|
|
4922
4955
|
# The amount of storage (in gibibytes) to allocate initially for the DB
|
|
4923
4956
|
# instance. Follow the allocation rules specified in `CreateDBInstance`.
|