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

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-codecommit/types.rb

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

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 CodeCommit User Guide.

<note markdown=“1”> 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 Amazon Web
 Services 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 Amazon Web
 Services 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][1

in the *IAM User Guide*.

</note>

[1]: docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html

Returns:

  • (String) 


1556
1557
1558
1559
1560
1561
1562
 
# File 'lib/aws-sdk-codecommit/types.rb', line 1556

class CreatePullRequestApprovalRuleInput < Struct.new(
  :pull_request_id,
  :approval_rule_name,
  :approval_rule_content)
  SENSITIVE = []
  include Aws::Structure
end

#approval_rule_name ⇒ String

The name for the approval rule.

Returns:

  • (String) 


1556
1557
1558
1559
1560
1561
1562
 
# File 'lib/aws-sdk-codecommit/types.rb', line 1556

class CreatePullRequestApprovalRuleInput < Struct.new(
  :pull_request_id,
  :approval_rule_name,
  :approval_rule_content)
  SENSITIVE = []
  include Aws::Structure
end

#pull_request_id ⇒ String

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

Returns:

  • (String) 


1556
1557
1558
1559
1560
1561
1562
 
# File 'lib/aws-sdk-codecommit/types.rb', line 1556

class CreatePullRequestApprovalRuleInput < Struct.new(
  :pull_request_id,
  :approval_rule_name,
  :approval_rule_content)
  SENSITIVE = []
  include Aws::Structure
end