Struct aws_sdk_transfer::input::CreateUserInput
source · [−]#[non_exhaustive]pub struct CreateUserInput {
pub home_directory: Option<String>,
pub home_directory_type: Option<HomeDirectoryType>,
pub home_directory_mappings: Option<Vec<HomeDirectoryMapEntry>>,
pub policy: Option<String>,
pub posix_profile: Option<PosixProfile>,
pub role: Option<String>,
pub server_id: Option<String>,
pub ssh_public_key_body: Option<String>,
pub tags: Option<Vec<Tag>>,
pub user_name: Option<String>,
}
Fields (Non-exhaustive)
This struct is marked as non-exhaustive
Struct { .. }
syntax; cannot be matched against without a wildcard ..
; and struct update syntax will not work.home_directory: 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
.
home_directory_type: Option<HomeDirectoryType>
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.
home_directory_mappings: 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 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 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.
The following is an Entry
and Target
pair example for chroot
.
[ { "Entry:": "/", "Target": "/bucket_name/home/mydirectory" } ]
policy: Option<String>
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 Services Security Token Service API Reference.
posix_profile: 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 EFS file systems. The POSIX permissions that are set on files and directories in Amazon EFS determine the level of access your users get when transferring files into and out of your Amazon EFS file systems.
role: Option<String>
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.
server_id: Option<String>
A system-assigned unique identifier for a server instance. This is the specific server that you added your user to.
ssh_public_key_body: Option<String>
The public portion of the Secure Shell (SSH) key used to authenticate the user to the server.
Currently, Transfer Family does not accept elliptical curve keys (keys beginning with ecdsa
).
Key-value pairs that can be used to group and search for users. Tags are metadata attached to users for any purpose.
user_name: Option<String>
A unique string that identifies a user and is associated with a ServerId
. This user name must be a minimum of 3 and a maximum of 100 characters long. The following are valid characters: a-z, A-Z, 0-9, underscore '_', hyphen '-', period '.', and at sign '@'. The user name can't start with a hyphen, period, or at sign.
Implementations
sourceimpl CreateUserInput
impl CreateUserInput
sourcepub async fn make_operation(
&self,
_config: &Config
) -> Result<Operation<CreateUser, AwsErrorRetryPolicy>, BuildError>
pub async fn make_operation(
&self,
_config: &Config
) -> Result<Operation<CreateUser, AwsErrorRetryPolicy>, BuildError>
Consumes the builder and constructs an Operation<CreateUser
>
sourcepub fn builder() -> Builder
pub fn builder() -> Builder
Creates a new builder-style object to manufacture CreateUserInput
sourceimpl CreateUserInput
impl CreateUserInput
sourcepub fn home_directory(&self) -> Option<&str>
pub fn home_directory(&self) -> Option<&str>
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) -> Option<&HomeDirectoryType>
pub fn home_directory_type(&self) -> Option<&HomeDirectoryType>
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) -> Option<&[HomeDirectoryMapEntry]>
pub fn home_directory_mappings(&self) -> Option<&[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 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 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.
The following is an Entry
and Target
pair example for chroot
.
[ { "Entry:": "/", "Target": "/bucket_name/home/mydirectory" } ]
sourcepub fn policy(&self) -> Option<&str>
pub fn policy(&self) -> Option<&str>
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 Services Security Token Service API Reference.
sourcepub fn posix_profile(&self) -> Option<&PosixProfile>
pub fn 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 EFS file systems. The POSIX permissions that are set on files and directories in Amazon EFS determine the level of access your users get when transferring files into and out of your Amazon EFS file systems.
sourcepub fn role(&self) -> Option<&str>
pub fn role(&self) -> Option<&str>
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) -> Option<&str>
pub fn server_id(&self) -> Option<&str>
A system-assigned unique identifier for a server instance. This is the specific server that you added your user to.
sourcepub fn ssh_public_key_body(&self) -> Option<&str>
pub fn ssh_public_key_body(&self) -> Option<&str>
The public portion of the Secure Shell (SSH) key used to authenticate the user to the server.
Currently, Transfer Family does not accept elliptical curve keys (keys beginning with ecdsa
).
Key-value pairs that can be used to group and search for users. Tags are metadata attached to users for any purpose.
sourcepub fn user_name(&self) -> Option<&str>
pub fn user_name(&self) -> Option<&str>
A unique string that identifies a user and is associated with a ServerId
. This user name must be a minimum of 3 and a maximum of 100 characters long. The following are valid characters: a-z, A-Z, 0-9, underscore '_', hyphen '-', period '.', and at sign '@'. The user name can't start with a hyphen, period, or at sign.
Trait Implementations
sourceimpl Clone for CreateUserInput
impl Clone for CreateUserInput
sourcefn clone(&self) -> CreateUserInput
fn clone(&self) -> CreateUserInput
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
sourceimpl Debug for CreateUserInput
impl Debug for CreateUserInput
sourceimpl PartialEq<CreateUserInput> for CreateUserInput
impl PartialEq<CreateUserInput> for CreateUserInput
sourcefn eq(&self, other: &CreateUserInput) -> bool
fn eq(&self, other: &CreateUserInput) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
sourcefn ne(&self, other: &CreateUserInput) -> bool
fn ne(&self, other: &CreateUserInput) -> bool
This method tests for !=
.
impl StructuralPartialEq for CreateUserInput
Auto Trait Implementations
impl RefUnwindSafe for CreateUserInput
impl Send for CreateUserInput
impl Sync for CreateUserInput
impl Unpin for CreateUserInput
impl UnwindSafe for CreateUserInput
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