Class TeamsChannelConfiguration

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:

  • Method Details

    • 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 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:
      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.

    • 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 Amazon Resource Name (ARN) of the MicrosoftTeamsChannelConfiguration associated with the user identity to delete.

      Returns:
      The Amazon Resource Name (ARN) of the MicrosoftTeamsChannelConfiguration associated with the user identity to delete.

    • iamRoleArn

      public final String 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:
      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.

    • 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 Amazon Resource Names (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 Amazon Resource Names (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.

    • hasTags

      public final boolean hasTags()
      For responses, this returns true if the service returned a value for the Tags 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.

    • tags

      public final List<Tag> tags()

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

      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 hasTags() method.

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

    • state

      public final String state()

      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.

      Returns:
      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.

    • stateReason

      public final String stateReason()

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

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

    • toBuilder

      public TeamsChannelConfiguration.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<TeamsChannelConfiguration.Builder,TeamsChannelConfiguration>
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.