@pulumi/aws-native/scheduler/schedule.d.ts

The Pulumi AWS Cloud Control Provider enables you to build, deploy, and manage [any AWS resource that's supported by the AWS Cloud Control API](https://github.com/pulumi/pulumi-aws-native/blob/master/provider/cmd/pulumi-gen-aws-native/supported-types.txt)

import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
import * as enums from "../types/enums";
/**
 * Definition of AWS::Scheduler::Schedule Resource Type
 */
export declare class Schedule extends pulumi.CustomResource {
    /**
     * Get an existing Schedule resource's state with the given name, ID, and optional extra
     * properties used to qualify the lookup.
     *
     * @param name The _unique_ name of the resulting resource.
     * @param id The _unique_ provider ID of the resource to lookup.
     * @param opts Optional settings to control the behavior of the CustomResource.
     */
    static get(name: string, id: pulumi.Input<pulumi.ID>, opts?: pulumi.CustomResourceOptions): Schedule;
    /**
     * Returns true if the given object is an instance of Schedule.  This is designed to work even
     * when multiple copies of the Pulumi SDK have been loaded into the same process.
     */
    static isInstance(obj: any): obj is Schedule;
    /**
     * The Amazon Resource Name (ARN) of the schedule.
     */
    readonly arn: pulumi.Output<string>;
    /**
     * The description of the schedule.
     */
    readonly description: pulumi.Output<string | undefined>;
    /**
     * 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.
     */
    readonly endDate: pulumi.Output<string | undefined>;
    /**
     * Allows you to configure a time window during which EventBridge Scheduler invokes the schedule.
     */
    readonly flexibleTimeWindow: pulumi.Output<outputs.scheduler.ScheduleFlexibleTimeWindow>;
    /**
     * The name of the schedule group to associate with this schedule. If you omit this, the default schedule group is used.
     */
    readonly groupName: pulumi.Output<string | undefined>;
    /**
     * The ARN for a KMS Key that will be used to encrypt customer data.
     */
    readonly kmsKeyArn: pulumi.Output<string | undefined>;
    /**
     * The name of the schedule.
     */
    readonly name: pulumi.Output<string | undefined>;
    /**
     * The scheduling expression.
     */
    readonly scheduleExpression: pulumi.Output<string>;
    /**
     * The timezone in which the scheduling expression is evaluated.
     */
    readonly scheduleExpressionTimezone: pulumi.Output<string | undefined>;
    /**
     * 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.
     */
    readonly startDate: pulumi.Output<string | undefined>;
    /**
     * Specifies whether the schedule is enabled or disabled.
     *
     * *Allowed Values* : `ENABLED` | `DISABLED`
     */
    readonly state: pulumi.Output<enums.scheduler.ScheduleState | undefined>;
    /**
     * The schedule's target details.
     */
    readonly target: pulumi.Output<outputs.scheduler.ScheduleTarget>;
    /**
     * Create a Schedule resource with the given unique name, arguments, and options.
     *
     * @param name The _unique_ name of the resource.
     * @param args The arguments to use to populate this resource's properties.
     * @param opts A bag of options that control this resource's behavior.
     */
    constructor(name: string, args: ScheduleArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * The set of arguments for constructing a Schedule resource.
 */
export interface ScheduleArgs {
    /**
     * The description of the schedule.
     */
    description?: pulumi.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 EndDate you specify.
     */
    endDate?: pulumi.Input<string>;
    /**
     * Allows you to configure a time window during which EventBridge Scheduler invokes the schedule.
     */
    flexibleTimeWindow: pulumi.Input<inputs.scheduler.ScheduleFlexibleTimeWindowArgs>;
    /**
     * The name of the schedule group to associate with this schedule. If you omit this, the default schedule group is used.
     */
    groupName?: pulumi.Input<string>;
    /**
     * The ARN for a KMS Key that will be used to encrypt customer data.
     */
    kmsKeyArn?: pulumi.Input<string>;
    /**
     * The name of the schedule.
     */
    name?: pulumi.Input<string>;
    /**
     * The scheduling expression.
     */
    scheduleExpression: pulumi.Input<string>;
    /**
     * The timezone in which the scheduling expression is evaluated.
     */
    scheduleExpressionTimezone?: pulumi.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 StartDate you specify.
     */
    startDate?: pulumi.Input<string>;
    /**
     * Specifies whether the schedule is enabled or disabled.
     *
     * *Allowed Values* : `ENABLED` | `DISABLED`
     */
    state?: pulumi.Input<enums.scheduler.ScheduleState>;
    /**
     * The schedule's target details.
     */
    target: pulumi.Input<inputs.scheduler.ScheduleTargetArgs>;
}