Skip to content

PipelineEndpoint

Source code in docs_src/capo_osis/types/pipeline_endpoint.py
class PipelineEndpoint(TypedDict, closed=True):
    pipeline_arn: NotRequired["capo_osis.types.pipeline_arn.PipelineArn"]
    """<p>The Amazon Resource Name (ARN) of the pipeline associated with this endpoint.</p>"""
    endpoint_id: NotRequired["capo_osis.types.pipeline_endpoint_id.PipelineEndpointId"]
    """<p>The unique identifier for the pipeline endpoint.</p>"""
    status: NotRequired[
        "capo_osis.types.pipeline_endpoint_status.PipelineEndpointStatus"
    ]
    """<p>The current status of the pipeline endpoint.</p>"""
    vpc_id: NotRequired["capo_osis.types.string.String"]
    """<p>The ID of the VPC where the pipeline endpoint is created.</p>"""
    vpc_options: NotRequired[
        "capo_osis.types.pipeline_endpoint_vpc_options.PipelineEndpointVpcOptions"
    ]
    """<p>Configuration options for the VPC endpoint, including subnet and security group settings.</p>"""
    ingest_endpoint_url: NotRequired["capo_osis.types.string.String"]
    """<p>The URL used to ingest data to the pipeline through the VPC endpoint.</p>"""

endpoint_id instance-attribute

endpoint_id: NotRequired[PipelineEndpointId]

The unique identifier for the pipeline endpoint.

ingest_endpoint_url instance-attribute

ingest_endpoint_url: NotRequired[String]

The URL used to ingest data to the pipeline through the VPC endpoint.

pipeline_arn instance-attribute

pipeline_arn: NotRequired[PipelineArn]

The Amazon Resource Name (ARN) of the pipeline associated with this endpoint.

status instance-attribute

status: NotRequired[PipelineEndpointStatus]

The current status of the pipeline endpoint.

vpc_id instance-attribute

vpc_id: NotRequired[String]

The ID of the VPC where the pipeline endpoint is created.

vpc_options instance-attribute

vpc_options: NotRequired[PipelineEndpointVpcOptions]

Configuration options for the VPC endpoint, including subnet and security group settings.