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 = 
[:slack_channel_name]

Instance Attribute Summary collapse

Instance Attribute Details

#chat_configuration_arn ⇒ String

The Amazon Resource Name (ARN) of the SlackChannelConfiguration.

Returns:

  • (String) 


1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
 
# File 'gems/aws-sdk-chatbot/lib/aws-sdk-chatbot/types.rb', line 1785

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

#configuration_name ⇒ String

The name of the configuration.

Returns:

  • (String) 


1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
 
# File 'gems/aws-sdk-chatbot/lib/aws-sdk-chatbot/types.rb', line 1785

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,
  :state,
  :state_reason)
  SENSITIVE = [:slack_channel_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>) 


1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
 
# File 'gems/aws-sdk-chatbot/lib/aws-sdk-chatbot/types.rb', line 1785

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,
  :state,
  :state_reason)
  SENSITIVE = [:slack_channel_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.

Returns:

  • (String) 


1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
 
# File 'gems/aws-sdk-chatbot/lib/aws-sdk-chatbot/types.rb', line 1785

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

#logging_level ⇒ String

Logging levels include ERROR, INFO, or NONE.

Returns:

  • (String) 


1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
 
# File 'gems/aws-sdk-chatbot/lib/aws-sdk-chatbot/types.rb', line 1785

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

#slack_channel_id ⇒ String

The ID of the Slack channel.

To get this 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) 


1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
 
# File 'gems/aws-sdk-chatbot/lib/aws-sdk-chatbot/types.rb', line 1785

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

#slack_channel_name ⇒ String

The name of the Slack channel.

Returns:

  • (String) 


1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
 
# File 'gems/aws-sdk-chatbot/lib/aws-sdk-chatbot/types.rb', line 1785

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

#slack_team_id ⇒ String

The ID of the Slack workspace authorized with Amazon Chime.

Returns:

  • (String) 


1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
 
# File 'gems/aws-sdk-chatbot/lib/aws-sdk-chatbot/types.rb', line 1785

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

#slack_team_name ⇒ String

Name of the Slack workspace.

Returns:

  • (String) 


1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
 
# File 'gems/aws-sdk-chatbot/lib/aws-sdk-chatbot/types.rb', line 1785

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

#sns_topic_arns ⇒ Array<String>

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

Returns:

  • (Array<String>) 


1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
 
# File 'gems/aws-sdk-chatbot/lib/aws-sdk-chatbot/types.rb', line 1785

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,
  :state,
  :state_reason)
  SENSITIVE = [:slack_channel_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) 


1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
 
# File 'gems/aws-sdk-chatbot/lib/aws-sdk-chatbot/types.rb', line 1785

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

#state_reason ⇒ String

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

Returns:

  • (String) 


1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
 
# File 'gems/aws-sdk-chatbot/lib/aws-sdk-chatbot/types.rb', line 1785

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,
  :state,
  :state_reason)
  SENSITIVE = [:slack_channel_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:



1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
 
# File 'gems/aws-sdk-chatbot/lib/aws-sdk-chatbot/types.rb', line 1785

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

#user_authorization_required ⇒ Boolean

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

Returns:

  • (Boolean) 


1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
 
# File 'gems/aws-sdk-chatbot/lib/aws-sdk-chatbot/types.rb', line 1785

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