java.lang.Object
- software.amazon.awssdk.services.chatbot.model.TeamsChannelConfiguration

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<TeamsChannelConfiguration.Builder,TeamsChannelConfiguration>

@Generated("software.amazon.awssdk:codegen")
public final class TeamsChannelConfiguration
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<TeamsChannelConfiguration.Builder,TeamsChannelConfiguration>

An AWS Chatbot configuration for Microsoft Teams.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface TeamsChannelConfiguration.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static TeamsChannelConfiguration.Builder`	`builder()`
`String`	`channelId()`	The ID of the Microsoft Teams channel.
`String`	`channelName()`	The name of the Microsoft Teams channel.
`String`	`chatConfigurationArn()`	The ARN of the MicrosoftTeamsChannelConfiguration.
`String`	`configurationName()`	The name of the configuration.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`List<String>`	`guardrailPolicyArns()`	The list of IAM policy ARNs that are applied as channel guardrails.
`boolean`	`hasGuardrailPolicyArns()`	For responses, this returns true if the service returned a value for the GuardrailPolicyArns property.
`int`	`hashCode()`
`boolean`	`hasSnsTopicArns()`	For responses, this returns true if the service returned a value for the SnsTopicArns property.
`String`	`iamRoleArn()`	The ARN of the IAM role that defines the permissions for AWS Chatbot.
`String`	`loggingLevel()`	Logging levels include ERROR, INFO, or NONE.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends TeamsChannelConfiguration.Builder>`	`serializableBuilderClass()`
`List<String>`	`snsTopicArns()`	The ARNs of the SNS topics that deliver notifications to AWS Chatbot.
`String`	`teamId()`	The ID of the Microsoft Team authorized with AWS Chatbot.
`String`	`teamName()`	The name of the Microsoft Teams Team.
`String`	`tenantId()`	The ID of the Microsoft Teams tenant.
`TeamsChannelConfiguration.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.
`Boolean`	`userAuthorizationRequired()`	Enables use of a user role requirement in your chat configuration.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - channelId
```
public final String channelId()
```
    The ID of the Microsoft Teams channel.
    
    Returns:
    
    The ID of the Microsoft Teams channel.
  - channelName
```
public final String channelName()
```
    The name of the Microsoft Teams channel.
    
    Returns:
    
    The name of the Microsoft Teams channel.
  - teamId
```
public final String teamId()
```
    The ID of the Microsoft Team 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 details, see steps 1-4 in Get started with Microsoft Teams in the AWS Chatbot Administrator Guide.
    
    Returns:
    
    The ID of the Microsoft Team 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 details, see steps 1-4 in Get started with Microsoft Teams in the AWS Chatbot Administrator Guide.
  - teamName
```
public final String teamName()
```
    The name of the Microsoft Teams Team.
    
    Returns:
    
    The name of the Microsoft Teams Team.
  - tenantId
```
public final String tenantId()
```
    The ID of the Microsoft Teams tenant.
    
    Returns:
    
    The ID of the Microsoft Teams tenant.
  - chatConfigurationArn
```
public final String chatConfigurationArn()
```
    The ARN of the MicrosoftTeamsChannelConfiguration.
    
    Returns:
    
    The ARN of the MicrosoftTeamsChannelConfiguration.
  - iamRoleArn
```
public final String iamRoleArn()
```
    The ARN of the IAM role that defines the permissions for AWS Chatbot. This is a user-defined role that AWS Chatbot will assume. This is not the service-linked role. For more information, see IAM Policies for AWS Chatbot.
    
    Returns:
    
    The ARN of the IAM role that defines the permissions for AWS Chatbot. This is a user-defined role that AWS Chatbot will assume. This is not the service-linked role. For more information, see IAM Policies for AWS Chatbot.
  - hasSnsTopicArns
```
public final boolean hasSnsTopicArns()
```
    For responses, this returns true if the service returned a value for the SnsTopicArns property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - snsTopicArns
```
public final List<String> snsTopicArns()
```
    The ARNs of the SNS topics that deliver notifications to AWS Chatbot.
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasSnsTopicArns() method.
    
    Returns:
    
    The ARNs of the SNS topics that deliver notifications to AWS Chatbot.
  - configurationName
```
public final String configurationName()
```
    The name of the configuration.
    
    Returns:
    
    The name of the configuration.
  - loggingLevel
```
public final String loggingLevel()
```
    Logging levels include ERROR, INFO, or NONE.
    
    Returns:
    
    Logging levels include ERROR, INFO, or NONE.
  - hasGuardrailPolicyArns
```
public final boolean hasGuardrailPolicyArns()
```
    For responses, this returns true if the service returned a value for the GuardrailPolicyArns property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - guardrailPolicyArns
```
public final List<String> 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.
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasGuardrailPolicyArns() method.
    
    Returns:
    
    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.
  - userAuthorizationRequired
```
public final Boolean userAuthorizationRequired()
```
    Enables use of a user role requirement in your chat configuration.
    
    Returns:
    
    Enables use of a user role requirement in your chat configuration.
  - toBuilder
```
public TeamsChannelConfiguration.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<TeamsChannelConfiguration.Builder,TeamsChannelConfiguration>
  - builder
```
public static TeamsChannelConfiguration.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends TeamsChannelConfiguration.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class TeamsChannelConfiguration

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

channelId

channelName

teamId

teamName

tenantId

chatConfigurationArn

iamRoleArn

hasSnsTopicArns

snsTopicArns

configurationName

loggingLevel

hasGuardrailPolicyArns

guardrailPolicyArns

userAuthorizationRequired

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields