Package software.amazon.awssdk.services.codecommit.model

Interface CreateApprovalRuleTemplateRequest.Builder

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

  • Method Details

    • approvalRuleTemplateName

      CreateApprovalRuleTemplateRequest.Builder approvalRuleTemplateName(String approvalRuleTemplateName)

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

      Parameters:
      approvalRuleTemplateName - The name of the approval rule template. Provide descriptive names, because this name is applied to the approval rules created automatically in associated repositories.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • approvalRuleTemplateContent

      CreateApprovalRuleTemplateRequest.Builder approvalRuleTemplateContent(String approvalRuleTemplateContent)

      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 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:
      approvalRuleTemplateContent - 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 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.

    • approvalRuleTemplateDescription

      CreateApprovalRuleTemplateRequest.Builder approvalRuleTemplateDescription(String approvalRuleTemplateDescription)

      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.

      Parameters:
      approvalRuleTemplateDescription - 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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      CreateApprovalRuleTemplateRequest.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

      CreateApprovalRuleTemplateRequest.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.