@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 might be required when you assume a role in another account.
|
String |
getHomeDirectory()
Specifies the landing directory (or folder), which is the location that files are written to or read from in an
Amazon S3 bucket, for the described access.
|
List<HomeDirectoryMapEntry> |
getHomeDirectoryMappings()
Specifies the logical directory mappings that specify what Amazon S3 or Amazon EFS paths and keys should be
visible to the associated access 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 scope-down policy for your user so that you can use the same AWS Identity and Access Management (IAM) role
across multiple users.
|
PosixProfile |
getPosixProfile() |
String |
getRole()
The IAM role that controls access to your Amazon S3 bucket from the specified associated access.
|
int |
hashCode() |
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
void |
setExternalId(String externalId)
A unique identifier that might be required when you assume a role in another account.
|
void |
setHomeDirectory(String homeDirectory)
Specifies the landing directory (or folder), which is the location that files are written to or read from in an
Amazon S3 bucket, for the described access.
|
void |
setHomeDirectoryMappings(Collection<HomeDirectoryMapEntry> homeDirectoryMappings)
Specifies the logical directory mappings that specify what Amazon S3 or Amazon EFS paths and keys should be
visible to the associated access 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 scope-down policy for your user so that you can use the same AWS Identity and Access Management (IAM) role
across multiple users.
|
void |
setPosixProfile(PosixProfile posixProfile) |
void |
setRole(String role)
The IAM role that controls access to your Amazon S3 bucket from the specified associated access.
|
String |
toString()
Returns a string representation of this object.
|
DescribedAccess |
withExternalId(String externalId)
A unique identifier that might be required when you assume a role in another account.
|
DescribedAccess |
withHomeDirectory(String homeDirectory)
Specifies the landing directory (or folder), which is the location that files are written to or read from in an
Amazon S3 bucket, for the described access.
|
DescribedAccess |
withHomeDirectoryMappings(Collection<HomeDirectoryMapEntry> homeDirectoryMappings)
Specifies the logical directory mappings that specify what Amazon S3 or Amazon EFS paths and keys should be
visible to the associated access and how you want to make them visible.
|
DescribedAccess |
withHomeDirectoryMappings(HomeDirectoryMapEntry... homeDirectoryMappings)
Specifies the logical directory mappings that specify what Amazon S3 or Amazon EFS paths and keys should be
visible to the associated access 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 scope-down policy for your user so that you can use the same AWS Identity and Access Management (IAM) role
across multiple users.
|
DescribedAccess |
withPosixProfile(PosixProfile posixProfile) |
DescribedAccess |
withRole(String role)
The IAM role that controls access to your Amazon S3 bucket from the specified associated access.
|
public void setHomeDirectory(String homeDirectory)
Specifies the landing directory (or folder), which is the location that files are written to or read from in an Amazon S3 bucket, for the described access.
homeDirectory
- Specifies the landing directory (or folder), which is the location that files are written to or read from
in an Amazon S3 bucket, for the described access.public String getHomeDirectory()
Specifies the landing directory (or folder), which is the location that files are written to or read from in an Amazon S3 bucket, for the described access.
public DescribedAccess withHomeDirectory(String homeDirectory)
Specifies the landing directory (or folder), which is the location that files are written to or read from in an Amazon S3 bucket, for the described access.
homeDirectory
- Specifies the landing directory (or folder), which is the location that files are written to or read from
in an Amazon S3 bucket, for the described access.public List<HomeDirectoryMapEntry> getHomeDirectoryMappings()
Specifies the logical directory mappings that specify what Amazon S3 or Amazon EFS paths and keys should be
visible to the associated access 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 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
.
In most cases, you can use this value instead of the scope-down 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 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
.
In most cases, you can use this value instead of the scope-down 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)
Specifies the logical directory mappings that specify what Amazon S3 or Amazon EFS paths and keys should be
visible to the associated access 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 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
.
In most cases, you can use this value instead of the scope-down 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
- Specifies the logical directory mappings that specify what Amazon S3 or Amazon EFS paths and keys should
be visible to the associated access 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 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
.
In most cases, you can use this value instead of the scope-down 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)
Specifies the logical directory mappings that specify what Amazon S3 or Amazon EFS paths and keys should be
visible to the associated access 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 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
.
In most cases, you can use this value instead of the scope-down 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
- Specifies the logical directory mappings that specify what Amazon S3 or Amazon EFS paths and keys should
be visible to the associated access 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 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
.
In most cases, you can use this value instead of the scope-down 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)
Specifies the logical directory mappings that specify what Amazon S3 or Amazon EFS paths and keys should be
visible to the associated access 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 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
.
In most cases, you can use this value instead of the scope-down 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
- Specifies the logical directory mappings that specify what Amazon S3 or Amazon EFS paths and keys should
be visible to the associated access 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 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
.
In most cases, you can use this value instead of the scope-down 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 paths as is in their
file transfer protocol clients. If you set it to 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 to LOGICAL
, you must provide
mappings in the HomeDirectoryMappings
for how you want to make Amazon S3 paths visible to
your users.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 paths as is in their
file transfer protocol clients. If you set it to 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 to LOGICAL
, you must provide
mappings in the HomeDirectoryMappings
for how you want to make Amazon S3 paths visible to
your users.HomeDirectoryType
public 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 paths as is in their
file transfer protocol clients. If you set it to 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 to LOGICAL
, you must provide
mappings in the HomeDirectoryMappings
for how you want to make Amazon S3 paths visible to
your users.HomeDirectoryType
public 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 paths as is in their
file transfer protocol clients. If you set it to 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 to LOGICAL
, you must provide
mappings in the HomeDirectoryMappings
for how you want to make Amazon S3 paths visible to
your users.HomeDirectoryType
public void setPolicy(String policy)
A scope-down policy for your user so that you can use the same AWS Identity and Access Management (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}
.
policy
- A scope-down policy for your user so that you can use the same AWS Identity and Access Management (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}
.public String getPolicy()
A scope-down policy for your user so that you can use the same AWS Identity and Access Management (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}
.
${Transfer:UserName}
,
${Transfer:HomeDirectory}
, and ${Transfer:HomeBucket}
.public DescribedAccess withPolicy(String policy)
A scope-down policy for your user so that you can use the same AWS Identity and Access Management (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}
.
policy
- A scope-down policy for your user so that you can use the same AWS Identity and Access Management (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}
.public void setPosixProfile(PosixProfile posixProfile)
posixProfile
- public PosixProfile getPosixProfile()
public DescribedAccess withPosixProfile(PosixProfile posixProfile)
posixProfile
- public void setRole(String role)
The IAM role that controls access to your Amazon S3 bucket from the specified associated access. The policies attached to this role will determine the level of access that you want to provide the associated access when transferring files into and out of your Amazon S3 bucket or buckets. The IAM role should also contain a trust relationship that allows a server to access your resources when servicing transfer requests for the associated access.
role
- The IAM role that controls access to your Amazon S3 bucket from the specified associated access. The
policies attached to this role will determine the level of access that you want to provide the associated
access when transferring files into and out of your Amazon S3 bucket or buckets. The IAM role should also
contain a trust relationship that allows a server to access your resources when servicing transfer
requests for the associated access.public String getRole()
The IAM role that controls access to your Amazon S3 bucket from the specified associated access. The policies attached to this role will determine the level of access that you want to provide the associated access when transferring files into and out of your Amazon S3 bucket or buckets. The IAM role should also contain a trust relationship that allows a server to access your resources when servicing transfer requests for the associated access.
public DescribedAccess withRole(String role)
The IAM role that controls access to your Amazon S3 bucket from the specified associated access. The policies attached to this role will determine the level of access that you want to provide the associated access when transferring files into and out of your Amazon S3 bucket or buckets. The IAM role should also contain a trust relationship that allows a server to access your resources when servicing transfer requests for the associated access.
role
- The IAM role that controls access to your Amazon S3 bucket from the specified associated access. The
policies attached to this role will determine the level of access that you want to provide the associated
access when transferring files into and out of your Amazon S3 bucket or buckets. The IAM role should also
contain a trust relationship that allows a server to access your resources when servicing transfer
requests for the associated access.public void setExternalId(String externalId)
A unique identifier that might be required when you assume a role in another account. Think of the
ExternalID
as a group membership mechanism that uses a unique identifier (often a SID, but could be
a group name or something else) as a basis. If the administrator of the account to which the role belongs
provided you with an external ID, then provide that value in the ExternalId
parameter. A
cross-account role is usually set up to trust everyone in an account. Therefore, the administrator of the
trusting account might send an external ID to the administrator of the trusted account. That way, only someone
with the ID can assume the role, rather than everyone in the account.
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 might be required when you assume a role in another account. Think of the
ExternalID
as a group membership mechanism that uses a unique identifier (often a SID, but
could be a group name or something else) as a basis. If the administrator of the account to which the role
belongs provided you with an external ID, then provide that value in the ExternalId
parameter. A cross-account role is usually set up to trust everyone in an account. Therefore, the
administrator of the trusting account might send an external ID to the administrator of the trusted
account. That way, only someone with the ID can assume the role, rather than everyone in the account.
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 might be required when you assume a role in another account. Think of the
ExternalID
as a group membership mechanism that uses a unique identifier (often a SID, but could be
a group name or something else) as a basis. If the administrator of the account to which the role belongs
provided you with an external ID, then provide that value in the ExternalId
parameter. A
cross-account role is usually set up to trust everyone in an account. Therefore, the administrator of the
trusting account might send an external ID to the administrator of the trusted account. That way, only someone
with the ID can assume the role, rather than everyone in the account.
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
as a group membership mechanism that uses a unique identifier (often a SID, but
could be a group name or something else) as a basis. If the administrator of the account to which the
role belongs provided you with an external ID, then provide that value in the ExternalId
parameter. A cross-account role is usually set up to trust everyone in an account. Therefore, the
administrator of the trusting account might send an external ID to the administrator of the trusted
account. That way, only someone with the ID can assume the role, rather than everyone in the account.
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 DescribedAccess withExternalId(String externalId)
A unique identifier that might be required when you assume a role in another account. Think of the
ExternalID
as a group membership mechanism that uses a unique identifier (often a SID, but could be
a group name or something else) as a basis. If the administrator of the account to which the role belongs
provided you with an external ID, then provide that value in the ExternalId
parameter. A
cross-account role is usually set up to trust everyone in an account. Therefore, the administrator of the
trusting account might send an external ID to the administrator of the trusted account. That way, only someone
with the ID can assume the role, rather than everyone in the account.
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 might be required when you assume a role in another account. Think of the
ExternalID
as a group membership mechanism that uses a unique identifier (often a SID, but
could be a group name or something else) as a basis. If the administrator of the account to which the role
belongs provided you with an external ID, then provide that value in the ExternalId
parameter. A cross-account role is usually set up to trust everyone in an account. Therefore, the
administrator of the trusting account might send an external ID to the administrator of the trusted
account. That way, only someone with the ID can assume the role, rather than everyone in the account.
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 Object
Object.toString()
public DescribedAccess clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.