Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.CloudWatchEvents.Types.Rule

Description

Synopsis

data Rule = Rule' {
- eventPattern :: Maybe Text
- state :: Maybe RuleState
- arn :: Maybe Text
- eventBusName :: Maybe Text
- scheduleExpression :: Maybe Text
- name :: Maybe Text
- description :: Maybe Text
- managedBy :: Maybe Text
- roleArn :: Maybe Text
}
newRule :: Rule
rule_eventPattern :: Lens' Rule (Maybe Text)
rule_state :: Lens' Rule (Maybe RuleState)
rule_arn :: Lens' Rule (Maybe Text)
rule_eventBusName :: Lens' Rule (Maybe Text)
rule_scheduleExpression :: Lens' Rule (Maybe Text)
rule_name :: Lens' Rule (Maybe Text)
rule_description :: Lens' Rule (Maybe Text)
rule_managedBy :: Lens' Rule (Maybe Text)
rule_roleArn :: Lens' Rule (Maybe Text)

Documentation

data Rule Source #

Contains information about a rule in Amazon EventBridge.

See: newRule smart constructor.

Constructors

Rule'

Fields

eventPattern :: Maybe Text
The event pattern of the rule. For more information, see Events and Event Patterns in the Amazon EventBridge User Guide.
state :: Maybe RuleState
The state of the rule.
arn :: Maybe Text
The Amazon Resource Name (ARN) of the rule.
eventBusName :: Maybe Text
The name or ARN of the event bus associated with the rule. If you omit this, the default event bus is used.
scheduleExpression :: Maybe Text
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.
name :: Maybe Text
The name of the rule.
description :: Maybe Text
The description of the rule.
managedBy :: Maybe Text
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.
roleArn :: Maybe Text
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.

Instances

Instances details

Eq Rule Source #
Instance details Defined in Amazonka.CloudWatchEvents.Types.Rule Methods (==) :: Rule -> Rule -> Bool # (/=) :: Rule -> Rule -> Bool #
Read Rule Source #
Instance details Defined in Amazonka.CloudWatchEvents.Types.Rule Methods readsPrec :: Int -> ReadS Rule # readList :: ReadS [Rule] # readPrec :: ReadPrec Rule # readListPrec :: ReadPrec [Rule] #
Show Rule Source #
Instance details Defined in Amazonka.CloudWatchEvents.Types.Rule Methods showsPrec :: Int -> Rule -> ShowS # show :: Rule -> String # showList :: [Rule] -> ShowS #
Generic Rule Source #
Instance details Defined in Amazonka.CloudWatchEvents.Types.Rule Associated Types type Rep Rule :: Type -> Type # Methods from :: Rule -> Rep Rule x # to :: Rep Rule x -> Rule #
NFData Rule Source #
Instance details Defined in Amazonka.CloudWatchEvents.Types.Rule Methods rnf :: Rule -> () #
Hashable Rule Source #
Instance details Defined in Amazonka.CloudWatchEvents.Types.Rule Methods hashWithSalt :: Int -> Rule -> Int # hash :: Rule -> Int #
FromJSON Rule Source #
Instance details Defined in Amazonka.CloudWatchEvents.Types.Rule Methods parseJSON :: Value -> Parser Rule # parseJSONList :: Value -> Parser [Rule] #
type Rep Rule Source #
Instance details Defined in Amazonka.CloudWatchEvents.Types.Rule type Rep Rule = D1 ('MetaData "Rule" "Amazonka.CloudWatchEvents.Types.Rule" "libZSservicesZSamazonka-cloudwatch-eventsZSamazonka-cloudwatch-events" 'False) (C1 ('MetaCons "Rule'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "eventPattern") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "state") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RuleState))) :: (S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "eventBusName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "scheduleExpression") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "managedBy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "roleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))))

newRule :: Rule Source #

Create a value of Rule with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:eventPattern:Rule', rule_eventPattern - The event pattern of the rule. For more information, see Events and Event Patterns in the Amazon EventBridge User Guide.

$sel:state:Rule', rule_state - The state of the rule.

$sel:arn:Rule', rule_arn - The Amazon Resource Name (ARN) of the rule.

$sel:eventBusName:Rule', rule_eventBusName - The name or ARN of the event bus associated with the rule. If you omit this, the default event bus is used.

$sel:scheduleExpression:Rule', rule_scheduleExpression - 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.

$sel:name:Rule', rule_name - The name of the rule.

$sel:description:Rule', rule_description - The description of the rule.

$sel:managedBy:Rule', rule_managedBy - 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.

$sel:roleArn:Rule', rule_roleArn - 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.

rule_eventPattern :: Lens' Rule (Maybe Text) Source #

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

rule_state :: Lens' Rule (Maybe RuleState) Source #

The state of the rule.

rule_arn :: Lens' Rule (Maybe Text) Source #

The Amazon Resource Name (ARN) of the rule.

rule_eventBusName :: Lens' Rule (Maybe Text) Source #

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

rule_scheduleExpression :: Lens' Rule (Maybe Text) Source #

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.

rule_name :: Lens' Rule (Maybe Text) Source #

The name of the rule.

rule_description :: Lens' Rule (Maybe Text) Source #

The description of the rule.

rule_managedBy :: Lens' Rule (Maybe Text) Source #

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.

rule_roleArn :: Lens' Rule (Maybe Text) Source #

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.