@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class DescribedServer extends Object implements Serializable, Cloneable, StructuredPojo
Describes the properties of a file transfer protocol-enabled server that was specified.
Constructor and Description |
---|
DescribedServer() |
Modifier and Type | Method and Description |
---|---|
DescribedServer |
clone() |
boolean |
equals(Object obj) |
String |
getArn()
Specifies the unique Amazon Resource Name (ARN) of the server.
|
List<String> |
getAs2ServiceManagedEgressIpAddresses()
The list of egress IP addresses of this server.
|
String |
getCertificate()
Specifies the ARN of the Amazon Web ServicesCertificate Manager (ACM) certificate.
|
String |
getDomain()
Specifies the domain of the storage system that is used for file transfers.
|
EndpointDetails |
getEndpointDetails()
The virtual private cloud (VPC) endpoint settings that are configured for your server.
|
String |
getEndpointType()
Defines the type of endpoint that your server is connected to.
|
String |
getHostKeyFingerprint()
Specifies the Base64-encoded SHA256 fingerprint of the server's host key.
|
IdentityProviderDetails |
getIdentityProviderDetails()
Specifies information to call a customer-supplied authentication API.
|
String |
getIdentityProviderType()
The mode of authentication for a server.
|
String |
getLoggingRole()
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.
|
String |
getPostAuthenticationLoginBanner()
Specifies a string to display when users connect to a server.
|
String |
getPreAuthenticationLoginBanner()
Specifies a string to display when users connect to a server.
|
ProtocolDetails |
getProtocolDetails()
The protocol settings that are configured for your server.
|
List<String> |
getProtocols()
Specifies the file transfer protocol or protocols over which your file transfer protocol client can connect to
your server's endpoint.
|
S3StorageOptions |
getS3StorageOptions()
Specifies whether or not performance for your Amazon S3 directories is optimized.
|
String |
getSecurityPolicyName()
Specifies the name of the security policy for the server.
|
String |
getServerId()
Specifies the unique system-assigned identifier for a server that you instantiate.
|
String |
getState()
The condition of the server that was described.
|
List<String> |
getStructuredLogDestinations()
Specifies the log groups to which your server logs are sent.
|
List<Tag> |
getTags()
Specifies the key-value pairs that you can use to search for and group servers that were assigned to the server
that was described.
|
Integer |
getUserCount()
Specifies the number of users that are assigned to a server you specified with the
ServerId . |
WorkflowDetails |
getWorkflowDetails()
Specifies the workflow ID for the workflow to assign and the execution role that's used for executing the
workflow.
|
int |
hashCode() |
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
void |
setArn(String arn)
Specifies the unique Amazon Resource Name (ARN) of the server.
|
void |
setAs2ServiceManagedEgressIpAddresses(Collection<String> as2ServiceManagedEgressIpAddresses)
The list of egress IP addresses of this server.
|
void |
setCertificate(String certificate)
Specifies the ARN of the Amazon Web ServicesCertificate Manager (ACM) certificate.
|
void |
setDomain(String domain)
Specifies the domain of the storage system that is used for file transfers.
|
void |
setEndpointDetails(EndpointDetails endpointDetails)
The virtual private cloud (VPC) endpoint settings that are configured for your server.
|
void |
setEndpointType(String endpointType)
Defines the type of endpoint that your server is connected to.
|
void |
setHostKeyFingerprint(String hostKeyFingerprint)
Specifies the Base64-encoded SHA256 fingerprint of the server's host key.
|
void |
setIdentityProviderDetails(IdentityProviderDetails identityProviderDetails)
Specifies information to call a customer-supplied authentication API.
|
void |
setIdentityProviderType(String identityProviderType)
The mode of authentication for a server.
|
void |
setLoggingRole(String 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.
|
void |
setPostAuthenticationLoginBanner(String postAuthenticationLoginBanner)
Specifies a string to display when users connect to a server.
|
void |
setPreAuthenticationLoginBanner(String preAuthenticationLoginBanner)
Specifies a string to display when users connect to a server.
|
void |
setProtocolDetails(ProtocolDetails protocolDetails)
The protocol settings that are configured for your server.
|
void |
setProtocols(Collection<String> protocols)
Specifies the file transfer protocol or protocols over which your file transfer protocol client can connect to
your server's endpoint.
|
void |
setS3StorageOptions(S3StorageOptions s3StorageOptions)
Specifies whether or not performance for your Amazon S3 directories is optimized.
|
void |
setSecurityPolicyName(String securityPolicyName)
Specifies the name of the security policy for the server.
|
void |
setServerId(String serverId)
Specifies the unique system-assigned identifier for a server that you instantiate.
|
void |
setState(String state)
The condition of the server that was described.
|
void |
setStructuredLogDestinations(Collection<String> structuredLogDestinations)
Specifies the log groups to which your server logs are sent.
|
void |
setTags(Collection<Tag> 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.
|
void |
setUserCount(Integer userCount)
Specifies the number of users that are assigned to a server you specified with the
ServerId . |
void |
setWorkflowDetails(WorkflowDetails workflowDetails)
Specifies the workflow ID for the workflow to assign and the execution role that's used for executing the
workflow.
|
String |
toString()
Returns a string representation of this object.
|
DescribedServer |
withArn(String arn)
Specifies the unique Amazon Resource Name (ARN) of the server.
|
DescribedServer |
withAs2ServiceManagedEgressIpAddresses(Collection<String> as2ServiceManagedEgressIpAddresses)
The list of egress IP addresses of this server.
|
DescribedServer |
withAs2ServiceManagedEgressIpAddresses(String... as2ServiceManagedEgressIpAddresses)
The list of egress IP addresses of this server.
|
DescribedServer |
withCertificate(String certificate)
Specifies the ARN of the Amazon Web ServicesCertificate Manager (ACM) certificate.
|
DescribedServer |
withDomain(Domain domain)
Specifies the domain of the storage system that is used for file transfers.
|
DescribedServer |
withDomain(String domain)
Specifies the domain of the storage system that is used for file transfers.
|
DescribedServer |
withEndpointDetails(EndpointDetails endpointDetails)
The virtual private cloud (VPC) endpoint settings that are configured for your server.
|
DescribedServer |
withEndpointType(EndpointType endpointType)
Defines the type of endpoint that your server is connected to.
|
DescribedServer |
withEndpointType(String endpointType)
Defines the type of endpoint that your server is connected to.
|
DescribedServer |
withHostKeyFingerprint(String hostKeyFingerprint)
Specifies the Base64-encoded SHA256 fingerprint of the server's host key.
|
DescribedServer |
withIdentityProviderDetails(IdentityProviderDetails identityProviderDetails)
Specifies information to call a customer-supplied authentication API.
|
DescribedServer |
withIdentityProviderType(IdentityProviderType identityProviderType)
The mode of authentication for a server.
|
DescribedServer |
withIdentityProviderType(String identityProviderType)
The mode of authentication for a server.
|
DescribedServer |
withLoggingRole(String 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.
|
DescribedServer |
withPostAuthenticationLoginBanner(String postAuthenticationLoginBanner)
Specifies a string to display when users connect to a server.
|
DescribedServer |
withPreAuthenticationLoginBanner(String preAuthenticationLoginBanner)
Specifies a string to display when users connect to a server.
|
DescribedServer |
withProtocolDetails(ProtocolDetails protocolDetails)
The protocol settings that are configured for your server.
|
DescribedServer |
withProtocols(Collection<String> protocols)
Specifies the file transfer protocol or protocols over which your file transfer protocol client can connect to
your server's endpoint.
|
DescribedServer |
withProtocols(Protocol... protocols)
Specifies the file transfer protocol or protocols over which your file transfer protocol client can connect to
your server's endpoint.
|
DescribedServer |
withProtocols(String... protocols)
Specifies the file transfer protocol or protocols over which your file transfer protocol client can connect to
your server's endpoint.
|
DescribedServer |
withS3StorageOptions(S3StorageOptions s3StorageOptions)
Specifies whether or not performance for your Amazon S3 directories is optimized.
|
DescribedServer |
withSecurityPolicyName(String securityPolicyName)
Specifies the name of the security policy for the server.
|
DescribedServer |
withServerId(String serverId)
Specifies the unique system-assigned identifier for a server that you instantiate.
|
DescribedServer |
withState(State state)
The condition of the server that was described.
|
DescribedServer |
withState(String state)
The condition of the server that was described.
|
DescribedServer |
withStructuredLogDestinations(Collection<String> structuredLogDestinations)
Specifies the log groups to which your server logs are sent.
|
DescribedServer |
withStructuredLogDestinations(String... structuredLogDestinations)
Specifies the log groups to which your server logs are sent.
|
DescribedServer |
withTags(Collection<Tag> 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.
|
DescribedServer |
withTags(Tag... 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.
|
DescribedServer |
withUserCount(Integer userCount)
Specifies the number of users that are assigned to a server you specified with the
ServerId . |
DescribedServer |
withWorkflowDetails(WorkflowDetails workflowDetails)
Specifies the workflow ID for the workflow to assign and the execution role that's used for executing the
workflow.
|
public void setArn(String arn)
Specifies the unique Amazon Resource Name (ARN) of the server.
arn
- Specifies the unique Amazon Resource Name (ARN) of the server.public String getArn()
Specifies the unique Amazon Resource Name (ARN) of the server.
public DescribedServer withArn(String arn)
Specifies the unique Amazon Resource Name (ARN) of the server.
arn
- Specifies the unique Amazon Resource Name (ARN) of the server.public void setCertificate(String certificate)
Specifies the ARN of the Amazon Web ServicesCertificate Manager (ACM) certificate. Required when
Protocols
is set to FTPS
.
certificate
- Specifies the ARN of the Amazon Web ServicesCertificate Manager (ACM) certificate. Required when
Protocols
is set to FTPS
.public String getCertificate()
Specifies the ARN of the Amazon Web ServicesCertificate Manager (ACM) certificate. Required when
Protocols
is set to FTPS
.
Protocols
is set to FTPS
.public DescribedServer withCertificate(String certificate)
Specifies the ARN of the Amazon Web ServicesCertificate Manager (ACM) certificate. Required when
Protocols
is set to FTPS
.
certificate
- Specifies the ARN of the Amazon Web ServicesCertificate Manager (ACM) certificate. Required when
Protocols
is set to FTPS
.public void setProtocolDetails(ProtocolDetails protocolDetails)
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.
protocolDetails
- 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.
public ProtocolDetails getProtocolDetails()
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.
public DescribedServer withProtocolDetails(ProtocolDetails protocolDetails)
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.
protocolDetails
- 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.
public void setDomain(String domain)
Specifies the domain of the storage system that is used for file transfers. There are two domains available: Amazon Simple Storage Service (Amazon S3) and Amazon Elastic File System (Amazon EFS). The default value is S3.
domain
- Specifies the domain of the storage system that is used for file transfers. There are two domains
available: Amazon Simple Storage Service (Amazon S3) and Amazon Elastic File System (Amazon EFS). The
default value is S3.Domain
public String getDomain()
Specifies the domain of the storage system that is used for file transfers. There are two domains available: Amazon Simple Storage Service (Amazon S3) and Amazon Elastic File System (Amazon EFS). The default value is S3.
Domain
public DescribedServer withDomain(String domain)
Specifies the domain of the storage system that is used for file transfers. There are two domains available: Amazon Simple Storage Service (Amazon S3) and Amazon Elastic File System (Amazon EFS). The default value is S3.
domain
- Specifies the domain of the storage system that is used for file transfers. There are two domains
available: Amazon Simple Storage Service (Amazon S3) and Amazon Elastic File System (Amazon EFS). The
default value is S3.Domain
public DescribedServer withDomain(Domain domain)
Specifies the domain of the storage system that is used for file transfers. There are two domains available: Amazon Simple Storage Service (Amazon S3) and Amazon Elastic File System (Amazon EFS). The default value is S3.
domain
- Specifies the domain of the storage system that is used for file transfers. There are two domains
available: Amazon Simple Storage Service (Amazon S3) and Amazon Elastic File System (Amazon EFS). The
default value is S3.Domain
public void setEndpointDetails(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.
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 EndpointDetails getEndpointDetails()
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 DescribedServer withEndpointDetails(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.
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 setEndpointType(String 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.
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.EndpointType
public String getEndpointType()
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.
EndpointType
public DescribedServer withEndpointType(String 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.
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.EndpointType
public DescribedServer withEndpointType(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.
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.EndpointType
public void setHostKeyFingerprint(String 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.
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.public String getHostKeyFingerprint()
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 DescribedServer withHostKeyFingerprint(String 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.
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.public void setIdentityProviderDetails(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
.
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
.public IdentityProviderDetails getIdentityProviderDetails()
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 DescribedServer withIdentityProviderDetails(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
.
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
.public void setIdentityProviderType(String 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.
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.
IdentityProviderType
public String getIdentityProviderType()
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.
IdentityProviderType
public DescribedServer withIdentityProviderType(String 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.
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.
IdentityProviderType
public DescribedServer withIdentityProviderType(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.
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.
IdentityProviderType
public void setLoggingRole(String 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.
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 String getLoggingRole()
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 DescribedServer withLoggingRole(String 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.
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 setPostAuthenticationLoginBanner(String 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.
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.
public String getPostAuthenticationLoginBanner()
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 DescribedServer withPostAuthenticationLoginBanner(String 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.
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.
public void setPreAuthenticationLoginBanner(String 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.
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.
public String getPreAuthenticationLoginBanner()
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 DescribedServer withPreAuthenticationLoginBanner(String 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.
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.
public List<String> getProtocols()
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.
Protocol
public void setProtocols(Collection<String> protocols)
Specifies the file transfer protocol or protocols over which your file transfer protocol client can connect to your server's endpoint. The available protocols are:
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.
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.
Protocol
public DescribedServer withProtocols(String... protocols)
Specifies the file transfer protocol or protocols over which your file transfer protocol client can connect to your server's endpoint. The available protocols are:
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
setProtocols(java.util.Collection)
or withProtocols(java.util.Collection)
if you want to
override the existing values.
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.
Protocol
public DescribedServer withProtocols(Collection<String> protocols)
Specifies the file transfer protocol or protocols over which your file transfer protocol client can connect to your server's endpoint. The available protocols are:
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.
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.
Protocol
public DescribedServer withProtocols(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:
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.
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.
Protocol
public void setSecurityPolicyName(String securityPolicyName)
Specifies the name of the security policy for the server.
securityPolicyName
- Specifies the name of the security policy for the server.public String getSecurityPolicyName()
Specifies the name of the security policy for the server.
public DescribedServer withSecurityPolicyName(String securityPolicyName)
Specifies the name of the security policy for the server.
securityPolicyName
- Specifies the name of the security policy for the server.public void setServerId(String serverId)
Specifies the unique system-assigned identifier for a server that you instantiate.
serverId
- Specifies the unique system-assigned identifier for a server that you instantiate.public String getServerId()
Specifies the unique system-assigned identifier for a server that you instantiate.
public DescribedServer withServerId(String serverId)
Specifies the unique system-assigned identifier for a server that you instantiate.
serverId
- Specifies the unique system-assigned identifier for a server that you instantiate.public void setState(String 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.
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.
State
public String getState()
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.
State
public DescribedServer withState(String 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.
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.
State
public DescribedServer withState(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.
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.
State
public List<Tag> getTags()
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(Collection<Tag> 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.
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 DescribedServer withTags(Tag... 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.
NOTE: This method appends the values to the existing list (if any). Use
setTags(java.util.Collection)
or withTags(java.util.Collection)
if you want to override the
existing values.
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 DescribedServer withTags(Collection<Tag> 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.
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 setUserCount(Integer userCount)
Specifies the number of users that are assigned to a server you specified with the ServerId
.
userCount
- Specifies the number of users that are assigned to a server you specified with the ServerId
.public Integer getUserCount()
Specifies the number of users that are assigned to a server you specified with the ServerId
.
ServerId
.public DescribedServer withUserCount(Integer userCount)
Specifies the number of users that are assigned to a server you specified with the ServerId
.
userCount
- Specifies the number of users that are assigned to a server you specified with the ServerId
.public void setWorkflowDetails(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.
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.
public WorkflowDetails getWorkflowDetails()
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 DescribedServer withWorkflowDetails(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.
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.
public List<String> getStructuredLogDestinations()
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:
update-server --server-id s-1234567890abcdef0 --structured-log-destinations
public void setStructuredLogDestinations(Collection<String> structuredLogDestinations)
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
structuredLogDestinations
- 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
public DescribedServer withStructuredLogDestinations(String... structuredLogDestinations)
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
NOTE: This method appends the values to the existing list (if any). Use
setStructuredLogDestinations(java.util.Collection)
or
withStructuredLogDestinations(java.util.Collection)
if you want to override the existing values.
structuredLogDestinations
- 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
public DescribedServer withStructuredLogDestinations(Collection<String> structuredLogDestinations)
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
structuredLogDestinations
- 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
public void setS3StorageOptions(S3StorageOptions s3StorageOptions)
Specifies whether or not performance for your Amazon S3 directories is optimized. This is disabled by default.
By default, home directory mappings have a TYPE
of DIRECTORY
. If you enable this
option, you would then need to explicitly set the HomeDirectoryMapEntry
Type
to
FILE
if you want a mapping to have a file target.
s3StorageOptions
- Specifies whether or not performance for your Amazon S3 directories is optimized. This is disabled by
default.
By default, home directory mappings have a TYPE
of DIRECTORY
. If you enable this
option, you would then need to explicitly set the HomeDirectoryMapEntry
Type
to
FILE
if you want a mapping to have a file target.
public S3StorageOptions getS3StorageOptions()
Specifies whether or not performance for your Amazon S3 directories is optimized. This is disabled by default.
By default, home directory mappings have a TYPE
of DIRECTORY
. If you enable this
option, you would then need to explicitly set the HomeDirectoryMapEntry
Type
to
FILE
if you want a mapping to have a file target.
By default, home directory mappings have a TYPE
of DIRECTORY
. If you enable
this option, you would then need to explicitly set the HomeDirectoryMapEntry
Type
to FILE
if you want a mapping to have a file target.
public DescribedServer withS3StorageOptions(S3StorageOptions s3StorageOptions)
Specifies whether or not performance for your Amazon S3 directories is optimized. This is disabled by default.
By default, home directory mappings have a TYPE
of DIRECTORY
. If you enable this
option, you would then need to explicitly set the HomeDirectoryMapEntry
Type
to
FILE
if you want a mapping to have a file target.
s3StorageOptions
- Specifies whether or not performance for your Amazon S3 directories is optimized. This is disabled by
default.
By default, home directory mappings have a TYPE
of DIRECTORY
. If you enable this
option, you would then need to explicitly set the HomeDirectoryMapEntry
Type
to
FILE
if you want a mapping to have a file target.
public List<String> getAs2ServiceManagedEgressIpAddresses()
The list of egress IP addresses of this server. These IP addresses are only relevant for servers that use the AS2 protocol. They are used for sending asynchronous MDNs.
These IP addresses are assigned automatically when you create an AS2 server. Additionally, if you update an existing server and add the AS2 protocol, static IP addresses are assigned as well.
These IP addresses are assigned automatically when you create an AS2 server. Additionally, if you update an existing server and add the AS2 protocol, static IP addresses are assigned as well.
public void setAs2ServiceManagedEgressIpAddresses(Collection<String> as2ServiceManagedEgressIpAddresses)
The list of egress IP addresses of this server. These IP addresses are only relevant for servers that use the AS2 protocol. They are used for sending asynchronous MDNs.
These IP addresses are assigned automatically when you create an AS2 server. Additionally, if you update an existing server and add the AS2 protocol, static IP addresses are assigned as well.
as2ServiceManagedEgressIpAddresses
- The list of egress IP addresses of this server. These IP addresses are only relevant for servers that use
the AS2 protocol. They are used for sending asynchronous MDNs.
These IP addresses are assigned automatically when you create an AS2 server. Additionally, if you update an existing server and add the AS2 protocol, static IP addresses are assigned as well.
public DescribedServer withAs2ServiceManagedEgressIpAddresses(String... as2ServiceManagedEgressIpAddresses)
The list of egress IP addresses of this server. These IP addresses are only relevant for servers that use the AS2 protocol. They are used for sending asynchronous MDNs.
These IP addresses are assigned automatically when you create an AS2 server. Additionally, if you update an existing server and add the AS2 protocol, static IP addresses are assigned as well.
NOTE: This method appends the values to the existing list (if any). Use
setAs2ServiceManagedEgressIpAddresses(java.util.Collection)
or
withAs2ServiceManagedEgressIpAddresses(java.util.Collection)
if you want to override the existing
values.
as2ServiceManagedEgressIpAddresses
- The list of egress IP addresses of this server. These IP addresses are only relevant for servers that use
the AS2 protocol. They are used for sending asynchronous MDNs.
These IP addresses are assigned automatically when you create an AS2 server. Additionally, if you update an existing server and add the AS2 protocol, static IP addresses are assigned as well.
public DescribedServer withAs2ServiceManagedEgressIpAddresses(Collection<String> as2ServiceManagedEgressIpAddresses)
The list of egress IP addresses of this server. These IP addresses are only relevant for servers that use the AS2 protocol. They are used for sending asynchronous MDNs.
These IP addresses are assigned automatically when you create an AS2 server. Additionally, if you update an existing server and add the AS2 protocol, static IP addresses are assigned as well.
as2ServiceManagedEgressIpAddresses
- The list of egress IP addresses of this server. These IP addresses are only relevant for servers that use
the AS2 protocol. They are used for sending asynchronous MDNs.
These IP addresses are assigned automatically when you create an AS2 server. Additionally, if you update an existing server and add the AS2 protocol, static IP addresses are assigned as well.
public String toString()
toString
in class Object
Object.toString()
public DescribedServer clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.