aws-sdk-rds 1.128.0 → 1.129.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-rds/client.rb +1279 -258
- data/lib/aws-sdk-rds/client_api.rb +93 -0
- data/lib/aws-sdk-rds/db_cluster.rb +30 -34
- data/lib/aws-sdk-rds/db_cluster_snapshot.rb +20 -24
- data/lib/aws-sdk-rds/db_engine.rb +8 -0
- data/lib/aws-sdk-rds/db_engine_version.rb +66 -4
- data/lib/aws-sdk-rds/db_instance.rb +514 -139
- data/lib/aws-sdk-rds/db_snapshot.rb +78 -30
- data/lib/aws-sdk-rds/errors.rb +44 -0
- data/lib/aws-sdk-rds/resource.rb +186 -59
- data/lib/aws-sdk-rds/types.rb +1058 -285
- data/lib/aws-sdk-rds.rb +1 -1
- metadata +2 -2
@@ -177,8 +177,7 @@ module Aws::RDS
|
|
177
177
|
# the encrypted DB snapshot.
|
178
178
|
#
|
179
179
|
# The Amazon Web Services KMS key identifier is the key ARN, key ID,
|
180
|
-
# alias ARN, or alias name for the
|
181
|
-
# master key (CMK).
|
180
|
+
# alias ARN, or alias name for the KMS key.
|
182
181
|
# @return [String]
|
183
182
|
def kms_key_id
|
184
183
|
data[:kms_key_id]
|
@@ -440,15 +439,13 @@ module Aws::RDS
|
|
440
439
|
# @option options [String] :kms_key_id
|
441
440
|
# The Amazon Web Services KMS key identifier for an encrypted DB
|
442
441
|
# snapshot. The Amazon Web Services KMS key identifier is the key ARN,
|
443
|
-
# key ID, alias ARN, or alias name for the
|
444
|
-
# customer master key (CMK).
|
442
|
+
# key ID, alias ARN, or alias name for the KMS key.
|
445
443
|
#
|
446
444
|
# If you copy an encrypted DB snapshot from your Amazon Web Services
|
447
445
|
# account, you can specify a value for this parameter to encrypt the
|
448
|
-
# copy with a new
|
449
|
-
#
|
450
|
-
#
|
451
|
-
# snapshot.
|
446
|
+
# copy with a new KMS key. If you don't specify a value for this
|
447
|
+
# parameter, then the copy of the DB snapshot is encrypted with the same
|
448
|
+
# Amazon Web Services KMS key as the source DB snapshot.
|
452
449
|
#
|
453
450
|
# If you copy an encrypted DB snapshot that is shared from another
|
454
451
|
# Amazon Web Services account, then you must specify a value for this
|
@@ -458,11 +455,11 @@ module Aws::RDS
|
|
458
455
|
# the copy is encrypted.
|
459
456
|
#
|
460
457
|
# If you copy an encrypted snapshot to a different Amazon Web Services
|
461
|
-
# Region, then you must specify
|
462
|
-
# for the destination Amazon Web Services Region.
|
463
|
-
#
|
464
|
-
#
|
465
|
-
#
|
458
|
+
# Region, then you must specify an Amazon Web Services KMS key
|
459
|
+
# identifier for the destination Amazon Web Services Region. KMS keys
|
460
|
+
# are specific to the Amazon Web Services Region that they are created
|
461
|
+
# in, and you can't use KMS keys from one Amazon Web Services Region in
|
462
|
+
# another Amazon Web Services Region.
|
466
463
|
# @option options [Array<Types::Tag>] :tags
|
467
464
|
# A list of tags. For more information, see [Tagging Amazon RDS
|
468
465
|
# Resources][1] in the *Amazon RDS User Guide.*
|
@@ -502,12 +499,11 @@ module Aws::RDS
|
|
502
499
|
# presigned URL must be set to the us-east-1 Amazon Web Services
|
503
500
|
# Region.
|
504
501
|
#
|
505
|
-
# * `KmsKeyId` - The Amazon Web Services KMS key identifier for the
|
506
|
-
#
|
507
|
-
#
|
508
|
-
#
|
509
|
-
#
|
510
|
-
# contained in the presigned URL.
|
502
|
+
# * `KmsKeyId` - The Amazon Web Services KMS key identifier for the KMS
|
503
|
+
# key to use to encrypt the copy of the DB snapshot in the destination
|
504
|
+
# Amazon Web Services Region. This is the same identifier for both the
|
505
|
+
# `CopyDBSnapshot` action that is called in the destination Amazon Web
|
506
|
+
# Services Region, and the action contained in the presigned URL.
|
511
507
|
#
|
512
508
|
# * `SourceDBSnapshotIdentifier` - The DB snapshot identifier for the
|
513
509
|
# encrypted snapshot to be copied. This identifier must be in the
|
@@ -626,6 +622,7 @@ module Aws::RDS
|
|
626
622
|
# db_parameter_group_name: "String",
|
627
623
|
# deletion_protection: false,
|
628
624
|
# enable_customer_owned_ip: false,
|
625
|
+
# custom_iam_instance_profile: "String",
|
629
626
|
# })
|
630
627
|
# @param [Hash] options ({})
|
631
628
|
# @option options [required, String] :db_instance_identifier
|
@@ -679,6 +676,8 @@ module Aws::RDS
|
|
679
676
|
# A value that indicates whether the DB instance is a Multi-AZ
|
680
677
|
# deployment.
|
681
678
|
#
|
679
|
+
# This setting doesn't apply to RDS Custom.
|
680
|
+
#
|
682
681
|
# Constraint: You can't specify the `AvailabilityZone` parameter if the
|
683
682
|
# DB instance is a Multi-AZ deployment.
|
684
683
|
# @option options [Boolean] :publicly_accessible
|
@@ -698,9 +697,14 @@ module Aws::RDS
|
|
698
697
|
# @option options [Boolean] :auto_minor_version_upgrade
|
699
698
|
# A value that indicates whether minor version upgrades are applied
|
700
699
|
# automatically to the DB instance during the maintenance window.
|
700
|
+
#
|
701
|
+
# If you restore an RDS Custom DB instance, you must disable this
|
702
|
+
# parameter.
|
701
703
|
# @option options [String] :license_model
|
702
704
|
# License model information for the restored DB instance.
|
703
705
|
#
|
706
|
+
# This setting doesn't apply to RDS Custom.
|
707
|
+
#
|
704
708
|
# Default: Same as source.
|
705
709
|
#
|
706
710
|
# Valid values: `license-included` \| `bring-your-own-license` \|
|
@@ -708,13 +712,13 @@ module Aws::RDS
|
|
708
712
|
# @option options [String] :db_name
|
709
713
|
# The database name for the restored DB instance.
|
710
714
|
#
|
711
|
-
#
|
712
|
-
# engines.
|
713
|
-
#
|
714
|
-
# </note>
|
715
|
+
# This parameter doesn't apply to the MySQL, PostgreSQL, or MariaDB
|
716
|
+
# engines. It also doesn't apply to RDS Custom DB instances.
|
715
717
|
# @option options [String] :engine
|
716
718
|
# The database engine to use for the new instance.
|
717
719
|
#
|
720
|
+
# This setting doesn't apply to RDS Custom.
|
721
|
+
#
|
718
722
|
# Default: The same as source
|
719
723
|
#
|
720
724
|
# Constraint: Must be compatible with the engine of the source. For
|
@@ -767,8 +771,10 @@ module Aws::RDS
|
|
767
771
|
#
|
768
772
|
# Permanent options, such as the TDE option for Oracle Advanced Security
|
769
773
|
# TDE, can't be removed from an option group, and that option group
|
770
|
-
# can't be removed from a DB instance
|
771
|
-
# instance
|
774
|
+
# can't be removed from a DB instance after it is associated with a DB
|
775
|
+
# instance.
|
776
|
+
#
|
777
|
+
# This setting doesn't apply to RDS Custom.
|
772
778
|
# @option options [Array<Types::Tag>] :tags
|
773
779
|
# A list of tags. For more information, see [Tagging Amazon RDS
|
774
780
|
# Resources][1] in the *Amazon RDS User Guide.*
|
@@ -788,9 +794,13 @@ module Aws::RDS
|
|
788
794
|
# @option options [String] :tde_credential_arn
|
789
795
|
# The ARN from the key store with which to associate the instance for
|
790
796
|
# TDE encryption.
|
797
|
+
#
|
798
|
+
# This setting doesn't apply to RDS Custom.
|
791
799
|
# @option options [String] :tde_credential_password
|
792
800
|
# The password for the given ARN from the key store in order to access
|
793
801
|
# the device.
|
802
|
+
#
|
803
|
+
# This setting doesn't apply to RDS Custom.
|
794
804
|
# @option options [Array<String>] :vpc_security_group_ids
|
795
805
|
# A list of EC2 VPC security groups to associate with this DB instance.
|
796
806
|
#
|
@@ -798,13 +808,15 @@ module Aws::RDS
|
|
798
808
|
# VPC.
|
799
809
|
# @option options [String] :domain
|
800
810
|
# Specify the Active Directory directory ID to restore the DB instance
|
801
|
-
# in. The domain must be created prior to this operation. Currently,
|
802
|
-
# only MySQL, Microsoft SQL Server, Oracle, and
|
803
|
-
#
|
811
|
+
# in. The domain/ must be created prior to this operation. Currently,
|
812
|
+
# you can create only MySQL, Microsoft SQL Server, Oracle, and
|
813
|
+
# PostgreSQL DB instances in an Active Directory Domain.
|
804
814
|
#
|
805
815
|
# For more information, see [ Kerberos Authentication][1] in the *Amazon
|
806
816
|
# RDS User Guide*.
|
807
817
|
#
|
818
|
+
# This setting doesn't apply to RDS Custom.
|
819
|
+
#
|
808
820
|
#
|
809
821
|
#
|
810
822
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/kerberos-authentication.html
|
@@ -815,6 +827,8 @@ module Aws::RDS
|
|
815
827
|
# @option options [String] :domain_iam_role_name
|
816
828
|
# Specify the name of the IAM role to be used when making API calls to
|
817
829
|
# the Directory Service.
|
830
|
+
#
|
831
|
+
# This setting doesn't apply to RDS Custom.
|
818
832
|
# @option options [Boolean] :enable_iam_database_authentication
|
819
833
|
# A value that indicates whether to enable mapping of Amazon Web
|
820
834
|
# Services Identity and Access Management (IAM) accounts to database
|
@@ -824,6 +838,8 @@ module Aws::RDS
|
|
824
838
|
# Database Authentication for MySQL and PostgreSQL][1] in the *Amazon
|
825
839
|
# RDS User Guide.*
|
826
840
|
#
|
841
|
+
# This setting doesn't apply to RDS Custom.
|
842
|
+
#
|
827
843
|
#
|
828
844
|
#
|
829
845
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.html
|
@@ -833,20 +849,28 @@ module Aws::RDS
|
|
833
849
|
# used. For more information, see [Publishing Database Logs to Amazon
|
834
850
|
# CloudWatch Logs][1] in the *Amazon RDS User Guide*.
|
835
851
|
#
|
852
|
+
# This setting doesn't apply to RDS Custom.
|
853
|
+
#
|
836
854
|
#
|
837
855
|
#
|
838
856
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch
|
839
857
|
# @option options [Array<Types::ProcessorFeature>] :processor_features
|
840
858
|
# The number of CPU cores and the number of threads per core for the DB
|
841
859
|
# instance class of the DB instance.
|
860
|
+
#
|
861
|
+
# This setting doesn't apply to RDS Custom.
|
842
862
|
# @option options [Boolean] :use_default_processor_features
|
843
863
|
# A value that indicates whether the DB instance class of the DB
|
844
864
|
# instance uses its default processor features.
|
865
|
+
#
|
866
|
+
# This setting doesn't apply to RDS Custom.
|
845
867
|
# @option options [String] :db_parameter_group_name
|
846
868
|
# The name of the DB parameter group to associate with this DB instance.
|
847
869
|
#
|
848
|
-
# If you
|
849
|
-
# default `DBParameterGroup` for the specified DB engine
|
870
|
+
# If you don't specify a value for `DBParameterGroupName`, then RDS
|
871
|
+
# uses the default `DBParameterGroup` for the specified DB engine.
|
872
|
+
#
|
873
|
+
# This setting doesn't apply to RDS Custom.
|
850
874
|
#
|
851
875
|
# Constraints:
|
852
876
|
#
|
@@ -875,6 +899,8 @@ module Aws::RDS
|
|
875
899
|
# a CoIP can provide lower latency for connections to the DB instance
|
876
900
|
# from outside of its virtual private cloud (VPC) on your local network.
|
877
901
|
#
|
902
|
+
# This setting doesn't apply to RDS Custom.
|
903
|
+
#
|
878
904
|
# For more information about RDS on Outposts, see [Working with Amazon
|
879
905
|
# RDS on Amazon Web Services Outposts][1] in the *Amazon RDS User
|
880
906
|
# Guide*.
|
@@ -886,6 +912,28 @@ module Aws::RDS
|
|
886
912
|
#
|
887
913
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html
|
888
914
|
# [2]: https://docs.aws.amazon.com/outposts/latest/userguide/outposts-networking-components.html#ip-addressing
|
915
|
+
# @option options [String] :custom_iam_instance_profile
|
916
|
+
# The instance profile associated with the underlying Amazon EC2
|
917
|
+
# instance of an RDS Custom DB instance. The instance profile must meet
|
918
|
+
# the following requirements:
|
919
|
+
#
|
920
|
+
# * The profile must exist in your account.
|
921
|
+
#
|
922
|
+
# * The profile must have an IAM role that Amazon EC2 has permissions to
|
923
|
+
# assume.
|
924
|
+
#
|
925
|
+
# * The instance profile name and the associated IAM role name must
|
926
|
+
# start with the prefix `AWSRDSCustom`.
|
927
|
+
#
|
928
|
+
# For the list of permissions required for the IAM role, see [ Configure
|
929
|
+
# IAM and your VPC][1] in the *Amazon Relational Database Service User
|
930
|
+
# Guide*.
|
931
|
+
#
|
932
|
+
# This setting is required for RDS Custom.
|
933
|
+
#
|
934
|
+
#
|
935
|
+
#
|
936
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-setup-orcl.html#custom-setup-orcl.iam-vpc
|
889
937
|
# @return [DBInstance]
|
890
938
|
def restore(options = {})
|
891
939
|
options = options.merge(db_snapshot_identifier: @snapshot_id)
|
data/lib/aws-sdk-rds/errors.rb
CHANGED
@@ -35,6 +35,9 @@ module Aws::RDS
|
|
35
35
|
# * {CustomAvailabilityZoneAlreadyExistsFault}
|
36
36
|
# * {CustomAvailabilityZoneNotFoundFault}
|
37
37
|
# * {CustomAvailabilityZoneQuotaExceededFault}
|
38
|
+
# * {CustomDBEngineVersionAlreadyExistsFault}
|
39
|
+
# * {CustomDBEngineVersionNotFoundFault}
|
40
|
+
# * {CustomDBEngineVersionQuotaExceededFault}
|
38
41
|
# * {DBClusterAlreadyExistsFault}
|
39
42
|
# * {DBClusterBacktrackNotFoundFault}
|
40
43
|
# * {DBClusterEndpointAlreadyExistsFault}
|
@@ -97,6 +100,7 @@ module Aws::RDS
|
|
97
100
|
# * {InsufficientDBClusterCapacityFault}
|
98
101
|
# * {InsufficientDBInstanceCapacityFault}
|
99
102
|
# * {InsufficientStorageClusterCapacityFault}
|
103
|
+
# * {InvalidCustomDBEngineVersionStateFault}
|
100
104
|
# * {InvalidDBClusterCapacityFault}
|
101
105
|
# * {InvalidDBClusterEndpointStateFault}
|
102
106
|
# * {InvalidDBClusterSnapshotStateFault}
|
@@ -231,6 +235,36 @@ module Aws::RDS
|
|
231
235
|
end
|
232
236
|
end
|
233
237
|
|
238
|
+
class CustomDBEngineVersionAlreadyExistsFault < ServiceError
|
239
|
+
|
240
|
+
# @param [Seahorse::Client::RequestContext] context
|
241
|
+
# @param [String] message
|
242
|
+
# @param [Aws::RDS::Types::CustomDBEngineVersionAlreadyExistsFault] data
|
243
|
+
def initialize(context, message, data = Aws::EmptyStructure.new)
|
244
|
+
super(context, message, data)
|
245
|
+
end
|
246
|
+
end
|
247
|
+
|
248
|
+
class CustomDBEngineVersionNotFoundFault < ServiceError
|
249
|
+
|
250
|
+
# @param [Seahorse::Client::RequestContext] context
|
251
|
+
# @param [String] message
|
252
|
+
# @param [Aws::RDS::Types::CustomDBEngineVersionNotFoundFault] data
|
253
|
+
def initialize(context, message, data = Aws::EmptyStructure.new)
|
254
|
+
super(context, message, data)
|
255
|
+
end
|
256
|
+
end
|
257
|
+
|
258
|
+
class CustomDBEngineVersionQuotaExceededFault < ServiceError
|
259
|
+
|
260
|
+
# @param [Seahorse::Client::RequestContext] context
|
261
|
+
# @param [String] message
|
262
|
+
# @param [Aws::RDS::Types::CustomDBEngineVersionQuotaExceededFault] data
|
263
|
+
def initialize(context, message, data = Aws::EmptyStructure.new)
|
264
|
+
super(context, message, data)
|
265
|
+
end
|
266
|
+
end
|
267
|
+
|
234
268
|
class DBClusterAlreadyExistsFault < ServiceError
|
235
269
|
|
236
270
|
# @param [Seahorse::Client::RequestContext] context
|
@@ -851,6 +885,16 @@ module Aws::RDS
|
|
851
885
|
end
|
852
886
|
end
|
853
887
|
|
888
|
+
class InvalidCustomDBEngineVersionStateFault < ServiceError
|
889
|
+
|
890
|
+
# @param [Seahorse::Client::RequestContext] context
|
891
|
+
# @param [String] message
|
892
|
+
# @param [Aws::RDS::Types::InvalidCustomDBEngineVersionStateFault] data
|
893
|
+
def initialize(context, message, data = Aws::EmptyStructure.new)
|
894
|
+
super(context, message, data)
|
895
|
+
end
|
896
|
+
end
|
897
|
+
|
854
898
|
class InvalidDBClusterCapacityFault < ServiceError
|
855
899
|
|
856
900
|
# @param [Seahorse::Client::RequestContext] context
|