software.amazon.awscdk.services.chatbot

Interface CfnSlackChannelConfigurationProps

All Known Implementing Classes:

CfnSlackChannelConfigurationProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.73.0 (build 6faeda3)",
           date="2023-01-25T18:29:02.601Z")
public interface CfnSlackChannelConfigurationProps

Properties for defining a `CfnSlackChannelConfiguration`.

Example:

 // 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
         .guardrailPolicies(List.of("guardrailPolicies"))
         .loggingLevel("loggingLevel")
         .snsTopicArns(List.of("snsTopicArns"))
         .userRoleRequired(false)
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnSlackChannelConfigurationProps.Builder A builder for CfnSlackChannelConfigurationProps
static class	CfnSlackChannelConfigurationProps.Jsii$Proxy An implementation for CfnSlackChannelConfigurationProps

Method Summary

Modifier and Type	Method and Description
static CfnSlackChannelConfigurationProps.Builder	builder()
java.lang.String	getConfigurationName() The name of the configuration.
default java.util.List<java.lang.String>	getGuardrailPolicies() The list of IAM policy ARNs that are applied as channel guardrails.
java.lang.String	getIamRoleArn() The ARN of the IAM role that defines the permissions for AWS Chatbot .
default java.lang.String	getLoggingLevel() Specifies the logging level for this configuration.
java.lang.String	getSlackChannelId() The ID of the Slack channel.
java.lang.String	getSlackWorkspaceId() The ID of the Slack workspace authorized with AWS Chatbot .
default java.util.List<java.lang.String>	getSnsTopicArns() The ARNs of the SNS topics that deliver notifications to AWS Chatbot .
default java.lang.Object	getUserRoleRequired() Enables use of a user role requirement in your chat configuration.

Method Detail

getConfigurationName

java.lang.String getConfigurationName()

The name of the configuration.

getIamRoleArn

java.lang.String getIamRoleArn()

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 .

getSlackChannelId

java.lang.String getSlackChannelId()

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 .

getSlackWorkspaceId

java.lang.String getSlackWorkspaceId()

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 .

getGuardrailPolicies

default java.util.List<java.lang.String> getGuardrailPolicies()

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.

getLoggingLevel

default java.lang.String getLoggingLevel()

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 .

getSnsTopicArns

default java.util.List<java.lang.String> getSnsTopicArns()

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

getUserRoleRequired

default java.lang.Object getUserRoleRequired()

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

builder

static CfnSlackChannelConfigurationProps.Builder builder()

Returns:

a CfnSlackChannelConfigurationProps.Builder of CfnSlackChannelConfigurationProps