com.ibm.cos.v2.identity.spi

Interface AwsCredentialsIdentity

All Superinterfaces:

Identity

All Known Subinterfaces:

AwsCredentials, AwsSessionCredentialsIdentity, IBMOAuthCredentials, S3ExpressSessionCredentials

All Known Implementing Classes:

AwsBasicCredentials, AwsSessionCredentials, BasicIBMOAuthCredentials, DefaultAwsCredentialsIdentity, DefaultAwsSessionCredentialsIdentity, DefaultS3ExpressSessionCredentials

@ThreadSafe
public interface AwsCredentialsIdentity
extends Identity

Provides access to the AWS credentials used for accessing services: AWS access key ID and secret access key. These credentials are used to securely sign requests to services (e.g., AWS services) that use them for authentication.

For more details on AWS access keys, see: https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys

See Also:

AwsSessionCredentialsIdentity

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	AwsCredentialsIdentity.Builder

Method Summary

Modifier and Type	Method and Description
String	accessKeyId() Retrieve the AWS access key, used to identify the user interacting with services.
default Optional<String>	accountId() Retrieve the AWS account id associated with this credentials identity, if found.
static AwsCredentialsIdentity.Builder	builder()
static AwsCredentialsIdentity	create(String accessKeyId, String secretAccessKey) Constructs a new credentials object, with the specified AWS access key and AWS secret key.
String	secretAccessKey() Retrieve the AWS secret access key, used to authenticate the user interacting with services.

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

expirationTime, providerName

Method Detail

accessKeyId

String accessKeyId()

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

secretAccessKey

String secretAccessKey()

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

accountId

default Optional<String> accountId()

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

builder

static AwsCredentialsIdentity.Builder builder()

create

static AwsCredentialsIdentity create(String accessKeyId,
                                     String secretAccessKey)

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

Parameters:

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

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