aws-sdk-rds 1.293.0 → 1.295.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-rds/client.rb +1368 -1389
- data/lib/aws-sdk-rds/client_api.rb +202 -158
- data/lib/aws-sdk-rds/db_cluster.rb +340 -349
- data/lib/aws-sdk-rds/db_cluster_parameter_group.rb +2 -2
- data/lib/aws-sdk-rds/db_cluster_snapshot.rb +25 -25
- data/lib/aws-sdk-rds/db_engine_version.rb +55 -55
- data/lib/aws-sdk-rds/db_instance.rb +300 -309
- data/lib/aws-sdk-rds/db_parameter_group.rb +2 -2
- data/lib/aws-sdk-rds/db_snapshot.rb +74 -74
- data/lib/aws-sdk-rds/endpoint_parameters.rb +4 -4
- data/lib/aws-sdk-rds/option_group.rb +1 -1
- data/lib/aws-sdk-rds/resource.rb +210 -228
- data/lib/aws-sdk-rds/types.rb +1040 -1061
- data/lib/aws-sdk-rds.rb +1 -1
- data/sig/client.rbs +100 -100
- data/sig/db_cluster.rbs +65 -65
- data/sig/db_cluster_snapshot.rbs +6 -6
- data/sig/db_engine_version.rbs +21 -21
- data/sig/db_instance.rbs +44 -44
- data/sig/db_snapshot.rbs +14 -14
- data/sig/event.rbs +1 -1
- data/sig/resource.rbs +21 -21
- data/sig/types.rbs +120 -120
- metadata +1 -1
@@ -60,12 +60,6 @@ module Aws::RDS
|
|
60
60
|
data[:db_instance_status]
|
61
61
|
end
|
62
62
|
|
63
|
-
# The time when a stopped DB instance is restarted automatically.
|
64
|
-
# @return [Time]
|
65
|
-
def automatic_restart_time
|
66
|
-
data[:automatic_restart_time]
|
67
|
-
end
|
68
|
-
|
69
63
|
# The master username for the DB instance.
|
70
64
|
# @return [String]
|
71
65
|
def master_username
|
@@ -260,6 +254,14 @@ module Aws::RDS
|
|
260
254
|
data[:iops]
|
261
255
|
end
|
262
256
|
|
257
|
+
# The storage throughput for the DB instance.
|
258
|
+
#
|
259
|
+
# This setting applies only to the `gp3` storage type.
|
260
|
+
# @return [Integer]
|
261
|
+
def storage_throughput
|
262
|
+
data[:storage_throughput]
|
263
|
+
end
|
264
|
+
|
263
265
|
# The list of option group memberships for this DB instance.
|
264
266
|
# @return [Array<Types::OptionGroupMembership>]
|
265
267
|
def option_group_memberships
|
@@ -580,11 +582,21 @@ module Aws::RDS
|
|
580
582
|
data[:tag_list]
|
581
583
|
end
|
582
584
|
|
583
|
-
# The
|
584
|
-
# instance
|
585
|
-
#
|
586
|
-
|
587
|
-
|
585
|
+
# The automation mode of the RDS Custom DB instance: `full` or `all
|
586
|
+
# paused`. If `full`, the DB instance automates monitoring and instance
|
587
|
+
# recovery. If `all paused`, the instance pauses automation for the
|
588
|
+
# duration set by `--resume-full-automation-mode-minutes`.
|
589
|
+
# @return [String]
|
590
|
+
def automation_mode
|
591
|
+
data[:automation_mode]
|
592
|
+
end
|
593
|
+
|
594
|
+
# The number of minutes to pause the automation. When the time period
|
595
|
+
# ends, RDS Custom resumes full automation. The minimum value is 60
|
596
|
+
# (default). The maximum value is 1,440.
|
597
|
+
# @return [Time]
|
598
|
+
def resume_full_automation_mode_time
|
599
|
+
data[:resume_full_automation_mode_time]
|
588
600
|
end
|
589
601
|
|
590
602
|
# Indicates whether a customer-owned IP address (CoIP) is enabled for an
|
@@ -612,11 +624,25 @@ module Aws::RDS
|
|
612
624
|
data[:customer_owned_ip_enabled]
|
613
625
|
end
|
614
626
|
|
615
|
-
# The
|
616
|
-
#
|
627
|
+
# The network type of the DB instance.
|
628
|
+
#
|
629
|
+
# The network type is determined by the `DBSubnetGroup` specified for
|
630
|
+
# the DB instance. A `DBSubnetGroup` can support only the IPv4 protocol
|
631
|
+
# or the IPv4 and the IPv6 protocols (`DUAL`).
|
632
|
+
#
|
633
|
+
# For more information, see [ Working with a DB instance in a VPC][1] in
|
634
|
+
# the *Amazon RDS User Guide* and [ Working with a DB instance in a
|
635
|
+
# VPC][2] in the *Amazon Aurora User Guide.*
|
636
|
+
#
|
637
|
+
# Valid Values: `IPV4 | DUAL`
|
638
|
+
#
|
639
|
+
#
|
640
|
+
#
|
641
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html
|
642
|
+
# [2]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html
|
617
643
|
# @return [String]
|
618
|
-
def
|
619
|
-
data[:
|
644
|
+
def network_type
|
645
|
+
data[:network_type]
|
620
646
|
end
|
621
647
|
|
622
648
|
# The status of the database activity stream.
|
@@ -656,21 +682,32 @@ module Aws::RDS
|
|
656
682
|
data[:activity_stream_engine_native_audit_fields_included]
|
657
683
|
end
|
658
684
|
|
659
|
-
# The
|
660
|
-
#
|
661
|
-
# recovery. If `all paused`, the instance pauses automation for the
|
662
|
-
# duration set by `--resume-full-automation-mode-minutes`.
|
685
|
+
# The Amazon Resource Name (ARN) of the recovery point in Amazon Web
|
686
|
+
# Services Backup.
|
663
687
|
# @return [String]
|
664
|
-
def
|
665
|
-
data[:
|
688
|
+
def aws_backup_recovery_point_arn
|
689
|
+
data[:aws_backup_recovery_point_arn]
|
666
690
|
end
|
667
691
|
|
668
|
-
# The
|
669
|
-
#
|
670
|
-
#
|
692
|
+
# The list of replicated automated backups associated with the DB
|
693
|
+
# instance.
|
694
|
+
# @return [Array<Types::DBInstanceAutomatedBackupsReplication>]
|
695
|
+
def db_instance_automated_backups_replications
|
696
|
+
data[:db_instance_automated_backups_replications]
|
697
|
+
end
|
698
|
+
|
699
|
+
# The location where automated backups and manual snapshots are stored:
|
700
|
+
# Dedicated Local Zones, Amazon Web Services Outposts or the Amazon Web
|
701
|
+
# Services Region.
|
702
|
+
# @return [String]
|
703
|
+
def backup_target
|
704
|
+
data[:backup_target]
|
705
|
+
end
|
706
|
+
|
707
|
+
# The time when a stopped DB instance is restarted automatically.
|
671
708
|
# @return [Time]
|
672
|
-
def
|
673
|
-
data[:
|
709
|
+
def automatic_restart_time
|
710
|
+
data[:automatic_restart_time]
|
674
711
|
end
|
675
712
|
|
676
713
|
# The instance profile associated with the underlying Amazon EC2
|
@@ -696,47 +733,16 @@ module Aws::RDS
|
|
696
733
|
data[:custom_iam_instance_profile]
|
697
734
|
end
|
698
735
|
|
699
|
-
# The location where automated backups and manual snapshots are stored:
|
700
|
-
# Dedicated Local Zones, Amazon Web Services Outposts or the Amazon Web
|
701
|
-
# Services Region.
|
702
|
-
# @return [String]
|
703
|
-
def backup_target
|
704
|
-
data[:backup_target]
|
705
|
-
end
|
706
|
-
|
707
|
-
# The network type of the DB instance.
|
708
|
-
#
|
709
|
-
# The network type is determined by the `DBSubnetGroup` specified for
|
710
|
-
# the DB instance. A `DBSubnetGroup` can support only the IPv4 protocol
|
711
|
-
# or the IPv4 and the IPv6 protocols (`DUAL`).
|
712
|
-
#
|
713
|
-
# For more information, see [ Working with a DB instance in a VPC][1] in
|
714
|
-
# the *Amazon RDS User Guide* and [ Working with a DB instance in a
|
715
|
-
# VPC][2] in the *Amazon Aurora User Guide.*
|
716
|
-
#
|
717
|
-
# Valid Values: `IPV4 | DUAL`
|
718
|
-
#
|
719
|
-
#
|
720
|
-
#
|
721
|
-
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html
|
722
|
-
# [2]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html
|
723
|
-
# @return [String]
|
724
|
-
def network_type
|
725
|
-
data[:network_type]
|
726
|
-
end
|
727
|
-
|
728
736
|
# The status of the policy state of the activity stream.
|
729
737
|
# @return [String]
|
730
738
|
def activity_stream_policy_status
|
731
739
|
data[:activity_stream_policy_status]
|
732
740
|
end
|
733
741
|
|
734
|
-
# The
|
735
|
-
#
|
736
|
-
|
737
|
-
|
738
|
-
def storage_throughput
|
739
|
-
data[:storage_throughput]
|
742
|
+
# The details of the DB instance's server certificate.
|
743
|
+
# @return [Types::CertificateDetails]
|
744
|
+
def certificate_details
|
745
|
+
data[:certificate_details]
|
740
746
|
end
|
741
747
|
|
742
748
|
# The Oracle system ID (Oracle SID) for a container database (CDB). The
|
@@ -761,12 +767,6 @@ module Aws::RDS
|
|
761
767
|
data[:master_user_secret]
|
762
768
|
end
|
763
769
|
|
764
|
-
# The details of the DB instance's server certificate.
|
765
|
-
# @return [Types::CertificateDetails]
|
766
|
-
def certificate_details
|
767
|
-
data[:certificate_details]
|
768
|
-
end
|
769
|
-
|
770
770
|
# The identifier of the source DB cluster if this DB instance is a read
|
771
771
|
# replica.
|
772
772
|
# @return [String]
|
@@ -780,6 +780,13 @@ module Aws::RDS
|
|
780
780
|
data[:percent_progress]
|
781
781
|
end
|
782
782
|
|
783
|
+
# Specifies whether the DB instance is in the multi-tenant configuration
|
784
|
+
# (TRUE) or the single-tenant configuration (FALSE).
|
785
|
+
# @return [Boolean]
|
786
|
+
def multi_tenant
|
787
|
+
data[:multi_tenant]
|
788
|
+
end
|
789
|
+
|
783
790
|
# Indicates whether the DB instance has a dedicated log volume (DLV)
|
784
791
|
# enabled.
|
785
792
|
# @return [Boolean]
|
@@ -801,13 +808,6 @@ module Aws::RDS
|
|
801
808
|
data[:is_storage_config_upgrade_available]
|
802
809
|
end
|
803
810
|
|
804
|
-
# Specifies whether the DB instance is in the multi-tenant configuration
|
805
|
-
# (TRUE) or the single-tenant configuration (FALSE).
|
806
|
-
# @return [Boolean]
|
807
|
-
def multi_tenant
|
808
|
-
data[:multi_tenant]
|
809
|
-
end
|
810
|
-
|
811
811
|
# The lifecycle type for the DB instance.
|
812
812
|
#
|
813
813
|
# For more information, see CreateDBInstance.
|
@@ -962,7 +962,7 @@ module Aws::RDS
|
|
962
962
|
# db_instance_class: "String", # required
|
963
963
|
# engine: "String", # required
|
964
964
|
# master_username: "String",
|
965
|
-
# master_user_password: "
|
965
|
+
# master_user_password: "SensitiveString",
|
966
966
|
# db_security_groups: ["String"],
|
967
967
|
# vpc_security_group_ids: ["String"],
|
968
968
|
# availability_zone: "String",
|
@@ -977,6 +977,7 @@ module Aws::RDS
|
|
977
977
|
# auto_minor_version_upgrade: false,
|
978
978
|
# license_model: "String",
|
979
979
|
# iops: 1,
|
980
|
+
# storage_throughput: 1,
|
980
981
|
# option_group_name: "String",
|
981
982
|
# character_set_name: "String",
|
982
983
|
# nchar_character_set_name: "String",
|
@@ -990,7 +991,7 @@ module Aws::RDS
|
|
990
991
|
# db_cluster_identifier: "String",
|
991
992
|
# storage_type: "String",
|
992
993
|
# tde_credential_arn: "String",
|
993
|
-
# tde_credential_password: "
|
994
|
+
# tde_credential_password: "SensitiveString",
|
994
995
|
# storage_encrypted: false,
|
995
996
|
# kms_key_id: "String",
|
996
997
|
# domain: "String",
|
@@ -1019,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
|
-
#
|
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
|
#
|
@@ -1721,37 +1729,28 @@ module Aws::RDS
|
|
1721
1729
|
# Specifies whether the DB instance is publicly accessible.
|
1722
1730
|
#
|
1723
1731
|
# When the DB instance is publicly accessible and you connect from
|
1724
|
-
# outside of the DB instance's virtual private cloud (VPC), its
|
1725
|
-
#
|
1732
|
+
# outside of the DB instance's virtual private cloud (VPC), its domain
|
1733
|
+
# name system (DNS) endpoint resolves to the public IP address. When you
|
1726
1734
|
# connect from within the same VPC as the DB instance, the endpoint
|
1727
1735
|
# resolves to the private IP address. Access to the DB instance is
|
1728
|
-
#
|
1729
|
-
# access is not permitted if the security group assigned to the DB
|
1730
|
-
# instance doesn't permit it.
|
1736
|
+
# controlled by its security group settings.
|
1731
1737
|
#
|
1732
1738
|
# When the DB instance isn't publicly accessible, it is an internal DB
|
1733
1739
|
# instance with a DNS name that resolves to a private IP address.
|
1734
1740
|
#
|
1735
|
-
#
|
1736
|
-
# `
|
1741
|
+
# The default behavior when `PubliclyAccessible` is not specified
|
1742
|
+
# depends on whether a `DBSubnetGroup` is specified.
|
1737
1743
|
#
|
1738
|
-
# If `
|
1739
|
-
#
|
1744
|
+
# If `DBSubnetGroup` isn't specified, `PubliclyAccessible` defaults to
|
1745
|
+
# `false` for Aurora instances and `true` for non-Aurora instances.
|
1740
1746
|
#
|
1741
|
-
#
|
1742
|
-
#
|
1747
|
+
# If `DBSubnetGroup` is specified, `PubliclyAccessible` defaults to
|
1748
|
+
# `false` unless the value of `DBSubnetGroup` is `default`, in which
|
1749
|
+
# case `PubliclyAccessible` defaults to `true`.
|
1743
1750
|
#
|
1744
|
-
#
|
1745
|
-
#
|
1746
|
-
#
|
1747
|
-
# If `DBSubnetGroupName` is specified, and `PubliclyAccessible` isn't
|
1748
|
-
# specified, the following applies:
|
1749
|
-
#
|
1750
|
-
# * If the subnets are part of a VPC that doesn’t have an internet
|
1751
|
-
# gateway attached to it, the DB instance is private.
|
1752
|
-
#
|
1753
|
-
# * If the subnets are part of a VPC that has an internet gateway
|
1754
|
-
# attached to it, the DB instance is public.
|
1751
|
+
# If `PubliclyAccessible` is true and the VPC that the `DBSubnetGroup`
|
1752
|
+
# is in doesn't have an internet gateway attached to it, Amazon RDS
|
1753
|
+
# returns an error.
|
1755
1754
|
# @option options [Array<Types::Tag>] :tags
|
1756
1755
|
# Tags to assign to the DB instance.
|
1757
1756
|
# @option options [String] :db_cluster_identifier
|
@@ -2095,28 +2094,21 @@ module Aws::RDS
|
|
2095
2094
|
#
|
2096
2095
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html
|
2097
2096
|
# [2]: https://docs.aws.amazon.com/outposts/latest/userguide/routing.html#ip-addressing
|
2098
|
-
# @option options [String] :
|
2099
|
-
# The
|
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.
|
2097
|
+
# @option options [String] :network_type
|
2098
|
+
# The network type of the DB instance.
|
2107
2099
|
#
|
2108
|
-
#
|
2109
|
-
#
|
2100
|
+
# The network type is determined by the `DBSubnetGroup` specified for
|
2101
|
+
# the DB instance. A `DBSubnetGroup` can support only the IPv4 protocol
|
2102
|
+
# or the IPv4 and the IPv6 protocols (`DUAL`).
|
2110
2103
|
#
|
2111
|
-
#
|
2112
|
-
#
|
2104
|
+
# For more information, see [ Working with a DB instance in a VPC][1] in
|
2105
|
+
# the *Amazon RDS User Guide.*
|
2113
2106
|
#
|
2114
|
-
#
|
2115
|
-
# IAM and your VPC][1] in the *Amazon RDS User Guide*.
|
2107
|
+
# Valid Values: `IPV4 | DUAL`
|
2116
2108
|
#
|
2117
2109
|
#
|
2118
2110
|
#
|
2119
|
-
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/
|
2111
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html
|
2120
2112
|
# @option options [String] :backup_target
|
2121
2113
|
# The location for storing automated backups and manual snapshots.
|
2122
2114
|
#
|
@@ -2136,29 +2128,50 @@ module Aws::RDS
|
|
2136
2128
|
#
|
2137
2129
|
#
|
2138
2130
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html
|
2139
|
-
# @option options [String] :
|
2140
|
-
# The
|
2131
|
+
# @option options [String] :custom_iam_instance_profile
|
2132
|
+
# The instance profile associated with the underlying Amazon EC2
|
2133
|
+
# instance of an RDS Custom DB instance.
|
2141
2134
|
#
|
2142
|
-
#
|
2143
|
-
# the DB instance. A `DBSubnetGroup` can support only the IPv4 protocol
|
2144
|
-
# or the IPv4 and the IPv6 protocols (`DUAL`).
|
2135
|
+
# This setting is required for RDS Custom.
|
2145
2136
|
#
|
2146
|
-
#
|
2147
|
-
# the *Amazon RDS User Guide.*
|
2137
|
+
# Constraints:
|
2148
2138
|
#
|
2149
|
-
#
|
2139
|
+
# * The profile must exist in your account.
|
2150
2140
|
#
|
2141
|
+
# * The profile must have an IAM role that Amazon EC2 has permissions to
|
2142
|
+
# assume.
|
2151
2143
|
#
|
2144
|
+
# * The instance profile name and the associated IAM role name must
|
2145
|
+
# start with the prefix `AWSRDSCustom`.
|
2152
2146
|
#
|
2153
|
-
# [
|
2154
|
-
#
|
2155
|
-
# The storage throughput value, in mebibyte per second (MiBps), for the
|
2156
|
-
# DB instance.
|
2147
|
+
# For the list of permissions required for the IAM role, see [ Configure
|
2148
|
+
# IAM and your VPC][1] in the *Amazon RDS User Guide*.
|
2157
2149
|
#
|
2158
|
-
# This setting applies only to the `gp3` storage type.
|
2159
2150
|
#
|
2160
|
-
#
|
2161
|
-
#
|
2151
|
+
#
|
2152
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-setup-orcl.html#custom-setup-orcl.iam-vpc
|
2153
|
+
# @option options [String] :db_system_id
|
2154
|
+
# The Oracle system identifier (SID), which is the name of the Oracle
|
2155
|
+
# database instance that manages your database files. In this context,
|
2156
|
+
# the term "Oracle database instance" refers exclusively to the system
|
2157
|
+
# global area (SGA) and Oracle background processes. If you don't
|
2158
|
+
# specify a SID, the value defaults to `RDSCDB`. The Oracle SID is also
|
2159
|
+
# the name of your CDB.
|
2160
|
+
# @option options [String] :ca_certificate_identifier
|
2161
|
+
# The CA certificate identifier to use for the DB instance's server
|
2162
|
+
# certificate.
|
2163
|
+
#
|
2164
|
+
# This setting doesn't apply to RDS Custom DB instances.
|
2165
|
+
#
|
2166
|
+
# For more information, see [Using SSL/TLS to encrypt a connection to a
|
2167
|
+
# DB instance][1] in the *Amazon RDS User Guide* and [ Using SSL/TLS to
|
2168
|
+
# encrypt a connection to a DB cluster][2] in the *Amazon Aurora User
|
2169
|
+
# Guide*.
|
2170
|
+
#
|
2171
|
+
#
|
2172
|
+
#
|
2173
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL.html
|
2174
|
+
# [2]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL.html
|
2162
2175
|
# @option options [Boolean] :manage_master_user_password
|
2163
2176
|
# Specifies whether to manage the master user password with Amazon Web
|
2164
2177
|
# Services Secrets Manager.
|
@@ -2198,31 +2211,6 @@ module Aws::RDS
|
|
2198
2211
|
# There is a default KMS key for your Amazon Web Services account. Your
|
2199
2212
|
# Amazon Web Services account has a different default KMS key for each
|
2200
2213
|
# 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.
|
2204
|
-
#
|
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
2214
|
# @option options [Boolean] :multi_tenant
|
2227
2215
|
# Specifies whether to use the multi-tenant configuration or the
|
2228
2216
|
# single-tenant configuration (default). This parameter only applies to
|
@@ -2238,6 +2226,9 @@ module Aws::RDS
|
|
2238
2226
|
# * If you specify the multi-tenant configuration when you create your
|
2239
2227
|
# DB instance, you can't later modify this DB instance to use the
|
2240
2228
|
# single-tenant configuration.
|
2229
|
+
# @option options [Boolean] :dedicated_log_volume
|
2230
|
+
# Indicates whether the DB instance has a dedicated log volume (DLV)
|
2231
|
+
# enabled.
|
2241
2232
|
# @option options [String] :engine_lifecycle_support
|
2242
2233
|
# The life cycle type for this DB instance.
|
2243
2234
|
#
|
@@ -2305,6 +2296,7 @@ module Aws::RDS
|
|
2305
2296
|
# multi_az: false,
|
2306
2297
|
# auto_minor_version_upgrade: false,
|
2307
2298
|
# iops: 1,
|
2299
|
+
# storage_throughput: 1,
|
2308
2300
|
# option_group_name: "String",
|
2309
2301
|
# db_parameter_group_name: "String",
|
2310
2302
|
# publicly_accessible: false,
|
@@ -2321,7 +2313,7 @@ module Aws::RDS
|
|
2321
2313
|
# monitoring_interval: 1,
|
2322
2314
|
# monitoring_role_arn: "String",
|
2323
2315
|
# kms_key_id: "String",
|
2324
|
-
# pre_signed_url: "
|
2316
|
+
# pre_signed_url: "SensitiveString",
|
2325
2317
|
# enable_iam_database_authentication: false,
|
2326
2318
|
# database_insights_mode: "standard", # accepts standard, advanced
|
2327
2319
|
# enable_performance_insights: false,
|
@@ -2343,12 +2335,11 @@ module Aws::RDS
|
|
2343
2335
|
# domain_auth_secret_arn: "String",
|
2344
2336
|
# domain_dns_ips: ["String"],
|
2345
2337
|
# 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
2338
|
# enable_customer_owned_ip: false,
|
2339
|
+
# network_type: "String",
|
2340
|
+
# max_allocated_storage: 1,
|
2351
2341
|
# backup_target: "String",
|
2342
|
+
# custom_iam_instance_profile: "String",
|
2352
2343
|
# allocated_storage: 1,
|
2353
2344
|
# source_db_cluster_identifier: "String",
|
2354
2345
|
# dedicated_log_volume: false,
|
@@ -2413,6 +2404,11 @@ module Aws::RDS
|
|
2413
2404
|
# @option options [Integer] :iops
|
2414
2405
|
# The amount of Provisioned IOPS (input/output operations per second) to
|
2415
2406
|
# initially allocate for the DB instance.
|
2407
|
+
# @option options [Integer] :storage_throughput
|
2408
|
+
# Specifies the storage throughput value for the read replica.
|
2409
|
+
#
|
2410
|
+
# This setting doesn't apply to RDS Custom or Amazon Aurora DB
|
2411
|
+
# instances.
|
2416
2412
|
# @option options [String] :option_group_name
|
2417
2413
|
# The option group to associate the DB instance with. If not specified,
|
2418
2414
|
# RDS uses the option group associated with the source DB instance or
|
@@ -2855,38 +2851,26 @@ module Aws::RDS
|
|
2855
2851
|
#
|
2856
2852
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/db2-replication.html
|
2857
2853
|
# [2]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-read-replicas.html
|
2858
|
-
# @option options [
|
2859
|
-
#
|
2860
|
-
#
|
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.
|
2854
|
+
# @option options [Boolean] :enable_customer_owned_ip
|
2855
|
+
# Specifies whether to enable a customer-owned IP address (CoIP) for an
|
2856
|
+
# RDS on Outposts read replica.
|
2878
2857
|
#
|
2879
|
-
# *
|
2880
|
-
#
|
2858
|
+
# A *CoIP* provides local or external connectivity to resources in your
|
2859
|
+
# Outpost subnets through your on-premises network. For some use cases,
|
2860
|
+
# a CoIP can provide lower latency for connections to the read replica
|
2861
|
+
# from outside of its virtual private cloud (VPC) on your local network.
|
2881
2862
|
#
|
2882
|
-
# For
|
2883
|
-
#
|
2863
|
+
# For more information about RDS on Outposts, see [Working with Amazon
|
2864
|
+
# RDS on Amazon Web Services Outposts][1] in the *Amazon RDS User
|
2865
|
+
# Guide*.
|
2884
2866
|
#
|
2885
|
-
#
|
2867
|
+
# For more information about CoIPs, see [Customer-owned IP addresses][2]
|
2868
|
+
# in the *Amazon Web Services Outposts User Guide*.
|
2886
2869
|
#
|
2887
2870
|
#
|
2888
2871
|
#
|
2889
|
-
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/
|
2872
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html
|
2873
|
+
# [2]: https://docs.aws.amazon.com/outposts/latest/userguide/routing.html#ip-addressing
|
2890
2874
|
# @option options [String] :network_type
|
2891
2875
|
# The network type of the DB instance.
|
2892
2876
|
#
|
@@ -2906,31 +2890,17 @@ module Aws::RDS
|
|
2906
2890
|
#
|
2907
2891
|
#
|
2908
2892
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html
|
2909
|
-
# @option options [Integer] :
|
2910
|
-
#
|
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*.
|
2893
|
+
# @option options [Integer] :max_allocated_storage
|
2894
|
+
# The upper limit in gibibytes (GiB) to which Amazon RDS can
|
2895
|
+
# automatically scale the storage of the DB instance.
|
2926
2896
|
#
|
2927
|
-
# For more information about
|
2928
|
-
#
|
2897
|
+
# For more information about this setting, including limitations that
|
2898
|
+
# apply to it, see [ Managing capacity automatically with Amazon RDS
|
2899
|
+
# storage autoscaling][1] in the *Amazon RDS User Guide*.
|
2929
2900
|
#
|
2930
2901
|
#
|
2931
2902
|
#
|
2932
|
-
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/
|
2933
|
-
# [2]: https://docs.aws.amazon.com/outposts/latest/userguide/routing.html#ip-addressing
|
2903
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIOPS.StorageTypes.html#USER_PIOPS.Autoscaling
|
2934
2904
|
# @option options [String] :backup_target
|
2935
2905
|
# The location where RDS stores automated backups and manual snapshots.
|
2936
2906
|
#
|
@@ -2939,6 +2909,27 @@ module Aws::RDS
|
|
2939
2909
|
# * `local` for Dedicated Local Zones
|
2940
2910
|
#
|
2941
2911
|
# * `region` for Amazon Web Services Region
|
2912
|
+
# @option options [String] :custom_iam_instance_profile
|
2913
|
+
# The instance profile associated with the underlying Amazon EC2
|
2914
|
+
# instance of an RDS Custom DB instance. The instance profile must meet
|
2915
|
+
# the following requirements:
|
2916
|
+
#
|
2917
|
+
# * The profile must exist in your account.
|
2918
|
+
#
|
2919
|
+
# * The profile must have an IAM role that Amazon EC2 has permissions to
|
2920
|
+
# assume.
|
2921
|
+
#
|
2922
|
+
# * The instance profile name and the associated IAM role name must
|
2923
|
+
# start with the prefix `AWSRDSCustom`.
|
2924
|
+
#
|
2925
|
+
# For the list of permissions required for the IAM role, see [ Configure
|
2926
|
+
# IAM and your VPC][1] in the *Amazon RDS User Guide*.
|
2927
|
+
#
|
2928
|
+
# This setting is required for RDS Custom DB instances.
|
2929
|
+
#
|
2930
|
+
#
|
2931
|
+
#
|
2932
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-setup-orcl.html#custom-setup-orcl.iam-vpc
|
2942
2933
|
# @option options [Integer] :allocated_storage
|
2943
2934
|
# The amount of storage (in gibibytes) to allocate initially for the
|
2944
2935
|
# read replica. Follow the allocation rules specified in
|
@@ -3131,7 +3122,7 @@ module Aws::RDS
|
|
3131
3122
|
# db_security_groups: ["String"],
|
3132
3123
|
# vpc_security_group_ids: ["String"],
|
3133
3124
|
# apply_immediately: false,
|
3134
|
-
# master_user_password: "
|
3125
|
+
# master_user_password: "SensitiveString",
|
3135
3126
|
# db_parameter_group_name: "String",
|
3136
3127
|
# backup_retention_period: 1,
|
3137
3128
|
# preferred_backup_window: "String",
|
@@ -3142,24 +3133,25 @@ module Aws::RDS
|
|
3142
3133
|
# auto_minor_version_upgrade: false,
|
3143
3134
|
# license_model: "String",
|
3144
3135
|
# iops: 1,
|
3136
|
+
# storage_throughput: 1,
|
3145
3137
|
# option_group_name: "String",
|
3146
3138
|
# new_db_instance_identifier: "String",
|
3147
3139
|
# storage_type: "String",
|
3148
3140
|
# tde_credential_arn: "String",
|
3149
|
-
# tde_credential_password: "
|
3141
|
+
# tde_credential_password: "SensitiveString",
|
3150
3142
|
# ca_certificate_identifier: "String",
|
3151
3143
|
# domain: "String",
|
3152
3144
|
# domain_fqdn: "String",
|
3153
3145
|
# domain_ou: "String",
|
3154
3146
|
# domain_auth_secret_arn: "String",
|
3155
3147
|
# domain_dns_ips: ["String"],
|
3148
|
+
# disable_domain: false,
|
3156
3149
|
# copy_tags_to_snapshot: false,
|
3157
3150
|
# monitoring_interval: 1,
|
3158
3151
|
# db_port_number: 1,
|
3159
3152
|
# publicly_accessible: false,
|
3160
3153
|
# monitoring_role_arn: "String",
|
3161
3154
|
# domain_iam_role_name: "String",
|
3162
|
-
# disable_domain: false,
|
3163
3155
|
# promotion_tier: 1,
|
3164
3156
|
# enable_iam_database_authentication: false,
|
3165
3157
|
# database_insights_mode: "standard", # accepts standard, advanced
|
@@ -3181,18 +3173,17 @@ module Aws::RDS
|
|
3181
3173
|
# max_allocated_storage: 1,
|
3182
3174
|
# certificate_rotation_restart: false,
|
3183
3175
|
# replica_mode: "open-read-only", # accepts open-read-only, mounted
|
3184
|
-
# enable_customer_owned_ip: false,
|
3185
|
-
# aws_backup_recovery_point_arn: "AwsBackupRecoveryPointArn",
|
3186
3176
|
# automation_mode: "full", # accepts full, all-paused
|
3187
3177
|
# resume_full_automation_mode_minutes: 1,
|
3178
|
+
# enable_customer_owned_ip: false,
|
3188
3179
|
# network_type: "String",
|
3189
|
-
#
|
3180
|
+
# aws_backup_recovery_point_arn: "AwsBackupRecoveryPointArn",
|
3190
3181
|
# manage_master_user_password: false,
|
3191
3182
|
# rotate_master_user_password: false,
|
3192
3183
|
# master_user_secret_kms_key_id: "String",
|
3193
|
-
# engine: "String",
|
3194
|
-
# dedicated_log_volume: false,
|
3195
3184
|
# multi_tenant: false,
|
3185
|
+
# dedicated_log_volume: false,
|
3186
|
+
# engine: "String",
|
3196
3187
|
# master_user_authentication_type: "password", # accepts password, iam-db-auth
|
3197
3188
|
# })
|
3198
3189
|
# @param [Hash] options ({})
|
@@ -3617,6 +3608,13 @@ module Aws::RDS
|
|
3617
3608
|
# `AllocatedStorage`.
|
3618
3609
|
#
|
3619
3610
|
# Default: Uses existing setting
|
3611
|
+
# @option options [Integer] :storage_throughput
|
3612
|
+
# The storage throughput value for the DB instance.
|
3613
|
+
#
|
3614
|
+
# This setting applies only to the `gp3` storage type.
|
3615
|
+
#
|
3616
|
+
# This setting doesn't apply to Amazon Aurora or RDS Custom DB
|
3617
|
+
# instances.
|
3620
3618
|
# @option options [String] :option_group_name
|
3621
3619
|
# The option group to associate the DB instance with.
|
3622
3620
|
#
|
@@ -3735,7 +3733,7 @@ module Aws::RDS
|
|
3735
3733
|
#
|
3736
3734
|
# * Must be in the distinguished name format.
|
3737
3735
|
#
|
3738
|
-
#
|
3736
|
+
# ^
|
3739
3737
|
#
|
3740
3738
|
# Example:
|
3741
3739
|
# `OU=mymanagedADtestOU,DC=mymanagedADtest,DC=mymanagedAD,DC=mydomain`
|
@@ -3758,6 +3756,9 @@ module Aws::RDS
|
|
3758
3756
|
# ^
|
3759
3757
|
#
|
3760
3758
|
# Example: `123.124.125.126,234.235.236.237`
|
3759
|
+
# @option options [Boolean] :disable_domain
|
3760
|
+
# Specifies whether to remove the DB instance from the Active Directory
|
3761
|
+
# domain.
|
3761
3762
|
# @option options [Boolean] :copy_tags_to_snapshot
|
3762
3763
|
# Specifies whether to copy all tags from the DB instance to snapshots
|
3763
3764
|
# of the DB instance. By default, tags aren't copied.
|
@@ -3856,9 +3857,6 @@ module Aws::RDS
|
|
3856
3857
|
# Service.
|
3857
3858
|
#
|
3858
3859
|
# 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
3860
|
# @option options [Integer] :promotion_tier
|
3863
3861
|
# The order of priority in which an Aurora Replica is promoted to the
|
3864
3862
|
# primary instance after a failure of the existing primary instance. For
|
@@ -4085,6 +4083,22 @@ module Aws::RDS
|
|
4085
4083
|
#
|
4086
4084
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/db2-replication.html
|
4087
4085
|
# [2]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-read-replicas.html
|
4086
|
+
# @option options [String] :automation_mode
|
4087
|
+
# The automation mode of the RDS Custom DB instance. If `full`, the DB
|
4088
|
+
# instance automates monitoring and instance recovery. If `all paused`,
|
4089
|
+
# the instance pauses automation for the duration set by
|
4090
|
+
# `ResumeFullAutomationModeMinutes`.
|
4091
|
+
# @option options [Integer] :resume_full_automation_mode_minutes
|
4092
|
+
# The number of minutes to pause the automation. When the time period
|
4093
|
+
# ends, RDS Custom resumes full automation.
|
4094
|
+
#
|
4095
|
+
# Default: `60`
|
4096
|
+
#
|
4097
|
+
# Constraints:
|
4098
|
+
#
|
4099
|
+
# * Must be at least 60.
|
4100
|
+
#
|
4101
|
+
# * Must be no more than 1,440.
|
4088
4102
|
# @option options [Boolean] :enable_customer_owned_ip
|
4089
4103
|
# Specifies whether to enable a customer-owned IP address (CoIP) for an
|
4090
4104
|
# RDS on Outposts DB instance.
|
@@ -4105,27 +4119,6 @@ module Aws::RDS
|
|
4105
4119
|
#
|
4106
4120
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html
|
4107
4121
|
# [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
4122
|
# @option options [String] :network_type
|
4130
4123
|
# The network type of the DB instance.
|
4131
4124
|
#
|
@@ -4141,13 +4134,11 @@ module Aws::RDS
|
|
4141
4134
|
#
|
4142
4135
|
#
|
4143
4136
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html
|
4144
|
-
# @option options [
|
4145
|
-
# The
|
4146
|
-
#
|
4147
|
-
# This setting applies only to the `gp3` storage type.
|
4137
|
+
# @option options [String] :aws_backup_recovery_point_arn
|
4138
|
+
# The Amazon Resource Name (ARN) of the recovery point in Amazon Web
|
4139
|
+
# Services Backup.
|
4148
4140
|
#
|
4149
|
-
# This setting doesn't apply to
|
4150
|
-
# instances.
|
4141
|
+
# This setting doesn't apply to RDS Custom DB instances.
|
4151
4142
|
# @option options [Boolean] :manage_master_user_password
|
4152
4143
|
# Specifies whether to manage the master user password with Amazon Web
|
4153
4144
|
# Services Secrets Manager.
|
@@ -4234,6 +4225,25 @@ module Aws::RDS
|
|
4234
4225
|
# There is a default KMS key for your Amazon Web Services account. Your
|
4235
4226
|
# Amazon Web Services account has a different default KMS key for each
|
4236
4227
|
# Amazon Web Services Region.
|
4228
|
+
# @option options [Boolean] :multi_tenant
|
4229
|
+
# Specifies whether the to convert your DB instance from the
|
4230
|
+
# single-tenant configuration to the multi-tenant configuration. This
|
4231
|
+
# parameter is supported only for RDS for Oracle CDB instances.
|
4232
|
+
#
|
4233
|
+
# During the conversion, RDS creates an initial tenant database and
|
4234
|
+
# associates the DB name, master user name, character set, and national
|
4235
|
+
# character set metadata with this database. The tags associated with
|
4236
|
+
# the instance also propagate to the initial tenant database. You can
|
4237
|
+
# add more tenant databases to your DB instance by using the
|
4238
|
+
# `CreateTenantDatabase` operation.
|
4239
|
+
#
|
4240
|
+
# The conversion to the multi-tenant configuration is permanent and
|
4241
|
+
# irreversible, so you can't later convert back to the single-tenant
|
4242
|
+
# configuration. When you specify this parameter, you must also specify
|
4243
|
+
# `ApplyImmediately`.
|
4244
|
+
# @option options [Boolean] :dedicated_log_volume
|
4245
|
+
# Indicates whether the DB instance has a dedicated log volume (DLV)
|
4246
|
+
# enabled.
|
4237
4247
|
# @option options [String] :engine
|
4238
4248
|
# The target Oracle DB engine when you convert a non-CDB to a CDB. This
|
4239
4249
|
# intermediate step is necessary to upgrade an Oracle Database 19c
|
@@ -4261,25 +4271,6 @@ module Aws::RDS
|
|
4261
4271
|
# parameter group. To avoid reverting to the default, specify a new
|
4262
4272
|
# parameter group with `--db-parameter-group-name` and a new option
|
4263
4273
|
# 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
4274
|
# @option options [String] :master_user_authentication_type
|
4284
4275
|
# Specifies the authentication type for the master user. With IAM master
|
4285
4276
|
# user authentication, you can change the master DB user to use IAM
|
@@ -4402,6 +4393,7 @@ module Aws::RDS
|
|
4402
4393
|
# db_name: "String",
|
4403
4394
|
# engine: "String",
|
4404
4395
|
# iops: 1,
|
4396
|
+
# storage_throughput: 1,
|
4405
4397
|
# option_group_name: "String",
|
4406
4398
|
# copy_tags_to_snapshot: false,
|
4407
4399
|
# tags: [
|
@@ -4412,7 +4404,7 @@ module Aws::RDS
|
|
4412
4404
|
# ],
|
4413
4405
|
# storage_type: "String",
|
4414
4406
|
# tde_credential_arn: "String",
|
4415
|
-
# tde_credential_password: "
|
4407
|
+
# tde_credential_password: "SensitiveString",
|
4416
4408
|
# vpc_security_group_ids: ["String"],
|
4417
4409
|
# domain: "String",
|
4418
4410
|
# domain_iam_role_name: "String",
|
@@ -4433,12 +4425,11 @@ module Aws::RDS
|
|
4433
4425
|
# deletion_protection: false,
|
4434
4426
|
# source_dbi_resource_id: "String",
|
4435
4427
|
# max_allocated_storage: 1,
|
4436
|
-
# source_db_instance_automated_backups_arn: "String",
|
4437
4428
|
# enable_customer_owned_ip: false,
|
4438
|
-
# custom_iam_instance_profile: "String",
|
4439
|
-
# backup_target: "String",
|
4440
4429
|
# network_type: "String",
|
4441
|
-
#
|
4430
|
+
# source_db_instance_automated_backups_arn: "String",
|
4431
|
+
# backup_target: "String",
|
4432
|
+
# custom_iam_instance_profile: "String",
|
4442
4433
|
# allocated_storage: 1,
|
4443
4434
|
# dedicated_log_volume: false,
|
4444
4435
|
# ca_certificate_identifier: "String",
|
@@ -4661,6 +4652,10 @@ module Aws::RDS
|
|
4661
4652
|
# * Must be an integer greater than 1000.
|
4662
4653
|
#
|
4663
4654
|
# ^
|
4655
|
+
# @option options [Integer] :storage_throughput
|
4656
|
+
# The storage throughput value for the DB instance.
|
4657
|
+
#
|
4658
|
+
# This setting doesn't apply to RDS Custom or Amazon Aurora.
|
4664
4659
|
# @option options [String] :option_group_name
|
4665
4660
|
# The name of the option group to use for the restored DB instance.
|
4666
4661
|
#
|
@@ -4854,12 +4849,6 @@ module Aws::RDS
|
|
4854
4849
|
#
|
4855
4850
|
#
|
4856
4851
|
# [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
4852
|
# @option options [Boolean] :enable_customer_owned_ip
|
4864
4853
|
# Specifies whether to enable a customer-owned IP address (CoIP) for an
|
4865
4854
|
# RDS on Outposts DB instance.
|
@@ -4882,27 +4871,31 @@ module Aws::RDS
|
|
4882
4871
|
#
|
4883
4872
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html
|
4884
4873
|
# [2]: https://docs.aws.amazon.com/outposts/latest/userguide/routing.html#ip-addressing
|
4885
|
-
# @option options [String] :
|
4886
|
-
# The
|
4887
|
-
# instance of an RDS Custom DB instance. The instance profile must meet
|
4888
|
-
# the following requirements:
|
4874
|
+
# @option options [String] :network_type
|
4875
|
+
# The network type of the DB instance.
|
4889
4876
|
#
|
4890
|
-
#
|
4877
|
+
# The network type is determined by the `DBSubnetGroup` specified for
|
4878
|
+
# the DB instance. A `DBSubnetGroup` can support only the IPv4 protocol
|
4879
|
+
# or the IPv4 and the IPv6 protocols (`DUAL`).
|
4891
4880
|
#
|
4892
|
-
#
|
4893
|
-
#
|
4881
|
+
# For more information, see [ Working with a DB instance in a VPC][1] in
|
4882
|
+
# the *Amazon RDS User Guide.*
|
4894
4883
|
#
|
4895
|
-
#
|
4896
|
-
# start with the prefix `AWSRDSCustom`.
|
4884
|
+
# Valid Values:
|
4897
4885
|
#
|
4898
|
-
#
|
4899
|
-
# IAM and your VPC][1] in the *Amazon RDS User Guide*.
|
4886
|
+
# * `IPV4`
|
4900
4887
|
#
|
4901
|
-
#
|
4888
|
+
# * `DUAL`
|
4902
4889
|
#
|
4903
4890
|
#
|
4904
4891
|
#
|
4905
|
-
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/
|
4892
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html
|
4893
|
+
# @option options [String] :source_db_instance_automated_backups_arn
|
4894
|
+
# The Amazon Resource Name (ARN) of the replicated automated backups
|
4895
|
+
# from which to restore, for example,
|
4896
|
+
# `arn:aws:rds:us-east-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE`.
|
4897
|
+
#
|
4898
|
+
# This setting doesn't apply to RDS Custom.
|
4906
4899
|
# @option options [String] :backup_target
|
4907
4900
|
# The location for storing automated backups and manual snapshots for
|
4908
4901
|
# the restored DB instance.
|
@@ -4923,29 +4916,27 @@ module Aws::RDS
|
|
4923
4916
|
#
|
4924
4917
|
#
|
4925
4918
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html
|
4926
|
-
# @option options [String] :
|
4927
|
-
# The
|
4928
|
-
#
|
4929
|
-
#
|
4930
|
-
# the DB instance. A `DBSubnetGroup` can support only the IPv4 protocol
|
4931
|
-
# or the IPv4 and the IPv6 protocols (`DUAL`).
|
4919
|
+
# @option options [String] :custom_iam_instance_profile
|
4920
|
+
# The instance profile associated with the underlying Amazon EC2
|
4921
|
+
# instance of an RDS Custom DB instance. The instance profile must meet
|
4922
|
+
# the following requirements:
|
4932
4923
|
#
|
4933
|
-
#
|
4934
|
-
# the *Amazon RDS User Guide.*
|
4924
|
+
# * The profile must exist in your account.
|
4935
4925
|
#
|
4936
|
-
#
|
4926
|
+
# * The profile must have an IAM role that Amazon EC2 has permissions to
|
4927
|
+
# assume.
|
4937
4928
|
#
|
4938
|
-
# *
|
4929
|
+
# * The instance profile name and the associated IAM role name must
|
4930
|
+
# start with the prefix `AWSRDSCustom`.
|
4939
4931
|
#
|
4940
|
-
#
|
4932
|
+
# For the list of permissions required for the IAM role, see [ Configure
|
4933
|
+
# IAM and your VPC][1] in the *Amazon RDS User Guide*.
|
4941
4934
|
#
|
4935
|
+
# This setting is required for RDS Custom.
|
4942
4936
|
#
|
4943
4937
|
#
|
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
4938
|
#
|
4948
|
-
#
|
4939
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-setup-orcl.html#custom-setup-orcl.iam-vpc
|
4949
4940
|
# @option options [Integer] :allocated_storage
|
4950
4941
|
# The amount of storage (in gibibytes) to allocate initially for the DB
|
4951
4942
|
# instance. Follow the allocation rules specified in `CreateDBInstance`.
|