Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Artifactory Provider
  3. API Docs
  4. DistributionCustomWebhook
artifactory v8.4.0 published on Tuesday, Nov 19, 2024 by Pulumi
pulumi/pulumi-artifactory

artifactory.DistributionCustomWebhook

Explore with Pulumi AI

artifactory logo
artifactory v8.4.0 published on Tuesday, Nov 19, 2024 by Pulumi
pulumi/pulumi-artifactory

    Provides an Artifactory custom webhook resource. This can be used to register and manage Artifactory webhook subscription which enables you to be notified or notify other users when such events take place in Artifactory.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as artifactory from "@pulumi/artifactory";

const distribution_custom_webhook = new artifactory.DistributionCustomWebhook("distribution-custom-webhook", {
    key: "distribution-custom-webhook",
    eventTypes: [
        "distribute_started",
        "distribute_completed",
        "distribute_aborted",
        "distribute_failed",
        "delete_started",
        "delete_completed",
        "delete_failed",
    ],
    criteria: {
        anyReleaseBundle: false,
        registeredReleaseBundleNames: ["bundle-name"],
        includePatterns: ["foo/**"],
        excludePatterns: ["bar/**"],
    },
    handlers: [{
        url: "https://tempurl.org",
        secrets: {
            secretName1: "value1",
            secretName2: "value2",
        },
        httpHeaders: {
            headerName1: "value1",
            headerName2: "value2",
        },
        payload: "{ \"ref\": \"main\" , \"inputs\": { \"artifact_path\": \"test-repo/repo-path\" } }",
    }],
});

    import pulumi
import pulumi_artifactory as artifactory

distribution_custom_webhook = artifactory.DistributionCustomWebhook("distribution-custom-webhook",
    key="distribution-custom-webhook",
    event_types=[
        "distribute_started",
        "distribute_completed",
        "distribute_aborted",
        "distribute_failed",
        "delete_started",
        "delete_completed",
        "delete_failed",
    ],
    criteria={
        "any_release_bundle": False,
        "registered_release_bundle_names": ["bundle-name"],
        "include_patterns": ["foo/**"],
        "exclude_patterns": ["bar/**"],
    },
    handlers=[{
        "url": "https://tempurl.org",
        "secrets": {
            "secretName1": "value1",
            "secretName2": "value2",
        },
        "http_headers": {
            "headerName1": "value1",
            "headerName2": "value2",
        },
        "payload": "{ \"ref\": \"main\" , \"inputs\": { \"artifact_path\": \"test-repo/repo-path\" } }",
    }])

    package main

import (
	"github.com/pulumi/pulumi-artifactory/sdk/v8/go/artifactory"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := artifactory.NewDistributionCustomWebhook(ctx, "distribution-custom-webhook", &artifactory.DistributionCustomWebhookArgs{
			Key: pulumi.String("distribution-custom-webhook"),
			EventTypes: pulumi.StringArray{
				pulumi.String("distribute_started"),
				pulumi.String("distribute_completed"),
				pulumi.String("distribute_aborted"),
				pulumi.String("distribute_failed"),
				pulumi.String("delete_started"),
				pulumi.String("delete_completed"),
				pulumi.String("delete_failed"),
			},
			Criteria: &artifactory.DistributionCustomWebhookCriteriaArgs{
				AnyReleaseBundle: pulumi.Bool(false),
				RegisteredReleaseBundleNames: pulumi.StringArray{
					pulumi.String("bundle-name"),
				},
				IncludePatterns: pulumi.StringArray{
					pulumi.String("foo/**"),
				},
				ExcludePatterns: pulumi.StringArray{
					pulumi.String("bar/**"),
				},
			},
			Handlers: artifactory.DistributionCustomWebhookHandlerArray{
				&artifactory.DistributionCustomWebhookHandlerArgs{
					Url: pulumi.String("https://tempurl.org"),
					Secrets: pulumi.StringMap{
						"secretName1": pulumi.String("value1"),
						"secretName2": pulumi.String("value2"),
					},
					HttpHeaders: pulumi.StringMap{
						"headerName1": pulumi.String("value1"),
						"headerName2": pulumi.String("value2"),
					},
					Payload: pulumi.String("{ \"ref\": \"main\" , \"inputs\": { \"artifact_path\": \"test-repo/repo-path\" } }"),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Artifactory = Pulumi.Artifactory;

return await Deployment.RunAsync(() => 
{
    var distribution_custom_webhook = new Artifactory.DistributionCustomWebhook("distribution-custom-webhook", new()
    {
        Key = "distribution-custom-webhook",
        EventTypes = new[]
        {
            "distribute_started",
            "distribute_completed",
            "distribute_aborted",
            "distribute_failed",
            "delete_started",
            "delete_completed",
            "delete_failed",
        },
        Criteria = new Artifactory.Inputs.DistributionCustomWebhookCriteriaArgs
        {
            AnyReleaseBundle = false,
            RegisteredReleaseBundleNames = new[]
            {
                "bundle-name",
            },
            IncludePatterns = new[]
            {
                "foo/**",
            },
            ExcludePatterns = new[]
            {
                "bar/**",
            },
        },
        Handlers = new[]
        {
            new Artifactory.Inputs.DistributionCustomWebhookHandlerArgs
            {
                Url = "https://tempurl.org",
                Secrets = 
                {
                    { "secretName1", "value1" },
                    { "secretName2", "value2" },
                },
                HttpHeaders = 
                {
                    { "headerName1", "value1" },
                    { "headerName2", "value2" },
                },
                Payload = "{ \"ref\": \"main\" , \"inputs\": { \"artifact_path\": \"test-repo/repo-path\" } }",
            },
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.artifactory.DistributionCustomWebhook;
import com.pulumi.artifactory.DistributionCustomWebhookArgs;
import com.pulumi.artifactory.inputs.DistributionCustomWebhookCriteriaArgs;
import com.pulumi.artifactory.inputs.DistributionCustomWebhookHandlerArgs;
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) {
        var distribution_custom_webhook = new DistributionCustomWebhook("distribution-custom-webhook", DistributionCustomWebhookArgs.builder()
            .key("distribution-custom-webhook")
            .eventTypes(            
                "distribute_started",
                "distribute_completed",
                "distribute_aborted",
                "distribute_failed",
                "delete_started",
                "delete_completed",
                "delete_failed")
            .criteria(DistributionCustomWebhookCriteriaArgs.builder()
                .anyReleaseBundle(false)
                .registeredReleaseBundleNames("bundle-name")
                .includePatterns("foo/**")
                .excludePatterns("bar/**")
                .build())
            .handlers(DistributionCustomWebhookHandlerArgs.builder()
                .url("https://tempurl.org")
                .secrets(Map.ofEntries(
                    Map.entry("secretName1", "value1"),
                    Map.entry("secretName2", "value2")
                ))
                .httpHeaders(Map.ofEntries(
                    Map.entry("headerName1", "value1"),
                    Map.entry("headerName2", "value2")
                ))
                .payload("{ \"ref\": \"main\" , \"inputs\": { \"artifact_path\": \"test-repo/repo-path\" } }")
                .build())
            .build());

    }
}

    resources:
  distribution-custom-webhook:
    type: artifactory:DistributionCustomWebhook
    properties:
      key: distribution-custom-webhook
      eventTypes:
        - distribute_started
        - distribute_completed
        - distribute_aborted
        - distribute_failed
        - delete_started
        - delete_completed
        - delete_failed
      criteria:
        anyReleaseBundle: false
        registeredReleaseBundleNames:
          - bundle-name
        includePatterns:
          - foo/**
        excludePatterns:
          - bar/**
      handlers:
        - url: https://tempurl.org
          secrets:
            secretName1: value1
            secretName2: value2
          httpHeaders:
            headerName1: value1
            headerName2: value2
          payload: '{ "ref": "main" , "inputs": { "artifact_path": "test-repo/repo-path" } }'

    Create DistributionCustomWebhook Resource

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

    Constructor syntax

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

@overload
def DistributionCustomWebhook(resource_name: str,
                              opts: Optional[ResourceOptions] = None,
                              event_types: Optional[Sequence[str]] = None,
                              key: Optional[str] = None,
                              criteria: Optional[DistributionCustomWebhookCriteriaArgs] = None,
                              description: Optional[str] = None,
                              enabled: Optional[bool] = None,
                              handlers: Optional[Sequence[DistributionCustomWebhookHandlerArgs]] = None)
    func NewDistributionCustomWebhook(ctx *Context, name string, args DistributionCustomWebhookArgs, opts ...ResourceOption) (*DistributionCustomWebhook, error)
    public DistributionCustomWebhook(string name, DistributionCustomWebhookArgs args, CustomResourceOptions? opts = null)
    public DistributionCustomWebhook(String name, DistributionCustomWebhookArgs args)
public DistributionCustomWebhook(String name, DistributionCustomWebhookArgs args, CustomResourceOptions options)

    type: artifactory:DistributionCustomWebhook
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 DistributionCustomWebhookArgs
    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 DistributionCustomWebhookArgs
    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 DistributionCustomWebhookArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DistributionCustomWebhookArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DistributionCustomWebhookArgs
    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 distributionCustomWebhookResource = new Artifactory.DistributionCustomWebhook("distributionCustomWebhookResource", new()
{
    EventTypes = new[]
    {
        "string",
    },
    Key = "string",
    Criteria = new Artifactory.Inputs.DistributionCustomWebhookCriteriaArgs
    {
        AnyReleaseBundle = false,
        RegisteredReleaseBundleNames = new[]
        {
            "string",
        },
        ExcludePatterns = new[]
        {
            "string",
        },
        IncludePatterns = new[]
        {
            "string",
        },
    },
    Description = "string",
    Enabled = false,
    Handlers = new[]
    {
        new Artifactory.Inputs.DistributionCustomWebhookHandlerArgs
        {
            Url = "string",
            HttpHeaders = 
            {
                { "string", "string" },
            },
            Payload = "string",
            Proxy = "string",
            Secrets = 
            {
                { "string", "string" },
            },
        },
    },
});

    example, err := artifactory.NewDistributionCustomWebhook(ctx, "distributionCustomWebhookResource", &artifactory.DistributionCustomWebhookArgs{
	EventTypes: pulumi.StringArray{
		pulumi.String("string"),
	},
	Key: pulumi.String("string"),
	Criteria: &artifactory.DistributionCustomWebhookCriteriaArgs{
		AnyReleaseBundle: pulumi.Bool(false),
		RegisteredReleaseBundleNames: pulumi.StringArray{
			pulumi.String("string"),
		},
		ExcludePatterns: pulumi.StringArray{
			pulumi.String("string"),
		},
		IncludePatterns: pulumi.StringArray{
			pulumi.String("string"),
		},
	},
	Description: pulumi.String("string"),
	Enabled:     pulumi.Bool(false),
	Handlers: artifactory.DistributionCustomWebhookHandlerArray{
		&artifactory.DistributionCustomWebhookHandlerArgs{
			Url: pulumi.String("string"),
			HttpHeaders: pulumi.StringMap{
				"string": pulumi.String("string"),
			},
			Payload: pulumi.String("string"),
			Proxy:   pulumi.String("string"),
			Secrets: pulumi.StringMap{
				"string": pulumi.String("string"),
			},
		},
	},
})

    var distributionCustomWebhookResource = new DistributionCustomWebhook("distributionCustomWebhookResource", DistributionCustomWebhookArgs.builder()
    .eventTypes("string")
    .key("string")
    .criteria(DistributionCustomWebhookCriteriaArgs.builder()
        .anyReleaseBundle(false)
        .registeredReleaseBundleNames("string")
        .excludePatterns("string")
        .includePatterns("string")
        .build())
    .description("string")
    .enabled(false)
    .handlers(DistributionCustomWebhookHandlerArgs.builder()
        .url("string")
        .httpHeaders(Map.of("string", "string"))
        .payload("string")
        .proxy("string")
        .secrets(Map.of("string", "string"))
        .build())
    .build());

    distribution_custom_webhook_resource = artifactory.DistributionCustomWebhook("distributionCustomWebhookResource",
    event_types=["string"],
    key="string",
    criteria={
        "any_release_bundle": False,
        "registered_release_bundle_names": ["string"],
        "exclude_patterns": ["string"],
        "include_patterns": ["string"],
    },
    description="string",
    enabled=False,
    handlers=[{
        "url": "string",
        "http_headers": {
            "string": "string",
        },
        "payload": "string",
        "proxy": "string",
        "secrets": {
            "string": "string",
        },
    }])

    const distributionCustomWebhookResource = new artifactory.DistributionCustomWebhook("distributionCustomWebhookResource", {
    eventTypes: ["string"],
    key: "string",
    criteria: {
        anyReleaseBundle: false,
        registeredReleaseBundleNames: ["string"],
        excludePatterns: ["string"],
        includePatterns: ["string"],
    },
    description: "string",
    enabled: false,
    handlers: [{
        url: "string",
        httpHeaders: {
            string: "string",
        },
        payload: "string",
        proxy: "string",
        secrets: {
            string: "string",
        },
    }],
});

    type: artifactory:DistributionCustomWebhook
properties:
    criteria:
        anyReleaseBundle: false
        excludePatterns:
            - string
        includePatterns:
            - string
        registeredReleaseBundleNames:
            - string
    description: string
    enabled: false
    eventTypes:
        - string
    handlers:
        - httpHeaders:
            string: string
          payload: string
          proxy: string
          secrets:
            string: string
          url: string
    key: string

    DistributionCustomWebhook 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 DistributionCustomWebhook resource accepts the following input properties:

    EventTypes List<string>
    List of Events in Artifactory, Distribution, Release Bundle that function as the event trigger for the Webhook. Allow values: distribute_started, distribute_completed, distribute_aborted, distribute_failed, delete_started, delete_completed, delete_failed`
    Key string
    The identity key of the webhook. Must be between 2 and 200 characters. Cannot contain spaces.
    Criteria DistributionCustomWebhookCriteria
    Specifies where the webhook will be applied on which repositories.
    Description string
    Webhook description. Max length 1000 characters.
    Enabled bool
    Status of webhook. Default to true.
    Handlers List<DistributionCustomWebhookHandler>
    At least one is required.
    EventTypes []string
    List of Events in Artifactory, Distribution, Release Bundle that function as the event trigger for the Webhook. Allow values: distribute_started, distribute_completed, distribute_aborted, distribute_failed, delete_started, delete_completed, delete_failed`
    Key string
    The identity key of the webhook. Must be between 2 and 200 characters. Cannot contain spaces.
    Criteria DistributionCustomWebhookCriteriaArgs
    Specifies where the webhook will be applied on which repositories.
    Description string
    Webhook description. Max length 1000 characters.
    Enabled bool
    Status of webhook. Default to true.
    Handlers []DistributionCustomWebhookHandlerArgs
    At least one is required.
    eventTypes List<String>
    List of Events in Artifactory, Distribution, Release Bundle that function as the event trigger for the Webhook. Allow values: distribute_started, distribute_completed, distribute_aborted, distribute_failed, delete_started, delete_completed, delete_failed`
    key String
    The identity key of the webhook. Must be between 2 and 200 characters. Cannot contain spaces.
    criteria DistributionCustomWebhookCriteria
    Specifies where the webhook will be applied on which repositories.
    description String
    Webhook description. Max length 1000 characters.
    enabled Boolean
    Status of webhook. Default to true.
    handlers List<DistributionCustomWebhookHandler>
    At least one is required.
    eventTypes string[]
    List of Events in Artifactory, Distribution, Release Bundle that function as the event trigger for the Webhook. Allow values: distribute_started, distribute_completed, distribute_aborted, distribute_failed, delete_started, delete_completed, delete_failed`
    key string
    The identity key of the webhook. Must be between 2 and 200 characters. Cannot contain spaces.
    criteria DistributionCustomWebhookCriteria
    Specifies where the webhook will be applied on which repositories.
    description string
    Webhook description. Max length 1000 characters.
    enabled boolean
    Status of webhook. Default to true.
    handlers DistributionCustomWebhookHandler[]
    At least one is required.
    event_types Sequence[str]
    List of Events in Artifactory, Distribution, Release Bundle that function as the event trigger for the Webhook. Allow values: distribute_started, distribute_completed, distribute_aborted, distribute_failed, delete_started, delete_completed, delete_failed`
    key str
    The identity key of the webhook. Must be between 2 and 200 characters. Cannot contain spaces.
    criteria DistributionCustomWebhookCriteriaArgs
    Specifies where the webhook will be applied on which repositories.
    description str
    Webhook description. Max length 1000 characters.
    enabled bool
    Status of webhook. Default to true.
    handlers Sequence[DistributionCustomWebhookHandlerArgs]
    At least one is required.
    eventTypes List<String>
    List of Events in Artifactory, Distribution, Release Bundle that function as the event trigger for the Webhook. Allow values: distribute_started, distribute_completed, distribute_aborted, distribute_failed, delete_started, delete_completed, delete_failed`
    key String
    The identity key of the webhook. Must be between 2 and 200 characters. Cannot contain spaces.
    criteria Property Map
    Specifies where the webhook will be applied on which repositories.
    description String
    Webhook description. Max length 1000 characters.
    enabled Boolean
    Status of webhook. Default to true.
    handlers List<Property Map>
    At least one is required.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the DistributionCustomWebhook 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 DistributionCustomWebhook Resource

    Get an existing DistributionCustomWebhook 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?: DistributionCustomWebhookState, opts?: CustomResourceOptions): DistributionCustomWebhook
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        criteria: Optional[DistributionCustomWebhookCriteriaArgs] = None,
        description: Optional[str] = None,
        enabled: Optional[bool] = None,
        event_types: Optional[Sequence[str]] = None,
        handlers: Optional[Sequence[DistributionCustomWebhookHandlerArgs]] = None,
        key: Optional[str] = None) -> DistributionCustomWebhook
    func GetDistributionCustomWebhook(ctx *Context, name string, id IDInput, state *DistributionCustomWebhookState, opts ...ResourceOption) (*DistributionCustomWebhook, error)
    public static DistributionCustomWebhook Get(string name, Input<string> id, DistributionCustomWebhookState? state, CustomResourceOptions? opts = null)
    public static DistributionCustomWebhook get(String name, Output<String> id, DistributionCustomWebhookState 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:
    Criteria DistributionCustomWebhookCriteria
    Specifies where the webhook will be applied on which repositories.
    Description string
    Webhook description. Max length 1000 characters.
    Enabled bool
    Status of webhook. Default to true.
    EventTypes List<string>
    List of Events in Artifactory, Distribution, Release Bundle that function as the event trigger for the Webhook. Allow values: distribute_started, distribute_completed, distribute_aborted, distribute_failed, delete_started, delete_completed, delete_failed`
    Handlers List<DistributionCustomWebhookHandler>
    At least one is required.
    Key string
    The identity key of the webhook. Must be between 2 and 200 characters. Cannot contain spaces.
    Criteria DistributionCustomWebhookCriteriaArgs
    Specifies where the webhook will be applied on which repositories.
    Description string
    Webhook description. Max length 1000 characters.
    Enabled bool
    Status of webhook. Default to true.
    EventTypes []string
    List of Events in Artifactory, Distribution, Release Bundle that function as the event trigger for the Webhook. Allow values: distribute_started, distribute_completed, distribute_aborted, distribute_failed, delete_started, delete_completed, delete_failed`
    Handlers []DistributionCustomWebhookHandlerArgs
    At least one is required.
    Key string
    The identity key of the webhook. Must be between 2 and 200 characters. Cannot contain spaces.
    criteria DistributionCustomWebhookCriteria
    Specifies where the webhook will be applied on which repositories.
    description String
    Webhook description. Max length 1000 characters.
    enabled Boolean
    Status of webhook. Default to true.
    eventTypes List<String>
    List of Events in Artifactory, Distribution, Release Bundle that function as the event trigger for the Webhook. Allow values: distribute_started, distribute_completed, distribute_aborted, distribute_failed, delete_started, delete_completed, delete_failed`
    handlers List<DistributionCustomWebhookHandler>
    At least one is required.
    key String
    The identity key of the webhook. Must be between 2 and 200 characters. Cannot contain spaces.
    criteria DistributionCustomWebhookCriteria
    Specifies where the webhook will be applied on which repositories.
    description string
    Webhook description. Max length 1000 characters.
    enabled boolean
    Status of webhook. Default to true.
    eventTypes string[]
    List of Events in Artifactory, Distribution, Release Bundle that function as the event trigger for the Webhook. Allow values: distribute_started, distribute_completed, distribute_aborted, distribute_failed, delete_started, delete_completed, delete_failed`
    handlers DistributionCustomWebhookHandler[]
    At least one is required.
    key string
    The identity key of the webhook. Must be between 2 and 200 characters. Cannot contain spaces.
    criteria DistributionCustomWebhookCriteriaArgs
    Specifies where the webhook will be applied on which repositories.
    description str
    Webhook description. Max length 1000 characters.
    enabled bool
    Status of webhook. Default to true.
    event_types Sequence[str]
    List of Events in Artifactory, Distribution, Release Bundle that function as the event trigger for the Webhook. Allow values: distribute_started, distribute_completed, distribute_aborted, distribute_failed, delete_started, delete_completed, delete_failed`
    handlers Sequence[DistributionCustomWebhookHandlerArgs]
    At least one is required.
    key str
    The identity key of the webhook. Must be between 2 and 200 characters. Cannot contain spaces.
    criteria Property Map
    Specifies where the webhook will be applied on which repositories.
    description String
    Webhook description. Max length 1000 characters.
    enabled Boolean
    Status of webhook. Default to true.
    eventTypes List<String>
    List of Events in Artifactory, Distribution, Release Bundle that function as the event trigger for the Webhook. Allow values: distribute_started, distribute_completed, distribute_aborted, distribute_failed, delete_started, delete_completed, delete_failed`
    handlers List<Property Map>
    At least one is required.
    key String
    The identity key of the webhook. Must be between 2 and 200 characters. Cannot contain spaces.

    Supporting Types

    DistributionCustomWebhookCriteria, DistributionCustomWebhookCriteriaArgs

    AnyReleaseBundle bool
    Trigger on any release bundle.
    RegisteredReleaseBundleNames List<string>
    Trigger on this list of release bundle names.
    ExcludePatterns List<string>
    Simple comma separated wildcard patterns for repository artifact paths (with no leading slash). Ant-style path expressions are supported (*, **, ?). For example: org/apache/**.
    IncludePatterns List<string>
    Simple comma separated wildcard patterns for repository artifact paths (with no leading slash). Ant-style path expressions are supported (*, **, ?). For example: org/apache/**.
    AnyReleaseBundle bool
    Trigger on any release bundle.
    RegisteredReleaseBundleNames []string
    Trigger on this list of release bundle names.
    ExcludePatterns []string
    Simple comma separated wildcard patterns for repository artifact paths (with no leading slash). Ant-style path expressions are supported (*, **, ?). For example: org/apache/**.
    IncludePatterns []string
    Simple comma separated wildcard patterns for repository artifact paths (with no leading slash). Ant-style path expressions are supported (*, **, ?). For example: org/apache/**.
    anyReleaseBundle Boolean
    Trigger on any release bundle.
    registeredReleaseBundleNames List<String>
    Trigger on this list of release bundle names.
    excludePatterns List<String>
    Simple comma separated wildcard patterns for repository artifact paths (with no leading slash). Ant-style path expressions are supported (*, **, ?). For example: org/apache/**.
    includePatterns List<String>
    Simple comma separated wildcard patterns for repository artifact paths (with no leading slash). Ant-style path expressions are supported (*, **, ?). For example: org/apache/**.
    anyReleaseBundle boolean
    Trigger on any release bundle.
    registeredReleaseBundleNames string[]
    Trigger on this list of release bundle names.
    excludePatterns string[]
    Simple comma separated wildcard patterns for repository artifact paths (with no leading slash). Ant-style path expressions are supported (*, **, ?). For example: org/apache/**.
    includePatterns string[]
    Simple comma separated wildcard patterns for repository artifact paths (with no leading slash). Ant-style path expressions are supported (*, **, ?). For example: org/apache/**.
    any_release_bundle bool
    Trigger on any release bundle.
    registered_release_bundle_names Sequence[str]
    Trigger on this list of release bundle names.
    exclude_patterns Sequence[str]
    Simple comma separated wildcard patterns for repository artifact paths (with no leading slash). Ant-style path expressions are supported (*, **, ?). For example: org/apache/**.
    include_patterns Sequence[str]
    Simple comma separated wildcard patterns for repository artifact paths (with no leading slash). Ant-style path expressions are supported (*, **, ?). For example: org/apache/**.
    anyReleaseBundle Boolean
    Trigger on any release bundle.
    registeredReleaseBundleNames List<String>
    Trigger on this list of release bundle names.
    excludePatterns List<String>
    Simple comma separated wildcard patterns for repository artifact paths (with no leading slash). Ant-style path expressions are supported (*, **, ?). For example: org/apache/**.
    includePatterns List<String>
    Simple comma separated wildcard patterns for repository artifact paths (with no leading slash). Ant-style path expressions are supported (*, **, ?). For example: org/apache/**.

    DistributionCustomWebhookHandler, DistributionCustomWebhookHandlerArgs

    Url string
    Specifies the URL that the Webhook invokes. This will be the URL that Artifactory will send an HTTP POST request to.
    HttpHeaders Dictionary<string, string>
    HTTP headers you wish to use to invoke the Webhook, comprise key/value pair.
    Payload string
    This attribute is used to build the request body. Used in custom webhooks
    Proxy string
    Proxy key from Artifactory UI (Administration > Proxies > Configuration).
    Secrets Dictionary<string, string>
    Defines a set of sensitive values (such as, tokens and passwords) that can be injected in the headers and/or payload.Secrets’ values are encrypted. In the header/payload, the value can be invoked using the {{.secrets.token}} format, where token is the name provided for the secret value. Comprise key/value pair. Note: if multiple handlers are used, same secret name and different secret value for the same url won't work. Example:
    Url string
    Specifies the URL that the Webhook invokes. This will be the URL that Artifactory will send an HTTP POST request to.
    HttpHeaders map[string]string
    HTTP headers you wish to use to invoke the Webhook, comprise key/value pair.
    Payload string
    This attribute is used to build the request body. Used in custom webhooks
    Proxy string
    Proxy key from Artifactory UI (Administration > Proxies > Configuration).
    Secrets map[string]string
    Defines a set of sensitive values (such as, tokens and passwords) that can be injected in the headers and/or payload.Secrets’ values are encrypted. In the header/payload, the value can be invoked using the {{.secrets.token}} format, where token is the name provided for the secret value. Comprise key/value pair. Note: if multiple handlers are used, same secret name and different secret value for the same url won't work. Example:
    url String
    Specifies the URL that the Webhook invokes. This will be the URL that Artifactory will send an HTTP POST request to.
    httpHeaders Map<String,String>
    HTTP headers you wish to use to invoke the Webhook, comprise key/value pair.
    payload String
    This attribute is used to build the request body. Used in custom webhooks
    proxy String
    Proxy key from Artifactory UI (Administration > Proxies > Configuration).
    secrets Map<String,String>
    Defines a set of sensitive values (such as, tokens and passwords) that can be injected in the headers and/or payload.Secrets’ values are encrypted. In the header/payload, the value can be invoked using the {{.secrets.token}} format, where token is the name provided for the secret value. Comprise key/value pair. Note: if multiple handlers are used, same secret name and different secret value for the same url won't work. Example:
    url string
    Specifies the URL that the Webhook invokes. This will be the URL that Artifactory will send an HTTP POST request to.
    httpHeaders {[key: string]: string}
    HTTP headers you wish to use to invoke the Webhook, comprise key/value pair.
    payload string
    This attribute is used to build the request body. Used in custom webhooks
    proxy string
    Proxy key from Artifactory UI (Administration > Proxies > Configuration).
    secrets {[key: string]: string}
    Defines a set of sensitive values (such as, tokens and passwords) that can be injected in the headers and/or payload.Secrets’ values are encrypted. In the header/payload, the value can be invoked using the {{.secrets.token}} format, where token is the name provided for the secret value. Comprise key/value pair. Note: if multiple handlers are used, same secret name and different secret value for the same url won't work. Example:
    url str
    Specifies the URL that the Webhook invokes. This will be the URL that Artifactory will send an HTTP POST request to.
    http_headers Mapping[str, str]
    HTTP headers you wish to use to invoke the Webhook, comprise key/value pair.
    payload str
    This attribute is used to build the request body. Used in custom webhooks
    proxy str
    Proxy key from Artifactory UI (Administration > Proxies > Configuration).
    secrets Mapping[str, str]
    Defines a set of sensitive values (such as, tokens and passwords) that can be injected in the headers and/or payload.Secrets’ values are encrypted. In the header/payload, the value can be invoked using the {{.secrets.token}} format, where token is the name provided for the secret value. Comprise key/value pair. Note: if multiple handlers are used, same secret name and different secret value for the same url won't work. Example:
    url String
    Specifies the URL that the Webhook invokes. This will be the URL that Artifactory will send an HTTP POST request to.
    httpHeaders Map<String>
    HTTP headers you wish to use to invoke the Webhook, comprise key/value pair.
    payload String
    This attribute is used to build the request body. Used in custom webhooks
    proxy String
    Proxy key from Artifactory UI (Administration > Proxies > Configuration).
    secrets Map<String>
    Defines a set of sensitive values (such as, tokens and passwords) that can be injected in the headers and/or payload.Secrets’ values are encrypted. In the header/payload, the value can be invoked using the {{.secrets.token}} format, where token is the name provided for the secret value. Comprise key/value pair. Note: if multiple handlers are used, same secret name and different secret value for the same url won't work. Example:

    Package Details

    Repository
    artifactory pulumi/pulumi-artifactory
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the artifactory Terraform Provider.
    artifactory logo
    artifactory v8.4.0 published on Tuesday, Nov 19, 2024 by Pulumi
    pulumi/pulumi-artifactory