Class: Aws::Transfer::Types::UpdateUserRequest

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

Overview

Note:

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

{
  home_directory: "HomeDirectory",
  home_directory_type: "PATH", # accepts PATH, LOGICAL
  home_directory_mappings: [
    {
      entry: "MapEntry", # required
      target: "MapTarget", # required
    },
  ],
  policy: "Policy",
  role: "Role",
  server_id: "ServerId", # required
  user_name: "UserName", # required
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#home_directory ⇒ String

A parameter that specifies the landing directory (folder) for a user when they log in to the server using their client.

An example is ‘<your-Amazon-S3-bucket-name>/home/username`.

Returns:

  • (String) 


1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
 
# File 'lib/aws-sdk-transfer/types.rb', line 1598

class UpdateUserRequest < Struct.new(
  :home_directory,
  :home_directory_type,
  :home_directory_mappings,
  :policy,
  :role,
  :server_id,
  :user_name)
  include Aws::Structure
end

#home_directory_mappings ⇒ Array<Types::HomeDirectoryMapEntry>

Logical directory mappings that specify what S3 paths and keys should be visible to your user and how you want to make them visible. You will need to specify the “‘Entry`” and “`Target`” pair, where `Entry` shows how the path is made visible and `Target` is the actual S3 path. If you only specify a target, it will be displayed as is. You will need to also make sure that your AWS IAM Role provides access to paths in `Target`. The following is an example.

‘’[ “/bucket2/documentation”, { “Entry”: “your-personal-report.pdf”, “Target”: “/bucket3/customized-reports/$transfer:UserName.pdf” } ]‘`

In most cases, you can use this value instead of the scope down policy to lock your user down to the designated home directory (“chroot”). To do this, you can set ‘Entry` to ’/‘ and set `Target` to the HomeDirectory parameter value.

<note markdown=“1”> If the target of a logical directory entry does not exist in S3, the entry will be ignored. As a workaround, you can use the S3 api to create 0 byte objects as place holders for your directory. If using the CLI, use the s3api call instead of s3 so you can use the put-object operation. For example, you use the following: ‘aws s3api put-object –bucket bucketname –key path/to/folder/`. Make sure that the end of the key name ends in a / for it to be considered a folder.

</note>

Returns:



1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
 
# File 'lib/aws-sdk-transfer/types.rb', line 1598

class UpdateUserRequest < Struct.new(
  :home_directory,
  :home_directory_type,
  :home_directory_mappings,
  :policy,
  :role,
  :server_id,
  :user_name)
  include Aws::Structure
end

#home_directory_type ⇒ String

The type of landing directory (folder) you want your users’ home directory to be when they log into the SFTP serve. If you set it to ‘PATH`, the user will see the absolute Amazon S3 bucket paths as is in their SFTP clients. If you set it `LOGICAL`, you will need to provide mappings in the `HomeDirectoryMappings` for how you want to make S3 paths visible to your user.

Returns:

  • (String) 


1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
 
# File 'lib/aws-sdk-transfer/types.rb', line 1598

class UpdateUserRequest < Struct.new(
  :home_directory,
  :home_directory_type,
  :home_directory_mappings,
  :policy,
  :role,
  :server_id,
  :user_name)
  include Aws::Structure
end

#policy ⇒ String

Allows you to supply a scope-down policy for your user so you can use the same AWS Identity and Access Management (IAM) role across multiple users. The policy scopes down user access to portions of your Amazon S3 bucket. Variables you can use inside this policy include ‘$Transfer:UserName`, `$Transfer:HomeDirectory`, and `$Transfer:HomeBucket`.

<note markdown=“1”> For scope-down policies, AWS Transfer for SFTP stores the policy as a JSON blob, instead of the Amazon Resource Name (ARN) of the policy. You save the policy as a JSON blob and pass it in the ‘Policy` argument.

For an example of a scope-down policy, see

“docs.aws.amazon.com/transfer/latest/userguide/users.html#users-policies-scope-down”&gt;Creating a Scope-Down Policy.

For more information, see

“docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html” in the *AWS Security Token Service API Reference*.

</note>

Returns:

  • (String) 


1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
 
# File 'lib/aws-sdk-transfer/types.rb', line 1598

class UpdateUserRequest < Struct.new(
  :home_directory,
  :home_directory_type,
  :home_directory_mappings,
  :policy,
  :role,
  :server_id,
  :user_name)
  include Aws::Structure
end

#role ⇒ String

The IAM role that controls your user’s access to your Amazon S3 bucket. The policies attached to this role will determine the level of access you want to provide your users when transferring files into and out of your Amazon S3 bucket or buckets. The IAM role should also contain a trust relationship that allows the Secure File Transfer Protocol (SFTP) server to access your resources when servicing your SFTP user’s transfer requests.

Returns:

  • (String) 


1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
 
# File 'lib/aws-sdk-transfer/types.rb', line 1598

class UpdateUserRequest < Struct.new(
  :home_directory,
  :home_directory_type,
  :home_directory_mappings,
  :policy,
  :role,
  :server_id,
  :user_name)
  include Aws::Structure
end

#server_id ⇒ String

A system-assigned unique identifier for an SFTP server instance that the user account is assigned to.

Returns:

  • (String) 


1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
 
# File 'lib/aws-sdk-transfer/types.rb', line 1598

class UpdateUserRequest < Struct.new(
  :home_directory,
  :home_directory_type,
  :home_directory_mappings,
  :policy,
  :role,
  :server_id,
  :user_name)
  include Aws::Structure
end

#user_name ⇒ String

A unique string that identifies a user and is associated with a server as specified by the ‘ServerId`. This is the string that will be used by your user when they log in to your SFTP server. This user name is a minimum of 3 and a maximum of 32 characters long. The following are valid characters: a-z, A-Z, 0-9, underscore, and hyphen. The user name can’t start with a hyphen.

Returns:

  • (String) 


1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
 
# File 'lib/aws-sdk-transfer/types.rb', line 1598

class UpdateUserRequest < Struct.new(
  :home_directory,
  :home_directory_type,
  :home_directory_mappings,
  :policy,
  :role,
  :server_id,
  :user_name)
  include Aws::Structure
end