#[non_exhaustive]pub struct DescribedUserBuilder { /* private fields */ }
Expand description
A builder for DescribedUser
.
Implementations§
Source§impl DescribedUserBuilder
impl DescribedUserBuilder
Sourcepub fn arn(self, input: impl Into<String>) -> Self
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.
This field is required.Sourcepub fn set_arn(self, input: Option<String>) -> Self
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.
Sourcepub fn get_arn(&self) -> &Option<String>
pub fn get_arn(&self) -> &Option<String>
Specifies the unique Amazon Resource Name (ARN) for the user that was requested to be described.
Sourcepub fn home_directory(self, input: impl Into<String>) -> Self
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
.
The HomeDirectory
parameter is only used if HomeDirectoryType
is set to PATH
.
Sourcepub fn set_home_directory(self, input: Option<String>) -> Self
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
.
The HomeDirectory
parameter is only used if HomeDirectoryType
is set to PATH
.
Sourcepub fn get_home_directory(&self) -> &Option<String>
pub fn get_home_directory(&self) -> &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
.
Sourcepub fn home_directory_mappings(self, input: HomeDirectoryMapEntry) -> Self
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 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.
Sourcepub fn set_home_directory_mappings(
self,
input: Option<Vec<HomeDirectoryMapEntry>>,
) -> Self
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 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.
Sourcepub fn get_home_directory_mappings(&self) -> &Option<Vec<HomeDirectoryMapEntry>>
pub fn get_home_directory_mappings(&self) -> &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.
Sourcepub fn home_directory_type(self, input: HomeDirectoryType) -> Self
pub fn home_directory_type(self, input: HomeDirectoryType) -> Self
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.
Sourcepub fn set_home_directory_type(self, input: Option<HomeDirectoryType>) -> Self
pub fn set_home_directory_type(self, input: Option<HomeDirectoryType>) -> Self
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.
Sourcepub fn get_home_directory_type(&self) -> &Option<HomeDirectoryType>
pub fn get_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.
Sourcepub fn policy(self, input: impl Into<String>) -> Self
pub fn policy(self, input: impl Into<String>) -> Self
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}
.
Sourcepub fn set_policy(self, input: Option<String>) -> Self
pub fn set_policy(self, input: Option<String>) -> Self
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}
.
Sourcepub fn get_policy(&self) -> &Option<String>
pub fn get_policy(&self) -> &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}
.
Sourcepub fn posix_profile(self, input: PosixProfile) -> Self
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.
Sourcepub fn set_posix_profile(self, input: Option<PosixProfile>) -> Self
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.
Sourcepub fn get_posix_profile(&self) -> &Option<PosixProfile>
pub fn get_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.
Sourcepub fn role(self, input: impl Into<String>) -> Self
pub fn role(self, input: impl Into<String>) -> Self
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.
Sourcepub fn set_role(self, input: Option<String>) -> Self
pub fn set_role(self, input: Option<String>) -> Self
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.
Sourcepub fn get_role(&self) -> &Option<String>
pub fn get_role(&self) -> &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.
Sourcepub fn ssh_public_keys(self, input: SshPublicKey) -> Self
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.
Sourcepub fn set_ssh_public_keys(self, input: Option<Vec<SshPublicKey>>) -> Self
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.
Sourcepub fn get_ssh_public_keys(&self) -> &Option<Vec<SshPublicKey>>
pub fn get_ssh_public_keys(&self) -> &Option<Vec<SshPublicKey>>
Specifies the public key portion of the Secure Shell (SSH) keys stored for the described user.
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.
Specifies the key-value pairs for the user requested. Tag can be used to search for and group users for a variety of purposes.
Specifies the key-value pairs for the user requested. Tag can be used to search for and group users for a variety of purposes.
Sourcepub fn user_name(self, input: impl Into<String>) -> Self
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.
Sourcepub fn set_user_name(self, input: Option<String>) -> Self
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.
Sourcepub fn get_user_name(&self) -> &Option<String>
pub fn get_user_name(&self) -> &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.
Sourcepub fn build(self) -> Result<DescribedUser, BuildError>
pub fn build(self) -> Result<DescribedUser, BuildError>
Consumes the builder and constructs a DescribedUser
.
This method will fail if any of the following fields are not set:
Trait Implementations§
Source§impl Clone for DescribedUserBuilder
impl Clone for DescribedUserBuilder
Source§fn clone(&self) -> DescribedUserBuilder
fn clone(&self) -> DescribedUserBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for DescribedUserBuilder
impl Debug for DescribedUserBuilder
Source§impl Default for DescribedUserBuilder
impl Default for DescribedUserBuilder
Source§fn default() -> DescribedUserBuilder
fn default() -> DescribedUserBuilder
Source§impl PartialEq for DescribedUserBuilder
impl PartialEq for DescribedUserBuilder
impl StructuralPartialEq for DescribedUserBuilder
Auto Trait Implementations§
impl Freeze for DescribedUserBuilder
impl RefUnwindSafe for DescribedUserBuilder
impl Send for DescribedUserBuilder
impl Sync for DescribedUserBuilder
impl Unpin for DescribedUserBuilder
impl UnwindSafe for DescribedUserBuilder
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§unsafe fn clone_to_uninit(&self, dst: *mut T)
unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the foreground set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red()
and
green()
, which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg()
:
use yansi::{Paint, Color};
painted.fg(Color::White);
Set foreground color to white using white()
.
use yansi::Paint;
painted.white();
Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Returns self
with the
fg()
set to
Color::BrightBlack
.
§Example
println!("{}", value.bright_black());
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Returns self
with the
fg()
set to
Color::BrightGreen
.
§Example
println!("{}", value.bright_green());
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Returns self
with the
fg()
set to
Color::BrightYellow
.
§Example
println!("{}", value.bright_yellow());
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Returns self
with the
fg()
set to
Color::BrightMagenta
.
§Example
println!("{}", value.bright_magenta());
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Returns self
with the
fg()
set to
Color::BrightWhite
.
§Example
println!("{}", value.bright_white());
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the background set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red()
and
on_green()
, which have the same functionality but
are pithier.
§Example
Set background color to red using fg()
:
use yansi::{Paint, Color};
painted.bg(Color::Red);
Set background color to red using on_red()
.
use yansi::Paint;
painted.on_red();
Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightBlack
.
§Example
println!("{}", value.on_bright_black());
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightGreen
.
§Example
println!("{}", value.on_bright_green());
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightYellow
.
§Example
println!("{}", value.on_bright_yellow());
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightBlue
.
§Example
println!("{}", value.on_bright_blue());
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightMagenta
.
§Example
println!("{}", value.on_bright_magenta());
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightCyan
.
§Example
println!("{}", value.on_bright_cyan());
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightWhite
.
§Example
println!("{}", value.on_bright_white());
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute
value
.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold()
and
underline()
, which have the same functionality
but are pithier.
§Example
Make text bold using attr()
:
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);
Make text bold using using bold()
.
use yansi::Paint;
painted.bold();
Source§fn underline(&self) -> Painted<&T>
fn underline(&self) -> Painted<&T>
Returns self
with the
attr()
set to
Attribute::Underline
.
§Example
println!("{}", value.underline());
Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Returns self
with the
attr()
set to
Attribute::RapidBlink
.
§Example
println!("{}", value.rapid_blink());
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi
Quirk
value
.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask()
and
wrap()
, which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk()
:
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);
Enable wrapping using wrap()
.
use yansi::Paint;
painted.wrap();
Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition
value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted
only when both stdout
and stderr
are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);