Skip to content

UpdatePipelineRequest

Source code in docs_src/capo_osis/types/update_pipeline_request.py
class UpdatePipelineRequest(TypedDict, closed=True):
    pipeline_name: "capo_osis.types.pipeline_name.PipelineName"
    """<p>The name of the pipeline to update.</p>"""
    min_units: NotRequired["capo_osis.types.pipeline_units.PipelineUnits"]
    """<p>The minimum pipeline capacity, in Ingestion Compute Units (ICUs).</p>"""
    max_units: NotRequired["capo_osis.types.pipeline_units.PipelineUnits"]
    """<p>The maximum pipeline capacity, in Ingestion Compute Units (ICUs)</p>"""
    pipeline_configuration_body: NotRequired[
        "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>"""
    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>"""
    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>"""

buffer_options instance-attribute

buffer_options: NotRequired[BufferOptions]

Key-value pairs to configure persistent buffering for the pipeline.

encryption_at_rest_options instance-attribute

encryption_at_rest_options: NotRequired[EncryptionAtRestOptions]

Key-value pairs to configure encryption for data that is written to a persistent buffer.

log_publishing_options instance-attribute

log_publishing_options: NotRequired[LogPublishingOptions]

Key-value pairs to configure log publishing.

max_units instance-attribute

max_units: NotRequired[PipelineUnits]

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

min_units instance-attribute

min_units: NotRequired[PipelineUnits]

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

pipeline_configuration_body instance-attribute

pipeline_configuration_body: NotRequired[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.

pipeline_name instance-attribute

pipeline_name: PipelineName

The name of the pipeline to update.

pipeline_role_arn instance-attribute

pipeline_role_arn: NotRequired[PipelineRoleArn]

The Amazon Resource Name (ARN) of the IAM role that grants the pipeline permission to access Amazon Web Services resources.