/ 
Paws-0.46
River stage two • 9 direct dependents • 11 total dependents
/ Paws::CodePipeline::WebhookDefinition

NAME

Paws::CodePipeline::WebhookDefinition

USAGE

This class represents one of two things:

Arguments in a call to a service

Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. Each attribute should be used as a named argument in the calls that expect this type of object.

As an example, if Att1 is expected to be a Paws::CodePipeline::WebhookDefinition object:

$service_obj->Method(Att1 => { Authentication => $value, ..., TargetPipeline => $value  });

Results returned from an API call

Use accessors for each attribute. If Att1 is expected to be an Paws::CodePipeline::WebhookDefinition object:

$result = $service_obj->Method(...);
$result->Att1->Authentication

DESCRIPTION

Represents information about a webhook and its definition.

ATTRIBUTES

REQUIRED Authentication => Str

Supported options are GITHUB_HMAC, IP, and UNAUTHENTICATED.

  • For information about the authentication scheme implemented by GITHUB_HMAC, see Securing your webhooks (https://developer.github.com/webhooks/securing/) 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.

REQUIRED AuthenticationConfiguration => Paws::CodePipeline::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.

REQUIRED Filters => ArrayRef[Paws::CodePipeline::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.

REQUIRED Name => Str

The name of the webhook.

REQUIRED TargetAction => Str

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.

REQUIRED TargetPipeline => Str

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

SEE ALSO

This class forms part of Paws, describing an object used in Paws::CodePipeline

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues