Class: Aws::CodePipeline::Types::WebhookDefinition
- Inherits:
-
Struct
- Object
- Struct
- Aws::CodePipeline::Types::WebhookDefinition
- Includes:
- Structure
- Defined in:
- lib/aws-sdk-codepipeline/types.rb
Overview
Represents information about a webhook and its definition.
Constant Summary collapse
- SENSITIVE =
[]
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.
-
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.
4567 4568 4569 4570 4571 4572 4573 4574 4575 4576 |
# File 'lib/aws-sdk-codepipeline/types.rb', line 4567 class WebhookDefinition < Struct.new( :name, :target_pipeline, :target_action, :filters, :authentication, :authentication_configuration) SENSITIVE = [] 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.
4567 4568 4569 4570 4571 4572 4573 4574 4575 4576 |
# File 'lib/aws-sdk-codepipeline/types.rb', line 4567 class WebhookDefinition < Struct.new( :name, :target_pipeline, :target_action, :filters, :authentication, :authentication_configuration) SENSITIVE = [] 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.
4567 4568 4569 4570 4571 4572 4573 4574 4575 4576 |
# File 'lib/aws-sdk-codepipeline/types.rb', line 4567 class WebhookDefinition < Struct.new( :name, :target_pipeline, :target_action, :filters, :authentication, :authentication_configuration) SENSITIVE = [] include Aws::Structure end |
#name ⇒ String
The name of the webhook.
4567 4568 4569 4570 4571 4572 4573 4574 4575 4576 |
# File 'lib/aws-sdk-codepipeline/types.rb', line 4567 class WebhookDefinition < Struct.new( :name, :target_pipeline, :target_action, :filters, :authentication, :authentication_configuration) SENSITIVE = [] 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.
4567 4568 4569 4570 4571 4572 4573 4574 4575 4576 |
# File 'lib/aws-sdk-codepipeline/types.rb', line 4567 class WebhookDefinition < Struct.new( :name, :target_pipeline, :target_action, :filters, :authentication, :authentication_configuration) SENSITIVE = [] include Aws::Structure end |
#target_pipeline ⇒ String
The name of the pipeline you want to connect to the webhook.
4567 4568 4569 4570 4571 4572 4573 4574 4575 4576 |
# File 'lib/aws-sdk-codepipeline/types.rb', line 4567 class WebhookDefinition < Struct.new( :name, :target_pipeline, :target_action, :filters, :authentication, :authentication_configuration) SENSITIVE = [] include Aws::Structure end |