software.amazon.awssdk.services.transfer.model

Interface DescribedServer.Builder

All Superinterfaces:

Buildable, CopyableBuilder<DescribedServer.Builder,DescribedServer>, SdkBuilder<DescribedServer.Builder,DescribedServer>, SdkPojo

Enclosing class:

DescribedServer

public static interface DescribedServer.Builder
extends SdkPojo, CopyableBuilder<DescribedServer.Builder,DescribedServer>

Method Summary

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 AWS Certificate Manager (ACM) certificate.
default DescribedServer.Builder	endpointDetails(Consumer<EndpointDetails.Builder> endpointDetails) Specifies the virtual private cloud (VPC) endpoint settings that you configured for your server.
DescribedServer.Builder	endpointDetails(EndpointDetails endpointDetails) Specifies the virtual private cloud (VPC) endpoint settings that you 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) Specifies the mode of authentication method enabled for this service.
DescribedServer.Builder	identityProviderType(String identityProviderType) Specifies the mode of authentication method enabled for this service.
DescribedServer.Builder	loggingRole(String loggingRole) Specifies the AWS Identity and Access Management (IAM) role that allows a server to turn on Amazon CloudWatch logging for Amazon S3 events.
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) Specifies the condition of a server for the server that was described.
DescribedServer.Builder	state(String state) Specifies the condition of a server for the server that was described.
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.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

arn

DescribedServer.Builder arn(String arn)

Specifies the unique Amazon Resource Name (ARN) of the server.

Parameters:

arn - Specifies the unique Amazon Resource Name (ARN) of the server.

Returns:

Returns a reference to this object so that method calls can be chained together.

certificate

DescribedServer.Builder certificate(String certificate)

Specifies the ARN of the AWS Certificate Manager (ACM) certificate. Required when Protocols is set to FTPS.

Parameters:

certificate - Specifies the ARN of the AWS Certificate Manager (ACM) certificate. Required when Protocols is set to FTPS.

Returns:

Returns a reference to this object so that method calls can be chained together.

endpointDetails

DescribedServer.Builder endpointDetails(EndpointDetails endpointDetails)

Specifies the virtual private cloud (VPC) endpoint settings that you configured for your server.

Parameters:

endpointDetails - Specifies the virtual private cloud (VPC) endpoint settings that you configured for your server.

Returns:

Returns a reference to this object so that method calls can be chained together.

endpointDetails

default DescribedServer.Builder endpointDetails(Consumer<EndpointDetails.Builder> endpointDetails)

Specifies the virtual private cloud (VPC) endpoint settings that you configured for your server.

This is a convenience that creates an instance of the EndpointDetails.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).

Parameters:

endpointDetails - a consumer that will call methods on EndpointDetails.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

endpointDetails(EndpointDetails)

endpointType

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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

EndpointType, EndpointType

endpointType

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

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

EndpointType, EndpointType

hostKeyFingerprint

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

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

identityProviderDetails

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

Parameters:

identityProviderDetails - Specifies information to call a customer-supplied authentication API. This field is not populated when the IdentityProviderType of a server is SERVICE_MANAGED.

Returns:

Returns a reference to this object so that method calls can be chained together.

identityProviderDetails

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

This is a convenience that creates an instance of the 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).

Parameters:

identityProviderDetails - a consumer that will call methods on IdentityProviderDetails.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

identityProviderDetails(IdentityProviderDetails)

identityProviderType

DescribedServer.Builder identityProviderType(String identityProviderType)

Specifies the mode of authentication method enabled for this service. A value of SERVICE_MANAGED means that you are using this server to store and access user credentials within the service. A value of API_GATEWAY indicates that you have integrated an API Gateway endpoint that will be invoked for authenticating your user into the service.

Parameters:

identityProviderType - Specifies the mode of authentication method enabled for this service. A value of SERVICE_MANAGED means that you are using this server to store and access user credentials within the service. A value of API_GATEWAY indicates that you have integrated an API Gateway endpoint that will be invoked for authenticating your user into the service.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

IdentityProviderType, IdentityProviderType

identityProviderType

DescribedServer.Builder identityProviderType(IdentityProviderType identityProviderType)

Specifies the mode of authentication method enabled for this service. A value of SERVICE_MANAGED means that you are using this server to store and access user credentials within the service. A value of API_GATEWAY indicates that you have integrated an API Gateway endpoint that will be invoked for authenticating your user into the service.

Parameters:

identityProviderType - Specifies the mode of authentication method enabled for this service. A value of SERVICE_MANAGED means that you are using this server to store and access user credentials within the service. A value of API_GATEWAY indicates that you have integrated an API Gateway endpoint that will be invoked for authenticating your user into the service.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

IdentityProviderType, IdentityProviderType

loggingRole

DescribedServer.Builder loggingRole(String loggingRole)

Specifies the AWS Identity and Access Management (IAM) role that allows a server to turn on Amazon CloudWatch logging for Amazon S3 events. When set, user activity can be viewed in your CloudWatch logs.

Parameters:

loggingRole - Specifies the AWS Identity and Access Management (IAM) role that allows a server to turn on Amazon CloudWatch logging for Amazon S3 events. When set, user activity can be viewed in your CloudWatch logs.

Returns:

Returns a reference to this object so that method calls can be chained together.

protocolsWithStrings

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

protocolsWithStrings

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

protocols

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

protocols

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

securityPolicyName

DescribedServer.Builder securityPolicyName(String securityPolicyName)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

serverId

DescribedServer.Builder serverId(String serverId)

Specifies the unique system-assigned identifier for a server that you instantiate.

Parameters:

serverId - Specifies the unique system-assigned identifier for a server that you instantiate.

Returns:

Returns a reference to this object so that method calls can be chained together.

state

DescribedServer.Builder state(String state)

Specifies the condition of a server for 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.

Parameters:

state - Specifies the condition of a server for 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

State, State

state

DescribedServer.Builder state(State state)

Specifies the condition of a server for 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.

Parameters:

state - Specifies the condition of a server for 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

State, State

tags

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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

tags

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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

tags

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 that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #tags(List).

Parameters:

tags - a consumer that will call methods on List.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#tags(List)

userCount

DescribedServer.Builder userCount(Integer userCount)

Specifies the number of users that are assigned to a server you specified with the ServerId.

Parameters:

userCount - Specifies the number of users that are assigned to a server you specified with the ServerId.

Returns:

Returns a reference to this object so that method calls can be chained together.