You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::CodePipeline::Types::WebhookDefinitionWhen passing WebhookDefinition as input to an Aws::Client method, you can use a vanilla Hash:
{
name: "WebhookName", target_pipeline: "PipelineName", target_action: "ActionName", filters: [ {
json_path: "JsonPath", match_equals: "MatchEquals",
},
],
authentication: "GITHUB_HMAC", authentication_configuration: { allowed_ip_range: "WebhookAuthConfigurationAllowedIPRange",
secret_token: "WebhookAuthConfigurationSecretToken",
},
}
Represents information about a webhook and its definition.
Returned by:
Instance Attribute Summary collapseSupported options are GITHUB_HMAC, IP, and UNAUTHENTICATED.
Properties that configure the authentication applied to incoming webhook trigger requests.
A list of rules applied to the body/payload sent in the POST request to a webhook URL.
The name of the webhook.
The name of the action in a pipeline you want to connect to the webhook.
The name of the pipeline you want to connect to the webhook.
Supported options are GITHUB_HMAC, IP, and UNAUTHENTICATED.
For information about the authentication scheme implemented by GITHUB_HMAC, see Securing your webhooks 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.
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.
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.
#target_action ⇒ StringThe 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.
#target_pipeline ⇒ StringThe name of the pipeline you want to connect to the webhook.
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4