Docs Packages
  1. Packages
  2. Launch Darkly
  3. API Docs
  4. Webhook
Launch Darkly v0.0.6 published on Sunday, Feb 19, 2023 by lbrlabs
lbrlabs/pulumi-launchdarkly

launchdarkly.Webhook

Explore with Pulumi AI

launchdarkly logo
Launch Darkly v0.0.6 published on Sunday, Feb 19, 2023 by lbrlabs
lbrlabs/pulumi-launchdarkly

    Provides a LaunchDarkly webhook resource.

    This resource allows you to create and manage webhooks within your LaunchDarkly organization.

    Create Webhook Resource

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

    Constructor syntax

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

@overload
def Webhook(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            url: Optional[str] = None,
            name: Optional[str] = None,
            on: Optional[bool] = None,
            secret: Optional[str] = None,
            statements: Optional[Sequence[WebhookStatementArgs]] = None,
            tags: Optional[Sequence[str]] = None)
    func NewWebhook(ctx *Context, name string, args WebhookArgs, opts ...ResourceOption) (*Webhook, error)
    public Webhook(string name, WebhookArgs args, CustomResourceOptions? opts = null)
    public Webhook(String name, WebhookArgs args)
public Webhook(String name, WebhookArgs args, CustomResourceOptions options)

    type: launchdarkly:Webhook
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 WebhookArgs
    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 WebhookArgs
    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 WebhookArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args WebhookArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args WebhookArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

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

    var webhookResource = new Launchdarkly.Webhook("webhookResource", new()
{
    Url = "string",
    Name = "string",
    On = false,
    Secret = "string",
    Statements = new[]
    {
        new Launchdarkly.Inputs.WebhookStatementArgs
        {
            Effect = "string",
            Actions = new[]
            {
                "string",
            },
            NotActions = new[]
            {
                "string",
            },
            NotResources = new[]
            {
                "string",
            },
            Resources = new[]
            {
                "string",
            },
        },
    },
    Tags = new[]
    {
        "string",
    },
});

    example, err := launchdarkly.NewWebhook(ctx, "webhookResource", &launchdarkly.WebhookArgs{
	Url:    pulumi.String("string"),
	Name:   pulumi.String("string"),
	On:     pulumi.Bool(false),
	Secret: pulumi.String("string"),
	Statements: launchdarkly.WebhookStatementArray{
		&launchdarkly.WebhookStatementArgs{
			Effect: pulumi.String("string"),
			Actions: pulumi.StringArray{
				pulumi.String("string"),
			},
			NotActions: pulumi.StringArray{
				pulumi.String("string"),
			},
			NotResources: pulumi.StringArray{
				pulumi.String("string"),
			},
			Resources: pulumi.StringArray{
				pulumi.String("string"),
			},
		},
	},
	Tags: pulumi.StringArray{
		pulumi.String("string"),
	},
})

    var webhookResource = new Webhook("webhookResource", WebhookArgs.builder()        
    .url("string")
    .name("string")
    .on(false)
    .secret("string")
    .statements(WebhookStatementArgs.builder()
        .effect("string")
        .actions("string")
        .notActions("string")
        .notResources("string")
        .resources("string")
        .build())
    .tags("string")
    .build());

    webhook_resource = launchdarkly.Webhook("webhookResource",
    url="string",
    name="string",
    on=False,
    secret="string",
    statements=[launchdarkly.WebhookStatementArgs(
        effect="string",
        actions=["string"],
        not_actions=["string"],
        not_resources=["string"],
        resources=["string"],
    )],
    tags=["string"])

    const webhookResource = new launchdarkly.Webhook("webhookResource", {
    url: "string",
    name: "string",
    on: false,
    secret: "string",
    statements: [{
        effect: "string",
        actions: ["string"],
        notActions: ["string"],
        notResources: ["string"],
        resources: ["string"],
    }],
    tags: ["string"],
});

    type: launchdarkly:Webhook
properties:
    name: string
    "on": false
    secret: string
    statements:
        - actions:
            - string
          effect: string
          notActions:
            - string
          notResources:
            - string
          resources:
            - string
    tags:
        - string
    url: string

    Webhook Resource Properties

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

    Inputs

    The Webhook resource accepts the following input properties:

    Url string
    The URL of the remote webhook.
    Name string
    The webhook's human-readable name.
    On bool
    Specifies whether the webhook is enabled.
    Secret string
    The secret used to sign the webhook.
    Statements List<Lbrlabs.PulumiPackage.Launchdarkly.Inputs.WebhookStatement>
    Tags List<string>
    Set of tags associated with the webhook.
    Url string
    The URL of the remote webhook.
    Name string
    The webhook's human-readable name.
    On bool
    Specifies whether the webhook is enabled.
    Secret string
    The secret used to sign the webhook.
    Statements []WebhookStatementArgs
    Tags []string
    Set of tags associated with the webhook.
    url String
    The URL of the remote webhook.
    name String
    The webhook's human-readable name.
    on Boolean
    Specifies whether the webhook is enabled.
    secret String
    The secret used to sign the webhook.
    statements List<WebhookStatement>
    tags List<String>
    Set of tags associated with the webhook.
    url string
    The URL of the remote webhook.
    name string
    The webhook's human-readable name.
    on boolean
    Specifies whether the webhook is enabled.
    secret string
    The secret used to sign the webhook.
    statements WebhookStatement[]
    tags string[]
    Set of tags associated with the webhook.
    url str
    The URL of the remote webhook.
    name str
    The webhook's human-readable name.
    on bool
    Specifies whether the webhook is enabled.
    secret str
    The secret used to sign the webhook.
    statements Sequence[WebhookStatementArgs]
    tags Sequence[str]
    Set of tags associated with the webhook.
    url String
    The URL of the remote webhook.
    name String
    The webhook's human-readable name.
    on Boolean
    Specifies whether the webhook is enabled.
    secret String
    The secret used to sign the webhook.
    statements List<Property Map>
    tags List<String>
    Set of tags associated with the webhook.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing Webhook Resource

    Get an existing Webhook 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?: WebhookState, opts?: CustomResourceOptions): Webhook
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        name: Optional[str] = None,
        on: Optional[bool] = None,
        secret: Optional[str] = None,
        statements: Optional[Sequence[WebhookStatementArgs]] = None,
        tags: Optional[Sequence[str]] = None,
        url: Optional[str] = None) -> Webhook
    func GetWebhook(ctx *Context, name string, id IDInput, state *WebhookState, opts ...ResourceOption) (*Webhook, error)
    public static Webhook Get(string name, Input<string> id, WebhookState? state, CustomResourceOptions? opts = null)
    public static Webhook get(String name, Output<String> id, WebhookState 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:
    Name string
    The webhook's human-readable name.
    On bool
    Specifies whether the webhook is enabled.
    Secret string
    The secret used to sign the webhook.
    Statements List<Lbrlabs.PulumiPackage.Launchdarkly.Inputs.WebhookStatement>
    Tags List<string>
    Set of tags associated with the webhook.
    Url string
    The URL of the remote webhook.
    Name string
    The webhook's human-readable name.
    On bool
    Specifies whether the webhook is enabled.
    Secret string
    The secret used to sign the webhook.
    Statements []WebhookStatementArgs
    Tags []string
    Set of tags associated with the webhook.
    Url string
    The URL of the remote webhook.
    name String
    The webhook's human-readable name.
    on Boolean
    Specifies whether the webhook is enabled.
    secret String
    The secret used to sign the webhook.
    statements List<WebhookStatement>
    tags List<String>
    Set of tags associated with the webhook.
    url String
    The URL of the remote webhook.
    name string
    The webhook's human-readable name.
    on boolean
    Specifies whether the webhook is enabled.
    secret string
    The secret used to sign the webhook.
    statements WebhookStatement[]
    tags string[]
    Set of tags associated with the webhook.
    url string
    The URL of the remote webhook.
    name str
    The webhook's human-readable name.
    on bool
    Specifies whether the webhook is enabled.
    secret str
    The secret used to sign the webhook.
    statements Sequence[WebhookStatementArgs]
    tags Sequence[str]
    Set of tags associated with the webhook.
    url str
    The URL of the remote webhook.
    name String
    The webhook's human-readable name.
    on Boolean
    Specifies whether the webhook is enabled.
    secret String
    The secret used to sign the webhook.
    statements List<Property Map>
    tags List<String>
    Set of tags associated with the webhook.
    url String
    The URL of the remote webhook.

    Supporting Types

    WebhookStatement, WebhookStatementArgs

    Effect string
    Either allow or deny. This argument defines whether the statement allows or denies access to the named resources and actions.
    Actions List<string>
    The list of action specifiers defining the actions to which the statement applies. Either actions or not_actions must be specified. For a list of available actions read Actions reference.
    NotActions List<string>
    The list of action specifiers defining the actions to which the statement does not apply. Either actions or not_actions must be specified. For a list of available actions read Actions reference.
    NotResources List<string>
    The list of resource specifiers defining the resources to which the statement does not apply. Either resources or not_resources must be specified. For a list of available resources read Understanding resource types and scopes.
    Resources List<string>
    The list of resource specifiers defining the resources to which the statement applies. Either resources or not_resources must be specified. For a list of available resources read Understanding resource types and scopes.
    Effect string
    Either allow or deny. This argument defines whether the statement allows or denies access to the named resources and actions.
    Actions []string
    The list of action specifiers defining the actions to which the statement applies. Either actions or not_actions must be specified. For a list of available actions read Actions reference.
    NotActions []string
    The list of action specifiers defining the actions to which the statement does not apply. Either actions or not_actions must be specified. For a list of available actions read Actions reference.
    NotResources []string
    The list of resource specifiers defining the resources to which the statement does not apply. Either resources or not_resources must be specified. For a list of available resources read Understanding resource types and scopes.
    Resources []string
    The list of resource specifiers defining the resources to which the statement applies. Either resources or not_resources must be specified. For a list of available resources read Understanding resource types and scopes.
    effect String
    Either allow or deny. This argument defines whether the statement allows or denies access to the named resources and actions.
    actions List<String>
    The list of action specifiers defining the actions to which the statement applies. Either actions or not_actions must be specified. For a list of available actions read Actions reference.
    notActions List<String>
    The list of action specifiers defining the actions to which the statement does not apply. Either actions or not_actions must be specified. For a list of available actions read Actions reference.
    notResources List<String>
    The list of resource specifiers defining the resources to which the statement does not apply. Either resources or not_resources must be specified. For a list of available resources read Understanding resource types and scopes.
    resources List<String>
    The list of resource specifiers defining the resources to which the statement applies. Either resources or not_resources must be specified. For a list of available resources read Understanding resource types and scopes.
    effect string
    Either allow or deny. This argument defines whether the statement allows or denies access to the named resources and actions.
    actions string[]
    The list of action specifiers defining the actions to which the statement applies. Either actions or not_actions must be specified. For a list of available actions read Actions reference.
    notActions string[]
    The list of action specifiers defining the actions to which the statement does not apply. Either actions or not_actions must be specified. For a list of available actions read Actions reference.
    notResources string[]
    The list of resource specifiers defining the resources to which the statement does not apply. Either resources or not_resources must be specified. For a list of available resources read Understanding resource types and scopes.
    resources string[]
    The list of resource specifiers defining the resources to which the statement applies. Either resources or not_resources must be specified. For a list of available resources read Understanding resource types and scopes.
    effect str
    Either allow or deny. This argument defines whether the statement allows or denies access to the named resources and actions.
    actions Sequence[str]
    The list of action specifiers defining the actions to which the statement applies. Either actions or not_actions must be specified. For a list of available actions read Actions reference.
    not_actions Sequence[str]
    The list of action specifiers defining the actions to which the statement does not apply. Either actions or not_actions must be specified. For a list of available actions read Actions reference.
    not_resources Sequence[str]
    The list of resource specifiers defining the resources to which the statement does not apply. Either resources or not_resources must be specified. For a list of available resources read Understanding resource types and scopes.
    resources Sequence[str]
    The list of resource specifiers defining the resources to which the statement applies. Either resources or not_resources must be specified. For a list of available resources read Understanding resource types and scopes.
    effect String
    Either allow or deny. This argument defines whether the statement allows or denies access to the named resources and actions.
    actions List<String>
    The list of action specifiers defining the actions to which the statement applies. Either actions or not_actions must be specified. For a list of available actions read Actions reference.
    notActions List<String>
    The list of action specifiers defining the actions to which the statement does not apply. Either actions or not_actions must be specified. For a list of available actions read Actions reference.
    notResources List<String>
    The list of resource specifiers defining the resources to which the statement does not apply. Either resources or not_resources must be specified. For a list of available resources read Understanding resource types and scopes.
    resources List<String>
    The list of resource specifiers defining the resources to which the statement applies. Either resources or not_resources must be specified. For a list of available resources read Understanding resource types and scopes.

    Import

    LaunchDarkly webhooks can be imported using the webhook’s 24 character ID, e.g.

     $ pulumi import launchdarkly:index/webhook:Webhook example 57c0af609969090743529967

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

    Package Details

    Repository
    launchdarkly lbrlabs/pulumi-launchdarkly
    License
    Notes
    This Pulumi package is based on the launchdarkly Terraform Provider.
    launchdarkly logo
    Launch Darkly v0.0.6 published on Sunday, Feb 19, 2023 by lbrlabs
    lbrlabs/pulumi-launchdarkly