Package software.amazon.awscdk.services.chatbot

Class CfnSlackChannelConfiguration

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.chatbot.CfnSlackChannelConfiguration

All Implemented Interfaces:

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

@Generated(value="jsii-pacmak/1.103.1 (build bef2dea)",
           date="2024-10-11T15:55:54.314Z")
@Stability(Stable)
public class CfnSlackChannelConfiguration
extends CfnResource
implements IInspectable, ITaggableV2

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 Configure a Slack client 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"))
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .userRoleRequired(false)
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-chatbot-slackchannelconfiguration.html

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final 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.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

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

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.ITaggableV2

ITaggableV2.Jsii$Default, ITaggableV2.Jsii$Proxy

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CfnSlackChannelConfiguration(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnSlackChannelConfiguration(software.amazon.jsii.JsiiObjectRef objRef)
	CfnSlackChannelConfiguration(software.constructs.Construct scope, String id, CfnSlackChannelConfigurationProps props)

Method Summary

Modifier and Type	Method	Description
String	getAttrArn()	Amazon Resource Name (ARN) of the configuration.
TagManager	getCdkTagManager()	Tag Manager which manages the tags for this resource.
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 .
List<CfnTag>	getTags()	The tags to add to the configuration.
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	setTags(List<CfnTag> value)	The tags to add to the configuration.
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.CfnResource

addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

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 Details

CFN_RESOURCE_TYPE_NAME

@Stability(Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Details

CfnSlackChannelConfiguration

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

CfnSlackChannelConfiguration

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

CfnSlackChannelConfiguration

@Stability(Stable)
public CfnSlackChannelConfiguration(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 CfnSlackChannelConfigurationProps props)

Parameters:

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

id - Construct identifier for this resource (unique in its scope). This parameter is required.

props - Resource properties. This parameter is required.

Method Details

inspect

@Stability(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(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(Stable)
@NotNull
public String getAttrArn()

Amazon Resource Name (ARN) of the configuration.

getCdkTagManager

@Stability(Stable)
@NotNull
public TagManager getCdkTagManager()

Tag Manager which manages the tags for this resource.

Specified by:

getCdkTagManager in interface ITaggableV2

getCfnProperties

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

Overrides:

getCfnProperties in class CfnResource

getConfigurationName

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

The name of the configuration.

setConfigurationName

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

The name of the configuration.

getIamRoleArn

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

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

setIamRoleArn

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

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

getSlackChannelId

@Stability(Stable)
@NotNull
public String getSlackChannelId()

The ID of the Slack channel.

setSlackChannelId

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

The ID of the Slack channel.

getSlackWorkspaceId

@Stability(Stable)
@NotNull
public String getSlackWorkspaceId()

The ID of the Slack workspace authorized with AWS Chatbot .

setSlackWorkspaceId

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

The ID of the Slack workspace authorized with AWS Chatbot .

getGuardrailPolicies

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

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

setGuardrailPolicies

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

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

getLoggingLevel

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

Specifies the logging level for this configuration.

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

setLoggingLevel

@Stability(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.

getSnsTopicArns

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

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

setSnsTopicArns

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

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

getTags

@Stability(Stable)
@Nullable
public List<CfnTag> getTags()

The tags to add to the configuration.

setTags

@Stability(Stable)
public void setTags(@Nullable
 List<CfnTag> value)

The tags to add to the configuration.

getUserRoleRequired

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

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

setUserRoleRequired

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

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

setUserRoleRequired

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

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