@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class UpdateAccessRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
NOOP| Constructor and Description |
|---|
UpdateAccessRequest() |
| Modifier and Type | Method and Description |
|---|---|
UpdateAccessRequest |
clone()
Creates a shallow clone of this object for all fields except the handler context.
|
boolean |
equals(Object obj) |
String |
getExternalId()
A unique identifier that is required to identify specific groups within your directory.
|
String |
getHomeDirectory()
The landing directory (folder) for a user when they log in to the server using the client.
|
List<HomeDirectoryMapEntry> |
getHomeDirectoryMappings()
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.
|
String |
getHomeDirectoryType()
The type of landing directory (folder) that you want your users' home directory to be when they log in to the
server.
|
String |
getPolicy()
|
PosixProfile |
getPosixProfile() |
String |
getRole()
Specifies the IAM role that controls your users' access to your Amazon S3 bucket or EFS file system.
|
String |
getServerId()
A system-assigned unique identifier for a server instance.
|
int |
hashCode() |
void |
setExternalId(String externalId)
A unique identifier that is required to identify specific groups within your directory.
|
void |
setHomeDirectory(String homeDirectory)
The landing directory (folder) for a user when they log in to the server using the client.
|
void |
setHomeDirectoryMappings(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.
|
void |
setHomeDirectoryType(String homeDirectoryType)
The type of landing directory (folder) that you want your users' home directory to be when they log in to the
server.
|
void |
setPolicy(String policy)
|
void |
setPosixProfile(PosixProfile posixProfile) |
void |
setRole(String role)
Specifies the IAM role that controls your users' access to your Amazon S3 bucket or EFS file system.
|
void |
setServerId(String serverId)
A system-assigned unique identifier for a server instance.
|
String |
toString()
Returns a string representation of this object.
|
UpdateAccessRequest |
withExternalId(String externalId)
A unique identifier that is required to identify specific groups within your directory.
|
UpdateAccessRequest |
withHomeDirectory(String homeDirectory)
The landing directory (folder) for a user when they log in to the server using the client.
|
UpdateAccessRequest |
withHomeDirectoryMappings(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.
|
UpdateAccessRequest |
withHomeDirectoryMappings(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.
|
UpdateAccessRequest |
withHomeDirectoryType(HomeDirectoryType homeDirectoryType)
The type of landing directory (folder) that you want your users' home directory to be when they log in to the
server.
|
UpdateAccessRequest |
withHomeDirectoryType(String homeDirectoryType)
The type of landing directory (folder) that you want your users' home directory to be when they log in to the
server.
|
UpdateAccessRequest |
withPolicy(String policy)
|
UpdateAccessRequest |
withPosixProfile(PosixProfile posixProfile) |
UpdateAccessRequest |
withRole(String role)
Specifies the IAM role that controls your users' access to your Amazon S3 bucket or EFS file system.
|
UpdateAccessRequest |
withServerId(String serverId)
A system-assigned unique identifier for a server instance.
|
addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeoutpublic void setHomeDirectory(String homeDirectory)
The landing directory (folder) for a user when they log in to the server using the client.
A HomeDirectory example is /directory_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 /directory_name/home/mydirectory.
public String getHomeDirectory()
The landing directory (folder) for a user when they log in to the server using the client.
A HomeDirectory example is /directory_name/home/mydirectory.
A HomeDirectory example is /directory_name/home/mydirectory.
public UpdateAccessRequest withHomeDirectory(String homeDirectory)
The landing directory (folder) for a user when they log in to the server using the client.
A HomeDirectory example is /directory_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 /directory_name/home/mydirectory.
public void setHomeDirectoryType(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 paths as is in their
file transfer protocol clients. If you set it LOGICAL, you must provide mappings in the
HomeDirectoryMappings for how you want to make Amazon S3 paths visible to your users.
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 paths as
is in their file transfer protocol clients. If you set it LOGICAL, you must provide mappings
in the HomeDirectoryMappings for how you want to make Amazon S3 paths visible to your users.HomeDirectoryTypepublic String getHomeDirectoryType()
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 paths as is in their
file transfer protocol clients. If you set it LOGICAL, you must provide mappings in the
HomeDirectoryMappings for how you want to make Amazon S3 paths visible to your users.
PATH, the user will see the absolute Amazon S3 bucket paths as
is in their file transfer protocol clients. If you set it LOGICAL, you must provide mappings
in the HomeDirectoryMappings for how you want to make Amazon S3 paths visible to your users.HomeDirectoryTypepublic UpdateAccessRequest withHomeDirectoryType(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 paths as is in their
file transfer protocol clients. If you set it LOGICAL, you must provide mappings in the
HomeDirectoryMappings for how you want to make Amazon S3 paths visible to your users.
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 paths as
is in their file transfer protocol clients. If you set it LOGICAL, you must provide mappings
in the HomeDirectoryMappings for how you want to make Amazon S3 paths visible to your users.HomeDirectoryTypepublic UpdateAccessRequest withHomeDirectoryType(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 paths as is in their
file transfer protocol clients. If you set it LOGICAL, you must provide mappings in the
HomeDirectoryMappings for how you want to make Amazon S3 paths visible to your users.
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 paths as
is in their file transfer protocol clients. If you set it LOGICAL, you must provide mappings
in the HomeDirectoryMappings for how you want to make Amazon S3 paths visible to your users.HomeDirectoryTypepublic List<HomeDirectoryMapEntry> getHomeDirectoryMappings()
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 will be displayed as is. You also must ensure that your AWS
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": "your-personal-report.pdf", "Target": "/bucket3/customized-reports/${transfer:UserName}.pdf" } ]
In most cases, you can use this value instead of the scope-down 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" } ]
If the target of a logical directory entry does not exist in Amazon S3 or Amazon EFS, the entry will be ignored.
As a workaround, you can use the Amazon S3 API or EFS API to create 0-byte objects as place holders for your
directory. If using the AWS CLI, use the s3api or efsapi call instead of
s3 or efs so you can use the put-object operation. For example, you can
use the following.
aws s3api put-object --bucket bucketname --key path/to/folder/
The end of the key name must end in a / for it to be considered a folder.
Required: No
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 will be
displayed as is. You also must ensure that your AWS 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": "your-personal-report.pdf", "Target": "/bucket3/customized-reports/${transfer:UserName}.pdf" } ]
In most cases, you can use this value instead of the scope-down 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" } ]
If the target of a logical directory entry does not exist in Amazon S3 or Amazon EFS, the entry will be
ignored. As a workaround, you can use the Amazon S3 API or EFS API to create 0-byte objects as place
holders for your directory. If using the AWS CLI, use the s3api or efsapi call
instead of s3 or efs so you can use the put-object operation. For
example, you can use the following.
aws s3api put-object --bucket bucketname --key path/to/folder/
The end of the key name must end in a / for it to be considered a folder.
Required: No
public void setHomeDirectoryMappings(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 will be displayed as is. You also must ensure that your AWS
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": "your-personal-report.pdf", "Target": "/bucket3/customized-reports/${transfer:UserName}.pdf" } ]
In most cases, you can use this value instead of the scope-down 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" } ]
If the target of a logical directory entry does not exist in Amazon S3 or Amazon EFS, the entry will be ignored.
As a workaround, you can use the Amazon S3 API or EFS API to create 0-byte objects as place holders for your
directory. If using the AWS CLI, use the s3api or efsapi call instead of
s3 or efs so you can use the put-object operation. For example, you can
use the following.
aws s3api put-object --bucket bucketname --key path/to/folder/
The end of the key name must end in a / for it to be considered a folder.
Required: No
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 will be
displayed as is. You also must ensure that your AWS 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": "your-personal-report.pdf", "Target": "/bucket3/customized-reports/${transfer:UserName}.pdf" } ]
In most cases, you can use this value instead of the scope-down 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" } ]
If the target of a logical directory entry does not exist in Amazon S3 or Amazon EFS, the entry will be
ignored. As a workaround, you can use the Amazon S3 API or EFS API to create 0-byte objects as place
holders for your directory. If using the AWS CLI, use the s3api or efsapi call
instead of s3 or efs so you can use the put-object operation. For
example, you can use the following.
aws s3api put-object --bucket bucketname --key path/to/folder/
The end of the key name must end in a / for it to be considered a folder.
Required: No
public UpdateAccessRequest withHomeDirectoryMappings(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 will be displayed as is. You also must ensure that your AWS
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": "your-personal-report.pdf", "Target": "/bucket3/customized-reports/${transfer:UserName}.pdf" } ]
In most cases, you can use this value instead of the scope-down 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" } ]
If the target of a logical directory entry does not exist in Amazon S3 or Amazon EFS, the entry will be ignored.
As a workaround, you can use the Amazon S3 API or EFS API to create 0-byte objects as place holders for your
directory. If using the AWS CLI, use the s3api or efsapi call instead of
s3 or efs so you can use the put-object operation. For example, you can
use the following.
aws s3api put-object --bucket bucketname --key path/to/folder/
The end of the key name must end in a / for it to be considered a folder.
Required: No
NOTE: This method appends the values to the existing list (if any). Use
setHomeDirectoryMappings(java.util.Collection) or
withHomeDirectoryMappings(java.util.Collection) if you want to override the existing values.
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 will be
displayed as is. You also must ensure that your AWS 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": "your-personal-report.pdf", "Target": "/bucket3/customized-reports/${transfer:UserName}.pdf" } ]
In most cases, you can use this value instead of the scope-down 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" } ]
If the target of a logical directory entry does not exist in Amazon S3 or Amazon EFS, the entry will be
ignored. As a workaround, you can use the Amazon S3 API or EFS API to create 0-byte objects as place
holders for your directory. If using the AWS CLI, use the s3api or efsapi call
instead of s3 or efs so you can use the put-object operation. For
example, you can use the following.
aws s3api put-object --bucket bucketname --key path/to/folder/
The end of the key name must end in a / for it to be considered a folder.
Required: No
public UpdateAccessRequest withHomeDirectoryMappings(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 will be displayed as is. You also must ensure that your AWS
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": "your-personal-report.pdf", "Target": "/bucket3/customized-reports/${transfer:UserName}.pdf" } ]
In most cases, you can use this value instead of the scope-down 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" } ]
If the target of a logical directory entry does not exist in Amazon S3 or Amazon EFS, the entry will be ignored.
As a workaround, you can use the Amazon S3 API or EFS API to create 0-byte objects as place holders for your
directory. If using the AWS CLI, use the s3api or efsapi call instead of
s3 or efs so you can use the put-object operation. For example, you can
use the following.
aws s3api put-object --bucket bucketname --key path/to/folder/
The end of the key name must end in a / for it to be considered a folder.
Required: No
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 will be
displayed as is. You also must ensure that your AWS 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": "your-personal-report.pdf", "Target": "/bucket3/customized-reports/${transfer:UserName}.pdf" } ]
In most cases, you can use this value instead of the scope-down 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" } ]
If the target of a logical directory entry does not exist in Amazon S3 or Amazon EFS, the entry will be
ignored. As a workaround, you can use the Amazon S3 API or EFS API to create 0-byte objects as place
holders for your directory. If using the AWS CLI, use the s3api or efsapi call
instead of s3 or efs so you can use the put-object operation. For
example, you can use the following.
aws s3api put-object --bucket bucketname --key path/to/folder/
The end of the key name must end in a / for it to be considered a folder.
Required: No
public void setPolicy(String policy)
A scope-down 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 domain of ServerId is S3. Amazon EFS does not use scope down policy.
For scope-down policies, AWS 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 scope-down policy, see Example scope-down policy.
For more information, see AssumeRole in the AWS Security Token Service API Reference.
policy -
A scope-down 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 domain of ServerId is S3. Amazon EFS does not use scope down policy.
For scope-down policies, AWS 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 scope-down policy, see Example scope-down policy.
For more information, see AssumeRole in the AWS Security Token Service API Reference.
public String getPolicy()
A scope-down 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 domain of ServerId is S3. Amazon EFS does not use scope down policy.
For scope-down policies, AWS 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 scope-down policy, see Example scope-down policy.
For more information, see AssumeRole in the AWS Security Token Service API Reference.
A scope-down 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 domain of ServerId is S3. Amazon EFS does not use scope down policy.
For scope-down policies, AWS 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 scope-down policy, see Example scope-down policy.
For more information, see AssumeRole in the AWS Security Token Service API Reference.
public UpdateAccessRequest withPolicy(String policy)
A scope-down 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 domain of ServerId is S3. Amazon EFS does not use scope down policy.
For scope-down policies, AWS 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 scope-down policy, see Example scope-down policy.
For more information, see AssumeRole in the AWS Security Token Service API Reference.
policy -
A scope-down 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 domain of ServerId is S3. Amazon EFS does not use scope down policy.
For scope-down policies, AWS 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 scope-down policy, see Example scope-down policy.
For more information, see AssumeRole in the AWS Security Token Service API Reference.
public void setPosixProfile(PosixProfile posixProfile)
posixProfile - public PosixProfile getPosixProfile()
public UpdateAccessRequest withPosixProfile(PosixProfile posixProfile)
posixProfile - public void setRole(String role)
Specifies 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 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.public String getRole()
Specifies 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.
public UpdateAccessRequest withRole(String role)
Specifies 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 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.public void setServerId(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.public String getServerId()
A system-assigned unique identifier for a server instance. This is the specific server that you added your user to.
public UpdateAccessRequest withServerId(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.public void setExternalId(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 AWS 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 AWS 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: =,.@:/-
public String getExternalId()
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 AWS 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: =,.@:/-
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: =,.@:/-
public UpdateAccessRequest withExternalId(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 AWS 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 AWS 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: =,.@:/-
public String toString()
toString in class ObjectObject.toString()public UpdateAccessRequest clone()
AmazonWebServiceRequestclone in class AmazonWebServiceRequestObject.clone()