@pulumiverse/scaleway/functionCron.d.ts

A Pulumi package for creating and managing Scaleway cloud resources.

import * as pulumi from "@pulumi/pulumi";
/**
 * The `scaleway.functions.Cron` resource allows you to create and manage CRON triggers for Scaleway [Serverless Functions](https://www.scaleway.com/en/docs/serverless/functions/).
 *
 * Refer to the Functions CRON triggers [documentation](https://www.scaleway.com/en/docs/serverless/functions/how-to/add-trigger-to-a-function/) and [API documentation](https://www.scaleway.com/en/developers/api/serverless-functions/#path-triggers-list-all-triggers) for more information.
 *
 * ## Example Usage
 *
 * The following command allows you to add a CRON trigger to a Serverless Function.
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as scaleway from "@pulumiverse/scaleway";
 *
 * const main = new scaleway.functions.Namespace("main", {name: "test-cron"});
 * const mainFunction = new scaleway.functions.Function("main", {
 *     name: "test-cron",
 *     namespaceId: main.id,
 *     runtime: "node14",
 *     privacy: "private",
 *     handler: "handler.handle",
 * });
 * const mainCron = new scaleway.functions.Cron("main", {
 *     name: "test-cron",
 *     functionId: mainFunction.id,
 *     schedule: "0 0 * * *",
 *     args: JSON.stringify({
 *         test: "scw",
 *     }),
 * });
 * const func = new scaleway.functions.Cron("func", {
 *     functionId: mainFunction.id,
 *     schedule: "0 1 * * *",
 *     args: JSON.stringify({
 *         my_var: "terraform",
 *     }),
 * });
 * ```
 *
 * ## Import
 *
 * Function Cron can be imported using `{region}/{id}`, as shown below:
 *
 * bash
 *
 * ```sh
 * $ pulumi import scaleway:index/functionCron:FunctionCron main fr-par/11111111-1111-1111-1111-111111111111
 * ```
 *
 * @deprecated scaleway.index/functioncron.FunctionCron has been deprecated in favor of scaleway.functions/cron.Cron
 */
export declare class FunctionCron extends pulumi.CustomResource {
    /**
     * Get an existing FunctionCron 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 state Any extra arguments used during the lookup.
     * @param opts Optional settings to control the behavior of the CustomResource.
     */
    static get(name: string, id: pulumi.Input<pulumi.ID>, state?: FunctionCronState, opts?: pulumi.CustomResourceOptions): FunctionCron;
    /**
     * Returns true if the given object is an instance of FunctionCron.  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 FunctionCron;
    /**
     * The key-value mapping to define arguments that will be passed to your function’s event object
     */
    readonly args: pulumi.Output<string>;
    /**
     * The unique identifier of the function to link to your CRON trigger.
     */
    readonly functionId: pulumi.Output<string>;
    /**
     * The name of the function CRON trigger. If not provided, a random name is generated.
     */
    readonly name: pulumi.Output<string>;
    /**
     * `region`) The region
     * in which the function was created.
     */
    readonly region: pulumi.Output<string>;
    /**
     * CRON format string (refer to the [CRON schedule reference](https://www.scaleway.com/en/docs/serverless/functions/reference-content/cron-schedules/) for more information).
     */
    readonly schedule: pulumi.Output<string>;
    /**
     * The CRON status.
     */
    readonly status: pulumi.Output<string>;
    /**
     * Create a FunctionCron 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.
     */
    /** @deprecated scaleway.index/functioncron.FunctionCron has been deprecated in favor of scaleway.functions/cron.Cron */
    constructor(name: string, args: FunctionCronArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering FunctionCron resources.
 */
export interface FunctionCronState {
    /**
     * The key-value mapping to define arguments that will be passed to your function’s event object
     */
    args?: pulumi.Input<string>;
    /**
     * The unique identifier of the function to link to your CRON trigger.
     */
    functionId?: pulumi.Input<string>;
    /**
     * The name of the function CRON trigger. If not provided, a random name is generated.
     */
    name?: pulumi.Input<string>;
    /**
     * `region`) The region
     * in which the function was created.
     */
    region?: pulumi.Input<string>;
    /**
     * CRON format string (refer to the [CRON schedule reference](https://www.scaleway.com/en/docs/serverless/functions/reference-content/cron-schedules/) for more information).
     */
    schedule?: pulumi.Input<string>;
    /**
     * The CRON status.
     */
    status?: pulumi.Input<string>;
}
/**
 * The set of arguments for constructing a FunctionCron resource.
 */
export interface FunctionCronArgs {
    /**
     * The key-value mapping to define arguments that will be passed to your function’s event object
     */
    args: pulumi.Input<string>;
    /**
     * The unique identifier of the function to link to your CRON trigger.
     */
    functionId: pulumi.Input<string>;
    /**
     * The name of the function CRON trigger. If not provided, a random name is generated.
     */
    name?: pulumi.Input<string>;
    /**
     * `region`) The region
     * in which the function was created.
     */
    region?: pulumi.Input<string>;
    /**
     * CRON format string (refer to the [CRON schedule reference](https://www.scaleway.com/en/docs/serverless/functions/reference-content/cron-schedules/) for more information).
     */
    schedule: pulumi.Input<string>;
}