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

Class DynamicInput

java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awscdk.services.pipes.alpha.DynamicInput
All Implemented Interfaces:
IResolvable, software.amazon.jsii.JsiiSerializable
@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)", date="2024-05-08T21:35:15.949Z") @Stability(Experimental) public class DynamicInput extends software.amazon.jsii.JsiiObject implements IResolvable
(experimental) Dynamic variables that can be used in the input transformation.

Example: 

 Queue sourceQueue;
 Queue targetQueue;
 InputTransformation targetInputTransformation = InputTransformation.fromObject(Map.of(
         "staticField", "static value",
         "dynamicField", DynamicInput.fromEventPath("$.body.payload"),
         "pipeVariable", DynamicInput.getPipeName()));
 Pipe pipe = Pipe.Builder.create(this, "Pipe")
         .pipeName("MyPipe")
         .source(new SqsSource(sourceQueue))
         .target(new SqsTarget(targetQueue, Map.of(
                 "inputTransformation", targetInputTransformation)))
         .build();

  • Nested Class Summary

    Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

    software.amazon.jsii.JsiiObject.InitializationMode

    Nested classes/interfaces inherited from interface software.amazon.awscdk.IResolvable

    IResolvable.Jsii$Default, IResolvable.Jsii$Proxy

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    protected
    DynamicInput(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
     
    protected
    DynamicInput(software.amazon.jsii.JsiiObjectRef objRef)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    static DynamicInput
    fromEventPath(String path)
    (experimental) Value from the event payload at jsonPath.
    List<String>
    getCreationStack()
    (experimental) The creation stack of this resolvable which will be appended to errors thrown during resolution.
    String
    getDisplayHint()
    (experimental) Human readable display hint about the event pattern.
    static DynamicInput
    getEnrichmentArn()
    (experimental) The ARN of the enrichment of the pipe.
    static DynamicInput
    getEvent()
    (experimental) The event as received by the input transformer.
    static DynamicInput
    getEventIngestionTime()
    (experimental) The time at which the event was received by the input transformer.
    static DynamicInput
    getEventJson()
    (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.
    static DynamicInput
    getPipeArn()
    (experimental) The Amazon Resource Name (ARN) of the pipe.
    static DynamicInput
    getPipeName()
    (experimental) The name of the pipe.
    static DynamicInput
    getSourceArn()
    (experimental) The ARN of the event source of the pipe.
    static DynamicInput
    getTargetArn()
    (experimental) The ARN of the target of the pipe.
    Object
    resolve(IResolveContext _context)
    (experimental) Produce the Token's value at resolution time.
    String
    toJSON()
    (experimental) Return a JSON representation of a dynamic input.
    String
    toString()
    (experimental) Return a string representation of a dynamic input.

    Methods inherited from class software.amazon.jsii.JsiiObject

    jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

    Methods inherited from interface software.amazon.awscdk.IResolvable

    getTypeHint

    Methods inherited from interface software.amazon.jsii.JsiiSerializable

    $jsii$toJson

  • Constructor Details

    • DynamicInput

      protected DynamicInput(software.amazon.jsii.JsiiObjectRef objRef)

    • DynamicInput

      protected DynamicInput(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

  • Method Details

    • fromEventPath

      @Stability(Experimental) @NotNull public static DynamicInput fromEventPath(@NotNull String path)
      (experimental) Value from the event payload at jsonPath.

      Parameters:
      path - This parameter is required.

    • resolve

      @Stability(Experimental) @NotNull public Object resolve(@NotNull IResolveContext _context)
      (experimental) Produce the Token's value at resolution time.

      Specified by:
      resolve in interface IResolvable
      Parameters:
      _context - This parameter is required.

    • toJSON

      @Stability(Experimental) @NotNull public String toJSON()
      (experimental) Return a JSON representation of a dynamic input.

    • toString

      @Stability(Experimental) @NotNull public String toString()
      (experimental) Return a string representation of a dynamic input.
      Specified by:
      toString in interface IResolvable
      Overrides:
      toString in class Object

    • getEnrichmentArn

      @Stability(Experimental) @NotNull public static DynamicInput getEnrichmentArn()
      (experimental) The ARN of the enrichment of the pipe.

    • getEvent

      @Stability(Experimental) @NotNull public static DynamicInput getEvent()
      (experimental) The event as received by the input transformer.

    • getEventIngestionTime

      @Stability(Experimental) @NotNull public static DynamicInput getEventIngestionTime()
      (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.

    • getEventJson

      @Stability(Experimental) @NotNull public static DynamicInput getEventJson()
      (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.

    • getPipeArn

      @Stability(Experimental) @NotNull public static DynamicInput getPipeArn()
      (experimental) The Amazon Resource Name (ARN) of the pipe.

    • getPipeName

      @Stability(Experimental) @NotNull public static DynamicInput getPipeName()
      (experimental) The name of the pipe.

    • getSourceArn

      @Stability(Experimental) @NotNull public static DynamicInput getSourceArn()
      (experimental) The ARN of the event source of the pipe.

    • getTargetArn

      @Stability(Experimental) @NotNull public static DynamicInput getTargetArn()
      (experimental) The ARN of the target of the pipe.

    • getCreationStack

      @Stability(Experimental) @NotNull public List<String> getCreationStack()
      (experimental) The creation stack of this resolvable which will be appended to errors thrown during resolution.

      This may return an array with a single informational element indicating how to get this property populated, if it was skipped for performance reasons.

      Specified by:
      getCreationStack in interface IResolvable

    • getDisplayHint

      @Stability(Experimental) @NotNull public String getDisplayHint()
      (experimental) Human readable display hint about the event pattern.