com.ibm.cos.v2.auth.credentials

Class AwsBasicCredentials

java.lang.Object

com.ibm.cos.v2.auth.credentials.AwsBasicCredentials

All Implemented Interfaces:

AwsCredentials, AwsCredentialsIdentity, Identity, ToCopyableBuilder<AwsBasicCredentials.Builder,AwsBasicCredentials>

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

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:

AwsCredentialsProvider

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AwsBasicCredentials(String accessKeyId, String secretAccessKey) Constructs a new credentials object, with the specified AWS access key and AWS secret key.

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 AwsBasicCredentials.Builder	builder()
AwsBasicCredentials	copy(Consumer<? super AwsBasicCredentials.Builder> modifier) A convenience method for calling ToCopyableBuilder.toBuilder(), updating the returned builder and then calling SdkBuilder.build().
static AwsBasicCredentials	create(String accessKeyId, String secretAccessKey) Constructs a new credentials object, with the specified AWS access key and AWS secret key.
boolean	equals(Object o)
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.
AwsBasicCredentials.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.Identity

expirationTime

Constructor Detail

AwsBasicCredentials

protected AwsBasicCredentials(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 AWS.

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

Method Detail

builder

public static AwsBasicCredentials.Builder builder()

Specified by:

builder in interface AwsCredentialsIdentity

create

public static AwsBasicCredentials create(String accessKeyId,
                                         String secretAccessKey)

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

Specified by:

create in interface AwsCredentialsIdentity

Parameters:

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

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

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

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()

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 AwsBasicCredentials.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<AwsBasicCredentials.Builder,AwsBasicCredentials>

Returns:

a builder for type T

copy

public AwsBasicCredentials copy(Consumer<? super AwsBasicCredentials.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<AwsBasicCredentials.Builder,AwsBasicCredentials>

Parameters:

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

Returns:

A new copy of this object with the requested modifications.