aws-cdk-lib.aws_osis.CfnPipelineProps

interface CfnPipelineProps

LanguageType name
.NETAmazon.CDK.aws_osis.CfnPipelineProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsosis#CfnPipelineProps
Javaservices.osis.CfnPipelineProps
Pythonaws_cdk.aws_osis.CfnPipelineProps
TypeScript aws-cdk-lib » aws_osis » CfnPipelineProps

Properties for defining a CfnPipeline.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_osis as osis } from 'aws-cdk-lib';
const cfnPipelineProps: osis.CfnPipelineProps = {
  maxUnits: 123,
  minUnits: 123,
  pipelineConfigurationBody: 'pipelineConfigurationBody',
  pipelineName: 'pipelineName',

  // the properties below are optional
  logPublishingOptions: {
    cloudWatchLogDestination: {
      logGroup: 'logGroup',
    },
    isLoggingEnabled: false,
  },
  tags: [{
    key: 'key',
    value: 'value',
  }],
  vpcOptions: {
    securityGroupIds: ['securityGroupIds'],
    subnetIds: ['subnetIds'],
  },
};

Properties

NameTypeDescription
maxUnitsnumberThe maximum pipeline capacity, in Ingestion Compute Units (ICUs).
minUnitsnumberThe minimum pipeline capacity, in Ingestion Compute Units (ICUs).
pipelineConfigurationBodystringThe Data Prepper pipeline configuration in YAML format.
pipelineNamestringThe name of the pipeline.
logPublishingOptions?IResolvable | LogPublishingOptionsPropertyKey-value pairs that represent log publishing settings.
tags?CfnTag[]List of tags to add to the pipeline upon creation.
vpcOptions?IResolvable | VpcOptionsPropertyOptions that specify the subnets and security groups for an OpenSearch Ingestion VPC endpoint.

maxUnits

Type: number

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


minUnits

Type: number

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


pipelineConfigurationBody

Type: string

The Data Prepper pipeline configuration in YAML format.


pipelineName

Type: string

The name of the pipeline.


logPublishingOptions?

Type: IResolvable | LogPublishingOptionsProperty (optional)

Key-value pairs that represent log publishing settings.


tags?

Type: CfnTag[] (optional)

List of tags to add to the pipeline upon creation.


vpcOptions?

Type: IResolvable | VpcOptionsProperty (optional)

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