slack_channel_configurations

Creates, updates, deletes or gets a slack_channel_configuration resource or lists slack_channel_configurations in a region

Overview

Name	slack_channel_configurations
Type	Resource
Description	An AWS Support App resource that creates, updates, lists and deletes Slack channel configurations.
Id	aws.supportapp.slack_channel_configurations

Fields

Name	Datatype	Description
team_id	string	The team ID in Slack, which uniquely identifies a workspace.
channel_id	string	The channel ID in Slack, which identifies a channel within a workspace.
channel_name	string	The channel name in Slack.
notify_on_create_or_reopen_case	boolean	Whether to notify when a case is created or reopened.
notify_on_add_correspondence_to_case	boolean	Whether to notify when a correspondence is added to a case.
notify_on_resolve_case	boolean	Whether to notify when a case is resolved.
notify_on_case_severity	string	The severity level of a support case that a customer wants to get notified for.
channel_role_arn	string	The Amazon Resource Name (ARN) of an IAM role that grants the AWS Support App access to perform operations for AWS services.
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	TeamId, ChannelId, NotifyOnCaseSeverity, ChannelRoleArn, region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all slack_channel_configurations in a region.

SELECT
region,
team_id,
channel_id,
channel_name,
notify_on_create_or_reopen_case,
notify_on_add_correspondence_to_case,
notify_on_resolve_case,
notify_on_case_severity,
channel_role_arn
FROM aws.supportapp.slack_channel_configurations
WHERE region = 'us-east-1';

Gets all properties from an individual slack_channel_configuration.

SELECT
region,
team_id,
channel_id,
channel_name,
notify_on_create_or_reopen_case,
notify_on_add_correspondence_to_case,
notify_on_resolve_case,
notify_on_case_severity,
channel_role_arn
FROM aws.supportapp.slack_channel_configurations
WHERE region = 'us-east-1' AND data__Identifier = '<TeamId>|<ChannelId>';

INSERT example

Use the following StackQL query and manifest file to create a new slack_channel_configuration resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO aws.supportapp.slack_channel_configurations (
 TeamId,
 ChannelId,
 NotifyOnCaseSeverity,
 ChannelRoleArn,
 region
)
SELECT 
'{{ TeamId }}',
 '{{ ChannelId }}',
 '{{ NotifyOnCaseSeverity }}',
 '{{ ChannelRoleArn }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.supportapp.slack_channel_configurations (
 TeamId,
 ChannelId,
 ChannelName,
 NotifyOnCreateOrReopenCase,
 NotifyOnAddCorrespondenceToCase,
 NotifyOnResolveCase,
 NotifyOnCaseSeverity,
 ChannelRoleArn,
 region
)
SELECT 
 '{{ TeamId }}',
 '{{ ChannelId }}',
 '{{ ChannelName }}',
 '{{ NotifyOnCreateOrReopenCase }}',
 '{{ NotifyOnAddCorrespondenceToCase }}',
 '{{ NotifyOnResolveCase }}',
 '{{ NotifyOnCaseSeverity }}',
 '{{ ChannelRoleArn }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: slack_channel_configuration
    props:
      - name: TeamId
        value: '{{ TeamId }}'
      - name: ChannelId
        value: '{{ ChannelId }}'
      - name: ChannelName
        value: '{{ ChannelName }}'
      - name: NotifyOnCreateOrReopenCase
        value: '{{ NotifyOnCreateOrReopenCase }}'
      - name: NotifyOnAddCorrespondenceToCase
        value: '{{ NotifyOnAddCorrespondenceToCase }}'
      - name: NotifyOnResolveCase
        value: '{{ NotifyOnResolveCase }}'
      - name: NotifyOnCaseSeverity
        value: '{{ NotifyOnCaseSeverity }}'
      - name: ChannelRoleArn
        value: '{{ ChannelRoleArn }}'

DELETE example

/*+ delete */
DELETE FROM aws.supportapp.slack_channel_configurations
WHERE data__Identifier = '<TeamId|ChannelId>'
AND region = 'us-east-1';

Permissions

To operate on the slack_channel_configurations resource, the following permissions are required:

Create

supportapp:CreateSlackChannelConfiguration,
supportapp:ListSlackChannelConfigurations

Read

supportapp:ListSlackChannelConfigurations

Update

supportapp:UpdateSlackChannelConfiguration,
supportapp:ListSlackChannelConfigurations

Delete

supportapp:DeleteSlackChannelConfiguration,
supportapp:ListSlackChannelConfigurations

List

supportapp:ListSlackChannelConfigurations