aws-sdk-docdb 1.21.0 → 1.27.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b2294ff131428a60a2a2fe34c66cb4e5917559fdabe882f166fd323b6ad386c4
-  data.tar.gz: 7a1c7ed233ccb81887612f4c65446de3c12a94f4f47bc5f437de8e7ef882042e
+  metadata.gz: 935d4281c9928da301f3335928b984c21d61bfc0c5e87576687d5c5e358a2828
+  data.tar.gz: a1032acf3a2572abfe970c5e37fa4cbd40633fae4d1983638207098be9434fb8
 SHA512:
-  metadata.gz: ea938b4e43deab8e86bbc8440c31dbf2cf5e229f21612bb03e1de6fbd56f2f2872cbb436f3e702c5301c9383d03970a00be1c584c7d9b3e3e96a510dfc6a5e90
-  data.tar.gz: 1f95556d7939e9f26b7c4efd1c59f8685f8766b30212b9a2fdbb04fd7deda052e3377998445bdb4c37e2b4363991a5648f4d1b8099a685578b03abe453f6f815
+  metadata.gz: bf00ef31a82b3cba643a12477b3d9b692cdbe98146ad5ea36937cfc1b20ad07a89c6b81a284cf12428ac183e05a4a5227f90d495db3ab341ed0e88db1af48575
+  data.tar.gz: cbadb52070a7657e1b46f5b9f9a46ad8339792f2234a800bff6256af58237ab2297de10b70ce8c8f239f201c0f23c78937d9292784cf357e432ec0e80be96c01

data/lib/aws-sdk-docdb.rb

@@ -7,6 +7,7 @@
 #
 # WARNING ABOUT GENERATED CODE
 
+
 require 'aws-sdk-core'
 require 'aws-sigv4'
 
@@ -48,6 +49,6 @@ require_relative 'aws-sdk-docdb/customizations'
 # @!group service
 module Aws::DocDB
 
-  GEM_VERSION = '1.21.0'
+  GEM_VERSION = '1.27.0'
 
 end

data/lib/aws-sdk-docdb/client.rb

@@ -29,6 +29,7 @@ require 'aws-sdk-core/plugins/transfer_encoding.rb'
 require 'aws-sdk-core/plugins/http_checksum.rb'
 require 'aws-sdk-core/plugins/signature_v4.rb'
 require 'aws-sdk-core/plugins/protocols/query.rb'
+require 'aws-sdk-docdb/plugins/cross_region_copying.rb'
 
 Aws::Plugins::GlobalConfiguration.add_identifier(:docdb)
 
@@ -75,6 +76,7 @@ module Aws::DocDB
     add_plugin(Aws::Plugins::HttpChecksum)
     add_plugin(Aws::Plugins::SignatureV4)
     add_plugin(Aws::Plugins::Protocols::Query)
+    add_plugin(Aws::DocDB::Plugins::CrossRegionCopying)
 
     # @overload initialize(options)
     #   @param [Hash] options
@@ -334,7 +336,7 @@ module Aws::DocDB
     #
     # @option params [required, String] :resource_name
     #   The Amazon DocumentDB resource that the tags are added to. This value
-    #   is an Amazon Resource Name (ARN).
+    #   is an Amazon Resource Name .
     #
     # @option params [required, Array<Types::Tag>] :tags
     #   The tags to be assigned to the Amazon DocumentDB resource.
@@ -362,8 +364,8 @@ module Aws::DocDB
       req.send_request(options)
     end
 
-    # Applies a pending maintenance action to a resource (for example, to a
-    # DB instance).
+    # Applies a pending maintenance action to a resource (for example, to an
+    # Amazon DocumentDB instance).
     #
     # @option params [required, String] :resource_identifier
     #   The Amazon Resource Name (ARN) of the resource that the pending
@@ -436,7 +438,7 @@ module Aws::DocDB
     #
     #   * If the source parameter group is in a different AWS Region than the
     #     copy, specify a valid cluster parameter group ARN; for example,
-    #     `arn:aws:rds:us-east-1:123456789012:cluster-pg:custom-cluster-group1`.
+    #     `arn:aws:rds:us-east-1:123456789012:sample-cluster:sample-parameter-group`.
     #
     # @option params [required, String] :target_db_cluster_parameter_group_identifier
     #   The identifier for the copied cluster parameter group.
@@ -497,23 +499,21 @@ module Aws::DocDB
     #
     # To copy a cluster snapshot from a shared manual cluster snapshot,
     # `SourceDBClusterSnapshotIdentifier` must be the Amazon Resource Name
-    # (ARN) of the shared cluster snapshot.
+    # (ARN) of the shared cluster snapshot. You can only copy a shared DB
+    # cluster snapshot, whether encrypted or not, in the same AWS Region.
     #
     # To cancel the copy operation after it is in progress, delete the
     # target cluster snapshot identified by
