aws-sdk-rds 1.277.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.
@@ -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.
@@ -227,17 +235,20 @@ module Aws::RDS
227
235
  data[:read_replica_db_cluster_identifiers]
228
236
  end
229
237
 
230
- # The open mode of an Oracle read replica. The default is
231
- # `open-read-only`. For more information, see [Working with Oracle Read
232
- # Replicas for Amazon RDS][1] in the *Amazon RDS User Guide*.
238
+ # The open mode of a Db2 or an Oracle read replica. The default is
239
+ # `open-read-only`. For more information, see [Working with replicas for
240
+ # Amazon RDS for Db2][1] and [Working with read replicas for Amazon RDS
241
+ # for Oracle][2] in the *Amazon RDS User Guide*.
233
242
  #
234
- # <note markdown="1"> This attribute is only supported in RDS for Oracle.
243
+ # <note markdown="1"> This attribute is only supported in RDS for Db2, RDS for Oracle, and
244
+ # RDS Custom for Oracle.
235
245
  #
236
246
  # </note>
237
247
  #
238
248
  #
239
249
  #
240
- # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-read-replicas.html
250
+ # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/db2-replication.html
251
+ # [2]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-read-replicas.html
241
252
  # @return [String]
242
253
  def replica_mode
243
254
  data[:replica_mode]
@@ -257,6 +268,14 @@ module Aws::RDS
257
268
  data[:iops]
258
269
  end
259
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
+
260
279
  # The list of option group memberships for this DB instance.
261
280
  # @return [Array<Types::OptionGroupMembership>]
262
281
  def option_group_memberships
@@ -577,11 +596,21 @@ module Aws::RDS
577
596
  data[:tag_list]
578
597
  end
579
598
 
580
- # The list of replicated automated backups associated with the DB
581
- # instance.
582
- # @return [Array<Types::DBInstanceAutomatedBackupsReplication>]
583
- def db_instance_automated_backups_replications
584
- data[:db_instance_automated_backups_replications]
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]
585
614
  end
586
615
 
587
616
  # Indicates whether a customer-owned IP address (CoIP) is enabled for an
@@ -609,11 +638,25 @@ module Aws::RDS
609
638
  data[:customer_owned_ip_enabled]
610
639
  end
611
640
 
612
- # The Amazon Resource Name (ARN) of the recovery point in Amazon Web
613
- # Services Backup.
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
614
657
  # @return [String]
615
- def aws_backup_recovery_point_arn
616
- data[:aws_backup_recovery_point_arn]
658
+ def network_type
659
+ data[:network_type]
617
660
  end
618
661
 
619
662
  # The status of the database activity stream.
@@ -653,21 +696,32 @@ module Aws::RDS
653
696
  data[:activity_stream_engine_native_audit_fields_included]
654
697
  end
655
698
 
656
- # The automation mode of the RDS Custom DB instance: `full` or `all
657
- # paused`. If `full`, the DB instance automates monitoring and instance
658
- # recovery. If `all paused`, the instance pauses automation for the
659
- # duration set by `--resume-full-automation-mode-minutes`.
699
+ # The Amazon Resource Name (ARN) of the recovery point in Amazon Web
700
+ # Services Backup.
660
701
  # @return [String]
661
- def automation_mode
662
- data[:automation_mode]
702
+ def aws_backup_recovery_point_arn
703
+ data[:aws_backup_recovery_point_arn]
663
704
  end
664
705
 
665
- # The number of minutes to pause the automation. When the time period
666
- # ends, RDS Custom resumes full automation. The minimum value is 60
667
- # (default). The maximum value is 1,440.
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.
668
722
  # @return [Time]
669
- def resume_full_automation_mode_time
670
- data[:resume_full_automation_mode_time]
723
+ def automatic_restart_time
724
+ data[:automatic_restart_time]
671
725
  end
672
726
 
673
727
  # The instance profile associated with the underlying Amazon EC2
@@ -693,46 +747,16 @@ module Aws::RDS
693
747
  data[:custom_iam_instance_profile]
694
748
  end
695
749
 
696
- # The location where automated backups and manual snapshots are stored:
697
- # Amazon Web Services Outposts or the Amazon Web Services Region.
698
- # @return [String]
699
- def backup_target
700
- data[:backup_target]
701
- end
702
-
703
- # The network type of the DB instance.
704
- #
705
- # The network type is determined by the `DBSubnetGroup` specified for
706
- # the DB instance. A `DBSubnetGroup` can support only the IPv4 protocol
707
- # or the IPv4 and the IPv6 protocols (`DUAL`).
708
- #
709
- # For more information, see [ Working with a DB instance in a VPC][1] in
710
- # the *Amazon RDS User Guide* and [ Working with a DB instance in a
711
- # VPC][2] in the *Amazon Aurora User Guide.*
712
- #
713
- # Valid Values: `IPV4 | DUAL`
714
- #
715
- #
716
- #
717
- # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html
718
- # [2]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html
719
- # @return [String]
720
- def network_type
721
- data[:network_type]
722
- end
723
-
724
750
  # The status of the policy state of the activity stream.
725
751
  # @return [String]
726
752
  def activity_stream_policy_status
727
753
  data[:activity_stream_policy_status]
728
754
  end
729
755
 
730
- # The storage throughput for the DB instance.
731
- #
732
- # This setting applies only to the `gp3` storage type.
733
- # @return [Integer]
734
- def storage_throughput
735
- 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]
736
760
  end
737
761
 
738
762
  # The Oracle system ID (Oracle SID) for a container database (CDB). The
@@ -757,12 +781,6 @@ module Aws::RDS
757
781
  data[:master_user_secret]
758
782
  end
759
783
 
760
- # The details of the DB instance's server certificate.
761
- # @return [Types::CertificateDetails]
762
- def certificate_details
763
- data[:certificate_details]
764
- end
765
-
766
784
  # The identifier of the source DB cluster if this DB instance is a read
767
785
  # replica.
768
786
  # @return [String]
@@ -776,6 +794,13 @@ module Aws::RDS
776
794
  data[:percent_progress]
