pulumi-aws-native-kotlin/com.pulumi.awsnative.events.kotlin/RuleArgs

RuleArgs

data class RuleArgs(val description: Output<String>? = null, val eventBusName: Output<String>? = null, val eventPattern: Output<Any>? = null, val name: Output<String>? = null, val roleArn: Output<String>? = null, val scheduleExpression: Output<String>? = null, val state: Output<RuleState>? = null, val targets: Output<List<RuleTargetArgs>>? = null) : ConvertibleToJava<RuleArgs>

Resource Type definition for AWS::Events::Rule

Example Usage

Example

No Java example available.

Constructors

RuleArgs

constructor(description: Output<String>? = null, eventBusName: Output<String>? = null, eventPattern: Output<Any>? = null, name: Output<String>? = null, roleArn: Output<String>? = null, scheduleExpression: Output<String>? = null, state: Output<RuleState>? = null, targets: Output<List<RuleTargetArgs>>? = null)

Properties

description

val description: Output<String>? = null

The description of the rule.

eventBusName

val eventBusName: Output<String>? = null

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

eventPattern

val eventPattern: Output<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.

name

val name: Output<String>? = null

The name of the rule.

roleArn

val roleArn: Output<String>? = null

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

scheduleExpression

val scheduleExpression: Output<String>? = null

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.

state

val state: Output<RuleState>? = null

The state of the rule.

targets

val targets: Output<List<RuleTargetArgs>>? = 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.

Functions

toJava

open override fun toJava(): RuleArgs