@pulumiverse/scaleway
Version:
A Pulumi package for creating and managing Scaleway cloud resources.
241 lines • 8.85 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "./types/input";
import * as outputs from "./types/output";
/**
* The `scaleway.containers.Trigger` resource allows you to create and manage triggers for Scaleway [Serverless Containers](https://www.scaleway.com/en/docs/serverless/containers/).
*
* Refer to the Containers 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
*
* ### SQS
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as scaleway from "@pulumiverse/scaleway";
*
* const main = new scaleway.containers.Trigger("main", {
* containerId: mainScalewayContainer.id,
* name: "my-sqs-trigger",
* destinationConfig: {
* httpPath: "/",
* httpMethod: "get",
* },
* sqs: {
* endpoint: mainScalewayMnqSqsQueue.sqsEndpoint,
* queueUrl: mainScalewayMnqSqsQueue.url,
* accessKey: mainScalewayMnqSqsCredentials.accessKey,
* secretKey: mainScalewayMnqSqsCredentials.secretKey,
* region: mainScalewayMnqSqs.region,
* },
* });
* ```
*
* ### NATS
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as scaleway from "@pulumiverse/scaleway";
*
* const main = new scaleway.containers.Trigger("main", {
* containerId: mainScalewayContainer.id,
* name: "my-nats-trigger",
* destinationConfig: {
* httpPath: "/ping",
* httpMethod: "get",
* },
* nats: {
* subject: "TestSubject",
* serverUrls: [mainScalewayMnqNatsAccount.endpoint],
* credentialsFileContent: mainScalewayMnqNatsCredentials.file,
* region: mainScalewayMnqNatsAccount.region,
* },
* });
* ```
*
* ### Cron
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as scaleway from "@pulumiverse/scaleway";
*
* const main = new scaleway.containers.Trigger("main", {
* containerId: mainScalewayContainer.id,
* name: "my-cron-trigger",
* destinationConfig: {
* httpPath: "/patch/here",
* httpMethod: "patch",
* },
* cron: {
* schedule: "5 4 1 * *",
* timezone: "Europe/Paris",
* body: "{\"message\": \"This is the content to send to the container.\"}",
* headers: {
* "Content-Length": "45",
* "Content-Type": "application/json",
* },
* },
* });
* ```
*
* ## Import
*
* Container Triggers can be imported using `{region}/{id}`, as shown below:
*
* ```sh
* $ pulumi import scaleway:index/containerTrigger:ContainerTrigger main fr-par/11111111-1111-1111-1111-111111111111
* ```
*
* @deprecated scaleway.index/containertrigger.ContainerTrigger has been deprecated in favor of scaleway.containers/trigger.Trigger
*/
export declare class ContainerTrigger extends pulumi.CustomResource {
/**
* Get an existing ContainerTrigger 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?: ContainerTriggerState, opts?: pulumi.CustomResourceOptions): ContainerTrigger;
/**
* Returns true if the given object is an instance of ContainerTrigger. 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 ContainerTrigger;
/**
* The unique identifier of the container to create a trigger for.
*
* > **Important:** Updates to this field will recreate the resource.
*/
readonly containerId: pulumi.Output<string>;
/**
* The configuration for the cron source of the trigger
*/
readonly cron: pulumi.Output<outputs.ContainerTriggerCron | undefined>;
/**
* The description of the trigger.
*/
readonly description: pulumi.Output<string | undefined>;
/**
* The configuration of the destination to trigger.
*/
readonly destinationConfig: pulumi.Output<outputs.ContainerTriggerDestinationConfig>;
/**
* The unique name of the trigger. If not provided, a random name is generated.
*/
readonly name: pulumi.Output<string>;
/**
* The configuration for the Scaleway NATS account used by the trigger
*/
readonly nats: pulumi.Output<outputs.ContainerTriggerNats | undefined>;
/**
* `region`). The region in which the namespace is created.
*/
readonly region: pulumi.Output<string | undefined>;
/**
* The configuration of the Scaleway SQS queue used by the trigger
*/
readonly sqs: pulumi.Output<outputs.ContainerTriggerSqs | undefined>;
/**
* The list of tags associated with the trigger.
*/
readonly tags: pulumi.Output<string[] | undefined>;
/**
* Create a ContainerTrigger 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/containertrigger.ContainerTrigger has been deprecated in favor of scaleway.containers/trigger.Trigger */
constructor(name: string, args: ContainerTriggerArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering ContainerTrigger resources.
*/
export interface ContainerTriggerState {
/**
* The unique identifier of the container to create a trigger for.
*
* > **Important:** Updates to this field will recreate the resource.
*/
containerId?: pulumi.Input<string | undefined>;
/**
* The configuration for the cron source of the trigger
*/
cron?: pulumi.Input<inputs.ContainerTriggerCron | undefined>;
/**
* The description of the trigger.
*/
description?: pulumi.Input<string | undefined>;
/**
* The configuration of the destination to trigger.
*/
destinationConfig?: pulumi.Input<inputs.ContainerTriggerDestinationConfig | undefined>;
/**
* The unique name of the trigger. If not provided, a random name is generated.
*/
name?: pulumi.Input<string | undefined>;
/**
* The configuration for the Scaleway NATS account used by the trigger
*/
nats?: pulumi.Input<inputs.ContainerTriggerNats | undefined>;
/**
* `region`). The region in which the namespace is created.
*/
region?: pulumi.Input<string | undefined>;
/**
* The configuration of the Scaleway SQS queue used by the trigger
*/
sqs?: pulumi.Input<inputs.ContainerTriggerSqs | undefined>;
/**
* The list of tags associated with the trigger.
*/
tags?: pulumi.Input<pulumi.Input<string>[] | undefined>;
}
/**
* The set of arguments for constructing a ContainerTrigger resource.
*/
export interface ContainerTriggerArgs {
/**
* The unique identifier of the container to create a trigger for.
*
* > **Important:** Updates to this field will recreate the resource.
*/
containerId: pulumi.Input<string>;
/**
* The configuration for the cron source of the trigger
*/
cron?: pulumi.Input<inputs.ContainerTriggerCron | undefined>;
/**
* The description of the trigger.
*/
description?: pulumi.Input<string | undefined>;
/**
* The configuration of the destination to trigger.
*/
destinationConfig: pulumi.Input<inputs.ContainerTriggerDestinationConfig>;
/**
* The unique name of the trigger. If not provided, a random name is generated.
*/
name?: pulumi.Input<string | undefined>;
/**
* The configuration for the Scaleway NATS account used by the trigger
*/
nats?: pulumi.Input<inputs.ContainerTriggerNats | undefined>;
/**
* `region`). The region in which the namespace is created.
*/
region?: pulumi.Input<string | undefined>;
/**
* The configuration of the Scaleway SQS queue used by the trigger
*/
sqs?: pulumi.Input<inputs.ContainerTriggerSqs | undefined>;
/**
* The list of tags associated with the trigger.
*/
tags?: pulumi.Input<pulumi.Input<string>[] | undefined>;
}
//# sourceMappingURL=containerTrigger.d.ts.map