Struct aws_sdk_eventbridge::operation::put_rule::PutRuleInput

#[non_exhaustive]
pub struct PutRuleInput {
    pub name: Option<String>,
    pub schedule_expression: Option<String>,
    pub event_pattern: Option<String>,
    pub state: Option<RuleState>,
    pub description: Option<String>,
    pub role_arn: Option<String>,
    pub tags: Option<Vec<Tag>>,
    pub event_bus_name: Option<String>,
}

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 that you are creating or updating.

schedule_expression: Option<String>

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

event_pattern: Option<String>

The event pattern. For more information, see Amazon EventBridge 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>

A description of the rule.

role_arn: Option<String>

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.

tags: Option<Vec<Tag>>

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

event_bus_name: Option<String>

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

Implementations

impl PutRuleInput

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

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

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

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

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

The event pattern. For more information, see Amazon EventBridge 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>

A description of the rule.

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

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.

pub fn tags(&self) -> &[Tag]

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

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .tags.is_none().

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

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

impl PutRuleInput

pub fn builder() -> PutRuleInputBuilder

Creates a new builder-style object to manufacture PutRuleInput.

Trait Implementations

impl Clone for PutRuleInput

fn clone(&self) -> PutRuleInput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PutRuleInput

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

Formats the value using the given formatter.

impl PartialEq for PutRuleInput

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for PutRuleInput