@lbrlabs/pulumi-scaleway/containerCron.d.ts

A Pulumi package for creating and managing scaleway cloud resources.

import * as pulumi from "@pulumi/pulumi";
/**
 * Creates and manages Scaleway Container Triggers. For the moment, the feature is limited to CRON Schedule (time-based).
 *
 * For more information consult
 * the [documentation](https://www.scaleway.com/en/docs/serverless/containers/)
 * .
 *
 * For more details about the limitation
 * check [containers-limitations](https://www.scaleway.com/en/docs/compute/containers/reference-content/containers-limitations/)
 * .
 *
 * You can check also
 * our [containers cron api documentation](https://developers.scaleway.com/en/products/containers/api/#crons-942bf4).
 *
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as scaleway from "@lbrlabs/pulumi-scaleway";
 *
 * const mainContainerNamespace = new scaleway.ContainerNamespace("mainContainerNamespace", {});
 * const mainContainer = new scaleway.Container("mainContainer", {namespaceId: mainContainerNamespace.id});
 * const mainContainerCron = new scaleway.ContainerCron("mainContainerCron", {
 *     containerId: mainContainer.id,
 *     schedule: "5 4 1 * *",
 *     args: JSON.stringify({
 *         address: {
 *             city: "Paris",
 *             country: "FR",
 *         },
 *         age: 23,
 *         firstName: "John",
 *         isAlive: true,
 *         lastName: "Smith",
 *     }),
 * });
 * ```
 *
 * ## Import
 *
 * Container Cron can be imported using the `{region}/{id}`, e.g. bash
 *
 * ```sh
 *  $ pulumi import scaleway:index/containerCron:ContainerCron main fr-par/11111111-1111-1111-1111-111111111111
 * ```
 */
export declare class ContainerCron extends pulumi.CustomResource {
    /**
     * Get an existing ContainerCron 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?: ContainerCronState, opts?: pulumi.CustomResourceOptions): ContainerCron;
    /**
     * Returns true if the given object is an instance of ContainerCron.  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 ContainerCron;
    /**
     * The key-value mapping to define arguments that will be passed to your container’s event object
     * during
     */
    readonly args: pulumi.Output<string>;
    /**
     * The container ID to link with your cron.
     */
    readonly containerId: pulumi.Output<string>;
    /**
     * (Defaults to provider `region`) The region
     * in where the job was created.
     */
    readonly region: pulumi.Output<string>;
    /**
     * Cron format string, e.g. @hourly, as schedule time of its jobs to be created and
     * executed.
     */
    readonly schedule: pulumi.Output<string>;
    /**
     * The cron status.
     */
    readonly status: pulumi.Output<string>;
    /**
     * Create a ContainerCron 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: ContainerCronArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering ContainerCron resources.
 */
export interface ContainerCronState {
    /**
     * The key-value mapping to define arguments that will be passed to your container’s event object
     * during
     */
    args?: pulumi.Input<string>;
    /**
     * The container ID to link with your cron.
     */
    containerId?: pulumi.Input<string>;
    /**
     * (Defaults to provider `region`) The region
     * in where the job was created.
     */
    region?: pulumi.Input<string>;
    /**
     * Cron format string, e.g. @hourly, as schedule time of its jobs to be created and
     * executed.
     */
    schedule?: pulumi.Input<string>;
    /**
     * The cron status.
     */
    status?: pulumi.Input<string>;
}
/**
 * The set of arguments for constructing a ContainerCron resource.
 */
export interface ContainerCronArgs {
    /**
     * The key-value mapping to define arguments that will be passed to your container’s event object
     * during
     */
    args: pulumi.Input<string>;
    /**
     * The container ID to link with your cron.
     */
    containerId: pulumi.Input<string>;
    /**
     * (Defaults to provider `region`) The region
     * in where the job was created.
     */
    region?: pulumi.Input<string>;
    /**
     * Cron format string, e.g. @hourly, as schedule time of its jobs to be created and
     * executed.
     */
    schedule: pulumi.Input<string>;
}