Package software.amazon.awscdk.mixins.preview.services.osis.mixins

Class CfnPipelinePropsMixin.Builder

java.lang.Object

software.amazon.awscdk.mixins.preview.services.osis.mixins.CfnPipelinePropsMixin.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnPipelinePropsMixin>

Enclosing class:

CfnPipelinePropsMixin

@Stability(Stable)
public static final class CfnPipelinePropsMixin.Builder
extends Object
implements software.amazon.jsii.Builder<CfnPipelinePropsMixin>

A fluent builder for CfnPipelinePropsMixin.

Method Summary

Modifier and Type	Method	Description
CfnPipelinePropsMixin.Builder	bufferOptions(IResolvable bufferOptions)	Options that specify the configuration of a persistent buffer.
CfnPipelinePropsMixin.Builder	bufferOptions(CfnPipelinePropsMixin.BufferOptionsProperty bufferOptions)	Options that specify the configuration of a persistent buffer.
CfnPipelinePropsMixin	build()
static CfnPipelinePropsMixin.Builder	create()
static CfnPipelinePropsMixin.Builder	create(CfnPropertyMixinOptions options)
CfnPipelinePropsMixin.Builder	encryptionAtRestOptions(IResolvable encryptionAtRestOptions)	Options to control how OpenSearch encrypts buffer data.
CfnPipelinePropsMixin.Builder	encryptionAtRestOptions(CfnPipelinePropsMixin.EncryptionAtRestOptionsProperty encryptionAtRestOptions)	Options to control how OpenSearch encrypts buffer data.
CfnPipelinePropsMixin.Builder	logPublishingOptions(IResolvable logPublishingOptions)	Key-value pairs that represent log publishing settings.
CfnPipelinePropsMixin.Builder	logPublishingOptions(CfnPipelinePropsMixin.LogPublishingOptionsProperty logPublishingOptions)	Key-value pairs that represent log publishing settings.
CfnPipelinePropsMixin.Builder	maxUnits(Number maxUnits)	The maximum pipeline capacity, in Ingestion Compute Units (ICUs).
CfnPipelinePropsMixin.Builder	minUnits(Number minUnits)	The minimum pipeline capacity, in Ingestion Compute Units (ICUs).
CfnPipelinePropsMixin.Builder	pipelineConfigurationBody(String pipelineConfigurationBody)	The Data Prepper pipeline configuration in YAML format.
CfnPipelinePropsMixin.Builder	pipelineName(String pipelineName)	The name of the pipeline.
CfnPipelinePropsMixin.Builder	pipelineRoleArn(String pipelineRoleArn)	The Amazon Resource Name (ARN) of the IAM role that the pipeline uses to access AWS resources.
CfnPipelinePropsMixin.Builder	resourcePolicy(IResolvable resourcePolicy)
CfnPipelinePropsMixin.Builder	resourcePolicy(CfnPipelinePropsMixin.ResourcePolicyProperty resourcePolicy)
CfnPipelinePropsMixin.Builder	tags(List<? extends CfnTag> tags)	List of tags to add to the pipeline upon creation.
CfnPipelinePropsMixin.Builder	vpcOptions(IResolvable vpcOptions)	Options that specify the subnets and security groups for an OpenSearch Ingestion VPC endpoint.
CfnPipelinePropsMixin.Builder	vpcOptions(CfnPipelinePropsMixin.VpcOptionsProperty vpcOptions)	Options that specify the subnets and security groups for an OpenSearch Ingestion VPC endpoint.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

create

@Stability(Stable)
public static CfnPipelinePropsMixin.Builder create(CfnPropertyMixinOptions options)

Parameters:

options - Mixin options.

Returns:

a new instance of CfnPipelinePropsMixin.Builder.

create

@Stability(Stable)
public static CfnPipelinePropsMixin.Builder create()

Returns:

a new instance of CfnPipelinePropsMixin.Builder.

bufferOptions

@Stability(Stable)
public CfnPipelinePropsMixin.Builder bufferOptions(IResolvable bufferOptions)

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 .

Parameters:

bufferOptions - Options that specify the configuration of a persistent buffer. This parameter is required.

Returns:

this

See Also:

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

bufferOptions

@Stability(Stable)
public CfnPipelinePropsMixin.Builder bufferOptions(CfnPipelinePropsMixin.BufferOptionsProperty bufferOptions)

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 .

Parameters:

bufferOptions - Options that specify the configuration of a persistent buffer. This parameter is required.

Returns:

this

See Also:

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

encryptionAtRestOptions

@Stability(Stable)
public CfnPipelinePropsMixin.Builder encryptionAtRestOptions(IResolvable encryptionAtRestOptions)

Options to control how OpenSearch encrypts buffer data.

Parameters:

encryptionAtRestOptions - Options to control how OpenSearch encrypts buffer data. This parameter is required.

Returns:

this

See Also:

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

encryptionAtRestOptions

@Stability(Stable)
public CfnPipelinePropsMixin.Builder encryptionAtRestOptions(CfnPipelinePropsMixin.EncryptionAtRestOptionsProperty encryptionAtRestOptions)

Options to control how OpenSearch encrypts buffer data.

Parameters:

encryptionAtRestOptions - Options to control how OpenSearch encrypts buffer data. This parameter is required.

Returns:

this

See Also:

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

logPublishingOptions

@Stability(Stable)
public CfnPipelinePropsMixin.Builder logPublishingOptions(IResolvable logPublishingOptions)

Key-value pairs that represent log publishing settings.

Parameters:

logPublishingOptions - Key-value pairs that represent log publishing settings. This parameter is required.

Returns:

this

See Also:

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

logPublishingOptions

@Stability(Stable)
public CfnPipelinePropsMixin.Builder logPublishingOptions(CfnPipelinePropsMixin.LogPublishingOptionsProperty logPublishingOptions)

Key-value pairs that represent log publishing settings.

Parameters:

logPublishingOptions - Key-value pairs that represent log publishing settings. This parameter is required.

Returns:

this

See Also:

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

maxUnits

@Stability(Stable)
public CfnPipelinePropsMixin.Builder maxUnits(Number maxUnits)

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

Parameters:

maxUnits - The maximum pipeline capacity, in Ingestion Compute Units (ICUs). This parameter is required.

Returns:

this

See Also:

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

minUnits

@Stability(Stable)
public CfnPipelinePropsMixin.Builder minUnits(Number minUnits)

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

Parameters:

minUnits - The minimum pipeline capacity, in Ingestion Compute Units (ICUs). This parameter is required.

Returns:

this

See Also:

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

pipelineConfigurationBody

@Stability(Stable)
public CfnPipelinePropsMixin.Builder pipelineConfigurationBody(String pipelineConfigurationBody)

The Data Prepper pipeline configuration in YAML format.

Parameters:

pipelineConfigurationBody - The Data Prepper pipeline configuration in YAML format. This parameter is required.

Returns:

this

See Also:

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

pipelineName

@Stability(Stable)
public CfnPipelinePropsMixin.Builder pipelineName(String pipelineName)

The name of the pipeline.

Parameters:

pipelineName - The name of the pipeline. This parameter is required.

Returns:

this

See Also:

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

pipelineRoleArn

@Stability(Stable)
public CfnPipelinePropsMixin.Builder pipelineRoleArn(String pipelineRoleArn)

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

Parameters:

pipelineRoleArn - The Amazon Resource Name (ARN) of the IAM role that the pipeline uses to access AWS resources. This parameter is required.

Returns:

this

See Also:

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

resourcePolicy

@Stability(Stable)
public CfnPipelinePropsMixin.Builder resourcePolicy(IResolvable resourcePolicy)

Parameters:

resourcePolicy - This parameter is required.

Returns:

this

See Also:

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

resourcePolicy

@Stability(Stable)
public CfnPipelinePropsMixin.Builder resourcePolicy(CfnPipelinePropsMixin.ResourcePolicyProperty resourcePolicy)

Parameters:

resourcePolicy - This parameter is required.

Returns:

this

See Also:

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

tags

@Stability(Stable)
public CfnPipelinePropsMixin.Builder tags(List<? extends CfnTag> tags)

List of tags to add to the pipeline upon creation.

Parameters:

tags - List of tags to add to the pipeline upon creation. This parameter is required.

Returns:

this

See Also:

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

vpcOptions

@Stability(Stable)
public CfnPipelinePropsMixin.Builder vpcOptions(IResolvable vpcOptions)

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

Parameters:

vpcOptions - Options that specify the subnets and security groups for an OpenSearch Ingestion VPC endpoint. This parameter is required.

Returns:

this

See Also:

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

vpcOptions

@Stability(Stable)
public CfnPipelinePropsMixin.Builder vpcOptions(CfnPipelinePropsMixin.VpcOptionsProperty vpcOptions)

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

Parameters:

vpcOptions - Options that specify the subnets and security groups for an OpenSearch Ingestion VPC endpoint. This parameter is required.

Returns:

this

See Also:

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

build

@Stability(Stable)
public CfnPipelinePropsMixin build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnPipelinePropsMixin>

Returns:

a newly built instance of CfnPipelinePropsMixin.