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

Builder

Properties

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

var createdAt: Instant?

The date and time when the pipeline was created.

destinations

var destinations: List<PipelineDestination>?

Destinations to which the pipeline writes data.

encryptionAtRestOptions

var encryptionAtRestOptions: EncryptionAtRestOptions?

Options to control how OpenSearch encrypts buffer data.

ingestEndpointUrls

var ingestEndpointUrls: List<String>?

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

lastUpdatedAt

var lastUpdatedAt: Instant?

The date and time when the pipeline was last updated.

logPublishingOptions

var logPublishingOptions: LogPublishingOptions?

Key-value pairs that represent log publishing settings.

maxUnits

var maxUnits: Int

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

minUnits

var minUnits: Int

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

pipelineArn

var pipelineArn: String?

The Amazon Resource Name (ARN) of the pipeline.

pipelineConfigurationBody

var pipelineConfigurationBody: String?

The Data Prepper pipeline configuration in YAML format.

pipelineName

var pipelineName: String?

The name of the pipeline.

serviceVpcEndpoints

var serviceVpcEndpoints: List<ServiceVpcEndpoint>?

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

status

var status: PipelineStatus?

The current status of the pipeline.

statusReason

var statusReason: PipelineStatusReason?

The reason for the current status of the pipeline.

Functions

bufferOptions

fun bufferOptions(block: BufferOptions.Builder.() -> Unit)

construct an aws.sdk.kotlin.services.osis.model.BufferOptions inside the given block

encryptionAtRestOptions

fun encryptionAtRestOptions(block: EncryptionAtRestOptions.Builder.() -> Unit)

construct an aws.sdk.kotlin.services.osis.model.EncryptionAtRestOptions inside the given block

logPublishingOptions

fun logPublishingOptions(block: LogPublishingOptions.Builder.() -> Unit)

construct an aws.sdk.kotlin.services.osis.model.LogPublishingOptions inside the given block

statusReason

fun statusReason(block: PipelineStatusReason.Builder.() -> Unit)

construct an aws.sdk.kotlin.services.osis.model.PipelineStatusReason inside the given block