software.amazon.awscdk.services.chatbot

Interface SlackChannelConfigurationProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

SlackChannelConfigurationProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-05-19T23:09:25.246Z")
 @Stability(value=Stable)
public interface SlackChannelConfigurationProps
extends software.amazon.jsii.JsiiSerializable

Properties for a new Slack channel configuration.

Example:

 // Define CodeStar Notification rules for Pipelines
 import software.amazon.awscdk.services.chatbot.*;
 Pipeline pipeline;
 SlackChannelConfiguration target = SlackChannelConfiguration.Builder.create(this, "MySlackChannel")
         .slackChannelConfigurationName("YOUR_CHANNEL_NAME")
         .slackWorkspaceId("YOUR_SLACK_WORKSPACE_ID")
         .slackChannelId("YOUR_SLACK_CHANNEL_ID")
         .build();
 INotificationRule rule = pipeline.notifyOnExecutionStateChange("NotifyOnExecutionStateChange", target);
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static SlackChannelConfigurationProps.Builder	builder()
default LoggingLevel	getLoggingLevel() Specifies the logging level for this configuration.
default RetentionDays	getLogRetention() The number of days log events are kept in CloudWatch Logs.
default LogRetentionRetryOptions	getLogRetentionRetryOptions() When log retention is specified, a custom resource attempts to create the CloudWatch log group.
default IRole	getLogRetentionRole() The IAM role for the Lambda function associated with the custom resource that sets the retention policy.
default List<ITopic>	getNotificationTopics() The SNS topics that deliver notifications to AWS Chatbot.
default IRole	getRole() The permission role of Slack channel configuration.
String	getSlackChannelConfigurationName() The name of Slack channel configuration.
String	getSlackChannelId() The ID of the Slack channel.
String	getSlackWorkspaceId() The ID of the Slack workspace authorized with AWS Chatbot.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getSlackChannelConfigurationName

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

The name of Slack channel configuration.

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.

See Also:

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

getLoggingLevel

@Stability(value=Stable)
 @Nullable
default LoggingLevel getLoggingLevel()

Specifies the logging level for this configuration.

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

Default: LoggingLevel.NONE

getLogRetention

@Stability(value=Stable)
 @Nullable
default RetentionDays getLogRetention()

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

getLogRetentionRetryOptions

@Stability(value=Stable)
 @Nullable
default LogRetentionRetryOptions getLogRetentionRetryOptions()

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.

getLogRetentionRole

@Stability(value=Stable)
 @Nullable
default IRole getLogRetentionRole()

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

Default: - A new role is created.

getNotificationTopics

@Stability(value=Stable)
 @Nullable
default List<ITopic> getNotificationTopics()

The SNS topics that deliver notifications to AWS Chatbot.

Default: None

getRole

@Stability(value=Stable)
 @Nullable
default IRole getRole()

The permission role of Slack channel configuration.

Default: - A role will be created.

builder

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

Returns:

a SlackChannelConfigurationProps.Builder of SlackChannelConfigurationProps