Class: Aws::Chatbot::Types::TeamsChannelConfiguration

Inherits:

Struct

• Object
• Struct
• Aws::Chatbot::Types::TeamsChannelConfiguration

Includes:

Structure

Defined in:

lib/aws-sdk-chatbot/types.rb

Overview

An AWS Chatbot configuration for Microsoft Teams.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:channel_name, :team_name]

Instance Attribute Summary

• #channel_id ⇒ String

  The ID of the Microsoft Teams channel.

• #channel_name ⇒ String

  The name of the Microsoft Teams channel.

• #chat_configuration_arn ⇒ String

  The Amazon Resource Name (ARN) of the MicrosoftTeamsChannelConfiguration associated with the user identity to delete.

• #configuration_name ⇒ String

  The name of the configuration.

• #guardrail_policy_arns ⇒ Array<String>

  The list of IAM policy ARNs that are applied as channel guardrails.

• #iam_role_arn ⇒ String

  A user-defined role that AWS Chatbot assumes.

• #logging_level ⇒ String

  Logging levels include ‘ERROR`, `INFO`, or `NONE`.

• #sns_topic_arns ⇒ Array<String>

  The Amazon Resource Names (ARNs) of the SNS topics that deliver notifications to AWS Chatbot.

• #state ⇒ String

  Either ‘ENABLED` or `DISABLED`.

• #state_reason ⇒ String

  Provided if State is ‘DISABLED`.

• #tags ⇒ Array<Types::Tag>

  A map of tags assigned to a resource.

• #team_id ⇒ String

  The ID of the Microsoft Teams authorized with AWS Chatbot.

• #team_name ⇒ String

  The name of the Microsoft Teams Team.

• #tenant_id ⇒ String

  The ID of the Microsoft Teams tenant.

• #user_authorization_required ⇒ Boolean

  Enables use of a user role requirement in your chat configuration.

Instance Attribute Details

#channel_id ⇒ String

The ID of the Microsoft Teams channel.

Returns:

• (String)

# File 'lib/aws-sdk-chatbot/types.rb', line 1655

class TeamsChannelConfiguration < Struct.new(
  :channel_id,
  :channel_name,
  :team_id,
  :team_name,
  :tenant_id,
  :chat_configuration_arn,
  :iam_role_arn,
  :sns_topic_arns,
  :configuration_name,
  :logging_level,
  :guardrail_policy_arns,
  :user_authorization_required,
  :tags,
  :state,
  :state_reason)
  SENSITIVE = [:channel_name, :team_name]
  include Aws::Structure
end

#channel_name ⇒ String

The name of the Microsoft Teams channel.

Returns:

• (String)

# File 'lib/aws-sdk-chatbot/types.rb', line 1655

class TeamsChannelConfiguration < Struct.new(
  :channel_id,
  :channel_name,
  :team_id,
  :team_name,
  :tenant_id,
  :chat_configuration_arn,
  :iam_role_arn,
  :sns_topic_arns,
  :configuration_name,
  :logging_level,
  :guardrail_policy_arns,
  :user_authorization_required,
  :tags,
  :state,
  :state_reason)
  SENSITIVE = [:channel_name, :team_name]
  include Aws::Structure
end

#chat_configuration_arn ⇒ String

The Amazon Resource Name (ARN) of the MicrosoftTeamsChannelConfiguration associated with the user identity to delete.

Returns:

• (String)

# File 'lib/aws-sdk-chatbot/types.rb', line 1655

class TeamsChannelConfiguration < Struct.new(
  :channel_id,
  :channel_name,
  :team_id,
  :team_name,
  :tenant_id,
  :chat_configuration_arn,
  :iam_role_arn,
  :sns_topic_arns,
  :configuration_name,
  :logging_level,
  :guardrail_policy_arns,
  :user_authorization_required,
  :tags,
  :state,
  :state_reason)
  SENSITIVE = [:channel_name, :team_name]
  include Aws::Structure
end

#configuration_name ⇒ String

The name of the configuration.

Returns:

• (String)

# File 'lib/aws-sdk-chatbot/types.rb', line 1655

class TeamsChannelConfiguration < Struct.new(
  :channel_id,
  :channel_name,
  :team_id,
  :team_name,
  :tenant_id,
  :chat_configuration_arn,
  :iam_role_arn,
  :sns_topic_arns,
  :configuration_name,
  :logging_level,
  :guardrail_policy_arns,
  :user_authorization_required,
  :tags,
  :state,
  :state_reason)
  SENSITIVE = [:channel_name, :team_name]
  include Aws::Structure
end

#guardrail_policy_arns ⇒ Array<String>

The list of IAM policy ARNs that are applied as channel guardrails. The AWS managed ‘AdministratorAccess` policy is applied by default if this is not set.

Returns:

• (Array<String>)

# File 'lib/aws-sdk-chatbot/types.rb', line 1655

class TeamsChannelConfiguration < Struct.new(
  :channel_id,
  :channel_name,
  :team_id,
  :team_name,
  :tenant_id,
  :chat_configuration_arn,
  :iam_role_arn,
  :sns_topic_arns,
  :configuration_name,
  :logging_level,
  :guardrail_policy_arns,
  :user_authorization_required,
  :tags,
  :state,
  :state_reason)
  SENSITIVE = [:channel_name, :team_name]
  include Aws::Structure
end

#iam_role_arn ⇒ String

A user-defined role that AWS Chatbot assumes. This is not the service-linked role.

For more information, see [IAM policies for AWS Chatbot] in the AWS Chatbot Administrator Guide.

[1]: docs.aws.amazon.com/chatbot/latest/adminguide/chatbot-iam-policies.html

Returns:

• (String)

# File 'lib/aws-sdk-chatbot/types.rb', line 1655

class TeamsChannelConfiguration < Struct.new(
  :channel_id,
  :channel_name,
  :team_id,
  :team_name,
  :tenant_id,
  :chat_configuration_arn,
  :iam_role_arn,
  :sns_topic_arns,
  :configuration_name,
  :logging_level,
  :guardrail_policy_arns,
  :user_authorization_required,
  :tags,
  :state,
  :state_reason)
  SENSITIVE = [:channel_name, :team_name]
  include Aws::Structure
end

#logging_level ⇒ String

Logging levels include ‘ERROR`, `INFO`, or `NONE`.

Returns:

• (String)

# File 'lib/aws-sdk-chatbot/types.rb', line 1655

class TeamsChannelConfiguration < Struct.new(
  :channel_id,
  :channel_name,
  :team_id,
  :team_name,
  :tenant_id,
  :chat_configuration_arn,
  :iam_role_arn,
  :sns_topic_arns,
  :configuration_name,
  :logging_level,
  :guardrail_policy_arns,
  :user_authorization_required,
  :tags,
  :state,
  :state_reason)
  SENSITIVE = [:channel_name, :team_name]
  include Aws::Structure
end

#sns_topic_arns ⇒ Array<String>

The Amazon Resource Names (ARNs) of the SNS topics that deliver notifications to AWS Chatbot.

Returns:

• (Array<String>)

# File 'lib/aws-sdk-chatbot/types.rb', line 1655

class TeamsChannelConfiguration < Struct.new(
  :channel_id,
  :channel_name,
  :team_id,
  :team_name,
  :tenant_id,
  :chat_configuration_arn,
  :iam_role_arn,
  :sns_topic_arns,
  :configuration_name,
  :logging_level,
  :guardrail_policy_arns,
  :user_authorization_required,
  :tags,
  :state,
  :state_reason)
  SENSITIVE = [:channel_name, :team_name]
  include Aws::Structure
end

#state ⇒ String

Either ‘ENABLED` or `DISABLED`. The resource returns `DISABLED` if the organization’s AWS Chatbot policy has explicitly denied that configuration. For example, if Amazon Chime is disabled.

Returns:

• (String)

# File 'lib/aws-sdk-chatbot/types.rb', line 1655

class TeamsChannelConfiguration < Struct.new(
  :channel_id,
  :channel_name,
  :team_id,
  :team_name,
  :tenant_id,
  :chat_configuration_arn,
  :iam_role_arn,
  :sns_topic_arns,
  :configuration_name,
  :logging_level,
  :guardrail_policy_arns,
  :user_authorization_required,
  :tags,
  :state,
  :state_reason)
  SENSITIVE = [:channel_name, :team_name]
  include Aws::Structure
end

#state_reason ⇒ String

