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

ALIYUN::CloudSSO::UserProvision は、Resource Access Management (RAM) ユーザープロビジョニングを作成するために使用されます。

構文

{
  "Type": "ALIYUN::CloudSSO::UserProvision",
  "Properties": {
    "Description": String,
    "DirectoryId": String,
    "PrincipalId": String,
    "TargetType": String,
    "DuplicationStrategy": String,
    "DeletionStrategy": String,
    "PrincipalType": String,
    "TargetId": String
  }
}

プロパティ

プロパティ	タイプ	必須	編集可能	説明	制約
DeletionStrategy	String	はい	はい	削除ポリシー。	このポリシーを使用して、RAM ユーザープロビジョニングを削除するときに、同期された RAM ユーザーを削除するかどうかを決定できます。有効な値： Delete：RAM ユーザープロビジョニングを削除するときに、同期された RAM ユーザーを削除します。 Keep：RAM ユーザープロビジョニングを削除するときに、同期された RAM ユーザーを保持します。
DirectoryId	String	はい	いいえ	ディレクトリ ID。	なし。
DuplicationStrategy	String	はい	はい	競合処理ポリシー。	このポリシーは、既存の RAM ユーザーのユーザー名が、RAM に同期される CloudSSO ユーザーのユーザー名と同じである場合に使用されます。有効な値： KeepBoth：既存の RAM ユーザーと CloudSSO ユーザーの両方を保持します。既存の RAM ユーザーのユーザー名が、RAM に同期される CloudSSO ユーザーのユーザー名と同じである場合、システムは CloudSSO ユーザーのユーザー名に `_sso` サフィックスを追加して新しい RAM ユーザーを作成します。 TakeOver：既存の RAM ユーザーを CloudSSO ユーザーで置き換えます。既存の RAM ユーザーのユーザー名が、RAM に同期される CloudSSO ユーザーのユーザー名と同じである場合、システムは RAM ユーザーを CloudSSO ユーザーで置き換えます。
PrincipalId	String	はい	いいえ	RAM ユーザープロビジョニングの ID。	有効な値： `PrincipalType` を `Group` に設定する場合は、PrincipalId を g-****** 形式の CloudSSO グループの ID に設定する必要があります。 `PrincipalType` を `User` に設定する場合は、PrincipalId を u-****** 形式の CloudSSO ユーザーの ID に設定する必要があります。
PrincipalType	String	はい	いいえ	RAM ユーザープロビジョニングの ID タイプ。	有効な値： User：CloudSSO ユーザー Group：CloudSSO グループ
TargetId	String	はい	いいえ	RAM ユーザープロビジョニングを作成するオブジェクトの ID。	値は、リソースディレクトリ内のアカウントの ID である必要があります。
TargetType	String	はい	いいえ	RAM ユーザープロビジョニングを作成するオブジェクトのタイプ。	値を `RD-Account` に設定します。
Description	String	いいえ	はい	説明。	なし。

戻り値

Fn::GetAtt

UserProvisionId：RAM ユーザープロビジョニングの ID。

例

`YAML` 形式

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  DeletionStrategy:
    AllowedValues:
    - Delete
    - Keep
    Description:
      ja: '削除ポリシー。RAM ユーザー同期が削除されたときの、同期された RAM ユーザーの処理方法。有効な値：

        - Delete：削除 RAM ユーザー同期が削除されると、Cloud SSO から RAM に同期された RAM ユーザーが削除されます。

        - Keep：RAM ユーザー同期が削除されると、Cloud SSO から RAM に同期された RAM ユーザーが保持されます。'
    Required: true
    Type: String
  Description:
    AssociationProperty: TextArea
    Description:
      ja: ユーザーの説明。
    Required: false
    Type: String
  DirectoryId:
    Description:
      ja: ディレクトリの ID。
    Required: true
    Type: String
  DuplicationStrategy:
    AllowedValues:
    - KeepBoth
    - TakeOver
    Description:
      ja: '競合ポリシー。Cloud SSO ユーザーが RAM に同期されるときに、RAM に同じ名前のユーザーがいる場合の処理方法。有効な値：

        - KeepBoth：両方を保持します。Cloud SSO ユーザーが RAM に同期されるときに、RAM に既に同じ名前のユーザーがいる場合、Cloud SSO ユーザーのユーザー名にサフィックス _sso を追加したユーザー名で RAM ユーザーを作成しようとします。

        - TakeOver：引き継ぎます。Cloud SSO ユーザーが RAM に同期されるときに、RAM に既に同じ名前のユーザーがいる場合、既存の RAM ユーザーは Cloud SSO 同期ユーザーによって直接置き換えられます。'
    Required: true
    Type: String
  PrincipalId:
    Description:
      ja: 'プリンシパルの ID。有効な値：

        - PrincipalType の値が Group の場合、値は Cloud SSO ユーザー グループ ID（g-********）です。

        - PrincipalType の値が User の場合、値は Cloud SSO ユーザー ID（u-********）です。'
    Required: true
    Type: String
  PrincipalType:
    AllowedValues:
    - User
    - Group
    Description:
      ja: 'プリンシパルのタイプ。有効な値：

        - User：プリンシパルは Cloud SSO ユーザーです。

        - Group：プリンシパルは Cloud SSO グループです。'
    Required: true
    Type: String
  TargetId:
    Description:
      ja: RAM ユーザー同期のターゲット ID。現在は、RD アカウント ID です。
    Required: true
    Type: String
  TargetType:
    AllowedValues:
    - RD-Account
    Description:
      ja: RAM ユーザー同期のターゲット タイプ。現在は、RD-Account です。
    Required: true
    Type: String
