PipeVariable

class aws_cdk.aws_pipes_alpha.PipeVariable(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: Enum

(experimental) Reserved pipe variables.

See:

https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-pipes-input-transformation.html#input-transform-reserved

Stability:

experimental

Attributes

ARN

(experimental) The Amazon Resource Name (ARN) of the pipe.

Stability:

experimental

ENRICHMENT_ARN

(experimental) The ARN of the enrichment of the pipe.

Stability:

experimental

EVENT

(experimental) The event as received by the input transformer.

Stability:

experimental

EVENT_INGESTION_TIME

(experimental) The time at which the event was received by the input transformer.

This is an ISO 8601 timestamp. This time is different for the enrichment input transformer and the target input transformer, depending on when the enrichment completed processing the event.

Stability:

experimental

EVENT_JSON

(experimental) The same as aws.pipes.event, but the variable only has a value if the original payload, either from the source or returned by the enrichment, is JSON. If the pipe has an encoded field, such as the Amazon SQS body field or the Kinesis data, those fields are decoded and turned into valid JSON. Because it isn’t escaped, the variable can only be used as a value for a JSON field. For more information, see Implicit body data parsing.

Stability:

experimental

NAME

(experimental) The name of the pipe.

Stability:

experimental

SOURCE_ARN

(experimental) The ARN of the event source of the pipe.

Stability:

experimental

TARGET_ARN

(experimental) The ARN of the target of the pipe.

Stability:

experimental