CfnTriggerProps¶
-
class
aws_cdk.aws_glue.
CfnTriggerProps
(*, actions, type, description=None, name=None, predicate=None, schedule=None, start_on_creation=None, tags=None, workflow_name=None)¶ Bases:
object
Properties for defining a
CfnTrigger
.- Parameters
actions (
Union
[IResolvable
,Sequence
[Union
[IResolvable
,ActionProperty
,Dict
[str
,Any
]]]]) – The actions initiated by this trigger.type (
str
) – The type of trigger that this is.description (
Optional
[str
]) – A description of this trigger.name (
Optional
[str
]) – The name of the trigger.predicate (
Union
[IResolvable
,PredicateProperty
,Dict
[str
,Any
],None
]) – The predicate of this trigger, which defines when it will fire.schedule (
Optional
[str
]) – Acron
expression used to specify the schedule. For more information, see Time-Based Schedules for Jobs and Crawlers in the AWS Glue Developer Guide . For example, to run something every day at 12:15 UTC, specifycron(15 12 * * ? *)
.start_on_creation (
Union
[bool
,IResolvable
,None
]) – Set to true to startSCHEDULED
andCONDITIONAL
triggers when created. True is not supported forON_DEMAND
triggers.tags (
Optional
[Any
]) – The tags to use with this trigger.workflow_name (
Optional
[str
]) – The name of the workflow associated with the trigger.
- Link
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-trigger.html
- ExampleMetadata
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_glue as glue # arguments_: Any # tags: Any cfn_trigger_props = glue.CfnTriggerProps( actions=[glue.CfnTrigger.ActionProperty( arguments=arguments_, crawler_name="crawlerName", job_name="jobName", notification_property=glue.CfnTrigger.NotificationPropertyProperty( notify_delay_after=123 ), security_configuration="securityConfiguration", timeout=123 )], type="type", # the properties below are optional description="description", name="name", predicate=glue.CfnTrigger.PredicateProperty( conditions=[glue.CfnTrigger.ConditionProperty( crawler_name="crawlerName", crawl_state="crawlState", job_name="jobName", logical_operator="logicalOperator", state="state" )], logical="logical" ), schedule="schedule", start_on_creation=False, tags=tags, workflow_name="workflowName" )
Attributes
-
actions
¶ The actions initiated by this trigger.
- Link
- Return type
Union
[IResolvable
,List
[Union
[IResolvable
,ActionProperty
]]]
-
description
¶ A description of this trigger.
- Link
- Return type
Optional
[str
]
-
name
¶ The name of the trigger.
- Link
- Return type
Optional
[str
]
-
predicate
¶ The predicate of this trigger, which defines when it will fire.
-
schedule
¶ A
cron
expression used to specify the schedule.For more information, see Time-Based Schedules for Jobs and Crawlers in the AWS Glue Developer Guide . For example, to run something every day at 12:15 UTC, specify
cron(15 12 * * ? *)
.- Link
- Return type
Optional
[str
]
-
start_on_creation
¶ Set to true to start
SCHEDULED
andCONDITIONAL
triggers when created.True is not supported for
ON_DEMAND
triggers.- Link
- Return type
Union
[bool
,IResolvable
,None
]
The tags to use with this trigger.
-
type
¶ The type of trigger that this is.
-
workflow_name
¶ The name of the workflow associated with the trigger.
- Link
- Return type
Optional
[str
]