API.md

API Reference

Classes

Name	Description
SlackApprovalAction	No description
SlackNotifier	No description

Structs

Name	Description
SlackApprovalActionProps	No description
SlackNotifierProps	No description

Enums

Name	Description
ChannelTypes	No description

class SlackApprovalAction

Implements: IAction Extends: Action

Initializer

new SlackApprovalAction(props: SlackApprovalActionProps)

• 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
  • slackBotToken (string) No description
  • slackSigningSecret (string) No description
  • additionalInformation (string) No description Optional
  • externalEntityLink (string) No description Optional
  • slackBotIcon (string) No description Optional
  • slackBotName (string) No description Optional
  • slackChannel (string) No description Optional
  • slackChannelId (string) No description Optional
  • slackChannelTypes (Array<ChannelTypes>) No description Optional

Methods

protected bound(scope, stage, options)

(experimental) The method called when an Action is attached to a Pipeline.

This method is guaranteed to be called only once for each Action instance.

protected bound(scope: Construct, stage: IStage, options: ActionBindOptions): ActionConfig

• scope (Construct) No description
• stage (IStage) No description
• options (ActionBindOptions) No description
  • bucket (IBucket) No description
  • role (IRole) No description

Returns:

• ActionConfig

class SlackNotifier

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

Initializer

new SlackNotifier(scope: Construct, id: string, props: SlackNotifierProps)

• scope (Construct) No description
• id (string) No description
• props (SlackNotifierProps) No description
  • pipeline (IPipeline) No description
  • slackBotToken (string) No description
  • slackSigningSecret (string) No description
  • slackBotIcon (string) No description Optional
  • slackBotName (string) No description Optional
  • slackChannel (string) No description Optional
  • slackChannelId (string) No description Optional
  • slackChannelTypes (Array<ChannelTypes>) No description Optional
  • stageNames (Array) No description Optional

Properties

Name	Type	Description
environment	Map<string, string>

Methods

protected validate()

Validate the current construct.

This method can be implemented by derived constructs in order to perform validation logic. It is called on all constructs before synthesis.

protected validate(): Array<string>

Returns:

• Array

struct SlackApprovalActionProps

Name	Type	Description
actionName	string	The physical, human-readable name of the Action.
slackBotToken	string
slackSigningSecret	string
additionalInformation?	string	Optional
externalEntityLink?	string	Optional
runOrder?	number	The runOrder property for this Action. Default: 1
slackBotIcon?	string	Optional
slackBotName?	string	Optional
slackChannel?	string	Optional
slackChannelId?	string	Optional
slackChannelTypes?	Array<ChannelTypes>	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 SlackNotifierProps

Name	Type	Description
pipeline	IPipeline
slackBotToken	string
slackSigningSecret	string
slackBotIcon?	string	Optional
slackBotName?	string	Optional
slackChannel?	string	Optional
slackChannelId?	string	Optional
slackChannelTypes?	Array<ChannelTypes>	Optional
stageNames?	Array	Optional

enum ChannelTypes

Name	Description
PUBLIC
PRIVATE