Pipeline - Amazon OpenSearch Service

Pipeline

Information about an existing OpenSearch Ingestion pipeline.

Contents

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.

Type: BufferOptions object

Required: No

CreatedAt

The date and time when the pipeline was created.

Type: Timestamp

Required: No

Destinations

Destinations to which the pipeline writes data.

Type: Array of PipelineDestination objects

Required: No

EncryptionAtRestOptions

Options to control how OpenSearch encrypts buffer data.

Type: EncryptionAtRestOptions object

Required: No

IngestEndpointUrls

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

Type: Array of strings

Required: No

LastUpdatedAt

The date and time when the pipeline was last updated.

Type: Timestamp

Required: No

LogPublishingOptions

Key-value pairs that represent log publishing settings.

Type: LogPublishingOptions object

Required: No

MaxUnits

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

Type: Integer

Required: No

MinUnits

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

Type: Integer

Required: No

PipelineArn

The Amazon Resource Name (ARN) of the pipeline.

Type: String

Required: No

PipelineConfigurationBody

The Data Prepper pipeline configuration in YAML format.

Type: String

Required: No

PipelineName

The name of the pipeline.

Type: String

Required: No

ServiceVpcEndpoints

A list of VPC endpoints that OpenSearch Ingestion has created to other AWS services.

Type: Array of ServiceVpcEndpoint objects

Required: No

Status

The current status of the pipeline.

Type: String

Valid Values: CREATING | ACTIVE | UPDATING | DELETING | CREATE_FAILED | UPDATE_FAILED | STARTING | START_FAILED | STOPPING | STOPPED

Required: No

StatusReason

The reason for the current status of the pipeline.

Type: PipelineStatusReason object

Required: No

Tags

A list of tags associated with the given pipeline.

Type: Array of Tag objects

Required: No

VpcEndpoints

The VPC interface endpoints that have access to the pipeline.

Type: Array of VpcEndpoint objects

Required: No

VpcEndpointService

The VPC endpoint service name for the pipeline.

Type: String

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: