UpdateServerRequest.Builder (AWS SDK for Java

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<UpdateServerRequest.Builder,UpdateServerRequest>, SdkBuilder<UpdateServerRequest.Builder,UpdateServerRequest>, SdkPojo, SdkRequest.Builder, TransferRequest.Builder

Enclosing class:

UpdateServerRequest
```
public static interface UpdateServerRequest.Builder
extends TransferRequest.Builder, SdkPojo, CopyableBuilder<UpdateServerRequest.Builder,UpdateServerRequest>
```

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`UpdateServerRequest.Builder`	`certificate(String certificate)` The Amazon Resource Name (ARN) of the AWS Certificate Manager (ACM) certificate.
`default UpdateServerRequest.Builder`	`endpointDetails(Consumer<EndpointDetails.Builder> endpointDetails)` The virtual private cloud (VPC) endpoint settings that are configured for your server.
`UpdateServerRequest.Builder`	`endpointDetails(EndpointDetails endpointDetails)` The virtual private cloud (VPC) endpoint settings that are configured for your server.
`UpdateServerRequest.Builder`	`endpointType(EndpointType endpointType)` The type of endpoint that you want your server to connect to.
`UpdateServerRequest.Builder`	`endpointType(String endpointType)` The type of endpoint that you want your server to connect to.
`UpdateServerRequest.Builder`	`hostKey(String hostKey)` The RSA private key as generated by `ssh-keygen -N "" -m PEM -f my-new-server-key`.
`default UpdateServerRequest.Builder`	`identityProviderDetails(Consumer<IdentityProviderDetails.Builder> identityProviderDetails)` An array containing all of the information required to call a customer's authentication API method.
`UpdateServerRequest.Builder`	`identityProviderDetails(IdentityProviderDetails identityProviderDetails)` An array containing all of the information required to call a customer's authentication API method.
`UpdateServerRequest.Builder`	`loggingRole(String loggingRole)` 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.Builder`	`overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)` Add an optional request override configuration.
`UpdateServerRequest.Builder`	`overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)` Add an optional request override configuration.
`UpdateServerRequest.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.
`UpdateServerRequest.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.
`UpdateServerRequest.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.
`UpdateServerRequest.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.
`UpdateServerRequest.Builder`	`securityPolicyName(String securityPolicyName)` Specifies the name of the security policy that is attached to the server.
`UpdateServerRequest.Builder`	`serverId(String serverId)` A system-assigned unique identifier for a server instance that the user account is assigned to.

Methods inherited from interface software.amazon.awssdk.services.transfer.model.TransferRequest.Builder
build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration

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
  - certificate
```
UpdateServerRequest.Builder certificate(String certificate)
```
    The Amazon Resource Name (ARN) of the AWS Certificate Manager (ACM) certificate. Required when Protocols is set to FTPS.
    
    To request a new public certificate, see Request a public certificate in the AWS Certificate Manager User Guide.
    
    To import an existing certificate into ACM, see Importing certificates into ACM in the AWS Certificate Manager User Guide.
    
    To request a private certificate to use FTPS through private IP addresses, see Request a private certificate in the AWS Certificate Manager User Guide.
    
    Certificates with the following cryptographic algorithms and key sizes are supported:
    - 2048-bit RSA (RSA_2048)
    - 4096-bit RSA (RSA_4096)
    - Elliptic Prime Curve 256 bit (EC_prime256v1)
    - Elliptic Prime Curve 384 bit (EC_secp384r1)
    - Elliptic Prime Curve 521 bit (EC_secp521r1)
    The certificate must be a valid SSL/TLS X.509 version 3 certificate with FQDN or IP address specified and information about the issuer.
    Parameters:
    certificate - The Amazon Resource Name (ARN) of the AWS Certificate Manager (ACM) certificate. Required when Protocols is set to FTPS.
    
    To request a new public certificate, see Request a public certificate in the AWS Certificate Manager User Guide.
    
    To import an existing certificate into ACM, see Importing certificates into ACM in the AWS Certificate Manager User Guide.
    
    To request a private certificate to use FTPS through private IP addresses, see Request a private certificate in the AWS Certificate Manager User Guide.
    
    Certificates with the following cryptographic algorithms and key sizes are supported:
    
    2048-bit RSA (RSA_2048)
    
    4096-bit RSA (RSA_4096)
    
    Elliptic Prime Curve 256 bit (EC_prime256v1)
    
    Elliptic Prime Curve 384 bit (EC_secp384r1)
    
    Elliptic Prime Curve 521 bit (EC_secp521r1)
    
    The certificate must be a valid SSL/TLS X.509 version 3 certificate with FQDN or IP address specified and information about the issuer.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - endpointDetails
```
UpdateServerRequest.Builder endpointDetails(EndpointDetails endpointDetails)
```
    The virtual private cloud (VPC) endpoint settings that are configured for your server. With a VPC endpoint, you can restrict access to your 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 server. With a VPC endpoint, you can restrict access to your 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.
  - endpointDetails
```
default UpdateServerRequest.Builder endpointDetails(Consumer<EndpointDetails.Builder> endpointDetails)
```
    The virtual private cloud (VPC) endpoint settings that are configured for your server. With a VPC endpoint, you can restrict access to your 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.
    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
```
UpdateServerRequest.Builder endpointType(String endpointType)
```
    The type of endpoint that you want your server to connect to. You can choose to connect to the public internet or a VPC endpoint. With a VPC endpoint, you can restrict access to your server and resources only within your VPC.
    
    It is recommended that you use VPC as the EndpointType. With this endpoint type, you have the option to directly associate up to three Elastic IPv4 addresses (BYO IP included) with your server's endpoint and use VPC security groups to restrict traffic by the client's public IP address. This is not possible with EndpointType set to VPC_ENDPOINT.
    
    Parameters:
    
    endpointType - The type of endpoint that you want your server to connect to. You can choose to connect to the public internet or a VPC endpoint. With a VPC endpoint, you can restrict access to your server and resources only within your VPC.
    
    It is recommended that you use VPC as the EndpointType. With this endpoint type, you have the option to directly associate up to three Elastic IPv4 addresses (BYO IP included) with your server's endpoint and use VPC security groups to restrict traffic by the client's public IP address. This is not possible with EndpointType set to VPC_ENDPOINT.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    EndpointType, EndpointType
  - endpointType
```
UpdateServerRequest.Builder endpointType(EndpointType endpointType)
```
    The type of endpoint that you want your server to connect to. You can choose to connect to the public internet or a VPC endpoint. With a VPC endpoint, you can restrict access to your server and resources only within your VPC.
    
    It is recommended that you use VPC as the EndpointType. With this endpoint type, you have the option to directly associate up to three Elastic IPv4 addresses (BYO IP included) with your server's endpoint and use VPC security groups to restrict traffic by the client's public IP address. This is not possible with EndpointType set to VPC_ENDPOINT.
    
    Parameters:
    
    endpointType - The type of endpoint that you want your server to connect to. You can choose to connect to the public internet or a VPC endpoint. With a VPC endpoint, you can restrict access to your server and resources only within your VPC.
    
    It is recommended that you use VPC as the EndpointType. With this endpoint type, you have the option to directly associate up to three Elastic IPv4 addresses (BYO IP included) with your server's endpoint and use VPC security groups to restrict traffic by the client's public IP address. This is not possible with EndpointType set to VPC_ENDPOINT.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    EndpointType, EndpointType
  - hostKey
```
UpdateServerRequest.Builder hostKey(String hostKey)
```
    The RSA private key as generated by ssh-keygen -N "" -m PEM -f my-new-server-key.
    
    If you aren't planning to migrate existing users from an existing server to a new server, don't update the host key. Accidentally changing a server's host key can be disruptive.
    
    For more information, see Change the host key for your SFTP-enabled server in the AWS Transfer Family User Guide.
    
    Parameters:
    
    hostKey - The RSA private key as generated by ssh-keygen -N "" -m PEM -f my-new-server-key.
    
    If you aren't planning to migrate existing users from an existing server to a new server, don't update the host key. Accidentally changing a server's host key can be disruptive.
    
    For more information, see Change the host key for your SFTP-enabled server in the AWS Transfer Family User Guide.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - identityProviderDetails
```
UpdateServerRequest.Builder identityProviderDetails(IdentityProviderDetails identityProviderDetails)
```
    An array containing all of the information required to call a customer's authentication API method.
    
    Parameters:
    
    identityProviderDetails - 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.
  - identityProviderDetails
```
default UpdateServerRequest.Builder identityProviderDetails(Consumer<IdentityProviderDetails.Builder> identityProviderDetails)
```
    An array containing all of the information required to call a customer's authentication API method.
    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)
  - loggingRole
```
UpdateServerRequest.Builder loggingRole(String loggingRole)
```
    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 - 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.
  - protocolsWithStrings
```
UpdateServerRequest.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:
    - Secure Shell (SSH) File Transfer Protocol (SFTP): File transfer over SSH
    - File Transfer Protocol Secure (FTPS): File transfer with TLS encryption
    - File Transfer Protocol (FTP): Unencrypted file transfer
    If you select FTPS, you must choose a certificate stored in AWS Certificate Manager (ACM) which will be 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 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 to SERVICE_MANAGED.
    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:
    
    Secure Shell (SSH) File Transfer Protocol (SFTP): File transfer over SSH
    
    File Transfer Protocol Secure (FTPS): File transfer with TLS encryption
    
    File Transfer Protocol (FTP): Unencrypted file transfer
    
    If you select FTPS, you must choose a certificate stored in AWS Certificate Manager (ACM) which will be 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 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 to SERVICE_MANAGED.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - protocolsWithStrings