777
795
  end
778
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
+
779
804
  # Indicates whether the DB instance has a dedicated log volume (DLV)
780
805
  # enabled.
781
806
  # @return [Boolean]
@@ -797,13 +822,6 @@ module Aws::RDS
797
822
  data[:is_storage_config_upgrade_available]
798
823
  end
799
824
 
800
- # Specifies whether the DB instance is in the multi-tenant configuration
801
- # (TRUE) or the single-tenant configuration (FALSE).
802
- # @return [Boolean]
803
- def multi_tenant
804
- data[:multi_tenant]
805
- end
806
-
807
825
  # The lifecycle type for the DB instance.
808
826
  #
809
827
  # For more information, see CreateDBInstance.
@@ -958,7 +976,7 @@ module Aws::RDS
958
976
  # db_instance_class: "String", # required
959
977
  # engine: "String", # required
960
978
  # master_username: "String",
961
- # master_user_password: "String",
979
+ # master_user_password: "SensitiveString",
962
980
  # db_security_groups: ["String"],
963
981
  # vpc_security_group_ids: ["String"],
964
982
  # availability_zone: "String",
@@ -973,6 +991,7 @@ module Aws::RDS
973
991
  # auto_minor_version_upgrade: false,
974
992
  # license_model: "String",
975
993
  # iops: 1,
994
+ # storage_throughput: 1,
976
995
  # option_group_name: "String",
977
996
  # character_set_name: "String",
978
997
  # nchar_character_set_name: "String",
@@ -986,7 +1005,7 @@ module Aws::RDS
986
1005
  # db_cluster_identifier: "String",
987
1006
  # storage_type: "String",
988
1007
  # tde_credential_arn: "String",
989
- # tde_credential_password: "String",
1008
+ # tde_credential_password: "SensitiveString",
990
1009
  # storage_encrypted: false,
991
1010
  # kms_key_id: "String",
992
1011
  # domain: "String",
@@ -1015,17 +1034,17 @@ module Aws::RDS
1015
1034
  # deletion_protection: false,
1016
1035
  # max_allocated_storage: 1,
1017
1036
  # enable_customer_owned_ip: false,
1018
- # custom_iam_instance_profile: "String",
1019
- # backup_target: "String",
1020
1037
  # network_type: "String",
1021
- # storage_throughput: 1,
1038
+ # backup_target: "String",
1039
+ # custom_iam_instance_profile: "String",
1040
+ # db_system_id: "String",
1041
+ # ca_certificate_identifier: "String",
1022
1042
  # manage_master_user_password: false,
1023
1043
  # master_user_secret_kms_key_id: "String",
1024
- # ca_certificate_identifier: "String",
1025
- # db_system_id: "String",
1026
- # dedicated_log_volume: false,
1027
1044
  # multi_tenant: false,
1045
+ # dedicated_log_volume: false,
1028
1046
  # engine_lifecycle_support: "String",
1047
+ # master_user_authentication_type: "password", # accepts password, iam-db-auth
1029
1048
  # })
1030
1049
  # @param [Hash] options ({})
1031
1050
  # @option options [String] :db_name
@@ -1547,12 +1566,8 @@ module Aws::RDS
1547
1566
  # set the `AvailabilityZone` parameter if the DB instance is a Multi-AZ
1548
1567
  # deployment.
1549
1568
  #
1550
- # This setting doesn't apply to the following DB instances:
1551
- #
1552
- # * Amazon Aurora (DB instance Availability Zones (AZs) are managed by
1553
- # the DB cluster.)
1554
- #
1555
- # * RDS Custom
1569
+ # This setting doesn't apply to Amazon Aurora because the DB instance
1570
+ # Availability Zones (AZs) are managed by the DB cluster.
1556
1571
  # @option options [String] :engine_version
1557
1572
  # The version number of the database engine to use.
1558
1573
  #
@@ -1639,7 +1654,7 @@ module Aws::RDS
1639
1654
  # The license model information for this DB instance.
1640
1655
  #
1641
1656
  # <note markdown="1"> License models for RDS for Db2 require additional configuration. The
1642
- # Bring Your Own License (BYOL) model requires a custom parameter group
1657
+ # bring your own license (BYOL) model requires a custom parameter group
1643
1658
  # and an Amazon Web Services License Manager self-managed license. The
1644
1659
  # Db2 license through Amazon Web Services Marketplace model requires an
1645
1660
  # Amazon Web Services Marketplace subscription. For more information,
@@ -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 Domain
1724
- # Name System (DNS) endpoint resolves to the public IP address. When you
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
- # ultimately controlled by the security group it uses. That public
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
- # Default: The default behavior varies depending on whether
1735
- # `DBSubnetGroupName` is specified.
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
- # * If the default VPC in the target Region has an internet gateway
1744
- # attached to it, the DB instance is public.
1758
+ # If `DBSubnetGroup` isn't specified, `PubliclyAccessible` defaults to
1759
+ # `false` for Aurora instances and `true` for non-Aurora instances.
1745
1760
  #
1746
- # If `DBSubnetGroupName` is specified, and `PubliclyAccessible` isn't
1747
- # specified, the following applies:
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
- # * If the subnets are part of a VPC that doesn’t have an internet
1750
- # gateway attached to it, the DB instance is private.
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,33 +2108,28 @@ 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] :custom_iam_instance_profile
2098
- # The instance profile associated with the underlying Amazon EC2
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
- # * The profile must have an IAM role that Amazon EC2 has permissions to
2108
- # assume.
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
- # * The instance profile name and the associated IAM role name must
2111
- # start with the prefix `AWSRDSCustom`.
2118
+ # For more information, see [ Working with a DB instance in a VPC][1] in
2119
+ # the *Amazon RDS User Guide.*
2112
2120
  #
2113
- # For the list of permissions required for the IAM role, see [ Configure
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/custom-setup-orcl.html#custom-setup-orcl.iam-vpc
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
  #
2122
2129
  # Valid Values:
2123
2130
  #
2131
+ # * `local` (Dedicated Local Zone)
2132
+ #
2124
2133
  # * `outposts` (Amazon Web Services Outposts)
2125
2134
  #
2126
2135
  # * `region` (Amazon Web Services Region)
@@ -2133,42 +2142,63 @@ module Aws::RDS
2133
2142
  #
2134
2143
  #
2135
2144
  # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html
2136
- # @option options [String] :network_type
2137
- # The network type of the DB instance.
2138
- #
2139
- # The network type is determined by the `DBSubnetGroup` specified for
2140
- # the DB instance. A `DBSubnetGroup` can support only the IPv4 protocol
2141
- # or the IPv4 and the IPv6 protocols (`DUAL`).
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.
2142
2148
  #
2143
- # For more information, see [ Working with a DB instance in a VPC][1] in
2144
- # the *Amazon RDS User Guide.*
2149
+ # This setting is required for RDS Custom.
2145
2150
  #
2146
- # Valid Values: `IPV4 | DUAL`
2151
+ # Constraints:
2147
2152
  #
2153
+ # * The profile must exist in your account.
2148
2154
  #
2155
+ # * The profile must have an IAM role that Amazon EC2 has permissions to
2156
+ # assume.
2149
2157
  #
2150
- # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html
2151
- # @option options [Integer] :storage_throughput
2152
- # The storage throughput value, in mebibyte per second (MiBps), for the
2153
- # DB instance.
2158
+ # * The instance profile name and the associated IAM role name must
2159
+ # start with the prefix `AWSRDSCustom`.
2154
2160
  #
2155
- # This setting applies only to the `gp3` storage type.
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*.
2156
2163
  #
2157
- # This setting doesn't apply to Amazon Aurora or RDS Custom DB
2158
- # instances.
2159
- # @option options [Boolean] :manage_master_user_password
2160
- # Specifies whether to manage the master user password with Amazon Web
2161
- # Services Secrets Manager.
2162
2164
  #
2163
- # For more information, see [Password management with Amazon Web
2164
- # Services Secrets Manager][1] in the *Amazon RDS User Guide.*
2165
2165
  #
2166
- # Constraints:
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.
2167
2177
  #
2168
- # * Can't manage the master user password with Amazon Web Services
2169
- # Secrets Manager if `MasterUserPassword` is specified.
2178
+ # This setting doesn't apply to RDS Custom DB instances.
2170
2179
  #
2171
- # ^
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
+ # ^
2172
2202
  #
2173
2203
  #
2174
2204
  #
@@ -2195,31 +2225,6 @@ module Aws::RDS
2195
2225
  # There is a default KMS key for your Amazon Web Services account. Your
2196
2226
  # Amazon Web Services account has a different default KMS key for each
2197
2227
  # Amazon Web Services Region.
2198
- # @option options [String] :ca_certificate_identifier
2199
- # The CA certificate identifier to use for the DB instance's server
2200
- # certificate.
2201
- #
2202
- # This setting doesn't apply to RDS Custom DB instances.
2203
- #
2204
- # For more information, see [Using SSL/TLS to encrypt a connection to a
2205
- # DB instance][1] in the *Amazon RDS User Guide* and [ Using SSL/TLS to
2206
- # encrypt a connection to a DB cluster][2] in the *Amazon Aurora User
2207
- # Guide*.
2208
- #
2209
- #
2210
- #
2211
- # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL.html
2212
- # [2]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL.html
2213
- # @option options [String] :db_system_id
2214
- # The Oracle system identifier (SID), which is the name of the Oracle
2215
- # database instance that manages your database files. In this context,
2216
- # the term "Oracle database instance" refers exclusively to the system
2217
- # global area (SGA) and Oracle background processes. If you don't
2218
- # specify a SID, the value defaults to `RDSCDB`. The Oracle SID is also
2219
- # the name of your CDB.
2220
- # @option options [Boolean] :dedicated_log_volume
2221
- # Indicates whether the DB instance has a dedicated log volume (DLV)
2222
- # enabled.
2223
2228
  # @option options [Boolean] :multi_tenant
2224
2229
  # Specifies whether to use the multi-tenant configuration or the
2225
2230
  # single-tenant configuration (default). This parameter only applies to
@@ -2235,6 +2240,9 @@ module Aws::RDS
2235
2240
  # * If you specify the multi-tenant configuration when you create your
2236
2241
  # DB instance, you can't later modify this DB instance to use the
2237
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.
2238
2246
  # @option options [String] :engine_lifecycle_support
2239
2247
  # The life cycle type for this DB instance.
2240
2248
  #
@@ -2266,6 +2274,19 @@ module Aws::RDS
2266
2274
  #
2267
2275
  #
2268
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.
2269
2290
  # @return [DBInstance]
2270
2291
  def create(options = {})
2271
2292
  options = options.merge(db_instance_identifier: @id)
@@ -2289,6 +2310,7 @@ module Aws::RDS
2289
2310
  # multi_az: false,
2290
2311
  # auto_minor_version_upgrade: false,
2291
2312
  # iops: 1,
2313
+ # storage_throughput: 1,
2292
2314
  # option_group_name: "String",
2293
2315
  # db_parameter_group_name: "String",
2294
2316
  # publicly_accessible: false,
@@ -2305,7 +2327,7 @@ module Aws::RDS
2305
2327
  # monitoring_interval: 1,
2306
2328
  # monitoring_role_arn: "String",
2307
2329
  # kms_key_id: "String",
2308
- # pre_signed_url: "String",
2330
+ # pre_signed_url: "SensitiveString",
2309
2331
  # enable_iam_database_authentication: false,
2310
2332
  # database_insights_mode: "standard", # accepts standard, advanced
2311
2333
  # enable_performance_insights: false,
@@ -2327,11 +2349,11 @@ module Aws::RDS
2327
2349
  # domain_auth_secret_arn: "String",
2328
2350
  # domain_dns_ips: ["String"],
2329
2351
  # replica_mode: "open-read-only", # accepts open-read-only, mounted
2352
+ # enable_customer_owned_ip: false,
2353
+ # network_type: "String",
2330
2354
  # max_allocated_storage: 1,
