Package com.pulumi.aws.scheduler

Class ScheduleArgs

  • public final class ScheduleArgs
extends com.pulumi.resources.ResourceArgs

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  ScheduleArgs.Builder  

      • Nested classes/interfaces inherited from class com.pulumi.resources.InputArgs

        com.pulumi.resources.InputArgs.InputArgsInternal

    • Method Detail

      • actionAfterCompletion

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> actionAfterCompletion()
        Returns:
        Action that applies to the schedule after completing invocation of the target. Valid values are `NONE` and `DELETE`. Defaults to `NONE`.

      • description

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> description()
        Returns:
        Brief description of the schedule.

      • endDate

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> endDate()
        Returns:
        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`.

      • flexibleTimeWindow

        public com.pulumi.core.Output<ScheduleFlexibleTimeWindowArgs> flexibleTimeWindow()
        Returns:
        Configures a time window during which EventBridge Scheduler invokes the schedule. Detailed below.

      • groupName

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> groupName()
        Returns:
        Name of the schedule group to associate with this schedule. When omitted, the `default` schedule group is used.

      • kmsKeyArn

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> kmsKeyArn()
        Returns:
        ARN for the customer managed KMS key that EventBridge Scheduler will use to encrypt and decrypt your data.

      • name

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> name()
        Returns:
        Name of the schedule. If omitted, the provider will assign a random, unique name. Conflicts with `namePrefix`.

      • namePrefix

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> namePrefix()
        Returns:
        Creates a unique name beginning with the specified prefix. Conflicts with `name`.

      • region

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> region()
        Returns:
        Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.

      • scheduleExpression

        public com.pulumi.core.Output<java.lang.String> scheduleExpression()
        Returns:
        Defines when the schedule runs. Read more in [Schedule types on EventBridge Scheduler](https://docs.aws.amazon.com/scheduler/latest/UserGuide/schedule-types.html).

      • scheduleExpressionTimezone

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> scheduleExpressionTimezone()
        Returns:
        Timezone in which the scheduling expression is evaluated. Defaults to `UTC`. Example: `Australia/Sydney`.

      • startDate

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> startDate()
        Returns:
        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`.

      • state

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> state()
        Returns:
        Specifies whether the schedule is enabled or disabled. One of: `ENABLED` (default), `DISABLED`.

      • target

        public com.pulumi.core.Output<ScheduleTargetArgs> target()
        Returns:
        Configures the target of the schedule. Detailed below. The following arguments are optional: