aws-sdk-docdb 1.70.0 → 1.71.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e138c0412ac528fb2afe3ba2603016ab7563a959a86361699c0d3f647f14f459
-  data.tar.gz: e3e8ed7a6c3335afd5f5aca3cb945c5a5769b1893b1fb43d828fbc71019686ee
+  metadata.gz: ea1ec49066ad7269a775084f8dce6d2b62251b388b4c9ff7953af1ed5a57889e
+  data.tar.gz: 6e37dd53e5d273dd499bf17ae2acc8ea9006a67cc9fb3c4873188cdde63d0222
 SHA512:
-  metadata.gz: f7dce05cd6fe7963bceed51c413d3ca1a6ea09b8fdb3c24fbf8837a255d56b77dd54eb4316c82c9ea3da6cb64d09d3258e875d754a5273d0c4a76b75605d3534
-  data.tar.gz: e2cf06247cc74e94b6b4dab99d25aad9d41a38934373f4845b40d8323696cbee6ffdbcfa6ec779ccc0b248c7ce46a0a07ae987b74b045681e3dafbb21dfa620f
+  metadata.gz: 1a5e76001c5ac82d8f7f39c1a3a1e2cfafd331852dc391fa63c3fe8217187153860186dac9fe8b1f13f08c43c818026f249de634b9a588e7526497922a29ea33
+  data.tar.gz: b44b6779f015cdf6b76ece8d03762dd956f6fc406b4803f6dc18094c2eeabc3ef8d6499476d39d4de9dc1e133d7a8490f4595d05fa25e79eed10a3e4be97bf27

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 Unreleased Changes
 ------------------
 
+1.71.0 (2024-08-15)
+------------------
+
+* Feature - This release adds Global Cluster Failover capability which enables you to change your global cluster's primary AWS region, the region that serves writes, during a regional outage. Performing a failover action preserves your Global Cluster setup.
+
 1.70.0 (2024-07-02)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.70.0
+1.71.0

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

@@ -3664,6 +3664,107 @@ module Aws::DocDB
       req.send_request(options)
     end
 
