@pulumiverse/scaleway
Version:
A Pulumi package for creating and managing Scaleway cloud resources.
156 lines (155 loc) • 6.06 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* The `scaleway.containers.Cron` resource allows you to create and manage CRON triggers for Scaleway [Serverless Containers](https://www.scaleway.com/en/docs/serverless/containers/).
*
* Refer to the Containers CRON triggers [documentation](https://www.scaleway.com/en/docs/serverless/containers/how-to/add-trigger-to-a-container/) and [API documentation](https://www.scaleway.com/en/developers/api/serverless-containers/#path-triggers-list-all-triggers) for more information.
*
* ## Example Usage
*
* The following command allows you to add a CRON trigger to a Serverless Container.
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as scaleway from "@pulumiverse/scaleway";
*
* const main = new scaleway.containers.Namespace("main", {});
* const mainContainer = new scaleway.containers.Container("main", {
* name: "my-container-with-cron-tf",
* namespaceId: main.id,
* });
* const mainCron = new scaleway.containers.Cron("main", {
* containerId: mainContainer.id,
* name: "my-cron-name",
* 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 `{region}/{id}`, as shown below:
*
* bash
*
* ```sh
* $ pulumi import scaleway:index/containerCron:ContainerCron main fr-par/11111111-1111-1111-1111-111111111111
* ```
*
* @deprecated scaleway.index/containercron.ContainerCron has been deprecated in favor of scaleway.containers/cron.Cron
*/
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
*/
readonly args: pulumi.Output<string>;
/**
* The unique identifier of the container to link to your CRON trigger.
*/
readonly containerId: pulumi.Output<string>;
/**
* The name of the container CRON trigger. If not provided, a random name is generated.
*/
readonly name: pulumi.Output<string>;
/**
* (Defaults to provider `region`) The region
* in which the CRON trigger is created.
*/
readonly region: pulumi.Output<string>;
/**
* CRON format string (refer to the [CRON schedule reference](https://www.scaleway.com/en/docs/serverless/containers/reference-content/cron-schedules/) for more information).
*/
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.
*/
/** @deprecated scaleway.index/containercron.ContainerCron has been deprecated in favor of scaleway.containers/cron.Cron */
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
*/
args?: pulumi.Input<string>;
/**
* The unique identifier of the container to link to your CRON trigger.
*/
containerId?: pulumi.Input<string>;
/**
* The name of the container CRON trigger. If not provided, a random name is generated.
*/
name?: pulumi.Input<string>;
/**
* (Defaults to provider `region`) The region
* in which the CRON trigger is created.
*/
region?: pulumi.Input<string>;
/**
* CRON format string (refer to the [CRON schedule reference](https://www.scaleway.com/en/docs/serverless/containers/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 ContainerCron resource.
*/
export interface ContainerCronArgs {
/**
* The key-value mapping to define arguments that will be passed to your container’s event object
*/
args: pulumi.Input<string>;
/**
* The unique identifier of the container to link to your CRON trigger.
*/
containerId: pulumi.Input<string>;
/**
* The name of the container CRON trigger. If not provided, a random name is generated.
*/
name?: pulumi.Input<string>;
/**
* (Defaults to provider `region`) The region
* in which the CRON trigger is created.
*/
region?: pulumi.Input<string>;
/**
* CRON format string (refer to the [CRON schedule reference](https://www.scaleway.com/en/docs/serverless/containers/reference-content/cron-schedules/) for more information).
*/
schedule: pulumi.Input<string>;
}