class Aws::CodePipeline::Types::WebhookDefinition

Represents information about a webhook and its definition.

@note When making an API call, you may pass WebhookDefinition

data as a hash:

    {
      name: "WebhookName", # required
      target_pipeline: "PipelineName", # required
      target_action: "ActionName", # required
      filters: [ # required
        {
          json_path: "JsonPath", # required
          match_equals: "MatchEquals",
        },
      ],
      authentication: "GITHUB_HMAC", # required, accepts GITHUB_HMAC, IP, UNAUTHENTICATED
      authentication_configuration: { # required
        allowed_ip_range: "WebhookAuthConfigurationAllowedIPRange",
        secret_token: "WebhookAuthConfigurationSecretToken",
      },
    }

@!attribute [rw] name

The name of the webhook.
@return [String]

@!attribute [rw] target_pipeline

The name of the pipeline you want to connect to the webhook.
@return [String]

@!attribute [rw] target_action

The name of the action in a pipeline you want to connect to the
webhook. The action must be from the source (first) stage of the
pipeline.
@return [String]

@!attribute [rw] filters

A list of rules applied to the body/payload sent in the POST request
to a webhook URL. All defined rules must pass for the request to be
accepted and the pipeline started.
@return [Array<Types::WebhookFilterRule>]

@!attribute [rw] authentication

Supported options are GITHUB\_HMAC, IP, and UNAUTHENTICATED.

* For information about the authentication scheme implemented by
  GITHUB\_HMAC, see [Securing your webhooks][1] on the GitHub
  Developer website.

* IP rejects webhooks trigger requests unless they originate from an
  IP address in the IP range whitelisted in the authentication
  configuration.

* UNAUTHENTICATED accepts all webhook trigger requests regardless of
  origin.

[1]: https://developer.github.com/webhooks/securing/
@return [String]

@!attribute [rw] authentication_configuration

Properties that configure the authentication applied to incoming
webhook trigger requests. The required properties depend on the
authentication type. For GITHUB\_HMAC, only the `SecretToken
`property must be set. For IP, only the `AllowedIPRange `property
must be set to a valid CIDR range. For UNAUTHENTICATED, no
properties can be set.
@return [Types::WebhookAuthConfiguration]

@see docs.aws.amazon.com/goto/WebAPI/codepipeline-2015-07-09/WebhookDefinition AWS API Documentation

Constants

SENSITIVE