AWS::Transfer::Server
Instantiates an auto-scaling virtual server based on the selected file transfer protocol
in AWS. When you make updates to your file transfer protocol-enabled server or when you work
with users, use the service-generated ServerId
property that is assigned to the
newly created server.
Syntax
To declare this entity in your AWS CloudFormation template, use the following syntax:
JSON
{ "Type" : "AWS::Transfer::Server", "Properties" : { "Certificate" :
String
, "Domain" :String
, "EndpointDetails" :EndpointDetails
, "EndpointType" :String
, "IdentityProviderDetails" :IdentityProviderDetails
, "IdentityProviderType" :String
, "LoggingRole" :String
, "PostAuthenticationLoginBanner" :String
, "PreAuthenticationLoginBanner" :String
, "ProtocolDetails" :ProtocolDetails
, "Protocols" :[ Protocol, ... ]
, "SecurityPolicyName" :String
, "Tags" :[ Tag, ... ]
, "WorkflowDetails" :WorkflowDetails
} }
YAML
Type: AWS::Transfer::Server Properties: Certificate:
String
Domain:String
EndpointDetails:EndpointDetails
EndpointType:String
IdentityProviderDetails:IdentityProviderDetails
IdentityProviderType:String
LoggingRole:String
PostAuthenticationLoginBanner:String
PreAuthenticationLoginBanner:String
ProtocolDetails:ProtocolDetails
Protocols:- Protocol
SecurityPolicyName:String
Tags:- Tag
WorkflowDetails:WorkflowDetails
Properties
Certificate
-
The Amazon Resource Name (ARN) of the AWS Certificate Manager (ACM) certificate. Required when
Protocols
is set toFTPS
.To request a new public certificate, see Request a public certificate in the AWS Certificate Manager User Guide.
To import an existing certificate into ACM, see Importing certificates into ACM in the AWS Certificate Manager User Guide.
To request a private certificate to use FTPS through private IP addresses, see Request a private certificate in the AWS 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)
Note The certificate must be a valid SSL/TLS X.509 version 3 certificate with FQDN or IP address specified and information about the issuer.
Required: No
Type: String
Maximum:
1600
Update requires: No interruption
-
Domain
-
Specifies the domain of the storage system that is used for file transfers.
Required: No
Type: String
Allowed values:
EFS | S3
Update requires: Replacement
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 your endpoint accessible only to resources within your VPC, or you can attach Elastic IP addresses and make your endpoint accessible to clients over the internet. Your VPC's default security groups are automatically assigned to your endpoint.
Required: No
Type: EndpointDetails
Update requires: No interruption
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.
Required: No
Type: String
Allowed values:
PUBLIC | VPC | VPC_ENDPOINT
Update requires: No interruption
IdentityProviderDetails
-
Required when
IdentityProviderType
is set toAWS_DIRECTORY_SERVICE
orAPI_GATEWAY
. Accepts an array containing all of the information required to use a directory inAWS_DIRECTORY_SERVICE
or invoke a customer-supplied authentication API, including the API Gateway URL. Not required whenIdentityProviderType
is set toSERVICE_MANAGED
.Required: No
Type: IdentityProviderDetails
Update requires: No interruption
IdentityProviderType
-
The mode of authentication for a server. The default value is
SERVICE_MANAGED
, which allows you to store and access user credentials within the AWS Transfer Family service.Use
AWS_DIRECTORY_SERVICE
to provide access to Active Directory groups in AWS Directory Service for Microsoft Active Directory or Microsoft Active Directory in your on-premises environment or in AWS using AD Connector. This option also requires you to provide a Directory ID by using theIdentityProviderDetails
parameter.Use the
API_GATEWAY
value to integrate with an identity provider of your choosing. TheAPI_GATEWAY
setting requires you to provide an Amazon API Gateway endpoint URL to call for authentication by using theIdentityProviderDetails
parameter.Use the
AWS_LAMBDA
value to directly use an AWS Lambda function as your identity provider. If you choose this value, you must specify the ARN for the Lambda function in theFunction
parameter or theIdentityProviderDetails
data type.Required: No
Type: String
Allowed values:
API_GATEWAY | AWS_DIRECTORY_SERVICE | AWS_LAMBDA | SERVICE_MANAGED
Update requires: Replacement
LoggingRole
-
The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that allows a server to turn on Amazon CloudWatch logging for Amazon S3 or Amazon EFSevents. When set, you can view user activity in your CloudWatch logs.
Required: No
Type: String
Minimum:
20
Maximum:
2048
Pattern:
arn:.*role/.*
Update requires: No interruption
PostAuthenticationLoginBanner
-
Specifies a string to display when users connect to a server. This string is displayed after the user authenticates.
Note The SFTP protocol does not support post-authentication display banners.
Required: No
Type: String
Maximum:
512
Pattern:
[\x09-\x0D\x20-\x7E]*
Update requires: No interruption
PreAuthenticationLoginBanner
-
Specifies 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.
Required: No
Type: String
Maximum:
512
Pattern:
[\x09-\x0D\x20-\x7E]*
Update requires: No interruption
ProtocolDetails
-
The protocol settings that are configured for your server.
-
To indicate passive mode (for FTP and FTPS protocols), use the
PassiveIp
parameter. Enter a single dotted-quad IPv4 address, such as the external IP address of a firewall, router, or load balancer. -
To ignore the error that is generated when the client attempts to use the
SETSTAT
command on a file that you are uploading to an Amazon S3 bucket, use theSetStatOption
parameter. To have the AWS Transfer Family server ignore theSETSTAT
command and upload files without needing to make any changes to your SFTP client, set the value toENABLE_NO_OP
. If you set theSetStatOption
parameter toENABLE_NO_OP
, Transfer Family generates a log entry to Amazon CloudWatch Logs, so that you can determine when the client is making aSETSTAT
call. -
To determine whether your AWS Transfer Family server resumes recent, negotiated sessions through a unique session ID, use the
TlsSessionResumptionMode
parameter. -
As2Transports
indicates the transport method for the AS2 messages. Currently, only HTTP is supported.
Required: No
Type: ProtocolDetails
Update requires: No interruption
-
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 -
AS2
(Applicability Statement 2): used for transporting structured business-to-business data
Note -
If you select
FTPS
, you must choose a certificate stored in AWS Certificate Manager (ACM) which is used to identify your server when clients connect to it over FTPS. -
If
Protocol
includes eitherFTP
orFTPS
, then theEndpointType
must beVPC
and theIdentityProviderType
must be eitherAWS_DIRECTORY_SERVICE
,AWS_LAMBDA
, orAPI_GATEWAY
. -
If
Protocol
includesFTP
, thenAddressAllocationIds
cannot be associated. -
If
Protocol
is set only toSFTP
, theEndpointType
can be set toPUBLIC
and theIdentityProviderType
can be set any of the supported identity types:SERVICE_MANAGED
,AWS_DIRECTORY_SERVICE
,AWS_LAMBDA
, orAPI_GATEWAY
. -
If
Protocol
includesAS2
, then theEndpointType
must beVPC
, and domain must be Amazon S3.
Required: No
Type: List of Protocol
Maximum:
4
Update requires: No interruption
-
SecurityPolicyName
-
Specifies the name of the security policy that is attached to the server.
Required: No
Type: String
Maximum:
100
Pattern:
TransferSecurityPolicy-.+
Update requires: No interruption
Tags
-
Key-value pairs that can be used to group and search for servers.
Required: No
Type: List of Tag
Maximum:
50
Update requires: No interruption
WorkflowDetails
-
Specifies the workflow ID for the workflow to assign and the execution role that's used for executing the workflow.
In addition to a workflow to execute when a file is uploaded completely,
WorkflowDetails
can also contain a workflow ID (and execution role) for a workflow to execute on partial upload. A partial upload occurs when a file is open when the session disconnects.Required: No
Type: WorkflowDetails
Update requires: No interruption
Return values
Ref
When you pass the logical ID of this resource to the intrinsic Ref
function, Ref
returns the server ARN, such as
arn:aws:transfer:us-east-1:123456789012:server/s-01234567890abcdef
.
For more information about using the Ref
function, see Ref.
Fn::GetAtt
The Fn::GetAtt
intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.
For more information about using the Fn::GetAtt
intrinsic function, see Fn::GetAtt.
Arn
-
The Amazon Resource Name associated with the server, in the form
arn:aws:transfer:region:account-id:server/server-id/
.An example of a server ARN is:
arn:aws:transfer:us-east-1:123456789012:server/s-01234567890abcdef
. ServerId
-
The service-assigned ID of the server that is created.
An example
ServerId
iss-01234567890abcdef
.
Examples
Create a server with VPC hosted endpoint type
The following example creates a Secure Shell (SSH) File Transfer Protocol (SFTP)-enabled server using a VPC hosted endpoint type with a custom identity provider, a CloudWatch logging role, security policy, and tags.
JSON
{ "AWSTemplateFormatVersion": "2010-09-09", "Description": "creates SFTP Server", "Resources": { "MyTransferServer": { "Type": "AWS::Transfer::Server", "Properties": { "EndpointDetails": { "AddressAllocationIds": [ "AddressAllocationId-1", "AddressAllocationId-2" ], "SubnetIds": [ "SubnetId-1", "SubnetId-2" ], "VpcId": "VpcId" }, "EndpointType": "VPC", "LoggingRole": "Logging-Role-ARN", "Protocols": [ "SFTP" ], "SecurityPolicyName": "Security-Policy-Name", "IdentityProviderDetails": { "InvocationRole": "Invocation-Role-ARN", "Url": "API_GATEWAY-Invocation-URL" }, "IdentityProviderType": "API_GATEWAY", "Tags": [ { "Key": "KeyName", "Value": "ValueName" } ] } } } }
YAML
AWSTemplateFormatVersion: '2010-09-09' Description: creates SFTP Server Resources: MyTransferServer: Type : AWS::Transfer::Server Properties : EndpointDetails: AddressAllocationIds: - AddressAllocationId-1 - AddressAllocationId-2 SubnetIds: - SubnetId-1 - SubnetId-2 VpcId: VpcId EndpointType: VPC LoggingRole: Logging-Role-ARN Protocols: - SFTP SecurityPolicyName: Security-Policy-Name IdentityProviderDetails: InvocationRole: Invocation-Role-ARN Url: API_GATEWAY-Invocation-URL IdentityProviderType: API_GATEWAY Tags: - Key: KeyName Value: ValueName
See also
CreateServer in the AWS Transfer Family User Guide.