@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
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);
Modifier and Type | Interface and Description |
---|---|
static class |
SlackChannelConfigurationProps.Builder
A builder for
SlackChannelConfigurationProps |
static class |
SlackChannelConfigurationProps.Jsii$Proxy
An implementation for
SlackChannelConfigurationProps |
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.
|
@Stability(value=Stable) @NotNull String getSlackChannelConfigurationName()
@Stability(value=Stable) @NotNull String getSlackChannelId()
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.
@Stability(value=Stable) @NotNull String getSlackWorkspaceId()
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.
@Stability(value=Stable) @Nullable default LoggingLevel getLoggingLevel()
This property affects the log entries pushed to Amazon CloudWatch Logs.
Default: LoggingLevel.NONE
@Stability(value=Stable) @Nullable default RetentionDays getLogRetention()
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
@Stability(value=Stable) @Nullable default LogRetentionRetryOptions getLogRetentionRetryOptions()
These options control the retry policy when interacting with CloudWatch APIs.
Default: - Default AWS SDK retry options.
@Stability(value=Stable) @Nullable default IRole getLogRetentionRole()
Default: - A new role is created.
@Stability(value=Stable) @Nullable default List<ITopic> getNotificationTopics()
Default: None
@Stability(value=Stable) @Nullable default IRole getRole()
Default: - A role will be created.
@Stability(value=Stable) static SlackChannelConfigurationProps.Builder builder()
Copyright © 2023. All rights reserved.