Class: Aws::Kinesis::Types::QueueDescription

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

Overview

A description of a queue. Returned by CreateQueue, UpdateQueue, and DescribeQueue.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#queue_arn ⇒ String

The ARN of the queue. The resource identifier in the ARN is generated when the queue is created and is not derived from QueueName. Use the returned QueueARN to identify the queue in subsequent requests.

Returns:

  • (String)


2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
# File 'gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/types.rb', line 2934

class QueueDescription < Struct.new(
  :queue_name,
  :queue_arn,
  :queue_status,
  :queue_creation_timestamp,
  :stream_configuration_list,
  :queue_attributes)
  SENSITIVE = []
  include Aws::Structure
end

#queue_attributes ⇒ Types::QueueAttributes

The configuration attributes of the queue.



2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
# File 'gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/types.rb', line 2934

class QueueDescription < Struct.new(
  :queue_name,
  :queue_arn,
  :queue_status,
  :queue_creation_timestamp,
  :stream_configuration_list,
  :queue_attributes)
  SENSITIVE = []
  include Aws::Structure
end

#queue_creation_timestamp ⇒ Time

The time the queue was created.

Returns:

  • (Time)


2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
# File 'gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/types.rb', line 2934

class QueueDescription < Struct.new(
  :queue_name,
  :queue_arn,
  :queue_status,
  :queue_creation_timestamp,
  :stream_configuration_list,
  :queue_attributes)
  SENSITIVE = []
  include Aws::Structure
end

#queue_name ⇒ String

The name of the queue.

Returns:

  • (String)


2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
# File 'gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/types.rb', line 2934

class QueueDescription < Struct.new(
  :queue_name,
  :queue_arn,
  :queue_status,
  :queue_creation_timestamp,
  :stream_configuration_list,
  :queue_attributes)
  SENSITIVE = []
  include Aws::Structure
end

#queue_status ⇒ String

The current status of the queue.

Returns:

  • (String)


2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
# File 'gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/types.rb', line 2934

class QueueDescription < Struct.new(
  :queue_name,
  :queue_arn,
  :queue_status,
  :queue_creation_timestamp,
  :stream_configuration_list,
  :queue_attributes)
  SENSITIVE = []
  include Aws::Structure
end

#stream_configuration_list ⇒ Array<Types::QueueStreamConfiguration>

The data stream the queue delivers records from, and the position in that stream where delivery begins. The list contains exactly one entry, because a queue delivers records from a single data stream.



2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
# File 'gems/aws-sdk-kinesis/lib/aws-sdk-kinesis/types.rb', line 2934

class QueueDescription < Struct.new(
  :queue_name,
  :queue_arn,
  :queue_status,
  :queue_creation_timestamp,
  :stream_configuration_list,
  :queue_attributes)
  SENSITIVE = []
  include Aws::Structure
end