Struct ChimeWebhookConfiguration

#[non_exhaustive]
pub struct ChimeWebhookConfiguration {
    pub webhook_description: String,
    pub chat_configuration_arn: String,
    pub iam_role_arn: String,
    pub sns_topic_arns: Vec<String>,
    pub configuration_name: Option<String>,
    pub logging_level: Option<String>,
    pub tags: Option<Vec<Tag>>,
    pub state: Option<String>,
    pub state_reason: Option<String>,
}

An AWS Chatbot configuration for Amazon Chime.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

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.

chat_configuration_arn: String

The Amazon Resource Name (ARN) of the ChimeWebhookConfiguration.

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.

sns_topic_arns: Vec<String>

The Amazon Resource Names (ARNs) of the SNS topics that deliver notifications to AWS Chatbot.

configuration_name: Option<String>

The name of the configuration.

logging_level: Option<String>

Logging levels include ERROR, INFO, or NONE.

tags: Option<Vec<Tag>>

A map of tags assigned to a resource. A tag is a string-to-string map of key-value pairs.

state: Option<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.

state_reason: Option<String>

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

Implementations

impl ChimeWebhookConfiguration

pub fn webhook_description(&self) -> &str

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.

pub fn chat_configuration_arn(&self) -> &str

The Amazon Resource Name (ARN) of the ChimeWebhookConfiguration.

pub fn iam_role_arn(&self) -> &str

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.

pub fn sns_topic_arns(&self) -> &[String]

The Amazon Resource Names (ARNs) of the SNS topics that deliver notifications to AWS Chatbot.

pub fn configuration_name(&self) -> Option<&str>

The name of the configuration.

pub fn logging_level(&self) -> Option<&str>

Logging levels include ERROR, INFO, or NONE.

pub fn tags(&self) -> &[Tag]

A map of tags assigned to a resource. A tag is a string-to-string map of key-value pairs.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .tags.is_none().

pub fn state(&self) -> Option<&str>

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.

pub fn state_reason(&self) -> Option<&str>

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

impl ChimeWebhookConfiguration

pub fn builder() -> ChimeWebhookConfigurationBuilder

Creates a new builder-style object to manufacture ChimeWebhookConfiguration.

Trait Implementations

impl Clone for ChimeWebhookConfiguration

fn clone(&self) -> ChimeWebhookConfiguration

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ChimeWebhookConfiguration

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for ChimeWebhookConfiguration

fn eq(&self, other: &ChimeWebhookConfiguration) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for ChimeWebhookConfiguration