software.amazon.awscdk.services.transfer

Interface CfnServerProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnServerProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:42.608Z")
 @Stability(value=Stable)
public interface CfnServerProps
extends software.amazon.jsii.JsiiSerializable

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 software.amazon.awscdk.services.transfer.*;
 CfnServerProps cfnServerProps = CfnServerProps.builder()
         .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()
                 .onUpload(List.of(WorkflowDetailProperty.builder()
                         .executionRole("executionRole")
                         .workflowId("workflowId")
                         .build()))
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnServerProps.Builder A builder for CfnServerProps
static class	CfnServerProps.Jsii$Proxy An implementation for CfnServerProps

Method Summary

Modifier and Type	Method and Description
static CfnServerProps.Builder	builder()
default String	getCertificate() The Amazon Resource Name (ARN) of the AWS Certificate Manager (ACM) certificate.
default String	getDomain() Specifies the domain of the storage system that is used for file transfers.
default Object	getEndpointDetails() The virtual private cloud (VPC) endpoint settings that are configured for your server.
default String	getEndpointType() The type of endpoint that you want your server to use.
default Object	getIdentityProviderDetails() Required when `IdentityProviderType` is set to `AWS_DIRECTORY_SERVICE` or `API_GATEWAY` .
default String	getIdentityProviderType() Specifies the mode of authentication for a server.
default String	getLoggingRole() Specifies 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.
default String	getPostAuthenticationLoginBanner() Specify a string to display when users connect to a server.
default String	getPreAuthenticationLoginBanner() Specify a string to display when users connect to a server.
default Object	getProtocolDetails() The protocol settings that are configured for your server.
default List<String>	getProtocols() Specifies the file transfer protocol or protocols over which your file transfer protocol client can connect to your server's endpoint.
default String	getSecurityPolicyName() Specifies the name of the security policy that is attached to the server.
default List<CfnTag>	getTags() Key-value pairs that can be used to group and search for servers.
default Object	getWorkflowDetails() Specifies the workflow ID for the workflow to assign and the execution role used for executing the workflow.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getCertificate

@Stability(value=Stable)
 @Nullable
default 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.

getDomain

@Stability(value=Stable)
 @Nullable
default String getDomain()

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

getEndpointDetails

@Stability(value=Stable)
 @Nullable
default 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 it accessible only to resources within your VPC, or you can attach Elastic IP addresses and make it accessible to clients over the internet. Your VPC's default security groups are automatically assigned to your endpoint.

getEndpointType

@Stability(value=Stable)
 @Nullable
default 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.

getIdentityProviderDetails

@Stability(value=Stable)
 @Nullable
default 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 .

getIdentityProviderType

@Stability(value=Stable)
 @Nullable
default String getIdentityProviderType()

Specifies 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 Managed Active Directory or Microsoft Active Directory in your on-premises environment or in AWS using AD Connectors. This option also requires you to provide a Directory ID 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 API Gateway endpoint URL to call for authentication using the IdentityProviderDetails parameter.

Use the AWS_LAMBDA value to directly use a 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(value=Stable)
 @Nullable
default String getLoggingRole()

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

When set, user activity can be viewed in your CloudWatch logs.

getPostAuthenticationLoginBanner

@Stability(value=Stable)
 @Nullable
default String getPostAuthenticationLoginBanner()

Specify 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(value=Stable)
 @Nullable
default String getPreAuthenticationLoginBanner()

Specify 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(value=Stable)
 @Nullable
default Object getProtocolDetails()

The protocol settings that are configured for your server.

• Use the PassiveIp parameter to indicate passive mode (for FTP and FTPS protocols). Enter a single dotted-quad IPv4 address, such as the external IP address of a firewall, router, or load balancer.
• Use the SetStatOption to ignore the error that is generated when the client attempts to use SETSTAT on a file you are uploading to an S3 bucket. Set the value to ENABLE_NO_OP to have the Transfer Family server ignore the SETSTAT command, and upload files without needing to make any changes to your SFTP client. Note that with SetStatOption set to ENABLE_NO_OP , Transfer generates a log entry to CloudWatch Logs, so you can determine when the client is making a SETSTAT call.
• Use the TlsSessionResumptionMode parameter to determine whether or not your Transfer server resumes recent, negotiated sessions through a unique session ID.

getProtocols

@Stability(value=Stable)
 @Nullable
default 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

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 AWS_DIRECTORY_SERVICE 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 to SERVICE_MANAGED .

getSecurityPolicyName

@Stability(value=Stable)
 @Nullable
default String getSecurityPolicyName()

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

getTags

@Stability(value=Stable)
 @Nullable
default List<CfnTag> getTags()

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

getWorkflowDetails

@Stability(value=Stable)
 @Nullable
default Object getWorkflowDetails()

Specifies the workflow ID for the workflow to assign and the execution role used for executing the workflow.

builder

@Stability(value=Stable)
static CfnServerProps.Builder builder()

Returns:

a CfnServerProps.Builder of CfnServerProps