Documentation for a newer release is available. View Latest

S3 File Manager

El administrador de archivos S3 es adecuado para la integración con sistemas de almacenamiento remotos que son compatibles con la API de Amazon S3.

Dependencia de Maven

Para utilizar el S3 File Manager en tu aplicación, incluye la siguiente dependencia:

    <dependency>
        <groupId>com.iconsolutions.ipf.filemanager</groupId>
        <artifactId>ipf-file-manager-s3</artifactId>
    </dependency>

Configuración

Property Grouping: ipf.file-manager.s3

Key Description Default Value

ipf.file-manager.s3.resiliency-settings.attempt-timeout

The maximum time allowed for each individual attempt before timing out. Shorter timeouts fail faster but might not allow enough time for slow operations.

 
"5s"

ipf.file-manager.s3.upload-parallelism

Controls the maximum number of parallel upload operations that can occur simultaneously. Higher values may improve throughput but increase resource usage.

 
1

ipf.file-manager.s3.checksum-algorithm

The algorithm used to verify data integrity during transfers. CRC32 provides a good balance between performance and reliability.

 
"CRC32"

ipf.file-manager.s3.resiliency-settings.retryable-status-codes

HTTP status codes that should trigger a retry. Typically includes server errors like 500 (Internal Server Error) and 503 (Service Unavailable).

 
[
    500,
    503
]

ipf.file-manager.s3.credentials.secret-access-key

AWS secret access key for authentication when using static credentials provider.

 
"secretAccessKey"

ipf.file-manager.s3.resiliency-settings.max-attempts

Determines the maximum number of retries to be made. Note that this includes the first failed attempt.

 
5

ipf.file-manager.s3.region

AWS region is mandatory but will be automatically provided by the environment, see docs.aws.amazon.com/sdkref/latest/guide/feature-region.html

 
"us-east-1"

ipf.file-manager.s3.reader.buffer-size

Larger buffer size for better throughput with large files

 
"32kB"

ipf.file-manager.s3.enabled

S3 file manager is disabled by default when the maven dependency is included. Can be enabled by setting this property to true

 
false

ipf.file-manager.s3.credentials-provider

Values:
- static: Uses fixed access/secret keys specified in configuration
- sts-web-identity: Uses AWS IAM OIDC/Web Identity token provider for EKS/Kubernetes environments
- default: Uses AWS Default Credentials Provider Chain (docs.aws.amazon.com/sdk-for-java/latest/developer-guide/credentials.html#credentials-default)
Follows this order: environment variables, AWS credentials file, IAM role for EC2/ECS
Falls back to DefaultCredentialsProvider if not specified or any other value

 
"static"

ipf.file-manager.s3.credentials.access-key-id

AWS access key ID for authentication when using static credentials provider.

 
"accessKey"

ipf.file-manager.s3.resiliency-settings.call-timeout

The overall timeout for the entire operation, including all retry attempts. Sets an upper bound on how long client code will wait for completion.

 
"3s"

ipf.file-manager.s3.chunk-encoding-enabled

Controls whether to use chunked transfer encoding for uploading files. When disabled, the entire file content is buffered before upload.

 
false

Gestión de errores

Unresolved include directive in modules/ipf-file-manager/pages/features/s3.adoc - include::../events_es.adoc[]

Ejemplos

Unresolved include directive in modules/ipf-file-manager/pages/features/s3.adoc - include::partial$s3-failure-examples_es.adoc[]