class Amazonite::EventBridge::PutRuleRequest

Included Modules

Defined in:

eventbridge/put_rule_request.cr

Constructors

Instance Method Summary

Constructor Detail

def self.new(pull : JSON::PullParser) #

[View source]
def self.new(name : String, schedule_expression : String | Nil = nil, event_pattern : String | Nil = nil, state : RuleState | Nil = nil, description : String | Nil = nil, role_arn : String | Nil = nil, tags : Array(Tag) | Nil = nil, event_bus_name : String | Nil = nil) #

[View source]

Instance Method Detail

def ==(other : self) #
Description copied from class Reference

Returns true if this reference is the same as other. Invokes same?.


def description : String | Nil #

A description of the rule.


[View source]
def description=(description : String | Nil) #

A description of the rule.


[View source]
def event_bus_name : String | Nil #

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


[View source]
def event_bus_name=(event_bus_name : String | Nil) #

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


[View source]
def event_pattern : String | Nil #

The event pattern. For more information, see Amazon EventBridge event patterns in the * Amazon EventBridge User Guide *.


[View source]
def event_pattern=(event_pattern : String | Nil) #

The event pattern. For more information, see Amazon EventBridge event patterns in the * Amazon EventBridge User Guide *.


[View source]
def hash(hasher) #
Description copied from class Reference

See Object#hash(hasher)


def name : String #

The name of the rule that you are creating or updating.


[View source]
def name=(name : String) #

The name of the rule that you are creating or updating.


[View source]
def role_arn : String | Nil #

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

If you're setting an event bus in another account as the target and that account granted permission to your account through an organization instead of directly by the account ID, you must specify a RoleArn with proper permissions in the Target structure, instead of here in this parameter.


[View source]
def role_arn=(role_arn : String | Nil) #

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

If you're setting an event bus in another account as the target and that account granted permission to your account through an organization instead of directly by the account ID, you must specify a RoleArn with proper permissions in the Target structure, instead of here in this parameter.


[View source]
def schedule_expression : String | Nil #

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


[View source]
def schedule_expression=(schedule_expression : String | Nil) #

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


[View source]
def state : RuleState | Nil #

The state of the rule.

Valid values include:

  • DISABLED: The rule is disabled. EventBridge does not match any events against the rule.

  • ENABLED: The rule is enabled. EventBridge matches events against the rule, except for Amazon Web Services management events delivered through CloudTrail.

  • ENABLED_WITH_ALL_CLOUDTRAIL_MANAGEMENT_EVENTS: The rule is enabled for all events, including Amazon Web Services management events delivered through CloudTrail.

Management events provide visibility into management operations that are performed on resources in your Amazon Web Services account. These are also known as control plane operations. For more information, see Logging management events in the CloudTrail User Guide, and Filtering management events from Amazon Web Services services in the * Amazon EventBridge User Guide *.

This value is only valid for rules on the default event bus or custom event buses. It does not apply to partner event buses.


[View source]
def state=(state : RuleState | Nil) #

The state of the rule.

Valid values include:

  • DISABLED: The rule is disabled. EventBridge does not match any events against the rule.

  • ENABLED: The rule is enabled. EventBridge matches events against the rule, except for Amazon Web Services management events delivered through CloudTrail.

  • ENABLED_WITH_ALL_CLOUDTRAIL_MANAGEMENT_EVENTS: The rule is enabled for all events, including Amazon Web Services management events delivered through CloudTrail.

Management events provide visibility into management operations that are performed on resources in your Amazon Web Services account. These are also known as control plane operations. For more information, see Logging management events in the CloudTrail User Guide, and Filtering management events from Amazon Web Services services in the * Amazon EventBridge User Guide *.

This value is only valid for rules on the default event bus or custom event buses. It does not apply to partner event buses.


[View source]
def tags : Array(Tag) | Nil #

The list of key-value pairs to associate with the rule.


[View source]
def tags=(tags : Array(Tag) | Nil) #

The list of key-value pairs to associate with the rule.


[View source]
def validate! : Nil #

[View source]