Class: Aws::OSIS::Types::Pipeline

Inherits:

Struct

Object
Struct
Aws::OSIS::Types::Pipeline

show all

Includes:: Structure

Defined in:: lib/aws-sdk-osis/types.rb

Overview

Information about an existing OpenSearch Ingestion pipeline.

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#buffer_options ⇒ Types::BufferOptions

Options that specify the configuration of a persistent buffer.
#created_at ⇒ Time

The date and time when the pipeline was created.
#destinations ⇒ Array<Types::PipelineDestination>

Destinations to which the pipeline writes data.
#encryption_at_rest_options ⇒ Types::EncryptionAtRestOptions

Options to control how OpenSearch encrypts buffer data.
#ingest_endpoint_urls ⇒ Array<String>

The ingestion endpoints for the pipeline, which you can send data to.
#last_updated_at ⇒ Time

The date and time when the pipeline was last updated.
#log_publishing_options ⇒ Types::LogPublishingOptions

Key-value pairs that represent log publishing settings.
#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_configuration_body ⇒ String

The Data Prepper pipeline configuration in YAML format.
#pipeline_name ⇒ String

The name of the pipeline.
#service_vpc_endpoints ⇒ Array<Types::ServiceVpcEndpoint>

A list of VPC endpoints that OpenSearch Ingestion has created to other Amazon Web Services services.
#status ⇒ String

The current status of the pipeline.
#status_reason ⇒ Types::PipelineStatusReason

The reason for the current status of the pipeline.
#tags ⇒ Array<Types::Tag>

A list of tags associated with the given pipeline.
#vpc_endpoint_service ⇒ String

The VPC endpoint service name for the pipeline.
#vpc_endpoints ⇒ Array<Types::VpcEndpoint>

The VPC interface endpoints that have access to the pipeline.

Instance Attribute Details

#buffer_options ⇒ `Types::BufferOptions`

Options that specify the configuration of a persistent buffer. To configure how OpenSearch Ingestion encrypts this data, set the ‘EncryptionAtRestOptions`. For more information, see [Persistent buffering].

[1]: docs.aws.amazon.com/opensearch-service/latest/developerguide/osis-features-overview.html#persistent-buffering

Returns:

(Types::BufferOptions)

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

class Pipeline < Struct.new(
  :pipeline_name,
  :pipeline_arn,
  :min_units,
  :max_units,
  :status,
  :status_reason,
  :pipeline_configuration_body,
  :created_at,
  :last_updated_at,
  :ingest_endpoint_urls,
  :log_publishing_options,
  :vpc_endpoints,
  :buffer_options,
  :encryption_at_rest_options,
  :vpc_endpoint_service,
  :service_vpc_endpoints,
  :destinations,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#created_at ⇒ `Time`

The date and time when the pipeline was created.

Returns:

(Time)

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

class Pipeline < Struct.new(
  :pipeline_name,
  :pipeline_arn,
  :min_units,
  :max_units,
  :status,
  :status_reason,
  :pipeline_configuration_body,
  :created_at,
  :last_updated_at,
  :ingest_endpoint_urls,
  :log_publishing_options,
  :vpc_endpoints,
  :buffer_options,
  :encryption_at_rest_options,
  :vpc_endpoint_service,
  :service_vpc_endpoints,
  :destinations,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#destinations ⇒ `Array<Types::PipelineDestination>`

Destinations to which the pipeline writes data.

Returns:

(Array<Types::PipelineDestination>)

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

class Pipeline < Struct.new(
  :pipeline_name,
  :pipeline_arn,
  :min_units,
  :max_units,
  :status,
  :status_reason,
  :pipeline_configuration_body,
  :created_at,
  :last_updated_at,
  :ingest_endpoint_urls,
  :log_publishing_options,
  :vpc_endpoints,
  :buffer_options,
  :encryption_at_rest_options,
  :vpc_endpoint_service,
  :service_vpc_endpoints,
  :destinations,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#encryption_at_rest_options ⇒ `Types::EncryptionAtRestOptions`

Options to control how OpenSearch encrypts buffer data.

Returns:

(Types::EncryptionAtRestOptions)

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

class Pipeline < Struct.new(
  :pipeline_name,
  :pipeline_arn,
  :min_units,
  :max_units,
  :status,
  :status_reason,
  :pipeline_configuration_body,
  :created_at,
  :last_updated_at,
  :ingest_endpoint_urls,
  :log_publishing_options,
  :vpc_endpoints,
  :buffer_options,
  :encryption_at_rest_options,
  :vpc_endpoint_service,
  :service_vpc_endpoints,
  :destinations,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#ingest_endpoint_urls ⇒ `Array<String>`

The ingestion endpoints for the pipeline, which you can send data to.

Returns:

(Array<String>)

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

class Pipeline < Struct.new(
  :pipeline_name,
  :pipeline_arn,
  :min_units,
  :max_units,
  :status,
  :status_reason,
  :pipeline_configuration_body,
  :created_at,
  :last_updated_at,
  :ingest_endpoint_urls,
  :log_publishing_options,
  :vpc_endpoints,
  :buffer_options,
  :encryption_at_rest_options,
  :vpc_endpoint_service,
  :service_vpc_endpoints,
  :destinations,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#last_updated_at ⇒ `Time`

The date and time when the pipeline was last updated.

Returns:

(Time)

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

class Pipeline < Struct.new(
  :pipeline_name,
  :pipeline_arn,
  :min_units,
  :max_units,
  :status,
  :status_reason,
  :pipeline_configuration_body,
  :created_at,
  :last_updated_at,
  :ingest_endpoint_urls,
  :log_publishing_options,
  :vpc_endpoints,
  :buffer_options,
  :encryption_at_rest_options,
  :vpc_endpoint_service,
  :service_vpc_endpoints,
  :destinations,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#log_publishing_options ⇒ `Types::LogPublishingOptions`

Key-value pairs that represent log publishing settings.

Returns:

(Types::LogPublishingOptions)

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

class Pipeline < Struct.new(
  :pipeline_name,
  :pipeline_arn,
  :min_units,
  :max_units,
  :status,
  :status_reason,
  :pipeline_configuration_body,
  :created_at,
  :last_updated_at,
  :ingest_endpoint_urls,
  :log_publishing_options,
  :vpc_endpoints,
  :buffer_options,
  :encryption_at_rest_options,
  :vpc_endpoint_service,
  :service_vpc_endpoints,
  :destinations,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#max_units ⇒ `Integer`

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

Returns:

(Integer)

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

class Pipeline < Struct.new(
  :pipeline_name,
  :pipeline_arn,
  :min_units,
  :max_units,
  :status,
  :status_reason,
  :pipeline_configuration_body,
  :created_at,
  :last_updated_at,
  :ingest_endpoint_urls,
  :log_publishing_options,
  :vpc_endpoints,
  :buffer_options,
  :encryption_at_rest_options,
  :vpc_endpoint_service,
  :service_vpc_endpoints,
  :destinations,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#min_units ⇒ `Integer`

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

Returns:

(Integer)

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

class Pipeline < Struct.new(
  :pipeline_name,
  :pipeline_arn,
  :min_units,
  :max_units,
  :status,
  :status_reason,
  :pipeline_configuration_body,
  :created_at,
  :last_updated_at,
  :ingest_endpoint_urls,
  :log_publishing_options,
  :vpc_endpoints,
  :buffer_options,
  :encryption_at_rest_options,
  :vpc_endpoint_service,
  :service_vpc_endpoints,
  :destinations,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#pipeline_arn ⇒ `String`

The Amazon Resource Name (ARN) of the pipeline.

Returns:

(String)

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

class Pipeline < Struct.new(
  :pipeline_name,
  :pipeline_arn,
  :min_units,
  :max_units,
  :status,
  :status_reason,
  :pipeline_configuration_body,
  :created_at,
  :last_updated_at,
  :ingest_endpoint_urls,
  :log_publishing_options,
  :vpc_endpoints,
  :buffer_options,
  :encryption_at_rest_options,
  :vpc_endpoint_service,
  :service_vpc_endpoints,
  :destinations,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#pipeline_configuration_body ⇒ `String`

The Data Prepper pipeline configuration in YAML format.

Returns:

(String)

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

class Pipeline < Struct.new(
  :pipeline_name,
  :pipeline_arn,
  :min_units,
  :max_units,
  :status,
  :status_reason,
  :pipeline_configuration_body,
  :created_at,
  :last_updated_at,
  :ingest_endpoint_urls,
  :log_publishing_options,
  :vpc_endpoints,
  :buffer_options,
  :encryption_at_rest_options,
  :vpc_endpoint_service,
  :service_vpc_endpoints,
  :destinations,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#pipeline_name ⇒ `String`

The name of the pipeline.

Returns:

(String)

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

class Pipeline < Struct.new(
  :pipeline_name,
  :pipeline_arn,
  :min_units,
  :max_units,
  :status,
  :status_reason,
  :pipeline_configuration_body,
  :created_at,
  :last_updated_at,
  :ingest_endpoint_urls,
  :log_publishing_options,
  :vpc_endpoints,
  :buffer_options,
  :encryption_at_rest_options,
  :vpc_endpoint_service,
  :service_vpc_endpoints,
  :destinations,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#service_vpc_endpoints ⇒ `Array<Types::ServiceVpcEndpoint>`

A list of VPC endpoints that OpenSearch Ingestion has created to other Amazon Web Services services.

Returns:

(Array<Types::ServiceVpcEndpoint>)

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

class Pipeline < Struct.new(
  :pipeline_name,
  :pipeline_arn,
  :min_units,
  :max_units,
  :status,
  :status_reason,
  :pipeline_configuration_body,
  :created_at,
  :last_updated_at,
  :ingest_endpoint_urls,
  :log_publishing_options,
  :vpc_endpoints,
  :buffer_options,
  :encryption_at_rest_options,
  :vpc_endpoint_service,
  :service_vpc_endpoints,
  :destinations,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ `String`

The current status of the pipeline.

Returns:

(String)

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

class Pipeline < Struct.new(
  :pipeline_name,
  :pipeline_arn,
  :min_units,
  :max_units,
  :status,
  :status_reason,
  :pipeline_configuration_body,
  :created_at,
  :last_updated_at,
  :ingest_endpoint_urls,
  :log_publishing_options,
  :vpc_endpoints,
  :buffer_options,
  :encryption_at_rest_options,
  :vpc_endpoint_service,
  :service_vpc_endpoints,
  :destinations,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#status_reason ⇒ `Types::PipelineStatusReason`

The reason for the current status of the pipeline.

Returns:

(Types::PipelineStatusReason)

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

class Pipeline < Struct.new(
  :pipeline_name,
  :pipeline_arn,
  :min_units,
  :max_units,
  :status,
  :status_reason,
  :pipeline_configuration_body,
  :created_at,
  :last_updated_at,
  :ingest_endpoint_urls,
  :log_publishing_options,
  :vpc_endpoints,
  :buffer_options,
  :encryption_at_rest_options,
  :vpc_endpoint_service,
  :service_vpc_endpoints,
  :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 'lib/aws-sdk-osis/types.rb', line 524

class Pipeline < Struct.new(
  :pipeline_name,
  :pipeline_arn,
  :min_units,
  :max_units,
  :status,
  :status_reason,
  :pipeline_configuration_body,
  :created_at,
  :last_updated_at,
  :ingest_endpoint_urls,
  :log_publishing_options,
  :vpc_endpoints,
  :buffer_options,
  :encryption_at_rest_options,
  :vpc_endpoint_service,
  :service_vpc_endpoints,
  :destinations,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#vpc_endpoint_service ⇒ `String`

The VPC endpoint service name for the pipeline.

Returns:

(String)

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

class Pipeline < Struct.new(
  :pipeline_name,
  :pipeline_arn,
  :min_units,
  :max_units,
  :status,
  :status_reason,
  :pipeline_configuration_body,
  :created_at,
  :last_updated_at,
  :ingest_endpoint_urls,
  :log_publishing_options,
  :vpc_endpoints,
  :buffer_options,
  :encryption_at_rest_options,
  :vpc_endpoint_service,
  :service_vpc_endpoints,
  :destinations,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#vpc_endpoints ⇒ `Array<Types::VpcEndpoint>`

The VPC interface endpoints that have access to the pipeline.

Returns:

(Array<Types::VpcEndpoint>)

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

class Pipeline < Struct.new(
  :pipeline_name,
  :pipeline_arn,
  :min_units,
  :max_units,
  :status,
  :status_reason,
  :pipeline_configuration_body,
  :created_at,
  :last_updated_at,
  :ingest_endpoint_urls,
  :log_publishing_options,
  :vpc_endpoints,
  :buffer_options,
  :encryption_at_rest_options,
  :vpc_endpoint_service,
  :service_vpc_endpoints,
  :destinations,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

Class: Aws::OSIS::Types::Pipeline

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#buffer_options ⇒ Types::BufferOptions

#created_at ⇒ Time

#destinations ⇒ Array<Types::PipelineDestination>

#encryption_at_rest_options ⇒ Types::EncryptionAtRestOptions

#ingest_endpoint_urls ⇒ Array<String>

#last_updated_at ⇒ Time

#log_publishing_options ⇒ Types::LogPublishingOptions

#max_units ⇒ Integer

#min_units ⇒ Integer

#pipeline_arn ⇒ String

#pipeline_configuration_body ⇒ String

#pipeline_name ⇒ String

#service_vpc_endpoints ⇒ Array<Types::ServiceVpcEndpoint>

#status ⇒ String

#status_reason ⇒ Types::PipelineStatusReason

#tags ⇒ Array<Types::Tag>

#vpc_endpoint_service ⇒ String

#vpc_endpoints ⇒ Array<Types::VpcEndpoint>

#buffer_options ⇒ `Types::BufferOptions`

#created_at ⇒ `Time`

#destinations ⇒ `Array<Types::PipelineDestination>`

#encryption_at_rest_options ⇒ `Types::EncryptionAtRestOptions`

#ingest_endpoint_urls ⇒ `Array<String>`

#last_updated_at ⇒ `Time`

#log_publishing_options ⇒ `Types::LogPublishingOptions`

#max_units ⇒ `Integer`

#min_units ⇒ `Integer`

#pipeline_arn ⇒ `String`

#pipeline_configuration_body ⇒ `String`

#pipeline_name ⇒ `String`

#service_vpc_endpoints ⇒ `Array<Types::ServiceVpcEndpoint>`

#status ⇒ `String`

#status_reason ⇒ `Types::PipelineStatusReason`

#tags ⇒ `Array<Types::Tag>`

#vpc_endpoint_service ⇒ `String`

#vpc_endpoints ⇒ `Array<Types::VpcEndpoint>`