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.
@@ -420,9 +420,9 @@ module Aws::RDS
420
420
  # })
421
421
  # @param [Hash] options ({})
422
422
  # @option options [Boolean] :reset_all_parameters
423
- # A value that indicates whether to reset all parameters in the DB
424
- # parameter group to default values. By default, all parameters in the
425
- # DB parameter group are reset to default values.
423
+ # Specifies whether to reset all parameters in the DB parameter group to
424
+ # default values. By default, all parameters in the DB parameter group
425
+ # are reset to default values.
426
426
  # @option options [Array<Types::Parameter>] :parameters
427
427
  # To reset the entire DB parameter group, specify the `DBParameterGroup`
428
428
  # name and `ResetAllParameters` parameters. To reset specific
@@ -167,7 +167,7 @@ module Aws::RDS
167
167
  data[:tde_credential_arn]
168
168
  end
169
169
 
170
- # Specifies whether the DB snapshot is encrypted.
170
+ # Indicates whether the DB snapshot is encrypted.
171
171
  # @return [Boolean]
172
172
  def encrypted
173
173
  data[:encrypted]
@@ -198,8 +198,8 @@ module Aws::RDS
198
198
  data[:timezone]
199
199
  end
200
200
 
201
- # True if mapping of Amazon Web Services Identity and Access Management
202
- # (IAM) accounts to database accounts is enabled, and otherwise false.
201
+ # Indicates whether mapping of Amazon Web Services Identity and Access
202
+ # Management (IAM) accounts to database accounts is enabled.
203
203
  # @return [Boolean]
204
204
  def iam_database_authentication_enabled
205
205
  data[:iam_database_authentication_enabled]
@@ -511,8 +511,8 @@ module Aws::RDS
511
511
  #
512
512
  # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html
513
513
  # @option options [Boolean] :copy_tags
514
- # A value that indicates whether to copy all tags from the source DB
515
- # snapshot to the target DB snapshot. By default, tags aren't copied.
514
+ # Specifies whether to copy all tags from the source DB snapshot to the
515
+ # target DB snapshot. By default, tags aren't copied.
516
516
  # @option options [String] :pre_signed_url
517
517
  # When you are copying a snapshot from one Amazon Web Services GovCloud
518
518
  # (US) Region to another, the URL that contains a Signature Version 4
@@ -600,10 +600,10 @@ module Aws::RDS
600
600
  #
601
601
  # Example: `rds-caz-aiqhTgQv`.
602
602
  # @option options [Boolean] :copy_option_group
603
- # A value that indicates whether to copy the DB option group associated
604
- # with the source DB snapshot to the target Amazon Web Services account
605
- # and associate with the target DB snapshot. The associated option group
606
- # can be copied only with cross-account snapshot copy calls.
603
+ # Specifies whether to copy the DB option group associated with the
604
+ # source DB snapshot to the target Amazon Web Services account and
605
+ # associate with the target DB snapshot. The associated option group can
606
+ # be copied only with cross-account snapshot copy calls.
607
607
  # @option options [String] :source_region
608
608
  # The source region of the snapshot. This is only needed when the
609
609
  # shapshot is encrypted and in a different region.
@@ -740,15 +740,14 @@ module Aws::RDS
740
740
  #
741
741
  # Example: `mydbsubnetgroup`
742
742
  # @option options [Boolean] :multi_az
743
- # A value that indicates whether the DB instance is a Multi-AZ
744
- # deployment.
743
+ # Specifies whether the DB instance is a Multi-AZ deployment.
745
744
  #
746
745
  # This setting doesn't apply to RDS Custom.
747
746
  #
748
747
  # Constraint: You can't specify the `AvailabilityZone` parameter if the
749
748
  # DB instance is a Multi-AZ deployment.
750
749
  # @option options [Boolean] :publicly_accessible
751
- # A value that indicates whether the DB instance is publicly accessible.
750
+ # Specifies whether the DB instance is publicly accessible.
752
751
  #
