Skip to main content

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​

Namemicrosoft_teams_channel_configurations
TypeResource
DescriptionResource schema for AWS::Chatbot::MicrosoftTeamsChannelConfiguration.
Idawscc.chatbot.microsoft_teams_channel_configurations

Fields​

NameDatatypeDescription
team_idstringThe id of the Microsoft Teams team
teams_channel_idstringThe id of the Microsoft Teams channel
teams_channel_namestringThe name of the Microsoft Teams channel
teams_tenant_idstringThe id of the Microsoft Teams tenant
configuration_namestringThe name of the configuration
iam_role_arnstringThe ARN of the IAM role that defines the permissions for AWS Chatbot
sns_topic_arnsarrayARNs of SNS topics which delivers notifications to AWS Chatbot, for example CloudWatch alarm notifications.
logging_levelstringSpecifies the logging level for this configuration:ERROR,INFO or NONE. This property affects the log entries pushed to Amazon CloudWatch logs
arnstringAmazon Resource Name (ARN) of the configuration
guardrail_policiesarrayThe 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_requiredbooleanEnables use of a user role requirement in your chat configuration
▶tagsarrayThe tags to add to the configuration
customization_resource_arnsarrayARNs of Custom Actions to associate with notifications in the provided chat channel.
regionstringAWS region.

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

Methods​

NameResourceAccessible byRequired Params
create_resourcemicrosoft_teams_channel_configurationsINSERTTeamId, TeamsChannelId, TeamsTenantId, ConfigurationName, IamRoleArn, region
delete_resourcemicrosoft_teams_channel_configurationsDELETEIdentifier, region
update_resourcemicrosoft_teams_channel_configurationsUPDATEIdentifier, PatchDocument, region
list_resourcesmicrosoft_teams_channel_configurations_list_onlySELECTregion
get_resourcemicrosoft_teams_channel_configurationsSELECTIdentifier, region

SELECT examples​

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 = '{{ region }}' AND
  Identifier = '{{ arn }}';

INSERT example​

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

/*+ 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 }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

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 }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example​

/*+ delete */
DELETE FROM awscc.chatbot.microsoft_teams_channel_configurations
WHERE
  Identifier = '{{ arn }}' AND
  region = '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Additional Parameters​

Mutable resources in the Cloud Control provider support additional optional parameters which can be supplied with INSERT, UPDATE, or DELETE operations. These include:

ParameterDescription
ClientToken
A unique identifier to ensure the idempotency of the resource request.This allows the provider to accurately distinguish between retries and new requests.
A client token is valid for 36 hours once used.
After that, a resource request with the same client token is treated as a new request.
If you do not specify a client token, one is generated for inclusion in the request.
RoleArn
The ARN of the IAM role used to perform this resource operation.The role specified must have the permissions required for this operation.
If you do not specify a role, a temporary session is created using your AWS user credentials.
TypeVersionId
For private resource types, the type version to use in this resource operation.If you do not specify a resource version, the default version is used.

Permissions​

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

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