AWS Fundamentals Logo
AWS Fundamentals
L1 ConstructAWS::OSIS::Pipeline

CfnPipeline

The AWS::OSIS::Pipeline resource creates an Amazon OpenSearch Ingestion pipeline.

Import

import { CfnPipeline } from 'aws-cdk-lib/aws-osis';

Or use the module namespace:

import * as osis from 'aws-cdk-lib/aws-osis';
// osis.CfnPipeline

Properties

Configuration passed to the constructor as CfnPipelineProps.

maxUnitsRequired
number

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

minUnitsRequired
number

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

pipelineConfigurationBodyRequired
string

The Data Prepper pipeline configuration in YAML format.

pipelineNameRequired
string

The name of the pipeline.

bufferOptionsOptional
IResolvable | BufferOptionsProperty

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](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/osis-features-overview.html#persistent-buffering) .

encryptionAtRestOptionsOptional
IResolvable | EncryptionAtRestOptionsProperty

Options to control how OpenSearch encrypts buffer data.

logPublishingOptionsOptional
IResolvable | LogPublishingOptionsProperty

Key-value pairs that represent log publishing settings.

pipelineRoleArnOptional
string

The Amazon Resource Name (ARN) of the IAM role that the pipeline uses to access AWS resources.

resourcePolicyOptional
IResolvable | ResourcePolicyProperty
tagsOptional
CfnTag[]

List of tags to add to the pipeline upon creation.

vpcOptionsOptional
IResolvable | VpcOptionsProperty

Options that specify the subnets and security groups for an OpenSearch Ingestion VPC endpoint.

CloudFormation Resource

This L1 construct maps directly to the following CloudFormation resource type.

AWS::OSIS::PipelineView in CloudFormation Explorer

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Facts

LevelL1 (CloudFormation)
Moduleaws-osis
CFN TypeAWS::OSIS::Pipeline
Properties11

Explore This Service

External Links