CfnServer

java.lang.Object
- 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

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:40.271Z")
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")
                 .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();

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`CfnServer.Builder` A fluent builder for `CfnServer`.
`static interface`	`CfnServer.EndpointDetailsProperty` The virtual private cloud (VPC) endpoint settings that are configured for your server.
`static interface`	`CfnServer.IdentityProviderDetailsProperty` Required when `IdentityProviderType` is set to `AWS_DIRECTORY_SERVICE` or `API_GATEWAY` .
`static interface`	`CfnServer.ProtocolDetailsProperty` Protocol settings that are configured for your server.
`static interface`	`CfnServer.WorkflowDetailProperty` Specifies the workflow ID for the workflow to assign and the execution role that's used for executing the workflow.
`static interface`	`CfnServer.WorkflowDetailsProperty` Container for the `WorkflowDetail` data type.

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct
IConstruct.Jsii$Default

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`CFN_RESOURCE_TYPE_NAME` The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors
Modifier	Constructor and Description
	`CfnServer(Construct scope, java.lang.String id)` Create a new `AWS::Transfer::Server`.
	`CfnServer(Construct scope, java.lang.String id, CfnServerProps props)` Create a new `AWS::Transfer::Server`.
`protected`	`CfnServer(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)`
`protected`	`CfnServer(software.amazon.jsii.JsiiObjectRef objRef)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.String`	`getAttrArn()` The Amazon Resource Name associated with the server, in the form `arn:aws:transfer:region: account-id :server/ server-id /` .
`java.lang.String`	`getAttrServerId()` The service-assigned ID of the server that is created.
`java.lang.String`	`getCertificate()` The Amazon Resource Name (ARN) of the AWS Certificate Manager (ACM) certificate.
`protected java.util.Map<java.lang.String,java.lang.Object>`	`getCfnProperties()`
`java.lang.String`	`getDomain()` Specifies the domain of the storage system that is used for file transfers.
`java.lang.Object`	`getEndpointDetails()` The virtual private cloud (VPC) endpoint settings that are configured for your server.
`java.lang.String`	`getEndpointType()` The type of endpoint that you want your server to use.
`java.lang.Object`	`getIdentityProviderDetails()` Required when `IdentityProviderType` is set to `AWS_DIRECTORY_SERVICE` or `API_GATEWAY` .
`java.lang.String`	`getIdentityProviderType()` The mode of authentication for a server.
`java.lang.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.
`java.lang.String`	`getPostAuthenticationLoginBanner()` Specifies a string to display when users connect to a server.
`java.lang.String`	`getPreAuthenticationLoginBanner()` Specifies a string to display when users connect to a server.
`java.lang.Object`	`getProtocolDetails()` The protocol settings that are configured for your server.
`java.util.List<java.lang.String>`	`getProtocols()` Specifies the file transfer protocol or protocols over which your file transfer protocol client can connect to your server's endpoint.
`java.lang.String`	`getSecurityPolicyName()` Specifies the name of the security policy that is attached to the server.
`TagManager`	`getTags()` Key-value pairs that can be used to group and search for servers.
`java.lang.Object`	`getWorkflowDetails()` Specifies the workflow ID for the workflow to assign and the execution role that's used for executing the workflow.
`void`	`inspect(TreeInspector inspector)` Examines the CloudFormation resource and discloses attributes.
`protected java.util.Map<java.lang.String,java.lang.Object>`	`renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)`
`void`	`setCertificate(java.lang.String value)` The Amazon Resource Name (ARN) of the AWS Certificate Manager (ACM) certificate.
`void`	`setDomain(java.lang.String value)` Specifies the domain of the storage system that is used for file transfers.
`void`	`setEndpointDetails(CfnServer.EndpointDetailsProperty value)` The virtual private cloud (VPC) endpoint settings that are configured for your server.
`void`	`setEndpointDetails(IResolvable value)` The virtual private cloud (VPC) endpoint settings that are configured for your server.
`void`	`setEndpointType(java.lang.String value)` The type of endpoint that you want your server to use.
`void`	`setIdentityProviderDetails(CfnServer.IdentityProviderDetailsProperty value)` Required when `IdentityProviderType` is set to `AWS_DIRECTORY_SERVICE` or `API_GATEWAY` .
`void`	`setIdentityProviderDetails(IResolvable value)` Required when `IdentityProviderType` is set to `AWS_DIRECTORY_SERVICE` or `API_GATEWAY` .
`void`	`setIdentityProviderType(java.lang.String value)` The mode of authentication for a server.
`void`	`setLoggingRole(java.lang.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.
`void`	`setPostAuthenticationLoginBanner(java.lang.String value)` Specifies a string to display when users connect to a server.
`void`	`setPreAuthenticationLoginBanner(java.lang.String value)` Specifies a string to display when users connect to a server.
`void`	`setProtocolDetails(CfnServer.ProtocolDetailsProperty value)` The protocol settings that are configured for your server.
`void`	`setProtocolDetails(IResolvable value)` The protocol settings that are configured for your server.
`void`	`setProtocols(java.util.List<java.lang.String> value)` Specifies the file transfer protocol or protocols over which your file transfer protocol client can connect to your server's endpoint.
`void`	`setSecurityPolicyName(java.lang.String value)` Specifies the name of the security policy that is attached to the server.
`void`	`setWorkflowDetails(CfnServer.WorkflowDetailsProperty value)` Specifies the workflow ID for the workflow to assign and the execution role that's used for executing the workflow.
`void`	`setWorkflowDetails(IResolvable value)` Specifies the workflow ID for the workflow to assign and the execution role that's used for executing the workflow.

Methods inherited from class software.amazon.awscdk.core.CfnResource
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement
getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - CFN_RESOURCE_TYPE_NAME
```
public static final java.lang.String CFN_RESOURCE_TYPE_NAME
```
    The CloudFormation resource type name for this resource class.
- Constructor Detail
  - CfnServer
```
protected CfnServer(software.amazon.jsii.JsiiObjectRef objRef)
```
  - CfnServer
```
protected CfnServer(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
```
  - CfnServer
```
public CfnServer(Construct scope,
                 java.lang.String id,
                 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
```
public CfnServer(Construct scope,
                 java.lang.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 Detail
  - inspect
```
public void inspect(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
```
protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
```
    Overrides:
    
    renderProperties in class CfnResource
    
    Parameters:
    
    props - This parameter is required.
  - getAttrArn
```
public java.lang.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
```
public java.lang.String getAttrServerId()
```
    The service-assigned ID of the server that is created.
    An example ServerId is s-01234567890abcdef .
  - getCfnProperties
```
protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
```
    Overrides:
    
    getCfnProperties in class CfnResource
  - getTags
```
public TagManager getTags()
```
    Key-value pairs that can be used to group and search for servers.
  - getCertificate
```
public java.lang.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
```
public void setCertificate(java.lang.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
```
public java.lang.String getDomain()
```
    Specifies the domain of the storage system that is used for file transfers.
  - setDomain
```
public void setDomain(java.lang.String value)
```
    Specifies the domain of the storage system that is used for file transfers.
  - getEndpointDetails
```
public java.lang.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
```
public void setEndpointDetails(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
```
public void setEndpointDetails(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
```
public java.lang.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
```
public void setEndpointType(java.lang.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
```
public java.lang.Object getIdentityProviderDetails()
```
    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 .
  - setIdentityProviderDetails
```
public void setIdentityProviderDetails(IResolvable value)
```
    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 .
  - setIdentityProviderDetails
```
public void setIdentityProviderDetails(CfnServer.IdentityProviderDetailsProperty value)
```
    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 .
  - getIdentityProviderType
```
public java.lang.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 or the IdentityProviderDetails data type.
  - setIdentityProviderType
```
public void setIdentityProviderType(java.lang.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 or the IdentityProviderDetails data type.
  - getLoggingRole
```
public java.lang.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
```
public void setLoggingRole(java.lang.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
```
public java.lang.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
```
public void setPostAuthenticationLoginBanner(java.lang.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
```
public java.lang.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
```
public void setPreAuthenticationLoginBanner(java.lang.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
```
public java.lang.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
```
public void setProtocolDetails(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
```
public void setProtocolDetails(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
```
public java.util.List<java.lang.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
```
public void setProtocols(java.util.List<java.lang.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
```
public java.lang.String getSecurityPolicyName()
```
    Specifies the name of the security policy that is attached to the server.
  - setSecurityPolicyName
```
public void setSecurityPolicyName(java.lang.String value)
```
    Specifies the name of the security policy that is attached to the server.
  - getWorkflowDetails
```
public java.lang.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
```
public void setWorkflowDetails(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
```
public void setWorkflowDetails(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.

Class CfnServer

Nested Class Summary

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

Field Summary

Constructor Summary

Method Summary

Methods inherited from class software.amazon.awscdk.core.CfnResource

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

Methods inherited from class software.amazon.awscdk.core.CfnElement

Methods inherited from class software.amazon.awscdk.core.Construct

Methods inherited from class java.lang.Object

Field Detail

CFN_RESOURCE_TYPE_NAME

Constructor Detail

CfnServer

CfnServer

CfnServer

CfnServer

Method Detail

inspect

renderProperties

getAttrArn

getAttrServerId

getCfnProperties

getTags

getCertificate

setCertificate

getDomain

setDomain

getEndpointDetails

setEndpointDetails

setEndpointDetails

getEndpointType

setEndpointType

getIdentityProviderDetails

setIdentityProviderDetails

setIdentityProviderDetails

getIdentityProviderType

setIdentityProviderType

getLoggingRole

setLoggingRole

getPostAuthenticationLoginBanner

setPostAuthenticationLoginBanner

getPreAuthenticationLoginBanner

setPreAuthenticationLoginBanner

getProtocolDetails

setProtocolDetails

setProtocolDetails

getProtocols

setProtocols

getSecurityPolicyName

setSecurityPolicyName

getWorkflowDetails

setWorkflowDetails

setWorkflowDetails