Interface CfnServerProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnServerProps.Jsii$Proxy
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") .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")) .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:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final class
A builder forCfnServerProps
static final class
An implementation forCfnServerProps
-
Method Summary
Modifier and TypeMethodDescriptionstatic CfnServerProps.Builder
builder()
default String
The Amazon Resource Name (ARN) of the AWS Certificate Manager (ACM) certificate.default String
Specifies the domain of the storage system that is used for file transfers.default Object
The virtual private cloud (VPC) endpoint settings that are configured for your server.default String
The type of endpoint that you want your server to use.default Object
Required whenIdentityProviderType
is set toAWS_DIRECTORY_SERVICE
,AWS _LAMBDA
orAPI_GATEWAY
.default String
The mode of authentication for a server.default 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.default String
Specifies a string to display when users connect to a server.default String
Specifies a string to display when users connect to a server.default Object
The protocol settings that are configured for your server.Specifies the file transfer protocol or protocols over which your file transfer protocol client can connect to your server's endpoint.default Object
Specifies whether or not performance for your Amazon S3 directories is optimized.default String
Specifies the name of the security policy for the server.Specifies the log groups to which your server logs are sent.getTags()
Key-value pairs that can be used to group and search for servers.default Object
Specifies the workflow ID for the workflow to assign and the execution role that's used for executing the workflow.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getCertificate
The Amazon Resource Name (ARN) of the AWS Certificate Manager (ACM) certificate.Required when
Protocols
is set toFTPS
.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.
- See Also:
-
getDomain
Specifies the domain of the storage system that is used for file transfers.There are two domains available: Amazon Simple Storage Service (Amazon S3) and Amazon Elastic File System (Amazon EFS). The default value is S3.
- See Also:
-
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.
- See Also:
-
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.
After May 19, 2021, you won't be able to create a server using
EndpointType=VPC_ENDPOINT
in your AWS account if your account hasn't already done so before May 19, 2021. If you have already created servers withEndpointType=VPC_ENDPOINT
in your AWS account on or before May 19, 2021, you will not be affected. After this date, useEndpointType
=VPC
.For more information, see Discontinuing the use of VPC_ENDPOINT .
It is recommended that you use
VPC
as theEndpointType
. With this endpoint type, you have the option to directly associate up to three Elastic IPv4 addresses (BYO IP included) with your server's endpoint and use VPC security groups to restrict traffic by the client's public IP address. This is not possible withEndpointType
set toVPC_ENDPOINT
.- See Also:
-
getIdentityProviderDetails
Required whenIdentityProviderType
is set toAWS_DIRECTORY_SERVICE
,AWS _LAMBDA
orAPI_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. Cannot be specified whenIdentityProviderType
is set toSERVICE_MANAGED
.- See Also:
-
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 theIdentityProviderDetails
parameter.Use the
API_GATEWAY
value to integrate with an identity provider of your choosing. TheAPI_GATEWAY
setting requires you to provide an Amazon API Gateway endpoint URL to call for authentication by using theIdentityProviderDetails
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 theFunction
parameter for theIdentityProviderDetails
data type.- See Also:
-
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.
- See Also:
-
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.
- See Also:
-
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.
- See Also:
-
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 theSetStatOption
parameter. To have the AWS Transfer Family server ignore theSETSTAT
command and upload files without needing to make any changes to your SFTP client, set the value toENABLE_NO_OP
. If you set theSetStatOption
parameter toENABLE_NO_OP
, Transfer Family generates a log entry to Amazon CloudWatch Logs, so that you can determine when the client is making aSETSTAT
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.
The
Protocols
parameter is an array of strings.Allowed values : One or more of
SFTP
,FTPS
,FTP
,AS2
- See Also:
- To indicate passive mode (for FTP and FTPS protocols), use the
-
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 SSHFTPS
(File Transfer Protocol Secure): File transfer with TLS encryptionFTP
(File Transfer Protocol): Unencrypted file transferAS2
(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 eitherFTP
orFTPS
, then theEndpointType
must beVPC
and theIdentityProviderType
must be eitherAWS_DIRECTORY_SERVICE
,AWS_LAMBDA
, orAPI_GATEWAY
. - If
Protocol
includesFTP
, thenAddressAllocationIds
cannot be associated. - If
Protocol
is set only toSFTP
, theEndpointType
can be set toPUBLIC
and theIdentityProviderType
can be set any of the supported identity types:SERVICE_MANAGED
,AWS_DIRECTORY_SERVICE
,AWS_LAMBDA
, orAPI_GATEWAY
. - If
Protocol
includesAS2
, then theEndpointType
must beVPC
, and domain must be Amazon S3.
The
Protocols
parameter is an array of strings.Allowed values : One or more of
SFTP
,FTPS
,FTP
,AS2
- See Also:
-
getS3StorageOptions
Specifies whether or not performance for your Amazon S3 directories is optimized. This is disabled by default.By default, home directory mappings have a
TYPE
ofDIRECTORY
. If you enable this option, you would then need to explicitly set theHomeDirectoryMapEntry
Type
toFILE
if you want a mapping to have a file target.- See Also:
-
getSecurityPolicyName
Specifies the name of the security policy for the server.- See Also:
-
getStructuredLogDestinations
Specifies the log groups to which your server logs are sent.To specify a log group, you must provide the ARN for an existing log group. In this case, the format of the log group is as follows:
arn:aws:logs:region-name:amazon-account-id:log-group:log-group-name:*
For example,
arn:aws:logs:us-east-1:111122223333:log-group:mytestgroup:*
If you have previously specified a log group for a server, you can clear it, and in effect turn off structured logging, by providing an empty value for this parameter in an
update-server
call. For example:update-server --server-id s-1234567890abcdef0 --structured-log-destinations
- See Also:
-
getTags
Key-value pairs that can be used to group and search for servers.- See Also:
-
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.- See Also:
-
builder
- Returns:
- a
CfnServerProps.Builder
ofCfnServerProps
-