interface CfnPipelineProps

Language	Type name
.NET	Amazon.CDK.AWS.OSIS.CfnPipelineProps
Java	software.amazon.awscdk.services.osis.CfnPipelineProps
Python	aws_cdk.aws_osis.CfnPipelineProps
TypeScript	@aws-cdk/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 * as osis from '@aws-cdk/aws-osis';
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

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.
logPublishingOptions?	LogPublishingOptionsProperty | IResolvable	Key-value pairs that represent log publishing settings.
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.

---

logPublishingOptions?

Type: LogPublishingOptionsProperty | IResolvable (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.