753
752
  # When the DB instance is publicly accessible, its Domain Name System
754
753
  # (DNS) endpoint resolves to the private IP address from within the DB
@@ -763,8 +762,8 @@ module Aws::RDS
763
762
  #
764
763
  # For more information, see CreateDBInstance.
765
764
  # @option options [Boolean] :auto_minor_version_upgrade
766
- # A value that indicates whether minor version upgrades are applied
767
- # automatically to the DB instance during the maintenance window.
765
+ # Specifies whether to automatically apply minor version upgrades to the
766
+ # DB instance during the maintenance window.
768
767
  #
769
768
  # If you restore an RDS Custom DB instance, you must disable this
770
769
  # parameter.
@@ -775,7 +774,7 @@ module Aws::RDS
775
774
  #
776
775
  # Default: Same as source.
777
776
  #
778
- # Valid values: `license-included` \| `bring-your-own-license` \|
777
+ # Valid Values: `license-included` \| `bring-your-own-license` \|
779
778
  # `general-public-license`
780
779
  # @option options [String] :db_name
781
780
  # The database name for the restored DB instance.
@@ -852,7 +851,7 @@ module Aws::RDS
852
851
  # @option options [String] :storage_type
853
852
  # Specifies the storage type to be associated with the DB instance.
854
853
  #
855
- # Valid values: `gp2 | gp3 | io1 | standard`
854
+ # Valid Values: `gp2 | gp3 | io1 | standard`
856
855
  #
857
856
  # If you specify `io1` or `gp3`, you must also include a value for the
858
857
  # `Iops` parameter.
@@ -914,6 +913,10 @@ module Aws::RDS
914
913
  #
915
914
  # Constraints:
916
915
  #
916
+ # * Can't be longer than 64 characters.
917
+ #
918
+ # ^
919
+ #
917
920
  # Example:
918
921
  # `arn:aws:secretsmanager:region:account-number:secret:myselfmanagedADtestsecret-123456`
919
922
  # @option options [Array<String>] :domain_dns_ips
@@ -930,8 +933,8 @@ module Aws::RDS
930
933
  #
931
934
  # Example: `123.124.125.126,234.235.236.237`
932
935
  # @option options [Boolean] :copy_tags_to_snapshot
933
- # A value that indicates whether to copy all tags from the restored DB
934
- # instance to snapshots of the DB instance.
936
+ # Specifies whether to copy all tags from the restored DB instance to
937
+ # snapshots of the DB instance.
935
938
  #
936
939
  # In most cases, tags aren't copied by default. However, when you
937
940
  # restore a DB instance from a DB snapshot, RDS checks whether you
@@ -952,9 +955,9 @@ module Aws::RDS
952
955
  #
953
956
  # This setting doesn't apply to RDS Custom DB instances.
954
957
  # @option options [Boolean] :enable_iam_database_authentication
955
- # A value that indicates whether to enable mapping of Amazon Web
956
- # Services Identity and Access Management (IAM) accounts to database
957
- # accounts. By default, mapping is disabled.
958
+ # Specifies whether to enable mapping of Amazon Web Services Identity
959
+ # and Access Management (IAM) accounts to database accounts. By default,
960
+ # mapping is disabled.
958
961
  #
959
962
  # For more information about IAM database authentication, see [ IAM
960
963
  # Database Authentication for MySQL and PostgreSQL][1] in the *Amazon
@@ -982,8 +985,8 @@ module Aws::RDS
982
985
  #
983
986
  # This setting doesn't apply to RDS Custom.
984
987
  # @option options [Boolean] :use_default_processor_features
985
- # A value that indicates whether the DB instance class of the DB
986
- # instance uses its default processor features.
988
+ # Specifies whether the DB instance class of the DB instance uses its
989
+ # default processor features.
987
990
  #
988
991
  # This setting doesn't apply to RDS Custom.
