Class: Aws::Connect::Types::AuthenticationProfile

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-connect/types.rb

Overview

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].

[1]: docs.aws.amazon.com/connect/latest/adminguide/authentication-profiles.html

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#allowed_ipsArray<String>

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*.

[1]: docs.aws.amazon.com/connect/latest/adminguide/authentication-profiles.html#configure-ip-based-ac

Returns:

  • (Array<String>)


1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
# File 'lib/aws-sdk-connect/types.rb', line 1397

class AuthenticationProfile < Struct.new(
  :id,
  :arn,
  :name,
  :description,
  :allowed_ips,
  :blocked_ips,
  :is_default,
  :created_time,
  :last_modified_time,
  :last_modified_region,
  :periodic_session_duration,
  :max_session_duration)
  SENSITIVE = []
  include Aws::Structure
end

#arnString

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

Returns:

  • (String)


1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
# File 'lib/aws-sdk-connect/types.rb', line 1397

class AuthenticationProfile < Struct.new(
  :id,
  :arn,
  :name,
  :description,
  :allowed_ips,
  :blocked_ips,
  :is_default,
  :created_time,
  :last_modified_time,
  :last_modified_region,
  :periodic_session_duration,
  :max_session_duration)
  SENSITIVE = []
  include Aws::Structure
end

#blocked_ipsArray<String>

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*.

[1]: docs.aws.amazon.com/connect/latest/adminguide/authentication-profiles.html#configure-ip-based-ac

Returns:

  • (Array<String>)


1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
# File 'lib/aws-sdk-connect/types.rb', line 1397

class AuthenticationProfile < Struct.new(
  :id,
  :arn,
  :name,
  :description,
  :allowed_ips,
  :blocked_ips,
  :is_default,
  :created_time,
  :last_modified_time,
  :last_modified_region,
  :periodic_session_duration,
  :max_session_duration)
  SENSITIVE = []
  include Aws::Structure
end

#created_timeTime

The timestamp when the authentication profile was created.

Returns:

  • (Time)


1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
# File 'lib/aws-sdk-connect/types.rb', line 1397

class AuthenticationProfile < Struct.new(
  :id,
  :arn,
  :name,
  :description,
  :allowed_ips,
  :blocked_ips,
  :is_default,
  :created_time,
  :last_modified_time,
  :last_modified_region,
  :periodic_session_duration,
  :max_session_duration)
  SENSITIVE = []
  include Aws::Structure
end

#descriptionString

The description for the authentication profile.

Returns:

  • (String)


1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
# File 'lib/aws-sdk-connect/types.rb', line 1397

class AuthenticationProfile < Struct.new(
  :id,
  :arn,
  :name,
  :description,
  :allowed_ips,
  :blocked_ips,
  :is_default,
  :created_time,
  :last_modified_time,
  :last_modified_region,
  :periodic_session_duration,
  :max_session_duration)
  SENSITIVE = []
  include Aws::Structure
end

#idString

A unique identifier for the authentication profile.

Returns:

  • (String)


1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
# File 'lib/aws-sdk-connect/types.rb', line 1397

class AuthenticationProfile < Struct.new(
  :id,
  :arn,
  :name,
  :description,
  :allowed_ips,
  :blocked_ips,
  :is_default,
  :created_time,
  :last_modified_time,
  :last_modified_region,
  :periodic_session_duration,
  :max_session_duration)
  SENSITIVE = []
  include Aws::Structure
end

#is_defaultBoolean

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:

  • (Boolean)


1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
# File 'lib/aws-sdk-connect/types.rb', line 1397

class AuthenticationProfile < Struct.new(
  :id,
  :arn,
  :name,
  :description,
  :allowed_ips,
  :blocked_ips,
  :is_default,
  :created_time,
  :last_modified_time,
  :last_modified_region,
  :periodic_session_duration,
  :max_session_duration)
  SENSITIVE = []
  include Aws::Structure
end

#last_modified_regionString

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

Returns:

  • (String)


1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
# File 'lib/aws-sdk-connect/types.rb', line 1397

class AuthenticationProfile < Struct.new(
  :id,
  :arn,
  :name,
  :description,
  :allowed_ips,
  :blocked_ips,
  :is_default,
  :created_time,
  :last_modified_time,
  :last_modified_region,
  :periodic_session_duration,
  :max_session_duration)
  SENSITIVE = []
  include Aws::Structure
end

#last_modified_timeTime

The timestamp when the authentication profile was last modified.

Returns:

  • (Time)


1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
# File 'lib/aws-sdk-connect/types.rb', line 1397

class AuthenticationProfile < Struct.new(
  :id,
  :arn,
  :name,
  :description,
  :allowed_ips,
  :blocked_ips,
  :is_default,
  :created_time,
  :last_modified_time,
  :last_modified_region,
  :periodic_session_duration,
  :max_session_duration)
  SENSITIVE = []
  include Aws::Structure
end

#max_session_durationInteger

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*.

[1]: docs.aws.amazon.com/connect/latest/adminguide/authentication-profiles.html#configure-session-timeouts

Returns:

  • (Integer)


1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
# File 'lib/aws-sdk-connect/types.rb', line 1397

class AuthenticationProfile < Struct.new(
  :id,
  :arn,
  :name,
  :description,
  :allowed_ips,
  :blocked_ips,
  :is_default,
  :created_time,
  :last_modified_time,
  :last_modified_region,
  :periodic_session_duration,
  :max_session_duration)
  SENSITIVE = []
  include Aws::Structure
end

#nameString

The name for the authentication profile.

Returns:

  • (String)


1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
# File 'lib/aws-sdk-connect/types.rb', line 1397

class AuthenticationProfile < Struct.new(
  :id,
  :arn,
  :name,
  :description,
  :allowed_ips,
  :blocked_ips,
  :is_default,
  :created_time,
  :last_modified_time,
  :last_modified_region,
  :periodic_session_duration,
  :max_session_duration)
  SENSITIVE = []
  include Aws::Structure
end

#periodic_session_durationInteger

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*.

[1]: docs.aws.amazon.com/connect/latest/adminguide/authentication-profiles.html#configure-session-timeouts

Returns:

  • (Integer)


1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
# File 'lib/aws-sdk-connect/types.rb', line 1397

class AuthenticationProfile < Struct.new(
  :id,
  :arn,
  :name,
  :description,
  :allowed_ips,
  :blocked_ips,
  :is_default,
  :created_time,
  :last_modified_time,
  :last_modified_region,
  :periodic_session_duration,
  :max_session_duration)
  SENSITIVE = []
  include Aws::Structure
end