interface CfnServerProps

Language	Type name
.NET	`Amazon.CDK.AWS.Transfer.CfnServerProps`
Java	`software.amazon.awscdk.services.transfer.CfnServerProps`
Python	`aws_cdk.aws_transfer.CfnServerProps`
TypeScript	`@aws-cdk/aws-transfer` » `CfnServerProps`

Properties for defining a CfnServer.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as transfer from '@aws-cdk/aws-transfer';
const cfnServerProps: transfer.CfnServerProps = {
  certificate: 'certificate',
  domain: 'domain',
  endpointDetails: {
    addressAllocationIds: ['addressAllocationIds'],
    securityGroupIds: ['securityGroupIds'],
    subnetIds: ['subnetIds'],
    vpcEndpointId: 'vpcEndpointId',
    vpcId: 'vpcId',
  },
  endpointType: 'endpointType',
  identityProviderDetails: {
    directoryId: 'directoryId',
    function: 'function',
    invocationRole: 'invocationRole',
    sftpAuthenticationMethods: 'sftpAuthenticationMethods',
    url: 'url',
  },
  identityProviderType: 'identityProviderType',
  loggingRole: 'loggingRole',
  postAuthenticationLoginBanner: 'postAuthenticationLoginBanner',
  preAuthenticationLoginBanner: 'preAuthenticationLoginBanner',
  protocolDetails: {
    as2Transports: ['as2Transports'],
    passiveIp: 'passiveIp',
    setStatOption: 'setStatOption',
    tlsSessionResumptionMode: 'tlsSessionResumptionMode',
  },
  protocols: ['protocols'],
  securityPolicyName: 'securityPolicyName',
  tags: [{
    key: 'key',
    value: 'value',
  }],
  workflowDetails: {
    onPartialUpload: [{
      executionRole: 'executionRole',
      workflowId: 'workflowId',
    }],
    onUpload: [{
      executionRole: 'executionRole',
      workflowId: 'workflowId',
    }],
  },
};

Properties

Name	Type	Description
certificate?	`string`	The Amazon Resource Name (ARN) of the AWS Certificate Manager (ACM) certificate.
domain?	`string`	Specifies the domain of the storage system that is used for file transfers.
endpointDetails?	`IResolvable` `\|` `EndpointDetailsProperty`	The virtual private cloud (VPC) endpoint settings that are configured for your server.
endpointType?	`string`	The type of endpoint that you want your server to use.
identityProviderDetails?	`IResolvable` `\|` `IdentityProviderDetailsProperty`	Required when `IdentityProviderType` is set to `AWS_DIRECTORY_SERVICE` , `AWS _LAMBDA` or `API_GATEWAY` .
identityProviderType?	`string`	The mode of authentication for a server.
loggingRole?	`string`	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.
postAuthenticationLoginBanner?	`string`	Specifies a string to display when users connect to a server. This string is displayed after the user authenticates.
preAuthenticationLoginBanner?	`string`	Specifies a string to display when users connect to a server.
protocolDetails?	`IResolvable` `\|` `ProtocolDetailsProperty`	The protocol settings that are configured for your server.
protocols?	`string[]`	Specifies the file transfer protocol or protocols over which your file transfer protocol client can connect to your server's endpoint.
securityPolicyName?	`string`	Specifies the name of the security policy that is attached to the server.
tags?	`CfnTag[]`	Key-value pairs that can be used to group and search for servers.
workflowDetails?	`IResolvable` `\|` `WorkflowDetailsProperty`	Specifies the workflow ID for the workflow to assign and the execution role that's used for executing the workflow.

certificate?

Type: string (optional)

The Amazon Resource Name (ARN) of the AWS Certificate Manager (ACM) certificate.

Required when Protocols is set to FTPS .

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)

The certificate must be a valid SSL/TLS X.509 version 3 certificate with FQDN or IP address specified and information about the issuer.

domain?

Type: string (optional)

Specifies the domain of the storage system that is used for file transfers.

endpointDetails?

Type: IResolvable | EndpointDetailsProperty (optional)

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.

endpointType?

Type: string (optional)

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.

identityProviderDetails?

Type: IResolvable | IdentityProviderDetailsProperty (optional)

Required when IdentityProviderType is set to AWS_DIRECTORY_SERVICE , AWS _LAMBDA 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 .

identityProviderType?

Type: string (optional)

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 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 Amazon API Gateway endpoint URL to call for authentication by using the IdentityProviderDetails 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 the Function parameter for the IdentityProviderDetails data type.

loggingRole?

Type: string (optional)

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.

postAuthenticationLoginBanner?

Type: string (optional)

Specifies 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.

preAuthenticationLoginBanner?

Type: string (optional)

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.

protocolDetails?

Type: IResolvable | ProtocolDetailsProperty (optional)

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 the SetStatOption parameter. To have the AWS Transfer Family server ignore the SETSTAT command and upload files without needing to make any changes to your SFTP client, set the value to ENABLE_NO_OP . If you set the SetStatOption parameter to ENABLE_NO_OP , Transfer Family generates a log entry to Amazon CloudWatch Logs, so that you can determine when the client is making a SETSTAT 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.

protocols?

Type: string[] (optional)

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

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 either FTP or FTPS , then the EndpointType must be VPC and the IdentityProviderType must be either AWS_DIRECTORY_SERVICE , AWS_LAMBDA , 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 any of the supported identity types: SERVICE_MANAGED , AWS_DIRECTORY_SERVICE , AWS_LAMBDA , or API_GATEWAY .

If Protocol includes AS2 , then the EndpointType must be VPC , and domain must be Amazon S3.

securityPolicyName?

Type: string (optional)

Specifies the name of the security policy that is attached to the server.

tags?

Type: CfnTag[] (optional)

Key-value pairs that can be used to group and search for servers.

workflowDetails?

Type: IResolvable | WorkflowDetailsProperty (optional)

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.