software.amazon.awscdk.services.chatbot

Class SlackChannelConfiguration.Builder

java.lang.Object

software.amazon.awscdk.services.chatbot.SlackChannelConfiguration.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<SlackChannelConfiguration>

Enclosing class:

SlackChannelConfiguration

@Stability(value=Experimental)
public static final class SlackChannelConfiguration.Builder
extends Object
implements software.amazon.jsii.Builder<SlackChannelConfiguration>

(experimental) A fluent builder for SlackChannelConfiguration.

Method Summary

Modifier and Type	Method and Description
SlackChannelConfiguration	build()
static SlackChannelConfiguration.Builder	create(software.constructs.Construct scope, String id)
SlackChannelConfiguration.Builder	loggingLevel(LoggingLevel loggingLevel) (experimental) Specifies the logging level for this configuration.
SlackChannelConfiguration.Builder	logRetention(RetentionDays logRetention) (experimental) The number of days log events are kept in CloudWatch Logs.
SlackChannelConfiguration.Builder	logRetentionRetryOptions(LogRetentionRetryOptions logRetentionRetryOptions) (experimental) When log retention is specified, a custom resource attempts to create the CloudWatch log group.
SlackChannelConfiguration.Builder	logRetentionRole(IRole logRetentionRole) (experimental) The IAM role for the Lambda function associated with the custom resource that sets the retention policy.
SlackChannelConfiguration.Builder	notificationTopics(List<? extends ITopic> notificationTopics) (experimental) The SNS topics that deliver notifications to AWS Chatbot.
SlackChannelConfiguration.Builder	role(IRole role) (experimental) The permission role of Slack channel configuration.
SlackChannelConfiguration.Builder	slackChannelConfigurationName(String slackChannelConfigurationName) (experimental) The name of Slack channel configuration.
SlackChannelConfiguration.Builder	slackChannelId(String slackChannelId) (experimental) The ID of the Slack channel.
SlackChannelConfiguration.Builder	slackWorkspaceId(String slackWorkspaceId) (experimental) The ID of the Slack workspace authorized with AWS Chatbot.

Methods inherited from class java.lang.Object

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

Method Detail

create

@Stability(value=Experimental)
public static SlackChannelConfiguration.Builder create(software.constructs.Construct scope,
                                                                                      String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Returns:

a new instance of SlackChannelConfiguration.Builder.

slackChannelConfigurationName

@Stability(value=Experimental)
public SlackChannelConfiguration.Builder slackChannelConfigurationName(String slackChannelConfigurationName)

(experimental) The name of Slack channel configuration.

Parameters:

slackChannelConfigurationName - The name of Slack channel configuration. This parameter is required.

Returns:

this

slackChannelId

@Stability(value=Experimental)
public SlackChannelConfiguration.Builder slackChannelId(String slackChannelId)

(experimental) 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

@Stability(value=Experimental)
public SlackChannelConfiguration.Builder slackWorkspaceId(String slackWorkspaceId)

(experimental) 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

See Also:

https://docs.aws.amazon.com/chatbot/latest/adminguide/setting-up.html#Setup_intro

loggingLevel

@Stability(value=Experimental)
public SlackChannelConfiguration.Builder loggingLevel(LoggingLevel loggingLevel)

(experimental) Specifies the logging level for this configuration.

This property affects the log entries pushed to Amazon CloudWatch Logs.

Default: LoggingLevel.NONE

Parameters:

loggingLevel - Specifies the logging level for this configuration. This parameter is required.

Returns:

this

logRetention

@Stability(value=Experimental)
public SlackChannelConfiguration.Builder logRetention(RetentionDays logRetention)

(experimental) The number of days log events are kept in CloudWatch Logs.

When updating this property, unsetting it doesn't remove the log retention policy. To remove the retention policy, set the value to INFINITE.

Default: logs.RetentionDays.INFINITE

Parameters:

logRetention - The number of days log events are kept in CloudWatch Logs. This parameter is required.

Returns:

this

logRetentionRetryOptions

@Stability(value=Experimental)
public SlackChannelConfiguration.Builder logRetentionRetryOptions(LogRetentionRetryOptions logRetentionRetryOptions)

(experimental) When log retention is specified, a custom resource attempts to create the CloudWatch log group.

These options control the retry policy when interacting with CloudWatch APIs.

Default: - Default AWS SDK retry options.

Parameters:

logRetentionRetryOptions - When log retention is specified, a custom resource attempts to create the CloudWatch log group. This parameter is required.

Returns:

this

logRetentionRole

@Stability(value=Experimental)
public SlackChannelConfiguration.Builder logRetentionRole(IRole logRetentionRole)

(experimental) The IAM role for the Lambda function associated with the custom resource that sets the retention policy.

Default: - A new role is created.

Parameters:

logRetentionRole - The IAM role for the Lambda function associated with the custom resource that sets the retention policy. This parameter is required.

Returns:

this

notificationTopics

@Stability(value=Experimental)
public SlackChannelConfiguration.Builder notificationTopics(List<? extends ITopic> notificationTopics)

(experimental) The SNS topics that deliver notifications to AWS Chatbot.

Default: None

Parameters:

notificationTopics - The SNS topics that deliver notifications to AWS Chatbot. This parameter is required.

Returns:

this

role

@Stability(value=Experimental)
public SlackChannelConfiguration.Builder role(IRole role)

(experimental) The permission role of Slack channel configuration.

Default: - A role will be created.

Parameters:

role - The permission role of Slack channel configuration. This parameter is required.

Returns:

this

build

@Stability(value=Experimental)
public SlackChannelConfiguration build()

Specified by:

build in interface software.amazon.jsii.Builder<SlackChannelConfiguration>