eventbridge/aws.sdk.kotlin.services.eventbridge.model/DescribeRuleResponse

DescribeRuleResponse

class DescribeRuleResponse

Types

Builder

class Builder

Companion

object Companion

Properties

arn

val arn: String?

The Amazon Resource Name (ARN) of the rule.

createdBy

val createdBy: String?

The account ID of the user that created the rule. If you use PutRule to put a rule on an event bus in another account, the other account is the owner of the rule, and the rule ARN includes the account ID for that account. However, the value for CreatedBy is the account ID as the account that created the rule in the other account.

description

val description: String?

The description of the rule.

eventBusName

val eventBusName: String?

The name of the event bus associated with the rule.

eventPattern

val eventPattern: String?

The event pattern. For more information, see Events and Event Patterns in the Amazon EventBridge User Guide.

managedBy

val managedBy: String?

If this is a managed rule, created by an Amazon Web Services service on your behalf, this field displays the principal name of the Amazon Web Services service that created the rule.

name

val name: String?

The name of the rule.

roleArn

val roleArn: String?

The Amazon Resource Name (ARN) of the IAM role associated with the rule.

scheduleExpression

val scheduleExpression: String?

The scheduling expression. For example, "cron(0 20 * * ? *)", "rate(5 minutes)".

state

val state: RuleState?

Specifies whether the rule is enabled or disabled.