Struct DescribedUser

#[non_exhaustive]
pub struct DescribedUser {
    pub arn: String,
    pub home_directory: Option<String>,
    pub home_directory_mappings: Option<Vec<HomeDirectoryMapEntry>>,
    pub home_directory_type: Option<HomeDirectoryType>,
    pub policy: Option<String>,
    pub posix_profile: Option<PosixProfile>,
    pub role: Option<String>,
    pub ssh_public_keys: Option<Vec<SshPublicKey>>,
    pub tags: Option<Vec<Tag>>,
    pub user_name: Option<String>,
}

Describes the properties of a user that was specified.

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: String

Specifies the unique Amazon Resource Name (ARN) for the user that was requested to be described.

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.

The HomeDirectory parameter is only used if HomeDirectoryType is set to PATH.

home_directory_mappings: Option<Vec<HomeDirectoryMapEntry>>

Logical directory mappings that specify what Amazon S3 or Amazon EFS paths and keys should be visible to your user and how you want to make them visible. You must specify the Entry and Target pair, where Entry shows how the path is made visible and Target is the actual Amazon S3 or Amazon EFS path. If you only specify a target, it is displayed as is. You also must ensure that your Identity and Access Management (IAM) role provides access to paths in Target. This value can be set only when HomeDirectoryType is set to LOGICAL.

In most cases, you can use this value instead of the session 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.

home_directory_type: Option<HomeDirectoryType>

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

If HomeDirectoryType is LOGICAL, you must provide mappings, using the HomeDirectoryMappings parameter. If, on the other hand, HomeDirectoryType is PATH, you provide an absolute path using the HomeDirectory parameter. You cannot have both HomeDirectory and HomeDirectoryMappings in your template.

policy: Option<String>

A session policy for your user so that you can use the same Identity and Access Management (IAM) role across multiple users. This policy scopes down a user's access to portions of their Amazon S3 bucket. Variables that you can use inside this policy include ${Transfer:UserName}, ${Transfer:HomeDirectory}, and ${Transfer:HomeBucket}.

posix_profile: Option<PosixProfile>

Specifies the full POSIX identity, including user ID (Uid), group ID (Gid), and any secondary groups IDs (SecondaryGids), that controls your users' access to your Amazon Elastic File System (Amazon EFS) file systems. The POSIX permissions that are set on files and directories in your file system determine the level of access your users get when transferring files into and out of your Amazon EFS file systems.

role: Option<String>

The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that controls your users' access to your Amazon S3 bucket or Amazon 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 Amazon 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.

ssh_public_keys: Option<Vec<SshPublicKey>>

Specifies the public key portion of the Secure Shell (SSH) keys stored for the described user.

tags: Option<Vec<Tag>>

Specifies the key-value pairs for the user requested. Tag can be used to search for and group users for a variety of purposes.

user_name: Option<String>

Specifies the name of the user that was requested to be described. User names are used for authentication purposes. This is the string that will be used by your user when they log in to your server.

Implementations

impl DescribedUser

pub fn arn(&self) -> &str

Specifies the unique Amazon Resource Name (ARN) for the user that was requested to be described.

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.

The HomeDirectory parameter is only used if HomeDirectoryType is set to PATH.

pub fn home_directory_mappings(&self) -> &[HomeDirectoryMapEntry]

Logical directory mappings that specify what Amazon S3 or Amazon EFS paths and keys should be visible to your user and how you want to make them visible. You must specify the Entry and Target pair, where Entry shows how the path is made visible and Target is the actual Amazon S3 or Amazon EFS path. If you only specify a target, it is displayed as is. You also must ensure that your Identity and Access Management (IAM) role provides access to paths in Target. This value can be set only when HomeDirectoryType is set to LOGICAL.

In most cases, you can use this value instead of the session 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.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .home_directory_mappings.is_none().

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

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

If HomeDirectoryType is LOGICAL, you must provide mappings, using the HomeDirectoryMappings parameter. If, on the other hand, HomeDirectoryType is PATH, you provide an absolute path using the HomeDirectory parameter. You cannot have both HomeDirectory and HomeDirectoryMappings in your template.

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

A session policy for your user so that you can use the same Identity and Access Management (IAM) role across multiple users. This policy scopes down a user's access to portions of their Amazon S3 bucket. Variables that you can use inside this policy include ${Transfer:UserName}, ${Transfer:HomeDirectory}, and ${Transfer:HomeBucket}.

pub fn posix_profile(&self) -> Option<&PosixProfile>

Specifies the full POSIX identity, including user ID (Uid), group ID (Gid), and any secondary groups IDs (SecondaryGids), that controls your users' access to your Amazon Elastic File System (Amazon EFS) file systems. The POSIX permissions that are set on files and directories in your file system determine the level of access your users get when transferring files into and out of your Amazon EFS file systems.

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

The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that controls your users' access to your Amazon S3 bucket or Amazon 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 Amazon 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.

pub fn ssh_public_keys(&self) -> &[SshPublicKey]

Specifies the public key portion of the Secure Shell (SSH) keys stored for the described user.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .ssh_public_keys.is_none().

pub fn tags(&self) -> &[Tag]

Specifies the key-value pairs for the user requested. Tag can be used to search for and group users for a variety of purposes.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .tags.is_none().

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

Specifies the name of the user that was requested to be described. User names are used for authentication purposes. This is the string that will be used by your user when they log in to your server.

impl DescribedUser

pub fn builder() -> DescribedUserBuilder

Creates a new builder-style object to manufacture DescribedUser.

Trait Implementations

impl Clone for DescribedUser

fn clone(&self) -> DescribedUser

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DescribedUser

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

Formats the value using the given formatter.

impl PartialEq for DescribedUser

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for DescribedUser