Class: Aws::Firehose::Types::MSKSourceDescription

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

Overview

Details about the Amazon MSK cluster used as the source for a Firehose Firehose stream.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#authentication_configuration ⇒ Types::AuthenticationConfiguration

The authentication configuration of the Amazon MSK cluster.

Returns:



3429
3430
3431
3432
3433
3434
3435
3436
3437
 
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 3429

class MSKSourceDescription < Struct.new(
  :msk_cluster_arn,
  :topic_name,
  :authentication_configuration,
  :delivery_start_timestamp,
  :read_from_timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#delivery_start_timestamp ⇒ Time

Firehose starts retrieving records from the topic within the Amazon MSK cluster starting with this timestamp.

Returns:

  • (Time) 


3429
3430
3431
3432
3433
3434
3435
3436
3437
 
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 3429

class MSKSourceDescription < Struct.new(
  :msk_cluster_arn,
  :topic_name,
  :authentication_configuration,
  :delivery_start_timestamp,
  :read_from_timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#msk_cluster_arn ⇒ String

The ARN of the Amazon MSK cluster.

Returns:

  • (String) 


3429
3430
3431
3432
3433
3434
3435
3436
3437
 
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 3429

class MSKSourceDescription < Struct.new(
  :msk_cluster_arn,
  :topic_name,
  :authentication_configuration,
  :delivery_start_timestamp,
  :read_from_timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#read_from_timestamp ⇒ Time

The start date and time in UTC for the offset position within your MSK topic from where Firehose begins to read. By default, this is set to timestamp when Firehose becomes Active.

If you want to create a Firehose stream with Earliest start position from SDK or CLI, you need to set the ReadFromTimestampUTC parameter to Epoch (1970-01-01T00:00:00Z).

Returns:

  • (Time) 


3429
3430
3431
3432
3433
3434
3435
3436
3437
 
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 3429

class MSKSourceDescription < Struct.new(
  :msk_cluster_arn,
  :topic_name,
  :authentication_configuration,
  :delivery_start_timestamp,
  :read_from_timestamp)
  SENSITIVE = []
  include Aws::Structure
end

#topic_name ⇒ String

The topic name within the Amazon MSK cluster.

Returns:

  • (String) 


3429
3430
3431
3432
3433
3434
3435
3436
3437
 
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 3429

class MSKSourceDescription < Struct.new(
  :msk_cluster_arn,
  :topic_name,
  :authentication_configuration,
  :delivery_start_timestamp,
  :read_from_timestamp)
  SENSITIVE = []
  include Aws::Structure
end