Interface S3Presigner.Builder
-
- All Superinterfaces:
SdkPresigner.Builder
- All Known Implementing Classes:
DefaultS3Presigner.Builder
- Enclosing interface:
- S3Presigner
@NotThreadSafe public static interface S3Presigner.Builder extends SdkPresigner.Builder
A builder for creatingS3Presigner
s. Created usingS3Presigner.builder()
.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description S3Presigner
build()
default S3Presigner.Builder
credentialsProvider(AwsCredentialsProvider credentialsProvider)
S3Presigner.Builder
credentialsProvider(IdentityProvider<? extends AwsCredentialsIdentity> credentialsProvider)
S3Presigner.Builder
disableS3ExpressSessionAuth(Boolean disableS3ExpressSessionAuth)
Explicitly disable using S3 express session credentials when presigning a request with an S3 express bucket name.S3Presigner.Builder
dualstackEnabled(Boolean dualstackEnabled)
S3Presigner.Builder
endpointOverride(URI endpointOverride)
S3Presigner.Builder
fipsEnabled(Boolean dualstackEnabled)
S3Presigner.Builder
region(Region region)
S3Presigner.Builder
s3Client(S3Client s3Client)
Supply an S3 client for presigning S3 express requests that require S3 express session credentials,S3ExpressSessionCredentials
.S3Presigner.Builder
serviceConfiguration(S3Configuration serviceConfiguration)
Allows providing a custom S3 serviceConfiguration by providing aS3Configuration
object; Note: chunkedEncodingEnabled and checksumValidationEnabled do not apply to presigned requests.
-
-
-
Method Detail
-
serviceConfiguration
S3Presigner.Builder serviceConfiguration(S3Configuration serviceConfiguration)
Allows providing a custom S3 serviceConfiguration by providing aS3Configuration
object; Note: chunkedEncodingEnabled and checksumValidationEnabled do not apply to presigned requests.- Parameters:
serviceConfiguration
-S3Configuration
- Returns:
- this Builder
-
disableS3ExpressSessionAuth
S3Presigner.Builder disableS3ExpressSessionAuth(Boolean disableS3ExpressSessionAuth)
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 ans3Client(S3Client)
is also configured on the presigner.Note: If this option and
s3Client(S3Client)
is not configured, S3 express presigning works, but session auth will be disabled- Parameters:
disableS3ExpressSessionAuth
- - whether to disable S3 express session auth or not- Returns:
- this Builder
-
s3Client
S3Presigner.Builder s3Client(S3Client s3Client)
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 usingdisableS3ExpressSessionAuth(Boolean)
.Note: If this option and
disableS3ExpressSessionAuth(Boolean)
is not configured, S3 express presigning works, but session auth will be disabled- Parameters:
s3Client
-S3Client
- Returns:
- this Builder
-
region
S3Presigner.Builder region(Region region)
- Specified by:
region
in interfaceSdkPresigner.Builder
-
credentialsProvider
default S3Presigner.Builder credentialsProvider(AwsCredentialsProvider credentialsProvider)
- Specified by:
credentialsProvider
in interfaceSdkPresigner.Builder
-
credentialsProvider
S3Presigner.Builder credentialsProvider(IdentityProvider<? extends AwsCredentialsIdentity> credentialsProvider)
- Specified by:
credentialsProvider
in interfaceSdkPresigner.Builder
-
dualstackEnabled
S3Presigner.Builder dualstackEnabled(Boolean dualstackEnabled)
- Specified by:
dualstackEnabled
in interfaceSdkPresigner.Builder
-
fipsEnabled
S3Presigner.Builder fipsEnabled(Boolean dualstackEnabled)
- Specified by:
fipsEnabled
in interfaceSdkPresigner.Builder
-
endpointOverride
S3Presigner.Builder endpointOverride(URI endpointOverride)
- Specified by:
endpointOverride
in interfaceSdkPresigner.Builder
-
build
S3Presigner build()
- Specified by:
build
in interfaceSdkPresigner.Builder
-
-