Package software.amazon.awscdk.services.events

Class RuleProps.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.events.RuleProps.Jsii$Proxy

All Implemented Interfaces:

RuleProps, software.amazon.jsii.JsiiSerializable

Enclosing interface:

RuleProps

@Stability(Stable)
@Internal
public static final class RuleProps.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements RuleProps

An implementation for RuleProps

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.services.events.RuleProps

RuleProps.Builder, RuleProps.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Jsii$Proxy(RuleProps.Builder builder)	Constructor that initializes the object based on literal property values passed by the RuleProps.Builder.
protected	Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)	Constructor that initializes the object based on values retrieved from the JsiiObject.

Method Summary

Modifier and Type	Method	Description
com.fasterxml.jackson.databind.JsonNode	$jsii$toJson()
final boolean	equals(Object o)
final String	getDescription()	A description of the rule's purpose.
final Boolean	getEnabled()	Indicates whether the rule is enabled.
final IEventBus	getEventBus()	The event bus to associate with this rule.
final EventPattern	getEventPattern()	Describes which events EventBridge routes to the specified target.
final String	getRuleName()	A name for the rule.
final Schedule	getSchedule()	The schedule or rate (frequency) that determines when EventBridge runs the rule.
final List<IRuleTarget>	getTargets()	Targets to invoke when this rule matches an event.
final int	hashCode()

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, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Jsii$Proxy

protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Constructor that initializes the object based on values retrieved from the JsiiObject.

Parameters:

objRef - Reference to the JSII managed object.

Jsii$Proxy

protected Jsii$Proxy(RuleProps.Builder builder)

Constructor that initializes the object based on literal property values passed by the RuleProps.Builder.

Method Details

getDescription

public final String getDescription()

Description copied from interface: RuleProps

A description of the rule's purpose.

Default: - No description.

Specified by:

getDescription in interface RuleProps

getEnabled

public final Boolean getEnabled()

Description copied from interface: RuleProps

Indicates whether the rule is enabled.

Default: true

Specified by:

getEnabled in interface RuleProps

getEventBus

public final IEventBus getEventBus()

Description copied from interface: RuleProps

The event bus to associate with this rule.

Default: - The default event bus.

Specified by:

getEventBus in interface RuleProps

getEventPattern

public final EventPattern getEventPattern()

Description copied from interface: RuleProps

Describes which events EventBridge routes to the specified target.

These routed events are matched events. For more information, see Events and Event Patterns in the Amazon EventBridge User Guide.

Default: - None.

Specified by:

getEventPattern in interface RuleProps

See Also:

• https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html You must specify this property (either via props or via `addEventPattern`), the `scheduleExpression` property, or both. The method `addEventPattern` can be used to add filter values to the event pattern.

getRuleName

public final String getRuleName()

Description copied from interface: RuleProps

A name for the rule.

Default: - AWS CloudFormation generates a unique physical ID and uses that ID for the rule name. For more information, see Name Type.

Specified by:

getRuleName in interface RuleProps

getSchedule

public final Schedule getSchedule()

Description copied from interface: RuleProps

The schedule or rate (frequency) that determines when EventBridge runs the rule.

For more information, see Schedule Expression Syntax for Rules in the Amazon EventBridge User Guide.

Default: - None.

Specified by:

getSchedule in interface RuleProps

See Also:

• https://docs.aws.amazon.com/eventbridge/latest/userguide/scheduled-events.html You must specify this property, the `eventPattern` property, or both.

getTargets

public final List<IRuleTarget> getTargets()

Description copied from interface: RuleProps

Targets to invoke when this rule matches an event.

Input will be the full matched event. If you wish to specify custom target input, use addTarget(target[, inputOptions]).

Default: - No targets.

Specified by:

getTargets in interface RuleProps

$jsii$toJson

@Internal
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()

Specified by:

$jsii$toJson in interface software.amazon.jsii.JsiiSerializable

equals

public final boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object