NAME

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

DESCRIPTION

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

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

SYNOPSIS

    my $codecommit = Paws->service('CodeCommit');
    my $CreateApprovalRuleTemplateOutput =
      $codecommit->CreateApprovalRuleTemplate(
      ApprovalRuleTemplateContent => 'MyApprovalRuleTemplateContent',
      ApprovalRuleTemplateName    => 'MyApprovalRuleTemplateName',
      ApprovalRuleTemplateDescription =>
        'MyApprovalRuleTemplateDescription',    # OPTIONAL
      );

    # Results:
    my $ApprovalRuleTemplate =
      $CreateApprovalRuleTemplateOutput->ApprovalRuleTemplate;

    # Returns a L<Paws::CodeCommit::CreateApprovalRuleTemplateOutput> 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/CreateApprovalRuleTemplate

ATTRIBUTES

REQUIRED ApprovalRuleTemplateContent => Str

The content of the approval rule that is created on pull requests in associated repositories. If you specify one or more destination references (branches), approval rules are created in an associated repository only if their destination references (branches) match those specified in the template.

When you create the content of the approval rule template, 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 are 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.

ApprovalRuleTemplateDescription => Str

The description of the approval rule template. Consider providing a description that explains what this template does and when it might be appropriate to associate it with repositories.

REQUIRED ApprovalRuleTemplateName => Str

The name of the approval rule template. Provide descriptive names, because this name is applied to the approval rules created automatically in associated repositories.

SEE ALSO

This class forms part of Paws, documenting arguments for method CreateApprovalRuleTemplate in Paws::CodeCommit

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