aws-cdk-lib.aws_chatbot.ISlackChannelConfiguration

interface ISlackChannelConfiguration

LanguageType name
.NETAmazon.CDK.AWS.Chatbot.ISlackChannelConfiguration
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awschatbot#ISlackChannelConfiguration
Javasoftware.amazon.awscdk.services.chatbot.ISlackChannelConfiguration
Pythonaws_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

NameTypeDescription
envResourceEnvironmentThe environment this resource belongs to.
grantPrincipalIPrincipalThe principal to grant permissions to.
nodeNodeThe tree node.
slackChannelConfigurationArnstringThe ARN of the Slack channel configuration In the form of arn:aws:chatbot:{region}:{account}:chat-configuration/slack-channel/{slackChannelName}.
slackChannelConfigurationNamestringThe name of Slack channel configuration.
stackStackThe stack in which this resource is defined.
role?IRoleThe permission role of Slack channel configuration.

env

Type: ResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that 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

NameDescription
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.