aws-sdk-rds 1.290.0 → 1.294.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +20 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-rds/client.rb +1518 -1355
- data/lib/aws-sdk-rds/client_api.rb +220 -159
- data/lib/aws-sdk-rds/customizations.rb +0 -1
- data/lib/aws-sdk-rds/db_cluster.rb +374 -341
- 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 +317 -289
- 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/option_group.rb +1 -1
- data/lib/aws-sdk-rds/resource.rb +212 -182
- data/lib/aws-sdk-rds/types.rb +1228 -1017
- data/lib/aws-sdk-rds.rb +1 -1
- data/sig/client.rbs +114 -105
- data/sig/db_cluster.rbs +68 -66
- data/sig/db_cluster_snapshot.rbs +6 -6
- data/sig/db_engine_version.rbs +21 -21
- data/sig/db_instance.rbs +47 -45
- data/sig/db_snapshot.rbs +14 -14
- data/sig/event.rbs +1 -1
- data/sig/resource.rbs +24 -22
- data/sig/types.rbs +133 -120
- metadata +1 -1
@@ -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
|
@@ -260,6 +254,14 @@ module Aws::RDS
|
|
260
254
|
data[:iops]
|
261
255
|
end
|
262
256
|
|
257
|
+
# The storage throughput for the DB instance.
|
258
|
+
#
|
259
|
+
# This setting applies only to the `gp3` storage type.
|
260
|
+
# @return [Integer]
|
261
|
+
def storage_throughput
|
262
|
+
data[:storage_throughput]
|
263
|
+
end
|
264
|
+
|
263
265
|
# The list of option group memberships for this DB instance.
|
264
266
|
# @return [Array<Types::OptionGroupMembership>]
|
265
267
|
def option_group_memberships
|
@@ -580,11 +582,21 @@ module Aws::RDS
|
|
580
582
|
data[:tag_list]
|
581
583
|
end
|
582
584
|
|
583
|
-
# The
|
584
|
-
# instance
|
585
|
-
#
|
586
|
-
|
587
|
-
|
585
|
+
# The automation mode of the RDS Custom DB instance: `full` or `all
|
586
|
+
# paused`. If `full`, the DB instance automates monitoring and instance
|
587
|
+
# recovery. If `all paused`, the instance pauses automation for the
|
588
|
+
# duration set by `--resume-full-automation-mode-minutes`.
|
589
|
+
# @return [String]
|
590
|
+
def automation_mode
|
591
|
+
data[:automation_mode]
|
592
|
+
end
|
593
|
+
|
594
|
+
# The number of minutes to pause the automation. When the time period
|
595
|
+
# ends, RDS Custom resumes full automation. The minimum value is 60
|
596
|
+
# (default). The maximum value is 1,440.
|
597
|
+
# @return [Time]
|
598
|
+
def resume_full_automation_mode_time
|
599
|
+
data[:resume_full_automation_mode_time]
|
588
600
|
end
|
589
601
|
|
590
602
|
# Indicates whether a customer-owned IP address (CoIP) is enabled for an
|
@@ -612,11 +624,25 @@ module Aws::RDS
|
|
612
624
|
data[:customer_owned_ip_enabled]
|
613
625
|
end
|
614
626
|
|
615
|
-
# The
|
616
|
-
#
|
627
|
+
# The network type of the DB instance.
|
628
|
+
#
|
629
|
+
# The network type is determined by the `DBSubnetGroup` specified for
|
630
|
+
# the DB instance. A `DBSubnetGroup` can support only the IPv4 protocol
|
631
|
+
# or the IPv4 and the IPv6 protocols (`DUAL`).
|
632
|
+
#
|
633
|
+
# For more information, see [ Working with a DB instance in a VPC][1] in
|
634
|
+
# the *Amazon RDS User Guide* and [ Working with a DB instance in a
|
635
|
+
# VPC][2] in the *Amazon Aurora User Guide.*
|
636
|
+
#
|
637
|
+
# Valid Values: `IPV4 | DUAL`
|
638
|
+
#
|
639
|
+
#
|
640
|
+
#
|
641
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html
|
642
|
+
# [2]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html
|
617
643
|
# @return [String]
|
618
|
-
def
|
619
|
-
data[:
|
644
|
+
def network_type
|
645
|
+
data[:network_type]
|
620
646
|
end
|
621
647
|
|
622
648
|
# The status of the database activity stream.
|
@@ -656,21 +682,32 @@ module Aws::RDS
|
|
656
682
|
data[:activity_stream_engine_native_audit_fields_included]
|
657
683
|
end
|
658
684
|
|
659
|
-
# The
|
660
|
-
#
|
661
|
-
# recovery. If `all paused`, the instance pauses automation for the
|
662
|
-
# duration set by `--resume-full-automation-mode-minutes`.
|
685
|
+
# The Amazon Resource Name (ARN) of the recovery point in Amazon Web
|
686
|
+
# Services Backup.
|
663
687
|
# @return [String]
|
664
|
-
def
|
665
|
-
data[:
|
688
|
+
def aws_backup_recovery_point_arn
|
689
|
+
data[:aws_backup_recovery_point_arn]
|
666
690
|
end
|
667
691
|
|
668
|
-
# The
|
669
|
-
#
|
670
|
-
#
|
692
|
+
# The list of replicated automated backups associated with the DB
|
693
|
+
# instance.
|
694
|
+
# @return [Array<Types::DBInstanceAutomatedBackupsReplication>]
|
695
|
+
def db_instance_automated_backups_replications
|
696
|
+
data[:db_instance_automated_backups_replications]
|
697
|
+
end
|
698
|
+
|
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 time when a stopped DB instance is restarted automatically.
|
671
708
|
# @return [Time]
|
672
|
-
def
|
673
|
-
data[:
|
709
|
+
def automatic_restart_time
|
710
|
+
data[:automatic_restart_time]
|
674
711
|
end
|
675
712
|
|
676
713
|
# The instance profile associated with the underlying Amazon EC2
|
@@ -696,47 +733,16 @@ module Aws::RDS
|
|
696
733
|
data[:custom_iam_instance_profile]
|
697
734
|
end
|
698
735
|
|
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
736
|
# The status of the policy state of the activity stream.
|
729
737
|
# @return [String]
|
730
738
|
def activity_stream_policy_status
|
731
739
|
data[:activity_stream_policy_status]
|
732
740
|
end
|
733
741
|
|
734
|
-
# The
|
735
|
-
#
|
736
|
-
|
737
|
-
|
738
|
-
def storage_throughput
|
739
|
-
data[:storage_throughput]
|
742
|
+
# The details of the DB instance's server certificate.
|
743
|
+
# @return [Types::CertificateDetails]
|
744
|
+
def certificate_details
|
745
|
+
data[:certificate_details]
|
740
746
|
end
|
741
747
|
|
742
748
|
# The Oracle system ID (Oracle SID) for a container database (CDB). The
|
@@ -761,12 +767,6 @@ module Aws::RDS
|
|
761
767
|
data[:master_user_secret]
|
762
768
|
end
|
763
769
|
|
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
770
|
# The identifier of the source DB cluster if this DB instance is a read
|
771
771
|
# replica.
|
772
772
|
# @return [String]
|
@@ -780,6 +780,13 @@ module Aws::RDS
|
|
780
780
|
data[:percent_progress]
|
781
781
|
end
|
782
782
|
|
783
|
+
# Specifies whether the DB instance is in the multi-tenant configuration
|
784
|
+
# (TRUE) or the single-tenant configuration (FALSE).
|
785
|
+
# @return [Boolean]
|
786
|
+
def multi_tenant
|
787
|
+
data[:multi_tenant]
|
788
|
+
end
|
789
|
+
|
783
790
|
# Indicates whether the DB instance has a dedicated log volume (DLV)
|
784
791
|
# enabled.
|
785
792
|
# @return [Boolean]
|
@@ -801,13 +808,6 @@ module Aws::RDS
|
|
801
808
|
data[:is_storage_config_upgrade_available]
|
802
809
|
end
|
803
810
|
|
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
811
|
# The lifecycle type for the DB instance.
|
812
812
|
#
|
813
813
|
# For more information, see CreateDBInstance.
|
@@ -962,7 +962,7 @@ module Aws::RDS
|
|
962
962
|
# db_instance_class: "String", # required
|
963
963
|
# engine: "String", # required
|
964
964
|
# master_username: "String",
|
965
|
-
# master_user_password: "
|
965
|
+
# master_user_password: "SensitiveString",
|
966
966
|
# db_security_groups: ["String"],
|
967
967
|
# vpc_security_group_ids: ["String"],
|
968
968
|
# availability_zone: "String",
|
@@ -977,6 +977,7 @@ module Aws::RDS
|
|
977
977
|
# auto_minor_version_upgrade: false,
|
978
978
|
# license_model: "String",
|
979
979
|
# iops: 1,
|
980
|
+
# storage_throughput: 1,
|
980
981
|
# option_group_name: "String",
|
981
982
|
# character_set_name: "String",
|
982
983
|
# nchar_character_set_name: "String",
|
@@ -990,7 +991,7 @@ module Aws::RDS
|
|
990
991
|
# db_cluster_identifier: "String",
|
991
992
|
# storage_type: "String",
|
992
993
|
# tde_credential_arn: "String",
|
993
|
-
# tde_credential_password: "
|
994
|
+
# tde_credential_password: "SensitiveString",
|
994
995
|
# storage_encrypted: false,
|
995
996
|
# kms_key_id: "String",
|
996
997
|
# domain: "String",
|
@@ -1019,17 +1020,17 @@ module Aws::RDS
|
|
1019
1020
|
# deletion_protection: false,
|
1020
1021
|
# max_allocated_storage: 1,
|
1021
1022
|
# enable_customer_owned_ip: false,
|
1022
|
-
# custom_iam_instance_profile: "String",
|
1023
|
-
# backup_target: "String",
|
1024
1023
|
# network_type: "String",
|
1025
|
-
#
|
1024
|
+
# backup_target: "String",
|
1025
|
+
# custom_iam_instance_profile: "String",
|
1026
|
+
# db_system_id: "String",
|
1027
|
+
# ca_certificate_identifier: "String",
|
1026
1028
|
# manage_master_user_password: false,
|
1027
1029
|
# master_user_secret_kms_key_id: "String",
|
1028
|
-
# ca_certificate_identifier: "String",
|
1029
|
-
# db_system_id: "String",
|
1030
|
-
# dedicated_log_volume: false,
|
1031
1030
|
# multi_tenant: false,
|
1031
|
+
# dedicated_log_volume: false,
|
1032
1032
|
# engine_lifecycle_support: "String",
|
1033
|
+
# master_user_authentication_type: "password", # accepts password, iam-db-auth
|
1033
1034
|
# })
|
1034
1035
|
# @param [Hash] options ({})
|
1035
1036
|
# @option options [String] :db_name
|
@@ -1691,6 +1692,14 @@ module Aws::RDS
|
|
1691
1692
|
#
|
1692
1693
|
#
|
1693
1694
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html
|
1695
|
+
# @option options [Integer] :storage_throughput
|
1696
|
+
# The storage throughput value, in mebibyte per second (MiBps), for the
|
1697
|
+
# DB instance.
|
1698
|
+
#
|
1699
|
+
# This setting applies only to the `gp3` storage type.
|
1700
|
+
#
|
1701
|
+
# This setting doesn't apply to Amazon Aurora or RDS Custom DB
|
1702
|
+
# instances.
|
1694
1703
|
# @option options [String] :option_group_name
|
1695
1704
|
# The option group to associate the DB instance with.
|
1696
1705
|
#
|
@@ -2094,28 +2103,21 @@ module Aws::RDS
|
|
2094
2103
|
#
|
2095
2104
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html
|
2096
2105
|
# [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.
|
2106
|
+
# @option options [String] :network_type
|
2107
|
+
# The network type of the DB instance.
|
2106
2108
|
#
|
2107
|
-
#
|
2108
|
-
#
|
2109
|
+
# The network type is determined by the `DBSubnetGroup` specified for
|
2110
|
+
# the DB instance. A `DBSubnetGroup` can support only the IPv4 protocol
|
2111
|
+
# or the IPv4 and the IPv6 protocols (`DUAL`).
|
2109
2112
|
#
|
2110
|
-
#
|
2111
|
-
#
|
2113
|
+
# For more information, see [ Working with a DB instance in a VPC][1] in
|
2114
|
+
# the *Amazon RDS User Guide.*
|
2112
2115
|
#
|
2113
|
-
#
|
2114
|
-
# IAM and your VPC][1] in the *Amazon RDS User Guide*.
|
2116
|
+
# Valid Values: `IPV4 | DUAL`
|
2115
2117
|
#
|
2116
2118
|
#
|
2117
2119
|
#
|
2118
|
-
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/
|
2120
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html
|
2119
2121
|
# @option options [String] :backup_target
|
2120
2122
|
# The location for storing automated backups and manual snapshots.
|
2121
2123
|
#
|
@@ -2135,29 +2137,50 @@ module Aws::RDS
|
|
2135
2137
|
#
|
2136
2138
|
#
|
2137
2139
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html
|
2138
|
-
# @option options [String] :
|
2139
|
-
# The
|
2140
|
+
# @option options [String] :custom_iam_instance_profile
|
2141
|
+
# The instance profile associated with the underlying Amazon EC2
|
2142
|
+
# instance of an RDS Custom DB instance.
|
2140
2143
|
#
|
2141
|
-
#
|
2142
|
-
# the DB instance. A `DBSubnetGroup` can support only the IPv4 protocol
|
2143
|
-
# or the IPv4 and the IPv6 protocols (`DUAL`).
|
2144
|
+
# This setting is required for RDS Custom.
|
2144
2145
|
#
|
2145
|
-
#
|
2146
|
-
# the *Amazon RDS User Guide.*
|
2146
|
+
# Constraints:
|
2147
2147
|
#
|
2148
|
-
#
|
2148
|
+
# * The profile must exist in your account.
|
2149
|
+
#
|
2150
|
+
# * The profile must have an IAM role that Amazon EC2 has permissions to
|
2151
|
+
# assume.
|
2149
2152
|
#
|
2153
|
+
# * The instance profile name and the associated IAM role name must
|
2154
|
+
# start with the prefix `AWSRDSCustom`.
|
2150
2155
|
#
|
2156
|
+
# For the list of permissions required for the IAM role, see [ Configure
|
2157
|
+
# IAM and your VPC][1] in the *Amazon RDS User Guide*.
|
2151
2158
|
#
|
2152
|
-
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html
|
2153
|
-
# @option options [Integer] :storage_throughput
|
2154
|
-
# The storage throughput value, in mebibyte per second (MiBps), for the
|
2155
|
-
# DB instance.
|
2156
2159
|
#
|
2157
|
-
# This setting applies only to the `gp3` storage type.
|
2158
2160
|
#
|
2159
|
-
#
|
2160
|
-
#
|
2161
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-setup-orcl.html#custom-setup-orcl.iam-vpc
|
2162
|
+
# @option options [String] :db_system_id
|
2163
|
+
# The Oracle system identifier (SID), which is the name of the Oracle
|
2164
|
+
# database instance that manages your database files. In this context,
|
2165
|
+
# the term "Oracle database instance" refers exclusively to the system
|
2166
|
+
# global area (SGA) and Oracle background processes. If you don't
|
2167
|
+
# specify a SID, the value defaults to `RDSCDB`. The Oracle SID is also
|
2168
|
+
# the name of your CDB.
|
2169
|
+
# @option options [String] :ca_certificate_identifier
|
2170
|
+
# The CA certificate identifier to use for the DB instance's server
|
2171
|
+
# certificate.
|
2172
|
+
#
|
2173
|
+
# This setting doesn't apply to RDS Custom DB instances.
|
2174
|
+
#
|
2175
|
+
# For more information, see [Using SSL/TLS to encrypt a connection to a
|
2176
|
+
# DB instance][1] in the *Amazon RDS User Guide* and [ Using SSL/TLS to
|
2177
|
+
# encrypt a connection to a DB cluster][2] in the *Amazon Aurora User
|
2178
|
+
# Guide*.
|
2179
|
+
#
|
2180
|
+
#
|
2181
|
+
#
|
2182
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL.html
|
2183
|
+
# [2]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL.html
|
2161
2184
|
# @option options [Boolean] :manage_master_user_password
|
2162
2185
|
# Specifies whether to manage the master user password with Amazon Web
|
2163
2186
|
# Services Secrets Manager.
|
@@ -2197,37 +2220,12 @@ module Aws::RDS
|
|
2197
2220
|
# There is a default KMS key for your Amazon Web Services account. Your
|
2198
2221
|
# Amazon Web Services account has a different default KMS key for each
|
2199
2222
|
# Amazon Web Services Region.
|
2200
|
-
# @option options [
|
2201
|
-
#
|
2202
|
-
#
|
2223
|
+
# @option options [Boolean] :multi_tenant
|
2224
|
+
# Specifies whether to use the multi-tenant configuration or the
|
2225
|
+
# single-tenant configuration (default). This parameter only applies to
|
2226
|
+
# RDS for Oracle container database (CDB) engines.
|
2203
2227
|
#
|
2204
|
-
#
|
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
|
-
# @option options [Boolean] :multi_tenant
|
2226
|
-
# Specifies whether to use the multi-tenant configuration or the
|
2227
|
-
# single-tenant configuration (default). This parameter only applies to
|
2228
|
-
# RDS for Oracle container database (CDB) engines.
|
2229
|
-
#
|
2230
|
-
# Note the following restrictions:
|
2228
|
+
# Note the following restrictions:
|
2231
2229
|
#
|
2232
2230
|
# * The DB engine that you specify in the request must support the
|
2233
2231
|
# multi-tenant configuration. If you attempt to enable the
|
@@ -2237,6 +2235,9 @@ module Aws::RDS
|
|
2237
2235
|
# * If you specify the multi-tenant configuration when you create your
|
2238
2236
|
# DB instance, you can't later modify this DB instance to use the
|
2239
2237
|
# single-tenant configuration.
|
2238
|
+
# @option options [Boolean] :dedicated_log_volume
|
2239
|
+
# Indicates whether the DB instance has a dedicated log volume (DLV)
|
2240
|
+
# enabled.
|
2240
2241
|
# @option options [String] :engine_lifecycle_support
|
2241
2242
|
# The life cycle type for this DB instance.
|
2242
2243
|
#
|
@@ -2268,6 +2269,19 @@ module Aws::RDS
|
|
2268
2269
|
#
|
2269
2270
|
#
|
2270
2271
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/extended-support.html
|
2272
|
+
# @option options [String] :master_user_authentication_type
|
2273
|
+
# Specifies the authentication type for the master user. With IAM master
|
2274
|
+
# user authentication, you can configure the master DB user with IAM
|
2275
|
+
# database authentication when you create a DB instance.
|
2276
|
+
#
|
2277
|
+
# You can specify one of the following values:
|
2278
|
+
#
|
2279
|
+
# * `password` - Use standard database authentication with a password.
|
2280
|
+
#
|
2281
|
+
# * `iam-db-auth` - Use IAM database authentication for the master user.
|
2282
|
+
#
|
2283
|
+
# This option is only valid for RDS for PostgreSQL and Aurora PostgreSQL
|
2284
|
+
# engines.
|
2271
2285
|
# @return [DBInstance]
|
2272
2286
|
def create(options = {})
|
2273
2287
|
options = options.merge(db_instance_identifier: @id)
|
@@ -2291,6 +2305,7 @@ module Aws::RDS
|
|
2291
2305
|
# multi_az: false,
|
2292
2306
|
# auto_minor_version_upgrade: false,
|
2293
2307
|
# iops: 1,
|
2308
|
+
# storage_throughput: 1,
|
2294
2309
|
# option_group_name: "String",
|
2295
2310
|
# db_parameter_group_name: "String",
|
2296
2311
|
# publicly_accessible: false,
|
@@ -2307,7 +2322,7 @@ module Aws::RDS
|
|
2307
2322
|
# monitoring_interval: 1,
|
2308
2323
|
# monitoring_role_arn: "String",
|
2309
2324
|
# kms_key_id: "String",
|
2310
|
-
# pre_signed_url: "
|
2325
|
+
# pre_signed_url: "SensitiveString",
|
2311
2326
|
# enable_iam_database_authentication: false,
|
2312
2327
|
# database_insights_mode: "standard", # accepts standard, advanced
|
2313
2328
|
# enable_performance_insights: false,
|
@@ -2329,12 +2344,11 @@ module Aws::RDS
|
|
2329
2344
|
# domain_auth_secret_arn: "String",
|
2330
2345
|
# domain_dns_ips: ["String"],
|
2331
2346
|
# 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
2347
|
# enable_customer_owned_ip: false,
|
2348
|
+
# network_type: "String",
|
2349
|
+
# max_allocated_storage: 1,
|
2337
2350
|
# backup_target: "String",
|
2351
|
+
# custom_iam_instance_profile: "String",
|
2338
2352
|
# allocated_storage: 1,
|
2339
2353
|
# source_db_cluster_identifier: "String",
|
2340
2354
|
# dedicated_log_volume: false,
|
@@ -2399,6 +2413,11 @@ module Aws::RDS
|
|
2399
2413
|
# @option options [Integer] :iops
|
2400
2414
|
# The amount of Provisioned IOPS (input/output operations per second) to
|
2401
2415
|
# initially allocate for the DB instance.
|
2416
|
+
# @option options [Integer] :storage_throughput
|
2417
|
+
# Specifies the storage throughput value for the read replica.
|
2418
|
+
#
|
2419
|
+
# This setting doesn't apply to RDS Custom or Amazon Aurora DB
|
2420
|
+
# instances.
|
2402
2421
|
# @option options [String] :option_group_name
|
2403
2422
|
# The option group to associate the DB instance with. If not specified,
|
2404
2423
|
# RDS uses the option group associated with the source DB instance or
|
@@ -2841,38 +2860,26 @@ module Aws::RDS
|
|
2841
2860
|
#
|
2842
2861
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/db2-replication.html
|
2843
2862
|
# [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.
|
2863
|
+
# @option options [Boolean] :enable_customer_owned_ip
|
2864
|
+
# Specifies whether to enable a customer-owned IP address (CoIP) for an
|
2865
|
+
# RDS on Outposts read replica.
|
2864
2866
|
#
|
2865
|
-
# *
|
2866
|
-
#
|
2867
|
+
# A *CoIP* provides local or external connectivity to resources in your
|
2868
|
+
# Outpost subnets through your on-premises network. For some use cases,
|
2869
|
+
# a CoIP can provide lower latency for connections to the read replica
|
2870
|
+
# from outside of its virtual private cloud (VPC) on your local network.
|
2867
2871
|
#
|
2868
|
-
# For
|
2869
|
-
#
|
2872
|
+
# For more information about RDS on Outposts, see [Working with Amazon
|
2873
|
+
# RDS on Amazon Web Services Outposts][1] in the *Amazon RDS User
|
2874
|
+
# Guide*.
|
2870
2875
|
#
|
2871
|
-
#
|
2876
|
+
# For more information about CoIPs, see [Customer-owned IP addresses][2]
|
2877
|
+
# in the *Amazon Web Services Outposts User Guide*.
|
2872
2878
|
#
|
2873
2879
|
#
|
2874
2880
|
#
|
2875
|
-
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/
|
2881
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html
|
2882
|
+
# [2]: https://docs.aws.amazon.com/outposts/latest/userguide/routing.html#ip-addressing
|
2876
2883
|
# @option options [String] :network_type
|
2877
2884
|
# The network type of the DB instance.
|
2878
2885
|
#
|
@@ -2892,31 +2899,17 @@ module Aws::RDS
|
|
2892
2899
|
#
|
2893
2900
|
#
|
2894
2901
|
# [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*.
|
2902
|
+
# @option options [Integer] :max_allocated_storage
|
2903
|
+
# The upper limit in gibibytes (GiB) to which Amazon RDS can
|
2904
|
+
# automatically scale the storage of the DB instance.
|
2912
2905
|
#
|
2913
|
-
# For more information about
|
2914
|
-
#
|
2906
|
+
# For more information about this setting, including limitations that
|
2907
|
+
# apply to it, see [ Managing capacity automatically with Amazon RDS
|
2908
|
+
# storage autoscaling][1] in the *Amazon RDS User Guide*.
|
2915
2909
|
#
|
2916
2910
|
#
|
2917
2911
|
#
|
2918
|
-
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/
|
2919
|
-
# [2]: https://docs.aws.amazon.com/outposts/latest/userguide/routing.html#ip-addressing
|
2912
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIOPS.StorageTypes.html#USER_PIOPS.Autoscaling
|
2920
2913
|
# @option options [String] :backup_target
|
2921
2914
|
# The location where RDS stores automated backups and manual snapshots.
|
2922
2915
|
#
|
@@ -2925,6 +2918,27 @@ module Aws::RDS
|
|
2925
2918
|
# * `local` for Dedicated Local Zones
|
2926
2919
|
#
|
2927
2920
|
# * `region` for Amazon Web Services Region
|
2921
|
+
# @option options [String] :custom_iam_instance_profile
|
2922
|
+
# The instance profile associated with the underlying Amazon EC2
|
2923
|
+
# instance of an RDS Custom DB instance. The instance profile must meet
|
2924
|
+
# the following requirements:
|
2925
|
+
#
|
2926
|
+
# * The profile must exist in your account.
|
2927
|
+
#
|
2928
|
+
# * The profile must have an IAM role that Amazon EC2 has permissions to
|
2929
|
+
# assume.
|
2930
|
+
#
|
2931
|
+
# * The instance profile name and the associated IAM role name must
|
2932
|
+
# start with the prefix `AWSRDSCustom`.
|
2933
|
+
#
|
2934
|
+
# For the list of permissions required for the IAM role, see [ Configure
|
2935
|
+
# IAM and your VPC][1] in the *Amazon RDS User Guide*.
|
2936
|
+
#
|
2937
|
+
# This setting is required for RDS Custom DB instances.
|
2938
|
+
#
|
2939
|
+
#
|
2940
|
+
#
|
2941
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-setup-orcl.html#custom-setup-orcl.iam-vpc
|
2928
2942
|
# @option options [Integer] :allocated_storage
|
2929
2943
|
# The amount of storage (in gibibytes) to allocate initially for the
|
2930
2944
|
# read replica. Follow the allocation rules specified in
|
@@ -3117,7 +3131,7 @@ module Aws::RDS
|
|
3117
3131
|
# db_security_groups: ["String"],
|
3118
3132
|
# vpc_security_group_ids: ["String"],
|
3119
3133
|
# apply_immediately: false,
|
3120
|
-
# master_user_password: "
|
3134
|
+
# master_user_password: "SensitiveString",
|
3121
3135
|
# db_parameter_group_name: "String",
|
3122
3136
|
# backup_retention_period: 1,
|
3123
3137
|
# preferred_backup_window: "String",
|
@@ -3128,24 +3142,25 @@ module Aws::RDS
|
|
3128
3142
|
# auto_minor_version_upgrade: false,
|
3129
3143
|
# license_model: "String",
|
3130
3144
|
# iops: 1,
|
3145
|
+
# storage_throughput: 1,
|
3131
3146
|
# option_group_name: "String",
|
3132
3147
|
# new_db_instance_identifier: "String",
|
3133
3148
|
# storage_type: "String",
|
3134
3149
|
# tde_credential_arn: "String",
|
3135
|
-
# tde_credential_password: "
|
3150
|
+
# tde_credential_password: "SensitiveString",
|
3136
3151
|
# ca_certificate_identifier: "String",
|
3137
3152
|
# domain: "String",
|
3138
3153
|
# domain_fqdn: "String",
|
3139
3154
|
# domain_ou: "String",
|
3140
3155
|
# domain_auth_secret_arn: "String",
|
3141
3156
|
# domain_dns_ips: ["String"],
|
3157
|
+
# disable_domain: false,
|
3142
3158
|
# copy_tags_to_snapshot: false,
|
3143
3159
|
# monitoring_interval: 1,
|
3144
3160
|
# db_port_number: 1,
|
3145
3161
|
# publicly_accessible: false,
|
3146
3162
|
# monitoring_role_arn: "String",
|
3147
3163
|
# domain_iam_role_name: "String",
|
3148
|
-
# disable_domain: false,
|
3149
3164
|
# promotion_tier: 1,
|
3150
3165
|
# enable_iam_database_authentication: false,
|
3151
3166
|
# database_insights_mode: "standard", # accepts standard, advanced
|
@@ -3167,18 +3182,18 @@ module Aws::RDS
|
|
3167
3182
|
# max_allocated_storage: 1,
|
3168
3183
|
# certificate_rotation_restart: false,
|
3169
3184
|
# replica_mode: "open-read-only", # accepts open-read-only, mounted
|
3170
|
-
# enable_customer_owned_ip: false,
|
3171
|
-
# aws_backup_recovery_point_arn: "AwsBackupRecoveryPointArn",
|
3172
3185
|
# automation_mode: "full", # accepts full, all-paused
|
3173
3186
|
# resume_full_automation_mode_minutes: 1,
|
3187
|
+
# enable_customer_owned_ip: false,
|
3174
3188
|
# network_type: "String",
|
3175
|
-
#
|
3189
|
+
# aws_backup_recovery_point_arn: "AwsBackupRecoveryPointArn",
|
3176
3190
|
# manage_master_user_password: false,
|
3177
3191
|
# rotate_master_user_password: false,
|
3178
3192
|
# master_user_secret_kms_key_id: "String",
|
3179
|
-
# engine: "String",
|
3180
|
-
# dedicated_log_volume: false,
|
3181
3193
|
# multi_tenant: false,
|
3194
|
+
# dedicated_log_volume: false,
|
3195
|
+
# engine: "String",
|
3196
|
+
# master_user_authentication_type: "password", # accepts password, iam-db-auth
|
3182
3197
|
# })
|
3183
3198
|
# @param [Hash] options ({})
|
3184
3199
|
# @option options [Integer] :allocated_storage
|
@@ -3602,6 +3617,13 @@ module Aws::RDS
|
|
3602
3617
|
# `AllocatedStorage`.
|
3603
3618
|
#
|
3604
3619
|
# Default: Uses existing setting
|
3620
|
+
# @option options [Integer] :storage_throughput
|
3621
|
+
# The storage throughput value for the DB instance.
|
3622
|
+
#
|
3623
|
+
# This setting applies only to the `gp3` storage type.
|
3624
|
+
#
|
3625
|
+
# This setting doesn't apply to Amazon Aurora or RDS Custom DB
|
3626
|
+
# instances.
|
3605
3627
|
# @option options [String] :option_group_name
|
3606
3628
|
# The option group to associate the DB instance with.
|
3607
3629
|
#
|
@@ -3743,6 +3765,9 @@ module Aws::RDS
|
|
3743
3765
|
# ^
|
3744
3766
|
#
|
3745
3767
|
# Example: `123.124.125.126,234.235.236.237`
|
3768
|
+
# @option options [Boolean] :disable_domain
|
3769
|
+
# Specifies whether to remove the DB instance from the Active Directory
|
3770
|
+
# domain.
|
3746
3771
|
# @option options [Boolean] :copy_tags_to_snapshot
|
3747
3772
|
# Specifies whether to copy all tags from the DB instance to snapshots
|
3748
3773
|
# of the DB instance. By default, tags aren't copied.
|
@@ -3841,9 +3866,6 @@ module Aws::RDS
|
|
3841
3866
|
# Service.
|
3842
3867
|
#
|
3843
3868
|
# 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
3869
|
# @option options [Integer] :promotion_tier
|
3848
3870
|
# The order of priority in which an Aurora Replica is promoted to the
|
3849
3871
|
# primary instance after a failure of the existing primary instance. For
|
@@ -4070,6 +4092,22 @@ module Aws::RDS
|
|
4070
4092
|
#
|
4071
4093
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/db2-replication.html
|
4072
4094
|
# [2]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-read-replicas.html
|
4095
|
+
# @option options [String] :automation_mode
|
4096
|
+
# The automation mode of the RDS Custom DB instance. If `full`, the DB
|
4097
|
+
# instance automates monitoring and instance recovery. If `all paused`,
|
4098
|
+
# the instance pauses automation for the duration set by
|
4099
|
+
# `ResumeFullAutomationModeMinutes`.
|
4100
|
+
# @option options [Integer] :resume_full_automation_mode_minutes
|
4101
|
+
# The number of minutes to pause the automation. When the time period
|
4102
|
+
# ends, RDS Custom resumes full automation.
|
4103
|
+
#
|
4104
|
+
# Default: `60`
|
4105
|
+
#
|
4106
|
+
# Constraints:
|
4107
|
+
#
|
4108
|
+
# * Must be at least 60.
|
4109
|
+
#
|
4110
|
+
# * Must be no more than 1,440.
|
4073
4111
|
# @option options [Boolean] :enable_customer_owned_ip
|
4074
4112
|
# Specifies whether to enable a customer-owned IP address (CoIP) for an
|
4075
4113
|
# RDS on Outposts DB instance.
|
@@ -4090,27 +4128,6 @@ module Aws::RDS
|
|
4090
4128
|
#
|
4091
4129
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html
|
4092
4130
|
# [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
4131
|
# @option options [String] :network_type
|
4115
4132
|
# The network type of the DB instance.
|
4116
4133
|
#
|
@@ -4126,13 +4143,11 @@ module Aws::RDS
|
|
4126
4143
|
#
|
4127
4144
|
#
|
4128
4145
|
# [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.
|
4146
|
+
# @option options [String] :aws_backup_recovery_point_arn
|
4147
|
+
# The Amazon Resource Name (ARN) of the recovery point in Amazon Web
|
4148
|
+
# Services Backup.
|
4133
4149
|
#
|
4134
|
-
# This setting doesn't apply to
|
4135
|
-
# instances.
|
4150
|
+
# This setting doesn't apply to RDS Custom DB instances.
|
4136
4151
|
# @option options [Boolean] :manage_master_user_password
|
4137
4152
|
# Specifies whether to manage the master user password with Amazon Web
|
4138
4153
|
# Services Secrets Manager.
|
@@ -4219,6 +4234,25 @@ module Aws::RDS
|
|
4219
4234
|
# There is a default KMS key for your Amazon Web Services account. Your
|
4220
4235
|
# Amazon Web Services account has a different default KMS key for each
|
4221
4236
|
# Amazon Web Services Region.
|
4237
|
+
# @option options [Boolean] :multi_tenant
|
4238
|
+
# Specifies whether the to convert your DB instance from the
|
4239
|
+
# single-tenant configuration to the multi-tenant configuration. This
|
4240
|
+
# parameter is supported only for RDS for Oracle CDB instances.
|
4241
|
+
#
|
4242
|
+
# During the conversion, RDS creates an initial tenant database and
|
4243
|
+
# associates the DB name, master user name, character set, and national
|
4244
|
+
# character set metadata with this database. The tags associated with
|
4245
|
+
# the instance also propagate to the initial tenant database. You can
|
4246
|
+
# add more tenant databases to your DB instance by using the
|
4247
|
+
# `CreateTenantDatabase` operation.
|
4248
|
+
#
|
4249
|
+
# The conversion to the multi-tenant configuration is permanent and
|
4250
|
+
# irreversible, so you can't later convert back to the single-tenant
|
4251
|
+
# configuration. When you specify this parameter, you must also specify
|
4252
|
+
# `ApplyImmediately`.
|
4253
|
+
# @option options [Boolean] :dedicated_log_volume
|
4254
|
+
# Indicates whether the DB instance has a dedicated log volume (DLV)
|
4255
|
+
# enabled.
|
4222
4256
|
# @option options [String] :engine
|
4223
4257
|
# The target Oracle DB engine when you convert a non-CDB to a CDB. This
|
4224
4258
|
# intermediate step is necessary to upgrade an Oracle Database 19c
|
@@ -4246,25 +4280,19 @@ module Aws::RDS
|
|
4246
4280
|
# parameter group. To avoid reverting to the default, specify a new
|
4247
4281
|
# parameter group with `--db-parameter-group-name` and a new option
|
4248
4282
|
# 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.
|
4283
|
+
# @option options [String] :master_user_authentication_type
|
4284
|
+
# Specifies the authentication type for the master user. With IAM master
|
4285
|
+
# user authentication, you can change the master DB user to use IAM
|
4286
|
+
# database authentication.
|
4256
4287
|
#
|
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.
|
4288
|
+
# You can specify one of the following values:
|
4263
4289
|
#
|
4264
|
-
#
|
4265
|
-
#
|
4266
|
-
#
|
4267
|
-
#
|
4290
|
+
# * `password` - Use standard database authentication with a password.
|
4291
|
+
#
|
4292
|
+
# * `iam-db-auth` - Use IAM database authentication for the master user.
|
4293
|
+
#
|
4294
|
+
# This option is only valid for RDS for PostgreSQL and Aurora PostgreSQL
|
4295
|
+
# engines.
|
4268
4296
|
# @return [DBInstance]
|
4269
4297
|
def modify(options = {})
|
4270
4298
|
options = options.merge(db_instance_identifier: @id)
|
@@ -4374,6 +4402,7 @@ module Aws::RDS
|
|
4374
4402
|
# db_name: "String",
|
4375
4403
|
# engine: "String",
|
4376
4404
|
# iops: 1,
|
4405
|
+
# storage_throughput: 1,
|
4377
4406
|
# option_group_name: "String",
|
4378
4407
|
# copy_tags_to_snapshot: false,
|
4379
4408
|
# tags: [
|
@@ -4384,7 +4413,7 @@ module Aws::RDS
|
|
4384
4413
|
# ],
|
4385
4414
|
# storage_type: "String",
|
4386
4415
|
# tde_credential_arn: "String",
|
4387
|
-
# tde_credential_password: "
|
4416
|
+
# tde_credential_password: "SensitiveString",
|
4388
4417
|
# vpc_security_group_ids: ["String"],
|
4389
4418
|
# domain: "String",
|
4390
4419
|
# domain_iam_role_name: "String",
|
@@ -4405,12 +4434,11 @@ module Aws::RDS
|
|
4405
4434
|
# deletion_protection: false,
|
4406
4435
|
# source_dbi_resource_id: "String",
|
4407
4436
|
# max_allocated_storage: 1,
|
4408
|
-
# source_db_instance_automated_backups_arn: "String",
|
4409
4437
|
# enable_customer_owned_ip: false,
|
4410
|
-
# custom_iam_instance_profile: "String",
|
4411
|
-
# backup_target: "String",
|
4412
4438
|
# network_type: "String",
|
4413
|
-
#
|
4439
|
+
# source_db_instance_automated_backups_arn: "String",
|
4440
|
+
# backup_target: "String",
|
4441
|
+
# custom_iam_instance_profile: "String",
|
4414
4442
|
# allocated_storage: 1,
|
4415
4443
|
# dedicated_log_volume: false,
|
4416
4444
|
# ca_certificate_identifier: "String",
|
@@ -4633,6 +4661,10 @@ module Aws::RDS
|
|
4633
4661
|
# * Must be an integer greater than 1000.
|
4634
4662
|
#
|
4635
4663
|
# ^
|
4664
|
+
# @option options [Integer] :storage_throughput
|
4665
|
+
# The storage throughput value for the DB instance.
|
4666
|
+
#
|
4667
|
+
# This setting doesn't apply to RDS Custom or Amazon Aurora.
|
4636
4668
|
# @option options [String] :option_group_name
|
4637
4669
|
# The name of the option group to use for the restored DB instance.
|
4638
4670
|
#
|
@@ -4826,12 +4858,6 @@ module Aws::RDS
|
|
4826
4858
|
#
|
4827
4859
|
#
|
4828
4860
|
# [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
4861
|
# @option options [Boolean] :enable_customer_owned_ip
|
4836
4862
|
# Specifies whether to enable a customer-owned IP address (CoIP) for an
|
4837
4863
|
# RDS on Outposts DB instance.
|
@@ -4854,27 +4880,31 @@ module Aws::RDS
|
|
4854
4880
|
#
|
4855
4881
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html
|
4856
4882
|
# [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:
|
4883
|
+
# @option options [String] :network_type
|
4884
|
+
# The network type of the DB instance.
|
4861
4885
|
#
|
4862
|
-
#
|
4886
|
+
# The network type is determined by the `DBSubnetGroup` specified for
|
4887
|
+
# the DB instance. A `DBSubnetGroup` can support only the IPv4 protocol
|
4888
|
+
# or the IPv4 and the IPv6 protocols (`DUAL`).
|
4863
4889
|
#
|
4864
|
-
#
|
4865
|
-
#
|
4890
|
+
# For more information, see [ Working with a DB instance in a VPC][1] in
|
4891
|
+
# the *Amazon RDS User Guide.*
|
4866
4892
|
#
|
4867
|
-
#
|
4868
|
-
# start with the prefix `AWSRDSCustom`.
|
4893
|
+
# Valid Values:
|
4869
4894
|
#
|
4870
|
-
#
|
4871
|
-
# IAM and your VPC][1] in the *Amazon RDS User Guide*.
|
4895
|
+
# * `IPV4`
|
4872
4896
|
#
|
4873
|
-
#
|
4897
|
+
# * `DUAL`
|
4874
4898
|
#
|
4875
4899
|
#
|
4876
4900
|
#
|
4877
|
-
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/
|
4901
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html
|
4902
|
+
# @option options [String] :source_db_instance_automated_backups_arn
|
4903
|
+
# The Amazon Resource Name (ARN) of the replicated automated backups
|
4904
|
+
# from which to restore, for example,
|
4905
|
+
# `arn:aws:rds:us-east-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE`.
|
4906
|
+
#
|
4907
|
+
# This setting doesn't apply to RDS Custom.
|
4878
4908
|
# @option options [String] :backup_target
|
4879
4909
|
# The location for storing automated backups and manual snapshots for
|
4880
4910
|
# the restored DB instance.
|
@@ -4895,29 +4925,27 @@ module Aws::RDS
|
|
4895
4925
|
#
|
4896
4926
|
#
|
4897
4927
|
# [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`).
|
4928
|
+
# @option options [String] :custom_iam_instance_profile
|
4929
|
+
# The instance profile associated with the underlying Amazon EC2
|
4930
|
+
# instance of an RDS Custom DB instance. The instance profile must meet
|
4931
|
+
# the following requirements:
|
4904
4932
|
#
|
4905
|
-
#
|
4906
|
-
# the *Amazon RDS User Guide.*
|
4933
|
+
# * The profile must exist in your account.
|
4907
4934
|
#
|
4908
|
-
#
|
4935
|
+
# * The profile must have an IAM role that Amazon EC2 has permissions to
|
4936
|
+
# assume.
|
4909
4937
|
#
|
4910
|
-
# *
|
4938
|
+
# * The instance profile name and the associated IAM role name must
|
4939
|
+
# start with the prefix `AWSRDSCustom`.
|
4911
4940
|
#
|
4912
|
-
#
|
4941
|
+
# For the list of permissions required for the IAM role, see [ Configure
|
4942
|
+
# IAM and your VPC][1] in the *Amazon RDS User Guide*.
|
4913
4943
|
#
|
4944
|
+
# This setting is required for RDS Custom.
|
4914
4945
|
#
|
4915
4946
|
#
|
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
4947
|
#
|
4920
|
-
#
|
4948
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-setup-orcl.html#custom-setup-orcl.iam-vpc
|
4921
4949
|
# @option options [Integer] :allocated_storage
|
4922
4950
|
# The amount of storage (in gibibytes) to allocate initially for the DB
|
4923
4951
|
# instance. Follow the allocation rules specified in `CreateDBInstance`.
|