aws-sdk-rds 1.95.0 → 1.96.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 +1 -1
- data/lib/aws-sdk-rds/client.rb +219 -141
- data/lib/aws-sdk-rds/client_api.rb +4 -0
- data/lib/aws-sdk-rds/db_cluster.rb +7 -0
- data/lib/aws-sdk-rds/db_cluster_snapshot.rb +10 -1
- data/lib/aws-sdk-rds/db_instance.rb +84 -54
- 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 +46 -35
- data/lib/aws-sdk-rds/types.rb +202 -117
- 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"))
|
@@ -1339,6 +1339,13 @@ module Aws::RDS
|
|
1339
1339
|
# The Active Directory directory ID to move the DB cluster to. Specify
|
1340
1340
|
# `none` to remove the cluster from its current domain. The domain must
|
1341
1341
|
# be created prior to this operation.
|
1342
|
+
#
|
1343
|
+
# For more information, see [Kerberos Authentication][1] in the *Amazon
|
1344
|
+
# Aurora User Guide*.
|
1345
|
+
#
|
1346
|
+
#
|
1347
|
+
#
|
1348
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/kerberos-authentication.html
|
1342
1349
|
# @option options [String] :domain_iam_role_name
|
1343
1350
|
# Specify the name of the IAM role to be used when making API calls to
|
1344
1351
|
# the Directory Service.
|
@@ -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.
|
@@ -225,6 +225,22 @@ module Aws::RDS
|
|
225
225
|
data[:read_replica_db_cluster_identifiers]
|
226
226
|
end
|
227
227
|
|
228
|
+
# The open mode of an Oracle read replica. The default is
|
229
|
+
# `open-read-only`. For more information, see [Working with Oracle Read
|
230
|
+
# Replicas for Amazon RDS][1] in the *Amazon RDS User Guide*.
|
231
|
+
#
|
232
|
+
# <note markdown="1"> This attribute is only supported in RDS for Oracle.
|
233
|
+
#
|
234
|
+
# </note>
|
235
|
+
#
|
236
|
+
#
|
237
|
+
#
|
238
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-read-replicas.html
|
239
|
+
# @return [String]
|
240
|
+
def replica_mode
|
241
|
+
data[:replica_mode]
|
242
|
+
end
|
243
|
+
|
228
244
|
# License model information for this DB instance.
|
229
245
|
# @return [String]
|
230
246
|
def license_model
|
@@ -707,6 +723,9 @@ module Aws::RDS
|
|
707
723
|
#
|
708
724
|
# * Must contain 1 to 64 letters or numbers.
|
709
725
|
#
|
726
|
+
# * Must begin with a letter. Subsequent characters can be letters,
|
727
|
+
# underscores, or digits (0-9).
|
728
|
+
#
|
710
729
|
# * Can't be a word reserved by the specified database engine
|
711
730
|
#
|
712
731
|
# **MariaDB**
|
@@ -719,6 +738,9 @@ module Aws::RDS
|
|
719
738
|
#
|
720
739
|
# * Must contain 1 to 64 letters or numbers.
|
721
740
|
#
|
741
|
+
# * Must begin with a letter. Subsequent characters can be letters,
|
742
|
+
# underscores, or digits (0-9).
|
743
|
+
#
|
722
744
|
# * Can't be a word reserved by the specified database engine
|
723
745
|
#
|
724
746
|
# **PostgreSQL**
|
@@ -731,8 +753,8 @@ module Aws::RDS
|
|
731
753
|
#
|
732
754
|
# * Must contain 1 to 63 letters, numbers, or underscores.
|
733
755
|
#
|
734
|
-
# * Must begin with a letter
|
735
|
-
#
|
756
|
+
# * Must begin with a letter. Subsequent characters can be letters,
|
757
|
+
# underscores, or digits (0-9).
|
736
758
|
#
|
737
759
|
# * Can't be a word reserved by the specified database engine
|
738
760
|
#
|
@@ -1330,24 +1352,15 @@ module Aws::RDS
|
|
1330
1352
|
# for each AWS Region.
|
1331
1353
|
# @option options [String] :domain
|
1332
1354
|
# 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.
|
1355
|
+
# Currently, only MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB
|
1356
|
+
# instances can be created in an Active Directory Domain.
|
1335
1357
|
#
|
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
|
1358
|
+
# For more information, see [ Kerberos Authentication][1] in the *Amazon
|
1340
1359
|
# RDS User Guide*.
|
1341
1360
|
#
|
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
1361
|
#
|
1347
1362
|
#
|
1348
|
-
#
|
1349
|
-
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_SQLServerWinAuth.html
|
1350
|
-
# [2]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-kerberos.html
|
1363
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/kerberos-authentication.html
|
1351
1364
|
# @option options [Boolean] :copy_tags_to_snapshot
|
1352
1365
|
# A value that indicates whether to copy tags from the DB instance to
|
1353
1366
|
# snapshots of the DB instance. By default, tags are not copied.
|
@@ -1544,6 +1557,7 @@ module Aws::RDS
|
|
1544
1557
|
# deletion_protection: false,
|
1545
1558
|
# domain: "String",
|
1546
1559
|
# domain_iam_role_name: "String",
|
1560
|
+
# replica_mode: "open-read-only", # accepts open-read-only, mounted
|
1547
1561
|
# source_region: "String",
|
1548
1562
|
# })
|
1549
1563
|
# @param [Hash] options ({})
|
@@ -1847,25 +1861,39 @@ module Aws::RDS
|
|
1847
1861
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_DeleteInstance.html
|
1848
1862
|
# @option options [String] :domain
|
1849
1863
|
# The Active Directory directory ID to create the DB instance in.
|
1864
|
+
# Currently, only MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB
|
1865
|
+
# instances can be created in an Active Directory Domain.
|
1850
1866
|
#
|
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
|
1867
|
+
# For more information, see [ Kerberos Authentication][1] in the *Amazon
|
1860
1868
|
# RDS User Guide*.
|
1861
1869
|
#
|
1862
1870
|
#
|
1863
1871
|
#
|
1864
|
-
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/
|
1865
|
-
# [2]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_SQLServerWinAuth.html
|
1872
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/kerberos-authentication.html
|
1866
1873
|
# @option options [String] :domain_iam_role_name
|
1867
1874
|
# Specify the name of the IAM role to be used when making API calls to
|
1868
1875
|
# the Directory Service.
|
1876
|
+
# @option options [String] :replica_mode
|
1877
|
+
# The open mode of the replica database: mounted or read-only.
|
1878
|
+
#
|
1879
|
+
# <note markdown="1"> This parameter is only supported for Oracle DB instances.
|
1880
|
+
#
|
1881
|
+
# </note>
|
1882
|
+
#
|
1883
|
+
# Mounted DB replicas are included in Oracle Enterprise Edition. The
|
1884
|
+
# main use case for mounted replicas is cross-Region disaster recovery.
|
1885
|
+
# The primary database doesn't use Active Data Guard to transmit
|
1886
|
+
# information to the mounted replica. Because it doesn't accept user
|
1887
|
+
# connections, a mounted replica can't serve a read-only workload.
|
1888
|
+
#
|
1889
|
+
# You can create a combination of mounted and read-only DB replicas for
|
1890
|
+
# the same primary DB instance. For more information, see [Working with
|
1891
|
+
# Oracle Read Replicas for Amazon RDS][1] in the *Amazon RDS User
|
1892
|
+
# Guide*.
|
1893
|
+
#
|
1894
|
+
#
|
1895
|
+
#
|
1896
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-read-replicas.html
|
1869
1897
|
# @option options [String] :destination_region
|
1870
1898
|
# @option options [String] :source_region
|
1871
1899
|
# The source region of the snapshot. This is only needed when the
|
@@ -2037,6 +2065,7 @@ module Aws::RDS
|
|
2037
2065
|
# deletion_protection: false,
|
2038
2066
|
# max_allocated_storage: 1,
|
2039
2067
|
# certificate_rotation_restart: false,
|
2068
|
+
# replica_mode: "open-read-only", # accepts open-read-only, mounted
|
2040
2069
|
# })
|
2041
2070
|
# @param [Hash] options ({})
|
2042
2071
|
# @option options [Integer] :allocated_storage
|
@@ -2390,25 +2419,16 @@ module Aws::RDS
|
|
2390
2419
|
# @option options [String] :domain
|
2391
2420
|
# The Active Directory directory ID to move the DB instance to. Specify
|
2392
2421
|
# `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*.
|
2422
|
+
# be created prior to this operation. Currently, only MySQL, Microsoft
|
2423
|
+
# SQL Server, Oracle, and PostgreSQL DB instances can be created in an
|
2424
|
+
# Active Directory Domain.
|
2402
2425
|
#
|
2403
|
-
# For
|
2404
|
-
#
|
2405
|
-
# information, see [ Using Kerberos Authentication with Amazon RDS for
|
2406
|
-
# Oracle][2] in the *Amazon RDS User Guide*.
|
2426
|
+
# For more information, see [ Kerberos Authentication][1] in the *Amazon
|
2427
|
+
# RDS User Guide*.
|
2407
2428
|
#
|
2408
2429
|
#
|
2409
2430
|
#
|
2410
|
-
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/
|
2411
|
-
# [2]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-kerberos.html
|
2431
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/kerberos-authentication.html
|
2412
2432
|
# @option options [Boolean] :copy_tags_to_snapshot
|
2413
2433
|
# A value that indicates whether to copy all tags from the DB instance
|
2414
2434
|
# to snapshots of the DB instance. By default, tags are not copied.
|
@@ -2610,6 +2630,25 @@ module Aws::RDS
|
|
2610
2630
|
#
|
2611
2631
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL-certificate-rotation.html
|
2612
2632
|
# [2]: https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL-certificate-rotation.html
|
2633
|
+
# @option options [String] :replica_mode
|
2634
|
+
# A value that sets the open mode of a replica database to either
|
2635
|
+
# mounted or read-only.
|
2636
|
+
#
|
2637
|
+
# <note markdown="1"> Currently, this parameter is only supported for Oracle DB instances.
|
2638
|
+
#
|
2639
|
+
# </note>
|
2640
|
+
#
|
2641
|
+
# Mounted DB replicas are included in Oracle Enterprise Edition. The
|
2642
|
+
# main use case for mounted replicas is cross-Region disaster recovery.
|
2643
|
+
# The primary database doesn't use Active Data Guard to transmit
|
2644
|
+
# information to the mounted replica. Because it doesn't accept user
|
2645
|
+
# connections, a mounted replica can't serve a read-only workload. For
|
2646
|
+
# more information, see [Working with Oracle Read Replicas for Amazon
|
2647
|
+
# RDS][1] in the *Amazon RDS User Guide*.
|
2648
|
+
#
|
2649
|
+
#
|
2650
|
+
#
|
2651
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-read-replicas.html
|
2613
2652
|
# @return [DBInstance]
|
2614
2653
|
def modify(options = {})
|
2615
2654
|
options = options.merge(db_instance_identifier: @id)
|
@@ -2924,24 +2963,15 @@ module Aws::RDS
|
|
2924
2963
|
# @option options [String] :domain
|
2925
2964
|
# Specify the Active Directory directory ID to restore the DB instance
|
2926
2965
|
# in. The domain must be created prior to this operation. Currently,
|
2927
|
-
# only Microsoft SQL Server and
|
2928
|
-
# Active Directory Domain.
|
2966
|
+
# only MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB instances
|
2967
|
+
# can be created in an Active Directory Domain.
|
2929
2968
|
#
|
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
|
2969
|
+
# For more information, see [ Kerberos Authentication][1] in the *Amazon
|
2934
2970
|
# RDS User Guide*.
|
2935
2971
|
#
|
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
2972
|
#
|
2942
2973
|
#
|
2943
|
-
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/
|
2944
|
-
# [2]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-kerberos.html
|
2974
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/kerberos-authentication.html
|
2945
2975
|
# @option options [String] :domain_iam_role_name
|
2946
2976
|
# Specify the name of the IAM role to be used when making API calls to
|
2947
2977
|
# the Directory Service.
|
@@ -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
|
#
|
data/lib/aws-sdk-rds/resource.rb
CHANGED
@@ -586,6 +586,9 @@ module Aws::RDS
|
|
586
586
|
#
|
587
587
|
# * Must contain 1 to 64 letters or numbers.
|
588
588
|
#
|
589
|
+
# * Must begin with a letter. Subsequent characters can be letters,
|
590
|
+
# underscores, or digits (0-9).
|
591
|
+
#
|
589
592
|
# * Can't be a word reserved by the specified database engine
|
590
593
|
#
|
591
594
|
# **MariaDB**
|
@@ -598,6 +601,9 @@ module Aws::RDS
|
|
598
601
|
#
|
599
602
|
# * Must contain 1 to 64 letters or numbers.
|
600
603
|
#
|
604
|
+
# * Must begin with a letter. Subsequent characters can be letters,
|
605
|
+
# underscores, or digits (0-9).
|
606
|
+
#
|
601
607
|
# * Can't be a word reserved by the specified database engine
|
602
608
|
#
|
603
609
|
# **PostgreSQL**
|
@@ -610,8 +616,8 @@ module Aws::RDS
|
|
610
616
|
#
|
611
617
|
# * Must contain 1 to 63 letters, numbers, or underscores.
|
612
618
|
#
|
613
|
-
# * Must begin with a letter
|
614
|
-
#
|
619
|
+
# * Must begin with a letter. Subsequent characters can be letters,
|
620
|
+
# underscores, or digits (0-9).
|
615
621
|
#
|
616
622
|
# * Can't be a word reserved by the specified database engine
|
617
623
|
#
|
@@ -1222,24 +1228,15 @@ module Aws::RDS
|
|
1222
1228
|
# for each AWS Region.
|
1223
1229
|
# @option options [String] :domain
|
1224
1230
|
# The Active Directory directory ID to create the DB instance in.
|
1225
|
-
# Currently, only Microsoft SQL Server and
|
1226
|
-
# created in an Active Directory Domain.
|
1231
|
+
# Currently, only MySQL, Microsoft SQL Server, Oracle, and PostgreSQL DB
|
1232
|
+
# instances can be created in an Active Directory Domain.
|
1227
1233
|
#
|
1228
|
-
# For
|
1229
|
-
# Authentication to authenticate users that connect to the DB instance.
|
1230
|
-
# For more information, see [ Using Windows Authentication with an
|
1231
|
-
# Amazon RDS DB Instance Running Microsoft SQL Server][1] in the *Amazon
|
1234
|
+
# For more information, see [ Kerberos Authentication][1] in the *Amazon
|
1232
1235
|
# RDS User Guide*.
|
1233
1236
|
#
|
1234
|
-
# For Oracle DB instances, Amazon RDS can use Kerberos Authentication to
|
1235
|
-
# authenticate users that connect to the DB instance. For more
|
1236
|
-
# information, see [ Using Kerberos Authentication with Amazon RDS for
|
1237
|
-
# Oracle][2] in the *Amazon RDS User Guide*.
|
1238
1237
|
#
|
1239
1238
|
#
|
1240
|
-
#
|
1241
|
-
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_SQLServerWinAuth.html
|
1242
|
-
# [2]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-kerberos.html
|
1239
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/kerberos-authentication.html
|
1243
1240
|
# @option options [Boolean] :copy_tags_to_snapshot
|
1244
1241
|
# A value that indicates whether to copy tags from the DB instance to
|
1245
1242
|
# snapshots of the DB instance. By default, tags are not copied.
|
@@ -1557,17 +1554,17 @@ module Aws::RDS
|
|
1557
1554
|
# and subscribe to it.
|
1558
1555
|
# @option options [String] :source_type
|
1559
1556
|
# The type of source that is generating the events. For example, if you
|
1560
|
-
# want to be notified of events generated by a DB instance, you
|
1561
|
-
#
|
1562
|
-
#
|
1557
|
+
# want to be notified of events generated by a DB instance, you set this
|
1558
|
+
# parameter to `db-instance`. If this value isn't specified, all events
|
1559
|
+
# are returned.
|
1563
1560
|
#
|
1564
1561
|
# Valid values: `db-instance` \| `db-cluster` \| `db-parameter-group` \|
|
1565
1562
|
# `db-security-group` \| `db-snapshot` \| `db-cluster-snapshot`
|
1566
1563
|
# @option options [Array<String>] :event_categories
|
1567
|
-
# A list of event categories for a
|
1568
|
-
# to. You can see a list of the categories
|
1569
|
-
# [Events][1]
|
1570
|
-
#
|
1564
|
+
# A list of event categories for a particular source type (`SourceType`)
|
1565
|
+
# that you want to subscribe to. You can see a list of the categories
|
1566
|
+
# for a given source type in [Events][1] in the *Amazon RDS User Guide*
|
1567
|
+
# or by using the `DescribeEventCategories` operation.
|
1571
1568
|
#
|
1572
1569
|
#
|
1573
1570
|
#
|
@@ -1581,19 +1578,26 @@ module Aws::RDS
|
|
1581
1578
|
#
|
1582
1579
|
# Constraints:
|
1583
1580
|
#
|
1584
|
-
# * If SourceIds
|
1581
|
+
# * If a `SourceIds` value is supplied, `SourceType` must also be
|
1582
|
+
# provided.
|
1585
1583
|
#
|
1586
|
-
# * If the source type is a DB instance,
|
1584
|
+
# * If the source type is a DB instance, a `DBInstanceIdentifier` value
|
1587
1585
|
# must be supplied.
|
1588
1586
|
#
|
1589
|
-
# * If the source type is a DB
|
1587
|
+
# * If the source type is a DB cluster, a `DBClusterIdentifier` value
|
1590
1588
|
# must be supplied.
|
1591
1589
|
#
|
1592
1590
|
# * If the source type is a DB parameter group, a `DBParameterGroupName`
|
1591
|
+
# value must be supplied.
|
1592
|
+
#
|
1593
|
+
# * If the source type is a DB security group, a `DBSecurityGroupName`
|
1594
|
+
# value must be supplied.
|
1595
|
+
#
|
1596
|
+
# * If the source type is a DB snapshot, a `DBSnapshotIdentifier` value
|
1593
1597
|
# must be supplied.
|
1594
1598
|
#
|
1595
|
-
# * If the source type is a DB snapshot, a
|
1596
|
-
# be supplied.
|
1599
|
+
# * If the source type is a DB cluster snapshot, a
|
1600
|
+
# `DBClusterSnapshotIdentifier` value must be supplied.
|
1597
1601
|
# @option options [Boolean] :enabled
|
1598
1602
|
# A value that indicates whether to activate the subscription. If the
|
1599
1603
|
# event notification subscription isn't activated, the subscription is
|
@@ -2325,8 +2329,8 @@ module Aws::RDS
|
|
2325
2329
|
# @option options [String] :source_type
|
2326
2330
|
# The type of source that is generating the events.
|
2327
2331
|
#
|
2328
|
-
# Valid values: db-instance \| db-
|
2329
|
-
# \| db-snapshot
|
2332
|
+
# Valid values: `db-instance` \| `db-cluster` \| `db-parameter-group` \|
|
2333
|
+
# `db-security-group` \| `db-snapshot` \| `db-cluster-snapshot`
|
2330
2334
|
# @option options [Array<Types::Filter>] :filters
|
2331
2335
|
# This parameter isn't currently supported.
|
2332
2336
|
# @return [EventCategoryMap::Collection]
|
@@ -2414,19 +2418,26 @@ module Aws::RDS
|
|
2414
2418
|
#
|
2415
2419
|
# Constraints:
|
2416
2420
|
#
|
2417
|
-
# * If SourceIdentifier is supplied, SourceType must also be
|
2421
|
+
# * If `SourceIdentifier` is supplied, `SourceType` must also be
|
2422
|
+
# provided.
|
2418
2423
|
#
|
2419
|
-
# * If the source type is
|
2424
|
+
# * If the source type is a DB instance, a `DBInstanceIdentifier` value
|
2420
2425
|
# must be supplied.
|
2421
2426
|
#
|
2422
|
-
# * If the source type is
|
2427
|
+
# * If the source type is a DB cluster, a `DBClusterIdentifier` value
|
2423
2428
|
# must be supplied.
|
2424
2429
|
#
|
2425
|
-
# * If the source type is
|
2430
|
+
# * If the source type is a DB parameter group, a `DBParameterGroupName`
|
2431
|
+
# value must be supplied.
|
2432
|
+
#
|
2433
|
+
# * If the source type is a DB security group, a `DBSecurityGroupName`
|
2434
|
+
# value must be supplied.
|
2435
|
+
#
|
2436
|
+
# * If the source type is a DB snapshot, a `DBSnapshotIdentifier` value
|
2426
2437
|
# must be supplied.
|
2427
2438
|
#
|
2428
|
-
# * If the source type is
|
2429
|
-
# supplied.
|
2439
|
+
# * If the source type is a DB cluster snapshot, a
|
2440
|
+
# `DBClusterSnapshotIdentifier` value must be supplied.
|
2430
2441
|
#
|
2431
2442
|
# * Can't end with a hyphen or contain two consecutive hyphens.
|
2432
2443
|
# @option options [String] :source_type
|