Class DescribedServer
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<DescribedServer.Builder,
DescribedServer>
Describes the properties of a file transfer protocol-enabled server that was specified.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
arn()
Specifies the unique Amazon Resource Name (ARN) of the server.The list of egress IP addresses of this server.static DescribedServer.Builder
builder()
final String
Specifies the ARN of the Amazon Web ServicesCertificate Manager (ACM) certificate.final Domain
domain()
Specifies the domain of the storage system that is used for file transfers.final String
Specifies the domain of the storage system that is used for file transfers.final EndpointDetails
The virtual private cloud (VPC) endpoint settings that are configured for your server.final EndpointType
Defines the type of endpoint that your server is connected to.final String
Defines the type of endpoint that your server is connected to.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final boolean
For responses, this returns true if the service returned a value for the As2ServiceManagedEgressIpAddresses property.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the Protocols property.final boolean
For responses, this returns true if the service returned a value for the StructuredLogDestinations property.final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.final String
Specifies the Base64-encoded SHA256 fingerprint of the server's host key.final IdentityProviderDetails
Specifies information to call a customer-supplied authentication API.final IdentityProviderType
The mode of authentication for a server.final String
The mode of authentication for a server.final String
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.final String
Specifies a string to display when users connect to a server.final String
Specifies a string to display when users connect to a server.final ProtocolDetails
The protocol settings that are configured for your server.Specifies the file transfer protocol or protocols over which your file transfer protocol client can connect to your server's endpoint.Specifies the file transfer protocol or protocols over which your file transfer protocol client can connect to your server's endpoint.final S3StorageOptions
Specifies whether or not performance for your Amazon S3 directories is optimized.final String
Specifies the name of the security policy for the server.static Class
<? extends DescribedServer.Builder> final String
serverId()
Specifies the unique system-assigned identifier for a server that you instantiate.final State
state()
The condition of the server that was described.final String
The condition of the server that was described.Specifies the log groups to which your server logs are sent.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.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final Integer
Specifies the number of users that are assigned to a server you specified with theServerId
.final WorkflowDetails
Specifies the workflow ID for the workflow to assign and the execution role that's used for executing the workflow.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
arn
Specifies the unique Amazon Resource Name (ARN) of the server.
- Returns:
- Specifies the unique Amazon Resource Name (ARN) of the server.
-
certificate
Specifies the ARN of the Amazon Web ServicesCertificate Manager (ACM) certificate. Required when
Protocols
is set toFTPS
.- Returns:
- Specifies the ARN of the Amazon Web ServicesCertificate Manager (ACM) certificate. Required when
Protocols
is set toFTPS
.
-
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 theSetStatOption
parameter. To have the Transfer Family server ignore theSETSTAT
command and upload files without needing to make any changes to your SFTP client, set the value toENABLE_NO_OP
. If you set theSetStatOption
parameter toENABLE_NO_OP
, Transfer Family generates a log entry to Amazon CloudWatch Logs, so that you can determine when the client is making aSETSTAT
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.
- Returns:
- 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 theSetStatOption
parameter. To have the Transfer Family server ignore theSETSTAT
command and upload files without needing to make any changes to your SFTP client, set the value toENABLE_NO_OP
. If you set theSetStatOption
parameter toENABLE_NO_OP
, Transfer Family generates a log entry to Amazon CloudWatch Logs, so that you can determine when the client is making aSETSTAT
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.
-
-
-
domain
Specifies the domain of the storage system that is used for file transfers.
If the service returns an enum value that is not available in the current SDK version,
domain
will 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.
- See Also:
-
domainAsString
Specifies the domain of the storage system that is used for file transfers.
If the service returns an enum value that is not available in the current SDK version,
domain
will 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.
- See Also:
-
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
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,
endpointType
will 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:
-
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,
endpointType
will 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:
-
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.- 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-key
command.
-
identityProviderDetails
Specifies information to call a customer-supplied authentication API. This field is not populated when the
IdentityProviderType
of a server isAWS_DIRECTORY_SERVICE
orSERVICE_MANAGED
.- Returns:
- Specifies information to call a customer-supplied authentication API. This field is not populated when
the
IdentityProviderType
of a server isAWS_DIRECTORY_SERVICE
orSERVICE_MANAGED
.
-
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 theIdentityProviderDetails
parameter.Use the
API_GATEWAY
value to integrate with an identity provider of your choosing. TheAPI_GATEWAY
setting requires you to provide an Amazon API Gateway endpoint URL to call for authentication by using theIdentityProviderDetails
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 theFunction
parameter for theIdentityProviderDetails
data type.If the service returns an enum value that is not available in the current SDK version,
identityProviderType
will 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_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 theIdentityProviderDetails
parameter.Use the
API_GATEWAY
value to integrate with an identity provider of your choosing. TheAPI_GATEWAY
setting requires you to provide an Amazon API Gateway endpoint URL to call for authentication by using theIdentityProviderDetails
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 theFunction
parameter for theIdentityProviderDetails
data type. - See Also:
-
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_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 theIdentityProviderDetails
parameter.Use the
API_GATEWAY
value to integrate with an identity provider of your choosing. TheAPI_GATEWAY
setting requires you to provide an Amazon API Gateway endpoint URL to call for authentication by using theIdentityProviderDetails
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 theFunction
parameter for theIdentityProviderDetails
data type.If the service returns an enum value that is not available in the current SDK version,
identityProviderType
will 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_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 theIdentityProviderDetails
parameter.Use the
API_GATEWAY
value to integrate with an identity provider of your choosing. TheAPI_GATEWAY
setting requires you to provide an Amazon API Gateway endpoint URL to call for authentication by using theIdentityProviderDetails
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 theFunction
parameter for theIdentityProviderDetails
data type. - See Also:
-
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
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
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
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 eitherFTP
orFTPS
, then theEndpointType
must beVPC
and theIdentityProviderType
must be eitherAWS_DIRECTORY_SERVICE
,AWS_LAMBDA
, orAPI_GATEWAY
. -
If
Protocol
includesFTP
, thenAddressAllocationIds
cannot be associated. -
If
Protocol
is set only toSFTP
, theEndpointType
can be set toPUBLIC
and theIdentityProviderType
can be set any of the supported identity types:SERVICE_MANAGED
,AWS_DIRECTORY_SERVICE
,AWS_LAMBDA
, orAPI_GATEWAY
. -
If
Protocol
includesAS2
, then theEndpointType
must 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
Protocol
includes eitherFTP
orFTPS
, then theEndpointType
must beVPC
and theIdentityProviderType
must be eitherAWS_DIRECTORY_SERVICE
,AWS_LAMBDA
, orAPI_GATEWAY
. -
If
Protocol
includesFTP
, thenAddressAllocationIds
cannot be associated. -
If
Protocol
is set only toSFTP
, theEndpointType
can be set toPUBLIC
and theIdentityProviderType
can be set any of the supported identity types:SERVICE_MANAGED
,AWS_DIRECTORY_SERVICE
,AWS_LAMBDA
, orAPI_GATEWAY
. -
If
Protocol
includesAS2
, then theEndpointType
must 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
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 eitherFTP
orFTPS
, then theEndpointType
must beVPC
and theIdentityProviderType
must be eitherAWS_DIRECTORY_SERVICE
,AWS_LAMBDA
, orAPI_GATEWAY
. -
If
Protocol
includesFTP
, thenAddressAllocationIds
cannot be associated. -
If
Protocol
is set only toSFTP
, theEndpointType
can be set toPUBLIC
and theIdentityProviderType
can be set any of the supported identity types:SERVICE_MANAGED
,AWS_DIRECTORY_SERVICE
,AWS_LAMBDA
, orAPI_GATEWAY
. -
If
Protocol
includesAS2
, then theEndpointType
must 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
Protocol
includes eitherFTP
orFTPS
, then theEndpointType
must beVPC
and theIdentityProviderType
must be eitherAWS_DIRECTORY_SERVICE
,AWS_LAMBDA
, orAPI_GATEWAY
. -
If
Protocol
includesFTP
, thenAddressAllocationIds
cannot be associated. -
If
Protocol
is set only toSFTP
, theEndpointType
can be set toPUBLIC
and theIdentityProviderType
can be set any of the supported identity types:SERVICE_MANAGED
,AWS_DIRECTORY_SERVICE
,AWS_LAMBDA
, orAPI_GATEWAY
. -
If
Protocol
includesAS2
, then theEndpointType
must beVPC
, and domain must be Amazon S3.
-
-
-
securityPolicyName
Specifies the name of the security policy for the server.
- Returns:
- Specifies the name of the security policy for the server.
-
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
The condition of the server that was described. A value of
ONLINE
indicates that the server can accept jobs and transfer files. AState
value ofOFFLINE
means that the server cannot perform file transfer operations.The states of
STARTING
andSTOPPING
indicate that the server is in an intermediate state, either not fully able to respond, or not fully offline. The values ofSTART_FAILED
orSTOP_FAILED
can indicate an error condition.If the service returns an enum value that is not available in the current SDK version,
state
will 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
ONLINE
indicates that the server can accept jobs and transfer files. AState
value ofOFFLINE
means that the server cannot perform file transfer operations.The states of
STARTING
andSTOPPING
indicate that the server is in an intermediate state, either not fully able to respond, or not fully offline. The values ofSTART_FAILED
orSTOP_FAILED
can indicate an error condition. - See Also:
-
stateAsString
The condition of the server that was described. A value of
ONLINE
indicates that the server can accept jobs and transfer files. AState
value ofOFFLINE
means that the server cannot perform file transfer operations.The states of
STARTING
andSTOPPING
indicate that the server is in an intermediate state, either not fully able to respond, or not fully offline. The values ofSTART_FAILED
orSTOP_FAILED
can indicate an error condition.If the service returns an enum value that is not available in the current SDK version,
state
will 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
ONLINE
indicates that the server can accept jobs and transfer files. AState
value ofOFFLINE
means that the server cannot perform file transfer operations.The states of
STARTING
andSTOPPING
indicate that the server is in an intermediate state, either not fully able to respond, or not fully offline. The values ofSTART_FAILED
orSTOP_FAILED
can indicate an error condition. - See Also:
-
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
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
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
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.- 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,
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.
-
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
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
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
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-server
call. For example:update-server --server-id s-1234567890abcdef0 --structured-log-destinations
-
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
ofDIRECTORY
. If you enable this option, you would then need to explicitly set theHomeDirectoryMapEntry
Type
toFILE
if 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
TYPE
ofDIRECTORY
. If you enable this option, you would then need to explicitly set theHomeDirectoryMapEntry
Type
toFILE
if 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
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
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<DescribedServer.Builder,
DescribedServer> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-