ALIYUN::CloudSSO::User リソースタイプ - Resource Orchestration Service

ALIYUN::CloudSSO::User は、ユーザーを作成するために使用されます。

構文

{
  "Type": "ALIYUN::CloudSSO::User",
  "Properties": {
    "Status": String,
    "UserName": String,
    "DirectoryId": String,
    "Description": String,
    "Email": String,
    "FirstName": String,
    "DisplayName": String,
    "LastName": String
  }
}

プロパティ

プロパティ	タイプ	必須	編集可能	説明	制約
DirectoryId	String	はい	いいえ	ディレクトリ ID。	なし。
UserName	String	はい	いいえ	ユーザー名。	ユーザー名は、ディレクトリ内で一意である必要があります。変更することはできません。数字、文字、および次の特殊文字を含めることができます：`@ _ - .`。最大 64 文字まで使用できます。
Description	String	いいえ	はい	ユーザーの説明。	説明は最大 1,024 文字まで使用できます。
DisplayName	String	いいえ	はい	ユーザーの表示名。	表示名は最大 256 文字まで使用できます。
Email	String	いいえ	はい	ユーザーのメールアドレス。	メールアドレスは、ディレクトリ内で一意である必要があります。最大 128 文字まで使用できます。
FirstName	String	いいえ	はい	ユーザーの名。	名は最大 64 文字まで使用できます。
LastName	String	いいえ	はい	ユーザーの姓。	姓は最大 64 文字まで使用できます。
Status	String	いいえ	はい	ユーザーのステータス。	有効な値： Enabled (デフォルト) Disabled

戻り値

Fn::GetAtt

UserId: ユーザー ID。

例

`YAML` フォーマット

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  Description:
    AssociationProperty: TextArea
    Description:
      ja: 'ユーザーの説明。

        説明は最大 1,024 文字まで使用できます。'
    MaxLength: 1024
    Required: false
    Type: String
  DirectoryId:
    Description:
      ja: ディレクトリの ID。
    Required: true
    Type: String
  DisplayName:
    Description:
      ja: 'ユーザーの表示名。

        名前は最大 256 文字まで使用できます。'
    MaxLength: 256
    Required: false
    Type: String
  Email:
    Description:
      ja: 'ユーザーのメールアドレス。メールアドレスは、ディレクトリ内で一意である必要があります。

        メールアドレスは最大 128 文字まで使用できます。'
    MaxLength: 128
    Required: false
    Type: String
  FirstName:
    Description:
      ja: 'ユーザーの名。
        名前は最大 64 文字まで使用できます。'
    MaxLength: 64
    Required: false
    Type: String
  LastName:
    Description:
      ja: 'ユーザーの姓。
        名前は最大 64 文字まで使用できます。'
    MaxLength: 64
    Required: false
    Type: String
  Status:
    AllowedValues:
    - Enabled
    - Disabled
    Description:
      ja: 'ユーザーのステータス。有効な値：

        - Enabled: ユーザーのログインが有効になっています。これはデフォルト値です。

        - Disabled: ユーザーのログインが無効になっています。'
    Required: false
    Type: String
  UserName:
    AllowedPattern: ^[a-zA-Z0-9@._-]{1,64}$
    Description:
      ja: 'ユーザーの名前。名前は、ディレクトリ内で一意である必要があります。名前は変更できません。

        名前には、数字、文字、および次の特殊文字を含めることができます：@_-.

        名前は最大 64 文字まで使用できます。'
    Required: true
    Type: String
Resources:
  User:
    Properties:
      Description:
        Ref: Description
      DirectoryId:
        Ref: DirectoryId
      DisplayName:
        Ref: DisplayName
      Email:
        Ref: Email
      FirstName:
        Ref: FirstName
      LastName:
        Ref: LastName
      Status:
        Ref: Status
      UserName:
        Ref: UserName
    Type: ALIYUN::CloudSSO::User
Outputs:
  UserId:
    Description: ユーザーの ID。
    Value:
      Fn::GetAtt:
      - User
      - UserId

`JSON` フォーマット

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "Status": {
      "Type": "String",
      "Description": {
        "ja": "ユーザーのステータス。有効な値：\n- Enabled: ユーザーのログインが有効になっています。これはデフォルト値です。\n- Disabled: ユーザーのログインが無効になっています。"
      },
      "AllowedValues": [
        "Enabled",
        "Disabled"
      ],
      "Required": false
    },
    "UserName": {
      "Type": "String",
      "Description": {
        "ja": "ユーザーの名前。名前は、ディレクトリ内で一意である必要があります。名前は変更できません。\n名前には、数字、文字、および次の特殊文字を含めることができます：@_ - .\n名前は最大 64 文字まで使用できます。"
      },
      "AllowedPattern": "^[a-zA-Z0-9@._-]{1,64}$",
      "Required": true
    },
    "DirectoryId": {
      "Type": "String",
      "Description": {
        "ja": "ディレクトリの ID。"
      },
      "Required": true
    },
    "Description": {
      "AssociationProperty": "TextArea",
      "Type": "String",
      "Description": {
        "ja": "ユーザーの説明。\n説明は最大 1,024 文字まで使用できます。"
      },
      "Required": false,
      "MaxLength": 1024
    },
    "Email": {
      "Type": "String",
      "Description": {
        "ja": "ユーザーのメールアドレス。メールアドレスは、ディレクトリ内で一意である必要があります。\nメールアドレスは最大 128 文字まで使用できます。"
      },
      "Required": false,
      "MaxLength": 128
    },
    "FirstName": {
      "Type": "String",
      "Description": {
        "ja": "ユーザーの名。\n名前は最大 64 文字まで使用できます。"
      },
      "Required": false,
      "MaxLength": 64
    },
    "DisplayName": {
      "Type": "String",
      "Description": {
        "ja": "ユーザーの表示名。\n名前は最大 256 文字まで使用できます。"
      },
      "Required": false,
      "MaxLength": 256
    },
    "LastName": {
      "Type": "String",
      "Description": {
        "ja": "ユーザーの姓。\n名前は最大 64 文字まで使用できます。"
      },
      "Required": false,
      "MaxLength": 64
    }
  },
  "Resources": {
    "User": {
      "Type": "ALIYUN::CloudSSO::User",
      "Properties": {
        "Status": {
          "Ref": "Status"
        },
        "UserName": {
          "Ref": "UserName"
        },
        "DirectoryId": {
          "Ref": "DirectoryId"
        },
        "Description": {
          "Ref": "Description"
        },
        "Email": {
          "Ref": "Email"
        },
        "FirstName": {
          "Ref": "FirstName"
        },
        "DisplayName": {
          "Ref": "DisplayName"
        },
        "LastName": {
          "Ref": "LastName"
        }
      }
    }
  },
  "Outputs": {
    "UserId": {
      "Description": "ユーザーの ID。",
      "Value": {
        "Fn::GetAtt": [
          "User",
          "UserId"
        ]
      }
    }
  }
}

構文

プロパティ

戻り値

例

YAML フォーマット

JSON フォーマット

`YAML` フォーマット

`JSON` フォーマット