aws-sdk-dsql 1.26.0 → 1.28.0

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

@@ -178,6 +178,100 @@ module Aws::DSQL
       include Aws::Structure
     end
 
+    # @!attribute [rw] cluster_identifier
+    #   The ID of the cluster for which to create the stream.
+    #   @return [String]
+    #
+    # @!attribute [rw] target_definition
+    #   The target destination configuration for the stream. Contains
+    #   Kinesis stream configuration including stream ARN and IAM role ARN.
+    #   @return [Types::TargetDefinition]
+    #
+    # @!attribute [rw] ordering
+    #   The ordering mode for the stream. Determines how change events are
+    #   ordered when delivered to the target.
+    #   @return [String]
+    #
+    # @!attribute [rw] format
+    #   The format of the stream records.
+    #   @return [String]
+    #
+    # @!attribute [rw] tags
+    #   A map of key and value pairs to use to tag your stream.
+    #   @return [Hash<String,String>]
+    #
+    # @!attribute [rw] client_token
+    #   A unique, case-sensitive identifier that you provide to ensure the
+    #   idempotency of the request. Idempotency ensures that an API request
+    #   completes only once. With an idempotent request, if the original
+    #   request completes successfully, the subsequent retries with the same
+    #   client token return the result from the original successful request
+    #   and they have no additional effect.
+    #
+    #   If you don't specify a client token, the Amazon Web Services SDK
+    #   automatically generates one.
+    #
+    #   **A suitable default value is auto-generated.** You should normally
+    #   not need to pass this option.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/dsql-2018-05-10/CreateStreamInput AWS API Documentation
+    #
+    class CreateStreamInput < Struct.new(
+      :cluster_identifier,
+      :target_definition,
+      :ordering,
+      :format,
+      :tags,
+      :client_token)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # The output of a created stream.
+    #
+    # @!attribute [rw] cluster_identifier
+    #   The ID of the cluster for the created stream.
+    #   @return [String]
+    #
+    # @!attribute [rw] stream_identifier
+    #   The ID of the created stream.
+    #   @return [String]
+    #
+    # @!attribute [rw] arn
+    #   The ARN of the created stream.
+    #   @return [String]
+    #
+    # @!attribute [rw] status
+    #   The status of the created stream.
+    #   @return [String]
+    #
+    # @!attribute [rw] creation_time
+    #   The time when created the stream.
+    #   @return [Time]
+    #
+    # @!attribute [rw] ordering
+    #   The ordering mode of the created stream.
+    #   @return [String]
+    #
+    # @!attribute [rw] format
+    #   The format of the created stream records.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/dsql-2018-05-10/CreateStreamOutput AWS API Documentation
+    #
+    class CreateStreamOutput < Struct.new(
+      :cluster_identifier,
+      :stream_identifier,
+      :arn,
+      :status,
+      :creation_time,
+      :ordering,
+      :format)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # @!attribute [rw] identifier
     #   The ID of the cluster to delete.
     #   @return [String]
@@ -274,6 +368,73 @@ module Aws::DSQL
       include Aws::Structure
     end
 
+    # @!attribute [rw] cluster_identifier
+    #   The ID of the cluster containing the stream to delete.
+    #   @return [String]
+    #
+    # @!attribute [rw] stream_identifier
+    #   The ID of the stream to delete.
+    #   @return [String]
+    #
+    # @!attribute [rw] client_token
+    #   A unique, case-sensitive identifier that you provide to ensure the
+    #   idempotency of the request. Idempotency ensures that an API request
+    #   completes only once. With an idempotent request, if the original
+    #   request completes successfully, the subsequent retries with the same
+    #   client token return the result from the original successful request
+    #   and they have no additional effect.
+    #
+    #   If you don't specify a client token, the Amazon Web Services SDK
+    #   automatically generates one.
+    #
+    #   **A suitable default value is auto-generated.** You should normally
+    #   not need to pass this option.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/dsql-2018-05-10/DeleteStreamInput AWS API Documentation
+    #
+    class DeleteStreamInput < Struct.new(
+      :cluster_identifier,
+      :stream_identifier,
+      :client_token)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # The output from a deleted stream.
+    #
+    # @!attribute [rw] cluster_identifier
+    #   The ID of the cluster for the deleted stream.
+    #   @return [String]
+    #
+    # @!attribute [rw] stream_identifier
+    #   The ID of the deleted stream.
+    #   @return [String]
+    #
+    # @!attribute [rw] arn
+    #   The ARN of the deleted stream.
+    #   @return [String]
+    #
+    # @!attribute [rw] status
+    #   The status of the stream.
+    #   @return [String]
+    #
+    # @!attribute [rw] creation_time
+    #   The time when the stream was created.
+    #   @return [Time]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/dsql-2018-05-10/DeleteStreamOutput AWS API Documentation
+    #
+    class DeleteStreamOutput < Struct.new(
+      :cluster_identifier,
+      :stream_identifier,
+      :arn,
+      :status,
+      :creation_time)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # Configuration details about encryption for the cluster including the
     # KMS key ARN, encryption type, and encryption status.
     #
@@ -397,6 +558,82 @@ module Aws::DSQL
       include Aws::Structure
     end
 
+    # @!attribute [rw] cluster_identifier
+    #   The ID of the cluster containing the stream to retrieve.
+    #   @return [String]
+    #
+    # @!attribute [rw] stream_identifier
+    #   The ID of the stream to retrieve.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/dsql-2018-05-10/GetStreamInput AWS API Documentation
+    #
+    class GetStreamInput < Struct.new(
+      :cluster_identifier,
+      :stream_identifier)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # The output of a retrieved stream.
+    #
+    # @!attribute [rw] cluster_identifier
+    #   The ID of the cluster for the retrieved stream.
+    #   @return [String]
+    #
+    # @!attribute [rw] stream_identifier
+    #   The ID of the retrieved stream.
+    #   @return [String]
+    #
+    # @!attribute [rw] arn
+    #   The ARN of the retrieved stream.
+    #   @return [String]
+    #
+    # @!attribute [rw] status
+    #   The current status of the retrieved stream.
+    #   @return [String]
+    #
+    # @!attribute [rw] creation_time
+    #   The time when the stream was created.
+    #   @return [Time]
+    #
+    # @!attribute [rw] ordering
+    #   The ordering mode of the stream.
+    #   @return [String]
+    #
+    # @!attribute [rw] format
+    #   The format of the stream records.
+    #   @return [String]
+    #
+    # @!attribute [rw] target_definition
+    #   The target definition for the stream destination.
+    #   @return [Types::TargetDefinition]
+    #
+    # @!attribute [rw] status_reason
+    #   Stream status reason with error code and timestamp (if applicable).
+    #   @return [Types::StatusReason]
+    #
+    # @!attribute [rw] tags
+    #   A map of tags associated with the stream.
+    #   @return [Hash<String,String>]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/dsql-2018-05-10/GetStreamOutput AWS API Documentation
+    #
+    class GetStreamOutput < Struct.new(
+      :cluster_identifier,
+      :stream_identifier,
+      :arn,
+      :status,
+      :creation_time,
+      :ordering,
+      :format,
+      :target_definition,
+      :status_reason,
+      :tags)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # @!attribute [rw] identifier
     #   The ID of the cluster to retrieve.
     #   @return [String]
@@ -445,6 +682,29 @@ module Aws::DSQL
       include Aws::Structure
     end
 
+    # Kinesis stream target configuration.
+    #
+    # @!attribute [rw] stream_arn
+    #   The ARN of the Kinesis stream.
+    #   @return [String]
+    #
+    # @!attribute [rw] role_arn
+    #   The ARN of the IAM role that grants permission to write to the
+    #   Kinesis stream. This can be a standard role
+    #   (`arn:aws:iam::account-id:role/role-name`) or a role with a path
+    #   prefix (`arn:aws:iam::account-id:role/service-role/role-name`), such
+    #   as roles auto-created by the console.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/dsql-2018-05-10/KinesisTargetDefinition AWS API Documentation
+    #
+    class KinesisTargetDefinition < Struct.new(
+      :stream_arn,
+      :role_arn)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # @!attribute [rw] max_results
     #   An optional parameter that specifies the maximum number of results
     #   to return. You can use nextToken to display the next page of
@@ -486,6 +746,52 @@ module Aws::DSQL
       include Aws::Structure
     end
 
+    # @!attribute [rw] cluster_identifier
+    #   The ID of the cluster for which to list streams.
+    #   @return [String]
+    #
+    # @!attribute [rw] max_results
+    #   An optional parameter that specifies the maximum number of results
+    #   to return. You can use nextToken to display the next page of
+    #   results. Default: 10.
+    #   @return [Integer]
+    #
+    # @!attribute [rw] next_token
+    #   If your initial ListStreams operation returns a nextToken, you can
+    #   include the returned nextToken in following ListStreams operations,
+    #   which returns results in the next page.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/dsql-2018-05-10/ListStreamsInput AWS API Documentation
+    #
+    class ListStreamsInput < Struct.new(
+      :cluster_identifier,
+      :max_results,
+      :next_token)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] next_token
+    #   If nextToken is returned, there are more results available. The
+    #   value of nextToken is a unique pagination token for each page. To
+    #   retrieve the next page, make the call again using the returned
+    #   token.
+    #   @return [String]
+    #
+    # @!attribute [rw] streams
+    #   An array of the returned streams.
+    #   @return [Array<Types::StreamSummary>]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/dsql-2018-05-10/ListStreamsOutput AWS API Documentation
+    #
+    class ListStreamsOutput < Struct.new(
+      :next_token,
+      :streams)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # @!attribute [rw] resource_arn
     #   The ARN of the resource for which you want to list the tags.
     #   @return [String]
@@ -644,6 +950,59 @@ module Aws::DSQL
       include Aws::Structure
     end
 
+    # Stream status reason with error and timestamp.
+    #
+    # @!attribute [rw] error
+    #   The error code for the stream failure.
+    #   @return [String]
+    #
+    # @!attribute [rw] updated_at
+    #   The timestamp when the status was updated.
+    #   @return [Time]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/dsql-2018-05-10/StatusReason AWS API Documentation
+    #
+    class StatusReason < Struct.new(
+      :error,
+      :updated_at)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # Summary information about a stream.
+    #
+    # @!attribute [rw] cluster_identifier
+    #   The ID of the cluster.
+    #   @return [String]
+    #
+    # @!attribute [rw] stream_identifier
+    #   The ID of the stream.
+    #   @return [String]
+    #
+    # @!attribute [rw] arn
+    #   The ARN of the stream.
+    #   @return [String]
+    #
+    # @!attribute [rw] creation_time
+    #   The timestamp when the stream was created.
+    #   @return [Time]
+    #
+    # @!attribute [rw] status
+    #   The current status of the stream.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/dsql-2018-05-10/StreamSummary AWS API Documentation
+    #
+    class StreamSummary < Struct.new(
+      :cluster_identifier,
+      :stream_identifier,
+      :arn,
+      :creation_time,
+      :status)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # @!attribute [rw] resource_arn
     #   The ARN of the resource that you want to tag.
     #   @return [String]
@@ -661,6 +1020,29 @@ module Aws::DSQL
       include Aws::Structure
     end
 
+    # Target definition for stream destination.
+    #
+    # @note TargetDefinition is a union - when making an API calls you must set exactly one of the members.
+    #
+    # @note TargetDefinition is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of TargetDefinition corresponding to the set member.
+    #
+    # @!attribute [rw] kinesis
+    #   Kinesis stream target configuration.
+    #   @return [Types::KinesisTargetDefinition]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/dsql-2018-05-10/TargetDefinition AWS API Documentation
+    #
+    class TargetDefinition < Struct.new(
+      :kinesis,
+      :unknown)
+      SENSITIVE = []
+      include Aws::Structure
+      include Aws::Structure::Union
+
+      class Kinesis < TargetDefinition; end
+      class Unknown < TargetDefinition; end
+    end
+
     # The request was denied due to request throttling.
     #
     # @!attribute [rw] message

data/lib/aws-sdk-dsql/waiters.rb

@@ -71,6 +71,8 @@ module Aws::DSQL
   # | ------------------ | -------------------- | -------- | ------------- |
   # | cluster_active     | {Client#get_cluster} | 2        | 60            |
   # | cluster_not_exists | {Client#get_cluster} | 2        | 60            |
