class CfnSlackChannelConfiguration (construct)

Language	Type name
.NET	`Amazon.CDK.AWS.Chatbot.CfnSlackChannelConfiguration`
Java	`software.amazon.awscdk.services.chatbot.CfnSlackChannelConfiguration`
Python	`aws_cdk.aws_chatbot.CfnSlackChannelConfiguration`
TypeScript	`@aws-cdk/aws-chatbot` » `CfnSlackChannelConfiguration`

Implements IConstruct, IConstruct, IDependable, IInspectable

A CloudFormation AWS::Chatbot::SlackChannelConfiguration.

The AWS::Chatbot::SlackChannelConfiguration resource configures a Slack channel to allow users to use AWS Chatbot with AWS CloudFormation templates.

This resource requires some setup to be done in the AWS Chatbot console. To provide the required Slack workspace ID, you must perform the initial authorization flow with Slack in the AWS Chatbot console, then 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 .

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as chatbot from '@aws-cdk/aws-chatbot';
const cfnSlackChannelConfiguration = new chatbot.CfnSlackChannelConfiguration(this, 'MyCfnSlackChannelConfiguration', {
  configurationName: 'configurationName',
  iamRoleArn: 'iamRoleArn',
  slackChannelId: 'slackChannelId',
  slackWorkspaceId: 'slackWorkspaceId',

  // the properties below are optional
  guardrailPolicies: ['guardrailPolicies'],
  loggingLevel: 'loggingLevel',
  snsTopicArns: ['snsTopicArns'],
  userRoleRequired: false,
});

Initializer

new CfnSlackChannelConfiguration(scope: Construct, id: string, props: CfnSlackChannelConfigurationProps)

Parameters

scope Construct — - scope in which this resource is defined.
id string — - scoped id of the resource.
props CfnSlackChannelConfigurationProps — - resource properties.

Create a new AWS::Chatbot::SlackChannelConfiguration.

Construct Props

Name	Type	Description
configurationName	`string`	The name of the configuration.
iamRoleArn	`string`	The ARN of the IAM role that defines the permissions for AWS Chatbot .
slackChannelId	`string`	The ID of the Slack channel.
slackWorkspaceId	`string`	The ID of the Slack workspace authorized with AWS Chatbot .
guardrailPolicies?	`string[]`	The list of IAM policy ARNs that are applied as channel guardrails.
loggingLevel?	`string`	Specifies the logging level for this configuration. This property affects the log entries pushed to Amazon CloudWatch Logs.
snsTopicArns?	`string[]`	The ARNs of the SNS topics that deliver notifications to AWS Chatbot .
userRoleRequired?	`boolean \|` `IResolvable`	Enables use of a user role requirement in your chat configuration.

configurationName

Type: string

The name of the configuration.

iamRoleArn

Type: string

The ARN of 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 .

slackChannelId

Type: 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 .

slackWorkspaceId

Type: 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 .

guardrailPolicies?

Type: string[] (optional)

The list of IAM policy ARNs that are applied as channel guardrails.

The AWS managed 'AdministratorAccess' policy is applied as a default if this is not set.

loggingLevel?

Type: string (optional)

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 .

snsTopicArns?

Type: string[] (optional)

The ARNs of the SNS topics that deliver notifications to AWS Chatbot .

userRoleRequired?

Type: boolean | IResolvable (optional)

Enables use of a user role requirement in your chat configuration.

Properties

Name	Type	Description
attrArn	`string`
cfnOptions	`ICfnResourceOptions`	Options for this resource, such as condition, update policy etc.
cfnProperties	`{ [string]: any }`
cfnResourceType	`string`	AWS resource type.
configurationName	`string`	The name of the configuration.
creationStack	`string[]`
iamRoleArn	`string`	The ARN of the IAM role that defines the permissions for AWS Chatbot .
logicalId	`string`	The logical ID for this CloudFormation stack element.
node	`ConstructNode`	The construct tree node associated with this construct.
ref	`string`	Return a string that will be resolved to a CloudFormation `{ Ref }` for this element.
slackChannelId	`string`	The ID of the Slack channel.
slackWorkspaceId	`string`	The ID of the Slack workspace authorized with AWS Chatbot .
stack	`Stack`	The stack in which this element is defined.
guardrailPolicies?	`string[]`	The list of IAM policy ARNs that are applied as channel guardrails.
loggingLevel?	`string`	Specifies the logging level for this configuration. This property affects the log entries pushed to Amazon CloudWatch Logs.
snsTopicArns?	`string[]`	The ARNs of the SNS topics that deliver notifications to AWS Chatbot .
userRoleRequired?	`boolean \|` `IResolvable`	Enables use of a user role requirement in your chat configuration.
static CFN_RESOURCE_TYPE_NAME	`string`	The CloudFormation resource type name for this resource class.

