Interface S3ExpressAuthScheme
-
- All Superinterfaces:
AuthScheme<S3ExpressSessionCredentials>
- All Known Implementing Classes:
CrtS3ExpressNoOpAuthScheme
,DefaultS3ExpressAuthScheme
public interface S3ExpressAuthScheme extends AuthScheme<S3ExpressSessionCredentials>
An auth scheme for faster authentication when interacting with S3 express.This authentication scheme performs pre-authentication with S3 express using
S3Client.createSession(software.amazon.awssdk.services.s3.model.CreateSessionRequest)
. TheseS3ExpressSessionCredentials
are cached for future requests to the same bucket that are using the same credential provider.By default, this auth scheme is included on every
S3Client
instance and does not need to be explicitly enabled. If S3 express authentication is not desired for any reason, you can disable it on the client withS3BaseClientBuilder.disableS3ExpressSessionAuth(Boolean)
. When disabled, normal sigv4 will be used instead.
-
-
Method Summary
All Methods Static Methods Instance Methods Abstract Methods Modifier and Type Method Description static S3ExpressAuthScheme
create()
IdentityProvider<S3ExpressSessionCredentials>
identityProvider(IdentityProviders providers)
Retrieve theAwsCredentialsIdentity
basedIdentityProvider
associated with this authentication scheme.HttpSigner<S3ExpressSessionCredentials>
signer()
Retrieve theAwsV4HttpSigner
associated with this authentication scheme.-
Methods inherited from interface software.amazon.awssdk.http.auth.spi.scheme.AuthScheme
schemeId
-
-
-
-
Field Detail
-
SCHEME_ID
static final String SCHEME_ID
The Scheme-Id for S3Express auth scheme- See Also:
- Constant Field Values
-
-
Method Detail
-
create
static S3ExpressAuthScheme create()
-
identityProvider
IdentityProvider<S3ExpressSessionCredentials> identityProvider(IdentityProviders providers)
Retrieve theAwsCredentialsIdentity
basedIdentityProvider
associated with this authentication scheme.- Specified by:
identityProvider
in interfaceAuthScheme<S3ExpressSessionCredentials>
-
signer
HttpSigner<S3ExpressSessionCredentials> signer()
Retrieve theAwsV4HttpSigner
associated with this authentication scheme.- Specified by:
signer
in interfaceAuthScheme<S3ExpressSessionCredentials>
-
-