Resources:
  UserProvision:
    Properties:
      DeletionStrategy:
        Ref: DeletionStrategy
      Description:
        Ref: Description
      DirectoryId:
        Ref: DirectoryId
      DuplicationStrategy:
        Ref: DuplicationStrategy
      PrincipalId:
        Ref: PrincipalId
      PrincipalType:
        Ref: PrincipalType
      TargetId:
        Ref: TargetId
      TargetType:
        Ref: TargetType
    Type: ALIYUN::CloudSSO::UserProvision
Outputs:
  UserProvisionId:
    Description: ユーザー プロビジョニングの ID。
    Value:
      Fn::GetAtt:
      - UserProvision
      - UserProvisionId

`JSON` 形式

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "Description": {
      "AssociationProperty": "TextArea",
      "Type": "String",
      "Description": {
        "ja": "ユーザーの説明。"
      },
      "Required": false
    },
    "DirectoryId": {
      "Type": "String",
      "Description": {
        "ja": "ディレクトリの ID。"
      },
      "Required": true
    },
    "PrincipalId": {
      "Type": "String",
      "Description": {
        "ja": "プリンシパルの ID。有効な値：\n- PrincipalType の値が Group の場合、値は Cloud SSO ユーザー グループ ID（g-********）です。\n- PrincipalType の値が User の場合、値は Cloud SSO ユーザー ID（u-********）です。"
      },
      "Required": true
    },
    "TargetType": {
      "Type": "String",
      "Description": {
        "ja": "RAM ユーザー同期のターゲット タイプ。現在は、RD-Account です。"
      },
      "AllowedValues": [
        "RD-Account"
      ],
      "Required": true
    },
    "DuplicationStrategy": {
      "Type": "String",
      "Description": {
        "ja": "競合ポリシー。Cloud SSO ユーザーが RAM に同期されるときに、RAM に同じ名前のユーザーがいる場合の処理方法。有効な値：\n- KeepBoth：両方を保持します。Cloud SSO ユーザーが RAM に同期されるときに、RAM に既に同じ名前のユーザーがいる場合、Cloud SSO ユーザーのユーザー名にサフィックス _sso を追加したユーザー名で RAM ユーザーを作成しようとします。\n- TakeOver：引き継ぎます。Cloud SSO ユーザーが RAM に同期されるときに、RAM に既に同じ名前のユーザーがいる場合、既存の RAM ユーザーは Cloud SSO 同期ユーザーによって直接置き換えられます。"
      },
      "AllowedValues": [
        "KeepBoth",
        "TakeOver"
      ],
      "Required": true
    },
    "DeletionStrategy": {
      "Type": "String",
      "Description": {
        "ja": "削除ポリシー。RAM ユーザー同期が削除されたときの、同期された RAM ユーザーの処理方法。有効な値：\n- Delete：削除 RAM ユーザー同期が削除されると、Cloud SSO から RAM に同期された RAM ユーザーが削除されます。\n- Keep：RAM ユーザー同期が削除されると、Cloud SSO から RAM に同期された RAM ユーザーが保持されます。"
      },
      "AllowedValues": [
        "Delete",
        "Keep"
      ],
      "Required": true
    },
    "PrincipalType": {
      "Type": "String",
      "Description": {
        "ja": "プリンシパルのタイプ。有効な値：\n- User：プリンシパルは Cloud SSO ユーザーです。\n- Group：プリンシパルは Cloud SSO グループです。"
      },
      "AllowedValues": [
        "User",
        "Group"
      ],
      "Required": true
    },
    "TargetId": {
      "Type": "String",
      "Description": {
        "ja": "RAM ユーザー同期のターゲット ID。現在は、RD アカウント ID です。"
      },
      "Required": true
    }
  },
  "Resources": {
    "UserProvision": {
      "Type": "ALIYUN::CloudSSO::UserProvision",
      "Properties": {
        "Description": {
          "Ref": "Description"
        },
        "DirectoryId": {
          "Ref": "DirectoryId"
        },
        "PrincipalId": {
          "Ref": "PrincipalId"
        },
        "TargetType": {
          "Ref": "TargetType"
        },
        "DuplicationStrategy": {
          "Ref": "DuplicationStrategy"
        },
        "DeletionStrategy": {
          "Ref": "DeletionStrategy"
        },
        "PrincipalType": {
          "Ref": "PrincipalType"
        },
        "TargetId": {
          "Ref": "TargetId"
        }
      }
    }
  },
  "Outputs": {
    "UserProvisionId": {
      "Description": "ユーザー プロビジョニングの ID。",
      "Value": {
        "Fn::GetAtt": [
          "UserProvision",
          "UserProvisionId"
        ]
      }
    }
  }
}

構文

プロパティ

戻り値

例

YAML 形式

JSON 形式

`YAML` 形式

`JSON` 形式