com.ibm.cos.v2.auth.credentials

Class AwsSessionCredentials

java.lang.Object

com.ibm.cos.v2.auth.credentials.AwsSessionCredentials

All Implemented Interfaces:

AwsCredentials, AwsCredentialsIdentity, AwsSessionCredentialsIdentity, Identity, ToCopyableBuilder<AwsSessionCredentials.Builder,AwsSessionCredentials>

@Immutable
public final class AwsSessionCredentials
extends Object
implements AwsCredentials, AwsSessionCredentialsIdentity, ToCopyableBuilder<AwsSessionCredentials.Builder,AwsSessionCredentials>

A special type of AwsCredentials that provides a session token to be used in service authentication. Session tokens are typically provided by a token broker service, like AWS Security Token Service, and provide temporary access to an AWS service.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AwsSessionCredentials.Builder A builder for creating an instance of AwsSessionCredentials.

Method Summary

Modifier and Type	Method and Description
String	accessKeyId() Retrieve the AWS access key, used to identify the user interacting with AWS.
Optional<String>	accountId() Retrieve the AWS account id associated with this credentials identity, if found.
static AwsSessionCredentials.Builder	builder() Returns a builder for this object.
AwsSessionCredentials	copy(Consumer<? super AwsSessionCredentials.Builder> modifier) A convenience method for calling ToCopyableBuilder.toBuilder(), updating the returned builder and then calling SdkBuilder.build().
static AwsSessionCredentials	create(String accessKey, String secretKey, String sessionToken) Constructs a new session credentials object, with the specified AWS access key, AWS secret key and AWS session token.
boolean	equals(Object o)
Optional<Instant>	expirationTime() Retrieve the expiration time of these credentials, if it exists.
int	hashCode()
Optional<String>	providerName() The name of the identity provider that created this credential identity.
String	secretAccessKey() Retrieve the AWS secret access key, used to authenticate the user interacting with AWS.
String	sessionToken() Retrieve the AWS session token.
AwsSessionCredentials.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

create

Method Detail

builder

public static AwsSessionCredentials.Builder builder()

Returns a builder for this object.

Specified by:

builder in interface AwsCredentialsIdentity

Specified by:

builder in interface AwsSessionCredentialsIdentity

create

public static AwsSessionCredentials create(String accessKey,
                                           String secretKey,
                                           String sessionToken)

Constructs a new session credentials object, with the specified AWS access key, AWS secret key and AWS session token.

Specified by:

create in interface AwsSessionCredentialsIdentity

Parameters:

accessKey - The AWS access key, used to identify the user interacting with AWS.

secretKey - The AWS secret access key, used to authenticate the user interacting with AWS.

sessionToken - The AWS session token, retrieved from an AWS token service, used for authenticating that this user has received temporary permission to access some resource.

accessKeyId

public String accessKeyId()

Retrieve the AWS access key, used to identify the user interacting with AWS.

Specified by:

accessKeyId in interface AwsCredentialsIdentity

secretAccessKey

public String secretAccessKey()

Retrieve the AWS secret access key, used to authenticate the user interacting with AWS.

Specified by:

secretAccessKey in interface AwsCredentialsIdentity

expirationTime

public Optional<Instant> expirationTime()

Retrieve the expiration time of these credentials, if it exists.

Specified by:

expirationTime in interface Identity

sessionToken

public String sessionToken()

Retrieve the AWS session token. This token is retrieved from an AWS token service, and is used for authenticating that this user has received temporary permission to access some resource.

Specified by:

sessionToken in interface AwsSessionCredentialsIdentity

providerName

public Optional<String> providerName()

The name of the identity provider that created this credential identity.

Specified by:

providerName in interface Identity

accountId

public Optional<String> accountId()

Description copied from interface: AwsCredentialsIdentity

Retrieve the AWS account id associated with this credentials identity, if found.

Specified by:

accountId in interface AwsCredentialsIdentity

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toBuilder

public AwsSessionCredentials.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<AwsSessionCredentials.Builder,AwsSessionCredentials>

Returns:

a builder for type T

copy

public AwsSessionCredentials copy(Consumer<? super AwsSessionCredentials.Builder> modifier)

Description copied from interface: ToCopyableBuilder

A convenience method for calling ToCopyableBuilder.toBuilder(), updating the returned builder and then calling SdkBuilder.build(). This is useful for making small modifications to the existing object.

Specified by:

copy in interface ToCopyableBuilder<AwsSessionCredentials.Builder,AwsSessionCredentials>

Parameters:

modifier - A function that mutates this immutable object using the provided builder.

Returns:

A new copy of this object with the requested modifications.