```
UpdateServerRequest.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:
    - Secure Shell (SSH) File Transfer Protocol (SFTP): File transfer over SSH
    - File Transfer Protocol Secure (FTPS): File transfer with TLS encryption
    - File Transfer Protocol (FTP): Unencrypted file transfer
    If you select FTPS, you must choose a certificate stored in AWS Certificate Manager (ACM) which will be 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 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 to SERVICE_MANAGED.
    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:
    
    Secure Shell (SSH) File Transfer Protocol (SFTP): File transfer over SSH
    
    File Transfer Protocol Secure (FTPS): File transfer with TLS encryption
    
    File Transfer Protocol (FTP): Unencrypted file transfer
    
    If you select FTPS, you must choose a certificate stored in AWS Certificate Manager (ACM) which will be 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 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 to SERVICE_MANAGED.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - protocols
```
UpdateServerRequest.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:
    - Secure Shell (SSH) File Transfer Protocol (SFTP): File transfer over SSH
    - File Transfer Protocol Secure (FTPS): File transfer with TLS encryption
    - File Transfer Protocol (FTP): Unencrypted file transfer
    If you select FTPS, you must choose a certificate stored in AWS Certificate Manager (ACM) which will be 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 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 to SERVICE_MANAGED.
    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:
    
    Secure Shell (SSH) File Transfer Protocol (SFTP): File transfer over SSH
    
    File Transfer Protocol Secure (FTPS): File transfer with TLS encryption
    
    File Transfer Protocol (FTP): Unencrypted file transfer
    
    If you select FTPS, you must choose a certificate stored in AWS Certificate Manager (ACM) which will be 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 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 to SERVICE_MANAGED.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - protocols
```
UpdateServerRequest.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:
    - Secure Shell (SSH) File Transfer Protocol (SFTP): File transfer over SSH
    - File Transfer Protocol Secure (FTPS): File transfer with TLS encryption
    - File Transfer Protocol (FTP): Unencrypted file transfer
    If you select FTPS, you must choose a certificate stored in AWS Certificate Manager (ACM) which will be 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 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 to SERVICE_MANAGED.
    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:
    
    Secure Shell (SSH) File Transfer Protocol (SFTP): File transfer over SSH
    
    File Transfer Protocol Secure (FTPS): File transfer with TLS encryption
    
    File Transfer Protocol (FTP): Unencrypted file transfer
    
    If you select FTPS, you must choose a certificate stored in AWS Certificate Manager (ACM) which will be 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 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 to SERVICE_MANAGED.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - securityPolicyName
```
UpdateServerRequest.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
```
UpdateServerRequest.Builder serverId(String serverId)
```
    A system-assigned unique identifier for a server instance that the user account is assigned to.
    
    Parameters:
    
    serverId - A system-assigned unique identifier for a server instance that the user account is assigned to.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - overrideConfiguration
```
UpdateServerRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
```
    Description copied from interface: AwsRequest.Builder
    
    Add an optional request override configuration.
    
    Specified by:
    
    overrideConfiguration in interface AwsRequest.Builder
    
    Parameters:
    
    overrideConfiguration - The override configuration.
    
    Returns:
    
    This object for method chaining.
  - overrideConfiguration
```
UpdateServerRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
```
    Description copied from interface: AwsRequest.Builder
    
    Add an optional request override configuration.
    
    Specified by:
    
    overrideConfiguration in interface AwsRequest.Builder
    
    Parameters:
    
    builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
    
    Returns:
    
    This object for method chaining.

AWS SDK for Java API Reference - 2.16.43

Interface UpdateServerRequest.Builder

Method Summary

Methods inherited from interface software.amazon.awssdk.services.transfer.model.TransferRequest.Builder

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

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

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

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

Method Detail

certificate

endpointDetails

endpointDetails

endpointType

endpointType

hostKey

identityProviderDetails

identityProviderDetails

loggingRole

protocolsWithStrings

protocolsWithStrings

protocols

protocols

securityPolicyName

serverId

overrideConfiguration

overrideConfiguration