com.ibm.cos.v2.services.s3.s3express

Interface S3ExpressSessionCredentials

All Superinterfaces:

AwsCredentialsIdentity, Identity

All Known Implementing Classes:

DefaultS3ExpressSessionCredentials

public interface S3ExpressSessionCredentials
extends AwsCredentialsIdentity

Session credentials used by S3ExpressAuthScheme.

While these contain the same information as AwsCredentialsIdentity, they are only valid for accessing S3 express, and they are only valid for use when accessing a single bucket. S3 express is able to validate these credentials more quickly than standard AwsCredentialsIdentitys, reducing the latency required for each request.

Users of the SDK should not need to create this themselves. These credentials are created automatically by the S3ExpressAuthScheme that is automatically included with S3Client when S3BaseClientBuilder.disableS3ExpressSessionAuth(Boolean) is not true.

See Also:

S3ExpressAuthScheme, S3Client.createSession(CreateSessionRequest)

Nested Class Summary

Nested classes/interfaces inherited from interface com.ibm.cos.v2.identity.spi.AwsCredentialsIdentity

AwsCredentialsIdentity.Builder

Method Summary

Modifier and Type	Method and Description
static S3ExpressSessionCredentials	create(String accessKeyId, String secretAccessKey, String sessionToken) Create S3 express session credentials for the provided access key ID, secret access key and session token.
static S3ExpressSessionCredentials	fromSessionResponse(SessionCredentials credentials) Create S3 express session credentials for the provided SessionCredentials.
String	sessionToken() Retrieve the S3 express token.

Methods inherited from interface com.ibm.cos.v2.identity.spi.AwsCredentialsIdentity

accessKeyId, accountId, builder, create, secretAccessKey

Methods inherited from interface com.ibm.cos.v2.identity.spi.Identity

expirationTime, providerName

Method Detail

sessionToken

String sessionToken()

Retrieve the S3 express token.

create

static S3ExpressSessionCredentials create(String accessKeyId,
                                          String secretAccessKey,
                                          String sessionToken)

Create S3 express session credentials for the provided access key ID, secret access key and session token.

fromSessionResponse

static S3ExpressSessionCredentials fromSessionResponse(SessionCredentials credentials)

Create S3 express session credentials for the provided SessionCredentials.