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:

EventCommonOptions, RuleProps, software.amazon.jsii.JsiiSerializable

Enclosing interface:

RuleProps

@Stability(value=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 and Description
protected	Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef) Constructor that initializes the object based on values retrieved from the JsiiObject.
protected	Jsii$Proxy(RuleProps.Builder builder) Constructor that initializes the object based on literal property values passed by the RuleProps.Builder.

Method Summary

Modifier and Type	Method and Description
com.fasterxml.jackson.databind.JsonNode	$jsii$toJson()
boolean	equals(Object o)
software.constructs.Construct	getCrossStackScope() The scope to use if the source of the rule and its target are in different Stacks (but in the same account & region).
String	getDescription() A description of the rule's purpose.
Boolean	getEnabled() Indicates whether the rule is enabled.
IEventBus	getEventBus() The event bus to associate with this rule.
EventPattern	getEventPattern() Additional restrictions for the event to route to the specified target.
String	getRuleName() A name for the rule.
Schedule	getSchedule() The schedule or rate (frequency) that determines when EventBridge runs the rule.
List<IRuleTarget>	getTargets() Targets to invoke when this rule matches an event.
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

Methods inherited from interface software.amazon.awscdk.services.events.RuleProps

builder

Constructor Detail

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 Detail

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

getSchedule

public final Schedule getSchedule()

Description copied from interface: RuleProps

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

You must specify this property, the eventPattern property, or both.

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

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

getCrossStackScope

public final software.constructs.Construct getCrossStackScope()

Description copied from interface: EventCommonOptions

The scope to use if the source of the rule and its target are in different Stacks (but in the same account & region).

This helps dealing with cycles that often arise in these situations.

Default: - none (the main scope will be used, even for cross-stack Events)

Specified by:

getCrossStackScope in interface EventCommonOptions

getDescription

public final String getDescription()

Description copied from interface: EventCommonOptions

A description of the rule's purpose.

Default: - No description

Specified by:

getDescription in interface EventCommonOptions

getEventPattern

public final EventPattern getEventPattern()

Description copied from interface: EventCommonOptions

Additional restrictions for the event to route to the specified target.

The method that generates the rule probably imposes some type of event filtering. The filtering implied by what you pass here is added on top of that filtering.

Default: - No additional filtering based on an event pattern.

Specified by:

getEventPattern in interface EventCommonOptions

See Also:

https://docs.aws.amazon.com/eventbridge/latest/userguide/eventbridge-and-event-patterns.html

getRuleName

public final String getRuleName()

Description copied from interface: EventCommonOptions

A name for the rule.

Default: AWS CloudFormation generates a unique physical ID.

Specified by:

getRuleName in interface EventCommonOptions

$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