989
992
  # @option options [String] :db_parameter_group_name
@@ -1004,17 +1007,17 @@ module Aws::RDS
1004
1007
  #
1005
1008
  # * Can't end with a hyphen or contain two consecutive hyphens.
1006
1009
  # @option options [Boolean] :deletion_protection
1007
- # A value that indicates whether the DB instance has deletion protection
1008
- # enabled. The database can't be deleted when deletion protection is
1009
- # enabled. By default, deletion protection isn't enabled. For more
1010
- # information, see [ Deleting a DB Instance][1].
1010
+ # Specifies whether to enable deletion protection for the DB instance.
1011
+ # The database can't be deleted when deletion protection is enabled. By
1012
+ # default, deletion protection isn't enabled. For more information, see
1013
+ # [ Deleting a DB Instance][1].
1011
1014
  #
1012
1015
  #
1013
1016
  #
1014
1017
  # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_DeleteInstance.html
1015
1018
  # @option options [Boolean] :enable_customer_owned_ip
1016
- # A value that indicates whether to enable a customer-owned IP address
1017
- # (CoIP) for an RDS on Outposts DB instance.
1019
+ # Specifies whether to enable a customer-owned IP address (CoIP) for an
1020
+ # RDS on Outposts DB instance.
1018
1021
  #
1019
1022
  # A *CoIP* provides local or external connectivity to resources in your
1020
1023
  # Outpost subnets through your on-premises network. For some use cases,
@@ -1071,7 +1074,7 @@ module Aws::RDS
1071
1074
  # @option options [String] :network_type
1072
1075
  # The network type of the DB instance.
1073
1076
  #
1074
- # Valid values:
1077
+ # Valid Values:
1075
1078
  #
1076
1079
  # * `IPV4`
1077
1080
  #
@@ -310,7 +310,7 @@ module Aws::RDS
310
310
  # parameter to `db-instance`. For RDS Proxy events, specify `db-proxy`.
311
311
  # If this value isn't specified, all events are returned.
312
312
  #
313
- # Valid values: `db-instance` \| `db-cluster` \| `db-parameter-group` \|
313
+ # Valid Values: `db-instance` \| `db-cluster` \| `db-parameter-group` \|
314
314
  # `db-security-group` \| `db-snapshot` \| `db-cluster-snapshot` \|
315
315
  # `db-proxy`
316
316
  # @option options [Array<String>] :event_categories
@@ -357,8 +357,8 @@ module Aws::RDS
357
357
  # * If the source type is an RDS Proxy, a `DBProxyName` value must be
358
358
  # supplied.
359
359
  # @option options [Boolean] :enabled
360
- # A value that indicates whether to activate the subscription. If the
361
- # event notification subscription isn't activated, the subscription is
360
+ # Specifies whether to activate the subscription. If the event
361
+ # notification subscription isn't activated, the subscription is
362
362
  # created but not active.
363
363
  # @option options [Array<Types::Tag>] :tags
364
364
  # A list of tags. For more information, see [Tagging Amazon RDS
@@ -416,7 +416,7 @@ module Aws::RDS
416
416
  # set this parameter to db-instance. For RDS Proxy events, specify
417
417
  # `db-proxy`. If this value isn't specified, all events are returned.
418
418
  #
419
- # Valid values: `db-instance` \| `db-cluster` \| `db-parameter-group` \|
419
+ # Valid Values: `db-instance` \| `db-cluster` \| `db-parameter-group` \|
420
420
  # `db-security-group` \| `db-snapshot` \| `db-cluster-snapshot` \|
421
421
  # `db-proxy`
422
422
  # @option options [Array<String>] :event_categories
@@ -429,7 +429,7 @@ module Aws::RDS
429
429
  #
430
430
  # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Events.html
431
431
  # @option options [Boolean] :enabled
432
- # A value that indicates whether to activate the subscription.
432
+ # Specifies whether to activate the subscription.
433
433
  # @return [EventSubscription]
