Package software.amazon.awscdk.services.osis

Interface CfnPipelineProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnPipelineProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)",
           date="2025-10-24T13:34:42.994Z")
@Stability(Stable)
public interface CfnPipelineProps
extends software.amazon.jsii.JsiiSerializable

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 software.amazon.awscdk.services.osis.*;
 Object policy;
 CfnPipelineProps cfnPipelineProps = CfnPipelineProps.builder()
         .maxUnits(123)
         .minUnits(123)
         .pipelineConfigurationBody("pipelineConfigurationBody")
         .pipelineName("pipelineName")
         // the properties below are optional
         .bufferOptions(BufferOptionsProperty.builder()
                 .persistentBufferEnabled(false)
                 .build())
         .encryptionAtRestOptions(EncryptionAtRestOptionsProperty.builder()
                 .kmsKeyArn("kmsKeyArn")
                 .build())
         .logPublishingOptions(LogPublishingOptionsProperty.builder()
                 .cloudWatchLogDestination(CloudWatchLogDestinationProperty.builder()
                         .logGroup("logGroup")
                         .build())
                 .isLoggingEnabled(false)
                 .build())
         .pipelineRoleArn("pipelineRoleArn")
         .resourcePolicy(ResourcePolicyProperty.builder()
                 .policy(policy)
                 .build())
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .vpcOptions(VpcOptionsProperty.builder()
                 .subnetIds(List.of("subnetIds"))
                 // the properties below are optional
                 .securityGroupIds(List.of("securityGroupIds"))
                 .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	CfnPipelineProps.Builder	A builder for CfnPipelineProps
static final class	CfnPipelineProps.Jsii$Proxy	An implementation for CfnPipelineProps

Method Summary

Modifier and Type	Method	Description
static CfnPipelineProps.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.
Number	getMaxUnits()	The maximum pipeline capacity, in Ingestion Compute Units (ICUs).
Number	getMinUnits()	The minimum pipeline capacity, in Ingestion Compute Units (ICUs).
String	getPipelineConfigurationBody()	The Data Prepper pipeline configuration in YAML format.
String	getPipelineName()	The name of the pipeline.
default String	getPipelineRoleArn()	The Pipeline Role (ARN) for the pipeline.
default Object	getResourcePolicy()	Returns union: either IResolvable or CfnPipeline.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

getMaxUnits

@Stability(Stable)
@NotNull
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)
@NotNull
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)
@NotNull
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)
@NotNull
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

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 CfnPipeline.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 CfnPipeline.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 CfnPipeline.LogPublishingOptionsProperty

See Also:

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

getPipelineRoleArn

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

The Pipeline Role (ARN) for the pipeline.

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 CfnPipeline.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 CfnPipeline.VpcOptionsProperty

See Also:

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

builder

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

Returns:

a CfnPipelineProps.Builder of CfnPipelineProps