software.amazon.awscdk.services.chatbot

Class CfnSlackChannelConfiguration.Builder

java.lang.Object

software.amazon.awscdk.services.chatbot.CfnSlackChannelConfiguration.Builder

Enclosing class:

CfnSlackChannelConfiguration

public static final class CfnSlackChannelConfiguration.Builder
extends java.lang.Object

A fluent builder for CfnSlackChannelConfiguration.

Method Summary

Modifier and Type	Method and Description
CfnSlackChannelConfiguration	build()
CfnSlackChannelConfiguration.Builder	configurationName(java.lang.String configurationName) The name of the configuration.
static CfnSlackChannelConfiguration.Builder	create(Construct scope, java.lang.String id)
CfnSlackChannelConfiguration.Builder	guardrailPolicies(java.util.List<java.lang.String> guardrailPolicies) The list of IAM policy ARNs that are applied as channel guardrails.
CfnSlackChannelConfiguration.Builder	iamRoleArn(java.lang.String iamRoleArn) The ARN of the IAM role that defines the permissions for AWS Chatbot .
CfnSlackChannelConfiguration.Builder	loggingLevel(java.lang.String loggingLevel) Specifies the logging level for this configuration.
CfnSlackChannelConfiguration.Builder	slackChannelId(java.lang.String slackChannelId) The ID of the Slack channel.
CfnSlackChannelConfiguration.Builder	slackWorkspaceId(java.lang.String slackWorkspaceId) The ID of the Slack workspace authorized with AWS Chatbot .
CfnSlackChannelConfiguration.Builder	snsTopicArns(java.util.List<java.lang.String> snsTopicArns) The ARNs of the SNS topics that deliver notifications to AWS Chatbot .
CfnSlackChannelConfiguration.Builder	userRoleRequired(java.lang.Boolean userRoleRequired) Enables use of a user role requirement in your chat configuration.
CfnSlackChannelConfiguration.Builder	userRoleRequired(IResolvable userRoleRequired) Enables use of a user role requirement in your chat configuration.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

public static CfnSlackChannelConfiguration.Builder create(Construct scope,
                                                          java.lang.String id)

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

Returns:

a new instance of CfnSlackChannelConfiguration.Builder.

configurationName

public CfnSlackChannelConfiguration.Builder configurationName(java.lang.String configurationName)

The name of the configuration.

Parameters:

configurationName - The name of the configuration. This parameter is required.

Returns:

this

iamRoleArn

public CfnSlackChannelConfiguration.Builder iamRoleArn(java.lang.String iamRoleArn)

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 .

Parameters:

iamRoleArn - The ARN of the IAM role that defines the permissions for AWS Chatbot . This parameter is required.

Returns:

this

slackChannelId

public CfnSlackChannelConfiguration.Builder slackChannelId(java.lang.String slackChannelId)

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 .

Parameters:

slackChannelId - The ID of the Slack channel. This parameter is required.

Returns:

this

slackWorkspaceId

public CfnSlackChannelConfiguration.Builder slackWorkspaceId(java.lang.String slackWorkspaceId)

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 .

Parameters:

slackWorkspaceId - The ID of the Slack workspace authorized with AWS Chatbot . This parameter is required.

Returns:

this

guardrailPolicies

public CfnSlackChannelConfiguration.Builder guardrailPolicies(java.util.List<java.lang.String> guardrailPolicies)

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.

Parameters:

guardrailPolicies - The list of IAM policy ARNs that are applied as channel guardrails. This parameter is required.

Returns:

this

loggingLevel

public CfnSlackChannelConfiguration.Builder loggingLevel(java.lang.String loggingLevel)

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 .

Parameters:

loggingLevel - Specifies the logging level for this configuration. This property affects the log entries pushed to Amazon CloudWatch Logs. This parameter is required.

Returns:

this

snsTopicArns

public CfnSlackChannelConfiguration.Builder snsTopicArns(java.util.List<java.lang.String> snsTopicArns)

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

Parameters:

snsTopicArns - The ARNs of the SNS topics that deliver notifications to AWS Chatbot . This parameter is required.

Returns:

this

userRoleRequired

public CfnSlackChannelConfiguration.Builder userRoleRequired(java.lang.Boolean userRoleRequired)

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

Parameters:

userRoleRequired - Enables use of a user role requirement in your chat configuration. This parameter is required.

Returns:

this

userRoleRequired

public CfnSlackChannelConfiguration.Builder userRoleRequired(IResolvable userRoleRequired)

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

Parameters:

userRoleRequired - Enables use of a user role requirement in your chat configuration. This parameter is required.

Returns:

this

build

public CfnSlackChannelConfiguration build()