1. Packages
  2. Artifactory
  3. API Docs
  4. ArtifactPropertyWebhook
artifactory v6.8.4 published on Thursday, Jun 6, 2024 by Pulumi

artifactory.ArtifactPropertyWebhook

Explore with Pulumi AI

artifactory logo
artifactory v6.8.4 published on Thursday, Jun 6, 2024 by Pulumi

    Provides an Artifactory 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 my_generic_local = new artifactory.LocalGenericRepository("my-generic-local", {key: "my-generic-local"});
    const artifact_webhook = new artifactory.ArtifactPropertyWebhook("artifact-webhook", {
        key: "artifact-property-webhook",
        eventTypes: [
            "added",
            "deleted",
        ],
        criteria: {
            anyLocal: true,
            anyRemote: false,
            anyFederated: false,
            repoKeys: [my_generic_local.key],
            includePatterns: ["foo/**"],
            excludePatterns: ["bar/**"],
        },
        handlers: [{
            url: "http://tempurl.org/webhook",
            secret: "some-secret",
            proxy: "proxy-key",
            customHttpHeaders: {
                "header-1": "value-1",
                "header-2": "value-2",
            },
        }],
    }, {
        dependsOn: [my_generic_local],
    });
    
    import pulumi
    import pulumi_artifactory as artifactory
    
    my_generic_local = artifactory.LocalGenericRepository("my-generic-local", key="my-generic-local")
    artifact_webhook = artifactory.ArtifactPropertyWebhook("artifact-webhook",
        key="artifact-property-webhook",
        event_types=[
            "added",
            "deleted",
        ],
        criteria=artifactory.ArtifactPropertyWebhookCriteriaArgs(
            any_local=True,
            any_remote=False,
            any_federated=False,
            repo_keys=[my_generic_local.key],
            include_patterns=["foo/**"],
            exclude_patterns=["bar/**"],
        ),
        handlers=[artifactory.ArtifactPropertyWebhookHandlerArgs(
            url="http://tempurl.org/webhook",
            secret="some-secret",
            proxy="proxy-key",
            custom_http_headers={
                "header-1": "value-1",
                "header-2": "value-2",
            },
        )],
        opts=pulumi.ResourceOptions(depends_on=[my_generic_local]))
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-artifactory/sdk/v6/go/artifactory"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := artifactory.NewLocalGenericRepository(ctx, "my-generic-local", &artifactory.LocalGenericRepositoryArgs{
    			Key: pulumi.String("my-generic-local"),
    		})
    		if err != nil {
    			return err
    		}
    		_, err = artifactory.NewArtifactPropertyWebhook(ctx, "artifact-webhook", &artifactory.ArtifactPropertyWebhookArgs{
    			Key: pulumi.String("artifact-property-webhook"),
    			EventTypes: pulumi.StringArray{
    				pulumi.String("added"),
    				pulumi.String("deleted"),
    			},
    			Criteria: &artifactory.ArtifactPropertyWebhookCriteriaArgs{
    				AnyLocal:     pulumi.Bool(true),
    				AnyRemote:    pulumi.Bool(false),
    				AnyFederated: pulumi.Bool(false),
    				RepoKeys: pulumi.StringArray{
    					my_generic_local.Key,
    				},
    				IncludePatterns: pulumi.StringArray{
    					pulumi.String("foo/**"),
    				},
    				ExcludePatterns: pulumi.StringArray{
    					pulumi.String("bar/**"),
    				},
    			},
    			Handlers: artifactory.ArtifactPropertyWebhookHandlerArray{
    				&artifactory.ArtifactPropertyWebhookHandlerArgs{
    					Url:    pulumi.String("http://tempurl.org/webhook"),
    					Secret: pulumi.String("some-secret"),
    					Proxy:  pulumi.String("proxy-key"),
    					CustomHttpHeaders: pulumi.StringMap{
    						"header-1": pulumi.String("value-1"),
    						"header-2": pulumi.String("value-2"),
    					},
    				},
    			},
    		}, pulumi.DependsOn([]pulumi.Resource{
    			my_generic_local,
    		}))
    		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 my_generic_local = new Artifactory.LocalGenericRepository("my-generic-local", new()
        {
            Key = "my-generic-local",
        });
    
        var artifact_webhook = new Artifactory.ArtifactPropertyWebhook("artifact-webhook", new()
        {
            Key = "artifact-property-webhook",
            EventTypes = new[]
            {
                "added",
                "deleted",
            },
            Criteria = new Artifactory.Inputs.ArtifactPropertyWebhookCriteriaArgs
            {
                AnyLocal = true,
                AnyRemote = false,
                AnyFederated = false,
                RepoKeys = new[]
                {
                    my_generic_local.Key,
                },
                IncludePatterns = new[]
                {
                    "foo/**",
                },
                ExcludePatterns = new[]
                {
                    "bar/**",
                },
            },
            Handlers = new[]
            {
                new Artifactory.Inputs.ArtifactPropertyWebhookHandlerArgs
                {
                    Url = "http://tempurl.org/webhook",
                    Secret = "some-secret",
                    Proxy = "proxy-key",
                    CustomHttpHeaders = 
                    {
                        { "header-1", "value-1" },
                        { "header-2", "value-2" },
                    },
                },
            },
        }, new CustomResourceOptions
        {
            DependsOn =
            {
                my_generic_local,
            },
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.artifactory.LocalGenericRepository;
    import com.pulumi.artifactory.LocalGenericRepositoryArgs;
    import com.pulumi.artifactory.ArtifactPropertyWebhook;
    import com.pulumi.artifactory.ArtifactPropertyWebhookArgs;
    import com.pulumi.artifactory.inputs.ArtifactPropertyWebhookCriteriaArgs;
    import com.pulumi.artifactory.inputs.ArtifactPropertyWebhookHandlerArgs;
    import com.pulumi.resources.CustomResourceOptions;
    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 my_generic_local = new LocalGenericRepository("my-generic-local", LocalGenericRepositoryArgs.builder()
                .key("my-generic-local")
                .build());
    
            var artifact_webhook = new ArtifactPropertyWebhook("artifact-webhook", ArtifactPropertyWebhookArgs.builder()
                .key("artifact-property-webhook")
                .eventTypes(            
                    "added",
                    "deleted")
                .criteria(ArtifactPropertyWebhookCriteriaArgs.builder()
                    .anyLocal(true)
                    .anyRemote(false)
                    .anyFederated(false)
                    .repoKeys(my_generic_local.key())
                    .includePatterns("foo/**")
                    .excludePatterns("bar/**")
                    .build())
                .handlers(ArtifactPropertyWebhookHandlerArgs.builder()
                    .url("http://tempurl.org/webhook")
                    .secret("some-secret")
                    .proxy("proxy-key")
                    .customHttpHeaders(Map.ofEntries(
                        Map.entry("header-1", "value-1"),
                        Map.entry("header-2", "value-2")
                    ))
                    .build())
                .build(), CustomResourceOptions.builder()
                    .dependsOn(my_generic_local)
                    .build());
    
        }
    }
    
    resources:
      my-generic-local:
        type: artifactory:LocalGenericRepository
        properties:
          key: my-generic-local
      artifact-webhook:
        type: artifactory:ArtifactPropertyWebhook
        properties:
          key: artifact-property-webhook
          eventTypes:
            - added
            - deleted
          criteria:
            anyLocal: true
            anyRemote: false
            anyFederated: false
            repoKeys:
              - ${["my-generic-local"].key}
            includePatterns:
              - foo/**
            excludePatterns:
              - bar/**
          handlers:
            - url: http://tempurl.org/webhook
              secret: some-secret
              proxy: proxy-key
              customHttpHeaders:
                header-1: value-1
                header-2: value-2
        options:
          dependson:
            - ${["my-generic-local"]}
    

    Create ArtifactPropertyWebhook Resource

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

    Constructor syntax

    new ArtifactPropertyWebhook(name: string, args: ArtifactPropertyWebhookArgs, opts?: CustomResourceOptions);
    @overload
    def ArtifactPropertyWebhook(resource_name: str,
                                args: ArtifactPropertyWebhookArgs,
                                opts: Optional[ResourceOptions] = None)
    
    @overload
    def ArtifactPropertyWebhook(resource_name: str,
                                opts: Optional[ResourceOptions] = None,
                                criteria: Optional[ArtifactPropertyWebhookCriteriaArgs] = None,
                                event_types: Optional[Sequence[str]] = None,
                                handlers: Optional[Sequence[ArtifactPropertyWebhookHandlerArgs]] = None,
                                key: Optional[str] = None,
                                description: Optional[str] = None,
                                enabled: Optional[bool] = None)
    func NewArtifactPropertyWebhook(ctx *Context, name string, args ArtifactPropertyWebhookArgs, opts ...ResourceOption) (*ArtifactPropertyWebhook, error)
    public ArtifactPropertyWebhook(string name, ArtifactPropertyWebhookArgs args, CustomResourceOptions? opts = null)
    public ArtifactPropertyWebhook(String name, ArtifactPropertyWebhookArgs args)
    public ArtifactPropertyWebhook(String name, ArtifactPropertyWebhookArgs args, CustomResourceOptions options)
    
    type: artifactory:ArtifactPropertyWebhook
    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 ArtifactPropertyWebhookArgs
    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 ArtifactPropertyWebhookArgs
    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 ArtifactPropertyWebhookArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ArtifactPropertyWebhookArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ArtifactPropertyWebhookArgs
    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 artifactPropertyWebhookResource = new Artifactory.ArtifactPropertyWebhook("artifactPropertyWebhookResource", new()
    {
        Criteria = new Artifactory.Inputs.ArtifactPropertyWebhookCriteriaArgs
        {
            AnyFederated = false,
            AnyLocal = false,
            AnyRemote = false,
            RepoKeys = new[]
            {
                "string",
            },
            ExcludePatterns = new[]
            {
                "string",
            },
            IncludePatterns = new[]
            {
                "string",
            },
        },
        EventTypes = new[]
        {
            "string",
        },
        Handlers = new[]
        {
            new Artifactory.Inputs.ArtifactPropertyWebhookHandlerArgs
            {
                Url = "string",
                CustomHttpHeaders = 
                {
                    { "string", "string" },
                },
                Proxy = "string",
                Secret = "string",
                UseSecretForSigning = false,
            },
        },
        Key = "string",
        Description = "string",
        Enabled = false,
    });
    
    example, err := artifactory.NewArtifactPropertyWebhook(ctx, "artifactPropertyWebhookResource", &artifactory.ArtifactPropertyWebhookArgs{
    	Criteria: &artifactory.ArtifactPropertyWebhookCriteriaArgs{
    		AnyFederated: pulumi.Bool(false),
    		AnyLocal:     pulumi.Bool(false),
    		AnyRemote:    pulumi.Bool(false),
    		RepoKeys: pulumi.StringArray{
    			pulumi.String("string"),
    		},
    		ExcludePatterns: pulumi.StringArray{
    			pulumi.String("string"),
    		},
    		IncludePatterns: pulumi.StringArray{
    			pulumi.String("string"),
    		},
    	},
    	EventTypes: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	Handlers: artifactory.ArtifactPropertyWebhookHandlerArray{
    		&artifactory.ArtifactPropertyWebhookHandlerArgs{
    			Url: pulumi.String("string"),
    			CustomHttpHeaders: pulumi.StringMap{
    				"string": pulumi.String("string"),
    			},
    			Proxy:               pulumi.String("string"),
    			Secret:              pulumi.String("string"),
    			UseSecretForSigning: pulumi.Bool(false),
    		},
    	},
    	Key:         pulumi.String("string"),
    	Description: pulumi.String("string"),
    	Enabled:     pulumi.Bool(false),
    })
    
    var artifactPropertyWebhookResource = new ArtifactPropertyWebhook("artifactPropertyWebhookResource", ArtifactPropertyWebhookArgs.builder()
        .criteria(ArtifactPropertyWebhookCriteriaArgs.builder()
            .anyFederated(false)
            .anyLocal(false)
            .anyRemote(false)
            .repoKeys("string")
            .excludePatterns("string")
            .includePatterns("string")
            .build())
        .eventTypes("string")
        .handlers(ArtifactPropertyWebhookHandlerArgs.builder()
            .url("string")
            .customHttpHeaders(Map.of("string", "string"))
            .proxy("string")
            .secret("string")
            .useSecretForSigning(false)
            .build())
        .key("string")
        .description("string")
        .enabled(false)
        .build());
    
    artifact_property_webhook_resource = artifactory.ArtifactPropertyWebhook("artifactPropertyWebhookResource",
        criteria=artifactory.ArtifactPropertyWebhookCriteriaArgs(
            any_federated=False,
            any_local=False,
            any_remote=False,
            repo_keys=["string"],
            exclude_patterns=["string"],
            include_patterns=["string"],
        ),
        event_types=["string"],
        handlers=[artifactory.ArtifactPropertyWebhookHandlerArgs(
            url="string",
            custom_http_headers={
                "string": "string",
            },
            proxy="string",
            secret="string",
            use_secret_for_signing=False,
        )],
        key="string",
        description="string",
        enabled=False)
    
    const artifactPropertyWebhookResource = new artifactory.ArtifactPropertyWebhook("artifactPropertyWebhookResource", {
        criteria: {
            anyFederated: false,
            anyLocal: false,
            anyRemote: false,
            repoKeys: ["string"],
            excludePatterns: ["string"],
            includePatterns: ["string"],
        },
        eventTypes: ["string"],
        handlers: [{
            url: "string",
            customHttpHeaders: {
                string: "string",
            },
            proxy: "string",
            secret: "string",
            useSecretForSigning: false,
        }],
        key: "string",
        description: "string",
        enabled: false,
    });
    
    type: artifactory:ArtifactPropertyWebhook
    properties:
        criteria:
            anyFederated: false
            anyLocal: false
            anyRemote: false
            excludePatterns:
                - string
            includePatterns:
                - string
            repoKeys:
                - string
        description: string
        enabled: false
        eventTypes:
            - string
        handlers:
            - customHttpHeaders:
                string: string
              proxy: string
              secret: string
              url: string
              useSecretForSigning: false
        key: string
    

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

    Criteria ArtifactPropertyWebhookCriteria
    Specifies where the webhook will be applied on which repositories.
    EventTypes List<string>
    List of Events in Artifactory, Distribution, Release Bundle that function as the event trigger for the Webhook. Allow values: added, deleted.
    Handlers List<ArtifactPropertyWebhookHandler>
    At least one is required.
    Key string
    The identity key of the webhook. Must be between 2 and 200 characters. Cannot contain spaces.
    Description string
    Webhook description. Max length 1000 characters.
    Enabled bool
    Status of webhook. Default to true.
    Criteria ArtifactPropertyWebhookCriteriaArgs
    Specifies where the webhook will be applied on which repositories.
    EventTypes []string
    List of Events in Artifactory, Distribution, Release Bundle that function as the event trigger for the Webhook. Allow values: added, deleted.
    Handlers []ArtifactPropertyWebhookHandlerArgs
    At least one is required.
    Key string
    The identity key of the webhook. Must be between 2 and 200 characters. Cannot contain spaces.
    Description string
    Webhook description. Max length 1000 characters.
    Enabled bool
    Status of webhook. Default to true.
    criteria ArtifactPropertyWebhookCriteria
    Specifies where the webhook will be applied on which repositories.
    eventTypes List<String>
    List of Events in Artifactory, Distribution, Release Bundle that function as the event trigger for the Webhook. Allow values: added, deleted.
    handlers List<ArtifactPropertyWebhookHandler>
    At least one is required.
    key String
    The identity key of the webhook. Must be between 2 and 200 characters. Cannot contain spaces.
    description String
    Webhook description. Max length 1000 characters.
    enabled Boolean
    Status of webhook. Default to true.
    criteria ArtifactPropertyWebhookCriteria
    Specifies where the webhook will be applied on which repositories.
    eventTypes string[]
    List of Events in Artifactory, Distribution, Release Bundle that function as the event trigger for the Webhook. Allow values: added, deleted.
    handlers ArtifactPropertyWebhookHandler[]
    At least one is required.
    key string
    The identity key of the webhook. Must be between 2 and 200 characters. Cannot contain spaces.
    description string
    Webhook description. Max length 1000 characters.
    enabled boolean
    Status of webhook. Default to true.
    criteria ArtifactPropertyWebhookCriteriaArgs
    Specifies where the webhook will be applied on which repositories.
    event_types Sequence[str]
    List of Events in Artifactory, Distribution, Release Bundle that function as the event trigger for the Webhook. Allow values: added, deleted.
    handlers Sequence[ArtifactPropertyWebhookHandlerArgs]
    At least one is required.
    key str
    The identity key of the webhook. Must be between 2 and 200 characters. Cannot contain spaces.
    description str
    Webhook description. Max length 1000 characters.
    enabled bool
    Status of webhook. Default to true.
    criteria Property Map
    Specifies where the webhook will be applied on which repositories.
    eventTypes List<String>
    List of Events in Artifactory, Distribution, Release Bundle that function as the event trigger for the Webhook. Allow values: added, deleted.
    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.
    description String
    Webhook description. Max length 1000 characters.
    enabled Boolean
    Status of webhook. Default to true.

    Outputs

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

    Get an existing ArtifactPropertyWebhook 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?: ArtifactPropertyWebhookState, opts?: CustomResourceOptions): ArtifactPropertyWebhook
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            criteria: Optional[ArtifactPropertyWebhookCriteriaArgs] = None,
            description: Optional[str] = None,
            enabled: Optional[bool] = None,
            event_types: Optional[Sequence[str]] = None,
            handlers: Optional[Sequence[ArtifactPropertyWebhookHandlerArgs]] = None,
            key: Optional[str] = None) -> ArtifactPropertyWebhook
    func GetArtifactPropertyWebhook(ctx *Context, name string, id IDInput, state *ArtifactPropertyWebhookState, opts ...ResourceOption) (*ArtifactPropertyWebhook, error)
    public static ArtifactPropertyWebhook Get(string name, Input<string> id, ArtifactPropertyWebhookState? state, CustomResourceOptions? opts = null)
    public static ArtifactPropertyWebhook get(String name, Output<String> id, ArtifactPropertyWebhookState 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 ArtifactPropertyWebhookCriteria
    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: added, deleted.
    Handlers List<ArtifactPropertyWebhookHandler>
    At least one is required.
    Key string
    The identity key of the webhook. Must be between 2 and 200 characters. Cannot contain spaces.
    Criteria ArtifactPropertyWebhookCriteriaArgs
    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: added, deleted.
    Handlers []ArtifactPropertyWebhookHandlerArgs
    At least one is required.
    Key string
    The identity key of the webhook. Must be between 2 and 200 characters. Cannot contain spaces.
    criteria ArtifactPropertyWebhookCriteria
    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: added, deleted.
    handlers List<ArtifactPropertyWebhookHandler>
    At least one is required.
    key String
    The identity key of the webhook. Must be between 2 and 200 characters. Cannot contain spaces.
    criteria ArtifactPropertyWebhookCriteria
    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: added, deleted.
    handlers ArtifactPropertyWebhookHandler[]
    At least one is required.
    key string
    The identity key of the webhook. Must be between 2 and 200 characters. Cannot contain spaces.
    criteria ArtifactPropertyWebhookCriteriaArgs
    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: added, deleted.
    handlers Sequence[ArtifactPropertyWebhookHandlerArgs]
    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: added, deleted.
    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

    ArtifactPropertyWebhookCriteria, ArtifactPropertyWebhookCriteriaArgs

    AnyFederated bool
    Trigger on any federated repo.
    AnyLocal bool
    Trigger on any local repo.
    AnyRemote bool
    Trigger on any remote repo.
    RepoKeys List<string>
    Trigger on this list of repo keys.
    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/**.
    AnyFederated bool
    Trigger on any federated repo.
    AnyLocal bool
    Trigger on any local repo.
    AnyRemote bool
    Trigger on any remote repo.
    RepoKeys []string
    Trigger on this list of repo keys.
    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/**.
    anyFederated Boolean
    Trigger on any federated repo.
    anyLocal Boolean
    Trigger on any local repo.
    anyRemote Boolean
    Trigger on any remote repo.
    repoKeys List<String>
    Trigger on this list of repo keys.
    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/**.
    anyFederated boolean
    Trigger on any federated repo.
    anyLocal boolean
    Trigger on any local repo.
    anyRemote boolean
    Trigger on any remote repo.
    repoKeys string[]
    Trigger on this list of repo keys.
    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_federated bool
    Trigger on any federated repo.
    any_local bool
    Trigger on any local repo.
    any_remote bool
    Trigger on any remote repo.
    repo_keys Sequence[str]
    Trigger on this list of repo keys.
    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/**.
    anyFederated Boolean
    Trigger on any federated repo.
    anyLocal Boolean
    Trigger on any local repo.
    anyRemote Boolean
    Trigger on any remote repo.
    repoKeys List<String>
    Trigger on this list of repo keys.
    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/**.

    ArtifactPropertyWebhookHandler, ArtifactPropertyWebhookHandlerArgs

    Url string
    Specifies the URL that the Webhook invokes. This will be the URL that Artifactory will send an HTTP POST request to.
    CustomHttpHeaders Dictionary<string, string>
    Custom HTTP headers you wish to use to invoke the Webhook, comprise of key/value pair.
    Proxy string
    Proxy key from Artifactory UI (Administration > Proxies > Configuration).
    Secret string
    Secret authentication token that will be sent to the configured URL. The value will be sent as x-jfrog-event-auth header.
    UseSecretForSigning bool
    When set to true, the secret will be used to sign the event payload, allowing the target to validate that the payload content has not been changed and will not be passed as part of the event. If left unset or set to false, the secret is passed through the X-JFrog-Event-Auth HTTP header.
    Url string
    Specifies the URL that the Webhook invokes. This will be the URL that Artifactory will send an HTTP POST request to.
    CustomHttpHeaders map[string]string
    Custom HTTP headers you wish to use to invoke the Webhook, comprise of key/value pair.
    Proxy string
    Proxy key from Artifactory UI (Administration > Proxies > Configuration).
    Secret string
    Secret authentication token that will be sent to the configured URL. The value will be sent as x-jfrog-event-auth header.
    UseSecretForSigning bool
    When set to true, the secret will be used to sign the event payload, allowing the target to validate that the payload content has not been changed and will not be passed as part of the event. If left unset or set to false, the secret is passed through the X-JFrog-Event-Auth HTTP header.
    url String
    Specifies the URL that the Webhook invokes. This will be the URL that Artifactory will send an HTTP POST request to.
    customHttpHeaders Map<String,String>
    Custom HTTP headers you wish to use to invoke the Webhook, comprise of key/value pair.
    proxy String
    Proxy key from Artifactory UI (Administration > Proxies > Configuration).
    secret String
    Secret authentication token that will be sent to the configured URL. The value will be sent as x-jfrog-event-auth header.
    useSecretForSigning Boolean
    When set to true, the secret will be used to sign the event payload, allowing the target to validate that the payload content has not been changed and will not be passed as part of the event. If left unset or set to false, the secret is passed through the X-JFrog-Event-Auth HTTP header.
    url string
    Specifies the URL that the Webhook invokes. This will be the URL that Artifactory will send an HTTP POST request to.
    customHttpHeaders {[key: string]: string}
    Custom HTTP headers you wish to use to invoke the Webhook, comprise of key/value pair.
    proxy string
    Proxy key from Artifactory UI (Administration > Proxies > Configuration).
    secret string
    Secret authentication token that will be sent to the configured URL. The value will be sent as x-jfrog-event-auth header.
    useSecretForSigning boolean
    When set to true, the secret will be used to sign the event payload, allowing the target to validate that the payload content has not been changed and will not be passed as part of the event. If left unset or set to false, the secret is passed through the X-JFrog-Event-Auth HTTP header.
    url str
    Specifies the URL that the Webhook invokes. This will be the URL that Artifactory will send an HTTP POST request to.
    custom_http_headers Mapping[str, str]
    Custom HTTP headers you wish to use to invoke the Webhook, comprise of key/value pair.
    proxy str
    Proxy key from Artifactory UI (Administration > Proxies > Configuration).
    secret str
    Secret authentication token that will be sent to the configured URL. The value will be sent as x-jfrog-event-auth header.
    use_secret_for_signing bool
    When set to true, the secret will be used to sign the event payload, allowing the target to validate that the payload content has not been changed and will not be passed as part of the event. If left unset or set to false, the secret is passed through the X-JFrog-Event-Auth HTTP header.
    url String
    Specifies the URL that the Webhook invokes. This will be the URL that Artifactory will send an HTTP POST request to.
    customHttpHeaders Map<String>
    Custom HTTP headers you wish to use to invoke the Webhook, comprise of key/value pair.
    proxy String
    Proxy key from Artifactory UI (Administration > Proxies > Configuration).
    secret String
    Secret authentication token that will be sent to the configured URL. The value will be sent as x-jfrog-event-auth header.
    useSecretForSigning Boolean
    When set to true, the secret will be used to sign the event payload, allowing the target to validate that the payload content has not been changed and will not be passed as part of the event. If left unset or set to false, the secret is passed through the X-JFrog-Event-Auth HTTP header.

    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 v6.8.4 published on Thursday, Jun 6, 2024 by Pulumi