#[non_exhaustive]pub struct TeamsChannelConfiguration {Show 15 fields
pub channel_id: String,
pub channel_name: Option<String>,
pub team_id: String,
pub team_name: Option<String>,
pub tenant_id: 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 guardrail_policy_arns: Option<Vec<String>>,
pub user_authorization_required: Option<bool>,
pub tags: Option<Vec<Tag>>,
pub state: Option<String>,
pub state_reason: Option<String>,
}
Expand description
An AWS Chatbot configuration for Microsoft Teams.
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
Struct { .. }
syntax; cannot be matched against without a wildcard ..
; and struct update syntax will not work.channel_id: String
The ID of the Microsoft Teams channel.
channel_name: Option<String>
The name of the Microsoft Teams channel.
team_id: String
The ID of the Microsoft Teams authorized with AWS Chatbot.
To get the team ID, you must perform the initial authorization flow with Microsoft Teams in the AWS Chatbot console. Then you can copy and paste the team ID from the console. For more information, see Step 1: Configure a Microsoft Teams client in the AWS Chatbot Administrator Guide.
team_name: Option<String>
The name of the Microsoft Teams Team.
tenant_id: String
The ID of the Microsoft Teams tenant.
chat_configuration_arn: String
The Amazon Resource Name (ARN) of the MicrosoftTeamsChannelConfiguration associated with the user identity to delete.
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
.
guardrail_policy_arns: Option<Vec<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.
Enables use of a user role requirement in your chat configuration.
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§
Source§impl TeamsChannelConfiguration
impl TeamsChannelConfiguration
Sourcepub fn channel_id(&self) -> &str
pub fn channel_id(&self) -> &str
The ID of the Microsoft Teams channel.
Sourcepub fn channel_name(&self) -> Option<&str>
pub fn channel_name(&self) -> Option<&str>
The name of the Microsoft Teams channel.
Sourcepub fn team_id(&self) -> &str
pub fn team_id(&self) -> &str
The ID of the Microsoft Teams authorized with AWS Chatbot.
To get the team ID, you must perform the initial authorization flow with Microsoft Teams in the AWS Chatbot console. Then you can copy and paste the team ID from the console. For more information, see Step 1: Configure a Microsoft Teams client in the AWS Chatbot Administrator Guide.
Sourcepub fn chat_configuration_arn(&self) -> &str
pub fn chat_configuration_arn(&self) -> &str
The Amazon Resource Name (ARN) of the MicrosoftTeamsChannelConfiguration associated with the user identity to delete.
Sourcepub fn iam_role_arn(&self) -> &str
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.
Sourcepub fn sns_topic_arns(&self) -> &[String]
pub fn sns_topic_arns(&self) -> &[String]
The Amazon Resource Names (ARNs) of the SNS topics that deliver notifications to AWS Chatbot.
Sourcepub fn configuration_name(&self) -> Option<&str>
pub fn configuration_name(&self) -> Option<&str>
The name of the configuration.
Sourcepub fn logging_level(&self) -> Option<&str>
pub fn logging_level(&self) -> Option<&str>
Logging levels include ERROR
, INFO
, or NONE
.
Sourcepub fn guardrail_policy_arns(&self) -> &[String]
pub fn guardrail_policy_arns(&self) -> &[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.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .guardrail_policy_arns.is_none()
.
Enables use of a user role requirement in your chat configuration.
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()
.
Sourcepub fn state(&self) -> Option<&str>
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.
Sourcepub fn state_reason(&self) -> Option<&str>
pub fn state_reason(&self) -> Option<&str>
Provided if State is DISABLED
. Provides context as to why the resource is disabled.
Source§impl TeamsChannelConfiguration
impl TeamsChannelConfiguration
Sourcepub fn builder() -> TeamsChannelConfigurationBuilder
pub fn builder() -> TeamsChannelConfigurationBuilder
Creates a new builder-style object to manufacture TeamsChannelConfiguration
.
Trait Implementations§
Source§impl Clone for TeamsChannelConfiguration
impl Clone for TeamsChannelConfiguration
Source§fn clone(&self) -> TeamsChannelConfiguration
fn clone(&self) -> TeamsChannelConfiguration
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for TeamsChannelConfiguration
impl Debug for TeamsChannelConfiguration
impl StructuralPartialEq for TeamsChannelConfiguration
Auto Trait Implementations§
impl Freeze for TeamsChannelConfiguration
impl RefUnwindSafe for TeamsChannelConfiguration
impl Send for TeamsChannelConfiguration
impl Sync for TeamsChannelConfiguration
impl Unpin for TeamsChannelConfiguration
impl UnwindSafe for TeamsChannelConfiguration
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the foreground set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red()
and
green()
, which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg()
:
use yansi::{Paint, Color};
painted.fg(Color::White);
Set foreground color to white using white()
.
use yansi::Paint;
painted.white();
Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the background set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red()
and
on_green()
, which have the same functionality but
are pithier.
§Example
Set background color to red using fg()
:
use yansi::{Paint, Color};
painted.bg(Color::Red);
Set background color to red using on_red()
.
use yansi::Paint;
painted.on_red();
Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute
value
.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold()
and
underline()
, which have the same functionality
but are pithier.
§Example
Make text bold using attr()
:
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);
Make text bold using using bold()
.
use yansi::Paint;
painted.bold();
Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi
Quirk
value
.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask()
and
wrap()
, which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk()
:
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);
Enable wrapping using wrap()
.
use yansi::Paint;
painted.wrap();
Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition
value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted
only when both stdout
and stderr
are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);