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	awscc.supportapp.slack_channel_configurations

Fields

get (all properties)

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.

list (identifiers only)

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.
region	string	AWS region.

For more information, see AWS::SupportApp::SlackChannelConfiguration.

Methods

Name	Resource	Accessible by	Required Params
create_resource	slack_channel_configurations	INSERT	TeamId, ChannelId, NotifyOnCaseSeverity, ChannelRoleArn, region
delete_resource	slack_channel_configurations	DELETE	Identifier, region
update_resource	slack_channel_configurations	UPDATE	Identifier, PatchDocument, region
list_resources	slack_channel_configurations_list_only	SELECT	region
get_resource	slack_channel_configurations	SELECT	Identifier, region

SELECT examples

get (all properties)

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 awscc.supportapp.slack_channel_configurations
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ team_id }}|{{ channel_id }}';

list (identifiers only)

Lists all slack_channel_configurations in a region.

SELECT
  region,
  team_id,
  channel_id
FROM awscc.supportapp.slack_channel_configurations_list_only
WHERE
  region = '{{ region }}';

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 awscc.supportapp.slack_channel_configurations (
  TeamId,
  ChannelId,
  NotifyOnCaseSeverity,
  ChannelRoleArn,
  region
)
SELECT
  '{{ team_id }}',
  '{{ channel_id }}',
  '{{ notify_on_case_severity }}',
  '{{ channel_role_arn }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.supportapp.slack_channel_configurations (
  TeamId,
  ChannelId,
  ChannelName,
  NotifyOnCreateOrReopenCase,
  NotifyOnAddCorrespondenceToCase,
  NotifyOnResolveCase,
  NotifyOnCaseSeverity,
  ChannelRoleArn,
  region
)
SELECT
  '{{ 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 }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

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: team_id
      value: '{{ team_id }}'
    - name: channel_id
      value: '{{ channel_id }}'
    - name: channel_name
      value: '{{ channel_name }}'
    - name: notify_on_create_or_reopen_case
      value: '{{ notify_on_create_or_reopen_case }}'
    - name: notify_on_add_correspondence_to_case
      value: '{{ notify_on_add_correspondence_to_case }}'
    - name: notify_on_resolve_case
      value: '{{ notify_on_resolve_case }}'
    - name: notify_on_case_severity
      value: '{{ notify_on_case_severity }}'
    - name: channel_role_arn
      value: '{{ channel_role_arn }}'

UPDATE example

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

/*+ update */
UPDATE awscc.supportapp.slack_channel_configurations
SET PatchDocument = string('{{ {
    "ChannelName": channel_name,
    "NotifyOnCreateOrReopenCase": notify_on_create_or_reopen_case,
    "NotifyOnAddCorrespondenceToCase": notify_on_add_correspondence_to_case,
    "NotifyOnResolveCase": notify_on_resolve_case,
    "NotifyOnCaseSeverity": notify_on_case_severity,
    "ChannelRoleArn": channel_role_arn
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ team_id }}|{{ channel_id }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.supportapp.slack_channel_configurations
WHERE
  Identifier = '{{ team_id }}|{{ channel_id }}' AND
  region = '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Additional Parameters

Mutable resources in the Cloud Control provider support additional optional parameters which can be supplied with INSERT, UPDATE, or DELETE operations. These include:

Parameter	Description
ClientToken	A unique identifier to ensure the idempotency of the resource request. This allows the provider to accurately distinguish between retries and new requests. A client token is valid for 36 hours once used. After that, a resource request with the same client token is treated as a new request. If you do not specify a client token, one is generated for inclusion in the request.
RoleArn	The ARN of the IAM role used to perform this resource operation. The role specified must have the permissions required for this operation. If you do not specify a role, a temporary session is created using your AWS user credentials.
TypeVersionId	For private resource types, the type version to use in this resource operation. If you do not specify a resource version, the default version is used.

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