Interface ListedUser.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<ListedUser.Builder,
,ListedUser> SdkBuilder<ListedUser.Builder,
,ListedUser> SdkPojo
- Enclosing class:
ListedUser
-
Method Summary
Modifier and TypeMethodDescriptionProvides the unique Amazon Resource Name (ARN) for the user that you want to learn about.homeDirectory
(String homeDirectory) The landing directory (folder) for a user when they log in to the server using the client.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.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.sshPublicKeyCount
(Integer sshPublicKeyCount) Specifies the number of SSH public keys stored for the user you specified.Specifies the name of the user whose ARN was specified.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
Provides the unique Amazon Resource Name (ARN) for the user that you want to learn about.
- Parameters:
arn
- Provides the unique Amazon Resource Name (ARN) for the user that you want to learn about.- 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.
-
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:
-
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.
The IAM role that controls your users' access to your Amazon S3 bucket for servers with
Domain=S3
, or your EFS file system for servers withDomain=EFS
.The policies attached to this role determine the level of access you want to provide your users when transferring files into and out of your S3 buckets or EFS file systems.
- 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.The IAM role that controls your users' access to your Amazon S3 bucket for servers with
Domain=S3
, or your EFS file system for servers withDomain=EFS
.The policies attached to this role determine the level of access you want to provide your users when transferring files into and out of your S3 buckets or EFS file systems.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
sshPublicKeyCount
Specifies the number of SSH public keys stored for the user you specified.
- Parameters:
sshPublicKeyCount
- Specifies the number of SSH public keys stored for the user you specified.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
userName
Specifies the name of the user whose ARN was specified. User names are used for authentication purposes.
- Parameters:
userName
- Specifies the name of the user whose ARN was specified. User names are used for authentication purposes.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-