public static interface DescribedServer.Builder extends SdkPojo, CopyableBuilder<DescribedServer.Builder,DescribedServer>
| Modifier and Type | Method and Description |
|---|---|
DescribedServer.Builder |
arn(String arn)
Specifies the unique Amazon Resource Name (ARN) of the server.
|
DescribedServer.Builder |
certificate(String certificate)
Specifies the ARN of the Amazon Web ServicesCertificate Manager (ACM) certificate.
|
DescribedServer.Builder |
domain(Domain domain)
Specifies the domain of the storage system that is used for file transfers.
|
DescribedServer.Builder |
domain(String domain)
Specifies the domain of the storage system that is used for file transfers.
|
default DescribedServer.Builder |
endpointDetails(Consumer<EndpointDetails.Builder> endpointDetails)
The virtual private cloud (VPC) endpoint settings that are configured for your server.
|
DescribedServer.Builder |
endpointDetails(EndpointDetails endpointDetails)
The virtual private cloud (VPC) endpoint settings that are configured for your server.
|
DescribedServer.Builder |
endpointType(EndpointType endpointType)
Defines the type of endpoint that your server is connected to.
|
DescribedServer.Builder |
endpointType(String endpointType)
Defines the type of endpoint that your server is connected to.
|
DescribedServer.Builder |
hostKeyFingerprint(String hostKeyFingerprint)
Specifies the Base64-encoded SHA256 fingerprint of the server's host key.
|
default DescribedServer.Builder |
identityProviderDetails(Consumer<IdentityProviderDetails.Builder> identityProviderDetails)
Specifies information to call a customer-supplied authentication API.
|
DescribedServer.Builder |
identityProviderDetails(IdentityProviderDetails identityProviderDetails)
Specifies information to call a customer-supplied authentication API.
|
DescribedServer.Builder |
identityProviderType(IdentityProviderType identityProviderType)
The mode of authentication for a server.
|
DescribedServer.Builder |
identityProviderType(String identityProviderType)
The mode of authentication for a server.
|
DescribedServer.Builder |
loggingRole(String loggingRole)
The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that allows a server to turn
on Amazon CloudWatch logging for Amazon S3 or Amazon EFSevents.
|
DescribedServer.Builder |
postAuthenticationLoginBanner(String postAuthenticationLoginBanner)
Specifies a string to display when users connect to a server.
|
DescribedServer.Builder |
preAuthenticationLoginBanner(String preAuthenticationLoginBanner)
Specifies a string to display when users connect to a server.
|
default DescribedServer.Builder |
protocolDetails(Consumer<ProtocolDetails.Builder> protocolDetails)
The protocol settings that are configured for your server.
|
DescribedServer.Builder |
protocolDetails(ProtocolDetails protocolDetails)
The protocol settings that are configured for your server.
|
DescribedServer.Builder |
protocols(Collection<Protocol> protocols)
Specifies the file transfer protocol or protocols over which your file transfer protocol client can connect
to your server's endpoint.
|
DescribedServer.Builder |
protocols(Protocol... protocols)
Specifies the file transfer protocol or protocols over which your file transfer protocol client can connect
to your server's endpoint.
|
DescribedServer.Builder |
protocolsWithStrings(Collection<String> protocols)
Specifies the file transfer protocol or protocols over which your file transfer protocol client can connect
to your server's endpoint.
|
DescribedServer.Builder |
protocolsWithStrings(String... protocols)
Specifies the file transfer protocol or protocols over which your file transfer protocol client can connect
to your server's endpoint.
|
DescribedServer.Builder |
securityPolicyName(String securityPolicyName)
Specifies the name of the security policy that is attached to the server.
|
DescribedServer.Builder |
serverId(String serverId)
Specifies the unique system-assigned identifier for a server that you instantiate.
|
DescribedServer.Builder |
state(State state)
The condition of the server that was described.
|
DescribedServer.Builder |
state(String state)
The condition of the server that was described.
|
DescribedServer.Builder |
structuredLogDestinations(Collection<String> structuredLogDestinations)
Specifies the log groups to which your server logs are sent.
|
DescribedServer.Builder |
structuredLogDestinations(String... structuredLogDestinations)
Specifies the log groups to which your server logs are sent.
|
DescribedServer.Builder |
tags(Collection<Tag> tags)
Specifies the key-value pairs that you can use to search for and group servers that were assigned to the
server that was described.
|
DescribedServer.Builder |
tags(Consumer<Tag.Builder>... tags)
Specifies the key-value pairs that you can use to search for and group servers that were assigned to the
server that was described.
|
DescribedServer.Builder |
tags(Tag... tags)
Specifies the key-value pairs that you can use to search for and group servers that were assigned to the
server that was described.
|
DescribedServer.Builder |
userCount(Integer userCount)
Specifies the number of users that are assigned to a server you specified with the
ServerId. |
default DescribedServer.Builder |
workflowDetails(Consumer<WorkflowDetails.Builder> workflowDetails)
Specifies the workflow ID for the workflow to assign and the execution role that's used for executing the
workflow.
|
DescribedServer.Builder |
workflowDetails(WorkflowDetails workflowDetails)
Specifies the workflow ID for the workflow to assign and the execution role that's used for executing the
workflow.
|
equalsBySdkFields, sdkFieldscopyapplyMutation, buildDescribedServer.Builder arn(String arn)
Specifies the unique Amazon Resource Name (ARN) of the server.
arn - Specifies the unique Amazon Resource Name (ARN) of the server.DescribedServer.Builder certificate(String certificate)
Specifies the ARN of the Amazon Web ServicesCertificate Manager (ACM) certificate. Required when
Protocols is set to FTPS.
certificate - Specifies the ARN of the Amazon Web ServicesCertificate Manager (ACM) certificate. Required when
Protocols is set to FTPS.DescribedServer.Builder protocolDetails(ProtocolDetails protocolDetails)
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
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 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.
protocolDetails - 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 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 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.
default DescribedServer.Builder protocolDetails(Consumer<ProtocolDetails.Builder> protocolDetails)
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
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 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.
ProtocolDetails.Builder avoiding the
need to create one manually via ProtocolDetails.builder().
When the Consumer completes, SdkBuilder.build() is called immediately and its
result is passed to protocolDetails(ProtocolDetails).
protocolDetails - a consumer that will call methods on ProtocolDetails.BuilderprotocolDetails(ProtocolDetails)DescribedServer.Builder domain(String domain)
Specifies the domain of the storage system that is used for file transfers.
DescribedServer.Builder domain(Domain domain)
Specifies the domain of the storage system that is used for file transfers.
DescribedServer.Builder endpointDetails(EndpointDetails 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 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.
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 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.default DescribedServer.Builder endpointDetails(Consumer<EndpointDetails.Builder> 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 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.
This is a convenience method that creates an instance of theEndpointDetails.Builder avoiding the
need to create one manually via EndpointDetails.builder().
When the Consumer completes, SdkBuilder.build() is called immediately and its
result is passed to endpointDetails(EndpointDetails).
endpointDetails - a consumer that will call methods on EndpointDetails.BuilderendpointDetails(EndpointDetails)DescribedServer.Builder endpointType(String endpointType)
Defines the type of endpoint that your server is connected to. If your server is connected to a VPC endpoint, your server isn't accessible over the public internet.
endpointType - Defines the type of endpoint that your server is connected to. If your server is connected to a VPC
endpoint, your server isn't accessible over the public internet.EndpointType,
EndpointTypeDescribedServer.Builder endpointType(EndpointType endpointType)
Defines the type of endpoint that your server is connected to. If your server is connected to a VPC endpoint, your server isn't accessible over the public internet.
endpointType - Defines the type of endpoint that your server is connected to. If your server is connected to a VPC
endpoint, your server isn't accessible over the public internet.EndpointType,
EndpointTypeDescribedServer.Builder hostKeyFingerprint(String hostKeyFingerprint)
Specifies the Base64-encoded SHA256 fingerprint of the server's host key. This value is equivalent to the
output of the ssh-keygen -l -f my-new-server-key command.
hostKeyFingerprint - Specifies the Base64-encoded SHA256 fingerprint of the server's host key. This value is equivalent to
the output of the ssh-keygen -l -f my-new-server-key command.DescribedServer.Builder identityProviderDetails(IdentityProviderDetails identityProviderDetails)
Specifies information to call a customer-supplied authentication API. This field is not populated when the
IdentityProviderType of a server is AWS_DIRECTORY_SERVICE or
SERVICE_MANAGED.
identityProviderDetails - Specifies information to call a customer-supplied authentication API. This field is not populated when
the IdentityProviderType of a server is AWS_DIRECTORY_SERVICE or
SERVICE_MANAGED.default DescribedServer.Builder identityProviderDetails(Consumer<IdentityProviderDetails.Builder> identityProviderDetails)
Specifies information to call a customer-supplied authentication API. This field is not populated when the
IdentityProviderType of a server is AWS_DIRECTORY_SERVICE or
SERVICE_MANAGED.
IdentityProviderDetails.Builder avoiding
the need to create one manually via IdentityProviderDetails.builder().
When the Consumer completes, SdkBuilder.build() is called immediately
and its result is passed to identityProviderDetails(IdentityProviderDetails).
identityProviderDetails - a consumer that will call methods on IdentityProviderDetails.BuilderidentityProviderDetails(IdentityProviderDetails)DescribedServer.Builder identityProviderType(String identityProviderType)
The mode of authentication for a server. The default value is SERVICE_MANAGED, which allows you
to store and access user credentials within the Transfer Family service.
Use AWS_DIRECTORY_SERVICE to provide access to Active Directory groups in Directory Service for
Microsoft Active Directory or Microsoft Active Directory in your on-premises environment or in Amazon Web
Services 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 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.
identityProviderType - The mode of authentication for a server. The default value is SERVICE_MANAGED, which
allows you to store and access user credentials within the Transfer Family service.
Use AWS_DIRECTORY_SERVICE to provide access to Active Directory groups in Directory
Service for Microsoft Active Directory or Microsoft Active Directory in your on-premises environment
or in Amazon Web Services 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 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.
IdentityProviderType,
IdentityProviderTypeDescribedServer.Builder identityProviderType(IdentityProviderType identityProviderType)
The mode of authentication for a server. The default value is SERVICE_MANAGED, which allows you
to store and access user credentials within the Transfer Family service.
Use AWS_DIRECTORY_SERVICE to provide access to Active Directory groups in Directory Service for
Microsoft Active Directory or Microsoft Active Directory in your on-premises environment or in Amazon Web
Services 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 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.
identityProviderType - The mode of authentication for a server. The default value is SERVICE_MANAGED, which
allows you to store and access user credentials within the Transfer Family service.
Use AWS_DIRECTORY_SERVICE to provide access to Active Directory groups in Directory
Service for Microsoft Active Directory or Microsoft Active Directory in your on-premises environment
or in Amazon Web Services 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 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.
IdentityProviderType,
IdentityProviderTypeDescribedServer.Builder loggingRole(String loggingRole)
The Amazon Resource Name (ARN) of the 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.
loggingRole - The Amazon Resource Name (ARN) of the 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.DescribedServer.Builder postAuthenticationLoginBanner(String postAuthenticationLoginBanner)
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.
postAuthenticationLoginBanner - 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.
DescribedServer.Builder preAuthenticationLoginBanner(String preAuthenticationLoginBanner)
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.
preAuthenticationLoginBanner - 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.
DescribedServer.Builder protocolsWithStrings(Collection<String> 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 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 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.
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 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 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.
DescribedServer.Builder protocolsWithStrings(String... 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 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 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.
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 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 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.
DescribedServer.Builder protocols(Collection<Protocol> 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 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 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.
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 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 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.
DescribedServer.Builder protocols(Protocol... 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 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 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.
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 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 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.
DescribedServer.Builder securityPolicyName(String securityPolicyName)
Specifies the name of the security policy that is attached to the server.
securityPolicyName - Specifies the name of the security policy that is attached to the server.DescribedServer.Builder serverId(String serverId)
Specifies the unique system-assigned identifier for a server that you instantiate.
serverId - Specifies the unique system-assigned identifier for a server that you instantiate.DescribedServer.Builder state(String state)
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.
state - 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.
State,
StateDescribedServer.Builder state(State state)
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.
state - 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.
State,
StateDescribedServer.Builder tags(Collection<Tag> tags)
Specifies the key-value pairs that you can use to search for and group servers that were assigned to the server that was described.
tags - Specifies the key-value pairs that you can use to search for and group servers that were assigned to
the server that was described.DescribedServer.Builder tags(Tag... tags)
Specifies the key-value pairs that you can use to search for and group servers that were assigned to the server that was described.
tags - Specifies the key-value pairs that you can use to search for and group servers that were assigned to
the server that was described.DescribedServer.Builder tags(Consumer<Tag.Builder>... tags)
Specifies the key-value pairs that you can use to search for and group servers that were assigned to the server that was described.
This is a convenience method that creates an instance of theTag.Builder avoiding the need to create one manually
via Tag.builder().
When the Consumer completes,
SdkBuilder.build() is called immediately and its
result is passed to #tags(List.
tags - a consumer that will call methods on
Tag.Builder#tags(java.util.Collection) DescribedServer.Builder userCount(Integer userCount)
Specifies the number of users that are assigned to a server you specified with the ServerId.
userCount - Specifies the number of users that are assigned to a server you specified with the
ServerId.DescribedServer.Builder workflowDetails(WorkflowDetails workflowDetails)
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 the server session disconnects while the file is still being uploaded.
workflowDetails - 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 the server session disconnects while the file is still being uploaded.
default DescribedServer.Builder workflowDetails(Consumer<WorkflowDetails.Builder> workflowDetails)
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 the server session disconnects while the file is still being uploaded.
WorkflowDetails.Builder avoiding the
need to create one manually via WorkflowDetails.builder().
When the Consumer completes, SdkBuilder.build() is called immediately and its
result is passed to workflowDetails(WorkflowDetails).
workflowDetails - a consumer that will call methods on WorkflowDetails.BuilderworkflowDetails(WorkflowDetails)DescribedServer.Builder structuredLogDestinations(Collection<String> structuredLogDestinations)
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
structuredLogDestinations - 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
DescribedServer.Builder structuredLogDestinations(String... structuredLogDestinations)
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
structuredLogDestinations - 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
Copyright © 2023. All rights reserved.