aws-sdk-rds 1.7.0 → 1.8.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -306,16 +306,16 @@ module Aws::RDS
306
306
  data[:storage_encrypted]
307
307
  end
308
308
 
309
- # If `StorageEncrypted` is true, the KMS key identifier for the
309
+ # If `StorageEncrypted` is true, the AWS KMS key identifier for the
310
310
  # encrypted DB instance.
311
311
  # @return [String]
312
312
  def kms_key_id
313
313
  data[:kms_key_id]
314
314
  end
315
315
 
316
- # The region-unique, immutable identifier for the DB instance. This
317
- # identifier is found in AWS CloudTrail log entries whenever the KMS key
318
- # for the DB instance is accessed.
316
+ # The AWS Region-unique, immutable identifier for the DB instance. This
317
+ # identifier is found in AWS CloudTrail log entries whenever the AWS KMS
318
+ # key for the DB instance is accessed.
319
319
  # @return [String]
320
320
  def dbi_resource_id
321
321
  data[:dbi_resource_id]
@@ -357,7 +357,7 @@ module Aws::RDS
357
357
  end
358
358
 
359
359
  # The ARN for the IAM role that permits RDS to send Enhanced Monitoring
360
- # metrics to CloudWatch Logs.
360
+ # metrics to Amazon CloudWatch Logs.
361
361
  # @return [String]
362
362
  def monitoring_role_arn
363
363
  data[:monitoring_role_arn]
@@ -391,7 +391,7 @@ module Aws::RDS
391
391
  end
392
392
 
393
393
  # True if mapping of AWS Identity and Access Management (IAM) accounts
394
- # to database accounts is enabled; otherwise false.
394
+ # to database accounts is enabled, and otherwise false.
395
395
  #
396
396
  # IAM database authentication can be enabled for the following database
397
397
  # engines
@@ -407,16 +407,16 @@ module Aws::RDS
407
407
  data[:iam_database_authentication_enabled]
408
408
  end
409
409
 
410
- # True if Performance Insights is enabled for the DB instance; otherwise
411
- # false.
410
+ # True if Performance Insights is enabled for the DB instance, and
411
+ # otherwise false.
412
412
  # @return [Boolean]
413
413
  def performance_insights_enabled
414
414
  data[:performance_insights_enabled]
415
415
  end
416
416
 
417
- # The KMS key identifier for encryption of Performance Insights data.
418
- # The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier,
419
- # or the KMS key alias for the KMS encryption key.
417
+ # The AWS KMS key identifier for encryption of Performance Insights
418
+ # data. The KMS key ID is the Amazon Resource Name (ARN), KMS key
419
+ # identifier, or the KMS key alias for the KMS encryption key.
420
420
  # @return [String]
421
421
  def performance_insights_kms_key_id
422
422
  data[:performance_insights_kms_key_id]
@@ -680,7 +680,7 @@ module Aws::RDS
680
680
  # * Cannot be a word reserved by the specified database engine
681
681
  # @option options [Integer] :allocated_storage
682
682
  # The amount of storage (in gigabytes) to be initially allocated for the
683
- # database instance.
683
+ # DB instance.
684
684
  #
685
685
  # Type: Integer
686
686
  #
@@ -765,8 +765,8 @@ module Aws::RDS
765
765
  # * Web and Express editions: Must be an integer from 20 to 1024.
766
766
  # @option options [required, String] :db_instance_class
767
767
  # The compute and memory capacity of the DB instance, for example,
768
- # `db.m4.large`. Not all DB instance classes are available in all
769
- # regions, or for all database engines. For the full list of DB instance
768
+ # `db.m4.large`. Not all DB instance classes are available in all AWS
769
+ # Regions, or for all database engines. For the full list of DB instance
770
770
  # classes, and availability for your engine, see [DB Instance Class][1]
771
771
  # in the Amazon RDS User Guide.
772
772
  #
@@ -782,6 +782,8 @@ module Aws::RDS
782
782
  #
783
783
  # * `aurora`
784
784
  #
785
+ # * `aurora-postgresql`
786
+ #
785
787
  # * `mariadb`
786
788
  #
787
789
  # * `mysql`
@@ -869,8 +871,8 @@ module Aws::RDS
869
871
  #
870
872
  # * Cannot be a reserved word for the chosen database engine.
871
873
  # @option options [String] :master_user_password
872
- # The password for the master user. Can be any printable ASCII character
873
- # except "/", """, or "@".
874
+ # The password for the master user. The password can include any
875
+ # printable ASCII character except "/", """, or "@".
874
876
  #
875
877
  # **Amazon Aurora**
876
878
  #
@@ -911,8 +913,8 @@ module Aws::RDS
911
913
  # Default: The default EC2 VPC security group for the DB subnet group's
912
914
  # VPC.
913
915
  # @option options [String] :availability_zone
914
- # The EC2 Availability Zone that the database instance is created in.
915
- # For information on regions and Availability Zones, see [Regions and
916
+ # The EC2 Availability Zone that the DB instance is created in. For
917
+ # information on AWS Regions and Availability Zones, see [Regions and
916
918
  # Availability Zones][1].
917
919
  #
918
920
  # Default: A random, system-chosen Availability Zone in the endpoint's
@@ -920,7 +922,7 @@ module Aws::RDS
920
922
  #
921
923
  # Example: `us-east-1d`
922
924
  #
923
- # Constraint: The AvailabilityZone parameter cannot be specified if the
925
+ # Constraint: The AvailabilityZone parameter can't be specified if the
924
926
  # MultiAZ parameter is set to `true`. The specified Availability Zone
925
927
  # must be in the same AWS Region as the current endpoint.
926
928
  #
@@ -932,25 +934,23 @@ module Aws::RDS
932
934
  #
933
935
  # If there is no DB subnet group, then it is a non-VPC DB instance.
