Struct Rule

#[non_exhaustive]
pub struct Rule {
    pub name: Option<String>,
    pub arn: Option<String>,
    pub event_pattern: Option<String>,
    pub state: Option<RuleState>,
    pub description: Option<String>,
    pub schedule_expression: Option<String>,
    pub role_arn: Option<String>,
    pub managed_by: Option<String>,
    pub event_bus_name: Option<String>,
}

Contains information about a rule in Amazon EventBridge.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

name: Option<String>

The name of the rule.

arn: Option<String>

The Amazon Resource Name (ARN) of the rule.

event_pattern: Option<String>

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

state: Option<RuleState>

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.

description: Option<String>

The description of the rule.

schedule_expression: Option<String>

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.

role_arn: Option<String>

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

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.

managed_by: Option<String>

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

event_bus_name: Option<String>

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

Implementations

impl Rule

pub fn name(&self) -> Option<&str>

The name of the rule.

pub fn arn(&self) -> Option<&str>

The Amazon Resource Name (ARN) of the rule.

pub fn event_pattern(&self) -> Option<&str>

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

pub fn state(&self) -> Option<&RuleState>

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.

pub fn description(&self) -> Option<&str>

The description of the rule.

pub fn schedule_expression(&self) -> Option<&str>

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.

pub fn role_arn(&self) -> Option<&str>

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

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.

pub fn managed_by(&self) -> Option<&str>

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

pub fn event_bus_name(&self) -> Option<&str>

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

impl Rule

pub fn builder() -> RuleBuilder

Creates a new builder-style object to manufacture Rule.

Trait Implementations

impl Clone for Rule

fn clone(&self) -> Rule

Returns a duplicate of the value.

const fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Rule

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for Rule

fn eq(&self, other: &Rule) -> bool

Tests for self and other values to be equal, and is used by ==.

const fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Rule