Provided if State is ‘DISABLED`. Provides context as to why the resource is disabled.

Returns:

• (String)

# File 'lib/aws-sdk-chatbot/types.rb', line 1655

class TeamsChannelConfiguration < Struct.new(
  :channel_id,
  :channel_name,
  :team_id,
  :team_name,
  :tenant_id,
  :chat_configuration_arn,
  :iam_role_arn,
  :sns_topic_arns,
  :configuration_name,
  :logging_level,
  :guardrail_policy_arns,
  :user_authorization_required,
  :tags,
  :state,
  :state_reason)
  SENSITIVE = [:channel_name, :team_name]
  include Aws::Structure
end

#tags ⇒ Array<Types::Tag>

A map of tags assigned to a resource. A tag is a string-to-string map of key-value pairs.

Returns:

• (Array<Types::Tag>)

# File 'lib/aws-sdk-chatbot/types.rb', line 1655

class TeamsChannelConfiguration < Struct.new(
  :channel_id,
  :channel_name,
  :team_id,
  :team_name,
  :tenant_id,
  :chat_configuration_arn,
  :iam_role_arn,
  :sns_topic_arns,
  :configuration_name,
  :logging_level,
  :guardrail_policy_arns,
  :user_authorization_required,
  :tags,
  :state,
  :state_reason)
  SENSITIVE = [:channel_name, :team_name]
  include Aws::Structure
end

#team_id ⇒ String

The ID of the Microsoft Teams authorized with AWS Chatbot.

To get the team ID, you must perform the initial authorization flow with Microsoft Teams in the AWS Chatbot console. Then you can copy and paste the team ID from the console. For more information, see

Step 1: Configure a Microsoft Teams client][1

in the <i> AWS

Chatbot Administrator Guide</i>.

[1]: docs.aws.amazon.com/chatbot/latest/adminguide/teams-setup.html#teams-client-setup

Returns:

• (String)

# File 'lib/aws-sdk-chatbot/types.rb', line 1655

class TeamsChannelConfiguration < Struct.new(
  :channel_id,
  :channel_name,
  :team_id,
  :team_name,
  :tenant_id,
  :chat_configuration_arn,
  :iam_role_arn,
  :sns_topic_arns,
  :configuration_name,
  :logging_level,
  :guardrail_policy_arns,
  :user_authorization_required,
  :tags,
  :state,
  :state_reason)
  SENSITIVE = [:channel_name, :team_name]
  include Aws::Structure
end

#team_name ⇒ String

The name of the Microsoft Teams Team.

Returns:

• (String)

# File 'lib/aws-sdk-chatbot/types.rb', line 1655

class TeamsChannelConfiguration < Struct.new(
  :channel_id,
  :channel_name,
  :team_id,
  :team_name,
  :tenant_id,
  :chat_configuration_arn,
  :iam_role_arn,
  :sns_topic_arns,
  :configuration_name,
  :logging_level,
  :guardrail_policy_arns,
  :user_authorization_required,
  :tags,
  :state,
  :state_reason)
  SENSITIVE = [:channel_name, :team_name]
  include Aws::Structure
end

#tenant_id ⇒ String

The ID of the Microsoft Teams tenant.

Returns:

• (String)

# File 'lib/aws-sdk-chatbot/types.rb', line 1655

class TeamsChannelConfiguration < Struct.new(
  :channel_id,
  :channel_name,
  :team_id,
  :team_name,
  :tenant_id,
  :chat_configuration_arn,
  :iam_role_arn,
  :sns_topic_arns,
  :configuration_name,
  :logging_level,
  :guardrail_policy_arns,
  :user_authorization_required,
  :tags,
  :state,
  :state_reason)
  SENSITIVE = [:channel_name, :team_name]
  include Aws::Structure
end

#user_authorization_required ⇒ Boolean

Enables use of a user role requirement in your chat configuration.

Returns:

• (Boolean)

# File 'lib/aws-sdk-chatbot/types.rb', line 1655

class TeamsChannelConfiguration < Struct.new(
  :channel_id,
  :channel_name,
  :team_id,
  :team_name,
  :tenant_id,
  :chat_configuration_arn,
  :iam_role_arn,
  :sns_topic_arns,
  :configuration_name,
  :logging_level,
  :guardrail_policy_arns,
  :user_authorization_required,
  :tags,
  :state,
  :state_reason)
  SENSITIVE = [:channel_name, :team_name]
  include Aws::Structure
end