com.amazonaws.services.transfer.model

Class UpdateServerRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.transfer.model.UpdateServerRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class UpdateServerRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
UpdateServerRequest()

Method Summary

Modifier and Type	Method and Description
UpdateServerRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
EndpointDetails	getEndpointDetails() The virtual private cloud (VPC) endpoint settings that are configured for your SFTP server.
String	getEndpointType() The type of endpoint that you want your SFTP server to connect to.
String	getHostKey() The RSA private key as generated by ssh-keygen -N "" -f my-new-server-key.
IdentityProviderDetails	getIdentityProviderDetails() This response parameter is an array containing all of the information required to call a customer's authentication API method.
String	getLoggingRole() A value that changes the AWS Identity and Access Management (IAM) role that allows Amazon S3 events to be logged in Amazon CloudWatch, turning logging on or off.
String	getServerId() A system-assigned unique identifier for an SFTP server instance that the user account is assigned to.
int	hashCode()
void	setEndpointDetails(EndpointDetails endpointDetails) The virtual private cloud (VPC) endpoint settings that are configured for your SFTP server.
void	setEndpointType(String endpointType) The type of endpoint that you want your SFTP server to connect to.
void	setHostKey(String hostKey) The RSA private key as generated by ssh-keygen -N "" -f my-new-server-key.
void	setIdentityProviderDetails(IdentityProviderDetails identityProviderDetails) This response parameter is an array containing all of the information required to call a customer's authentication API method.
void	setLoggingRole(String loggingRole) A value that changes the AWS Identity and Access Management (IAM) role that allows Amazon S3 events to be logged in Amazon CloudWatch, turning logging on or off.
void	setServerId(String serverId) A system-assigned unique identifier for an SFTP server instance that the user account is assigned to.
String	toString() Returns a string representation of this object.
UpdateServerRequest	withEndpointDetails(EndpointDetails endpointDetails) The virtual private cloud (VPC) endpoint settings that are configured for your SFTP server.
UpdateServerRequest	withEndpointType(EndpointType endpointType) The type of endpoint that you want your SFTP server to connect to.
UpdateServerRequest	withEndpointType(String endpointType) The type of endpoint that you want your SFTP server to connect to.
UpdateServerRequest	withHostKey(String hostKey) The RSA private key as generated by ssh-keygen -N "" -f my-new-server-key.
UpdateServerRequest	withIdentityProviderDetails(IdentityProviderDetails identityProviderDetails) This response parameter is an array containing all of the information required to call a customer's authentication API method.
UpdateServerRequest	withLoggingRole(String loggingRole) A value that changes the AWS Identity and Access Management (IAM) role that allows Amazon S3 events to be logged in Amazon CloudWatch, turning logging on or off.
UpdateServerRequest	withServerId(String serverId) A system-assigned unique identifier for an SFTP server instance that the user account is assigned to.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

UpdateServerRequest

public UpdateServerRequest()

Method Detail

setEndpointDetails

public void setEndpointDetails(EndpointDetails endpointDetails)

The virtual private cloud (VPC) endpoint settings that are configured for your SFTP server. With a VPC endpoint, you can restrict access to your SFTP server to resources only within your VPC. To control incoming internet traffic, you will need to associate one or more Elastic IP addresses with your server's endpoint.

Parameters:

endpointDetails - The virtual private cloud (VPC) endpoint settings that are configured for your SFTP server. With a VPC endpoint, you can restrict access to your SFTP server to resources only within your VPC. To control incoming internet traffic, you will need to associate one or more Elastic IP addresses with your server's endpoint.

getEndpointDetails

public EndpointDetails getEndpointDetails()

The virtual private cloud (VPC) endpoint settings that are configured for your SFTP server. With a VPC endpoint, you can restrict access to your SFTP server to resources only within your VPC. To control incoming internet traffic, you will need to associate one or more Elastic IP addresses with your server's endpoint.

Returns:

The virtual private cloud (VPC) endpoint settings that are configured for your SFTP server. With a VPC endpoint, you can restrict access to your SFTP server to resources only within your VPC. To control incoming internet traffic, you will need to associate one or more Elastic IP addresses with your server's endpoint.

withEndpointDetails

public UpdateServerRequest withEndpointDetails(EndpointDetails endpointDetails)

The virtual private cloud (VPC) endpoint settings that are configured for your SFTP server. With a VPC endpoint, you can restrict access to your SFTP server to resources only within your VPC. To control incoming internet traffic, you will need to associate one or more Elastic IP addresses with your server's endpoint.

Parameters:

endpointDetails - The virtual private cloud (VPC) endpoint settings that are configured for your SFTP server. With a VPC endpoint, you can restrict access to your SFTP server to resources only within your VPC. To control incoming internet traffic, you will need to associate one or more Elastic IP addresses with your server's endpoint.

Returns:

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

setEndpointType

public void setEndpointType(String endpointType)

The type of endpoint that you want your SFTP server to connect to. You can choose to connect to the public internet or a virtual private cloud (VPC) endpoint. With a VPC endpoint, your SFTP server isn't accessible over the public internet.

Parameters:

endpointType - The type of endpoint that you want your SFTP server to connect to. You can choose to connect to the public internet or a virtual private cloud (VPC) endpoint. With a VPC endpoint, your SFTP server isn't accessible over the public internet.

See Also:

EndpointType

getEndpointType

public String getEndpointType()

The type of endpoint that you want your SFTP server to connect to. You can choose to connect to the public internet or a virtual private cloud (VPC) endpoint. With a VPC endpoint, your SFTP server isn't accessible over the public internet.

Returns:

The type of endpoint that you want your SFTP server to connect to. You can choose to connect to the public internet or a virtual private cloud (VPC) endpoint. With a VPC endpoint, your SFTP server isn't accessible over the public internet.

See Also:

EndpointType

withEndpointType

public UpdateServerRequest withEndpointType(String endpointType)

The type of endpoint that you want your SFTP server to connect to. You can choose to connect to the public internet or a virtual private cloud (VPC) endpoint. With a VPC endpoint, your SFTP server isn't accessible over the public internet.

Parameters:

endpointType - The type of endpoint that you want your SFTP server to connect to. You can choose to connect to the public internet or a virtual private cloud (VPC) endpoint. With a VPC endpoint, your SFTP 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

withEndpointType

public UpdateServerRequest withEndpointType(EndpointType endpointType)

The type of endpoint that you want your SFTP server to connect to. You can choose to connect to the public internet or a virtual private cloud (VPC) endpoint. With a VPC endpoint, your SFTP server isn't accessible over the public internet.

Parameters:

endpointType - The type of endpoint that you want your SFTP server to connect to. You can choose to connect to the public internet or a virtual private cloud (VPC) endpoint. With a VPC endpoint, your SFTP 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

setHostKey

public void setHostKey(String hostKey)

The RSA private key as generated by ssh-keygen -N "" -f my-new-server-key.

If you aren't planning to migrate existing users from an existing SFTP server to a new AWS SFTP server, don't update the host key. Accidentally changing a server's host key can be disruptive.

For more information, see "https://docs.aws.amazon.com/transfer/latest/userguide/configuring-servers.html#change-host-key" in the AWS SFTP User Guide.

Parameters:

hostKey - The RSA private key as generated by ssh-keygen -N "" -f my-new-server-key.

If you aren't planning to migrate existing users from an existing SFTP server to a new AWS SFTP server, don't update the host key. Accidentally changing a server's host key can be disruptive.

For more information, see "https://docs.aws.amazon.com/transfer/latest/userguide/configuring-servers.html#change-host-key" in the AWS SFTP User Guide.

getHostKey

public String getHostKey()

The RSA private key as generated by ssh-keygen -N "" -f my-new-server-key.

If you aren't planning to migrate existing users from an existing SFTP server to a new AWS SFTP server, don't update the host key. Accidentally changing a server's host key can be disruptive.

For more information, see "https://docs.aws.amazon.com/transfer/latest/userguide/configuring-servers.html#change-host-key" in the AWS SFTP User Guide.

Returns:

The RSA private key as generated by ssh-keygen -N "" -f my-new-server-key.

If you aren't planning to migrate existing users from an existing SFTP server to a new AWS SFTP server, don't update the host key. Accidentally changing a server's host key can be disruptive.

For more information, see "https://docs.aws.amazon.com/transfer/latest/userguide/configuring-servers.html#change-host-key" in the AWS SFTP User Guide.

withHostKey

public UpdateServerRequest withHostKey(String hostKey)

The RSA private key as generated by ssh-keygen -N "" -f my-new-server-key.

If you aren't planning to migrate existing users from an existing SFTP server to a new AWS SFTP server, don't update the host key. Accidentally changing a server's host key can be disruptive.

For more information, see "https://docs.aws.amazon.com/transfer/latest/userguide/configuring-servers.html#change-host-key" in the AWS SFTP User Guide.

Parameters:

hostKey - The RSA private key as generated by ssh-keygen -N "" -f my-new-server-key.

If you aren't planning to migrate existing users from an existing SFTP server to a new AWS SFTP server, don't update the host key. Accidentally changing a server's host key can be disruptive.

For more information, see "https://docs.aws.amazon.com/transfer/latest/userguide/configuring-servers.html#change-host-key" in the AWS SFTP User Guide.

Returns:

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

setIdentityProviderDetails

public void setIdentityProviderDetails(IdentityProviderDetails identityProviderDetails)

This response parameter is an array containing all of the information required to call a customer's authentication API method.

Parameters:

identityProviderDetails - This response parameter is an array containing all of the information required to call a customer's authentication API method.

getIdentityProviderDetails

public IdentityProviderDetails getIdentityProviderDetails()

This response parameter is an array containing all of the information required to call a customer's authentication API method.

Returns:

This response parameter is an array containing all of the information required to call a customer's authentication API method.

withIdentityProviderDetails

public UpdateServerRequest withIdentityProviderDetails(IdentityProviderDetails identityProviderDetails)

This response parameter is an array containing all of the information required to call a customer's authentication API method.

Parameters:

identityProviderDetails - This response parameter is an array containing all of the information required to call a customer's authentication API method.

Returns:

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

setLoggingRole

public void setLoggingRole(String loggingRole)

A value that changes the AWS Identity and Access Management (IAM) role that allows Amazon S3 events to be logged in Amazon CloudWatch, turning logging on or off.

Parameters:

loggingRole - A value that changes the AWS Identity and Access Management (IAM) role that allows Amazon S3 events to be logged in Amazon CloudWatch, turning logging on or off.

getLoggingRole

public String getLoggingRole()

A value that changes the AWS Identity and Access Management (IAM) role that allows Amazon S3 events to be logged in Amazon CloudWatch, turning logging on or off.

Returns:

A value that changes the AWS Identity and Access Management (IAM) role that allows Amazon S3 events to be logged in Amazon CloudWatch, turning logging on or off.

withLoggingRole

public UpdateServerRequest withLoggingRole(String loggingRole)

A value that changes the AWS Identity and Access Management (IAM) role that allows Amazon S3 events to be logged in Amazon CloudWatch, turning logging on or off.

Parameters:

loggingRole - A value that changes the AWS Identity and Access Management (IAM) role that allows Amazon S3 events to be logged in Amazon CloudWatch, turning logging on or off.

Returns:

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

setServerId

public void setServerId(String serverId)

A system-assigned unique identifier for an SFTP server instance that the user account is assigned to.

Parameters:

serverId - A system-assigned unique identifier for an SFTP server instance that the user account is assigned to.

getServerId

public String getServerId()

A system-assigned unique identifier for an SFTP server instance that the user account is assigned to.

Returns:

A system-assigned unique identifier for an SFTP server instance that the user account is assigned to.

withServerId

public UpdateServerRequest withServerId(String serverId)

A system-assigned unique identifier for an SFTP server instance that the user account is assigned to.

Parameters:

serverId - A system-assigned unique identifier for an SFTP server instance that the user account is assigned to.

Returns:

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

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public UpdateServerRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()