Package software.amazon.awscdk.cfnpropertymixins.services.osis

Interface CfnPipelineMixinProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnPipelineMixinProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-04-14T18:32:15.700Z")
@Stability(Stable)
public interface CfnPipelineMixinProps
extends software.amazon.jsii.JsiiSerializable

Properties for CfnPipelinePropsMixin.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.osis.*;
 Object policy;
 CfnPipelineMixinProps cfnPipelineMixinProps = CfnPipelineMixinProps.builder()
         .bufferOptions(BufferOptionsProperty.builder()
                 .persistentBufferEnabled(false)
                 .build())
         .encryptionAtRestOptions(EncryptionAtRestOptionsProperty.builder()
                 .kmsKeyArn("kmsKeyArn")
                 .build())
         .logPublishingOptions(LogPublishingOptionsProperty.builder()
                 .cloudWatchLogDestination(CloudWatchLogDestinationProperty.builder()
                         .logGroup("logGroup")
                         .build())
                 .isLoggingEnabled(false)
                 .build())
         .maxUnits(123)
         .minUnits(123)
         .pipelineConfigurationBody("pipelineConfigurationBody")
         .pipelineName("pipelineName")
         .pipelineRoleArn("pipelineRoleArn")
         .resourcePolicy(ResourcePolicyProperty.builder()
                 .policy(policy)
                 .build())
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .vpcOptions(VpcOptionsProperty.builder()
                 .securityGroupIds(List.of("securityGroupIds"))
                 .subnetIds(List.of("subnetIds"))
                 .vpcAttachmentOptions(VpcAttachmentOptionsProperty.builder()
                         .attachToVpc(false)
                         .cidrBlock("cidrBlock")
                         .build())
                 .vpcEndpointManagement("vpcEndpointManagement")
                 .build())
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnPipelineMixinProps.Builder	A builder for CfnPipelineMixinProps
static final class	CfnPipelineMixinProps.Jsii$Proxy	An implementation for CfnPipelineMixinProps

Method Summary

Modifier and Type	Method	Description
static CfnPipelineMixinProps.Builder	builder()
default Object	getBufferOptions()	Options that specify the configuration of a persistent buffer.
default Object	getEncryptionAtRestOptions()	Options to control how OpenSearch encrypts buffer data.
default Object	getLogPublishingOptions()	Key-value pairs that represent log publishing settings.
default Number	getMaxUnits()	The maximum pipeline capacity, in Ingestion Compute Units (ICUs).
default Number	getMinUnits()	The minimum pipeline capacity, in Ingestion Compute Units (ICUs).
default String	getPipelineConfigurationBody()	The Data Prepper pipeline configuration in YAML format.
default String	getPipelineName()	The name of the pipeline.
default String	getPipelineRoleArn()	The Amazon Resource Name (ARN) of the IAM role that the pipeline uses to access AWS resources.
default Object	getResourcePolicy()	Returns union: either IResolvable or CfnPipelinePropsMixin.ResourcePolicyProperty
default List<CfnTag>	getTags()	List of tags to add to the pipeline upon creation.
default Object	getVpcOptions()	Options that specify the subnets and security groups for an OpenSearch Ingestion VPC endpoint.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getBufferOptions

@Stability(Stable)
@Nullable
default Object getBufferOptions()

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 .

Returns union: either IResolvable or CfnPipelinePropsMixin.BufferOptionsProperty

See Also:

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

getEncryptionAtRestOptions

@Stability(Stable)
@Nullable
default Object getEncryptionAtRestOptions()

Options to control how OpenSearch encrypts buffer data.

Returns union: either IResolvable or CfnPipelinePropsMixin.EncryptionAtRestOptionsProperty

See Also:

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

getLogPublishingOptions

@Stability(Stable)
@Nullable
default Object getLogPublishingOptions()

Key-value pairs that represent log publishing settings.

Returns union: either IResolvable or CfnPipelinePropsMixin.LogPublishingOptionsProperty

See Also:

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

getMaxUnits

@Stability(Stable)
@Nullable
default Number getMaxUnits()

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

getMinUnits

@Stability(Stable)
@Nullable
default Number getMinUnits()

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

getPipelineConfigurationBody

@Stability(Stable)
@Nullable
default String getPipelineConfigurationBody()

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

getPipelineName

@Stability(Stable)
@Nullable
default String getPipelineName()

The name of the pipeline.

See Also:

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

getPipelineRoleArn

@Stability(Stable)
@Nullable
default String getPipelineRoleArn()

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

getResourcePolicy

@Stability(Stable)
@Nullable
default Object getResourcePolicy()

Returns union: either IResolvable or CfnPipelinePropsMixin.ResourcePolicyProperty

See Also:

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

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

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

getVpcOptions

@Stability(Stable)
@Nullable
default Object getVpcOptions()

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

Returns union: either IResolvable or CfnPipelinePropsMixin.VpcOptionsProperty

See Also:

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

builder

@Stability(Stable)
static CfnPipelineMixinProps.Builder builder()

Returns:

a CfnPipelineMixinProps.Builder of CfnPipelineMixinProps