aws-cdk-lib.aws_chatbot.SlackChannelConfigurationProps

SlackChannelConfigurationProps Struct

Properties for a new Slack channel configuration.

SlackChannelConfigurationProps

used as props by

• SlackChannelConfiguration

Source

aws-chatbot/lib/slack-channel-configuration.ts

Type last changed

v2.145.0 · 7 Jun 2024

Example

import * as chatbot from 'aws-cdk-lib/aws-chatbot';

declare const project: codebuild.Project;

const target = new chatbot.SlackChannelConfiguration(this, 'MySlackChannel', {
  slackChannelConfigurationName: 'YOUR_CHANNEL_NAME',
  slackWorkspaceId: 'YOUR_SLACK_WORKSPACE_ID',
  slackChannelId: 'YOUR_SLACK_CHANNEL_ID',
});

const rule = project.notifyOnBuildSucceeded('NotifyOnBuildSucceeded', target);

import aws_cdk.aws_chatbot as chatbot

# project: codebuild.Project


target = chatbot.SlackChannelConfiguration(self, "MySlackChannel",
    slack_channel_configuration_name="YOUR_CHANNEL_NAME",
    slack_workspace_id="YOUR_SLACK_WORKSPACE_ID",
    slack_channel_id="YOUR_SLACK_CHANNEL_ID"
)

rule = project.notify_on_build_succeeded("NotifyOnBuildSucceeded", target)

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);

// Install: dotnet add package Amazon.CDK.Lib
using Amazon.CDK.AWS.Chatbot;

Project project;


var target = new SlackChannelConfiguration(this, "MySlackChannel", new SlackChannelConfigurationProps {
    SlackChannelConfigurationName = "YOUR_CHANNEL_NAME",
    SlackWorkspaceId = "YOUR_SLACK_WORKSPACE_ID",
    SlackChannelId = "YOUR_SLACK_CHANNEL_ID"
});

var rule = project.NotifyOnBuildSucceeded("NotifyOnBuildSucceeded", target);

// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
import chatbot "github.com/aws/aws-cdk-go/awscdk"

var project Project


target := chatbot.NewSlackChannelConfiguration(this, jsii.String("MySlackChannel"), &SlackChannelConfigurationProps{
	SlackChannelConfigurationName: jsii.String("YOUR_CHANNEL_NAME"),
	SlackWorkspaceId: jsii.String("YOUR_SLACK_WORKSPACE_ID"),
	SlackChannelId: jsii.String("YOUR_SLACK_CHANNEL_ID"),
})

rule := project.notifyOnBuildSucceeded(jsii.String("NotifyOnBuildSucceeded"), target)

Properties

guardrailPolicies?optionalIManagedPolicy[]guardrail_policies?optionaltyping.List[IManagedPolicy]guardrailPolicies?optionalList<IManagedPolicy>GuardrailPolicies?optionalIManagedPolicy[]GuardrailPolicies?optional*[]IManagedPolicy#

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.

loggingLevel?optionalLoggingLevellogging_level?optionalLoggingLevelloggingLevel?optionalLoggingLevelLoggingLevel?optionalLoggingLevelLoggingLevel?optionalLoggingLevel= LoggingLevel.NONE#

Specifies the logging level for this configuration.

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

logRetention?optionalRetentionDayslog_retention?optionalRetentionDayslogRetention?optionalRetentionDaysLogRetention?optionalRetentionDaysLogRetention?optionalRetentionDays= logs.RetentionDays.INFINITE#

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.

logRetentionRetryOptions?optionalLogRetentionRetryOptionslog_retention_retry_options?optionalLogRetentionRetryOptionslogRetentionRetryOptions?optionalLogRetentionRetryOptionsLogRetentionRetryOptions?optionalLogRetentionRetryOptionsLogRetentionRetryOptions?optionalLogRetentionRetryOptions#

When log retention is specified, a custom resource attempts to create the CloudWatch log group.

Default: Default AWS SDK retry options.

These options control the retry policy when interacting with CloudWatch APIs.

logRetentionRole?optionalIRolelog_retention_role?optionalIRolelogRetentionRole?optionalIRoleLogRetentionRole?optionalIRoleLogRetentionRole?optionalIRole#

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

Default: A new role is created.

notificationTopics?optionalITopic[]notification_topics?optionaltyping.List[ITopic]notificationTopics?optionalList<ITopic>NotificationTopics?optionalITopic[]NotificationTopics?optional*[]ITopic= None#

The SNS topics that deliver notifications to AWS Chatbot.

role?optionalIRolerole?optionalIRolerole?optionalIRoleRole?optionalIRoleRole?optionalIRole#

The permission role of Slack channel configuration.

Default: A role will be created.

slackChannelConfigurationNamestringslack_channel_configuration_namestrslackChannelConfigurationNameStringSlackChannelConfigurationNamestringSlackChannelConfigurationName*stringrequired#

The name of Slack channel configuration.

slackChannelIdstringslack_channel_idstrslackChannelIdStringSlackChannelIdstringSlackChannelId*stringrequired#

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.

slackWorkspaceIdstringslack_workspace_idstrslackWorkspaceIdStringSlackWorkspaceIdstringSlackWorkspaceId*stringrequired#

The ID of the Slack workspace authorized with AWS Chatbot.

notes

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.

userRoleRequired?optionalbooleanuser_role_required?optionalbooluserRoleRequired?optionalBooleanUserRoleRequired?optionalboolUserRoleRequired?optional*bool= false#

Enables use of a user role requirement in your chat configuration.