aws-sdk-rds 1.51.0 → 1.52.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.
@@ -214,12 +214,7 @@ module Aws::RDS
214
214
  # @option options [required, String] :description
215
215
  # The description for the DB parameter group.
216
216
  # @option options [Array<Types::Tag>] :tags
217
- # A list of tags. For more information, see [Tagging Amazon RDS
218
- # Resources][1] in the *Amazon RDS User Guide.*
219
- #
220
- #
221
- #
222
- # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html
217
+ # Tags to assign to the DB parameter group.
223
218
  # @return [DBParameterGroup]
224
219
  def create(options = {})
225
220
  options = options.merge(db_parameter_group_name: @name)
@@ -356,10 +351,9 @@ module Aws::RDS
356
351
  # })
357
352
  # @param [Hash] options ({})
358
353
  # @option options [Boolean] :reset_all_parameters
359
- # Specifies whether (`true`) or not (`false`) to reset all parameters in
360
- # the DB parameter group to default values.
361
- #
362
- # Default: `true`
354
+ # A value that indicates whether to reset all parameters in the DB
355
+ # parameter group to default values. By default, all parameters in the
356
+ # DB parameter group are reset to default values.
363
357
  # @option options [Array<Types::Parameter>] :parameters
364
358
  # To reset the entire DB parameter group, specify the `DBParameterGroup`
365
359
  # name and `ResetAllParameters` parameters. To reset specific
@@ -49,13 +49,13 @@ module Aws::RDS
49
49
  data[:vpc_id]
50
50
  end
51
51
 
52
- # Contains a list of EC2SecurityGroup elements.
52
+ # Contains a list of `EC2SecurityGroup` elements.
53
53
  # @return [Array<Types::EC2SecurityGroup>]
54
54
  def ec2_security_groups
55
55
  data[:ec2_security_groups]
56
56
  end
57
57
 
58
- # Contains a list of IPRange elements.
58
+ # Contains a list of `IPRange` elements.
59
59
  # @return [Array<Types::IPRange>]
60
60
  def ip_ranges
61
61
  data[:ip_ranges]
@@ -252,12 +252,7 @@ module Aws::RDS
252
252
  # @option options [required, String] :db_security_group_description
253
253
  # The description for the DB security group.
254
254
  # @option options [Array<Types::Tag>] :tags
255
- # A list of tags. For more information, see [Tagging Amazon RDS
256
- # Resources][1] in the *Amazon RDS User Guide.*
257
- #
258
- #
259
- #
260
- # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html
255
+ # Tags to assign to the DB security group.
261
256
  # @return [DBSecurityGroup]
262
257
  def create(options = {})
263
258
  options = options.merge(db_security_group_name: @name)
@@ -436,8 +436,8 @@ module Aws::RDS
436
436
  #
437
437
  # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html
438
438
  # @option options [Boolean] :copy_tags
439
- # True to copy all tags from the source DB snapshot to the target DB
440
- # snapshot, and otherwise false. The default is false.
439
+ # A value that indicates whether to copy all tags from the source DB
440
+ # snapshot to the target DB snapshot. By default, tags are not copied.
441
441
  # @option options [String] :pre_signed_url
442
442
  # The URL that contains a Signature Version 4 signed request for the
443
443
  # `CopyDBSnapshot` API action in the source AWS Region that contains the
@@ -606,12 +606,12 @@ module Aws::RDS
606
606
  #
607
607
  # Constraints: Value must be `1150-65535`
608
608
  # @option options [String] :availability_zone
609
- # The EC2 Availability Zone that the DB instance is created in.
609
+ # The Availability Zone (AZ) where the DB instance will be created.
610
610
  #
611
611
  # Default: A random, system-chosen Availability Zone.
612
612
  #
613
- # Constraint: You can't specify the AvailabilityZone parameter if the
614
- # MultiAZ parameter is set to `true`.
613
+ # Constraint: You can't specify the `AvailabilityZone` parameter if the
614
+ # DB instance is a Multi-AZ deployment.
615
615
  #
616
616
  # Example: `us-east-1a`
617
617
  # @option options [String] :db_subnet_group_name
@@ -622,19 +622,21 @@ module Aws::RDS
622
622
  #
623
623
  # Example: `mySubnetgroup`
624
624
  # @option options [Boolean] :multi_az
625
- # Specifies if the DB instance is a Multi-AZ deployment.
625
+ # A value that indicates whether the DB instance is a Multi-AZ
626
+ # deployment.
626
627
  #
627
- # Constraint: You can't specify the AvailabilityZone parameter if the
628
- # MultiAZ parameter is set to `true`.
628
+ # Constraint: You can't specify the `AvailabilityZone` parameter if the
629
+ # DB instance is a Multi-AZ deployment.
629
630
  # @option options [Boolean] :publicly_accessible
630
- # Specifies the accessibility options for the DB instance. A value of
631
- # true specifies an Internet-facing instance with a publicly resolvable
632
- # DNS name, which resolves to a public IP address. A value of false
633
- # specifies an internal instance with a DNS name that resolves to a
634
- # private IP address. For more information, see CreateDBInstance.
631
+ # A value that indicates whether the DB instance is publicly accessible.
632
+ # When the DB instance is publicly accessible, it is an Internet-facing
633
+ # instance with a publicly resolvable DNS name, which resolves to a
634
+ # public IP address. When the DB instance is not publicly accessible, it
635
+ # is an internal instance with a DNS name that resolves to a private IP
636
+ # address. For more information, see CreateDBInstance.
635
637
  # @option options [Boolean] :auto_minor_version_upgrade
