NAME
Paws::Transfer::CreateAccess - Arguments for method CreateAccess on Paws::Transfer
DESCRIPTION
This class represents the parameters used for calling the method CreateAccess on the AWS Transfer Family service. Use the attributes of this class as arguments to method CreateAccess.
You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateAccess.
SYNOPSIS
my $transfer = Paws->service('Transfer');
my $CreateAccessResponse = $transfer->CreateAccess(
ExternalId => 'MyExternalId',
Role => 'MyRole',
ServerId => 'MyServerId',
HomeDirectory => 'MyHomeDirectory', # OPTIONAL
HomeDirectoryMappings => [
{
Entry => 'MyMapEntry', # max: 1024
Target => 'MyMapTarget', # max: 1024
},
...
], # OPTIONAL
HomeDirectoryType => 'PATH', # OPTIONAL
Policy => 'MyPolicy', # OPTIONAL
PosixProfile => {
Gid => 1, # max: 4294967295
Uid => 1, # max: 4294967295
SecondaryGids => [
1, ... # max: 4294967295
], # max: 16; OPTIONAL
}, # OPTIONAL
);
# Results:
my $ExternalId = $CreateAccessResponse->ExternalId;
my $ServerId = $CreateAccessResponse->ServerId;
# Returns a L<Paws::Transfer::CreateAccessResponse> object.Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/transfer/CreateAccess
ATTRIBUTES
REQUIRED ExternalId => Str
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 Amazon Web Services 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: =,.@:/-
HomeDirectory => Str
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.
HomeDirectoryMappings => ArrayRef[Paws::Transfer::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 Amazon Web Services 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 EFS, the entry is 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 CLI, use the s3api or efsapi call instead of s3 or efs so you can use the put-object operation. For example, you use the following: aws s3api put-object --bucket bucketname --key path/to/folder/. Make sure that the end of the key name ends in a / for it to be considered a folder.
HomeDirectoryType => Str
The type of landing directory (folder) you want your users' home directory to be when they log into the server. If you set it to PATH, the user will see the absolute Amazon S3 bucket or EFS paths as is in their file transfer protocol clients. If you set it LOGICAL, you will need to provide mappings in the HomeDirectoryMappings for how you want to make Amazon S3 or EFS paths visible to your users.
Valid values are: "PATH", "LOGICAL"
Policy => Str
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 policies.
For scope-down policies, Amazon Web Services 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 (https://docs.aws.amazon.com/transfer/latest/userguide/scope-down-policy.html).
For more information, see AssumeRole (https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html) in the Amazon Web Services Security Token Service API Reference.
PosixProfile => Paws::Transfer::PosixProfile
REQUIRED Role => Str
Specifies the Amazon Resource Name (ARN) of 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.
REQUIRED ServerId => Str
A system-assigned unique identifier for a server instance. This is the specific server that you added your user to.
SEE ALSO
This class forms part of Paws, documenting arguments for method CreateAccess in Paws::Transfer
BUGS and CONTRIBUTIONS
The source code is located here: https://github.com/pplu/aws-sdk-perl
Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues