Package software.amazon.awssdk.services.securityhub.model

Class AwsIamAccessKeyDetails

java.lang.Object

software.amazon.awssdk.services.securityhub.model.AwsIamAccessKeyDetails

All Implemented Interfaces:

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

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

IAM access key details related to a finding.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	AwsIamAccessKeyDetails.Builder

Method Summary

Modifier and Type	Method	Description
String	accessKeyId()	The identifier of the access key.
String	accountId()	The Amazon Web Services account ID of the account for the key.
static AwsIamAccessKeyDetails.Builder	builder()
String	createdAt()	Indicates when the IAM access key was created.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	principalId()	The ID of the principal associated with an access key.
String	principalName()	The name of the principal.
String	principalType()	The type of principal associated with an access key.
List<SdkField<?>>	sdkFields()
static Class<? extends AwsIamAccessKeyDetails.Builder>	serializableBuilderClass()
AwsIamAccessKeySessionContext	sessionContext()	Information about the session that the key was used for.
AwsIamAccessKeyStatus	status()	The status of the IAM access key related to a finding.
String	statusAsString()	The status of the IAM access key related to a finding.
AwsIamAccessKeyDetails.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
String	userName()	Deprecated. This filter is deprecated.

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

userName

@Deprecated
public final String userName()

Deprecated.

This filter is deprecated. Instead, use PrincipalName.

The user associated with the IAM access key related to a finding.

The UserName parameter has been replaced with the PrincipalName parameter because access keys can also be assigned to principals that are not IAM users.

Returns:

The user associated with the IAM access key related to a finding.

The UserName parameter has been replaced with the PrincipalName parameter because access keys can also be assigned to principals that are not IAM users.

status

public final AwsIamAccessKeyStatus status()

The status of the IAM access key related to a finding.

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

Returns:

The status of the IAM access key related to a finding.

See Also:

AwsIamAccessKeyStatus

statusAsString

public final String statusAsString()

The status of the IAM access key related to a finding.

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

Returns:

The status of the IAM access key related to a finding.

See Also:

AwsIamAccessKeyStatus

createdAt

public final String createdAt()

Indicates when the IAM access key was created.

This field accepts only the specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:

• YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)

• YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)

• YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)

• YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)

• YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)

Returns:

Indicates when the IAM access key was created.

This field accepts only the specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:

• YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)

• YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)

• YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)

• YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)

• YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)

principalId

public final String principalId()

The ID of the principal associated with an access key.

Returns:

The ID of the principal associated with an access key.

principalType

public final String principalType()

The type of principal associated with an access key.

Returns:

The type of principal associated with an access key.

principalName

public final String principalName()

The name of the principal.

Returns:

The name of the principal.

accountId

public final String accountId()

The Amazon Web Services account ID of the account for the key.

Returns:

The Amazon Web Services account ID of the account for the key.

accessKeyId

public final String accessKeyId()

The identifier of the access key.

Returns:

The identifier of the access key.

sessionContext

public final AwsIamAccessKeySessionContext sessionContext()

Information about the session that the key was used for.

Returns:

Information about the session that the key was used for.

toBuilder

public AwsIamAccessKeyDetails.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<AwsIamAccessKeyDetails.Builder,AwsIamAccessKeyDetails>

builder

public static AwsIamAccessKeyDetails.Builder builder()

serializableBuilderClass

public static Class<? extends AwsIamAccessKeyDetails.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