Class: Aws::CodeCommit::Types::UpdatePullRequestApprovalRuleContentInput

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

Overview

Note:

When making an API call, you may pass UpdatePullRequestApprovalRuleContentInput data as a hash:

{
  pull_request_id: "PullRequestId", # required
  approval_rule_name: "ApprovalRuleName", # required
  existing_rule_content_sha_256: "RuleContentSha256",
  new_rule_content: "ApprovalRuleContent", # required
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#approval_rule_nameString

The name of the approval rule you want to update.

Returns:

  • (String)

7738
7739
7740
7741
7742
7743
7744
7745
# File 'lib/aws-sdk-codecommit/types.rb', line 7738

class UpdatePullRequestApprovalRuleContentInput < Struct.new(
  :pull_request_id,
  :approval_rule_name,
  :existing_rule_content_sha_256,
  :new_rule_content)
  SENSITIVE = []
  include Aws::Structure
end

#existing_rule_content_sha_256String

The SHA-256 hash signature for the content of the approval rule. You can retrieve this information by using GetPullRequest.

Returns:

  • (String)

7738
7739
7740
7741
7742
7743
7744
7745
# File 'lib/aws-sdk-codecommit/types.rb', line 7738

class UpdatePullRequestApprovalRuleContentInput < Struct.new(
  :pull_request_id,
  :approval_rule_name,
  :existing_rule_content_sha_256,
  :new_rule_content)
  SENSITIVE = []
  include Aws::Structure
end

#new_rule_contentString

The updated content for the approval rule.

<note markdown=“1”> When you update 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 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][1

in the *IAM User Guide*.

</note>

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

Returns:

  • (String)

7738
7739
7740
7741
7742
7743
7744
7745
# File 'lib/aws-sdk-codecommit/types.rb', line 7738

class UpdatePullRequestApprovalRuleContentInput < Struct.new(
  :pull_request_id,
  :approval_rule_name,
  :existing_rule_content_sha_256,
  :new_rule_content)
  SENSITIVE = []
  include Aws::Structure
end

#pull_request_idString

The system-generated ID of the pull request.

Returns:

  • (String)

7738
7739
7740
7741
7742
7743
7744
7745
# File 'lib/aws-sdk-codecommit/types.rb', line 7738

class UpdatePullRequestApprovalRuleContentInput < Struct.new(
  :pull_request_id,
  :approval_rule_name,
  :existing_rule_content_sha_256,
  :new_rule_content)
  SENSITIVE = []
  include Aws::Structure
end