Interface CreatePipelineRequest.Builder

    • Method Detail

      • 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.
      • 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.
      • 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).

        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:
        #tags(java.util.Collection)