Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Sentry
  3. API Docs
  4. SentryKey
Sentry v0.0.9 published on Friday, Nov 15, 2024 by Pulumiverse
pulumiverse/pulumi-sentry

sentry.SentryKey

Explore with Pulumi AI

sentry logo
Sentry v0.0.9 published on Friday, Nov 15, 2024 by Pulumiverse
pulumiverse/pulumi-sentry

    Sentry Key resource.

    Example Usage

    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 pulumi
import pulumiverse_sentry as sentry

# Create a key
default = sentry.SentryKey("default",
    organization="my-organization",
    project="web-app",
    name="My Key")

    package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/pulumiverse/pulumi-sentry/sdk/go/sentry"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		// Create a key
		_, err := sentry.NewSentryKey(ctx, "default", &sentry.SentryKeyArgs{
			Organization: pulumi.String("my-organization"),
			Project:      pulumi.String("web-app"),
			Name:         pulumi.String("My Key"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Sentry = Pulumiverse.Sentry;

return await Deployment.RunAsync(() => 
{
    // Create a key
    var @default = new Sentry.SentryKey("default", new()
    {
        Organization = "my-organization",
        Project = "web-app",
        Name = "My Key",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.sentry.SentryKey;
import com.pulumi.sentry.SentryKeyArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        // Create a key
        var default_ = new SentryKey("default", SentryKeyArgs.builder()
            .organization("my-organization")
            .project("web-app")
            .name("My Key")
            .build());

    }
}

    resources:
  # Create a key
  default:
    type: sentry:SentryKey
    properties:
      organization: my-organization
      project: web-app
      name: My Key

    Create SentryKey Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new SentryKey(name: string, args: SentryKeyArgs, opts?: CustomResourceOptions);
    @overload
def SentryKey(resource_name: str,
              args: SentryKeyArgs,
              opts: Optional[ResourceOptions] = None)

@overload
def SentryKey(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              organization: Optional[str] = None,
              project: Optional[str] = None,
              name: Optional[str] = None,
              rate_limit_count: Optional[int] = None,
              rate_limit_window: Optional[int] = None)
    func NewSentryKey(ctx *Context, name string, args SentryKeyArgs, opts ...ResourceOption) (*SentryKey, error)
    public SentryKey(string name, SentryKeyArgs args, CustomResourceOptions? opts = null)
    public SentryKey(String name, SentryKeyArgs args)
public SentryKey(String name, SentryKeyArgs args, CustomResourceOptions options)

    type: sentry:SentryKey
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args SentryKeyArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args SentryKeyArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args SentryKeyArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SentryKeyArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SentryKeyArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var sentryKeyResource = new Sentry.SentryKey("sentryKeyResource", new()
{
    Organization = "string",
    Project = "string",
    Name = "string",
    RateLimitCount = 0,
    RateLimitWindow = 0,
});

    example, err := sentry.NewSentryKey(ctx, "sentryKeyResource", &sentry.SentryKeyArgs{
	Organization:    pulumi.String("string"),
	Project:         pulumi.String("string"),
	Name:            pulumi.String("string"),
	RateLimitCount:  pulumi.Int(0),
	RateLimitWindow: pulumi.Int(0),
})

    var sentryKeyResource = new SentryKey("sentryKeyResource", SentryKeyArgs.builder()
    .organization("string")
    .project("string")
    .name("string")
    .rateLimitCount(0)
    .rateLimitWindow(0)
    .build());

    sentry_key_resource = sentry.SentryKey("sentryKeyResource",
    organization="string",
    project="string",
    name="string",
    rate_limit_count=0,
    rate_limit_window=0)

    const sentryKeyResource = new sentry.SentryKey("sentryKeyResource", {
    organization: "string",
    project: "string",
    name: "string",
    rateLimitCount: 0,
    rateLimitWindow: 0,
});

    type: sentry:SentryKey
properties:
    name: string
    organization: string
    project: string
    rateLimitCount: 0
    rateLimitWindow: 0

    SentryKey Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The SentryKey resource accepts the following input properties:

    Organization string
    The slug of the organization the key should be created for.
    Project string
    The slug of the project the key should be created for.
    Name string
    The name of the key.
    RateLimitCount int
    Number of events that can be reported within the rate limit window.
    RateLimitWindow int
    Length of time that will be considered when checking the rate limit.
    Organization string
    The slug of the organization the key should be created for.
    Project string
    The slug of the project the key should be created for.
    Name string
    The name of the key.
    RateLimitCount int
    Number of events that can be reported within the rate limit window.
    RateLimitWindow int
    Length of time that will be considered when checking the rate limit.
    organization String
    The slug of the organization the key should be created for.
    project String
    The slug of the project the key should be created for.
    name String
    The name of the key.
    rateLimitCount Integer
    Number of events that can be reported within the rate limit window.
    rateLimitWindow Integer
    Length of time that will be considered when checking the rate limit.
    organization string
    The slug of the organization the key should be created for.
    project string
    The slug of the project the key should be created for.
    name string
    The name of the key.
    rateLimitCount number
    Number of events that can be reported within the rate limit window.
    rateLimitWindow number
    Length of time that will be considered when checking the rate limit.
    organization str
    The slug of the organization the key should be created for.
    project str
    The slug of the project the key should be created for.
    name str
    The name of the key.
    rate_limit_count int
    Number of events that can be reported within the rate limit window.
    rate_limit_window int
    Length of time that will be considered when checking the rate limit.
    organization String
    The slug of the organization the key should be created for.
    project String
    The slug of the project the key should be created for.
    name String
    The name of the key.
    rateLimitCount Number
    Number of events that can be reported within the rate limit window.
    rateLimitWindow Number
    Length of time that will be considered when checking the rate limit.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the SentryKey resource produces the following output properties:

    DsnCsp string
    DSN for the Content Security Policy (CSP) for the key.
    DsnPublic string
    DSN for the key.
    DsnSecret string

    Deprecated: DSN (Deprecated) for the key.

    Id string
    The provider-assigned unique ID for this managed resource.
    IsActive bool
    Flag indicating the key is active.
    ProjectId int
    The ID of the project that the key belongs to.
    Public string
    Public key portion of the client key.
    Secret string
    Secret key portion of the client key.
    DsnCsp string
    DSN for the Content Security Policy (CSP) for the key.
    DsnPublic string
    DSN for the key.
    DsnSecret string

    Deprecated: DSN (Deprecated) for the key.

    Id string
    The provider-assigned unique ID for this managed resource.
    IsActive bool
    Flag indicating the key is active.
    ProjectId int
    The ID of the project that the key belongs to.
    Public string
    Public key portion of the client key.
    Secret string
    Secret key portion of the client key.
    dsnCsp String
    DSN for the Content Security Policy (CSP) for the key.
    dsnPublic String
    DSN for the key.
    dsnSecret String

    Deprecated: DSN (Deprecated) for the key.

    id String
    The provider-assigned unique ID for this managed resource.
    isActive Boolean
    Flag indicating the key is active.
    projectId Integer
    The ID of the project that the key belongs to.
    public_ String
    Public key portion of the client key.
    secret String
    Secret key portion of the client key.
    dsnCsp string
    DSN for the Content Security Policy (CSP) for the key.
    dsnPublic string
    DSN for the key.
    dsnSecret string

    Deprecated: DSN (Deprecated) for the key.

    id string
    The provider-assigned unique ID for this managed resource.
    isActive boolean
    Flag indicating the key is active.
    projectId number
    The ID of the project that the key belongs to.
    public string
    Public key portion of the client key.
    secret string
    Secret key portion of the client key.
    dsn_csp str
    DSN for the Content Security Policy (CSP) for the key.
    dsn_public str
    DSN for the key.
    dsn_secret str

    Deprecated: DSN (Deprecated) for the key.

    id str
    The provider-assigned unique ID for this managed resource.
    is_active bool
    Flag indicating the key is active.
    project_id int
    The ID of the project that the key belongs to.
    public str
    Public key portion of the client key.
    secret str
    Secret key portion of the client key.
    dsnCsp String
    DSN for the Content Security Policy (CSP) for the key.
    dsnPublic String
    DSN for the key.
    dsnSecret String

    Deprecated: DSN (Deprecated) for the key.

    id String
    The provider-assigned unique ID for this managed resource.
    isActive Boolean
    Flag indicating the key is active.
    projectId Number
    The ID of the project that the key belongs to.
    public String
    Public key portion of the client key.
    secret String
    Secret key portion of the client key.

    Look up Existing SentryKey Resource

    Get an existing SentryKey resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: SentryKeyState, opts?: CustomResourceOptions): SentryKey
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        dsn_csp: Optional[str] = None,
        dsn_public: Optional[str] = None,
        dsn_secret: Optional[str] = None,
        is_active: Optional[bool] = None,
        name: Optional[str] = None,
        organization: Optional[str] = None,
        project: Optional[str] = None,
        project_id: Optional[int] = None,
        public: Optional[str] = None,
        rate_limit_count: Optional[int] = None,
        rate_limit_window: Optional[int] = None,
        secret: Optional[str] = None) -> SentryKey
    func GetSentryKey(ctx *Context, name string, id IDInput, state *SentryKeyState, opts ...ResourceOption) (*SentryKey, error)
    public static SentryKey Get(string name, Input<string> id, SentryKeyState? state, CustomResourceOptions? opts = null)
    public static SentryKey get(String name, Output<String> id, SentryKeyState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    DsnCsp string
    DSN for the Content Security Policy (CSP) for the key.
    DsnPublic string
    DSN for the key.
    DsnSecret string

    Deprecated: DSN (Deprecated) for the key.

    IsActive bool
    Flag indicating the key is active.
    Name string
    The name of the key.
    Organization string
    The slug of the organization the key should be created for.
    Project string
    The slug of the project the key should be created for.
    ProjectId int
    The ID of the project that the key belongs to.
    Public string
    Public key portion of the client key.
    RateLimitCount int
    Number of events that can be reported within the rate limit window.
    RateLimitWindow int
    Length of time that will be considered when checking the rate limit.
    Secret string
    Secret key portion of the client key.
    DsnCsp string
    DSN for the Content Security Policy (CSP) for the key.
    DsnPublic string
    DSN for the key.
    DsnSecret string

    Deprecated: DSN (Deprecated) for the key.

    IsActive bool
    Flag indicating the key is active.
    Name string
    The name of the key.
    Organization string
    The slug of the organization the key should be created for.
    Project string
    The slug of the project the key should be created for.
    ProjectId int
    The ID of the project that the key belongs to.
    Public string
    Public key portion of the client key.
    RateLimitCount int
    Number of events that can be reported within the rate limit window.
    RateLimitWindow int
    Length of time that will be considered when checking the rate limit.
    Secret string
    Secret key portion of the client key.
    dsnCsp String
    DSN for the Content Security Policy (CSP) for the key.
    dsnPublic String
    DSN for the key.
    dsnSecret String

    Deprecated: DSN (Deprecated) for the key.

    isActive Boolean
    Flag indicating the key is active.
    name String
    The name of the key.
    organization String
    The slug of the organization the key should be created for.
    project String
    The slug of the project the key should be created for.
    projectId Integer
    The ID of the project that the key belongs to.
    public_ String
    Public key portion of the client key.
    rateLimitCount Integer
    Number of events that can be reported within the rate limit window.
    rateLimitWindow Integer
    Length of time that will be considered when checking the rate limit.
    secret String
    Secret key portion of the client key.
    dsnCsp string
    DSN for the Content Security Policy (CSP) for the key.
    dsnPublic string
    DSN for the key.
    dsnSecret string

    Deprecated: DSN (Deprecated) for the key.

    isActive boolean
    Flag indicating the key is active.
    name string
    The name of the key.
    organization string
    The slug of the organization the key should be created for.
    project string
    The slug of the project the key should be created for.
    projectId number
    The ID of the project that the key belongs to.
    public string
    Public key portion of the client key.
    rateLimitCount number
    Number of events that can be reported within the rate limit window.
    rateLimitWindow number
    Length of time that will be considered when checking the rate limit.
    secret string
    Secret key portion of the client key.
    dsn_csp str
    DSN for the Content Security Policy (CSP) for the key.
    dsn_public str
    DSN for the key.
    dsn_secret str

    Deprecated: DSN (Deprecated) for the key.

    is_active bool
    Flag indicating the key is active.
    name str
    The name of the key.
    organization str
    The slug of the organization the key should be created for.
    project str
    The slug of the project the key should be created for.
    project_id int
    The ID of the project that the key belongs to.
    public str
    Public key portion of the client key.
    rate_limit_count int
    Number of events that can be reported within the rate limit window.
    rate_limit_window int
    Length of time that will be considered when checking the rate limit.
    secret str
    Secret key portion of the client key.
    dsnCsp String
    DSN for the Content Security Policy (CSP) for the key.
    dsnPublic String
    DSN for the key.
    dsnSecret String

    Deprecated: DSN (Deprecated) for the key.

    isActive Boolean
    Flag indicating the key is active.
    name String
    The name of the key.
    organization String
    The slug of the organization the key should be created for.
    project String
    The slug of the project the key should be created for.
    projectId Number
    The ID of the project that the key belongs to.
    public String
    Public key portion of the client key.
    rateLimitCount Number
    Number of events that can be reported within the rate limit window.
    rateLimitWindow Number
    Length of time that will be considered when checking the rate limit.
    secret String
    Secret key portion of the client 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]/

    $ pulumi import sentry:index/sentryKey:SentryKey default org-slug/project-slug/key-id

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    sentry pulumiverse/pulumi-sentry
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the sentry Terraform Provider.
    sentry logo
    Sentry v0.0.9 published on Friday, Nov 15, 2024 by Pulumiverse
    pulumiverse/pulumi-sentry