microsoft_teams_channel_configurations

Creates, updates, deletes or gets a microsoft_teams_channel_configuration resource or lists microsoft_teams_channel_configurations in a region

Overview

Name	microsoft_teams_channel_configurations
Type	Resource
Description	Resource schema for AWS::Chatbot::MicrosoftTeamsChannelConfiguration.
Id	aws.chatbot.microsoft_teams_channel_configurations

Fields

Name	Datatype	Description
team_id	string	The id of the Microsoft Teams team
teams_channel_id	string	The id of the Microsoft Teams channel
teams_tenant_id	string	The id of the Microsoft Teams tenant
configuration_name	string	The name of the configuration
iam_role_arn	string	The ARN of the IAM role that defines the permissions for AWS Chatbot
sns_topic_arns	array	ARNs of SNS topics which delivers notifications to AWS Chatbot, for example CloudWatch alarm notifications.
logging_level	string	Specifies the logging level for this configuration:ERROR,INFO or NONE. This property affects the log entries pushed to Amazon CloudWatch logs
arn	string	Amazon Resource Name (ARN) of the configuration
guardrail_policies	array	The list of IAM policy ARNs that are applied as channel guardrails. The AWS managed 'AdministratorAccess' policy is applied as a default if this is not set.
user_role_required	boolean	Enables use of a user role requirement in your chat configuration
tags	array	The tags to add to the configuration
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	TeamId, TeamsChannelId, TeamsTenantId, ConfigurationName, IamRoleArn, 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 microsoft_teams_channel_configurations in a region.

SELECT
region,
team_id,
teams_channel_id,
teams_tenant_id,
configuration_name,
iam_role_arn,
sns_topic_arns,
logging_level,
arn,
guardrail_policies,
user_role_required,
tags
FROM aws.chatbot.microsoft_teams_channel_configurations
WHERE region = 'us-east-1';

Gets all properties from an individual microsoft_teams_channel_configuration.

SELECT
region,
team_id,
teams_channel_id,
teams_tenant_id,
configuration_name,
iam_role_arn,
sns_topic_arns,
logging_level,
arn,
guardrail_policies,
user_role_required,
tags
FROM aws.chatbot.microsoft_teams_channel_configurations
WHERE region = 'us-east-1' AND data__Identifier = '<Arn>';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO aws.chatbot.microsoft_teams_channel_configurations (
 TeamId,
 TeamsChannelId,
 TeamsTenantId,
 ConfigurationName,
 IamRoleArn,
 region
)
SELECT 
'{{ TeamId }}',
 '{{ TeamsChannelId }}',
 '{{ TeamsTenantId }}',
 '{{ ConfigurationName }}',
 '{{ IamRoleArn }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.chatbot.microsoft_teams_channel_configurations (
 TeamId,
 TeamsChannelId,
 TeamsTenantId,
 ConfigurationName,
 IamRoleArn,
 SnsTopicArns,
 LoggingLevel,
 GuardrailPolicies,
 UserRoleRequired,
 Tags,
 region
)
SELECT 
 '{{ TeamId }}',
 '{{ TeamsChannelId }}',
 '{{ TeamsTenantId }}',
 '{{ ConfigurationName }}',
 '{{ IamRoleArn }}',
 '{{ SnsTopicArns }}',
 '{{ LoggingLevel }}',
 '{{ GuardrailPolicies }}',
 '{{ UserRoleRequired }}',
 '{{ Tags }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: microsoft_teams_channel_configuration
    props:
      - name: TeamId
        value: '{{ TeamId }}'
      - name: TeamsChannelId
        value: '{{ TeamsChannelId }}'
      - name: TeamsTenantId
        value: '{{ TeamsTenantId }}'
      - name: ConfigurationName
        value: '{{ ConfigurationName }}'
      - name: IamRoleArn
        value: '{{ IamRoleArn }}'
      - name: SnsTopicArns
        value:
          - '{{ SnsTopicArns[0] }}'
      - name: LoggingLevel
        value: '{{ LoggingLevel }}'
      - name: GuardrailPolicies
        value:
          - '{{ GuardrailPolicies[0] }}'
      - name: UserRoleRequired
        value: '{{ UserRoleRequired }}'
      - name: Tags
        value:
          - Value: '{{ Value }}'
            Key: '{{ Key }}'

DELETE example

/*+ delete */
DELETE FROM aws.chatbot.microsoft_teams_channel_configurations
WHERE data__Identifier = '<Arn>'
AND region = 'us-east-1';

Permissions

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

Create

chatbot:CreateMicrosoftTeamsChannelConfiguration,
chatbot:TagResource,
iam:PassRole,
iam:CreateServiceLinkedRole

Read

chatbot:GetMicrosoftTeamsChannelConfiguration

Update

chatbot:UpdateMicrosoftTeamsChannelConfiguration,
chatbot:TagResource,
chatbot:UntagResource,
chatbot:ListTagsForResource,
iam:PassRole

Delete

chatbot:GetMicrosoftTeamsChannelConfiguration,
chatbot:DeleteMicrosoftTeamsChannelConfiguration

List

chatbot:ListMicrosoftTeamsChannelConfigurations