@cloudcomponents/cdk-chatops
@cloudcomponents/cdk-chatops / MSTeamsIncomingWebhookConfiguration
-
Construct↳
MSTeamsIncomingWebhookConfiguration
• new MSTeamsIncomingWebhookConfiguration(scope, id, props)
| Name | Type |
|---|---|
scope |
Construct |
id |
string |
props |
MSTeamsIncomingWebhookConfigurationProps |
Construct.constructor
• Readonly incomingWebhook: IFunction
• Readonly node: ConstructNode
The construct tree node associated with this construct.
stability stable
Construct.node
▸ addEventSource(snsEventSource): void
| Name | Type |
|---|---|
snsEventSource |
SnsEventSource |
void
▸ Protected onPrepare(): void
Perform final modifications before synthesis.
This method can be implemented by derived constructs in order to perform final changes before synthesis. prepare() will be called after child constructs have been prepared.
This is an advanced framework feature. Only use this if you understand the implications.
stability stable
void
Construct.onPrepare
▸ Protected onSynthesize(session): void
Allows this construct to emit artifacts into the cloud assembly during synthesis.
This method is usually implemented by framework-level constructs such as Stack and Asset
as they participate in synthesizing the cloud assembly.
stability stable
| Name | Type | Description |
|---|---|---|
session |
ISynthesisSession |
The synthesis session. |
void
Construct.onSynthesize
▸ Protected onValidate(): string[]
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.
stability stable
string[]
An array of validation error messages, or an empty array if the construct is valid.
Construct.onValidate
▸ Protected prepare(): void
Perform final modifications before synthesis.
This method can be implemented by derived constructs in order to perform final changes before synthesis. prepare() will be called after child constructs have been prepared.
This is an advanced framework feature. Only use this if you understand the implications.
stability stable
void
Construct.prepare
▸ Protected synthesize(session): void
Allows this construct to emit artifacts into the cloud assembly during synthesis.
This method is usually implemented by framework-level constructs such as Stack and Asset
as they participate in synthesizing the cloud assembly.
stability stable
| Name | Type | Description |
|---|---|---|
session |
ISynthesisSession |
The synthesis session. |
void
Construct.synthesize
▸ toString(): string
Returns a string representation of this construct.
stability stable
string
Construct.toString
▸ Protected validate(): string[]
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.
stability stable
string[]
An array of validation error messages, or an empty array if the construct is valid.
Construct.validate
▸ Static isConstruct(x): x is Construct
Return whether the given object is a Construct.
stability stable
| Name | Type |
|---|---|
x |
any |
x is Construct
Construct.isConstruct
@cloudcomponents/cdk-chatops / SlackChannelConfiguration
-
Construct↳
SlackChannelConfiguration
- addLambdaInvokeCommandPermissions
- addNotificationPermissions
- addReadOnlyCommandPermissions
- addSupportCommandPermissions
- addToRolePolicy
- onPrepare
- onSynthesize
- onValidate
- prepare
- synthesize
- toString
- validate
- isConstruct
• new SlackChannelConfiguration(scope, id, props)
| Name | Type |
|---|---|
scope |
Construct |
id |
string |
props |
SlackChannelConfigurationProps |
Construct.constructor
• Readonly configurationArn: string
• Readonly node: ConstructNode
The construct tree node associated with this construct.
stability stable
Construct.node
• Readonly role: IRole
▸ addLambdaInvokeCommandPermissions(lambda?): void
Allows Lambda-invoke commands in supported clients
| Name | Type |
|---|---|
lambda? |
IFunction |
void
▸ addNotificationPermissions(): void
Allows AWS Chatbot to retreive metric graphs from Amazon Cloudwatch
void
▸ addReadOnlyCommandPermissions(): void
void
▸ addSupportCommandPermissions(): void
Allows calling AWS Support APIs in supportzed clients
void
▸ addToRolePolicy(statement): void
Adds a statement to the IAM role assumed by the instance.
| Name | Type |
|---|---|
statement |
PolicyStatement |
void
▸ Protected onPrepare(): void
Perform final modifications before synthesis.
This method can be implemented by derived constructs in order to perform final changes before synthesis. prepare() will be called after child constructs have been prepared.
This is an advanced framework feature. Only use this if you understand the implications.
stability stable
void
Construct.onPrepare
▸ Protected onSynthesize(session): void
Allows this construct to emit artifacts into the cloud assembly during synthesis.
This method is usually implemented by framework-level constructs such as Stack and Asset
as they participate in synthesizing the cloud assembly.
stability stable
| Name | Type | Description |
|---|---|---|
session |
ISynthesisSession |
The synthesis session. |
void
Construct.onSynthesize
▸ Protected onValidate(): string[]
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.
stability stable
string[]
An array of validation error messages, or an empty array if the construct is valid.
Construct.onValidate
▸ Protected prepare(): void
Perform final modifications before synthesis.
This method can be implemented by derived constructs in order to perform final changes before synthesis. prepare() will be called after child constructs have been prepared.
This is an advanced framework feature. Only use this if you understand the implications.
stability stable
void
Construct.prepare
▸ Protected synthesize(session): void
Allows this construct to emit artifacts into the cloud assembly during synthesis.
This method is usually implemented by framework-level constructs such as Stack and Asset
as they participate in synthesizing the cloud assembly.
stability stable
| Name | Type | Description |
|---|---|---|
session |
ISynthesisSession |
The synthesis session. |
void
Construct.synthesize
▸ toString(): string
Returns a string representation of this construct.
stability stable
string
Construct.toString
▸ Protected validate(): string[]
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.
stability stable
string[]
An array of validation error messages, or an empty array if the construct is valid.
Construct.validate
▸ Static isConstruct(x): x is Construct
Return whether the given object is a Construct.
stability stable
| Name | Type |
|---|---|
x |
any |
x is Construct
Construct.isConstruct
@cloudcomponents/cdk-chatops / AccountLabelMode
• ALIAS = "ALIAS"
• ID = "ID"
• ID_AND_ALIAS = "ID_AND_ALIAS"
@cloudcomponents/cdk-chatops / LoggingLevel
• ERROR = "ERROR"
• INFO = "INFO"
• NONE = "NONE"
@cloudcomponents/cdk-chatops / ISlackChannelConfiguration
• Readonly configurationArn: string
@cloudcomponents/cdk-chatops / MSTeamsIncomingWebhookConfigurationProps
• Optional Readonly accountLabelMode: AccountLabelMode
default ACCOUNT_LABEL_MODE.ID_AND_ALIAS
• Optional Readonly notificationTopics: ITopic[]
The SNS topics that deliver notifications to MS Teams.
• Optional Readonly themeColor: string
Specifies a custom brand color for the card. The color will be displayed in a non-obtrusive manner.
default #CEDB56
• Readonly url: string
The url of the incoming webhook for a channel
@cloudcomponents/cdk-chatops / SlackChannelConfigurationProps
• Readonly configurationName: string
The name of the configuration.
• Optional Readonly loggingLevel: LoggingLevel
Specifies the logging level for this configuration. This property affects the log entries pushed to Amazon CloudWatch Logs.
Logging levels include ERROR, INFO, or NONE.
default NONE
• Optional Readonly notificationTopics: ITopic[]
The SNS topics that deliver notifications to AWS Chatbot.
• Optional Readonly role: IRole
The iam role that defines the permissions for AWS Chatbot.
This is a user-defined role that AWS Chatbot will assume. This is not the service-linked role. For more information, see IAM Policies for AWS Chatbot.
• Readonly slackChannelId: string
The ID of the Slack channel.
To get the ID, open Slack, right click on the channel name in the left pane, then choose Copy Link. The channel ID is the 9-character string at the end of the URL. For example, ABCBBLZZZ.
• Readonly slackWorkspaceId: string
The ID of the Slack workspace authorized with AWS Chatbot.
To get the workspace ID, you must perform the initial authorization flow with Slack in the AWS Chatbot console. Then you can copy and paste the workspace ID from the console. For more details, see steps 1-4 in Setting Up AWS Chatbot with Slack in the AWS Chatbot User Guide.