636
- # Indicates that minor version upgrades are applied automatically to the
637
- # DB instance during the maintenance window.
638
+ # A value that indicates whether minor version upgrades are applied
639
+ # automatically to the DB instance during the maintenance window.
638
640
  # @option options [String] :license_model
639
641
  # License model information for the restored DB instance.
640
642
  #
@@ -721,8 +723,7 @@ module Aws::RDS
721
723
  # If you specify `io1`, you must also include a value for the `Iops`
722
724
  # parameter.
723
725
  #
724
- # Default: `io1` if the `Iops` parameter is specified, otherwise
725
- # `standard`
726
+ # Default: `io1` if the `Iops` parameter is specified, otherwise `gp2`
726
727
  # @option options [String] :tde_credential_arn
727
728
  # The ARN from the key store with which to associate the instance for
728
729
  # TDE encryption.
@@ -737,14 +738,16 @@ module Aws::RDS
737
738
  # @option options [String] :domain
738
739
  # Specify the Active Directory Domain to restore the instance in.
739
740
  # @option options [Boolean] :copy_tags_to_snapshot
740
- # True to copy all tags from the restored DB instance to snapshots of
741
- # the restored DB instance, and otherwise false. The default is false.
741
+ # A value that indicates whether to copy all tags from the restored DB
742
+ # instance to snapshots of the DB instance. By default, tags are not
743
+ # copied.
742
744
  # @option options [String] :domain_iam_role_name
743
745
  # Specify the name of the IAM role to be used when making API calls to
744
746
  # the Directory Service.
745
747
  # @option options [Boolean] :enable_iam_database_authentication
746
- # True to enable mapping of AWS Identity and Access Management (IAM)
747
- # accounts to database accounts, and otherwise false.
748
+ # A value that indicates whether to enable mapping of AWS Identity and
749
+ # Access Management (IAM) accounts to database accounts. By default,
750
+ # mapping is disabled.
748
751
  #
749
752
  # You can enable IAM database authentication for the following database
750
753
  # engines
@@ -752,8 +755,6 @@ module Aws::RDS
752
755
  # * For MySQL 5.6, minor version 5.6.34 or higher
753
756
  #
754
757
  # * For MySQL 5.7, minor version 5.7.16 or higher
755
- #
756
- # Default: `false`
757
758
  # @option options [Array<String>] :enable_cloudwatch_logs_exports
758
759
  # The list of logs that the restored DB instance is to export to
759
760
  # CloudWatch Logs. The values in the list depend on the DB engine being
@@ -767,8 +768,8 @@ module Aws::RDS
767
768
  # The number of CPU cores and the number of threads per core for the DB
768
769
  # instance class of the DB instance.
769
770
  # @option options [Boolean] :use_default_processor_features
770
- # A value that specifies that the DB instance class of the DB instance
771
- # uses its default processor features.
771
+ # A value that indicates whether the DB instance class of the DB
772
+ # instance uses its default processor features.
772
773
  # @option options [String] :db_parameter_group_name
773
774
  # The name of the DB parameter group to associate with this DB instance.
774
775
  # If this argument is omitted, the default DBParameterGroup for the
@@ -784,10 +785,10 @@ module Aws::RDS
784
785
  #
785
786
  # * Can't end with a hyphen or contain two consecutive hyphens.
786
787
  # @option options [Boolean] :deletion_protection
787
- # Indicates if the DB instance should have deletion protection enabled.
788
- # The database can't be deleted when this value is set to true. The
789
- # default is false. For more information, see [ Deleting a DB
790
- # Instance][1].
788
+ # A value that indicates whether the DB instance has deletion protection
789
+ # enabled. The database can't be deleted when deletion protection is
790
+ # enabled. By default, deletion protection is disabled. For more
791
+ # information, see [ Deleting a DB Instance][1].
791
792
  #
792
793
  #
793
794
  #
@@ -49,7 +49,7 @@ module Aws::RDS
49
49
  data[:subnet_group_status]
50
50
  end
51
51
 
52
- # Contains a list of Subnet elements.
52
+ # Contains a list of `Subnet` elements.
53
53
  # @return [Array<Types::Subnet>]
54
54
  def subnets
55
55
  data[:subnets]
@@ -211,12 +211,7 @@ module Aws::RDS
211
211
  # @option options [required, Array<String>] :subnet_ids
212
212
  # The EC2 Subnet IDs for the DB subnet group.
213
213
  # @option options [Array<Types::Tag>] :tags
214
- # A list of tags. For more information, see [Tagging Amazon RDS
215
- # Resources][1] in the *Amazon RDS User Guide.*
216
- #
217
- #
218
- #
219
- # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html
214
+ # Tags to assign to the DB subnet group.
220
215
  # @return [DBSubnetGroup]
221
216
  def create(options = {})
222
217
  options = options.merge(db_subnet_group_name: @name)
@@ -323,8 +323,9 @@ module Aws::RDS
323
323
  # * If the source type is a DB snapshot, a `DBSnapshotIdentifier` must