-    # `TargetDBClusterSnapshotIdentifier` while that DB cluster snapshot is
-    # in the *copying* status.
+    # `TargetDBClusterSnapshotIdentifier` while that cluster snapshot is in
+    # the *copying* status.
     #
     # @option params [required, String] :source_db_cluster_snapshot_identifier
     #   The identifier of the cluster snapshot to copy. This parameter is not
     #   case sensitive.
     #
-    #   You can't copy an encrypted, shared cluster snapshot from one AWS
-    #   Region to another.
-    #
     #   Constraints:
     #
-    #   * Must specify a valid system snapshot in the "available" state.
+    #   * Must specify a valid system snapshot in the *available* state.
     #
     #   * If the source snapshot is in the same AWS Region as the copy,
     #     specify a valid snapshot identifier.
@@ -555,8 +555,8 @@ module Aws::DocDB
     #   `KmsKeyId` to the AWS KMS key ID that you want to use to encrypt the
     #   copy of the cluster snapshot in the destination Region. AWS KMS
     #   encryption keys are specific to the AWS Region that they are created
-    #   in, and you can't use encryption keys from one Region in another
-    #   Region.
+    #   in, and you can't use encryption keys from one AWS Region in another
+    #   AWS Region.
     #
     #   If you copy an unencrypted cluster snapshot and specify a value for
     #   the `KmsKeyId` parameter, an error is returned.
@@ -565,32 +565,33 @@ module Aws::DocDB
     #   The URL that contains a Signature Version 4 signed request for the
     #   `CopyDBClusterSnapshot` API action in the AWS Region that contains the
     #   source cluster snapshot to copy. You must use the `PreSignedUrl`
-    #   parameter when copying an encrypted cluster snapshot from another AWS
-    #   Region.
+    #   parameter when copying a cluster snapshot from another AWS Region.
+    #
+    #   If you are using an AWS SDK tool or the AWS CLI, you can specify
+    #   `SourceRegion` (or `--source-region` for the AWS CLI) instead of
+    #   specifying `PreSignedUrl` manually. Specifying `SourceRegion`
+    #   autogenerates a pre-signed URL that is a valid request for the
+    #   operation that can be executed in the source AWS Region.
     #
     #   The presigned URL must be a valid request for the
-    #   `CopyDBSClusterSnapshot` API action that can be executed in the source
-    #   AWS Region that contains the encrypted DB cluster snapshot to be
-    #   copied. The presigned URL request must contain the following parameter
-    #   values:
-    #
-    #   * `KmsKeyId` - The AWS KMS key identifier for the key to use to
-    #     encrypt the copy of the cluster snapshot in the destination AWS
-    #     Region. This is the same identifier for both the
-    #     `CopyDBClusterSnapshot` action that is called in the destination AWS
-    #     Region, and the action contained in the presigned URL.
-    #
-    #   * `DestinationRegion` - The name of the AWS Region that the DB cluster
-    #     snapshot will be created in.
-    #
-    #   * `SourceDBClusterSnapshotIdentifier` - The cluster snapshot
-    #     identifier for the encrypted cluster snapshot to be copied. This
-    #     identifier must be in the Amazon Resource Name (ARN) format for the
-    #     source AWS Region. For example, if you are copying an encrypted
-    #     cluster snapshot from the us-west-2 AWS Region, then your
-    #     `SourceDBClusterSnapshotIdentifier` looks like the following
-    #     example:
-    #     `arn:aws:rds:us-west-2:123456789012:cluster-snapshot:my-cluster-snapshot-20161115`.
+    #   `CopyDBClusterSnapshot` API action that can be executed in the source
+    #   AWS Region that contains the cluster snapshot to be copied. The
+    #   presigned URL request must contain the following parameter values:
+    #
+    #   * `SourceRegion` - The ID of the region that contains the snapshot to
+    #     be copied.
+    #
+    #   * `SourceDBClusterSnapshotIdentifier` - The identifier for the the
+    #     encrypted cluster snapshot to be copied. This identifier must be in
+    #     the Amazon Resource Name (ARN) format for the source AWS Region. For
+    #     example, if you are copying an encrypted cluster snapshot from the
+    #     us-east-1 AWS Region, then your `SourceDBClusterSnapshotIdentifier`
+    #     looks something like the following:
+    #     `arn:aws:rds:us-east-1:12345678012:sample-cluster:sample-cluster-snapshot`.
+    #
+    #   * `TargetDBClusterSnapshotIdentifier` - The identifier for the new
+    #     cluster snapshot to be created. This parameter isn't case
+    #     sensitive.
     #
     # @option params [Boolean] :copy_tags
     #   Set to `true` to copy all tags from the source cluster snapshot to the
