| Column Name | Column Data Type |
|---|
server_id Required Input Column
A system-assigned unique identifier for a server that has this user assigned. | VARCHAR |
user_name Required Input Column
The name of the user assigned to one or more servers. User names are part of the sign-in credentials to use the Transfer Family service and perform file transfer tasks. | VARCHAR |
_aws_profile Input Column
The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role. | STRUCT(
"type" VARCHAR,
"name" VARCHAR,
"account_id" VARCHAR,
"via_profile_name" VARCHAR,
"assumed_role_arn" VARCHAR,
"organization" STRUCT(
"account_name" VARCHAR,
"id" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[],
"master_account" STRUCT(
"id" VARCHAR,
"email" VARCHAR
),
"parents" STRUCT(
"type" VARCHAR,
"id" VARCHAR,
"name" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[]
)[]
)
) |
Show child fields- _aws_profile.account_id
The AWS account id - _aws_profile.assumed_role_arn
The ARN of the assumed role - _aws_profile.name
The unique name of the profile. - _aws_profile.organization
Information about this profile's membership in the AWS organization. Show child fields- _aws_profile.organization.account_name
The name of account speciifed by the organization - _aws_profile.organization.id
The organization id - _aws_profile.organization.master_account
Show child fields- _aws_profile.organization.master_account.email
The organization master account email address - _aws_profile.organization.master_account.id
The organization master account id
- _aws_profile.organization.parents[]
Show child fields- _aws_profile.organization.parents[].id
The id of the parent - _aws_profile.organization.parents[].name
The name of the parent - _aws_profile.organization.parents[].tags[]
Show child fields- _aws_profile.organization.parents[].tags[].key
- _aws_profile.organization.parents[].tags[].value
- _aws_profile.organization.parents[].type
The type of parent can be an organization unit or a root
- _aws_profile.organization.tags[]
Show child fields- _aws_profile.organization.tags[].key
- _aws_profile.organization.tags[].value
- _aws_profile.type
The type of profile, either 'credentials' or 'assumed_role' - _aws_profile.via_profile_name
This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.
|
_aws_region Input Column
The AWS region to use. | VARCHAR |
user
An array containing the properties of the Transfer Family user for the ServerID value that you specified. | STRUCT(
"arn" VARCHAR,
"home_directory" VARCHAR,
"home_directory_mappings" STRUCT(
"entry" VARCHAR,
"target" VARCHAR,
"type" VARCHAR
)[],
"home_directory_type" VARCHAR,
"policy" VARCHAR,
"posix_profile" STRUCT(
"uid" BIGINT,
"gid" BIGINT,
"secondary_gids" BIGINT[]
),
"role" VARCHAR,
"ssh_public_keys" STRUCT(
"date_imported" TIMESTAMP_S,
"ssh_public_key_body" VARCHAR,
"ssh_public_key_id" VARCHAR
)[],
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[],
"user_name" VARCHAR
) |
Show child fields- user.arn
Specifies the unique Amazon Resource Name (ARN) for the user that was requested to be described. - user.home_directory
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. - user.home_directory_mappings[]
Show child fields- user.home_directory_mappings[].entry
Represents an entry for HomeDirectoryMappings. - user.home_directory_mappings[].target
Represents the map target that is used in a HomeDirectoryMapEntry. - user.home_directory_mappings[].type
Specifies the type of mapping. Set the type to FILE if you want the mapping to point to a file, or DIRECTORY for the directory to point to a directory. By default, home directory mappings have a Type of DIRECTORY when you create a Transfer Family server. You would need to explicitly set Type to FILE if you want a mapping to have a file target.
- user.home_directory_type
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. - user.policy
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}. - user.posix_profile
Specifies 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 Elastic File System (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. Show child fields- user.posix_profile.gid
The POSIX group ID used for all EFS operations by this user. - user.posix_profile.secondary_gids[]
- user.posix_profile.uid
The POSIX user ID used for all EFS operations by this user.
- user.role
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. - user.ssh_public_keys[]
Show child fields- user.ssh_public_keys[].date_imported
Specifies the date that the public key was added to the Transfer Family user. - user.ssh_public_keys[].ssh_public_key_body
Specifies the content of the SSH public key as specified by the PublicKeyId. Transfer Family accepts RSA, ECDSA, and ED25519 keys. - user.ssh_public_keys[].ssh_public_key_id
Specifies the SshPublicKeyId parameter contains the identifier of the public key.
- user.tags[]
Show child fields- user.tags[].key
The name assigned to the tag that you create. - user.tags[].value
Contains one or more values that you assigned to the key name you create.
- user.user_name
Specifies the name of the user that was requested to be described. User names are used for authentication purposes. This is the string that will be used by your user when they log in to your server.
|