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.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #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.

When creating CodePipeline webhooks, do not use your own credentials or reuse the same secret token across multiple webhooks. For optimal security, generate a unique secret token for each webhook you create. The secret token is an arbitrary string that you provide, which GitHub uses to compute and sign the webhook payloads sent to CodePipeline, for protecting the integrity and authenticity of the webhook payloads. Using your own credentials or reusing the same token across multiple webhooks can lead to security vulnerabilities.

<note markdown=“1”> If a secret token was provided, it will be redacted in the response.

</note>

• 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.

[1]: developer.github.com/webhooks/securing/

Returns:

• (String)

# File 'lib/aws-sdk-codepipeline/types.rb', line 5719

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.

Returns:

• (Types::WebhookAuthConfiguration)

# File 'lib/aws-sdk-codepipeline/types.rb', line 5719

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.

Returns:

• (Array<Types::WebhookFilterRule>)

# File 'lib/aws-sdk-codepipeline/types.rb', line 5719

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.

Returns:

• (String)

# File 'lib/aws-sdk-codepipeline/types.rb', line 5719

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.

Returns:

• (String)

# File 'lib/aws-sdk-codepipeline/types.rb', line 5719

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.

Returns:

• (String)

# File 'lib/aws-sdk-codepipeline/types.rb', line 5719

class WebhookDefinition < Struct.new(
  :name,
  :target_pipeline,
  :target_action,
  :filters,
  :authentication,
  :authentication_configuration)
  SENSITIVE = []
  include Aws::Structure
end