Interface TeamsChannelConfiguration.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<TeamsChannelConfiguration.Builder,
,TeamsChannelConfiguration> SdkBuilder<TeamsChannelConfiguration.Builder,
,TeamsChannelConfiguration> SdkPojo
- Enclosing class:
TeamsChannelConfiguration
-
Method Summary
Modifier and TypeMethodDescriptionThe ID of the Microsoft Teams channel.channelName
(String channelName) The name of the Microsoft Teams channel.chatConfigurationArn
(String chatConfigurationArn) The Amazon Resource Name (ARN) of the MicrosoftTeamsChannelConfiguration associated with the user identity to delete.configurationName
(String configurationName) The name of the configuration.guardrailPolicyArns
(String... guardrailPolicyArns) The list of IAM policy ARNs that are applied as channel guardrails.guardrailPolicyArns
(Collection<String> guardrailPolicyArns) The list of IAM policy ARNs that are applied as channel guardrails.iamRoleArn
(String iamRoleArn) A user-defined role that AWS Chatbot assumes.loggingLevel
(String loggingLevel) Logging levels includeERROR
,INFO
, orNONE
.snsTopicArns
(String... snsTopicArns) The Amazon Resource Names (ARNs) of the SNS topics that deliver notifications to AWS Chatbot.snsTopicArns
(Collection<String> snsTopicArns) The Amazon Resource Names (ARNs) of the SNS topics that deliver notifications to AWS Chatbot.EitherENABLED
orDISABLED
.stateReason
(String stateReason) Provided if State isDISABLED
.tags
(Collection<Tag> tags) A map of tags assigned to a resource.tags
(Consumer<Tag.Builder>... tags) A map of tags assigned to a resource.A map of tags assigned to a resource.The ID of the Microsoft Teams authorized with AWS Chatbot.The name of the Microsoft Teams Team.The ID of the Microsoft Teams tenant.userAuthorizationRequired
(Boolean userAuthorizationRequired) Enables use of a user role requirement in your chat configuration.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFieldNameToField, sdkFields
-
Method Details
-
channelId
The ID of the Microsoft Teams channel.
- Parameters:
channelId
- The ID of the Microsoft Teams channel.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
channelName
The name of the Microsoft Teams channel.
- Parameters:
channelName
- The name of the Microsoft Teams channel.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
teamId
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.
- Parameters:
teamId
- 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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
teamName
The name of the Microsoft Teams Team.
- Parameters:
teamName
- The name of the Microsoft Teams Team.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tenantId
The ID of the Microsoft Teams tenant.
- Parameters:
tenantId
- The ID of the Microsoft Teams tenant.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
chatConfigurationArn
The Amazon Resource Name (ARN) of the MicrosoftTeamsChannelConfiguration associated with the user identity to delete.
- Parameters:
chatConfigurationArn
- The Amazon Resource Name (ARN) of the MicrosoftTeamsChannelConfiguration associated with the user identity to delete.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
iamRoleArn
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.
- Parameters:
iamRoleArn
- 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:
- Returns a reference to this object so that method calls can be chained together.
-
snsTopicArns
The Amazon Resource Names (ARNs) of the SNS topics that deliver notifications to AWS Chatbot.
- Parameters:
snsTopicArns
- The Amazon Resource Names (ARNs) of the SNS topics that deliver notifications to AWS Chatbot.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
snsTopicArns
The Amazon Resource Names (ARNs) of the SNS topics that deliver notifications to AWS Chatbot.
- Parameters:
snsTopicArns
- The Amazon Resource Names (ARNs) of the SNS topics that deliver notifications to AWS Chatbot.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
configurationName
The name of the configuration.
- Parameters:
configurationName
- The name of the configuration.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
loggingLevel
Logging levels include
ERROR
,INFO
, orNONE
.- Parameters:
loggingLevel
- Logging levels includeERROR
,INFO
, orNONE
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
guardrailPolicyArns
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.- Parameters:
guardrailPolicyArns
- The list of IAM policy ARNs that are applied as channel guardrails. The AWS managedAdministratorAccess
policy is applied by default if this is not set.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
guardrailPolicyArns
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.- Parameters:
guardrailPolicyArns
- The list of IAM policy ARNs that are applied as channel guardrails. The AWS managedAdministratorAccess
policy is applied by default if this is not set.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
userAuthorizationRequired
Enables use of a user role requirement in your chat configuration.
- Parameters:
userAuthorizationRequired
- Enables use of a user role requirement in your chat configuration.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tags
A map of tags assigned to a resource. A tag is a string-to-string map of key-value pairs.
- Parameters:
tags
- A map of tags assigned to a resource. A tag is a string-to-string map of key-value pairs.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tags
A map of tags assigned to a resource. A tag is a string-to-string map of key-value pairs.
- Parameters:
tags
- A map of tags assigned to a resource. A tag is a string-to-string map of key-value pairs.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tags
A map of tags assigned to a resource. A tag is a string-to-string map of key-value pairs.
This is a convenience method that creates an instance of theTag.Builder
avoiding the need to create one manually viaTag.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed totags(List<Tag>)
.- Parameters:
tags
- a consumer that will call methods onTag.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
state
Either
ENABLED
orDISABLED
. The resource returnsDISABLED
if the organization's AWS Chatbot policy has explicitly denied that configuration. For example, if Amazon Chime is disabled.- Parameters:
state
- EitherENABLED
orDISABLED
. The resource returnsDISABLED
if the organization's AWS Chatbot policy has explicitly denied that configuration. For example, if Amazon Chime is disabled.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
stateReason
Provided if State is
DISABLED
. Provides context as to why the resource is disabled.- Parameters:
stateReason
- Provided if State isDISABLED
. Provides context as to why the resource is disabled.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-