Package software.amazon.awscdk.services.scheduler.alpha

Class ScheduleTargetInput

java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awscdk.services.scheduler.alpha.ScheduleTargetInput
All Implemented Interfaces:
software.amazon.jsii.JsiiSerializable
@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)", date="2024-05-08T21:35:16.042Z") @Stability(Experimental) public abstract class ScheduleTargetInput extends software.amazon.jsii.JsiiObject
(experimental) The text, or well-formed JSON, passed to the target of the schedule.

Example: 

 import software.amazon.awscdk.services.sns.*;
 Topic topic = new Topic(this, "Topic");
 Map<String, String> payload = Map.of(
         "message", "Hello scheduler!");
 SnsPublish target = SnsPublish.Builder.create(topic)
         .input(ScheduleTargetInput.fromObject(payload))
         .build();
 Schedule.Builder.create(this, "Schedule")
         .schedule(ScheduleExpression.rate(Duration.hours(1)))
         .target(target)
         .build();

  • Nested Class Summary

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

    software.amazon.jsii.JsiiObject.InitializationMode

  • Constructor Summary

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

  • Method Summary

    Modifier and Type
    Method
    Description
    abstract String
    bind(ISchedule schedule)
    (experimental) Return the input properties for this input object.
    static ScheduleTargetInput
    fromObject(Object obj)
    (experimental) Pass a JSON object to the target, it is possible to embed ContextAttributes and other cdk references.
    static ScheduleTargetInput
    fromText(String text)
    (experimental) Pass text to the target, it is possible to embed ContextAttributes that will be resolved to actual values while the CloudFormation is deployed or cdk Tokens that will be resolved when the CloudFormation templates are generated by CDK.

    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, toString, wait, wait, wait

    Methods inherited from interface software.amazon.jsii.JsiiSerializable

    $jsii$toJson

  • Constructor Details

    • ScheduleTargetInput

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

    • ScheduleTargetInput

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

    • ScheduleTargetInput

      @Stability(Experimental) protected ScheduleTargetInput()

  • Method Details

    • fromObject

      @Stability(Experimental) @NotNull public static ScheduleTargetInput fromObject(@NotNull Object obj)
      (experimental) Pass a JSON object to the target, it is possible to embed ContextAttributes and other cdk references.

      Parameters:
      obj - object to use to convert to JSON to use as input for the target. This parameter is required.

    • fromText

      @Stability(Experimental) @NotNull public static ScheduleTargetInput fromText(@NotNull String text)
      (experimental) Pass text to the target, it is possible to embed ContextAttributes that will be resolved to actual values while the CloudFormation is deployed or cdk Tokens that will be resolved when the CloudFormation templates are generated by CDK.

      The target input value will be a single string that you pass. For passing complex values like JSON object to a target use method ScheduleTargetInput.fromObject() instead.

      Parameters:
      text - Text to use as the input for the target. This parameter is required.

    • bind

      @Stability(Experimental) @NotNull public abstract String bind(@NotNull ISchedule schedule)
      (experimental) Return the input properties for this input object.

      Parameters:
      schedule - This parameter is required.