Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Creates a new trigger.
Synopsis
- data CreateTrigger = CreateTrigger' {}
- newCreateTrigger :: Text -> TriggerType -> CreateTrigger
- createTrigger_description :: Lens' CreateTrigger (Maybe Text)
- createTrigger_eventBatchingCondition :: Lens' CreateTrigger (Maybe EventBatchingCondition)
- createTrigger_predicate :: Lens' CreateTrigger (Maybe Predicate)
- createTrigger_schedule :: Lens' CreateTrigger (Maybe Text)
- createTrigger_startOnCreation :: Lens' CreateTrigger (Maybe Bool)
- createTrigger_tags :: Lens' CreateTrigger (Maybe (HashMap Text Text))
- createTrigger_workflowName :: Lens' CreateTrigger (Maybe Text)
- createTrigger_name :: Lens' CreateTrigger Text
- createTrigger_type :: Lens' CreateTrigger TriggerType
- createTrigger_actions :: Lens' CreateTrigger [Action]
- data CreateTriggerResponse = CreateTriggerResponse' {
- name :: Maybe Text
- httpStatus :: Int
- newCreateTriggerResponse :: Int -> CreateTriggerResponse
- createTriggerResponse_name :: Lens' CreateTriggerResponse (Maybe Text)
- createTriggerResponse_httpStatus :: Lens' CreateTriggerResponse Int
Creating a Request
data CreateTrigger Source #
See: newCreateTrigger
smart constructor.
CreateTrigger' | |
|
Instances
Create a value of CreateTrigger
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:
CreateTrigger
, createTrigger_description
- A description of the new trigger.
CreateTrigger
, createTrigger_eventBatchingCondition
- Batch condition that must be met (specified number of events received or
batch time window expired) before EventBridge event trigger fires.
CreateTrigger
, createTrigger_predicate
- A predicate to specify when the new trigger should fire.
This field is required when the trigger type is CONDITIONAL
.
CreateTrigger
, createTrigger_schedule
- A cron
expression used to specify the schedule (see
Time-Based Schedules for Jobs and Crawlers.
For example, to run something every day at 12:15 UTC, you would specify:
cron(15 12 * * ? *)
.
This field is required when the trigger type is SCHEDULED.
$sel:startOnCreation:CreateTrigger'
, createTrigger_startOnCreation
- Set to true
to start SCHEDULED
and CONDITIONAL
triggers when
created. True is not supported for ON_DEMAND
triggers.
$sel:tags:CreateTrigger'
, createTrigger_tags
- The tags to use with this trigger. You may use tags to limit access to
the trigger. For more information about tags in Glue, see
Amazon Web Services Tags in Glue
in the developer guide.
CreateTrigger
, createTrigger_workflowName
- The name of the workflow associated with the trigger.
CreateTrigger
, createTrigger_name
- The name of the trigger.
CreateTrigger
, createTrigger_type
- The type of the new trigger.
CreateTrigger
, createTrigger_actions
- The actions initiated by this trigger when it fires.
Request Lenses
createTrigger_description :: Lens' CreateTrigger (Maybe Text) Source #
A description of the new trigger.
createTrigger_eventBatchingCondition :: Lens' CreateTrigger (Maybe EventBatchingCondition) Source #
Batch condition that must be met (specified number of events received or batch time window expired) before EventBridge event trigger fires.
createTrigger_predicate :: Lens' CreateTrigger (Maybe Predicate) Source #
A predicate to specify when the new trigger should fire.
This field is required when the trigger type is CONDITIONAL
.
createTrigger_schedule :: Lens' CreateTrigger (Maybe Text) Source #
A cron
expression used to specify the schedule (see
Time-Based Schedules for Jobs and Crawlers.
For example, to run something every day at 12:15 UTC, you would specify:
cron(15 12 * * ? *)
.
This field is required when the trigger type is SCHEDULED.
createTrigger_startOnCreation :: Lens' CreateTrigger (Maybe Bool) Source #
Set to true
to start SCHEDULED
and CONDITIONAL
triggers when
created. True is not supported for ON_DEMAND
triggers.
createTrigger_tags :: Lens' CreateTrigger (Maybe (HashMap Text Text)) Source #
The tags to use with this trigger. You may use tags to limit access to the trigger. For more information about tags in Glue, see Amazon Web Services Tags in Glue in the developer guide.
createTrigger_workflowName :: Lens' CreateTrigger (Maybe Text) Source #
The name of the workflow associated with the trigger.
createTrigger_name :: Lens' CreateTrigger Text Source #
The name of the trigger.
createTrigger_type :: Lens' CreateTrigger TriggerType Source #
The type of the new trigger.
createTrigger_actions :: Lens' CreateTrigger [Action] Source #
The actions initiated by this trigger when it fires.
Destructuring the Response
data CreateTriggerResponse Source #
See: newCreateTriggerResponse
smart constructor.
CreateTriggerResponse' | |
|
Instances
newCreateTriggerResponse Source #
Create a value of CreateTriggerResponse
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:
CreateTrigger
, createTriggerResponse_name
- The name of the trigger.
$sel:httpStatus:CreateTriggerResponse'
, createTriggerResponse_httpStatus
- The response's http status code.
Response Lenses
createTriggerResponse_name :: Lens' CreateTriggerResponse (Maybe Text) Source #
The name of the trigger.
createTriggerResponse_httpStatus :: Lens' CreateTriggerResponse Int Source #
The response's http status code.