aws-sdk-rds 1.127.0 → 1.131.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.
@@ -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 Amazon Web Services KMS customer
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 Amazon Web Services KMS
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 Amazon Web Services KMS CMK. If you don't specify a
449
- # value for this parameter, then the copy of the DB snapshot is
450
- # encrypted with the same Amazon Web Services KMS key as the source DB
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 a Amazon Web Services KMS key identifier
462
- # for the destination Amazon Web Services Region. Amazon Web Services
463
- # KMS CMKs are specific to the Amazon Web Services Region that they are
464
- # created in, and you can't use CMKs from one Amazon Web Services
465
- # Region in another Amazon Web Services Region.
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
- # customer master key (CMK) to use to encrypt the copy of the DB
507
- # snapshot in the destination Amazon Web Services Region. This is the
508
- # same identifier for both the `CopyDBSnapshot` action that is called
509
- # in the destination Amazon Web Services Region, and the action
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
@@ -679,6 +684,8 @@ 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
@@ -698,9 +705,14 @@ module Aws::RDS
698
705
  # @option options [Boolean] :auto_minor_version_upgrade
699
706
  # A value that indicates whether minor version upgrades are applied
700
707
  # automatically to the DB instance during the maintenance window.
708
+ #
709
+ # If you restore an RDS Custom DB instance, you must disable this
710
+ # parameter.
701
711
  # @option options [String] :license_model
702
712
  # License model information for the restored DB instance.
703
713
  #
714
+ # This setting doesn't apply to RDS Custom.
715
+ #
704
716
  # Default: Same as source.
705
717
  #
706
718
  # Valid values: `license-included` \| `bring-your-own-license` \|
@@ -708,13 +720,13 @@ module Aws::RDS
708
720
  # @option options [String] :db_name
709
721
  # The database name for the restored DB instance.
710
722
  #
711
- # <note markdown="1"> This parameter doesn't apply to the MySQL, PostgreSQL, or MariaDB
712
- # engines.
713
- #
714
- # </note>
723
+ # This parameter doesn't apply to the MySQL, PostgreSQL, or MariaDB
724
+ # engines. It also doesn't apply to RDS Custom DB instances.
715
725
  # @option options [String] :engine
716
726
  # The database engine to use for the new instance.
717
727
  #
728
+ # This setting doesn't apply to RDS Custom.
729
+ #
718
730
  # Default: The same as source
719
731
  #
720
732
  # Constraint: Must be compatible with the engine of the source. For
@@ -767,8 +779,10 @@ module Aws::RDS
767
779
  #
768
780
  # Permanent options, such as the TDE option for Oracle Advanced Security
769
781
  # TDE, can't be removed from an option group, and that option group
770
- # can't be removed from a DB instance once it is associated with a DB
771
- # instance
782
+ # can't be removed from a DB instance after it is associated with a DB
783
+ # instance.
784
+ #
785
+ # This setting doesn't apply to RDS Custom.
772
786
  # @option options [Array<Types::Tag>] :tags
773
787
  # A list of tags. For more information, see [Tagging Amazon RDS
774
788
  # Resources][1] in the *Amazon RDS User Guide.*
@@ -788,9 +802,13 @@ module Aws::RDS
788
802
  # @option options [String] :tde_credential_arn
789
803
  # The ARN from the key store with which to associate the instance for
790
804
  # TDE encryption.
805
+ #
806
+ # This setting doesn't apply to RDS Custom.
791
807
  # @option options [String] :tde_credential_password
792
808
  # The password for the given ARN from the key store in order to access
793
809
  # the device.
810
+ #
811
+ # This setting doesn't apply to RDS Custom.
794
812
  # @option options [Array<String>] :vpc_security_group_ids
795
813
  # A list of EC2 VPC security groups to associate with this DB instance.
796
814
  #
@@ -798,13 +816,15 @@ module Aws::RDS
798
816
  # VPC.
799
817
  # @option options [String] :domain
800
818
  # 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 PostgreSQL DB instances
803
- # can be created in an Active Directory Domain.
819
+ # in. The domain/ must be created prior to this operation. Currently,
820
+ # you can create only MySQL, Microsoft SQL Server, Oracle, and
821
+ # PostgreSQL DB instances in an Active Directory Domain.
804
822
  #
805
823
  # For more information, see [ Kerberos Authentication][1] in the *Amazon
806
824
  # RDS User Guide*.
807
825
  #
826
+ # This setting doesn't apply to RDS Custom.
827
+ #
808
828
  #
809
829
  #
810
830
  # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/kerberos-authentication.html
@@ -815,6 +835,8 @@ module Aws::RDS
815
835
  # @option options [String] :domain_iam_role_name
816
836
  # Specify the name of the IAM role to be used when making API calls to
817
837
  # the Directory Service.
838
+ #
839
+ # This setting doesn't apply to RDS Custom.
818
840
  # @option options [Boolean] :enable_iam_database_authentication
819
841
  # A value that indicates whether to enable mapping of Amazon Web
820
842
  # Services Identity and Access Management (IAM) accounts to database
@@ -824,6 +846,8 @@ module Aws::RDS
824
846
  # Database Authentication for MySQL and PostgreSQL][1] in the *Amazon
825
847
  # RDS User Guide.*
826
848
  #
849
+ # This setting doesn't apply to RDS Custom.
850
+ #
827
851
  #
828
852
  #
829
853
  # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.html
@@ -833,20 +857,28 @@ module Aws::RDS
833
857
  # used. For more information, see [Publishing Database Logs to Amazon
834
858
  # CloudWatch Logs][1] in the *Amazon RDS User Guide*.
835
859
  #
860
+ # This setting doesn't apply to RDS Custom.
861
+ #
836
862
  #
837
863
  #
838
864
  # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch
839
865
  # @option options [Array<Types::ProcessorFeature>] :processor_features
840
866
  # The number of CPU cores and the number of threads per core for the DB
841
867
  # instance class of the DB instance.
868
+ #
869
+ # This setting doesn't apply to RDS Custom.
842
870
  # @option options [Boolean] :use_default_processor_features
843
871
  # A value that indicates whether the DB instance class of the DB
844
872
  # instance uses its default processor features.
873
+ #
874
+ # This setting doesn't apply to RDS Custom.
845
875
  # @option options [String] :db_parameter_group_name
846
876
  # The name of the DB parameter group to associate with this DB instance.
847
877
  #
848
- # If you do not specify a value for `DBParameterGroupName`, then the
849
- # default `DBParameterGroup` for the specified DB engine is used.
878
+ # If you don't specify a value for `DBParameterGroupName`, then RDS
879
+ # uses the default `DBParameterGroup` for the specified DB engine.
880
+ #
881
+ # This setting doesn't apply to RDS Custom.
850
882
  #
851
883
  # Constraints:
852
884
  #
@@ -875,6 +907,8 @@ module Aws::RDS
875
907
  # a CoIP can provide lower latency for connections to the DB instance
876
908
  # from outside of its virtual private cloud (VPC) on your local network.
877
909
  #
910
+ # This setting doesn't apply to RDS Custom.
911
+ #
878
912
  # For more information about RDS on Outposts, see [Working with Amazon
879
913
  # RDS on Amazon Web Services Outposts][1] in the *Amazon RDS User
880
914
  # Guide*.
@@ -886,6 +920,41 @@ module Aws::RDS
886
920
  #
887
921
  # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html
888
922
  # [2]: https://docs.aws.amazon.com/outposts/latest/userguide/outposts-networking-components.html#ip-addressing
923
+ # @option options [String] :custom_iam_instance_profile
924
+ # The instance profile associated with the underlying Amazon EC2
925
+ # instance of an RDS Custom DB instance. The instance profile must meet
926
+ # the following requirements:
927
+ #
928
+ # * The profile must exist in your account.
929
+ #
930
+ # * The profile must have an IAM role that Amazon EC2 has permissions to
931
+ # assume.
932
+ #
933
+ # * The instance profile name and the associated IAM role name must
934
+ # start with the prefix `AWSRDSCustom`.
935
+ #
936
+ # For the list of permissions required for the IAM role, see [ Configure
937
+ # IAM and your VPC][1] in the *Amazon Relational Database Service User
938
+ # Guide*.
939
+ #
940
+ # This setting is required for RDS Custom.
941
+ #
942
+ #
943
+ #
944
+ # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-setup-orcl.html#custom-setup-orcl.iam-vpc
945
+ # @option options [String] :backup_target
946
+ # Specifies where automated backups and manual snapshots are stored for
947
+ # the restored DB instance.
948
+ #
949
+ # Possible values are `outposts` (Amazon Web Services Outposts) and
950
+ # `region` (Amazon Web Services Region). The default is `region`.
951
+ #
952
+ # For more information, see [Working with Amazon RDS on Amazon Web
953
+ # Services Outposts][1] in the *Amazon RDS User Guide*.
954
+ #
955
+ #
956
+ #
957
+ # [1]: https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html
889
958
  # @return [DBInstance]
890
959
  def restore(options = {})
891
960
  options = options.merge(db_snapshot_identifier: @snapshot_id)
@@ -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(