Interface UpdatePullRequestApprovalRuleContentRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CodeCommitRequest.Builder, CopyableBuilder<UpdatePullRequestApprovalRuleContentRequest.Builder,UpdatePullRequestApprovalRuleContentRequest>, SdkBuilder<UpdatePullRequestApprovalRuleContentRequest.Builder,UpdatePullRequestApprovalRuleContentRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
UpdatePullRequestApprovalRuleContentRequest
public static interface UpdatePullRequestApprovalRuleContentRequest.Builder extends CodeCommitRequest.Builder, SdkPojo, CopyableBuilder<UpdatePullRequestApprovalRuleContentRequest.Builder,UpdatePullRequestApprovalRuleContentRequest>

  • Method Details

    • pullRequestId

      UpdatePullRequestApprovalRuleContentRequest.Builder pullRequestId(String pullRequestId)

      The system-generated ID of the pull request.

      Parameters:
      pullRequestId - The system-generated ID of the pull request.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • approvalRuleName

      UpdatePullRequestApprovalRuleContentRequest.Builder approvalRuleName(String approvalRuleName)

      The name of the approval rule you want to update.

      Parameters:
      approvalRuleName - The name of the approval rule you want to update.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • existingRuleContentSha256

      UpdatePullRequestApprovalRuleContentRequest.Builder existingRuleContentSha256(String existingRuleContentSha256)

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

      Parameters:
      existingRuleContentSha256 - The SHA-256 hash signature for the content of the approval rule. You can retrieve this information by using GetPullRequest.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • newRuleContent

      UpdatePullRequestApprovalRuleContentRequest.Builder newRuleContent(String newRuleContent)

      The updated content for the approval rule.

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

      Parameters:
      newRuleContent - The updated content for the approval rule.

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

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      UpdatePullRequestApprovalRuleContentRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      UpdatePullRequestApprovalRuleContentRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.