software.amazon.awscdk.services.chatbot

Class CfnSlackChannelConfiguration

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnRefElement

software.amazon.awscdk.core.CfnResource

software.amazon.awscdk.services.chatbot.CfnSlackChannelConfiguration

All Implemented Interfaces:

IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-05-19T23:09:25.223Z")
 @Stability(value=Stable)
public class CfnSlackChannelConfiguration
extends CfnResource
implements IInspectable

A CloudFormation `AWS::Chatbot::SlackChannelConfiguration`.

The AWS::Chatbot::SlackChannelConfiguration resource configures a Slack channel to allow users to use AWS Chatbot with AWS CloudFormation templates.

This resource requires some setup to be done in the AWS Chatbot console. To provide the required Slack workspace ID, you must perform the initial authorization flow with Slack in the AWS Chatbot console, then 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 .

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.chatbot.*;
 CfnSlackChannelConfiguration cfnSlackChannelConfiguration = CfnSlackChannelConfiguration.Builder.create(this, "MyCfnSlackChannelConfiguration")
         .configurationName("configurationName")
         .iamRoleArn("iamRoleArn")
         .slackChannelId("slackChannelId")
         .slackWorkspaceId("slackWorkspaceId")
         // the properties below are optional
         .guardrailPolicies(List.of("guardrailPolicies"))
         .loggingLevel("loggingLevel")
         .snsTopicArns(List.of("snsTopicArns"))
         .userRoleRequired(false)
         .build();
 

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnSlackChannelConfiguration(Construct scope, String id, CfnSlackChannelConfigurationProps props) Create a new `AWS::Chatbot::SlackChannelConfiguration`.
protected	CfnSlackChannelConfiguration(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnSlackChannelConfiguration(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAttrArn()
protected Map<String,Object>	getCfnProperties()
String	getConfigurationName() The name of the configuration.
List<String>	getGuardrailPolicies() The list of IAM policy ARNs that are applied as channel guardrails.
String	getIamRoleArn() The ARN of the IAM role that defines the permissions for AWS Chatbot .
String	getLoggingLevel() Specifies the logging level for this configuration.
String	getSlackChannelId() The ID of the Slack channel.
String	getSlackWorkspaceId() The ID of the Slack workspace authorized with AWS Chatbot .
List<String>	getSnsTopicArns() The ARNs of the SNS topics that deliver notifications to AWS Chatbot .
Object	getUserRoleRequired() Enables use of a user role requirement in your chat configuration.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setConfigurationName(String value) The name of the configuration.
void	setGuardrailPolicies(List<String> value) The list of IAM policy ARNs that are applied as channel guardrails.
void	setIamRoleArn(String value) The ARN of the IAM role that defines the permissions for AWS Chatbot .
void	setLoggingLevel(String value) Specifies the logging level for this configuration.
void	setSlackChannelId(String value) The ID of the Slack channel.
void	setSlackWorkspaceId(String value) The ID of the Slack workspace authorized with AWS Chatbot .
void	setSnsTopicArns(List<String> value) The ARNs of the SNS topics that deliver notifications to AWS Chatbot .
void	setUserRoleRequired(Boolean value) Enables use of a user role requirement in your chat configuration.
void	setUserRoleRequired(IResolvable value) Enables use of a user role requirement in your chat configuration.

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

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

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

getRef

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

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

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

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

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnSlackChannelConfiguration

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

CfnSlackChannelConfiguration

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

CfnSlackChannelConfiguration

@Stability(value=Stable)
public CfnSlackChannelConfiguration(@NotNull
                                                             Construct scope,
                                                             @NotNull
                                                             String id,
                                                             @NotNull
                                                             CfnSlackChannelConfigurationProps props)

Create a new `AWS::Chatbot::SlackChannelConfiguration`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrArn

@Stability(value=Stable)
 @NotNull
public String getAttrArn()

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getConfigurationName

@Stability(value=Stable)
 @NotNull
public String getConfigurationName()

The name of the configuration.

setConfigurationName

@Stability(value=Stable)
public void setConfigurationName(@NotNull
                                                          String value)

The name of the configuration.

getIamRoleArn

@Stability(value=Stable)
 @NotNull
public String getIamRoleArn()

The ARN of the IAM role that defines the permissions for AWS Chatbot .

This is a user-defined role that AWS Chatbot will assume. This is not the service-linked role. For more information, see IAM Policies for AWS Chatbot .

setIamRoleArn

@Stability(value=Stable)
public void setIamRoleArn(@NotNull
                                                   String value)

The ARN of the IAM role that defines the permissions for AWS Chatbot .

This is a user-defined role that AWS Chatbot will assume. This is not the service-linked role. For more information, see IAM Policies for AWS Chatbot .

getSlackChannelId

@Stability(value=Stable)
 @NotNull
public 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 .

setSlackChannelId

@Stability(value=Stable)
public void setSlackChannelId(@NotNull
                                                       String value)

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(value=Stable)
 @NotNull
public 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 .

setSlackWorkspaceId

@Stability(value=Stable)
public void setSlackWorkspaceId(@NotNull
                                                         String value)

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 .

getGuardrailPolicies

@Stability(value=Stable)
 @Nullable
public List<String> getGuardrailPolicies()

The list of IAM policy ARNs that are applied as channel guardrails.

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

setGuardrailPolicies

@Stability(value=Stable)
public void setGuardrailPolicies(@Nullable
                                                          List<String> value)

The list of IAM policy ARNs that are applied as channel guardrails.

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

getLoggingLevel

@Stability(value=Stable)
 @Nullable
public String getLoggingLevel()

Specifies the logging level for this configuration. This property affects the log entries pushed to Amazon CloudWatch Logs.

Logging levels include ERROR , INFO , or NONE .

setLoggingLevel

@Stability(value=Stable)
public void setLoggingLevel(@Nullable
                                                     String value)

Specifies the logging level for this configuration. This property affects the log entries pushed to Amazon CloudWatch Logs.

Logging levels include ERROR , INFO , or NONE .

getSnsTopicArns

@Stability(value=Stable)
 @Nullable
public List<String> getSnsTopicArns()

The ARNs of the SNS topics that deliver notifications to AWS Chatbot .

setSnsTopicArns

@Stability(value=Stable)
public void setSnsTopicArns(@Nullable
                                                     List<String> value)

The ARNs of the SNS topics that deliver notifications to AWS Chatbot .

getUserRoleRequired

@Stability(value=Stable)
 @Nullable
public Object getUserRoleRequired()

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

setUserRoleRequired

@Stability(value=Stable)
public void setUserRoleRequired(@Nullable
                                                         Boolean value)

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

setUserRoleRequired

@Stability(value=Stable)
public void setUserRoleRequired(@Nullable
                                                         IResolvable value)

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