aws-sdk-rds 1.128.0 → 1.132.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/CHANGELOG.md +20 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-rds/client.rb +2812 -633
- data/lib/aws-sdk-rds/client_api.rb +158 -0
- data/lib/aws-sdk-rds/db_cluster.rb +757 -99
- data/lib/aws-sdk-rds/db_cluster_parameter_group.rb +12 -0
- data/lib/aws-sdk-rds/db_cluster_snapshot.rb +186 -38
- 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 +622 -252
- data/lib/aws-sdk-rds/db_snapshot.rb +111 -41
- data/lib/aws-sdk-rds/errors.rb +44 -0
- data/lib/aws-sdk-rds/plugins/cross_region_copying.rb +5 -1
- data/lib/aws-sdk-rds/resource.rb +542 -160
- data/lib/aws-sdk-rds/types.rb +2805 -614
- data/lib/aws-sdk-rds.rb +1 -1
- metadata +4 -4
@@ -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]
|
@@ -238,6 +237,13 @@ module Aws::RDS
|
|
238
237
|
data[:original_snapshot_create_time]
|
239
238
|
end
|
240
239
|
|
240
|
+
# Specifies where manual snapshots are stored: Amazon Web Services
|
241
|
+
# Outposts or the Amazon Web Services Region.
|
242
|
+
# @return [String]
|
243
|
+
def snapshot_target
|
244
|
+
data[:snapshot_target]
|
245
|
+
end
|
246
|
+
|
241
247
|
# @!endgroup
|
242
248
|
|
243
249
|
# @return [Client]
|
@@ -440,15 +446,13 @@ module Aws::RDS
|
|
440
446
|
# @option options [String] :kms_key_id
|
441
447
|
# The Amazon Web Services KMS key identifier for an encrypted DB
|
442
448
|
# 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).
|
449
|
+
# key ID, alias ARN, or alias name for the KMS key.
|
445
450
|
#
|
446
451
|
# If you copy an encrypted DB snapshot from your Amazon Web Services
|
447
452
|
# account, you can specify a value for this parameter to encrypt the
|
448
|
-
# copy with a new
|
449
|
-
#
|
450
|
-
#
|
451
|
-
# snapshot.
|
453
|
+
# copy with a new KMS key. If you don't specify a value for this
|
454
|
+
# parameter, then the copy of the DB snapshot is encrypted with the same
|
455
|
+
# Amazon Web Services KMS key as the source DB snapshot.
|
452
456
|
#
|
453
457
|
# If you copy an encrypted DB snapshot that is shared from another
|
454
458
|
# Amazon Web Services account, then you must specify a value for this
|
@@ -458,11 +462,11 @@ module Aws::RDS
|
|
458
462
|
# the copy is encrypted.
|
459
463
|
#
|
460
464
|
# 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
|
-
#
|
465
|
+
# Region, then you must specify an Amazon Web Services KMS key
|
466
|
+
# identifier for the destination Amazon Web Services Region. KMS keys
|
467
|
+
# are specific to the Amazon Web Services Region that they are created
|
468
|
+
# in, and you can't use KMS keys from one Amazon Web Services Region in
|
469
|
+
# another Amazon Web Services Region.
|
466
470
|
# @option options [Array<Types::Tag>] :tags
|
467
471
|
# A list of tags. For more information, see [Tagging Amazon RDS
|
468
472
|
# Resources][1] in the *Amazon RDS User Guide.*
|
@@ -502,12 +506,11 @@ module Aws::RDS
|
|
502
506
|
# presigned URL must be set to the us-east-1 Amazon Web Services
|
503
507
|
# Region.
|
504
508
|
#
|
505
|
-
# * `KmsKeyId` - The Amazon Web Services KMS key identifier for the
|
506
|
-
#
|
507
|
-
#
|
508
|
-
#
|
509
|
-
#
|
510
|
-
# contained in the presigned URL.
|
509
|
+
# * `KmsKeyId` - The Amazon Web Services KMS key identifier for the KMS
|
510
|
+
# key to use to encrypt the copy of the DB snapshot in the destination
|
511
|
+
# Amazon Web Services Region. This is the same identifier for both the
|
512
|
+
# `CopyDBSnapshot` action that is called in the destination Amazon Web
|
513
|
+
# Services Region, and the action contained in the presigned URL.
|
511
514
|
#
|
512
515
|
# * `SourceDBSnapshotIdentifier` - The DB snapshot identifier for the
|
513
516
|
# encrypted snapshot to be copied. This identifier must be in the
|
@@ -626,6 +629,8 @@ module Aws::RDS
|
|
626
629
|
# db_parameter_group_name: "String",
|
627
630
|
# deletion_protection: false,
|
628
631
|
# enable_customer_owned_ip: false,
|
632
|
+
# custom_iam_instance_profile: "String",
|
633
|
+
# backup_target: "String",
|
629
634
|
# })
|
630
635
|
# @param [Hash] options ({})
|
631
636
|
# @option options [required, String] :db_instance_identifier
|
@@ -643,10 +648,10 @@ module Aws::RDS
|
|
643
648
|
# Example: `my-snapshot-id`
|
644
649
|
# @option options [String] :db_instance_class
|
645
650
|
# The compute and memory capacity of the Amazon RDS DB instance, for
|
646
|
-
# example
|
647
|
-
#
|
648
|
-
#
|
649
|
-
#
|
651
|
+
# example db.m4.large. Not all DB instance classes are available in all
|
652
|
+
# Amazon Web Services Regions, or for all database engines. For the full
|
653
|
+
# list of DB instance classes, and availability for your engine, see [DB
|
654
|
+
# Instance Class][1] in the *Amazon RDS User Guide.*
|
650
655
|
#
|
651
656
|
# Default: The same DBInstanceClass as the original DB instance.
|
652
657
|
#
|
@@ -679,17 +684,20 @@ module Aws::RDS
|
|
679
684
|
# A value that indicates whether the DB instance is a Multi-AZ
|
680
685
|
# deployment.
|
681
686
|
#
|
687
|
+
# This setting doesn't apply to RDS Custom.
|
688
|
+
#
|
682
689
|
# Constraint: You can't specify the `AvailabilityZone` parameter if the
|
683
690
|
# DB instance is a Multi-AZ deployment.
|
684
691
|
# @option options [Boolean] :publicly_accessible
|
685
692
|
# A value that indicates whether the DB instance is publicly accessible.
|
686
693
|
#
|
687
|
-
# When the DB instance is publicly accessible, its
|
688
|
-
# to the private IP address from within the DB
|
689
|
-
#
|
690
|
-
#
|
691
|
-
#
|
692
|
-
#
|
694
|
+
# When the DB instance is publicly accessible, its Domain Name System
|
695
|
+
# (DNS) endpoint resolves to the private IP address from within the DB
|
696
|
+
# instance's virtual private cloud (VPC). It resolves to the public IP
|
697
|
+
# address from outside of the DB instance's VPC. Access to the DB
|
698
|
+
# instance is ultimately controlled by the security group it uses. That
|
699
|
+
# public access is not permitted if the security group assigned to the
|
700
|
+
# DB instance doesn't permit it.
|
693
701
|
#
|
694
702
|
# When the DB instance isn't publicly accessible, it is an internal DB
|
695
703
|
# instance with a DNS name that resolves to a private IP address.
|
@@ -698,9 +706,14 @@ module Aws::RDS
|
|
698
706
|
# @option options [Boolean] :auto_minor_version_upgrade
|
699
707
|
# A value that indicates whether minor version upgrades are applied
|
700
708
|
# automatically to the DB instance during the maintenance window.
|
709
|
+
#
|
710
|
+
# If you restore an RDS Custom DB instance, you must disable this
|
711
|
+
# parameter.
|
701
712
|
# @option options [String] :license_model
|
702
713
|
# License model information for the restored DB instance.
|
703
714
|
#
|
715
|
+
# This setting doesn't apply to RDS Custom.
|
716
|
+
#
|
704
717
|
# Default: Same as source.
|
705
718
|
#
|
706
719
|
# Valid values: `license-included` \| `bring-your-own-license` \|
|
@@ -708,13 +721,13 @@ module Aws::RDS
|
|
708
721
|
# @option options [String] :db_name
|
709
722
|
# The database name for the restored DB instance.
|
710
723
|
#
|
711
|
-
#
|
712
|
-
# engines.
|
713
|
-
#
|
714
|
-
# </note>
|
724
|
+
# This parameter doesn't apply to the MySQL, PostgreSQL, or MariaDB
|
725
|
+
# engines. It also doesn't apply to RDS Custom DB instances.
|
715
726
|
# @option options [String] :engine
|
716
727
|
# The database engine to use for the new instance.
|
717
728
|
#
|
729
|
+
# This setting doesn't apply to RDS Custom.
|
730
|
+
#
|
718
731
|
# Default: The same as source
|
719
732
|
#
|
720
733
|
# Constraint: Must be compatible with the engine of the source. For
|
@@ -767,8 +780,10 @@ module Aws::RDS
|
|
767
780
|
#
|
768
781
|
# Permanent options, such as the TDE option for Oracle Advanced Security
|
769
782
|
# TDE, can't be removed from an option group, and that option group
|
770
|
-
# can't be removed from a DB instance
|
771
|
-
# instance
|
783
|
+
# can't be removed from a DB instance after it is associated with a DB
|
784
|
+
# instance.
|
785
|
+
#
|
786
|
+
# This setting doesn't apply to RDS Custom.
|
772
787
|
# @option options [Array<Types::Tag>] :tags
|
773
788
|
# A list of tags. For more information, see [Tagging Amazon RDS
|
774
789
|
# Resources][1] in the *Amazon RDS User Guide.*
|
@@ -788,9 +803,13 @@ module Aws::RDS
|
|
788
803
|
# @option options [String] :tde_credential_arn
|
789
804
|
# The ARN from the key store with which to associate the instance for
|
790
805
|
# TDE encryption.
|
806
|
+
#
|
807
|
+
# This setting doesn't apply to RDS Custom.
|
791
808
|
# @option options [String] :tde_credential_password
|
792
809
|
# The password for the given ARN from the key store in order to access
|
793
810
|
# the device.
|
811
|
+
#
|
812
|
+
# This setting doesn't apply to RDS Custom.
|
794
813
|
# @option options [Array<String>] :vpc_security_group_ids
|
795
814
|
# A list of EC2 VPC security groups to associate with this DB instance.
|
796
815
|
#
|
@@ -798,13 +817,15 @@ module Aws::RDS
|
|
798
817
|
# VPC.
|
799
818
|
# @option options [String] :domain
|
800
819
|
# 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
|
-
#
|
820
|
+
# in. The domain/ must be created prior to this operation. Currently,
|
821
|
+
# you can create only MySQL, Microsoft SQL Server, Oracle, and
|
822
|
+
# PostgreSQL DB instances in an Active Directory Domain.
|
804
823
|
#
|
805
824
|
# For more information, see [ Kerberos Authentication][1] in the *Amazon
|
806
825
|
# RDS User Guide*.
|
807
826
|
#
|
827
|
+
# This setting doesn't apply to RDS Custom.
|
828
|
+
#
|
808
829
|
#
|
809
830
|
#
|
810
831
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/kerberos-authentication.html
|
@@ -815,6 +836,8 @@ module Aws::RDS
|
|
815
836
|
# @option options [String] :domain_iam_role_name
|
816
837
|
# Specify the name of the IAM role to be used when making API calls to
|
817
838
|
# the Directory Service.
|
839
|
+
#
|
840
|
+
# This setting doesn't apply to RDS Custom.
|
818
841
|
# @option options [Boolean] :enable_iam_database_authentication
|
819
842
|
# A value that indicates whether to enable mapping of Amazon Web
|
820
843
|
# Services Identity and Access Management (IAM) accounts to database
|
@@ -824,6 +847,8 @@ module Aws::RDS
|
|
824
847
|
# Database Authentication for MySQL and PostgreSQL][1] in the *Amazon
|
825
848
|
# RDS User Guide.*
|
826
849
|
#
|
850
|
+
# This setting doesn't apply to RDS Custom.
|
851
|
+
#
|
827
852
|
#
|
828
853
|
#
|
829
854
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.html
|
@@ -833,20 +858,28 @@ module Aws::RDS
|
|
833
858
|
# used. For more information, see [Publishing Database Logs to Amazon
|
834
859
|
# CloudWatch Logs][1] in the *Amazon RDS User Guide*.
|
835
860
|
#
|
861
|
+
# This setting doesn't apply to RDS Custom.
|
862
|
+
#
|
836
863
|
#
|
837
864
|
#
|
838
865
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch
|
839
866
|
# @option options [Array<Types::ProcessorFeature>] :processor_features
|
840
867
|
# The number of CPU cores and the number of threads per core for the DB
|
841
868
|
# instance class of the DB instance.
|
869
|
+
#
|
870
|
+
# This setting doesn't apply to RDS Custom.
|
842
871
|
# @option options [Boolean] :use_default_processor_features
|
843
872
|
# A value that indicates whether the DB instance class of the DB
|
844
873
|
# instance uses its default processor features.
|
874
|
+
#
|
875
|
+
# This setting doesn't apply to RDS Custom.
|
845
876
|
# @option options [String] :db_parameter_group_name
|
846
877
|
# The name of the DB parameter group to associate with this DB instance.
|
847
878
|
#
|
848
|
-
# If you
|
849
|
-
# default `DBParameterGroup` for the specified DB engine
|
879
|
+
# If you don't specify a value for `DBParameterGroupName`, then RDS
|
880
|
+
# uses the default `DBParameterGroup` for the specified DB engine.
|
881
|
+
#
|
882
|
+
# This setting doesn't apply to RDS Custom.
|
850
883
|
#
|
851
884
|
# Constraints:
|
852
885
|
#
|
@@ -860,7 +893,7 @@ module Aws::RDS
|
|
860
893
|
# @option options [Boolean] :deletion_protection
|
861
894
|
# A value that indicates whether the DB instance has deletion protection
|
862
895
|
# enabled. The database can't be deleted when deletion protection is
|
863
|
-
# enabled. By default, deletion protection
|
896
|
+
# enabled. By default, deletion protection isn't enabled. For more
|
864
897
|
# information, see [ Deleting a DB Instance][1].
|
865
898
|
#
|
866
899
|
#
|
@@ -875,6 +908,8 @@ module Aws::RDS
|
|
875
908
|
# a CoIP can provide lower latency for connections to the DB instance
|
876
909
|
# from outside of its virtual private cloud (VPC) on your local network.
|
877
910
|
#
|
911
|
+
# This setting doesn't apply to RDS Custom.
|
912
|
+
#
|
878
913
|
# For more information about RDS on Outposts, see [Working with Amazon
|
879
914
|
# RDS on Amazon Web Services Outposts][1] in the *Amazon RDS User
|
880
915
|
# Guide*.
|
@@ -886,6 +921,41 @@ module Aws::RDS
|
|
886
921
|
#
|
887
922
|
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html
|
888
923
|
# [2]: https://docs.aws.amazon.com/outposts/latest/userguide/outposts-networking-components.html#ip-addressing
|
924
|
+
# @option options [String] :custom_iam_instance_profile
|
925
|
+
# The instance profile associated with the underlying Amazon EC2
|
926
|
+
# instance of an RDS Custom DB instance. The instance profile must meet
|
927
|
+
# the following requirements:
|
928
|
+
#
|
929
|
+
# * The profile must exist in your account.
|
930
|
+
#
|
931
|
+
# * The profile must have an IAM role that Amazon EC2 has permissions to
|
932
|
+
# assume.
|
933
|
+
#
|
934
|
+
# * The instance profile name and the associated IAM role name must
|
935
|
+
# start with the prefix `AWSRDSCustom`.
|
936
|
+
#
|
937
|
+
# For the list of permissions required for the IAM role, see [ Configure
|
938
|
+
# IAM and your VPC][1] in the *Amazon Relational Database Service User
|
939
|
+
# Guide*.
|
940
|
+
#
|
941
|
+
# This setting is required for RDS Custom.
|
942
|
+
#
|
943
|
+
#
|
944
|
+
#
|
945
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-setup-orcl.html#custom-setup-orcl.iam-vpc
|
946
|
+
# @option options [String] :backup_target
|
947
|
+
# Specifies where automated backups and manual snapshots are stored for
|
948
|
+
# the restored DB instance.
|
949
|
+
#
|
950
|
+
# Possible values are `outposts` (Amazon Web Services Outposts) and
|
951
|
+
# `region` (Amazon Web Services Region). The default is `region`.
|
952
|
+
#
|
953
|
+
# For more information, see [Working with Amazon RDS on Amazon Web
|
954
|
+
# Services Outposts][1] in the *Amazon RDS User Guide*.
|
955
|
+
#
|
956
|
+
#
|
957
|
+
#
|
958
|
+
# [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html
|
889
959
|
# @return [DBInstance]
|
890
960
|
def restore(options = {})
|
891
961
|
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
|
@@ -42,7 +42,11 @@ module Aws
|
|
42
42
|
credentials_provider: context.config.credentials
|
43
43
|
)
|
44
44
|
url = Aws::Partitions::EndpointProvider.resolve(
|
45
|
-
signer.region, 'rds'
|
45
|
+
signer.region, 'rds', 'regional',
|
46
|
+
{
|
47
|
+
dualstack: context.config.use_dualstack_endpoint,
|
48
|
+
fips: context.config.use_fips_endpoint
|
49
|
+
}
|
46
50
|
)
|
47
51
|
url += "?#{param_list}"
|
48
52
|
signer.presign_url(
|