324
324
  # be supplied.
325
325
  # @option options [Boolean] :enabled
326
- # A Boolean value; set to **true** to activate the subscription, set to
327
- # **false** to create the subscription but not active it.
326
+ # A value that indicates whether to activate the subscription. If the
327
+ # event notification subscription is not activated, the subscription is
328
+ # created but not active.
328
329
  # @option options [Array<Types::Tag>] :tags
329
330
  # A list of tags. For more information, see [Tagging Amazon RDS
330
331
  # Resources][1] in the *Amazon RDS User Guide.*
@@ -389,7 +390,7 @@ module Aws::RDS
389
390
  #
390
391
  # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Events.html
391
392
  # @option options [Boolean] :enabled
392
- # A Boolean value; set to **true** to activate the subscription.
393
+ # A value that indicates whether to activate the subscription.
393
394
  # @return [EventSubscription]
394
395
  def modify(options = {})
395
396
  options = options.merge(subscription_name: @name)
@@ -236,12 +236,7 @@ module Aws::RDS
236
236
  # @option options [required, String] :option_group_description
237
237
  # The description of the option group.
238
238
  # @option options [Array<Types::Tag>] :tags
239
- # A list of tags. For more information, see [Tagging Amazon RDS
240
- # Resources][1] in the *Amazon RDS User Guide.*
241
- #
242
- #
243
- #
244
- # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html
239
+ # Tags to assign to the option group.
245
240
  # @return [OptionGroup]
246
241
  def create(options = {})
247
242
  options = options.merge(option_group_name: @name)
@@ -347,9 +342,9 @@ module Aws::RDS
347
342
  # @option options [Array<String>] :options_to_remove
348
343
  # Options in this list are removed from the option group.
349
344
  # @option options [Boolean] :apply_immediately
350
- # Indicates whether the changes should be applied immediately, or during
351
- # the next maintenance window for each instance associated with the
352
- # option group.
345
+ # A value that indicates whether to apply the change immediately or
346
+ # during the next maintenance window for each instance associated with
347
+ # the option group.
353
348
  # @return [OptionGroup]
354
349
  def modify(options = {})
355
350
  options = options.merge(option_group_name: @name)
@@ -66,7 +66,7 @@ module Aws::RDS
66
66
 
67
67
  # The effective date when the pending maintenance action is applied to
68
68
  # the resource. This date takes into account opt-in requests received
69
- # from the ApplyPendingMaintenanceAction API, the
69
+ # from the `ApplyPendingMaintenanceAction` API, the
70
70
  # `AutoAppliedAfterDate`, and the `ForcedApplyDate`. This value is blank
71
71
  # if an opt-in request has not been received and nothing has been
72
72
  # specified as `AutoAppliedAfterDate` or `ForcedApplyDate`.
@@ -68,8 +68,8 @@ module Aws::RDS
68
68
  # })
69
69
  # @param [Hash] options ({})
70
70
  # @option options [Array<String>] :availability_zones
71
- # A list of EC2 Availability Zones that instances in the DB cluster can
72
- # be created in. For information on AWS Regions and Availability Zones,
71
+ # A list of Availability Zones (AZs) where instances in the DB cluster
72
+ # can be created. For information on AWS Regions and Availability Zones,
73
73
  # see [Choosing the Regions and Availability Zones][1] in the *Amazon
74
74
  # Aurora User Guide*.
75
75
  #
@@ -77,8 +77,7 @@ module Aws::RDS
77
77
  #
78
78
  # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Concepts.RegionsAndAvailabilityZones.html
79
79
  # @option options [Integer] :backup_retention_period
80
- # The number of days for which automated backups are retained. You must
81
- # specify a minimum value of 1.
80
+ # The number of days for which automated backups are retained.
82
81
  #
83
82
  # Default: 1
84
83
  #
@@ -215,14 +214,9 @@ module Aws::RDS
215
214
  # The Amazon Resource Name (ARN) of the source DB instance or DB cluster
216
215
  # if this DB cluster is created as a Read Replica.
217
216
  # @option options [Array<Types::Tag>] :tags
218
- # A list of tags. For more information, see [Tagging Amazon RDS
219
- # Resources][1] in the *Amazon RDS User Guide.*
220
- #
221
- #
222
- #
223
- # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html
217
+ # Tags to assign to the DB cluster.
224
218
  # @option options [Boolean] :storage_encrypted
225
- # Specifies whether the DB cluster is encrypted.
219
+ # A value that indicates whether the DB cluster is encrypted.
226
220
  # @option options [String] :kms_key_id
227
221
  # The AWS KMS key identifier for an encrypted DB cluster.
228
222
  #
@@ -238,7 +232,7 @@ module Aws::RDS
238
232
  # then Amazon RDS will use the encryption key used to encrypt the
239
233
  # source. Otherwise, Amazon RDS will use your default encryption key.
240
234
  #
241
- # * If the `StorageEncrypted` parameter is true and
235
+ # * If the `StorageEncrypted` parameter is enabled and
242
236
  # `ReplicationSourceIdentifier` is not specified, then Amazon RDS will
243
237
  # use your default encryption key.
244
238
  #
@@ -290,10 +284,9 @@ module Aws::RDS
290
284
  # [1]: https://docs.aws.amazon.com/AmazonS3/latest/API/sigv4-query-string-auth.html
291
285
  # [2]: https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html
292
286
  # @option options [Boolean] :enable_iam_database_authentication
293
- # True to enable mapping of AWS Identity and Access Management (IAM)
294
- # accounts to database accounts, and otherwise false.
295
- #
296
- # Default: `false`
287
+ # A value that indicates whether to enable mapping of AWS Identity and
288
+ # Access Management (IAM) accounts to database accounts. By default,
289
+ # mapping is disabled.
297
290
  # @option options [Integer] :backtrack_window
298
291
  # The target backtrack window, in seconds. To disable backtracking, set
299
292
  # this value to 0.
@@ -322,15 +315,15 @@ module Aws::RDS
322
315
  # For DB clusters in `serverless` DB engine mode, the scaling properties
323
316
  # of the DB cluster.
324
317
  # @option options [Boolean] :deletion_protection
325
- # Indicates if the DB cluster should have deletion protection enabled.
326
- # The database can't be deleted when this value is set to true. The
327
- # default is false.
318
+ # A value that indicates whether the DB cluster has deletion protection
319
+ # enabled. The database can't be deleted when deletion protection is
320
+ # enabled. By default, deletion protection is disabled.
328
321
  # @option options [String] :global_cluster_identifier
329
322
  # The global cluster ID of an Aurora cluster that becomes the primary
330
323
  # cluster in the new global database cluster.
331
324
  # @option options [Boolean] :copy_tags_to_snapshot
332
- # True to copy all tags from the DB cluster to snapshots of the DB
333
- # cluster, and otherwise false. The default is false.
325
+ # A value that indicates whether to copy all tags from the DB cluster to
326
+ # snapshots of the DB cluster. The default is not to copy them.
334
327
  # @option options [String] :destination_region
335
328
  # @option options [String] :source_region
336
329
  # The source region of the snapshot. This is only needed when the
@@ -388,12 +381,7 @@ module Aws::RDS
388
381
  # @option options [required, String] :description
389
382
  # The description for the DB cluster parameter group.
390
383
  # @option options [Array<Types::Tag>] :tags
391
- # A list of tags. For more information, see [Tagging Amazon RDS
392
- # Resources][1] in the *Amazon RDS User Guide.*
393
- #
394
- #
395
- #
396
- # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html
384
+ # Tags to assign to the DB cluster parameter group.
397
385
  # @return [DBClusterParameterGroup]
398
386
  def create_db_cluster_parameter_group(options = {})
399
387
  resp = @client.create_db_cluster_parameter_group(options)
@@ -468,8 +456,6 @@ module Aws::RDS
468
456
  # The meaning of this parameter differs according to the database engine
469
457
  # you use.
470
458
  #
471
- # Type: String
472
- #
473
459
  # **MySQL**
474
460
  #
475
461
  # The name of the database to create when the DB instance is created. If
@@ -689,7 +675,7 @@ module Aws::RDS
689
675
  # **Amazon Aurora**
690
676
  #
691
677
  # Not applicable. The name for the master user is managed by the DB
692
- # cluster. For more information, see CreateDBCluster.
678
+ # cluster.
693
679
  #
694
680
  # **MariaDB**
695
681
  #
@@ -755,7 +741,7 @@ module Aws::RDS
755
741
  # **Amazon Aurora**
756
742
  #
757
743
  # Not applicable. The password for the master user is managed by the DB
758
- # cluster. For more information, see CreateDBCluster.
744
+ # cluster.
759
745
  #
760
746
  # **MariaDB**
761
747
  #
@@ -787,12 +773,12 @@ module Aws::RDS
787
773
  # **Amazon Aurora**
788
774
  #
789
775
  # Not applicable. The associated list of EC2 VPC security groups is
790
- # managed by the DB cluster. For more information, see CreateDBCluster.
776
+ # managed by the DB cluster.
791
777
  #
792
778
  # Default: The default EC2 VPC security group for the DB subnet group's
793
779
  # VPC.
794
780
  # @option options [String] :availability_zone
795
- # The EC2 Availability Zone that the DB instance is created in. For
781
+ # The Availability Zone (AZ) where the database will be created. For
796
782
  # information on AWS Regions and Availability Zones, see [Regions and
797
783
  # Availability Zones][1].
798
784
  #
@@ -801,9 +787,9 @@ module Aws::RDS
801
787
  #
802
788
  # Example: `us-east-1d`
803
789
  #
804
- # Constraint: The AvailabilityZone parameter can't be specified if the
805
- # MultiAZ parameter is set to `true`. The specified Availability Zone
806
- # must be in the same AWS Region as the current endpoint.
790
+ # Constraint: The `AvailabilityZone` parameter can't be specified if
791
+ # the DB instance is a Multi-AZ deployment. The specified Availability
792
+ # Zone must be in the same AWS Region as the current endpoint.
807
793
  #
808
794
  #
809
795
  #
@@ -850,7 +836,7 @@ module Aws::RDS
850
836
  # **Amazon Aurora**
851
837
  #
852
838
  # Not applicable. The retention period for automated backups is managed
853
- # by the DB cluster. For more information, see CreateDBCluster.
839
+ # by the DB cluster.
854
840
  #
855
841
  # Default: 1
856
842
  #
@@ -868,7 +854,7 @@ module Aws::RDS
868
854
  # **Amazon Aurora**
