You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::CodePipeline::Types::WebhookDefinition

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/types.rb

Overview

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",
  },
}

Represents information about a webhook and its definition.

Instance Attribute Summary collapse

Instance Attribute Details

#authenticationString

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

Returns:

  • (String)


3886
3887
3888
3889
3890
3891
3892
3893
3894
# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/types.rb', line 3886

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

#authentication_configurationTypes::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 AllowedIPRangeproperty must be set to a valid CIDR range. For UNAUTHENTICATED, no properties can be set.



3886
3887
3888
3889
3890
3891
3892
3893
3894
# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/types.rb', line 3886

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

#filtersArray<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:



3886
3887
3888
3889
3890
3891
3892
3893
3894
# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/types.rb', line 3886

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

#nameString

The name of the webhook.

Returns:

  • (String)


3886
3887
3888
3889
3890
3891
3892
3893
3894
# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/types.rb', line 3886

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

#target_actionString

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)


3886
3887
3888
3889
3890
3891
3892
3893
3894
# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/types.rb', line 3886

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

#target_pipelineString

The name of the pipeline you want to connect to the webhook.

Returns:

  • (String)


3886
3887
3888
3889
3890
3891
3892
3893
3894
# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/types.rb', line 3886

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