Package io.quarkus.amazon.s3.runtime

Class S3Config

java.lang.Object

io.quarkus.amazon.s3.runtime.S3Config

@ConfigRoot(phase=RUN_TIME)
public class S3Config
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
boolean	accelerateMode	Enable using the accelerate endpoint when accessing S3.
NettyHttpClientConfig	asyncClient	Netty HTTP transport configurations
AwsConfig	aws	AWS services configurations
boolean	checksumValidation	Enable doing a validation of the checksum of an object stored in S3.
boolean	chunkedEncoding	Enable using chunked encoding when signing the request payload for PutObjectRequest and UploadPartRequest.
boolean	dualstack	Enable dualstack mode for accessing S3.
boolean	pathStyleAccess	Enable using path style access for accessing S3 objects instead of DNS style access.
Optional<String>	profileName	Define the profile name that should be consulted to determine the default value of useArnRegionEnabled.
SdkConfig	sdk	AWS SDK client configurations
SyncHttpClientConfig	syncClient	Sync HTTP transport configurations
boolean	useArnRegionEnabled	Enable cross-region call to the region specified in the S3 resource ARN different than the region the client was configured with.

Constructor Summary

Constructors

Constructor	Description
S3Config()

Method Summary

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

accelerateMode

@ConfigItem(defaultValue="false")
public boolean accelerateMode

Enable using the accelerate endpoint when accessing S3.

Accelerate endpoints allow faster transfer of objects by using Amazon CloudFront's globally distributed edge locations.

checksumValidation

@ConfigItem(defaultValue="true")
public boolean checksumValidation

Enable doing a validation of the checksum of an object stored in S3.

chunkedEncoding

@ConfigItem(defaultValue="true")
public boolean chunkedEncoding

Enable using chunked encoding when signing the request payload for PutObjectRequest and UploadPartRequest.

dualstack

@ConfigItem(defaultValue="false")
public boolean dualstack

Enable dualstack mode for accessing S3. If you want to use IPv6 when accessing S3, dualstack must be enabled.

pathStyleAccess

@ConfigItem(defaultValue="false")
public boolean pathStyleAccess

Enable using path style access for accessing S3 objects instead of DNS style access. DNS style access is preferred as it will result in better load balancing when accessing S3.

useArnRegionEnabled

@ConfigItem(defaultValue="false")
public boolean useArnRegionEnabled

Enable cross-region call to the region specified in the S3 resource ARN different than the region the client was configured with. If this flag is not set to 'true', the cross-region call will throw an exception.

profileName

@ConfigItem
public Optional<String> profileName

Define the profile name that should be consulted to determine the default value of useArnRegionEnabled. This is not used, if the useArnRegionEnabled is configured to 'true'.

If not specified, the value in `AWS_PROFILE` environment variable or `aws.profile` system property is used and defaults to `default` name.

sdk

@ConfigItem(name="<<parent>>")
@ConfigDocSection
public SdkConfig sdk

AWS SDK client configurations

aws

@ConfigItem
@ConfigDocSection
public AwsConfig aws

AWS services configurations

syncClient

@ConfigItem
@ConfigDocSection
public SyncHttpClientConfig syncClient

Sync HTTP transport configurations

asyncClient

@ConfigItem
@ConfigDocSection
public NettyHttpClientConfig asyncClient

Netty HTTP transport configurations

Constructor Detail

S3Config

public S3Config()