/* * Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with * the License. A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions * and limitations under the License. */ package com.amazonaws.services.transfer.model; import java.io.Serializable; import javax.annotation.Generated; import com.amazonaws.protocol.StructuredPojo; import com.amazonaws.protocol.ProtocolMarshaller; /** *
* Describes the properties of a file transfer protocol-enabled server that was specified. *
* * @see AWS API * Documentation */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class DescribedServer implements Serializable, Cloneable, StructuredPojo { /** ** Specifies the unique Amazon Resource Name (ARN) of the server. *
*/ private String arn; /** *
* Specifies the ARN of the Amazon Web ServicesCertificate Manager (ACM) certificate. Required when
* Protocols
is set to FTPS
.
*
* The protocol settings that are configured for your server. *
*
* To indicate passive mode (for FTP and FTPS protocols), use the PassiveIp
parameter. Enter a single
* dotted-quad IPv4 address, such as the external IP address of a firewall, router, or load balancer.
*
* To ignore the error that is generated when the client attempts to use the SETSTAT
command on a file
* that you are uploading to an Amazon S3 bucket, use the SetStatOption
parameter. To have the Transfer
* Family server ignore the SETSTAT
command and upload files without needing to make any changes to
* your SFTP client, set the value to ENABLE_NO_OP
. If you set the SetStatOption
parameter
* to ENABLE_NO_OP
, Transfer Family generates a log entry to Amazon CloudWatch Logs, so that you can
* determine when the client is making a SETSTAT
call.
*
* To determine whether your Transfer Family server resumes recent, negotiated sessions through a unique session ID,
* use the TlsSessionResumptionMode
parameter.
*
* As2Transports
indicates the transport method for the AS2 messages. Currently, only HTTP is
* supported.
*
* Specifies the domain of the storage system that is used for file transfers. *
*/ private String domain; /** ** The virtual private cloud (VPC) endpoint settings that are configured for your server. When you host your * endpoint within your VPC, you can make your endpoint accessible only to resources within your VPC, or you can * attach Elastic IP addresses and make your endpoint accessible to clients over the internet. Your VPC's default * security groups are automatically assigned to your endpoint. *
*/ private EndpointDetails endpointDetails; /** ** Defines the type of endpoint that your server is connected to. If your server is connected to a VPC endpoint, * your server isn't accessible over the public internet. *
*/ private String endpointType; /** *
* Specifies the Base64-encoded SHA256 fingerprint of the server's host key. This value is equivalent to the output
* of the ssh-keygen -l -f my-new-server-key
command.
*
* Specifies information to call a customer-supplied authentication API. This field is not populated when the
* IdentityProviderType
of a server is AWS_DIRECTORY_SERVICE
or
* SERVICE_MANAGED
.
*
* The mode of authentication for a server. The default value is SERVICE_MANAGED
, which allows you to
* store and access user credentials within the Transfer Family service.
*
* Use AWS_DIRECTORY_SERVICE
to provide access to Active Directory groups in Directory Service for
* Microsoft Active Directory or Microsoft Active Directory in your on-premises environment or in Amazon Web
* Services using AD Connector. This option also requires you to provide a Directory ID by using the
* IdentityProviderDetails
parameter.
*
* Use the API_GATEWAY
value to integrate with an identity provider of your choosing. The
* API_GATEWAY
setting requires you to provide an Amazon API Gateway endpoint URL to call for
* authentication by using the IdentityProviderDetails
parameter.
*
* Use the AWS_LAMBDA
value to directly use an Lambda function as your identity provider. If you choose
* this value, you must specify the ARN for the Lambda function in the Function
parameter for the
* IdentityProviderDetails
data type.
*
* The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that allows a server to turn on * Amazon CloudWatch logging for Amazon S3 or Amazon EFSevents. When set, you can view user activity in your * CloudWatch logs. *
*/ private String loggingRole; /** ** Specifies 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. *
** Specifies 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.
*
* 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: *
*
* SFTP
(Secure Shell (SSH) File Transfer Protocol): File transfer over SSH
*
* FTPS
(File Transfer Protocol Secure): File transfer with TLS encryption
*
* FTP
(File Transfer Protocol): Unencrypted file transfer
*
* AS2
(Applicability Statement 2): used for transporting structured business-to-business data
*
* If you select FTPS
, you must choose a certificate stored in Certificate Manager (ACM) which is 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 either
* AWS_DIRECTORY_SERVICE
, AWS_LAMBDA
, 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 any of the supported identity types:
* SERVICE_MANAGED
, AWS_DIRECTORY_SERVICE
, AWS_LAMBDA
, or
* API_GATEWAY
.
*
* If Protocol
includes AS2
, then the EndpointType
must be VPC
,
* and domain must be Amazon S3.
*
* Specifies the name of the security policy that is attached to the server. *
*/ private String securityPolicyName; /** ** Specifies the unique system-assigned identifier for a server that you instantiate. *
*/ private String serverId; /** *
* The condition of 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
indicate 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.
*
* Specifies the key-value pairs that you can use to search for and group servers that were assigned to the server * that was described. *
*/ private java.util.List
* Specifies the number of users that are assigned to a server you specified with the ServerId
.
*
* Specifies the workflow ID for the workflow to assign and the execution role that's used for executing the * workflow. *
*
* In addition to a workflow to execute when a file is uploaded completely, WorkflowDetails
can also
* contain a workflow ID (and execution role) for a workflow to execute on partial upload. A partial upload occurs
* when the server session disconnects while the file is still being uploaded.
*
* Specifies the log groups to which your server logs are sent. *
** To specify a log group, you must provide the ARN for an existing log group. In this case, the format of the log * group is as follows: *
*
* arn:aws:logs:region-name:amazon-account-id:log-group:log-group-name:*
*
* For example, arn:aws:logs:us-east-1:111122223333:log-group:mytestgroup:*
*
* If you have previously specified a log group for a server, you can clear it, and in effect turn off structured
* logging, by providing an empty value for this parameter in an update-server
call. For example:
*
* update-server --server-id s-1234567890abcdef0 --structured-log-destinations
*
* Specifies the unique Amazon Resource Name (ARN) of the server. *
* * @param arn * Specifies the unique Amazon Resource Name (ARN) of the server. */ public void setArn(String arn) { this.arn = arn; } /** ** Specifies the unique Amazon Resource Name (ARN) of the server. *
* * @return Specifies the unique Amazon Resource Name (ARN) of the server. */ public String getArn() { return this.arn; } /** ** Specifies the unique Amazon Resource Name (ARN) of the server. *
* * @param arn * Specifies the unique Amazon Resource Name (ARN) of the server. * @return Returns a reference to this object so that method calls can be chained together. */ public DescribedServer withArn(String arn) { setArn(arn); return this; } /** *
* Specifies the ARN of the Amazon Web ServicesCertificate Manager (ACM) certificate. Required when
* Protocols
is set to FTPS
.
*
Protocols
is set to FTPS
.
*/
public void setCertificate(String certificate) {
this.certificate = certificate;
}
/**
*
* Specifies the ARN of the Amazon Web ServicesCertificate Manager (ACM) certificate. Required when
* Protocols
is set to FTPS
.
*
Protocols
is set to FTPS
.
*/
public String getCertificate() {
return this.certificate;
}
/**
*
* Specifies the ARN of the Amazon Web ServicesCertificate Manager (ACM) certificate. Required when
* Protocols
is set to FTPS
.
*
Protocols
is set to FTPS
.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribedServer withCertificate(String certificate) {
setCertificate(certificate);
return this;
}
/**
* * The protocol settings that are configured for your server. *
*
* To indicate passive mode (for FTP and FTPS protocols), use the PassiveIp
parameter. Enter a single
* dotted-quad IPv4 address, such as the external IP address of a firewall, router, or load balancer.
*
* To ignore the error that is generated when the client attempts to use the SETSTAT
command on a file
* that you are uploading to an Amazon S3 bucket, use the SetStatOption
parameter. To have the Transfer
* Family server ignore the SETSTAT
command and upload files without needing to make any changes to
* your SFTP client, set the value to ENABLE_NO_OP
. If you set the SetStatOption
parameter
* to ENABLE_NO_OP
, Transfer Family generates a log entry to Amazon CloudWatch Logs, so that you can
* determine when the client is making a SETSTAT
call.
*
* To determine whether your Transfer Family server resumes recent, negotiated sessions through a unique session ID,
* use the TlsSessionResumptionMode
parameter.
*
* As2Transports
indicates the transport method for the AS2 messages. Currently, only HTTP is
* supported.
*
* To indicate passive mode (for FTP and FTPS protocols), use the PassiveIp
parameter. Enter a
* single dotted-quad IPv4 address, such as the external IP address of a firewall, router, or load balancer.
*
* To ignore the error that is generated when the client attempts to use the SETSTAT
command on
* a file that you are uploading to an Amazon S3 bucket, use the SetStatOption
parameter. To
* have the Transfer Family server ignore the SETSTAT
command and upload files without needing
* to make any changes to your SFTP client, set the value to ENABLE_NO_OP
. If you set the
* SetStatOption
parameter to ENABLE_NO_OP
, Transfer Family generates a log entry
* to Amazon CloudWatch Logs, so that you can determine when the client is making a SETSTAT
* call.
*
* To determine whether your Transfer Family server resumes recent, negotiated sessions through a unique
* session ID, use the TlsSessionResumptionMode
parameter.
*
* As2Transports
indicates the transport method for the AS2 messages. Currently, only HTTP is
* supported.
*
* The protocol settings that are configured for your server. *
*
* To indicate passive mode (for FTP and FTPS protocols), use the PassiveIp
parameter. Enter a single
* dotted-quad IPv4 address, such as the external IP address of a firewall, router, or load balancer.
*
* To ignore the error that is generated when the client attempts to use the SETSTAT
command on a file
* that you are uploading to an Amazon S3 bucket, use the SetStatOption
parameter. To have the Transfer
* Family server ignore the SETSTAT
command and upload files without needing to make any changes to
* your SFTP client, set the value to ENABLE_NO_OP
. If you set the SetStatOption
parameter
* to ENABLE_NO_OP
, Transfer Family generates a log entry to Amazon CloudWatch Logs, so that you can
* determine when the client is making a SETSTAT
call.
*
* To determine whether your Transfer Family server resumes recent, negotiated sessions through a unique session ID,
* use the TlsSessionResumptionMode
parameter.
*
* As2Transports
indicates the transport method for the AS2 messages. Currently, only HTTP is
* supported.
*
* To indicate passive mode (for FTP and FTPS protocols), use the PassiveIp
parameter. Enter a
* single dotted-quad IPv4 address, such as the external IP address of a firewall, router, or load balancer.
*
* To ignore the error that is generated when the client attempts to use the SETSTAT
command on
* a file that you are uploading to an Amazon S3 bucket, use the SetStatOption
parameter. To
* have the Transfer Family server ignore the SETSTAT
command and upload files without needing
* to make any changes to your SFTP client, set the value to ENABLE_NO_OP
. If you set the
* SetStatOption
parameter to ENABLE_NO_OP
, Transfer Family generates a log entry
* to Amazon CloudWatch Logs, so that you can determine when the client is making a SETSTAT
* call.
*
* To determine whether your Transfer Family server resumes recent, negotiated sessions through a unique
* session ID, use the TlsSessionResumptionMode
parameter.
*
* As2Transports
indicates the transport method for the AS2 messages. Currently, only HTTP is
* supported.
*
* The protocol settings that are configured for your server. *
*
* To indicate passive mode (for FTP and FTPS protocols), use the PassiveIp
parameter. Enter a single
* dotted-quad IPv4 address, such as the external IP address of a firewall, router, or load balancer.
*
* To ignore the error that is generated when the client attempts to use the SETSTAT
command on a file
* that you are uploading to an Amazon S3 bucket, use the SetStatOption
parameter. To have the Transfer
* Family server ignore the SETSTAT
command and upload files without needing to make any changes to
* your SFTP client, set the value to ENABLE_NO_OP
. If you set the SetStatOption
parameter
* to ENABLE_NO_OP
, Transfer Family generates a log entry to Amazon CloudWatch Logs, so that you can
* determine when the client is making a SETSTAT
call.
*
* To determine whether your Transfer Family server resumes recent, negotiated sessions through a unique session ID,
* use the TlsSessionResumptionMode
parameter.
*
* As2Transports
indicates the transport method for the AS2 messages. Currently, only HTTP is
* supported.
*
* To indicate passive mode (for FTP and FTPS protocols), use the PassiveIp
parameter. Enter a
* single dotted-quad IPv4 address, such as the external IP address of a firewall, router, or load balancer.
*
* To ignore the error that is generated when the client attempts to use the SETSTAT
command on
* a file that you are uploading to an Amazon S3 bucket, use the SetStatOption
parameter. To
* have the Transfer Family server ignore the SETSTAT
command and upload files without needing
* to make any changes to your SFTP client, set the value to ENABLE_NO_OP
. If you set the
* SetStatOption
parameter to ENABLE_NO_OP
, Transfer Family generates a log entry
* to Amazon CloudWatch Logs, so that you can determine when the client is making a SETSTAT
* call.
*
* To determine whether your Transfer Family server resumes recent, negotiated sessions through a unique
* session ID, use the TlsSessionResumptionMode
parameter.
*
* As2Transports
indicates the transport method for the AS2 messages. Currently, only HTTP is
* supported.
*
* Specifies the domain of the storage system that is used for file transfers. *
* * @param domain * Specifies the domain of the storage system that is used for file transfers. * @see Domain */ public void setDomain(String domain) { this.domain = domain; } /** ** Specifies the domain of the storage system that is used for file transfers. *
* * @return Specifies the domain of the storage system that is used for file transfers. * @see Domain */ public String getDomain() { return this.domain; } /** ** Specifies the domain of the storage system that is used for file transfers. *
* * @param domain * Specifies the domain of the storage system that is used for file transfers. * @return Returns a reference to this object so that method calls can be chained together. * @see Domain */ public DescribedServer withDomain(String domain) { setDomain(domain); return this; } /** ** Specifies the domain of the storage system that is used for file transfers. *
* * @param domain * Specifies the domain of the storage system that is used for file transfers. * @return Returns a reference to this object so that method calls can be chained together. * @see Domain */ public DescribedServer withDomain(Domain domain) { this.domain = domain.toString(); return this; } /** ** The virtual private cloud (VPC) endpoint settings that are configured for your server. When you host your * endpoint within your VPC, you can make your endpoint accessible only to resources within your VPC, or you can * attach Elastic IP addresses and make your endpoint accessible to clients over the internet. Your VPC's default * security groups are automatically assigned to your endpoint. *
* * @param 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 your endpoint accessible only to resources within your VPC, or you * can attach Elastic IP addresses and make your endpoint accessible to clients over the internet. Your VPC's * default security groups are automatically assigned to your endpoint. */ public void setEndpointDetails(EndpointDetails endpointDetails) { this.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 your endpoint accessible only to resources within your VPC, or you can * attach Elastic IP addresses and make your endpoint accessible to clients over the internet. Your VPC's default * security groups are automatically assigned to your endpoint. *
* * @return The virtual private cloud (VPC) endpoint settings that are configured for your server. When you host your * endpoint within your VPC, you can make your endpoint accessible only to resources within your VPC, or you * can attach Elastic IP addresses and make your endpoint accessible to clients over the internet. Your * VPC's default security groups are automatically assigned to your endpoint. */ public EndpointDetails getEndpointDetails() { return this.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 your endpoint accessible only to resources within your VPC, or you can * attach Elastic IP addresses and make your endpoint accessible to clients over the internet. Your VPC's default * security groups are automatically assigned to your endpoint. *
* * @param 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 your endpoint accessible only to resources within your VPC, or you * can attach Elastic IP addresses and make your endpoint accessible to clients over the internet. Your VPC's * default security groups are automatically assigned to your endpoint. * @return Returns a reference to this object so that method calls can be chained together. */ public DescribedServer withEndpointDetails(EndpointDetails endpointDetails) { setEndpointDetails(endpointDetails); return this; } /** ** Defines the type of endpoint that your server is connected to. If your server is connected to a VPC endpoint, * your server isn't accessible over the public internet. *
* * @param endpointType * Defines the type of endpoint that your server is connected to. If your server is connected to a VPC * endpoint, your server isn't accessible over the public internet. * @see EndpointType */ public void setEndpointType(String endpointType) { this.endpointType = endpointType; } /** ** Defines the type of endpoint that your server is connected to. If your server is connected to a VPC endpoint, * your server isn't accessible over the public internet. *
* * @return Defines the type of endpoint that your server is connected to. If your server is connected to a VPC * endpoint, your server isn't accessible over the public internet. * @see EndpointType */ public String getEndpointType() { return this.endpointType; } /** ** Defines the type of endpoint that your server is connected to. If your server is connected to a VPC endpoint, * your server isn't accessible over the public internet. *
* * @param endpointType * Defines the type of endpoint that your server is connected to. If your server is connected to a VPC * endpoint, your server isn't accessible over the public internet. * @return Returns a reference to this object so that method calls can be chained together. * @see EndpointType */ public DescribedServer withEndpointType(String endpointType) { setEndpointType(endpointType); return this; } /** ** Defines the type of endpoint that your server is connected to. If your server is connected to a VPC endpoint, * your server isn't accessible over the public internet. *
* * @param endpointType * Defines the type of endpoint that your server is connected to. If your server is connected to a VPC * endpoint, your server isn't accessible over the public internet. * @return Returns a reference to this object so that method calls can be chained together. * @see EndpointType */ public DescribedServer withEndpointType(EndpointType endpointType) { this.endpointType = endpointType.toString(); return this; } /** *
* Specifies the Base64-encoded SHA256 fingerprint of the server's host key. This value is equivalent to the output
* of the ssh-keygen -l -f my-new-server-key
command.
*
ssh-keygen -l -f my-new-server-key
command.
*/
public void setHostKeyFingerprint(String hostKeyFingerprint) {
this.hostKeyFingerprint = hostKeyFingerprint;
}
/**
*
* Specifies the Base64-encoded SHA256 fingerprint of the server's host key. This value is equivalent to the output
* of the ssh-keygen -l -f my-new-server-key
command.
*
ssh-keygen -l -f my-new-server-key
command.
*/
public String getHostKeyFingerprint() {
return this.hostKeyFingerprint;
}
/**
*
* Specifies the Base64-encoded SHA256 fingerprint of the server's host key. This value is equivalent to the output
* of the ssh-keygen -l -f my-new-server-key
command.
*
ssh-keygen -l -f my-new-server-key
command.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribedServer withHostKeyFingerprint(String hostKeyFingerprint) {
setHostKeyFingerprint(hostKeyFingerprint);
return this;
}
/**
*
* Specifies information to call a customer-supplied authentication API. This field is not populated when the
* IdentityProviderType
of a server is AWS_DIRECTORY_SERVICE
or
* SERVICE_MANAGED
.
*
IdentityProviderType
of a server is AWS_DIRECTORY_SERVICE
or
* SERVICE_MANAGED
.
*/
public void setIdentityProviderDetails(IdentityProviderDetails identityProviderDetails) {
this.identityProviderDetails = identityProviderDetails;
}
/**
*
* Specifies information to call a customer-supplied authentication API. This field is not populated when the
* IdentityProviderType
of a server is AWS_DIRECTORY_SERVICE
or
* SERVICE_MANAGED
.
*
IdentityProviderType
of a server is AWS_DIRECTORY_SERVICE
or
* SERVICE_MANAGED
.
*/
public IdentityProviderDetails getIdentityProviderDetails() {
return this.identityProviderDetails;
}
/**
*
* Specifies information to call a customer-supplied authentication API. This field is not populated when the
* IdentityProviderType
of a server is AWS_DIRECTORY_SERVICE
or
* SERVICE_MANAGED
.
*
IdentityProviderType
of a server is AWS_DIRECTORY_SERVICE
or
* SERVICE_MANAGED
.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribedServer withIdentityProviderDetails(IdentityProviderDetails identityProviderDetails) {
setIdentityProviderDetails(identityProviderDetails);
return this;
}
/**
*
* The mode of authentication for a server. The default value is SERVICE_MANAGED
, which allows you to
* store and access user credentials within the Transfer Family service.
*
* Use AWS_DIRECTORY_SERVICE
to provide access to Active Directory groups in Directory Service for
* Microsoft Active Directory or Microsoft Active Directory in your on-premises environment or in Amazon Web
* Services using AD Connector. This option also requires you to provide a Directory ID by using the
* IdentityProviderDetails
parameter.
*
* Use the API_GATEWAY
value to integrate with an identity provider of your choosing. The
* API_GATEWAY
setting requires you to provide an Amazon API Gateway endpoint URL to call for
* authentication by using the IdentityProviderDetails
parameter.
*
* Use the AWS_LAMBDA
value to directly use an Lambda function as your identity provider. If you choose
* this value, you must specify the ARN for the Lambda function in the Function
parameter for the
* IdentityProviderDetails
data type.
*
SERVICE_MANAGED
, which allows
* you to store and access user credentials within the Transfer Family service.
*
* Use AWS_DIRECTORY_SERVICE
to provide access to Active Directory groups in Directory Service
* for Microsoft Active Directory or Microsoft Active Directory in your on-premises environment or in Amazon
* Web Services using AD Connector. This option also requires you to provide a Directory ID by using the
* IdentityProviderDetails
parameter.
*
* Use the API_GATEWAY
value to integrate with an identity provider of your choosing. The
* API_GATEWAY
setting requires you to provide an Amazon API Gateway endpoint URL to call for
* authentication by using the IdentityProviderDetails
parameter.
*
* Use the AWS_LAMBDA
value to directly use an Lambda function as your identity provider. If you
* choose this value, you must specify the ARN for the Lambda function in the Function
parameter
* for the IdentityProviderDetails
data type.
* @see IdentityProviderType
*/
public void setIdentityProviderType(String identityProviderType) {
this.identityProviderType = identityProviderType;
}
/**
*
* The mode of authentication for a server. The default value is SERVICE_MANAGED
, which allows you to
* store and access user credentials within the Transfer Family service.
*
* Use AWS_DIRECTORY_SERVICE
to provide access to Active Directory groups in Directory Service for
* Microsoft Active Directory or Microsoft Active Directory in your on-premises environment or in Amazon Web
* Services using AD Connector. This option also requires you to provide a Directory ID by using the
* IdentityProviderDetails
parameter.
*
* Use the API_GATEWAY
value to integrate with an identity provider of your choosing. The
* API_GATEWAY
setting requires you to provide an Amazon API Gateway endpoint URL to call for
* authentication by using the IdentityProviderDetails
parameter.
*
* Use the AWS_LAMBDA
value to directly use an Lambda function as your identity provider. If you choose
* this value, you must specify the ARN for the Lambda function in the Function
parameter for the
* IdentityProviderDetails
data type.
*
SERVICE_MANAGED
, which allows
* you to store and access user credentials within the Transfer Family service.
*
* Use AWS_DIRECTORY_SERVICE
to provide access to Active Directory groups in Directory Service
* for Microsoft Active Directory or Microsoft Active Directory in your on-premises environment or in Amazon
* Web Services using AD Connector. This option also requires you to provide a Directory ID by using the
* IdentityProviderDetails
parameter.
*
* Use the API_GATEWAY
value to integrate with an identity provider of your choosing. The
* API_GATEWAY
setting requires you to provide an Amazon API Gateway endpoint URL to call for
* authentication by using the IdentityProviderDetails
parameter.
*
* Use the AWS_LAMBDA
value to directly use an Lambda function as your identity provider. If
* you choose this value, you must specify the ARN for the Lambda function in the Function
* parameter for the IdentityProviderDetails
data type.
* @see IdentityProviderType
*/
public String getIdentityProviderType() {
return this.identityProviderType;
}
/**
*
* The mode of authentication for a server. The default value is SERVICE_MANAGED
, which allows you to
* store and access user credentials within the Transfer Family service.
*
* Use AWS_DIRECTORY_SERVICE
to provide access to Active Directory groups in Directory Service for
* Microsoft Active Directory or Microsoft Active Directory in your on-premises environment or in Amazon Web
* Services using AD Connector. This option also requires you to provide a Directory ID by using the
* IdentityProviderDetails
parameter.
*
* Use the API_GATEWAY
value to integrate with an identity provider of your choosing. The
* API_GATEWAY
setting requires you to provide an Amazon API Gateway endpoint URL to call for
* authentication by using the IdentityProviderDetails
parameter.
*
* Use the AWS_LAMBDA
value to directly use an Lambda function as your identity provider. If you choose
* this value, you must specify the ARN for the Lambda function in the Function
parameter for the
* IdentityProviderDetails
data type.
*
SERVICE_MANAGED
, which allows
* you to store and access user credentials within the Transfer Family service.
*
* Use AWS_DIRECTORY_SERVICE
to provide access to Active Directory groups in Directory Service
* for Microsoft Active Directory or Microsoft Active Directory in your on-premises environment or in Amazon
* Web Services using AD Connector. This option also requires you to provide a Directory ID by using the
* IdentityProviderDetails
parameter.
*
* Use the API_GATEWAY
value to integrate with an identity provider of your choosing. The
* API_GATEWAY
setting requires you to provide an Amazon API Gateway endpoint URL to call for
* authentication by using the IdentityProviderDetails
parameter.
*
* Use the AWS_LAMBDA
value to directly use an Lambda function as your identity provider. If you
* choose this value, you must specify the ARN for the Lambda function in the Function
parameter
* for the IdentityProviderDetails
data type.
* @return Returns a reference to this object so that method calls can be chained together.
* @see IdentityProviderType
*/
public DescribedServer withIdentityProviderType(String identityProviderType) {
setIdentityProviderType(identityProviderType);
return this;
}
/**
*
* The mode of authentication for a server. The default value is SERVICE_MANAGED
, which allows you to
* store and access user credentials within the Transfer Family service.
*
* Use AWS_DIRECTORY_SERVICE
to provide access to Active Directory groups in Directory Service for
* Microsoft Active Directory or Microsoft Active Directory in your on-premises environment or in Amazon Web
* Services using AD Connector. This option also requires you to provide a Directory ID by using the
* IdentityProviderDetails
parameter.
*
* Use the API_GATEWAY
value to integrate with an identity provider of your choosing. The
* API_GATEWAY
setting requires you to provide an Amazon API Gateway endpoint URL to call for
* authentication by using the IdentityProviderDetails
parameter.
*
* Use the AWS_LAMBDA
value to directly use an Lambda function as your identity provider. If you choose
* this value, you must specify the ARN for the Lambda function in the Function
parameter for the
* IdentityProviderDetails
data type.
*
SERVICE_MANAGED
, which allows
* you to store and access user credentials within the Transfer Family service.
*
* Use AWS_DIRECTORY_SERVICE
to provide access to Active Directory groups in Directory Service
* for Microsoft Active Directory or Microsoft Active Directory in your on-premises environment or in Amazon
* Web Services using AD Connector. This option also requires you to provide a Directory ID by using the
* IdentityProviderDetails
parameter.
*
* Use the API_GATEWAY
value to integrate with an identity provider of your choosing. The
* API_GATEWAY
setting requires you to provide an Amazon API Gateway endpoint URL to call for
* authentication by using the IdentityProviderDetails
parameter.
*
* Use the AWS_LAMBDA
value to directly use an Lambda function as your identity provider. If you
* choose this value, you must specify the ARN for the Lambda function in the Function
parameter
* for the IdentityProviderDetails
data type.
* @return Returns a reference to this object so that method calls can be chained together.
* @see IdentityProviderType
*/
public DescribedServer withIdentityProviderType(IdentityProviderType identityProviderType) {
this.identityProviderType = identityProviderType.toString();
return this;
}
/**
*
* The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that allows a server to turn on * Amazon CloudWatch logging for Amazon S3 or Amazon EFSevents. When set, you can view user activity in your * CloudWatch logs. *
* * @param loggingRole * The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that allows a server to * turn on Amazon CloudWatch logging for Amazon S3 or Amazon EFSevents. When set, you can view user activity * in your CloudWatch logs. */ public void setLoggingRole(String loggingRole) { this.loggingRole = loggingRole; } /** ** The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that allows a server to turn on * Amazon CloudWatch logging for Amazon S3 or Amazon EFSevents. When set, you can view user activity in your * CloudWatch logs. *
* * @return The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that allows a server to * turn on Amazon CloudWatch logging for Amazon S3 or Amazon EFSevents. When set, you can view user activity * in your CloudWatch logs. */ public String getLoggingRole() { return this.loggingRole; } /** ** The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that allows a server to turn on * Amazon CloudWatch logging for Amazon S3 or Amazon EFSevents. When set, you can view user activity in your * CloudWatch logs. *
* * @param loggingRole * The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that allows a server to * turn on Amazon CloudWatch logging for Amazon S3 or Amazon EFSevents. When set, you can view user activity * in your CloudWatch logs. * @return Returns a reference to this object so that method calls can be chained together. */ public DescribedServer withLoggingRole(String loggingRole) { setLoggingRole(loggingRole); return this; } /** ** Specifies 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. *
** The SFTP protocol does not support post-authentication display banners. *
*/ public void setPostAuthenticationLoginBanner(String postAuthenticationLoginBanner) { this.postAuthenticationLoginBanner = postAuthenticationLoginBanner; } /** ** Specifies 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. *
** The SFTP protocol does not support post-authentication display banners. *
*/ public String getPostAuthenticationLoginBanner() { return this.postAuthenticationLoginBanner; } /** ** Specifies 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. *
** The SFTP protocol does not support post-authentication display banners. *
* @return Returns a reference to this object so that method calls can be chained together. */ public DescribedServer withPostAuthenticationLoginBanner(String postAuthenticationLoginBanner) { setPostAuthenticationLoginBanner(postAuthenticationLoginBanner); return this; } /** ** Specifies 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.
*
* 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.
*/
public void setPreAuthenticationLoginBanner(String preAuthenticationLoginBanner) {
this.preAuthenticationLoginBanner = preAuthenticationLoginBanner;
}
/**
*
* Specifies 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.
*
* 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.
*/
public String getPreAuthenticationLoginBanner() {
return this.preAuthenticationLoginBanner;
}
/**
*
* Specifies 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.
*
* 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribedServer withPreAuthenticationLoginBanner(String preAuthenticationLoginBanner) {
setPreAuthenticationLoginBanner(preAuthenticationLoginBanner);
return this;
}
/**
*
* 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: *
*
* SFTP
(Secure Shell (SSH) File Transfer Protocol): File transfer over SSH
*
* FTPS
(File Transfer Protocol Secure): File transfer with TLS encryption
*
* FTP
(File Transfer Protocol): Unencrypted file transfer
*
* AS2
(Applicability Statement 2): used for transporting structured business-to-business data
*
* If you select FTPS
, you must choose a certificate stored in Certificate Manager (ACM) which is 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 either
* AWS_DIRECTORY_SERVICE
, AWS_LAMBDA
, 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 any of the supported identity types:
* SERVICE_MANAGED
, AWS_DIRECTORY_SERVICE
, AWS_LAMBDA
, or
* API_GATEWAY
.
*
* If Protocol
includes AS2
, then the EndpointType
must be VPC
,
* and domain must be Amazon S3.
*
* SFTP
(Secure Shell (SSH) File Transfer Protocol): File transfer over SSH
*
* FTPS
(File Transfer Protocol Secure): File transfer with TLS encryption
*
* FTP
(File Transfer Protocol): Unencrypted file transfer
*
* AS2
(Applicability Statement 2): used for transporting structured business-to-business data
*
* If you select FTPS
, you must choose a certificate stored in Certificate Manager (ACM) which
* is 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
* either AWS_DIRECTORY_SERVICE
, AWS_LAMBDA
, 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 any of the supported identity
* types: SERVICE_MANAGED
, AWS_DIRECTORY_SERVICE
, AWS_LAMBDA
, or
* API_GATEWAY
.
*
* If Protocol
includes AS2
, then the EndpointType
must be
* VPC
, and domain must be Amazon S3.
*
* 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: *
*
* SFTP
(Secure Shell (SSH) File Transfer Protocol): File transfer over SSH
*
* FTPS
(File Transfer Protocol Secure): File transfer with TLS encryption
*
* FTP
(File Transfer Protocol): Unencrypted file transfer
*
* AS2
(Applicability Statement 2): used for transporting structured business-to-business data
*
* If you select FTPS
, you must choose a certificate stored in Certificate Manager (ACM) which is 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 either
* AWS_DIRECTORY_SERVICE
, AWS_LAMBDA
, 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 any of the supported identity types:
* SERVICE_MANAGED
, AWS_DIRECTORY_SERVICE
, AWS_LAMBDA
, or
* API_GATEWAY
.
*
* If Protocol
includes AS2
, then the EndpointType
must be VPC
,
* and domain must be Amazon S3.
*
* SFTP
(Secure Shell (SSH) File Transfer Protocol): File transfer over SSH
*
* FTPS
(File Transfer Protocol Secure): File transfer with TLS encryption
*
* FTP
(File Transfer Protocol): Unencrypted file transfer
*
* AS2
(Applicability Statement 2): used for transporting structured business-to-business data
*
* If you select FTPS
, you must choose a certificate stored in Certificate Manager (ACM) which
* is 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
* either AWS_DIRECTORY_SERVICE
, AWS_LAMBDA
, 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 any of the supported identity
* types: SERVICE_MANAGED
, AWS_DIRECTORY_SERVICE
, AWS_LAMBDA
, or
* API_GATEWAY
.
*
* If Protocol
includes AS2
, then the EndpointType
must be
* VPC
, and domain must be Amazon S3.
*
* 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: *
*
* SFTP
(Secure Shell (SSH) File Transfer Protocol): File transfer over SSH
*
* FTPS
(File Transfer Protocol Secure): File transfer with TLS encryption
*
* FTP
(File Transfer Protocol): Unencrypted file transfer
*
* AS2
(Applicability Statement 2): used for transporting structured business-to-business data
*
* If you select FTPS
, you must choose a certificate stored in Certificate Manager (ACM) which is 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 either
* AWS_DIRECTORY_SERVICE
, AWS_LAMBDA
, 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 any of the supported identity types:
* SERVICE_MANAGED
, AWS_DIRECTORY_SERVICE
, AWS_LAMBDA
, or
* API_GATEWAY
.
*
* If Protocol
includes AS2
, then the EndpointType
must be VPC
,
* and domain must be Amazon S3.
*
* NOTE: This method appends the values to the existing list (if any). Use * {@link #setProtocols(java.util.Collection)} or {@link #withProtocols(java.util.Collection)} if you want to * override the existing values. *
* * @param 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: *
* SFTP
(Secure Shell (SSH) File Transfer Protocol): File transfer over SSH
*
* FTPS
(File Transfer Protocol Secure): File transfer with TLS encryption
*
* FTP
(File Transfer Protocol): Unencrypted file transfer
*
* AS2
(Applicability Statement 2): used for transporting structured business-to-business data
*
* If you select FTPS
, you must choose a certificate stored in Certificate Manager (ACM) which
* is 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
* either AWS_DIRECTORY_SERVICE
, AWS_LAMBDA
, 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 any of the supported identity
* types: SERVICE_MANAGED
, AWS_DIRECTORY_SERVICE
, AWS_LAMBDA
, or
* API_GATEWAY
.
*
* If Protocol
includes AS2
, then the EndpointType
must be
* VPC
, and domain must be Amazon S3.
*
* 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: *
*
* SFTP
(Secure Shell (SSH) File Transfer Protocol): File transfer over SSH
*
* FTPS
(File Transfer Protocol Secure): File transfer with TLS encryption
*
* FTP
(File Transfer Protocol): Unencrypted file transfer
*
* AS2
(Applicability Statement 2): used for transporting structured business-to-business data
*
* If you select FTPS
, you must choose a certificate stored in Certificate Manager (ACM) which is 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 either
* AWS_DIRECTORY_SERVICE
, AWS_LAMBDA
, 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 any of the supported identity types:
* SERVICE_MANAGED
, AWS_DIRECTORY_SERVICE
, AWS_LAMBDA
, or
* API_GATEWAY
.
*
* If Protocol
includes AS2
, then the EndpointType
must be VPC
,
* and domain must be Amazon S3.
*
* SFTP
(Secure Shell (SSH) File Transfer Protocol): File transfer over SSH
*
* FTPS
(File Transfer Protocol Secure): File transfer with TLS encryption
*
* FTP
(File Transfer Protocol): Unencrypted file transfer
*
* AS2
(Applicability Statement 2): used for transporting structured business-to-business data
*
* If you select FTPS
, you must choose a certificate stored in Certificate Manager (ACM) which
* is 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
* either AWS_DIRECTORY_SERVICE
, AWS_LAMBDA
, 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 any of the supported identity
* types: SERVICE_MANAGED
, AWS_DIRECTORY_SERVICE
, AWS_LAMBDA
, or
* API_GATEWAY
.
*
* If Protocol
includes AS2
, then the EndpointType
must be
* VPC
, and domain must be Amazon S3.
*
* 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: *
*
* SFTP
(Secure Shell (SSH) File Transfer Protocol): File transfer over SSH
*
* FTPS
(File Transfer Protocol Secure): File transfer with TLS encryption
*
* FTP
(File Transfer Protocol): Unencrypted file transfer
*
* AS2
(Applicability Statement 2): used for transporting structured business-to-business data
*
* If you select FTPS
, you must choose a certificate stored in Certificate Manager (ACM) which is 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 either
* AWS_DIRECTORY_SERVICE
, AWS_LAMBDA
, 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 any of the supported identity types:
* SERVICE_MANAGED
, AWS_DIRECTORY_SERVICE
, AWS_LAMBDA
, or
* API_GATEWAY
.
*
* If Protocol
includes AS2
, then the EndpointType
must be VPC
,
* and domain must be Amazon S3.
*
* SFTP
(Secure Shell (SSH) File Transfer Protocol): File transfer over SSH
*
* FTPS
(File Transfer Protocol Secure): File transfer with TLS encryption
*
* FTP
(File Transfer Protocol): Unencrypted file transfer
*
* AS2
(Applicability Statement 2): used for transporting structured business-to-business data
*
* If you select FTPS
, you must choose a certificate stored in Certificate Manager (ACM) which
* is 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
* either AWS_DIRECTORY_SERVICE
, AWS_LAMBDA
, 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 any of the supported identity
* types: SERVICE_MANAGED
, AWS_DIRECTORY_SERVICE
, AWS_LAMBDA
, or
* API_GATEWAY
.
*
* If Protocol
includes AS2
, then the EndpointType
must be
* VPC
, and domain must be Amazon S3.
*
* Specifies the name of the security policy that is attached to the server. *
* * @param securityPolicyName * Specifies the name of the security policy that is attached to the server. */ public void setSecurityPolicyName(String securityPolicyName) { this.securityPolicyName = securityPolicyName; } /** ** Specifies the name of the security policy that is attached to the server. *
* * @return Specifies the name of the security policy that is attached to the server. */ public String getSecurityPolicyName() { return this.securityPolicyName; } /** ** Specifies the name of the security policy that is attached to the server. *
* * @param securityPolicyName * Specifies the name of the security policy that is attached to the server. * @return Returns a reference to this object so that method calls can be chained together. */ public DescribedServer withSecurityPolicyName(String securityPolicyName) { setSecurityPolicyName(securityPolicyName); return this; } /** ** Specifies the unique system-assigned identifier for a server that you instantiate. *
* * @param serverId * Specifies the unique system-assigned identifier for a server that you instantiate. */ public void setServerId(String serverId) { this.serverId = serverId; } /** ** Specifies the unique system-assigned identifier for a server that you instantiate. *
* * @return Specifies the unique system-assigned identifier for a server that you instantiate. */ public String getServerId() { return this.serverId; } /** ** Specifies the unique system-assigned identifier for a server that you instantiate. *
* * @param serverId * Specifies the unique system-assigned identifier for a server that you instantiate. * @return Returns a reference to this object so that method calls can be chained together. */ public DescribedServer withServerId(String serverId) { setServerId(serverId); return this; } /** *
* The condition of 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
indicate 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.
*
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
indicate 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.
* @see State
*/
public void setState(String state) {
this.state = state;
}
/**
*
* The condition of 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
indicate 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.
*
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
indicate 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.
* @see State
*/
public String getState() {
return this.state;
}
/**
*
* The condition of 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
indicate 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.
*
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
indicate 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.
* @return Returns a reference to this object so that method calls can be chained together.
* @see State
*/
public DescribedServer withState(String state) {
setState(state);
return this;
}
/**
*
* The condition of 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
indicate 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.
*
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
indicate 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.
* @return Returns a reference to this object so that method calls can be chained together.
* @see State
*/
public DescribedServer withState(State state) {
this.state = state.toString();
return this;
}
/**
*
* Specifies the key-value pairs that you can use to search for and group servers that were assigned to the server * that was described. *
* * @return Specifies the key-value pairs that you can use to search for and group servers that were assigned to the * server that was described. */ public java.util.List* Specifies the key-value pairs that you can use to search for and group servers that were assigned to the server * that was described. *
* * @param tags * Specifies the key-value pairs that you can use to search for and group servers that were assigned to the * server that was described. */ public void setTags(java.util.Collection* Specifies the key-value pairs that you can use to search for and group servers that were assigned to the server * that was described. *
** NOTE: This method appends the values to the existing list (if any). Use * {@link #setTags(java.util.Collection)} or {@link #withTags(java.util.Collection)} if you want to override the * existing values. *
* * @param tags * Specifies the key-value pairs that you can use to search for and group servers that were assigned to the * server that was described. * @return Returns a reference to this object so that method calls can be chained together. */ public DescribedServer withTags(Tag... tags) { if (this.tags == null) { setTags(new java.util.ArrayList* Specifies the key-value pairs that you can use to search for and group servers that were assigned to the server * that was described. *
* * @param tags * Specifies the key-value pairs that you can use to search for and group servers that were assigned to the * server that was described. * @return Returns a reference to this object so that method calls can be chained together. */ public DescribedServer withTags(java.util.Collection
* Specifies the number of users that are assigned to a server you specified with the ServerId
.
*
ServerId
.
*/
public void setUserCount(Integer userCount) {
this.userCount = userCount;
}
/**
*
* Specifies the number of users that are assigned to a server you specified with the ServerId
.
*
ServerId
.
*/
public Integer getUserCount() {
return this.userCount;
}
/**
*
* Specifies the number of users that are assigned to a server you specified with the ServerId
.
*
ServerId
.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribedServer withUserCount(Integer userCount) {
setUserCount(userCount);
return this;
}
/**
* * Specifies the workflow ID for the workflow to assign and the execution role that's used for executing the * workflow. *
*
* In addition to a workflow to execute when a file is uploaded completely, WorkflowDetails
can also
* contain a workflow ID (and execution role) for a workflow to execute on partial upload. A partial upload occurs
* when the server session disconnects while the file is still being uploaded.
*
* In addition to a workflow to execute when a file is uploaded completely, WorkflowDetails
can
* also contain a workflow ID (and execution role) for a workflow to execute on partial upload. A partial
* upload occurs when the server session disconnects while the file is still being uploaded.
*/
public void setWorkflowDetails(WorkflowDetails workflowDetails) {
this.workflowDetails = workflowDetails;
}
/**
*
* Specifies the workflow ID for the workflow to assign and the execution role that's used for executing the * workflow. *
*
* In addition to a workflow to execute when a file is uploaded completely, WorkflowDetails
can also
* contain a workflow ID (and execution role) for a workflow to execute on partial upload. A partial upload occurs
* when the server session disconnects while the file is still being uploaded.
*
* In addition to a workflow to execute when a file is uploaded completely, WorkflowDetails
can
* also contain a workflow ID (and execution role) for a workflow to execute on partial upload. A partial
* upload occurs when the server session disconnects while the file is still being uploaded.
*/
public WorkflowDetails getWorkflowDetails() {
return this.workflowDetails;
}
/**
*
* Specifies the workflow ID for the workflow to assign and the execution role that's used for executing the * workflow. *
*
* In addition to a workflow to execute when a file is uploaded completely, WorkflowDetails
can also
* contain a workflow ID (and execution role) for a workflow to execute on partial upload. A partial upload occurs
* when the server session disconnects while the file is still being uploaded.
*
* In addition to a workflow to execute when a file is uploaded completely, WorkflowDetails
can
* also contain a workflow ID (and execution role) for a workflow to execute on partial upload. A partial
* upload occurs when the server session disconnects while the file is still being uploaded.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribedServer withWorkflowDetails(WorkflowDetails workflowDetails) {
setWorkflowDetails(workflowDetails);
return this;
}
/**
*
* Specifies the log groups to which your server logs are sent. *
** To specify a log group, you must provide the ARN for an existing log group. In this case, the format of the log * group is as follows: *
*
* arn:aws:logs:region-name:amazon-account-id:log-group:log-group-name:*
*
* For example, arn:aws:logs:us-east-1:111122223333:log-group:mytestgroup:*
*
* If you have previously specified a log group for a server, you can clear it, and in effect turn off structured
* logging, by providing an empty value for this parameter in an update-server
call. For example:
*
* update-server --server-id s-1234567890abcdef0 --structured-log-destinations
*
* To specify a log group, you must provide the ARN for an existing log group. In this case, the format of * the log group is as follows: *
*
* arn:aws:logs:region-name:amazon-account-id:log-group:log-group-name:*
*
* For example, arn:aws:logs:us-east-1:111122223333:log-group:mytestgroup:*
*
* If you have previously specified a log group for a server, you can clear it, and in effect turn off
* structured logging, by providing an empty value for this parameter in an update-server
call.
* For example:
*
*
* Specifies the log groups to which your server logs are sent.
*
* To specify a log group, you must provide the ARN for an existing log group. In this case, the format of the log
* group is as follows:
*
*
* For example,
* If you have previously specified a log group for a server, you can clear it, and in effect turn off structured
* logging, by providing an empty value for this parameter in an
* update-server --server-id s-1234567890abcdef0 --structured-log-destinations
*/
public java.util.Listarn:aws:logs:region-name:amazon-account-id:log-group:log-group-name:*
* arn:aws:logs:us-east-1:111122223333:log-group:mytestgroup:*
* update-server
call. For example:
* update-server --server-id s-1234567890abcdef0 --structured-log-destinations
*
* To specify a log group, you must provide the ARN for an existing log group. In this case, the format of * the log group is as follows: *
*
* arn:aws:logs:region-name:amazon-account-id:log-group:log-group-name:*
*
* For example, arn:aws:logs:us-east-1:111122223333:log-group:mytestgroup:*
*
* If you have previously specified a log group for a server, you can clear it, and in effect turn off
* structured logging, by providing an empty value for this parameter in an update-server
call.
* For example:
*
*
* Specifies the log groups to which your server logs are sent.
*
* To specify a log group, you must provide the ARN for an existing log group. In this case, the format of the log
* group is as follows:
*
*
* For example,
* If you have previously specified a log group for a server, you can clear it, and in effect turn off structured
* logging, by providing an empty value for this parameter in an
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setStructuredLogDestinations(java.util.Collection)} or
* {@link #withStructuredLogDestinations(java.util.Collection)} if you want to override the existing values.
* update-server --server-id s-1234567890abcdef0 --structured-log-destinations
*/
public void setStructuredLogDestinations(java.util.Collectionarn:aws:logs:region-name:amazon-account-id:log-group:log-group-name:*
* arn:aws:logs:us-east-1:111122223333:log-group:mytestgroup:*
* update-server
call. For example:
* update-server --server-id s-1234567890abcdef0 --structured-log-destinations
*
* To specify a log group, you must provide the ARN for an existing log group. In this case, the format of * the log group is as follows: *
*
* arn:aws:logs:region-name:amazon-account-id:log-group:log-group-name:*
*
* For example, arn:aws:logs:us-east-1:111122223333:log-group:mytestgroup:*
*
* If you have previously specified a log group for a server, you can clear it, and in effect turn off
* structured logging, by providing an empty value for this parameter in an update-server
call.
* For example:
*
*
* Specifies the log groups to which your server logs are sent.
*
* To specify a log group, you must provide the ARN for an existing log group. In this case, the format of the log
* group is as follows:
*
*
* For example,
* If you have previously specified a log group for a server, you can clear it, and in effect turn off structured
* logging, by providing an empty value for this parameter in an
* update-server --server-id s-1234567890abcdef0 --structured-log-destinations
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribedServer withStructuredLogDestinations(String... structuredLogDestinations) {
if (this.structuredLogDestinations == null) {
setStructuredLogDestinations(new java.util.ArrayListarn:aws:logs:region-name:amazon-account-id:log-group:log-group-name:*
* arn:aws:logs:us-east-1:111122223333:log-group:mytestgroup:*
* update-server
call. For example:
* update-server --server-id s-1234567890abcdef0 --structured-log-destinations
*
* To specify a log group, you must provide the ARN for an existing log group. In this case, the format of * the log group is as follows: *
*
* arn:aws:logs:region-name:amazon-account-id:log-group:log-group-name:*
*
* For example, arn:aws:logs:us-east-1:111122223333:log-group:mytestgroup:*
*
* If you have previously specified a log group for a server, you can clear it, and in effect turn off
* structured logging, by providing an empty value for this parameter in an update-server
call.
* For example:
*
* update-server --server-id s-1234567890abcdef0 --structured-log-destinations
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribedServer withStructuredLogDestinations(java.util.Collection