@@ -600,6 +601,10 @@ module Aws::DocDB
     # @option params [Array<Types::Tag>] :tags
     #   The tags to be assigned to the cluster snapshot.
     #
+    # @option params [String] :source_region
+    #   The source region of the snapshot. This is only needed when the
+    #   shapshot is encrypted and in a different region.
+    #
     # @return [Types::CopyDBClusterSnapshotResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
     #   * {Types::CopyDBClusterSnapshotResult#db_cluster_snapshot #db_cluster_snapshot} => Types::DBClusterSnapshot
@@ -618,6 +623,7 @@ module Aws::DocDB
     #         value: "String",
     #       },
     #     ],
+    #     source_region: "String",
     #   })
     #
     # @example Response structure
@@ -703,7 +709,10 @@ module Aws::DocDB
     #   Valid values: `docdb`
     #
     # @option params [String] :engine_version
-    #   The version number of the database engine to use.
+    #   The version number of the database engine to use. The --engine-version
+    #   will default to the latest major engine version. For production
+    #   workloads, we recommend explicitly declaring this parameter with the
+    #   intended major engine version.
     #
     # @option params [Integer] :port
     #   The port number on which the instances in the cluster accept
@@ -776,27 +785,28 @@ module Aws::DocDB
     #
     #   If an encryption key is not specified in `KmsKeyId`\:
     #
-    #   * If `ReplicationSourceIdentifier` identifies an encrypted source,
-    #     then Amazon DocumentDB uses the encryption key that is used to
-    #     encrypt the source. Otherwise, Amazon DocumentDB uses your default
-    #     encryption key.
-    #
-    #   * If the `StorageEncrypted` parameter is `true` and
-    #     `ReplicationSourceIdentifier` is not specified, Amazon DocumentDB
+    #   * If the `StorageEncrypted` parameter is `true`, Amazon DocumentDB
     #     uses your default encryption key.
     #
+    #   ^
+    #
     #   AWS KMS creates the default encryption key for your AWS account. Your
     #   AWS account has a different default encryption key for each AWS
     #   Region.
     #
-    #   If you create a replica of an encrypted cluster in another AWS Region,
-    #   you must set `KmsKeyId` to a KMS key ID that is valid in the
-    #   destination AWS Region. This key is used to encrypt the replica in
-    #   that AWS Region.
+    # @option params [String] :pre_signed_url
+    #   Not currently supported.
     #
     # @option params [Array<String>] :enable_cloudwatch_logs_exports
     #   A list of log types that need to be enabled for exporting to Amazon
-    #   CloudWatch Logs.
+    #   CloudWatch Logs. You can enable audit logs or profiler logs. For more
+    #   information, see [ Auditing Amazon DocumentDB Events][1] and [
+    #   Profiling Amazon DocumentDB Operations][2].
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/documentdb/latest/developerguide/event-auditing.html
+    #   [2]: https://docs.aws.amazon.com/documentdb/latest/developerguide/profiling.html
     #
     # @option params [Boolean] :deletion_protection
     #   Specifies whether this cluster can be deleted. If `DeletionProtection`
@@ -804,6 +814,10 @@ module Aws::DocDB
     #   `DeletionProtection` is disabled. `DeletionProtection` protects
     #   clusters from being accidentally deleted.
     #
+    # @option params [String] :source_region
+    #   The source region of the snapshot. This is only needed when the
+    #   shapshot is encrypted and in a different region.
+    #
     # @return [Types::CreateDBClusterResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
     #   * {Types::CreateDBClusterResult#db_cluster #db_cluster} => Types::DBCluster
@@ -832,8 +846,10 @@ module Aws::DocDB
     #     ],
     #     storage_encrypted: false,
     #     kms_key_id: "String",
+    #     pre_signed_url: "String",
     #     enable_cloudwatch_logs_exports: ["String"],
     #     deletion_protection: false,
+    #     source_region: "String",
     #   })
     #
     # @example Response structure
@@ -890,24 +906,26 @@ module Aws::DocDB
     # Creates a new cluster parameter group.
     #
     # Parameters in a cluster parameter group apply to all of the instances
-    # in a DB cluster.
+    # in a cluster.
     #
     # A cluster parameter group is initially created with the default
     # parameters for the database engine used by instances in the cluster.
