@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class DescribedAccess extends Object implements Serializable, Cloneable, StructuredPojo
Describes the properties of the access that was specified.
| Constructor and Description |
|---|
DescribedAccess() |
| Modifier and Type | Method and Description |
|---|---|
DescribedAccess |
clone() |
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()
A session policy for your user so that you can use the same Identity and Access Management (IAM) role across
multiple users.
|
PosixProfile |
getPosixProfile() |
String |
getRole()
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.
|
int |
hashCode() |
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller. |
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)
A session policy for your user so that you can use the same Identity and Access Management (IAM) role across
multiple users.
|
void |
setPosixProfile(PosixProfile posixProfile) |
void |
setRole(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.
|
String |
toString()
Returns a string representation of this object.
|
DescribedAccess |
withExternalId(String externalId)
A unique identifier that is required to identify specific groups within your directory.
|
DescribedAccess |
withHomeDirectory(String homeDirectory)
The landing directory (folder) for a user when they log in to the server using the client.
|
DescribedAccess |
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.
|
DescribedAccess |
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.
|
DescribedAccess |
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.
|
DescribedAccess |
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.
|
DescribedAccess |
withPolicy(String policy)
A session policy for your user so that you can use the same Identity and Access Management (IAM) role across
multiple users.
|
DescribedAccess |
withPosixProfile(PosixProfile posixProfile) |
DescribedAccess |
withRole(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.
|
public 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 /bucket_name/home/mydirectory.
The HomeDirectory parameter is only used if HomeDirectoryType is set to
PATH.
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 if HomeDirectoryType is set to
PATH.
public String getHomeDirectory()
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 if HomeDirectoryType is set to
PATH.
A HomeDirectory example is /bucket_name/home/mydirectory.
The HomeDirectory parameter is only used if HomeDirectoryType is set to
PATH.
public DescribedAccess withHomeDirectory(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 if HomeDirectoryType is set to
PATH.
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 if HomeDirectoryType is set to
PATH.
public 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 is displayed as is. You also must ensure that your Identity and
Access Management (IAM) role provides access to paths in Target. This value can be set only when
HomeDirectoryType is set to LOGICAL.
In most cases, you can use this value instead of the session policy to lock down the associated access to the
designated home directory ("chroot"). To do this, you can set Entry to '/' and set
Target to the HomeDirectory parameter value.
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 Identity and Access Management (IAM) role provides access
to paths in Target. This value can be set only when HomeDirectoryType is set to
LOGICAL.
In most cases, you can use this value instead of the session policy to lock down the associated access to
the designated home directory ("chroot"). To do this, you can set Entry to '/'
and set Target to the HomeDirectory parameter value.
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 is displayed as is. You also must ensure that your Identity and
Access Management (IAM) role provides access to paths in Target. This value can be set only when
HomeDirectoryType is set to LOGICAL.
In most cases, you can use this value instead of the session policy to lock down the associated access to the
designated home directory ("chroot"). To do this, you can set Entry to '/' and set
Target to the HomeDirectory parameter value.
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 Identity and Access Management (IAM) role provides access
to paths in Target. This value can be set only when HomeDirectoryType is set to
LOGICAL.
In most cases, you can use this value instead of the session policy to lock down the associated access to
the designated home directory ("chroot"). To do this, you can set Entry to '/'
and set Target to the HomeDirectory parameter value.
public DescribedAccess 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 is displayed as is. You also must ensure that your Identity and
Access Management (IAM) role provides access to paths in Target. This value can be set only when
HomeDirectoryType is set to LOGICAL.
In most cases, you can use this value instead of the session policy to lock down the associated access to the
designated home directory ("chroot"). To do this, you can set Entry to '/' and set
Target to the HomeDirectory parameter value.
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 is
displayed as is. You also must ensure that your Identity and Access Management (IAM) role provides access
to paths in Target. This value can be set only when HomeDirectoryType is set to
LOGICAL.
In most cases, you can use this value instead of the session policy to lock down the associated access to
the designated home directory ("chroot"). To do this, you can set Entry to '/'
and set Target to the HomeDirectory parameter value.
public DescribedAccess 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 is displayed as is. You also must ensure that your Identity and
Access Management (IAM) role provides access to paths in Target. This value can be set only when
HomeDirectoryType is set to LOGICAL.
In most cases, you can use this value instead of the session policy to lock down the associated access to the
designated home directory ("chroot"). To do this, you can set Entry to '/' and set
Target to the HomeDirectory parameter value.
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 Identity and Access Management (IAM) role provides access
to paths in Target. This value can be set only when HomeDirectoryType is set to
LOGICAL.
In most cases, you can use this value instead of the session policy to lock down the associated access to
the designated home directory ("chroot"). To do this, you can set Entry to '/'
and set Target to the HomeDirectory parameter value.
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 or Amazon EFS path as
is in their file transfer protocol clients. If you set it to LOGICAL, you need to provide mappings
in the HomeDirectoryMappings for how you want to make Amazon S3 or Amazon EFS paths visible to your
users.
If HomeDirectoryType is LOGICAL, you must provide mappings, using the
HomeDirectoryMappings parameter. If, on the other hand, HomeDirectoryType is
PATH, you provide an absolute path using the HomeDirectory parameter. You cannot have
both HomeDirectory and HomeDirectoryMappings in your template.
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 to LOGICAL, you need to
provide mappings in the HomeDirectoryMappings for how you want to make Amazon S3 or Amazon
EFS paths visible to your users.
If HomeDirectoryType is LOGICAL, you must provide mappings, using the
HomeDirectoryMappings parameter. If, on the other hand, HomeDirectoryType is
PATH, you provide an absolute path using the HomeDirectory parameter. You cannot
have both HomeDirectory and HomeDirectoryMappings in your template.
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 or Amazon EFS path as
is in their file transfer protocol clients. If you set it to LOGICAL, you need to provide mappings
in the HomeDirectoryMappings for how you want to make Amazon S3 or Amazon EFS paths visible to your
users.
If HomeDirectoryType is LOGICAL, you must provide mappings, using the
HomeDirectoryMappings parameter. If, on the other hand, HomeDirectoryType is
PATH, you provide an absolute path using the HomeDirectory parameter. You cannot have
both HomeDirectory and HomeDirectoryMappings in your template.
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 to LOGICAL, you need
to provide mappings in the HomeDirectoryMappings for how you want to make Amazon S3 or
Amazon EFS paths visible to your users.
If HomeDirectoryType is LOGICAL, you must provide mappings, using the
HomeDirectoryMappings parameter. If, on the other hand, HomeDirectoryType is
PATH, you provide an absolute path using the HomeDirectory parameter. You
cannot have both HomeDirectory and HomeDirectoryMappings in your template.
HomeDirectoryTypepublic DescribedAccess 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 or Amazon EFS path as
is in their file transfer protocol clients. If you set it to LOGICAL, you need to provide mappings
in the HomeDirectoryMappings for how you want to make Amazon S3 or Amazon EFS paths visible to your
users.
If HomeDirectoryType is LOGICAL, you must provide mappings, using the
HomeDirectoryMappings parameter. If, on the other hand, HomeDirectoryType is
PATH, you provide an absolute path using the HomeDirectory parameter. You cannot have
both HomeDirectory and HomeDirectoryMappings in your template.
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 to LOGICAL, you need to
provide mappings in the HomeDirectoryMappings for how you want to make Amazon S3 or Amazon
EFS paths visible to your users.
If HomeDirectoryType is LOGICAL, you must provide mappings, using the
HomeDirectoryMappings parameter. If, on the other hand, HomeDirectoryType is
PATH, you provide an absolute path using the HomeDirectory parameter. You cannot
have both HomeDirectory and HomeDirectoryMappings in your template.
HomeDirectoryTypepublic DescribedAccess 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 or Amazon EFS path as
is in their file transfer protocol clients. If you set it to LOGICAL, you need to provide mappings
in the HomeDirectoryMappings for how you want to make Amazon S3 or Amazon EFS paths visible to your
users.
If HomeDirectoryType is LOGICAL, you must provide mappings, using the
HomeDirectoryMappings parameter. If, on the other hand, HomeDirectoryType is
PATH, you provide an absolute path using the HomeDirectory parameter. You cannot have
both HomeDirectory and HomeDirectoryMappings in your template.
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 to LOGICAL, you need to
provide mappings in the HomeDirectoryMappings for how you want to make Amazon S3 or Amazon
EFS paths visible to your users.
If HomeDirectoryType is LOGICAL, you must provide mappings, using the
HomeDirectoryMappings parameter. If, on the other hand, HomeDirectoryType is
PATH, you provide an absolute path using the HomeDirectory parameter. You cannot
have both HomeDirectory and HomeDirectoryMappings in your template.
HomeDirectoryTypepublic void setPolicy(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}.
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}.public String getPolicy()
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}.
${Transfer:UserName},
${Transfer:HomeDirectory}, and ${Transfer:HomeBucket}.public DescribedAccess withPolicy(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}.
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}.public void setPosixProfile(PosixProfile posixProfile)
posixProfile - public PosixProfile getPosixProfile()
public DescribedAccess withPosixProfile(PosixProfile posixProfile)
posixProfile - public void setRole(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.
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.public String getRole()
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.
public DescribedAccess withRole(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.
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.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 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: =,.@:/-
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: =,.@:/-
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 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: =,.@:/-
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: =,.@:/-
public DescribedAccess 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 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: =,.@:/-
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: =,.@:/-
public String toString()
toString in class ObjectObject.toString()public DescribedAccess clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojoProtocolMarshaller.marshall in interface StructuredPojoprotocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.