434
434
  def modify(options = {})
435
435
  options = options.merge(subscription_name: @name)
@@ -402,9 +402,8 @@ module Aws::RDS
402
402
  # @option options [Array<String>] :options_to_remove
403
403
  # Options in this list are removed from the option group.
404
404
  # @option options [Boolean] :apply_immediately
405
- # A value that indicates whether to apply the change immediately or
406
- # during the next maintenance window for each instance associated with
407
- # the option group.
405
+ # Specifies whether to apply the change immediately or during the next
406
+ # maintenance window for each instance associated with the option group.
408
407
  # @return [OptionGroup]
409
408
  def modify(options = {})
410
409
  options = options.merge(option_group_name: @name)
@@ -58,7 +58,7 @@ module Aws::RDS
58
58
  data[:minimum_required_minor_engine_version]
59
59
  end
60
60
 
61
- # Specifies whether the option requires a port.
61
+ # Indicates whether the option requires a port.
62
62
  # @return [Boolean]
63
63
  def port_required
64
64
  data[:port_required]
@@ -137,7 +137,7 @@ module Aws::RDS
137
137
  data[:option_group_option_versions]
138
138
  end
139
139
 
140
- # Specifies whether the option can be copied across Amazon Web Services
140
+ # Indicates whether the option can be copied across Amazon Web Services
141
141
  # accounts.
142
142
  # @return [Boolean]
143
143
  def copyable_cross_account
@@ -35,7 +35,7 @@ module Aws::RDS
35
35
  end
36
36
  alias :parameter_name :name
37
37
 
38
- # Specifies the value of the parameter.
38
+ # The value of the parameter.
39
39
  # @return [String]
40
40
  def parameter_value
41
41
  data[:parameter_value]
@@ -47,7 +47,7 @@ module Aws::RDS
47
47
  data[:description]
48
48
  end
49
49
 
50
- # Indicates the source of the parameter value.
50
+ # The source of the parameter value.
51
51
  # @return [String]
52
52
  def source
53
53
  data[:source]
@@ -95,7 +95,7 @@ module Aws::RDS
95
95
  data[:offering_type]
96
96
  end
97
97
 
98
- # Indicates if the reservation applies to Multi-AZ deployments.
98
+ # Indicates whether the reservation applies to Multi-AZ deployments.
99
99
  # @return [Boolean]
100
100
  def multi_az
101
101
  data[:multi_az]
@@ -77,7 +77,7 @@ module Aws::RDS
77
77
  data[:offering_type]
78
78
  end
79
79
 
80
- # Indicates if the offering applies to Multi-AZ deployments.
80
+ # Indicates whether the offering applies to Multi-AZ deployments.
81
81
  # @return [Boolean]
82
82
  def multi_az
83
83
  data[:multi_az]
@@ -1346,7 +1346,8 @@ module Aws::RDS
1346
1346
  # * Can't be specified if `ManageMasterUserPassword` is turned on.
1347
1347
  #
1348
1348
  # * Can include any printable ASCII character except "/", """, or
1349
- # "@".
1349
+ # "@". For RDS for Oracle, can't include the "&amp;" (ampersand)
1350
+ # or the "'" (single quotes) character.
1350
1351
  #
1351
1352
  # Length Constraints:
1352
1353
  #
@@ -2373,7 +2374,7 @@ module Aws::RDS
2373
2374
  # parameter to `db-instance`. For RDS Proxy events, specify `db-proxy`.
2374
2375
  # If this value isn't specified, all events are returned.
2375
2376
  #
2376
- # Valid values: `db-instance` \| `db-cluster` \| `db-parameter-group` \|
2377
+ # Valid Values: `db-instance` \| `db-cluster` \| `db-parameter-group` \|
2377
2378
  # `db-security-group` \| `db-snapshot` \| `db-cluster-snapshot` \|
2378
2379
  # `db-proxy`
2379
2380
  # @option options [Array<String>] :event_categories
@@ -2420,8 +2421,8 @@ module Aws::RDS
2420
2421
  # * If the source type is an RDS Proxy, a `DBProxyName` value must be
2421
2422
  # supplied.
2422
2423
  # @option options [Boolean] :enabled
2423
- # A value that indicates whether to activate the subscription. If the
2424
- # event notification subscription isn't activated, the subscription is
2424
+ # Specifies whether to activate the subscription. If the event
2425
+ # notification subscription isn't activated, the subscription is
2425
2426
  # created but not active.
2426
2427
  # @option options [Array<Types::Tag>] :tags
2427
2428
  # A list of tags. For more information, see [Tagging Amazon RDS
@@ -2767,7 +2768,7 @@ module Aws::RDS
2767
2768
  # })
2768
2769
  # @param [Hash] options ({})
2769
2770
  # @option options [String] :engine
2770
- # The database engine to return.
2771
+ # The database engine to return version details for.
2771
2772
  #
2772
2773
  # Valid Values:
2773
2774
  #
@@ -2799,7 +2800,7 @@ module Aws::RDS
2799
2800
  #
2800
2801
  # * `sqlserver-web`
2801
2802
  # @option options [String] :engine_version
2802
- # The database engine version to return.
2803
+ # A specific database engine version to return details for.
2803
2804
  #
2804
2805
  # Example: `5.1.49`
2805
2806
  # @option options [String] :db_parameter_group_family
@@ -2808,7 +2809,7 @@ module Aws::RDS
2808
2809
  #
2809
2810
  # Constraints:
2810
2811
  #
2811
- # * If supplied, must match an existing DBParameterGroupFamily.
2812
+ # * If supplied, must match an existing DB parameter group family.
2812
2813
  #
2813
2814
  # ^
2814
2815
  # @option options [Array<Types::Filter>] :filters
@@ -2849,34 +2850,31 @@ module Aws::RDS
2849
2850
  #
2850
2851
  # * `deprecated`
2851
2852
  # @option options [Boolean] :default_only
2852
- # A value that indicates whether only the default version of the
2853
- # specified engine or engine and major version combination is returned.
2853
+ # Specifies whether to return only the default version of the specified
2854
+ # engine or the engine and major version combination.
2854
2855
  # @option options [Boolean] :list_supported_character_sets
2855
- # A value that indicates whether to list the supported character sets
2856
- # for each engine version.
2856
+ # Specifies whether to list the supported character sets for each engine
2857
+ # version.
2857
2858
  #
2858
2859
  # If this parameter is enabled and the requested engine supports the
2859
2860
  # `CharacterSetName` parameter for `CreateDBInstance`, the response
2860
2861
  # includes a list of supported character sets for each engine version.
2861
2862
  #
2862
2863
  # For RDS Custom, the default is not to list supported character sets.
2863
- # If you set `ListSupportedCharacterSets` to `true`, RDS Custom returns
2864
- # no results.
2864
+ # If you enable this parameter, RDS Custom returns no results.
2865
2865
  # @option options [Boolean] :list_supported_timezones
2866
- # A value that indicates whether to list the supported time zones for
2867
- # each engine version.
2866
+ # Specifies whether to list the supported time zones for each engine
2867
+ # version.
2868
2868
  #
2869
2869
  # If this parameter is enabled and the requested engine supports the
2870
2870
  # `TimeZone` parameter for `CreateDBInstance`, the response includes a
2871
2871
  # list of supported time zones for each engine version.
2872
2872
  #
2873
2873
  # For RDS Custom, the default is not to list supported time zones. If
2874
- # you set `ListSupportedTimezones` to `true`, RDS Custom returns no
2875
- # results.
2874
+ # you enable this parameter, RDS Custom returns no results.
2876
2875
  # @option options [Boolean] :include_all
