You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::CodeCommit::Types::CreatePullRequestApprovalRuleInput

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing CreatePullRequestApprovalRuleInput as input to an Aws::Client method, you can use a vanilla Hash:

{
  pull_request_id: "PullRequestId", # required
  approval_rule_name: "ApprovalRuleName", # required
  approval_rule_content: "ApprovalRuleContent", # required
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#approval_rule_content ⇒ String

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 in the IAM User Guide.

Returns:

  • (String) —

    The content of the approval rule, including the number of approvals needed and the structure of an approval pool defined for approvals, if any.

#approval_rule_name ⇒ String

The name for the approval rule.

Returns:

  • (String) —

    The name for the approval rule.

#pull_request_id ⇒ String

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

Returns:

  • (String) —

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