You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::CodeStar::Types::CreateUserProfileRequest

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

Overview

Note:

When making an API call, you may pass CreateUserProfileRequest data as a hash:

{
  user_arn: "UserArn", # required
  display_name: "UserProfileDisplayName", # required
  email_address: "Email", # required
  ssh_public_key: "SshPublicKey",
}

Instance Attribute Summary collapse

Instance Attribute Details

#display_nameString

The name that will be displayed as the friendly name for the user in AWS CodeStar.

Returns:

  • (String)


167
168
169
170
171
172
173
# File 'gems/aws-sdk-codestar/lib/aws-sdk-codestar/types.rb', line 167

class CreateUserProfileRequest < Struct.new(
  :user_arn,
  :display_name,
  :email_address,
  :ssh_public_key)
  include Aws::Structure
end

#email_addressString

The email address that will be displayed as part of the user's profile in AWS CodeStar.

Returns:

  • (String)


167
168
169
170
171
172
173
# File 'gems/aws-sdk-codestar/lib/aws-sdk-codestar/types.rb', line 167

class CreateUserProfileRequest < Struct.new(
  :user_arn,
  :display_name,
  :email_address,
  :ssh_public_key)
  include Aws::Structure
end

#ssh_public_keyString

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)


167
168
169
170
171
172
173
# File 'gems/aws-sdk-codestar/lib/aws-sdk-codestar/types.rb', line 167

class CreateUserProfileRequest < Struct.new(
  :user_arn,
  :display_name,
  :email_address,
  :ssh_public_key)
  include Aws::Structure
end

#user_arnString

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

Returns:

  • (String)


167
168
169
170
171
172
173
# File 'gems/aws-sdk-codestar/lib/aws-sdk-codestar/types.rb', line 167

class CreateUserProfileRequest < Struct.new(
  :user_arn,
  :display_name,
  :email_address,
  :ssh_public_key)
  include Aws::Structure
end