aws-sdk-rds 1.293.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.
@@ -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 list of replicated automated backups associated with the DB
584
- # instance.
585
- # @return [Array<Types::DBInstanceAutomatedBackupsReplication>]
586
- def db_instance_automated_backups_replications
587
- data[:db_instance_automated_backups_replications]
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 Amazon Resource Name (ARN) of the recovery point in Amazon Web
616
- # Services Backup.
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 aws_backup_recovery_point_arn
619
- data[:aws_backup_recovery_point_arn]
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 automation mode of the RDS Custom DB instance: `full` or `all
660
- # paused`. If `full`, the DB instance automates monitoring and instance
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 automation_mode
665
- data[:automation_mode]
688
+ def aws_backup_recovery_point_arn
689
+ data[:aws_backup_recovery_point_arn]
666
690
  end
667
691
 
668
- # The number of minutes to pause the automation. When the time period
669
- # ends, RDS Custom resumes full automation. The minimum value is 60
670
- # (default). The maximum value is 1,440.
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 resume_full_automation_mode_time
673
- data[:resume_full_automation_mode_time]
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 storage throughput for the DB instance.
735
- #
736
- # This setting applies only to the `gp3` storage type.
737
- # @return [Integer]
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: "String",
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: "String",
994
+ # tde_credential_password: "SensitiveString",
994
995
  # storage_encrypted: false,
995
996
  # kms_key_id: "String",
996
997
  # domain: "String",
@@ -1019,16 +1020,15 @@ 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
- # storage_throughput: 1,
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
1033
  # master_user_authentication_type: "password", # accepts password, iam-db-auth
1034
1034
  # })
@@ -1692,6 +1692,14 @@ module Aws::RDS
1692
1692
  #
1693
1693
  #
1694
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.
1695
1703
  # @option options [String] :option_group_name
1696
1704
  # The option group to associate the DB instance with.
1697
1705
  #
@@ -2095,28 +2103,21 @@ module Aws::RDS
2095
2103
  #
2096
2104
  # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html
2097
2105
  # [2]: https://docs.aws.amazon.com/outposts/latest/userguide/routing.html#ip-addressing
2098
- # @option options [String] :custom_iam_instance_profile
2099
- # The instance profile associated with the underlying Amazon EC2
2100
- # instance of an RDS Custom DB instance.
2101
- #
2102
- # This setting is required for RDS Custom.
2103
- #
2104
- # Constraints:
2105
- #
2106
- # * The profile must exist in your account.
2106
+ # @option options [String] :network_type
2107
+ # The network type of the DB instance.
2107
2108
  #
