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

Class SnsPublish

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.scheduler.targets.alpha.ScheduleTargetBase

software.amazon.awscdk.services.scheduler.targets.alpha.SnsPublish

All Implemented Interfaces:

IScheduleTarget, software.amazon.jsii.JsiiSerializable

@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)",
           date="2024-05-08T21:35:16.140Z")
@Stability(Experimental)
public class SnsPublish
extends ScheduleTargetBase
implements IScheduleTarget

(experimental) Use an Amazon SNS topic as a target for AWS EventBridge Scheduler.

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

Modifier and Type	Class	Description
static final class	SnsPublish.Builder	(experimental) A fluent builder for SnsPublish.

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

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.scheduler.alpha.IScheduleTarget

IScheduleTarget.Jsii$Default, IScheduleTarget.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
	SnsPublish(ITopic topic)
	SnsPublish(ITopic topic, ScheduleTargetBaseProps props)
protected	SnsPublish(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	SnsPublish(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method	Description
protected void	addTargetActionToRole(ISchedule schedule, IRole role)

Methods inherited from class software.amazon.awscdk.services.scheduler.targets.alpha.ScheduleTargetBase

bind, bindBaseTargetConfig, getTargetArn

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.awscdk.services.scheduler.alpha.IScheduleTarget

bind

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Details

SnsPublish

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

SnsPublish

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

SnsPublish

@Stability(Experimental)
public SnsPublish(@NotNull
 ITopic topic,
 @Nullable
 ScheduleTargetBaseProps props)

Parameters:

topic - This parameter is required.

props -

SnsPublish

@Stability(Experimental)
public SnsPublish(@NotNull
 ITopic topic)

Parameters:

topic - This parameter is required.

Method Details

addTargetActionToRole

@Stability(Experimental)
protected void addTargetActionToRole(@NotNull
 ISchedule schedule,
 @NotNull
 IRole role)

Specified by:

addTargetActionToRole in class ScheduleTargetBase

Parameters:

schedule - This parameter is required.

role - This parameter is required.