Interface ICfnSlackChannelConfigurationProps
Properties for defining a CfnSlackChannelConfiguration
.
Namespace: Amazon.CDK.AWS.Chatbot
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface ICfnSlackChannelConfigurationProps
Syntax (vb)
Public Interface ICfnSlackChannelConfigurationProps
Remarks
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Chatbot;
var cfnSlackChannelConfigurationProps = new CfnSlackChannelConfigurationProps {
ConfigurationName = "configurationName",
IamRoleArn = "iamRoleArn",
SlackChannelId = "slackChannelId",
SlackWorkspaceId = "slackWorkspaceId",
// the properties below are optional
GuardrailPolicies = new [] { "guardrailPolicies" },
LoggingLevel = "loggingLevel",
SnsTopicArns = new [] { "snsTopicArns" },
UserRoleRequired = false
};
Synopsis
Properties
ConfigurationName | The name of the configuration. |
GuardrailPolicies | The list of IAM policy ARNs that are applied as channel guardrails. |
IamRoleArn | The ARN of the IAM role that defines the permissions for AWS Chatbot . |
LoggingLevel | Specifies the logging level for this configuration. This property affects the log entries pushed to Amazon CloudWatch Logs. |
SlackChannelId | The ID of the Slack channel. |
SlackWorkspaceId | The ID of the Slack workspace authorized with AWS Chatbot . |
SnsTopicArns | The ARNs of the SNS topics that deliver notifications to AWS Chatbot . |
UserRoleRequired | Enables use of a user role requirement in your chat configuration. |
Properties
ConfigurationName
The name of the configuration.
string ConfigurationName { get; }
Property Value
System.String
Remarks
GuardrailPolicies
The list of IAM policy ARNs that are applied as channel guardrails.
virtual string[] GuardrailPolicies { get; }
Property Value
System.String[]
Remarks
The AWS managed 'AdministratorAccess' policy is applied as a default if this is not set.
IamRoleArn
The ARN of the IAM role that defines the permissions for AWS Chatbot .
string IamRoleArn { get; }
Property Value
System.String
Remarks
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 .
LoggingLevel
Specifies the logging level for this configuration. This property affects the log entries pushed to Amazon CloudWatch Logs.
virtual string LoggingLevel { get; }
Property Value
System.String
Remarks
Logging levels include ERROR
, INFO
, or NONE
.
Default: - "NONE"
SlackChannelId
The ID of the Slack channel.
string SlackChannelId { get; }
Property Value
System.String
Remarks
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
.
SlackWorkspaceId
The ID of the Slack workspace authorized with AWS Chatbot .
string SlackWorkspaceId { get; }
Property Value
System.String
Remarks
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 .
SnsTopicArns
The ARNs of the SNS topics that deliver notifications to AWS Chatbot .
virtual string[] SnsTopicArns { get; }
Property Value
System.String[]
Remarks
UserRoleRequired
Enables use of a user role requirement in your chat configuration.
virtual object UserRoleRequired { get; }
Property Value
System.Object