Class: Aws::Chatbot::Types::SlackChannelConfiguration

Inherits:

Struct

• Object
• Struct
• Aws::Chatbot::Types::SlackChannelConfiguration

Defined in:

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

Overview

An AWS Chatbot configuration for Slack.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #chat_configuration_arn ⇒ String

  The ARN of the SlackChannelConfiguration.

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

• #slack_channel_id ⇒ String

  The ID of the Slack channel.

• #slack_channel_name ⇒ String

  The name of the Slack Channel.

• #slack_team_id ⇒ String

  The ID of the Slack workspace authorized with AWS Chatbot.

• #slack_team_name ⇒ String

  Name of the Slack Workspace.

• #sns_topic_arns ⇒ Array<String>

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

• #user_authorization_required ⇒ Boolean

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

Instance Attribute Details

#chat_configuration_arn ⇒ String

The ARN of the SlackChannelConfiguration.

Returns:

• (String)

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

class SlackChannelConfiguration < Struct.new(
  :slack_team_name,
  :slack_team_id,
  :slack_channel_id,
  :slack_channel_name,
  :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 1064

class SlackChannelConfiguration < Struct.new(
  :slack_team_name,
  :slack_team_id,
  :slack_channel_id,
  :slack_channel_name,
  :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 1064

class SlackChannelConfiguration < Struct.new(
  :slack_team_name,
  :slack_team_id,
  :slack_channel_id,
  :slack_channel_name,
  :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 1064

class SlackChannelConfiguration < Struct.new(
  :slack_team_name,
  :slack_team_id,
  :slack_channel_id,
  :slack_channel_name,
  :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 1064

class SlackChannelConfiguration < Struct.new(
  :slack_team_name,
  :slack_team_id,
  :slack_channel_id,
  :slack_channel_name,
  :chat_configuration_arn,
  :iam_role_arn,
  :sns_topic_arns,
  :configuration_name,
  :logging_level,
  :guardrail_policy_arns,
  :user_authorization_required)
  SENSITIVE = []
  include Aws::Structure
end

#slack_channel_id ⇒ String

The ID of the Slack channel. To get the ID, open Slack, right click on the channel name in the left pane, then choose Copy Link. The channel ID is the 9-character string at the end of the URL. For example, ABCBBLZZZ.

Returns:

• (String)

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

class SlackChannelConfiguration < Struct.new(
  :slack_team_name,
  :slack_team_id,
  :slack_channel_id,
  :slack_channel_name,
  :chat_configuration_arn,
  :iam_role_arn,
  :sns_topic_arns,
  :configuration_name,
  :logging_level,
  :guardrail_policy_arns,
  :user_authorization_required)
  SENSITIVE = []
  include Aws::Structure
end

#slack_channel_name ⇒ String

The name of the Slack Channel.

Returns:

• (String)

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

class SlackChannelConfiguration < Struct.new(
  :slack_team_name,
  :slack_team_id,
  :slack_channel_id,
  :slack_channel_name,
  :chat_configuration_arn,
  :iam_role_arn,
  :sns_topic_arns,
  :configuration_name,
  :logging_level,
  :guardrail_policy_arns,
  :user_authorization_required)
  SENSITIVE = []
  include Aws::Structure
end

#slack_team_id ⇒ String

The ID of the Slack workspace authorized with AWS Chatbot.

Returns:

• (String)

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

class SlackChannelConfiguration < Struct.new(
  :slack_team_name,
  :slack_team_id,
  :slack_channel_id,
  :slack_channel_name,
  :chat_configuration_arn,
  :iam_role_arn,
  :sns_topic_arns,
  :configuration_name,
  :logging_level,
  :guardrail_policy_arns,
  :user_authorization_required)
  SENSITIVE = []
  include Aws::Structure
end

#slack_team_name ⇒ String

Name of the Slack Workspace.

Returns:

• (String)

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

class SlackChannelConfiguration < Struct.new(
  :slack_team_name,
  :slack_team_id,
  :slack_channel_id,
  :slack_channel_name,
  :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 1064

class SlackChannelConfiguration < Struct.new(
  :slack_team_name,
  :slack_team_id,
  :slack_channel_id,
  :slack_channel_name,
  :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 1064

class SlackChannelConfiguration < Struct.new(
  :slack_team_name,
  :slack_team_id,
  :slack_channel_id,
  :slack_channel_name,
  :chat_configuration_arn,
  :iam_role_arn,
  :sns_topic_arns,
  :configuration_name,
  :logging_level,
  :guardrail_policy_arns,
  :user_authorization_required)
  SENSITIVE = []
  include Aws::Structure
end