Use DATASOURCE::RAM::Users to query information about RAM users - Resource Orchestration Service

Syntax

{
  "Type": "DATASOURCE::RAM::Users",
  "Properties": {
    "GroupName": String,
    "UserName": String,
    "RefreshOptions": String
  }
}

Properties

Property	Type	Required	Editable	Description	Constraint
GroupName	String	No	Yes	The user group name.	None.
UserName	String	No	Yes	The RAM user name.	Supports the asterisk (`*`) and question mark (`?`) wildcard characters for fuzzy matching.
RefreshOptions	String	No	Yes	The data source refresh policy on stack update.	Valid values: Never (default): Does not refresh data source resources on stack update. Always: Refreshes data source resources on stack update.

Return values (Fn::GetAtt)

UserNames: the RAM user names.
Users: the details of RAM users.

Property	Type	Description	Constraint
UserNames	List	The RAM user names.	None.
Users	List	The details of RAM users.	None.
DisplayName	String	The RAM user display name.	None.
UserId	String	The RAM user ID.	None.
Comments	String	The remarks of the RAM user.	None.
CreateDate	String	The time when the RAM user was created, in UTC.	None.
UserName	String	The RAM user name.	None.

Examples

JSON format

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "UserName": {
      "Type": "String",
      "Description": "Filter the results by a specific user name. Supports using * and ?  to fuzzy match.",
      "Default": "test*"
    }
  },
  "Resources": {
    "Users": {
      "Type": "DATASOURCE::RAM::Users",
      "Properties": {
        "UserName": {
          "Ref": "UserName"
        }
      }
    }
  },
  "Outputs": {
    "UserNames": {
      "Description": "The list of user names.",
      "Value": {
        "Fn::GetAtt": [
          "Users",
          "UserNames"
        ]
      }
    },
    "Users": {
      "Description": "The list of users.",
      "Value": {
        "Fn::GetAtt": [
          "Users",
          "Users"
        ]
      }
    }
  }
}