slack_workspace_configurations

Creates, updates, deletes or gets a slack_workspace_configuration resource or lists slack_workspace_configurations in a region

Overview

Name	slack_workspace_configurations
Type	Resource
Description	An AWS Support App resource that creates, updates, lists, and deletes Slack workspace configurations.
Id	awscc.supportapp.slack_workspace_configurations

Fields

get (all properties)

Name	Datatype	Description
team_id	string	The team ID in Slack, which uniquely identifies a workspace.
version_id	string	An identifier used to update an existing Slack workspace configuration in AWS CloudFormation.
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
team_id	string	The team ID in Slack, which uniquely identifies a workspace.
region	string	AWS region.

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

Methods

Name	Resource	Accessible by	Required Params
create_resource	slack_workspace_configurations	INSERT	TeamId, region
delete_resource	slack_workspace_configurations	DELETE	Identifier, region
update_resource	slack_workspace_configurations	UPDATE	Identifier, PatchDocument, region
list_resources	slack_workspace_configurations_list_only	SELECT	region
get_resource	slack_workspace_configurations	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual slack_workspace_configuration.

SELECT
  region,
  team_id,
  version_id
FROM awscc.supportapp.slack_workspace_configurations
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ team_id }}';

list (identifiers only)

Lists all slack_workspace_configurations in a region.

SELECT
  region,
  team_id
FROM awscc.supportapp.slack_workspace_configurations_list_only
WHERE
  region = 'us-east-1';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.supportapp.slack_workspace_configurations (
  TeamId,
  region
)
SELECT
  '{{ team_id }}',
  '{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.supportapp.slack_workspace_configurations (
  TeamId,
  VersionId,
  region
)
SELECT
  '{{ team_id }}',
  '{{ version_id }}',
  '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: slack_workspace_configuration
    props:
      - name: team_id
        value: '{{ team_id }}'
      - name: version_id
        value: '{{ version_id }}'

UPDATE example

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

/*+ update */
UPDATE awscc.supportapp.slack_workspace_configurations
SET PatchDocument = string('{{ {
    "VersionId": version_id
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ team_id }}';

DELETE example

/*+ delete */
DELETE FROM awscc.supportapp.slack_workspace_configurations
WHERE
  Identifier = '{{ team_id }}' AND
  region = 'us-east-1';

Permissions

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

Create

supportapp:RegisterSlackWorkspaceForOrganization,
supportapp:ListSlackWorkspaceConfigurations

Read

supportapp:ListSlackWorkspaceConfigurations

Update

supportapp:RegisterSlackWorkspaceForOrganization,
supportapp:ListSlackWorkspaceConfigurations

Delete

supportapp:ListSlackWorkspaceConfigurations,
supportapp:DeleteSlackWorkspaceConfiguration

List

supportapp:ListSlackWorkspaceConfigurations