Skip to content

Latest commit

 

History

History
115 lines (64 loc) · 5.22 KB

API.md

File metadata and controls

115 lines (64 loc) · 5.22 KB

API Reference

Classes

Name Description
SlackApproval No description

Structs

Name Description
SlackApprovalActionProps No description
SlackApprovalProps No description

class SlackApproval

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

Initializer

new SlackApproval(scope: Construct, id: string, props: SlackApprovalProps)
  • scope (Construct) No description
  • id (string) No description
  • props (SlackApprovalProps) No description
    • slackToken (string) No description

Properties

Name Type Description
approverHandler Function
props SlackApprovalProps
topic Topic

Methods

addApprovalAction(props) 

addApprovalAction(props: SlackApprovalActionProps): IAction
  • props (SlackApprovalActionProps) No description
    • actionName (string) The physical, human-readable name of the Action.
    • runOrder (number) The runOrder property for this Action. Default: 1
    • variablesNamespace (string) The name of the namespace to use for variables emitted by this action. Default: a name will be generated, based on the stage and action names, if any of the action's variables were referenced - otherwise, no namespace will be set
    • role (IRole) The Role in which context's this Action will be executing in. Default: a new Role will be generated
    • additionalInformation (string) Any additional information that you want to include in the notification email message. Optional
    • externalEntityLink (string) URL you want to provide to the reviewer as part of the approval request. Default: the approval request will not have an external link
    • notificationTopic (ITopic) Optional SNS topic to send notifications to when an approval is pending. Optional
    • notifyEmails (Array) A list of email addresses to subscribe to notifications when this Action is pending approval. Optional
    • slackChannel (string) No description
    • slackIcon (string) No description Optional
    • slackUsername (string) No description Optional

Returns:

struct SlackApprovalActionProps

Name Type Description
actionName string The physical, human-readable name of the Action.
slackChannel string
additionalInformation? string Any additional information that you want to include in the notification email message.
Optional
externalEntityLink? string URL you want to provide to the reviewer as part of the approval request.
Default: the approval request will not have an external link
notificationTopic? ITopic Optional SNS topic to send notifications to when an approval is pending.
Optional
notifyEmails? Array A list of email addresses to subscribe to notifications when this Action is pending approval.
Optional
role? IRole The Role in which context's this Action will be executing in.
Default: a new Role will be generated
runOrder? number The runOrder property for this Action.
Default: 1
slackIcon? string Optional
slackUsername? string Optional
variablesNamespace? string The name of the namespace to use for variables emitted by this action.
Default: a name will be generated, based on the stage and action names, if any of the action's variables were referenced - otherwise, no namespace will be set

struct SlackApprovalProps

Name Type Description
slackToken string