schedule
Gets an individual schedule
resource
Overview
Name | schedule |
Type | Resource |
Description | schedule |
Id | awscc.scheduler.schedule |
Fields
Name | Datatype | Description |
---|---|---|
arn | string | The Amazon Resource Name (ARN) of the schedule. |
description | string | The description of the schedule. |
end_date | string | The date, in UTC, before which the schedule can invoke its target. Depending on the schedule's recurrence expression, invocations might stop on, or before, the EndDate you specify. |
flexible_time_window | object | |
group_name | string | The name of the schedule group to associate with this schedule. If you omit this, the default schedule group is used. |
kms_key_arn | string | The ARN for a KMS Key that will be used to encrypt customer data. |
name | string | |
schedule_expression | string | The scheduling expression. |
schedule_expression_timezone | string | The timezone in which the scheduling expression is evaluated. |
start_date | string | The date, in UTC, after which the schedule can begin invoking its target. Depending on the schedule's recurrence expression, invocations might occur on, or after, the StartDate you specify. |
state | string | |
target | object | |
region | string | AWS region. |
Methods
Currently only SELECT
is supported for this resource resource.
Example
SELECT
region,
arn,
description,
end_date,
flexible_time_window,
group_name,
kms_key_arn,
name,
schedule_expression,
schedule_expression_timezone,
start_date,
state,
target
FROM awscc.scheduler.schedule
WHERE data__Identifier = '<Name>';
Permissions
To operate on the schedule
resource, the following permissions are required:
Read
scheduler:GetSchedule
Update
scheduler:UpdateSchedule,
scheduler:GetSchedule,
iam:PassRole
Delete
scheduler:DeleteSchedule,
scheduler:GetSchedule