@lbrlabs/pulumi-scaleway
Version:
A Pulumi package for creating and managing scaleway cloud resources.
135 lines (134 loc) • 4.6 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "./types/input";
import * as outputs from "./types/output";
/**
* Creates and manages Scaleway Messaging and queuing SQS Credentials.
* For further information please check
* our [documentation](https://www.scaleway.com/en/docs/serverless/messaging/reference-content/sqs-overview/)
*
* ## Examples
*
* ### Basic
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as scaleway from "@lbrlabs/pulumi-scaleway";
*
* const mainMnqSqs = new scaleway.MnqSqs("mainMnqSqs", {});
* const mainMnqSqsCredentials = new scaleway.MnqSqsCredentials("mainMnqSqsCredentials", {
* projectId: mainMnqSqs.projectId,
* permissions: {
* canManage: false,
* canReceive: true,
* canPublish: false,
* },
* });
* ```
*
* ## Import
*
* SQS credentials can be imported using the `{region}/{id}`, e.g. bash
*
* ```sh
* $ pulumi import scaleway:index/mnqSqsCredentials:MnqSqsCredentials main fr-par/11111111111111111111111111111111
* ```
*/
export declare class MnqSqsCredentials extends pulumi.CustomResource {
/**
* Get an existing MnqSqsCredentials 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?: MnqSqsCredentialsState, opts?: pulumi.CustomResourceOptions): MnqSqsCredentials;
/**
* Returns true if the given object is an instance of MnqSqsCredentials. 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 MnqSqsCredentials;
/**
* The ID of the key.
*/
readonly accessKey: pulumi.Output<string>;
/**
* The unique name of the sqs credentials.
*/
readonly name: pulumi.Output<string>;
/**
* . List of permissions associated to these credentials. Only one of permissions may be set.
*/
readonly permissions: pulumi.Output<outputs.MnqSqsCredentialsPermissions>;
/**
* `projectId`) The ID of the project the sqs is enabled for.
*/
readonly projectId: pulumi.Output<string>;
/**
* `region`). The region in which sqs is enabled.
*/
readonly region: pulumi.Output<string>;
/**
* The secret value of the key.
*/
readonly secretKey: pulumi.Output<string>;
/**
* Create a MnqSqsCredentials 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?: MnqSqsCredentialsArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering MnqSqsCredentials resources.
*/
export interface MnqSqsCredentialsState {
/**
* The ID of the key.
*/
accessKey?: pulumi.Input<string>;
/**
* The unique name of the sqs credentials.
*/
name?: pulumi.Input<string>;
/**
* . List of permissions associated to these credentials. Only one of permissions may be set.
*/
permissions?: pulumi.Input<inputs.MnqSqsCredentialsPermissions>;
/**
* `projectId`) The ID of the project the sqs is enabled for.
*/
projectId?: pulumi.Input<string>;
/**
* `region`). The region in which sqs is enabled.
*/
region?: pulumi.Input<string>;
/**
* The secret value of the key.
*/
secretKey?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a MnqSqsCredentials resource.
*/
export interface MnqSqsCredentialsArgs {
/**
* The unique name of the sqs credentials.
*/
name?: pulumi.Input<string>;
/**
* . List of permissions associated to these credentials. Only one of permissions may be set.
*/
permissions?: pulumi.Input<inputs.MnqSqsCredentialsPermissions>;
/**
* `projectId`) The ID of the project the sqs is enabled for.
*/
projectId?: pulumi.Input<string>;
/**
* `region`). The region in which sqs is enabled.
*/
region?: pulumi.Input<string>;
}