934
936
  # @option options [String] :preferred_maintenance_window
935
- # The weekly time range during which system maintenance can occur, in
936
- # Universal Coordinated Time (UTC). For more information, see [DB
937
- # Instance Maintenance][1].
937
+ # The time range each week during which system maintenance can occur, in
938
+ # Universal Coordinated Time (UTC). For more information, see [Amazon
939
+ # RDS Maintenance Window][1].
938
940
  #
939
941
  # Format: `ddd:hh24:mi-ddd:hh24:mi`
940
942
  #
941
- # Default: A 30-minute window selected at random from an 8-hour block of
942
- # time per AWS Region, occurring on a random day of the week. To see the
943
- # time blocks available, see [ Adjusting the Preferred Maintenance
944
- # Window][2] in the *Amazon RDS User Guide.*
943
+ # The default is a 30-minute window selected at random from an 8-hour
944
+ # block of time for each AWS Region, occurring on a random day of the
945
+ # week.
945
946
  #
946
- # Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun
947
+ # Valid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.
947
948
  #
948
949
  # Constraints: Minimum 30-minute window.
949
950
  #
950
951
  #
951
952
  #
952
- # [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBMaintenance.html
953
- # [2]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/AdjustingTheMaintenanceWindow.html
953
+ # [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.Maintenance.html#Concepts.DBMaintenance
954
954
  # @option options [String] :db_parameter_group_name
955
955
  # The name of the DB parameter group to associate with this DB instance.
956
956
  # If this argument is omitted, the default DBParameterGroup for the
@@ -983,22 +983,22 @@ module Aws::RDS
983
983
  # @option options [String] :preferred_backup_window
984
984
  # The daily time range during which automated backups are created if
985
985
  # automated backups are enabled, using the `BackupRetentionPeriod`
986
- # parameter. For more information, see [DB Instance Backups][1].
986
+ # parameter. For more information, see [The Backup Window][1].
987
987
  #
988
988
  # **Amazon Aurora**
989
989
  #
990
990
  # Not applicable. The daily time range for creating automated backups is
991
991
  # managed by the DB cluster. For more information, see CreateDBCluster.
992
992
  #
993
- # Default: A 30-minute window selected at random from an 8-hour block of
994
- # time per AWS Region. To see the time blocks available, see [ Adjusting
995
- # the Preferred DB Instance Maintenance Window][2].
993
+ # The default is a 30-minute window selected at random from an 8-hour
994
+ # block of time for each AWS Region. To see the time blocks available,
995
+ # see [ Adjusting the Preferred DB Instance Maintenance Window][2].
996
996
  #
997
997
  # Constraints:
998
998
  #
999
999
  # * Must be in the format `hh24:mi-hh24:mi`.
1000
1000
  #
1001
- # * Times should be in Universal Coordinated Time (UTC).
1001
+ # * Must be in Universal Coordinated Time (UTC).
1002
1002
  #
1003
1003
  # * Must not conflict with the preferred maintenance window.
1004
1004
  #
@@ -1006,7 +1006,7 @@ module Aws::RDS
1006
1006
  #
1007
1007
  #
1008
1008
  #
1009
- # [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Overview.BackingUpAndRestoringAmazonRDSInstances.html
1009
+ # [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithAutomatedBackups.html#USER_WorkingWithAutomatedBackups.BackupWindow
1010
1010
  # [2]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.Maintenance.html#AdjustingTheMaintenanceWindow
1011
1011
  # @option options [Integer] :port
1012
1012
  # The port number on which the database accepts connections.
@@ -1056,7 +1056,7 @@ module Aws::RDS
1056
1056
  #
1057
1057
  # Type: Integer
1058
1058
  # @option options [Boolean] :multi_az
1059
- # Specifies if the DB instance is a Multi-AZ deployment. You cannot set
1059
+ # Specifies if the DB instance is a Multi-AZ deployment. You can't set
1060
1060
  # the AvailabilityZone parameter if the MultiAZ parameter is set to
1061
1061
  # true.
1062
1062
  # @option options [String] :engine_version
@@ -1074,59 +1074,59 @@ module Aws::RDS
1074
1074
  #
1075
1075
  # **MariaDB**
1076
1076
  #
1077
- # * `10.1.23` (supported in all AWS regions)
1077
+ # * `10.1.23` (supported in all AWS Regions)
1078
1078
  #
1079
- # * `10.1.19` (supported in all AWS regions)
1079
+ # * `10.1.19` (supported in all AWS Regions)
1080
1080
  #
1081
- # * `10.1.14` (supported in all regions except us-east-2)
1081
+ # * `10.1.14` (supported in all AWS Regions except us-east-2)
1082
1082
  #
1083
1083
  #
1084
1084
  #
1085
- # * `10.0.31` (supported in all AWS regions)
1085
+ # * `10.0.31` (supported in all AWS Regions)
1086
1086
  #
1087
- # * `10.0.28` (supported in all AWS regions)
1087
+ # * `10.0.28` (supported in all AWS Regions)
1088
1088
  #
1089
- # * `10.0.24` (supported in all AWS regions)
1089
+ # * `10.0.24` (supported in all AWS Regions)
1090
1090
  #
1091
- # * `10.0.17` (supported in all regions except us-east-2, ca-central-1,
1092
- # eu-west-2)
1091
+ # * `10.0.17` (supported in all AWS Regions except us-east-2,
1092
+ # ca-central-1, eu-west-2)
1093
1093
  #
1094
1094
  # **Microsoft SQL Server 2016**
1095
1095
  #
1096
- # * `13.00.4422.0.v1` (supported for all editions, and all AWS regions)
1096
+ # * `13.00.4422.0.v1` (supported for all editions, and all AWS Regions)
1097
1097
  #
1098
- # * `13.00.2164.0.v1` (supported for all editions, and all AWS regions)
1098
+ # * `13.00.2164.0.v1` (supported for all editions, and all AWS Regions)
1099
1099
  #
1100
1100
  # **Microsoft SQL Server 2014**
1101
1101
  #
1102
- # * `12.00.5546.0.v1` (supported for all editions, and all AWS regions)
1102
+ # * `12.00.5546.0.v1` (supported for all editions, and all AWS Regions)
1103
1103
  #
1104
- # * `12.00.5000.0.v1` (supported for all editions, and all AWS regions)
1104
+ # * `12.00.5000.0.v1` (supported for all editions, and all AWS Regions)
1105
1105
  #
1106
1106
  # * `12.00.4422.0.v1` (supported for all editions except Enterprise
1107
- # Edition, and all AWS regions except ca-central-1 and eu-west-2)
1107
+ # Edition, and all AWS Regions except ca-central-1 and eu-west-2)
1108
1108
  #
1109
1109
  # **Microsoft SQL Server 2012**
1110
1110
  #
1111
- # * `11.00.6594.0.v1` (supported for all editions, and all AWS regions)
1111
+ # * `11.00.6594.0.v1` (supported for all editions, and all AWS Regions)
1112
1112
  #
1113
- # * `11.00.6020.0.v1` (supported for all editions, and all AWS regions)
1113
+ # * `11.00.6020.0.v1` (supported for all editions, and all AWS Regions)
1114
1114
  #
1115
- # * `11.00.5058.0.v1` (supported for all editions, and all AWS regions
1115
+ # * `11.00.5058.0.v1` (supported for all editions, and all AWS Regions
1116
1116
  # except us-east-2, ca-central-1, and eu-west-2)
1117
1117
  #
1118
- # * `11.00.2100.60.v1` (supported for all editions, and all AWS regions
1118
+ # * `11.00.2100.60.v1` (supported for all editions, and all AWS Regions
1119
1119
  # except us-east-2, ca-central-1, and eu-west-2)
1120
1120
  #
1121
1121
  # **Microsoft SQL Server 2008 R2**
1122
1122
  #
1123
- # * `10.50.6529.0.v1` (supported for all editions, and all AWS regions
1123
+ # * `10.50.6529.0.v1` (supported for all editions, and all AWS Regions
1124
1124
  # except us-east-2, ca-central-1, and eu-west-2)
1125
1125
  #
1126
- # * `10.50.6000.34.v1` (supported for all editions, and all AWS regions
1126
+ # * `10.50.6000.34.v1` (supported for all editions, and all AWS Regions
1127
1127
  # except us-east-2, ca-central-1, and eu-west-2)
1128
1128
  #
1129
- # * `10.50.2789.0.v1` (supported for all editions, and all AWS regions
1129
+ # * `10.50.2789.0.v1` (supported for all editions, and all AWS Regions
1130
1130
  # except us-east-2, ca-central-1, and eu-west-2)
1131
1131
  #
1132
1132
  # **MySQL**
@@ -1137,30 +1137,28 @@ module Aws::RDS
1137
1137
  #
1138
1138
  # * `5.7.16` (supported in all AWS regions)
1139
1139
  #
1140
- # * `5.7.11` (supported in all AWS regions)
1141
- #
1142
1140
  #
1143
1141
  #
1144
- # * `5.6.37` (supported in all AWS regions)
1142
+ # * `5.6.37` (supported in all AWS Regions)
1145
1143
  #
1146
- # * `5.6.35` (supported in all AWS regions)
1144
+ # * `5.6.35` (supported in all AWS Regions)
1147
1145
  #
1148
- # * `5.6.34` (supported in all AWS regions)
1146
+ # * `5.6.34` (supported in all AWS Regions)
1149
1147
  #
1150
- # * `5.6.29` (supported in all AWS regions)
1148
+ # * `5.6.29` (supported in all AWS Regions)
1151
1149
  #
1152
- # * `5.6.27` (supported in all regions except us-east-2, ca-central-1,
1153
- # eu-west-2)
1150
+ # * `5.6.27` (supported in all AWS Regions except us-east-2,
1151
+ # ca-central-1, eu-west-2)
1154
1152
  #
1155
1153
  #
1156
1154
  #
1157
- # * `5.5.57` (supported in all AWS regions)
1155
+ # * `5.5.57` (supported in all AWS Regions)
1158
1156
  #
1159
- # * `5.5.54` (supported in all AWS regions)
1157
+ # * `5.5.54` (supported in all AWS Regions)
1160
1158
  #
1161
- # * `5.5.53` (supported in all AWS regions)
1159
+ # * `5.5.53` (supported in all AWS Regions)
1162
1160
  #
1163
- # * `5.5.46` (supported in all AWS regions)
1161
+ # * `5.5.46` (supported in all AWS Regions)
1164
1162
  #
1165
1163
  # **Oracle 12c**
1166
1164
  #
@@ -1238,19 +1236,25 @@ module Aws::RDS
1238
1236
  # `general-public-license`
1239
1237
  # @option options [Integer] :iops
1240
1238
  # The amount of Provisioned IOPS (input/output operations per second) to
1241
- # be initially allocated for the DB instance.
1239
+ # be initially allocated for the DB instance. For information about
1240
+ # valid Iops values, see see [Amazon RDS Provisioned IOPS Storage to
1241
+ # Improve Performance][1].
1242
1242
  #
1243
1243
  # Constraints: Must be a multiple between 3 and 10 of the storage amount
1244
1244
  # for the DB instance. Must also be an integer multiple of 1000. For
1245
1245
  # example, if the size of your DB instance is 500 GB, then your `Iops`
1246
1246
  # value can be 2000, 3000, 4000, or 5000.
1247
+ #
1248
+ #
1249
+ #
1250
+ # [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html#USER_PIOPS
1247
1251
  # @option options [String] :option_group_name
1248
1252
  # Indicates that the DB instance should be associated with the specified
1249
1253
  # option group.
1250
1254
  #
1251
1255
  # Permanent options, such as the TDE option for Oracle Advanced Security
1252
- # TDE, cannot be removed from an option group, and that option group
1253
- # cannot be removed from a DB instance once it is associated with a DB
1256
+ # TDE, can't be removed from an option group, and that option group
1257
+ # can't be removed from a DB instance once it is associated with a DB
1254
1258
  # instance
1255
1259
  # @option options [String] :character_set_name
1256
1260
  # For supported engines, indicates that the DB instance should be
@@ -1281,7 +1285,12 @@ module Aws::RDS
1281
1285
  # as part of the request and the PubliclyAccessible value has not been
1282
1286
  # set, the DB instance is private.
1283
1287
  # @option options [Array<Types::Tag>] :tags
1284
- # A list of tags.
1288
+ # A list of tags. For more information, see [Tagging Amazon RDS
1289
+ # Resources][1].
1290
+ #
1291
+ #
1292
+ #
1293
+ # [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html
1285
1294
  # @option options [String] :db_cluster_identifier
1286
1295
  # The identifier of the DB cluster that the instance will belong to.
1287
1296
  #
@@ -1296,13 +1305,13 @@ module Aws::RDS
1296
1305
  # If you specify `io1`, you must also include a value for the `Iops`
1297
1306
  # parameter.
1298
1307
  #
1299
- # Default: `io1` if the `Iops` parameter is specified; otherwise
1308
+ # Default: `io1` if the `Iops` parameter is specified, otherwise
1300
1309
  # `standard`
1301
1310
  # @option options [String] :tde_credential_arn
1302
- # The ARN from the Key Store with which to associate the instance for
1311
+ # The ARN from the key store with which to associate the instance for
1303
1312
  # TDE encryption.
1304
1313
  # @option options [String] :tde_credential_password
1305
- # The password for the given ARN from the Key Store in order to access
1314
+ # The password for the given ARN from the key store in order to access
1306
1315
  # the device.
1307
1316
  # @option options [Boolean] :storage_encrypted
1308
1317
  # Specifies whether the DB instance is encrypted.
@@ -1314,7 +1323,7 @@ module Aws::RDS
1314
1323
  #
1315
1324
  # Default: false
1316
1325
  # @option options [String] :kms_key_id
1317
- # The KMS key identifier for an encrypted DB instance.
1326
+ # The AWS KMS key identifier for an encrypted DB instance.
1318
1327
  #
1319
1328
  # The KMS key identifier is the Amazon Resource Name (ARN) for the KMS
1320
1329
  # encryption key. If you are creating a DB instance with the same AWS
@@ -1336,7 +1345,7 @@ module Aws::RDS
1336
1345
  # Specify the Active Directory Domain to create the instance in.
1337
1346
  # @option options [Boolean] :copy_tags_to_snapshot
1338
1347
  # True to copy all tags from the DB instance to snapshots of the DB
1339
- # instance; otherwise false. The default is false.
1348
+ # instance, and otherwise false. The default is false.
1340
1349
  # @option options [Integer] :monitoring_interval
1341
1350
  # The interval, in seconds, between points when Enhanced Monitoring
1342
1351
  # metrics are collected for the DB instance. To disable collecting
@@ -1348,7 +1357,7 @@ module Aws::RDS
1348
1357
  # Valid Values: `0, 1, 5, 10, 15, 30, 60`
1349
1358
  # @option options [String] :monitoring_role_arn
1350
1359
  # The ARN for the IAM role that permits RDS to send enhanced monitoring
1351
- # metrics to CloudWatch Logs. For example,
1360
+ # metrics to Amazon CloudWatch Logs. For example,
1352
1361
  # `arn:aws:iam:123456789012:role/emaccess`. For information on creating
1353
1362
  # a monitoring role, go to [Setting Up and Enabling Enhanced
1354
1363
  # Monitoring][1].
@@ -1384,7 +1393,7 @@ module Aws::RDS
1384
1393
  # [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_SQLServer.html#SQLServer.Concepts.General.TimeZone
1385
1394
  # @option options [Boolean] :enable_iam_database_authentication
1386
1395
  # True to enable mapping of AWS Identity and Access Management (IAM)
1387
- # accounts to database accounts; otherwise false.
1396
+ # accounts to database accounts, and otherwise false.
1388
1397
  #
1389
1398
  # You can enable IAM database authentication for the following database
1390
1399
  # engines:
@@ -1402,12 +1411,12 @@ module Aws::RDS
1402
1411
  #
1403
1412
  # Default: `false`
1404
1413
  # @option options [Boolean] :enable_performance_insights
1405
- # True to enable Performance Insights for the DB instance; otherwise
1414
+ # True to enable Performance Insights for the DB instance, and otherwise
1406
1415
  # false.
1407
1416
  # @option options [String] :performance_insights_kms_key_id
1408
- # The KMS key identifier for encryption of Performance Insights data.
1409
- # The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier,
1410
- # or the KMS key alias for the KMS encryption key.
1417
+ # The AWS KMS key identifier for encryption of Performance Insights
1418
+ # data. The KMS key ID is the Amazon Resource Name (ARN), KMS key
1419
+ # identifier, or the KMS key alias for the KMS encryption key.
1411
1420
  # @return [DBInstance]
1412
1421
  def create(options = {})
1413
1422
  options = options.merge(db_instance_identifier: @id)
@@ -1455,8 +1464,8 @@ module Aws::RDS
1455
1464
  # a lowercase string.
1456
1465
  # @option options [String] :db_instance_class
1457
1466
  # The compute and memory capacity of the Read Replica, for example,
