@pulumiverse/sentry
Version:
A Pulumi package for creating and managing Sentry resources.
180 lines (179 loc) • 5.44 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Sentry Key resource.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as sentry from "@pulumiverse/sentry";
*
* // Create a key
* const _default = new sentry.SentryKey("default", {
* organization: "my-organization",
* project: "web-app",
* name: "My Key",
* });
* ```
*
* ## Import
*
* import using the organization, project slugs and key id from the URL:
*
* https://sentry.io/settings/[org-slug]/projects/[project-slug]/keys/[key-id]/
*
* ```sh
* $ pulumi import sentry:index/sentryKey:SentryKey default org-slug/project-slug/key-id
* ```
*/
export declare class SentryKey extends pulumi.CustomResource {
/**
* Get an existing SentryKey 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?: SentryKeyState, opts?: pulumi.CustomResourceOptions): SentryKey;
/**
* Returns true if the given object is an instance of SentryKey. 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 SentryKey;
/**
* DSN for the Content Security Policy (CSP) for the key.
*/
readonly dsnCsp: pulumi.Output<string>;
/**
* DSN for the key.
*/
readonly dsnPublic: pulumi.Output<string>;
/**
* @deprecated DSN (Deprecated) for the key.
*/
readonly dsnSecret: pulumi.Output<string>;
/**
* Flag indicating the key is active.
*/
readonly isActive: pulumi.Output<boolean>;
/**
* The name of the key.
*/
readonly name: pulumi.Output<string>;
/**
* The slug of the organization the key should be created for.
*/
readonly organization: pulumi.Output<string>;
/**
* The slug of the project the key should be created for.
*/
readonly project: pulumi.Output<string>;
/**
* The ID of the project that the key belongs to.
*/
readonly projectId: pulumi.Output<number>;
/**
* Public key portion of the client key.
*/
readonly public: pulumi.Output<string>;
/**
* Number of events that can be reported within the rate limit window.
*/
readonly rateLimitCount: pulumi.Output<number>;
/**
* Length of time that will be considered when checking the rate limit.
*/
readonly rateLimitWindow: pulumi.Output<number>;
/**
* Secret key portion of the client key.
*/
readonly secret: pulumi.Output<string>;
/**
* Create a SentryKey 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: SentryKeyArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering SentryKey resources.
*/
export interface SentryKeyState {
/**
* DSN for the Content Security Policy (CSP) for the key.
*/
dsnCsp?: pulumi.Input<string>;
/**
* DSN for the key.
*/
dsnPublic?: pulumi.Input<string>;
/**
* @deprecated DSN (Deprecated) for the key.
*/
dsnSecret?: pulumi.Input<string>;
/**
* Flag indicating the key is active.
*/
isActive?: pulumi.Input<boolean>;
/**
* The name of the key.
*/
name?: pulumi.Input<string>;
/**
* The slug of the organization the key should be created for.
*/
organization?: pulumi.Input<string>;
/**
* The slug of the project the key should be created for.
*/
project?: pulumi.Input<string>;
/**
* The ID of the project that the key belongs to.
*/
projectId?: pulumi.Input<number>;
/**
* Public key portion of the client key.
*/
public?: pulumi.Input<string>;
/**
* Number of events that can be reported within the rate limit window.
*/
rateLimitCount?: pulumi.Input<number>;
/**
* Length of time that will be considered when checking the rate limit.
*/
rateLimitWindow?: pulumi.Input<number>;
/**
* Secret key portion of the client key.
*/
secret?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a SentryKey resource.
*/
export interface SentryKeyArgs {
/**
* The name of the key.
*/
name?: pulumi.Input<string>;
/**
* The slug of the organization the key should be created for.
*/
organization: pulumi.Input<string>;
/**
* The slug of the project the key should be created for.
*/
project: pulumi.Input<string>;
/**
* Number of events that can be reported within the rate limit window.
*/
rateLimitCount?: pulumi.Input<number>;
/**
* Length of time that will be considered when checking the rate limit.
*/
rateLimitWindow?: pulumi.Input<number>;
}