Class: Aws::CodeCommit::Types::CreateApprovalRuleTemplateInput

Inherits:

Struct

• Object
• Struct
• Aws::CodeCommit::Types::CreateApprovalRuleTemplateInput

Includes:

Structure

Defined in:

lib/aws-sdk-codecommit/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #approval_rule_template_content ⇒ String

  The content of the approval rule that is created on pull requests in associated repositories.

• #approval_rule_template_description ⇒ String

  The description of the approval rule template.

• #approval_rule_template_name ⇒ String

  The name of the approval rule template.

Instance Attribute Details

#approval_rule_template_content ⇒ String

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.

<note markdown=“1”> 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][1

in the *IAM User Guide*.

</note>

[1]: docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html

Returns:

• (String)

# File 'lib/aws-sdk-codecommit/types.rb', line 1359

class CreateApprovalRuleTemplateInput < Struct.new(
  :approval_rule_template_name,
  :approval_rule_template_content,
  :approval_rule_template_description)
  SENSITIVE = []
  include Aws::Structure
end

#approval_rule_template_description ⇒ String

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:

• (String)

# File 'lib/aws-sdk-codecommit/types.rb', line 1359

class CreateApprovalRuleTemplateInput < Struct.new(
  :approval_rule_template_name,
  :approval_rule_template_content,
  :approval_rule_template_description)
  SENSITIVE = []
  include Aws::Structure
end

#approval_rule_template_name ⇒ String

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:

• (String)

# File 'lib/aws-sdk-codecommit/types.rb', line 1359

class CreateApprovalRuleTemplateInput < Struct.new(
  :approval_rule_template_name,
  :approval_rule_template_content,
  :approval_rule_template_description)
  SENSITIVE = []
  include Aws::Structure
end