Class SlackChannelConfiguration
- java.lang.Object
-
- software.amazon.awssdk.services.chatbot.model.SlackChannelConfiguration
-
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<SlackChannelConfiguration.Builder,SlackChannelConfiguration>
@Generated("software.amazon.awssdk:codegen") public final class SlackChannelConfiguration extends Object implements SdkPojo, Serializable, ToCopyableBuilder<SlackChannelConfiguration.Builder,SlackChannelConfiguration>
An AWS Chatbot configuration for Slack.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceSlackChannelConfiguration.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static SlackChannelConfiguration.Builderbuilder()StringchatConfigurationArn()The Amazon Resource Name (ARN) of the SlackChannelConfiguration.StringconfigurationName()The name of the configuration.booleanequals(Object obj)booleanequalsBySdkFields(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.booleanhasGuardrailPolicyArns()For responses, this returns true if the service returned a value for the GuardrailPolicyArns property.inthashCode()booleanhasSnsTopicArns()For responses, this returns true if the service returned a value for the SnsTopicArns property.booleanhasTags()For responses, this returns true if the service returned a value for the Tags property.StringiamRoleArn()A user-defined role that AWS Chatbot assumes.StringloggingLevel()Logging levels includeERROR,INFO, orNONE.Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()static Class<? extends SlackChannelConfiguration.Builder>serializableBuilderClass()StringslackChannelId()The ID of the Slack channel.StringslackChannelName()The name of the Slack channel.StringslackTeamId()The ID of the Slack workspace authorized with Amazon Chime.StringslackTeamName()Name of the Slack workspace.List<String>snsTopicArns()The ARNs of the SNS topics that deliver notifications to AWS Chatbot.Stringstate()EitherENABLEDorDISABLED.StringstateReason()Provided if State isDISABLED.List<Tag>tags()A map of tags assigned to a resource.SlackChannelConfiguration.BuildertoBuilder()StringtoString()Returns a string representation of this object.BooleanuserAuthorizationRequired()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
-
slackTeamName
public final String slackTeamName()
Name of the Slack workspace.
- Returns:
- Name of the Slack workspace.
-
slackTeamId
public final String slackTeamId()
The ID of the Slack workspace authorized with Amazon Chime.
- Returns:
- The ID of the Slack workspace authorized with Amazon Chime.
-
slackChannelId
public final String slackChannelId()
The ID of the Slack channel.
To get this ID, open Slack, right click on the channel name in the left pane, then choose Copy Link. The channel ID is the 9-character string at the end of the URL. For example, ABCBBLZZZ.
- Returns:
- The ID of the Slack channel.
To get this ID, open Slack, right click on the channel name in the left pane, then choose Copy Link. The channel ID is the 9-character string at the end of the URL. For example, ABCBBLZZZ.
-
slackChannelName
public final String slackChannelName()
The name of the Slack channel.
- Returns:
- The name of the Slack channel.
-
chatConfigurationArn
public final String chatConfigurationArn()
The Amazon Resource Name (ARN) of the SlackChannelConfiguration.
- Returns:
- The Amazon Resource Name (ARN) of the SlackChannelConfiguration.
-
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 theisEmpty()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, orNONE.- Returns:
- Logging levels include
ERROR,INFO, orNONE.
-
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 theisEmpty()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
AdministratorAccesspolicy 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
AdministratorAccesspolicy 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 theisEmpty()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
ENABLEDorDISABLED. The resource returnsDISABLEDif the organization's AWS Chatbot policy has explicitly denied that configuration. For example, if Amazon Chime is disabled.- Returns:
- Either
ENABLEDorDISABLED. The resource returnsDISABLEDif 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 SlackChannelConfiguration.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<SlackChannelConfiguration.Builder,SlackChannelConfiguration>
-
builder
public static SlackChannelConfiguration.Builder builder()
-
serializableBuilderClass
public static Class<? extends SlackChannelConfiguration.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-
-