AWS::Chatbot::SlackChannelConfiguration
AWS::Chatbot::SlackChannelConfiguration
リソースは、ユーザーが AWS CloudFormation テンプレートで AWS Chatbot を使用できるようにする Slack チャネルを設定します。
このリソースでは、AWS Chatbot コンソールでセットアップを行う必要があります。必要な Slack ワークスペース ID を提供するには、AWS Chatbot コンソールで Slack を使用して初期認証フローを実行し、コンソールからワークスペース ID をコピーして貼り付ける必要があります。詳細については、AWS Chatbot ユーザーガイドの「Setting Up AWS Chatbot with Slack」のステップ 1~4 を参照してください。
構文
AWS CloudFormation テンプレートでこのエンティティを宣言するには、次の構文を使用します。
JSON
{ "Type" : "AWS::Chatbot::SlackChannelConfiguration", "Properties" : { "ConfigurationName" :
String
, "IamRoleArn" :String
, "LoggingLevel" :String
, "SlackChannelId" :String
, "SlackWorkspaceId" :String
, "SnsTopicArns" :[ String, ... ]
} }
YAML
Type: AWS::Chatbot::SlackChannelConfiguration Properties: ConfigurationName:
String
IamRoleArn:String
LoggingLevel:String
SlackChannelId:String
SlackWorkspaceId:String
SnsTopicArns:- String
プロパティ
ConfigurationName
-
設定の名前。
必須: はい
タイプ: 文字列
Update requires: Replacement
IamRoleArn
-
AWS Chatbot のアクセス許可を定義する IAM ロールの ARN。
これは AWS Chatbot が継承するユーザー定義のロールです。これはサービスにリンクされたロールではありません。詳細については、「IAM Policies for AWS Chatbot」を参照してください。
必須: はい
タイプ: 文字列
Update requires: No interruption
LoggingLevel
-
この設定のログレベルを指定します。このプロパティは、Amazon CloudWatch Logs にプッシュされるログエントリに影響します。
ログレベルには
ERROR
、INFO
、NONE
があります。必須: いいえ
タイプ: 文字列
Update requires: No interruption
SlackChannelId
-
Slack チャネルの ID。
ID を取得するには、Slack を開き、左ペインでチャネル名を右クリックし、次に [Copy Link (リンクのコピー)] を選択します。チャネル ID は、URL の末尾にある 9 文字の文字列です。たとえば、
ABCBBLZZZ
と指定します。必須: はい
タイプ: 文字列
Update requires: No interruption
SlackWorkspaceId
-
AWS Chatbot で承認された Slack ワークスペースの ID。
ワークスペース ID を取得するには、AWS Chatbot コンソールで Slack を使用して初期認証フローを実行する必要があります。そうすると、コンソールからワークスペース ID をコピーして貼り付けることができます。詳細については、AWS Chatbot ユーザーガイドの「Setting Up AWS Chatbot with Slack」のステップ 1~4 を参照してください。
必須: はい
タイプ: 文字列
Update requires: Replacement
SnsTopicArns
-
AWS Chatbot に通知を配信する SNS トピックの ARN。
必須: いいえ
タイプ: 文字列のリスト
Update requires: No interruption
戻り値
Ref
このリソースの論理 ID を組み込み Ref 関数に渡すと、Ref は作成された設定の ARN を返します。
Fn::GetAtt
解説
一般的なトラブルシューティングシナリオ:
-
ワークスペース ID がありません。
ワークスペース ID がない場合は、AWS Chatbot コンソールで初期認証フローを実行する必要があります。そうすると、コンソールからワークスペース ID をコピーして貼り付けることができます。詳細については、AWS Chatbot ユーザーガイドの「Setting Up AWS Chatbot with Slack」のステップ 1~4 を参照してください。
-
すでにワークスペースの初期認証を行っています。もう一度行う必要がありますか?
いいえ、既存のワークスペースを使用できます。ワークスペース ID を取得するには、AWS Chatbot コンソールにログインする必要があります。