@Generated(value="jsii-pacmak/1.73.0 (build 6faeda3)", date="2023-01-31T18:36:52.453Z") public class SlackChannelConfiguration extends Resource implements ISlackChannelConfiguration
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);
Modifier and Type | Class and Description |
---|---|
static class |
SlackChannelConfiguration.Builder
A fluent builder for
SlackChannelConfiguration . |
ISlackChannelConfiguration.Jsii$Default, ISlackChannelConfiguration.Jsii$Proxy
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) |
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.
|
applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isResource
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
applyRemovalPolicy, getEnv, getStack
getNode
protected SlackChannelConfiguration(software.amazon.jsii.JsiiObjectRef objRef)
protected SlackChannelConfiguration(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
public SlackChannelConfiguration(software.constructs.Construct scope, java.lang.String id, SlackChannelConfigurationProps props)
scope
- This parameter is required.id
- This parameter is required.props
- This parameter is required.public static ISlackChannelConfiguration fromSlackChannelConfigurationArn(software.constructs.Construct scope, java.lang.String id, java.lang.String slackChannelConfigurationArn)
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.public static Metric metricAll(java.lang.String metricName, MetricOptions props)
metricName
- This parameter is required.props
- public static Metric metricAll(java.lang.String metricName)
metricName
- This parameter is required.public void addNotificationTopic(ITopic notificationTopic)
notificationTopic
- This parameter is required.public void addToRolePolicy(PolicyStatement statement)
addToRolePolicy
in interface ISlackChannelConfiguration
statement
- This parameter is required.public NotificationRuleTargetConfig bindAsNotificationRuleTarget(software.constructs.Construct _scope)
bindAsNotificationRuleTarget
in interface INotificationRuleTarget
_scope
- This parameter is required.public Metric metric(java.lang.String metricName, MetricOptions props)
metric
in interface ISlackChannelConfiguration
metricName
- This parameter is required.props
- public Metric metric(java.lang.String metricName)
metric
in interface ISlackChannelConfiguration
metricName
- This parameter is required.public IPrincipal getGrantPrincipal()
getGrantPrincipal
in interface IGrantable
public java.lang.String getSlackChannelConfigurationArn()
getSlackChannelConfigurationArn
in interface ISlackChannelConfiguration
public java.lang.String getSlackChannelConfigurationName()
getSlackChannelConfigurationName
in interface ISlackChannelConfiguration
public IRole getRole()
getRole
in interface ISlackChannelConfiguration