[−][src]Struct rusoto_transfer::DescribedUser
Returns properties of the user that you want to describe.
Fields
arn: String
Specifies the unique Amazon Resource Name (ARN) for the user that was requested to be described.
home_directory: Option<String>
Specifies the landing directory (or folder), which is the location that files are written to or read from in an Amazon S3 bucket, for the described user. An example is your-Amazon-S3-bucket-name>/home/username
.
home_directory_mappings: Option<Vec<HomeDirectoryMapEntry>>
Specifies the logical directory mappings that specify what Amazon S3 paths and keys should be visible to your user and how you want to make them visible. You will need to specify the "Entry
" and "Target
" pair, where Entry
shows how the path is made visible and Target
is the actual Amazon S3 path. If you only specify a target, it will be displayed as is. You will need to also make sure that your AWS Identity and Access Management (IAM) role provides access to paths in Target
.
In most cases, you can use this value instead of the scope-down 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.
home_directory_type: Option<String>
Specifies the type of landing directory (folder) you mapped for your users to see when they log into the file transfer protocol-enabled server. If you set it to PATH
, the user will see the absolute Amazon S3 bucket paths as is in their file transfer protocol clients. If you set it LOGICAL
, you will need to provide mappings in the HomeDirectoryMappings
for how you want to make Amazon S3 paths visible to your users.
policy: Option<String>
Specifies the name of the policy in use for the described user.
role: Option<String>
Specifies the IAM role that controls your users' access to your Amazon S3 bucket. The policies attached to this role will determine the level of access you want to provide your users when transferring files into and out of your Amazon S3 bucket or buckets. The IAM role should also contain a trust relationship that allows a file transfer protocol-enabled server to access your resources when servicing your users' transfer requests.
ssh_public_keys: Option<Vec<SshPublicKey>>
Specifies the public key portion of the Secure Shell (SSH) keys stored for the described user.
Specifies the key-value pairs for the user requested. Tag can be used to search for and group users for a variety of purposes.
user_name: 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 file transfer protocol-enabled server.
Trait Implementations
impl Clone for DescribedUser
[src]
fn clone(&self) -> DescribedUser
[src]
fn clone_from(&mut self, source: &Self)
1.0.0[src]
impl Debug for DescribedUser
[src]
impl Default for DescribedUser
[src]
fn default() -> DescribedUser
[src]
impl<'de> Deserialize<'de> for DescribedUser
[src]
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
[src]
__D: Deserializer<'de>,
impl PartialEq<DescribedUser> for DescribedUser
[src]
fn eq(&self, other: &DescribedUser) -> bool
[src]
fn ne(&self, other: &DescribedUser) -> bool
[src]
impl StructuralPartialEq for DescribedUser
[src]
Auto Trait Implementations
impl RefUnwindSafe for DescribedUser
impl Send for DescribedUser
impl Sync for DescribedUser
impl Unpin for DescribedUser
impl UnwindSafe for DescribedUser
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> DeserializeOwned for T where
T: for<'de> Deserialize<'de>,
[src]
T: for<'de> Deserialize<'de>,
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> Same<T> for T
type Output = T
Should always be Self
impl<T> Sealed<T> for T where
T: ?Sized,
T: ?Sized,
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
fn to_owned(&self) -> T
[src]
fn clone_into(&self, target: &mut T)
[src]
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,