ScheduleState class
Input properties used for looking up and filtering Schedule resources.
Constructors
-
ScheduleState({Input<
String?> ? actionAfterCompletion, Input<String?> ? arn, Input<String?> ? description, Input<String?> ? endDate, Input<ScheduleFlexibleTimeWindow?> ? flexibleTimeWindow, Input<String?> ? groupName, Input<String?> ? kmsKeyArn, Input<String?> ? name, Input<String?> ? namePrefix, Input<String?> ? region, Input<String?> ? scheduleExpression, Input<String?> ? scheduleExpressionTimezone, Input<String?> ? startDate, Input<String?> ? state, Input<ScheduleTarget?> ? target}) -
Creates a new ScheduleState.
actionAfterCompletionAction that applies to the schedule after completing invocation of the target. Valid values areNONEandDELETE. Defaults toNONE.arnARN of the schedule.descriptionBrief description of the schedule.endDateThe 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 end date you specify. EventBridge Scheduler ignores the end date for one-time schedules. Example:2030-01-01T01:00:00Z.flexibleTimeWindowConfigures a time window during which EventBridge Scheduler invokes the schedule. Detailed below.groupNameName of the schedule group to associate with this schedule. When omitted, thedefaultschedule group is used.kmsKeyArnARN for the customer managed KMS key that EventBridge Scheduler will use to encrypt and decrypt your data.nameName of the schedule. If omitted, the provider will assign a random, unique name. Conflicts withnamePrefix.namePrefixCreates a unique name beginning with the specified prefix. Conflicts withname.regionRegion where this resource will be managed. Defaults to the Region set in the provider configuration.scheduleExpressionDefines when the schedule runs. Read more in Schedule types on EventBridge Scheduler.scheduleExpressionTimezoneTimezone in which the scheduling expression is evaluated. Defaults toUTC. Example:Australia/Sydney.startDateThe 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 start date you specify. EventBridge Scheduler ignores the start date for one-time schedules. Example:2030-01-01T01:00:00Z.stateSpecifies whether the schedule is enabled or disabled. One of:ENABLED(default),DISABLED.targetConfigures the target of the schedule. Detailed below.const -
ScheduleState.fromMap(Map<
String, dynamic> map) -
factory
Properties
-
actionAfterCompletion
→ Input<
String?> ? -
Action that applies to the schedule after completing invocation of the target. Valid values are
NONEandDELETE. Defaults toNONE.final -
arn
→ Input<
String?> ? -
ARN of the schedule.
final
-
description
→ Input<
String?> ? -
Brief description of the schedule.
final
-
endDate
→ Input<
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 end date you specify. EventBridge Scheduler ignores the end date for one-time schedules. Example:
2030-01-01T01:00:00Z.final -
flexibleTimeWindow
→ Input<
ScheduleFlexibleTimeWindow?> ? -
Configures a time window during which EventBridge Scheduler invokes the schedule. Detailed below.
final
-
groupName
→ Input<
String?> ? -
Name of the schedule group to associate with this schedule. When omitted, the
defaultschedule group is used.final - hashCode → int
-
The hash code for this object.
no setterinherited
-
kmsKeyArn
→ Input<
String?> ? -
ARN for the customer managed KMS key that EventBridge Scheduler will use to encrypt and decrypt your data.
final
-
name
→ Input<
String?> ? -
Name of the schedule. If omitted, the provider will assign a random, unique name. Conflicts with
namePrefix.final -
namePrefix
→ Input<
String?> ? -
Creates a unique name beginning with the specified prefix. Conflicts with
name.final -
region
→ Input<
String?> ? -
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
scheduleExpression
→ Input<
String?> ? -
Defines when the schedule runs. Read more in Schedule types on EventBridge Scheduler.
final
-
scheduleExpressionTimezone
→ Input<
String?> ? -
Timezone in which the scheduling expression is evaluated. Defaults to
UTC. Example:Australia/Sydney.final -
startDate
→ Input<
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 start date you specify. EventBridge Scheduler ignores the start date for one-time schedules. Example:
2030-01-01T01:00:00Z.final -
state
→ Input<
String?> ? -
Specifies whether the schedule is enabled or disabled. One of:
ENABLED(default),DISABLED.final -
target
→ Input<
ScheduleTarget?> ? -
Configures the target of the schedule. Detailed below.
final
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toMap(
) → Map< String, dynamic> -
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited