Class: Aws::DSQL::Types::CreateStreamInput

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-dsql/lib/aws-sdk-dsql/types.rb

Overview

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#client_tokenString

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.

Returns:

  • (String)


220
221
222
223
224
225
226
227
228
229
# File 'gems/aws-sdk-dsql/lib/aws-sdk-dsql/types.rb', line 220

class CreateStreamInput < Struct.new(
  :cluster_identifier,
  :target_definition,
  :ordering,
  :format,
  :tags,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#cluster_identifierString

The ID of the cluster for which to create the stream.

Returns:

  • (String)


220
221
222
223
224
225
226
227
228
229
# File 'gems/aws-sdk-dsql/lib/aws-sdk-dsql/types.rb', line 220

class CreateStreamInput < Struct.new(
  :cluster_identifier,
  :target_definition,
  :ordering,
  :format,
  :tags,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#formatString

The format of the stream records.

Returns:

  • (String)


220
221
222
223
224
225
226
227
228
229
# File 'gems/aws-sdk-dsql/lib/aws-sdk-dsql/types.rb', line 220

class CreateStreamInput < Struct.new(
  :cluster_identifier,
  :target_definition,
  :ordering,
  :format,
  :tags,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#orderingString

The ordering mode for the stream. Determines how change events are ordered when delivered to the target.

Returns:

  • (String)


220
221
222
223
224
225
226
227
228
229
# File 'gems/aws-sdk-dsql/lib/aws-sdk-dsql/types.rb', line 220

class CreateStreamInput < Struct.new(
  :cluster_identifier,
  :target_definition,
  :ordering,
  :format,
  :tags,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#tagsHash<String,String>

A map of key and value pairs to use to tag your stream.

Returns:

  • (Hash<String,String>)


220
221
222
223
224
225
226
227
228
229
# File 'gems/aws-sdk-dsql/lib/aws-sdk-dsql/types.rb', line 220

class CreateStreamInput < Struct.new(
  :cluster_identifier,
  :target_definition,
  :ordering,
  :format,
  :tags,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#target_definitionTypes::TargetDefinition

The target destination configuration for the stream. Contains Kinesis stream configuration including stream ARN and IAM role ARN.



220
221
222
223
224
225
226
227
228
229
# File 'gems/aws-sdk-dsql/lib/aws-sdk-dsql/types.rb', line 220

class CreateStreamInput < Struct.new(
  :cluster_identifier,
  :target_definition,
  :ordering,
  :format,
  :tags,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end