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) for the server to be described.
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) This property defines the mode of authentication method enabled for this service.
DescribedServer.Builder	identityProviderType(String identityProviderType) This property defines the mode of authentication method enabled for this service.
DescribedServer.Builder	loggingRole(String loggingRole) This property is an AWS Identity and Access Management (IAM) entity that allows the server to turn on Amazon CloudWatch logging for Amazon S3 events.
DescribedServer.Builder	serverId(String serverId) This property is a unique system assigned identifier for the SFTP server that you instantiate.
DescribedServer.Builder	state(State state) The condition of the SFTP server for the server that was described.
DescribedServer.Builder	state(String state) The condition of the SFTP server for the server that was described.
DescribedServer.Builder	tags(Collection<Tag> tags) This property contains 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) This property contains 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) This property contains 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) The number of users that are assigned to the SFTP server you specified with the ServerId.

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

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) for the server to be described.

Parameters:

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

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 the server is SERVICE_MANAGED>.

Parameters:

identityProviderDetails - Specifies information to call a customer-supplied authentication API. This field is not populated when the IdentityProviderType of the 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 the 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)

This property defines 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 SFTP 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 - This property defines 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 SFTP 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)

This property defines 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 SFTP 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 - This property defines 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 SFTP 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)

This property is an AWS Identity and Access Management (IAM) entity that allows the server to turn on Amazon CloudWatch logging for Amazon S3 events. When set, user activity can be view in your CloudWatch logs.

Parameters:

loggingRole - This property is an AWS Identity and Access Management (IAM) entity that allows the server to turn on Amazon CloudWatch logging for Amazon S3 events. When set, user activity can be view in your CloudWatch logs.

Returns:

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

serverId

DescribedServer.Builder serverId(String serverId)

This property is a unique system assigned identifier for the SFTP server that you instantiate.

Parameters:

serverId - This property is a unique system assigned identifier for the SFTP 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)

The condition of the SFTP 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 indicated 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 - The condition of the SFTP 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 indicated 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)

The condition of the SFTP 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 indicated 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 - The condition of the SFTP 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 indicated 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)

This property contains 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 - This property contains 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)

This property contains 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 - This property contains 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)

This property contains 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)

The number of users that are assigned to the SFTP server you specified with the ServerId.

Parameters:

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

Returns:

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