Class DescribedServer
- java.lang.Object
-
- software.amazon.awssdk.services.transfer.model.DescribedServer
-
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<DescribedServer.Builder,DescribedServer>
@Generated("software.amazon.awssdk:codegen") public final class DescribedServer extends Object implements SdkPojo, Serializable, ToCopyableBuilder<DescribedServer.Builder,DescribedServer>
Describes the properties of a file transfer protocol-enabled server that was specified.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceDescribedServer.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description Stringarn()Specifies the unique Amazon Resource Name (ARN) of the server.List<String>as2ServiceManagedEgressIpAddresses()The list of egress IP addresses of this server.static DescribedServer.Builderbuilder()Stringcertificate()Specifies the ARN of the Amazon Web ServicesCertificate Manager (ACM) certificate.Domaindomain()Specifies the domain of the storage system that is used for file transfers.StringdomainAsString()Specifies the domain of the storage system that is used for file transfers.EndpointDetailsendpointDetails()The virtual private cloud (VPC) endpoint settings that are configured for your server.EndpointTypeendpointType()Defines the type of endpoint that your server is connected to.StringendpointTypeAsString()Defines the type of endpoint that your server is connected to.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)booleanhasAs2ServiceManagedEgressIpAddresses()For responses, this returns true if the service returned a value for the As2ServiceManagedEgressIpAddresses property.inthashCode()booleanhasProtocols()For responses, this returns true if the service returned a value for the Protocols property.booleanhasStructuredLogDestinations()For responses, this returns true if the service returned a value for the StructuredLogDestinations property.booleanhasTags()For responses, this returns true if the service returned a value for the Tags property.StringhostKeyFingerprint()Specifies the Base64-encoded SHA256 fingerprint of the server's host key.IdentityProviderDetailsidentityProviderDetails()Specifies information to call a customer-supplied authentication API.IdentityProviderTypeidentityProviderType()The mode of authentication for a server.StringidentityProviderTypeAsString()The mode of authentication for a server.StringloggingRole()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.StringpostAuthenticationLoginBanner()Specifies a string to display when users connect to a server.StringpreAuthenticationLoginBanner()Specifies a string to display when users connect to a server.ProtocolDetailsprotocolDetails()The protocol settings that are configured for your server.List<Protocol>protocols()Specifies the file transfer protocol or protocols over which your file transfer protocol client can connect to your server's endpoint.List<String>protocolsAsStrings()Specifies the file transfer protocol or protocols over which your file transfer protocol client can connect to your server's endpoint.S3StorageOptionss3StorageOptions()Specifies whether or not performance for your Amazon S3 directories is optimized.Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()StringsecurityPolicyName()Specifies the name of the security policy for the server.static Class<? extends DescribedServer.Builder>serializableBuilderClass()StringserverId()Specifies the unique system-assigned identifier for a server that you instantiate.Statestate()The condition of the server that was described.StringstateAsString()The condition of the server that was described.List<String>structuredLogDestinations()Specifies the log groups to which your server logs are sent.List<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.BuildertoBuilder()StringtoString()Returns a string representation of this object.IntegeruserCount()Specifies the number of users that are assigned to a server you specified with theServerId.WorkflowDetailsworkflowDetails()Specifies the workflow ID for the workflow to assign and the execution role that's used for executing the workflow.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
arn
public final String arn()
Specifies the unique Amazon Resource Name (ARN) of the server.
- Returns:
- Specifies the unique Amazon Resource Name (ARN) of the server.
-
certificate
public final String certificate()
Specifies the ARN of the Amazon Web ServicesCertificate Manager (ACM) certificate. Required when
Protocolsis set toFTPS.- Returns:
- Specifies the ARN of the Amazon Web ServicesCertificate Manager (ACM) certificate. Required when
Protocolsis set toFTPS.
-
protocolDetails
public final ProtocolDetails protocolDetails()
The protocol settings that are configured for your server.
-
To indicate passive mode (for FTP and FTPS protocols), use the
PassiveIpparameter. 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
SETSTATcommand on a file that you are uploading to an Amazon S3 bucket, use theSetStatOptionparameter. To have the Transfer Family server ignore theSETSTATcommand and upload files without needing to make any changes to your SFTP client, set the value toENABLE_NO_OP. If you set theSetStatOptionparameter toENABLE_NO_OP, Transfer Family generates a log entry to Amazon CloudWatch Logs, so that you can determine when the client is making aSETSTATcall. -
To determine whether your Transfer Family server resumes recent, negotiated sessions through a unique session ID, use the
TlsSessionResumptionModeparameter. -
As2Transportsindicates the transport method for the AS2 messages. Currently, only HTTP is supported.
- Returns:
- The protocol settings that are configured for your server.
-
To indicate passive mode (for FTP and FTPS protocols), use the
PassiveIpparameter. 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
SETSTATcommand on a file that you are uploading to an Amazon S3 bucket, use theSetStatOptionparameter. To have the Transfer Family server ignore theSETSTATcommand and upload files without needing to make any changes to your SFTP client, set the value toENABLE_NO_OP. If you set theSetStatOptionparameter toENABLE_NO_OP, Transfer Family generates a log entry to Amazon CloudWatch Logs, so that you can determine when the client is making aSETSTATcall. -
To determine whether your Transfer Family server resumes recent, negotiated sessions through a unique session ID, use the
TlsSessionResumptionModeparameter. -
As2Transportsindicates the transport method for the AS2 messages. Currently, only HTTP is supported.
-
-
-
domain
public final 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.
If the service returns an enum value that is not available in the current SDK version,
domainwill returnDomain.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromdomainAsString().- Returns:
- 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.
- See Also:
Domain
-
domainAsString
public final String domainAsString()
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.
If the service returns an enum value that is not available in the current SDK version,
domainwill returnDomain.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromdomainAsString().- Returns:
- 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.
- See Also:
Domain
-
endpointDetails
public final EndpointDetails endpointDetails()
The virtual private cloud (VPC) endpoint settings that are configured for your server. When you host your endpoint within your VPC, you can make 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.
- Returns:
- The virtual private cloud (VPC) endpoint settings that are configured for your server. When you host your endpoint within your VPC, you can make 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.
-
endpointType
public final 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.
If the service returns an enum value that is not available in the current SDK version,
endpointTypewill returnEndpointType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromendpointTypeAsString().- Returns:
- 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 Also:
EndpointType
-
endpointTypeAsString
public final String endpointTypeAsString()
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.
If the service returns an enum value that is not available in the current SDK version,
endpointTypewill returnEndpointType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromendpointTypeAsString().- Returns:
- 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 Also:
EndpointType
-
hostKeyFingerprint
public final 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-keycommand.- Returns:
- 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-keycommand.
-
identityProviderDetails
public final IdentityProviderDetails identityProviderDetails()
Specifies information to call a customer-supplied authentication API. This field is not populated when the
IdentityProviderTypeof a server isAWS_DIRECTORY_SERVICEorSERVICE_MANAGED.- Returns:
- Specifies information to call a customer-supplied authentication API. This field is not populated when
the
IdentityProviderTypeof a server isAWS_DIRECTORY_SERVICEorSERVICE_MANAGED.
-
identityProviderType
public final 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_SERVICEto 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 theIdentityProviderDetailsparameter.Use the
API_GATEWAYvalue to integrate with an identity provider of your choosing. TheAPI_GATEWAYsetting requires you to provide an Amazon API Gateway endpoint URL to call for authentication by using theIdentityProviderDetailsparameter.Use the
AWS_LAMBDAvalue 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 theFunctionparameter for theIdentityProviderDetailsdata type.If the service returns an enum value that is not available in the current SDK version,
identityProviderTypewill returnIdentityProviderType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromidentityProviderTypeAsString().- Returns:
- 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_SERVICEto 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 theIdentityProviderDetailsparameter.Use the
API_GATEWAYvalue to integrate with an identity provider of your choosing. TheAPI_GATEWAYsetting requires you to provide an Amazon API Gateway endpoint URL to call for authentication by using theIdentityProviderDetailsparameter.Use the
AWS_LAMBDAvalue 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 theFunctionparameter for theIdentityProviderDetailsdata type. - See Also:
IdentityProviderType
-
identityProviderTypeAsString
public final String identityProviderTypeAsString()
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_SERVICEto 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 theIdentityProviderDetailsparameter.Use the
API_GATEWAYvalue to integrate with an identity provider of your choosing. TheAPI_GATEWAYsetting requires you to provide an Amazon API Gateway endpoint URL to call for authentication by using theIdentityProviderDetailsparameter.Use the
AWS_LAMBDAvalue 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 theFunctionparameter for theIdentityProviderDetailsdata type.If the service returns an enum value that is not available in the current SDK version,
identityProviderTypewill returnIdentityProviderType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromidentityProviderTypeAsString().- Returns:
- 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_SERVICEto 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 theIdentityProviderDetailsparameter.Use the
API_GATEWAYvalue to integrate with an identity provider of your choosing. TheAPI_GATEWAYsetting requires you to provide an Amazon API Gateway endpoint URL to call for authentication by using theIdentityProviderDetailsparameter.Use the
AWS_LAMBDAvalue 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 theFunctionparameter for theIdentityProviderDetailsdata type. - See Also:
IdentityProviderType
-
loggingRole
public final 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.
- Returns:
- 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.
-
postAuthenticationLoginBanner
public final 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.
- Returns:
- 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.
-
preAuthenticationLoginBanner
public final 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.- Returns:
- 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.
-
protocols
public final List<Protocol> protocols()
Specifies the file transfer protocol or protocols over which your file transfer protocol client can connect to your server's endpoint. The available protocols are:
-
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
Protocolincludes eitherFTPorFTPS, then theEndpointTypemust beVPCand theIdentityProviderTypemust be eitherAWS_DIRECTORY_SERVICE,AWS_LAMBDA, orAPI_GATEWAY. -
If
ProtocolincludesFTP, thenAddressAllocationIdscannot be associated. -
If
Protocolis set only toSFTP, theEndpointTypecan be set toPUBLICand theIdentityProviderTypecan be set any of the supported identity types:SERVICE_MANAGED,AWS_DIRECTORY_SERVICE,AWS_LAMBDA, orAPI_GATEWAY. -
If
ProtocolincludesAS2, then theEndpointTypemust beVPC, and domain must be Amazon S3.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasProtocols()method.- Returns:
- Specifies the file transfer protocol or protocols over which your file transfer protocol client can
connect to your server's endpoint. The available protocols are:
-
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
Protocolincludes eitherFTPorFTPS, then theEndpointTypemust beVPCand theIdentityProviderTypemust be eitherAWS_DIRECTORY_SERVICE,AWS_LAMBDA, orAPI_GATEWAY. -
If
ProtocolincludesFTP, thenAddressAllocationIdscannot be associated. -
If
Protocolis set only toSFTP, theEndpointTypecan be set toPUBLICand theIdentityProviderTypecan be set any of the supported identity types:SERVICE_MANAGED,AWS_DIRECTORY_SERVICE,AWS_LAMBDA, orAPI_GATEWAY. -
If
ProtocolincludesAS2, then theEndpointTypemust beVPC, and domain must be Amazon S3.
-
-
-
hasProtocols
public final boolean hasProtocols()
For responses, this returns true if the service returned a value for the Protocols property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
-
protocolsAsStrings
public final List<String> protocolsAsStrings()
Specifies the file transfer protocol or protocols over which your file transfer protocol client can connect to your server's endpoint. The available protocols are:
-
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
Protocolincludes eitherFTPorFTPS, then theEndpointTypemust beVPCand theIdentityProviderTypemust be eitherAWS_DIRECTORY_SERVICE,AWS_LAMBDA, orAPI_GATEWAY. -
If
ProtocolincludesFTP, thenAddressAllocationIdscannot be associated. -
If
Protocolis set only toSFTP, theEndpointTypecan be set toPUBLICand theIdentityProviderTypecan be set any of the supported identity types:SERVICE_MANAGED,AWS_DIRECTORY_SERVICE,AWS_LAMBDA, orAPI_GATEWAY. -
If
ProtocolincludesAS2, then theEndpointTypemust beVPC, and domain must be Amazon S3.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasProtocols()method.- Returns:
- Specifies the file transfer protocol or protocols over which your file transfer protocol client can
connect to your server's endpoint. The available protocols are:
-
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
Protocolincludes eitherFTPorFTPS, then theEndpointTypemust beVPCand theIdentityProviderTypemust be eitherAWS_DIRECTORY_SERVICE,AWS_LAMBDA, orAPI_GATEWAY. -
If
ProtocolincludesFTP, thenAddressAllocationIdscannot be associated. -
If
Protocolis set only toSFTP, theEndpointTypecan be set toPUBLICand theIdentityProviderTypecan be set any of the supported identity types:SERVICE_MANAGED,AWS_DIRECTORY_SERVICE,AWS_LAMBDA, orAPI_GATEWAY. -
If
ProtocolincludesAS2, then theEndpointTypemust beVPC, and domain must be Amazon S3.
-
-
-
securityPolicyName
public final String securityPolicyName()
Specifies the name of the security policy for the server.
- Returns:
- Specifies the name of the security policy for the server.
-
serverId
public final String serverId()
Specifies the unique system-assigned identifier for a server that you instantiate.
- Returns:
- Specifies the unique system-assigned identifier for a server that you instantiate.
-
state
public final State state()
The condition of the server that was described. A value of
ONLINEindicates that the server can accept jobs and transfer files. AStatevalue ofOFFLINEmeans that the server cannot perform file transfer operations.The states of
STARTINGandSTOPPINGindicate that the server is in an intermediate state, either not fully able to respond, or not fully offline. The values ofSTART_FAILEDorSTOP_FAILEDcan indicate an error condition.If the service returns an enum value that is not available in the current SDK version,
statewill returnState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstateAsString().- Returns:
- The condition of the server that was described. A value of
ONLINEindicates that the server can accept jobs and transfer files. AStatevalue ofOFFLINEmeans that the server cannot perform file transfer operations.The states of
STARTINGandSTOPPINGindicate that the server is in an intermediate state, either not fully able to respond, or not fully offline. The values ofSTART_FAILEDorSTOP_FAILEDcan indicate an error condition. - See Also:
State
-
stateAsString
public final String stateAsString()
The condition of the server that was described. A value of
ONLINEindicates that the server can accept jobs and transfer files. AStatevalue ofOFFLINEmeans that the server cannot perform file transfer operations.The states of
STARTINGandSTOPPINGindicate that the server is in an intermediate state, either not fully able to respond, or not fully offline. The values ofSTART_FAILEDorSTOP_FAILEDcan indicate an error condition.If the service returns an enum value that is not available in the current SDK version,
statewill returnState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstateAsString().- Returns:
- The condition of the server that was described. A value of
ONLINEindicates that the server can accept jobs and transfer files. AStatevalue ofOFFLINEmeans that the server cannot perform file transfer operations.The states of
STARTINGandSTOPPINGindicate that the server is in an intermediate state, either not fully able to respond, or not fully offline. The values ofSTART_FAILEDorSTOP_FAILEDcan indicate an error condition. - See Also:
State
-
hasTags
public final boolean hasTags()
For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
-
tags
public final List<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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasTags()method.- Returns:
- Specifies the key-value pairs that you can use to search for and group servers that were assigned to the server that was described.
-
userCount
public final Integer userCount()
Specifies the number of users that are assigned to a server you specified with the
ServerId.- Returns:
- Specifies the number of users that are assigned to a server you specified with the
ServerId.
-
workflowDetails
public final 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,
WorkflowDetailscan 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.- Returns:
- 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,
WorkflowDetailscan 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.
-
hasStructuredLogDestinations
public final boolean hasStructuredLogDestinations()
For responses, this returns true if the service returned a value for the StructuredLogDestinations property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
-
structuredLogDestinations
public final List<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-servercall. For example:update-server --server-id s-1234567890abcdef0 --structured-log-destinationsAttempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasStructuredLogDestinations()method.- Returns:
- 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-servercall. For example:update-server --server-id s-1234567890abcdef0 --structured-log-destinations
-
s3StorageOptions
public final 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
TYPEofDIRECTORY. If you enable this option, you would then need to explicitly set theHomeDirectoryMapEntryTypetoFILEif you want a mapping to have a file target.- Returns:
- Specifies whether or not performance for your Amazon S3 directories is optimized. This is disabled by
default.
By default, home directory mappings have a
TYPEofDIRECTORY. If you enable this option, you would then need to explicitly set theHomeDirectoryMapEntryTypetoFILEif you want a mapping to have a file target.
-
hasAs2ServiceManagedEgressIpAddresses
public final boolean hasAs2ServiceManagedEgressIpAddresses()
For responses, this returns true if the service returned a value for the As2ServiceManagedEgressIpAddresses property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
-
as2ServiceManagedEgressIpAddresses
public final List<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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasAs2ServiceManagedEgressIpAddresses()method.- Returns:
- 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.
-
toBuilder
public DescribedServer.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<DescribedServer.Builder,DescribedServer>
-
builder
public static DescribedServer.Builder builder()
-
serializableBuilderClass
public static Class<? extends DescribedServer.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
toString
public final String toString()
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-
-