package Paws::Transfer::CreateAccess; use Moose; has ExternalId => (is => 'ro', isa => 'Str', required => 1); has HomeDirectory => (is => 'ro', isa => 'Str'); has HomeDirectoryMappings => (is => 'ro', isa => 'ArrayRef[Paws::Transfer::HomeDirectoryMapEntry]'); has HomeDirectoryType => (is => 'ro', isa => 'Str'); has Policy => (is => 'ro', isa => 'Str'); has PosixProfile => (is => 'ro', isa => 'Paws::Transfer::PosixProfile'); has Role => (is => 'ro', isa => 'Str', required => 1); has ServerId => (is => 'ro', isa => 'Str', required => 1); use MooseX::ClassAttribute; class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateAccess'); class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Transfer::CreateAccessResponse'); class_has _result_key => (isa => 'Str', is => 'ro'); 1; ### main pod documentation begin ### =head1 NAME Paws::Transfer::CreateAccess - Arguments for method CreateAccess on L =head1 DESCRIPTION This class represents the parameters used for calling the method CreateAccess on the L 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. =head1 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 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 L =head1 ATTRIBUTES =head2 B 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. C*"} -Properties * | Select SamAccountName,ObjectSid> In that command, replace I 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: =,.@:/- =head2 HomeDirectory => Str The landing directory (folder) for a user when they log in to the server using the client. A C example is C. =head2 HomeDirectoryMappings => ArrayRef[L] 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 C and C pair, where C shows how the path is made visible and C 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 C. This value can only be set when C is set to I. The following is an C and C pair example. C<[ { "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 ("C"). To do this, you can set C to C and set C to the C parameter value. The following is an C and C pair example for C. C<[ { "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 C or C call instead of C or C so you can use the put-object operation. For example, you use the following: C. Make sure that the end of the key name ends in a C for it to be considered a folder. =head2 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 C, the user will see the absolute Amazon S3 bucket or EFS paths as is in their file transfer protocol clients. If you set it C, you will need to provide mappings in the C for how you want to make Amazon S3 or EFS paths visible to your users. Valid values are: C<"PATH">, C<"LOGICAL"> =head2 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 C<${Transfer:UserName}>, C<${Transfer:HomeDirectory}>, and C<${Transfer:HomeBucket}>. This only applies when domain of C 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 C 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 I. =head2 PosixProfile => L =head2 B 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. =head2 B ServerId => Str A system-assigned unique identifier for a server instance. This is the specific server that you added your user to. =head1 SEE ALSO This class forms part of L, documenting arguments for method CreateAccess in L =head1 BUGS and CONTRIBUTIONS The source code is located here: L Please report bugs to: L =cut