attrArn

Type: string

cfnOptions

Type: ICfnResourceOptions

Options for this resource, such as condition, update policy etc.

cfnProperties

Type: { [string]: any }

cfnResourceType

Type: string

AWS resource type.

configurationName

Type: string

The name of the configuration.

creationStack

Type: string[]

iamRoleArn

Type: string

The ARN of 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 .

logicalId

Type: string

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

node

Type: ConstructNode

The construct tree node associated with this construct.

ref

Type: string

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

slackChannelId

Type: 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 .

slackWorkspaceId

Type: string

The ID of the Slack workspace authorized with AWS Chatbot .

stack

Type: Stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

guardrailPolicies?

Type: string[] (optional)

The list of IAM policy ARNs that are applied as channel guardrails.

The AWS managed 'AdministratorAccess' policy is applied as a default if this is not set.

loggingLevel?

Type: string (optional)

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 .

snsTopicArns?

Type: string[] (optional)

The ARNs of the SNS topics that deliver notifications to AWS Chatbot .

userRoleRequired?

Type: boolean | IResolvable (optional)

Enables use of a user role requirement in your chat configuration.

static CFN_RESOURCE_TYPE_NAME

Type: string

The CloudFormation resource type name for this resource class.

Methods

Name	Description
addDeletionOverride(path)	Syntactic sugar for `addOverride(path, undefined)`.
addDependsOn(target)	Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addMetadata(key, value)	Add a value to the CloudFormation Resource Metadata.
addOverride(path, value)	Adds an override to the synthesized CloudFormation resource.
addPropertyDeletionOverride(propertyPath)	Adds an override that deletes the value of a property from the resource definition.
addPropertyOverride(propertyPath, value)	Adds an override to a resource property.
applyRemovalPolicy(policy?, options?)	Sets the deletion policy of the resource based on the removal policy specified.
getAtt(attributeName)	Returns a token for an runtime attribute of this resource.
getMetadata(key)	Retrieve a value value from the CloudFormation Resource Metadata.
inspect(inspector)	Examines the CloudFormation resource and discloses attributes.
overrideLogicalId(newLogicalId)	Overrides the auto-generated logical ID with a specific ID.
toString()	Returns a string representation of this construct.
protected renderProperties(props)

addDeletionOverride(path)

public addDeletionOverride(path: string): void

Parameters

path string — The path of the value to delete.

Syntactic sugar for addOverride(path, undefined).

addDependsOn(target)

public addDependsOn(target: CfnResource): void

Parameters

target CfnResource

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

addMetadata(key, value)

public addMetadata(key: string, value: any): void

Parameters

key string
value any

Add a value to the CloudFormation Resource Metadata.

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)

addOverride(path, value)

public addOverride(path: string, value: any): void

Parameters

path string — - The path of the property, you can use dot notation to override values in complex types.
value any — - The value.

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example,

cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');

would add the overrides

"Properties": {
   "GlobalSecondaryIndexes": [
     {
       "Projection": {
         "NonKeyAttributes": [ "myattribute" ]
         ...
       }
       ...
     },
     {
       "ProjectionType": "INCLUDE"
       ...
     },
   ]
   ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

addPropertyDeletionOverride(propertyPath)

public addPropertyDeletionOverride(propertyPath: string): void

Parameters

propertyPath string — The path to the property.

Adds an override that deletes the value of a property from the resource definition.

addPropertyOverride(propertyPath, value)

public addPropertyOverride(propertyPath: string, value: any): void

Parameters

propertyPath string — The path of the property.
value any — The value.

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

applyRemovalPolicy(policy?, options?)

public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void

Parameters

policy RemovalPolicy
options RemovalPolicyOptions

Sets the deletion policy of the resource based on the removal policy specified.

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

getAtt(attributeName)

public getAtt(attributeName: string): Reference

Parameters

attributeName string — The name of the attribute.

Returns

Reference

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

getMetadata(key)

public getMetadata(key: string): any

Parameters

key string

Returns

any

Retrieve a value value from the CloudFormation Resource Metadata.

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)

inspect(inspector)

public inspect(inspector: TreeInspector): void

Parameters

inspector TreeInspector — - tree inspector to collect and process attributes.

Examines the CloudFormation resource and discloses attributes.

overrideLogicalId(newLogicalId)

public overrideLogicalId(newLogicalId: string): void

Parameters

newLogicalId string — The new logical ID to use for this stack element.

Overrides the auto-generated logical ID with a specific ID.

toString()

public toString(): string

Returns

string

Returns a string representation of this construct.

protected renderProperties(props)

protected renderProperties(props: { [string]: any }): { [string]: any }

Parameters

props { [string]: any }

Returns

{ [string]: any }