Struct aws_sdk_transfer::types::builders::ListedAccessBuilder
source · #[non_exhaustive]pub struct ListedAccessBuilder { /* private fields */ }
Expand description
A builder for ListedAccess
.
Implementations§
source§impl ListedAccessBuilder
impl ListedAccessBuilder
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.
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 external_id(self, input: impl Into<String>) -> Self
pub fn external_id(self, input: impl Into<String>) -> Self
A unique identifier that is required to identify specific groups within your directory. The users of the group that you associate have access to your Amazon S3 or Amazon EFS resources over the enabled protocols using Transfer Family. If you know the group name, you can view the SID values by running the following command using Windows PowerShell.
Get-ADGroup -Filter {samAccountName -like "YourGroupName*"} -Properties * | Select SamAccountName,ObjectSid
In that command, replace YourGroupName with the name of your Active Directory group.
The regular expression used to validate this parameter is a string of characters consisting of uppercase and lowercase alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@:/-
sourcepub fn set_external_id(self, input: Option<String>) -> Self
pub fn set_external_id(self, input: Option<String>) -> Self
A unique identifier that is required to identify specific groups within your directory. The users of the group that you associate have access to your Amazon S3 or Amazon EFS resources over the enabled protocols using Transfer Family. If you know the group name, you can view the SID values by running the following command using Windows PowerShell.
Get-ADGroup -Filter {samAccountName -like "YourGroupName*"} -Properties * | Select SamAccountName,ObjectSid
In that command, replace YourGroupName with the name of your Active Directory group.
The regular expression used to validate this parameter is a string of characters consisting of uppercase and lowercase alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@:/-
sourcepub fn get_external_id(&self) -> &Option<String>
pub fn get_external_id(&self) -> &Option<String>
A unique identifier that is required to identify specific groups within your directory. The users of the group that you associate have access to your Amazon S3 or Amazon EFS resources over the enabled protocols using Transfer Family. If you know the group name, you can view the SID values by running the following command using Windows PowerShell.
Get-ADGroup -Filter {samAccountName -like "YourGroupName*"} -Properties * | Select SamAccountName,ObjectSid
In that command, replace YourGroupName with the name of your Active Directory group.
The regular expression used to validate this parameter is a string of characters consisting of uppercase and lowercase alphanumeric characters with no spaces. You can also include underscores or any of the following characters: =,.@:/-
sourcepub fn build(self) -> ListedAccess
pub fn build(self) -> ListedAccess
Consumes the builder and constructs a ListedAccess
.
Trait Implementations§
source§impl Clone for ListedAccessBuilder
impl Clone for ListedAccessBuilder
source§fn clone(&self) -> ListedAccessBuilder
fn clone(&self) -> ListedAccessBuilder
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for ListedAccessBuilder
impl Debug for ListedAccessBuilder
source§impl Default for ListedAccessBuilder
impl Default for ListedAccessBuilder
source§fn default() -> ListedAccessBuilder
fn default() -> ListedAccessBuilder
source§impl PartialEq for ListedAccessBuilder
impl PartialEq for ListedAccessBuilder
source§fn eq(&self, other: &ListedAccessBuilder) -> bool
fn eq(&self, other: &ListedAccessBuilder) -> bool
self
and other
values to be equal, and is used
by ==
.impl StructuralPartialEq for ListedAccessBuilder
Auto Trait Implementations§
impl Freeze for ListedAccessBuilder
impl RefUnwindSafe for ListedAccessBuilder
impl Send for ListedAccessBuilder
impl Sync for ListedAccessBuilder
impl Unpin for ListedAccessBuilder
impl UnwindSafe for ListedAccessBuilder
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