Interface DescribedUser.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<DescribedUser.Builder,
,DescribedUser> SdkBuilder<DescribedUser.Builder,
,DescribedUser> SdkPojo
- Enclosing class:
DescribedUser
-
Method Summary
Modifier and TypeMethodDescriptionSpecifies the unique Amazon Resource Name (ARN) for the user that was requested to be described.homeDirectory
(String homeDirectory) The landing directory (folder) for a user when they log in to the server using the client.homeDirectoryMappings
(Collection<HomeDirectoryMapEntry> homeDirectoryMappings) 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.homeDirectoryMappings
(Consumer<HomeDirectoryMapEntry.Builder>... homeDirectoryMappings) 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.homeDirectoryMappings
(HomeDirectoryMapEntry... homeDirectoryMappings) 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.homeDirectoryType
(String homeDirectoryType) The type of landing directory (folder) that you want your users' home directory to be when they log in to the server.homeDirectoryType
(HomeDirectoryType homeDirectoryType) The type of landing directory (folder) that you want your users' home directory to be when they log in to the server.A session policy for your user so that you can use the same Identity and Access Management (IAM) role across multiple users.default DescribedUser.Builder
posixProfile
(Consumer<PosixProfile.Builder> 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 Elastic File System (Amazon EFS) file systems.posixProfile
(PosixProfile 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 Elastic File System (Amazon EFS) file systems.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.sshPublicKeys
(Collection<SshPublicKey> sshPublicKeys) Specifies the public key portion of the Secure Shell (SSH) keys stored for the described user.sshPublicKeys
(Consumer<SshPublicKey.Builder>... sshPublicKeys) Specifies the public key portion of the Secure Shell (SSH) keys stored for the described user.sshPublicKeys
(SshPublicKey... sshPublicKeys) Specifies the public key portion of the Secure Shell (SSH) keys stored for the described user.tags
(Collection<Tag> tags) Specifies the key-value pairs for the user requested.tags
(Consumer<Tag.Builder>... tags) Specifies the key-value pairs for the user requested.Specifies the key-value pairs for the user requested.Specifies the name of the user that was requested to be described.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
arn
Specifies the unique Amazon Resource Name (ARN) for the user that was requested to be described.
- Parameters:
arn
- Specifies the unique Amazon Resource Name (ARN) for the user that was requested to be described.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
homeDirectory
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 ifHomeDirectoryType
is set toPATH
.- Parameters:
homeDirectory
- 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 ifHomeDirectoryType
is set toPATH
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
homeDirectoryMappings
DescribedUser.Builder homeDirectoryMappings(Collection<HomeDirectoryMapEntry> homeDirectoryMappings) 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
andTarget
pair, whereEntry
shows how the path is made visible andTarget
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 Identity and Access Management (IAM) role provides access to paths inTarget
. This value can be set only whenHomeDirectoryType
is set to LOGICAL.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 setEntry
to '/' and setTarget
to the HomeDirectory parameter value.- Parameters:
homeDirectoryMappings
- 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 theEntry
andTarget
pair, whereEntry
shows how the path is made visible andTarget
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 Identity and Access Management (IAM) role provides access to paths inTarget
. This value can be set only whenHomeDirectoryType
is set to LOGICAL.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 setEntry
to '/' and setTarget
to the HomeDirectory parameter value.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
homeDirectoryMappings
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
andTarget
pair, whereEntry
shows how the path is made visible andTarget
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 Identity and Access Management (IAM) role provides access to paths inTarget
. This value can be set only whenHomeDirectoryType
is set to LOGICAL.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 setEntry
to '/' and setTarget
to the HomeDirectory parameter value.- Parameters:
homeDirectoryMappings
- 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 theEntry
andTarget
pair, whereEntry
shows how the path is made visible andTarget
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 Identity and Access Management (IAM) role provides access to paths inTarget
. This value can be set only whenHomeDirectoryType
is set to LOGICAL.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 setEntry
to '/' and setTarget
to the HomeDirectory parameter value.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
homeDirectoryMappings
DescribedUser.Builder homeDirectoryMappings(Consumer<HomeDirectoryMapEntry.Builder>... homeDirectoryMappings) 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
andTarget
pair, whereEntry
shows how the path is made visible andTarget
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 Identity and Access Management (IAM) role provides access to paths inTarget
. This value can be set only whenHomeDirectoryType
is set to LOGICAL.In most cases, you can use this value instead of the session policy to lock your user down to the designated home directory ("
This is a convenience method that creates an instance of thechroot
"). To do this, you can setEntry
to '/' and setTarget
to the HomeDirectory parameter value.HomeDirectoryMapEntry.Builder
avoiding the need to create one manually viaHomeDirectoryMapEntry.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tohomeDirectoryMappings(List<HomeDirectoryMapEntry>)
.- Parameters:
homeDirectoryMappings
- a consumer that will call methods onHomeDirectoryMapEntry.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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 toLOGICAL
, you need to provide mappings in theHomeDirectoryMappings
for how you want to make Amazon S3 or Amazon EFS paths visible to your users.If
HomeDirectoryType
isLOGICAL
, you must provide mappings, using theHomeDirectoryMappings
parameter. If, on the other hand,HomeDirectoryType
isPATH
, you provide an absolute path using theHomeDirectory
parameter. You cannot have bothHomeDirectory
andHomeDirectoryMappings
in your template.- Parameters:
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 toPATH
, 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 toLOGICAL
, you need to provide mappings in theHomeDirectoryMappings
for how you want to make Amazon S3 or Amazon EFS paths visible to your users.If
HomeDirectoryType
isLOGICAL
, you must provide mappings, using theHomeDirectoryMappings
parameter. If, on the other hand,HomeDirectoryType
isPATH
, you provide an absolute path using theHomeDirectory
parameter. You cannot have bothHomeDirectory
andHomeDirectoryMappings
in your template.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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 toLOGICAL
, you need to provide mappings in theHomeDirectoryMappings
for how you want to make Amazon S3 or Amazon EFS paths visible to your users.If
HomeDirectoryType
isLOGICAL
, you must provide mappings, using theHomeDirectoryMappings
parameter. If, on the other hand,HomeDirectoryType
isPATH
, you provide an absolute path using theHomeDirectory
parameter. You cannot have bothHomeDirectory
andHomeDirectoryMappings
in your template.- Parameters:
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 toPATH
, 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 toLOGICAL
, you need to provide mappings in theHomeDirectoryMappings
for how you want to make Amazon S3 or Amazon EFS paths visible to your users.If
HomeDirectoryType
isLOGICAL
, you must provide mappings, using theHomeDirectoryMappings
parameter. If, on the other hand,HomeDirectoryType
isPATH
, you provide an absolute path using theHomeDirectory
parameter. You cannot have bothHomeDirectory
andHomeDirectoryMappings
in your template.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
policy
A session policy for your user so that you can use the same Identity and Access Management (IAM) role across multiple users. This policy scopes down a user's access to portions of their Amazon S3 bucket. Variables that you can use inside this policy include
${Transfer:UserName}
,${Transfer:HomeDirectory}
, and${Transfer:HomeBucket}
.- Parameters:
policy
- A session policy for your user so that you can use the same Identity and Access Management (IAM) role across multiple users. This policy scopes down a user's access to portions of their Amazon S3 bucket. Variables that you can use inside this policy include${Transfer:UserName}
,${Transfer:HomeDirectory}
, and${Transfer:HomeBucket}
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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 Elastic File System (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.- Parameters:
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 Elastic File System (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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
posixProfile
Specifies the full POSIX identity, including user ID (
This is a convenience method that creates an instance of theUid
), group ID (Gid
), and any secondary groups IDs (SecondaryGids
), that controls your users' access to your Amazon Elastic File System (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.PosixProfile.Builder
avoiding the need to create one manually viaPosixProfile.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toposixProfile(PosixProfile)
.- Parameters:
posixProfile
- a consumer that will call methods onPosixProfile.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
role
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.
- Parameters:
role
- 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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
sshPublicKeys
Specifies the public key portion of the Secure Shell (SSH) keys stored for the described user.
- Parameters:
sshPublicKeys
- Specifies the public key portion of the Secure Shell (SSH) keys stored for the described user.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
sshPublicKeys
Specifies the public key portion of the Secure Shell (SSH) keys stored for the described user.
- Parameters:
sshPublicKeys
- Specifies the public key portion of the Secure Shell (SSH) keys stored for the described user.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
sshPublicKeys
Specifies the public key portion of the Secure Shell (SSH) keys stored for the described user.
This is a convenience method that creates an instance of theSshPublicKey.Builder
avoiding the need to create one manually viaSshPublicKey.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tosshPublicKeys(List<SshPublicKey>)
.- Parameters:
sshPublicKeys
- a consumer that will call methods onSshPublicKey.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
tags
Specifies the key-value pairs for the user requested. Tag can be used to search for and group users for a variety of purposes.
- Parameters:
tags
- Specifies the key-value pairs for the user requested. Tag can be used to search for and group users for a variety of purposes.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tags
Specifies the key-value pairs for the user requested. Tag can be used to search for and group users for a variety of purposes.
- Parameters:
tags
- Specifies the key-value pairs for the user requested. Tag can be used to search for and group users for a variety of purposes.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tags
Specifies the key-value pairs for the user requested. Tag can be used to search for and group users for a variety of purposes.
This is a convenience method that creates an instance of theTag.Builder
avoiding the need to create one manually viaTag.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed totags(List<Tag>)
.- Parameters:
tags
- a consumer that will call methods onTag.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
userName
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 server.
- Parameters:
userName
- 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 server.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-