Class: Aws::SecurityHub::Types::AwsIamAccessKeyDetails

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb

Overview

Note:

When making an API call, you may pass AwsIamAccessKeyDetails data as a hash:

{
  user_name: "NonEmptyString",
  status: "Active", # accepts Active, Inactive
  created_at: "NonEmptyString",
  principal_id: "NonEmptyString",
  principal_type: "NonEmptyString",
  principal_name: "NonEmptyString",
  account_id: "NonEmptyString",
  access_key_id: "NonEmptyString",
  session_context: {
    attributes: {
      mfa_authenticated: false,
      creation_date: "NonEmptyString",
    },
    session_issuer: {
      type: "NonEmptyString",
      principal_id: "NonEmptyString",
      arn: "NonEmptyString",
      account_id: "NonEmptyString",
      user_name: "NonEmptyString",
    },
  },
}

IAM access key details related to a finding.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#access_key_idString

The identifier of the access key.

Returns:

  • (String)


5673
5674
5675
5676
5677
5678
5679
5680
5681
5682
5683
5684
5685
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 5673

class AwsIamAccessKeyDetails < Struct.new(
  :user_name,
  :status,
  :created_at,
  :principal_id,
  :principal_type,
  :principal_name,
  :account_id,
  :access_key_id,
  :session_context)
  SENSITIVE = []
  include Aws::Structure
end

#account_idString

The AWS account ID of the account for the key.

Returns:

  • (String)


5673
5674
5675
5676
5677
5678
5679
5680
5681
5682
5683
5684
5685
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 5673

class AwsIamAccessKeyDetails < Struct.new(
  :user_name,
  :status,
  :created_at,
  :principal_id,
  :principal_type,
  :principal_name,
  :account_id,
  :access_key_id,
  :session_context)
  SENSITIVE = []
  include Aws::Structure
end

#created_atString

Indicates when the IAM access key was created.

Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces. For example, 2020-03-22T13:22:13.933Z.

Returns:

  • (String)


5673
5674
5675
5676
5677
5678
5679
5680
5681
5682
5683
5684
5685
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 5673

class AwsIamAccessKeyDetails < Struct.new(
  :user_name,
  :status,
  :created_at,
  :principal_id,
  :principal_type,
  :principal_name,
  :account_id,
  :access_key_id,
  :session_context)
  SENSITIVE = []
  include Aws::Structure
end

#principal_idString

The ID of the principal associated with an access key.

Returns:

  • (String)


5673
5674
5675
5676
5677
5678
5679
5680
5681
5682
5683
5684
5685
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 5673

class AwsIamAccessKeyDetails < Struct.new(
  :user_name,
  :status,
  :created_at,
  :principal_id,
  :principal_type,
  :principal_name,
  :account_id,
  :access_key_id,
  :session_context)
  SENSITIVE = []
  include Aws::Structure
end

#principal_nameString

The name of the principal.

Returns:

  • (String)


5673
5674
5675
5676
5677
5678
5679
5680
5681
5682
5683
5684
5685
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 5673

class AwsIamAccessKeyDetails < Struct.new(
  :user_name,
  :status,
  :created_at,
  :principal_id,
  :principal_type,
  :principal_name,
  :account_id,
  :access_key_id,
  :session_context)
  SENSITIVE = []
  include Aws::Structure
end

#principal_typeString

The type of principal associated with an access key.

Returns:

  • (String)


5673
5674
5675
5676
5677
5678
5679
5680
5681
5682
5683
5684
5685
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 5673

class AwsIamAccessKeyDetails < Struct.new(
  :user_name,
  :status,
  :created_at,
  :principal_id,
  :principal_type,
  :principal_name,
  :account_id,
  :access_key_id,
  :session_context)
  SENSITIVE = []
  include Aws::Structure
end

#session_contextTypes::AwsIamAccessKeySessionContext

Information about the session that the key was used for.



5673
5674
5675
5676
5677
5678
5679
5680
5681
5682
5683
5684
5685
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 5673

class AwsIamAccessKeyDetails < Struct.new(
  :user_name,
  :status,
  :created_at,
  :principal_id,
  :principal_type,
  :principal_name,
  :account_id,
  :access_key_id,
  :session_context)
  SENSITIVE = []
  include Aws::Structure
end

#statusString

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

Returns:

  • (String)


5673
5674
5675
5676
5677
5678
5679
5680
5681
5682
5683
5684
5685
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 5673

class AwsIamAccessKeyDetails < Struct.new(
  :user_name,
  :status,
  :created_at,
  :principal_id,
  :principal_type,
  :principal_name,
  :account_id,
  :access_key_id,
  :session_context)
  SENSITIVE = []
  include Aws::Structure
end

#user_nameString

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:

  • (String)


5673
5674
5675
5676
5677
5678
5679
5680
5681
5682
5683
5684
5685
# File 'gems/aws-sdk-securityhub/lib/aws-sdk-securityhub/types.rb', line 5673

class AwsIamAccessKeyDetails < Struct.new(
  :user_name,
  :status,
  :created_at,
  :principal_id,
  :principal_type,
  :principal_name,
  :account_id,
  :access_key_id,
  :session_context)
  SENSITIVE = []
  include Aws::Structure
end