Interface S3Presigner.Builder
- All Superinterfaces:
SdkPresigner.Builder
- All Known Implementing Classes:
DefaultS3Presigner.Builder
- Enclosing interface:
- S3Presigner
@SdkPublicApi
@NotThreadSafe
public static interface S3Presigner.Builder
extends SdkPresigner.Builder
A builder for creating
S3Presigners. Created using S3Presigner.builder().-
Method Summary
Modifier and TypeMethodDescriptionbuild()default S3Presigner.BuildercredentialsProvider(AwsCredentialsProvider credentialsProvider) credentialsProvider(IdentityProvider<? extends AwsCredentialsIdentity> credentialsProvider) disableS3ExpressSessionAuth(Boolean disableS3ExpressSessionAuth) Explicitly disable using S3 express session credentials when presigning a request with an S3 express bucket name.dualstackEnabled(Boolean dualstackEnabled) endpointOverride(URI endpointOverride) fipsEnabled(Boolean fipsEnabled) 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 aS3Configurationobject; Note: chunkedEncodingEnabled and checksumValidationEnabled do not apply to presigned requests.
-
Method Details
-
serviceConfiguration
Allows providing a custom S3 serviceConfiguration by providing aS3Configurationobject; Note: chunkedEncodingEnabled and checksumValidationEnabled do not apply to presigned requests.- Parameters:
serviceConfiguration-S3Configuration- Returns:
- this Builder
-
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 thatS3ExpressSessionCredentialswill 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
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
- Specified by:
regionin interfaceSdkPresigner.Builder
-
credentialsProvider
- Specified by:
credentialsProviderin interfaceSdkPresigner.Builder
-
credentialsProvider
S3Presigner.Builder credentialsProvider(IdentityProvider<? extends AwsCredentialsIdentity> credentialsProvider) - Specified by:
credentialsProviderin interfaceSdkPresigner.Builder
-
dualstackEnabled
- Specified by:
dualstackEnabledin interfaceSdkPresigner.Builder
-
fipsEnabled
- Specified by:
fipsEnabledin interfaceSdkPresigner.Builder
-
endpointOverride
- Specified by:
endpointOverridein interfaceSdkPresigner.Builder
-
build
S3Presigner build()- Specified by:
buildin interfaceSdkPresigner.Builder
-