@Generated(value="software.amazon.awssdk:codegen") public final class UpdateServerRequest extends TransferRequest implements ToCopyableBuilder<UpdateServerRequest.Builder,UpdateServerRequest>
Modifier and Type | Class and Description |
---|---|
static interface |
UpdateServerRequest.Builder |
Modifier and Type | Method and Description |
---|---|
static UpdateServerRequest.Builder |
builder() |
String |
certificate()
The Amazon Resource Name (ARN) of the AWS Certificate 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 connect to.
|
String |
endpointTypeAsString()
The type of endpoint that you want your server to connect to.
|
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj)
Indicates whether some other object is "equal to" this one by SDK fields.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz)
Used to retrieve the value of a field from any class that extends
SdkRequest . |
int |
hashCode() |
boolean |
hasProtocols()
Returns true if the Protocols property was specified by the sender (it may be empty), or false if the sender did
not specify the value (it will be empty).
|
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()
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.
|
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()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString()
Returns a string representation of this object.
|
overrideConfiguration
copy
public final 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.
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.
public final 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.
public final 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
.
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()
.
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
.
EndpointType
public final String endpointTypeAsString()
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
.
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()
.
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
.
EndpointType
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 AWS Transfer Family User Guide.
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.
public final IdentityProviderDetails identityProviderDetails()
An array containing all of the information required to call a customer's authentication API method.
public final 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.
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 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
.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasProtocols()
to see if a value was sent in this field.
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
.
public final boolean hasProtocols()
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 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
.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasProtocols()
to see if a value was sent in this field.
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
.
public final String securityPolicyName()
Specifies the name of the security policy that is attached to the server.
public final String serverId()
A system-assigned unique identifier for a server instance that the user account is assigned to.
public UpdateServerRequest.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<UpdateServerRequest.Builder,UpdateServerRequest>
toBuilder
in class TransferRequest
public static UpdateServerRequest.Builder builder()
public static Class<? extends UpdateServerRequest.Builder> serializableBuilderClass()
public final int hashCode()
hashCode
in class AwsRequest
public final boolean equals(Object obj)
equals
in class AwsRequest
public final boolean equalsBySdkFields(Object obj)
SdkPojo
SdkPojo
class,
and is generated based on a service model.
If an SdkPojo
class does not have any inherited fields, equalsBySdkFields
and equals
are essentially the same.
equalsBySdkFields
in interface SdkPojo
obj
- the object to be compared withpublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequest
SdkRequest
. The field name
specified should match the member name from the corresponding service-2.json model specified in the
codegen-resources folder for a given service. The class specifies what class to cast the returned value to.
If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class)
method will
again be available.getValueForField
in class SdkRequest
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.