NAME

Paws::CodeCommit::CreatePullRequestApprovalRule - Arguments for method CreatePullRequestApprovalRule on Paws::CodeCommit

DESCRIPTION

This class represents the parameters used for calling the method CreatePullRequestApprovalRule on the AWS CodeCommit service. Use the attributes of this class as arguments to method CreatePullRequestApprovalRule.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreatePullRequestApprovalRule.

SYNOPSIS

    my $codecommit = Paws->service('CodeCommit');
    my $CreatePullRequestApprovalRuleOutput =
      $codecommit->CreatePullRequestApprovalRule(
      ApprovalRuleContent => 'MyApprovalRuleContent',
      ApprovalRuleName    => 'MyApprovalRuleName',
      PullRequestId       => 'MyPullRequestId',
      );
    # Results:
    my $ApprovalRule = $CreatePullRequestApprovalRuleOutput->ApprovalRule;
    # Returns a L<Paws::CodeCommit::CreatePullRequestApprovalRuleOutput> object.

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. For the AWS API documentation, see <https://docs.aws.amazon.com/goto/WebAPI/codecommit/CreatePullRequestApprovalRule>

ATTRIBUTES

REQUIRED ApprovalRuleContent => Str

The content of the approval rule, including the number of approvals needed and the structure of an approval pool defined for approvals, if any. For more information about approval pools, see the AWS CodeCommit User Guide.

When you create the content of the approval rule, you can specify approvers in an approval pool in one of two ways:

•: CodeCommitApprovers: This option only requires an AWS account and a resource. It can be used for both IAM users and federated access users whose name matches the provided resource name. This is a very powerful option that offers a great deal of flexibility. For example, if you specify the AWS account 123456789012 and Mary_Major, all of the following would be counted as approvals coming from that user:

An IAM user in the account (arn:aws:iam::123456789012:user/Mary_Major)
A federated user identified in IAM as Mary_Major (arn:aws:sts::123456789012:federated-user/Mary_Major)

This option does not recognize an active session of someone assuming the role of CodeCommitReview with a role session name of Mary_Major (arn:aws:sts::123456789012:assumed-role/CodeCommitReview/Mary_Major) unless you include a wildcard (*Mary_Major).

•: Fully qualified ARN: This option allows you to specify the fully qualified Amazon Resource Name (ARN) of the IAM user or role.

For more information about IAM ARNs, wildcards, and formats, see IAM Identifiers (https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html) in the IAM User Guide.

REQUIRED ApprovalRuleName => Str

The name for the approval rule.

REQUIRED PullRequestId => Str

The system-generated ID of the pull request for which you want to create the approval rule.

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>