interface CfnPipelineProps

Language	Type name
.NET	`Amazon.CDK.AWS.OSIS.CfnPipelineProps`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsosis#CfnPipelineProps`
Java	`software.amazon.awscdk.services.osis.CfnPipelineProps`
Python	`aws_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';

declare const policy: any;
const cfnPipelineProps: osis.CfnPipelineProps = {
  maxUnits: 123,
  minUnits: 123,
  pipelineConfigurationBody: 'pipelineConfigurationBody',
  pipelineName: 'pipelineName',

  // the properties below are optional
  bufferOptions: {
    persistentBufferEnabled: false,
  },
  encryptionAtRestOptions: {
    kmsKeyArn: 'kmsKeyArn',
  },
  logPublishingOptions: {
    cloudWatchLogDestination: {
      logGroup: 'logGroup',
    },
    isLoggingEnabled: false,
  },
  pipelineRoleArn: 'pipelineRoleArn',
  resourcePolicy: {
    policy: policy,
  },
  tags: [{
    key: 'key',
    value: 'value',
  }],
  vpcOptions: {
    subnetIds: ['subnetIds'],

    // the properties below are optional
    securityGroupIds: ['securityGroupIds'],
    vpcAttachmentOptions: {
      attachToVpc: false,
      cidrBlock: 'cidrBlock',
    },
    vpcEndpointManagement: 'vpcEndpointManagement',
  },
};

Properties

Name	Type	Description
maxUnits	`number`	The maximum pipeline capacity, in Ingestion Compute Units (ICUs).
minUnits	`number`	The minimum pipeline capacity, in Ingestion Compute Units (ICUs).
pipelineConfigurationBody	`string`	The Data Prepper pipeline configuration in YAML format.
pipelineName	`string`	The name of the pipeline.
bufferOptions?	`IResolvable` `\|` `BufferOptionsProperty`	Options that specify the configuration of a persistent buffer.
encryptionAtRestOptions?	`IResolvable` `\|` `EncryptionAtRestOptionsProperty`	Options to control how OpenSearch encrypts buffer data.
logPublishingOptions?	`IResolvable` `\|` `LogPublishingOptionsProperty`	Key-value pairs that represent log publishing settings.
pipelineRoleArn?	`string`	The Amazon Resource Name (ARN) of the IAM role that the pipeline uses to access AWS resources.
resourcePolicy?	`IResolvable` `\|` `ResourcePolicyProperty`
tags?	`CfnTag[]`	List of tags to add to the pipeline upon creation.
vpcOptions?	`IResolvable` `\|` `VpcOptionsProperty`	Options 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.

bufferOptions?

Type: IResolvable | BufferOptionsProperty (optional)

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 .

encryptionAtRestOptions?

Type: IResolvable | EncryptionAtRestOptionsProperty (optional)

Options to control how OpenSearch encrypts buffer data.

logPublishingOptions?

Type: IResolvable | LogPublishingOptionsProperty (optional)

Key-value pairs that represent log publishing settings.

pipelineRoleArn?

Type: string (optional)

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

resourcePolicy?

Type: IResolvable | ResourcePolicyProperty (optional)

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.

AWS CDK

2.231.0