Struct aws_sdk_transfer::types::builders::ListedUserBuilder
source · #[non_exhaustive]pub struct ListedUserBuilder { /* private fields */ }
Expand description
A builder for ListedUser
.
Implementations§
source§impl ListedUserBuilder
impl ListedUserBuilder
sourcepub fn arn(self, input: impl Into<String>) -> Self
pub fn arn(self, input: impl Into<String>) -> Self
Provides the unique Amazon Resource Name (ARN) for the user that you want to learn about.
This field is required.sourcepub fn set_arn(self, input: Option<String>) -> Self
pub fn set_arn(self, input: Option<String>) -> Self
Provides the unique Amazon Resource Name (ARN) for the user that you want to learn about.
sourcepub fn get_arn(&self) -> &Option<String>
pub fn get_arn(&self) -> &Option<String>
Provides the unique Amazon Resource Name (ARN) for the user that you want to learn about.
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_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 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.
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.
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.
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.
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.
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.
sourcepub fn ssh_public_key_count(self, input: i32) -> Self
pub fn ssh_public_key_count(self, input: i32) -> Self
Specifies the number of SSH public keys stored for the user you specified.
sourcepub fn set_ssh_public_key_count(self, input: Option<i32>) -> Self
pub fn set_ssh_public_key_count(self, input: Option<i32>) -> Self
Specifies the number of SSH public keys stored for the user you specified.
sourcepub fn get_ssh_public_key_count(&self) -> &Option<i32>
pub fn get_ssh_public_key_count(&self) -> &Option<i32>
Specifies the number of SSH public keys stored for the user you specified.
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 whose ARN was specified. User names are used for authentication purposes.
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 whose ARN was specified. User names are used for authentication purposes.
sourcepub fn get_user_name(&self) -> &Option<String>
pub fn get_user_name(&self) -> &Option<String>
Specifies the name of the user whose ARN was specified. User names are used for authentication purposes.
sourcepub fn build(self) -> Result<ListedUser, BuildError>
pub fn build(self) -> Result<ListedUser, BuildError>
Consumes the builder and constructs a ListedUser
.
This method will fail if any of the following fields are not set:
Trait Implementations§
source§impl Clone for ListedUserBuilder
impl Clone for ListedUserBuilder
source§fn clone(&self) -> ListedUserBuilder
fn clone(&self) -> ListedUserBuilder
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for ListedUserBuilder
impl Debug for ListedUserBuilder
source§impl Default for ListedUserBuilder
impl Default for ListedUserBuilder
source§fn default() -> ListedUserBuilder
fn default() -> ListedUserBuilder
source§impl PartialEq for ListedUserBuilder
impl PartialEq for ListedUserBuilder
source§fn eq(&self, other: &ListedUserBuilder) -> bool
fn eq(&self, other: &ListedUserBuilder) -> bool
self
and other
values to be equal, and is used
by ==
.impl StructuralPartialEq for ListedUserBuilder
Auto Trait Implementations§
impl Freeze for ListedUserBuilder
impl RefUnwindSafe for ListedUserBuilder
impl Send for ListedUserBuilder
impl Sync for ListedUserBuilder
impl Unpin for ListedUserBuilder
impl UnwindSafe for ListedUserBuilder
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> 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 more