software.amazon.awscdk.services.chatbot

Class CfnSlackChannelConfiguration

java.lang.Object

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:

IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.73.0 (build 6faeda3)",
           date="2023-01-31T18:36:52.449Z")
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 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 java.lang.String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnSlackChannelConfiguration(Construct scope, java.lang.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
java.lang.String	getAttrArn()
protected java.util.Map<java.lang.String,java.lang.Object>	getCfnProperties()
java.lang.String	getConfigurationName() The name of the configuration.
java.util.List<java.lang.String>	getGuardrailPolicies() The list of IAM policy ARNs that are applied as channel guardrails.
java.lang.String	getIamRoleArn() The ARN of the IAM role that defines the permissions for AWS Chatbot .
java.lang.String	getLoggingLevel() Specifies the logging level for this configuration.
java.lang.String	getSlackChannelId() The ID of the Slack channel.
java.lang.String	getSlackWorkspaceId() The ID of the Slack workspace authorized with AWS Chatbot .
java.util.List<java.lang.String>	getSnsTopicArns() The ARNs of the SNS topics that deliver notifications to AWS Chatbot .
java.lang.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 java.util.Map<java.lang.String,java.lang.Object>	renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
void	setConfigurationName(java.lang.String value) The name of the configuration.
void	setGuardrailPolicies(java.util.List<java.lang.String> value) The list of IAM policy ARNs that are applied as channel guardrails.
void	setIamRoleArn(java.lang.String value) The ARN of the IAM role that defines the permissions for AWS Chatbot .
void	setLoggingLevel(java.lang.String value) Specifies the logging level for this configuration.
void	setSlackChannelId(java.lang.String value) The ID of the Slack channel.
void	setSlackWorkspaceId(java.lang.String value) The ID of the Slack workspace authorized with AWS Chatbot .
void	setSnsTopicArns(java.util.List<java.lang.String> value) The ARNs of the SNS topics that deliver notifications to AWS Chatbot .
void	setUserRoleRequired(java.lang.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 java.lang.Object

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

Field Detail

CFN_RESOURCE_TYPE_NAME

public static final java.lang.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

public CfnSlackChannelConfiguration(Construct scope,
                                    java.lang.String id,
                                    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

public void inspect(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

protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrArn

public java.lang.String getAttrArn()

getCfnProperties

protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getConfigurationName

public java.lang.String getConfigurationName()

The name of the configuration.

setConfigurationName

public void setConfigurationName(java.lang.String value)

The name of the configuration.

getIamRoleArn

public java.lang.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

public void setIamRoleArn(java.lang.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

public java.lang.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

public void setSlackChannelId(java.lang.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

public java.lang.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

public void setSlackWorkspaceId(java.lang.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

public java.util.List<java.lang.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

public void setGuardrailPolicies(java.util.List<java.lang.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

public java.lang.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

public void setLoggingLevel(java.lang.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

public java.util.List<java.lang.String> getSnsTopicArns()

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

setSnsTopicArns

public void setSnsTopicArns(java.util.List<java.lang.String> value)

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

getUserRoleRequired

public java.lang.Object getUserRoleRequired()

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

setUserRoleRequired

public void setUserRoleRequired(java.lang.Boolean value)

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

setUserRoleRequired

public void setUserRoleRequired(IResolvable value)

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