software.amazon.awscdk.services.chatbot

Class SlackChannelConfiguration

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.Resource

software.amazon.awscdk.services.chatbot.SlackChannelConfiguration

All Implemented Interfaces:

IConstruct, IDependable, IResource, ISlackChannelConfiguration, INotificationRuleTarget, IGrantable

@Generated(value="jsii-pacmak/1.73.0 (build 6faeda3)",
           date="2023-01-31T18:36:52.453Z")
public class SlackChannelConfiguration
extends Resource
implements ISlackChannelConfiguration

A new Slack channel configuration.

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 Classes

Modifier and Type	Class and Description
static class	SlackChannelConfiguration.Builder A fluent builder for SlackChannelConfiguration.

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.chatbot.ISlackChannelConfiguration

ISlackChannelConfiguration.Jsii$Default, ISlackChannelConfiguration.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SlackChannelConfiguration(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	SlackChannelConfiguration(software.amazon.jsii.JsiiObjectRef objRef)
	SlackChannelConfiguration(software.constructs.Construct scope, java.lang.String id, SlackChannelConfigurationProps props)

Method Summary

Modifier and Type	Method and Description
void	addNotificationTopic(ITopic notificationTopic) Adds a SNS topic that deliver notifications to AWS Chatbot.
void	addToRolePolicy(PolicyStatement statement) Adds extra permission to iam-role of Slack channel configuration.
NotificationRuleTargetConfig	bindAsNotificationRuleTarget(software.constructs.Construct _scope) Returns a target configuration for notification rule.
static ISlackChannelConfiguration	fromSlackChannelConfigurationArn(software.constructs.Construct scope, java.lang.String id, java.lang.String slackChannelConfigurationArn) Import an existing Slack channel configuration provided an ARN.
IPrincipal	getGrantPrincipal() The principal to grant permissions to.
IRole	getRole() The permission role of Slack channel configuration.
java.lang.String	getSlackChannelConfigurationArn() The ARN of the Slack channel configuration In the form of arn:aws:chatbot:{region}:{account}:chat-configuration/slack-channel/{slackChannelName}.
java.lang.String	getSlackChannelConfigurationName() The name of Slack channel configuration.
Metric	metric(java.lang.String metricName) Return the given named metric for this SlackChannelConfiguration.
Metric	metric(java.lang.String metricName, MetricOptions props) Return the given named metric for this SlackChannelConfiguration.
static Metric	metricAll(java.lang.String metricName) Return the given named metric for All SlackChannelConfigurations.
static Metric	metricAll(java.lang.String metricName, MetricOptions props) Return the given named metric for All SlackChannelConfigurations.

Methods inherited from class software.amazon.awscdk.core.Resource

applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isResource

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.awscdk.core.IResource

applyRemovalPolicy, getEnv, getStack

Methods inherited from interface software.amazon.awscdk.core.IConstruct

getNode

Constructor Detail

SlackChannelConfiguration

protected SlackChannelConfiguration(software.amazon.jsii.JsiiObjectRef objRef)

SlackChannelConfiguration

protected SlackChannelConfiguration(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

SlackChannelConfiguration

public SlackChannelConfiguration(software.constructs.Construct scope,
                                 java.lang.String id,
                                 SlackChannelConfigurationProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

Method Detail

fromSlackChannelConfigurationArn

public static ISlackChannelConfiguration fromSlackChannelConfigurationArn(software.constructs.Construct scope,
                                                                          java.lang.String id,
                                                                          java.lang.String slackChannelConfigurationArn)

Import an existing Slack channel configuration provided an ARN.

Parameters:

scope - The parent creating construct. This parameter is required.

id - The construct's name. This parameter is required.

slackChannelConfigurationArn - configuration ARN (i.e. arn:aws:chatbot::1234567890:chat-configuration/slack-channel/my-slack). This parameter is required.

Returns:

a reference to the existing Slack channel configuration

metricAll

public static Metric metricAll(java.lang.String metricName,
                               MetricOptions props)

Return the given named metric for All SlackChannelConfigurations.

Parameters:

metricName - This parameter is required.

props -

metricAll

public static Metric metricAll(java.lang.String metricName)

Return the given named metric for All SlackChannelConfigurations.

Parameters:

metricName - This parameter is required.

addNotificationTopic

public void addNotificationTopic(ITopic notificationTopic)

Adds a SNS topic that deliver notifications to AWS Chatbot.

Parameters:

notificationTopic - This parameter is required.

addToRolePolicy

public void addToRolePolicy(PolicyStatement statement)

Adds extra permission to iam-role of Slack channel configuration.

Specified by:

addToRolePolicy in interface ISlackChannelConfiguration

Parameters:

statement - This parameter is required.

bindAsNotificationRuleTarget

public NotificationRuleTargetConfig bindAsNotificationRuleTarget(software.constructs.Construct _scope)

Returns a target configuration for notification rule.

Specified by:

bindAsNotificationRuleTarget in interface INotificationRuleTarget

Parameters:

_scope - This parameter is required.

metric

public Metric metric(java.lang.String metricName,
                     MetricOptions props)

Return the given named metric for this SlackChannelConfiguration.

Specified by:

metric in interface ISlackChannelConfiguration

Parameters:

metricName - This parameter is required.

props -

metric

public Metric metric(java.lang.String metricName)

Return the given named metric for this SlackChannelConfiguration.

Specified by:

metric in interface ISlackChannelConfiguration

Parameters:

metricName - This parameter is required.

getGrantPrincipal

public IPrincipal getGrantPrincipal()

The principal to grant permissions to.

Specified by:

getGrantPrincipal in interface IGrantable

getSlackChannelConfigurationArn

public java.lang.String getSlackChannelConfigurationArn()

The ARN of the Slack channel configuration In the form of arn:aws:chatbot:{region}:{account}:chat-configuration/slack-channel/{slackChannelName}.

Specified by:

getSlackChannelConfigurationArn in interface ISlackChannelConfiguration

getSlackChannelConfigurationName

public java.lang.String getSlackChannelConfigurationName()

The name of Slack channel configuration.

Specified by:

getSlackChannelConfigurationName in interface ISlackChannelConfiguration

getRole

public IRole getRole()

The permission role of Slack channel configuration.

Specified by:

getRole in interface ISlackChannelConfiguration