« blib/lib/Paws/CodeCommit/CreatePullRequest.pm
↑ Summary
blib/lib/Paws/CodeCommit/CreatePullRequestApprovalRuleOutput.pm »
| 1 | |||
| 2 | package Paws::CodeCommit::CreatePullRequestApprovalRule; | ||
| 3 | use Moose; | ||
| 4 | has ApprovalRuleContent => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'approvalRuleContent' , required => 1); | ||
| 5 | has ApprovalRuleName => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'approvalRuleName' , required => 1); | ||
| 6 | has PullRequestId => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'pullRequestId' , required => 1); | ||
| 7 | |||
| 8 | use MooseX::ClassAttribute; | ||
| 9 | |||
| 10 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreatePullRequestApprovalRule'); | ||
| 11 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::CodeCommit::CreatePullRequestApprovalRuleOutput'); | ||
| 12 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 13 | 1; | ||
| 14 | |||
| 15 | ### main pod documentation begin ### | ||
| 16 | |||
| 17 | =head1 NAME | ||
| 18 | |||
| 19 | Paws::CodeCommit::CreatePullRequestApprovalRule - Arguments for method CreatePullRequestApprovalRule on L<Paws::CodeCommit> | ||
| 20 | |||
| 21 | =head1 DESCRIPTION | ||
| 22 | |||
| 23 | This class represents the parameters used for calling the method CreatePullRequestApprovalRule on the | ||
| 24 | L<AWS CodeCommit|Paws::CodeCommit> service. Use the attributes of this class | ||
| 25 | as arguments to method CreatePullRequestApprovalRule. | ||
| 26 | |||
| 27 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreatePullRequestApprovalRule. | ||
| 28 | |||
| 29 | =head1 SYNOPSIS | ||
| 30 | |||
| 31 | my $codecommit = Paws->service('CodeCommit'); | ||
| 32 | my $CreatePullRequestApprovalRuleOutput = | ||
| 33 | $codecommit->CreatePullRequestApprovalRule( | ||
| 34 | ApprovalRuleContent => 'MyApprovalRuleContent', | ||
| 35 | ApprovalRuleName => 'MyApprovalRuleName', | ||
| 36 | PullRequestId => 'MyPullRequestId', | ||
| 37 | |||
| 38 | ); | ||
| 39 | |||
| 40 | # Results: | ||
| 41 | my $ApprovalRule = $CreatePullRequestApprovalRuleOutput->ApprovalRule; | ||
| 42 | |||
| 43 | # Returns a L<Paws::CodeCommit::CreatePullRequestApprovalRuleOutput> object. | ||
| 44 | |||
| 45 | 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. | ||
| 46 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/codecommit/CreatePullRequestApprovalRule> | ||
| 47 | |||
| 48 | =head1 ATTRIBUTES | ||
| 49 | |||
| 50 | |||
| 51 | =head2 B<REQUIRED> ApprovalRuleContent => Str | ||
| 52 | |||
| 53 | The content of the approval rule, including the number of approvals | ||
| 54 | needed and the structure of an approval pool defined for approvals, if | ||
| 55 | any. For more information about approval pools, see the AWS CodeCommit | ||
| 56 | User Guide. | ||
| 57 | |||
| 58 | When you create the content of the approval rule, you can specify | ||
| 59 | approvers in an approval pool in one of two ways: | ||
| 60 | |||
| 61 | =over | ||
| 62 | |||
| 63 | =item * | ||
| 64 | |||
| 65 | B<CodeCommitApprovers>: This option only requires an AWS account and a | ||
| 66 | resource. It can be used for both IAM users and federated access users | ||
| 67 | whose name matches the provided resource name. This is a very powerful | ||
| 68 | option that offers a great deal of flexibility. For example, if you | ||
| 69 | specify the AWS account I<123456789012> and I<Mary_Major>, all of the | ||
| 70 | following would be counted as approvals coming from that user: | ||
| 71 | |||
| 72 | =over | ||
| 73 | |||
| 74 | =item * | ||
| 75 | |||
| 76 | An IAM user in the account | ||
| 77 | (arn:aws:iam::I<123456789012>:user/I<Mary_Major>) | ||
| 78 | |||
| 79 | =item * | ||
| 80 | |||
| 81 | A federated user identified in IAM as Mary_Major | ||
| 82 | (arn:aws:sts::I<123456789012>:federated-user/I<Mary_Major>) | ||
| 83 | |||
| 84 | =back | ||
| 85 | |||
| 86 | This option does not recognize an active session of someone assuming | ||
| 87 | the role of CodeCommitReview with a role session name of I<Mary_Major> | ||
| 88 | (arn:aws:sts::I<123456789012>:assumed-role/CodeCommitReview/I<Mary_Major>) | ||
| 89 | unless you include a wildcard (*Mary_Major). | ||
| 90 | |||
| 91 | =item * | ||
| 92 | |||
| 93 | B<Fully qualified ARN>: This option allows you to specify the fully | ||
| 94 | qualified Amazon Resource Name (ARN) of the IAM user or role. | ||
| 95 | |||
| 96 | =back | ||
| 97 | |||
| 98 | For more information about IAM ARNs, wildcards, and formats, see IAM | ||
| 99 | Identifiers | ||
| 100 | (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html) | ||
| 101 | in the I<IAM User Guide>. | ||
| 102 | |||
| 103 | |||
| 104 | |||
| 105 | =head2 B<REQUIRED> ApprovalRuleName => Str | ||
| 106 | |||
| 107 | The name for the approval rule. | ||
| 108 | |||
| 109 | |||
| 110 | |||
| 111 | =head2 B<REQUIRED> PullRequestId => Str | ||
| 112 | |||
| 113 | The system-generated ID of the pull request for which you want to | ||
| 114 | create the approval rule. | ||
| 115 | |||
| 116 | |||
| 117 | |||
| 118 | |||
| 119 | =head1 SEE ALSO | ||
| 120 | |||
| 121 | This class forms part of L<Paws>, documenting arguments for method CreatePullRequestApprovalRule in L<Paws::CodeCommit> | ||
| 122 | |||
| 123 | =head1 BUGS and CONTRIBUTIONS | ||
| 124 | |||
| 125 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 126 | |||
| 127 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 128 | |||
| 129 | =cut | ||
| 130 |