2355
+ # backup_target: "String",
2331
2356
  # custom_iam_instance_profile: "String",
2332
- # network_type: "String",
2333
- # storage_throughput: 1,
2334
- # enable_customer_owned_ip: false,
2335
2357
  # allocated_storage: 1,
2336
2358
  # source_db_cluster_identifier: "String",
2337
2359
  # dedicated_log_volume: false,
@@ -2396,6 +2418,11 @@ module Aws::RDS
2396
2418
  # @option options [Integer] :iops
2397
2419
  # The amount of Provisioned IOPS (input/output operations per second) to
2398
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.
2399
2426
  # @option options [String] :option_group_name
2400
2427
  # The option group to associate the DB instance with. If not specified,
2401
2428
  # RDS uses the option group associated with the source DB instance or
@@ -2411,6 +2438,16 @@ module Aws::RDS
2411
2438
  # The name of the DB parameter group to associate with this read replica
2412
2439
  # DB instance.
2413
2440
  #
2441
+ # For the Db2 DB engine, if your source DB instance uses the bring your
2442
+ # own license (BYOL) model, then a custom parameter group must be
2443
+ # associated with the replica. For a same Amazon Web Services Region
2444
+ # replica, if you don't specify a custom parameter group, Amazon RDS
2445
+ # associates the custom parameter group associated with the source DB
2446
+ # instance. For a cross-Region replica, you must specify a custom
2447
+ # parameter group. This custom parameter group must include your IBM
2448
+ # Site ID and IBM Customer ID. For more information, see [IBM IDs for
2449
+ # bring your own license (BYOL) for Db2][1].
2450
+ #
2414
2451
  # For Single-AZ or Multi-AZ DB instance read replica instances, if you
2415
2452
  # don't specify a value for `DBParameterGroupName`, then Amazon RDS
2416
2453
  # uses the `DBParameterGroup` of the source DB instance for a same
@@ -2423,9 +2460,9 @@ module Aws::RDS
2423
2460
  #
2424
2461
  # Specifying a parameter group for this operation is only supported for
2425
2462
  # MySQL DB instances for cross-Region read replicas, for Multi-AZ DB
2426
- # cluster read replica instances, and for Oracle DB instances. It isn't
2427
- # supported for MySQL DB instances for same Region read replicas or for
2428
- # RDS Custom.
2463
+ # cluster read replica instances, for Db2 DB instances, and for Oracle
2464
+ # DB instances. It isn't supported for MySQL DB instances for same
2465
+ # Region read replicas or for RDS Custom.
2429
2466
  #
2430
2467
  # Constraints:
2431
2468
  #
@@ -2434,6 +2471,10 @@ module Aws::RDS
2434
2471
  # * First character must be a letter.
2435
2472
  #
2436
2473
  # * Can't end with a hyphen or contain two consecutive hyphens.
2474
+ #
2475
+ #
2476
+ #
2477
+ # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/db2-licensing.html#db2-prereqs-ibm-info
2437
2478
  # @option options [Boolean] :publicly_accessible
2438
2479
  # Specifies whether the DB instance is publicly accessible.
2439
2480
  #
@@ -2782,63 +2823,68 @@ module Aws::RDS
2782
2823
  #
2783
2824
  # Example: `123.124.125.126,234.235.236.237`
2784
2825
  # @option options [String] :replica_mode
2785
- # The open mode of the replica database: mounted or read-only.
2786
- #
2787
- # <note markdown="1"> This parameter is only supported for Oracle DB instances.
2826
+ # The open mode of the replica database.
2788
2827
  #
2789
- # </note>
2790
- #
2791
- # Mounted DB replicas are included in Oracle Database Enterprise
2792
- # Edition. The main use case for mounted replicas is cross-Region
2793
- # disaster recovery. The primary database doesn't use Active Data Guard
2794
- # to transmit information to the mounted replica. Because it doesn't
2795
- # accept user connections, a mounted replica can't serve a read-only
2796
- # workload.
2828
+ # This parameter is only supported for Db2 DB instances and Oracle DB
2829
+ # instances.
2797
2830
  #
2798
- # You can create a combination of mounted and read-only DB replicas for
2799
- # the same primary DB instance. For more information, see [Working with
2800
- # Oracle Read Replicas for Amazon RDS][1] in the *Amazon RDS User
2801
- # Guide*.
2831
+ # Db2
2802
2832
  #
2803
- # For RDS Custom, you must specify this parameter and set it to
2804
- # `mounted`. The value won't be set by default. After replica creation,
2805
- # you can manage the open mode manually.
2833
+ # : Standby DB replicas are included in Db2 Advanced Edition (AE) and
2834
+ # Db2 Standard Edition (SE). The main use case for standby replicas is
2835
+ # cross-Region disaster recovery. Because it doesn't accept user
2836
+ # connections, a standby replica can't serve a read-only workload.
2806
2837
  #
2838
+ # You can create a combination of standby and read-only DB replicas
2839
+ # for the same primary DB instance. For more information, see [Working
2840
+ # with replicas for Amazon RDS for Db2][1] in the *Amazon RDS User
2841
+ # Guide*.
2807
2842
  #
2843
+ # To create standby DB replicas for RDS for Db2, set this parameter to
2844
+ # `mounted`.
2808
2845
  #
2809
- # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-read-replicas.html
2810
- # @option options [Integer] :max_allocated_storage
2811
- # The upper limit in gibibytes (GiB) to which Amazon RDS can
2812
- # automatically scale the storage of the DB instance.
2846
+ # Oracle
2813
2847
  #
2814
- # For more information about this setting, including limitations that
2815
- # apply to it, see [ Managing capacity automatically with Amazon RDS
2816
- # storage autoscaling][1] in the *Amazon RDS User Guide*.
2848
+ # : Mounted DB replicas are included in Oracle Database Enterprise
2849
+ # Edition. The main use case for mounted replicas is cross-Region
2850
+ # disaster recovery. The primary database doesn't use Active Data
2851
+ # Guard to transmit information to the mounted replica. Because it
2852
+ # doesn't accept user connections, a mounted replica can't serve a
2853
+ # read-only workload.
2817
2854
  #
2855
+ # You can create a combination of mounted and read-only DB replicas
2856
+ # for the same primary DB instance. For more information, see [Working
2857
+ # with read replicas for Amazon RDS for Oracle][2] in the *Amazon RDS
2858
+ # User Guide*.
2818
2859
  #
2860
+ # For RDS Custom, you must specify this parameter and set it to
2861
+ # `mounted`. The value won't be set by default. After replica
2862
+ # creation, you can manage the open mode manually.
2819
2863
  #
2820
- # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIOPS.StorageTypes.html#USER_PIOPS.Autoscaling
2821
- # @option options [String] :custom_iam_instance_profile
2822
- # The instance profile associated with the underlying Amazon EC2
2823
- # instance of an RDS Custom DB instance. The instance profile must meet
2824
- # the following requirements:
2825
2864
  #
2826
- # * The profile must exist in your account.
2827
2865
  #
2828
- # * The profile must have an IAM role that Amazon EC2 has permissions to
2829
- # assume.
2866
+ # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/db2-replication.html
2867
+ # [2]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-read-replicas.html
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.
2830
2871
  #
2831
- # * The instance profile name and the associated IAM role name must
2832
- # start with the prefix `AWSRDSCustom`.
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.
2833
2876
  #
2834
- # For the list of permissions required for the IAM role, see [ Configure
2835
- # IAM and your VPC][1] in the *Amazon RDS User Guide*.
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*.
2836
2880
  #
2837
- # This setting is required for RDS Custom DB instances.
2881
+ # For more information about CoIPs, see [Customer-owned IP addresses][2]
2882
+ # in the *Amazon Web Services Outposts User Guide*.
2838
2883
  #
2839
2884
  #
2840
2885
  #
2841
- # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-setup-orcl.html#custom-setup-orcl.iam-vpc
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
2842
2888
  # @option options [String] :network_type
2843
2889
  # The network type of the DB instance.
2844
2890
  #
@@ -2858,31 +2904,46 @@ module Aws::RDS
2858
2904
  #
2859
2905
  #
2860
2906
  # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html
2861
- # @option options [Integer] :storage_throughput
2862
- # Specifies the storage throughput value for the read replica.
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.
2863
2910
  #
2864
- # This setting doesn't apply to RDS Custom or Amazon Aurora DB
2865
- # instances.
2866
- # @option options [Boolean] :enable_customer_owned_ip
2867
- # Specifies whether to enable a customer-owned IP address (CoIP) for an
2868
- # RDS on Outposts read replica.
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*.
2869
2914
  #
2870
- # A *CoIP* provides local or external connectivity to resources in your
2871
- # Outpost subnets through your on-premises network. For some use cases,
2872
- # a CoIP can provide lower latency for connections to the read replica
2873
- # from outside of its virtual private cloud (VPC) on your local network.
2874
2915
  #
2875
- # For more information about RDS on Outposts, see [Working with Amazon
2876
- # RDS on Amazon Web Services Outposts][1] in the *Amazon RDS User
2877
- # Guide*.
2878
2916
  #
2879
- # For more information about CoIPs, see [Customer-owned IP addresses][2]
2880
- # in the *Amazon Web Services Outposts User Guide*.
2917
+ # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIOPS.StorageTypes.html#USER_PIOPS.Autoscaling
2918
+ # @option options [String] :backup_target
2919
+ # The location where RDS stores automated backups and manual snapshots.
2881
2920
  #
2921
+ # Valid Values:
2882
2922
  #
2923
+ # * `local` for Dedicated Local Zones
2883
2924
  #
2884
- # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html
2885
- # [2]: https://docs.aws.amazon.com/outposts/latest/userguide/routing.html#ip-addressing
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
2886
2947
  # @option options [Integer] :allocated_storage
2887
2948
  # The amount of storage (in gibibytes) to allocate initially for the
2888
2949
  # read replica. Follow the allocation rules specified in
@@ -3075,7 +3136,7 @@ module Aws::RDS
3075
3136
  # db_security_groups: ["String"],
3076
3137
  # vpc_security_group_ids: ["String"],
3077
3138
  # apply_immediately: false,
3078
- # master_user_password: "String",
3139
+ # master_user_password: "SensitiveString",
3079
3140
  # db_parameter_group_name: "String",
3080
3141
  # backup_retention_period: 1,
3081
3142
  # preferred_backup_window: "String",
@@ -3086,24 +3147,25 @@ module Aws::RDS
3086
3147
  # auto_minor_version_upgrade: false,
3087
3148
  # license_model: "String",
3088
3149
  # iops: 1,
3150
+ # storage_throughput: 1,
3089
3151
  # option_group_name: "String",
3090
3152
  # new_db_instance_identifier: "String",
3091
3153
  # storage_type: "String",
3092
3154
  # tde_credential_arn: "String",
3093
- # tde_credential_password: "String",
3155
+ # tde_credential_password: "SensitiveString",
3094
3156
  # ca_certificate_identifier: "String",
3095
3157
  # domain: "String",
3096
3158
  # domain_fqdn: "String",
3097
3159
  # domain_ou: "String",
3098
3160
  # domain_auth_secret_arn: "String",
3099
3161
  # domain_dns_ips: ["String"],
3162
+ # disable_domain: false,
3100
3163
  # copy_tags_to_snapshot: false,
3101
3164
  # monitoring_interval: 1,
3102
3165
  # db_port_number: 1,
3103
3166
  # publicly_accessible: false,
3104
3167
  # monitoring_role_arn: "String",
3105
3168
  # domain_iam_role_name: "String",
3106
- # disable_domain: false,
3107
3169
  # promotion_tier: 1,
3108
3170
  # enable_iam_database_authentication: false,
3109
3171
  # database_insights_mode: "standard", # accepts standard, advanced
@@ -3125,18 +3187,18 @@ module Aws::RDS
3125
3187
  # max_allocated_storage: 1,
3126
3188
  # certificate_rotation_restart: false,
