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

Class: Aws::CodePipeline::Types::PutWebhookInput

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 PutWebhookInput data as a hash:

{
  webhook: { # required
    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",
    },
  },
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
}

Instance Attribute Summary collapse

Instance Attribute Details

#tagsArray<Types::Tag>

The tags for the webhook.

Returns:



3109
3110
3111
3112
3113
# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/types.rb', line 3109

class PutWebhookInput < Struct.new(
  :webhook,
  :tags)
  include Aws::Structure
end

#webhookTypes::WebhookDefinition

The detail provided in an input file to create the webhook, such as the webhook name, the pipeline name, and the action name. Give the webhook a unique name which identifies the webhook being defined. You may choose to name the webhook after the pipeline and action it targets so that you can easily recognize what it's used for later.



3109
3110
3111
3112
3113
# File 'gems/aws-sdk-codepipeline/lib/aws-sdk-codepipeline/types.rb', line 3109

class PutWebhookInput < Struct.new(
  :webhook,
  :tags)
  include Aws::Structure
end