Class: Aws::Connect::Types::Credentials

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

Overview

Contains credentials to use for federation.

Constant Summary collapse

SENSITIVE =
[:access_token, :refresh_token]

Instance Attribute Summary collapse

Instance Attribute Details

#access_tokenString

An access token generated for a federated user to access Amazon Connect.

Returns:

  • (String)


1859
1860
1861
1862
1863
1864
1865
1866
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/types.rb', line 1859

class Credentials < Struct.new(
  :access_token,
  :access_token_expiration,
  :refresh_token,
  :refresh_token_expiration)
  SENSITIVE = [:access_token, :refresh_token]
  include Aws::Structure
end

#access_token_expirationTime

A token generated with an expiration time for the session a user is logged in to Amazon Connect.

Returns:

  • (Time)


1859
1860
1861
1862
1863
1864
1865
1866
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/types.rb', line 1859

class Credentials < Struct.new(
  :access_token,
  :access_token_expiration,
  :refresh_token,
  :refresh_token_expiration)
  SENSITIVE = [:access_token, :refresh_token]
  include Aws::Structure
end

#refresh_tokenString

Renews a token generated for a user to access the Amazon Connect instance.

Returns:

  • (String)


1859
1860
1861
1862
1863
1864
1865
1866
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/types.rb', line 1859

class Credentials < Struct.new(
  :access_token,
  :access_token_expiration,
  :refresh_token,
  :refresh_token_expiration)
  SENSITIVE = [:access_token, :refresh_token]
  include Aws::Structure
end

#refresh_token_expirationTime

Renews the expiration timer for a generated token.

Returns:

  • (Time)


1859
1860
1861
1862
1863
1864
1865
1866
# File 'gems/aws-sdk-connect/lib/aws-sdk-connect/types.rb', line 1859

class Credentials < Struct.new(
  :access_token,
  :access_token_expiration,
  :refresh_token,
  :refresh_token_expiration)
  SENSITIVE = [:access_token, :refresh_token]
  include Aws::Structure
end