Struct aws_sdk_transfer::client::fluent_builders::UpdateAccess
source · [−]pub struct UpdateAccess { /* private fields */ }
Expand description
Fluent builder constructing a request to UpdateAccess
.
Allows you to update parameters for the access specified in the ServerID
and ExternalID
parameters.
Implementations
sourceimpl UpdateAccess
impl UpdateAccess
sourcepub async fn send(
self
) -> Result<UpdateAccessOutput, SdkError<UpdateAccessError>>
pub async fn send(
self
) -> Result<UpdateAccessOutput, SdkError<UpdateAccessError>>
Sends the request and returns the response.
If an error occurs, an SdkError
will be returned with additional details that
can be matched against.
By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.
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
.
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
.
sourcepub fn home_directory_type(self, input: HomeDirectoryType) -> Self
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.
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) 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.
sourcepub fn home_directory_mappings(self, input: HomeDirectoryMapEntry) -> Self
pub fn home_directory_mappings(self, input: HomeDirectoryMapEntry) -> Self
Appends an item to HomeDirectoryMappings
.
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.
The following is an Entry
and Target
pair example.
[ { "Entry": "/directory1", "Target": "/bucket_name/home/mydirectory" } ]
In most cases, you can use this value instead of the session policy to lock down your user to the designated home directory ("chroot
"). To do this, you can set Entry
to /
and set Target
to the HomeDirectory
parameter value.
The following is an Entry
and Target
pair example for chroot
.
[ { "Entry": "/", "Target": "/bucket_name/home/mydirectory" } ]
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 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.
The following is an Entry
and Target
pair example.
[ { "Entry": "/directory1", "Target": "/bucket_name/home/mydirectory" } ]
In most cases, you can use this value instead of the session policy to lock down your user to the designated home directory ("chroot
"). To do this, you can set Entry
to /
and set Target
to the HomeDirectory
parameter value.
The following is an Entry
and Target
pair example for chroot
.
[ { "Entry": "/", "Target": "/bucket_name/home/mydirectory" } ]
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 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}
.
This only applies when the domain of ServerId
is S3. EFS does not use session policies.
For session policies, Amazon Web Services Transfer Family stores the policy as a JSON blob, instead of the Amazon Resource Name (ARN) of the policy. You save the policy as a JSON blob and pass it in the Policy
argument.
For an example of a session policy, see Example session policy.
For more information, see AssumeRole in the Amazon Web ServicesSecurity Token Service API Reference.
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 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}
.
This only applies when the domain of ServerId
is S3. EFS does not use session policies.
For session policies, Amazon Web Services Transfer Family stores the policy as a JSON blob, instead of the Amazon Resource Name (ARN) of the policy. You save the policy as a JSON blob and pass it in the Policy
argument.
For an example of a session policy, see Example session policy.
For more information, see AssumeRole in the Amazon Web ServicesSecurity Token Service API Reference.
sourcepub fn posix_profile(self, input: PosixProfile) -> Self
pub fn posix_profile(self, input: PosixProfile) -> Self
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 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
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 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
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.
sourcepub fn set_role(self, input: Option<String>) -> Self
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.
sourcepub fn server_id(self, input: impl Into<String>) -> Self
pub fn server_id(self, input: impl Into<String>) -> Self
A system-assigned unique identifier for a server instance. This is the specific server that you added your user to.
sourcepub fn set_server_id(self, input: Option<String>) -> Self
pub fn set_server_id(self, input: Option<String>) -> Self
A system-assigned unique identifier for a server instance. This is the specific server that you added your user to.
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 Amazon Web Services 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 regex 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 Amazon Web Services 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 regex 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: =,.@:/-
Trait Implementations
sourceimpl Clone for UpdateAccess
impl Clone for UpdateAccess
sourcefn clone(&self) -> UpdateAccess
fn clone(&self) -> UpdateAccess
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
Auto Trait Implementations
impl !RefUnwindSafe for UpdateAccess
impl Send for UpdateAccess
impl Sync for UpdateAccess
impl Unpin for UpdateAccess
impl !UnwindSafe for UpdateAccess
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more