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

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

Inherits:

Struct

Object
Struct
Aws::CodePipeline::Types::PutWebhookInput

show all

Defined in:: (unknown)

Overview

Note:

When passing PutWebhookInput as input to an Aws::Client method, you can use a vanilla 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

#tags ⇒ Array<Types::Tag>
The tags for the webhook.
#webhook ⇒ Types::WebhookDefinition
The detail provided in an input file to create the webhook, such as the webhook name, the pipeline name, and the action name.

Instance Attribute Details

#tags ⇒ `Array<Types::Tag>`

The tags for the webhook.

Returns:

(Array<Types::Tag>) —
The tags for the webhook.

#webhook ⇒ `Types::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 that helps you identify it. You might name the webhook after the pipeline and action it targets so that you can easily recognize what it\'s used for later.