1458
- # `db.m4.large`. Not all DB instance classes are available in all
1459
- # regions, or for all database engines. For the full list of DB instance
1467
+ # `db.m4.large`. Not all DB instance classes are available in all AWS
1468
+ # Regions, or for all database engines. For the full list of DB instance
1460
1469
  # classes, and availability for your engine, see [DB Instance Class][1]
1461
1470
  # in the Amazon RDS User Guide.
1462
1471
  #
@@ -1510,7 +1519,12 @@ module Aws::RDS
1510
1519
  # as part of the request and the PubliclyAccessible value has not been
1511
1520
  # set, the DB instance is private.
1512
1521
  # @option options [Array<Types::Tag>] :tags
1513
- # A list of tags.
1522
+ # A list of tags. For more information, see [Tagging Amazon RDS
1523
+ # Resources][1].
1524
+ #
1525
+ #
1526
+ #
1527
+ # [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html
1514
1528
  # @option options [String] :db_subnet_group_name
1515
1529
  # Specifies a DB subnet group for the DB instance. The new DB instance
1516
1530
  # is created in the VPC associated with the DB subnet group. If no DB
@@ -1545,11 +1559,11 @@ module Aws::RDS
1545
1559
  # If you specify `io1`, you must also include a value for the `Iops`
1546
1560
  # parameter.
1547
1561
  #
1548
- # Default: `io1` if the `Iops` parameter is specified; otherwise
1562
+ # Default: `io1` if the `Iops` parameter is specified, otherwise
1549
1563
  # `standard`
1550
1564
  # @option options [Boolean] :copy_tags_to_snapshot
1551
1565
  # True to copy all tags from the Read Replica to snapshots of the Read
1552
- # Replica; otherwise false. The default is false.
1566
+ # Replica, and otherwise false. The default is false.
1553
1567
  # @option options [Integer] :monitoring_interval
1554
1568
  # The interval, in seconds, between points when Enhanced Monitoring
1555
1569
  # metrics are collected for the Read Replica. To disable collecting
@@ -1561,7 +1575,7 @@ module Aws::RDS
1561
1575
  # Valid Values: `0, 1, 5, 10, 15, 30, 60`
1562
1576
  # @option options [String] :monitoring_role_arn
1563
1577
  # The ARN for the IAM role that permits RDS to send enhanced monitoring
1564
- # metrics to CloudWatch Logs. For example,
1578
+ # metrics to Amazon CloudWatch Logs. For example,
1565
1579
  # `arn:aws:iam:123456789012:role/emaccess`. For information on creating
1566
1580
  # a monitoring role, go to [To create an IAM role for Amazon RDS
1567
1581
  # Enhanced Monitoring][1].
@@ -1588,7 +1602,7 @@ module Aws::RDS
1588
1602
  # If you create an encrypted Read Replica in a different AWS Region,
1589
1603
  # then you must specify a KMS key for the destination AWS Region. KMS
1590
1604
  # encryption keys are specific to the AWS Region that they are created
1591
- # in, and you cannot use encryption keys from one AWS Region in another
1605
+ # in, and you can't use encryption keys from one AWS Region in another
1592
1606
  # AWS Region.
1593
1607
  # @option options [String] :pre_signed_url
1594
1608
  # The URL that contains a Signature Version 4 signed request for the
@@ -1597,9 +1611,9 @@ module Aws::RDS
1597
1611
  #
1598
1612
  # You must specify this parameter when you create an encrypted Read
1599
1613
  # Replica from another AWS Region by using the Amazon RDS API. You can
1600
- # specify the source region option instead of this parameter when you
1601
- # create an encrypted Read Replica from another AWS Region by using the
1602
- # AWS CLI.
1614
+ # specify the `--source-region` option instead of this parameter when
1615
+ # you create an encrypted Read Replica from another AWS Region by using
1616
+ # the AWS CLI.
1603
1617
  #
1604
1618
  # The presigned URL must be a valid request for the
1605
1619
  # `CreateDBInstanceReadReplica` API action that can be executed in the
@@ -1612,24 +1626,24 @@ module Aws::RDS
1612
1626
  # presigned URL.
1613
1627
  #
1614
1628
  # For example, if you create an encrypted DB instance in the us-west-1
1615
- # region, from a source DB instance in the us-east-2 region, then you
1616
- # call the `CreateDBInstanceReadReplica` action in the us-east-1
1617
- # region and provide a presigned URL that contains a call to the
1618
- # `CreateDBInstanceReadReplica` action in the us-west-2 region. For
1619
- # this example, the `DestinationRegion` in the presigned URL must be
1620
- # set to the us-east-1 region.
1621
- #
1622
- # * `KmsKeyId` - The KMS key identifier for the key to use to encrypt
1623
- # the Read Replica in the destination AWS Region. This is the same
1624
- # identifier for both the `CreateDBInstanceReadReplica` action that is
1625
- # called in the destination AWS Region, and the action contained in
1626
- # the presigned URL.
1629
+ # AWS Region, from a source DB instance in the us-east-2 AWS Region,
1630
+ # then you call the `CreateDBInstanceReadReplica` action in the
1631
+ # us-east-1 AWS Region and provide a presigned URL that contains a
1632
+ # call to the `CreateDBInstanceReadReplica` action in the us-west-2
1633
+ # AWS Region. For this example, the `DestinationRegion` in the
1634
+ # presigned URL must be set to the us-east-1 AWS Region.
1635
+ #
1636
+ # * `KmsKeyId` - The AWS KMS key identifier for the key to use to
1637
+ # encrypt the Read Replica in the destination AWS Region. This is the
1638
+ # same identifier for both the `CreateDBInstanceReadReplica` action
1639
+ # that is called in the destination AWS Region, and the action
1640
+ # contained in the presigned URL.
1627
1641
  #
1628
1642
  # * `SourceDBInstanceIdentifier` - The DB instance identifier for the
1629
1643
  # encrypted DB instance to be replicated. This identifier must be in
1630
1644
  # the Amazon Resource Name (ARN) format for the source AWS Region. For
1631
1645
  # example, if you are creating an encrypted Read Replica from a DB
1632
- # instance in the us-west-2 region, then your
1646
+ # instance in the us-west-2 AWS Region, then your
1633
1647
  # `SourceDBInstanceIdentifier` looks like the following example:
1634
1648
  # `arn:aws:rds:us-west-2:123456789012:instance:mysql-instance1-20161115`.
1635
1649
  #
@@ -1643,7 +1657,7 @@ module Aws::RDS
1643
1657
  # [2]: http://docs.aws.amazon.com/general/latest/gr/signature-version-4.html
1644
1658
  # @option options [Boolean] :enable_iam_database_authentication
1645
1659
  # True to enable mapping of AWS Identity and Access Management (IAM)
1646
- # accounts to database accounts; otherwise false.
1660
+ # accounts to database accounts, and otherwise false.
1647
1661
  #
1648
1662
  # You can enable IAM database authentication for the following database
1649
1663
  # engines
@@ -1656,12 +1670,12 @@ module Aws::RDS
1656
1670
  #
1657
1671
  # Default: `false`
1658
1672
  # @option options [Boolean] :enable_performance_insights
1659
- # True to enable Performance Insights for the read replica; otherwise
1660
- # false.
1673
+ # True to enable Performance Insights for the read replica, and
1674
+ # otherwise false.
1661
1675
  # @option options [String] :performance_insights_kms_key_id
1662
- # The KMS key identifier for encryption of Performance Insights data.
1663
- # The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier,
1664
- # or the KMS key alias for the KMS encryption key.
1676
+ # The AWS KMS key identifier for encryption of Performance Insights
1677
+ # data. The KMS key ID is the Amazon Resource Name (ARN), KMS key
1678
+ # identifier, or the KMS key alias for the KMS encryption key.
1665
1679
  # @option options [String] :destination_region
1666
1680
  # @option options [String] :source_region
1667
1681
  # The source region of the snapshot. This is only needed when the
@@ -1704,7 +1718,12 @@ module Aws::RDS
1704
1718
  #
1705
1719
  # Example: `my-snapshot-id`
1706
1720
  # @option options [Array<Types::Tag>] :tags
1707
- # A list of tags.
1721
+ # A list of tags. For more information, see [Tagging Amazon RDS
1722
+ # Resources][1].
1723
+ #
1724
+ #
1725
+ #
1726
+ # [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html
1708
1727
  # @return [DBSnapshot]
1709
1728
  def create_snapshot(options = {})
1710
1729
  options = options.merge(db_instance_identifier: @id)
@@ -1887,8 +1906,8 @@ module Aws::RDS
1887
1906
  # for the instance, and creating a DB snapshot of the instance.
1888
1907
  # @option options [String] :db_instance_class
1889
1908
  # The new compute and memory capacity of the DB instance, for example,
1890
- # `db.m4.large`. Not all DB instance classes are available in all
1891
- # regions, or for all database engines. For the full list of DB instance
1909
+ # `db.m4.large`. Not all DB instance classes are available in all AWS
1910
+ # Regions, or for all database engines. For the full list of DB instance
1892
1911
  # classes, and availability for your engine, see [DB Instance Class][1]
1893
1912
  # in the Amazon RDS User Guide.
1894
1913
  #
@@ -1965,8 +1984,8 @@ module Aws::RDS
1965
1984
  #
1966
1985
  # [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Overview.DBInstance.Modifying.html
1967
1986
  # @option options [String] :master_user_password
1968
- # The new password for the master user. Can be any printable ASCII
1969
- # character except "/", """, or "@".
1987
+ # The new password for the master user. The password can include any
1988
+ # printable ASCII character except "/", """, or "@".
1970
1989
  #
1971
1990
  # Changing this parameter does not result in an outage and the change is
1972
1991
  # asynchronously applied as soon as possible. Between the time of the
@@ -2066,7 +2085,7 @@ module Aws::RDS
2066
2085
  #
2067
2086
  # * Must be in the format hh24:mi-hh24:mi
2068
2087
  #
2069
- # * Times should be in Universal Time Coordinated (UTC)
2088
+ # * Must be in Universal Time Coordinated (UTC)
2070
2089
  #
2071
2090
  # * Must not conflict with the preferred maintenance window
2072
2091
  #
@@ -2176,8 +2195,8 @@ module Aws::RDS
2176
2195
  # connections are not interrupted.
2177
2196
  #
2178
2197
  # Permanent options, such as the TDE option for Oracle Advanced Security
2179
- # TDE, cannot be removed from an option group, and that option group
2180
- # cannot be removed from a DB instance once it is associated with a DB
2198
+ # TDE, can't be removed from an option group, and that option group
2199
+ # can't be removed from a DB instance once it is associated with a DB
2181
2200
  # instance
2182
2201
  # @option options [String] :new_db_instance_identifier
2183
2202
  # The new DB instance identifier for the DB instance when renaming a DB
@@ -2203,13 +2222,13 @@ module Aws::RDS
2203
2222
  # If you specify `io1`, you must also include a value for the `Iops`
2204
2223
  # parameter.
2205
2224
  #
2206
- # Default: `io1` if the `Iops` parameter is specified; otherwise
2225
+ # Default: `io1` if the `Iops` parameter is specified, otherwise
2207
2226
  # `standard`
2208
2227
  # @option options [String] :tde_credential_arn
2209
- # The ARN from the Key Store with which to associate the instance for
2228
+ # The ARN from the key store with which to associate the instance for
2210
2229
  # TDE encryption.
2211
2230
  # @option options [String] :tde_credential_password
2212
- # The password for the given ARN from the Key Store in order to access
2231
+ # The password for the given ARN from the key store in order to access
2213
2232
  # the device.
2214
2233
  # @option options [String] :ca_certificate_identifier
