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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-chatbot/lib/aws-sdk-chatbot/types.rb

Overview

An AWS Chatbot configuration for Slack.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#chat_configuration_arn ⇒ String

The ARN of the SlackChannelConfiguration.

Returns:

  • (String) 


1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
 
# File 'gems/aws-sdk-chatbot/lib/aws-sdk-chatbot/types.rb', line 1126

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

#configuration_name ⇒ String

The name of the configuration.

Returns:

  • (String) 


1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
 
# File 'gems/aws-sdk-chatbot/lib/aws-sdk-chatbot/types.rb', line 1126

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,
  :tags)
  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>) 


1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
 
# File 'gems/aws-sdk-chatbot/lib/aws-sdk-chatbot/types.rb', line 1126

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,
  :tags)
  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) 


1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
 
# File 'gems/aws-sdk-chatbot/lib/aws-sdk-chatbot/types.rb', line 1126

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

#logging_level ⇒ String

Logging levels include ERROR, INFO, or NONE.

Returns:

  • (String) 


1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
 
# File 'gems/aws-sdk-chatbot/lib/aws-sdk-chatbot/types.rb', line 1126

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,
  :tags)
  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) 


1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
 
# File 'gems/aws-sdk-chatbot/lib/aws-sdk-chatbot/types.rb', line 1126

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

#slack_channel_name ⇒ String

The name of the Slack Channel.

Returns:

  • (String) 


1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
 
# File 'gems/aws-sdk-chatbot/lib/aws-sdk-chatbot/types.rb', line 1126

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

#slack_team_id ⇒ String

The ID of the Slack workspace authorized with AWS Chatbot.

Returns:

  • (String) 


1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
 
# File 'gems/aws-sdk-chatbot/lib/aws-sdk-chatbot/types.rb', line 1126

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

#slack_team_name ⇒ String

Name of the Slack Workspace.

Returns:

  • (String) 


1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
 
# File 'gems/aws-sdk-chatbot/lib/aws-sdk-chatbot/types.rb', line 1126

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,
  :tags)
  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>) 


1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
 
# File 'gems/aws-sdk-chatbot/lib/aws-sdk-chatbot/types.rb', line 1126

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

#tags ⇒ Array<Types::Tag>

A list of tags applied to the configuration.

Returns:



1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
 
# File 'gems/aws-sdk-chatbot/lib/aws-sdk-chatbot/types.rb', line 1126

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

#user_authorization_required ⇒ Boolean

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

Returns:

  • (Boolean) 


1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
 
# File 'gems/aws-sdk-chatbot/lib/aws-sdk-chatbot/types.rb', line 1126

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