Schedule¶
-
class
aws_cdk.aws_events.
Schedule
¶ Bases:
object
Schedule for scheduled event rules.
- ExampleMetadata
infused
Example:
connection = events.Connection(self, "Connection", authorization=events.Authorization.api_key("x-api-key", SecretValue.secrets_manager("ApiSecretName")), description="Connection with API Key x-api-key" ) destination = events.ApiDestination(self, "Destination", connection=connection, endpoint="https://example.com", description="Calling example.com with API key x-api-key" ) rule = events.Rule(self, "Rule", schedule=events.Schedule.rate(cdk.Duration.minutes(1)), targets=[targets.ApiDestination(destination)] )
Attributes
-
expression_string
¶ Retrieve the expression for this schedule.
- Return type
str
Static Methods
-
classmethod
cron
(*, day=None, hour=None, minute=None, month=None, week_day=None, year=None)¶ Create a schedule from a set of cron fields.
- Parameters
day (
Optional
[str
]) – The day of the month to run this rule at. Default: - Every day of the monthhour (
Optional
[str
]) – The hour to run this rule at. Default: - Every hourminute (
Optional
[str
]) – The minute to run this rule at. Default: - Every minutemonth (
Optional
[str
]) – The month to run this rule at. Default: - Every monthweek_day (
Optional
[str
]) – The day of the week to run this rule at. Default: - Any day of the weekyear (
Optional
[str
]) – The year to run this rule at. Default: - Every year
- Return type
-
classmethod
expression
(expression)¶ Construct a schedule from a literal schedule expression.
- Parameters
expression (
str
) – The expression to use. Must be in a format that EventBridge will recognize- Return type