2108
- # * The profile must have an IAM role that Amazon EC2 has permissions to
2109
- # assume.
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`).
2110
2112
  #
2111
- # * The instance profile name and the associated IAM role name must
2112
- # start with the prefix `AWSRDSCustom`.
2113
+ # For more information, see [ Working with a DB instance in a VPC][1] in
2114
+ # the *Amazon RDS User Guide.*
2113
2115
  #
2114
- # For the list of permissions required for the IAM role, see [ Configure
2115
- # IAM and your VPC][1] in the *Amazon RDS User Guide*.
2116
+ # Valid Values: `IPV4 | DUAL`
2116
2117
  #
2117
2118
  #
2118
2119
  #
2119
- # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-setup-orcl.html#custom-setup-orcl.iam-vpc
2120
+ # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html
2120
2121
  # @option options [String] :backup_target
2121
2122
  # The location for storing automated backups and manual snapshots.
2122
2123
  #
@@ -2136,29 +2137,50 @@ module Aws::RDS
2136
2137
  #
2137
2138
  #
2138
2139
  # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html
2139
- # @option options [String] :network_type
2140
- # The network type of the DB instance.
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.
2141
2143
  #
2142
- # The network type is determined by the `DBSubnetGroup` specified for
2143
- # the DB instance. A `DBSubnetGroup` can support only the IPv4 protocol
2144
- # or the IPv4 and the IPv6 protocols (`DUAL`).
2144
+ # This setting is required for RDS Custom.
2145
2145
  #
2146
- # For more information, see [ Working with a DB instance in a VPC][1] in
2147
- # the *Amazon RDS User Guide.*
2146
+ # Constraints:
2148
2147
  #
2149
- # Valid Values: `IPV4 | DUAL`
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.
2150
2152
  #
2153
+ # * The instance profile name and the associated IAM role name must
2154
+ # start with the prefix `AWSRDSCustom`.
2151
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*.
2152
2158
  #
2153
- # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html
2154
- # @option options [Integer] :storage_throughput
2155
- # The storage throughput value, in mebibyte per second (MiBps), for the
2156
- # DB instance.
2157
2159
  #
2158
- # This setting applies only to the `gp3` storage type.
2159
2160
  #
2160
- # This setting doesn't apply to Amazon Aurora or RDS Custom DB
2161
- # instances.
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
2162
2184
  # @option options [Boolean] :manage_master_user_password
2163
2185
  # Specifies whether to manage the master user password with Amazon Web
2164
2186
  # Services Secrets Manager.
@@ -2198,37 +2220,12 @@ module Aws::RDS
2198
2220
  # There is a default KMS key for your Amazon Web Services account. Your
2199
2221
  # Amazon Web Services account has a different default KMS key for each
2200
2222
  # Amazon Web Services Region.
2201
- # @option options [String] :ca_certificate_identifier
2202
- # The CA certificate identifier to use for the DB instance's server
2203
- # certificate.
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.
2204
2227
  #
2205
- # This setting doesn't apply to RDS Custom DB instances.
2206
- #
2207
- # For more information, see [Using SSL/TLS to encrypt a connection to a
2208
- # DB instance][1] in the *Amazon RDS User Guide* and [ Using SSL/TLS to
2209
- # encrypt a connection to a DB cluster][2] in the *Amazon Aurora User
2210
- # Guide*.
2211
- #
2212
- #
2213
- #
2214
- # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL.html
2215
- # [2]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL.html
2216
- # @option options [String] :db_system_id
2217
- # The Oracle system identifier (SID), which is the name of the Oracle
2218
- # database instance that manages your database files. In this context,
2219
- # the term "Oracle database instance" refers exclusively to the system
2220
- # global area (SGA) and Oracle background processes. If you don't
2221
- # specify a SID, the value defaults to `RDSCDB`. The Oracle SID is also
2222
- # the name of your CDB.
2223
- # @option options [Boolean] :dedicated_log_volume
2224
- # Indicates whether the DB instance has a dedicated log volume (DLV)
2225
- # enabled.
2226
- # @option options [Boolean] :multi_tenant
2227
- # Specifies whether to use the multi-tenant configuration or the
2228
- # single-tenant configuration (default). This parameter only applies to
2229
- # RDS for Oracle container database (CDB) engines.
2230
- #
2231
- # Note the following restrictions:
2228
+ # Note the following restrictions:
2232
2229
  #
2233
2230
  # * The DB engine that you specify in the request must support the
2234
2231
  # multi-tenant configuration. If you attempt to enable the
@@ -2238,6 +2235,9 @@ module Aws::RDS
2238
2235
  # * If you specify the multi-tenant configuration when you create your
2239
2236
  # DB instance, you can't later modify this DB instance to use the
2240
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.
2241
2241
  # @option options [String] :engine_lifecycle_support
2242
2242
  # The life cycle type for this DB instance.
2243
2243
  #
@@ -2305,6 +2305,7 @@ module Aws::RDS
2305
2305
  # multi_az: false,
2306
2306
  # auto_minor_version_upgrade: false,
2307
2307
  # iops: 1,
2308
+ # storage_throughput: 1,
2308
2309
  # option_group_name: "String",
2309
2310
  # db_parameter_group_name: "String",
2310
2311
  # publicly_accessible: false,
@@ -2321,7 +2322,7 @@ module Aws::RDS
2321
2322
  # monitoring_interval: 1,
2322
2323
  # monitoring_role_arn: "String",
2323
2324
  # kms_key_id: "String",
2324
- # pre_signed_url: "String",
2325
+ # pre_signed_url: "SensitiveString",
2325
2326
  # enable_iam_database_authentication: false,
2326
2327
  # database_insights_mode: "standard", # accepts standard, advanced
2327
2328
  # enable_performance_insights: false,
@@ -2343,12 +2344,11 @@ module Aws::RDS
2343
2344
  # domain_auth_secret_arn: "String",
2344
2345
  # domain_dns_ips: ["String"],
2345
2346
  # replica_mode: "open-read-only", # accepts open-read-only, mounted
2346
- # max_allocated_storage: 1,
2347
- # custom_iam_instance_profile: "String",
2348
- # network_type: "String",
2349
- # storage_throughput: 1,
2350
2347
  # enable_customer_owned_ip: false,
2348
+ # network_type: "String",
2349
+ # max_allocated_storage: 1,
2351
2350
  # backup_target: "String",
2351
+ # custom_iam_instance_profile: "String",
2352
2352
  # allocated_storage: 1,
2353
2353
  # source_db_cluster_identifier: "String",
2354
2354
  # dedicated_log_volume: false,
@@ -2413,6 +2413,11 @@ module Aws::RDS
2413
2413
  # @option options [Integer] :iops
2414
2414
  # The amount of Provisioned IOPS (input/output operations per second) to
2415
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.
2416
2421
  # @option options [String] :option_group_name
2417
2422
  # The option group to associate the DB instance with. If not specified,
2418
2423
  # RDS uses the option group associated with the source DB instance or
@@ -2855,38 +2860,26 @@ module Aws::RDS
2855
2860
  #
2856
2861
  # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/db2-replication.html
2857
2862
  # [2]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-read-replicas.html
2858
- # @option options [Integer] :max_allocated_storage
2859
- # The upper limit in gibibytes (GiB) to which Amazon RDS can
2860
- # automatically scale the storage of the DB instance.
2861
- #
2862
- # For more information about this setting, including limitations that
2863
- # apply to it, see [ Managing capacity automatically with Amazon RDS
2864
- # storage autoscaling][1] in the *Amazon RDS User Guide*.
2865
- #
2866
- #
2867
- #
2868
- # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIOPS.StorageTypes.html#USER_PIOPS.Autoscaling
2869
- # @option options [String] :custom_iam_instance_profile
2870
- # The instance profile associated with the underlying Amazon EC2
2871
- # instance of an RDS Custom DB instance. The instance profile must meet
2872
- # the following requirements:
2873
- #
2874
- # * The profile must exist in your account.
2875
- #
2876
- # * The profile must have an IAM role that Amazon EC2 has permissions to
2877
- # 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.
2878
2866
  #
2879
- # * The instance profile name and the associated IAM role name must
2880
- # start with the prefix `AWSRDSCustom`.
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.
2881
2871
  #
2882
- # For the list of permissions required for the IAM role, see [ Configure
2883
- # IAM and your VPC][1] in the *Amazon RDS User Guide*.
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*.
2884
2875
  #
2885
- # This setting is required for RDS Custom DB instances.
2876
+ # For more information about CoIPs, see [Customer-owned IP addresses][2]
2877
+ # in the *Amazon Web Services Outposts User Guide*.
2886
2878
  #
2887
2879
  #
2888
2880
  #
2889
- # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-setup-orcl.html#custom-setup-orcl.iam-vpc
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
2890
2883
  # @option options [String] :network_type
2891
2884
  # The network type of the DB instance.
2892
2885
  #
@@ -2906,31 +2899,17 @@ module Aws::RDS
2906
2899
  #
2907
2900
  #
2908
2901
  # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html
2909
- # @option options [Integer] :storage_throughput
2910
- # Specifies the storage throughput value for the read replica.
2911
- #
2912
- # This setting doesn't apply to RDS Custom or Amazon Aurora DB
2913
- # instances.
2914
- # @option options [Boolean] :enable_customer_owned_ip
2915
- # Specifies whether to enable a customer-owned IP address (CoIP) for an
2916
- # RDS on Outposts read replica.
2917
- #
2918
- # A *CoIP* provides local or external connectivity to resources in your
2919
- # Outpost subnets through your on-premises network. For some use cases,
2920
- # a CoIP can provide lower latency for connections to the read replica
2921
- # from outside of its virtual private cloud (VPC) on your local network.
2922
- #
2923
- # For more information about RDS on Outposts, see [Working with Amazon
2924
- # RDS on Amazon Web Services Outposts][1] in the *Amazon RDS User
2925
- # 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.
2926
2905
  #
2927
- # For more information about CoIPs, see [Customer-owned IP addresses][2]
2928
- # in the *Amazon Web Services Outposts User Guide*.
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*.
2929
2909
  #
2930
2910
  #
2931
2911
  #
2932
- # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html
2933
- # [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
2934
2913
  # @option options [String] :backup_target
2935
2914
  # The location where RDS stores automated backups and manual snapshots.
2936
2915
  #
@@ -2939,6 +2918,27 @@ module Aws::RDS
2939
2918
  # * `local` for Dedicated Local Zones
2940
2919
  #
2941
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
2942
2942
  # @option options [Integer] :allocated_storage
2943
2943
  # The amount of storage (in gibibytes) to allocate initially for the
2944
2944
  # read replica. Follow the allocation rules specified in
@@ -3131,7 +3131,7 @@ module Aws::RDS
3131
3131
  # db_security_groups: ["String"],
3132
3132
  # vpc_security_group_ids: ["String"],
3133
3133
  # apply_immediately: false,
3134
- # master_user_password: "String",
3134
+ # master_user_password: "SensitiveString",
3135
3135
  # db_parameter_group_name: "String",
3136
3136
  # backup_retention_period: 1,
3137
3137
  # preferred_backup_window: "String",
@@ -3142,24 +3142,25 @@ module Aws::RDS
3142
3142
  # auto_minor_version_upgrade: false,
3143
3143
  # license_model: "String",
3144
3144
  # iops: 1,
3145
+ # storage_throughput: 1,
3145
3146
  # option_group_name: "String",
3146
3147
  # new_db_instance_identifier: "String",
3147
3148
  # storage_type: "String",
3148
3149
  # tde_credential_arn: "String",
3149
- # tde_credential_password: "String",
3150
+ # tde_credential_password: "SensitiveString",
3150
3151
  # ca_certificate_identifier: "String",
3151
3152
  # domain: "String",
3152
3153
  # domain_fqdn: "String",
3153
3154
  # domain_ou: "String",
3154
3155
  # domain_auth_secret_arn: "String",
3155
3156
  # domain_dns_ips: ["String"],
3157
+ # disable_domain: false,
3156
3158
  # copy_tags_to_snapshot: false,
3157
3159
  # monitoring_interval: 1,
3158
3160
  # db_port_number: 1,
3159
3161
  # publicly_accessible: false,
3160
3162
  # monitoring_role_arn: "String",
3161
3163
  # domain_iam_role_name: "String",
3162
- # disable_domain: false,
3163
3164
  # promotion_tier: 1,
3164
3165
  # enable_iam_database_authentication: false,
3165
3166
  # database_insights_mode: "standard", # accepts standard, advanced
@@ -3181,18 +3182,17 @@ module Aws::RDS
3181
3182
  # max_allocated_storage: 1,
3182
3183
  # certificate_rotation_restart: false,
3183
3184
  # replica_mode: "open-read-only", # accepts open-read-only, mounted
3184
- # enable_customer_owned_ip: false,
3185
- # aws_backup_recovery_point_arn: "AwsBackupRecoveryPointArn",
3186
3185
  # automation_mode: "full", # accepts full, all-paused
3187
3186
  # resume_full_automation_mode_minutes: 1,
3187
+ # enable_customer_owned_ip: false,
3188
3188
  # network_type: "String",
3189
- # storage_throughput: 1,
3189
+ # aws_backup_recovery_point_arn: "AwsBackupRecoveryPointArn",
3190
3190
  # manage_master_user_password: false,
3191
3191
  # rotate_master_user_password: false,
3192
3192
  # master_user_secret_kms_key_id: "String",
3193
- # engine: "String",
3194
- # dedicated_log_volume: false,
3195
3193
  # multi_tenant: false,
3194
+ # dedicated_log_volume: false,
3195
+ # engine: "String",
3196
3196
  # master_user_authentication_type: "password", # accepts password, iam-db-auth
3197
3197
  # })
3198
3198
  # @param [Hash] options ({})
@@ -3617,6 +3617,13 @@ module Aws::RDS
3617
3617
  # `AllocatedStorage`.
3618
3618
  #
3619
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.
3620
3627
  # @option options [String] :option_group_name
3621
3628
  # The option group to associate the DB instance with.
3622
3629
  #
@@ -3758,6 +3765,9 @@ module Aws::RDS
3758
3765
  # ^
3759
3766
  #
3760
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.
3761
3771
  # @option options [Boolean] :copy_tags_to_snapshot
3762
3772
  # Specifies whether to copy all tags from the DB instance to snapshots
3763
3773
  # of the DB instance. By default, tags aren't copied.
@@ -3856,9 +3866,6 @@ module Aws::RDS
3856
3866
  # Service.
3857
3867
  #
3858
3868
  # This setting doesn't apply to RDS Custom DB instances.
3859
- # @option options [Boolean] :disable_domain
3860
- # Specifies whether to remove the DB instance from the Active Directory
3861
- # domain.
3862
3869
  # @option options [Integer] :promotion_tier
3863
3870
  # The order of priority in which an Aurora Replica is promoted to the
3864
3871
  # primary instance after a failure of the existing primary instance. For
@@ -4085,6 +4092,22 @@ module Aws::RDS
4085
4092
  #
4086
4093
  # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/db2-replication.html
4087
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.
4088
4111
  # @option options [Boolean] :enable_customer_owned_ip
4089
4112
  # Specifies whether to enable a customer-owned IP address (CoIP) for an
4090
4113
  # RDS on Outposts DB instance.
@@ -4105,27 +4128,6 @@ module Aws::RDS
4105
4128
  #
4106
4129
  # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html
4107
4130
  # [2]: https://docs.aws.amazon.com/outposts/latest/userguide/routing.html#ip-addressing
4108
- # @option options [String] :aws_backup_recovery_point_arn
4109
- # The Amazon Resource Name (ARN) of the recovery point in Amazon Web
4110
- # Services Backup.
4111
- #
4112
- # This setting doesn't apply to RDS Custom DB instances.
4113
- # @option options [String] :automation_mode
4114
- # The automation mode of the RDS Custom DB instance. If `full`, the DB
4115
- # instance automates monitoring and instance recovery. If `all paused`,
4116
- # the instance pauses automation for the duration set by
4117
- # `ResumeFullAutomationModeMinutes`.
4118
- # @option options [Integer] :resume_full_automation_mode_minutes
4119
- # The number of minutes to pause the automation. When the time period
4120
- # ends, RDS Custom resumes full automation.
4121
- #
4122
- # Default: `60`
4123
- #
4124
- # Constraints:
4125
- #
4126
- # * Must be at least 60.
4127
- #
4128
- # * Must be no more than 1,440.
4129
4131
  # @option options [String] :network_type
4130
4132
  # The network type of the DB instance.
4131
4133
  #
@@ -4141,13 +4143,11 @@ module Aws::RDS
4141
4143
  #
4142
4144
  #
4143
4145
  # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html
4144
- # @option options [Integer] :storage_throughput
4145
- # The storage throughput value for the DB instance.
4146
- #
4147
- # 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.
4148
4149
  #
4149
- # This setting doesn't apply to Amazon Aurora or RDS Custom DB
4150
- # instances.
4150
+ # This setting doesn't apply to RDS Custom DB instances.
4151
4151
  # @option options [Boolean] :manage_master_user_password
4152
4152
  # Specifies whether to manage the master user password with Amazon Web
4153
4153
  # Services Secrets Manager.
@@ -4234,6 +4234,25 @@ module Aws::RDS
4234
4234
  # There is a default KMS key for your Amazon Web Services account. Your
4235
4235
  # Amazon Web Services account has a different default KMS key for each
4236
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.
4237
4256
  # @option options [String] :engine
4238
4257
  # The target Oracle DB engine when you convert a non-CDB to a CDB. This
4239
4258
  # intermediate step is necessary to upgrade an Oracle Database 19c
@@ -4261,25 +4280,6 @@ module Aws::RDS
4261
4280
  # parameter group. To avoid reverting to the default, specify a new
4262
4281
  # parameter group with `--db-parameter-group-name` and a new option
4263
4282
  # group with `--option-group-name`.
4264
- # @option options [Boolean] :dedicated_log_volume
4265
- # Indicates whether the DB instance has a dedicated log volume (DLV)
4266
- # enabled.
4267
- # @option options [Boolean] :multi_tenant
4268
- # Specifies whether the to convert your DB instance from the
4269
- # single-tenant configuration to the multi-tenant configuration. This
4270
- # parameter is supported only for RDS for Oracle CDB instances.
4271
- #
4272
- # During the conversion, RDS creates an initial tenant database and
4273
- # associates the DB name, master user name, character set, and national
4274
- # character set metadata with this database. The tags associated with
4275
- # the instance also propagate to the initial tenant database. You can
4276
- # add more tenant databases to your DB instance by using the
4277
- # `CreateTenantDatabase` operation.
4278
- #
4279
- # The conversion to the multi-tenant configuration is permanent and
4280
- # irreversible, so you can't later convert back to the single-tenant
4281
- # configuration. When you specify this parameter, you must also specify
4282
- # `ApplyImmediately`.
4283
4283
  # @option options [String] :master_user_authentication_type
4284
4284
  # Specifies the authentication type for the master user. With IAM master
4285
4285
  # user authentication, you can change the master DB user to use IAM
@@ -4402,6 +4402,7 @@ module Aws::RDS
4402
4402
  # db_name: "String",
4403
4403
  # engine: "String",
4404
4404
  # iops: 1,
4405
+ # storage_throughput: 1,
4405
4406
  # option_group_name: "String",
4406
4407
  # copy_tags_to_snapshot: false,
4407
4408
  # tags: [
@@ -4412,7 +4413,7 @@ module Aws::RDS
4412
4413
  # ],
4413
4414
  # storage_type: "String",
4414
4415
  # tde_credential_arn: "String",
4415
- # tde_credential_password: "String",
4416
+ # tde_credential_password: "SensitiveString",
4416
4417
  # vpc_security_group_ids: ["String"],
4417
4418
  # domain: "String",
4418
4419
  # domain_iam_role_name: "String",
@@ -4433,12 +4434,11 @@ module Aws::RDS
4433
4434
  # deletion_protection: false,
4434
4435
  # source_dbi_resource_id: "String",
4435
4436
  # max_allocated_storage: 1,
4436
- # source_db_instance_automated_backups_arn: "String",
4437
4437
  # enable_customer_owned_ip: false,
4438
- # custom_iam_instance_profile: "String",
4439
- # backup_target: "String",
4440
4438
  # network_type: "String",
4441
- # storage_throughput: 1,
4439
+ # source_db_instance_automated_backups_arn: "String",
4440
+ # backup_target: "String",
4441
+ # custom_iam_instance_profile: "String",
4442
4442
  # allocated_storage: 1,
4443
4443
  # dedicated_log_volume: false,
4444
4444
  # ca_certificate_identifier: "String",
@@ -4661,6 +4661,10 @@ module Aws::RDS
4661
4661
  # * Must be an integer greater than 1000.
4662
4662
  #
4663
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.
4664
4668
  # @option options [String] :option_group_name
4665
4669
  # The name of the option group to use for the restored DB instance.
4666
4670
  #
@@ -4854,12 +4858,6 @@ module Aws::RDS
4854
4858
  #
4855
4859
  #
4856
4860
  # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIOPS.StorageTypes.html#USER_PIOPS.Autoscaling
4857
- # @option options [String] :source_db_instance_automated_backups_arn
4858
- # The Amazon Resource Name (ARN) of the replicated automated backups
4859
- # from which to restore, for example,
4860
- # `arn:aws:rds:us-east-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE`.
4861
- #
4862
- # This setting doesn't apply to RDS Custom.
4863
4861
  # @option options [Boolean] :enable_customer_owned_ip
4864
4862
  # Specifies whether to enable a customer-owned IP address (CoIP) for an
4865
4863
  # RDS on Outposts DB instance.
@@ -4882,27 +4880,31 @@ module Aws::RDS
4882
4880
  #
4883
4881
  # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html
4884
4882
  # [2]: https://docs.aws.amazon.com/outposts/latest/userguide/routing.html#ip-addressing
4885
- # @option options [String] :custom_iam_instance_profile
4886
- # The instance profile associated with the underlying Amazon EC2
4887
- # instance of an RDS Custom DB instance. The instance profile must meet
4888
- # the following requirements:
4883
+ # @option options [String] :network_type
4884
+ # The network type of the DB instance.
4889
4885
  #
4890
- # * The profile must exist in your account.
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`).
4891
4889
  #
