TeamsChannelConfiguration (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.chatbot.model.TeamsChannelConfiguration

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class TeamsChannelConfiguration
extends Object
implements Serializable, Cloneable, StructuredPojo

An AWS Chatbot configuration for Microsoft Teams.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

TeamsChannelConfiguration()

Constructors
Constructor and Description
`TeamsChannelConfiguration()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`TeamsChannelConfiguration`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getChannelId()` The ID of the Microsoft Teams channel.
`String`	`getChannelName()` The name of the Microsoft Teams channel.
`String`	`getChatConfigurationArn()` The ARN of the MicrosoftTeamsChannelConfiguration.
`String`	`getConfigurationName()` The name of the configuration.
`List<String>`	`getGuardrailPolicyArns()` The list of IAM policy ARNs that are applied as channel guardrails.
`String`	`getIamRoleArn()` The ARN of the IAM role that defines the permissions for AWS Chatbot.
`String`	`getLoggingLevel()` Logging levels include ERROR, INFO, or NONE.
`List<String>`	`getSnsTopicArns()` The ARNs of the SNS topics that deliver notifications to AWS Chatbot.
`List<Tag>`	`getTags()` A list of tags applied to the configuration.
`String`	`getTeamId()` The ID of the Microsoft Team authorized with AWS Chatbot.
`String`	`getTeamName()` The name of the Microsoft Teams Team.
`String`	`getTenantId()` The ID of the Microsoft Teams tenant.
`Boolean`	`getUserAuthorizationRequired()` Enables use of a user role requirement in your chat configuration.
`int`	`hashCode()`
`Boolean`	`isUserAuthorizationRequired()` Enables use of a user role requirement in your chat configuration.
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setChannelId(String channelId)` The ID of the Microsoft Teams channel.
`void`	`setChannelName(String channelName)` The name of the Microsoft Teams channel.
`void`	`setChatConfigurationArn(String chatConfigurationArn)` The ARN of the MicrosoftTeamsChannelConfiguration.
`void`	`setConfigurationName(String configurationName)` The name of the configuration.
`void`	`setGuardrailPolicyArns(Collection<String> guardrailPolicyArns)` The list of IAM policy ARNs that are applied as channel guardrails.
`void`	`setIamRoleArn(String iamRoleArn)` The ARN of the IAM role that defines the permissions for AWS Chatbot.
`void`	`setLoggingLevel(String loggingLevel)` Logging levels include ERROR, INFO, or NONE.
`void`	`setSnsTopicArns(Collection<String> snsTopicArns)` The ARNs of the SNS topics that deliver notifications to AWS Chatbot.
`void`	`setTags(Collection<Tag> tags)` A list of tags applied to the configuration.
`void`	`setTeamId(String teamId)` The ID of the Microsoft Team authorized with AWS Chatbot.
`void`	`setTeamName(String teamName)` The name of the Microsoft Teams Team.
`void`	`setTenantId(String tenantId)` The ID of the Microsoft Teams tenant.
`void`	`setUserAuthorizationRequired(Boolean userAuthorizationRequired)` Enables use of a user role requirement in your chat configuration.
`String`	`toString()` Returns a string representation of this object.
`TeamsChannelConfiguration`	`withChannelId(String channelId)` The ID of the Microsoft Teams channel.
`TeamsChannelConfiguration`	`withChannelName(String channelName)` The name of the Microsoft Teams channel.
`TeamsChannelConfiguration`	`withChatConfigurationArn(String chatConfigurationArn)` The ARN of the MicrosoftTeamsChannelConfiguration.
`TeamsChannelConfiguration`	`withConfigurationName(String configurationName)` The name of the configuration.
`TeamsChannelConfiguration`	`withGuardrailPolicyArns(Collection<String> guardrailPolicyArns)` The list of IAM policy ARNs that are applied as channel guardrails.
`TeamsChannelConfiguration`	`withGuardrailPolicyArns(String... guardrailPolicyArns)` The list of IAM policy ARNs that are applied as channel guardrails.
`TeamsChannelConfiguration`	`withIamRoleArn(String iamRoleArn)` The ARN of the IAM role that defines the permissions for AWS Chatbot.
`TeamsChannelConfiguration`	`withLoggingLevel(String loggingLevel)` Logging levels include ERROR, INFO, or NONE.
`TeamsChannelConfiguration`	`withSnsTopicArns(Collection<String> snsTopicArns)` The ARNs of the SNS topics that deliver notifications to AWS Chatbot.
`TeamsChannelConfiguration`	`withSnsTopicArns(String... snsTopicArns)` The ARNs of the SNS topics that deliver notifications to AWS Chatbot.
`TeamsChannelConfiguration`	`withTags(Collection<Tag> tags)` A list of tags applied to the configuration.
`TeamsChannelConfiguration`	`withTags(Tag... tags)` A list of tags applied to the configuration.
`TeamsChannelConfiguration`	`withTeamId(String teamId)` The ID of the Microsoft Team authorized with AWS Chatbot.
`TeamsChannelConfiguration`	`withTeamName(String teamName)` The name of the Microsoft Teams Team.
`TeamsChannelConfiguration`	`withTenantId(String tenantId)` The ID of the Microsoft Teams tenant.
`TeamsChannelConfiguration`	`withUserAuthorizationRequired(Boolean userAuthorizationRequired)` Enables use of a user role requirement in your chat configuration.

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

- Constructor Detail
  - TeamsChannelConfiguration
```
public TeamsChannelConfiguration()
```
- Method Detail
  - setChannelId
```
public void setChannelId(String channelId)
```
    The ID of the Microsoft Teams channel.
    
    Parameters:
    
    channelId - The ID of the Microsoft Teams channel.
  - getChannelId
```
public String getChannelId()
```
    The ID of the Microsoft Teams channel.
    
    Returns:
    
    The ID of the Microsoft Teams channel.
  - withChannelId
```
public TeamsChannelConfiguration withChannelId(String 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.
  - setChannelName
```
public void setChannelName(String channelName)
```
    The name of the Microsoft Teams channel.
    
    Parameters:
    
    channelName - The name of the Microsoft Teams channel.
  - getChannelName
```
public String getChannelName()
```
    The name of the Microsoft Teams channel.
    
    Returns:
    
    The name of the Microsoft Teams channel.
  - withChannelName
```
public TeamsChannelConfiguration withChannelName(String 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.
  - setTeamId
```
public void setTeamId(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.
    
    Parameters:
    
    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.
  - getTeamId
```
public String getTeamId()
```
    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.
  - withTeamId
```
public TeamsChannelConfiguration withTeamId(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTeamName
```
public void setTeamName(String teamName)
```
    The name of the Microsoft Teams Team.
    
    Parameters:
    
    teamName - The name of the Microsoft Teams Team.
  - getTeamName
```
public String getTeamName()
```
    The name of the Microsoft Teams Team.
    
    Returns:
    
    The name of the Microsoft Teams Team.
  - withTeamName
```
public TeamsChannelConfiguration withTeamName(String 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.
  - setTenantId
```
public void setTenantId(String tenantId)
```
    The ID of the Microsoft Teams tenant.
    
    Parameters:
    
    tenantId - The ID of the Microsoft Teams tenant.
  - getTenantId
```
public String getTenantId()
```
    The ID of the Microsoft Teams tenant.
    
    Returns:
    
    The ID of the Microsoft Teams tenant.
  - withTenantId
```
public TeamsChannelConfiguration withTenantId(String 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.
  - setChatConfigurationArn
```
public void setChatConfigurationArn(String chatConfigurationArn)
```
    The ARN of the MicrosoftTeamsChannelConfiguration.
    
    Parameters:
    
    chatConfigurationArn - The ARN of the MicrosoftTeamsChannelConfiguration.
  - getChatConfigurationArn
```
public String getChatConfigurationArn()
```
    The ARN of the MicrosoftTeamsChannelConfiguration.
    
    Returns:
    
    The ARN of the MicrosoftTeamsChannelConfiguration.
  - withChatConfigurationArn
```
public TeamsChannelConfiguration withChatConfigurationArn(String chatConfigurationArn)
```
    The ARN of the MicrosoftTeamsChannelConfiguration.
    
    Parameters:
    
    chatConfigurationArn - The ARN of the MicrosoftTeamsChannelConfiguration.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setIamRoleArn
```
public void setIamRoleArn(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.
    
    Parameters:
    
    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.
  - getIamRoleArn
```
public String getIamRoleArn()
```
    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.
  - withIamRoleArn
```
public TeamsChannelConfiguration withIamRoleArn(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - getSnsTopicArns
```
public List<String> getSnsTopicArns()
```
    The ARNs of the SNS topics that deliver notifications to AWS Chatbot.
    
    Returns:
    
    The ARNs of the SNS topics that deliver notifications to AWS Chatbot.
  - setSnsTopicArns
```
public void setSnsTopicArns(Collection<String> snsTopicArns)
```
    The ARNs of the SNS topics that deliver notifications to AWS Chatbot.
    
    Parameters:
    
    snsTopicArns - The ARNs of the SNS topics that deliver notifications to AWS Chatbot.
  - withSnsTopicArns
```
public TeamsChannelConfiguration withSnsTopicArns(String... snsTopicArns)
```
    The ARNs of the SNS topics that deliver notifications to AWS Chatbot.
    NOTE: This method appends the values to the existing list (if any). Use setSnsTopicArns(java.util.Collection) or withSnsTopicArns(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    snsTopicArns - The 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.
  - withSnsTopicArns
```
public TeamsChannelConfiguration withSnsTopicArns(Collection<String> snsTopicArns)
```
    The ARNs of the SNS topics that deliver notifications to AWS Chatbot.
    
    Parameters:
    
    snsTopicArns - The 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.
  - setConfigurationName
```
public void setConfigurationName(String configurationName)
```
    The name of the configuration.
    
    Parameters:
    
    configurationName - The name of the configuration.
  - getConfigurationName
```
public String getConfigurationName()
```
    The name of the configuration.
    
    Returns:
    
    The name of the configuration.
  - withConfigurationName
```
public TeamsChannelConfiguration withConfigurationName(String 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.
  - setLoggingLevel
```
public void setLoggingLevel(String loggingLevel)
```
    Logging levels include ERROR, INFO, or NONE.
    
    Parameters:
    
    loggingLevel - Logging levels include ERROR, INFO, or NONE.
  - getLoggingLevel
```
public String getLoggingLevel()
```
    Logging levels include ERROR, INFO, or NONE.
    
    Returns:
    
    Logging levels include ERROR, INFO, or NONE.
  - withLoggingLevel
```
public TeamsChannelConfiguration withLoggingLevel(String loggingLevel)
```
    Logging levels include ERROR, INFO, or NONE.
    
    Parameters:
    
    loggingLevel - Logging levels include ERROR, INFO, or NONE.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getGuardrailPolicyArns
```
public List<String> getGuardrailPolicyArns()
```
    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.
    
    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.
  - setGuardrailPolicyArns
```
public void setGuardrailPolicyArns(Collection<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.
    
    Parameters:
    
    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.
  - withGuardrailPolicyArns
```
public TeamsChannelConfiguration withGuardrailPolicyArns(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.
    NOTE: This method appends the values to the existing list (if any). Use setGuardrailPolicyArns(java.util.Collection) or withGuardrailPolicyArns(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withGuardrailPolicyArns
```
public TeamsChannelConfiguration withGuardrailPolicyArns(Collection<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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setUserAuthorizationRequired
```
public void setUserAuthorizationRequired(Boolean 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.
  - getUserAuthorizationRequired
```
public Boolean getUserAuthorizationRequired()
```
    Enables use of a user role requirement in your chat configuration.
    
    Returns:
    
    Enables use of a user role requirement in your chat configuration.
  - withUserAuthorizationRequired
```
public TeamsChannelConfiguration withUserAuthorizationRequired(Boolean 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.
  - isUserAuthorizationRequired
```
public Boolean isUserAuthorizationRequired()
```
    Enables use of a user role requirement in your chat configuration.
    
    Returns:
    
    Enables use of a user role requirement in your chat configuration.
  - getTags
```
public List<Tag> getTags()
```
    A list of tags applied to the configuration.
    
    Returns:
    
    A list of tags applied to the configuration.
  - setTags
```
public void setTags(Collection<Tag> tags)
```
    A list of tags applied to the configuration.
    
    Parameters:
    
    tags - A list of tags applied to the configuration.
  - withTags
```
public TeamsChannelConfiguration withTags(Tag... tags)
```
    A list of tags applied to the configuration.
    NOTE: This method appends the values to the existing list (if any). Use setTags(java.util.Collection) or withTags(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    tags - A list of tags applied to the configuration.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withTags
```
public TeamsChannelConfiguration withTags(Collection<Tag> tags)
```
    A list of tags applied to the configuration.
    
    Parameters:
    
    tags - A list of tags applied to the configuration.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public TeamsChannelConfiguration clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.780

Class TeamsChannelConfiguration

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

TeamsChannelConfiguration

Method Detail

setChannelId

getChannelId

withChannelId

setChannelName

getChannelName

withChannelName

setTeamId

getTeamId

withTeamId

setTeamName

getTeamName

withTeamName

setTenantId

getTenantId

withTenantId

setChatConfigurationArn

getChatConfigurationArn

withChatConfigurationArn

setIamRoleArn

getIamRoleArn

withIamRoleArn

getSnsTopicArns

setSnsTopicArns

withSnsTopicArns

withSnsTopicArns

setConfigurationName

getConfigurationName

withConfigurationName

setLoggingLevel

getLoggingLevel

withLoggingLevel

getGuardrailPolicyArns

setGuardrailPolicyArns

withGuardrailPolicyArns

withGuardrailPolicyArns

setUserAuthorizationRequired

getUserAuthorizationRequired

withUserAuthorizationRequired

isUserAuthorizationRequired

getTags

setTags

withTags

withTags

toString

equals

hashCode

clone

marshall