Stratosphere.Resources.EventsRule

The AWS::Events::Rule resource creates a rule that matches incoming Amazon CloudWatch Events (CloudWatch Events) events and routes them to one or more targets for processing. For more information, see Using CloudWatch Events in the Amazon CloudWatch User Guide.

Documentation

data EventsRule

Full data type definition for EventsRule. See eventsRule for a more convenient constructor.

Constructors

EventsRule

Fields

• _eventsRuleDescription :: Maybe (Val Text)
• _eventsRuleEventPattern :: Maybe Object
• _eventsRuleName :: Maybe (Val Text)
• _eventsRuleRoleArn :: Maybe (Val Text)
• _eventsRuleScheduleExpression :: Maybe (Val Text)
• _eventsRuleState :: Maybe EnabledState
• _eventsRuleTargets :: Maybe [Object]

Instances

Show EventsRule

Methods

showsPrec :: Int -> EventsRule -> ShowS

show :: EventsRule -> String

showList :: [EventsRule] -> ShowS

Generic EventsRule

Associated Types

type Rep EventsRule :: * -> *

Methods

from :: EventsRule -> Rep EventsRule x

to :: Rep EventsRule x -> EventsRule

ToJSON EventsRule

Methods

toJSON :: EventsRule -> Value

toEncoding :: EventsRule -> Encoding

toJSONList :: [EventsRule] -> Value

toEncodingList :: [EventsRule] -> Encoding

FromJSON EventsRule

Methods

parseJSON :: Value -> Parser EventsRule

parseJSONList :: Value -> Parser [EventsRule]

type Rep EventsRule

type Rep EventsRule = D1 (MetaData "EventsRule" "Stratosphere.Resources.EventsRule" "stratosphere-0.2.2-Fnop5S0NvsvBmp7LUeJWuv" False) (C1 (MetaCons "EventsRule" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_eventsRuleDescription") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe (Val Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_eventsRuleEventPattern") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Object))) (S1 (MetaSel (Just Symbol "_eventsRuleName") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe (Val Text)))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_eventsRuleRoleArn") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe (Val Text)))) (S1 (MetaSel (Just Symbol "_eventsRuleScheduleExpression") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe (Val Text))))) ((:*:) (S1 (MetaSel (Just Symbol "_eventsRuleState") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe EnabledState))) (S1 (MetaSel (Just Symbol "_eventsRuleTargets") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe [Object])))))))

eventsRule :: EventsRule

Constructor for EventsRule containing required fields as arguments.

erDescription :: Lens' EventsRule (Maybe (Val Text))

A description of the rule's purpose.

erEventPattern :: Lens' EventsRule (Maybe Object)

Describes which events CloudWatch Events routes to the specified target. These routed events are matched events. For more information, see Events and Event Patterns in the Amazon CloudWatch User Guide.

erName :: Lens' EventsRule (Maybe (Val Text))

A name for the rule. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the rule name. For more information, see Name Type. Important If you specify a name, you cannot do updates that require this resource to be replaced. You can still do updates that require no or some interruption. If you must replace the resource, specify a new name.

erRoleArn :: Lens' EventsRule (Maybe (Val Text))

The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants CloudWatch Events permission to make calls to target services, such as AWS Lambda (Lambda) or Amazon Kinesis streams.

erScheduleExpression :: Lens' EventsRule (Maybe (Val Text))

The schedule or rate (frequency) that determines when CloudWatch Events runs the rule. For more information, see Schedule Expression Syntax for Rules in the Amazon CloudWatch User Guide.

erState :: Lens' EventsRule (Maybe EnabledState)

Indicates whether the rule is enabled. For valid values, see the State parameter for the PutRule action in the Amazon CloudWatch Events API Reference.

erTargets :: Lens' EventsRule (Maybe [Object])

The resources, such as Lambda functions or Amazon Kinesis streams, that CloudWatch Events routes events to and invokes when the rule is triggered. For information about valid targets, see the PutTargets action in the Amazon CloudWatch Events API Reference.