@pulumiverse/scaleway
Version:
A Pulumi package for creating and managing Scaleway cloud resources.
138 lines (137 loc) • 4.44 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 SNS credentials.
* For further information, see
* our [main documentation](https://www.scaleway.com/en/docs/messaging/reference-content/sns-overview/)
*
* ## Example Usage
*
* ### Basic
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as scaleway from "@pulumiverse/scaleway";
*
* const main = new scaleway.mnq.Sns("main", {});
* const mainSnsCredentials = new scaleway.mnq.SnsCredentials("main", {
* projectId: main.projectId,
* name: "sns-credentials",
* permissions: {
* canManage: false,
* canReceive: true,
* canPublish: false,
* },
* });
* ```
*
* ## Import
*
* SNS credentials can be imported using `{region}/{id}`, e.g.
*
* bash
*
* ```sh
* $ pulumi import scaleway:mnq/snsCredentials:SnsCredentials main fr-par/11111111111111111111111111111111
* ```
*/
export declare class SnsCredentials extends pulumi.CustomResource {
/**
* Get an existing SnsCredentials 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?: SnsCredentialsState, opts?: pulumi.CustomResourceOptions): SnsCredentials;
/**
* Returns true if the given object is an instance of SnsCredentials. 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 SnsCredentials;
/**
* The ID of the key.
*/
readonly accessKey: pulumi.Output<string>;
/**
* The unique name of the SNS credentials.
*/
readonly name: pulumi.Output<string>;
/**
* . List of permissions associated with these credentials.
*/
readonly permissions: pulumi.Output<outputs.mnq.SnsCredentialsPermissions>;
/**
* `projectId`) The ID of the Project in which SNS is enabled.
*/
readonly projectId: pulumi.Output<string>;
/**
* `region`). The region in which SNS is enabled.
*/
readonly region: pulumi.Output<string>;
/**
* The secret value of the key.
*/
readonly secretKey: pulumi.Output<string>;
/**
* Create a SnsCredentials 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?: SnsCredentialsArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering SnsCredentials resources.
*/
export interface SnsCredentialsState {
/**
* The ID of the key.
*/
accessKey?: pulumi.Input<string>;
/**
* The unique name of the SNS credentials.
*/
name?: pulumi.Input<string>;
/**
* . List of permissions associated with these credentials.
*/
permissions?: pulumi.Input<inputs.mnq.SnsCredentialsPermissions>;
/**
* `projectId`) The ID of the Project in which SNS is enabled.
*/
projectId?: pulumi.Input<string>;
/**
* `region`). The region in which SNS is enabled.
*/
region?: pulumi.Input<string>;
/**
* The secret value of the key.
*/
secretKey?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a SnsCredentials resource.
*/
export interface SnsCredentialsArgs {
/**
* The unique name of the SNS credentials.
*/
name?: pulumi.Input<string>;
/**
* . List of permissions associated with these credentials.
*/
permissions?: pulumi.Input<inputs.mnq.SnsCredentialsPermissions>;
/**
* `projectId`) The ID of the Project in which SNS is enabled.
*/
projectId?: pulumi.Input<string>;
/**
* `region`). The region in which SNS is enabled.
*/
region?: pulumi.Input<string>;
}