Amazon.PowerShell.Cmdlets.TFR.AmazonTransferClientCmdlet.ClientConfig
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
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.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
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.The following is an Entry and Target pair example.[ { "Entry": "/directory1", "Target": "/bucket_name/home/mydirectory" } ]In most cases, you can use this value instead of the session policy to lock your user down to the designated home directory ("chroot"). To do this, you can set Entry to / and set Target to the value the user should see for their home directory when they log in.The following is an Entry and Target pair example for chroot.[ { "Entry": "/", "Target": "/bucket_name/home/mydirectory" } ]
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | HomeDirectoryMappings |
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.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Changes the cmdlet behavior to return the value passed to the ServerId parameter. The -PassThru parameter is deprecated, use -Select '^ServerId' instead. This parameter will be removed in a future version.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
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}.This policy applies only when the domain of
ServerId is Amazon S3. Amazon EFS does not use session policies.For session policies, 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 session policy, see
Example session policy.For more information, see
AssumeRole in the
Amazon Web Services Security Token Service API Reference.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
-PosixProfile_Gid <Int64>
The POSIX group ID used for all EFS operations by this user.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
-PosixProfile_SecondaryGid <Int64[]>
The secondary POSIX group IDs used for all EFS operations by this user.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | PosixProfile_SecondaryGids |
-PosixProfile_Uid <Int64>
The POSIX user ID used for all EFS operations by this user.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
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.
Required? | True |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Transfer.Model.CreateUserResponse). Specifying the name of a property of type Amazon.Transfer.Model.CreateUserResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
A system-assigned unique identifier for a server instance. This is the specific server that you added your user to.
Required? | True |
Position? | 1 |
Accept pipeline input? | True (ByValue, ByPropertyName) |
The public portion of the Secure Shell (SSH) key used to authenticate the user to the server.The three standard SSH public key format elements are
<key type>,
<body base64>, and an optional
<comment>, with spaces between each element.Transfer Family accepts RSA, ECDSA, and ED25519 keys.
- For RSA keys, the key type is ssh-rsa.
- For ED25519 keys, the key type is ssh-ed25519.
- For ECDSA keys, the key type is either ecdsa-sha2-nistp256, ecdsa-sha2-nistp384, or ecdsa-sha2-nistp521, depending on the size of the key you generated.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Key-value pairs that can be used to group and search for users. Tags are metadata attached to users for any purpose.
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | Tags |
A unique string that identifies a user and is associated with a ServerId. This user name must be a minimum of 3 and a maximum of 100 characters long. The following are valid characters: a-z, A-Z, 0-9, underscore '_', hyphen '-', period '.', and at sign '@'. The user name can't start with a hyphen, period, or at sign.
Required? | True |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |