@Generated(value="software.amazon.awssdk:codegen") public final class CreatePullRequestApprovalRuleRequest extends CodeCommitRequest implements ToCopyableBuilder<CreatePullRequestApprovalRuleRequest.Builder,CreatePullRequestApprovalRuleRequest>
| Modifier and Type | Class and Description |
|---|---|
static interface |
CreatePullRequestApprovalRuleRequest.Builder |
| Modifier and Type | Method and Description |
|---|---|
String |
approvalRuleContent()
The content of the approval rule, including the number of approvals needed and the structure of an approval pool
defined for approvals, if any.
|
String |
approvalRuleName()
The name for the approval rule.
|
static CreatePullRequestApprovalRuleRequest.Builder |
builder() |
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
String |
pullRequestId()
The system-generated ID of the pull request for which you want to create the approval rule.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends CreatePullRequestApprovalRuleRequest.Builder> |
serializableBuilderClass() |
CreatePullRequestApprovalRuleRequest.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
overrideConfigurationclone, finalize, getClass, notify, notifyAll, wait, wait, waitcopypublic final String pullRequestId()
The system-generated ID of the pull request for which you want to create the approval rule.
public final String approvalRuleName()
The name for the approval rule.
public final String approvalRuleContent()
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.
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.
public CreatePullRequestApprovalRuleRequest.Builder toBuilder()
toBuilder in interface ToCopyableBuilder<CreatePullRequestApprovalRuleRequest.Builder,CreatePullRequestApprovalRuleRequest>toBuilder in class CodeCommitRequestpublic static CreatePullRequestApprovalRuleRequest.Builder builder()
public static Class<? extends CreatePullRequestApprovalRuleRequest.Builder> serializableBuilderClass()
public final int hashCode()
hashCode in class AwsRequestpublic final boolean equals(Object obj)
equals in class AwsRequestpublic final boolean equalsBySdkFields(Object obj)
equalsBySdkFields in interface SdkPojopublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
getValueForField in class SdkRequestCopyright © 2023. All rights reserved.