GetRuleResult

data class GetRuleResult(val arn: String? = null, val description: String? = null, val eventBusName: String? = null, val eventPattern: Any? = null, val roleArn: String? = null, val scheduleExpression: String? = null, val state: RuleState? = null, val targets: List<RuleTarget>? = null)

Constructors

Link copied to clipboard
constructor(arn: String? = null, description: String? = null, eventBusName: String? = null, eventPattern: Any? = null, roleArn: String? = null, scheduleExpression: String? = null, state: RuleState? = null, targets: List<RuleTarget>? = null)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard
val arn: String? = null

The ARN of the rule, such as arn:aws:events:us-east-2:123456789012:rule/example.

Link copied to clipboard
val description: String? = null

The description of the rule.

Link copied to clipboard
val eventBusName: String? = null

The name or ARN of the event bus associated with the rule. If you omit this, the default event bus is used.

Link copied to clipboard
val eventPattern: Any? = null

The event pattern of the rule. For more information, see Events and Event Patterns in the Amazon EventBridge User Guide. Search the CloudFormation User Guide for AWS::Events::Rule for more information about the expected schema for this property.

Link copied to clipboard
val roleArn: String? = null

The Amazon Resource Name (ARN) of the role that is used for target invocation.

Link copied to clipboard

The scheduling expression. For example, "cron(0 20 * * ? *)", "rate(5 minutes)". For more information, see Creating an Amazon EventBridge rule that runs on a schedule.

Link copied to clipboard
val state: RuleState? = null

The state of the rule.

Link copied to clipboard
val targets: List<RuleTarget>? = null

Adds the specified targets to the specified rule, or updates the targets if they are already associated with the rule. Targets are the resources that are invoked when a rule is triggered.