Class: Aws::OSIS::Types::PipelineSummary

Inherits:

Struct

• Object
• Struct
• Aws::OSIS::Types::PipelineSummary

Defined in:

gems/aws-sdk-osis/lib/aws-sdk-osis/types.rb

Overview

Summary information for an OpenSearch Ingestion pipeline.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #created_at ⇒ Time

  The date and time when the pipeline was created.

• #destinations ⇒ Array<Types::PipelineDestination>

  A list of destinations to which the pipeline writes data.

• #last_updated_at ⇒ Time

  The date and time when the pipeline was last updated.

• #max_units ⇒ Integer

  The maximum pipeline capacity, in Ingestion Compute Units (ICUs).

• #min_units ⇒ Integer

  The minimum pipeline capacity, in Ingestion Compute Units (ICUs).

• #pipeline_arn ⇒ String

  The Amazon Resource Name (ARN) of the pipeline.

• #pipeline_name ⇒ String

  The name of the pipeline.

• #status ⇒ String

  The current status of the pipeline.

• #status_reason ⇒ Types::PipelineStatusReason

  Information about a pipeline's current status.

• #tags ⇒ Array<Types::Tag>

  A list of tags associated with the given pipeline.

Instance Attribute Details

#created_at ⇒ Time

The date and time when the pipeline was created.

Returns:

• (Time)

# File 'gems/aws-sdk-osis/lib/aws-sdk-osis/types.rb', line 997

class PipelineSummary < Struct.new(
  :status,
  :status_reason,
  :pipeline_name,
  :pipeline_arn,
  :min_units,
  :max_units,
  :created_at,
  :last_updated_at,
  :destinations,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#destinations ⇒ Array<Types::PipelineDestination>

A list of destinations to which the pipeline writes data.

Returns:

• (Array<Types::PipelineDestination>)

# File 'gems/aws-sdk-osis/lib/aws-sdk-osis/types.rb', line 997

class PipelineSummary < Struct.new(
  :status,
  :status_reason,
  :pipeline_name,
  :pipeline_arn,
  :min_units,
  :max_units,
  :created_at,
  :last_updated_at,
  :destinations,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#last_updated_at ⇒ Time

The date and time when the pipeline was last updated.

Returns:

• (Time)

# File 'gems/aws-sdk-osis/lib/aws-sdk-osis/types.rb', line 997

class PipelineSummary < Struct.new(
  :status,
  :status_reason,
  :pipeline_name,
  :pipeline_arn,
  :min_units,
  :max_units,
  :created_at,
  :last_updated_at,
  :destinations,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#max_units ⇒ Integer

The maximum pipeline capacity, in Ingestion Compute Units (ICUs).

Returns:

• (Integer)

# File 'gems/aws-sdk-osis/lib/aws-sdk-osis/types.rb', line 997

class PipelineSummary < Struct.new(
  :status,
  :status_reason,
  :pipeline_name,
  :pipeline_arn,
  :min_units,
  :max_units,
  :created_at,
  :last_updated_at,
  :destinations,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#min_units ⇒ Integer

The minimum pipeline capacity, in Ingestion Compute Units (ICUs).

Returns:

• (Integer)

# File 'gems/aws-sdk-osis/lib/aws-sdk-osis/types.rb', line 997

class PipelineSummary < Struct.new(
  :status,
  :status_reason,
  :pipeline_name,
  :pipeline_arn,
  :min_units,
  :max_units,
  :created_at,
  :last_updated_at,
  :destinations,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#pipeline_arn ⇒ String

The Amazon Resource Name (ARN) of the pipeline.

Returns:

• (String)

# File 'gems/aws-sdk-osis/lib/aws-sdk-osis/types.rb', line 997

class PipelineSummary < Struct.new(
  :status,
  :status_reason,
  :pipeline_name,
  :pipeline_arn,
  :min_units,
  :max_units,
  :created_at,
  :last_updated_at,
  :destinations,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#pipeline_name ⇒ String

The name of the pipeline.

Returns:

• (String)

# File 'gems/aws-sdk-osis/lib/aws-sdk-osis/types.rb', line 997

class PipelineSummary < Struct.new(
  :status,
  :status_reason,
  :pipeline_name,
  :pipeline_arn,
  :min_units,
  :max_units,
  :created_at,
  :last_updated_at,
  :destinations,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ String

The current status of the pipeline.

Returns:

• (String)

# File 'gems/aws-sdk-osis/lib/aws-sdk-osis/types.rb', line 997

class PipelineSummary < Struct.new(
  :status,
  :status_reason,
  :pipeline_name,
  :pipeline_arn,
  :min_units,
  :max_units,
  :created_at,
  :last_updated_at,
  :destinations,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#status_reason ⇒ Types::PipelineStatusReason

Information about a pipeline's current status.

Returns:

• (Types::PipelineStatusReason)

# File 'gems/aws-sdk-osis/lib/aws-sdk-osis/types.rb', line 997

class PipelineSummary < Struct.new(
  :status,
  :status_reason,
  :pipeline_name,
  :pipeline_arn,
  :min_units,
  :max_units,
  :created_at,
  :last_updated_at,
  :destinations,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Array<Types::Tag>

A list of tags associated with the given pipeline.

Returns:

• (Array<Types::Tag>)

# File 'gems/aws-sdk-osis/lib/aws-sdk-osis/types.rb', line 997

class PipelineSummary < Struct.new(
  :status,
  :status_reason,
  :pipeline_name,
  :pipeline_arn,
  :min_units,
  :max_units,
  :created_at,
  :last_updated_at,
  :destinations,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end