2215
2234
  # Indicates the certificate that needs to be associated with the
@@ -2221,7 +2240,7 @@ module Aws::RDS
2221
2240
  # instance can be created in a Active Directory Domain.
2222
2241
  # @option options [Boolean] :copy_tags_to_snapshot
2223
2242
  # True to copy all tags from the DB instance to snapshots of the DB
2224
- # instance; otherwise false. The default is false.
2243
+ # instance, and otherwise false. The default is false.
2225
2244
  # @option options [Integer] :monitoring_interval
2226
2245
  # The interval, in seconds, between points when Enhanced Monitoring
2227
2246
  # metrics are collected for the DB instance. To disable collecting
@@ -2296,7 +2315,7 @@ module Aws::RDS
2296
2315
  # Default: false
2297
2316
  # @option options [String] :monitoring_role_arn
2298
2317
  # The ARN for the IAM role that permits RDS to send enhanced monitoring
2299
- # metrics to CloudWatch Logs. For example,
2318
+ # metrics to Amazon CloudWatch Logs. For example,
2300
2319
  # `arn:aws:iam:123456789012:role/emaccess`. For information on creating
2301
2320
  # a monitoring role, go to [To create an IAM role for Amazon RDS
2302
2321
  # Enhanced Monitoring][1].
@@ -2325,7 +2344,7 @@ module Aws::RDS
2325
2344
  # [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Aurora.Managing.html#Aurora.Managing.FaultTolerance
2326
2345
  # @option options [Boolean] :enable_iam_database_authentication
2327
2346
  # True to enable mapping of AWS Identity and Access Management (IAM)
2328
- # accounts to database accounts; otherwise false.
2347
+ # accounts to database accounts, and otherwise false.
2329
2348
  #
2330
2349
  # You can enable IAM database authentication for the following database
2331
2350
  # engines
@@ -2343,12 +2362,12 @@ module Aws::RDS
2343
2362
  #
2344
2363
  # Default: `false`
2345
2364
  # @option options [Boolean] :enable_performance_insights
2346
- # True to enable Performance Insights for the DB instance; otherwise
2365
+ # True to enable Performance Insights for the DB instance, and otherwise
2347
2366
  # false.
2348
2367
  # @option options [String] :performance_insights_kms_key_id
2349
- # The KMS key identifier for encryption of Performance Insights data.
2350
- # The KMS key ID is the Amazon Resource Name (ARN), KMS key identifier,
2351
- # or the KMS key alias for the KMS encryption key.
2368
+ # The AWS KMS key identifier for encryption of Performance Insights
2369
+ # data. The KMS key ID is the Amazon Resource Name (ARN), KMS key
2370
+ # identifier, or the KMS key alias for the KMS encryption key.
2352
2371
  # @return [DBInstance]
2353
2372
  def modify(options = {})
2354
2373
  options = options.merge(db_instance_identifier: @id)
@@ -2384,15 +2403,16 @@ module Aws::RDS
2384
2403
  # automated backups are enabled, using the `BackupRetentionPeriod`
2385
2404
  # parameter.
2386
2405
  #
2387
- # Default: A 30-minute window selected at random from an 8-hour block of
2388
- # time per AWS Region. To see the time blocks available, see [ Adjusting
2389
- # the Preferred Maintenance Window][1] in the *Amazon RDS User Guide.*
2406
+ # The default is a 30-minute window selected at random from an 8-hour
2407
+ # block of time for each AWS Region. To see the time blocks available,
2408
+ # see [ Adjusting the Preferred Maintenance Window][1] in the *Amazon
2409
+ # RDS User Guide.*
2390
2410
  #
2391
2411
  # Constraints:
2392
2412
  #
2393
2413
  # * Must be in the format `hh24:mi-hh24:mi`.
2394
2414
  #
2395
- # * Times should be in Universal Coordinated Time (UTC).
2415
+ # * Must be in Universal Coordinated Time (UTC).
2396
2416
  #
2397
2417
  # * Must not conflict with the preferred maintenance window.
2398
2418
  #
@@ -2421,7 +2441,7 @@ module Aws::RDS
2421
2441
  # @option options [Boolean] :force_failover
2422
2442
  # When `true`, the reboot is conducted through a MultiAZ failover.
2423
2443
  #
2424
- # Constraint: You cannot specify `true` if the instance is not
2444
+ # Constraint: You can't specify `true` if the instance is not
2425
2445
  # configured for MultiAZ.
2426
2446
  # @return [DBInstance]
2427
2447
  def reboot(options = {})
@@ -2468,7 +2488,7 @@ module Aws::RDS
2468
2488
  # })
2469
2489
  # @param [Hash] options ({})
2470
2490
  # @option options [required, String] :target_db_instance_identifier
2471
- # The name of the new database instance to be created.
2491
+ # The name of the new DB instance to be created.
2472
2492
  #
2473
2493
  # Constraints:
2474
2494
  #
@@ -2500,7 +2520,7 @@ module Aws::RDS
2500
2520
  # @option options [String] :db_instance_class
2501
2521
  # The compute and memory capacity of the Amazon RDS DB instance, for
2502
2522
  # example, `db.m4.large`. Not all DB instance classes are available in
2503
- # all regions, or for all database engines. For the full list of DB
2523
+ # all AWS Regions, or for all database engines. For the full list of DB
2504
2524
  # instance classes, and availability for your engine, see [DB Instance
2505
2525
  # Class][1] in the Amazon RDS User Guide.
2506
2526
  #
@@ -2516,11 +2536,11 @@ module Aws::RDS
2516
2536
  #
2517
2537
  # Default: The same port as the original DB instance.
2518
2538
  # @option options [String] :availability_zone
2519
- # The EC2 Availability Zone that the database instance is created in.
2539
+ # The EC2 Availability Zone that the DB instance is created in.
2520
2540
  #
