Package software.amazon.awssdk.services.osis.model

Interface CreatePipelineRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<CreatePipelineRequest.Builder,CreatePipelineRequest>, OsisRequest.Builder, SdkBuilder<CreatePipelineRequest.Builder,CreatePipelineRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
CreatePipelineRequest
public static interface CreatePipelineRequest.Builder extends OsisRequest.Builder, SdkPojo, CopyableBuilder<CreatePipelineRequest.Builder,CreatePipelineRequest>

  • Method Details

    • pipelineName

      CreatePipelineRequest.Builder pipelineName(String pipelineName)

      The name of the OpenSearch Ingestion pipeline to create. Pipeline names are unique across the pipelines owned by an account within an Amazon Web Services Region.

      Parameters:
      pipelineName - The name of the OpenSearch Ingestion pipeline to create. Pipeline names are unique across the pipelines owned by an account within an Amazon Web Services Region.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • minUnits

      CreatePipelineRequest.Builder minUnits(Integer minUnits)

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

      Parameters:
      minUnits - The minimum pipeline capacity, in Ingestion Compute Units (ICUs).
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • maxUnits

      CreatePipelineRequest.Builder maxUnits(Integer maxUnits)

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

      Parameters:
      maxUnits - The maximum pipeline capacity, in Ingestion Compute Units (ICUs).
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • pipelineConfigurationBody

      CreatePipelineRequest.Builder pipelineConfigurationBody(String pipelineConfigurationBody)

      The pipeline configuration in YAML format. The command accepts the pipeline configuration as a string or within a .yaml file. If you provide the configuration as a string, each new line must be escaped with \n.

      Parameters:
      pipelineConfigurationBody - The pipeline configuration in YAML format. The command accepts the pipeline configuration as a string or within a .yaml file. If you provide the configuration as a string, each new line must be escaped with \n.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • logPublishingOptions

      CreatePipelineRequest.Builder logPublishingOptions(LogPublishingOptions logPublishingOptions)

      Key-value pairs to configure log publishing.

      Parameters:
      logPublishingOptions - Key-value pairs to configure log publishing.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • logPublishingOptions

      default CreatePipelineRequest.Builder logPublishingOptions(Consumer<LogPublishingOptions.Builder> logPublishingOptions)

      Key-value pairs to configure log publishing.

      This is a convenience method that creates an instance of the LogPublishingOptions.Builder avoiding the need to create one manually via LogPublishingOptions.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to logPublishingOptions(LogPublishingOptions).

      Parameters:
      logPublishingOptions - a consumer that will call methods on LogPublishingOptions.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • vpcOptions

      CreatePipelineRequest.Builder vpcOptions(VpcOptions vpcOptions)

      Container for the values required to configure VPC access for the pipeline. If you don't specify these values, OpenSearch Ingestion creates the pipeline with a public endpoint.

      Parameters:
      vpcOptions - Container for the values required to configure VPC access for the pipeline. If you don't specify these values, OpenSearch Ingestion creates the pipeline with a public endpoint.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • vpcOptions

      default CreatePipelineRequest.Builder vpcOptions(Consumer<VpcOptions.Builder> vpcOptions)

      Container for the values required to configure VPC access for the pipeline. If you don't specify these values, OpenSearch Ingestion creates the pipeline with a public endpoint.

      This is a convenience method that creates an instance of the VpcOptions.Builder avoiding the need to create one manually via VpcOptions.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to vpcOptions(VpcOptions).

      Parameters:
      vpcOptions - a consumer that will call methods on VpcOptions.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • tags

      CreatePipelineRequest.Builder tags(Collection<Tag> tags)

      List of tags to add to the pipeline upon creation.

      Parameters:
      tags - List of tags to add to the pipeline upon creation.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      CreatePipelineRequest.Builder tags(Tag... tags)

      List of tags to add to the pipeline upon creation.

      Parameters:
      tags - List of tags to add to the pipeline upon creation.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      CreatePipelineRequest.Builder tags(Consumer<Tag.Builder>... tags)

      List of tags to add to the pipeline upon creation.

      This is a convenience method that creates an instance of the Tag.Builder avoiding the need to create one manually via Tag.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to tags(List<Tag>).

      Parameters:
      tags - a consumer that will call methods on Tag.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • overrideConfiguration

      CreatePipelineRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      CreatePipelineRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.