« blib/lib/Paws/CodePipeline/PutThirdPartyJobSuccessResult.pm
↑ Summary
blib/lib/Paws/CodePipeline/PutWebhookOutput.pm »
| 1 | |||
| 2 | package Paws::CodePipeline::PutWebhook; | ||
| 3 | use Moose; | ||
| 4 | has Tags => (is => 'ro', isa => 'ArrayRef[Paws::CodePipeline::Tag]', traits => ['NameInRequest'], request_name => 'tags' ); | ||
| 5 | has Webhook => (is => 'ro', isa => 'Paws::CodePipeline::WebhookDefinition', traits => ['NameInRequest'], request_name => 'webhook' , required => 1); | ||
| 6 | |||
| 7 | use MooseX::ClassAttribute; | ||
| 8 | |||
| 9 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'PutWebhook'); | ||
| 10 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::CodePipeline::PutWebhookOutput'); | ||
| 11 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 12 | 1; | ||
| 13 | |||
| 14 | ### main pod documentation begin ### | ||
| 15 | |||
| 16 | =head1 NAME | ||
| 17 | |||
| 18 | Paws::CodePipeline::PutWebhook - Arguments for method PutWebhook on L<Paws::CodePipeline> | ||
| 19 | |||
| 20 | =head1 DESCRIPTION | ||
| 21 | |||
| 22 | This class represents the parameters used for calling the method PutWebhook on the | ||
| 23 | L<AWS CodePipeline|Paws::CodePipeline> service. Use the attributes of this class | ||
| 24 | as arguments to method PutWebhook. | ||
| 25 | |||
| 26 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to PutWebhook. | ||
| 27 | |||
| 28 | =head1 SYNOPSIS | ||
| 29 | |||
| 30 | my $codepipeline = Paws->service('CodePipeline'); | ||
| 31 | my $PutWebhookOutput = $codepipeline->PutWebhook( | ||
| 32 | Webhook => { | ||
| 33 | Authentication => | ||
| 34 | 'GITHUB_HMAC', # values: GITHUB_HMAC, IP, UNAUTHENTICATED | ||
| 35 | AuthenticationConfiguration => { | ||
| 36 | AllowedIPRange => 'MyWebhookAuthConfigurationAllowedIPRange' | ||
| 37 | , # min: 1, max: 100; OPTIONAL | ||
| 38 | SecretToken => 'MyWebhookAuthConfigurationSecretToken' | ||
| 39 | , # min: 1, max: 100; OPTIONAL | ||
| 40 | }, | ||
| 41 | Filters => [ | ||
| 42 | { | ||
| 43 | JsonPath => 'MyJsonPath', # min: 1, max: 150 | ||
| 44 | MatchEquals => 'MyMatchEquals', # min: 1, max: 150; OPTIONAL | ||
| 45 | }, | ||
| 46 | ... | ||
| 47 | ], # max: 5 | ||
| 48 | Name => 'MyWebhookName', # min: 1, max: 100 | ||
| 49 | TargetAction => 'MyActionName', # min: 1, max: 100 | ||
| 50 | TargetPipeline => 'MyPipelineName', # min: 1, max: 100 | ||
| 51 | |||
| 52 | }, | ||
| 53 | Tags => [ | ||
| 54 | { | ||
| 55 | Key => 'MyTagKey', # min: 1, max: 128 | ||
| 56 | Value => 'MyTagValue', # max: 256 | ||
| 57 | |||
| 58 | }, | ||
| 59 | ... | ||
| 60 | ], # OPTIONAL | ||
| 61 | ); | ||
| 62 | |||
| 63 | # Results: | ||
| 64 | my $Webhook = $PutWebhookOutput->Webhook; | ||
| 65 | |||
| 66 | # Returns a L<Paws::CodePipeline::PutWebhookOutput> object. | ||
| 67 | |||
| 68 | Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. | ||
| 69 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/codepipeline/PutWebhook> | ||
| 70 | |||
| 71 | =head1 ATTRIBUTES | ||
| 72 | |||
| 73 | |||
| 74 | =head2 Tags => ArrayRef[L<Paws::CodePipeline::Tag>] | ||
| 75 | |||
| 76 | The tags for the webhook. | ||
| 77 | |||
| 78 | |||
| 79 | |||
| 80 | =head2 B<REQUIRED> Webhook => L<Paws::CodePipeline::WebhookDefinition> | ||
| 81 | |||
| 82 | The detail provided in an input file to create the webhook, such as the | ||
| 83 | webhook name, the pipeline name, and the action name. Give the webhook | ||
| 84 | a unique name that helps you identify it. You might name the webhook | ||
| 85 | after the pipeline and action it targets so that you can easily | ||
| 86 | recognize what it's used for later. | ||
| 87 | |||
| 88 | |||
| 89 | |||
| 90 | |||
| 91 | =head1 SEE ALSO | ||
| 92 | |||
| 93 | This class forms part of L<Paws>, documenting arguments for method PutWebhook in L<Paws::CodePipeline> | ||
| 94 | |||
| 95 | =head1 BUGS and CONTRIBUTIONS | ||
| 96 | |||
| 97 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 98 | |||
| 99 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 100 | |||
| 101 | =cut | ||
| 102 |