pub struct CreateApprovalRuleTemplate { /* private fields */ }
Expand description
Fluent builder constructing a request to CreateApprovalRuleTemplate
.
Creates a template for approval rules that can then be associated with one or more repositories in your AWS account. When you associate a template with a repository, AWS CodeCommit creates an approval rule that matches the conditions of the template for all pull requests that meet the conditions of the template. For more information, see AssociateApprovalRuleTemplateWithRepository
.
Implementations
sourceimpl CreateApprovalRuleTemplate
impl CreateApprovalRuleTemplate
sourcepub async fn send(
self
) -> Result<CreateApprovalRuleTemplateOutput, SdkError<CreateApprovalRuleTemplateError>>
pub async fn send(
self
) -> Result<CreateApprovalRuleTemplateOutput, SdkError<CreateApprovalRuleTemplateError>>
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.
sourcepub fn approval_rule_template_name(self, input: impl Into<String>) -> Self
pub fn approval_rule_template_name(self, input: impl Into<String>) -> Self
The name of the approval rule template. Provide descriptive names, because this name is applied to the approval rules created automatically in associated repositories.
sourcepub fn set_approval_rule_template_name(self, input: Option<String>) -> Self
pub fn set_approval_rule_template_name(self, input: Option<String>) -> Self
The name of the approval rule template. Provide descriptive names, because this name is applied to the approval rules created automatically in associated repositories.
sourcepub fn approval_rule_template_content(self, input: impl Into<String>) -> Self
pub fn approval_rule_template_content(self, input: impl Into<String>) -> Self
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 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 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.
sourcepub fn set_approval_rule_template_content(self, input: Option<String>) -> Self
pub fn set_approval_rule_template_content(self, input: Option<String>) -> Self
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 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 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.
sourcepub fn approval_rule_template_description(
self,
input: impl Into<String>
) -> Self
pub fn approval_rule_template_description(
self,
input: impl Into<String>
) -> Self
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.
sourcepub fn set_approval_rule_template_description(
self,
input: Option<String>
) -> Self
pub fn set_approval_rule_template_description(
self,
input: Option<String>
) -> Self
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.
Trait Implementations
sourceimpl Clone for CreateApprovalRuleTemplate
impl Clone for CreateApprovalRuleTemplate
sourcefn clone(&self) -> CreateApprovalRuleTemplate
fn clone(&self) -> CreateApprovalRuleTemplate
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
Auto Trait Implementations
impl !RefUnwindSafe for CreateApprovalRuleTemplate
impl Send for CreateApprovalRuleTemplate
impl Sync for CreateApprovalRuleTemplate
impl Unpin for CreateApprovalRuleTemplate
impl !UnwindSafe for CreateApprovalRuleTemplate
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcepub fn borrow_mut(&mut self) -> &mut T
pub fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcepub fn to_owned(&self) -> T
pub fn to_owned(&self) -> T
Creates owned data from borrowed data, usually by cloning. Read more
sourcepub fn clone_into(&self, target: &mut T)
pub fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more