slack_channel_configurations

Creates, updates, deletes, gets or lists a slack_channel_configurations resource.

Overview

Name	slack_channel_configurations
Type	Resource
Id	aws.chatbot.slack_channel_configurations

Fields

The following fields are returned by SELECT queries:

describe_slack_channel_configurations

Name	Datatype	Description
chat_configuration_arn	string	The Amazon Resource Name (ARN) of the SlackChannelConfiguration. (pattern: <code>arn:aws:(wheatley|chatbot):[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9_/.-]{0,63}:[A-Za-z0-9][A-Za-z0-9:_/+=,@.-]{0,1023}</code>)
configuration_name	string	The name of the configuration. (pattern: <code>[A-Za-z0-9-_]+</code>)
guardrail_policy_arns	array	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.
iam_role_arn	string	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. (pattern: <code>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}</code>)
logging_level	string	Logging levels include ERROR, INFO, or NONE. (pattern: <code>(ERROR|INFO|NONE)</code>)
slack_channel_id	string	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. (pattern: <code>[A-Za-z0-9]+</code>)
slack_channel_name	string	The name of the Slack channel.
slack_team_id	string	The ID of the Slack workspace authorized with Amazon Chime. (pattern: <code>[0-9A-Z]{1,255}</code>)
slack_team_name	string	Name of the Slack workspace.
sns_topic_arns	array	The ARNs of the SNS topics that deliver notifications to AWS Chatbot.
state	string	Either ENABLED or DISABLED. The resource returns DISABLED if the organization's AWS Chatbot policy has explicitly denied that configuration. For example, if Amazon Chime is disabled. (pattern: <code>(ENABLED|DISABLED)</code>)
state_reason	string	Provided if State is DISABLED. Provides context as to why the resource is disabled.
tags	array	A map of tags assigned to a resource. A tag is a string-to-string map of key-value pairs.
user_authorization_required	boolean	Enables use of a user role requirement in your chat configuration.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_slack_channel_configurations	select	region		Lists Slack channel configurations optionally filtered by ChatConfigurationArn
create_slack_channel_configuration	insert	region, SlackTeamId, SlackChannelId, IamRoleArn, ConfigurationName		Creates an AWS Chatbot confugration for Slack.
update_slack_channel_configuration	update	region, ChatConfigurationArn, SlackChannelId		Updates a Slack channel configuration.
delete_slack_channel_configuration	delete	region		Deletes a Slack channel configuration for AWS Chatbot

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

describe_slack_channel_configurations

Lists Slack channel configurations optionally filtered by ChatConfigurationArn

SELECT
chat_configuration_arn,
configuration_name,
guardrail_policy_arns,
iam_role_arn,
logging_level,
slack_channel_id,
slack_channel_name,
slack_team_id,
slack_team_name,
sns_topic_arns,
state,
state_reason,
tags,
user_authorization_required
FROM aws.chatbot.slack_channel_configurations
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_slack_channel_configuration

Creates an AWS Chatbot confugration for Slack.

INSERT INTO aws.chatbot.slack_channel_configurations (
SlackTeamId,
SlackChannelId,
SlackChannelName,
SnsTopicArns,
IamRoleArn,
ConfigurationName,
LoggingLevel,
GuardrailPolicyArns,
UserAuthorizationRequired,
Tags,
region
)
SELECT 
'{{ SlackTeamId }}' /* required */,
'{{ SlackChannelId }}' /* required */,
'{{ SlackChannelName }}',
'{{ SnsTopicArns }}',
'{{ IamRoleArn }}' /* required */,
'{{ ConfigurationName }}' /* required */,
'{{ LoggingLevel }}',
'{{ GuardrailPolicyArns }}',
{{ UserAuthorizationRequired }},
'{{ Tags }}',
'{{ region }}'
RETURNING
channel_configuration
;

Manifest

# Description fields are for documentation purposes
- name: slack_channel_configurations
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the slack_channel_configurations resource.
  - name: SlackTeamId
    value: "{{ SlackTeamId }}"
  - name: SlackChannelId
    value: "{{ SlackChannelId }}"
  - name: SlackChannelName
    value: "{{ SlackChannelName }}"
  - name: SnsTopicArns
    value:
      - "{{ SnsTopicArns }}"
  - name: IamRoleArn
    value: "{{ IamRoleArn }}"
  - name: ConfigurationName
    value: "{{ ConfigurationName }}"
  - name: LoggingLevel
    value: "{{ LoggingLevel }}"
  - name: GuardrailPolicyArns
    value:
      - "{{ GuardrailPolicyArns }}"
  - name: UserAuthorizationRequired
    value: {{ UserAuthorizationRequired }}
  - name: Tags
    value:
      - TagKey: "{{ TagKey }}"
        TagValue: "{{ TagValue }}"

UPDATE examples

update_slack_channel_configuration

Updates a Slack channel configuration.

UPDATE aws.chatbot.slack_channel_configurations
SET 
ChatConfigurationArn = '{{ ChatConfigurationArn }}',
SlackChannelId = '{{ SlackChannelId }}',
SlackChannelName = '{{ SlackChannelName }}',
SnsTopicArns = '{{ SnsTopicArns }}',
IamRoleArn = '{{ IamRoleArn }}',
LoggingLevel = '{{ LoggingLevel }}',
GuardrailPolicyArns = '{{ GuardrailPolicyArns }}',
UserAuthorizationRequired = {{ UserAuthorizationRequired }}
WHERE 
region = '{{ region }}' --required
AND ChatConfigurationArn = '{{ ChatConfigurationArn }}' --required
AND SlackChannelId = '{{ SlackChannelId }}' --required
RETURNING
channel_configuration;

DELETE examples

delete_slack_channel_configuration

Deletes a Slack channel configuration for AWS Chatbot

DELETE FROM aws.chatbot.slack_channel_configurations
WHERE region = '{{ region }}' --required
;