Package software.amazon.awscdk.services.transfer

Class CfnServer

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.transfer.CfnServer
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:35.917Z") @Stability(Stable) public class CfnServer extends CfnResource implements IInspectable
A CloudFormation 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.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.transfer.*;
 CfnServer cfnServer = CfnServer.Builder.create(this, "MyCfnServer")
         .certificate("certificate")
         .domain("domain")
         .endpointDetails(EndpointDetailsProperty.builder()
                 .addressAllocationIds(List.of("addressAllocationIds"))
                 .securityGroupIds(List.of("securityGroupIds"))
                 .subnetIds(List.of("subnetIds"))
                 .vpcEndpointId("vpcEndpointId")
                 .vpcId("vpcId")
                 .build())
         .endpointType("endpointType")
         .identityProviderDetails(IdentityProviderDetailsProperty.builder()
                 .directoryId("directoryId")
                 .function("function")
                 .invocationRole("invocationRole")
                 .sftpAuthenticationMethods("sftpAuthenticationMethods")
                 .url("url")
                 .build())
         .identityProviderType("identityProviderType")
         .loggingRole("loggingRole")
         .postAuthenticationLoginBanner("postAuthenticationLoginBanner")
         .preAuthenticationLoginBanner("preAuthenticationLoginBanner")
         .protocolDetails(ProtocolDetailsProperty.builder()
                 .as2Transports(List.of("as2Transports"))
                 .passiveIp("passiveIp")
                 .setStatOption("setStatOption")
                 .tlsSessionResumptionMode("tlsSessionResumptionMode")
                 .build())
         .protocols(List.of("protocols"))
         .securityPolicyName("securityPolicyName")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .workflowDetails(WorkflowDetailsProperty.builder()
                 .onPartialUpload(List.of(WorkflowDetailProperty.builder()
                         .executionRole("executionRole")
                         .workflowId("workflowId")
                         .build()))
                 .onUpload(List.of(WorkflowDetailProperty.builder()
                         .executionRole("executionRole")
                         .workflowId("workflowId")
                         .build()))
                 .build())
         .build();

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnServer

      protected CfnServer(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnServer

      protected CfnServer(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnServer

      @Stability(Stable) public CfnServer(@NotNull Construct scope, @NotNull String id, @Nullable CfnServerProps props)
      Create a new AWS::Transfer::Server.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.
      props -
      • resource properties.

    • CfnServer

      @Stability(Stable) public CfnServer(@NotNull Construct scope, @NotNull String id)
      Create a new AWS::Transfer::Server.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector -
      • tree inspector to collect and process attributes.
      This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      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 .

    • getAttrServerId

      @Stability(Stable) @NotNull public String getAttrServerId()
      The service-assigned ID of the server that is created.

      An example ServerId is s-01234567890abcdef .

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      Key-value pairs that can be used to group and search for servers.

    • getCertificate

      @Stability(Stable) @Nullable public String getCertificate()
      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.

    • setCertificate

      @Stability(Stable) public void setCertificate(@Nullable String value)
      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.

    • getDomain

      @Stability(Stable) @Nullable public String getDomain()
      Specifies the domain of the storage system that is used for file transfers.

    • setDomain

      @Stability(Stable) public void setDomain(@Nullable String value)
      Specifies the domain of the storage system that is used for file transfers.

    • getEndpointDetails

      @Stability(Stable) @Nullable public Object getEndpointDetails()
      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.

    • setEndpointDetails

      @Stability(Stable) public void setEndpointDetails(@Nullable IResolvable value)
      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.

    • setEndpointDetails

      @Stability(Stable) public void setEndpointDetails(@Nullable CfnServer.EndpointDetailsProperty value)
      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.

    • getEndpointType

      @Stability(Stable) @Nullable public String getEndpointType()
      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.

    • setEndpointType

      @Stability(Stable) public void setEndpointType(@Nullable String value)
      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.

    • getIdentityProviderDetails

      @Stability(Stable) @Nullable public Object getIdentityProviderDetails()
      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 .

    • setIdentityProviderDetails

      @Stability(Stable) public void setIdentityProviderDetails(@Nullable IResolvable value)
      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 .

    • setIdentityProviderDetails

      @Stability(Stable) public void setIdentityProviderDetails(@Nullable CfnServer.IdentityProviderDetailsProperty value)
      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 .

    • getIdentityProviderType

      @Stability(Stable) @Nullable public String getIdentityProviderType()
      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.

    • setIdentityProviderType

      @Stability(Stable) public void setIdentityProviderType(@Nullable String value)
      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.

    • getLoggingRole

      @Stability(Stable) @Nullable public String getLoggingRole()
      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.

    • setLoggingRole

      @Stability(Stable) public void setLoggingRole(@Nullable String value)
      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.

    • getPostAuthenticationLoginBanner

      @Stability(Stable) @Nullable public String getPostAuthenticationLoginBanner()
      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.

    • setPostAuthenticationLoginBanner

      @Stability(Stable) public void setPostAuthenticationLoginBanner(@Nullable String value)
      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.

    • getPreAuthenticationLoginBanner

      @Stability(Stable) @Nullable public String getPreAuthenticationLoginBanner()
      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.

    • setPreAuthenticationLoginBanner

      @Stability(Stable) public void setPreAuthenticationLoginBanner(@Nullable String value)
      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.

    • getProtocolDetails

      @Stability(Stable) @Nullable public Object getProtocolDetails()
      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.

    • setProtocolDetails

      @Stability(Stable) public void setProtocolDetails(@Nullable IResolvable value)
      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.

    • setProtocolDetails

      @Stability(Stable) public void setProtocolDetails(@Nullable CfnServer.ProtocolDetailsProperty value)
      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.

    • getProtocols

      @Stability(Stable) @Nullable public List<String> getProtocols()
      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.

    • setProtocols

      @Stability(Stable) public void setProtocols(@Nullable List<String> value)
      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.

    • getSecurityPolicyName

      @Stability(Stable) @Nullable public String getSecurityPolicyName()
      Specifies the name of the security policy that is attached to the server.

    • setSecurityPolicyName

      @Stability(Stable) public void setSecurityPolicyName(@Nullable String value)
      Specifies the name of the security policy that is attached to the server.

    • getWorkflowDetails

      @Stability(Stable) @Nullable public Object getWorkflowDetails()
      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.

    • setWorkflowDetails

      @Stability(Stable) public void setWorkflowDetails(@Nullable IResolvable value)
      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.

    • setWorkflowDetails

      @Stability(Stable) public void setWorkflowDetails(@Nullable CfnServer.WorkflowDetailsProperty value)
      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.