-    # To provide custom values for any of the parameters, you must modify
-    # the group after you create it. After you create a DB cluster parameter
-    # group, you must associate it with your cluster. For the new DB cluster
-    # parameter group and associated settings to take effect, you must then
-    # reboot the instances in the cluster without failover.
+    # In Amazon DocumentDB, you cannot make modifications directly to the
+    # `default.docdb3.6` cluster parameter group. If your Amazon DocumentDB
+    # cluster is using the default cluster parameter group and you want to
+    # modify a value in it, you must first [ create a new parameter
+    # group][1] or [ copy an existing parameter group][2], modify it, and
+    # then apply the modified parameter group to your cluster. For the new
+    # cluster parameter group and associated settings to take effect, you
+    # must then reboot the instances in the cluster without failover. For
+    # more information, see [ Modifying Amazon DocumentDB Cluster Parameter
+    # Groups][3].
     #
-    # After you create a cluster parameter group, you should wait at least 5
-    # minutes before creating your first cluster that uses that cluster
-    # parameter group as the default parameter group. This allows Amazon
-    # DocumentDB to fully complete the create action before the cluster
-    # parameter group is used as the default for a new cluster. This step is
-    # especially important for parameters that are critical when creating
-    # the default database for a cluster, such as the character set for the
-    # default database defined by the `character_set_database` parameter.
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/documentdb/latest/developerguide/cluster_parameter_group-create.html
+    # [2]: https://docs.aws.amazon.com/documentdb/latest/developerguide/cluster_parameter_group-copy.html
+    # [3]: https://docs.aws.amazon.com/documentdb/latest/developerguide/cluster_parameter_group-modify.html
     #
     # @option params [required, String] :db_cluster_parameter_group_name
     #   The name of the cluster parameter group.
@@ -1076,10 +1094,6 @@ module Aws::DocDB
     #
     #   Example: `us-east-1d`
     #
-    #   Constraint: The `AvailabilityZone` parameter can't be specified if
-    #   the `MultiAZ` parameter is set to `true`. The specified Availability
-    #   Zone must be in the same AWS Region as the current endpoint.
-    #
     # @option params [String] :preferred_maintenance_window
     #   The time range each week during which system maintenance can occur, in
     #   Universal Coordinated Time (UTC).
@@ -1636,6 +1650,8 @@ module Aws::DocDB
     #   * {Types::CertificateMessage#certificates #certificates} => Array&lt;Types::Certificate&gt;
     #   * {Types::CertificateMessage#marker #marker} => String
     #
+    # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
+    #
     # @example Request syntax with placeholder values
     #
     #   resp = client.describe_certificates({
@@ -1708,6 +1724,8 @@ module Aws::DocDB
     #   * {Types::DBClusterParameterGroupsMessage#marker #marker} => String
     #   * {Types::DBClusterParameterGroupsMessage#db_cluster_parameter_groups #db_cluster_parameter_groups} => Array&lt;Types::DBClusterParameterGroup&gt;
     #
+    # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
+    #
     # @example Request syntax with placeholder values
     #
     #   resp = client.describe_db_cluster_parameter_groups({
@@ -1781,6 +1799,8 @@ module Aws::DocDB
     #   * {Types::DBClusterParameterGroupDetails#parameters #parameters} => Array&lt;Types::Parameter&gt;
     #   * {Types::DBClusterParameterGroupDetails#marker #marker} => String
     #
+    # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
+    #
     # @example Request syntax with placeholder values
     #
     #   resp = client.describe_db_cluster_parameters({
@@ -1949,6 +1969,8 @@ module Aws::DocDB
     #   * {Types::DBClusterSnapshotMessage#marker #marker} => String
     #   * {Types::DBClusterSnapshotMessage#db_cluster_snapshots #db_cluster_snapshots} => Array&lt;Types::DBClusterSnapshot&gt;
     #
+    # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
+    #
     # @example Request syntax with placeholder values
     #
     #   resp = client.describe_db_cluster_snapshots({
@@ -2125,7 +2147,7 @@ module Aws::DocDB
     # @option params [String] :engine_version
     #   The database engine version to return.
     #
-    #   Example: `5.1.49`
+    #   Example: `3.6.0`
     #
     # @option params [String] :db_parameter_group_family
     #   The name of a specific parameter group family to return details for.
@@ -2790,6 +2812,8 @@ module Aws::DocDB
     #   * {Types::PendingMaintenanceActionsMessage#pending_maintenance_actions #pending_maintenance_actions} => Array&lt;Types::ResourcePendingMaintenanceActions&gt;
     #   * {Types::PendingMaintenanceActionsMessage#marker #marker} => String
     #
+    # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
+    #
     # @example Request syntax with placeholder values
     #
     #   resp = client.describe_pending_maintenance_actions({
@@ -4258,7 +4282,7 @@ module Aws::DocDB
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-docdb'
-      context[:gem_version] = '1.21.0'
+      context[:gem_version] = '1.27.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

data/lib/aws-sdk-docdb/client_api.rb

