ALIYUN::RAM::LoginProfile - Resource Orchestration Service

ALIYUN::RAM::LoginProfile is used to create logon configurations for a Resource Access Management (RAM) user.

Syntax

{
  "Type": "ALIYUN::RAM::LoginProfile",
  "Properties": {
    "UserPrincipalName": String,
    "GenerateRandomPassword": Boolean,
    "MFABindRequired": Boolean,
    "PasswordResetRequired": Boolean,
    "Password": String,
    "Status": String
  }
}

Properties

Property	Type	Required	Editable	Description	Constraint
UserPrincipalName	String	Yes	No	The logon name of the RAM user.	None.
GenerateRandomPassword	Boolean	No	Yes	Specifies whether to generate a random password for the RAM user.	None.
MFABindRequired	Boolean	No	Yes	Specifies whether to forcefully enable multi-factor authentication (MFA) for the RAM user.	Valid values: true: forcefully enables MFA for the RAM user. The RAM user must bind an MFA device at the next logon. false (default): does not forcefully enable MFA for the RAM user.
PasswordResetRequired	Boolean	No	Yes	Specifies whether the RAM user is required to reset the password at the next logon.	None.
Password	String	No	Yes	The password that the RAM user uses to log on to the console.	None.
Status	String	No	Yes	Specifies whether to enable password-based logons to the console.	Valid values: Active (default): enables password-based logons to the console. Inactive: disables password-based logons to the console.

Return values

Fn::GetAtt

Password: the password that the RAM user uses to log on to the console.

Examples

YAML format

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  UserPrincipalName:
    Type: String
    Description:
      en: The login name of the RAM user.
    Required: true
  GenerateRandomPassword:
    Type: Boolean
    Description:
      en: Whether to generate a random password for the RAM user.
    Required: true
Resources:
  LoginProfile:
    Type: ALIYUN::RAM::LoginProfile
    Properties:
      UserPrincipalName:
        Ref: UserPrincipalName
      GenerateRandomPassword:
        Ref: GenerateRandomPassword
Outputs:
  Password:
    Description: The password of the RAM user.
    Value:
      Fn::GetAtt:
        - LoginProfile
        - Password

JSON format

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "UserPrincipalName": {
      "Type": "String",
      "Description": {
        "en": "The login name of the RAM user."
      },
      "Required": true
    },
    "GenerateRandomPassword": {
      "Type": "Boolean",
      "Description": {
        "en": "Whether to generate a random password for the RAM user."
      },
      "Required": true
    }
  },
  "Resources": {
    "LoginProfile": {
      "Type": "ALIYUN::RAM::LoginProfile",
      "Properties": {
        "UserPrincipalName": {
          "Ref": "UserPrincipalName"
        },
        "GenerateRandomPassword": {
          "Ref": "GenerateRandomPassword"
        }
      }
    }
  },
  "Outputs": {
    "Password": {
      "Description": "The password of the RAM user.",
      "Value": {
        "Fn::GetAtt": [
          "LoginProfile",
          "Password"
        ]
      }
    }
  }
}