osis/aws.sdk.kotlin.services.osis.model/Pipeline

Pipeline

class Pipeline

Information about an existing OpenSearch Ingestion pipeline.

Types

Builder

class Builder

Companion

object Companion

Properties

bufferOptions

val bufferOptions: 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.

createdAt

val createdAt: Instant?

The date and time when the pipeline was created.

destinations

val destinations: List<PipelineDestination>?

Destinations to which the pipeline writes data.

encryptionAtRestOptions

val encryptionAtRestOptions: EncryptionAtRestOptions?

Options to control how OpenSearch encrypts buffer data.

ingestEndpointUrls

val ingestEndpointUrls: List<String>?

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

lastUpdatedAt

val lastUpdatedAt: Instant?

The date and time when the pipeline was last updated.

logPublishingOptions

val logPublishingOptions: LogPublishingOptions?

Key-value pairs that represent log publishing settings.

maxUnits

val maxUnits: Int

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

minUnits

val minUnits: Int

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

pipelineArn

val pipelineArn: String?

The Amazon Resource Name (ARN) of the pipeline.

pipelineConfigurationBody

val pipelineConfigurationBody: String?

The Data Prepper pipeline configuration in YAML format.

pipelineName

val pipelineName: String?

The name of the pipeline.

serviceVpcEndpoints

val serviceVpcEndpoints: List<ServiceVpcEndpoint>?

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

status

val status: PipelineStatus?

The current status of the pipeline.

statusReason

val statusReason: PipelineStatusReason?

The reason for the current status of the pipeline.

Functions

copy

inline fun copy(block: Pipeline.Builder.() -> Unit = {}): Pipeline

equals

open operator override fun equals(other: Any?): Boolean

hashCode

open override fun hashCode(): Int

toString

open override fun toString(): String