enum PipeVariable

enum PipeVariable 🔹

Language Type name

.NET Amazon.CDK.AWS.Pipes.Alpha.PipeVariable

Go github.com/aws/aws-cdk-go/awscdkpipesalpha/v2#PipeVariable

Java software.amazon.awscdk.services.pipes.alpha.PipeVariable

Python aws_cdk.aws_pipes_alpha.PipeVariable

TypeScript (source) @aws-cdk/aws-pipes-alpha » PipeVariable

Reserved pipe variables.

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

Members

Name Description

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

NAME 🔹 The name of the pipe.

SOURCE_ARN 🔹 The ARN of the event source of the pipe.

ENRICHMENT_ARN 🔹 The ARN of the enrichment of the pipe.

TARGET_ARN 🔹 The ARN of the target of the pipe.

EVENT_INGESTION_TIME 🔹 The time at which the event was received by the input transformer.

EVENT 🔹 The event as received by the input transformer.

EVENT_JSON 🔹 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.

ARN 🔹

The Amazon Resource Name (ARN) of the pipe.

NAME 🔹

The name of the pipe.

SOURCE_ARN 🔹

The ARN of the event source of the pipe.

ENRICHMENT_ARN 🔹

The ARN of the enrichment of the pipe.

TARGET_ARN 🔹

The ARN of the target of the pipe.

EVENT_INGESTION_TIME 🔹

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.

EVENT 🔹

The event as received by the input transformer.

EVENT_JSON 🔹

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.

Language	Type name
.NET	`Amazon.CDK.AWS.Pipes.Alpha.PipeVariable`
Go	`github.com/aws/aws-cdk-go/awscdkpipesalpha/v2#PipeVariable`
Java	`software.amazon.awscdk.services.pipes.alpha.PipeVariable`
Python	`aws_cdk.aws_pipes_alpha.PipeVariable`
TypeScript (source)	`@aws-cdk/aws-pipes-alpha` » `PipeVariable`

Name	Description
ARN 🔹	The Amazon Resource Name (ARN) of the pipe.
NAME 🔹	The name of the pipe.
SOURCE_ARN 🔹	The ARN of the event source of the pipe.
ENRICHMENT_ARN 🔹	The ARN of the enrichment of the pipe.
TARGET_ARN 🔹	The ARN of the target of the pipe.
EVENT_INGESTION_TIME 🔹	The time at which the event was received by the input transformer.
EVENT 🔹	The event as received by the input transformer.
EVENT_JSON 🔹	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.