Struct aws_sdk_transfer::model::ListedUser

#[non_exhaustive]
pub struct ListedUser {
    pub arn: Option<String>,
    pub home_directory: Option<String>,
    pub home_directory_type: Option<HomeDirectoryType>,
    pub role: Option<String>,
    pub ssh_public_key_count: Option<i32>,
    pub user_name: Option<String>,
}

Returns properties of the user that you specify.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

arn: Option<String>

Provides the unique Amazon Resource Name (ARN) for the user that you want to learn about.

home_directory: Option<String>

The landing directory (folder) for a user when they log in to the server using the client.

A HomeDirectory example is /bucket_name/home/mydirectory.

home_directory_type: Option<HomeDirectoryType>

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

role: Option<String>

Specifies the Amazon Resource Name (ARN) of the IAM role that controls your users' access to your Amazon S3 bucket or EFS file system. The policies attached to this role determine the level of access that you want to provide your users when transferring files into and out of your Amazon S3 bucket or EFS file system. The IAM role should also contain a trust relationship that allows the server to access your resources when servicing your users' transfer requests.

The IAM role that controls your users' access to your Amazon S3 bucket for servers with Domain=S3, or your EFS file system for servers with Domain=EFS.

The policies attached to this role determine the level of access you want to provide your users when transferring files into and out of your S3 buckets or EFS file systems.

ssh_public_key_count: Option<i32>

Specifies the number of SSH public keys stored for the user you specified.

user_name: Option<String>

Specifies the name of the user whose ARN was specified. User names are used for authentication purposes.

Implementations

impl ListedUser

pub fn arn(&self) -> Option<&str>

Provides the unique Amazon Resource Name (ARN) for the user that you want to learn about.

pub fn home_directory(&self) -> Option<&str>

The landing directory (folder) for a user when they log in to the server using the client.

A HomeDirectory example is /bucket_name/home/mydirectory.

pub fn home_directory_type(&self) -> Option<&HomeDirectoryType>

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

pub fn role(&self) -> Option<&str>

Specifies the Amazon Resource Name (ARN) of the IAM role that controls your users' access to your Amazon S3 bucket or EFS file system. The policies attached to this role determine the level of access that you want to provide your users when transferring files into and out of your Amazon S3 bucket or EFS file system. The IAM role should also contain a trust relationship that allows the server to access your resources when servicing your users' transfer requests.

The IAM role that controls your users' access to your Amazon S3 bucket for servers with Domain=S3, or your EFS file system for servers with Domain=EFS.

The policies attached to this role determine the level of access you want to provide your users when transferring files into and out of your S3 buckets or EFS file systems.

pub fn ssh_public_key_count(&self) -> Option<i32>

Specifies the number of SSH public keys stored for the user you specified.

pub fn user_name(&self) -> Option<&str>

Specifies the name of the user whose ARN was specified. User names are used for authentication purposes.

impl ListedUser

pub fn builder() -> Builder

Creates a new builder-style object to manufacture ListedUser

Trait Implementations

impl Clone for ListedUser

fn clone(&self) -> ListedUser

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ListedUser

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq<ListedUser> for ListedUser

fn eq(&self, other: &ListedUser) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &ListedUser) -> bool

This method tests for !=.

impl StructuralPartialEq for ListedUser