API.md

API Reference

Classes

Name	Description
ApprovalRuleTemplate	No description
ApprovalRuleTemplateRepositoryAssociation	No description

Structs

Name	Description
ApprovalRuleTemplateProps	No description
ApprovalRuleTemplateRepositoryAssociationProps	No description
Approvers	No description
Template	No description

class ApprovalRuleTemplate

Implements: IConstruct, IConstruct, IConstruct, IDependable Extends: Construct

Initializer

new ApprovalRuleTemplate(scope: Construct, id: string, props: ApprovalRuleTemplateProps)

• scope (Construct) No description
• id (string) No description
• props (ApprovalRuleTemplateProps) No description
  • approvalRuleTemplateName (string) The name of the approval rule template.
  • template (Template) The content of the approval rule that is created on pull requests in associated repositories.
  • approvalRuleTemplateDescription (string) The description of the approval rule template. Optional

Properties

Name	Type	Description
approvalRuleTemplateName	string

class ApprovalRuleTemplateRepositoryAssociation

Implements: IConstruct, IConstruct, IConstruct, IDependable Extends: Construct

Initializer

new ApprovalRuleTemplateRepositoryAssociation(scope: Construct, id: string, props: ApprovalRuleTemplateRepositoryAssociationProps)

• scope (Construct) No description
• id (string) No description
• props (ApprovalRuleTemplateRepositoryAssociationProps) No description
  • approvalRuleTemplateName (string) The name of the template you want to associate with one or more repositories.
  • repository (IRepository) The repository you want to associate with the template.

Methods

onOverridden(id, options)

onOverridden(id: string, options: OnEventOptions): Rule

• id (string) No description
• options (OnEventOptions) No description
  • description (string) A description of the rule's purpose. Default: No description
  • eventPattern (EventPattern) Additional restrictions for the event to route to the specified target. Default: No additional filtering based on an event pattern.
  • ruleName (string) A name for the rule. Default: AWS CloudFormation generates a unique physical ID.
  • target (IRuleTarget) The target to register for the event. Default: No target is added to the rule. Use addTarget() to add a target.

Returns:

• Rule

struct ApprovalRuleTemplateProps

Name	Type	Description
approvalRuleTemplateName	string	The name of the approval rule template.
template	Template	The content of the approval rule that is created on pull requests in associated repositories.
approvalRuleTemplateDescription?	string	The description of the approval rule template. Optional

struct ApprovalRuleTemplateRepositoryAssociationProps

Name	Type	Description
approvalRuleTemplateName	string	The name of the template you want to associate with one or more repositories.
repository	IRepository	The repository you want to associate with the template.

struct Approvers

Name	Type	Description
numberOfApprovalsNeeded	number
approvalPoolMembers?	Array	Optional

struct Template

Name	Type	Description
approvers	Approvers
branches?	Array	Optional