Interface SlackChannelConfigurationProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
SlackChannelConfigurationProps.Jsii$Proxy
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 ClassesModifier and TypeInterfaceDescriptionstatic final class
A builder forSlackChannelConfigurationProps
static final class
An implementation forSlackChannelConfigurationProps
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
default LoggingLevel
Specifies the logging level for this configuration.default RetentionDays
The number of days log events are kept in CloudWatch Logs.default LogRetentionRetryOptions
When log retention is specified, a custom resource attempts to create the CloudWatch log group.default IRole
The IAM role for the Lambda function associated with the custom resource that sets the retention policy.The SNS topics that deliver notifications to AWS Chatbot.default IRole
getRole()
The permission role of Slack channel configuration.The name of Slack channel configuration.The ID of the Slack channel.The ID of the Slack workspace authorized with AWS Chatbot.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getSlackChannelConfigurationName
The name of Slack channel configuration. -
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
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:
-
getLoggingLevel
Specifies the logging level for this configuration.This property affects the log entries pushed to Amazon CloudWatch Logs.
Default: LoggingLevel.NONE
-
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
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
The IAM role for the Lambda function associated with the custom resource that sets the retention policy.Default: - A new role is created.
-
getNotificationTopics
The SNS topics that deliver notifications to AWS Chatbot.Default: None
-
getRole
The permission role of Slack channel configuration.Default: - A role will be created.
-
builder
-