4892
- # * The profile must have an IAM role that Amazon EC2 has permissions to
4893
- # assume.
4890
+ # For more information, see [ Working with a DB instance in a VPC][1] in
4891
+ # the *Amazon RDS User Guide.*
4894
4892
  #
4895
- # * The instance profile name and the associated IAM role name must
4896
- # start with the prefix `AWSRDSCustom`.
4893
+ # Valid Values:
4897
4894
  #
4898
- # For the list of permissions required for the IAM role, see [ Configure
4899
- # IAM and your VPC][1] in the *Amazon RDS User Guide*.
4895
+ # * `IPV4`
4900
4896
  #
4901
- # This setting is required for RDS Custom.
4897
+ # * `DUAL`
4902
4898
  #
4903
4899
  #
4904
4900
  #
4905
- # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-setup-orcl.html#custom-setup-orcl.iam-vpc
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.
4906
4908
  # @option options [String] :backup_target
4907
4909
  # The location for storing automated backups and manual snapshots for
4908
4910
  # the restored DB instance.
@@ -4923,29 +4925,27 @@ module Aws::RDS
4923
4925
  #
4924
4926
  #
4925
4927
  # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html
4926
- # @option options [String] :network_type
4927
- # The network type of the DB instance.
4928
- #
4929
- # The network type is determined by the `DBSubnetGroup` specified for
4930
- # the DB instance. A `DBSubnetGroup` can support only the IPv4 protocol
4931
- # 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:
4932
4932
  #
4933
- # For more information, see [ Working with a DB instance in a VPC][1] in
4934
- # the *Amazon RDS User Guide.*
4933
+ # * The profile must exist in your account.
4935
4934
  #
4936
- # Valid Values:
4935
+ # * The profile must have an IAM role that Amazon EC2 has permissions to
4936
+ # assume.
4937
4937
  #
4938
- # * `IPV4`
4938
+ # * The instance profile name and the associated IAM role name must
4939
+ # start with the prefix `AWSRDSCustom`.
4939
4940
  #
4940
- # * `DUAL`
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*.
4941
4943
  #
4944
+ # This setting is required for RDS Custom.
4942
4945
  #
4943
4946
  #
4944
- # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html
4945
- # @option options [Integer] :storage_throughput
4946
- # The storage throughput value for the DB instance.
4947
4947
  #
4948
- # This setting doesn't apply to RDS Custom or Amazon Aurora.
4948
+ # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-setup-orcl.html#custom-setup-orcl.iam-vpc
4949
4949
  # @option options [Integer] :allocated_storage
4950
4950
  # The amount of storage (in gibibytes) to allocate initially for the DB
4951
4951
  # instance. Follow the allocation rules specified in `CreateDBInstance`.