Class AwsAccountRoleCredential

java.lang.Object

co.yellowdog.platform.account.credentials.AwsAccountRoleCredential

All Implemented Interfaces:

Credential, Serializable

@JsonClassDescription("Amazon Web Services (AWS) account role credential")
public final class AwsAccountRoleCredential
extends Object
implements Credential

Holds the Role ARN and External ID required to allow YellowDog Platform to assume an assigned role in an external AWS account.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static AwsAccountRoleCredential.Builder	builder()
boolean	equals(Object o)
String	getDescription()
String	getExternalId()	The external ID required to assume the external role.
String	getExternalRoleArn()	The ARN of the IAM role in the external account.
String	getName()	Returns the name assigned to the Credential to identify it to the ComputeServiceClient.
int	hashCode()
AwsAccountRoleCredential.Builder	toBuilder()
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface co.yellowdog.platform.account.credentials.Credential

getExpiryTime

Method Details

builder

public static AwsAccountRoleCredential.Builder builder()

toBuilder

public AwsAccountRoleCredential.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

getExternalRoleArn

public String getExternalRoleArn()

The ARN of the IAM role in the external account.

Returns:

the ARN of the IAM role in the external account

getExternalId

public String getExternalId()

The external ID required to assume the external role.

Returns:

the external ID

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