@@ -263,6 +263,7 @@ module Aws::DocDB
     CopyDBClusterSnapshotMessage.add_member(:pre_signed_url, Shapes::ShapeRef.new(shape: String, location_name: "PreSignedUrl"))
     CopyDBClusterSnapshotMessage.add_member(:copy_tags, Shapes::ShapeRef.new(shape: BooleanOptional, location_name: "CopyTags"))
     CopyDBClusterSnapshotMessage.add_member(:tags, Shapes::ShapeRef.new(shape: TagList, location_name: "Tags"))
+    CopyDBClusterSnapshotMessage.add_member(:source_region, Shapes::ShapeRef.new(shape: String, location_name: "SourceRegion"))
     CopyDBClusterSnapshotMessage.struct_class = Types::CopyDBClusterSnapshotMessage
 
     CopyDBClusterSnapshotResult.add_member(:db_cluster_snapshot, Shapes::ShapeRef.new(shape: DBClusterSnapshot, location_name: "DBClusterSnapshot"))
@@ -284,8 +285,10 @@ module Aws::DocDB
     CreateDBClusterMessage.add_member(:tags, Shapes::ShapeRef.new(shape: TagList, location_name: "Tags"))
     CreateDBClusterMessage.add_member(:storage_encrypted, Shapes::ShapeRef.new(shape: BooleanOptional, location_name: "StorageEncrypted"))
     CreateDBClusterMessage.add_member(:kms_key_id, Shapes::ShapeRef.new(shape: String, location_name: "KmsKeyId"))
+    CreateDBClusterMessage.add_member(:pre_signed_url, Shapes::ShapeRef.new(shape: String, location_name: "PreSignedUrl"))
     CreateDBClusterMessage.add_member(:enable_cloudwatch_logs_exports, Shapes::ShapeRef.new(shape: LogTypeList, location_name: "EnableCloudwatchLogsExports"))
     CreateDBClusterMessage.add_member(:deletion_protection, Shapes::ShapeRef.new(shape: BooleanOptional, location_name: "DeletionProtection"))
+    CreateDBClusterMessage.add_member(:source_region, Shapes::ShapeRef.new(shape: String, location_name: "SourceRegion"))
     CreateDBClusterMessage.struct_class = Types::CreateDBClusterMessage
 
     CreateDBClusterParameterGroupMessage.add_member(:db_cluster_parameter_group_name, Shapes::ShapeRef.new(shape: String, required: true, location_name: "DBClusterParameterGroupName"))
@@ -1208,6 +1211,12 @@ module Aws::DocDB
         o.input = Shapes::ShapeRef.new(shape: DescribeCertificatesMessage)
         o.output = Shapes::ShapeRef.new(shape: CertificateMessage)
         o.errors << Shapes::ShapeRef.new(shape: CertificateNotFoundFault)
+        o[:pager] = Aws::Pager.new(
+          limit_key: "max_records",
+          tokens: {
+            "marker" => "marker"
+          }
+        )
       end)
 
       api.add_operation(:describe_db_cluster_parameter_groups, Seahorse::Model::Operation.new.tap do |o|
@@ -1217,6 +1226,12 @@ module Aws::DocDB
         o.input = Shapes::ShapeRef.new(shape: DescribeDBClusterParameterGroupsMessage)
         o.output = Shapes::ShapeRef.new(shape: DBClusterParameterGroupsMessage)
         o.errors << Shapes::ShapeRef.new(shape: DBParameterGroupNotFoundFault)
+        o[:pager] = Aws::Pager.new(
+          limit_key: "max_records",
+          tokens: {
+            "marker" => "marker"
+          }
+        )
       end)
 
       api.add_operation(:describe_db_cluster_parameters, Seahorse::Model::Operation.new.tap do |o|
@@ -1226,6 +1241,12 @@ module Aws::DocDB
         o.input = Shapes::ShapeRef.new(shape: DescribeDBClusterParametersMessage)
         o.output = Shapes::ShapeRef.new(shape: DBClusterParameterGroupDetails)
         o.errors << Shapes::ShapeRef.new(shape: DBParameterGroupNotFoundFault)
+        o[:pager] = Aws::Pager.new(
+          limit_key: "max_records",
+          tokens: {
+            "marker" => "marker"
+          }
+        )
       end)
 
       api.add_operation(:describe_db_cluster_snapshot_attributes, Seahorse::Model::Operation.new.tap do |o|
@@ -1244,6 +1265,12 @@ module Aws::DocDB
         o.input = Shapes::ShapeRef.new(shape: DescribeDBClusterSnapshotsMessage)
         o.output = Shapes::ShapeRef.new(shape: DBClusterSnapshotMessage)
         o.errors << Shapes::ShapeRef.new(shape: DBClusterSnapshotNotFoundFault)
+        o[:pager] = Aws::Pager.new(
+          limit_key: "max_records",
+          tokens: {
+            "marker" => "marker"
+          }
+        )
       end)
 
       api.add_operation(:describe_db_clusters, Seahorse::Model::Operation.new.tap do |o|
@@ -1356,6 +1383,12 @@ module Aws::DocDB
         o.input = Shapes::ShapeRef.new(shape: DescribePendingMaintenanceActionsMessage)
         o.output = Shapes::ShapeRef.new(shape: PendingMaintenanceActionsMessage)
         o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundFault)
