connect/aws.sdk.kotlin.services.connect.model/AuthenticationProfile

AuthenticationProfile

This API is in preview release for Connect Customer 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.

Types

Builder

class Builder

Companion

object Companion

Properties

allowedIps

val allowedIps: List<String>?

A list of IP address range strings that are allowed to access the Connect Customer instance. For more information about how to configure IP addresses, see Configure IP address based access control in the Connect Customer Administrator Guide.

arn

val arn: String?

The Amazon Resource Name (ARN) for the authentication profile.

blockedIps

val blockedIps: List<String>?

A list of IP address range strings that are blocked from accessing the Connect Customer instance. For more information about how to configure IP addresses, see Configure IP address based access control in the Connect Customer Administrator Guide.

createdTime

val createdTime: Instant?

The timestamp when the authentication profile was created.

description

val description: String?

The description for the authentication profile.

val id: String?

A unique identifier for the authentication profile.

isDefault

val isDefault: Boolean

Shows whether the authentication profile is the default authentication profile for the Connect Customer instance. The default authentication profile applies to all agents in an Connect Customer instance, unless overridden by another authentication profile.

lastModifiedRegion

val lastModifiedRegion: String?

The Amazon Web Services Region where the authentication profile was last modified.

lastModifiedTime

val lastModifiedTime: Instant?

The timestamp when the authentication profile was last modified.

maxSessionDuration

val maxSessionDuration: Int?

The long lived session duration for users logged in to Connect Customer, in minutes. After this time period, users must log in again. For more information, see Configure the session duration in the Connect Customer Administrator Guide.

name

val name: String?

The name for the authentication profile.

periodicSessionDuration

val ~~periodicSessionDuration~~: Int?

The short lived session duration configuration for users logged in to Connect Customer, in minutes. This value determines the maximum possible time before an agent is authenticated. For more information, see Configure the session duration in the Connect Customer Administrator Guide.

sessionInactivityDuration

val sessionInactivityDuration: Int?

The period, in minutes, before an agent is automatically signed out of the contact center when they go inactive.

sessionInactivityHandlingEnabled

val sessionInactivityHandlingEnabled: Boolean?

Determines if automatic logout on user inactivity is enabled.

Functions

copy

inline fun copy(block: AuthenticationProfile.Builder.() -> Unit = {}): AuthenticationProfile

equals

open operator override fun equals(other: Any?): Boolean

hashCode

open override fun hashCode(): Int

toString

open override fun toString(): String