public static interface CreateAccessRequest.Builder extends TransferRequest.Builder, SdkPojo, CopyableBuilder<CreateAccessRequest.Builder,CreateAccessRequest>
| Modifier and Type | Method and Description |
|---|---|
CreateAccessRequest.Builder |
externalId(String externalId)
A unique identifier that is required to identify specific groups within your directory.
|
CreateAccessRequest.Builder |
homeDirectory(String homeDirectory)
The landing directory (folder) for a user when they log in to the server using the client.
|
CreateAccessRequest.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.
|
CreateAccessRequest.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.
|
CreateAccessRequest.Builder |
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.
|
CreateAccessRequest.Builder |
homeDirectoryType(HomeDirectoryType homeDirectoryType)
The type of landing directory (folder) you want your users' home directory to be when they log into the
server.
|
CreateAccessRequest.Builder |
homeDirectoryType(String homeDirectoryType)
The type of landing directory (folder) you want your users' home directory to be when they log into the
server.
|
CreateAccessRequest.Builder |
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) |
CreateAccessRequest.Builder |
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) |
CreateAccessRequest.Builder |
policy(String policy)
A session policy for your user so that you can use the same IAM role across multiple users.
|
default CreateAccessRequest.Builder |
posixProfile(Consumer<PosixProfile.Builder> posixProfile)
Sets the value of the PosixProfile property for this object.
|
CreateAccessRequest.Builder |
posixProfile(PosixProfile posixProfile)
Sets the value of the PosixProfile property for this object.
|
CreateAccessRequest.Builder |
role(String role)
Specifies the Amazon Resource Name (ARN) of the IAM role that controls your users' access to your Amazon S3
bucket or EFS file system.
|
CreateAccessRequest.Builder |
serverId(String serverId)
A system-assigned unique identifier for a server instance.
|
buildoverrideConfigurationequalsBySdkFields, sdkFieldscopyapplyMutation, buildCreateAccessRequest.Builder homeDirectory(String 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.
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.
CreateAccessRequest.Builder homeDirectoryType(String 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.
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.HomeDirectoryType,
HomeDirectoryTypeCreateAccessRequest.Builder homeDirectoryType(HomeDirectoryType 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.
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.HomeDirectoryType,
HomeDirectoryTypeCreateAccessRequest.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 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" } ]
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 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" } ]
CreateAccessRequest.Builder 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. 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" } ]
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 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" } ]
CreateAccessRequest.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 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" } ]
List.Builder
avoiding the need to create one manually via List#builder() .
When the Consumer completes, List.Builder#build() is called
immediately and its result is passed to #homeDirectoryMappings(List) .homeDirectoryMappings - a consumer that will call methods on List.Builder #homeDirectoryMappings(List) CreateAccessRequest.Builder policy(String policy)
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.
policy - 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.
CreateAccessRequest.Builder posixProfile(PosixProfile posixProfile)
posixProfile - The new value for the PosixProfile property for this object.default CreateAccessRequest.Builder posixProfile(Consumer<PosixProfile.Builder> posixProfile)
PosixProfile.Builder avoiding the need
to create one manually via PosixProfile.builder().
When the Consumer completes, SdkBuilder.build() is called immediately and its
result is passed to posixProfile(PosixProfile).posixProfile - a consumer that will call methods on PosixProfile.BuilderposixProfile(PosixProfile)CreateAccessRequest.Builder role(String role)
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.
role - 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.CreateAccessRequest.Builder serverId(String serverId)
A system-assigned unique identifier for a server instance. This is the specific server that you added your user to.
serverId - A system-assigned unique identifier for a server instance. This is the specific server that you added
your user to.CreateAccessRequest.Builder externalId(String externalId)
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: =,.@:/-
externalId - 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: =,.@:/-
CreateAccessRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
overrideConfiguration in interface AwsRequest.BuilderCreateAccessRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
overrideConfiguration in interface AwsRequest.BuilderCopyright © 2022. All rights reserved.