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	awscc.chatbot.microsoft_teams_channel_configurations

Fields

get (all properties)

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_channel_name	string	The name 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
customization_resource_arns	array	ARNs of Custom Actions to associate with notifications in the provided chat channel.
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
arn	string	Amazon Resource Name (ARN) of the configuration
region	string	AWS region.

For more information, see AWS::Chatbot::MicrosoftTeamsChannelConfiguration.

Methods

Name	Resource	Accessible by	Required Params
create_resource	microsoft_teams_channel_configurations	INSERT	TeamId, TeamsChannelId, TeamsTenantId, ConfigurationName, IamRoleArn, region
delete_resource	microsoft_teams_channel_configurations	DELETE	Identifier, region
update_resource	microsoft_teams_channel_configurations	UPDATE	Identifier, PatchDocument, region
list_resources	microsoft_teams_channel_configurations_list_only	SELECT	region
get_resource	microsoft_teams_channel_configurations	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual microsoft_teams_channel_configuration.

SELECT
  region,
  team_id,
  teams_channel_id,
  teams_channel_name,
  teams_tenant_id,
  configuration_name,
  iam_role_arn,
  sns_topic_arns,
  logging_level,
  arn,
  guardrail_policies,
  user_role_required,
  tags,
  customization_resource_arns
FROM awscc.chatbot.microsoft_teams_channel_configurations
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ arn }}';

list (identifiers only)

Lists all microsoft_teams_channel_configurations in a region.

SELECT
  region,
  arn
FROM awscc.chatbot.microsoft_teams_channel_configurations_list_only
WHERE
  region = 'us-east-1';

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 awscc.chatbot.microsoft_teams_channel_configurations (
  TeamId,
  TeamsChannelId,
  TeamsTenantId,
  ConfigurationName,
  IamRoleArn,
  region
)
SELECT
  '{{ team_id }}',
  '{{ teams_channel_id }}',
  '{{ teams_tenant_id }}',
  '{{ configuration_name }}',
  '{{ iam_role_arn }}',
  '{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.chatbot.microsoft_teams_channel_configurations (
  TeamId,
  TeamsChannelId,
  TeamsChannelName,
  TeamsTenantId,
  ConfigurationName,
  IamRoleArn,
  SnsTopicArns,
  LoggingLevel,
  GuardrailPolicies,
  UserRoleRequired,
  Tags,
  CustomizationResourceArns,
  region
)
SELECT
  '{{ team_id }}',
  '{{ teams_channel_id }}',
  '{{ teams_channel_name }}',
  '{{ teams_tenant_id }}',
  '{{ configuration_name }}',
  '{{ iam_role_arn }}',
  '{{ sns_topic_arns }}',
  '{{ logging_level }}',
  '{{ guardrail_policies }}',
  '{{ user_role_required }}',
  '{{ tags }}',
  '{{ customization_resource_arns }}',
  '{{ 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: team_id
        value: '{{ team_id }}'
      - name: teams_channel_id
        value: '{{ teams_channel_id }}'
      - name: teams_channel_name
        value: '{{ teams_channel_name }}'
      - name: teams_tenant_id
        value: '{{ teams_tenant_id }}'
      - name: configuration_name
        value: '{{ configuration_name }}'
      - name: iam_role_arn
        value: '{{ iam_role_arn }}'
      - name: sns_topic_arns
        value:
          - '{{ sns_topic_arns[0] }}'
      - name: logging_level
        value: '{{ logging_level }}'
      - name: guardrail_policies
        value:
          - '{{ guardrail_policies[0] }}'
      - name: user_role_required
        value: '{{ user_role_required }}'
      - name: tags
        value:
          - value: '{{ value }}'
            key: '{{ key }}'
      - name: customization_resource_arns
        value:
          - '{{ customization_resource_arns[0] }}'

UPDATE example

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

/*+ update */
UPDATE awscc.chatbot.microsoft_teams_channel_configurations
SET PatchDocument = string('{{ {
    "TeamsChannelId": teams_channel_id,
    "TeamsChannelName": teams_channel_name,
    "IamRoleArn": iam_role_arn,
    "SnsTopicArns": sns_topic_arns,
    "LoggingLevel": logging_level,
    "GuardrailPolicies": guardrail_policies,
    "UserRoleRequired": user_role_required,
    "Tags": tags,
    "CustomizationResourceArns": customization_resource_arns
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ arn }}';

DELETE example

/*+ delete */
DELETE FROM awscc.chatbot.microsoft_teams_channel_configurations
WHERE
  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,
chatbot:AssociateToConfiguration,
chatbot:ListAssociations,
iam:PassRole,
iam:CreateServiceLinkedRole

Read

chatbot:GetMicrosoftTeamsChannelConfiguration,
chatbot:ListAssociations

Update

chatbot:UpdateMicrosoftTeamsChannelConfiguration,
chatbot:TagResource,
chatbot:UntagResource,
chatbot:ListTagsForResource,
chatbot:AssociateToConfiguration,
chatbot:DisassociateFromConfiguration,
chatbot:ListAssociations,
iam:PassRole

Delete

chatbot:GetMicrosoftTeamsChannelConfiguration,
chatbot:DeleteMicrosoftTeamsChannelConfiguration,
chatbot:DisassociateFromConfiguration,
chatbot:ListAssociations

List

chatbot:ListMicrosoftTeamsChannelConfigurations,
chatbot:ListAssociations