AuthenticationProfile (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.connect.model.AuthenticationProfile

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AuthenticationProfile
extends Object
implements Serializable, Cloneable, StructuredPojo
```
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:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

AuthenticationProfile()

Constructors
Constructor and Description
`AuthenticationProfile()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AuthenticationProfile`	`clone()`
`boolean`	`equals(Object obj)`
`List<String>`	`getAllowedIps()` A list of IP address range strings that are allowed to access the Amazon Connect instance.
`String`	`getArn()` The Amazon Resource Name (ARN) for the authentication profile.
`List<String>`	`getBlockedIps()` A list of IP address range strings that are blocked from accessing the Amazon Connect instance.
`Date`	`getCreatedTime()` The timestamp when the authentication profile was created.
`String`	`getDescription()` The description for the authentication profile.
`String`	`getId()` A unique identifier for the authentication profile.
`Boolean`	`getIsDefault()` Shows whether the authentication profile is the default authentication profile for the Amazon Connect instance.
`String`	`getLastModifiedRegion()` The Amazon Web Services Region where the authentication profile was last modified.
`Date`	`getLastModifiedTime()` The timestamp when the authentication profile was last modified.
`Integer`	`getMaxSessionDuration()` The long lived session duration for users logged in to Amazon Connect, in minutes.
`String`	`getName()` The name for the authentication profile.
`Integer`	`getPeriodicSessionDuration()` The short lived session duration configuration for users logged in to Amazon Connect, in minutes.
`int`	`hashCode()`
`Boolean`	`isDefault()` Shows whether the authentication profile is the default authentication profile for the Amazon Connect instance.
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setAllowedIps(Collection<String> allowedIps)` A list of IP address range strings that are allowed to access the Amazon Connect instance.
`void`	`setArn(String arn)` The Amazon Resource Name (ARN) for the authentication profile.
`void`	`setBlockedIps(Collection<String> blockedIps)` A list of IP address range strings that are blocked from accessing the Amazon Connect instance.
`void`	`setCreatedTime(Date createdTime)` The timestamp when the authentication profile was created.
`void`	`setDescription(String description)` The description for the authentication profile.
`void`	`setId(String id)` A unique identifier for the authentication profile.
`void`	`setIsDefault(Boolean isDefault)` Shows whether the authentication profile is the default authentication profile for the Amazon Connect instance.
`void`	`setLastModifiedRegion(String lastModifiedRegion)` The Amazon Web Services Region where the authentication profile was last modified.
`void`	`setLastModifiedTime(Date lastModifiedTime)` The timestamp when the authentication profile was last modified.
`void`	`setMaxSessionDuration(Integer maxSessionDuration)` The long lived session duration for users logged in to Amazon Connect, in minutes.
`void`	`setName(String name)` The name for the authentication profile.
`void`	`setPeriodicSessionDuration(Integer periodicSessionDuration)` The short lived session duration configuration for users logged in to Amazon Connect, in minutes.
`String`	`toString()` Returns a string representation of this object.
`AuthenticationProfile`	`withAllowedIps(Collection<String> allowedIps)` A list of IP address range strings that are allowed to access the Amazon Connect instance.
`AuthenticationProfile`	`withAllowedIps(String... allowedIps)` A list of IP address range strings that are allowed to access the Amazon Connect instance.
`AuthenticationProfile`	`withArn(String arn)` The Amazon Resource Name (ARN) for the authentication profile.
`AuthenticationProfile`	`withBlockedIps(Collection<String> blockedIps)` A list of IP address range strings that are blocked from accessing the Amazon Connect instance.
`AuthenticationProfile`	`withBlockedIps(String... blockedIps)` A list of IP address range strings that are blocked from accessing the Amazon Connect instance.
`AuthenticationProfile`	`withCreatedTime(Date createdTime)` The timestamp when the authentication profile was created.
`AuthenticationProfile`	`withDescription(String description)` The description for the authentication profile.
`AuthenticationProfile`	`withId(String id)` A unique identifier for the authentication profile.
`AuthenticationProfile`	`withIsDefault(Boolean isDefault)` Shows whether the authentication profile is the default authentication profile for the Amazon Connect instance.
`AuthenticationProfile`	`withLastModifiedRegion(String lastModifiedRegion)` The Amazon Web Services Region where the authentication profile was last modified.
`AuthenticationProfile`	`withLastModifiedTime(Date lastModifiedTime)` The timestamp when the authentication profile was last modified.
`AuthenticationProfile`	`withMaxSessionDuration(Integer maxSessionDuration)` The long lived session duration for users logged in to Amazon Connect, in minutes.
`AuthenticationProfile`	`withName(String name)` The name for the authentication profile.
`AuthenticationProfile`	`withPeriodicSessionDuration(Integer periodicSessionDuration)` The short lived session duration configuration for users logged in to Amazon Connect, in minutes.

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

- Constructor Detail
  - AuthenticationProfile
```
public AuthenticationProfile()
```
- Method Detail
  - setId
```
public void setId(String id)
```
    A unique identifier for the authentication profile.
    
    Parameters:
    
    id - A unique identifier for the authentication profile.
  - getId
```
public String getId()
```
    A unique identifier for the authentication profile.
    
    Returns:
    
    A unique identifier for the authentication profile.
  - withId
```
public AuthenticationProfile withId(String id)
```
    A unique identifier for the authentication profile.
    
    Parameters:
    
    id - A unique identifier for the authentication profile.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setArn
```
public void setArn(String arn)
```
    The Amazon Resource Name (ARN) for the authentication profile.
    
    Parameters:
    
    arn - The Amazon Resource Name (ARN) for the authentication profile.
  - getArn
```
public String getArn()
```
    The Amazon Resource Name (ARN) for the authentication profile.
    
    Returns:
    
    The Amazon Resource Name (ARN) for the authentication profile.
  - withArn
```
public AuthenticationProfile withArn(String arn)
```
    The Amazon Resource Name (ARN) for the authentication profile.
    
    Parameters:
    
    arn - The Amazon Resource Name (ARN) for the authentication profile.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setName
```
public void setName(String name)
```
    The name for the authentication profile.
    
    Parameters:
    
    name - The name for the authentication profile.
  - getName
```
public String getName()
```
    The name for the authentication profile.
    
    Returns:
    
    The name for the authentication profile.
  - withName
```
public AuthenticationProfile withName(String name)
```
    The name for the authentication profile.
    
    Parameters:
    
    name - The name for the authentication profile.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDescription
```
public void setDescription(String description)
```
    The description for the authentication profile.
    
    Parameters:
    
    description - The description for the authentication profile.
  - getDescription
```
public String getDescription()
```
    The description for the authentication profile.
    
    Returns:
    
    The description for the authentication profile.
  - withDescription
```
public AuthenticationProfile withDescription(String description)
```
    The description for the authentication profile.
    
    Parameters:
    
    description - The description for the authentication profile.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getAllowedIps
```
public List<String> getAllowedIps()
```
    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.
    
    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.
  - setAllowedIps
```
public void setAllowedIps(Collection<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.
    
    Parameters:
    
    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.
  - withAllowedIps
```
public AuthenticationProfile withAllowedIps(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.
    
    NOTE: This method appends the values to the existing list (if any). Use setAllowedIps(java.util.Collection) or withAllowedIps(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withAllowedIps
```
public AuthenticationProfile withAllowedIps(Collection<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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getBlockedIps
```
public List<String> getBlockedIps()
```
    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.
    
    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.
  - setBlockedIps
```
public void setBlockedIps(Collection<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.
    
    Parameters:
    
    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.
  - withBlockedIps
```
public AuthenticationProfile withBlockedIps(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.
    
    NOTE: This method appends the values to the existing list (if any). Use setBlockedIps(java.util.Collection) or withBlockedIps(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withBlockedIps
```
public AuthenticationProfile withBlockedIps(Collection<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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setIsDefault
```
public void setIsDefault(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.
    
    Parameters:
    
    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.
  - getIsDefault
```
public Boolean getIsDefault()
```
    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.
  - withIsDefault
```
public AuthenticationProfile withIsDefault(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - isDefault
```
public 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.
  - setCreatedTime
```
public void setCreatedTime(Date createdTime)
```
    The timestamp when the authentication profile was created.
    
    Parameters:
    
    createdTime - The timestamp when the authentication profile was created.
  - getCreatedTime
```
public Date getCreatedTime()
```
    The timestamp when the authentication profile was created.
    
    Returns:
    
    The timestamp when the authentication profile was created.
  - withCreatedTime
```
public AuthenticationProfile withCreatedTime(Date createdTime)
```
    The timestamp when the authentication profile was created.
    
    Parameters:
    
    createdTime - The timestamp when the authentication profile was created.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLastModifiedTime
```
public void setLastModifiedTime(Date lastModifiedTime)
```
    The timestamp when the authentication profile was last modified.
    
    Parameters:
    
    lastModifiedTime - The timestamp when the authentication profile was last modified.
  - getLastModifiedTime
```
public Date getLastModifiedTime()
```
    The timestamp when the authentication profile was last modified.
    
    Returns:
    
    The timestamp when the authentication profile was last modified.
  - withLastModifiedTime
```
public AuthenticationProfile withLastModifiedTime(Date lastModifiedTime)
```
    The timestamp when the authentication profile was last modified.
    
    Parameters:
    
    lastModifiedTime - The timestamp when the authentication profile was last modified.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLastModifiedRegion
```
public void setLastModifiedRegion(String lastModifiedRegion)
```
    The Amazon Web Services Region where the authentication profile was last modified.
    
    Parameters:
    
    lastModifiedRegion - The Amazon Web Services Region where the authentication profile was last modified.
  - getLastModifiedRegion
```
public String getLastModifiedRegion()
```
    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.
  - withLastModifiedRegion
```
public AuthenticationProfile withLastModifiedRegion(String lastModifiedRegion)
```
    The Amazon Web Services Region where the authentication profile was last modified.
    
    Parameters:
    
    lastModifiedRegion - The Amazon Web Services Region where the authentication profile was last modified.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPeriodicSessionDuration
```
public void setPeriodicSessionDuration(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.
    
    Parameters:
    
    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.
  - getPeriodicSessionDuration
```
public Integer getPeriodicSessionDuration()
```
    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.
  - withPeriodicSessionDuration
```
public AuthenticationProfile withPeriodicSessionDuration(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setMaxSessionDuration
```
public void setMaxSessionDuration(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.
    
    Parameters:
    
    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.
  - getMaxSessionDuration
```
public Integer getMaxSessionDuration()
```
    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.
  - withMaxSessionDuration
```
public AuthenticationProfile withMaxSessionDuration(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.
    
    Parameters:
    
    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:
    
    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 AuthenticationProfile 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.773

Class AuthenticationProfile

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AuthenticationProfile

Method Detail

setId

getId

withId

setArn

getArn

withArn

setName

getName

withName

setDescription

getDescription

withDescription

getAllowedIps

setAllowedIps

withAllowedIps

withAllowedIps

getBlockedIps

setBlockedIps

withBlockedIps

withBlockedIps

setIsDefault

getIsDefault

withIsDefault

isDefault

setCreatedTime

getCreatedTime

withCreatedTime

setLastModifiedTime

getLastModifiedTime

withLastModifiedTime

setLastModifiedRegion

getLastModifiedRegion

withLastModifiedRegion

setPeriodicSessionDuration

getPeriodicSessionDuration

withPeriodicSessionDuration

setMaxSessionDuration

getMaxSessionDuration

withMaxSessionDuration

toString

equals

hashCode

clone

marshall