Skip to content
v2.278.0

CfnSlackChannelConfigurationProps Struct ​

Properties for defining a CfnSlackChannelConfiguration.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_chatbot as chatbot } from 'aws-cdk-lib';
const cfnSlackChannelConfigurationProps: chatbot.CfnSlackChannelConfigurationProps = {
  configurationName: 'configurationName',
  iamRoleArn: 'iamRoleArn',
  slackChannelId: 'slackChannelId',
  slackWorkspaceId: 'slackWorkspaceId',

  // the properties below are optional
  customizationResourceArns: ['customizationResourceArns'],
  guardrailPolicies: ['guardrailPolicies'],
  loggingLevel: 'loggingLevel',
  snsTopicArns: ['snsTopicArns'],
  tags: [{
    key: 'key',
    value: 'value',
  }],
  userRoleRequired: false,
};
python
from aws_cdk import CfnTag
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_chatbot as chatbot

cfn_slack_channel_configuration_props = chatbot.CfnSlackChannelConfigurationProps(
    configuration_name="configurationName",
    iam_role_arn="iamRoleArn",
    slack_channel_id="slackChannelId",
    slack_workspace_id="slackWorkspaceId",

    # the properties below are optional
    customization_resource_arns=["customizationResourceArns"],
    guardrail_policies=["guardrailPolicies"],
    logging_level="loggingLevel",
    sns_topic_arns=["snsTopicArns"],
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    user_role_required=False
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.chatbot.*;

CfnSlackChannelConfigurationProps cfnSlackChannelConfigurationProps = CfnSlackChannelConfigurationProps.builder()
        .configurationName("configurationName")
        .iamRoleArn("iamRoleArn")
        .slackChannelId("slackChannelId")
        .slackWorkspaceId("slackWorkspaceId")

        // the properties below are optional
        .customizationResourceArns(List.of("customizationResourceArns"))
        .guardrailPolicies(List.of("guardrailPolicies"))
        .loggingLevel("loggingLevel")
        .snsTopicArns(List.of("snsTopicArns"))
        .tags(List.of(CfnTag.builder()
                .key("key")
                .value("value")
                .build()))
        .userRoleRequired(false)
        .build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Chatbot;

var cfnSlackChannelConfigurationProps = new CfnSlackChannelConfigurationProps {
    ConfigurationName = "configurationName",
    IamRoleArn = "iamRoleArn",
    SlackChannelId = "slackChannelId",
    SlackWorkspaceId = "slackWorkspaceId",

    // the properties below are optional
    CustomizationResourceArns = new [] { "customizationResourceArns" },
    GuardrailPolicies = new [] { "guardrailPolicies" },
    LoggingLevel = "loggingLevel",
    SnsTopicArns = new [] { "snsTopicArns" },
    Tags = new [] { new CfnTag {
        Key = "key",
        Value = "value"
    } },
    UserRoleRequired = false
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

cfnSlackChannelConfigurationProps := &CfnSlackChannelConfigurationProps{
	ConfigurationName: jsii.String("configurationName"),
	IamRoleArn: jsii.String("iamRoleArn"),
	SlackChannelId: jsii.String("slackChannelId"),
	SlackWorkspaceId: jsii.String("slackWorkspaceId"),

	// the properties below are optional
	CustomizationResourceArns: []*string{
		jsii.String("customizationResourceArns"),
	},
	GuardrailPolicies: []*string{
		jsii.String("guardrailPolicies"),
	},
	LoggingLevel: jsii.String("loggingLevel"),
	SnsTopicArns: []interface{}{
		jsii.String("snsTopicArns"),
	},
	Tags: []CfnTag{
		&CfnTag{
			Key: jsii.String("key"),
			Value: jsii.String("value"),
		},
	},
	UserRoleRequired: jsii.Boolean(false),
}

Properties ​

configurationNamestringconfiguration_namestrconfigurationNameStringConfigurationNamestringConfigurationName*string required #
The name of the configuration.
customizationResourceArnsoptionalstring[]customization_resource_arnsoptionaltyping.List[str]customizationResourceArnsoptionalList<String>CustomizationResourceArnsoptionalstring[]CustomizationResourceArnsoptional*[]*string #
Links a list of resource ARNs (for example, custom action ARNs) to a Slack channel configuration for Amazon Q Developer .
guardrailPoliciesoptionalstring[]guardrail_policiesoptionaltyping.List[str]guardrailPoliciesoptionalList<String>GuardrailPoliciesoptionalstring[]GuardrailPoliciesoptional*[]*string #
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.

iamRoleArnstring | IRoleRefiam_role_arntyping.Union[str, IRoleRef]iamRoleArnStringIamRoleArnstringIamRoleArninterface{} required #
The ARN of the IAM role that defines the permissions for Amazon Q Developer .
notes

This is a user-defined role that Amazon Q Developer will assume. This is not the service-linked role. For more information, see IAM Policies for Amazon Q Developer in chat applications .

loggingLeveloptionalstringlogging_leveloptionalstrloggingLeveloptionalStringLoggingLeveloptionalstringLoggingLeveloptional*string = "NONE" #
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 .

slackChannelIdstringslack_channel_idstrslackChannelIdStringSlackChannelIdstringSlackChannelId*string required #
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 character string at the end of the URL. For example, ABCBBLZZZ .

slackWorkspaceIdstringslack_workspace_idstrslackWorkspaceIdStringSlackWorkspaceIdstringSlackWorkspaceId*string required #
The ID of the Slack workspace authorized with Amazon Q Developer .
notes

To get the workspace ID, you must perform the initial authorization flow with Slack in the Amazon Q Developer in chat applications console. Then you can copy and paste the workspace ID from the console. For more details, see steps 1-3 in Tutorial: Get started with Slack in the Amazon Q Developer in chat applications User Guide .

snsTopicArnsoptionalstring | ITopicRef[]sns_topic_arnsoptionaltyping.List[typing.Union[str, ITopicRef]]snsTopicArnsoptionalList<String>SnsTopicArnsoptionalstring[]SnsTopicArnsoptional*[]interface{} #
The ARNs of the SNS topics that deliver notifications to Amazon Q Developer .
tagsoptionalCfnTag[]tagsoptionaltyping.List[CfnTag]tagsoptionalList<CfnTag>TagsoptionalCfnTag[]Tagsoptional*[]CfnTag #
The tags to add to the configuration.
userRoleRequiredoptionalboolean | IResolvableuser_role_requiredoptionaltyping.Union[bool, IResolvable]userRoleRequiredoptionalBooleanUserRoleRequiredoptionalboolUserRoleRequiredoptionalinterface{} = false #
Enables use of a user role requirement in your chat configuration.