3127
3189
  # replica_mode: "open-read-only", # accepts open-read-only, mounted
3128
- # enable_customer_owned_ip: false,
3129
- # aws_backup_recovery_point_arn: "AwsBackupRecoveryPointArn",
3130
3190
  # automation_mode: "full", # accepts full, all-paused
3131
3191
  # resume_full_automation_mode_minutes: 1,
3192
+ # enable_customer_owned_ip: false,
3132
3193
  # network_type: "String",
3133
- # storage_throughput: 1,
3194
+ # aws_backup_recovery_point_arn: "AwsBackupRecoveryPointArn",
3134
3195
  # manage_master_user_password: false,
3135
3196
  # rotate_master_user_password: false,
3136
3197
  # master_user_secret_kms_key_id: "String",
3137
- # engine: "String",
3138
- # dedicated_log_volume: false,
3139
3198
  # multi_tenant: false,
3199
+ # dedicated_log_volume: false,
3200
+ # engine: "String",
3201
+ # master_user_authentication_type: "password", # accepts password, iam-db-auth
3140
3202
  # })
3141
3203
  # @param [Hash] options ({})
3142
3204
  # @option options [Integer] :allocated_storage
@@ -3560,6 +3622,13 @@ module Aws::RDS
3560
3622
  # `AllocatedStorage`.
3561
3623
  #
3562
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.
3563
3632
  # @option options [String] :option_group_name
3564
3633
  # The option group to associate the DB instance with.
3565
3634
  #
@@ -3678,7 +3747,7 @@ module Aws::RDS
3678
3747
  #
3679
3748
  # * Must be in the distinguished name format.
3680
3749
  #
3681
- # * Can't be longer than 64 characters.
3750
+ # ^
3682
3751
  #
3683
3752
  # Example:
3684
3753
  # `OU=mymanagedADtestOU,DC=mymanagedADtest,DC=mymanagedAD,DC=mydomain`
@@ -3701,6 +3770,9 @@ module Aws::RDS
3701
3770
  # ^
3702
3771
  #
3703
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.
3704
3776
  # @option options [Boolean] :copy_tags_to_snapshot
3705
3777
  # Specifies whether to copy all tags from the DB instance to snapshots
3706
3778
  # of the DB instance. By default, tags aren't copied.
@@ -3799,9 +3871,6 @@ module Aws::RDS
3799
3871
  # Service.
3800
3872
  #
3801
3873
  # This setting doesn't apply to RDS Custom DB instances.
3802
- # @option options [Boolean] :disable_domain
3803
- # Specifies whether to remove the DB instance from the Active Directory
3804
- # domain.
3805
3874
  # @option options [Integer] :promotion_tier
3806
3875
  # The order of priority in which an Aurora Replica is promoted to the
3807
3876
  # primary instance after a failure of the existing primary instance. For
@@ -3986,51 +4055,48 @@ module Aws::RDS
3986
4055
  # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL-certificate-rotation.html
3987
4056
  # [2]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL-certificate-rotation.html
3988
4057
  # @option options [String] :replica_mode
3989
- # A value that sets the open mode of a replica database to either
3990
- # mounted or read-only.
3991
- #
3992
- # <note markdown="1"> Currently, this parameter is only supported for Oracle DB instances.
3993
- #
3994
- # </note>
4058
+ # The open mode of a replica database.
3995
4059
  #
3996
- # Mounted DB replicas are included in Oracle Enterprise Edition. The
3997
- # main use case for mounted replicas is cross-Region disaster recovery.
3998
- # The primary database doesn't use Active Data Guard to transmit
3999
- # information to the mounted replica. Because it doesn't accept user
4000
- # connections, a mounted replica can't serve a read-only workload. For
4001
- # more information, see [Working with Oracle Read Replicas for Amazon
4002
- # RDS][1] in the *Amazon RDS User Guide*.
4060
+ # This parameter is only supported for Db2 DB instances and Oracle DB
4061
+ # instances.
4003
4062
  #
4004
- # This setting doesn't apply to RDS Custom DB instances.
4063
+ # Db2
4005
4064
  #
4065
+ # : Standby DB replicas are included in Db2 Advanced Edition (AE) and
4066
+ # Db2 Standard Edition (SE). The main use case for standby replicas is
4067
+ # cross-Region disaster recovery. Because it doesn't accept user
4068
+ # connections, a standby replica can't serve a read-only workload.
4006
4069
  #
4070
+ # You can create a combination of standby and read-only DB replicas
4071
+ # for the same primary DB instance. For more information, see [Working
4072
+ # with replicas for Amazon RDS for Db2][1] in the *Amazon RDS User
4073
+ # Guide*.
4007
4074
  #
4008
- # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-read-replicas.html
4009
- # @option options [Boolean] :enable_customer_owned_ip
4010
- # Specifies whether to enable a customer-owned IP address (CoIP) for an
4011
- # RDS on Outposts DB instance.
4075
+ # To create standby DB replicas for RDS for Db2, set this parameter to
4076
+ # `mounted`.
4012
4077
  #
4013
- # A *CoIP* provides local or external connectivity to resources in your
4014
- # Outpost subnets through your on-premises network. For some use cases,
4015
- # a CoIP can provide lower latency for connections to the DB instance
4016
- # from outside of its virtual private cloud (VPC) on your local network.
4078
+ # Oracle
4017
4079
  #
4018
- # For more information about RDS on Outposts, see [Working with Amazon
4019
- # RDS on Amazon Web Services Outposts][1] in the *Amazon RDS User
4020
- # Guide*.
4080
+ # : Mounted DB replicas are included in Oracle Database Enterprise
4081
+ # Edition. The main use case for mounted replicas is cross-Region
4082
+ # disaster recovery. The primary database doesn't use Active Data
4083
+ # Guard to transmit information to the mounted replica. Because it
4084
+ # doesn't accept user connections, a mounted replica can't serve a
4085
+ # read-only workload.
4021
4086
  #
