awsuser : AWS User object.

An AWS user object represents a specific access key and secret key pair credentials of an AWS user.

Object Reference

References to awsuser are object references.

The name part of the name server group object reference has the following components:

  • Access key ID of the AWS user

Example: awsuser/ZG5zLmJpbmRfY25h:AKIAIY5E3YKTIIDGJKKQ

Restrictions

The object does not support the following operations:

  • Scheduling
  • CSV export

The object cannot be managed on Cloud Platform members.

Fields

These fields are actual members of the object; thus, they can be requested by using _return_fields, if the fields are readable.

The basic version of the object contains the field(s): access_key_id, account_id, govcloud_enabled, name.

The following fields are required to create this object:

Field Notes
access_key_id  
account_id  
name  
secret_access_key  

access_key_id

access_key_id

The unique Access Key ID of this AWS user. Maximum 255 characters.

Type

String.

Values with leading or trailing white space are not valid for this field.

Create

The field is required on creation.

Search

The field is available for search via

  • ‘=’ (exact equality)

Notes

The access_key_id is part of the base object.

account_id

account_id

The AWS Account ID of this AWS user. Maximum 64 characters.

Type

String.

Create

The field is required on creation.

Search

The field is available for search via

  • ‘=’ (exact equality)

Notes

The account_id is part of the base object.

govcloud_enabled

govcloud_enabled

Indicates if gov cloud is enabled or disabled.

Type

Bool.

Create

The default value is False.

Search

The field is available for search via

  • ‘=’ (exact equality)

Notes

The govcloud_enabled is part of the base object.

last_used

last_used

The timestamp when this AWS user credentials was last used.

Type

Timestamp.

Search

The field is not available for search.

Notes

The last_used cannot be updated.

last_used cannot be written.

name

name

The AWS user name. Maximum 64 characters.

Type

String.

Create

The field is required on creation.

Search

The field is available for search via

  • ‘:=’ (case insensitive search)
  • ‘=’ (exact equality)
  • ‘~=’ (regular expression)

Notes

The name is part of the base object.

nios_user_name

nios_user_name

The NIOS user name mapped to this AWS user. Maximum 64 characters.

Type

String.

Create

The default value is undefined.

Search

The field is available for search via

  • ‘:=’ (case insensitive search)
  • ‘=’ (exact equality)
  • ‘~=’ (regular expression)

secret_access_key

secret_access_key

The Secret Access Key for the Access Key ID of this user. Maximum 255 characters.

Type

String.

Values with leading or trailing white space are not valid for this field.

Create

The field is required on creation.

Search

The field is not available for search.

Notes

secret_access_key is not readable.

status

status

Indicate the validity status of this AWS user.

Type

String.

Valid values are:
  • SUCCESSFUL
  • UNSUCCESSFUL
  • UNUSED

Search

The field is available for search via

  • ‘=’ (exact equality)

Notes

The status cannot be updated.

status cannot be written.

Fields List

Field Type Req R/O Base Search
access_key_id String Y N Y =
account_id String Y N Y =
govcloud_enabled Bool N N Y =
last_used Timestamp N Y N N/A
name String Y N Y : = ~
nios_user_name String N N N : = ~
secret_access_key String Y N N N/A
status String N Y N =