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:

  • Method Details

    • 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:

    • 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:

    • createdAt

      public final String createdAt()

      Indicates when the IAM access key was created.

      For more information about the validation and formatting of timestamp fields in Security Hub, see Timestamps.

      Returns:
      Indicates when the IAM access key was created.

      For more information about the validation and formatting of timestamp fields in Security Hub, see Timestamps.

    • 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()
      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<AwsIamAccessKeyDetails.Builder,AwsIamAccessKeyDetails>
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.