UNPKG

@lbrlabs/pulumi-scaleway

Version:

A Pulumi package for creating and managing scaleway cloud resources.

141 lines (140 loc) 4.81 kB
import * as pulumi from "@pulumi/pulumi"; import * as inputs from "./types/input"; import * as outputs from "./types/output"; /** * Creates and manages Scaleway Function Triggers. * For more information see [the documentation](https://www.scaleway.com/en/developers/api/serverless-functions/#path-triggers). * * ## Examples * * ### SQS * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as scaleway from "@lbrlabs/pulumi-scaleway"; * * const main = new scaleway.FunctionTrigger("main", { * functionId: scaleway_function.main.id, * sqs: { * projectId: scaleway_mnq_sqs.main.project_id, * queue: "MyQueue", * region: scaleway_mnq_sqs.main.region, * }, * }); * ``` * * ## Import * * Function Triggers can be imported using the `{region}/{id}`, e.g. bash * * ```sh * $ pulumi import scaleway:index/functionTrigger:FunctionTrigger main fr-par/11111111-1111-1111-1111-111111111111 * ``` */ export declare class FunctionTrigger extends pulumi.CustomResource { /** * Get an existing FunctionTrigger 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?: FunctionTriggerState, opts?: pulumi.CustomResourceOptions): FunctionTrigger; /** * Returns true if the given object is an instance of FunctionTrigger. 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 FunctionTrigger; /** * The description of the trigger. */ readonly description: pulumi.Output<string | undefined>; /** * The ID of the function to create a trigger for */ readonly functionId: pulumi.Output<string>; /** * The unique name of the trigger. Default to a generated name. */ readonly name: pulumi.Output<string>; /** * The configuration for the Scaleway's Nats used by the trigger */ readonly nats: pulumi.Output<outputs.FunctionTriggerNats | undefined>; /** * `region`). The region in which the namespace should be created. */ readonly region: pulumi.Output<string>; /** * The configuration of the Scaleway's SQS used by the trigger */ readonly sqs: pulumi.Output<outputs.FunctionTriggerSqs | undefined>; /** * Create a FunctionTrigger 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: FunctionTriggerArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering FunctionTrigger resources. */ export interface FunctionTriggerState { /** * The description of the trigger. */ description?: pulumi.Input<string>; /** * The ID of the function to create a trigger for */ functionId?: pulumi.Input<string>; /** * The unique name of the trigger. Default to a generated name. */ name?: pulumi.Input<string>; /** * The configuration for the Scaleway's Nats used by the trigger */ nats?: pulumi.Input<inputs.FunctionTriggerNats>; /** * `region`). The region in which the namespace should be created. */ region?: pulumi.Input<string>; /** * The configuration of the Scaleway's SQS used by the trigger */ sqs?: pulumi.Input<inputs.FunctionTriggerSqs>; } /** * The set of arguments for constructing a FunctionTrigger resource. */ export interface FunctionTriggerArgs { /** * The description of the trigger. */ description?: pulumi.Input<string>; /** * The ID of the function to create a trigger for */ functionId: pulumi.Input<string>; /** * The unique name of the trigger. Default to a generated name. */ name?: pulumi.Input<string>; /** * The configuration for the Scaleway's Nats used by the trigger */ nats?: pulumi.Input<inputs.FunctionTriggerNats>; /** * `region`). The region in which the namespace should be created. */ region?: pulumi.Input<string>; /** * The configuration of the Scaleway's SQS used by the trigger */ sqs?: pulumi.Input<inputs.FunctionTriggerSqs>; }