interface CfnPipelineMixinProps

Language	Type name
.NET	Amazon.CDK.Mixins.Preview.AWS.OSIS.Mixins.CfnPipelineMixinProps
Go	github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awsosis/mixins#CfnPipelineMixinProps
Java	software.amazon.awscdk.mixins.preview.services.osis.mixins.CfnPipelineMixinProps
Python	aws_cdk.mixins_preview.aws_osis.mixins.CfnPipelineMixinProps
TypeScript	@aws-cdk/mixins-preview » aws_osis » mixins » CfnPipelineMixinProps

Properties for CfnPipelinePropsMixin.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-osis-pipeline.html

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { mixins as osis_mixins } from '@aws-cdk/mixins-preview/aws-osis';

declare const policy: any;
const cfnPipelineMixinProps: osis_mixins.CfnPipelineMixinProps = {
  bufferOptions: {
    persistentBufferEnabled: false,
  },
  encryptionAtRestOptions: {
    kmsKeyArn: 'kmsKeyArn',
  },
  logPublishingOptions: {
    cloudWatchLogDestination: {
      logGroup: 'logGroup',
    },
    isLoggingEnabled: false,
  },
  maxUnits: 123,
  minUnits: 123,
  pipelineConfigurationBody: 'pipelineConfigurationBody',
  pipelineName: 'pipelineName',
  pipelineRoleArn: 'pipelineRoleArn',
  resourcePolicy: {
    policy: policy,
  },
  tags: [{
    key: 'key',
    value: 'value',
  }],
  vpcOptions: {
    securityGroupIds: ['securityGroupIds'],
    subnetIds: ['subnetIds'],
    vpcAttachmentOptions: {
      attachToVpc: false,
      cidrBlock: 'cidrBlock',
    },
    vpcEndpointManagement: 'vpcEndpointManagement',
  },
};

Properties

Name	Type	Description
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.
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.
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.

---

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 .

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-osis-pipeline.html#cfn-osis-pipeline-bufferoptions

---

encryptionAtRestOptions?

Type: IResolvable | EncryptionAtRestOptionsProperty (optional)

Options to control how OpenSearch encrypts buffer data.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-osis-pipeline.html#cfn-osis-pipeline-encryptionatrestoptions

---

logPublishingOptions?

Type: IResolvable | LogPublishingOptionsProperty (optional)

Key-value pairs that represent log publishing settings.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-osis-pipeline.html#cfn-osis-pipeline-logpublishingoptions

---

maxUnits?

Type: number (optional)

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-osis-pipeline.html#cfn-osis-pipeline-maxunits

---

minUnits?

Type: number (optional)

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-osis-pipeline.html#cfn-osis-pipeline-minunits

---

pipelineConfigurationBody?

Type: string (optional)

The Data Prepper pipeline configuration in YAML format.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-osis-pipeline.html#cfn-osis-pipeline-pipelineconfigurationbody

---

pipelineName?

Type: string (optional)

The name of the pipeline.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-osis-pipeline.html#cfn-osis-pipeline-pipelinename

---

pipelineRoleArn?

Type: string (optional)

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-osis-pipeline.html#cfn-osis-pipeline-pipelinerolearn

---

resourcePolicy?

Type: IResolvable | ResourcePolicyProperty (optional)

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-osis-pipeline.html#cfn-osis-pipeline-resourcepolicy

---

tags?

Type: CfnTag[] (optional)

List of tags to add to the pipeline upon creation.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-osis-pipeline.html#cfn-osis-pipeline-tags

---

vpcOptions?

Type: IResolvable | VpcOptionsProperty (optional)

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-osis-pipeline.html#cfn-osis-pipeline-vpcoptions