Package 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.104.0 (build e79254c)",
           date="2024-11-22T02:23:58.017Z")
@Stability(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"))
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .userRoleRequired(false)
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-chatbot-slackchannelconfiguration.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	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 List<CfnTag>	getTags()	The tags to add to the configuration.
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 Details

getConfigurationName

@Stability(Stable)
@NotNull
String getConfigurationName()

The name of the configuration.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-chatbot-slackchannelconfiguration.html#cfn-chatbot-slackchannelconfiguration-configurationname

getIamRoleArn

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-chatbot-slackchannelconfiguration.html#cfn-chatbot-slackchannelconfiguration-iamrolearn

getSlackChannelId

@Stability(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 character string at the end of the URL. For example, ABCBBLZZZ .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-chatbot-slackchannelconfiguration.html#cfn-chatbot-slackchannelconfiguration-slackchannelid

getSlackWorkspaceId

@Stability(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-3 in Tutorial: Get started with Slack in the AWS Chatbot User Guide .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-chatbot-slackchannelconfiguration.html#cfn-chatbot-slackchannelconfiguration-slackworkspaceid

getGuardrailPolicies

@Stability(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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-chatbot-slackchannelconfiguration.html#cfn-chatbot-slackchannelconfiguration-guardrailpolicies

getLoggingLevel

@Stability(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 .

Default: - "NONE"

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-chatbot-slackchannelconfiguration.html#cfn-chatbot-slackchannelconfiguration-logginglevel

getSnsTopicArns

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

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-chatbot-slackchannelconfiguration.html#cfn-chatbot-slackchannelconfiguration-snstopicarns

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

The tags to add to the configuration.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-chatbot-slackchannelconfiguration.html#cfn-chatbot-slackchannelconfiguration-tags

getUserRoleRequired

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

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

Default: - false

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-chatbot-slackchannelconfiguration.html#cfn-chatbot-slackchannelconfiguration-userrolerequired

builder

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

Returns:

a CfnSlackChannelConfigurationProps.Builder of CfnSlackChannelConfigurationProps