Package software.amazon.awscdk.services.pipes.alpha

Enum PipeVariable

java.lang.Object
java.lang.Enum<PipeVariable>
software.amazon.awscdk.services.pipes.alpha.PipeVariable
All Implemented Interfaces:
Serializable, Comparable<PipeVariable>, java.lang.constant.Constable
@Generated(value="jsii-pacmak/1.101.0 (build b95fe5d)", date="2024-08-02T00:29:19.650Z") @Stability(Experimental) public enum PipeVariable extends Enum<PipeVariable>
(experimental) Reserved pipe variables.

See Also:

  • Enum Constant Details

    • ARN

      @Stability(Experimental) public static final PipeVariable ARN
      (experimental) The Amazon Resource Name (ARN) of the pipe.

    • NAME

      @Stability(Experimental) public static final PipeVariable NAME
      (experimental) The name of the pipe.

    • SOURCE_ARN

      @Stability(Experimental) public static final PipeVariable SOURCE_ARN
      (experimental) The ARN of the event source of the pipe.

    • ENRICHMENT_ARN

      @Stability(Experimental) public static final PipeVariable ENRICHMENT_ARN
      (experimental) The ARN of the enrichment of the pipe.

    • TARGET_ARN

      @Stability(Experimental) public static final PipeVariable TARGET_ARN
      (experimental) The ARN of the target of the pipe.

    • EVENT_INGESTION_TIME

      @Stability(Experimental) public static final PipeVariable 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.

    • EVENT

      @Stability(Experimental) public static final PipeVariable EVENT
      (experimental) The event as received by the input transformer.

    • EVENT_JSON

      @Stability(Experimental) public static final PipeVariable 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.

  • Method Details

    • values

      public static PipeVariable[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      Returns:
      an array containing the constants of this enum type, in the order they are declared

    • valueOf

      public static PipeVariable valueOf(String name)
      Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum type has no constant with the specified name
      NullPointerException - if the argument is null