interface ISlackChannelConfiguration

Language	Type name
.NET	Amazon.CDK.AWS.Chatbot.ISlackChannelConfiguration
Go	github.com/aws/aws-cdk-go/awscdk/v2/awschatbot#ISlackChannelConfiguration
Java	software.amazon.awscdk.services.chatbot.ISlackChannelConfiguration
Python	aws_cdk.aws_chatbot.ISlackChannelConfiguration
TypeScript (source)	aws-cdk-lib » aws_chatbot » ISlackChannelConfiguration

Implemented by SlackChannelConfiguration

Obtainable from SlackChannelConfiguration.fromSlackChannelConfigurationArn()

Represents a Slack channel configuration.

Properties

Name	Type	Description
env	ResourceEnvironment	The environment this resource belongs to.
grantPrincipal	IPrincipal	The principal to grant permissions to.
node	Node	The tree node.
slackChannelConfigurationArn	string	The ARN of the Slack channel configuration In the form of arn:aws:chatbot:{region}:{account}:chat-configuration/slack-channel/{slackChannelName}.
slackChannelConfigurationName	string	The name of Slack channel configuration.
stack	Stack	The stack in which this resource is defined.
role?	IRole	The permission role of Slack channel configuration.

---

env

Type: ResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.

For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.

---

grantPrincipal

Type: IPrincipal

The principal to grant permissions to.

---

node

Type: Node

The tree node.

---

slackChannelConfigurationArn

Type: string

The ARN of the Slack channel configuration In the form of arn:aws:chatbot:{region}:{account}:chat-configuration/slack-channel/{slackChannelName}.

---

slackChannelConfigurationName

Type: string

The name of Slack channel configuration.

---

stack

Type: Stack

The stack in which this resource is defined.

---

role?

Type: IRole (optional, default: A role will be created.)

The permission role of Slack channel configuration.

Methods

Name	Description
addToRolePolicy(statement)	Adds a statement to the IAM role.
applyRemovalPolicy(policy)	Apply the given removal policy to this resource.
bindAsNotificationRuleTarget(scope)	Returns a target configuration for notification rule.
metric(metricName, props?)	Return the given named metric for this SlackChannelConfiguration.

---

addToRolePolicy(statement)

public addToRolePolicy(statement: PolicyStatement): void

Parameters

• statement PolicyStatement

Adds a statement to the IAM role.

---

applyRemovalPolicy(policy)

public applyRemovalPolicy(policy: RemovalPolicy): void

Parameters

• policy RemovalPolicy

Apply the given removal policy to this resource.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

---

bindAsNotificationRuleTarget(scope)

public bindAsNotificationRuleTarget(scope: Construct): NotificationRuleTargetConfig

Parameters

• scope Construct

Returns

• NotificationRuleTargetConfig

Returns a target configuration for notification rule.

---

metric(metricName, props?)

public metric(metricName: string, props?: MetricOptions): Metric

Parameters

• metricName string
• props MetricOptions

Returns

• Metric

Return the given named metric for this SlackChannelConfiguration.