@pulumiverse/scaleway
Version:
A Pulumi package for creating and managing Scaleway cloud resources.
188 lines • 8.17 kB
JavaScript
;
// *** WARNING: this file was generated by pulumi-language-nodejs. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
var desc = Object.getOwnPropertyDescriptor(m, k);
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
desc = { enumerable: true, get: function() { return m[k]; } };
}
Object.defineProperty(o, k2, desc);
}) : (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
o[k2] = m[k];
}));
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
Object.defineProperty(o, "default", { enumerable: true, value: v });
}) : function(o, v) {
o["default"] = v;
});
var __importStar = (this && this.__importStar) || function (mod) {
if (mod && mod.__esModule) return mod;
var result = {};
if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
__setModuleDefault(result, mod);
return result;
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.SqsQueue = void 0;
const pulumi = __importStar(require("@pulumi/pulumi"));
const utilities = __importStar(require("../utilities"));
/**
* Creates and manages Scaleway Messaging and Queuing SQS queues.
* For further information, see
* our [main documentation](https://www.scaleway.com/en/docs/messaging/how-to/create-manage-queues/).
*
* ## Example Usage
*
* ### Basic
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as scaleway from "@pulumiverse/scaleway";
*
* const main = new scaleway.mnq.Sqs("main", {});
* const mainSqsCredentials = new scaleway.mnq.SqsCredentials("main", {
* projectId: main.projectId,
* name: "sqs-credentials",
* permissions: {
* canManage: true,
* canReceive: false,
* canPublish: false,
* },
* });
* const mainSqsQueue = new scaleway.mnq.SqsQueue("main", {
* projectId: main.projectId,
* name: "my-queue",
* sqsEndpoint: main.endpoint,
* accessKey: mainSqsCredentials.accessKey,
* secretKey: mainSqsCredentials.secretKey,
* });
* ```
*
* ### With Dead Letter Queue
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as scaleway from "@pulumiverse/scaleway";
*
* const main = new scaleway.mnq.Sqs("main", {});
* const mainSqsCredentials = new scaleway.mnq.SqsCredentials("main", {
* projectId: main.projectId,
* name: "sqs-credentials",
* permissions: {
* canManage: true,
* canReceive: false,
* canPublish: false,
* },
* });
* const deadLetter = new scaleway.mnq.SqsQueue("dead_letter", {
* projectId: main.projectId,
* name: "dead-letter-queue",
* sqsEndpoint: main.endpoint,
* accessKey: mainSqsCredentials.accessKey,
* secretKey: mainSqsCredentials.secretKey,
* });
* const mainSqsQueue = new scaleway.mnq.SqsQueue("main", {
* projectId: main.projectId,
* name: "my-queue",
* sqsEndpoint: main.endpoint,
* accessKey: mainSqsCredentials.accessKey,
* secretKey: mainSqsCredentials.secretKey,
* deadLetterQueue: {
* id: deadLetter.id,
* maxReceiveCount: 3,
* },
* });
* ```
*
* ## Dead Letter Queue
*
* The `deadLetterQueue` block supports the following:
*
* - `id` - (Required) The ID of the dead letter queue. Can be either in the format `{region}/{project-id}/{queue-name}` or `arn:scw:sqs:{region}:project-{project-id}:{queue-name}`.
*
* - `maxReceiveCount` - (Required) The number of times a message is delivered to the source queue before being moved to the dead letter queue. Must be between 1 and 1000.
*/
class SqsQueue extends pulumi.CustomResource {
/**
* Get an existing SqsQueue 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, id, state, opts) {
return new SqsQueue(name, state, { ...opts, id: id });
}
/** @internal */
static __pulumiType = 'scaleway:mnq/sqsQueue:SqsQueue';
/**
* Returns true if the given object is an instance of SqsQueue. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj) {
if (obj === undefined || obj === null) {
return false;
}
return obj['__pulumiType'] === SqsQueue.__pulumiType;
}
constructor(name, argsOrState, opts) {
let resourceInputs = {};
opts = opts || {};
if (opts.id) {
const state = argsOrState;
resourceInputs["accessKey"] = state?.accessKey;
resourceInputs["arn"] = state?.arn;
resourceInputs["contentBasedDeduplication"] = state?.contentBasedDeduplication;
resourceInputs["deadLetterQueue"] = state?.deadLetterQueue;
resourceInputs["fifoQueue"] = state?.fifoQueue;
resourceInputs["messageMaxAge"] = state?.messageMaxAge;
resourceInputs["messageMaxSize"] = state?.messageMaxSize;
resourceInputs["name"] = state?.name;
resourceInputs["namePrefix"] = state?.namePrefix;
resourceInputs["projectId"] = state?.projectId;
resourceInputs["receiveWaitTimeSeconds"] = state?.receiveWaitTimeSeconds;
resourceInputs["region"] = state?.region;
resourceInputs["secretKey"] = state?.secretKey;
resourceInputs["sqsEndpoint"] = state?.sqsEndpoint;
resourceInputs["url"] = state?.url;
resourceInputs["visibilityTimeoutSeconds"] = state?.visibilityTimeoutSeconds;
}
else {
const args = argsOrState;
if (args?.accessKey === undefined && !opts.urn) {
throw new Error("Missing required property 'accessKey'");
}
if (args?.secretKey === undefined && !opts.urn) {
throw new Error("Missing required property 'secretKey'");
}
resourceInputs["accessKey"] = args?.accessKey ? pulumi.secret(args.accessKey) : undefined;
resourceInputs["contentBasedDeduplication"] = args?.contentBasedDeduplication;
resourceInputs["deadLetterQueue"] = args?.deadLetterQueue;
resourceInputs["fifoQueue"] = args?.fifoQueue;
resourceInputs["messageMaxAge"] = args?.messageMaxAge;
resourceInputs["messageMaxSize"] = args?.messageMaxSize;
resourceInputs["name"] = args?.name;
resourceInputs["namePrefix"] = args?.namePrefix;
resourceInputs["projectId"] = args?.projectId;
resourceInputs["receiveWaitTimeSeconds"] = args?.receiveWaitTimeSeconds;
resourceInputs["region"] = args?.region;
resourceInputs["secretKey"] = args?.secretKey ? pulumi.secret(args.secretKey) : undefined;
resourceInputs["sqsEndpoint"] = args?.sqsEndpoint;
resourceInputs["visibilityTimeoutSeconds"] = args?.visibilityTimeoutSeconds;
resourceInputs["arn"] = undefined /*out*/;
resourceInputs["url"] = undefined /*out*/;
}
opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts);
const aliasOpts = { aliases: [{ type: "scaleway:index/mnqSqsQueue:MnqSqsQueue" }] };
opts = pulumi.mergeOptions(opts, aliasOpts);
const secretOpts = { additionalSecretOutputs: ["accessKey", "secretKey"] };
opts = pulumi.mergeOptions(opts, secretOpts);
super(SqsQueue.__pulumiType, name, resourceInputs, opts);
}
}
exports.SqsQueue = SqsQueue;
//# sourceMappingURL=sqsQueue.js.map