Package software.amazon.awssdk.services.iam.model

Class ServiceSpecificCredential

java.lang.Object

software.amazon.awssdk.services.iam.model.ServiceSpecificCredential

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<ServiceSpecificCredential.Builder,ServiceSpecificCredential>

@Generated("software.amazon.awssdk:codegen")
public final class ServiceSpecificCredential
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<ServiceSpecificCredential.Builder,ServiceSpecificCredential>

Contains the details of a service-specific credential.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ServiceSpecificCredential.Builder

Method Summary

Modifier and Type	Method	Description
static ServiceSpecificCredential.Builder	builder()
Instant	createDate()	The date and time, in ISO 8601 date-time format, when the service-specific credential were created.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
Instant	expirationDate()	The date and time when the service specific credential expires.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends ServiceSpecificCredential.Builder>	serializableBuilderClass()
String	serviceCredentialAlias()	For Bedrock API keys, this is the public portion of the credential that includes the IAM user name and a suffix containing version and creation information.
String	serviceCredentialSecret()	For Bedrock API keys, this is the secret portion of the credential that should be used to authenticate API calls.
String	serviceName()	The name of the service associated with the service-specific credential.
String	servicePassword()	The generated password for the service-specific credential.
String	serviceSpecificCredentialId()	The unique identifier for the service-specific credential.
String	serviceUserName()	The generated user name for the service-specific credential.
StatusType	status()	The status of the service-specific credential.
String	statusAsString()	The status of the service-specific credential.
ServiceSpecificCredential.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
String	userName()	The name of the IAM user associated with the service-specific credential.

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

createDate

public final Instant createDate()

The date and time, in ISO 8601 date-time format, when the service-specific credential were created.

Returns:

The date and time, in ISO 8601 date-time format, when the service-specific credential were created.

expirationDate

public final Instant expirationDate()

The date and time when the service specific credential expires. This field is only present for Bedrock API keys that were created with an expiration period.

Returns:

The date and time when the service specific credential expires. This field is only present for Bedrock API keys that were created with an expiration period.

serviceName

public final String serviceName()

The name of the service associated with the service-specific credential.

Returns:

The name of the service associated with the service-specific credential.

serviceUserName

public final String serviceUserName()

The generated user name for the service-specific credential. This value is generated by combining the IAM user's name combined with the ID number of the Amazon Web Services account, as in jane-at-123456789012, for example. This value cannot be configured by the user.

Returns:

The generated user name for the service-specific credential. This value is generated by combining the IAM user's name combined with the ID number of the Amazon Web Services account, as in jane-at-123456789012, for example. This value cannot be configured by the user.

servicePassword

public final String servicePassword()

The generated password for the service-specific credential.

Returns:

The generated password for the service-specific credential.

serviceCredentialAlias

public final String serviceCredentialAlias()

For Bedrock API keys, this is the public portion of the credential that includes the IAM user name and a suffix containing version and creation information.

Returns:

For Bedrock API keys, this is the public portion of the credential that includes the IAM user name and a suffix containing version and creation information.

serviceCredentialSecret

public final String serviceCredentialSecret()

For Bedrock API keys, this is the secret portion of the credential that should be used to authenticate API calls. This value is returned only when the credential is created.

Returns:

For Bedrock API keys, this is the secret portion of the credential that should be used to authenticate API calls. This value is returned only when the credential is created.

serviceSpecificCredentialId

public final String serviceSpecificCredentialId()

The unique identifier for the service-specific credential.

Returns:

The unique identifier for the service-specific credential.

userName

public final String userName()

The name of the IAM user associated with the service-specific credential.

Returns:

The name of the IAM user associated with the service-specific credential.

status

public final StatusType status()

The status of the service-specific credential. Active means that the key is valid for API calls, while Inactive means it is not.

If the service returns an enum value that is not available in the current SDK version, status will return StatusType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

Returns:

The status of the service-specific credential. Active means that the key is valid for API calls, while Inactive means it is not.

See Also:

StatusType

statusAsString

public final String statusAsString()

The status of the service-specific credential. Active means that the key is valid for API calls, while Inactive means it is not.

If the service returns an enum value that is not available in the current SDK version, status will return StatusType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

Returns:

The status of the service-specific credential. Active means that the key is valid for API calls, while Inactive means it is not.

See Also:

StatusType

toBuilder

public ServiceSpecificCredential.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ServiceSpecificCredential.Builder,ServiceSpecificCredential>

builder

public static ServiceSpecificCredential.Builder builder()

serializableBuilderClass

public static Class<? extends ServiceSpecificCredential.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo