aws-sdk-rds 1.94.0 → 1.99.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/lib/aws-sdk-rds.rb +3 -2
- data/lib/aws-sdk-rds/client.rb +280 -155
- data/lib/aws-sdk-rds/client_api.rb +4 -0
- data/lib/aws-sdk-rds/db_cluster.rb +16 -2
- data/lib/aws-sdk-rds/db_cluster_parameter_group.rb +2 -2
- data/lib/aws-sdk-rds/db_cluster_snapshot.rb +10 -1
- data/lib/aws-sdk-rds/db_instance.rb +105 -56
- data/lib/aws-sdk-rds/db_parameter_group.rb +2 -2
- data/lib/aws-sdk-rds/db_snapshot.rb +4 -13
- data/lib/aws-sdk-rds/event_subscription.rb +35 -22
- data/lib/aws-sdk-rds/resource.rb +74 -35
- data/lib/aws-sdk-rds/types.rb +267 -141
- metadata +2 -2
@@ -472,6 +472,7 @@ module Aws::RDS
|
|
472
472
|
RemoveSourceIdentifierFromSubscriptionMessage = Shapes::StructureShape.new(name: 'RemoveSourceIdentifierFromSubscriptionMessage')
|
473
473
|
RemoveSourceIdentifierFromSubscriptionResult = Shapes::StructureShape.new(name: 'RemoveSourceIdentifierFromSubscriptionResult')
|
474
474
|
RemoveTagsFromResourceMessage = Shapes::StructureShape.new(name: 'RemoveTagsFromResourceMessage')
|
475
|
+
ReplicaMode = Shapes::StringShape.new(name: 'ReplicaMode')
|
475
476
|
ReservedDBInstance = Shapes::StructureShape.new(name: 'ReservedDBInstance')
|
476
477
|
ReservedDBInstanceAlreadyExistsFault = Shapes::StructureShape.new(name: 'ReservedDBInstanceAlreadyExistsFault')
|
477
478
|
ReservedDBInstanceList = Shapes::ListShape.new(name: 'ReservedDBInstanceList')
|
@@ -895,6 +896,7 @@ module Aws::RDS
|
|
895
896
|
CreateDBInstanceReadReplicaMessage.add_member(:deletion_protection, Shapes::ShapeRef.new(shape: BooleanOptional, location_name: "DeletionProtection"))
|
896
897
|
CreateDBInstanceReadReplicaMessage.add_member(:domain, Shapes::ShapeRef.new(shape: String, location_name: "Domain"))
|
897
898
|
CreateDBInstanceReadReplicaMessage.add_member(:domain_iam_role_name, Shapes::ShapeRef.new(shape: String, location_name: "DomainIAMRoleName"))
|
899
|
+
CreateDBInstanceReadReplicaMessage.add_member(:replica_mode, Shapes::ShapeRef.new(shape: ReplicaMode, location_name: "ReplicaMode"))
|
898
900
|
CreateDBInstanceReadReplicaMessage.add_member(:destination_region, Shapes::ShapeRef.new(shape: String, location_name: "DestinationRegion", metadata: {"documented"=>false}))
|
899
901
|
CreateDBInstanceReadReplicaMessage.add_member(:source_region, Shapes::ShapeRef.new(shape: String, location_name: "SourceRegion"))
|
900
902
|
CreateDBInstanceReadReplicaMessage.struct_class = Types::CreateDBInstanceReadReplicaMessage
|
@@ -1261,6 +1263,7 @@ module Aws::RDS
|
|
1261
1263
|
DBInstance.add_member(:read_replica_source_db_instance_identifier, Shapes::ShapeRef.new(shape: String, location_name: "ReadReplicaSourceDBInstanceIdentifier"))
|
1262
1264
|
DBInstance.add_member(:read_replica_db_instance_identifiers, Shapes::ShapeRef.new(shape: ReadReplicaDBInstanceIdentifierList, location_name: "ReadReplicaDBInstanceIdentifiers"))
|
1263
1265
|
DBInstance.add_member(:read_replica_db_cluster_identifiers, Shapes::ShapeRef.new(shape: ReadReplicaDBClusterIdentifierList, location_name: "ReadReplicaDBClusterIdentifiers"))
|
1266
|
+
DBInstance.add_member(:replica_mode, Shapes::ShapeRef.new(shape: ReplicaMode, location_name: "ReplicaMode"))
|
1264
1267
|
DBInstance.add_member(:license_model, Shapes::ShapeRef.new(shape: String, location_name: "LicenseModel"))
|
1265
1268
|
DBInstance.add_member(:iops, Shapes::ShapeRef.new(shape: IntegerOptional, location_name: "Iops"))
|
1266
1269
|
DBInstance.add_member(:option_group_memberships, Shapes::ShapeRef.new(shape: OptionGroupMembershipList, location_name: "OptionGroupMemberships"))
|
@@ -2331,6 +2334,7 @@ module Aws::RDS
|
|
2331
2334
|
ModifyDBInstanceMessage.add_member(:deletion_protection, Shapes::ShapeRef.new(shape: BooleanOptional, location_name: "DeletionProtection"))
|
2332
2335
|
ModifyDBInstanceMessage.add_member(:max_allocated_storage, Shapes::ShapeRef.new(shape: IntegerOptional, location_name: "MaxAllocatedStorage"))
|
2333
2336
|
ModifyDBInstanceMessage.add_member(:certificate_rotation_restart, Shapes::ShapeRef.new(shape: BooleanOptional, location_name: "CertificateRotationRestart"))
|
2337
|
+
ModifyDBInstanceMessage.add_member(:replica_mode, Shapes::ShapeRef.new(shape: ReplicaMode, location_name: "ReplicaMode"))
|
2334
2338
|
ModifyDBInstanceMessage.struct_class = Types::ModifyDBInstanceMessage
|
2335
2339
|
|
2336
2340
|
ModifyDBInstanceResult.add_member(:db_instance, Shapes::ShapeRef.new(shape: DBInstance, location_name: "DBInstance"))
|
@@ -143,8 +143,7 @@ module Aws::RDS
|
|
143
143
|
data[:multi_az]
|
144
144
|
end
|
145
145
|
|
146
|
-
#
|
147
|
-
# cluster.
|
146
|
+
# The name of the database engine to be used for this DB cluster.
|
148
147
|
# @return [String]
|
149
148
|
def engine
|
150
149
|
data[:engine]
|
@@ -905,6 +904,14 @@ module Aws::RDS
|
|
905
904
|
# used. For more information, see [Publishing Database Logs to Amazon
|
906
905
|
# CloudWatch Logs][1] in the *Amazon Aurora User Guide*.
|
907
906
|
#
|
907
|
+
# **Aurora MySQL**
|
908
|
+
#
|
909
|
+
# Possible values are `audit`, `error`, `general`, and `slowquery`.
|
910
|
+
#
|
911
|
+
# **Aurora PostgreSQL**
|
912
|
+
#
|
913
|
+
# Possible values are `postgresql` and `upgrade`.
|
914
|
+
#
|
908
915
|
#
|
909
916
|
#
|
910
917
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch
|
@@ -1339,6 +1346,13 @@ module Aws::RDS
|
|
1339
1346
|
# The Active Directory directory ID to move the DB cluster to. Specify
|
1340
1347
|
# `none` to remove the cluster from its current domain. The domain must
|
1341
1348
|
# be created prior to this operation.
|
1349
|
+
#
|
1350
|
+
# For more information, see [Kerberos Authentication][1] in the *Amazon
|
1351
|
+
# Aurora User Guide*.
|
1352
|
+
#
|
1353
|
+
#
|
1354
|
+
#
|
1355
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/kerberos-authentication.html
|
1342
1356
|
# @option options [String] :domain_iam_role_name
|
1343
1357
|
# Specify the name of the IAM role to be used when making API calls to
|
1344
1358
|
# the Directory Service.
|
@@ -35,8 +35,8 @@ module Aws::RDS
|
|
35
35
|
end
|
36
36
|
alias :db_cluster_parameter_group_name :name
|
37
37
|
|
38
|
-
#
|
39
|
-
#
|
38
|
+
# The name of the DB parameter group family that this DB cluster
|
39
|
+
# parameter group is compatible with.
|
40
40
|
# @return [String]
|
41
41
|
def db_parameter_group_family
|
42
42
|
data[:db_parameter_group_family]
|
@@ -667,7 +667,16 @@ module Aws::RDS
|
|
667
667
|
# copy them.
|
668
668
|
# @option options [String] :domain
|
669
669
|
# Specify the Active Directory directory ID to restore the DB cluster
|
670
|
-
# in. The domain must be created prior to this operation.
|
670
|
+
# in. The domain must be created prior to this operation. Currently,
|
671
|
+
# only MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances
|
672
|
+
# can be created in an Active Directory Domain.
|
673
|
+
#
|
674
|
+
# For more information, see [ Kerberos Authentication][1] in the *Amazon
|
675
|
+
# RDS User Guide*.
|
676
|
+
#
|
677
|
+
#
|
678
|
+
#
|
679
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/kerberos-authentication.html
|
671
680
|
# @option options [String] :domain_iam_role_name
|
672
681
|
# Specify the name of the IAM role to be used when making API calls to
|
673
682
|
# the Directory Service.
|
@@ -42,8 +42,7 @@ module Aws::RDS
|
|
42
42
|
data[:db_instance_class]
|
43
43
|
end
|
44
44
|
|
45
|
-
#
|
46
|
-
# instance.
|
45
|
+
# The name of the database engine to be used for this DB instance.
|
47
46
|
# @return [String]
|
48
47
|
def engine
|
49
48
|
data[:engine]
|
@@ -225,6 +224,22 @@ module Aws::RDS
|
|
225
224
|
data[:read_replica_db_cluster_identifiers]
|
226
225
|
end
|
227
226
|
|
227
|
+
# The open mode of an Oracle read replica. The default is
|
228
|
+
# `open-read-only`. For more information, see [Working with Oracle Read
|
229
|
+
# Replicas for Amazon RDS][1] in the *Amazon RDS User Guide*.
|
230
|
+
#
|
231
|
+
# <note markdown="1"> This attribute is only supported in RDS for Oracle.
|
232
|
+
#
|
233
|
+
# </note>
|
234
|
+
#
|
235
|
+
#
|
236
|
+
#
|
237
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-read-replicas.html
|
238
|
+
# @return [String]
|
239
|
+
def replica_mode
|
240
|
+
data[:replica_mode]
|
241
|
+
end
|
242
|
+
|
228
243
|
# License model information for this DB instance.
|
229
244
|
# @return [String]
|
230
245
|
def license_model
|
@@ -707,6 +722,9 @@ module Aws::RDS
|
|
707
722
|
#
|
708
723
|
# * Must contain 1 to 64 letters or numbers.
|
709
724
|
#
|
725
|
+
# * Must begin with a letter. Subsequent characters can be letters,
|
726
|
+
# underscores, or digits (0-9).
|
727
|
+
#
|
710
728
|
# * Can't be a word reserved by the specified database engine
|
711
729
|
#
|
712
730
|
# **MariaDB**
|
@@ -719,6 +737,9 @@ module Aws::RDS
|
|
719
737
|
#
|
720
738
|
# * Must contain 1 to 64 letters or numbers.
|
721
739
|
#
|
740
|
+
# * Must begin with a letter. Subsequent characters can be letters,
|
741
|
+
# underscores, or digits (0-9).
|
742
|
+
#
|
722
743
|
# * Can't be a word reserved by the specified database engine
|
723
744
|
#
|
724
745
|
# **PostgreSQL**
|
@@ -731,8 +752,8 @@ module Aws::RDS
|
|
731
752
|
#
|
732
753
|
# * Must contain 1 to 63 letters, numbers, or underscores.
|
733
754
|
#
|
734
|
-
# * Must begin with a letter
|
735
|
-
#
|
755
|
+
# * Must begin with a letter. Subsequent characters can be letters,
|
756
|
+
# underscores, or digits (0-9).
|
736
757
|
#
|
737
758
|
# * Can't be a word reserved by the specified database engine
|
738
759
|
#
|
@@ -1330,24 +1351,15 @@ module Aws::RDS
|
|
1330
1351
|
# for each AWS Region.
|
1331
1352
|
# @option options [String] :domain
|
1332
1353
|
# The Active Directory directory ID to create the DB instance in.
|
1333
|
-
# Currently, only Microsoft SQL Server and
|
1334
|
-
# created in an Active Directory Domain.
|
1354
|
+
# Currently, only MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB
|
1355
|
+
# instances can be created in an Active Directory Domain.
|
1335
1356
|
#
|
1336
|
-
# For
|
1337
|
-
# Authentication to authenticate users that connect to the DB instance.
|
1338
|
-
# For more information, see [ Using Windows Authentication with an
|
1339
|
-
# Amazon RDS DB Instance Running Microsoft SQL Server][1] in the *Amazon
|
1357
|
+
# For more information, see [ Kerberos Authentication][1] in the *Amazon
|
1340
1358
|
# RDS User Guide*.
|
1341
1359
|
#
|
1342
|
-
# For Oracle DB instances, Amazon RDS can use Kerberos Authentication to
|
1343
|
-
# authenticate users that connect to the DB instance. For more
|
1344
|
-
# information, see [ Using Kerberos Authentication with Amazon RDS for
|
1345
|
-
# Oracle][2] in the *Amazon RDS User Guide*.
|
1346
|
-
#
|
1347
1360
|
#
|
1348
1361
|
#
|
1349
|
-
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/
|
1350
|
-
# [2]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-kerberos.html
|
1362
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/kerberos-authentication.html
|
1351
1363
|
# @option options [Boolean] :copy_tags_to_snapshot
|
1352
1364
|
# A value that indicates whether to copy tags from the DB instance to
|
1353
1365
|
# snapshots of the DB instance. By default, tags are not copied.
|
@@ -1466,6 +1478,26 @@ module Aws::RDS
|
|
1466
1478
|
# CloudWatch Logs ][1] in the *Amazon Relational Database Service User
|
1467
1479
|
# Guide*.
|
1468
1480
|
#
|
1481
|
+
# **MariaDB**
|
1482
|
+
#
|
1483
|
+
# Possible values are `audit`, `error`, `general`, and `slowquery`.
|
1484
|
+
#
|
1485
|
+
# **Microsoft SQL Server**
|
1486
|
+
#
|
1487
|
+
# Possible values are `agent` and `error`.
|
1488
|
+
#
|
1489
|
+
# **MySQL**
|
1490
|
+
#
|
1491
|
+
# Possible values are `audit`, `error`, `general`, and `slowquery`.
|
1492
|
+
#
|
1493
|
+
# **Oracle**
|
1494
|
+
#
|
1495
|
+
# Possible values are `alert`, `audit`, `listener`, and `trace`.
|
1496
|
+
#
|
1497
|
+
# **PostgreSQL**
|
1498
|
+
#
|
1499
|
+
# Possible values are `postgresql` and `upgrade`.
|
1500
|
+
#
|
1469
1501
|
#
|
1470
1502
|
#
|
1471
1503
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch
|
@@ -1544,6 +1576,7 @@ module Aws::RDS
|
|
1544
1576
|
# deletion_protection: false,
|
1545
1577
|
# domain: "String",
|
1546
1578
|
# domain_iam_role_name: "String",
|
1579
|
+
# replica_mode: "open-read-only", # accepts open-read-only, mounted
|
1547
1580
|
# source_region: "String",
|
1548
1581
|
# })
|
1549
1582
|
# @param [Hash] options ({})
|
@@ -1847,25 +1880,39 @@ module Aws::RDS
|
|
1847
1880
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_DeleteInstance.html
|
1848
1881
|
# @option options [String] :domain
|
1849
1882
|
# The Active Directory directory ID to create the DB instance in.
|
1883
|
+
# Currently, only MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB
|
1884
|
+
# instances can be created in an Active Directory Domain.
|
1850
1885
|
#
|
1851
|
-
# For
|
1852
|
-
# authenticate users that connect to the DB instance. For more
|
1853
|
-
# information, see [ Using Kerberos Authentication with Amazon RDS for
|
1854
|
-
# Oracle][1] in the *Amazon RDS User Guide*.
|
1855
|
-
#
|
1856
|
-
# For Microsoft SQL Server DB instances, Amazon RDS can use Windows
|
1857
|
-
# Authentication to authenticate users that connect to the DB instance.
|
1858
|
-
# For more information, see [ Using Windows Authentication with an
|
1859
|
-
# Amazon RDS DB Instance Running Microsoft SQL Server][2] in the *Amazon
|
1886
|
+
# For more information, see [ Kerberos Authentication][1] in the *Amazon
|
1860
1887
|
# RDS User Guide*.
|
1861
1888
|
#
|
1862
1889
|
#
|
1863
1890
|
#
|
1864
|
-
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/
|
1865
|
-
# [2]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_SQLServerWinAuth.html
|
1891
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/kerberos-authentication.html
|
1866
1892
|
# @option options [String] :domain_iam_role_name
|
1867
1893
|
# Specify the name of the IAM role to be used when making API calls to
|
1868
1894
|
# the Directory Service.
|
1895
|
+
# @option options [String] :replica_mode
|
1896
|
+
# The open mode of the replica database: mounted or read-only.
|
1897
|
+
#
|
1898
|
+
# <note markdown="1"> This parameter is only supported for Oracle DB instances.
|
1899
|
+
#
|
1900
|
+
# </note>
|
1901
|
+
#
|
1902
|
+
# Mounted DB replicas are included in Oracle Enterprise Edition. The
|
1903
|
+
# main use case for mounted replicas is cross-Region disaster recovery.
|
1904
|
+
# The primary database doesn't use Active Data Guard to transmit
|
1905
|
+
# information to the mounted replica. Because it doesn't accept user
|
1906
|
+
# connections, a mounted replica can't serve a read-only workload.
|
1907
|
+
#
|
1908
|
+
# You can create a combination of mounted and read-only DB replicas for
|
1909
|
+
# the same primary DB instance. For more information, see [Working with
|
1910
|
+
# Oracle Read Replicas for Amazon RDS][1] in the *Amazon RDS User
|
1911
|
+
# Guide*.
|
1912
|
+
#
|
1913
|
+
#
|
1914
|
+
#
|
1915
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-read-replicas.html
|
1869
1916
|
# @option options [String] :destination_region
|
1870
1917
|
# @option options [String] :source_region
|
1871
1918
|
# The source region of the snapshot. This is only needed when the
|
@@ -2037,6 +2084,7 @@ module Aws::RDS
|
|
2037
2084
|
# deletion_protection: false,
|
2038
2085
|
# max_allocated_storage: 1,
|
2039
2086
|
# certificate_rotation_restart: false,
|
2087
|
+
# replica_mode: "open-read-only", # accepts open-read-only, mounted
|
2040
2088
|
# })
|
2041
2089
|
# @param [Hash] options ({})
|
2042
2090
|
# @option options [Integer] :allocated_storage
|
@@ -2390,25 +2438,16 @@ module Aws::RDS
|
|
2390
2438
|
# @option options [String] :domain
|
2391
2439
|
# The Active Directory directory ID to move the DB instance to. Specify
|
2392
2440
|
# `none` to remove the instance from its current domain. The domain must
|
2393
|
-
# be created prior to this operation. Currently, only Microsoft
|
2394
|
-
# Server and
|
2395
|
-
# Domain.
|
2396
|
-
#
|
2397
|
-
# For Microsoft SQL Server DB instances, Amazon RDS can use Windows
|
2398
|
-
# Authentication to authenticate users that connect to the DB instance.
|
2399
|
-
# For more information, see [ Using Windows Authentication with an
|
2400
|
-
# Amazon RDS DB Instance Running Microsoft SQL Server][1] in the *Amazon
|
2401
|
-
# RDS User Guide*.
|
2441
|
+
# be created prior to this operation. Currently, only MySQL, Microsoft
|
2442
|
+
# SQL Server, Oracle, and PostgreSQL DB instances can be created in an
|
2443
|
+
# Active Directory Domain.
|
2402
2444
|
#
|
2403
|
-
# For
|
2404
|
-
#
|
2405
|
-
# information, see [ Using Kerberos Authentication with Amazon RDS for
|
2406
|
-
# Oracle][2] in the *Amazon RDS User Guide*.
|
2445
|
+
# For more information, see [ Kerberos Authentication][1] in the *Amazon
|
2446
|
+
# RDS User Guide*.
|
2407
2447
|
#
|
2408
2448
|
#
|
2409
2449
|
#
|
2410
|
-
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/
|
2411
|
-
# [2]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-kerberos.html
|
2450
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/kerberos-authentication.html
|
2412
2451
|
# @option options [Boolean] :copy_tags_to_snapshot
|
2413
2452
|
# A value that indicates whether to copy all tags from the DB instance
|
2414
2453
|
# to snapshots of the DB instance. By default, tags are not copied.
|
@@ -2610,6 +2649,25 @@ module Aws::RDS
|
|
2610
2649
|
#
|
2611
2650
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL-certificate-rotation.html
|
2612
2651
|
# [2]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL-certificate-rotation.html
|
2652
|
+
# @option options [String] :replica_mode
|
2653
|
+
# A value that sets the open mode of a replica database to either
|
2654
|
+
# mounted or read-only.
|
2655
|
+
#
|
2656
|
+
# <note markdown="1"> Currently, this parameter is only supported for Oracle DB instances.
|
2657
|
+
#
|
2658
|
+
# </note>
|
2659
|
+
#
|
2660
|
+
# Mounted DB replicas are included in Oracle Enterprise Edition. The
|
2661
|
+
# main use case for mounted replicas is cross-Region disaster recovery.
|
2662
|
+
# The primary database doesn't use Active Data Guard to transmit
|
2663
|
+
# information to the mounted replica. Because it doesn't accept user
|
2664
|
+
# connections, a mounted replica can't serve a read-only workload. For
|
2665
|
+
# more information, see [Working with Oracle Read Replicas for Amazon
|
2666
|
+
# RDS][1] in the *Amazon RDS User Guide*.
|
2667
|
+
#
|
2668
|
+
#
|
2669
|
+
#
|
2670
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-read-replicas.html
|
2613
2671
|
# @return [DBInstance]
|
2614
2672
|
def modify(options = {})
|
2615
2673
|
options = options.merge(db_instance_identifier: @id)
|
@@ -2924,24 +2982,15 @@ module Aws::RDS
|
|
2924
2982
|
# @option options [String] :domain
|
2925
2983
|
# Specify the Active Directory directory ID to restore the DB instance
|
2926
2984
|
# in. The domain must be created prior to this operation. Currently,
|
2927
|
-
# only Microsoft SQL Server and
|
2928
|
-
# Active Directory Domain.
|
2985
|
+
# only MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances
|
2986
|
+
# can be created in an Active Directory Domain.
|
2929
2987
|
#
|
2930
|
-
# For
|
2931
|
-
# Authentication to authenticate users that connect to the DB instance.
|
2932
|
-
# For more information, see [ Using Windows Authentication with an
|
2933
|
-
# Amazon RDS DB Instance Running Microsoft SQL Server][1] in the *Amazon
|
2988
|
+
# For more information, see [ Kerberos Authentication][1] in the *Amazon
|
2934
2989
|
# RDS User Guide*.
|
2935
2990
|
#
|
2936
|
-
# For Oracle DB instances, Amazon RDS can use Kerberos authentication to
|
2937
|
-
# authenticate users that connect to the DB instance. For more
|
2938
|
-
# information, see [ Using Kerberos Authentication with Amazon RDS for
|
2939
|
-
# Oracle][2] in the *Amazon RDS User Guide*.
|
2940
|
-
#
|
2941
2991
|
#
|
2942
2992
|
#
|
2943
|
-
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/
|
2944
|
-
# [2]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-kerberos.html
|
2993
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/kerberos-authentication.html
|
2945
2994
|
# @option options [String] :domain_iam_role_name
|
2946
2995
|
# Specify the name of the IAM role to be used when making API calls to
|
2947
2996
|
# the Directory Service.
|
@@ -35,8 +35,8 @@ module Aws::RDS
|
|
35
35
|
end
|
36
36
|
alias :db_parameter_group_name :name
|
37
37
|
|
38
|
-
#
|
39
|
-
#
|
38
|
+
# The name of the DB parameter group family that this DB parameter group
|
39
|
+
# is compatible with.
|
40
40
|
# @return [String]
|
41
41
|
def db_parameter_group_family
|
42
42
|
data[:db_parameter_group_family]
|
@@ -759,24 +759,15 @@ module Aws::RDS
|
|
759
759
|
# @option options [String] :domain
|
760
760
|
# Specify the Active Directory directory ID to restore the DB instance
|
761
761
|
# in. The domain must be created prior to this operation. Currently,
|
762
|
-
# only Microsoft SQL Server and
|
763
|
-
# Active Directory Domain.
|
762
|
+
# only MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances
|
763
|
+
# can be created in an Active Directory Domain.
|
764
764
|
#
|
765
|
-
# For
|
766
|
-
# Authentication to authenticate users that connect to the DB instance.
|
767
|
-
# For more information, see [ Using Windows Authentication with an
|
768
|
-
# Amazon RDS DB Instance Running Microsoft SQL Server][1] in the *Amazon
|
765
|
+
# For more information, see [ Kerberos Authentication][1] in the *Amazon
|
769
766
|
# RDS User Guide*.
|
770
767
|
#
|
771
|
-
# For Oracle DB instances, Amazon RDS can use Kerberos authentication to
|
772
|
-
# authenticate users that connect to the DB instance. For more
|
773
|
-
# information, see [ Using Kerberos Authentication with Amazon RDS for
|
774
|
-
# Oracle][2] in the *Amazon RDS User Guide*.
|
775
768
|
#
|
776
769
|
#
|
777
|
-
#
|
778
|
-
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_SQLServerWinAuth.html
|
779
|
-
# [2]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-kerberos.html
|
770
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/kerberos-authentication.html
|
780
771
|
# @option options [Boolean] :copy_tags_to_snapshot
|
781
772
|
# A value that indicates whether to copy all tags from the restored DB
|
782
773
|
# instance to snapshots of the DB instance. By default, tags are not
|
@@ -247,17 +247,23 @@ module Aws::RDS
|
|
247
247
|
#
|
248
248
|
# Constraints:
|
249
249
|
#
|
250
|
-
# * If the source type is a DB instance,
|
250
|
+
# * If the source type is a DB instance, a `DBInstanceIdentifier` value
|
251
251
|
# must be supplied.
|
252
252
|
#
|
253
|
-
# * If the source type is a DB
|
253
|
+
# * If the source type is a DB cluster, a `DBClusterIdentifier` value
|
254
254
|
# must be supplied.
|
255
255
|
#
|
256
256
|
# * If the source type is a DB parameter group, a `DBParameterGroupName`
|
257
|
+
# value must be supplied.
|
258
|
+
#
|
259
|
+
# * If the source type is a DB security group, a `DBSecurityGroupName`
|
260
|
+
# value must be supplied.
|
261
|
+
#
|
262
|
+
# * If the source type is a DB snapshot, a `DBSnapshotIdentifier` value
|
257
263
|
# must be supplied.
|
258
264
|
#
|
259
|
-
# * If the source type is a DB snapshot, a
|
260
|
-
# be supplied.
|
265
|
+
# * If the source type is a DB cluster snapshot, a
|
266
|
+
# `DBClusterSnapshotIdentifier` value must be supplied.
|
261
267
|
# @return [EventSubscription]
|
262
268
|
def add_subscriber(options = {})
|
263
269
|
options = options.merge(subscription_name: @name)
|
@@ -291,17 +297,17 @@ module Aws::RDS
|
|
291
297
|
# and subscribe to it.
|
292
298
|
# @option options [String] :source_type
|
293
299
|
# The type of source that is generating the events. For example, if you
|
294
|
-
# want to be notified of events generated by a DB instance, you
|
295
|
-
#
|
296
|
-
#
|
300
|
+
# want to be notified of events generated by a DB instance, you set this
|
301
|
+
# parameter to `db-instance`. If this value isn't specified, all events
|
302
|
+
# are returned.
|
297
303
|
#
|
298
304
|
# Valid values: `db-instance` \| `db-cluster` \| `db-parameter-group` \|
|
299
305
|
# `db-security-group` \| `db-snapshot` \| `db-cluster-snapshot`
|
300
306
|
# @option options [Array<String>] :event_categories
|
301
|
-
# A list of event categories for a
|
302
|
-
# to. You can see a list of the categories
|
303
|
-
# [Events][1]
|
304
|
-
#
|
307
|
+
# A list of event categories for a particular source type (`SourceType`)
|
308
|
+
# that you want to subscribe to. You can see a list of the categories
|
309
|
+
# for a given source type in [Events][1] in the *Amazon RDS User Guide*
|
310
|
+
# or by using the `DescribeEventCategories` operation.
|
305
311
|
#
|
306
312
|
#
|
307
313
|
#
|
@@ -315,19 +321,26 @@ module Aws::RDS
|
|
315
321
|
#
|
316
322
|
# Constraints:
|
317
323
|
#
|
318
|
-
# * If SourceIds
|
324
|
+
# * If a `SourceIds` value is supplied, `SourceType` must also be
|
325
|
+
# provided.
|
319
326
|
#
|
320
|
-
# * If the source type is a DB instance,
|
327
|
+
# * If the source type is a DB instance, a `DBInstanceIdentifier` value
|
321
328
|
# must be supplied.
|
322
329
|
#
|
323
|
-
# * If the source type is a DB
|
330
|
+
# * If the source type is a DB cluster, a `DBClusterIdentifier` value
|
324
331
|
# must be supplied.
|
325
332
|
#
|
326
333
|
# * If the source type is a DB parameter group, a `DBParameterGroupName`
|
334
|
+
# value must be supplied.
|
335
|
+
#
|
336
|
+
# * If the source type is a DB security group, a `DBSecurityGroupName`
|
337
|
+
# value must be supplied.
|
338
|
+
#
|
339
|
+
# * If the source type is a DB snapshot, a `DBSnapshotIdentifier` value
|
327
340
|
# must be supplied.
|
328
341
|
#
|
329
|
-
# * If the source type is a DB snapshot, a
|
330
|
-
# be supplied.
|
342
|
+
# * If the source type is a DB cluster snapshot, a
|
343
|
+
# `DBClusterSnapshotIdentifier` value must be supplied.
|
331
344
|
# @option options [Boolean] :enabled
|
332
345
|
# A value that indicates whether to activate the subscription. If the
|
333
346
|
# event notification subscription isn't activated, the subscription is
|
@@ -384,13 +397,13 @@ module Aws::RDS
|
|
384
397
|
# set this parameter to db-instance. If this value isn't specified, all
|
385
398
|
# events are returned.
|
386
399
|
#
|
387
|
-
# Valid values: db-instance \| db-
|
388
|
-
# \| db-snapshot
|
400
|
+
# Valid values: `db-instance` \| `db-cluster` \| `db-parameter-group` \|
|
401
|
+
# `db-security-group` \| `db-snapshot` \| `db-cluster-snapshot`
|
389
402
|
# @option options [Array<String>] :event_categories
|
390
|
-
# A list of event categories for a SourceType that you
|
391
|
-
# to. You can see a list of the categories for a given
|
392
|
-
# [Events][1]
|
393
|
-
#
|
403
|
+
# A list of event categories for a source type (`SourceType`) that you
|
404
|
+
# want to subscribe to. You can see a list of the categories for a given
|
405
|
+
# source type in [Events][1] in the *Amazon RDS User Guide* or by using
|
406
|
+
# the `DescribeEventCategories` operation.
|
394
407
|
#
|
395
408
|
#
|
396
409
|
#
|