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

Class: Aws::OpsWorks::Types::CreateUserProfileRequest

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

Overview

Note:

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

{
  iam_user_arn: "String", # required
  ssh_username: "String",
  ssh_public_key: "String",
  allow_self_management: false,
}

Instance Attribute Summary collapse

Instance Attribute Details

#allow_self_managementBoolean

Whether users can specify their own SSH public key through the My Settings page. For more information, see Setting an IAM User's Public SSH Key.

Returns:

  • (Boolean)


2203
2204
2205
2206
2207
2208
2209
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/types.rb', line 2203

class CreateUserProfileRequest < Struct.new(
  :iam_user_arn,
  :ssh_username,
  :ssh_public_key,
  :allow_self_management)
  include Aws::Structure
end

#iam_user_arnString

The user's IAM ARN; this can also be a federated user's ARN.

Returns:

  • (String)


2203
2204
2205
2206
2207
2208
2209
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/types.rb', line 2203

class CreateUserProfileRequest < Struct.new(
  :iam_user_arn,
  :ssh_username,
  :ssh_public_key,
  :allow_self_management)
  include Aws::Structure
end

#ssh_public_keyString

The user's public SSH key.

Returns:

  • (String)


2203
2204
2205
2206
2207
2208
2209
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/types.rb', line 2203

class CreateUserProfileRequest < Struct.new(
  :iam_user_arn,
  :ssh_username,
  :ssh_public_key,
  :allow_self_management)
  include Aws::Structure
end

#ssh_usernameString

The user's SSH user name. The allowable characters are [a-z], [A-Z], [0-9], '-', and '_'. If the specified name includes other punctuation marks, AWS OpsWorks Stacks removes them. For example, my.name will be changed to myname. If you do not specify an SSH user name, AWS OpsWorks Stacks generates one from the IAM user name.

Returns:

  • (String)


2203
2204
2205
2206
2207
2208
2209
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/types.rb', line 2203

class CreateUserProfileRequest < Struct.new(
  :iam_user_arn,
  :ssh_username,
  :ssh_public_key,
  :allow_self_management)
  include Aws::Structure
end