869
855
  #
870
856
  # Not applicable. The daily time range for creating automated backups is
871
- # managed by the DB cluster. For more information, see CreateDBCluster.
857
+ # managed by the DB cluster.
872
858
  #
873
859
  # The default is a 30-minute window selected at random from an 8-hour
874
860
  # block of time for each AWS Region. To see the time blocks available,
@@ -937,13 +923,14 @@ module Aws::RDS
937
923
  #
938
924
  # Type: Integer
939
925
  # @option options [Boolean] :multi_az
940
- # A value that specifies whether the DB instance is a Multi-AZ
941
- # deployment. You can't set the AvailabilityZone parameter if the
942
- # MultiAZ parameter is set to true.
926
+ # A value that indicates whether the DB instance is a Multi-AZ
927
+ # deployment. You can't set the `AvailabilityZone` parameter if the DB
928
+ # instance is a Multi-AZ deployment.
943
929
  # @option options [String] :engine_version
944
930
  # The version number of the database engine to use.
945
931
  #
946
- # For a list of valid engine versions, call DescribeDBEngineVersions.
932
+ # For a list of valid engine versions, use the
933
+ # `DescribeDBEngineVersions` action.
947
934
  #
948
935
  # The following are the database engines and links to information about
949
936
  # the major and minor versions that are available with Amazon RDS. Not
@@ -952,8 +939,7 @@ module Aws::RDS
952
939
  # **Amazon Aurora**
953
940
  #
954
941
  # Not applicable. The version number of the database engine to be used
955
- # by the DB instance is managed by the DB cluster. For more information,
956
- # see CreateDBCluster.
942
+ # by the DB instance is managed by the DB cluster.
957
943
  #
958
944
  # **MariaDB**
959
945
  #
@@ -987,10 +973,9 @@ module Aws::RDS
987
973
  # [4]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Appendix.Oracle.PatchComposition.html
988
974
  # [5]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_PostgreSQL.html#PostgreSQL.Concepts.General.DBVersions
989
975
  # @option options [Boolean] :auto_minor_version_upgrade
990
- # Indicates that minor engine upgrades are applied automatically to the
991
- # DB instance during the maintenance window.
992
- #
993
- # Default: `true`
976
+ # A value that indicates whether minor engine upgrades are applied
977
+ # automatically to the DB instance during the maintenance window. By
978
+ # default, minor engine upgrades are applied automatically.
994
979
  # @option options [String] :license_model
995
980
  # License model information for this DB instance.
996
981
  #
@@ -1023,13 +1008,14 @@ module Aws::RDS
1023
1008
  # **Amazon Aurora**
1024
1009
  #
1025
1010
  # Not applicable. The character set is managed by the DB cluster. For
1026
- # more information, see CreateDBCluster.
1011
+ # more information, see `CreateDBCluster`.
1027
1012
  # @option options [Boolean] :publicly_accessible
1028
- # Specifies the accessibility options for the DB instance. A value of
1029
- # true specifies an Internet-facing instance with a publicly resolvable
1030
- # DNS name, which resolves to a public IP address. A value of false
1031
- # specifies an internal instance with a DNS name that resolves to a
1032
- # private IP address.
1013
+ # A value that indicates whether the DB instance is publicly accessible.
1014
+ # When the DB instance is publicly accessible, it is an Internet-facing
1015
+ # instance with a publicly resolvable DNS name, which resolves to a
1016
+ # public IP address. When the DB instance is not publicly accessible, it
1017
+ # is an internal instance with a DNS name that resolves to a private IP
1018
+ # address.
1033
1019
  #
1034
1020
  # Default: The default behavior varies depending on whether
1035
1021
  # `DBSubnetGroupName` is specified.
@@ -1052,18 +1038,9 @@ module Aws::RDS
1052
1038
  # * If the subnets are part of a VPC that has an Internet gateway
1053
1039
  # attached to it, the DB instance is public.
1054
1040
  # @option options [Array<Types::Tag>] :tags
1055
- # A list of tags. For more information, see [Tagging Amazon RDS
1056
- # Resources][1] in the *Amazon RDS User Guide.*
1057
- #
1058
- #
1059
- #
1060
- # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html
1041
+ # Tags to assign to the DB instance.
1061
1042
  # @option options [String] :db_cluster_identifier
1062
1043
  # The identifier of the DB cluster that the instance will belong to.
1063
- #
1064
- # For information on creating a DB cluster, see CreateDBCluster.
1065
- #
1066
- # Type: String
1067
1044
  # @option options [String] :storage_type
1068
1045
  # Specifies the storage type to be associated with the DB instance.
1069
1046
  #
@@ -1072,8 +1049,7 @@ module Aws::RDS
1072
1049
  # If you specify `io1`, you must also include a value for the `Iops`
1073
1050
  # parameter.
1074
1051
  #
1075
- # Default: `io1` if the `Iops` parameter is specified, otherwise
1076
- # `standard`
1052
+ # Default: `io1` if the `Iops` parameter is specified, otherwise `gp2`
1077
1053
  # @option options [String] :tde_credential_arn
1078
1054
  # The ARN from the key store with which to associate the instance for
1079
1055
  # TDE encryption.
@@ -1081,14 +1057,13 @@ module Aws::RDS
1081
1057
  # The password for the given ARN from the key store in order to access
1082
1058
  # the device.
1083
1059
  # @option options [Boolean] :storage_encrypted
1084
- # Specifies whether the DB instance is encrypted.
1060
+ # A value that indicates whether the DB instance is encrypted. By
1061
+ # default, it is not encrypted.
1085
1062
  #
1086
1063
  # **Amazon Aurora**
1087
1064
  #
1088
1065
  # Not applicable. The encryption for DB instances is managed by the DB
1089
- # cluster. For more information, see CreateDBCluster.
1090
- #
1091
- # Default: false
1066
+ # cluster.
1092
1067
  # @option options [String] :kms_key_id
1093
1068
  # The AWS KMS key identifier for an encrypted DB instance.
1094
1069
  #
@@ -1101,24 +1076,34 @@ module Aws::RDS
1101
1076
  # **Amazon Aurora**
1102
1077
  #
1103
1078
  # Not applicable. The KMS key identifier is managed by the DB cluster.
1104
- # For more information, see CreateDBCluster.
1079
+ # For more information, see `CreateDBCluster`.
1105
1080
  #
1106
- # If the `StorageEncrypted` parameter is true, and you do not specify a
1107
- # value for the `KmsKeyId` parameter, then Amazon RDS will use your
1108
- # default encryption key. AWS KMS creates the default encryption key for
1109
- # your AWS account. Your AWS account has a different default encryption
1110
- # key for each AWS Region.
1081
+ # If `StorageEncrypted` is enabled, and you do not specify a value for
1082
+ # the `KmsKeyId` parameter, then Amazon RDS will use your default
1083
+ # encryption key. AWS KMS creates the default encryption key for your
1084
+ # AWS account. Your AWS account has a different default encryption key
1085
+ # for each AWS Region.
1111
1086
  # @option options [String] :domain
1112
- # Specify the Active Directory Domain to create the instance in.
1087
+ # For an Amazon RDS DB instance that's running Microsoft SQL Server,
1088
+ # this parameter specifies the Active Directory directory ID to create
1089
+ # the instance in. Amazon RDS uses Windows Authentication to
1090
+ # authenticate users that connect to the DB instance. For more
1091
+ # information, see [Using Windows Authentication with an Amazon RDS DB
1092
+ # Instance Running Microsoft SQL Server][1] in the *Amazon RDS User
1093
+ # Guide*.
1094
+ #
1095
+ #
1096
+ #
1097
+ # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/DeveloperGuide/USER_SQLServerWinAuth.html
1113
1098
  # @option options [Boolean] :copy_tags_to_snapshot
1114
- # True to copy all tags from the DB instance to snapshots of the DB
1115
- # instance, and otherwise false. The default is false.
1099
+ # A value that indicates whether to copy tags from the DB instance to
1100
+ # snapshots of the DB instance. By default, tags are not copied.
1116
1101
  #
1117
1102
  # **Amazon Aurora**
1118
1103
  #
1119
1104
  # Not applicable. Copying tags to snapshots is managed by the DB
1120
1105
  # cluster. Setting this value for an Aurora DB instance has no effect on
1121
- # the DB cluster setting. For more information, see CreateDBCluster.
1106
+ # the DB cluster setting.
1122
1107
  # @option options [Integer] :monitoring_interval
1123
1108
  # The interval, in seconds, between points when Enhanced Monitoring
1124
1109
  # metrics are collected for the DB instance. To disable collecting
@@ -1165,8 +1150,9 @@ module Aws::RDS
1165
1150
  #
1166
1151
  # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_SQLServer.html#SQLServer.Concepts.General.TimeZone
1167
1152
  # @option options [Boolean] :enable_iam_database_authentication
1168
- # True to enable mapping of AWS Identity and Access Management (IAM)
1169
- # accounts to database accounts, and otherwise false.
1153
+ # A value that indicates whether to enable mapping of AWS Identity and
1154
+ # Access Management (IAM) accounts to database accounts. By default,
1155
+ # mapping is disabled.
1170
1156
  #
1171
1157
  # You can enable IAM database authentication for the following database
1172
1158
  # engines:
@@ -1174,18 +1160,16 @@ module Aws::RDS
1174
1160
  # **Amazon Aurora**
1175
1161
  #
1176
1162
  # Not applicable. Mapping AWS IAM accounts to database accounts is
1177
- # managed by the DB cluster. For more information, see CreateDBCluster.
1163
+ # managed by the DB cluster.
1178
1164
  #
1179
1165
  # **MySQL**
1180
1166
  #
1181
1167
  # * For MySQL 5.6, minor version 5.6.34 or higher
1182
1168
  #
1183
1169
  # * For MySQL 5.7, minor version 5.7.16 or higher
1184
- #
1185
- # Default: `false`
1186
1170
  # @option options [Boolean] :enable_performance_insights
1187
- # True to enable Performance Insights for the DB instance, and otherwise
1188
- # false.
1171
+ # A value that indicates whether to enable Performance Insights for the
1172
+ # DB instance.
1189
1173
  #
1190
1174
  # For more information, see [Using Amazon Performance Insights][1] in
1191
1175
  # the *Amazon Relational Database Service User Guide*.
@@ -1197,6 +1181,11 @@ module Aws::RDS
1197
1181
  # The AWS KMS key identifier for encryption of Performance Insights
