Class: Aws::Transfer::Types::DescribedAccess
- Inherits:
-
Struct
- Object
- Struct
- Aws::Transfer::Types::DescribedAccess
- Defined in:
- gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb
Overview
Describes the properties of the access that was specified.
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#external_id ⇒ String
A unique identifier that is required to identify specific groups within your directory.
-
#home_directory ⇒ String
The landing directory (folder) for a user when they log in to the server using the client.
-
#home_directory_mappings ⇒ Array<Types::HomeDirectoryMapEntry>
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.
-
#home_directory_type ⇒ String
The type of landing directory (folder) that you want your users' home directory to be when they log in to the server.
-
#policy ⇒ String
A session policy for your user so that you can use the same Identity and Access Management (IAM) role across multiple users.
-
#posix_profile ⇒ Types::PosixProfile
The full POSIX identity, including user ID (
Uid
), group ID (Gid
), and any secondary groups IDs (SecondaryGids
), that controls your users' access to your Amazon EFS file systems. -
#role ⇒ String
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.
Instance Attribute Details
#external_id ⇒ String
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: =,.@:/-
1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 |
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 1955 class DescribedAccess < Struct.new( :home_directory, :home_directory_mappings, :home_directory_type, :policy, :posix_profile, :role, :external_id) SENSITIVE = [] include Aws::Structure end |
#home_directory ⇒ String
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
.
HomeDirectory
parameter is only used if HomeDirectoryType
is
set to PATH
.
1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 |
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 1955 class DescribedAccess < Struct.new( :home_directory, :home_directory_mappings, :home_directory_type, :policy, :posix_profile, :role, :external_id) SENSITIVE = [] include Aws::Structure end |
#home_directory_mappings ⇒ Array<Types::HomeDirectoryMapEntry>
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.
1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 |
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 1955 class DescribedAccess < Struct.new( :home_directory, :home_directory_mappings, :home_directory_type, :policy, :posix_profile, :role, :external_id) SENSITIVE = [] include Aws::Structure end |
#home_directory_type ⇒ String
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.
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.
1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 |
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 1955 class DescribedAccess < Struct.new( :home_directory, :home_directory_mappings, :home_directory_type, :policy, :posix_profile, :role, :external_id) SENSITIVE = [] include Aws::Structure end |
#policy ⇒ String
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\}
.
1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 |
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 1955 class DescribedAccess < Struct.new( :home_directory, :home_directory_mappings, :home_directory_type, :policy, :posix_profile, :role, :external_id) SENSITIVE = [] include Aws::Structure end |
#posix_profile ⇒ Types::PosixProfile
The full POSIX identity, including user ID (Uid
), group ID
(Gid
), and any secondary groups IDs (SecondaryGids
), that
controls your users' access to your Amazon EFS file systems. The
POSIX permissions that are set on files and directories in your file
system determine the level of access your users get when
transferring files into and out of your Amazon EFS file systems.
1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 |
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 1955 class DescribedAccess < Struct.new( :home_directory, :home_directory_mappings, :home_directory_type, :policy, :posix_profile, :role, :external_id) SENSITIVE = [] include Aws::Structure end |
#role ⇒ String
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.
1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 |
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 1955 class DescribedAccess < Struct.new( :home_directory, :home_directory_mappings, :home_directory_type, :policy, :posix_profile, :role, :external_id) SENSITIVE = [] include Aws::Structure end |