EventRuleArgs class

The set of arguments for EventRule. The set of arguments for EventRule.

Constructors

EventRuleArgs({Input<String?>? description, Input<String?>? eventBusName, Input<String?>? eventPattern, Input<bool?>? forceDestroy, Input<bool?>? isEnabled, Input<String?>? name, Input<String?>? namePrefix, Input<String?>? region, Input<String?>? roleArn, Input<String?>? scheduleExpression, Input<String?>? state, Input<Map<String, String>?>? tags})
Creates a new EventRuleArgs. description The description of the rule. eventBusName The name or ARN of the event bus to associate with this rule. If you omit this, the default event bus is used. eventPattern The event pattern described a JSON object. At least one of scheduleExpression or eventPattern is required. See full documentation of Events and Event Patterns in EventBridge for details. Note: The event pattern size is 2048 by default but it is adjustable up to 4096 characters by submitting a service quota increase request. See Amazon EventBridge quotas for details. forceDestroy Used to delete managed rules created by AWS. Defaults to false. isEnabled Whether the rule should be enabled. Defaults to true. Conflicts with state. name The name of the rule. If omitted, this provider will assign a random, unique name. Conflicts with namePrefix. namePrefix Creates a unique name beginning with the specified prefix. Conflicts with name. Note: Due to the length of the generated suffix, must be 38 characters or less. region Region where this resource will be managed. Defaults to the Region set in the provider configuration. roleArn ARN associated with the role that is used for target invocation. scheduleExpression The scheduling expression. For example, cron(0 20 * * ? *) or rate(5 minutes). At least one of scheduleExpression or eventPattern is required. Can only be used on the default event bus. For more information, refer to the AWS documentation Schedule Expressions for Rules. state State of the rule. Valid values are DISABLED, ENABLED, and ENABLED_WITH_ALL_CLOUDTRAIL_MANAGEMENT_EVENTS. When state is ENABLED, the rule is enabled for all events except those delivered by CloudTrail. To also enable the rule for events delivered by CloudTrail, set state to ENABLED_WITH_ALL_CLOUDTRAIL_MANAGEMENT_EVENTS. Defaults to ENABLED. Conflicts with isEnabled. tags A map of tags to assign to the resource. .If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
const
EventRuleArgs.fromMap(Map<String, dynamic> map)
factory

Properties

description → Input<String?>?
The description of the rule.
final
eventBusName → Input<String?>?
The name or ARN of the event bus to associate with this rule. If you omit this, the default event bus is used.
final
eventPattern → Input<String?>?
The event pattern described a JSON object. At least one of scheduleExpression or eventPattern is required. See full documentation of Events and Event Patterns in EventBridge for details. Note: The event pattern size is 2048 by default but it is adjustable up to 4096 characters by submitting a service quota increase request. See Amazon EventBridge quotas for details.
final
forceDestroy → Input<bool?>?
Used to delete managed rules created by AWS. Defaults to false.
final
hashCode → int
The hash code for this object.
no setterinherited
isEnabled → Input<bool?>?
Whether the rule should be enabled. Defaults to true. Conflicts with state.
final
name → Input<String?>?
The name of the rule. If omitted, this provider will assign a random, unique name. Conflicts with namePrefix.
final
namePrefix → Input<String?>?
Creates a unique name beginning with the specified prefix. Conflicts with name. Note: Due to the length of the generated suffix, must be 38 characters or less.
final
region → Input<String?>?
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
final
roleArn → Input<String?>?
ARN associated with the role that is used for target invocation.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
scheduleExpression → Input<String?>?
The scheduling expression. For example, cron(0 20 * * ? *) or rate(5 minutes). At least one of scheduleExpression or eventPattern is required. Can only be used on the default event bus. For more information, refer to the AWS documentation Schedule Expressions for Rules.
final
state → Input<String?>?
State of the rule. Valid values are DISABLED, ENABLED, and ENABLED_WITH_ALL_CLOUDTRAIL_MANAGEMENT_EVENTS. When state is ENABLED, the rule is enabled for all events except those delivered by CloudTrail. To also enable the rule for events delivered by CloudTrail, set state to ENABLED_WITH_ALL_CLOUDTRAIL_MANAGEMENT_EVENTS. Defaults to ENABLED. Conflicts with isEnabled.
final
tags → Input<Map<String, String>?>?
A map of tags to assign to the resource. .If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toMap() → Map<String, dynamic>
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited