Interface S3Configuration.Builder
-
- All Superinterfaces:
Buildable
,CopyableBuilder<S3Configuration.Builder,S3Configuration>
,SdkBuilder<S3Configuration.Builder,S3Configuration>
- Enclosing class:
- S3Configuration
@NotThreadSafe public static interface S3Configuration.Builder extends CopyableBuilder<S3Configuration.Builder,S3Configuration>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Deprecated Methods Modifier and Type Method Description Boolean
accelerateModeEnabled()
S3Configuration.Builder
accelerateModeEnabled(Boolean accelerateModeEnabled)
Option to enable using the accelerate endpoint when accessing S3.Boolean
checksumValidationEnabled()
S3Configuration.Builder
checksumValidationEnabled(Boolean checksumValidationEnabled)
Option to disable MD5 trailing checksum validation of an object stored in S3.Boolean
chunkedEncodingEnabled()
S3Configuration.Builder
chunkedEncodingEnabled(Boolean chunkedEncodingEnabled)
Option to enable using chunked encoding when signing the request payload forPutObjectRequest
andUploadPartRequest
.Boolean
dualstackEnabled()
S3Configuration.Builder
dualstackEnabled(Boolean dualstackEnabled)
Deprecated.This option has been replaced withAwsClientBuilder.dualstackEnabled(Boolean)
andS3Presigner.Builder.dualstackEnabled(Boolean)
.Boolean
multiRegionEnabled()
S3Configuration.Builder
multiRegionEnabled(Boolean multiRegionEnabled)
Option to enable or disable the usage of multi-region access point ARNs.Boolean
pathStyleAccessEnabled()
S3Configuration.Builder
pathStyleAccessEnabled(Boolean pathStyleAccessEnabled)
Option to enable using path style access for accessing S3 objects instead of DNS style access.ProfileFile
profileFile()
S3Configuration.Builder
profileFile(Supplier<ProfileFile> profileFile)
The supplier of profile file instances that should be consulted to determine the default value ofuseArnRegionEnabled(Boolean)
ormultiRegionEnabled(Boolean)
.S3Configuration.Builder
profileFile(ProfileFile profileFile)
The profile file that should be consulted to determine the default value ofuseArnRegionEnabled(Boolean)
ormultiRegionEnabled(Boolean)
.Supplier<ProfileFile>
profileFileSupplier()
String
profileName()
S3Configuration.Builder
profileName(String profileName)
The profile name that should be consulted to determine the default value ofuseArnRegionEnabled(Boolean)
ormultiRegionEnabled(Boolean)
.Boolean
useArnRegionEnabled()
S3Configuration.Builder
useArnRegionEnabled(Boolean useArnRegionEnabled)
If an S3 resource ARN is passed in as the target of an S3 operation that has a different region to the one the client was configured with, this flag must be set to 'true' to permit the client to make a cross-region call to the region specified in the ARN otherwise an exception will be thrown.-
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
-
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
-
-
-
-
Method Detail
-
dualstackEnabled
Boolean dualstackEnabled()
-
dualstackEnabled
@Deprecated S3Configuration.Builder dualstackEnabled(Boolean dualstackEnabled)
Deprecated.This option has been replaced withAwsClientBuilder.dualstackEnabled(Boolean)
andS3Presigner.Builder.dualstackEnabled(Boolean)
. If both this and one of those options are set, an exception will be thrown.Option to enable using the dualstack endpoints when accessing S3. Dualstack should be enabled if you want to use IPv6.Dualstack endpoints are disabled by default.
-
accelerateModeEnabled
Boolean accelerateModeEnabled()
-
accelerateModeEnabled
S3Configuration.Builder accelerateModeEnabled(Boolean accelerateModeEnabled)
Option to enable using the accelerate endpoint when accessing S3. Accelerate endpoints allow faster transfer of objects by using Amazon CloudFront's globally distributed edge locations.Accelerate mode is disabled by default.
-
pathStyleAccessEnabled
Boolean pathStyleAccessEnabled()
-
pathStyleAccessEnabled
S3Configuration.Builder pathStyleAccessEnabled(Boolean pathStyleAccessEnabled)
Option to 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.Path style access is disabled by default. Path style may still be used for legacy buckets that are not DNS compatible.
-
checksumValidationEnabled
Boolean checksumValidationEnabled()
-
checksumValidationEnabled
S3Configuration.Builder checksumValidationEnabled(Boolean checksumValidationEnabled)
Option to disable MD5 trailing checksum validation of an object stored in S3. This is enabled by default.The recommended approach is to specify a
ChecksumAlgorithm
on thePutObjectRequest
and enableChecksumMode
on theGetObjectRequest
. In that case, validation will be performed for the specified flexible checksum, and validation will not be performed for MD5 checksum.For
PutObjectRequest
, MD5 trailing checksum validation will be performed if:- Checksum validation is not disabled
- Server-side encryption is not used
- Flexible checksum algorithm is not specified
GetObjectRequest
, MD5 trailing checksum validation will be performed if:- Checksum validation is not disabled
ChecksumMode
is disabled (default)- Regular S3 is used (non-S3Express)
-
chunkedEncodingEnabled
Boolean chunkedEncodingEnabled()
-
chunkedEncodingEnabled
S3Configuration.Builder chunkedEncodingEnabled(Boolean chunkedEncodingEnabled)
Option to enable using chunked encoding when signing the request payload forPutObjectRequest
andUploadPartRequest
.- See Also:
S3Configuration.chunkedEncodingEnabled()
-
useArnRegionEnabled
Boolean useArnRegionEnabled()
-
useArnRegionEnabled
S3Configuration.Builder useArnRegionEnabled(Boolean useArnRegionEnabled)
If an S3 resource ARN is passed in as the target of an S3 operation that has a different region to the one the client was configured with, this flag must be set to 'true' to permit the client to make a cross-region call to the region specified in the ARN otherwise an exception will be thrown.- See Also:
S3Configuration.useArnRegionEnabled()
-
multiRegionEnabled
Boolean multiRegionEnabled()
-
multiRegionEnabled
S3Configuration.Builder multiRegionEnabled(Boolean multiRegionEnabled)
Option to enable or disable the usage of multi-region access point ARNs. Multi-region access point ARNs can result in cross-region calls, and can be prevented by setting this flag to false. This option is enabled by default.- See Also:
S3Configuration.multiRegionEnabled()
-
profileFile
ProfileFile profileFile()
-
profileFile
S3Configuration.Builder profileFile(ProfileFile profileFile)
The profile file that should be consulted to determine the default value ofuseArnRegionEnabled(Boolean)
ormultiRegionEnabled(Boolean)
. This is not used, if those parameters are configured.By default, the
ProfileFile.defaultProfileFile()
is used.
-
profileFileSupplier
Supplier<ProfileFile> profileFileSupplier()
-
profileFile
S3Configuration.Builder profileFile(Supplier<ProfileFile> profileFile)
The supplier of profile file instances that should be consulted to determine the default value ofuseArnRegionEnabled(Boolean)
ormultiRegionEnabled(Boolean)
. This is not used, if those parameters are configured on the builder.By default, the
ProfileFile.defaultProfileFile()
is used.
-
profileName
String profileName()
-
profileName
S3Configuration.Builder profileName(String profileName)
The profile name that should be consulted to determine the default value ofuseArnRegionEnabled(Boolean)
ormultiRegionEnabled(Boolean)
. This is not used, if those parameters are configured.By default, the
ProfileFileSystemSetting.AWS_PROFILE
is used.
-
-