CreatePipeRequest ¶

class CreatePipeRequest(TypedDict, closed=True):
    name: "capo_pipes.types.pipe_name.PipeName"
    """<p>The name of the pipe.</p>"""
    description: NotRequired["capo_pipes.types.pipe_description.PipeDescription"]
    """<p>A description of the pipe.</p>"""
    desired_state: NotRequired[
        "capo_pipes.types.requested_pipe_state.RequestedPipeState"
    ]
    """<p>The state the pipe should be in.</p>"""
    source: "capo_pipes.types.arn_or_url.ArnOrUrl"
    """<p>The ARN of the source resource.</p>"""
    source_parameters: NotRequired[
        "capo_pipes.types.pipe_source_parameters.PipeSourceParameters"
    ]
    """<p>The parameters required to set up a source for your pipe.</p>"""
    enrichment: NotRequired["capo_pipes.types.optional_arn.OptionalArn"]
    """<p>The ARN of the enrichment resource.</p>"""
    enrichment_parameters: NotRequired[
        "capo_pipes.types.pipe_enrichment_parameters.PipeEnrichmentParameters"
    ]
    """<p>The parameters required to set up enrichment on your pipe.</p>"""
    target: "capo_pipes.types.arn.Arn"
    """<p>The ARN of the target resource.</p>"""
    target_parameters: NotRequired[
        "capo_pipes.types.pipe_target_parameters.PipeTargetParameters"
    ]
    """<p>The parameters required to set up a target for your pipe.</p> <p>For more information about pipe target parameters, including how to use dynamic path parameters, see <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-pipes-event-target.html">Target parameters</a> in the <i>Amazon EventBridge User Guide</i>.</p>"""
    role_arn: "capo_pipes.types.role_arn.RoleArn"
    """<p>The ARN of the role that allows the pipe to send data to the target.</p>"""
    tags: NotRequired["capo_pipes.types.tag_map.TagMap"]
    """<p>The list of key-value pairs to associate with the pipe.</p>"""
    log_configuration: NotRequired[
        "capo_pipes.types.pipe_log_configuration_parameters.PipeLogConfigurationParameters"
    ]
    """<p>The logging configuration settings for the pipe.</p>"""
    kms_key_identifier: NotRequired[
        "capo_pipes.types.kms_key_identifier.KmsKeyIdentifier"
    ]
    """<p>The identifier of the KMS customer managed key for EventBridge to use, if you choose to use a customer managed key to encrypt pipe data. The identifier can be the key Amazon Resource Name (ARN), KeyId, key alias, or key alias ARN.</p> <p>If you do not specify a customer managed key identifier, EventBridge uses an Amazon Web Services owned key to encrypt pipe data.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/getting-started.html">Managing keys</a> in the <i>Key Management Service Developer Guide</i>. </p>"""