Struct aws_sdk_codecommit::client::fluent_builders::CreatePullRequestApprovalRule

pub struct CreatePullRequestApprovalRule<C = DynConnector, M = DefaultMiddleware, R = Standard> { /* private fields */ }

Fluent builder constructing a request to CreatePullRequestApprovalRule.

Creates an approval rule for a pull request.

Implementations

impl<C, M, R> CreatePullRequestApprovalRule<C, M, R> where
    C: SmithyConnector,
    M: SmithyMiddleware<C>,
    R: NewRequestPolicy, 

pub async fn send(
    self
) -> Result<CreatePullRequestApprovalRuleOutput, SdkError<CreatePullRequestApprovalRuleError>> where
    R::Policy: SmithyRetryPolicy<CreatePullRequestApprovalRuleInputOperationOutputAlias, CreatePullRequestApprovalRuleOutput, CreatePullRequestApprovalRuleError, CreatePullRequestApprovalRuleInputOperationRetryAlias>, 

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

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.

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 approval_rule_name(self, input: impl Into<String>) -> Self

The name for the approval rule.

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

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

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

Trait Implementations

impl<C: Clone, M: Clone, R: Clone> Clone for CreatePullRequestApprovalRule<C, M, R>

fn clone(&self) -> CreatePullRequestApprovalRule<C, M, R>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<C: Debug, M: Debug, R: Debug> Debug for CreatePullRequestApprovalRule<C, M, R>

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

Formats the value using the given formatter.