+  # | stream_active      | {Client#get_stream}  | 2        | 60            |
+  # | stream_not_exists  | {Client#get_stream}  | 2        | 60            |
   #
   module Waiters
 
@@ -146,5 +148,78 @@ module Aws::DSQL
       attr_reader :waiter
 
     end
+
+    # Wait until a Stream is ACTIVE
+    class StreamActive
+
+      # @param [Hash] options
+      # @option options [required, Client] :client
+      # @option options [Integer] :max_attempts (60)
+      # @option options [Integer] :delay (2)
+      # @option options [Proc] :before_attempt
+      # @option options [Proc] :before_wait
+      def initialize(options)
+        @client = options.fetch(:client)
+        @waiter = Aws::Waiters::Waiter.new({
+          max_attempts: 60,
+          delay: 2,
+          poller: Aws::Waiters::Poller.new(
+            operation_name: :get_stream,
+            acceptors: [{
+              "matcher" => "path",
+              "argument" => "status",
+              "state" => "success",
+              "expected" => "ACTIVE"
+            }]
+          )
+        }.merge(options))
+      end
+
+      # @option (see Client#get_stream)
+      # @return (see Client#get_stream)
+      def wait(params = {})
+        @waiter.wait(client: @client, params: params)
+      end
+
+      # @api private
+      attr_reader :waiter
+
+    end
+
+    # Wait until a Stream is gone
+    class StreamNotExists
+
+      # @param [Hash] options
+      # @option options [required, Client] :client
+      # @option options [Integer] :max_attempts (60)
+      # @option options [Integer] :delay (2)
+      # @option options [Proc] :before_attempt
+      # @option options [Proc] :before_wait
+      def initialize(options)
+        @client = options.fetch(:client)
+        @waiter = Aws::Waiters::Waiter.new({
+          max_attempts: 60,
+          delay: 2,
+          poller: Aws::Waiters::Poller.new(
+            operation_name: :get_stream,
+            acceptors: [{
+              "matcher" => "error",
+              "state" => "success",
+              "expected" => "ResourceNotFoundException"
+            }]
+          )
+        }.merge(options))
+      end
+
+      # @option (see Client#get_stream)
+      # @return (see Client#get_stream)
+      def wait(params = {})
+        @waiter.wait(client: @client, params: params)
+      end
+
+      # @api private
+      attr_reader :waiter
+
+    end
   end
 end

data/lib/aws-sdk-dsql.rb

@@ -55,7 +55,7 @@ module Aws::DSQL
   autoload :EndpointProvider, 'aws-sdk-dsql/endpoint_provider'
   autoload :Endpoints, 'aws-sdk-dsql/endpoints'
 
-  GEM_VERSION = '1.26.0'
+  GEM_VERSION = '1.28.0'
 
 end
 

data/sig/client.rbs

@@ -104,6 +104,32 @@ module Aws
                           ) -> _CreateClusterResponseSuccess
                         | (?Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreateClusterResponseSuccess
 
+      interface _CreateStreamResponseSuccess
+        include ::Seahorse::Client::_ResponseSuccess[Types::CreateStreamOutput]
+        def cluster_identifier: () -> ::String
+        def stream_identifier: () -> ::String
+        def arn: () -> ::String
+        def status: () -> ("CREATING" | "ACTIVE" | "DELETING" | "DELETED" | "FAILED" | "IMPAIRED")
+        def creation_time: () -> ::Time
+        def ordering: () -> ("UNORDERED")
+        def format: () -> ("JSON")
+      end
+      # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/DSQL/Client.html#create_stream-instance_method
+      def create_stream: (
+                           cluster_identifier: ::String,
+                           target_definition: {
+                             kinesis: {
+                               stream_arn: ::String,
+                               role_arn: ::String
+                             }?
+                           },
+                           ordering: ("UNORDERED"),
+                           format: ("JSON"),
+                           ?tags: Hash[::String, ::String],
+                           ?client_token: ::String
+                         ) -> _CreateStreamResponseSuccess
+                       | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreateStreamResponseSuccess
+
       interface _DeleteClusterResponseSuccess
         include ::Seahorse::Client::_ResponseSuccess[Types::DeleteClusterOutput]
         def identifier: () -> ::String
@@ -130,6 +156,22 @@ module Aws
                                  ) -> _DeleteClusterPolicyResponseSuccess
                                | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DeleteClusterPolicyResponseSuccess
 