4022
- # For more information about CoIPs, see [Customer-owned IP addresses][2]
4023
- # in the *Amazon Web Services Outposts User Guide*.
4087
+ # You can create a combination of mounted and read-only DB replicas
4088
+ # for the same primary DB instance. For more information, see [Working
4089
+ # with read replicas for Amazon RDS for Oracle][2] in the *Amazon RDS
4090
+ # User Guide*.
4024
4091
  #
4092
+ # For RDS Custom, you must specify this parameter and set it to
4093
+ # `mounted`. The value won't be set by default. After replica
4094
+ # creation, you can manage the open mode manually.
4025
4095
  #
4026
4096
  #
4027
- # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html
4028
- # [2]: https://docs.aws.amazon.com/outposts/latest/userguide/routing.html#ip-addressing
4029
- # @option options [String] :aws_backup_recovery_point_arn
4030
- # The Amazon Resource Name (ARN) of the recovery point in Amazon Web
4031
- # Services Backup.
4032
4097
  #
4033
- # This setting doesn't apply to RDS Custom DB instances.
4098
+ # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/db2-replication.html
4099
+ # [2]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-read-replicas.html
4034
4100
  # @option options [String] :automation_mode
4035
4101
  # The automation mode of the RDS Custom DB instance. If `full`, the DB
4036
4102
  # instance automates monitoring and instance recovery. If `all paused`,
@@ -4047,6 +4113,26 @@ module Aws::RDS
4047
4113
  # * Must be at least 60.
4048
4114
  #
4049
4115
  # * Must be no more than 1,440.
4116
+ # @option options [Boolean] :enable_customer_owned_ip
4117
+ # Specifies whether to enable a customer-owned IP address (CoIP) for an
4118
+ # RDS on Outposts DB instance.
4119
+ #
4120
+ # A *CoIP* provides local or external connectivity to resources in your
4121
+ # Outpost subnets through your on-premises network. For some use cases,
4122
+ # a CoIP can provide lower latency for connections to the DB instance
4123
+ # from outside of its virtual private cloud (VPC) on your local network.
4124
+ #
4125
+ # For more information about RDS on Outposts, see [Working with Amazon
4126
+ # RDS on Amazon Web Services Outposts][1] in the *Amazon RDS User
4127
+ # Guide*.
4128
+ #
4129
+ # For more information about CoIPs, see [Customer-owned IP addresses][2]
4130
+ # in the *Amazon Web Services Outposts User Guide*.
4131
+ #
4132
+ #
4133
+ #
4134
+ # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html
4135
+ # [2]: https://docs.aws.amazon.com/outposts/latest/userguide/routing.html#ip-addressing
4050
4136
  # @option options [String] :network_type
4051
4137
  # The network type of the DB instance.
4052
4138
  #
@@ -4062,13 +4148,11 @@ module Aws::RDS
4062
4148
  #
4063
4149
  #
4064
4150
  # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html
4065
- # @option options [Integer] :storage_throughput
4066
- # The storage throughput value for the DB instance.
4067
- #
4068
- # 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.
4069
4154
  #
4070
- # This setting doesn't apply to Amazon Aurora or RDS Custom DB
4071
- # instances.
4155
+ # This setting doesn't apply to RDS Custom DB instances.
4072
4156
  # @option options [Boolean] :manage_master_user_password
4073
4157
  # Specifies whether to manage the master user password with Amazon Web
4074
4158
  # Services Secrets Manager.
@@ -4155,6 +4239,25 @@ module Aws::RDS
4155
4239
  # There is a default KMS key for your Amazon Web Services account. Your
4156
4240
  # Amazon Web Services account has a different default KMS key for each
4157
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.
4158
4261
  # @option options [String] :engine
4159
4262
  # The target Oracle DB engine when you convert a non-CDB to a CDB. This
4160
4263
  # intermediate step is necessary to upgrade an Oracle Database 19c
@@ -4182,25 +4285,19 @@ module Aws::RDS
4182
4285
  # parameter group. To avoid reverting to the default, specify a new
4183
4286
  # parameter group with `--db-parameter-group-name` and a new option
4184
4287
  # group with `--option-group-name`.
4185
- # @option options [Boolean] :dedicated_log_volume
4186
- # Indicates whether the DB instance has a dedicated log volume (DLV)
4187
- # enabled.
4188
- # @option options [Boolean] :multi_tenant
4189
- # Specifies whether the to convert your DB instance from the
4190
- # single-tenant configuration to the multi-tenant configuration. This
4191
- # 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.
4192
4292
  #
4193
- # During the conversion, RDS creates an initial tenant database and
4194
- # associates the DB name, master user name, character set, and national
4195
- # character set metadata with this database. The tags associated with
4196
- # the instance also propagate to the initial tenant database. You can
4197
- # add more tenant databases to your DB instance by using the
4198
- # `CreateTenantDatabase` operation.
4293
+ # You can specify one of the following values:
4199
4294
  #
4200
- # The conversion to the multi-tenant configuration is permanent and
4201
- # irreversible, so you can't later convert back to the single-tenant
4202
- # configuration. When you specify this parameter, you must also specify
4203
- # `ApplyImmediately`.
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.
4204
4301
  # @return [DBInstance]
4205
4302
  def modify(options = {})
4206
4303
  options = options.merge(db_instance_identifier: @id)
@@ -4310,6 +4407,7 @@ module Aws::RDS
4310
4407
  # db_name: "String",
4311
4408
  # engine: "String",
4312
4409
  # iops: 1,
4410
+ # storage_throughput: 1,
4313
4411
  # option_group_name: "String",
4314
4412
  # copy_tags_to_snapshot: false,
4315
4413
  # tags: [
@@ -4320,7 +4418,7 @@ module Aws::RDS
4320
4418
  # ],
4321
4419
  # storage_type: "String",
4322
4420
  # tde_credential_arn: "String",
4323
- # tde_credential_password: "String",
4421
+ # tde_credential_password: "SensitiveString",
4324
4422
  # vpc_security_group_ids: ["String"],
4325
4423
  # domain: "String",
4326
4424
  # domain_iam_role_name: "String",
@@ -4341,12 +4439,11 @@ module Aws::RDS
4341
4439
  # deletion_protection: false,
