AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-codecommit/lib/aws-sdk-codecommit/types.rb

Overview

Note:

When making an API call, you may pass CreateApprovalRuleTemplateInput data as a hash:

{
  approval_rule_template_name: "ApprovalRuleTemplateName", # required
  approval_rule_template_content: "ApprovalRuleTemplateContent", # required
  approval_rule_template_description: "ApprovalRuleTemplateDescription",
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#approval_rule_template_contentString

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.

Returns:

  • (String)


1409
1410
1411
1412
1413
1414
1415
# File 'gems/aws-sdk-codecommit/lib/aws-sdk-codecommit/types.rb', line 1409

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

#approval_rule_template_descriptionString

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)


1409
1410
1411
1412
1413
1414
1415
# File 'gems/aws-sdk-codecommit/lib/aws-sdk-codecommit/types.rb', line 1409

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

#approval_rule_template_nameString

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)


1409
1410
1411
1412
1413
1414
1415
# File 'gems/aws-sdk-codecommit/lib/aws-sdk-codecommit/types.rb', line 1409

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