Package software.amazon.awscdk.services.transfer

Class CfnServer

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.transfer.CfnServer
All Implemented Interfaces:
IInspectable, ITaggable, IServerRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.113.0 (build fc68b25)", date="2025-10-14T12:28:22.036Z") @Stability(Stable) public class CfnServer extends CfnResource implements IInspectable, IServerRef, ITaggable
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")
         .ipAddressType("ipAddressType")
         .loggingRole("loggingRole")
         .postAuthenticationLoginBanner("postAuthenticationLoginBanner")
         .preAuthenticationLoginBanner("preAuthenticationLoginBanner")
         .protocolDetails(ProtocolDetailsProperty.builder()
                 .as2Transports(List.of("as2Transports"))
                 .passiveIp("passiveIp")
                 .setStatOption("setStatOption")
                 .tlsSessionResumptionMode("tlsSessionResumptionMode")
                 .build())
         .protocols(List.of("protocols"))
         .s3StorageOptions(S3StorageOptionsProperty.builder()
                 .directoryListingOptimization("directoryListingOptimization")
                 .build())
         .securityPolicyName("securityPolicyName")
         .structuredLogDestinations(List.of("structuredLogDestinations"))
         .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();

See Also:

  • 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 software.constructs.Construct scope, @NotNull String id, @Nullable CfnServerProps props)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties.

    • CfnServer

      @Stability(Stable) public CfnServer(@NotNull software.constructs.Construct scope, @NotNull String id)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). 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()
      Specifies the unique Amazon Resource Name (ARN) of the server.

    • getAttrAs2ServiceManagedEgressIpAddresses

      @Stability(Stable) @NotNull public List<String> getAttrAs2ServiceManagedEgressIpAddresses()
      The list of egress IP addresses of this server.

      These IP addresses are only relevant for servers that use the AS2 protocol. They are used for sending asynchronous MDNs.

      These IP addresses are assigned automatically when you create an AS2 server. Additionally, if you update an existing server and add the AS2 protocol, static IP addresses are assigned as well.

    • getAttrServerId

      @Stability(Stable) @NotNull public String getAttrServerId()
      Specifies the unique system-assigned identifier for a server that you instantiate.

    • getAttrState

      @Stability(Stable) @NotNull public String getAttrState()
      The condition of 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.

    • getCfnProperties

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

    • getServerRef

      @Stability(Stable) @NotNull public ServerReference getServerRef()
      A reference to a Server resource.
      Specified by:
      getServerRef in interface IServerRef

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getTags in interface ITaggable

    • getCertificate

      @Stability(Stable) @Nullable public String getCertificate()
      The Amazon Resource Name (ARN) of the Certificate Manager (ACM) certificate.

      Required when Protocols is set to FTPS .

    • setCertificate

      @Stability(Stable) public void setCertificate(@Nullable String value)
      The Amazon Resource Name (ARN) of the Certificate Manager (ACM) certificate.

      Required when Protocols is set to FTPS .

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

    • setEndpointDetails

      @Stability(Stable) public void setEndpointDetails(@Nullable IResolvable value)
      The virtual private cloud (VPC) endpoint settings that are configured for your server.

    • setEndpointDetails

      @Stability(Stable) public void setEndpointDetails(@Nullable CfnServer.EndpointDetailsProperty value)
      The virtual private cloud (VPC) endpoint settings that are configured for your server.

    • getEndpointType

      @Stability(Stable) @Nullable public String getEndpointType()
      The type of endpoint that you want your server to use.

    • setEndpointType

      @Stability(Stable) public void setEndpointType(@Nullable String value)
      The type of endpoint that you want your server to use.

    • getIdentityProviderDetails

      @Stability(Stable) @Nullable public Object getIdentityProviderDetails()
      Required when IdentityProviderType is set to AWS_DIRECTORY_SERVICE , AWS _LAMBDA or API_GATEWAY .

    • setIdentityProviderDetails

      @Stability(Stable) public void setIdentityProviderDetails(@Nullable IResolvable value)
      Required when IdentityProviderType is set to AWS_DIRECTORY_SERVICE , AWS _LAMBDA or API_GATEWAY .

    • setIdentityProviderDetails

      @Stability(Stable) public void setIdentityProviderDetails(@Nullable CfnServer.IdentityProviderDetailsProperty value)
      Required when IdentityProviderType is set to AWS_DIRECTORY_SERVICE , AWS _LAMBDA or API_GATEWAY .

    • getIdentityProviderType

      @Stability(Stable) @Nullable public String getIdentityProviderType()
      The mode of authentication for a server.

    • setIdentityProviderType

      @Stability(Stable) public void setIdentityProviderType(@Nullable String value)
      The mode of authentication for a server.

    • getIpAddressType

      @Stability(Stable) @Nullable public String getIpAddressType()
      Specifies whether to use IPv4 only, or to use dual-stack (IPv4 and IPv6) for your AWS Transfer Family endpoint.

    • setIpAddressType

      @Stability(Stable) public void setIpAddressType(@Nullable String value)
      Specifies whether to use IPv4 only, or to use dual-stack (IPv4 and IPv6) for your AWS Transfer Family endpoint.

    • 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 EFS events.

    • 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 EFS events.

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

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

    • getPreAuthenticationLoginBanner

      @Stability(Stable) @Nullable public String getPreAuthenticationLoginBanner()
      Specifies a string to display when users connect to a server.

    • setPreAuthenticationLoginBanner

      @Stability(Stable) public void setPreAuthenticationLoginBanner(@Nullable String value)
      Specifies a string to display when users connect to a server.

    • getProtocolDetails

      @Stability(Stable) @Nullable public Object getProtocolDetails()
      The protocol settings that are configured for your server.

    • setProtocolDetails

      @Stability(Stable) public void setProtocolDetails(@Nullable IResolvable value)
      The protocol settings that are configured for your server.

    • setProtocolDetails

      @Stability(Stable) public void setProtocolDetails(@Nullable CfnServer.ProtocolDetailsProperty value)
      The protocol settings that are configured for your server.

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

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

    • getS3StorageOptions

      @Stability(Stable) @Nullable public Object getS3StorageOptions()
      Specifies whether or not performance for your Amazon S3 directories is optimized.

    • setS3StorageOptions

      @Stability(Stable) public void setS3StorageOptions(@Nullable IResolvable value)
      Specifies whether or not performance for your Amazon S3 directories is optimized.

    • setS3StorageOptions

      @Stability(Stable) public void setS3StorageOptions(@Nullable CfnServer.S3StorageOptionsProperty value)
      Specifies whether or not performance for your Amazon S3 directories is optimized.

    • getSecurityPolicyName

      @Stability(Stable) @Nullable public String getSecurityPolicyName()
      Specifies the name of the security policy for the server.

    • setSecurityPolicyName

      @Stability(Stable) public void setSecurityPolicyName(@Nullable String value)
      Specifies the name of the security policy for the server.

    • getStructuredLogDestinations

      @Stability(Stable) @Nullable public List<String> getStructuredLogDestinations()
      Specifies the log groups to which your server logs are sent.

    • setStructuredLogDestinations

      @Stability(Stable) public void setStructuredLogDestinations(@Nullable List<String> value)
      Specifies the log groups to which your server logs are sent.

    • getTagsRaw

      @Stability(Stable) @Nullable public List<CfnTag> getTagsRaw()
      Key-value pairs that can be used to group and search for servers.

    • setTagsRaw

      @Stability(Stable) public void setTagsRaw(@Nullable List<CfnTag> value)
      Key-value pairs that can be used to group and search for servers.

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

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

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