Class ScheduleTargetInput
(experimental) The text, or well-formed JSON, passed to the target of the schedule.
Inheritance
Namespace: Amazon.CDK.AWS.Scheduler.Alpha
Assembly: Amazon.CDK.AWS.Scheduler.Alpha.dll
Syntax (csharp)
public abstract class ScheduleTargetInput : DeputyBase
Syntax (vb)
Public MustInherit Class ScheduleTargetInput
Inherits DeputyBase
Remarks
Stability: Experimental
ExampleMetadata: infused
Examples
using Amazon.CDK.AWS.SNS;
var topic = new Topic(this, "Topic");
IDictionary<string, string> payload = new Dictionary<string, string> {
{ "message", "Hello scheduler!" }
};
var target = new SnsPublish(topic, new ScheduleTargetBaseProps {
Input = ScheduleTargetInput.FromObject(payload)
});
new Schedule(this, "Schedule", new ScheduleProps {
Schedule = ScheduleExpression.Rate(Duration.Hours(1)),
Target = target
});
Synopsis
Constructors
ScheduleTargetInput() | |
ScheduleTargetInput(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
ScheduleTargetInput(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Methods
Bind(ISchedule) | (experimental) Return the input properties for this input object. |
FromObject(Object) | (experimental) Pass a JSON object to the target, it is possible to embed |
FromText(String) | (experimental) Pass text to the target, it is possible to embed |
Constructors
ScheduleTargetInput()
protected ScheduleTargetInput()
Remarks
Stability: Experimental
ScheduleTargetInput(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected ScheduleTargetInput(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
ScheduleTargetInput(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected ScheduleTargetInput(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Methods
Bind(ISchedule)
(experimental) Return the input properties for this input object.
public abstract string Bind(ISchedule schedule)
Parameters
- schedule ISchedule
Returns
System.String
Remarks
Stability: Experimental
FromObject(Object)
(experimental) Pass a JSON object to the target, it is possible to embed ContextAttributes
and other cdk references.
public static ScheduleTargetInput FromObject(object obj)
Parameters
- obj System.Object
object to use to convert to JSON to use as input for the target.
Returns
Remarks
Stability: Experimental
FromText(String)
(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.
public static ScheduleTargetInput FromText(string text)
Parameters
- text System.String
Text to use as the input for the target.
Returns
Remarks
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.
Stability: Experimental