software.amazon.awssdk.services.transfer.model

Interface ListedServer.Builder

All Superinterfaces:

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

Enclosing class:

ListedServer

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

Method Summary

Modifier and Type	Method and Description
ListedServer.Builder	arn(String arn) Specifies the unique Amazon Resource Name (ARN) for a server to be listed.
ListedServer.Builder	endpointType(EndpointType endpointType) Specifies the type of VPC endpoint that your server is connected to.
ListedServer.Builder	endpointType(String endpointType) Specifies the type of VPC endpoint that your server is connected to.
ListedServer.Builder	identityProviderType(IdentityProviderType identityProviderType) Specifies the authentication method used to validate a user for a server that was specified.
ListedServer.Builder	identityProviderType(String identityProviderType) Specifies the authentication method used to validate a user for a server that was specified.
ListedServer.Builder	loggingRole(String loggingRole) Specifies the AWS Identity and Access Management (IAM) role that allows a server to turn on Amazon CloudWatch logging.
ListedServer.Builder	serverId(String serverId) Specifies the unique system assigned identifier for the servers that were listed.
ListedServer.Builder	state(State state) Specifies the condition of a server for the server that was described.
ListedServer.Builder	state(String state) Specifies the condition of a server for the server that was described.
ListedServer.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

ListedServer.Builder arn(String arn)

Specifies the unique Amazon Resource Name (ARN) for a server to be listed.

Parameters:

arn - Specifies the unique Amazon Resource Name (ARN) for a server to be listed.

Returns:

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

identityProviderType

ListedServer.Builder identityProviderType(String identityProviderType)

Specifies the authentication method used to validate a user for a server that was specified. This can include Secure Shell (SSH), user name and password combinations, or your own custom authentication method. Valid values include SERVICE_MANAGED or API_GATEWAY.

Parameters:

identityProviderType - Specifies the authentication method used to validate a user for a server that was specified. This can include Secure Shell (SSH), user name and password combinations, or your own custom authentication method. Valid values include SERVICE_MANAGED or API_GATEWAY.

Returns:

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

See Also:

IdentityProviderType, IdentityProviderType

identityProviderType

ListedServer.Builder identityProviderType(IdentityProviderType identityProviderType)

Specifies the authentication method used to validate a user for a server that was specified. This can include Secure Shell (SSH), user name and password combinations, or your own custom authentication method. Valid values include SERVICE_MANAGED or API_GATEWAY.

Parameters:

identityProviderType - Specifies the authentication method used to validate a user for a server that was specified. This can include Secure Shell (SSH), user name and password combinations, or your own custom authentication method. Valid values include SERVICE_MANAGED or API_GATEWAY.

Returns:

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

See Also:

IdentityProviderType, IdentityProviderType

endpointType

ListedServer.Builder endpointType(String endpointType)

Specifies the type of VPC 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 - Specifies the type of VPC 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

ListedServer.Builder endpointType(EndpointType endpointType)

Specifies the type of VPC 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 - Specifies the type of VPC 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

loggingRole

ListedServer.Builder loggingRole(String loggingRole)

Specifies the AWS Identity and Access Management (IAM) role that allows a server to turn on Amazon CloudWatch logging.

Parameters:

loggingRole - Specifies the AWS Identity and Access Management (IAM) role that allows a server to turn on Amazon CloudWatch logging.

Returns:

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

serverId

ListedServer.Builder serverId(String serverId)

Specifies the unique system assigned identifier for the servers that were listed.

Parameters:

serverId - Specifies the unique system assigned identifier for the servers that were listed.

Returns:

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

state

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

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

userCount

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