+        o[:pager] = Aws::Pager.new(
+          limit_key: "max_records",
+          tokens: {
+            "marker" => "marker"
+          }
+        )
       end)
 
       api.add_operation(:failover_db_cluster, Seahorse::Model::Operation.new.tap do |o|

data/lib/aws-sdk-docdb/plugins/cross_region_copying.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+require 'aws-sigv4'
+
+module Aws
+  module DocDB
+    module Plugins
+      # This plugin populates the `:pre_signed_url` request param for APIs
+      # that support cross region copying.
+      #
+      # This parameter is required by RDS when copying an encrypted snapshot
+      # across regions. This plugin will be skipped if the `:pre_signed_url`
+      # parameter is provided by the user.
+      class CrossRegionCopying < Seahorse::Client::Plugin
+        # @api private
+        class Handler < Seahorse::Client::Handler
+          def call(context)
+            params = context.params
+            if params.is_a?(Hash) &&
+               params[:source_region] && !params[:pre_signed_url]
+              params[:pre_signed_url] = presigned_url(context, params)
+            end
+            @handler.call(context)
+          end
+
+          private
+
+          def presigned_url(context, params)
+            # :source_region is not modeled in the api
+            source_region = params.delete(:source_region)
+            param_list = Aws::Query::ParamList.new
+            param_list.set('Action', context.operation.name)
+            param_list.set('DestinationRegion', context.config.region)
+            param_list.set('Version', context.config.api.version)
+            Aws::Query::ParamBuilder.new(param_list).apply(
+              context.operation.input,
+              params
+            )
+            signer = Aws::Sigv4::Signer.new(
+              service: 'rds',
+              region: source_region,
+              credentials_provider: context.config.credentials
+            )
+            url = Aws::Partitions::EndpointProvider.resolve(
+              signer.region, 'rds'
+            )
+            url += "?#{param_list}"
+            signer.presign_url(
+              http_method: 'GET',
+              url: url,
+              expires_in: 3600
+            ).to_s
+          end
+        end
+
+        handler(
+          Handler,
+          step: :initialize,
+          operations: [
+            :copy_db_cluster_snapshot,
+            :create_db_cluster
+          ]
+        )
+      end
+    end
+  end
+end

data/lib/aws-sdk-docdb/types.rb

@@ -27,7 +27,7 @@ module Aws::DocDB
     #
     # @!attribute [rw] resource_name
     #   The Amazon DocumentDB resource that the tags are added to. This
-    #   value is an Amazon Resource Name (ARN).
+    #   value is an Amazon Resource Name .
     #   @return [String]
     #
     # @!attribute [rw] tags
@@ -267,7 +267,7 @@ module Aws::DocDB
     #   * If the source parameter group is in a different AWS Region than
     #     the copy, specify a valid cluster parameter group ARN; for
     #     example,
-    #     `arn:aws:rds:us-east-1:123456789012:cluster-pg:custom-cluster-group1`.
+    #     `arn:aws:rds:us-east-1:123456789012:sample-cluster:sample-parameter-group`.
     #   @return [String]
     #
     # @!attribute [rw] target_db_cluster_parameter_group_identifier
@@ -334,18 +334,16 @@ module Aws::DocDB
     #             value: "String",
     #           },
     #         ],
+    #         source_region: "String",
     #       }
     #
     # @!attribute [rw] source_db_cluster_snapshot_identifier
     #   The identifier of the cluster snapshot to copy. This parameter is
     #   not case sensitive.
     #
-    #   You can't copy an encrypted, shared cluster snapshot from one AWS
-    #   Region to another.
-    #
     #   Constraints:
     #
-    #   * Must specify a valid system snapshot in the "available" state.
+    #   * Must specify a valid system snapshot in the *available* state.
     #
     #   * If the source snapshot is in the same AWS Region as the copy,
     #     specify a valid snapshot identifier.
@@ -389,8 +387,8 @@ module Aws::DocDB
     #   `KmsKeyId` to the AWS KMS key ID that you want to use to encrypt the
     #   copy of the cluster snapshot in the destination Region. AWS KMS
     #   encryption keys are specific to the AWS Region that they are created
-    #   in, and you can't use encryption keys from one Region in another
-    #   Region.
+    #   in, and you can't use encryption keys from one AWS Region in
+    #   another AWS Region.
     #
     #   If you copy an unencrypted cluster snapshot and specify a value for
     #   the `KmsKeyId` parameter, an error is returned.
@@ -400,32 +398,35 @@ module Aws::DocDB
     #   The URL that contains a Signature Version 4 signed request for the
     #   `CopyDBClusterSnapshot` API action in the AWS Region that contains
     #   the source cluster snapshot to copy. You must use the `PreSignedUrl`
-    #   parameter when copying an encrypted cluster snapshot from another
-    #   AWS Region.
+    #   parameter when copying a cluster snapshot from another AWS Region.
+    #
+    #   If you are using an AWS SDK tool or the AWS CLI, you can specify
+    #   `SourceRegion` (or `--source-region` for the AWS CLI) instead of
+    #   specifying `PreSignedUrl` manually. Specifying `SourceRegion`
+    #   autogenerates a pre-signed URL that is a valid request for the
+    #   operation that can be executed in the source AWS Region.
     #
     #   The presigned URL must be a valid request for the
-    #   `CopyDBSClusterSnapshot` API action that can be executed in the
-    #   source AWS Region that contains the encrypted DB cluster snapshot to
-    #   be copied. The presigned URL request must contain the following
-    #   parameter values:
-    #
-    #   * `KmsKeyId` - The AWS KMS key identifier for the key to use to
-    #     encrypt the copy of the cluster snapshot in the destination AWS
-    #     Region. This is the same identifier for both the
-    #     `CopyDBClusterSnapshot` action that is called in the destination
-    #     AWS Region, and the action contained in the presigned URL.
-    #
-    #   * `DestinationRegion` - The name of the AWS Region that the DB
-    #     cluster snapshot will be created in.
-    #
-    #   * `SourceDBClusterSnapshotIdentifier` - The cluster snapshot
-    #     identifier for the encrypted cluster snapshot to be copied. This
-    #     identifier must be in the Amazon Resource Name (ARN) format for
-    #     the source AWS Region. For example, if you are copying an
-    #     encrypted cluster snapshot from the us-west-2 AWS Region, then
-    #     your `SourceDBClusterSnapshotIdentifier` looks like the following
-    #     example:
-    #     `arn:aws:rds:us-west-2:123456789012:cluster-snapshot:my-cluster-snapshot-20161115`.
+    #   `CopyDBClusterSnapshot` API action that can be executed in the
+    #   source AWS Region that contains the cluster snapshot to be copied.
+    #   The presigned URL request must contain the following parameter
+    #   values:
+    #
+    #   * `SourceRegion` - The ID of the region that contains the snapshot
+    #     to be copied.
+    #
+    #   * `SourceDBClusterSnapshotIdentifier` - The identifier for the the
+    #     encrypted cluster snapshot to be copied. This identifier must be
+    #     in the Amazon Resource Name (ARN) format for the source AWS
+    #     Region. For example, if you are copying an encrypted cluster
+    #     snapshot from the us-east-1 AWS Region, then your
+    #     `SourceDBClusterSnapshotIdentifier` looks something like the
+    #     following:
+    #     `arn:aws:rds:us-east-1:12345678012:sample-cluster:sample-cluster-snapshot`.
+    #
+    #   * `TargetDBClusterSnapshotIdentifier` - The identifier for the new
+    #     cluster snapshot to be created. This parameter isn't case
+    #     sensitive.
     #   @return [String]
     #
     # @!attribute [rw] copy_tags
@@ -438,6 +439,11 @@ module Aws::DocDB
     #   The tags to be assigned to the cluster snapshot.
     #   @return [Array<Types::Tag>]
     #
+    # @!attribute [rw] source_region
+    #   The source region of the snapshot. This is only needed when the
+    #   shapshot is encrypted and in a different region.
+    #   @return [String]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/CopyDBClusterSnapshotMessage AWS API Documentation
     #
     class CopyDBClusterSnapshotMessage < Struct.new(
@@ -446,7 +452,8 @@ module Aws::DocDB
       :kms_key_id,
       :pre_signed_url,
       :copy_tags,
-      :tags)
+      :tags,
+      :source_region)
       SENSITIVE = []
       include Aws::Structure
     end
@@ -490,8 +497,10 @@ module Aws::DocDB
     #         ],
     #         storage_encrypted: false,
     #         kms_key_id: "String",
+    #         pre_signed_url: "String",
     #         enable_cloudwatch_logs_exports: ["String"],
     #         deletion_protection: false,
+    #         source_region: "String",
     #       }
     #
     # @!attribute [rw] availability_zones
@@ -552,7 +561,10 @@ module Aws::DocDB
     #   @return [String]
     #
     # @!attribute [rw] engine_version
-    #   The version number of the database engine to use.
+    #   The version number of the database engine to use. The
+    #   --engine-version will default to the latest major engine version.
+    #   For production workloads, we recommend explicitly declaring this
+    #   parameter with the intended major engine version.
     #   @return [String]
     #
     # @!attribute [rw] port
@@ -633,28 +645,30 @@ module Aws::DocDB
     #
     #   If an encryption key is not specified in `KmsKeyId`\:
     #
-    #   * If `ReplicationSourceIdentifier` identifies an encrypted source,
-    #     then Amazon DocumentDB uses the encryption key that is used to
-    #     encrypt the source. Otherwise, Amazon DocumentDB uses your default
-    #     encryption key.
-    #
-    #   * If the `StorageEncrypted` parameter is `true` and
-    #     `ReplicationSourceIdentifier` is not specified, Amazon DocumentDB
+    #   * If the `StorageEncrypted` parameter is `true`, Amazon DocumentDB
     #     uses your default encryption key.
     #
+    #   ^
+    #
     #   AWS KMS creates the default encryption key for your AWS account.
     #   Your AWS account has a different default encryption key for each AWS
     #   Region.
+    #   @return [String]
     #
-    #   If you create a replica of an encrypted cluster in another AWS
-    #   Region, you must set `KmsKeyId` to a KMS key ID that is valid in the
-    #   destination AWS Region. This key is used to encrypt the replica in
-    #   that AWS Region.
+    # @!attribute [rw] pre_signed_url
+    #   Not currently supported.
     #   @return [String]
     #
     # @!attribute [rw] enable_cloudwatch_logs_exports
     #   A list of log types that need to be enabled for exporting to Amazon
-    #   CloudWatch Logs.
+    #   CloudWatch Logs. You can enable audit logs or profiler logs. For
+    #   more information, see [ Auditing Amazon DocumentDB Events][1] and [
+    #   Profiling Amazon DocumentDB Operations][2].
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/documentdb/latest/developerguide/event-auditing.html
+    #   [2]: https://docs.aws.amazon.com/documentdb/latest/developerguide/profiling.html
     #   @return [Array<String>]
     #
     # @!attribute [rw] deletion_protection
@@ -665,6 +679,11 @@ module Aws::DocDB
     #   deleted.
     #   @return [Boolean]
     #
+    # @!attribute [rw] source_region
+    #   The source region of the snapshot. This is only needed when the
+    #   shapshot is encrypted and in a different region.
+    #   @return [String]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/CreateDBClusterMessage AWS API Documentation
     #
     class CreateDBClusterMessage < Struct.new(
@@ -684,8 +703,10 @@ module Aws::DocDB
       :tags,
       :storage_encrypted,
       :kms_key_id,
+      :pre_signed_url,
       :enable_cloudwatch_logs_exports,
-      :deletion_protection)
+      :deletion_protection,
+      :source_region)
       SENSITIVE = []
       include Aws::Structure
     end
@@ -893,10 +914,6 @@ module Aws::DocDB
     #   endpoint's AWS Region.
     #
     #   Example: `us-east-1d`
-    #
-    #   Constraint: The `AvailabilityZone` parameter can't be specified if
-    #   the `MultiAZ` parameter is set to `true`. The specified Availability
-    #   Zone must be in the same AWS Region as the current endpoint.
     #   @return [String]
     #
     # @!attribute [rw] preferred_maintenance_window
@@ -2724,7 +2741,7 @@ module Aws::DocDB
     # @!attribute [rw] engine_version
     #   The database engine version to return.
     #
-    #   Example: `5.1.49`
+    #   Example: `3.6.0`
     #   @return [String]
     #
     # @!attribute [rw] db_parameter_group_family

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-docdb
 version: !ruby/object:Gem::Version
-  version: 1.21.0
+  version: 1.27.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-08-25 00:00:00.000000000 Z
+date: 2020-12-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core
@@ -19,7 +19,7 @@ dependencies:
         version: '3'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.99.0
+        version: 3.109.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +29,7 @@ dependencies:
         version: '3'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.99.0
+        version: 3.109.0
 - !ruby/object:Gem::Dependency
   name: aws-sigv4
   requirement: !ruby/object:Gem::Requirement
@@ -57,6 +57,7 @@ files:
 - lib/aws-sdk-docdb/client_api.rb
 - lib/aws-sdk-docdb/customizations.rb
 - lib/aws-sdk-docdb/errors.rb
+- lib/aws-sdk-docdb/plugins/cross_region_copying.rb
 - lib/aws-sdk-docdb/resource.rb
 - lib/aws-sdk-docdb/types.rb
 - lib/aws-sdk-docdb/waiters.rb