software.amazon.awscdk.services.chatbot

Interface CfnSlackChannelConfigurationProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnSlackChannelConfigurationProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:36.984Z")
 @Stability(value=Stable)
public interface CfnSlackChannelConfigurationProps
extends software.amazon.jsii.JsiiSerializable

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()
String	getConfigurationName() The name of the configuration.
default List<String>	getGuardrailPolicies() The list of IAM policy ARNs that are applied as channel guardrails.
String	getIamRoleArn() The ARN of the IAM role that defines the permissions for AWS Chatbot .
default String	getLoggingLevel() Specifies the logging level for this configuration.
String	getSlackChannelId() The ID of the Slack channel.
String	getSlackWorkspaceId() The ID of the Slack workspace authorized with AWS Chatbot .
default List<String>	getSnsTopicArns() The ARNs of the SNS topics that deliver notifications to AWS Chatbot .
default Object	getUserRoleRequired() Enables use of a user role requirement in your chat configuration.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getConfigurationName

@Stability(value=Stable)
 @NotNull
String getConfigurationName()

The name of the configuration.

getIamRoleArn

@Stability(value=Stable)
 @NotNull
String getIamRoleArn()

The ARN of the IAM role that defines the permissions for AWS Chatbot .

This is a user-definworked role that AWS Chatbot will assume. This is not the service-linked role. For more information, see IAM Policies for AWS Chatbot .

getSlackChannelId

@Stability(value=Stable)
 @NotNull
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

@Stability(value=Stable)
 @NotNull
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

@Stability(value=Stable)
 @Nullable
default List<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

@Stability(value=Stable)
 @Nullable
default 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

@Stability(value=Stable)
 @Nullable
default List<String> getSnsTopicArns()

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

getUserRoleRequired

@Stability(value=Stable)
 @Nullable
default Object getUserRoleRequired()

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

builder

@Stability(value=Stable)
static CfnSlackChannelConfigurationProps.Builder builder()

Returns:

a CfnSlackChannelConfigurationProps.Builder of CfnSlackChannelConfigurationProps