aws-sdk-docdb 1.18.1 → 1.24.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 04e7040430af17fcd6772173e29a86e4dce3d8ca08dcbb5e5d31619b8ea7f6ea
-  data.tar.gz: 3e8d5f083a9ed13f1395ace5cf4d27a4aec3e9834701cac1b8e7583b0b849d36
+  metadata.gz: b848eaf8bc2e8551685d823e6a5ef1a95777bd2304577a55756efdb8f983f31a
+  data.tar.gz: e0cdf94dcbd0574956f48a21949cb4bc975148ef5c123a72e400eaeab42a95ca
 SHA512:
-  metadata.gz: e33c661f4ce348baece38ead57b02570f4eff87d6d77c32339301b5d207bc450ec723bd1dda6e796f0feaa4ca81faa9293fa4ca4711cde4b7e4033f5f0c86e16
-  data.tar.gz: a519714a740c275746535d4e29b264de7ce9cc6868f9755b7148ec68cfb123e14c2cfc2485b4a2303431fe4838296e83a7875346ae1145525aba00d1bb58cd36
+  metadata.gz: f7c940aac6e6cc9f19e9d72bba9060483ed0c665ad5dda9d5a8d664178ee2f9b9ef9f115f081b6b8ebd7141a5bd11fe22bb5eb449bac83e86847dcbe1ef44281
+  data.tar.gz: 7bf82966ec1b612d060e3e57d0830593ed5b6c883394814840b5af0d80552b6693d52a5b8dfdc30653717b93ad88e1c6070b95879925ace3b5f425f16ea313d5

data/lib/aws-sdk-docdb.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # WARNING ABOUT GENERATED CODE
 #
 # This file is generated. See the contributing guide for more information:
@@ -5,6 +7,7 @@
 #
 # WARNING ABOUT GENERATED CODE
 
+
 require 'aws-sdk-core'
 require 'aws-sigv4'
 
@@ -43,9 +46,9 @@ require_relative 'aws-sdk-docdb/customizations'
 #
 # See {Errors} for more information.
 #
-# @service
+# @!group service
 module Aws::DocDB
 
-  GEM_VERSION = '1.18.1'
+  GEM_VERSION = '1.24.0'
 
 end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # WARNING ABOUT GENERATED CODE
 #
 # This file is generated. See the contributing guide for more information:
@@ -83,13 +85,28 @@ module Aws::DocDB
     #     * `Aws::Credentials` - Used for configuring static, non-refreshing
     #       credentials.
     #
+    #     * `Aws::SharedCredentials` - Used for loading static credentials from a
+    #       shared file, such as `~/.aws/config`.
+    #
+    #     * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
+    #
+    #     * `Aws::AssumeRoleWebIdentityCredentials` - Used when you need to
+    #       assume a role after providing credentials via the web.
+    #
+    #     * `Aws::SSOCredentials` - Used for loading credentials from AWS SSO using an
+    #       access token generated from `aws login`.
+    #
+    #     * `Aws::ProcessCredentials` - Used for loading credentials from a
+    #       process that outputs to stdout.
+    #
     #     * `Aws::InstanceProfileCredentials` - Used for loading credentials
     #       from an EC2 IMDS on an EC2 instance.
     #
-    #     * `Aws::SharedCredentials` - Used for loading credentials from a
-    #       shared file, such as `~/.aws/config`.
+    #     * `Aws::ECSCredentials` - Used for loading credentials from
+    #       instances running in ECS.
     #
-    #     * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
+    #     * `Aws::CognitoIdentityCredentials` - Used for loading credentials
+    #       from the Cognito Identity service.
     #
     #     When `:credentials` are not configured directly, the following
     #     locations will be searched for credentials:
@@ -99,10 +116,10 @@ module Aws::DocDB
     #     * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
     #     * `~/.aws/credentials`
     #     * `~/.aws/config`
-    #     * EC2 IMDS instance profile - When used by default, the timeouts are
-    #       very aggressive. Construct and pass an instance of
-    #       `Aws::InstanceProfileCredentails` to enable retries and extended
-    #       timeouts.
+    #     * EC2/ECS IMDS instance profile - When used by default, the timeouts
+    #       are very aggressive. Construct and pass an instance of
+    #       `Aws::InstanceProfileCredentails` or `Aws::ECSCredentials` to
+    #       enable retries and extended timeouts.
     #
     #   @option options [required, String] :region
     #     The AWS region to connect to.  The configured `:region` is
@@ -317,7 +334,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.
@@ -345,8 +362,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
@@ -419,7 +436,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.
@@ -480,23 +497,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.
@@ -538,8 +553,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.
@@ -548,32 +563,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
@@ -686,7 +702,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
@@ -777,9 +796,19 @@ module Aws::DocDB
     #   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`
@@ -815,6 +844,7 @@ module Aws::DocDB
     #     ],
     #     storage_encrypted: false,
     #     kms_key_id: "String",
+    #     pre_signed_url: "String",
     #     enable_cloudwatch_logs_exports: ["String"],
     #     deletion_protection: false,
     #   })
@@ -873,24 +903,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.
@@ -1059,10 +1091,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).
@@ -1619,6 +1647,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({
@@ -1691,6 +1721,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({
@@ -1764,6 +1796,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({
@@ -1932,6 +1966,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({
@@ -2108,7 +2144,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.
@@ -2773,6 +2809,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({
@@ -4241,7 +4279,7 @@ module Aws::DocDB
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-docdb'
-      context[:gem_version] = '1.18.1'
+      context[:gem_version] = '1.24.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # WARNING ABOUT GENERATED CODE
 #
 # This file is generated. See the contributing guide for more information:
@@ -282,6 +284,7 @@ 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.struct_class = Types::CreateDBClusterMessage
@@ -1206,6 +1209,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|
@@ -1215,6 +1224,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|
@@ -1224,6 +1239,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|
@@ -1242,6 +1263,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|
@@ -1354,6 +1381,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/errors.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # WARNING ABOUT GENERATED CODE
 #
 # This file is generated. See the contributing guide for more information:

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # WARNING ABOUT GENERATED CODE
 #
 # This file is generated. See the contributing guide for more information: