UpdateServerRequest (AWS Java SDK :: Services

java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.transfer.model.TransferRequest
    - - software.amazon.awssdk.services.transfer.model.UpdateServerRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<UpdateServerRequest.Builder,UpdateServerRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class UpdateServerRequest
extends TransferRequest
implements ToCopyableBuilder<UpdateServerRequest.Builder,UpdateServerRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface UpdateServerRequest.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`UpdateServerRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static UpdateServerRequest.Builder`	`builder()`
`String`	`certificate()` The Amazon Resource Name (ARN) of the Amazon Web ServicesCertificate Manager (ACM) certificate.
`EndpointDetails`	`endpointDetails()` The virtual private cloud (VPC) endpoint settings that are configured for your server.
`EndpointType`	`endpointType()` The type of endpoint that you want your server to use.
`String`	`endpointTypeAsString()` The type of endpoint that you want your server to use.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasProtocols()` For responses, this returns true if the service returned a value for the Protocols property.
`String`	`hostKey()` The RSA private key as generated by `ssh-keygen -N "" -m PEM -f my-new-server-key`.
`IdentityProviderDetails`	`identityProviderDetails()` An array containing all of the information required to call a customer's authentication API method.
`String`	`loggingRole()` Specifies the Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) role that allows a server to turn on Amazon CloudWatch logging for Amazon S3 or Amazon EFS events.
`String`	`postAuthenticationLoginBanner()` Specify a string to display when users connect to a server.
`String`	`preAuthenticationLoginBanner()` Specify a string to display when users connect to a server.
`ProtocolDetails`	`protocolDetails()` The protocol settings that are configured for your server.
`List<Protocol>`	`protocols()` Specifies the file transfer protocol or protocols over which your file transfer protocol client can connect to your server's endpoint.
`List<String>`	`protocolsAsStrings()` Specifies the file transfer protocol or protocols over which your file transfer protocol client can connect to your server's endpoint.
`List<SdkField<?>>`	`sdkFields()`
`String`	`securityPolicyName()` Specifies the name of the security policy that is attached to the server.
`static Class<? extends UpdateServerRequest.Builder>`	`serializableBuilderClass()`
`String`	`serverId()` A system-assigned unique identifier for a server instance that the user account is assigned to.
`UpdateServerRequest.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`WorkflowDetails`	`workflowDetails()` Specifies the workflow ID for the workflow to assign and the execution role used for executing the workflow.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - certificate
```
public final String certificate()
```
    The Amazon Resource Name (ARN) of the Amazon Web ServicesCertificate Manager (ACM) certificate. Required when Protocols is set to FTPS.
    
    To request a new public certificate, see Request a public certificate in the Amazon Web ServicesCertificate Manager User Guide.
    
    To import an existing certificate into ACM, see Importing certificates into ACM in the Amazon Web ServicesCertificate Manager User Guide.
    
    To request a private certificate to use FTPS through private IP addresses, see Request a private certificate in the Amazon Web ServicesCertificate 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:
    The Amazon Resource Name (ARN) of the Amazon Web ServicesCertificate Manager (ACM) certificate. Required when Protocols is set to FTPS.
    
    To request a new public certificate, see Request a public certificate in the Amazon Web ServicesCertificate Manager User Guide.
    
    To import an existing certificate into ACM, see Importing certificates into ACM in the Amazon Web ServicesCertificate Manager User Guide.
    
    To request a private certificate to use FTPS through private IP addresses, see Request a private certificate in the Amazon Web ServicesCertificate 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.
  - protocolDetails
```
public final ProtocolDetails protocolDetails()
```
    The protocol settings that are configured for your server.
    
    Use the PassiveIp parameter to indicate passive mode (for FTP and FTPS protocols). Enter a single dotted-quad IPv4 address, such as the external IP address of a firewall, router, or load balancer.
    
    Use the TlsSessionResumptionMode parameter to determine whether or not your Transfer server resumes recent, negotiated sessions through a unique session ID.
    
    Returns:
    
    The protocol settings that are configured for your server.
    
    Use the PassiveIp parameter to indicate passive mode (for FTP and FTPS protocols). Enter a single dotted-quad IPv4 address, such as the external IP address of a firewall, router, or load balancer.
    
    Use the TlsSessionResumptionMode parameter to determine whether or not your Transfer server resumes recent, negotiated sessions through a unique session ID.
  - endpointDetails
```
public final EndpointDetails endpointDetails()
```
    The virtual private cloud (VPC) endpoint settings that are configured for your server. When you host your endpoint within your VPC, you can make it accessible only to resources within your VPC, or you can attach Elastic IP addresses and make it accessible to clients over the internet. Your VPC's default security groups are automatically assigned to your endpoint.
    
    Returns:
    
    The virtual private cloud (VPC) endpoint settings that are configured for your server. When you host your endpoint within your VPC, you can make it accessible only to resources within your VPC, or you can attach Elastic IP addresses and make it accessible to clients over the internet. Your VPC's default security groups are automatically assigned to your endpoint.
  - endpointType
```
public final EndpointType endpointType()
```
    The type of endpoint that you want your server to use. You can choose to make your server's endpoint publicly accessible (PUBLIC) or host it inside your VPC. With an endpoint that is hosted in a VPC, you can restrict access to your server and resources only within your VPC or choose to make it internet facing by attaching Elastic IP addresses directly to it.
    
    After May 19, 2021, you won't be able to create a server using EndpointType=VPC_ENDPOINT in your Amazon Web Servicesaccount if your account hasn't already done so before May 19, 2021. If you have already created servers with EndpointType=VPC_ENDPOINT in your Amazon Web Servicesaccount on or before May 19, 2021, you will not be affected. After this date, use EndpointType=VPC.
    
    For more information, see https://docs.aws.amazon.com/transfer/latest/userguide/create-server-in-vpc.html#deprecate-vpc-endpoint.
    
    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.
    
    If the service returns an enum value that is not available in the current SDK version, endpointType will return EndpointType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from endpointTypeAsString().
    
    Returns:
    
    The type of endpoint that you want your server to use. You can choose to make your server's endpoint publicly accessible (PUBLIC) or host it inside your VPC. With an endpoint that is hosted in a VPC, you can restrict access to your server and resources only within your VPC or choose to make it internet facing by attaching Elastic IP addresses directly to it.
    
    After May 19, 2021, you won't be able to create a server using EndpointType=VPC_ENDPOINT in your Amazon Web Servicesaccount if your account hasn't already done so before May 19, 2021. If you have already created servers with EndpointType=VPC_ENDPOINT in your Amazon Web Servicesaccount on or before May 19, 2021, you will not be affected. After this date, use EndpointType= VPC.
    
    For more information, see https://docs.aws.amazon.com/transfer/latest/userguide/create-server-in-vpc.html#deprecate-vpc-endpoint.
    
    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.
    
    See Also:
    
    EndpointType
  - endpointTypeAsString
```
public final String endpointTypeAsString()
```
    The type of endpoint that you want your server to use. You can choose to make your server's endpoint publicly accessible (PUBLIC) or host it inside your VPC. With an endpoint that is hosted in a VPC, you can restrict access to your server and resources only within your VPC or choose to make it internet facing by attaching Elastic IP addresses directly to it.
    
    After May 19, 2021, you won't be able to create a server using EndpointType=VPC_ENDPOINT in your Amazon Web Servicesaccount if your account hasn't already done so before May 19, 2021. If you have already created servers with EndpointType=VPC_ENDPOINT in your Amazon Web Servicesaccount on or before May 19, 2021, you will not be affected. After this date, use EndpointType=VPC.
    
    For more information, see https://docs.aws.amazon.com/transfer/latest/userguide/create-server-in-vpc.html#deprecate-vpc-endpoint.
    
    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.
    
    If the service returns an enum value that is not available in the current SDK version, endpointType will return EndpointType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from endpointTypeAsString().
    
    Returns:
    
    The type of endpoint that you want your server to use. You can choose to make your server's endpoint publicly accessible (PUBLIC) or host it inside your VPC. With an endpoint that is hosted in a VPC, you can restrict access to your server and resources only within your VPC or choose to make it internet facing by attaching Elastic IP addresses directly to it.
    
    After May 19, 2021, you won't be able to create a server using EndpointType=VPC_ENDPOINT in your Amazon Web Servicesaccount if your account hasn't already done so before May 19, 2021. If you have already created servers with EndpointType=VPC_ENDPOINT in your Amazon Web Servicesaccount on or before May 19, 2021, you will not be affected. After this date, use EndpointType= VPC.
    
    For more information, see https://docs.aws.amazon.com/transfer/latest/userguide/create-server-in-vpc.html#deprecate-vpc-endpoint.
    
    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.
    
    See Also:
    
    EndpointType
  - hostKey
```
public final 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 Amazon Web ServicesTransfer Family User Guide.
    
    Returns:
    
    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 Amazon Web ServicesTransfer Family User Guide.
  - identityProviderDetails
```
public final IdentityProviderDetails identityProviderDetails()
```
    An array containing all of the information required to call a customer's authentication API method.
    
    Returns:
    
    An array containing all of the information required to call a customer's authentication API method.
  - loggingRole
```
public final String loggingRole()
```
    Specifies the Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) role that allows a server to turn on Amazon CloudWatch logging for Amazon S3 or Amazon EFS events. When set, user activity can be viewed in your CloudWatch logs.
    
    Returns:
    
    Specifies the Amazon Resource Name (ARN) of the Amazon Web Services Identity and Access Management (IAM) role that allows a server to turn on Amazon CloudWatch logging for Amazon S3 or Amazon EFS events. When set, user activity can be viewed in your CloudWatch logs.
  - postAuthenticationLoginBanner
```
public final String postAuthenticationLoginBanner()
```
    Specify a string to display when users connect to a server. This string is displayed after the user authenticates.
    
    The SFTP protocol does not support post-authentication display banners.
    
    Returns:
    
    Specify a string to display when users connect to a server. This string is displayed after the user authenticates.
    
    The SFTP protocol does not support post-authentication display banners.
  - preAuthenticationLoginBanner
```
public final String preAuthenticationLoginBanner()
```
    Specify a string to display when users connect to a server. This string is displayed before the user authenticates. For example, the following banner displays details about using the system.
    
    This system is for the use of authorized users only. Individuals using this computer system without authority, or in excess of their authority, are subject to having all of their activities on this system monitored and recorded by system personnel.
    
    Returns:
    
    Specify a string to display when users connect to a server. This string is displayed before the user authenticates. For example, the following banner displays details about using the system.
    
    This system is for the use of authorized users only. Individuals using this computer system without authority, or in excess of their authority, are subject to having all of their activities on this system monitored and recorded by system personnel.
  - protocols
```
public final List<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 Amazon Web ServicesCertificate 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 AWS_DIRECTORY_SERVICE or 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.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasProtocols() method.
    Returns:
    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 Amazon Web ServicesCertificate 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 AWS_DIRECTORY_SERVICE or 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.
  - hasProtocols
```
public final boolean hasProtocols()
```
    For responses, this returns true if the service returned a value for the Protocols property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - protocolsAsStrings
```
public final List<String> protocolsAsStrings()
```
    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 Amazon Web ServicesCertificate 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 AWS_DIRECTORY_SERVICE or 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.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasProtocols() method.
    Returns:
    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 Amazon Web ServicesCertificate 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 AWS_DIRECTORY_SERVICE or 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.
  - securityPolicyName
```
public final String securityPolicyName()
```
    Specifies the name of the security policy that is attached to the server.
    
    Returns:
    
    Specifies the name of the security policy that is attached to the server.
  - serverId
```
public final String serverId()
```
    A system-assigned unique identifier for a server instance that the user account is assigned to.
    
    Returns:
    
    A system-assigned unique identifier for a server instance that the user account is assigned to.
  - workflowDetails
```
public final WorkflowDetails workflowDetails()
```
    Specifies the workflow ID for the workflow to assign and the execution role used for executing the workflow.
    
    To remove an associated workflow from a server, you can provide an empty OnUpload object, as in the following example.
    
    aws transfer update-server --server-id s-01234567890abcdef --workflow-details '{"OnUpload":[]}'
    
    Returns:
    
    Specifies the workflow ID for the workflow to assign and the execution role used for executing the workflow.
    
    To remove an associated workflow from a server, you can provide an empty OnUpload object, as in the following example.
    
    aws transfer update-server --server-id s-01234567890abcdef --workflow-details '{"OnUpload":[]}'
  - toBuilder
```
public UpdateServerRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<UpdateServerRequest.Builder,UpdateServerRequest>
    
    Specified by:
    
    toBuilder in class TransferRequest
  - builder
```
public static UpdateServerRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends UpdateServerRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final 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
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class UpdateServerRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

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

Method Detail

certificate

protocolDetails

endpointDetails

endpointType

endpointTypeAsString

hostKey

identityProviderDetails

loggingRole

postAuthenticationLoginBanner

preAuthenticationLoginBanner

protocols

hasProtocols

protocolsAsStrings

securityPolicyName

serverId

workflowDetails

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields