All Products
Search
Document Center

Resource Orchestration Service:DATASOURCE::RAM::User

Last Updated:Sep 30, 2024

DATASOURCE::RAM::User is used to query the information about a Resource Access Management (RAM) user.

Syntax

{
  "Type": "DATASOURCE::RAM::User",
  "Properties": {
    "UserName": String,
    "UserId": String
  }
}

Properties

Property

Type

Required

Editable

Description

Constraint

UserName

String

No

Yes

The logon name of the RAM user.

None.

UserId

String

No

Yes

The ID of the RAM user.

None.

Return values

Fn::GetAtt

  • UserName: the logon name of the RAM user.

  • Email: the email address of the RAM user.

  • UserId: the ID of the RAM user.

  • Comments: the comments.

  • DisplayName: the display name of the RAM user.

  • MobilePhone: the phone number of the RAM user.

Examples

  • YAML format

    ROSTemplateFormatVersion: '2015-09-01'
    Parameters:
      UserName:
        Type: String
        Description:
          en: RAM user name. At most one UserName and UserId can be specified; if both are specified, UserName will be used. If neither is specified, the current user ID will be used.
        Required: false
      UserId:
        Type: String
        Description:
          en: RAM user ID. At most one UserName and UserId can be specified; if both are specified, UserName will be used. If neither is specified, the current user ID will be used.
        Required: false
    Resources:
      User:
        Type: DATASOURCE::RAM::User
        Properties:
          UserName:
            Ref: UserName
          UserId:
            Ref: UserId
    Outputs:
      UserName:
        Description: The name of the RAM user.
        Value:
          Fn::GetAtt:
            - User
            - UserName
      Email:
        Description: The email address of the RAM user.
        Value:
          Fn::GetAtt:
            - User
            - Email
      UserId:
        Description: The ID of the RAM user.
        Value:
          Fn::GetAtt:
            - User
            - UserId
      Comments:
        Description: The comments of the RAM user.
        Value:
          Fn::GetAtt:
            - User
            - Comments
      DisplayName:
        Description: The display name of the RAM user.
        Value:
          Fn::GetAtt:
            - User
            - DisplayName
      MobilePhone:
        Description: The mobile phone number of the RAM user.
        Value:
          Fn::GetAtt:
            - User
            - MobilePhone
    
  • JSON format

    {
      "ROSTemplateFormatVersion": "2015-09-01",
      "Parameters": {
        "UserName": {
          "Type": "String",
          "Description": {
            "en": "RAM user name. At most one UserName and UserId can be specified; if both are specified, UserName will be used. If neither is specified, the current user ID will be used."
          },
          "Required": false
        },
        "UserId": {
          "Type": "String",
          "Description": {
            "en": "RAM user ID. At most one UserName and UserId can be specified; if both are specified, UserName will be used. If neither is specified, the current user ID will be used."
          },
          "Required": false
        }
      },
      "Resources": {
        "User": {
          "Type": "DATASOURCE::RAM::User",
          "Properties": {
            "UserName": {
              "Ref": "UserName"
            },
            "UserId": {
              "Ref": "UserId"
            }
          }
        }
      },
      "Outputs": {
        "UserName": {
          "Description": "The name of the RAM user.",
          "Value": {
            "Fn::GetAtt": [
              "User",
              "UserName"
            ]
          }
        },
        "Email": {
          "Description": "The email address of the RAM user.",
          "Value": {
            "Fn::GetAtt": [
              "User",
              "Email"
            ]
          }
        },
        "UserId": {
          "Description": "The ID of the RAM user.",
          "Value": {
            "Fn::GetAtt": [
              "User",
              "UserId"
            ]
          }
        },
        "Comments": {
          "Description": "The comments of the RAM user.",
          "Value": {
            "Fn::GetAtt": [
              "User",
              "Comments"
            ]
          }
        },
        "DisplayName": {
          "Description": "The display name of the RAM user.",
          "Value": {
            "Fn::GetAtt": [
              "User",
              "DisplayName"
            ]
          }
        },
        "MobilePhone": {
          "Description": "The mobile phone number of the RAM user.",
          "Value": {
            "Fn::GetAtt": [
              "User",
              "MobilePhone"
            ]
          }
        }
      }
    }