2877
- # A value that indicates whether to include engine versions that aren't
2878
- # available in the list. The default is to list only available engine
2879
- # versions.
2876
+ # Specifies whether to also list the engine versions that aren't
2877
+ # available. The default is to list only available engine versions.
2880
2878
  # @return [DBEngineVersion::Collection]
2881
2879
  def db_engine_versions(options = {})
2882
2880
  batches = Enumerator.new do |y|
@@ -3175,10 +3173,10 @@ module Aws::RDS
3175
3173
  #
3176
3174
  # * `engine` - Accepts names of database engines.
3177
3175
  # @option options [Boolean] :include_shared
3178
- # A value that indicates whether to include shared manual DB cluster
3179
- # snapshots from other Amazon Web Services accounts that this Amazon Web
3180
- # Services account has been given permission to copy or restore. By
3181
- # default, these snapshots are not included.
3176
+ # Specifies whether to include shared manual DB cluster snapshots from
3177
+ # other Amazon Web Services accounts that this Amazon Web Services
3178
+ # account has been given permission to copy or restore. By default,
3179
+ # these snapshots are not included.
3182
3180
  #
3183
3181
  # You can give an Amazon Web Services account permission to restore a
3184
3182
  # manual DB snapshot from another Amazon Web Services account by using
@@ -3186,9 +3184,9 @@ module Aws::RDS
3186
3184
  #
3187
3185
  # This setting doesn't apply to RDS Custom.
3188
3186
  # @option options [Boolean] :include_public
3189
- # A value that indicates whether to include manual DB cluster snapshots
3190
- # that are public and can be copied or restored by any Amazon Web
3191
- # Services account. By default, the public snapshots are not included.
3187
+ # Specifies whether to include manual DB cluster snapshots that are
3188
+ # public and can be copied or restored by any Amazon Web Services
3189
+ # account. By default, the public snapshots are not included.
3192
3190
  #
3193
3191
  # You can share a manual DB snapshot as public by using the
3194
3192
  # ModifyDBSnapshotAttribute API.
@@ -3289,7 +3287,7 @@ module Aws::RDS
3289
3287
  # The type of source that is generating the events. For RDS Proxy
3290
3288
  # events, specify `db-proxy`.
3291
3289
  #
3292
- # Valid values: `db-instance` \| `db-cluster` \| `db-parameter-group` \|
3290
+ # Valid Values: `db-instance` \| `db-cluster` \| `db-parameter-group` \|
3293
3291
  # `db-security-group` \| `db-snapshot` \| `db-cluster-snapshot` \|
3294
3292
  # `db-proxy`
3295
3293
  # @option options [Array<Types::Filter>] :filters
@@ -3606,8 +3604,8 @@ module Aws::RDS
3606
3604
  #
3607
3605
  # Valid Values: `"Partial Upfront" | "All Upfront" | "No Upfront" `
3608
3606
  # @option options [Boolean] :multi_az
3609
- # A value that indicates whether to show only those reservations that
3610
- # support Multi-AZ.
3607
+ # Specifies whether to show only those reservations that support
3608
+ # Multi-AZ.
3611
3609
  # @option options [String] :lease_id
3612
3610
  # The lease identifier filter value. Specify this parameter to show only
3613
3611
  # the reservation that matches the specified lease ID.
@@ -3693,8 +3691,8 @@ module Aws::RDS
3693
3691
  #
3694
3692
  # Valid Values: `"Partial Upfront" | "All Upfront" | "No Upfront" `
3695
3693
  # @option options [Boolean] :multi_az
3696
- # A value that indicates whether to show only those reservations that
3697
- # support Multi-AZ.
3694
+ # Specifies whether to show only those reservations that support
3695
+ # Multi-AZ.
3698
3696
  # @option options [Array<Types::Filter>] :filters
3699
3697
  # This parameter isn't currently supported.
3700
3698
  # @return [ReservedDBInstancesOffering::Collection]