2521
2541
  # Default: A random, system-chosen Availability Zone.
2522
2542
  #
2523
- # Constraint: You cannot specify the AvailabilityZone parameter if the
2543
+ # Constraint: You can't specify the AvailabilityZone parameter if the
2524
2544
  # MultiAZ parameter is set to true.
2525
2545
  #
2526
2546
  # Example: `us-east-1a`
@@ -2534,7 +2554,7 @@ module Aws::RDS
2534
2554
  # @option options [Boolean] :multi_az
2535
2555
  # Specifies if the DB instance is a Multi-AZ deployment.
2536
2556
  #
2537
- # Constraint: You cannot specify the AvailabilityZone parameter if the
2557
+ # Constraint: You can't specify the AvailabilityZone parameter if the
2538
2558
  # MultiAZ parameter is set to `true`.
2539
2559
  # @option options [Boolean] :publicly_accessible
2540
2560
  # Specifies the accessibility options for the DB instance. A value of
@@ -2583,6 +2603,8 @@ module Aws::RDS
2583
2603
  #
2584
2604
  # * `aurora`
2585
2605
  #
2606
+ # * `aurora-postgresql`
2607
+ #
2586
2608
  # * `mariadb`
2587
2609
  #
2588
2610
  # * `mysql`
@@ -2618,14 +2640,19 @@ module Aws::RDS
2618
2640
  # The name of the option group to be used for the restored DB instance.
2619
2641
  #
2620
2642
  # Permanent options, such as the TDE option for Oracle Advanced Security
2621
- # TDE, cannot be removed from an option group, and that option group
2622
- # cannot be removed from a DB instance once it is associated with a DB
2643
+ # TDE, can't be removed from an option group, and that option group
2644
+ # can't be removed from a DB instance once it is associated with a DB
2623
2645
  # instance
2624
2646
  # @option options [Boolean] :copy_tags_to_snapshot
2625
2647
  # True to copy all tags from the restored DB instance to snapshots of
2626
- # the DB instance; otherwise false. The default is false.
2648
+ # the DB instance, and otherwise false. The default is false.
2627
2649
  # @option options [Array<Types::Tag>] :tags
2628
- # A list of tags.
2650
+ # A list of tags. For more information, see [Tagging Amazon RDS
2651
+ # Resources][1].
2652
+ #
2653
+ #
2654
+ #
2655
+ # [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html
2629
2656
  # @option options [String] :storage_type
2630
2657
  # Specifies the storage type to be associated with the DB instance.
2631
2658
  #
@@ -2634,13 +2661,13 @@ module Aws::RDS
2634
2661
  # If you specify `io1`, you must also include a value for the `Iops`
2635
2662
  # parameter.
2636
2663
  #
2637
- # Default: `io1` if the `Iops` parameter is specified; otherwise
2664
+ # Default: `io1` if the `Iops` parameter is specified, otherwise
2638
2665
  # `standard`
2639
2666
  # @option options [String] :tde_credential_arn
2640
- # The ARN from the Key Store with which to associate the instance for
2667
+ # The ARN from the key store with which to associate the instance for
2641
2668
  # TDE encryption.
2642
2669
  # @option options [String] :tde_credential_password
2643
- # The password for the given ARN from the Key Store in order to access
2670
+ # The password for the given ARN from the key store in order to access
2644
2671
  # the device.
2645
2672
  # @option options [String] :domain
2646
2673
  # Specify the Active Directory Domain to restore the instance in.
@@ -2649,7 +2676,7 @@ module Aws::RDS
2649
2676
  # the Directory Service.
2650
2677
  # @option options [Boolean] :enable_iam_database_authentication
2651
2678
  # True to enable mapping of AWS Identity and Access Management (IAM)
2652
- # accounts to database accounts; otherwise false.
2679
+ # accounts to database accounts, and otherwise false.
2653
2680
  #
2654
2681
  # You can enable IAM database authentication for the following database
2655
2682
  # engines
@@ -2982,7 +3009,7 @@ module Aws::RDS
2982
3009
  # })
2983
3010
  # @param [Hash] options ({})
2984
3011
  # @option options [String] :db_snapshot_identifier
2985
- # A specific DB snapshot identifier to describe. This parameter cannot
3012
+ # A specific DB snapshot identifier to describe. This parameter can't
2986
3013
  # be used in conjunction with `DBInstanceIdentifier`. This value is
2987
3014
  # stored as a lowercase string.
2988
3015
  #
@@ -3022,18 +3049,17 @@ module Aws::RDS
3022
3049
  # @option options [Array<Types::Filter>] :filters
3023
3050
  # This parameter is not currently supported.
3024
3051
  # @option options [Boolean] :include_shared
3025
- # Set this value to `true` to include shared manual DB snapshots from
3026
- # other AWS accounts that this AWS account has been given permission to
3027
- # copy or restore, otherwise set this value to `false`. The default is
3028
- # `false`.
3052
+ # True to include shared manual DB snapshots from other AWS accounts
3053
+ # that this AWS account has been given permission to copy or restore,
3054
+ # and otherwise false. The default is `false`.
3029
3055
  #
3030
3056
  # You can give an AWS account permission to restore a manual DB snapshot
3031
3057
  # from another AWS account by using the ModifyDBSnapshotAttribute API
3032
3058
  # action.
3033
3059
  # @option options [Boolean] :include_public
3034
- # Set this value to `true` to include manual DB snapshots that are
3035
- # public and can be copied or restored by any AWS account, otherwise set
3036
- # this value to `false`. The default is `false`.
3060
+ # True to include manual DB snapshots that are public and can be copied
3061
+ # or restored by any AWS account, and otherwise false. The default is
3062
+ # false.
3037
3063
  #
3038
3064
  # You can share a manual DB snapshot as public by using the
3039
3065
  # ModifyDBSnapshotAttribute API.