+      interface _DeleteStreamResponseSuccess
+        include ::Seahorse::Client::_ResponseSuccess[Types::DeleteStreamOutput]
+        def cluster_identifier: () -> ::String
+        def stream_identifier: () -> ::String
+        def arn: () -> ::String
+        def status: () -> ("CREATING" | "ACTIVE" | "DELETING" | "DELETED" | "FAILED" | "IMPAIRED")
+        def creation_time: () -> ::Time
+      end
+      # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/DSQL/Client.html#delete_stream-instance_method
+      def delete_stream: (
+                           cluster_identifier: ::String,
+                           stream_identifier: ::String,
+                           ?client_token: ::String
+                         ) -> _DeleteStreamResponseSuccess
+                       | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DeleteStreamResponseSuccess
+
       interface _GetClusterResponseSuccess
         include ::Seahorse::Client::_ResponseSuccess[Types::GetClusterOutput]
         def identifier: () -> ::String
@@ -159,6 +201,26 @@ module Aws
                               ) -> _GetClusterPolicyResponseSuccess
                             | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetClusterPolicyResponseSuccess
 
+      interface _GetStreamResponseSuccess
+        include ::Seahorse::Client::_ResponseSuccess[Types::GetStreamOutput]
+        def cluster_identifier: () -> ::String
+        def stream_identifier: () -> ::String
+        def arn: () -> ::String
+        def status: () -> ("CREATING" | "ACTIVE" | "DELETING" | "DELETED" | "FAILED" | "IMPAIRED")
+        def creation_time: () -> ::Time
+        def ordering: () -> ("UNORDERED")
+        def format: () -> ("JSON")
+        def target_definition: () -> Types::TargetDefinition
+        def status_reason: () -> Types::StatusReason
+        def tags: () -> ::Hash[::String, ::String]
+      end
+      # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/DSQL/Client.html#get_stream-instance_method
+      def get_stream: (
+                        cluster_identifier: ::String,
+                        stream_identifier: ::String
+                      ) -> _GetStreamResponseSuccess
+                    | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetStreamResponseSuccess
+
       interface _GetVpcEndpointServiceNameResponseSuccess
         include ::Seahorse::Client::_ResponseSuccess[Types::GetVpcEndpointServiceNameOutput]
         def service_name: () -> ::String
@@ -182,6 +244,19 @@ module Aws
                          ) -> _ListClustersResponseSuccess
                        | (?Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListClustersResponseSuccess
 
+      interface _ListStreamsResponseSuccess
+        include ::Seahorse::Client::_ResponseSuccess[Types::ListStreamsOutput]
+        def next_token: () -> ::String
+        def streams: () -> ::Array[Types::StreamSummary]
+      end
+      # https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/DSQL/Client.html#list_streams-instance_method
+      def list_streams: (
+                          cluster_identifier: ::String,
+                          ?max_results: ::Integer,
+                          ?next_token: ::String
+                        ) -> _ListStreamsResponseSuccess
+                      | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListStreamsResponseSuccess
+
       interface _ListTagsForResourceResponseSuccess
         include ::Seahorse::Client::_ResponseSuccess[Types::ListTagsForResourceOutput]
         def tags: () -> ::Hash[::String, ::String]
@@ -249,6 +324,16 @@ module Aws
                     identifier: ::String
                   ) -> Client::_GetClusterResponseSuccess
                     | (:cluster_not_exists waiter_name, Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> Client::_GetClusterResponseSuccess
+                    | (:stream_active waiter_name, 
+                    cluster_identifier: ::String,
+                    stream_identifier: ::String
+                  ) -> Client::_GetStreamResponseSuccess
+                    | (:stream_active waiter_name, Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> Client::_GetStreamResponseSuccess
+                    | (:stream_not_exists waiter_name, 
+                    cluster_identifier: ::String,
+                    stream_identifier: ::String
+                  ) -> Client::_GetStreamResponseSuccess
+                    | (:stream_not_exists waiter_name, Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> Client::_GetStreamResponseSuccess
     end
   end
 end