Interface CreateAccessRequest.Builder
-
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<CreateAccessRequest.Builder,CreateAccessRequest>
,SdkBuilder<CreateAccessRequest.Builder,CreateAccessRequest>
,SdkPojo
,SdkRequest.Builder
,TransferRequest.Builder
- Enclosing class:
- CreateAccessRequest
public static interface CreateAccessRequest.Builder extends TransferRequest.Builder, SdkPojo, CopyableBuilder<CreateAccessRequest.Builder,CreateAccessRequest>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method 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(String homeDirectoryType)
The type of landing directory (folder) that you want your users' home directory to be when they log in to the server.CreateAccessRequest.Builder
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.CreateAccessRequest.Builder
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
CreateAccessRequest.Builder
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
CreateAccessRequest.Builder
policy(String policy)
A session policy for your user so that you can use the same Identity and Access Management (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)
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.CreateAccessRequest.Builder
serverId(String serverId)
A system-assigned unique identifier for a server instance.-
Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
-
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
-
Methods inherited from interface software.amazon.awssdk.services.transfer.model.TransferRequest.Builder
build
-
-
-
-
Method Detail
-
homeDirectory
CreateAccessRequest.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
.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
CreateAccessRequest.Builder 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. 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
,HomeDirectoryType
-
homeDirectoryType
CreateAccessRequest.Builder 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. 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
,HomeDirectoryType
-
homeDirectoryMappings
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. 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.The following is an
Entry
andTarget
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 setEntry
to/
and setTarget
to theHomeDirectory
parameter value.The following is an
Entry
andTarget
pair example forchroot
.[ { "Entry": "/", "Target": "/bucket_name/home/mydirectory" } ]
- 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.The following is an
Entry
andTarget
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 setEntry
to/
and setTarget
to theHomeDirectory
parameter value.The following is an
Entry
andTarget
pair example forchroot
.[ { "Entry": "/", "Target": "/bucket_name/home/mydirectory" } ]
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
homeDirectoryMappings
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
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.The following is an
Entry
andTarget
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 setEntry
to/
and setTarget
to theHomeDirectory
parameter value.The following is an
Entry
andTarget
pair example forchroot
.[ { "Entry": "/", "Target": "/bucket_name/home/mydirectory" } ]
- 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.The following is an
Entry
andTarget
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 setEntry
to/
and setTarget
to theHomeDirectory
parameter value.The following is an
Entry
andTarget
pair example forchroot
.[ { "Entry": "/", "Target": "/bucket_name/home/mydirectory" } ]
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
homeDirectoryMappings
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
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.The following is an
Entry
andTarget
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 setEntry
to/
and setTarget
to theHomeDirectory
parameter value.The following is an
Entry
andTarget
pair example forchroot
.[ { "Entry": "/", "Target": "/bucket_name/home/mydirectory" } ]
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 to#homeDirectoryMappings(List
.) - 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:
#homeDirectoryMappings(java.util.Collection
)
-
policy
CreateAccessRequest.Builder policy(String 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}
.This policy applies only when the domain of
ServerId
is Amazon S3. Amazon EFS does not use session policies.For session policies, 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 Security Token Service API Reference.
- 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}
.This policy applies only when the domain of
ServerId
is Amazon S3. Amazon EFS does not use session policies.For session policies, 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 Security Token Service API Reference.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
posixProfile
CreateAccessRequest.Builder posixProfile(PosixProfile posixProfile)
Sets the value of the PosixProfile property for this object.- Parameters:
posixProfile
- The new value for the PosixProfile property for this object.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
posixProfile
default CreateAccessRequest.Builder posixProfile(Consumer<PosixProfile.Builder> posixProfile)
Sets the value of the PosixProfile property for this object. This is a convenience method that creates an instance of thePosixProfile.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:
posixProfile(PosixProfile)
-
role
CreateAccessRequest.Builder role(String 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.
-
serverId
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.
- Parameters:
serverId
- A system-assigned unique identifier for a server instance. This is the specific server that you added your user to.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
externalId
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 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 regular expression 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: =,.@:/-
- Parameters:
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 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 regular expression 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: =,.@:/-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
overrideConfiguration
CreateAccessRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
-
overrideConfiguration
CreateAccessRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
-
-