Pipeline ¶

class Pipeline(TypedDict, closed=True):
    pipeline_name: NotRequired["capo_osis.types.string.String"]
    """<p>The name of the pipeline.</p>"""
    pipeline_arn: NotRequired["capo_osis.types.string.String"]
    """<p>The Amazon Resource Name (ARN) of the pipeline.</p>"""
    min_units: "capo_osis.types.integer.Integer"
    """<p>The minimum pipeline capacity, in Ingestion Compute Units (ICUs).</p>"""
    max_units: "capo_osis.types.integer.Integer"
    """<p>The maximum pipeline capacity, in Ingestion Compute Units (ICUs).</p>"""
    status: NotRequired["capo_osis.types.pipeline_status.PipelineStatus"]
    """<p>The current status of the pipeline.</p>"""
    status_reason: NotRequired[
        "capo_osis.types.pipeline_status_reason.PipelineStatusReason"
    ]
    """<p>The reason for the current status of the pipeline.</p>"""
    pipeline_configuration_body: NotRequired["capo_osis.types.string.String"]
    """<p>The Data Prepper pipeline configuration in YAML format.</p>"""
    created_at: NotRequired["capo_osis.types.timestamp.Timestamp"]
    """<p>The date and time when the pipeline was created.</p>"""
    last_updated_at: NotRequired["capo_osis.types.timestamp.Timestamp"]
    """<p>The date and time when the pipeline was last updated.</p>"""
    ingest_endpoint_urls: NotRequired[
        "capo_osis.types.ingest_endpoint_urls_list.IngestEndpointUrlsList"
    ]
    """<p>The ingestion endpoints for the pipeline, which you can send data to.</p>"""
    log_publishing_options: NotRequired[
        "capo_osis.types.log_publishing_options.LogPublishingOptions"
    ]
    """<p>Key-value pairs that represent log publishing settings.</p>"""
    vpc_endpoints: NotRequired["capo_osis.types.vpc_endpoints_list.VpcEndpointsList"]
    """<p>The VPC interface endpoints that have access to the pipeline.</p>"""
    buffer_options: NotRequired["capo_osis.types.buffer_options.BufferOptions"]
    encryption_at_rest_options: NotRequired[
        "capo_osis.types.encryption_at_rest_options.EncryptionAtRestOptions"
    ]
    vpc_endpoint_service: NotRequired["capo_osis.types.string.String"]
    """<p>The VPC endpoint service name for the pipeline.</p>"""
    service_vpc_endpoints: NotRequired[
        "capo_osis.types.service_vpc_endpoints_list.ServiceVpcEndpointsList"
    ]
    """<p>A list of VPC endpoints that OpenSearch Ingestion has created to other Amazon Web Services services.</p>"""
    destinations: NotRequired[
        "capo_osis.types.pipeline_destination_list.PipelineDestinationList"
    ]
    """<p>Destinations to which the pipeline writes data.</p>"""
    tags: NotRequired["capo_osis.types.tag_list.TagList"]
    """<p>A list of tags associated with the given pipeline.</p>"""
    pipeline_role_arn: NotRequired["capo_osis.types.pipeline_role_arn.PipelineRoleArn"]
    """<p>The Amazon Resource Name (ARN) of the IAM role that the pipeline uses to access AWS resources.</p>"""