@pulumiverse/scaleway
Version:
A Pulumi package for creating and managing Scaleway cloud resources.
205 lines (204 loc) • 6.99 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Manage Scaleway Messaging and queuing SNS topics.
* For further information, see
* our [main documentation](https://www.scaleway.com/en/docs/messaging/how-to/create-manage-topics/).
*
* ## 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,
* permissions: {
* canManage: true,
* },
* });
* const topic = new scaleway.mnq.SnsTopic("topic", {
* projectId: main.projectId,
* name: "my-topic",
* accessKey: mainSnsCredentials.accessKey,
* secretKey: mainSnsCredentials.secretKey,
* });
* ```
*
* ## Import
*
* SNS topics can be imported using `{region}/{project-id}/{topic-name}`, e.g.
*
* bash
*
* ```sh
* $ pulumi import scaleway:index/mnqSnsTopic:MnqSnsTopic main fr-par/11111111111111111111111111111111/my-topic
* ```
*
* @deprecated scaleway.index/mnqsnstopic.MnqSnsTopic has been deprecated in favor of scaleway.mnq/snstopic.SnsTopic
*/
export declare class MnqSnsTopic extends pulumi.CustomResource {
/**
* Get an existing MnqSnsTopic 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?: MnqSnsTopicState, opts?: pulumi.CustomResourceOptions): MnqSnsTopic;
/**
* Returns true if the given object is an instance of MnqSnsTopic. 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 MnqSnsTopic;
/**
* The access key of the SNS credentials.
*/
readonly accessKey: pulumi.Output<string>;
/**
* The ARN of the topic
*/
readonly arn: pulumi.Output<string>;
/**
* Specifies whether to enable content-based deduplication.
*/
readonly contentBasedDeduplication: pulumi.Output<boolean>;
/**
* Whether the topic is a FIFO topic. If true, the topic name must end with .fifo.
*/
readonly fifoTopic: pulumi.Output<boolean>;
/**
* The unique name of the SNS topic. Either `name` or `namePrefix` is required. Conflicts with `namePrefix`.
*/
readonly name: pulumi.Output<string>;
/**
* Creates a unique name beginning with the specified prefix. Conflicts with `name`.
*/
readonly namePrefix: pulumi.Output<string>;
/**
* Owner of the SNS topic, should have format 'project-${project_id}'
*/
readonly owner: pulumi.Output<string>;
/**
* `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 key of the SNS credentials.
*/
readonly secretKey: pulumi.Output<string>;
/**
* The endpoint of the SNS service. Can contain a {region} placeholder. Defaults to `https://sns.mnq.{region}.scaleway.com`.
*/
readonly snsEndpoint: pulumi.Output<string | undefined>;
/**
* Create a MnqSnsTopic 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/mnqsnstopic.MnqSnsTopic has been deprecated in favor of scaleway.mnq/snstopic.SnsTopic */
constructor(name: string, args: MnqSnsTopicArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering MnqSnsTopic resources.
*/
export interface MnqSnsTopicState {
/**
* The access key of the SNS credentials.
*/
accessKey?: pulumi.Input<string>;
/**
* The ARN of the topic
*/
arn?: pulumi.Input<string>;
/**
* Specifies whether to enable content-based deduplication.
*/
contentBasedDeduplication?: pulumi.Input<boolean>;
/**
* Whether the topic is a FIFO topic. If true, the topic name must end with .fifo.
*/
fifoTopic?: pulumi.Input<boolean>;
/**
* The unique name of the SNS topic. Either `name` or `namePrefix` is required. Conflicts with `namePrefix`.
*/
name?: pulumi.Input<string>;
/**
* Creates a unique name beginning with the specified prefix. Conflicts with `name`.
*/
namePrefix?: pulumi.Input<string>;
/**
* Owner of the SNS topic, should have format 'project-${project_id}'
*/
owner?: pulumi.Input<string>;
/**
* `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 key of the SNS credentials.
*/
secretKey?: pulumi.Input<string>;
/**
* The endpoint of the SNS service. Can contain a {region} placeholder. Defaults to `https://sns.mnq.{region}.scaleway.com`.
*/
snsEndpoint?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a MnqSnsTopic resource.
*/
export interface MnqSnsTopicArgs {
/**
* The access key of the SNS credentials.
*/
accessKey: pulumi.Input<string>;
/**
* Specifies whether to enable content-based deduplication.
*/
contentBasedDeduplication?: pulumi.Input<boolean>;
/**
* Whether the topic is a FIFO topic. If true, the topic name must end with .fifo.
*/
fifoTopic?: pulumi.Input<boolean>;
/**
* The unique name of the SNS topic. Either `name` or `namePrefix` is required. Conflicts with `namePrefix`.
*/
name?: pulumi.Input<string>;
/**
* Creates a unique name beginning with the specified prefix. Conflicts with `name`.
*/
namePrefix?: pulumi.Input<string>;
/**
* `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 key of the SNS credentials.
*/
secretKey: pulumi.Input<string>;
/**
* The endpoint of the SNS service. Can contain a {region} placeholder. Defaults to `https://sns.mnq.{region}.scaleway.com`.
*/
snsEndpoint?: pulumi.Input<string>;
}