String name
The name of the step, used as an identifier.
InputFileLocation destinationFileLocation
Specifies the location for the file being copied. Only applicable for Copy type workflow steps. Use
${Transfer:username} in this field to parametrize the destination prefix by username.
String overwriteExisting
A flag that indicates whether or not to overwrite an existing file of the same name. The default is
FALSE.
String sourceFileLocation
Specifies which file to use as input to the workflow step: either the output from the previous step, or the originally uploaded file for the workflow.
Enter ${previous.file} to use the previous file as the input. In this case, this workflow step uses
the output file from the previous workflow step as input. This is the default value.
Enter ${original.file} to use the originally-uploaded file location as input for this step.
String homeDirectory
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.
String homeDirectoryType
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 need to provide mappings in the
HomeDirectoryMappings for how you want to make Amazon S3 or EFS paths visible to your users.
List<E> homeDirectoryMappings
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": "/directory1", "Target": "/bucket_name/home/mydirectory" } ]
In most cases, you can use this value instead of the session 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" } ]
String policy
A session 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 the domain of ServerId is S3. EFS does not use session policies.
For session 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 session policy, see Example session policy.
For more information, see AssumeRole in the Amazon Web Services Security Token Service API Reference.
PosixProfile posixProfile
String role
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.
String serverId
A system-assigned unique identifier for a server instance. This is the specific server that you added your user to.
String externalId
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: =,.@:/-
String certificate
The Amazon Resource Name (ARN) of the Amazon Web Services Certificate Manager (ACM) certificate. Required when
Protocols is set to FTPS.
To request a new public certificate, see Request a public certificate in the Amazon Web Services Certificate Manager User Guide.
To import an existing certificate into ACM, see Importing certificates into ACM in the Amazon Web Services Certificate Manager User Guide.
To request a private certificate to use FTPS through private IP addresses, see Request a private certificate in the Amazon Web Services Certificate Manager User Guide.
Certificates with the following cryptographic algorithms and key sizes are supported:
2048-bit RSA (RSA_2048)
4096-bit RSA (RSA_4096)
Elliptic Prime Curve 256 bit (EC_prime256v1)
Elliptic Prime Curve 384 bit (EC_secp384r1)
Elliptic Prime Curve 521 bit (EC_secp521r1)
The certificate must be a valid SSL/TLS X.509 version 3 certificate with FQDN or IP address specified and information about the issuer.
String domain
The domain of the storage system that is used for file transfers. There are two domains available: Amazon Simple Storage Service (Amazon S3) and Amazon Elastic File System (Amazon EFS). The default value is S3.
After the server is created, the domain cannot be changed.
EndpointDetails endpointDetails
The virtual private cloud (VPC) endpoint settings that are configured for your server. When you host your endpoint within your VPC, you can make it accessible only to resources within your VPC, or you can attach Elastic IP addresses and make it accessible to clients over the internet. Your VPC's default security groups are automatically assigned to your endpoint.
String endpointType
The type of endpoint that you want your server to use. You can choose to make your server's endpoint publicly accessible (PUBLIC) or host it inside your VPC. With an endpoint that is hosted in a VPC, you can restrict access to your server and resources only within your VPC or choose to make it internet facing by attaching Elastic IP addresses directly to it.
After May 19, 2021, you won't be able to create a server using EndpointType=VPC_ENDPOINT in your
Amazon Web Services account if your account hasn't already done so before May 19, 2021. If you have already
created servers with EndpointType=VPC_ENDPOINT in your Amazon Web Services account on or before May
19, 2021, you will not be affected. After this date, use EndpointType=VPC.
For more information, see https://docs.aws.amazon.com/transfer/latest/userguide/create-server-in-vpc.html#deprecate-vpc-endpoint.
It is recommended that you use VPC as the EndpointType. With this endpoint type, you
have the option to directly associate up to three Elastic IPv4 addresses (BYO IP included) with your server's
endpoint and use VPC security groups to restrict traffic by the client's public IP address. This is not possible
with EndpointType set to VPC_ENDPOINT.
String hostKey
The RSA, ECDSA, or ED25519 private key to use for your server.
Use the following command to generate an RSA 2048 bit key with no passphrase:
ssh-keygen -t rsa -b 2048 -N "" -m PEM -f my-new-server-key.
Use a minimum value of 2048 for the -b option: you can create a stronger key using 3072 or 4096.
Use the following command to generate an ECDSA 256 bit key with no passphrase:
ssh-keygen -t ecdsa -b 256 -N "" -m PEM -f my-new-server-key.
Valid values for the -b option for ECDSA are 256, 384, and 521.
Use the following command to generate an ED25519 key with no passphrase:
ssh-keygen -t ed25519 -N "" -f my-new-server-key.
For all of these commands, you can replace my-new-server-key with a string of your choice.
If you aren't planning to migrate existing users from an existing SFTP-enabled server to a new server, don't update the host key. Accidentally changing a server's host key can be disruptive.
For more information, see Change the host key for your SFTP-enabled server in the Amazon Web Services Transfer Family User Guide.
IdentityProviderDetails identityProviderDetails
Required when IdentityProviderType is set to AWS_DIRECTORY_SERVICE or
API_GATEWAY. Accepts an array containing all of the information required to use a directory in
AWS_DIRECTORY_SERVICE or invoke a customer-supplied authentication API, including the API Gateway
URL. Not required when IdentityProviderType is set to SERVICE_MANAGED.
String identityProviderType
Specifies the mode of authentication for a server. The default value is SERVICE_MANAGED, which
allows you to store and access user credentials within the Amazon Web Services Transfer Family service.
Use AWS_DIRECTORY_SERVICE to provide access to Active Directory groups in Amazon Web Services
Managed Active Directory or Microsoft Active Directory in your on-premises environment or in Amazon Web Services
using AD Connectors. This option also requires you to provide a Directory ID using the
IdentityProviderDetails parameter.
Use the API_GATEWAY value to integrate with an identity provider of your choosing. The
API_GATEWAY setting requires you to provide an API Gateway endpoint URL to call for authentication
using the IdentityProviderDetails parameter.
Use the AWS_LAMBDA value to directly use a Lambda function as your identity provider. If you choose
this value, you must specify the ARN for the lambda function in the Function parameter for the
IdentityProviderDetails data type.
String loggingRole
Specifies the Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) role that allows a server to turn on Amazon CloudWatch logging for Amazon S3 or Amazon EFS events. When set, user activity can be viewed in your CloudWatch logs.
String postAuthenticationLoginBanner
Specify a string to display when users connect to a server. This string is displayed after the user authenticates.
The SFTP protocol does not support post-authentication display banners.
String preAuthenticationLoginBanner
Specify a string to display when users connect to a server. This string is displayed before the user authenticates. For example, the following banner displays details about using the system.
This system is for the use of authorized users only. Individuals using this computer system without authority, or in excess of their authority, are subject to having all of their activities on this system monitored and recorded by system personnel.
List<E> protocols
Specifies the file transfer protocol or protocols over which your file transfer protocol client can connect to your server's endpoint. The available protocols are:
SFTP (Secure Shell (SSH) File Transfer Protocol): File transfer over SSH
FTPS (File Transfer Protocol Secure): File transfer with TLS encryption
FTP (File Transfer Protocol): Unencrypted file transfer
If you select FTPS, you must choose a certificate stored in Amazon Web Services Certificate Manager
(ACM) which is used to identify your server when clients connect to it over FTPS.
If Protocol includes either FTP or FTPS, then the
EndpointType must be VPC and the IdentityProviderType must be
AWS_DIRECTORY_SERVICE or API_GATEWAY.
If Protocol includes FTP, then AddressAllocationIds cannot be associated.
If Protocol is set only to SFTP, the EndpointType can be set to
PUBLIC and the IdentityProviderType can be set to SERVICE_MANAGED.
ProtocolDetails protocolDetails
The protocol settings that are configured for your server.
Use the PassiveIp parameter to indicate passive mode (for FTP and FTPS protocols). Enter a single
dotted-quad IPv4 address, such as the external IP address of a firewall, router, or load balancer.
Use the SetStatOption to ignore the error that is generated when the client attempts to use SETSTAT
on a file you are uploading to an S3 bucket. Set the value to ENABLE_NO_OP to have the Transfer
Family server ignore the SETSTAT command, and upload files without needing to make any changes to your SFTP
client. Note that with SetStatOption set to ENABLE_NO_OP, Transfer generates a log
entry to CloudWatch Logs, so you can determine when the client is making a SETSTAT call.
Use the TlsSessionResumptionMode parameter to determine whether or not your Transfer server resumes
recent, negotiated sessions through a unique session ID.
String securityPolicyName
Specifies the name of the security policy that is attached to the server.
List<E> tags
Key-value pairs that can be used to group and search for servers.
WorkflowDetails workflowDetails
Specifies the workflow ID for the workflow to assign and the execution role used for executing the workflow.
String serverId
The service-assigned ID of the server that is created.
String homeDirectory
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.
String homeDirectoryType
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 need to provide mappings in the
HomeDirectoryMappings for how you want to make Amazon S3 or EFS paths visible to your users.
List<E> homeDirectoryMappings
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": "/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 HomeDirectory parameter value.
The following is an Entry and Target pair example for chroot.
[ { "Entry": "/", "Target": "/bucket_name/home/mydirectory" } ]
String policy
A session 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 the domain of ServerId is S3. EFS does not use session policies.
For session 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 session policy, see Example session policy.
For more information, see AssumeRole in the Amazon Web Services Security Token Service API Reference.
PosixProfile posixProfile
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 EFS file
systems. The POSIX permissions that are set on files and directories in Amazon EFS determine the level of access
your users get when transferring files into and out of your Amazon EFS file systems.
String role
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.
String serverId
A system-assigned unique identifier for a server instance. This is the specific server that you added your user to.
String sshPublicKeyBody
The public portion of the Secure Shell (SSH) key used to authenticate the user to the server.
Transfer Family accepts RSA, ECDSA, and ED25519 keys.
List<E> tags
Key-value pairs that can be used to group and search for users. Tags are metadata attached to users for any purpose.
String userName
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.
String description
A textual description for the workflow.
List<E> steps
Specifies the details for the steps that are in the specified workflow.
The TYPE specifies which of the following actions is being taken for this step.
COPY: copy the file to another location
CUSTOM: custom step with a lambda target
DELETE: delete the file
TAG: add a tag to the file
Currently, copying and tagging are supported only on S3.
For file location, you specify either the S3 bucket and key, or the EFS filesystem ID and path.
List<E> onExceptionSteps
Specifies the steps (actions) to take if errors are encountered during execution of the workflow.
For custom steps, the lambda function needs to send FAILURE to the call back API to kick off the
exception steps. Additionally, if the lambda does not send SUCCESS before it times out, the
exception steps are executed.
List<E> tags
Key-value pairs that can be used to group and search for workflows. Tags are metadata attached to workflows for any purpose.
String workflowId
A unique identifier for the workflow.
String name
The name of the step, used as an identifier.
String target
The ARN for the lambda function that is being called.
Integer timeoutSeconds
Timeout, in seconds, for the step.
String sourceFileLocation
Specifies which file to use as input to the workflow step: either the output from the previous step, or the originally uploaded file for the workflow.
Enter ${previous.file} to use the previous file as the input. In this case, this workflow step uses
the output file from the previous workflow step as input. This is the default value.
Enter ${original.file} to use the originally-uploaded file location as input for this step.
String serverId
A system-assigned unique identifier for a server that has this user assigned.
String externalId
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: =,.@:/-
String serverId
A unique system-assigned identifier for a server instance.
String serverId
A system-assigned unique identifier for a file transfer protocol-enabled server instance that has the user assigned to it.
String sshPublicKeyId
A unique identifier used to reference your user's specific SSH key.
String userName
A unique string that identifies a user whose public key is being deleted.
String name
The name of the step, used as an identifier.
String sourceFileLocation
Specifies which file to use as input to the workflow step: either the output from the previous step, or the originally uploaded file for the workflow.
Enter ${previous.file} to use the previous file as the input. In this case, this workflow step uses
the output file from the previous workflow step as input. This is the default value.
Enter ${original.file} to use the originally-uploaded file location as input for this step.
String workflowId
A unique identifier for the workflow.
String serverId
A system-assigned unique identifier for a server that has this access assigned.
String externalId
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: =,.@:/-
String serverId
A system-assigned unique identifier for a server that has this access assigned.
DescribedAccess access
The external ID of the server that the access is attached to.
String homeDirectory
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.
List<E> homeDirectoryMappings
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.
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.
String homeDirectoryType
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 need to provide mappings in the
HomeDirectoryMappings for how you want to make Amazon S3 or EFS paths visible to your users.
String policy
A session 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}.
PosixProfile posixProfile
String role
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.
String externalId
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: =,.@:/-
String executionId
A unique identifier for the execution of a workflow.
FileLocation initialFileLocation
A structure that describes the Amazon S3 or EFS file location. This is the file location when the execution begins: if the file is being copied, this is the initial (as opposed to destination) file location.
ServiceMetadata serviceMetadata
A container object for the session details associated with a workflow.
String executionRole
The IAM role associated with the execution.
LoggingConfiguration loggingConfiguration
The IAM logging role associated with the execution.
PosixProfile posixProfile
String status
The status is one of the execution. Can be in progress, completed, exception encountered, or handling the exception.
ExecutionResults results
A structure that describes the execution results. This includes a list of the steps along with the details of
each step, error type and message (if any), and the OnExceptionSteps structure.
Boolean fips
Specifies whether this policy enables Federal Information Processing Standards (FIPS).
String securityPolicyName
Specifies the name of the security policy that is attached to the server.
List<E> sshCiphers
Specifies the enabled Secure Shell (SSH) cipher encryption algorithms in the security policy that is attached to the server.
List<E> sshKexs
Specifies the enabled SSH key exchange (KEX) encryption algorithms in the security policy that is attached to the server.
List<E> sshMacs
Specifies the enabled SSH message authentication code (MAC) encryption algorithms in the security policy that is attached to the server.
List<E> tlsCiphers
Specifies the enabled Transport Layer Security (TLS) cipher encryption algorithms in the security policy that is attached to the server.
String arn
Specifies the unique Amazon Resource Name (ARN) of the server.
String certificate
Specifies the ARN of the Amazon Web ServicesCertificate Manager (ACM) certificate. Required when
Protocols is set to FTPS.
ProtocolDetails protocolDetails
The protocol settings that are configured for your server.
Use the PassiveIp parameter to indicate passive mode. Enter a single IPv4 address, such as the
public IP address of a firewall, router, or load balancer.
String domain
Specifies the domain of the storage system that is used for file transfers.
EndpointDetails endpointDetails
The virtual private cloud (VPC) endpoint settings that are configured for your server. When you host your endpoint within your VPC, you can make it accessible only to resources within your VPC, or you can attach Elastic IP addresses and make it accessible to clients over the internet. Your VPC's default security groups are automatically assigned to your endpoint.
String endpointType
Defines the type of endpoint that your server is connected to. If your server is connected to a VPC endpoint, your server isn't accessible over the public internet.
String hostKeyFingerprint
Specifies the Base64-encoded SHA256 fingerprint of the server's host key. This value is equivalent to the output
of the ssh-keygen -l -f my-new-server-key command.
IdentityProviderDetails identityProviderDetails
Specifies information to call a customer-supplied authentication API. This field is not populated when the
IdentityProviderType of a server is AWS_DIRECTORY_SERVICE or
SERVICE_MANAGED.
String identityProviderType
Specifies the mode of authentication for a server. The default value is SERVICE_MANAGED, which
allows you to store and access user credentials within the Amazon Web Services Transfer Family service.
Use AWS_DIRECTORY_SERVICE to provide access to Active Directory groups in Amazon Web Services
Managed Active Directory or Microsoft Active Directory in your on-premises environment or in Amazon Web Services
using AD Connectors. This option also requires you to provide a Directory ID using the
IdentityProviderDetails parameter.
Use the API_GATEWAY value to integrate with an identity provider of your choosing. The
API_GATEWAY setting requires you to provide an API Gateway endpoint URL to call for authentication
using the IdentityProviderDetails parameter.
Use the AWS_LAMBDA value to directly use a Lambda function as your identity provider. If you choose
this value, you must specify the ARN for the lambda function in the Function parameter for the
IdentityProviderDetails data type.
String loggingRole
Specifies the Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) role that allows a server to turn on Amazon CloudWatch logging for Amazon S3 or Amazon EFS events. When set, user activity can be viewed in your CloudWatch logs.
String postAuthenticationLoginBanner
Specify a string to display when users connect to a server. This string is displayed after the user authenticates.
The SFTP protocol does not support post-authentication display banners.
String preAuthenticationLoginBanner
Specify a string to display when users connect to a server. This string is displayed before the user authenticates. For example, the following banner displays details about using the system.
This system is for the use of authorized users only. Individuals using this computer system without authority, or in excess of their authority, are subject to having all of their activities on this system monitored and recorded by system personnel.
List<E> protocols
Specifies the file transfer protocol or protocols over which your file transfer protocol client can connect to your server's endpoint. The available protocols are:
SFTP (Secure Shell (SSH) File Transfer Protocol): File transfer over SSH
FTPS (File Transfer Protocol Secure): File transfer with TLS encryption
FTP (File Transfer Protocol): Unencrypted file transfer
String securityPolicyName
Specifies the name of the security policy that is attached to the server.
String serverId
Specifies the unique system-assigned identifier for a server that you instantiate.
String state
Specifies the condition of a server for the server that was described. A value of ONLINE indicates
that the server can accept jobs and transfer files. A State value of OFFLINE means that
the server cannot perform file transfer operations.
The states of STARTING and STOPPING indicate that the server is in an intermediate
state, either not fully able to respond, or not fully offline. The values of START_FAILED or
STOP_FAILED can indicate an error condition.
List<E> tags
Specifies the key-value pairs that you can use to search for and group servers that were assigned to the server that was described.
Integer userCount
Specifies the number of users that are assigned to a server you specified with the ServerId.
WorkflowDetails workflowDetails
Specifies the workflow ID for the workflow to assign and the execution role used for executing the workflow.
String arn
Specifies the unique Amazon Resource Name (ARN) for the user that was requested to be described.
String homeDirectory
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.
List<E> homeDirectoryMappings
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.
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 HomeDirectory parameter value.
String homeDirectoryType
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 need to provide mappings in the
HomeDirectoryMappings for how you want to make Amazon S3 or EFS paths visible to your users.
String policy
A session 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}.
PosixProfile posixProfile
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.
String role
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.
List<E> sshPublicKeys
Specifies the public key portion of the Secure Shell (SSH) keys stored for the described user.
List<E> tags
Specifies the key-value pairs for the user requested. Tag can be used to search for and group users for a variety of purposes.
String userName
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.
String arn
Specifies the unique Amazon Resource Name (ARN) for the workflow.
String description
Specifies the text description for the workflow.
List<E> steps
Specifies the details for the steps that are in the specified workflow.
List<E> onExceptionSteps
Specifies the steps (actions) to take if errors are encountered during execution of the workflow.
String workflowId
A unique identifier for the workflow.
List<E> tags
Key-value pairs that can be used to group and search for workflows. Tags are metadata attached to workflows for any purpose.
String workflowId
A unique identifier for the workflow.
DescribedExecution execution
The structure that contains the details of the workflow' execution.
String securityPolicyName
Specifies the name of the security policy that is attached to the server.
DescribedSecurityPolicy securityPolicy
An array containing the properties of the security policy.
String serverId
A system-assigned unique identifier for a server.
DescribedServer server
An array containing the properties of a server with the ServerID you specified.
String serverId
A system-assigned unique identifier for a server that has this user assigned.
String userName
The name of the user assigned to one or more servers. User names are part of the sign-in credentials to use the Amazon Web Services Transfer Family service and perform file transfer tasks.
String serverId
A system-assigned unique identifier for a server that has this user assigned.
DescribedUser user
An array containing the properties of the user account for the ServerID value that you specified.
String workflowId
A unique identifier for the workflow.
DescribedWorkflow workflow
The structure that contains the details of the workflow.
List<E> addressAllocationIds
A list of address allocation IDs that are required to attach an Elastic IP address to your server's endpoint.
This property can only be set when EndpointType is set to VPC and it is only valid in
the UpdateServer API.
List<E> subnetIds
A list of subnet IDs that are required to host your server endpoint in your VPC.
This property can only be set when EndpointType is set to VPC.
String vpcEndpointId
The ID of the VPC endpoint.
This property can only be set when EndpointType is set to VPC_ENDPOINT.
For more information, see https://docs.aws.amazon.com/transfer/latest/userguide/create-server-in-vpc.html#deprecate-vpc-endpoint.
String vpcId
The VPC ID of the VPC in which a server's endpoint will be hosted.
This property can only be set when EndpointType is set to VPC.
List<E> securityGroupIds
A list of security groups IDs that are available to attach to your server's endpoint.
This property can only be set when EndpointType is set to VPC.
You can edit the SecurityGroupIds property in the UpdateServer API only if
you are changing the EndpointType from PUBLIC or VPC_ENDPOINT to
VPC. To change security groups associated with your server's VPC endpoint after creation, use the
Amazon EC2 ModifyVpcEndpoint
API.
String type
Specifies the error type.
ALREADY_EXISTS: occurs for a copy step, if the overwrite option is not selected and a file with the
same name already exists in the target location.
BAD_REQUEST: a general bad request: for example, a step that attempts to tag an EFS file returns
BAD_REQUEST, as only S3 files can be tagged.
CUSTOM_STEP_FAILED: occurs when the custom step provided a callback that indicates failure.
INTERNAL_SERVER_ERROR: a catch-all error that can occur for a variety of reasons.
NOT_FOUND: occurs when a requested entity, for example a source file for a copy step, does not
exist.
PERMISSION_DENIED: occurs if your policy does not contain the correct permissions to complete one or
more of the steps in the workflow.
TIMEOUT: occurs when the execution times out.
You can set the TimeoutSeconds for a custom step, anywhere from 1 second to 1800 seconds (30
minutes).
THROTTLED: occurs if you exceed the new execution refill rate of one workflow per second.
String message
Specifies the descriptive message that corresponds to the ErrorType.
String stepType
One of the available step types.
COPY: copy the file to another location
CUSTOM: custom step with a lambda target
DELETE: delete the file
TAG: add a tag to the file
String outputs
The values for the key/value pair applied as a tag to the file. Only applicable if the step type is
TAG.
ExecutionError error
Specifies the details for an error, if it occurred during execution of the specified workfow step.
S3FileLocation s3FileLocation
Specifies the S3 details for the file being used, such as bucket, Etag, and so forth.
EfsFileLocation efsFileLocation
Specifies the Amazon EFS ID and the path for the file being used.
String url
Provides the location of the service endpoint used to authenticate users.
String invocationRole
Provides the type of InvocationRole used to authenticate the user account.
String directoryId
The identifier of the Amazon Web Services Directory Service directory that you want to stop sharing.
String function
The ARN for a lambda function to use for the Identity provider.
String serverId
A system-assigned unique identifier for a server.
String sshPublicKeyBody
The public key portion of an SSH key pair.
Transfer Family accepts RSA, ECDSA, and ED25519 keys.
String userName
The name of the user account that is assigned to one or more servers.
S3InputFileLocation s3FileLocation
Specifies the details for the S3 file being copied.
EfsFileLocation efsFileLocation
Reserved for future use.
Integer maxResults
Specifies the maximum number of access SIDs to return.
String nextToken
When you can get additional results from the ListAccesses call, a NextToken parameter
is returned in the output. You can then pass in a subsequent command to the NextToken parameter to
continue listing additional accesses.
String serverId
A system-assigned unique identifier for a server that has users assigned to it.
String nextToken
When you can get additional results from the ListAccesses call, a NextToken parameter
is returned in the output. You can then pass in a subsequent command to the NextToken parameter to
continue listing additional accesses.
String serverId
A system-assigned unique identifier for a server that has users assigned to it.
List<E> accesses
Returns the accesses and their properties for the ServerId value that you specify.
String homeDirectory
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.
String homeDirectoryType
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 need to provide mappings in the
HomeDirectoryMappings for how you want to make Amazon S3 or EFS paths visible to your users.
String role
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.
String externalId
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: =,.@:/-
String executionId
A unique identifier for the execution of a workflow.
FileLocation initialFileLocation
A structure that describes the Amazon S3 or EFS file location. This is the file location when the execution begins: if the file is being copied, this is the initial (as opposed to destination) file location.
ServiceMetadata serviceMetadata
A container object for the session details associated with a workflow.
String status
The status is one of the execution. Can be in progress, completed, exception encountered, or handling the exception.
String arn
Specifies the unique Amazon Resource Name (ARN) for a server to be listed.
String domain
Specifies the domain of the storage system that is used for file transfers.
String identityProviderType
Specifies the mode of authentication for a server. The default value is SERVICE_MANAGED, which
allows you to store and access user credentials within the Amazon Web Services Transfer Family service.
Use AWS_DIRECTORY_SERVICE to provide access to Active Directory groups in Amazon Web Services
Managed Active Directory or Microsoft Active Directory in your on-premises environment or in Amazon Web Services
using AD Connectors. This option also requires you to provide a Directory ID using the
IdentityProviderDetails parameter.
Use the API_GATEWAY value to integrate with an identity provider of your choosing. The
API_GATEWAY setting requires you to provide an API Gateway endpoint URL to call for authentication
using the IdentityProviderDetails parameter.
Use the AWS_LAMBDA value to directly use a Lambda function as your identity provider. If you choose
this value, you must specify the ARN for the lambda function in the Function parameter for the
IdentityProviderDetails data type.
String endpointType
Specifies the type of VPC endpoint that your server is connected to. If your server is connected to a VPC endpoint, your server isn't accessible over the public internet.
String loggingRole
Specifies the Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) role that allows a server to turn on Amazon CloudWatch logging for Amazon S3 or Amazon EFS events. When set, user activity can be viewed in your CloudWatch logs.
String serverId
Specifies the unique system assigned identifier for the servers that were listed.
String state
Specifies the condition of a server for the server that was described. A value of ONLINE indicates
that the server can accept jobs and transfer files. A State value of OFFLINE means that
the server cannot perform file transfer operations.
The states of STARTING and STOPPING indicate that the server is in an intermediate
state, either not fully able to respond, or not fully offline. The values of START_FAILED or
STOP_FAILED can indicate an error condition.
Integer userCount
Specifies the number of users that are assigned to a server you specified with the ServerId.
String arn
Provides the unique Amazon Resource Name (ARN) for the user that you want to learn about.
String homeDirectory
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.
String homeDirectoryType
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 need to provide mappings in the
HomeDirectoryMappings for how you want to make Amazon S3 or EFS paths visible to your users.
String role
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.
The IAM role that controls your users' access to your Amazon S3 bucket for servers with Domain=S3,
or your EFS file system for servers with Domain=EFS.
The policies attached to this role determine the level of access you want to provide your users when transferring files into and out of your S3 buckets or EFS file systems.
Integer sshPublicKeyCount
Specifies the number of SSH public keys stored for the user you specified.
String userName
Specifies the name of the user whose ARN was specified. User names are used for authentication purposes.
Integer maxResults
Specifies the aximum number of executions to return.
String nextToken
ListExecutions returns the NextToken parameter in the output. You can then pass the
NextToken parameter in a subsequent command to continue listing additional executions.
This is useful for pagination, for instance. If you have 100 executions for a workflow, you might only want to
list first 10. If so, callthe API by specifing the max-results:
aws transfer list-executions --max-results 10
This returns details for the first 10 executions, as well as the pointer (NextToken) to the eleventh
execution. You can now call the API again, suppling the NextToken value you received:
aws transfer list-executions --max-results 10 --next-token $somePointerReturnedFromPreviousListResult
This call returns the next 10 executions, the 11th through the 20th. You can then repeat the call until the details for all 100 executions have been returned.
String workflowId
A unique identifier for the workflow.
String nextToken
ListExecutions returns the NextToken parameter in the output. You can then pass the
NextToken parameter in a subsequent command to continue listing additional executions.
String workflowId
A unique identifier for the workflow.
List<E> executions
Returns the details for each execution.
NextToken: returned from a call to several APIs, you can use pass it to a subsequent command to continue listing additional executions.
StartTime: timestamp indicating when the execution began.
Executions: details of the execution, including the execution ID, initial file location, and Service metadata.
Status: one of the following values: IN_PROGRESS, COMPLETED,
EXCEPTION, HANDLING_EXEPTION.
Integer maxResults
Specifies the number of security policies to return as a response to the ListSecurityPolicies query.
String nextToken
When additional results are obtained from the ListSecurityPolicies command, a NextToken
parameter is returned in the output. You can then pass the NextToken parameter in a subsequent
command to continue listing additional security policies.
String nextToken
When you can get additional results from the ListSecurityPolicies operation, a
NextToken parameter is returned in the output. In a following command, you can pass in the
NextToken parameter to continue listing security policies.
List<E> securityPolicyNames
An array of security policies that were listed.
Integer maxResults
Specifies the number of servers to return as a response to the ListServers query.
String nextToken
When additional results are obtained from the ListServers command, a NextToken
parameter is returned in the output. You can then pass the NextToken parameter in a subsequent
command to continue listing additional servers.
String nextToken
When you can get additional results from the ListServers operation, a NextToken
parameter is returned in the output. In a following command, you can pass in the NextToken parameter
to continue listing additional servers.
List<E> servers
An array of servers that were listed.
String arn
Requests the tags associated with a particular Amazon Resource Name (ARN). An ARN is an identifier for a specific Amazon Web Services resource, such as a server, user, or role.
Integer maxResults
Specifies the number of tags to return as a response to the ListTagsForResource request.
String nextToken
When you request additional results from the ListTagsForResource operation, a NextToken
parameter is returned in the input. You can then pass in a subsequent command to the NextToken
parameter to continue listing additional tags.
String arn
The ARN you specified to list the tags of.
String nextToken
When you can get additional results from the ListTagsForResource call, a NextToken
parameter is returned in the output. You can then pass in a subsequent command to the NextToken
parameter to continue listing additional tags.
List<E> tags
Key-value pairs that are assigned to a resource, usually for the purpose of grouping and searching for items. Tags are metadata that you define.
Integer maxResults
Specifies the number of users to return as a response to the ListUsers request.
String nextToken
When you can get additional results from the ListUsers call, a NextToken parameter is
returned in the output. You can then pass in a subsequent command to the NextToken parameter to
continue listing additional users.
String serverId
A system-assigned unique identifier for a server that has users assigned to it.
String nextToken
When you can get additional results from the ListUsers call, a NextToken parameter is
returned in the output. You can then pass in a subsequent command to the NextToken parameter to
continue listing additional users.
String serverId
A system-assigned unique identifier for a server that the users are assigned to.
List<E> users
Returns the user accounts and their properties for the ServerId value that you specify.
String loggingRole
Specifies the Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) role that allows a server to turn on Amazon CloudWatch logging for Amazon S3 or Amazon EFS events. When set, user activity can be viewed in your CloudWatch logs.
String logGroupName
The name of the CloudWatch logging group for the Amazon Web Services Transfer server to which this workflow belongs.
String passiveIp
Indicates passive mode, for FTP and FTPS protocols. Enter a single IPv4 address, such as the public IP address of a firewall, router, or load balancer. For example:
aws transfer update-server --protocol-details PassiveIp=0.0.0.0
Replace 0.0.0.0 in the example above with the actual IP address you want to use.
If you change the PassiveIp value, you must stop and then restart your Transfer Family server for
the change to take effect. For details on using passive mode (PASV) in a NAT environment, see Configuring your FTPS server behind a firewall or NAT with Transfer Family.
String tlsSessionResumptionMode
A property used with Transfer Family servers that use the FTPS protocol. TLS Session Resumption provides a
mechanism to resume or share a negotiated secret key between the control and data connection for an FTPS session.
TlsSessionResumptionMode determines whether or not the server resumes recent, negotiated sessions
through a unique session ID. This property is available during CreateServer and
UpdateServer calls. If a TlsSessionResumptionMode value is not specified during
CreateServer, it is set to ENFORCED by default.
DISABLED: the server does not process TLS session resumption client requests and creates a new TLS
session for each request.
ENABLED: the server processes and accepts clients that are performing TLS session resumption. The
server doesn't reject client data connections that do not perform the TLS session resumption client processing.
ENFORCED: the server processes and accepts clients that are performing TLS session resumption. The
server rejects client data connections that do not perform the TLS session resumption client processing. Before
you set the value to ENFORCED, test your clients.
Not all FTPS clients perform TLS session resumption. So, if you choose to enforce TLS session resumption, you
prevent any connections from FTPS clients that don't perform the protocol negotiation. To determine whether or
not you can use the ENFORCED value, you need to test your clients.
String setStatOption
Use the SetStatOption to ignore the error that is generated when the client attempts to use
SETSTAT on a file you are uploading to an S3 bucket.
Some SFTP file transfer clients can attempt to change the attributes of remote files, including timestamp and
permissions, using commands, such as SETSTAT when uploading the file. However, these commands are
not compatible with object storage systems, such as Amazon S3. Due to this incompatibility, file uploads from
these clients can result in errors even when the file is otherwise successfully uploaded.
Set the value to ENABLE_NO_OP to have the Transfer Family server ignore the SETSTAT
command, and upload files without needing to make any changes to your SFTP client. While the
SetStatOption ENABLE_NO_OP setting ignores the error, it does generate a log entry in
Amazon CloudWatch Logs, so you can determine when the client is making a SETSTAT call.
If you want to preserve the original timestamp for your file, and modify other file attributes using
SETSTAT, you can use Amazon EFS as backend storage with Transfer Family.
String bucket
Specifies the S3 bucket that contains the file being used.
String key
The name assigned to the file when it was created in S3. You use the object key to retrieve the object.
String versionId
Specifies the file version.
String etag
The entity tag is a hash of the object. The ETag reflects changes only to the contents of an object, not its metadata.
String workflowId
A unique identifier for the workflow.
String executionId
A unique identifier for the execution of a workflow.
String token
Used to distinguish between multiple callbacks for multiple Lambda steps within the same execution.
String status
Indicates whether the specified step succeeded or failed.
UserDetails userDetails
The Server ID (ServerId), Session ID (SessionId) and user (UserName) make
up the UserDetails.
Date dateImported
Specifies the date that the public key was added to the user account.
String sshPublicKeyBody
Specifies the content of the SSH public key as specified by the PublicKeyId.
Transfer Family accepts RSA, ECDSA, and ED25519 keys.
String sshPublicKeyId
Specifies the SshPublicKeyId parameter contains the identifier of the public key.
String serverId
A system-assigned unique identifier for a server that you start.
String serverId
A system-assigned unique identifier for a server that you stopped.
String name
The name of the step, used as an identifier.
List<E> tags
Array that contains from 1 to 10 key/value pairs.
String sourceFileLocation
Specifies which file to use as input to the workflow step: either the output from the previous step, or the originally uploaded file for the workflow.
Enter ${previous.file} to use the previous file as the input. In this case, this workflow step uses
the output file from the previous workflow step as input. This is the default value.
Enter ${original.file} to use the originally-uploaded file location as input for this step.
String serverId
A system-assigned identifier for a specific server. That server's user authentication method is tested with a user name and password.
String serverProtocol
The type of file transfer protocol to be tested.
The available protocols are:
Secure Shell (SSH) File Transfer Protocol (SFTP)
File Transfer Protocol Secure (FTPS)
File Transfer Protocol (FTP)
String sourceIp
The source IP address of the user account to be tested.
String userName
The name of the user account to be tested.
String userPassword
The password of the user account to be tested.
String response
The response that is returned from your API Gateway.
Integer statusCode
The HTTP status code that is the response from your API Gateway.
String message
A message that indicates whether the test was successful or not.
If an empty string is returned, the most likely cause is that the authentication failed due to an incorrect username or password.
String url
The endpoint of the service used to authenticate a user.
String retryAfterSeconds
String arn
The value of the resource that will have the tag removed. An Amazon Resource Name (ARN) is an identifier for a specific Amazon Web Services resource, such as a server, user, or role.
List<E> tagKeys
TagKeys are key-value pairs assigned to ARNs that can be used to group and search for resources by type. This metadata can be attached to resources for any purpose.
String homeDirectory
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.
String homeDirectoryType
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 need to provide mappings in the
HomeDirectoryMappings for how you want to make Amazon S3 or EFS paths visible to your users.
List<E> homeDirectoryMappings
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": "/directory1", "Target": "/bucket_name/home/mydirectory" } ]
In most cases, you can use this value instead of the session 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" } ]
String policy
A session 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 the domain of ServerId is S3. EFS does not use session policies.
For session 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 session policy, see Example session policy.
For more information, see AssumeRole in the Amazon Web ServicesSecurity Token Service API Reference.
PosixProfile posixProfile
String role
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.
String serverId
A system-assigned unique identifier for a server instance. This is the specific server that you added your user to.
String externalId
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: =,.@:/-
String certificate
The Amazon Resource Name (ARN) of the Amazon Web ServicesCertificate Manager (ACM) certificate. Required when
Protocols is set to FTPS.
To request a new public certificate, see Request a public certificate in the Amazon Web ServicesCertificate Manager User Guide.
To import an existing certificate into ACM, see Importing certificates into ACM in the Amazon Web ServicesCertificate Manager User Guide.
To request a private certificate to use FTPS through private IP addresses, see Request a private certificate in the Amazon Web ServicesCertificate Manager User Guide.
Certificates with the following cryptographic algorithms and key sizes are supported:
2048-bit RSA (RSA_2048)
4096-bit RSA (RSA_4096)
Elliptic Prime Curve 256 bit (EC_prime256v1)
Elliptic Prime Curve 384 bit (EC_secp384r1)
Elliptic Prime Curve 521 bit (EC_secp521r1)
The certificate must be a valid SSL/TLS X.509 version 3 certificate with FQDN or IP address specified and information about the issuer.
ProtocolDetails protocolDetails
The protocol settings that are configured for your server.
Use the PassiveIp parameter to indicate passive mode (for FTP and FTPS protocols). Enter a single
dotted-quad IPv4 address, such as the external IP address of a firewall, router, or load balancer.
Use the SetStatOption to ignore the error that is generated when the client attempts to use SETSTAT
on a file you are uploading to an S3 bucket. Set the value to ENABLE_NO_OP to have the Transfer
Family server ignore the SETSTAT command, and upload files without needing to make any changes to your SFTP
client. Note that with SetStatOption set to ENABLE_NO_OP, Transfer generates a log
entry to CloudWatch Logs, so you can determine when the client is making a SETSTAT call.
Use the TlsSessionResumptionMode parameter to determine whether or not your Transfer server resumes
recent, negotiated sessions through a unique session ID.
EndpointDetails endpointDetails
The virtual private cloud (VPC) endpoint settings that are configured for your server. When you host your endpoint within your VPC, you can make it accessible only to resources within your VPC, or you can attach Elastic IP addresses and make it accessible to clients over the internet. Your VPC's default security groups are automatically assigned to your endpoint.
String endpointType
The type of endpoint that you want your server to use. You can choose to make your server's endpoint publicly accessible (PUBLIC) or host it inside your VPC. With an endpoint that is hosted in a VPC, you can restrict access to your server and resources only within your VPC or choose to make it internet facing by attaching Elastic IP addresses directly to it.
After May 19, 2021, you won't be able to create a server using EndpointType=VPC_ENDPOINT in your
Amazon Web Servicesaccount if your account hasn't already done so before May 19, 2021. If you have already
created servers with EndpointType=VPC_ENDPOINT in your Amazon Web Servicesaccount on or before May
19, 2021, you will not be affected. After this date, use EndpointType=VPC.
For more information, see https://docs.aws.amazon.com/transfer/latest/userguide/create-server-in-vpc.html#deprecate-vpc-endpoint.
It is recommended that you use VPC as the EndpointType. With this endpoint type, you
have the option to directly associate up to three Elastic IPv4 addresses (BYO IP included) with your server's
endpoint and use VPC security groups to restrict traffic by the client's public IP address. This is not possible
with EndpointType set to VPC_ENDPOINT.
String hostKey
The RSA, ECDSA, or ED25519 private key to use for your server.
Use the following command to generate an RSA 2048 bit key with no passphrase:
ssh-keygen -t rsa -b 2048 -N "" -m PEM -f my-new-server-key.
Use a minimum value of 2048 for the -b option: you can create a stronger key using 3072 or 4096.
Use the following command to generate an ECDSA 256 bit key with no passphrase:
ssh-keygen -t ecdsa -b 256 -N "" -m PEM -f my-new-server-key.
Valid values for the -b option for ECDSA are 256, 384, and 521.
Use the following command to generate an ED25519 key with no passphrase:
ssh-keygen -t ed25519 -N "" -f my-new-server-key.
For all of these commands, you can replace my-new-server-key with a string of your choice.
If you aren't planning to migrate existing users from an existing SFTP-enabled server to a new server, don't update the host key. Accidentally changing a server's host key can be disruptive.
For more information, see Change the host key for your SFTP-enabled server in the Amazon Web Services Transfer Family User Guide.
IdentityProviderDetails identityProviderDetails
An array containing all of the information required to call a customer's authentication API method.
String loggingRole
Specifies the Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) role that allows a server to turn on Amazon CloudWatch logging for Amazon S3 or Amazon EFS events. When set, user activity can be viewed in your CloudWatch logs.
String postAuthenticationLoginBanner
Specify a string to display when users connect to a server. This string is displayed after the user authenticates.
The SFTP protocol does not support post-authentication display banners.
String preAuthenticationLoginBanner
Specify a string to display when users connect to a server. This string is displayed before the user authenticates. For example, the following banner displays details about using the system.
This system is for the use of authorized users only. Individuals using this computer system without authority, or in excess of their authority, are subject to having all of their activities on this system monitored and recorded by system personnel.
List<E> protocols
Specifies the file transfer protocol or protocols over which your file transfer protocol client can connect to your server's endpoint. The available protocols are:
Secure Shell (SSH) File Transfer Protocol (SFTP): File transfer over SSH
File Transfer Protocol Secure (FTPS): File transfer with TLS encryption
File Transfer Protocol (FTP): Unencrypted file transfer
If you select FTPS, you must choose a certificate stored in Amazon Web ServicesCertificate Manager
(ACM) which will be used to identify your server when clients connect to it over FTPS.
If Protocol includes either FTP or FTPS, then the
EndpointType must be VPC and the IdentityProviderType must be
AWS_DIRECTORY_SERVICE or API_GATEWAY.
If Protocol includes FTP, then AddressAllocationIds cannot be associated.
If Protocol is set only to SFTP, the EndpointType can be set to
PUBLIC and the IdentityProviderType can be set to SERVICE_MANAGED.
String securityPolicyName
Specifies the name of the security policy that is attached to the server.
String serverId
A system-assigned unique identifier for a server instance that the user account is assigned to.
WorkflowDetails workflowDetails
Specifies the workflow ID for the workflow to assign and the execution role used for executing the workflow.
To remove an associated workflow from a server, you can provide an empty OnUpload object, as in the
following example.
aws transfer update-server --server-id s-01234567890abcdef --workflow-details '{"OnUpload":[]}'
String serverId
A system-assigned unique identifier for a server that the user account is assigned to.
String homeDirectory
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.
String homeDirectoryType
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 need to provide mappings in the
HomeDirectoryMappings for how you want to make Amazon S3 or EFS paths visible to your users.
List<E> homeDirectoryMappings
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": "/directory1", "Target": "/bucket_name/home/mydirectory" } ]
In most cases, you can use this value instead of the session 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" } ]
String policy
A session 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 the domain of ServerId is S3. EFS does not use session policies.
For session 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 session policy, see Creating a session policy.
For more information, see AssumeRole in the Amazon Web Services Security Token Service API Reference.
PosixProfile posixProfile
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
Systems (Amazon EFS). The POSIX permissions that are set on files and directories in your file system determines
the level of access your users get when transferring files into and out of your Amazon EFS file systems.
String role
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.
String serverId
A system-assigned unique identifier for a server instance that the user account is assigned to.
String userName
A unique string that identifies a user and is associated with a server as specified by the 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.
String userName
A unique string that identifies a user account associated with a server.
String serverId
The system-assigned unique identifier for a Transfer server instance.
String sessionId
The system-assigned unique identifier for a session that corresponds to the workflow.
List<E> onUpload
A trigger that starts a workflow: the workflow begins to execute after a file is uploaded.
To remove an associated workflow from a server, you can provide an empty OnUpload object, as in the
following example.
aws transfer update-server --server-id s-01234567890abcdef --workflow-details '{"OnUpload":[]}'
String type
Currently, the following step types are supported.
COPY: copy the file to another location
CUSTOM: custom step with a lambda target
DELETE: delete the file
TAG: add a tag to the file
CopyStepDetails copyStepDetails
Details for a step that performs a file copy.
Consists of the following values:
A description
An S3 location for the destination of the file copy.
A flag that indicates whether or not to overwrite an existing file of the same name. The default is
FALSE.
CustomStepDetails customStepDetails
Details for a step that invokes a lambda function.
Consists of the lambda function name, target, and timeout (in seconds).
DeleteStepDetails deleteStepDetails
Details for a step that deletes the file.
TagStepDetails tagStepDetails
Details for a step that creates one or more tags.
You specify one or more tags: each tag contains a key/value pair.
Copyright © 2022. All rights reserved.