Class: Aws::CodeStar::Types::UserProfileSummary

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

Overview

Information about a user’s profile in AWS CodeStar.

See Also:

Constant Summary collapse

SENSITIVE = 
[:display_name, :email_address]

Instance Attribute Summary collapse

Instance Attribute Details

#display_name ⇒ String

The display name of a user in AWS CodeStar. For example, this could be set to both first and last name (“Mary Major”) or a single name (“Mary”). The display name is also used to generate the initial icon associated with the user in AWS CodeStar projects. If spaces are included in the display name, the first character that appears after the space will be used as the second character in the user initial icon. The initial icon displays a maximum of two characters, so a display name with more than one space (for example “Mary Jane Major”) would generate an initial icon using the first character and the first character after the space (“MJ”, not “MM”).

Returns:

  • (String) 


1251
1252
1253
1254
1255
1256
1257
1258
 
# File 'lib/aws-sdk-codestar/types.rb', line 1251

class UserProfileSummary < Struct.new(
  :user_arn,
  :display_name,
  :email_address,
  :ssh_public_key)
  SENSITIVE = [:display_name, :email_address]
  include Aws::Structure
end

#email_address ⇒ String

The email address associated with the user.

Returns:

  • (String) 


1251
1252
1253
1254
1255
1256
1257
1258
 
# File 'lib/aws-sdk-codestar/types.rb', line 1251

class UserProfileSummary < Struct.new(
  :user_arn,
  :display_name,
  :email_address,
  :ssh_public_key)
  SENSITIVE = [:display_name, :email_address]
  include Aws::Structure
end

#ssh_public_key ⇒ String

The SSH public key associated with the user in AWS CodeStar. If a project owner allows the user remote access to project resources, this public key will be used along with the user’s private key for SSH access.

Returns:

  • (String) 


1251
1252
1253
1254
1255
1256
1257
1258
 
# File 'lib/aws-sdk-codestar/types.rb', line 1251

class UserProfileSummary < Struct.new(
  :user_arn,
  :display_name,
  :email_address,
  :ssh_public_key)
  SENSITIVE = [:display_name, :email_address]
  include Aws::Structure
end

#user_arn ⇒ String

The Amazon Resource Name (ARN) of the user in IAM.

Returns:

  • (String) 


1251
1252
1253
1254
1255
1256
1257
1258
 
# File 'lib/aws-sdk-codestar/types.rb', line 1251

class UserProfileSummary < Struct.new(
  :user_arn,
  :display_name,
  :email_address,
  :ssh_public_key)
  SENSITIVE = [:display_name, :email_address]
  include Aws::Structure
end