Struct aws_sdk_codecommit::operation::create_pull_request_approval_rule::builders::CreatePullRequestApprovalRuleInputBuilder

#[non_exhaustive]
pub struct CreatePullRequestApprovalRuleInputBuilder { /* private fields */ }

A builder for CreatePullRequestApprovalRuleInput.

Implementations

impl CreatePullRequestApprovalRuleInputBuilder

pub fn pull_request_id(self, input: impl Into<String>) -> Self

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

This field is required.

pub fn set_pull_request_id(self, input: Option<String>) -> Self

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

pub fn get_pull_request_id(&self) -> &Option<String>

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

pub fn approval_rule_name(self, input: impl Into<String>) -> Self

The name for the approval rule.

This field is required.

pub fn set_approval_rule_name(self, input: Option<String>) -> Self

The name for the approval rule.

pub fn get_approval_rule_name(&self) -> &Option<String>

The name for the approval rule.

pub fn approval_rule_content(self, input: impl Into<String>) -> Self

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.

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

This field is required.

pub fn set_approval_rule_content(self, input: Option<String>) -> Self

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.

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

pub fn get_approval_rule_content(&self) -> &Option<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.

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

pub fn build(self) -> Result<CreatePullRequestApprovalRuleInput, BuildError>

Consumes the builder and constructs a CreatePullRequestApprovalRuleInput.

impl CreatePullRequestApprovalRuleInputBuilder

pub async fn send_with( self, client: &Client ) -> Result<CreatePullRequestApprovalRuleOutput, SdkError<CreatePullRequestApprovalRuleError, HttpResponse>>

Sends a request with this input using the given client.

Trait Implementations

impl Clone for CreatePullRequestApprovalRuleInputBuilder

fn clone(&self) -> CreatePullRequestApprovalRuleInputBuilder

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CreatePullRequestApprovalRuleInputBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for CreatePullRequestApprovalRuleInputBuilder

fn default() -> CreatePullRequestApprovalRuleInputBuilder

Returns the “default value” for a type.

impl PartialEq for CreatePullRequestApprovalRuleInputBuilder

fn eq(&self, other: &CreatePullRequestApprovalRuleInputBuilder) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for CreatePullRequestApprovalRuleInputBuilder