AWS::SupportApp::SlackWorkspaceConfiguration - AWS CloudFormation
SyntaxPropertiesReturn valuesExamples

AWS::SupportApp::SlackWorkspaceConfiguration

You can use the AWS::SupportApp::SlackWorkspaceConfiguration resource to specify your Slack workspace configuration. This resource configures your AWS account so that you can use the specified Slack workspace in the AWS Support App. This resource includes the following information:

  • The team ID for the Slack workspace

  • The version ID of the resource to use with AWS CloudFormation

For more information, see the following topics in the AWS Support User Guide:

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::SupportApp::SlackWorkspaceConfiguration",
  "Properties" : {
      "TeamId" : String,
      "VersionId" : String
    }
}

YAML

Type: AWS::SupportApp::SlackWorkspaceConfiguration
Properties:
  TeamId: String
  VersionId: String

Properties

TeamId

The team ID in Slack. This ID uniquely identifies a Slack workspace, such as T012ABCDEFG.

Required: Yes

Type: String

Pattern: ^\S+$

Minimum: 1

Maximum: 256

Update requires: Replacement

VersionId

An identifier used to update an existing Slack workspace configuration in AWS CloudFormation, such as 100.

Required: No

Type: String

Pattern: ^[0-9]+$

Minimum: 1

Maximum: 256

Update requires: No interruption

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the ID of the Slack workspace, such as T012ABCDEFG.

For the AWS Support App Slack workspace configuration, Ref returns the value of the Slack workspace ID.

For more information about using the Ref function, see Ref.

Examples

The following examples can help you create AWS Support App resources using CloudFormation.

Example

Use this template to create a Slack workspace configuration for your account or your organization. You must replace the Slack workspace ID.

JSON

{
    "AWSTemplateFormatVersion": "2010-09-09",
    "Description": "Example stack to create a Slack workspace configuration",
    "Resources": {
        "SlackWorkspaceConfiguration": {
            "Type": "AWS::SupportApp::SlackWorkspaceConfiguration",
            "Properties": {
                "TeamId": "T012ABCDEFG",
                "VersionId": "1"
            }
        }
    }
}

YAML

AWSTemplateFormatVersion: '2010-09-09'
Description: Example stack to create a Slack workspace configuration
Resources:
  SlackWorkspaceConfiguration:
    Type: AWS::SupportApp::SlackWorkspaceConfiguration
    Properties:
      TeamId: T012ABCDEFG
      VersionId: '1'