CreatePipelineRequest ¶

class CreatePipelineRequest(TypedDict, closed=True):
    pipeline_name: "capo_osis.types.pipeline_name.PipelineName"
    """<p>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.</p>"""
    min_units: "capo_osis.types.pipeline_units.PipelineUnits"
    """<p>The minimum pipeline capacity, in Ingestion Compute Units (ICUs).</p>"""
    max_units: "capo_osis.types.pipeline_units.PipelineUnits"
    """<p>The maximum pipeline capacity, in Ingestion Compute Units (ICUs).</p>"""
    pipeline_configuration_body: (
        "capo_osis.types.pipeline_configuration_body.PipelineConfigurationBody"
    )
    r"""<p>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 <code>\n</code>.</p>"""
    log_publishing_options: NotRequired[
        "capo_osis.types.log_publishing_options.LogPublishingOptions"
    ]
    """<p>Key-value pairs to configure log publishing.</p>"""
    vpc_options: NotRequired["capo_osis.types.vpc_options.VpcOptions"]
    """<p>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.</p>"""
    buffer_options: NotRequired["capo_osis.types.buffer_options.BufferOptions"]
    """<p>Key-value pairs to configure persistent buffering for the pipeline.</p>"""
    encryption_at_rest_options: NotRequired[
        "capo_osis.types.encryption_at_rest_options.EncryptionAtRestOptions"
    ]
    """<p>Key-value pairs to configure encryption for data that is written to a persistent buffer.</p>"""
    tags: NotRequired["capo_osis.types.tag_list.TagList"]
    """<p>List of tags to add to the pipeline upon creation.</p>"""
    pipeline_role_arn: NotRequired["capo_osis.types.pipeline_role_arn.PipelineRoleArn"]
    """<p>The Amazon Resource Name (ARN) of the IAM role that grants the pipeline permission to access Amazon Web Services resources.</p>"""