Class CfnPipeline.Builder

java.lang.Object
software.amazon.awscdk.services.osis.CfnPipeline.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<CfnPipeline>
Enclosing class:
CfnPipeline

@Stability(Stable) public static final class CfnPipeline.Builder extends Object implements software.amazon.jsii.Builder<CfnPipeline>
A fluent builder for CfnPipeline.
  • Method Details

    • create

      @Stability(Stable) public static CfnPipeline.Builder create(Construct scope, String id)
      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.
      Returns:
      a new instance of CfnPipeline.Builder.
    • maxUnits

      @Stability(Stable) public CfnPipeline.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
    • minUnits

      @Stability(Stable) public CfnPipeline.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
    • pipelineConfigurationBody

      @Stability(Stable) public CfnPipeline.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
    • pipelineName

      @Stability(Stable) public CfnPipeline.Builder pipelineName(String pipelineName)
      The name of the pipeline.

      Parameters:
      pipelineName - The name of the pipeline. This parameter is required.
      Returns:
      this
    • logPublishingOptions

      @Stability(Stable) public CfnPipeline.Builder logPublishingOptions(CfnPipeline.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
    • logPublishingOptions

      @Stability(Stable) public CfnPipeline.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
    • tags

      @Stability(Stable) public CfnPipeline.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
    • vpcOptions

      @Stability(Stable) public CfnPipeline.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
    • vpcOptions

      @Stability(Stable) public CfnPipeline.Builder vpcOptions(CfnPipeline.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
    • build

      @Stability(Stable) public CfnPipeline build()
      Specified by:
      build in interface software.amazon.jsii.Builder<CfnPipeline>
      Returns:
      a newly built instance of CfnPipeline.