Class: Aws::CodePipeline::Types::WebhookDefinition
- Inherits:
-
Struct
- Object
- Struct
- Aws::CodePipeline::Types::WebhookDefinition
- Includes:
- Structure
- Defined in:
- lib/aws-sdk-codepipeline/types.rb
Overview
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",
},
}
Represents information about a webhook and its definition.
Instance Attribute Summary collapse
-
#authentication ⇒ String
Supported options are GITHUB_HMAC, IP and UNAUTHENTICATED.
-
#authentication_configuration ⇒ Types::WebhookAuthConfiguration
Properties that configure the authentication applied to incoming webhook trigger requests.
-
#filters ⇒ Array<Types::WebhookFilterRule>
A list of rules applied to the body/payload sent in the POST request to a webhook URL.
-
#name ⇒ String
The name of the webhook.
-
#target_action ⇒ String
The name of the action in a pipeline you want to connect to the webhook.
-
#target_pipeline ⇒ String
The name of the pipeline you want to connect to the webhook.
Instance Attribute Details
#authentication ⇒ String
Supported options are GITHUB_HMAC, IP and UNAUTHENTICATED.
-
GITHUB_HMAC implements the authentication scheme described here: developer.github.com/webhooks/securing/
-
IP will reject webhooks trigger requests unless they originate from an IP within the IP range whitelisted in the authentication configuration.
-
UNAUTHENTICATED will accept all webhook trigger requests regardless of origin.
3334 3335 3336 3337 3338 3339 3340 3341 3342 |
# File 'lib/aws-sdk-codepipeline/types.rb', line 3334 class WebhookDefinition < Struct.new( :name, :target_pipeline, :target_action, :filters, :authentication, :authentication_configuration) include Aws::Structure end |
#authentication_configuration ⇒ Types::WebhookAuthConfiguration
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.
3334 3335 3336 3337 3338 3339 3340 3341 3342 |
# File 'lib/aws-sdk-codepipeline/types.rb', line 3334 class WebhookDefinition < Struct.new( :name, :target_pipeline, :target_action, :filters, :authentication, :authentication_configuration) include Aws::Structure end |
#filters ⇒ Array<Types::WebhookFilterRule>
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.
3334 3335 3336 3337 3338 3339 3340 3341 3342 |
# File 'lib/aws-sdk-codepipeline/types.rb', line 3334 class WebhookDefinition < Struct.new( :name, :target_pipeline, :target_action, :filters, :authentication, :authentication_configuration) include Aws::Structure end |
#name ⇒ String
The name of the webhook.
3334 3335 3336 3337 3338 3339 3340 3341 3342 |
# File 'lib/aws-sdk-codepipeline/types.rb', line 3334 class WebhookDefinition < Struct.new( :name, :target_pipeline, :target_action, :filters, :authentication, :authentication_configuration) include Aws::Structure end |
#target_action ⇒ String
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.
3334 3335 3336 3337 3338 3339 3340 3341 3342 |
# File 'lib/aws-sdk-codepipeline/types.rb', line 3334 class WebhookDefinition < Struct.new( :name, :target_pipeline, :target_action, :filters, :authentication, :authentication_configuration) include Aws::Structure end |
#target_pipeline ⇒ String
The name of the pipeline you want to connect to the webhook.
3334 3335 3336 3337 3338 3339 3340 3341 3342 |
# File 'lib/aws-sdk-codepipeline/types.rb', line 3334 class WebhookDefinition < Struct.new( :name, :target_pipeline, :target_action, :filters, :authentication, :authentication_configuration) include Aws::Structure end |