aws-sdk-rds 1.194.0 → 1.196.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/certificate.rb +2 -1
- data/lib/aws-sdk-rds/client.rb +450 -398
- data/lib/aws-sdk-rds/client_api.rb +1 -0
- data/lib/aws-sdk-rds/db_cluster.rb +44 -43
- data/lib/aws-sdk-rds/db_cluster_parameter_group.rb +3 -4
- data/lib/aws-sdk-rds/db_cluster_snapshot.rb +45 -50
- data/lib/aws-sdk-rds/db_engine.rb +12 -15
- data/lib/aws-sdk-rds/db_engine_version.rb +14 -14
- data/lib/aws-sdk-rds/db_instance.rb +218 -174
- data/lib/aws-sdk-rds/db_parameter_group.rb +3 -3
- data/lib/aws-sdk-rds/db_snapshot.rb +33 -30
- data/lib/aws-sdk-rds/event_subscription.rb +5 -5
- data/lib/aws-sdk-rds/option_group.rb +2 -3
- data/lib/aws-sdk-rds/option_group_option.rb +2 -2
- data/lib/aws-sdk-rds/parameter.rb +2 -2
- data/lib/aws-sdk-rds/reserved_db_instance.rb +1 -1
- data/lib/aws-sdk-rds/reserved_db_instances_offering.rb +1 -1
- data/lib/aws-sdk-rds/resource.rb +30 -32
- data/lib/aws-sdk-rds/types.rb +630 -573
- data/lib/aws-sdk-rds.rb +1 -1
- metadata +2 -2
data/lib/aws-sdk-rds/client.rb
CHANGED
@@ -664,14 +664,14 @@ module Aws::RDS
|
|
664
664
|
# @option params [required, String] :apply_action
|
665
665
|
# The pending maintenance action to apply to this resource.
|
666
666
|
#
|
667
|
-
# Valid
|
667
|
+
# Valid Values: `system-update`, `db-upgrade`, `hardware-maintenance`,
|
668
668
|
# `ca-certificate-rotation`
|
669
669
|
#
|
670
670
|
# @option params [required, String] :opt_in_type
|
671
671
|
# A value that specifies the type of opt-in request, or undoes an opt-in
|
672
672
|
# request. An opt-in request of type `immediate` can't be undone.
|
673
673
|
#
|
674
|
-
# Valid
|
674
|
+
# Valid Values:
|
675
675
|
#
|
676
676
|
# * `immediate` - Apply the maintenance action immediately.
|
677
677
|
#
|
@@ -904,16 +904,16 @@ module Aws::RDS
|
|
904
904
|
# [1]: http://en.wikipedia.org/wiki/ISO_8601
|
905
905
|
#
|
906
906
|
# @option params [Boolean] :force
|
907
|
-
#
|
908
|
-
#
|
909
|
-
#
|
907
|
+
# Specifies whether to force the DB cluster to backtrack when binary
|
908
|
+
# logging is enabled. Otherwise, an error occurs when binary logging is
|
909
|
+
# enabled.
|
910
910
|
#
|
911
911
|
# @option params [Boolean] :use_earliest_time_on_point_in_time_unavailable
|
912
|
-
#
|
913
|
-
#
|
914
|
-
#
|
915
|
-
#
|
916
|
-
#
|
912
|
+
# Specifies whether to backtrack the DB cluster to the earliest possible
|
913
|
+
# backtrack time when *BacktrackTo* is set to a timestamp earlier than
|
914
|
+
# the earliest backtrack time. When this parameter is disabled and
|
915
|
+
# *BacktrackTo* is set to a timestamp earlier than the earliest
|
916
|
+
# backtrack time, an error occurs.
|
917
917
|
#
|
918
918
|
# @return [Types::DBClusterBacktrack] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
919
919
|
#
|
@@ -1304,9 +1304,8 @@ module Aws::RDS
|
|
1304
1304
|
# [2]: https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html
|
1305
1305
|
#
|
1306
1306
|
# @option params [Boolean] :copy_tags
|
1307
|
-
#
|
1308
|
-
#
|
1309
|
-
# are not copied.
|
1307
|
+
# Specifies whether to copy all tags from the source DB cluster snapshot
|
1308
|
+
# to the target DB cluster snapshot. By default, tags are not copied.
|
1310
1309
|
#
|
1311
1310
|
# @option params [Array<Types::Tag>] :tags
|
1312
1311
|
# A list of tags. For more information, see [Tagging Amazon RDS
|
@@ -1614,8 +1613,8 @@ module Aws::RDS
|
|
1614
1613
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html
|
1615
1614
|
#
|
1616
1615
|
# @option params [Boolean] :copy_tags
|
1617
|
-
#
|
1618
|
-
#
|
1616
|
+
# Specifies whether to copy all tags from the source DB snapshot to the
|
1617
|
+
# target DB snapshot. By default, tags aren't copied.
|
1619
1618
|
#
|
1620
1619
|
# @option params [String] :pre_signed_url
|
1621
1620
|
# When you are copying a snapshot from one Amazon Web Services GovCloud
|
@@ -1707,10 +1706,10 @@ module Aws::RDS
|
|
1707
1706
|
# Example: `rds-caz-aiqhTgQv`.
|
1708
1707
|
#
|
1709
1708
|
# @option params [Boolean] :copy_option_group
|
1710
|
-
#
|
1711
|
-
#
|
1712
|
-
#
|
1713
|
-
#
|
1709
|
+
# Specifies whether to copy the DB option group associated with the
|
1710
|
+
# source DB snapshot to the target Amazon Web Services account and
|
1711
|
+
# associate with the target DB snapshot. The associated option group can
|
1712
|
+
# be copied only with cross-account snapshot copy calls.
|
1714
1713
|
#
|
1715
1714
|
# @option params [String] :source_region
|
1716
1715
|
# The source region of the snapshot. This is only needed when the
|
@@ -4351,7 +4350,8 @@ module Aws::RDS
|
|
4351
4350
|
# * Can't be specified if `ManageMasterUserPassword` is turned on.
|
4352
4351
|
#
|
4353
4352
|
# * Can include any printable ASCII character except "/", """, or
|
4354
|
-
# "@".
|
4353
|
+
# "@". For RDS for Oracle, can't include the "&" (ampersand)
|
4354
|
+
# or the "'" (single quotes) character.
|
4355
4355
|
#
|
4356
4356
|
# Length Constraints:
|
4357
4357
|
#
|
@@ -5570,9 +5570,8 @@ module Aws::RDS
|
|
5570
5570
|
# read replicas][1] and [Migrating from a Multi-AZ DB cluster to a DB
|
5571
5571
|
# instance using a read replica][2] in the *Amazon RDS User Guide*.
|
5572
5572
|
#
|
5573
|
-
# Amazon Aurora doesn't support this operation.
|
5574
|
-
#
|
5575
|
-
# cluster.
|
5573
|
+
# Amazon Aurora doesn't support this operation. To create a DB instance
|
5574
|
+
# for an Aurora DB cluster, use the `CreateDBInstance` operation.
|
5576
5575
|
#
|
5577
5576
|
# All read replica DB instances are created with backups disabled. All
|
5578
5577
|
# other attributes (including DB security groups and DB parameter
|
@@ -5636,7 +5635,7 @@ module Aws::RDS
|
|
5636
5635
|
# of DB instance classes, and availability for your engine, see [DB
|
5637
5636
|
# Instance Class][1] in the *Amazon RDS User Guide*.
|
5638
5637
|
#
|
5639
|
-
# Default: Inherits from the source DB instance.
|
5638
|
+
# Default: Inherits the value from the source DB instance.
|
5640
5639
|
#
|
5641
5640
|
#
|
5642
5641
|
#
|
@@ -5653,13 +5652,12 @@ module Aws::RDS
|
|
5653
5652
|
# @option params [Integer] :port
|
5654
5653
|
# The port number that the DB instance uses for connections.
|
5655
5654
|
#
|
5656
|
-
# Default: Inherits from the source DB instance
|
5657
|
-
#
|
5658
5655
|
# Valid Values: `1150-65535`
|
5659
5656
|
#
|
5657
|
+
# Default: Inherits the value from the source DB instance.
|
5658
|
+
#
|
5660
5659
|
# @option params [Boolean] :multi_az
|
5661
|
-
#
|
5662
|
-
# deployment.
|
5660
|
+
# Specifies whether the read replica is in a Multi-AZ deployment.
|
5663
5661
|
#
|
5664
5662
|
# You can create a read replica as a Multi-AZ DB instance. RDS creates a
|
5665
5663
|
# standby of your replica in another Availability Zone for failover
|
@@ -5667,52 +5665,55 @@ module Aws::RDS
|
|
5667
5665
|
# instance is independent of whether the source is a Multi-AZ DB
|
5668
5666
|
# instance or a Multi-AZ DB cluster.
|
5669
5667
|
#
|
5670
|
-
# This setting doesn't apply to RDS Custom.
|
5668
|
+
# This setting doesn't apply to RDS Custom DB instances.
|
5671
5669
|
#
|
5672
5670
|
# @option params [Boolean] :auto_minor_version_upgrade
|
5673
|
-
#
|
5674
|
-
#
|
5671
|
+
# Specifies whether to automatically apply minor engine upgrades to the
|
5672
|
+
# read replica during the maintenance window.
|
5675
5673
|
#
|
5676
|
-
# This setting doesn't apply to RDS Custom.
|
5674
|
+
# This setting doesn't apply to RDS Custom DB instances.
|
5677
5675
|
#
|
5678
|
-
# Default: Inherits from the source DB instance
|
5676
|
+
# Default: Inherits the value from the source DB instance.
|
5679
5677
|
#
|
5680
5678
|
# @option params [Integer] :iops
|
5681
5679
|
# The amount of Provisioned IOPS (input/output operations per second) to
|
5682
|
-
#
|
5680
|
+
# initially allocate for the DB instance.
|
5683
5681
|
#
|
5684
5682
|
# @option params [String] :option_group_name
|
5685
|
-
# The option group the DB instance
|
5686
|
-
# option group associated with the source instance or
|
5683
|
+
# The option group to associate the DB instance with. If not specified,
|
5684
|
+
# RDS uses the option group associated with the source DB instance or
|
5685
|
+
# cluster.
|
5687
5686
|
#
|
5688
5687
|
# <note markdown="1"> For SQL Server, you must use the option group associated with the
|
5689
5688
|
# source.
|
5690
5689
|
#
|
5691
5690
|
# </note>
|
5692
5691
|
#
|
5693
|
-
# This setting doesn't apply to RDS Custom.
|
5692
|
+
# This setting doesn't apply to RDS Custom DB instances.
|
5694
5693
|
#
|
5695
5694
|
# @option params [String] :db_parameter_group_name
|
5696
5695
|
# The name of the DB parameter group to associate with this DB instance.
|
5697
5696
|
#
|
5698
|
-
# If you
|
5699
|
-
# RDS uses the `DBParameterGroup` of source DB instance for a same
|
5697
|
+
# If you don't specify a value for `DBParameterGroupName`, then Amazon
|
5698
|
+
# RDS uses the `DBParameterGroup` of the source DB instance for a same
|
5700
5699
|
# Region read replica, or the default `DBParameterGroup` for the
|
5701
5700
|
# specified DB engine for a cross-Region read replica.
|
5702
5701
|
#
|
5703
5702
|
# Specifying a parameter group for this operation is only supported for
|
5704
|
-
# MySQL
|
5703
|
+
# MySQL DB instances for cross-Region read replicas and for Oracle DB
|
5704
|
+
# instances. It isn't supported for MySQL DB instances for same Region
|
5705
|
+
# read replicas or for RDS Custom.
|
5705
5706
|
#
|
5706
5707
|
# Constraints:
|
5707
5708
|
#
|
5708
5709
|
# * Must be 1 to 255 letters, numbers, or hyphens.
|
5709
5710
|
#
|
5710
|
-
# * First character must be a letter
|
5711
|
+
# * First character must be a letter.
|
5711
5712
|
#
|
5712
|
-
# * Can't end with a hyphen or contain two consecutive hyphens
|
5713
|
+
# * Can't end with a hyphen or contain two consecutive hyphens.
|
5713
5714
|
#
|
5714
5715
|
# @option params [Boolean] :publicly_accessible
|
5715
|
-
#
|
5716
|
+
# Specifies whether the DB instance is publicly accessible.
|
5716
5717
|
#
|
5717
5718
|
# When the DB cluster is publicly accessible, its Domain Name System
|
5718
5719
|
# (DNS) endpoint resolves to the private IP address from within the DB
|
@@ -5736,20 +5737,19 @@ module Aws::RDS
|
|
5736
5737
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html
|
5737
5738
|
#
|
5738
5739
|
# @option params [String] :db_subnet_group_name
|
5739
|
-
#
|
5740
|
-
#
|
5741
|
-
#
|
5742
|
-
# a VPC.
|
5740
|
+
# A DB subnet group for the DB instance. The new DB instance is created
|
5741
|
+
# in the VPC associated with the DB subnet group. If no DB subnet group
|
5742
|
+
# is specified, then the new DB instance isn't created in a VPC.
|
5743
5743
|
#
|
5744
5744
|
# Constraints:
|
5745
5745
|
#
|
5746
|
-
# * If supplied, must match the name of an existing
|
5746
|
+
# * If supplied, must match the name of an existing DB subnet group.
|
5747
5747
|
#
|
5748
5748
|
# * The specified DB subnet group must be in the same Amazon Web
|
5749
5749
|
# Services Region in which the operation is running.
|
5750
5750
|
#
|
5751
5751
|
# * All read replicas in one Amazon Web Services Region that are created
|
5752
|
-
# from the same source DB instance must either
|
5752
|
+
# from the same source DB instance must either:
|
5753
5753
|
#
|
5754
5754
|
# * Specify DB subnet groups from the same VPC. All these read
|
5755
5755
|
# replicas are created in the same VPC.
|
@@ -5763,37 +5763,39 @@ module Aws::RDS
|
|
5763
5763
|
# A list of Amazon EC2 VPC security groups to associate with the read
|
5764
5764
|
# replica.
|
5765
5765
|
#
|
5766
|
-
# This setting doesn't apply to RDS Custom.
|
5766
|
+
# This setting doesn't apply to RDS Custom DB instances.
|
5767
5767
|
#
|
5768
5768
|
# Default: The default EC2 VPC security group for the DB subnet group's
|
5769
5769
|
# VPC.
|
5770
5770
|
#
|
5771
5771
|
# @option params [String] :storage_type
|
5772
|
-
#
|
5773
|
-
#
|
5774
|
-
# Valid values: `gp2 | gp3 | io1 | standard`
|
5772
|
+
# The storage type to associate with the read replica.
|
5775
5773
|
#
|
5776
5774
|
# If you specify `io1` or `gp3`, you must also include a value for the
|
5777
5775
|
# `Iops` parameter.
|
5778
5776
|
#
|
5779
|
-
#
|
5777
|
+
# Valid Values: `gp2 | gp3 | io1 | standard`
|
5778
|
+
#
|
5779
|
+
# Default: `io1` if the `Iops` parameter is specified. Otherwise, `gp2`.
|
5780
5780
|
#
|
5781
5781
|
# @option params [Boolean] :copy_tags_to_snapshot
|
5782
|
-
#
|
5783
|
-
#
|
5782
|
+
# Specifies whether to copy all tags from the read replica to snapshots
|
5783
|
+
# of the read replica. By default, tags aren't copied.
|
5784
5784
|
#
|
5785
5785
|
# @option params [Integer] :monitoring_interval
|
5786
5786
|
# The interval, in seconds, between points when Enhanced Monitoring
|
5787
|
-
# metrics are collected for the read replica. To disable
|
5788
|
-
# Enhanced Monitoring metrics, specify 0
|
5787
|
+
# metrics are collected for the read replica. To disable collection of
|
5788
|
+
# Enhanced Monitoring metrics, specify `0`. The default is `0`.
|
5789
5789
|
#
|
5790
|
-
# If `MonitoringRoleArn` is specified, then you must
|
5791
|
-
# `MonitoringInterval` to a value other than 0
|
5790
|
+
# If `MonitoringRoleArn` is specified, then you must set
|
5791
|
+
# `MonitoringInterval` to a value other than `0`.
|
5792
5792
|
#
|
5793
|
-
# This setting doesn't apply to RDS Custom.
|
5793
|
+
# This setting doesn't apply to RDS Custom DB instances.
|
5794
5794
|
#
|
5795
5795
|
# Valid Values: `0, 1, 5, 10, 15, 30, 60`
|
5796
5796
|
#
|
5797
|
+
# Default: `0`
|
5798
|
+
#
|
5797
5799
|
# @option params [String] :monitoring_role_arn
|
5798
5800
|
# The ARN for the IAM role that permits RDS to send enhanced monitoring
|
5799
5801
|
# metrics to Amazon CloudWatch Logs. For example,
|
@@ -5804,7 +5806,7 @@ module Aws::RDS
|
|
5804
5806
|
# If `MonitoringInterval` is set to a value other than 0, then you must
|
5805
5807
|
# supply a `MonitoringRoleArn` value.
|
5806
5808
|
#
|
5807
|
-
# This setting doesn't apply to RDS Custom.
|
5809
|
+
# This setting doesn't apply to RDS Custom DB instances.
|
5808
5810
|
#
|
5809
5811
|
#
|
5810
5812
|
#
|
@@ -5908,7 +5910,7 @@ module Aws::RDS
|
|
5908
5910
|
#
|
5909
5911
|
# </note>
|
5910
5912
|
#
|
5911
|
-
# This setting doesn't apply to RDS Custom.
|
5913
|
+
# This setting doesn't apply to RDS Custom DB instances.
|
5912
5914
|
#
|
5913
5915
|
#
|
5914
5916
|
#
|
@@ -5916,28 +5918,27 @@ module Aws::RDS
|
|
5916
5918
|
# [2]: https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html
|
5917
5919
|
#
|
5918
5920
|
# @option params [Boolean] :enable_iam_database_authentication
|
5919
|
-
#
|
5920
|
-
#
|
5921
|
-
#
|
5921
|
+
# Specifies whether to enable mapping of Amazon Web Services Identity
|
5922
|
+
# and Access Management (IAM) accounts to database accounts. By default,
|
5923
|
+
# mapping isn't enabled.
|
5922
5924
|
#
|
5923
5925
|
# For more information about IAM database authentication, see [ IAM
|
5924
5926
|
# Database Authentication for MySQL and PostgreSQL][1] in the *Amazon
|
5925
5927
|
# RDS User Guide*.
|
5926
5928
|
#
|
5927
|
-
# This setting doesn't apply to RDS Custom.
|
5929
|
+
# This setting doesn't apply to RDS Custom DB instances.
|
5928
5930
|
#
|
5929
5931
|
#
|
5930
5932
|
#
|
5931
5933
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.html
|
5932
5934
|
#
|
5933
5935
|
# @option params [Boolean] :enable_performance_insights
|
5934
|
-
#
|
5935
|
-
# read replica.
|
5936
|
+
# Specifies whether to enable Performance Insights for the read replica.
|
5936
5937
|
#
|
5937
5938
|
# For more information, see [Using Amazon Performance Insights][1] in
|
5938
5939
|
# the *Amazon RDS User Guide*.
|
5939
5940
|
#
|
5940
|
-
# This setting doesn't apply to RDS Custom.
|
5941
|
+
# This setting doesn't apply to RDS Custom DB instances.
|
5941
5942
|
#
|
5942
5943
|
#
|
5943
5944
|
#
|
@@ -5955,32 +5956,27 @@ module Aws::RDS
|
|
5955
5956
|
# your Amazon Web Services account. Your Amazon Web Services account has
|
5956
5957
|
# a different default KMS key for each Amazon Web Services Region.
|
5957
5958
|
#
|
5958
|
-
# This setting doesn't apply to RDS Custom.
|
5959
|
+
# This setting doesn't apply to RDS Custom DB instances.
|
5959
5960
|
#
|
5960
5961
|
# @option params [Integer] :performance_insights_retention_period
|
5961
|
-
# The number of days to retain Performance Insights data.
|
5962
|
-
# 7 days. The following values are valid:
|
5963
|
-
#
|
5964
|
-
# * 7
|
5965
|
-
#
|
5966
|
-
# * *month* * 31, where *month* is a number of months from 1-23
|
5967
|
-
#
|
5968
|
-
# * 731
|
5962
|
+
# The number of days to retain Performance Insights data.
|
5969
5963
|
#
|
5970
|
-
#
|
5964
|
+
# This setting doesn't apply to RDS Custom DB instances.
|
5971
5965
|
#
|
5972
|
-
#
|
5966
|
+
# Valid Values:
|
5973
5967
|
#
|
5974
|
-
# *
|
5968
|
+
# * `7`
|
5975
5969
|
#
|
5976
|
-
# *
|
5970
|
+
# * *month* * 31, where *month* is a number of months from 1-23.
|
5971
|
+
# Examples: `93` (3 months * 31), `341` (11 months * 31), `589` (19
|
5972
|
+
# months * 31)
|
5977
5973
|
#
|
5978
|
-
# * 731
|
5974
|
+
# * `731`
|
5979
5975
|
#
|
5980
|
-
#
|
5981
|
-
# value, RDS issues an error.
|
5976
|
+
# Default: `7` days
|
5982
5977
|
#
|
5983
|
-
#
|
5978
|
+
# If you specify a retention period that isn't valid, such as `94`,
|
5979
|
+
# Amazon RDS returns an error.
|
5984
5980
|
#
|
5985
5981
|
# @option params [Array<String>] :enable_cloudwatch_logs_exports
|
5986
5982
|
# The list of logs that the new DB instance is to export to CloudWatch
|
@@ -5988,7 +5984,7 @@ module Aws::RDS
|
|
5988
5984
|
# more information, see [Publishing Database Logs to Amazon CloudWatch
|
5989
5985
|
# Logs ][1] in the *Amazon RDS User Guide*.
|
5990
5986
|
#
|
5991
|
-
# This setting doesn't apply to RDS Custom.
|
5987
|
+
# This setting doesn't apply to RDS Custom DB instances.
|
5992
5988
|
#
|
5993
5989
|
#
|
5994
5990
|
#
|
@@ -5998,19 +5994,19 @@ module Aws::RDS
|
|
5998
5994
|
# The number of CPU cores and the number of threads per core for the DB
|
5999
5995
|
# instance class of the DB instance.
|
6000
5996
|
#
|
6001
|
-
# This setting doesn't apply to RDS Custom.
|
5997
|
+
# This setting doesn't apply to RDS Custom DB instances.
|
6002
5998
|
#
|
6003
5999
|
# @option params [Boolean] :use_default_processor_features
|
6004
|
-
#
|
6005
|
-
#
|
6000
|
+
# Specifies whether the DB instance class of the DB instance uses its
|
6001
|
+
# default processor features.
|
6006
6002
|
#
|
6007
|
-
# This setting doesn't apply to RDS Custom.
|
6003
|
+
# This setting doesn't apply to RDS Custom DB instances.
|
6008
6004
|
#
|
6009
6005
|
# @option params [Boolean] :deletion_protection
|
6010
|
-
#
|
6011
|
-
#
|
6012
|
-
#
|
6013
|
-
#
|
6006
|
+
# Specifies whether to enable deletion protection for the DB instance.
|
6007
|
+
# The database can't be deleted when deletion protection is enabled. By
|
6008
|
+
# default, deletion protection isn't enabled. For more information, see
|
6009
|
+
# [ Deleting a DB Instance][1].
|
6014
6010
|
#
|
6015
6011
|
#
|
6016
6012
|
#
|
@@ -6024,17 +6020,17 @@ module Aws::RDS
|
|
6024
6020
|
# For more information, see [ Kerberos Authentication][1] in the *Amazon
|
6025
6021
|
# RDS User Guide*.
|
6026
6022
|
#
|
6027
|
-
# This setting doesn't apply to RDS Custom.
|
6023
|
+
# This setting doesn't apply to RDS Custom DB instances.
|
6028
6024
|
#
|
6029
6025
|
#
|
6030
6026
|
#
|
6031
6027
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/kerberos-authentication.html
|
6032
6028
|
#
|
6033
6029
|
# @option params [String] :domain_iam_role_name
|
6034
|
-
# The name of the IAM role to
|
6035
|
-
#
|
6030
|
+
# The name of the IAM role to use when making API calls to the Directory
|
6031
|
+
# Service.
|
6036
6032
|
#
|
6037
|
-
# This setting doesn't apply to RDS Custom.
|
6033
|
+
# This setting doesn't apply to RDS Custom DB instances.
|
6038
6034
|
#
|
6039
6035
|
# @option params [String] :domain_fqdn
|
6040
6036
|
# The fully qualified domain name (FQDN) of an Active Directory domain.
|
@@ -6135,7 +6131,7 @@ module Aws::RDS
|
|
6135
6131
|
# For the list of permissions required for the IAM role, see [ Configure
|
6136
6132
|
# IAM and your VPC][1] in the *Amazon RDS User Guide*.
|
6137
6133
|
#
|
6138
|
-
# This setting is required for RDS Custom.
|
6134
|
+
# This setting is required for RDS Custom DB instances.
|
6139
6135
|
#
|
6140
6136
|
#
|
6141
6137
|
#
|
@@ -6144,7 +6140,7 @@ module Aws::RDS
|
|
6144
6140
|
# @option params [String] :network_type
|
6145
6141
|
# The network type of the DB instance.
|
6146
6142
|
#
|
6147
|
-
# Valid
|
6143
|
+
# Valid Values:
|
6148
6144
|
#
|
6149
6145
|
# * `IPV4`
|
6150
6146
|
#
|
@@ -6164,11 +6160,12 @@ module Aws::RDS
|
|
6164
6160
|
# @option params [Integer] :storage_throughput
|
6165
6161
|
# Specifies the storage throughput value for the read replica.
|
6166
6162
|
#
|
6167
|
-
# This setting doesn't apply to RDS Custom or Amazon Aurora
|
6163
|
+
# This setting doesn't apply to RDS Custom or Amazon Aurora DB
|
6164
|
+
# instances.
|
6168
6165
|
#
|
6169
6166
|
# @option params [Boolean] :enable_customer_owned_ip
|
6170
|
-
#
|
6171
|
-
#
|
6167
|
+
# Specifies whether to enable a customer-owned IP address (CoIP) for an
|
6168
|
+
# RDS on Outposts read replica.
|
6172
6169
|
#
|
6173
6170
|
# A *CoIP* provides local or external connectivity to resources in your
|
6174
6171
|
# Outpost subnets through your on-premises network. For some use cases,
|
@@ -6657,9 +6654,9 @@ module Aws::RDS
|
|
6657
6654
|
# One or more VPC security group IDs to associate with the new proxy.
|
6658
6655
|
#
|
6659
6656
|
# @option params [Boolean] :require_tls
|
6660
|
-
#
|
6661
|
-
#
|
6662
|
-
#
|
6657
|
+
# Specifies whether Transport Layer Security (TLS) encryption is
|
6658
|
+
# required for connections to the proxy. By enabling this setting, you
|
6659
|
+
# can enforce encrypted TLS connections to the proxy.
|
6663
6660
|
#
|
6664
6661
|
# @option params [Integer] :idle_client_timeout
|
6665
6662
|
# The number of seconds that a connection to the proxy can be inactive
|
@@ -6667,13 +6664,13 @@ module Aws::RDS
|
|
6667
6664
|
# lower than the connection timeout limit for the associated database.
|
6668
6665
|
#
|
6669
6666
|
# @option params [Boolean] :debug_logging
|
6670
|
-
#
|
6671
|
-
# in its logs. This information helps you to debug issues
|
6672
|
-
# behavior or the performance and scalability of the proxy
|
6673
|
-
# The debug information includes the text of SQL statements
|
6674
|
-
# submit through the proxy. Thus, only enable this setting when
|
6675
|
-
# for debugging, and only when you have security measures in
|
6676
|
-
# safeguard any sensitive information that appears in the logs.
|
6667
|
+
# Specifies whether the proxy includes detailed information about SQL
|
6668
|
+
# statements in its logs. This information helps you to debug issues
|
6669
|
+
# involving SQL behavior or the performance and scalability of the proxy
|
6670
|
+
# connections. The debug information includes the text of SQL statements
|
6671
|
+
# that you submit through the proxy. Thus, only enable this setting when
|
6672
|
+
# needed for debugging, and only when you have security measures in
|
6673
|
+
# place to safeguard any sensitive information that appears in the logs.
|
6677
6674
|
#
|
6678
6675
|
# @option params [Array<Types::Tag>] :tags
|
6679
6676
|
# An optional set of key-value pairs to associate arbitrary data of your
|
@@ -6771,10 +6768,10 @@ module Aws::RDS
|
|
6771
6768
|
# VPC.
|
6772
6769
|
#
|
6773
6770
|
# @option params [String] :target_role
|
6774
|
-
#
|
6775
|
-
# read/write or
|
6776
|
-
# only role that proxies for RDS for
|
6777
|
-
# `READ_WRITE`.
|
6771
|
+
# The role of the DB proxy endpoint. The role determines whether the
|
6772
|
+
# endpoint can be used for read/write or only read operations. The
|
6773
|
+
# default is `READ_WRITE`. The only role that proxies for RDS for
|
6774
|
+
# Microsoft SQL Server support is `READ_WRITE`.
|
6778
6775
|
#
|
6779
6776
|
# @option params [Array<Types::Tag>] :tags
|
6780
6777
|
# A list of tags. For more information, see [Tagging Amazon RDS
|
@@ -7243,7 +7240,7 @@ module Aws::RDS
|
|
7243
7240
|
# parameter to `db-instance`. For RDS Proxy events, specify `db-proxy`.
|
7244
7241
|
# If this value isn't specified, all events are returned.
|
7245
7242
|
#
|
7246
|
-
# Valid
|
7243
|
+
# Valid Values: `db-instance` \| `db-cluster` \| `db-parameter-group` \|
|
7247
7244
|
# `db-security-group` \| `db-snapshot` \| `db-cluster-snapshot` \|
|
7248
7245
|
# `db-proxy`
|
7249
7246
|
#
|
@@ -7293,8 +7290,8 @@ module Aws::RDS
|
|
7293
7290
|
# supplied.
|
7294
7291
|
#
|
7295
7292
|
# @option params [Boolean] :enabled
|
7296
|
-
#
|
7297
|
-
#
|
7293
|
+
# Specifies whether to activate the subscription. If the event
|
7294
|
+
# notification subscription isn't activated, the subscription is
|
7298
7295
|
# created but not active.
|
7299
7296
|
#
|
7300
7297
|
# @option params [Array<Types::Tag>] :tags
|
@@ -8079,12 +8076,12 @@ module Aws::RDS
|
|
8079
8076
|
# ^
|
8080
8077
|
#
|
8081
8078
|
# @option params [Boolean] :skip_final_snapshot
|
8082
|
-
#
|
8083
|
-
#
|
8084
|
-
#
|
8085
|
-
#
|
8086
|
-
#
|
8087
|
-
#
|
8079
|
+
# Specifies whether to skip the creation of a final DB cluster snapshot
|
8080
|
+
# before the DB cluster is deleted. If skip is specified, no DB cluster
|
8081
|
+
# snapshot is created. If skip isn't specified, a DB cluster snapshot
|
8082
|
+
# is created before the DB cluster is deleted. By default, skip isn't
|
8083
|
+
# specified, and the DB cluster snapshot is created. By default, this
|
8084
|
+
# parameter is disabled.
|
8088
8085
|
#
|
8089
8086
|
# <note markdown="1"> You must specify a `FinalDBSnapshotIdentifier` parameter if
|
8090
8087
|
# `SkipFinalSnapshot` is disabled.
|
@@ -8110,10 +8107,10 @@ module Aws::RDS
|
|
8110
8107
|
# * Can't end with a hyphen or contain two consecutive hyphens
|
8111
8108
|
#
|
8112
8109
|
# @option params [Boolean] :delete_automated_backups
|
8113
|
-
#
|
8114
|
-
#
|
8115
|
-
#
|
8116
|
-
#
|
8110
|
+
# Specifies whether to remove automated backups immediately after the DB
|
8111
|
+
# cluster is deleted. This parameter isn't case-sensitive. The default
|
8112
|
+
# is to remove automated backups immediately after the DB cluster is
|
8113
|
+
# deleted.
|
8117
8114
|
#
|
8118
8115
|
# @return [Types::DeleteDBClusterResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
8119
8116
|
#
|
@@ -8588,16 +8585,15 @@ module Aws::RDS
|
|
8588
8585
|
req.send_request(options)
|
8589
8586
|
end
|
8590
8587
|
|
8591
|
-
#
|
8592
|
-
# instance
|
8593
|
-
#
|
8594
|
-
#
|
8595
|
-
# deleted.
|
8588
|
+
# Deletes a previously provisioned DB instance. When you delete a DB
|
8589
|
+
# instance, all automated backups for that instance are deleted and
|
8590
|
+
# can't be recovered. However, manual DB snapshots of the DB instance
|
8591
|
+
# aren't deleted.
|
8596
8592
|
#
|
8597
|
-
# If you request a final DB snapshot the status of the Amazon RDS DB
|
8598
|
-
# instance is `deleting` until the DB snapshot is created.
|
8599
|
-
#
|
8600
|
-
#
|
8593
|
+
# If you request a final DB snapshot, the status of the Amazon RDS DB
|
8594
|
+
# instance is `deleting` until the DB snapshot is created. This
|
8595
|
+
# operation can't be canceled or reverted after it begins. To monitor
|
8596
|
+
# the status of this operation, use `DescribeDBInstance`.
|
8601
8597
|
#
|
8602
8598
|
# When a DB instance is in a failure state and has a status of `failed`,
|
8603
8599
|
# `incompatible-restore`, or `incompatible-network`, you can only delete
|
@@ -8613,12 +8609,18 @@ module Aws::RDS
|
|
8613
8609
|
#
|
8614
8610
|
# * The DB instance is the only instance in the DB cluster.
|
8615
8611
|
#
|
8616
|
-
# To delete a DB instance in this case, first
|
8617
|
-
# `PromoteReadReplicaDBCluster`
|
8618
|
-
# it's no longer a read replica. After the promotion completes,
|
8619
|
-
#
|
8612
|
+
# To delete a DB instance in this case, first use the
|
8613
|
+
# `PromoteReadReplicaDBCluster` operation to promote the DB cluster so
|
8614
|
+
# that it's no longer a read replica. After the promotion completes,
|
8615
|
+
# use the `DeleteDBInstance` operation to delete the final instance in
|
8620
8616
|
# the DB cluster.
|
8621
8617
|
#
|
8618
|
+
# For RDS Custom DB instances, deleting the DB instance permanently
|
8619
|
+
# deletes the EC2 instance and the associated EBS volumes. Make sure
|
8620
|
+
# that you don't terminate or delete these resources before you delete
|
8621
|
+
# the DB instance. Otherwise, deleting the DB instance and creation of
|
8622
|
+
# the final snapshot might fail.
|
8623
|
+
#
|
8622
8624
|
# @option params [required, String] :db_instance_identifier
|
8623
8625
|
# The DB instance identifier for the DB instance to be deleted. This
|
8624
8626
|
# parameter isn't case-sensitive.
|
@@ -8630,12 +8632,11 @@ module Aws::RDS
|
|
8630
8632
|
# ^
|
8631
8633
|
#
|
8632
8634
|
# @option params [Boolean] :skip_final_snapshot
|
8633
|
-
#
|
8634
|
-
#
|
8635
|
-
#
|
8636
|
-
#
|
8637
|
-
#
|
8638
|
-
# created.
|
8635
|
+
# Specifies whether to skip the creation of a final DB snapshot before
|
8636
|
+
# deleting the instance. If you enable this parameter, RDS doesn't
|
8637
|
+
# create a DB snapshot. If you don't enable this parameter, RDS creates
|
8638
|
+
# a DB snapshot before the DB instance is deleted. By default, skip
|
8639
|
+
# isn't enabled, and the DB snapshot is created.
|
8639
8640
|
#
|
8640
8641
|
# <note markdown="1"> If you don't enable this parameter, you must specify the
|
8641
8642
|
# `FinalDBSnapshotIdentifier` parameter.
|
@@ -8673,10 +8674,10 @@ module Aws::RDS
|
|
8673
8674
|
# * Can't be specified when deleting a read replica.
|
8674
8675
|
#
|
8675
8676
|
# @option params [Boolean] :delete_automated_backups
|
8676
|
-
#
|
8677
|
-
#
|
8678
|
-
#
|
8679
|
-
#
|
8677
|
+
# Specifies whether to remove automated backups immediately after the DB
|
8678
|
+
# instance is deleted. This parameter isn't case-sensitive. The default
|
8679
|
+
# is to remove automated backups immediately after the DB instance is
|
8680
|
+
# deleted.
|
8680
8681
|
#
|
8681
8682
|
# @return [Types::DeleteDBInstanceResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
8682
8683
|
#
|
@@ -10000,8 +10001,8 @@ module Aws::RDS
|
|
10000
10001
|
req.send_request(options)
|
10001
10002
|
end
|
10002
10003
|
|
10003
|
-
# Lists the set of CA certificates provided by
|
10004
|
-
# Amazon Web Services account.
|
10004
|
+
# Lists the set of certificate authority (CA) certificates provided by
|
10005
|
+
# Amazon RDS for this Amazon Web Services account.
|
10005
10006
|
#
|
10006
10007
|
# For more information, see [Using SSL/TLS to encrypt a connection to a
|
10007
10008
|
# DB instance][1] in the *Amazon RDS User Guide* and [ Using SSL/TLS to
|
@@ -10045,6 +10046,7 @@ module Aws::RDS
|
|
10045
10046
|
#
|
10046
10047
|
# @return [Types::CertificateMessage] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
10047
10048
|
#
|
10049
|
+
# * {Types::CertificateMessage#default_certificate_for_new_launches #default_certificate_for_new_launches} => String
|
10048
10050
|
# * {Types::CertificateMessage#certificates #certificates} => Array<Types::Certificate>
|
10049
10051
|
# * {Types::CertificateMessage#marker #marker} => String
|
10050
10052
|
#
|
@@ -10117,6 +10119,7 @@ module Aws::RDS
|
|
10117
10119
|
#
|
10118
10120
|
# @example Response structure
|
10119
10121
|
#
|
10122
|
+
# resp.default_certificate_for_new_launches #=> String
|
10120
10123
|
# resp.certificates #=> Array
|
10121
10124
|
# resp.certificates[0].certificate_identifier #=> String
|
10122
10125
|
# resp.certificates[0].certificate_type #=> String
|
@@ -10713,8 +10716,15 @@ module Aws::RDS
|
|
10713
10716
|
# ^
|
10714
10717
|
#
|
10715
10718
|
# @option params [String] :source
|
10716
|
-
# A
|
10717
|
-
#
|
10719
|
+
# A specific source to return parameters for.
|
10720
|
+
#
|
10721
|
+
# Valid Values:
|
10722
|
+
#
|
10723
|
+
# * `customer`
|
10724
|
+
#
|
10725
|
+
# * `engine`
|
10726
|
+
#
|
10727
|
+
# * `service`
|
10718
10728
|
#
|
10719
10729
|
# @option params [Array<Types::Filter>] :filters
|
10720
10730
|
# This parameter isn't currently supported.
|
@@ -10995,19 +11005,19 @@ module Aws::RDS
|
|
10995
11005
|
# specified by `MaxRecords`.
|
10996
11006
|
#
|
10997
11007
|
# @option params [Boolean] :include_shared
|
10998
|
-
#
|
10999
|
-
#
|
11000
|
-
#
|
11001
|
-
#
|
11008
|
+
# Specifies whether to include shared manual DB cluster snapshots from
|
11009
|
+
# other Amazon Web Services accounts that this Amazon Web Services
|
11010
|
+
# account has been given permission to copy or restore. By default,
|
11011
|
+
# these snapshots are not included.
|
11002
11012
|
#
|
11003
11013
|
# You can give an Amazon Web Services account permission to restore a
|
11004
11014
|
# manual DB cluster snapshot from another Amazon Web Services account by
|
11005
11015
|
# the `ModifyDBClusterSnapshotAttribute` API action.
|
11006
11016
|
#
|
11007
11017
|
# @option params [Boolean] :include_public
|
11008
|
-
#
|
11009
|
-
#
|
11010
|
-
#
|
11018
|
+
# Specifies whether to include manual DB cluster snapshots that are
|
11019
|
+
# public and can be copied or restored by any Amazon Web Services
|
11020
|
+
# account. By default, the public snapshots are not included.
|
11011
11021
|
#
|
11012
11022
|
# You can share a manual DB cluster snapshot as public by using the
|
11013
11023
|
# ModifyDBClusterSnapshotAttribute API action.
|
@@ -11485,10 +11495,10 @@ module Aws::RDS
|
|
11485
11495
|
req.send_request(options)
|
11486
11496
|
end
|
11487
11497
|
|
11488
|
-
#
|
11498
|
+
# Describes the properties of specific versions of DB engines.
|
11489
11499
|
#
|
11490
11500
|
# @option params [String] :engine
|
11491
|
-
# The database engine to return.
|
11501
|
+
# The database engine to return version details for.
|
11492
11502
|
#
|
11493
11503
|
# Valid Values:
|
11494
11504
|
#
|
@@ -11521,7 +11531,7 @@ module Aws::RDS
|
|
11521
11531
|
# * `sqlserver-web`
|
11522
11532
|
#
|
11523
11533
|
# @option params [String] :engine_version
|
11524
|
-
#
|
11534
|
+
# A specific database engine version to return details for.
|
11525
11535
|
#
|
11526
11536
|
# Example: `5.1.49`
|
11527
11537
|
#
|
@@ -11531,7 +11541,7 @@ module Aws::RDS
|
|
11531
11541
|
#
|
11532
11542
|
# Constraints:
|
11533
11543
|
#
|
11534
|
-
# * If supplied, must match an existing
|
11544
|
+
# * If supplied, must match an existing DB parameter group family.
|
11535
11545
|
#
|
11536
11546
|
# ^
|
11537
11547
|
#
|
@@ -11589,37 +11599,34 @@ module Aws::RDS
|
|
11589
11599
|
# marker, up to the value specified by `MaxRecords`.
|
11590
11600
|
#
|
11591
11601
|
# @option params [Boolean] :default_only
|
11592
|
-
#
|
11593
|
-
#
|
11602
|
+
# Specifies whether to return only the default version of the specified
|
11603
|
+
# engine or the engine and major version combination.
|
11594
11604
|
#
|
11595
11605
|
# @option params [Boolean] :list_supported_character_sets
|
11596
|
-
#
|
11597
|
-
#
|
11606
|
+
# Specifies whether to list the supported character sets for each engine
|
11607
|
+
# version.
|
11598
11608
|
#
|
11599
11609
|
# If this parameter is enabled and the requested engine supports the
|
11600
11610
|
# `CharacterSetName` parameter for `CreateDBInstance`, the response
|
11601
11611
|
# includes a list of supported character sets for each engine version.
|
11602
11612
|
#
|
11603
11613
|
# For RDS Custom, the default is not to list supported character sets.
|
11604
|
-
# If you
|
11605
|
-
# no results.
|
11614
|
+
# If you enable this parameter, RDS Custom returns no results.
|
11606
11615
|
#
|
11607
11616
|
# @option params [Boolean] :list_supported_timezones
|
11608
|
-
#
|
11609
|
-
#
|
11617
|
+
# Specifies whether to list the supported time zones for each engine
|
11618
|
+
# version.
|
11610
11619
|
#
|
11611
11620
|
# If this parameter is enabled and the requested engine supports the
|
11612
11621
|
# `TimeZone` parameter for `CreateDBInstance`, the response includes a
|
11613
11622
|
# list of supported time zones for each engine version.
|
11614
11623
|
#
|
11615
11624
|
# For RDS Custom, the default is not to list supported time zones. If
|
11616
|
-
# you
|
11617
|
-
# results.
|
11625
|
+
# you enable this parameter, RDS Custom returns no results.
|
11618
11626
|
#
|
11619
11627
|
# @option params [Boolean] :include_all
|
11620
|
-
#
|
11621
|
-
# available
|
11622
|
-
# versions.
|
11628
|
+
# Specifies whether to also list the engine versions that aren't
|
11629
|
+
# available. The default is to list only available engine versions.
|
11623
11630
|
#
|
11624
11631
|
# @return [Types::DBEngineVersionMessage] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
11625
11632
|
#
|
@@ -13147,10 +13154,10 @@ module Aws::RDS
|
|
13147
13154
|
# specified by `MaxRecords`.
|
13148
13155
|
#
|
13149
13156
|
# @option params [Boolean] :include_shared
|
13150
|
-
#
|
13151
|
-
#
|
13152
|
-
#
|
13153
|
-
#
|
13157
|
+
# Specifies whether to include shared manual DB cluster snapshots from
|
13158
|
+
# other Amazon Web Services accounts that this Amazon Web Services
|
13159
|
+
# account has been given permission to copy or restore. By default,
|
13160
|
+
# these snapshots are not included.
|
13154
13161
|
#
|
13155
13162
|
# You can give an Amazon Web Services account permission to restore a
|
13156
13163
|
# manual DB snapshot from another Amazon Web Services account by using
|
@@ -13159,9 +13166,9 @@ module Aws::RDS
|
|
13159
13166
|
# This setting doesn't apply to RDS Custom.
|
13160
13167
|
#
|
13161
13168
|
# @option params [Boolean] :include_public
|
13162
|
-
#
|
13163
|
-
#
|
13164
|
-
#
|
13169
|
+
# Specifies whether to include manual DB cluster snapshots that are
|
13170
|
+
# public and can be copied or restored by any Amazon Web Services
|
13171
|
+
# account. By default, the public snapshots are not included.
|
13165
13172
|
#
|
13166
13173
|
# You can share a manual DB snapshot as public by using the
|
13167
13174
|
# ModifyDBSnapshotAttribute API.
|
@@ -13740,7 +13747,7 @@ module Aws::RDS
|
|
13740
13747
|
# The type of source that is generating the events. For RDS Proxy
|
13741
13748
|
# events, specify `db-proxy`.
|
13742
13749
|
#
|
13743
|
-
# Valid
|
13750
|
+
# Valid Values: `db-instance` \| `db-cluster` \| `db-parameter-group` \|
|
13744
13751
|
# `db-security-group` \| `db-snapshot` \| `db-cluster-snapshot` \|
|
13745
13752
|
# `db-proxy`
|
13746
13753
|
#
|
@@ -14809,8 +14816,8 @@ module Aws::RDS
|
|
14809
14816
|
# This setting doesn't apply to RDS Custom.
|
14810
14817
|
#
|
14811
14818
|
# @option params [Boolean] :vpc
|
14812
|
-
#
|
14813
|
-
#
|
14819
|
+
# Specifies whether to show only VPC or non-VPC offerings. RDS Custom
|
14820
|
+
# supports only VPC offerings.
|
14814
14821
|
#
|
14815
14822
|
# RDS Custom supports only VPC offerings. If you describe non-VPC
|
14816
14823
|
# offerings for RDS Custom, the output shows VPC offerings.
|
@@ -15098,8 +15105,8 @@ module Aws::RDS
|
|
15098
15105
|
# Valid Values: `"Partial Upfront" | "All Upfront" | "No Upfront" `
|
15099
15106
|
#
|
15100
15107
|
# @option params [Boolean] :multi_az
|
15101
|
-
#
|
15102
|
-
#
|
15108
|
+
# Specifies whether to show only those reservations that support
|
15109
|
+
# Multi-AZ.
|
15103
15110
|
#
|
15104
15111
|
# @option params [String] :lease_id
|
15105
15112
|
# The lease identifier filter value. Specify this parameter to show only
|
@@ -15260,8 +15267,8 @@ module Aws::RDS
|
|
15260
15267
|
# Valid Values: `"Partial Upfront" | "All Upfront" | "No Upfront" `
|
15261
15268
|
#
|
15262
15269
|
# @option params [Boolean] :multi_az
|
15263
|
-
#
|
15264
|
-
#
|
15270
|
+
# Specifies whether to show only those reservations that support
|
15271
|
+
# Multi-AZ.
|
15265
15272
|
#
|
15266
15273
|
# @option params [Array<Types::Filter>] :filters
|
15267
15274
|
# This parameter isn't currently supported.
|
@@ -15808,12 +15815,12 @@ module Aws::RDS
|
|
15808
15815
|
# [2]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html
|
15809
15816
|
#
|
15810
15817
|
# @option params [required, String] :db_cluster_identifier
|
15811
|
-
#
|
15812
|
-
# case-sensitive.
|
15818
|
+
# The identifier of the DB cluster to force a failover for. This
|
15819
|
+
# parameter isn't case-sensitive.
|
15813
15820
|
#
|
15814
15821
|
# Constraints:
|
15815
15822
|
#
|
15816
|
-
# * Must match the identifier of an existing
|
15823
|
+
# * Must match the identifier of an existing DB cluster.
|
15817
15824
|
#
|
15818
15825
|
# ^
|
15819
15826
|
#
|
@@ -16301,9 +16308,9 @@ module Aws::RDS
|
|
16301
16308
|
# command or the `DescribeCertificates` API operation.
|
16302
16309
|
#
|
16303
16310
|
# @option params [Boolean] :remove_customer_override
|
16304
|
-
#
|
16305
|
-
#
|
16306
|
-
#
|
16311
|
+
# Specifies whether to remove the override for the default certificate.
|
16312
|
+
# If the override is removed, the default certificate is the system
|
16313
|
+
# default.
|
16307
16314
|
#
|
16308
16315
|
# @return [Types::ModifyCertificatesResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
16309
16316
|
#
|
@@ -16912,7 +16919,7 @@ module Aws::RDS
|
|
16912
16919
|
# @option params [Boolean] :allow_major_version_upgrade
|
16913
16920
|
# Specifies whether major version upgrades are allowed.
|
16914
16921
|
#
|
16915
|
-
# Valid for Cluster Type: Aurora DB clusters
|
16922
|
+
# Valid for Cluster Type: Aurora DB clusters and Multi-AZ DB clusters
|
16916
16923
|
#
|
16917
16924
|
# Constraints:
|
16918
16925
|
#
|
@@ -17997,6 +18004,17 @@ module Aws::RDS
|
|
17997
18004
|
#
|
17998
18005
|
# Default: Uses existing setting
|
17999
18006
|
#
|
18007
|
+
# Constraints:
|
18008
|
+
#
|
18009
|
+
# * If you are modifying the DB instance class and upgrading the engine
|
18010
|
+
# version at the same time, the currently running engine version must
|
18011
|
+
# be supported on the specified DB instance class. Otherwise, the
|
18012
|
+
# operation returns an error. In this case, first run the operation to
|
18013
|
+
# modify the DB instance class, and then run it again to upgrade the
|
18014
|
+
# engine version.
|
18015
|
+
#
|
18016
|
+
# ^
|
18017
|
+
#
|
18000
18018
|
#
|
18001
18019
|
#
|
18002
18020
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html
|
@@ -18265,6 +18283,17 @@ module Aws::RDS
|
|
18265
18283
|
# In RDS Custom for Oracle, this parameter is supported for read
|
18266
18284
|
# replicas only if they are in the `PATCH_DB_FAILURE` lifecycle.
|
18267
18285
|
#
|
18286
|
+
# Constraints:
|
18287
|
+
#
|
18288
|
+
# * If you are upgrading the engine version and modifying the DB
|
18289
|
+
# instance class at the same time, the currently running engine
|
18290
|
+
# version must be supported on the specified DB instance class.
|
18291
|
+
# Otherwise, the operation returns an error. In this case, first run
|
18292
|
+
# the operation to modify the DB instance class, and then run it again
|
18293
|
+
# to upgrade the engine version.
|
18294
|
+
#
|
18295
|
+
# ^
|
18296
|
+
#
|
18268
18297
|
# @option params [Boolean] :allow_major_version_upgrade
|
18269
18298
|
# Specifies whether major version upgrades are allowed. Changing this
|
18270
18299
|
# parameter doesn't result in an outage and the change is
|
@@ -20058,7 +20087,7 @@ module Aws::RDS
|
|
20058
20087
|
# set this parameter to db-instance. For RDS Proxy events, specify
|
20059
20088
|
# `db-proxy`. If this value isn't specified, all events are returned.
|
20060
20089
|
#
|
20061
|
-
# Valid
|
20090
|
+
# Valid Values: `db-instance` \| `db-cluster` \| `db-parameter-group` \|
|
20062
20091
|
# `db-security-group` \| `db-snapshot` \| `db-cluster-snapshot` \|
|
20063
20092
|
# `db-proxy`
|
20064
20093
|
#
|
@@ -20073,7 +20102,7 @@ module Aws::RDS
|
|
20073
20102
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Events.html
|
20074
20103
|
#
|
20075
20104
|
# @option params [Boolean] :enabled
|
20076
|
-
#
|
20105
|
+
# Specifies whether to activate the subscription.
|
20077
20106
|
#
|
20078
20107
|
# @return [Types::ModifyEventSubscriptionResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
20079
20108
|
#
|
@@ -20305,9 +20334,8 @@ module Aws::RDS
|
|
20305
20334
|
# Options in this list are removed from the option group.
|
20306
20335
|
#
|
20307
20336
|
# @option params [Boolean] :apply_immediately
|
20308
|
-
#
|
20309
|
-
#
|
20310
|
-
# the option group.
|
20337
|
+
# Specifies whether to apply the change immediately or during the next
|
20338
|
+
# maintenance window for each instance associated with the option group.
|
20311
20339
|
#
|
20312
20340
|
# @return [Types::ModifyOptionGroupResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
20313
20341
|
#
|
@@ -21138,8 +21166,7 @@ module Aws::RDS
|
|
21138
21166
|
# ^
|
21139
21167
|
#
|
21140
21168
|
# @option params [Boolean] :force_failover
|
21141
|
-
#
|
21142
|
-
# Multi-AZ failover.
|
21169
|
+
# Specifies whether the reboot is conducted through a Multi-AZ failover.
|
21143
21170
|
#
|
21144
21171
|
# Constraint: You can't enable force failover if the instance isn't
|
21145
21172
|
# configured for Multi-AZ.
|
@@ -21749,10 +21776,9 @@ module Aws::RDS
|
|
21749
21776
|
# The name of the DB cluster parameter group to reset.
|
21750
21777
|
#
|
21751
21778
|
# @option params [Boolean] :reset_all_parameters
|
21752
|
-
#
|
21753
|
-
#
|
21754
|
-
#
|
21755
|
-
# `Parameters` parameter.
|
21779
|
+
# Specifies whether to reset all parameters in the DB cluster parameter
|
21780
|
+
# group to their default values. You can't use this parameter if there
|
21781
|
+
# is a list of parameter names specified for the `Parameters` parameter.
|
21756
21782
|
#
|
21757
21783
|
# @option params [Array<Types::Parameter>] :parameters
|
21758
21784
|
# A list of parameter names in the DB cluster parameter group to reset
|
@@ -21833,9 +21859,9 @@ module Aws::RDS
|
|
21833
21859
|
# ^
|
21834
21860
|
#
|
21835
21861
|
# @option params [Boolean] :reset_all_parameters
|
21836
|
-
#
|
21837
|
-
#
|
21838
|
-
#
|
21862
|
+
# Specifies whether to reset all parameters in the DB parameter group to
|
21863
|
+
# default values. By default, all parameters in the DB parameter group
|
21864
|
+
# are reset to default values.
|
21839
21865
|
#
|
21840
21866
|
# @option params [Array<Types::Parameter>] :parameters
|
21841
21867
|
# To reset the entire DB parameter group, specify the `DBParameterGroup`
|
@@ -22113,7 +22139,7 @@ module Aws::RDS
|
|
22113
22139
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html
|
22114
22140
|
#
|
22115
22141
|
# @option params [Boolean] :storage_encrypted
|
22116
|
-
#
|
22142
|
+
# Specifies whether the restored DB cluster is encrypted.
|
22117
22143
|
#
|
22118
22144
|
# @option params [String] :kms_key_id
|
22119
22145
|
# The Amazon Web Services KMS key identifier for an encrypted DB
|
@@ -22131,9 +22157,9 @@ module Aws::RDS
|
|
22131
22157
|
# default KMS key for each Amazon Web Services Region.
|
22132
22158
|
#
|
22133
22159
|
# @option params [Boolean] :enable_iam_database_authentication
|
22134
|
-
#
|
22135
|
-
#
|
22136
|
-
#
|
22160
|
+
# Specifies whether to enable mapping of Amazon Web Services Identity
|
22161
|
+
# and Access Management (IAM) accounts to database accounts. By default,
|
22162
|
+
# mapping isn't enabled.
|
22137
22163
|
#
|
22138
22164
|
# For more information, see [ IAM Database Authentication][1] in the
|
22139
22165
|
# *Amazon Aurora User Guide*.
|
@@ -22146,7 +22172,7 @@ module Aws::RDS
|
|
22146
22172
|
# The identifier for the database engine that was backed up to create
|
22147
22173
|
# the files stored in the Amazon S3 bucket.
|
22148
22174
|
#
|
22149
|
-
# Valid
|
22175
|
+
# Valid Values: `mysql`
|
22150
22176
|
#
|
22151
22177
|
# @option params [required, String] :source_engine_version
|
22152
22178
|
# The version of the database that the backup files were created from.
|
@@ -22205,14 +22231,13 @@ module Aws::RDS
|
|
22205
22231
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch
|
22206
22232
|
#
|
22207
22233
|
# @option params [Boolean] :deletion_protection
|
22208
|
-
#
|
22209
|
-
#
|
22210
|
-
#
|
22234
|
+
# Specifies whether to enable deletion protection for the DB cluster.
|
22235
|
+
# The database can't be deleted when deletion protection is enabled. By
|
22236
|
+
# default, deletion protection isn't enabled.
|
22211
22237
|
#
|
22212
22238
|
# @option params [Boolean] :copy_tags_to_snapshot
|
22213
|
-
#
|
22214
|
-
#
|
22215
|
-
# copy them.
|
22239
|
+
# Specifies whether to copy all tags from the restored DB cluster to
|
22240
|
+
# snapshots of the restored DB cluster. The default is not to copy them.
|
22216
22241
|
#
|
22217
22242
|
# @option params [String] :domain
|
22218
22243
|
# Specify the Active Directory directory ID to restore the DB cluster
|
@@ -22245,7 +22270,7 @@ module Aws::RDS
|
|
22245
22270
|
# @option params [String] :network_type
|
22246
22271
|
# The network type of the DB cluster.
|
22247
22272
|
#
|
22248
|
-
# Valid
|
22273
|
+
# Valid Values:
|
22249
22274
|
#
|
22250
22275
|
# * `IPV4`
|
22251
22276
|
#
|
@@ -22263,8 +22288,8 @@ module Aws::RDS
|
|
22263
22288
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html
|
22264
22289
|
#
|
22265
22290
|
# @option params [Boolean] :manage_master_user_password
|
22266
|
-
#
|
22267
|
-
#
|
22291
|
+
# Specifies whether to manage the master user password with Amazon Web
|
22292
|
+
# Services Secrets Manager.
|
22268
22293
|
#
|
22269
22294
|
# For more information, see [Password management with Amazon Web
|
22270
22295
|
# Services Secrets Manager][1] in the *Amazon RDS User Guide* and
|
@@ -22309,7 +22334,7 @@ module Aws::RDS
|
|
22309
22334
|
# @option params [String] :storage_type
|
22310
22335
|
# Specifies the storage type to be associated with the DB cluster.
|
22311
22336
|
#
|
22312
|
-
# Valid
|
22337
|
+
# Valid Values: `aurora`, `aurora-iopt1`
|
22313
22338
|
#
|
22314
22339
|
# Default: `aurora`
|
22315
22340
|
#
|
@@ -22759,9 +22784,9 @@ module Aws::RDS
|
|
22759
22784
|
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
22760
22785
|
#
|
22761
22786
|
# @option params [Boolean] :enable_iam_database_authentication
|
22762
|
-
#
|
22763
|
-
#
|
22764
|
-
#
|
22787
|
+
# Specifies whether to enable mapping of Amazon Web Services Identity
|
22788
|
+
# and Access Management (IAM) accounts to database accounts. By default,
|
22789
|
+
# mapping isn't enabled.
|
22765
22790
|
#
|
22766
22791
|
# For more information, see [ IAM Database Authentication][1] in the
|
22767
22792
|
# *Amazon Aurora User Guide*.
|
@@ -22864,24 +22889,23 @@ module Aws::RDS
|
|
22864
22889
|
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
22865
22890
|
#
|
22866
22891
|
# @option params [Boolean] :deletion_protection
|
22867
|
-
#
|
22868
|
-
#
|
22869
|
-
#
|
22892
|
+
# Specifies whether to enable deletion protection for the DB cluster.
|
22893
|
+
# The database can't be deleted when deletion protection is enabled. By
|
22894
|
+
# default, deletion protection isn't enabled.
|
22870
22895
|
#
|
22871
22896
|
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
22872
22897
|
#
|
22873
22898
|
# @option params [Boolean] :copy_tags_to_snapshot
|
22874
|
-
#
|
22875
|
-
#
|
22876
|
-
# copy them.
|
22899
|
+
# Specifies whether to copy all tags from the restored DB cluster to
|
22900
|
+
# snapshots of the restored DB cluster. The default is not to copy them.
|
22877
22901
|
#
|
22878
22902
|
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
22879
22903
|
#
|
22880
22904
|
# @option params [String] :domain
|
22881
|
-
#
|
22882
|
-
#
|
22883
|
-
#
|
22884
|
-
#
|
22905
|
+
# The Active Directory directory ID to restore the DB cluster in. The
|
22906
|
+
# domain must be created prior to this operation. Currently, only MySQL,
|
22907
|
+
# Microsoft SQL Server, Oracle, and PostgreSQL DB instances can be
|
22908
|
+
# created in an Active Directory Domain.
|
22885
22909
|
#
|
22886
22910
|
# For more information, see [ Kerberos Authentication][1] in the *Amazon
|
22887
22911
|
# RDS User Guide*.
|
@@ -22893,8 +22917,8 @@ module Aws::RDS
|
|
22893
22917
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/kerberos-authentication.html
|
22894
22918
|
#
|
22895
22919
|
# @option params [String] :domain_iam_role_name
|
22896
|
-
#
|
22897
|
-
#
|
22920
|
+
# The name of the IAM role to be used when making API calls to the
|
22921
|
+
# Directory Service.
|
22898
22922
|
#
|
22899
22923
|
# Valid for: Aurora DB clusters only
|
22900
22924
|
#
|
@@ -22919,7 +22943,7 @@ module Aws::RDS
|
|
22919
22943
|
# When specified for a Multi-AZ DB cluster, a value for the `Iops`
|
22920
22944
|
# parameter is required.
|
22921
22945
|
#
|
22922
|
-
# Valid
|
22946
|
+
# Valid Values: `aurora`, `aurora-iopt1` (Aurora DB clusters); `io1`
|
22923
22947
|
# (Multi-AZ DB clusters)
|
22924
22948
|
#
|
22925
22949
|
# Default: `aurora` (Aurora DB clusters); `io1` (Multi-AZ DB clusters)
|
@@ -22944,7 +22968,7 @@ module Aws::RDS
|
|
22944
22968
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html#USER_PIOPS
|
22945
22969
|
#
|
22946
22970
|
# @option params [Boolean] :publicly_accessible
|
22947
|
-
#
|
22971
|
+
# Specifies whether the DB cluster is publicly accessible.
|
22948
22972
|
#
|
22949
22973
|
# When the DB cluster is publicly accessible, its Domain Name System
|
22950
22974
|
# (DNS) endpoint resolves to the private IP address from within the DB
|
@@ -22994,7 +23018,7 @@ module Aws::RDS
|
|
22994
23018
|
# @option params [String] :network_type
|
22995
23019
|
# The network type of the DB cluster.
|
22996
23020
|
#
|
22997
|
-
# Valid
|
23021
|
+
# Valid Values:
|
22998
23022
|
#
|
22999
23023
|
# * `IPV4`
|
23000
23024
|
#
|
@@ -23352,9 +23376,9 @@ module Aws::RDS
|
|
23352
23376
|
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
23353
23377
|
#
|
23354
23378
|
# @option params [Boolean] :use_latest_restorable_time
|
23355
|
-
#
|
23356
|
-
#
|
23357
|
-
#
|
23379
|
+
# Specifies whether to restore the DB cluster to the latest restorable
|
23380
|
+
# backup time. By default, the DB cluster isn't restored to the latest
|
23381
|
+
# restorable backup time.
|
23358
23382
|
#
|
23359
23383
|
# Constraints: Can't be specified if `RestoreToTime` parameter is
|
23360
23384
|
# provided.
|
@@ -23429,9 +23453,9 @@ module Aws::RDS
|
|
23429
23453
|
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
23430
23454
|
#
|
23431
23455
|
# @option params [Boolean] :enable_iam_database_authentication
|
23432
|
-
#
|
23433
|
-
#
|
23434
|
-
#
|
23456
|
+
# Specifies whether to enable mapping of Amazon Web Services Identity
|
23457
|
+
# and Access Management (IAM) accounts to database accounts. By default,
|
23458
|
+
# mapping isn't enabled.
|
23435
23459
|
#
|
23436
23460
|
# For more information, see [ IAM Database Authentication][1] in the
|
23437
23461
|
# *Amazon Aurora User Guide*.
|
@@ -23494,9 +23518,11 @@ module Aws::RDS
|
|
23494
23518
|
# [2]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch
|
23495
23519
|
#
|
23496
23520
|
# @option params [String] :db_cluster_parameter_group_name
|
23497
|
-
# The name of the DB cluster parameter group to associate with
|
23498
|
-
#
|
23499
|
-
#
|
23521
|
+
# The name of the custom DB cluster parameter group to associate with
|
23522
|
+
# this DB cluster.
|
23523
|
+
#
|
23524
|
+
# If the `DBClusterParameterGroupName` parameter is omitted, the default
|
23525
|
+
# DB cluster parameter group for the specified engine is used.
|
23500
23526
|
#
|
23501
23527
|
# Constraints:
|
23502
23528
|
#
|
@@ -23512,22 +23538,21 @@ module Aws::RDS
|
|
23512
23538
|
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
23513
23539
|
#
|
23514
23540
|
# @option params [Boolean] :deletion_protection
|
23515
|
-
#
|
23516
|
-
#
|
23517
|
-
#
|
23541
|
+
# Specifies whether to enable deletion protection for the DB cluster.
|
23542
|
+
# The database can't be deleted when deletion protection is enabled. By
|
23543
|
+
# default, deletion protection isn't enabled.
|
23518
23544
|
#
|
23519
23545
|
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
23520
23546
|
#
|
23521
23547
|
# @option params [Boolean] :copy_tags_to_snapshot
|
23522
|
-
#
|
23523
|
-
#
|
23524
|
-
# copy them.
|
23548
|
+
# Specifies whether to copy all tags from the restored DB cluster to
|
23549
|
+
# snapshots of the restored DB cluster. The default is not to copy them.
|
23525
23550
|
#
|
23526
23551
|
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
23527
23552
|
#
|
23528
23553
|
# @option params [String] :domain
|
23529
|
-
#
|
23530
|
-
#
|
23554
|
+
# The Active Directory directory ID to restore the DB cluster in. The
|
23555
|
+
# domain must be created prior to this operation.
|
23531
23556
|
#
|
23532
23557
|
# For Amazon Aurora DB clusters, Amazon RDS can use Kerberos
|
23533
23558
|
# Authentication to authenticate users that connect to the DB cluster.
|
@@ -23541,8 +23566,8 @@ module Aws::RDS
|
|
23541
23566
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/kerberos-authentication.html
|
23542
23567
|
#
|
23543
23568
|
# @option params [String] :domain_iam_role_name
|
23544
|
-
#
|
23545
|
-
#
|
23569
|
+
# The name of the IAM role to be used when making API calls to the
|
23570
|
+
# Directory Service.
|
23546
23571
|
#
|
23547
23572
|
# Valid for: Aurora DB clusters only
|
23548
23573
|
#
|
@@ -23570,7 +23595,7 @@ module Aws::RDS
|
|
23570
23595
|
# database engines.
|
23571
23596
|
#
|
23572
23597
|
# For the full list of DB instance classes, and availability for your
|
23573
|
-
# engine, see [DB instance class][1] in the *Amazon RDS User Guide
|
23598
|
+
# engine, see [DB instance class][1] in the *Amazon RDS User Guide*.
|
23574
23599
|
#
|
23575
23600
|
# Valid for: Multi-AZ DB clusters only
|
23576
23601
|
#
|
@@ -23584,7 +23609,7 @@ module Aws::RDS
|
|
23584
23609
|
# When specified for a Multi-AZ DB cluster, a value for the `Iops`
|
23585
23610
|
# parameter is required.
|
23586
23611
|
#
|
23587
|
-
# Valid
|
23612
|
+
# Valid Values: `aurora`, `aurora-iopt1` (Aurora DB clusters); `io1`
|
23588
23613
|
# (Multi-AZ DB clusters)
|
23589
23614
|
#
|
23590
23615
|
# Default: `aurora` (Aurora DB clusters); `io1` (Multi-AZ DB clusters)
|
@@ -23592,7 +23617,7 @@ module Aws::RDS
|
|
23592
23617
|
# Valid for: Aurora DB clusters and Multi-AZ DB clusters
|
23593
23618
|
#
|
23594
23619
|
# @option params [Boolean] :publicly_accessible
|
23595
|
-
#
|
23620
|
+
# Specifies whether the DB cluster is publicly accessible.
|
23596
23621
|
#
|
23597
23622
|
# When the DB cluster is publicly accessible, its Domain Name System
|
23598
23623
|
# (DNS) endpoint resolves to the private IP address from within the DB
|
@@ -23659,7 +23684,7 @@ module Aws::RDS
|
|
23659
23684
|
# @option params [String] :network_type
|
23660
23685
|
# The network type of the DB cluster.
|
23661
23686
|
#
|
23662
|
-
# Valid
|
23687
|
+
# Valid Values:
|
23663
23688
|
#
|
23664
23689
|
# * `IPV4`
|
23665
23690
|
#
|
@@ -24023,8 +24048,7 @@ module Aws::RDS
|
|
24023
24048
|
# Example: `mydbsubnetgroup`
|
24024
24049
|
#
|
24025
24050
|
# @option params [Boolean] :multi_az
|
24026
|
-
#
|
24027
|
-
# deployment.
|
24051
|
+
# Specifies whether the DB instance is a Multi-AZ deployment.
|
24028
24052
|
#
|
24029
24053
|
# This setting doesn't apply to RDS Custom.
|
24030
24054
|
#
|
@@ -24032,7 +24056,7 @@ module Aws::RDS
|
|
24032
24056
|
# DB instance is a Multi-AZ deployment.
|
24033
24057
|
#
|
24034
24058
|
# @option params [Boolean] :publicly_accessible
|
24035
|
-
#
|
24059
|
+
# Specifies whether the DB instance is publicly accessible.
|
24036
24060
|
#
|
24037
24061
|
# When the DB instance is publicly accessible, its Domain Name System
|
24038
24062
|
# (DNS) endpoint resolves to the private IP address from within the DB
|
@@ -24048,8 +24072,8 @@ module Aws::RDS
|
|
24048
24072
|
# For more information, see CreateDBInstance.
|
24049
24073
|
#
|
24050
24074
|
# @option params [Boolean] :auto_minor_version_upgrade
|
24051
|
-
#
|
24052
|
-
#
|
24075
|
+
# Specifies whether to automatically apply minor version upgrades to the
|
24076
|
+
# DB instance during the maintenance window.
|
24053
24077
|
#
|
24054
24078
|
# If you restore an RDS Custom DB instance, you must disable this
|
24055
24079
|
# parameter.
|
@@ -24061,7 +24085,7 @@ module Aws::RDS
|
|
24061
24085
|
#
|
24062
24086
|
# Default: Same as source.
|
24063
24087
|
#
|
24064
|
-
# Valid
|
24088
|
+
# Valid Values: `license-included` \| `bring-your-own-license` \|
|
24065
24089
|
# `general-public-license`
|
24066
24090
|
#
|
24067
24091
|
# @option params [String] :db_name
|
@@ -24144,7 +24168,7 @@ module Aws::RDS
|
|
24144
24168
|
# @option params [String] :storage_type
|
24145
24169
|
# Specifies the storage type to be associated with the DB instance.
|
24146
24170
|
#
|
24147
|
-
# Valid
|
24171
|
+
# Valid Values: `gp2 | gp3 | io1 | standard`
|
24148
24172
|
#
|
24149
24173
|
# If you specify `io1` or `gp3`, you must also include a value for the
|
24150
24174
|
# `Iops` parameter.
|
@@ -24213,6 +24237,10 @@ module Aws::RDS
|
|
24213
24237
|
#
|
24214
24238
|
# Constraints:
|
24215
24239
|
#
|
24240
|
+
# * Can't be longer than 64 characters.
|
24241
|
+
#
|
24242
|
+
# ^
|
24243
|
+
#
|
24216
24244
|
# Example:
|
24217
24245
|
# `arn:aws:secretsmanager:region:account-number:secret:myselfmanagedADtestsecret-123456`
|
24218
24246
|
#
|
@@ -24231,8 +24259,8 @@ module Aws::RDS
|
|
24231
24259
|
# Example: `123.124.125.126,234.235.236.237`
|
24232
24260
|
#
|
24233
24261
|
# @option params [Boolean] :copy_tags_to_snapshot
|
24234
|
-
#
|
24235
|
-
#
|
24262
|
+
# Specifies whether to copy all tags from the restored DB instance to
|
24263
|
+
# snapshots of the DB instance.
|
24236
24264
|
#
|
24237
24265
|
# In most cases, tags aren't copied by default. However, when you
|
24238
24266
|
# restore a DB instance from a DB snapshot, RDS checks whether you
|
@@ -24255,9 +24283,9 @@ module Aws::RDS
|
|
24255
24283
|
# This setting doesn't apply to RDS Custom DB instances.
|
24256
24284
|
#
|
24257
24285
|
# @option params [Boolean] :enable_iam_database_authentication
|
24258
|
-
#
|
24259
|
-
#
|
24260
|
-
#
|
24286
|
+
# Specifies whether to enable mapping of Amazon Web Services Identity
|
24287
|
+
# and Access Management (IAM) accounts to database accounts. By default,
|
24288
|
+
# mapping is disabled.
|
24261
24289
|
#
|
24262
24290
|
# For more information about IAM database authentication, see [ IAM
|
24263
24291
|
# Database Authentication for MySQL and PostgreSQL][1] in the *Amazon
|
@@ -24288,8 +24316,8 @@ module Aws::RDS
|
|
24288
24316
|
# This setting doesn't apply to RDS Custom.
|
24289
24317
|
#
|
24290
24318
|
# @option params [Boolean] :use_default_processor_features
|
24291
|
-
#
|
24292
|
-
#
|
24319
|
+
# Specifies whether the DB instance class of the DB instance uses its
|
24320
|
+
# default processor features.
|
24293
24321
|
#
|
24294
24322
|
# This setting doesn't apply to RDS Custom.
|
24295
24323
|
#
|
@@ -24312,18 +24340,18 @@ module Aws::RDS
|
|
24312
24340
|
# * Can't end with a hyphen or contain two consecutive hyphens.
|
24313
24341
|
#
|
24314
24342
|
# @option params [Boolean] :deletion_protection
|
24315
|
-
#
|
24316
|
-
#
|
24317
|
-
#
|
24318
|
-
#
|
24343
|
+
# Specifies whether to enable deletion protection for the DB instance.
|
24344
|
+
# The database can't be deleted when deletion protection is enabled. By
|
24345
|
+
# default, deletion protection isn't enabled. For more information, see
|
24346
|
+
# [ Deleting a DB Instance][1].
|
24319
24347
|
#
|
24320
24348
|
#
|
24321
24349
|
#
|
24322
24350
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_DeleteInstance.html
|
24323
24351
|
#
|
24324
24352
|
# @option params [Boolean] :enable_customer_owned_ip
|
24325
|
-
#
|
24326
|
-
#
|
24353
|
+
# Specifies whether to enable a customer-owned IP address (CoIP) for an
|
24354
|
+
# RDS on Outposts DB instance.
|
24327
24355
|
#
|
24328
24356
|
# A *CoIP* provides local or external connectivity to resources in your
|
24329
24357
|
# Outpost subnets through your on-premises network. For some use cases,
|
@@ -24383,7 +24411,7 @@ module Aws::RDS
|
|
24383
24411
|
# @option params [String] :network_type
|
24384
24412
|
# The network type of the DB instance.
|
24385
24413
|
#
|
24386
|
-
# Valid
|
24414
|
+
# Valid Values:
|
24387
24415
|
#
|
24388
24416
|
# * `IPV4`
|
24389
24417
|
#
|
@@ -24902,9 +24930,9 @@ module Aws::RDS
|
|
24902
24930
|
# Default: `3306`
|
24903
24931
|
#
|
24904
24932
|
# @option params [Boolean] :multi_az
|
24905
|
-
#
|
24906
|
-
#
|
24907
|
-
#
|
24933
|
+
# Specifies whether the DB instance is a Multi-AZ deployment. If the DB
|
24934
|
+
# instance is a Multi-AZ deployment, you can't set the
|
24935
|
+
# `AvailabilityZone` parameter.
|
24908
24936
|
#
|
24909
24937
|
# @option params [String] :engine_version
|
24910
24938
|
# The version number of the database engine to use. Choose the latest
|
@@ -24912,9 +24940,9 @@ module Aws::RDS
|
|
24912
24940
|
# versions, see `CreateDBInstance`, or call `DescribeDBEngineVersions`.
|
24913
24941
|
#
|
24914
24942
|
# @option params [Boolean] :auto_minor_version_upgrade
|
24915
|
-
#
|
24916
|
-
#
|
24917
|
-
#
|
24943
|
+
# Specifies whether to automatically apply minor engine upgrades to the
|
24944
|
+
# DB instance during the maintenance window. By default, minor engine
|
24945
|
+
# upgrades are not applied automatically.
|
24918
24946
|
#
|
24919
24947
|
# @option params [String] :license_model
|
24920
24948
|
# The license model for this DB instance. Use `general-public-license`.
|
@@ -24935,7 +24963,7 @@ module Aws::RDS
|
|
24935
24963
|
# engine is used.
|
24936
24964
|
#
|
24937
24965
|
# @option params [Boolean] :publicly_accessible
|
24938
|
-
#
|
24966
|
+
# Specifies whether the DB instance is publicly accessible.
|
24939
24967
|
#
|
24940
24968
|
# When the DB instance is publicly accessible, its Domain Name System
|
24941
24969
|
# (DNS) endpoint resolves to the private IP address from within the DB
|
@@ -24962,7 +24990,7 @@ module Aws::RDS
|
|
24962
24990
|
# @option params [String] :storage_type
|
24963
24991
|
# Specifies the storage type to be associated with the DB instance.
|
24964
24992
|
#
|
24965
|
-
# Valid
|
24993
|
+
# Valid Values: `gp2 | gp3 | io1 | standard`
|
24966
24994
|
#
|
24967
24995
|
# If you specify `io1` or `gp3`, you must also include a value for the
|
24968
24996
|
# `Iops` parameter.
|
@@ -24970,8 +24998,7 @@ module Aws::RDS
|
|
24970
24998
|
# Default: `io1` if the `Iops` parameter is specified; otherwise `gp2`
|
24971
24999
|
#
|
24972
25000
|
# @option params [Boolean] :storage_encrypted
|
24973
|
-
#
|
24974
|
-
# not.
|
25001
|
+
# Specifies whether the new DB instance is encrypted or not.
|
24975
25002
|
#
|
24976
25003
|
# @option params [String] :kms_key_id
|
24977
25004
|
# The Amazon Web Services KMS key identifier for an encrypted DB
|
@@ -24989,8 +25016,8 @@ module Aws::RDS
|
|
24989
25016
|
# default KMS key for each Amazon Web Services Region.
|
24990
25017
|
#
|
24991
25018
|
# @option params [Boolean] :copy_tags_to_snapshot
|
24992
|
-
#
|
24993
|
-
#
|
25019
|
+
# Specifies whether to copy all tags from the DB instance to snapshots
|
25020
|
+
# of the DB instance. By default, tags are not copied.
|
24994
25021
|
#
|
24995
25022
|
# @option params [Integer] :monitoring_interval
|
24996
25023
|
# The interval, in seconds, between points when Enhanced Monitoring
|
@@ -25019,9 +25046,9 @@ module Aws::RDS
|
|
25019
25046
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Monitoring.OS.html#USER_Monitoring.OS.Enabling
|
25020
25047
|
#
|
25021
25048
|
# @option params [Boolean] :enable_iam_database_authentication
|
25022
|
-
#
|
25023
|
-
#
|
25024
|
-
#
|
25049
|
+
# Specifies whether to enable mapping of Amazon Web Services Identity
|
25050
|
+
# and Access Management (IAM) accounts to database accounts. By default,
|
25051
|
+
# mapping isn't enabled.
|
25025
25052
|
#
|
25026
25053
|
# For more information about IAM database authentication, see [ IAM
|
25027
25054
|
# Database Authentication for MySQL and PostgreSQL][1] in the *Amazon
|
@@ -25055,8 +25082,7 @@ module Aws::RDS
|
|
25055
25082
|
# allow Amazon RDS to access your Amazon S3 bucket.
|
25056
25083
|
#
|
25057
25084
|
# @option params [Boolean] :enable_performance_insights
|
25058
|
-
#
|
25059
|
-
# DB instance.
|
25085
|
+
# Specifies whether to enable Performance Insights for the DB instance.
|
25060
25086
|
#
|
25061
25087
|
# For more information, see [Using Amazon Performance Insights][1] in
|
25062
25088
|
# the *Amazon RDS User Guide*.
|
@@ -25115,14 +25141,14 @@ module Aws::RDS
|
|
25115
25141
|
# instance class of the DB instance.
|
25116
25142
|
#
|
25117
25143
|
# @option params [Boolean] :use_default_processor_features
|
25118
|
-
#
|
25119
|
-
#
|
25144
|
+
# Specifies whether the DB instance class of the DB instance uses its
|
25145
|
+
# default processor features.
|
25120
25146
|
#
|
25121
25147
|
# @option params [Boolean] :deletion_protection
|
25122
|
-
#
|
25123
|
-
#
|
25124
|
-
#
|
25125
|
-
#
|
25148
|
+
# Specifies whether to enable deletion protection for the DB instance.
|
25149
|
+
# The database can't be deleted when deletion protection is enabled. By
|
25150
|
+
# default, deletion protection isn't enabled. For more information, see
|
25151
|
+
# [ Deleting a DB Instance][1].
|
25126
25152
|
#
|
25127
25153
|
#
|
25128
25154
|
#
|
@@ -25143,7 +25169,7 @@ module Aws::RDS
|
|
25143
25169
|
# @option params [String] :network_type
|
25144
25170
|
# The network type of the DB instance.
|
25145
25171
|
#
|
25146
|
-
# Valid
|
25172
|
+
# Valid Values:
|
25147
25173
|
#
|
25148
25174
|
# * `IPV4`
|
25149
25175
|
#
|
@@ -25166,8 +25192,8 @@ module Aws::RDS
|
|
25166
25192
|
# This setting doesn't apply to RDS Custom or Amazon Aurora.
|
25167
25193
|
#
|
25168
25194
|
# @option params [Boolean] :manage_master_user_password
|
25169
|
-
#
|
25170
|
-
#
|
25195
|
+
# Specifies whether to manage the master user password with Amazon Web
|
25196
|
+
# Services Secrets Manager.
|
25171
25197
|
#
|
25172
25198
|
# For more information, see [Password management with Amazon Web
|
25173
25199
|
# Services Secrets Manager][1] in the *Amazon RDS User Guide.*
|
@@ -25442,8 +25468,8 @@ module Aws::RDS
|
|
25442
25468
|
|
25443
25469
|
# Restores a DB instance to an arbitrary point in time. You can restore
|
25444
25470
|
# to any point in time before the time identified by the
|
25445
|
-
# LatestRestorableTime property. You can restore to a point up to the
|
25446
|
-
# number of days specified by the BackupRetentionPeriod property.
|
25471
|
+
# `LatestRestorableTime` property. You can restore to a point up to the
|
25472
|
+
# number of days specified by the `BackupRetentionPeriod` property.
|
25447
25473
|
#
|
25448
25474
|
# The target database is created with most of the original
|
25449
25475
|
# configuration, but in a system-selected Availability Zone, with the
|
@@ -25469,38 +25495,40 @@ module Aws::RDS
|
|
25469
25495
|
# ^
|
25470
25496
|
#
|
25471
25497
|
# @option params [required, String] :target_db_instance_identifier
|
25472
|
-
# The name of the new DB instance to
|
25498
|
+
# The name of the new DB instance to create.
|
25473
25499
|
#
|
25474
25500
|
# Constraints:
|
25475
25501
|
#
|
25476
|
-
# * Must contain from 1 to 63 letters, numbers, or hyphens
|
25502
|
+
# * Must contain from 1 to 63 letters, numbers, or hyphens.
|
25477
25503
|
#
|
25478
|
-
# * First character must be a letter
|
25504
|
+
# * First character must be a letter.
|
25479
25505
|
#
|
25480
|
-
# * Can't end with a hyphen or contain two consecutive hyphens
|
25506
|
+
# * Can't end with a hyphen or contain two consecutive hyphens.
|
25481
25507
|
#
|
25482
25508
|
# @option params [Time,DateTime,Date,Integer,String] :restore_time
|
25483
25509
|
# The date and time to restore from.
|
25484
25510
|
#
|
25485
|
-
# Valid Values: Value must be a time in Universal Coordinated Time (UTC)
|
25486
|
-
# format
|
25487
|
-
#
|
25488
25511
|
# Constraints:
|
25489
25512
|
#
|
25490
|
-
# * Must be
|
25513
|
+
# * Must be a time in Universal Coordinated Time (UTC) format.
|
25514
|
+
#
|
25515
|
+
# * Must be before the latest restorable time for the DB instance.
|
25491
25516
|
#
|
25492
25517
|
# * Can't be specified if the `UseLatestRestorableTime` parameter is
|
25493
|
-
# enabled
|
25518
|
+
# enabled.
|
25494
25519
|
#
|
25495
25520
|
# Example: `2009-09-07T23:45:00Z`
|
25496
25521
|
#
|
25497
25522
|
# @option params [Boolean] :use_latest_restorable_time
|
25498
|
-
#
|
25499
|
-
#
|
25500
|
-
#
|
25523
|
+
# Specifies whether the DB instance is restored from the latest backup
|
25524
|
+
# time. By default, the DB instance isn't restored from the latest
|
25525
|
+
# backup time.
|
25501
25526
|
#
|
25502
|
-
# Constraints:
|
25503
|
-
#
|
25527
|
+
# Constraints:
|
25528
|
+
#
|
25529
|
+
# * Can't be specified if the `RestoreTime` parameter is provided.
|
25530
|
+
#
|
25531
|
+
# ^
|
25504
25532
|
#
|
25505
25533
|
# @option params [String] :db_instance_class
|
25506
25534
|
# The compute and memory capacity of the Amazon RDS DB instance, for
|
@@ -25509,7 +25537,7 @@ module Aws::RDS
|
|
25509
25537
|
# list of DB instance classes, and availability for your engine, see [DB
|
25510
25538
|
# Instance Class][1] in the *Amazon RDS User Guide*.
|
25511
25539
|
#
|
25512
|
-
# Default: The same
|
25540
|
+
# Default: The same DB instance class as the original DB instance.
|
25513
25541
|
#
|
25514
25542
|
#
|
25515
25543
|
#
|
@@ -25518,39 +25546,53 @@ module Aws::RDS
|
|
25518
25546
|
# @option params [Integer] :port
|
25519
25547
|
# The port number on which the database accepts connections.
|
25520
25548
|
#
|
25521
|
-
# Constraints: Value must be `1150-65535`
|
25522
|
-
#
|
25523
25549
|
# Default: The same port as the original DB instance.
|
25524
25550
|
#
|
25551
|
+
# Constraints:
|
25552
|
+
#
|
25553
|
+
# * The value must be `1150-65535`.
|
25554
|
+
#
|
25555
|
+
# ^
|
25556
|
+
#
|
25525
25557
|
# @option params [String] :availability_zone
|
25526
25558
|
# The Availability Zone (AZ) where the DB instance will be created.
|
25527
25559
|
#
|
25528
25560
|
# Default: A random, system-chosen Availability Zone.
|
25529
25561
|
#
|
25530
|
-
#
|
25531
|
-
#
|
25562
|
+
# Constraints:
|
25563
|
+
#
|
25564
|
+
# * You can't specify the `AvailabilityZone` parameter if the DB
|
25565
|
+
# instance is a Multi-AZ deployment.
|
25566
|
+
#
|
25567
|
+
# ^
|
25532
25568
|
#
|
25533
25569
|
# Example: `us-east-1a`
|
25534
25570
|
#
|
25535
25571
|
# @option params [String] :db_subnet_group_name
|
25536
25572
|
# The DB subnet group name to use for the new instance.
|
25537
25573
|
#
|
25538
|
-
# Constraints:
|
25539
|
-
#
|
25574
|
+
# Constraints:
|
25575
|
+
#
|
25576
|
+
# * If supplied, must match the name of an existing DB subnet group.
|
25577
|
+
#
|
25578
|
+
# ^
|
25540
25579
|
#
|
25541
25580
|
# Example: `mydbsubnetgroup`
|
25542
25581
|
#
|
25543
25582
|
# @option params [Boolean] :multi_az
|
25544
|
-
#
|
25545
|
-
# deployment.
|
25583
|
+
# Secifies whether the DB instance is a Multi-AZ deployment.
|
25546
25584
|
#
|
25547
25585
|
# This setting doesn't apply to RDS Custom.
|
25548
25586
|
#
|
25549
|
-
#
|
25550
|
-
#
|
25587
|
+
# Constraints:
|
25588
|
+
#
|
25589
|
+
# * You can't specify the `AvailabilityZone` parameter if the DB
|
25590
|
+
# instance is a Multi-AZ deployment.
|
25591
|
+
#
|
25592
|
+
# ^
|
25551
25593
|
#
|
25552
25594
|
# @option params [Boolean] :publicly_accessible
|
25553
|
-
#
|
25595
|
+
# Specifies whether the DB instance is publicly accessible.
|
25554
25596
|
#
|
25555
25597
|
# When the DB cluster is publicly accessible, its Domain Name System
|
25556
25598
|
# (DNS) endpoint resolves to the private IP address from within the DB
|
@@ -25566,21 +25608,21 @@ module Aws::RDS
|
|
25566
25608
|
# For more information, see CreateDBInstance.
|
25567
25609
|
#
|
25568
25610
|
# @option params [Boolean] :auto_minor_version_upgrade
|
25569
|
-
#
|
25570
|
-
#
|
25611
|
+
# Specifies whether minor version upgrades are applied automatically to
|
25612
|
+
# the DB instance during the maintenance window.
|
25571
25613
|
#
|
25572
25614
|
# This setting doesn't apply to RDS Custom.
|
25573
25615
|
#
|
25574
25616
|
# @option params [String] :license_model
|
25575
|
-
#
|
25617
|
+
# The license model information for the restored DB instance.
|
25576
25618
|
#
|
25577
25619
|
# This setting doesn't apply to RDS Custom.
|
25578
25620
|
#
|
25579
|
-
#
|
25580
|
-
#
|
25581
|
-
# Valid values: `license-included` \| `bring-your-own-license` \|
|
25621
|
+
# Valid Values: `license-included` \| `bring-your-own-license` \|
|
25582
25622
|
# `general-public-license`
|
25583
25623
|
#
|
25624
|
+
# Default: Same as the source.
|
25625
|
+
#
|
25584
25626
|
# @option params [String] :db_name
|
25585
25627
|
# The database name for the restored DB instance.
|
25586
25628
|
#
|
@@ -25594,10 +25636,6 @@ module Aws::RDS
|
|
25594
25636
|
#
|
25595
25637
|
# This setting doesn't apply to RDS Custom.
|
25596
25638
|
#
|
25597
|
-
# Default: The same as source
|
25598
|
-
#
|
25599
|
-
# Constraint: Must be compatible with the engine of the source
|
25600
|
-
#
|
25601
25639
|
# Valid Values:
|
25602
25640
|
#
|
25603
25641
|
# * `mariadb`
|
@@ -25622,19 +25660,28 @@ module Aws::RDS
|
|
25622
25660
|
#
|
25623
25661
|
# * `sqlserver-web`
|
25624
25662
|
#
|
25663
|
+
# Default: The same as source
|
25664
|
+
#
|
25665
|
+
# Constraints:
|
25666
|
+
#
|
25667
|
+
# * Must be compatible with the engine of the source.
|
25668
|
+
#
|
25669
|
+
# ^
|
25670
|
+
#
|
25625
25671
|
# @option params [Integer] :iops
|
25626
25672
|
# The amount of Provisioned IOPS (input/output operations per second) to
|
25627
|
-
#
|
25673
|
+
# initially allocate for the DB instance.
|
25628
25674
|
#
|
25629
|
-
#
|
25675
|
+
# This setting doesn't apply to SQL Server.
|
25630
25676
|
#
|
25631
|
-
#
|
25677
|
+
# Constraints:
|
25632
25678
|
#
|
25633
|
-
#
|
25634
|
-
#
|
25679
|
+
# * Must be an integer greater than 1000.
|
25680
|
+
#
|
25681
|
+
# ^
|
25635
25682
|
#
|
25636
25683
|
# @option params [String] :option_group_name
|
25637
|
-
# The name of the option group to
|
25684
|
+
# The name of the option group to use for the restored DB instance.
|
25638
25685
|
#
|
25639
25686
|
# Permanent options, such as the TDE option for Oracle Advanced Security
|
25640
25687
|
# TDE, can't be removed from an option group, and that option group
|
@@ -25644,9 +25691,8 @@ module Aws::RDS
|
|
25644
25691
|
# This setting doesn't apply to RDS Custom.
|
25645
25692
|
#
|
25646
25693
|
# @option params [Boolean] :copy_tags_to_snapshot
|
25647
|
-
#
|
25648
|
-
#
|
25649
|
-
# copied.
|
25694
|
+
# Specifies whether to copy all tags from the restored DB instance to
|
25695
|
+
# snapshots of the DB instance. By default, tags are not copied.
|
25650
25696
|
#
|
25651
25697
|
# @option params [Array<Types::Tag>] :tags
|
25652
25698
|
# A list of tags. For more information, see [Tagging Amazon RDS
|
@@ -25657,14 +25703,19 @@ module Aws::RDS
|
|
25657
25703
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html
|
25658
25704
|
#
|
25659
25705
|
# @option params [String] :storage_type
|
25660
|
-
#
|
25706
|
+
# The storage type to associate with the DB instance.
|
25661
25707
|
#
|
25662
|
-
# Valid
|
25708
|
+
# Valid Values: `gp2 | gp3 | io1 | standard`
|
25663
25709
|
#
|
25664
|
-
#
|
25665
|
-
# `
|
25710
|
+
# Default: `io1`, if the `Iops` parameter is specified. Otherwise,
|
25711
|
+
# `gp2`.
|
25666
25712
|
#
|
25667
|
-
#
|
25713
|
+
# Constraints:
|
25714
|
+
#
|
25715
|
+
# * If you specify `io1` or `gp3`, you must also include a value for the
|
25716
|
+
# `Iops` parameter.
|
25717
|
+
#
|
25718
|
+
# ^
|
25668
25719
|
#
|
25669
25720
|
# @option params [String] :tde_credential_arn
|
25670
25721
|
# The ARN from the key store with which to associate the instance for
|
@@ -25685,8 +25736,8 @@ module Aws::RDS
|
|
25685
25736
|
# VPC.
|
25686
25737
|
#
|
25687
25738
|
# @option params [String] :domain
|
25688
|
-
#
|
25689
|
-
#
|
25739
|
+
# The Active Directory directory ID to restore the DB instance in.
|
25740
|
+
# Create the domain before running this command. Currently, you can
|
25690
25741
|
# create only the MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB
|
25691
25742
|
# instances in an Active Directory Domain.
|
25692
25743
|
#
|
@@ -25756,9 +25807,9 @@ module Aws::RDS
|
|
25756
25807
|
# Example: `123.124.125.126,234.235.236.237`
|
25757
25808
|
#
|
25758
25809
|
# @option params [Boolean] :enable_iam_database_authentication
|
25759
|
-
#
|
25760
|
-
#
|
25761
|
-
#
|
25810
|
+
# Specifies whether to enable mapping of Amazon Web Services Identity
|
25811
|
+
# and Access Management (IAM) accounts to database accounts. By default,
|
25812
|
+
# mapping isn't enabled.
|
25762
25813
|
#
|
25763
25814
|
# This setting doesn't apply to RDS Custom.
|
25764
25815
|
#
|
@@ -25789,8 +25840,8 @@ module Aws::RDS
|
|
25789
25840
|
# This setting doesn't apply to RDS Custom.
|
25790
25841
|
#
|
25791
25842
|
# @option params [Boolean] :use_default_processor_features
|
25792
|
-
#
|
25793
|
-
#
|
25843
|
+
# Specifies whether the DB instance class of the DB instance uses its
|
25844
|
+
# default processor features.
|
25794
25845
|
#
|
25795
25846
|
# This setting doesn't apply to RDS Custom.
|
25796
25847
|
#
|
@@ -25804,7 +25855,7 @@ module Aws::RDS
|
|
25804
25855
|
#
|
25805
25856
|
# Constraints:
|
25806
25857
|
#
|
25807
|
-
# * If supplied, must match the name of an existing
|
25858
|
+
# * If supplied, must match the name of an existing DB parameter group.
|
25808
25859
|
#
|
25809
25860
|
# * Must be 1 to 255 letters, numbers, or hyphens.
|
25810
25861
|
#
|
@@ -25813,10 +25864,10 @@ module Aws::RDS
|
|
25813
25864
|
# * Can't end with a hyphen or contain two consecutive hyphens.
|
25814
25865
|
#
|
25815
25866
|
# @option params [Boolean] :deletion_protection
|
25816
|
-
#
|
25817
|
-
#
|
25818
|
-
#
|
25819
|
-
#
|
25867
|
+
# Specifies whether the DB instance has deletion protection enabled. The
|
25868
|
+
# database can't be deleted when deletion protection is enabled. By
|
25869
|
+
# default, deletion protection isn't enabled. For more information, see
|
25870
|
+
# [ Deleting a DB Instance][1].
|
25820
25871
|
#
|
25821
25872
|
#
|
25822
25873
|
#
|
@@ -25842,13 +25893,13 @@ module Aws::RDS
|
|
25842
25893
|
# @option params [String] :source_db_instance_automated_backups_arn
|
25843
25894
|
# The Amazon Resource Name (ARN) of the replicated automated backups
|
25844
25895
|
# from which to restore, for example,
|
25845
|
-
# `arn:aws:rds:
|
25896
|
+
# `arn:aws:rds:us-east-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE`.
|
25846
25897
|
#
|
25847
25898
|
# This setting doesn't apply to RDS Custom.
|
25848
25899
|
#
|
25849
25900
|
# @option params [Boolean] :enable_customer_owned_ip
|
25850
|
-
#
|
25851
|
-
#
|
25901
|
+
# Specifies whether to enable a customer-owned IP address (CoIP) for an
|
25902
|
+
# RDS on Outposts DB instance.
|
25852
25903
|
#
|
25853
25904
|
# A *CoIP* provides local or external connectivity to resources in your
|
25854
25905
|
# Outpost subnets through your on-premises network. For some use cases,
|
@@ -25908,12 +25959,6 @@ module Aws::RDS
|
|
25908
25959
|
# @option params [String] :network_type
|
25909
25960
|
# The network type of the DB instance.
|
25910
25961
|
#
|
25911
|
-
# Valid values:
|
25912
|
-
#
|
25913
|
-
# * `IPV4`
|
25914
|
-
#
|
25915
|
-
# * `DUAL`
|
25916
|
-
#
|
25917
25962
|
# The network type is determined by the `DBSubnetGroup` specified for
|
25918
25963
|
# the DB instance. A `DBSubnetGroup` can support only the IPv4 protocol
|
25919
25964
|
# or the IPv4 and the IPv6 protocols (`DUAL`).
|
@@ -25921,12 +25966,18 @@ module Aws::RDS
|
|
25921
25966
|
# For more information, see [ Working with a DB instance in a VPC][1] in
|
25922
25967
|
# the *Amazon RDS User Guide.*
|
25923
25968
|
#
|
25969
|
+
# Valid Values:
|
25970
|
+
#
|
25971
|
+
# * `IPV4`
|
25972
|
+
#
|
25973
|
+
# * `DUAL`
|
25974
|
+
#
|
25924
25975
|
#
|
25925
25976
|
#
|
25926
25977
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html
|
25927
25978
|
#
|
25928
25979
|
# @option params [Integer] :storage_throughput
|
25929
|
-
#
|
25980
|
+
# The storage throughput value for the DB instance.
|
25930
25981
|
#
|
25931
25982
|
# This setting doesn't apply to RDS Custom or Amazon Aurora.
|
25932
25983
|
#
|
@@ -27107,8 +27158,9 @@ module Aws::RDS
|
|
27107
27158
|
#
|
27108
27159
|
# @option params [Array<String>] :export_only
|
27109
27160
|
# The data to be exported from the snapshot or cluster. If this
|
27110
|
-
# parameter
|
27111
|
-
#
|
27161
|
+
# parameter isn't provided, all of the data is exported.
|
27162
|
+
#
|
27163
|
+
# Valid Values:
|
27112
27164
|
#
|
27113
27165
|
# * `database` - Export all the data from a specified database.
|
27114
27166
|
#
|
@@ -28288,7 +28340,7 @@ module Aws::RDS
|
|
28288
28340
|
params: params,
|
28289
28341
|
config: config)
|
28290
28342
|
context[:gem_name] = 'aws-sdk-rds'
|
28291
|
-
context[:gem_version] = '1.
|
28343
|
+
context[:gem_version] = '1.196.0'
|
28292
28344
|
Seahorse::Client::Request.new(handlers, context)
|
28293
28345
|
end
|
28294
28346
|
|