4342
4440
  # source_dbi_resource_id: "String",
4343
4441
  # max_allocated_storage: 1,
4344
- # source_db_instance_automated_backups_arn: "String",
4345
4442
  # enable_customer_owned_ip: false,
4346
- # custom_iam_instance_profile: "String",
4347
- # backup_target: "String",
4348
4443
  # network_type: "String",
4349
- # storage_throughput: 1,
4444
+ # source_db_instance_automated_backups_arn: "String",
4445
+ # backup_target: "String",
4446
+ # custom_iam_instance_profile: "String",
4350
4447
  # allocated_storage: 1,
4351
4448
  # dedicated_log_volume: false,
4352
4449
  # ca_certificate_identifier: "String",
@@ -4475,7 +4572,7 @@ module Aws::RDS
4475
4572
  # The license model information for the restored DB instance.
4476
4573
  #
4477
4574
  # <note markdown="1"> License models for RDS for Db2 require additional configuration. The
4478
- # Bring Your Own License (BYOL) model requires a custom parameter group
4575
+ # bring your own license (BYOL) model requires a custom parameter group
4479
4576
  # and an Amazon Web Services License Manager self-managed license. The
4480
4577
  # Db2 license through Amazon Web Services Marketplace model requires an
4481
4578
  # Amazon Web Services Marketplace subscription. For more information,
@@ -4569,6 +4666,10 @@ module Aws::RDS
4569
4666
  # * Must be an integer greater than 1000.
4570
4667
  #
4571
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.
4572
4673
  # @option options [String] :option_group_name
4573
4674
  # The name of the option group to use for the restored DB instance.
4574
4675
  #
@@ -4762,12 +4863,6 @@ module Aws::RDS
4762
4863
  #
4763
4864
  #
4764
4865
  # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIOPS.StorageTypes.html#USER_PIOPS.Autoscaling
4765
- # @option options [String] :source_db_instance_automated_backups_arn
4766
- # The Amazon Resource Name (ARN) of the replicated automated backups
4767
- # from which to restore, for example,
4768
- # `arn:aws:rds:us-east-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE`.
4769
- #
4770
- # This setting doesn't apply to RDS Custom.
4771
4866
  # @option options [Boolean] :enable_customer_owned_ip
4772
4867
  # Specifies whether to enable a customer-owned IP address (CoIP) for an
4773
4868
  # RDS on Outposts DB instance.
@@ -4790,33 +4885,39 @@ module Aws::RDS
4790
4885
  #
4791
4886
  # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html
4792
4887
  # [2]: https://docs.aws.amazon.com/outposts/latest/userguide/routing.html#ip-addressing
4793
- # @option options [String] :custom_iam_instance_profile
4794
- # The instance profile associated with the underlying Amazon EC2
4795
- # instance of an RDS Custom DB instance. The instance profile must meet
4796
- # the following requirements:
4888
+ # @option options [String] :network_type
4889
+ # The network type of the DB instance.
4797
4890
  #
4798
- # * The profile must exist in your account.
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`).
4799
4894
  #
4800
- # * The profile must have an IAM role that Amazon EC2 has permissions to
4801
- # assume.
4895
+ # For more information, see [ Working with a DB instance in a VPC][1] in
4896
+ # the *Amazon RDS User Guide.*
4802
4897
  #
4803
- # * The instance profile name and the associated IAM role name must
4804
- # start with the prefix `AWSRDSCustom`.
4898
+ # Valid Values:
4805
4899
  #
4806
- # For the list of permissions required for the IAM role, see [ Configure
4807
- # IAM and your VPC][1] in the *Amazon RDS User Guide*.
4900
+ # * `IPV4`
4808
4901
  #
4809
- # This setting is required for RDS Custom.
4902
+ # * `DUAL`
4810
4903
  #
4811
4904
  #
4812
4905
  #
4813
- # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-setup-orcl.html#custom-setup-orcl.iam-vpc
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.
4814
4913
  # @option options [String] :backup_target
4815
4914
  # The location for storing automated backups and manual snapshots for
4816
4915
  # the restored DB instance.
4817
4916
  #
4818
4917
  # Valid Values:
4819
4918
  #
4919
+ # * `local` (Dedicated Local Zone)
4920
+ #
4820
4921
  # * `outposts` (Amazon Web Services Outposts)
4821
4922
  #
4822
4923
  # * `region` (Amazon Web Services Region)
@@ -4829,29 +4930,27 @@ module Aws::RDS
4829
4930
  #
4830
4931
  #
4831
4932
  # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html
4832
- # @option options [String] :network_type
4833
- # The network type of the DB instance.
4834
- #
4835
- # The network type is determined by the `DBSubnetGroup` specified for
4836
- # the DB instance. A `DBSubnetGroup` can support only the IPv4 protocol
4837
- # 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:
4838
4937
  #
4839
- # For more information, see [ Working with a DB instance in a VPC][1] in
4840
- # the *Amazon RDS User Guide.*
4938
+ # * The profile must exist in your account.
4841
4939
  #
4842
- # Valid Values:
4940
+ # * The profile must have an IAM role that Amazon EC2 has permissions to
4941
+ # assume.
4843
4942
  #
4844
- # * `IPV4`
4943
+ # * The instance profile name and the associated IAM role name must
4944
+ # start with the prefix `AWSRDSCustom`.
4845
4945
  #
4846
- # * `DUAL`
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*.
4847
4948
  #
4949
+ # This setting is required for RDS Custom.
4848
4950
  #
4849
4951
  #
4850
- # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html
4851
- # @option options [Integer] :storage_throughput
4852
- # The storage throughput value for the DB instance.
4853
4952
  #
4854
- # This setting doesn't apply to RDS Custom or Amazon Aurora.
4953
+ # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-setup-orcl.html#custom-setup-orcl.iam-vpc
4855
4954
  # @option options [Integer] :allocated_storage
4856
4955
  # The amount of storage (in gibibytes) to allocate initially for the DB
4857
4956
  # instance. Follow the allocation rules specified in `CreateDBInstance`.