@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class ListedAccess extends Object implements Serializable, Cloneable, StructuredPojo
Lists the properties for one or more specified associated accesses.
Constructor and Description |
---|
ListedAccess() |
Modifier and Type | Method and Description |
---|---|
ListedAccess |
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.
|
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 |
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 |
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 |
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.
|
ListedAccess |
withExternalId(String externalId)
A unique identifier that is required to identify specific groups within your directory.
|
ListedAccess |
withHomeDirectory(String homeDirectory)
The landing directory (folder) for a user when they log in to the server using the client.
|
ListedAccess |
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.
|
ListedAccess |
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.
|
ListedAccess |
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 ListedAccess 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 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.
HomeDirectoryType
public 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.
HomeDirectoryType
public ListedAccess 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.
HomeDirectoryType
public ListedAccess 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.
HomeDirectoryType
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 ListedAccess 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 ListedAccess 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 Object
Object.toString()
public ListedAccess clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.