Class AwsCredential

java.lang.Object

co.yellowdog.platform.account.credentials.AwsCredential

All Implemented Interfaces:

Credential, Serializable

@JsonClassDescription("Amazon Web Services (AWS) access key credential")
public final class AwsCredential
extends Object
implements Credential

Holds the Access Key ID and Secret Access Key which form a set of credentials for Amazon Web Services (AWS).

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AwsCredential.Builder	A builder that can be used to build a new AwsCredential that is automatically validated on build.

Constructor Summary

Constructors

Constructor	Description
AwsCredential(String name, String description, String accessKeyId, String secretAccessKey, String sessionToken, Instant expiryTime)	Creates a new AwsCredential instance.

Method Summary

Modifier and Type	Method	Description
static AwsCredential.Builder	builder()
boolean	equals(Object o)
String	getAccessKeyId()	The AWS Access Key ID
String	getDescription()
Instant	getExpiryTime()	The expiry time if this credential is temporary
String	getName()	Returns the name assigned to the Credential to identify it to the ComputeServiceClient.
String	getSecretAccessKey()	The AWS Secret Access Key
String	getSessionToken()	The AWS Session Token if this credential is temporary
int	hashCode()
AwsCredential.Builder	toBuilder()
String	toString()

Methods inherited from class Object

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

Constructor Details

AwsCredential

public AwsCredential(String name,
 String description,
 String accessKeyId,
 String secretAccessKey,
 String sessionToken,
 Instant expiryTime)

Creates a new AwsCredential instance.

Parameters:

name -

description -

accessKeyId - the AWS Access Key ID

secretAccessKey - the AWS Secret Access Key

sessionToken - the AWS Session Token

expiryTime - the expiry time

Method Details

builder

public static AwsCredential.Builder builder()

toBuilder

public AwsCredential.Builder toBuilder()

Specified by:

toBuilder in interface Credential

getName

public String getName()

Description copied from interface: Credential

Returns the name assigned to the Credential to identify it to the ComputeServiceClient.

Specified by:

getName in interface Credential

Returns:

the name assigned to the Credential

getDescription

public String getDescription()

Specified by:

getDescription in interface Credential

getAccessKeyId

public String getAccessKeyId()

The AWS Access Key ID

Returns:

the AWS Access Key ID

getSecretAccessKey

public String getSecretAccessKey()

The AWS Secret Access Key

Returns:

the AWS Secret Access Key

getSessionToken

public String getSessionToken()

The AWS Session Token if this credential is temporary

Returns:

the AWS Session Token

getExpiryTime

public Instant getExpiryTime()

The expiry time if this credential is temporary

Specified by:

getExpiryTime in interface Credential

Returns:

the expiry time

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object