Class DefaultS3Presigner.Builder
java.lang.Object
software.amazon.awssdk.services.s3.internal.signing.DefaultSdkPresigner.Builder<DefaultS3Presigner.Builder>
software.amazon.awssdk.services.s3.internal.signing.DefaultS3Presigner.Builder
- All Implemented Interfaces:
SdkPresigner.Builder
,S3Presigner.Builder
- Enclosing class:
DefaultS3Presigner
public static final class DefaultS3Presigner.Builder
extends DefaultSdkPresigner.Builder<DefaultS3Presigner.Builder>
implements S3Presigner.Builder
-
Method Summary
Modifier and TypeMethodDescriptionbuild()
Build the presigner using the configuration on this builder.disableS3ExpressSessionAuth
(Boolean disableS3ExpressSessionAuth) Explicitly disable using S3 express session credentials when presigning a request with an S3 express bucket name.Supply an S3 client for presigning S3 express requests that require S3 express session credentials,S3ExpressSessionCredentials
.serviceConfiguration
(S3Configuration serviceConfiguration) Allows providing a custom S3 serviceConfiguration by providing aS3Configuration
object; Note: chunkedEncodingEnabled and checksumValidationEnabled do not apply to presigned requests.Methods inherited from class software.amazon.awssdk.services.s3.internal.signing.DefaultSdkPresigner.Builder
credentialsProvider, credentialsProvider, dualstackEnabled, endpointOverride, fipsEnabled, region
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface software.amazon.awssdk.services.s3.presigner.S3Presigner.Builder
credentialsProvider, credentialsProvider, dualstackEnabled, endpointOverride, fipsEnabled, region
-
Method Details
-
serviceConfiguration
Allows providing a custom S3 serviceConfiguration by providing aS3Configuration
object; Note: chunkedEncodingEnabled and checksumValidationEnabled do not apply to presigned requests.- Specified by:
serviceConfiguration
in interfaceS3Presigner.Builder
- Parameters:
serviceConfiguration
-S3Configuration
- Returns:
- this Builder
-
disableS3ExpressSessionAuth
Description copied from interface:S3Presigner.Builder
Explicitly disable using S3 express session credentials when presigning a request with an S3 express bucket name. This value is by default false, which means thatS3ExpressSessionCredentials
will be used for presigning the request if anS3Presigner.Builder.s3Client(S3Client)
is also configured on the presigner.Note: If this option and
S3Presigner.Builder.s3Client(S3Client)
is not configured, S3 express presigning works, but session auth will be disabled- Specified by:
disableS3ExpressSessionAuth
in interfaceS3Presigner.Builder
- Parameters:
disableS3ExpressSessionAuth
- - whether to disable S3 express session auth or not- Returns:
- this Builder
-
s3Client
Description copied from interface:S3Presigner.Builder
Supply an S3 client for presigning S3 express requests that require S3 express session credentials,S3ExpressSessionCredentials
. These session credentials are short-lived. If the client isn't supplied, a presigned request targeting an S3 express bucket will use standard Sigv4 credentials for signing. This results in the same behavior as disabling S3 session auth usingS3Presigner.Builder.disableS3ExpressSessionAuth(Boolean)
.Note: If this option and
S3Presigner.Builder.disableS3ExpressSessionAuth(Boolean)
is not configured, S3 express presigning works, but session auth will be disabled- Specified by:
s3Client
in interfaceS3Presigner.Builder
- Parameters:
s3Client
-S3Client
- Returns:
- this Builder
-
build
Description copied from interface:SdkPresigner.Builder
Build the presigner using the configuration on this builder.- Specified by:
build
in interfaceS3Presigner.Builder
- Specified by:
build
in interfaceSdkPresigner.Builder
-