SlackChannelConfiguration
An AWS Chatbot configuration for Slack.
Contents
- ChatConfigurationArn
-
The Amazon Resource Number (ARN) of the SlackChannelConfiguration.
Type: String
Length Constraints: Minimum length of 19. Maximum length of 1169.
Pattern:
^arn:aws:chatbot:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,1023}$
Required: Yes
- IamRoleArn
-
A user-defined role that AWS Chatbot assumes. This is not the service-linked role.
For more information, see IAM policies for AWS Chatbot in the AWS Chatbot Administrator Guide.
Type: String
Length Constraints: Minimum length of 12. Maximum length of 1224.
Pattern:
^arn:aws:[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,1023}$
Required: Yes
- SlackChannelId
-
The ID of the Slack channel.
To get this 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.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
^[A-Za-z0-9]+$
Required: Yes
- SlackChannelName
-
The name of the Slack channel.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Required: Yes
- SlackTeamId
-
The ID of the Slack workspace authorized with Amazon Chime.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
^[0-9A-Z]{1,255}$
Required: Yes
- SlackTeamName
-
Name of the Slack workspace.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Required: Yes
- SnsTopicArns
-
The ARNs of the SNS topics that deliver notifications to AWS Chatbot.
Type: Array of strings
Length Constraints: Minimum length of 12. Maximum length of 1224.
Pattern:
^arn:aws:[A-Za-z0-9][A-Za-z0-9_/.-]{0,62}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,1023}$
Required: Yes
- ConfigurationName
-
The name of the configuration.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
^[A-Za-z0-9-_]+$
Required: No
- GuardrailPolicyArns
-
The list of IAM policy ARNs that are applied as channel guardrails. The AWS managed
AdministratorAccess
policy is applied by default if this is not set.Type: Array of strings
Length Constraints: Minimum length of 11. Maximum length of 1163.
Pattern:
^(^$|(?!.*\/aws-service-role\/.*)arn:aws:iam:[A-Za-z0-9_\/.-]{0,63}:[A-Za-z0-9_\/.-]{0,63}:[A-Za-z0-9][A-Za-z0-9:_\/+=,@.-]{0,1023})$
Required: No
- LoggingLevel
-
Logging levels include
ERROR
,INFO
, orNONE
.Type: String
Length Constraints: Minimum length of 4. Maximum length of 5.
Pattern:
^(ERROR|INFO|NONE)$
Required: No
- Tags
-
A map of tags assigned to a resource. A tag is a string-to-string map of key-value pairs.
Type: Array of Tag objects
Required: No
- UserAuthorizationRequired
-
Enables use of a user role requirement in your chat configuration.
Type: Boolean
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: