Struct aws_sdk_transfer::model::described_user::Builder

#[non_exhaustive]
pub struct Builder { /* private fields */ }

A builder for DescribedUser

Implementations

impl Builder

pub fn arn(self, input: impl Into<String>) -> Self

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

pub fn set_arn(self, input: Option<String>) -> Self

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

pub fn home_directory(self, input: impl Into<String>) -> Self

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 set_home_directory(self, input: Option<String>) -> Self

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_mappings(self, input: HomeDirectoryMapEntry) -> Self

Appends an item to home_directory_mappings.

To override the contents of this collection use set_home_directory_mappings.

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 Amazon Web Services Identity and Access Management (IAM) role provides access to paths in Target. This value can only be set 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.

pub fn set_home_directory_mappings(
    self,
    input: Option<Vec<HomeDirectoryMapEntry>>
) -> Self

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 Amazon Web Services Identity and Access Management (IAM) role provides access to paths in Target. This value can only be set 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.

pub fn home_directory_type(self, input: HomeDirectoryType) -> Self

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 set_home_directory_type(self, input: Option<HomeDirectoryType>) -> Self

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 policy(self, input: impl Into<String>) -> Self

A session policy for your user so that you can use the same IAM role across multiple users. This policy scopes down user 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 set_policy(self, input: Option<String>) -> Self

A session policy for your user so that you can use the same IAM role across multiple users. This policy scopes down user 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, input: PosixProfile) -> Self

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 set_posix_profile(self, input: Option<PosixProfile>) -> Self

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, input: impl Into<String>) -> Self

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.

pub fn set_role(self, input: Option<String>) -> Self

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.

pub fn ssh_public_keys(self, input: SshPublicKey) -> Self

Appends an item to ssh_public_keys.

To override the contents of this collection use set_ssh_public_keys.

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

pub fn set_ssh_public_keys(self, input: Option<Vec<SshPublicKey>>) -> Self

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

pub fn tags(self, input: Tag) -> Self

Appends an item to tags.

To override the contents of this collection use set_tags.

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

pub fn set_tags(self, input: Option<Vec<Tag>>) -> Self

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

pub fn user_name(self, input: impl Into<String>) -> Self

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.

pub fn set_user_name(self, input: Option<String>) -> Self

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.

pub fn build(self) -> DescribedUser

Consumes the builder and constructs a DescribedUser

Trait Implementations

impl Clone for Builder

fn clone(&self) -> Builder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Builder

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

Formats the value using the given formatter.

impl Default for Builder

fn default() -> Builder

Returns the “default value” for a type.

impl PartialEq<Builder> for Builder

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

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

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

This method tests for !=.

impl StructuralPartialEq for Builder