java.lang.Object
- software.amazon.awssdk.services.connect.model.AuthenticationProfile

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<AuthenticationProfile.Builder,AuthenticationProfile>
```
@Generated("software.amazon.awssdk:codegen")
public final class AuthenticationProfile
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<AuthenticationProfile.Builder,AuthenticationProfile>
```
This API is in preview release for Amazon Connect and is subject to change. To request access to this API, contact Amazon Web Services Support.

Information about an authentication profile. An authentication profile is a resource that stores the authentication settings for users in your contact center. You use authentication profiles to set up IP address range restrictions and session timeouts. For more information, see Set IP address restrictions or session timeouts.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface AuthenticationProfile.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`List<String>`	`allowedIps()`	A list of IP address range strings that are allowed to access the Amazon Connect instance.
`String`	`arn()`	The Amazon Resource Name (ARN) for the authentication profile.
`List<String>`	`blockedIps()`	A list of IP address range strings that are blocked from accessing the Amazon Connect instance.
`static AuthenticationProfile.Builder`	`builder()`
`Instant`	`createdTime()`	The timestamp when the authentication profile was created.
`String`	`description()`	The description for the authentication profile.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasAllowedIps()`	For responses, this returns true if the service returned a value for the AllowedIps property.
`boolean`	`hasBlockedIps()`	For responses, this returns true if the service returned a value for the BlockedIps property.
`int`	`hashCode()`
`String`	`id()`	A unique identifier for the authentication profile.
`Boolean`	`isDefault()`	Shows whether the authentication profile is the default authentication profile for the Amazon Connect instance.
`String`	`lastModifiedRegion()`	The Amazon Web Services Region where the authentication profile was last modified.
`Instant`	`lastModifiedTime()`	The timestamp when the authentication profile was last modified.
`Integer`	`maxSessionDuration()`	The long lived session duration for users logged in to Amazon Connect, in minutes.
`String`	`name()`	The name for the authentication profile.
`Integer`	`periodicSessionDuration()`	The short lived session duration configuration for users logged in to Amazon Connect, in minutes.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends AuthenticationProfile.Builder>`	`serializableBuilderClass()`
`AuthenticationProfile.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.

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
  - id
```
public final String id()
```
    A unique identifier for the authentication profile.
    
    Returns:
    
    A unique identifier for the authentication profile.
  - arn
```
public final String arn()
```
    The Amazon Resource Name (ARN) for the authentication profile.
    
    Returns:
    
    The Amazon Resource Name (ARN) for the authentication profile.
  - name
```
public final String name()
```
    The name for the authentication profile.
    
    Returns:
    
    The name for the authentication profile.
  - description
```
public final String description()
```
    The description for the authentication profile.
    
    Returns:
    
    The description for the authentication profile.
  - hasAllowedIps
```
public final boolean hasAllowedIps()
```
    For responses, this returns true if the service returned a value for the AllowedIps 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.
  - allowedIps
```
public final List<String> allowedIps()
```
    A list of IP address range strings that are allowed to access the Amazon Connect instance. For more information about how to configure IP addresses, see Configure IP address based access control in the Amazon Connect Administrator Guide.
    
    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 hasAllowedIps() method.
    
    Returns:
    
    A list of IP address range strings that are allowed to access the Amazon Connect instance. For more information about how to configure IP addresses, see Configure IP address based access control in the Amazon Connect Administrator Guide.
  - hasBlockedIps
```
public final boolean hasBlockedIps()
```
    For responses, this returns true if the service returned a value for the BlockedIps 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.
  - blockedIps
```
public final List<String> blockedIps()
```
    A list of IP address range strings that are blocked from accessing the Amazon Connect instance. For more information about how to configure IP addresses, see Configure IP address based access control in the Amazon Connect Administrator Guide.
    
    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 hasBlockedIps() method.
    
    Returns:
    
    A list of IP address range strings that are blocked from accessing the Amazon Connect instance. For more information about how to configure IP addresses, see Configure IP address based access control in the Amazon Connect Administrator Guide.
  - isDefault
```
public final Boolean isDefault()
```
    Shows whether the authentication profile is the default authentication profile for the Amazon Connect instance. The default authentication profile applies to all agents in an Amazon Connect instance, unless overridden by another authentication profile.
    
    Returns:
    
    Shows whether the authentication profile is the default authentication profile for the Amazon Connect instance. The default authentication profile applies to all agents in an Amazon Connect instance, unless overridden by another authentication profile.
  - createdTime
```
public final Instant createdTime()
```
    The timestamp when the authentication profile was created.
    
    Returns:
    
    The timestamp when the authentication profile was created.
  - lastModifiedTime
```
public final Instant lastModifiedTime()
```
    The timestamp when the authentication profile was last modified.
    
    Returns:
    
    The timestamp when the authentication profile was last modified.
  - lastModifiedRegion
```
public final String lastModifiedRegion()
```
    The Amazon Web Services Region where the authentication profile was last modified.
    
    Returns:
    
    The Amazon Web Services Region where the authentication profile was last modified.
  - periodicSessionDuration
```
public final Integer periodicSessionDuration()
```
    The short lived session duration configuration for users logged in to Amazon Connect, in minutes. This value determines the maximum possible time before an agent is authenticated. For more information, see Configure the session duration in the Amazon Connect Administrator Guide.
    
    Returns:
    
    The short lived session duration configuration for users logged in to Amazon Connect, in minutes. This value determines the maximum possible time before an agent is authenticated. For more information, see Configure the session duration in the Amazon Connect Administrator Guide.
  - maxSessionDuration
```
public final Integer maxSessionDuration()
```
    The long lived session duration for users logged in to Amazon Connect, in minutes. After this time period, users must log in again. For more information, see Configure the session duration in the Amazon Connect Administrator Guide.
    
    Returns:
    
    The long lived session duration for users logged in to Amazon Connect, in minutes. After this time period, users must log in again. For more information, see Configure the session duration in the Amazon Connect Administrator Guide.
  - toBuilder
```
public AuthenticationProfile.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<AuthenticationProfile.Builder,AuthenticationProfile>
  - builder
```
public static AuthenticationProfile.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends AuthenticationProfile.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 AuthenticationProfile

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

id

arn

name

description

hasAllowedIps

allowedIps

hasBlockedIps

blockedIps

isDefault

createdTime

lastModifiedTime

lastModifiedRegion

periodicSessionDuration

maxSessionDuration

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields