Class: Aws::Chatbot::Types::ChimeWebhookConfiguration

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

Overview

An AWS Chatbot configuration for Amazon Chime.

See Also:

Constant Summary collapse

SENSITIVE = 
[:webhook_description]

Instance Attribute Summary collapse

Instance Attribute Details

#chat_configuration_arn ⇒ String

The Amazon Resource Name (ARN) of the ChimeWebhookConfiguration.

Returns:

  • (String) 


140
141
142
143
144
145
146
147
148
149
150
151
152
 
# File 'lib/aws-sdk-chatbot/types.rb', line 140

class ChimeWebhookConfiguration < Struct.new(
  :webhook_description,
  :chat_configuration_arn,
  :iam_role_arn,
  :sns_topic_arns,
  :configuration_name,
  :logging_level,
  :tags,
  :state,
  :state_reason)
  SENSITIVE = [:webhook_description]
  include Aws::Structure
end

#configuration_name ⇒ String

The name of the configuration.

Returns:

  • (String) 


140
141
142
143
144
145
146
147
148
149
150
151
152
 
# File 'lib/aws-sdk-chatbot/types.rb', line 140

class ChimeWebhookConfiguration < Struct.new(
  :webhook_description,
  :chat_configuration_arn,
  :iam_role_arn,
  :sns_topic_arns,
  :configuration_name,
  :logging_level,
  :tags,
  :state,
  :state_reason)
  SENSITIVE = [:webhook_description]
  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) 


140
141
142
143
144
145
146
147
148
149
150
151
152
 
# File 'lib/aws-sdk-chatbot/types.rb', line 140

class ChimeWebhookConfiguration < Struct.new(
  :webhook_description,
  :chat_configuration_arn,
  :iam_role_arn,
  :sns_topic_arns,
  :configuration_name,
  :logging_level,
  :tags,
  :state,
  :state_reason)
  SENSITIVE = [:webhook_description]
  include Aws::Structure
end

#logging_level ⇒ String

Logging levels include ERROR, INFO, or NONE.

Returns:

  • (String) 


140
141
142
143
144
145
146
147
148
149
150
151
152
 
# File 'lib/aws-sdk-chatbot/types.rb', line 140

class ChimeWebhookConfiguration < Struct.new(
  :webhook_description,
  :chat_configuration_arn,
  :iam_role_arn,
  :sns_topic_arns,
  :configuration_name,
  :logging_level,
  :tags,
  :state,
  :state_reason)
  SENSITIVE = [:webhook_description]
  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>) 


140
141
142
143
144
145
146
147
148
149
150
151
152
 
# File 'lib/aws-sdk-chatbot/types.rb', line 140

class ChimeWebhookConfiguration < Struct.new(
  :webhook_description,
  :chat_configuration_arn,
  :iam_role_arn,
  :sns_topic_arns,
  :configuration_name,
  :logging_level,
  :tags,
  :state,
  :state_reason)
  SENSITIVE = [:webhook_description]
  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) 


140
141
142
143
144
145
146
147
148
149
150
151
152
 
# File 'lib/aws-sdk-chatbot/types.rb', line 140

class ChimeWebhookConfiguration < Struct.new(
  :webhook_description,
  :chat_configuration_arn,
  :iam_role_arn,
  :sns_topic_arns,
  :configuration_name,
  :logging_level,
  :tags,
  :state,
  :state_reason)
  SENSITIVE = [:webhook_description]
  include Aws::Structure
end

#state_reason ⇒ String

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

Returns:

  • (String) 


140
141
142
143
144
145
146
147
148
149
150
151
152
 
# File 'lib/aws-sdk-chatbot/types.rb', line 140

class ChimeWebhookConfiguration < Struct.new(
  :webhook_description,
  :chat_configuration_arn,
  :iam_role_arn,
  :sns_topic_arns,
  :configuration_name,
  :logging_level,
  :tags,
  :state,
  :state_reason)
  SENSITIVE = [:webhook_description]
  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:



140
141
142
143
144
145
146
147
148
149
150
151
152
 
# File 'lib/aws-sdk-chatbot/types.rb', line 140

class ChimeWebhookConfiguration < Struct.new(
  :webhook_description,
  :chat_configuration_arn,
  :iam_role_arn,
  :sns_topic_arns,
  :configuration_name,
  :logging_level,
  :tags,
  :state,
  :state_reason)
  SENSITIVE = [:webhook_description]
  include Aws::Structure
end

#webhook_description ⇒ String

A description of the webhook. We recommend using the convention RoomName/WebhookName.

For more information, see [Tutorial: Get started with Amazon Chime] in the AWS Chatbot Administrator Guide.

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

Returns:

  • (String) 


140
141
142
143
144
145
146
147
148
149
150
151
152
 
# File 'lib/aws-sdk-chatbot/types.rb', line 140

class ChimeWebhookConfiguration < Struct.new(
  :webhook_description,
  :chat_configuration_arn,
  :iam_role_arn,
  :sns_topic_arns,
  :configuration_name,
  :logging_level,
  :tags,
  :state,
  :state_reason)
  SENSITIVE = [:webhook_description]
  include Aws::Structure
end