1198
1182
  # data. The KMS key ID is the Amazon Resource Name (ARN), KMS key
1199
1183
  # identifier, or the KMS key alias for the KMS encryption key.
1184
+ #
1185
+ # If you do not specify a value for `PerformanceInsightsKMSKeyId`, then
1186
+ # Amazon RDS uses your default encryption key. AWS KMS creates the
1187
+ # default encryption key for your AWS account. Your AWS account has a
1188
+ # different default encryption key for each AWS Region.
1200
1189
  # @option options [Integer] :performance_insights_retention_period
1201
1190
  # The amount of time, in days, to retain Performance Insights data.
1202
1191
  # Valid values are 7 or 731 (2 years).
@@ -1214,10 +1203,10 @@ module Aws::RDS
1214
1203
  # The number of CPU cores and the number of threads per core for the DB
1215
1204
  # instance class of the DB instance.
1216
1205
  # @option options [Boolean] :deletion_protection
1217
- # Indicates if the DB instance should have deletion protection enabled.
1218
- # The database can't be deleted when this value is set to true. The
1219
- # default is false. For more information, see [ Deleting a DB
1220
- # Instance][1].
1206
+ # A value that indicates whether the DB instance has deletion protection
1207
+ # enabled. The database can't be deleted when deletion protection is
1208
+ # enabled. By default, deletion protection is disabled. For more
1209
+ # information, see [ Deleting a DB Instance][1].
1221
1210
  #
1222
1211
  #
1223
1212
  #
@@ -1278,12 +1267,7 @@ module Aws::RDS
1278
1267
  # @option options [required, String] :description
1279
1268
  # The description for the DB parameter group.
1280
1269
  # @option options [Array<Types::Tag>] :tags
1281
- # A list of tags. For more information, see [Tagging Amazon RDS
1282
- # Resources][1] in the *Amazon RDS User Guide.*
1283
- #
1284
- #
1285
- #
1286
- # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html
1270
+ # Tags to assign to the DB parameter group.
1287
1271
  # @return [DBParameterGroup]
1288
1272
  def create_db_parameter_group(options = {})
1289
1273
  resp = @client.create_db_parameter_group(options)
@@ -1325,12 +1309,7 @@ module Aws::RDS
1325
1309
  # @option options [required, String] :db_security_group_description
1326
1310
  # The description for the DB security group.
1327
1311
  # @option options [Array<Types::Tag>] :tags
1328
- # A list of tags. For more information, see [Tagging Amazon RDS
1329
- # Resources][1] in the *Amazon RDS User Guide.*
1330
- #
1331
- #
1332
- #
1333
- # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html
1312
+ # Tags to assign to the DB security group.
1334
1313
  # @return [DBSecurityGroup]
1335
1314
  def create_db_security_group(options = {})
1336
1315
  resp = @client.create_db_security_group(options)
@@ -1368,12 +1347,7 @@ module Aws::RDS
1368
1347
  # @option options [required, Array<String>] :subnet_ids
1369
1348
  # The EC2 Subnet IDs for the DB subnet group.
1370
1349
  # @option options [Array<Types::Tag>] :tags
1371
- # A list of tags. For more information, see [Tagging Amazon RDS
1372
- # Resources][1] in the *Amazon RDS User Guide.*
1373
- #
1374
- #
1375
- #
1376
- # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html
1350
+ # Tags to assign to the DB subnet group.
1377
1351
  # @return [DBSubnetGroup]
1378
1352
  def create_db_subnet_group(options = {})
1379
1353
  resp = @client.create_db_subnet_group(options)
@@ -1449,8 +1423,9 @@ module Aws::RDS
1449
1423
  # * If the source type is a DB snapshot, a `DBSnapshotIdentifier` must
1450
1424
  # be supplied.
1451
1425
  # @option options [Boolean] :enabled
1452
- # A Boolean value; set to **true** to activate the subscription, set to
1453
- # **false** to create the subscription but not active it.
1426
+ # A value that indicates whether to activate the subscription. If the
1427
+ # event notification subscription is not activated, the subscription is
1428
+ # created but not active.
1454
1429
  # @option options [Array<Types::Tag>] :tags
1455
1430
  # A list of tags. For more information, see [Tagging Amazon RDS
1456
1431
  # Resources][1] in the *Amazon RDS User Guide.*
@@ -1504,12 +1479,7 @@ module Aws::RDS
1504
1479
  # @option options [required, String] :option_group_description
1505
1480
  # The description of the option group.
1506
1481
  # @option options [Array<Types::Tag>] :tags
1507
- # A list of tags. For more information, see [Tagging Amazon RDS
1508
- # Resources][1] in the *Amazon RDS User Guide.*
1509
- #
1510
- #
1511
- #
1512
- # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html
1482
+ # Tags to assign to the option group.
1513
1483
  # @return [OptionGroup]
1514
1484
  def create_option_group(options = {})
1515
1485
  resp = @client.create_option_group(options)
@@ -1589,7 +1559,7 @@ module Aws::RDS
1589
1559
  # Constraints: Minimum 20, maximum 100.
1590
1560
  # @option options [String] :marker
1591
1561
  # An optional pagination token provided by a previous
1592
- # DescribeCertificates request. If this parameter is specified, the
1562
+ # `DescribeCertificates` request. If this parameter is specified, the
1593
1563
  # response includes only records beyond the marker, up to the value
1594
1564
  # specified by `MaxRecords`.
1595
1565
  # @return [Certificate::Collection]
@@ -1790,14 +1760,20 @@ module Aws::RDS
1790
1760
  # @option options [Array<Types::Filter>] :filters
1791
1761
  # This parameter is not currently supported.
1792
1762
  # @option options [Boolean] :default_only
1793
- # Indicates that only the default version of the specified engine or
1794
- # engine and major version combination is returned.
1763
+ # A value that indicates whether only the default version of the
1764
+ # specified engine or engine and major version combination is returned.
1795
1765
  # @option options [Boolean] :list_supported_character_sets
1796
- # If this parameter is specified and the requested engine supports the
1766
+ # A value that indicates whether to list the supported character sets
1767
+ # for each engine version.
1768
+ #
1769
+ # If this parameter is enabled and the requested engine supports the
1797
1770
  # `CharacterSetName` parameter for `CreateDBInstance`, the response
1798
1771
  # includes a list of supported character sets for each engine version.
1799
1772
  # @option options [Boolean] :list_supported_timezones
1800
- # If this parameter is specified and the requested engine supports the
1773
+ # A value that indicates whether to list the supported time zones for
1774
+ # each engine version.
1775
+ #
1776
+ # If this parameter is enabled and the requested engine supports the
1801
1777
  # `TimeZone` parameter for `CreateDBInstance`, the response includes a
1802
1778
  # list of supported time zones for each engine version.
1803
1779
  # @return [DBEngineVersion::Collection]
@@ -2051,9 +2027,9 @@ module Aws::RDS
2051
2027
  # If you don't specify a `SnapshotType` value, then both automated and
2052
2028
  # manual snapshots are returned. Shared and public DB snapshots are not
2053
2029
  # included in the returned results by default. You can include shared
2054
- # snapshots with these results by setting the `IncludeShared` parameter
2055
- # to `true`. You can include public snapshots with these results by
2056
- # setting the `IncludePublic` parameter to `true`.
2030
+ # snapshots with these results by enabling the `IncludeShared`
2031
+ # parameter. You can include public snapshots with these results by
2032
+ # enabling the `IncludePublic` parameter.
2057
2033
  #
2058
2034
  # The `IncludeShared` and `IncludePublic` parameters don't apply for
2059
2035
  # `SnapshotType` values of `manual` or `automated`. The `IncludePublic`
@@ -2067,17 +2043,18 @@ module Aws::RDS
2067
2043
  # @option options [Array<Types::Filter>] :filters
2068
2044
  # This parameter is not currently supported.
2069
2045
  # @option options [Boolean] :include_shared
2070
- # True to include shared manual DB snapshots from other AWS accounts
2071
- # that this AWS account has been given permission to copy or restore,
2072
- # and otherwise false. The default is `false`.
2046
+ # A value that indicates whether to include shared manual DB cluster
2047
+ # snapshots from other AWS accounts that this AWS account has been given
2048
+ # permission to copy or restore. By default, these snapshots are not
2049
+ # included.
2073
2050
  #
2074
2051
  # You can give an AWS account permission to restore a manual DB snapshot
2075
- # from another AWS account by using the ModifyDBSnapshotAttribute API
2052
+ # from another AWS account by using the `ModifyDBSnapshotAttribute` API
2076
2053
  # action.
2077
2054
  # @option options [Boolean] :include_public
2078
- # True to include manual DB snapshots that are public and can be copied
2079
- # or restored by any AWS account, and otherwise false. The default is
2080
- # false.
2055
+ # A value that indicates whether to include manual DB cluster snapshots
2056
+ # that are public and can be copied or restored by any AWS account. By
2057
+ # default, the public snapshots are not included.
2081
2058
  #
2082
2059
  # You can share a manual DB snapshot as public by using the
2083
2060
  # ModifyDBSnapshotAttribute API.
@@ -2444,8 +2421,8 @@ module Aws::RDS
2444
2421
  #
2445
2422
  # Valid Values: `"Partial Upfront" | "All Upfront" | "No Upfront" `
2446
2423
  # @option options [Boolean] :multi_az
2447
- # The Multi-AZ filter value. Specify this parameter to show only those
2448
- # reservations matching the specified Multi-AZ parameter.
2424
+ # A value that indicates whether to show only those reservations that
2425
+ # support Multi-AZ.
2449
2426
  # @option options [Array<Types::Filter>] :filters
2450
2427
  # This parameter is not currently supported.
2451
2428
  # @return [ReservedDBInstance::Collection]
@@ -2521,8 +2498,8 @@ module Aws::RDS
2521
2498
  #
2522
2499
  # Valid Values: `"Partial Upfront" | "All Upfront" | "No Upfront" `
2523
2500
  # @option options [Boolean] :multi_az
2524
- # The Multi-AZ filter value. Specify this parameter to show only the
2525
- # available offerings matching the specified Multi-AZ parameter.
2501
+ # A value that indicates whether to show only those reservations that
2502
+ # support Multi-AZ.
2526
2503
  # @option options [Array<Types::Filter>] :filters
2527
2504
  # This parameter is not currently supported.
2528
2505
  # @return [ReservedDBInstancesOffering::Collection]