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

Inherits:

Struct

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

Defined in:

gems/aws-sdk-chatbot/lib/aws-sdk-chatbot/types.rb

Overview

An AWS Chatbot configuration for Microsoft Teams.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

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 ARN of the MicrosoftTeamsChannelConfiguration.

• #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

  The ARN of the IAM role that defines the permissions for AWS Chatbot.

• #logging_level ⇒ String

  Logging levels include ERROR, INFO, or NONE.

• #sns_topic_arns ⇒ Array<String>

  The ARNs of the SNS topics that deliver notifications to AWS Chatbot.

• #team_id ⇒ String

  The ID of the Microsoft Team 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 'gems/aws-sdk-chatbot/lib/aws-sdk-chatbot/types.rb', line 1201

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)
  SENSITIVE = []
  include Aws::Structure
end

#channel_name ⇒ String

The name of the Microsoft Teams channel.

Returns:

• (String)

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

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)
  SENSITIVE = []
  include Aws::Structure
end

#chat_configuration_arn ⇒ String

The ARN of the MicrosoftTeamsChannelConfiguration.

Returns:

• (String)

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

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)
  SENSITIVE = []
  include Aws::Structure
end

#configuration_name ⇒ String

The name of the configuration.

Returns:

• (String)

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

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)
  SENSITIVE = []
  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 'gems/aws-sdk-chatbot/lib/aws-sdk-chatbot/types.rb', line 1201

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)
  SENSITIVE = []
  include Aws::Structure
end

#iam_role_arn ⇒ String

The ARN of the IAM role that defines the permissions for AWS Chatbot. This is a user-defined role that AWS Chatbot will assume. This is not the service-linked role. For more information, see IAM Policies for AWS Chatbot.

Returns:

• (String)

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

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)
  SENSITIVE = []
  include Aws::Structure
end

#logging_level ⇒ String

Logging levels include ERROR, INFO, or NONE.

Returns:

• (String)

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

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)
  SENSITIVE = []
  include Aws::Structure
end

#sns_topic_arns ⇒ Array<String>

The ARNs of the SNS topics that deliver notifications to AWS Chatbot.

Returns:

• (Array<String>)

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

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)
  SENSITIVE = []
  include Aws::Structure
end

#team_id ⇒ String

The ID of the Microsoft Team 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 details, see steps 1-4 in Get started with Microsoft Teams in the AWS Chatbot Administrator Guide.

Returns:

• (String)

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

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)
  SENSITIVE = []
  include Aws::Structure
end

#team_name ⇒ String

The name of the Microsoft Teams Team.

Returns:

• (String)

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

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)
  SENSITIVE = []
  include Aws::Structure
end

#tenant_id ⇒ String

The ID of the Microsoft Teams tenant.

Returns:

• (String)

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

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)
  SENSITIVE = []
  include Aws::Structure
end

#user_authorization_required ⇒ Boolean

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

Returns:

• (Boolean)

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

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)
  SENSITIVE = []
  include Aws::Structure
end