Class SlackChannelConfigurationProps.Builder
java.lang.Object
software.amazon.awscdk.services.chatbot.SlackChannelConfigurationProps.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<SlackChannelConfigurationProps>
- Enclosing interface:
SlackChannelConfigurationProps
@Stability(Stable)
public static final class SlackChannelConfigurationProps.Builder
extends Object
implements software.amazon.jsii.Builder<SlackChannelConfigurationProps>
A builder for
SlackChannelConfigurationProps
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuild()
Builds the configured instance.guardrailPolicies
(List<? extends IManagedPolicy> guardrailPolicies) Sets the value ofSlackChannelConfigurationProps.getGuardrailPolicies()
loggingLevel
(LoggingLevel loggingLevel) Sets the value ofSlackChannelConfigurationProps.getLoggingLevel()
logRetention
(RetentionDays logRetention) Sets the value ofSlackChannelConfigurationProps.getLogRetention()
logRetentionRetryOptions
(LogRetentionRetryOptions logRetentionRetryOptions) Sets the value ofSlackChannelConfigurationProps.getLogRetentionRetryOptions()
logRetentionRole
(IRole logRetentionRole) Sets the value ofSlackChannelConfigurationProps.getLogRetentionRole()
notificationTopics
(List<? extends ITopic> notificationTopics) Sets the value ofSlackChannelConfigurationProps.getNotificationTopics()
Sets the value ofSlackChannelConfigurationProps.getRole()
slackChannelConfigurationName
(String slackChannelConfigurationName) Sets the value ofSlackChannelConfigurationProps.getSlackChannelConfigurationName()
slackChannelId
(String slackChannelId) Sets the value ofSlackChannelConfigurationProps.getSlackChannelId()
slackWorkspaceId
(String slackWorkspaceId) Sets the value ofSlackChannelConfigurationProps.getSlackWorkspaceId()
userRoleRequired
(Boolean userRoleRequired) Sets the value ofSlackChannelConfigurationProps.getUserRoleRequired()
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
slackChannelConfigurationName
@Stability(Stable) public SlackChannelConfigurationProps.Builder slackChannelConfigurationName(String slackChannelConfigurationName) Sets the value ofSlackChannelConfigurationProps.getSlackChannelConfigurationName()
- Parameters:
slackChannelConfigurationName
- The name of Slack channel configuration. This parameter is required.- Returns:
this
-
slackChannelId
@Stability(Stable) public SlackChannelConfigurationProps.Builder slackChannelId(String slackChannelId) Sets the value ofSlackChannelConfigurationProps.getSlackChannelId()
- Parameters:
slackChannelId
- The ID of the Slack channel. This parameter is required. 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.- Returns:
this
-
slackWorkspaceId
@Stability(Stable) public SlackChannelConfigurationProps.Builder slackWorkspaceId(String slackWorkspaceId) Sets the value ofSlackChannelConfigurationProps.getSlackWorkspaceId()
- Parameters:
slackWorkspaceId
- The ID of the Slack workspace authorized with AWS Chatbot. This parameter is required. 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.- Returns:
this
-
guardrailPolicies
@Stability(Stable) public SlackChannelConfigurationProps.Builder guardrailPolicies(List<? extends IManagedPolicy> guardrailPolicies) Sets the value ofSlackChannelConfigurationProps.getGuardrailPolicies()
- Parameters:
guardrailPolicies
- A list of IAM managed policies that are applied as channel guardrails.- Returns:
this
-
loggingLevel
@Stability(Stable) public SlackChannelConfigurationProps.Builder loggingLevel(LoggingLevel loggingLevel) Sets the value ofSlackChannelConfigurationProps.getLoggingLevel()
- Parameters:
loggingLevel
- Specifies the logging level for this configuration. This property affects the log entries pushed to Amazon CloudWatch Logs.- Returns:
this
-
logRetention
@Stability(Stable) public SlackChannelConfigurationProps.Builder logRetention(RetentionDays logRetention) Sets the value ofSlackChannelConfigurationProps.getLogRetention()
- Parameters:
logRetention
- 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 toINFINITE
.- Returns:
this
-
logRetentionRetryOptions
@Stability(Stable) public SlackChannelConfigurationProps.Builder logRetentionRetryOptions(LogRetentionRetryOptions logRetentionRetryOptions) Sets the value ofSlackChannelConfigurationProps.getLogRetentionRetryOptions()
- Parameters:
logRetentionRetryOptions
- 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.- Returns:
this
-
logRetentionRole
@Stability(Stable) public SlackChannelConfigurationProps.Builder logRetentionRole(IRole logRetentionRole) Sets the value ofSlackChannelConfigurationProps.getLogRetentionRole()
- Parameters:
logRetentionRole
- The IAM role for the Lambda function associated with the custom resource that sets the retention policy.- Returns:
this
-
notificationTopics
@Stability(Stable) public SlackChannelConfigurationProps.Builder notificationTopics(List<? extends ITopic> notificationTopics) Sets the value ofSlackChannelConfigurationProps.getNotificationTopics()
- Parameters:
notificationTopics
- The SNS topics that deliver notifications to AWS Chatbot.- Returns:
this
-
role
Sets the value ofSlackChannelConfigurationProps.getRole()
- Parameters:
role
- The permission role of Slack channel configuration.- Returns:
this
-
userRoleRequired
@Stability(Stable) public SlackChannelConfigurationProps.Builder userRoleRequired(Boolean userRoleRequired) Sets the value ofSlackChannelConfigurationProps.getUserRoleRequired()
- Parameters:
userRoleRequired
- Enables use of a user role requirement in your chat configuration.- Returns:
this
-
build
Builds the configured instance.- Specified by:
build
in interfacesoftware.amazon.jsii.Builder<SlackChannelConfigurationProps>
- Returns:
- a new instance of
SlackChannelConfigurationProps
- Throws:
NullPointerException
- if any required attribute was not provided
-