Package 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.104.0 (build e79254c)", date="2024-11-06T23:25:05.295Z") @Stability(Stable) public interface SlackChannelConfigurationProps extends software.amazon.jsii.JsiiSerializable
Properties for a new Slack channel configuration.

Example: 

 import software.amazon.awscdk.services.chatbot.*;
 Project project;
 SlackChannelConfiguration target = SlackChannelConfiguration.Builder.create(this, "MySlackChannel")
         .slackChannelConfigurationName("YOUR_CHANNEL_NAME")
         .slackWorkspaceId("YOUR_SLACK_WORKSPACE_ID")
         .slackChannelId("YOUR_SLACK_CHANNEL_ID")
         .build();
 INotificationRule rule = project.notifyOnBuildSucceeded("NotifyOnBuildSucceeded", target);

  • Method Details

    • getSlackChannelConfigurationName

      @Stability(Stable) @NotNull String getSlackChannelConfigurationName()
      The name of Slack channel configuration.

    • getSlackChannelId

      @Stability(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(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:

    • getGuardrailPolicies

      @Stability(Stable) @Nullable default List<IManagedPolicy> getGuardrailPolicies()
      A list of IAM managed policies that are applied as channel guardrails.

      Default: - The AWS managed 'AdministratorAccess' policy is applied as a default if this is not set.

    • getLoggingLevel

      @Stability(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(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(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(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(Stable) @Nullable default List<ITopic> getNotificationTopics()
      The SNS topics that deliver notifications to AWS Chatbot.

      Default: None

    • getRole

      @Stability(Stable) @Nullable default IRole getRole()
      The permission role of Slack channel configuration.

      Default: - A role will be created.

    • getUserRoleRequired

      @Stability(Stable) @Nullable default Boolean getUserRoleRequired()
      Enables use of a user role requirement in your chat configuration.

      Default: false

    • builder

      @Stability(Stable) static SlackChannelConfigurationProps.Builder builder()
      Returns:
      a SlackChannelConfigurationProps.Builder of SlackChannelConfigurationProps