+    # Promotes the specified secondary DB cluster to be the primary DB
+    # cluster in the global cluster when failing over a global cluster
+    # occurs.
+    #
+    # Use this operation to respond to an unplanned event, such as a
+    # regional disaster in the primary region. Failing over can result in a
+    # loss of write transaction data that wasn't replicated to the chosen
+    # secondary before the failover event occurred. However, the recovery
+    # process that promotes a DB instance on the chosen seconday DB cluster
+    # to be the primary writer DB instance guarantees that the data is in a
+    # transactionally consistent state.
+    #
+    # @option params [required, String] :global_cluster_identifier
+    #   The identifier of the Amazon DocumentDB global cluster to apply this
+    #   operation. The identifier is the unique key assigned by the user when
+    #   the cluster is created. In other words, it's the name of the global
+    #   cluster.
+    #
+    #   Constraints:
+    #
+    #   * Must match the identifier of an existing global cluster.
+    #
+    #   * Minimum length of 1. Maximum length of 255.
+    #
+    #   Pattern: `[A-Za-z][0-9A-Za-z-:._]*`
+    #
+    # @option params [required, String] :target_db_cluster_identifier
+    #   The identifier of the secondary Amazon DocumentDB cluster that you
+    #   want to promote to the primary for the global cluster. Use the Amazon
+    #   Resource Name (ARN) for the identifier so that Amazon DocumentDB can
+    #   locate the cluster in its Amazon Web Services region.
+    #
+    #   Constraints:
+    #
+    #   * Must match the identifier of an existing secondary cluster.
+    #
+    #   * Minimum length of 1. Maximum length of 255.
+    #
+    #   Pattern: `[A-Za-z][0-9A-Za-z-:._]*`
+    #
+    # @option params [Boolean] :allow_data_loss
+    #   Specifies whether to allow data loss for this global cluster
+    #   operation. Allowing data loss triggers a global failover operation.
+    #
+    #   If you don't specify `AllowDataLoss`, the global cluster operation
+    #   defaults to a switchover.
+    #
+    #   Constraints:
+    #
+    #   * Can't be specified together with the `Switchover` parameter.
+    #
+    #   ^
+    #
+    # @option params [Boolean] :switchover
+    #   Specifies whether to switch over this global database cluster.
+    #
+    #   Constraints:
+    #
+    #   * Can't be specified together with the `AllowDataLoss` parameter.
+    #
+    #   ^
+    #
+    # @return [Types::FailoverGlobalClusterResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::FailoverGlobalClusterResult#global_cluster #global_cluster} => Types::GlobalCluster
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.failover_global_cluster({
+    #     global_cluster_identifier: "GlobalClusterIdentifier", # required
+    #     target_db_cluster_identifier: "DBClusterIdentifier", # required
+    #     allow_data_loss: false,
+    #     switchover: false,
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.global_cluster.global_cluster_identifier #=> String
+    #   resp.global_cluster.global_cluster_resource_id #=> String
+    #   resp.global_cluster.global_cluster_arn #=> String
+    #   resp.global_cluster.status #=> String
+    #   resp.global_cluster.engine #=> String
+    #   resp.global_cluster.engine_version #=> String
+    #   resp.global_cluster.database_name #=> String
+    #   resp.global_cluster.storage_encrypted #=> Boolean
+    #   resp.global_cluster.deletion_protection #=> Boolean
+    #   resp.global_cluster.global_cluster_members #=> Array
+    #   resp.global_cluster.global_cluster_members[0].db_cluster_arn #=> String
+    #   resp.global_cluster.global_cluster_members[0].readers #=> Array
+    #   resp.global_cluster.global_cluster_members[0].readers[0] #=> String
+    #   resp.global_cluster.global_cluster_members[0].is_writer #=> Boolean
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/FailoverGlobalCluster AWS API Documentation
+    #
+    # @overload failover_global_cluster(params = {})
+    # @param [Hash] params ({})
+    def failover_global_cluster(params = {}, options = {})
+      req = build_request(:failover_global_cluster, params)
+      req.send_request(options)
+    end
+
     # Lists all tags on an Amazon DocumentDB resource.
     #
     # @option params [required, String] :resource_name
@@ -5435,7 +5536,7 @@ module Aws::DocDB
     #
     #   resp = client.switchover_global_cluster({
     #     global_cluster_identifier: "GlobalClusterIdentifier", # required
-    #     target_db_cluster_identifier: "String", # required
+    #     target_db_cluster_identifier: "DBClusterIdentifier", # required
     #   })
     #
     # @example Response structure
@@ -5477,7 +5578,7 @@ module Aws::DocDB
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-docdb'
-      context[:gem_version] = '1.70.0'
+      context[:gem_version] = '1.71.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

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

@@ -53,6 +53,7 @@ module Aws::DocDB
     CreateGlobalClusterResult = Shapes::StructureShape.new(name: 'CreateGlobalClusterResult')
     DBCluster = Shapes::StructureShape.new(name: 'DBCluster')
     DBClusterAlreadyExistsFault = Shapes::StructureShape.new(name: 'DBClusterAlreadyExistsFault', error: {"code"=>"DBClusterAlreadyExistsFault", "httpStatusCode"=>400, "senderFault"=>true})
+    DBClusterIdentifier = Shapes::StringShape.new(name: 'DBClusterIdentifier')
     DBClusterList = Shapes::ListShape.new(name: 'DBClusterList')
     DBClusterMember = Shapes::StructureShape.new(name: 'DBClusterMember')
     DBClusterMemberList = Shapes::ListShape.new(name: 'DBClusterMemberList')
@@ -145,6 +146,8 @@ module Aws::DocDB
     EventsMessage = Shapes::StructureShape.new(name: 'EventsMessage')
     FailoverDBClusterMessage = Shapes::StructureShape.new(name: 'FailoverDBClusterMessage')
     FailoverDBClusterResult = Shapes::StructureShape.new(name: 'FailoverDBClusterResult')
+    FailoverGlobalClusterMessage = Shapes::StructureShape.new(name: 'FailoverGlobalClusterMessage')
+    FailoverGlobalClusterResult = Shapes::StructureShape.new(name: 'FailoverGlobalClusterResult')
     Filter = Shapes::StructureShape.new(name: 'Filter')
     FilterList = Shapes::ListShape.new(name: 'FilterList')
     FilterValueList = Shapes::ListShape.new(name: 'FilterValueList')
@@ -870,6 +873,15 @@ module Aws::DocDB
     FailoverDBClusterResult.add_member(:db_cluster, Shapes::ShapeRef.new(shape: DBCluster, location_name: "DBCluster"))
     FailoverDBClusterResult.struct_class = Types::FailoverDBClusterResult
 
+    FailoverGlobalClusterMessage.add_member(:global_cluster_identifier, Shapes::ShapeRef.new(shape: GlobalClusterIdentifier, required: true, location_name: "GlobalClusterIdentifier"))
+    FailoverGlobalClusterMessage.add_member(:target_db_cluster_identifier, Shapes::ShapeRef.new(shape: DBClusterIdentifier, required: true, location_name: "TargetDbClusterIdentifier"))
+    FailoverGlobalClusterMessage.add_member(:allow_data_loss, Shapes::ShapeRef.new(shape: BooleanOptional, location_name: "AllowDataLoss"))
+    FailoverGlobalClusterMessage.add_member(:switchover, Shapes::ShapeRef.new(shape: BooleanOptional, location_name: "Switchover"))
+    FailoverGlobalClusterMessage.struct_class = Types::FailoverGlobalClusterMessage
+
+    FailoverGlobalClusterResult.add_member(:global_cluster, Shapes::ShapeRef.new(shape: GlobalCluster, location_name: "GlobalCluster"))
+    FailoverGlobalClusterResult.struct_class = Types::FailoverGlobalClusterResult
+
     Filter.add_member(:name, Shapes::ShapeRef.new(shape: String, required: true, location_name: "Name"))
     Filter.add_member(:values, Shapes::ShapeRef.new(shape: FilterValueList, required: true, location_name: "Values"))
     Filter.struct_class = Types::Filter
@@ -1219,7 +1231,7 @@ module Aws::DocDB
     SubscriptionNotFoundFault.struct_class = Types::SubscriptionNotFoundFault
 
     SwitchoverGlobalClusterMessage.add_member(:global_cluster_identifier, Shapes::ShapeRef.new(shape: GlobalClusterIdentifier, required: true, location_name: "GlobalClusterIdentifier"))
-    SwitchoverGlobalClusterMessage.add_member(:target_db_cluster_identifier, Shapes::ShapeRef.new(shape: String, required: true, location_name: "TargetDbClusterIdentifier"))
+    SwitchoverGlobalClusterMessage.add_member(:target_db_cluster_identifier, Shapes::ShapeRef.new(shape: DBClusterIdentifier, required: true, location_name: "TargetDbClusterIdentifier"))
     SwitchoverGlobalClusterMessage.struct_class = Types::SwitchoverGlobalClusterMessage
 
     SwitchoverGlobalClusterResult.add_member(:global_cluster, Shapes::ShapeRef.new(shape: GlobalCluster, location_name: "GlobalCluster"))
@@ -1745,6 +1757,18 @@ module Aws::DocDB
         o.errors << Shapes::ShapeRef.new(shape: InvalidDBInstanceStateFault)
       end)
 
+      api.add_operation(:failover_global_cluster, Seahorse::Model::Operation.new.tap do |o|
+        o.name = "FailoverGlobalCluster"
+        o.http_method = "POST"
+        o.http_request_uri = "/"
+        o.input = Shapes::ShapeRef.new(shape: FailoverGlobalClusterMessage)
+        o.output = Shapes::ShapeRef.new(shape: FailoverGlobalClusterResult)
+        o.errors << Shapes::ShapeRef.new(shape: GlobalClusterNotFoundFault)
+        o.errors << Shapes::ShapeRef.new(shape: InvalidGlobalClusterStateFault)
+        o.errors << Shapes::ShapeRef.new(shape: InvalidDBClusterStateFault)
+        o.errors << Shapes::ShapeRef.new(shape: DBClusterNotFoundFault)
+      end)
+
       api.add_operation(:list_tags_for_resource, Seahorse::Model::Operation.new.tap do |o|
         o.name = "ListTagsForResource"
         o.http_method = "POST"

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

@@ -516,6 +516,20 @@ module Aws::DocDB
       end
     end
 
+    class FailoverGlobalCluster
+      def self.build(context)
+        unless context.config.regional_endpoint
+          endpoint = context.config.endpoint.to_s
+        end
+        Aws::DocDB::EndpointParameters.new(
+          region: context.config.region,
+          use_dual_stack: context.config.use_dualstack_endpoint,
+          use_fips: context.config.use_fips_endpoint,
+          endpoint: endpoint,
+        )
+      end
+    end
+
     class ListTagsForResource
       def self.build(context)
         unless context.config.regional_endpoint

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

@@ -130,6 +130,8 @@ module Aws::DocDB
             Aws::DocDB::Endpoints::DescribePendingMaintenanceActions.build(context)
           when :failover_db_cluster
             Aws::DocDB::Endpoints::FailoverDBCluster.build(context)
+          when :failover_global_cluster
+            Aws::DocDB::Endpoints::FailoverGlobalCluster.build(context)
           when :list_tags_for_resource
             Aws::DocDB::Endpoints::ListTagsForResource.build(context)
           when :modify_db_cluster

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

@@ -3696,6 +3696,83 @@ module Aws::DocDB
       include Aws::Structure
     end
 
+    # @!attribute [rw] global_cluster_identifier
+    #   The identifier of the Amazon DocumentDB global cluster to apply this
+    #   operation. The identifier is the unique key assigned by the user
+    #   when the cluster is created. In other words, it's the name of the
+    #   global cluster.
+    #
+    #   Constraints:
+    #
+    #   * Must match the identifier of an existing global cluster.
+    #
+    #   * Minimum length of 1. Maximum length of 255.
+    #
+    #   Pattern: `[A-Za-z][0-9A-Za-z-:._]*`
+    #   @return [String]
+    #
+    # @!attribute [rw] target_db_cluster_identifier
+    #   The identifier of the secondary Amazon DocumentDB cluster that you
+    #   want to promote to the primary for the global cluster. Use the
+    #   Amazon Resource Name (ARN) for the identifier so that Amazon
+    #   DocumentDB can locate the cluster in its Amazon Web Services region.
+    #
+    #   Constraints:
+    #
+    #   * Must match the identifier of an existing secondary cluster.
+    #
+    #   * Minimum length of 1. Maximum length of 255.
+    #
+    #   Pattern: `[A-Za-z][0-9A-Za-z-:._]*`
+    #   @return [String]
+    #
+    # @!attribute [rw] allow_data_loss
+    #   Specifies whether to allow data loss for this global cluster
+    #   operation. Allowing data loss triggers a global failover operation.
+    #
+    #   If you don't specify `AllowDataLoss`, the global cluster operation
+    #   defaults to a switchover.
+    #
+    #   Constraints:
+    #
+    #   * Can't be specified together with the `Switchover` parameter.
+    #
+    #   ^
+    #   @return [Boolean]
+    #
+    # @!attribute [rw] switchover
+    #   Specifies whether to switch over this global database cluster.
+    #
+    #   Constraints:
+    #
+    #   * Can't be specified together with the `AllowDataLoss` parameter.
+    #
+    #   ^
+    #   @return [Boolean]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/FailoverGlobalClusterMessage AWS API Documentation
+    #
+    class FailoverGlobalClusterMessage < Struct.new(
+      :global_cluster_identifier,
+      :target_db_cluster_identifier,
+      :allow_data_loss,
+      :switchover)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] global_cluster
+    #   A data type representing an Amazon DocumentDB global cluster.
+    #   @return [Types::GlobalCluster]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/docdb-2014-10-31/FailoverGlobalClusterResult AWS API Documentation
+    #
+    class FailoverGlobalClusterResult < Struct.new(
+      :global_cluster)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # A named set of filter values, used to return a more specific list of
     # results. You can use a filter to match a set of resources by specific
     # criteria, such as IDs.

data/lib/aws-sdk-docdb.rb

@@ -53,6 +53,6 @@ require_relative 'aws-sdk-docdb/customizations'
 # @!group service
 module Aws::DocDB
 
-  GEM_VERSION = '1.70.0'
+  GEM_VERSION = '1.71.0'
 
 end

data/sig/client.rbs

@@ -685,6 +685,19 @@ module Aws
                                ) -> _FailoverDBClusterResponseSuccess
                              | (?Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _FailoverDBClusterResponseSuccess
 
+      interface _FailoverGlobalClusterResponseSuccess
+        include ::Seahorse::Client::_ResponseSuccess[Types::FailoverGlobalClusterResult]
+        def global_cluster: () -> Types::GlobalCluster
+      end
+      # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/DocDB/Client.html#failover_global_cluster-instance_method
+      def failover_global_cluster: (
+                                     global_cluster_identifier: ::String,
+                                     target_db_cluster_identifier: ::String,
+                                     ?allow_data_loss: bool,
+                                     ?switchover: bool
+                                   ) -> _FailoverGlobalClusterResponseSuccess
+                                 | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _FailoverGlobalClusterResponseSuccess
+
       interface _ListTagsForResourceResponseSuccess
         include ::Seahorse::Client::_ResponseSuccess[Types::TagListMessage]
         def tag_list: () -> ::Array[Types::Tag]

data/sig/types.rbs

@@ -783,6 +783,19 @@ module Aws::DocDB
       SENSITIVE: []
     end
 
+    class FailoverGlobalClusterMessage
+      attr_accessor global_cluster_identifier: ::String
+      attr_accessor target_db_cluster_identifier: ::String
+      attr_accessor allow_data_loss: bool
+      attr_accessor switchover: bool
+      SENSITIVE: []
+    end
+
+    class FailoverGlobalClusterResult
+      attr_accessor global_cluster: Types::GlobalCluster
+      SENSITIVE: []
+    end
+
     class Filter
       attr_accessor name: ::String
       attr_accessor values: ::Array[::String]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-docdb
 version: !ruby/object:Gem::Version
-  version: 1.70.0
+  version: 1.71.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-07-02 00:00:00.000000000 Z
+date: 2024-08-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core