@Stability(value=Stable) public static final class CfnServerProps.Builder extends Object implements software.amazon.jsii.Builder<CfnServerProps>
CfnServerProps| Constructor and Description |
|---|
Builder() |
@Stability(value=Stable) public CfnServerProps.Builder certificate(String certificate)
CfnServerProps.getCertificate()certificate - 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:
The certificate must be a valid SSL/TLS X.509 version 3 certificate with FQDN or IP address specified and information about the issuer.
this@Stability(value=Stable) public CfnServerProps.Builder domain(String domain)
CfnServerProps.getDomain()domain - Specifies the domain of the storage system that is used for file transfers.this@Stability(value=Stable) public CfnServerProps.Builder endpointDetails(CfnServer.EndpointDetailsProperty endpointDetails)
CfnServerProps.getEndpointDetails()endpointDetails - 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.this@Stability(value=Stable) public CfnServerProps.Builder endpointDetails(IResolvable endpointDetails)
CfnServerProps.getEndpointDetails()endpointDetails - 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.this@Stability(value=Stable) public CfnServerProps.Builder endpointType(String endpointType)
CfnServerProps.getEndpointType()endpointType - 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.this@Stability(value=Stable) public CfnServerProps.Builder identityProviderDetails(CfnServer.IdentityProviderDetailsProperty identityProviderDetails)
CfnServerProps.getIdentityProviderDetails()identityProviderDetails - 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 .this@Stability(value=Stable) public CfnServerProps.Builder identityProviderDetails(IResolvable identityProviderDetails)
CfnServerProps.getIdentityProviderDetails()identityProviderDetails - 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 .this@Stability(value=Stable) public CfnServerProps.Builder identityProviderType(String identityProviderType)
CfnServerProps.getIdentityProviderType()identityProviderType - 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.
this@Stability(value=Stable) public CfnServerProps.Builder loggingRole(String loggingRole)
CfnServerProps.getLoggingRole()loggingRole - 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.this@Stability(value=Stable) public CfnServerProps.Builder postAuthenticationLoginBanner(String postAuthenticationLoginBanner)
CfnServerProps.getPostAuthenticationLoginBanner()postAuthenticationLoginBanner - 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.
this@Stability(value=Stable) public CfnServerProps.Builder preAuthenticationLoginBanner(String preAuthenticationLoginBanner)
CfnServerProps.getPreAuthenticationLoginBanner()preAuthenticationLoginBanner - 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.
this@Stability(value=Stable) public CfnServerProps.Builder protocolDetails(CfnServer.ProtocolDetailsProperty protocolDetails)
CfnServerProps.getProtocolDetails()protocolDetails - The protocol settings that are configured for your server.
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.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.TlsSessionResumptionMode parameter to determine whether or not your Transfer server resumes recent, negotiated sessions through a unique session ID.this@Stability(value=Stable) public CfnServerProps.Builder protocolDetails(IResolvable protocolDetails)
CfnServerProps.getProtocolDetails()protocolDetails - The protocol settings that are configured for your server.
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.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.TlsSessionResumptionMode parameter to determine whether or not your Transfer server resumes recent, negotiated sessions through a unique session ID.this@Stability(value=Stable) public CfnServerProps.Builder protocols(List<String> protocols)
CfnServerProps.getProtocols()protocols - 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 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
Protocolincludes eitherFTPorFTPS, then theEndpointTypemust beVPCand theIdentityProviderTypemust beAWS_DIRECTORY_SERVICEorAPI_GATEWAY.If
ProtocolincludesFTP, thenAddressAllocationIdscannot be associated.If
Protocolis set only toSFTP, theEndpointTypecan be set toPUBLICand theIdentityProviderTypecan be set toSERVICE_MANAGED.
this@Stability(value=Stable) public CfnServerProps.Builder securityPolicyName(String securityPolicyName)
CfnServerProps.getSecurityPolicyName()securityPolicyName - Specifies the name of the security policy that is attached to the server.this@Stability(value=Stable) public CfnServerProps.Builder tags(List<? extends CfnTag> tags)
CfnServerProps.getTags()tags - Key-value pairs that can be used to group and search for servers.this@Stability(value=Stable) public CfnServerProps.Builder workflowDetails(CfnServer.WorkflowDetailsProperty workflowDetails)
CfnServerProps.getWorkflowDetails()workflowDetails - Specifies the workflow ID for the workflow to assign and the execution role used for executing the workflow.this@Stability(value=Stable) public CfnServerProps.Builder workflowDetails(IResolvable workflowDetails)
CfnServerProps.getWorkflowDetails()workflowDetails - Specifies the workflow ID for the workflow to assign and the execution role used for executing the workflow.this@Stability(value=Stable) public CfnServerProps build()
build in interface software.amazon.jsii.Builder<CfnServerProps>CfnServerPropsNullPointerException - if any required attribute was not providedCopyright © 2022. All rights reserved.