Class: Aws::DirectoryServiceData::Types::CreateUserRequest

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

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[:email_address, :given_name, :surname]

Instance Attribute Summary collapse

Instance Attribute Details

#client_token ⇒ String

A unique and case-sensitive identifier that you provide to make sure the idempotency of the request, so multiple identical calls have the same effect as one single call.

A client token is valid for 8 hours after the first request that uses it completes. After 8 hours, any request with the same client token is treated as a new request. If the request succeeds, any future uses of that token will be idempotent for another 8 hours.

If you submit a request with the same client token but change one of the other parameters within the 8-hour idempotency window, Directory Service Data returns an ‘ConflictException`.

<note markdown=“1”> This parameter is optional when using the CLI or SDK.

</note>

**A suitable default value is auto-generated.** You should normally not need to pass this option.

Returns:

  • (String) 


332
333
334
335
336
337
338
339
340
341
342
 
# File 'lib/aws-sdk-directoryservicedata/types.rb', line 332

class CreateUserRequest < Struct.new(
  :client_token,
  :directory_id,
  :email_address,
  :given_name,
  :other_attributes,
  :sam_account_name,
  :surname)
  SENSITIVE = [:email_address, :given_name, :surname]
  include Aws::Structure
end

#directory_id ⇒ String

The identifier (ID) of the directory that’s associated with the user.

Returns:

  • (String) 


332
333
334
335
336
337
338
339
340
341
342
 
# File 'lib/aws-sdk-directoryservicedata/types.rb', line 332

class CreateUserRequest < Struct.new(
  :client_token,
  :directory_id,
  :email_address,
  :given_name,
  :other_attributes,
  :sam_account_name,
  :surname)
  SENSITIVE = [:email_address, :given_name, :surname]
  include Aws::Structure
end

#email_address ⇒ String

The email address of the user.

Returns:

  • (String) 


332
333
334
335
336
337
338
339
340
341
342
 
# File 'lib/aws-sdk-directoryservicedata/types.rb', line 332

class CreateUserRequest < Struct.new(
  :client_token,
  :directory_id,
  :email_address,
  :given_name,
  :other_attributes,
  :sam_account_name,
  :surname)
  SENSITIVE = [:email_address, :given_name, :surname]
  include Aws::Structure
end

#given_name ⇒ String

The first name of the user.

Returns:

  • (String) 


332
333
334
335
336
337
338
339
340
341
342
 
# File 'lib/aws-sdk-directoryservicedata/types.rb', line 332

class CreateUserRequest < Struct.new(
  :client_token,
  :directory_id,
  :email_address,
  :given_name,
  :other_attributes,
  :sam_account_name,
  :surname)
  SENSITIVE = [:email_address, :given_name, :surname]
  include Aws::Structure
end

#other_attributes ⇒ Hash<String,Types::AttributeValue>

An expression that defines one or more attribute names with the data type and value of each attribute. A key is an attribute name, and the value is a list of maps. For a list of supported attributes, see [Directory Service Data Attributes].

<note markdown=“1”> Attribute names are case insensitive.

</note>

[1]: docs.aws.amazon.com/directoryservice/latest/admin-guide/ad_data_attributes.html

Returns:



332
333
334
335
336
337
338
339
340
341
342
 
# File 'lib/aws-sdk-directoryservicedata/types.rb', line 332

class CreateUserRequest < Struct.new(
  :client_token,
  :directory_id,
  :email_address,
  :given_name,
  :other_attributes,
  :sam_account_name,
  :surname)
  SENSITIVE = [:email_address, :given_name, :surname]
  include Aws::Structure
end

#sam_account_name ⇒ String

The name of the user.

Returns:

  • (String) 


332
333
334
335
336
337
338
339
340
341
342
 
# File 'lib/aws-sdk-directoryservicedata/types.rb', line 332

class CreateUserRequest < Struct.new(
  :client_token,
  :directory_id,
  :email_address,
  :given_name,
  :other_attributes,
  :sam_account_name,
  :surname)
  SENSITIVE = [:email_address, :given_name, :surname]
  include Aws::Structure
end

#surname ⇒ String

The last name of the user.

Returns:

  • (String) 


332
333
334
335
336
337
338
339
340
341
342
 
# File 'lib/aws-sdk-directoryservicedata/types.rb', line 332

class CreateUserRequest < Struct.new(
  :client_token,
  :directory_id,
  :email_address,
  :given_name,
  :other_attributes,
  :sam_account_name,
  :surname)
  SENSITIVE = [:email_address, :given_name, :surname]
  include Aws::Structure
end