ALIYUN::PAIPlugin::Group リソースのプロパティと構文 - Resource Orchestration Service

ALIYUN::PAIPlugin::Group は、ユーザーグループを作成するために使用されます。

構文

{
  "Type": "ALIYUN::PAIPlugin::Group",
  "Properties": {
    "Name": String,
    "Source": Integer,
    "Algorithm": String,
    "Column": String,
    "Filter": String,
    "InferenceJobId": String,
    "Project": String,
    "PhoneNumber": String,
    "Remark": String,
    "Table": String,
    "Text": String,
    "Uri": String
  }
}

プロパティ

プロパティ	タイプ	必須	編集可能	説明	制約
Name	String	はい	いいえ	ユーザーグループの名前。	なし。
Source	Integer	はい	いいえ	ユーザーグループのソース。	有効な値: 0: テキスト。各行に電話番号が 1 つずつ含まれます。最大 100 件の電話番号がサポートされています。 1: テキストファイル。各行に電話番号が 1 つずつ含まれます。テキストファイルを使用するには、コンソールでファイルをアップロードするか、カスタムの Object Storage Service (OSS) アドレスを指定します。カスタム OSS アドレスを指定する前に、コンソールで権限付与が完了していることを確認してください。 2: CSV ファイル。電話番号の列名を指定する必要があります。CSV ファイルを使用するには、コンソールでファイルをアップロードするか、カスタムの OSS アドレスを指定します。カスタム OSS アドレスを指定する前に、コンソールで権限付与が完了していることを確認してください。 3: MaxCompute テーブル。電話番号の列名を指定する必要があります。 4: アルゴリズム。
Algorithm	String	いいえ	いいえ	関連付けられているアルゴリズム。	このプロパティは、Source が 4 に設定されている場合に指定する必要があります。
Column	String	いいえ	いいえ	電話番号の列名。	このプロパティは、Source が 2 または 3 に設定されていて、電話番号が含まれている場合に指定する必要があります。
Filter	String	いいえ	いいえ	フィルター条件。	このプロパティは、Source が 3 に設定されている場合に指定する必要があります。
InferenceJobId	String	いいえ	いいえ	予測ジョブの ID。	このプロパティは、Source が 4 に設定されている場合に指定する必要があります。
Project	String	いいえ	いいえ	MaxCompute プロジェクトの名前。	このプロパティは、Source が 3 に設定されている場合に指定する必要があります。
PhoneNumber	String	いいえ	いいえ	電話番号を含めるかどうかを指定します。	ユーザーグループの電話番号が含まれている場合、そのユーザーグループをリーチプランに使用できます。
Remark	String	いいえ	いいえ	ユーザーグループに関する注釈。	なし。
Table	String	いいえ	いいえ	MaxCompute テーブルの名前。	このプロパティは、Source が 3 に設定されている場合に指定する必要があります。
Text	String	いいえ	いいえ	テキスト。	このプロパティは、Source が 1 に設定されている場合に指定する必要があります。
Uri	String	いいえ	いいえ	ファイルアドレス。	このプロパティは、Source が 1 または 2 に設定されている場合に指定する必要があります。

戻り値

Fn::GetAtt

CreatedTime: 作成時間。時間は UTC + 08:00 で表示されます。
Amount: ユーザーグループ内のユーザー数。
Id: ユーザーグループの ID。
Name: ユーザーグループの名前。

例

YAML

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  PhoneNumber:
    Type: String
    Description:
      ja: 携帯電話番号を含めるかどうか。携帯電話番号を持つユーザーは、リーチプランに使用できます。
    Required: false
  Text:
    Type: String
    Description:
      ja: 電話番号のテキスト。Source が 0（電話番号を入力）の場合に指定する必要があります。
    Required: false
  Source:
    Type: Number
    Description:
      ja: |-
        クラウドソース。有効な値:
        0: 電話番号を入力。
        1: 単一列 CSV ファイル（電話番号）。
        2: 複数列 CSV ファイル。
        3: MaxCompute テーブル。
        4: アルゴリズム。
    AllowedValues:
      - 0
      - 1
      - 2
      - 3
      - 4
    Required: true
  Name:
    Type: String
    Description:
      ja: ユーザーグループの名前。
    Required: true
Resources:
  ExtensionResource:
    Type: ALIYUN::PAIPlugin::Group
    Properties:
      PhoneNumber:
        Ref: PhoneNumber
      Text:
        Ref: Text
      Source:
        Ref: Source
      Name:
        Ref: Name
Outputs:
  CreatedTime:
    Description: ユーザーグループの作成時間。
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - CreatedTime
  Amount:
    Description: ユーザーグループの数。
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - Amount
  Id:
    Description: ユーザーグループの ID。
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - Id
  Name:
    Description: ユーザーグループの名前。
    Value:
      Fn::GetAtt:
        - ExtensionResource
        - Name

JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "PhoneNumber": {
      "Type": "String",
      "Description": {
        "ja": "携帯電話番号を含めるかどうか。携帯電話番号を持つユーザーは、リーチプランに使用できます。"
      },
      "Required": false
    },
    "Text": {
      "Type": "String",
      "Description": {
        "ja": "電話番号のテキスト。Source が 0（電話番号を入力）の場合に指定する必要があります。"
      },
      "Required": false
    },
    "Source": {
      "Type": "Number",
      "Description": {
        "ja": "クラウドソース。有効な値:\n0: 電話番号を入力。\n1: 単一列 CSV ファイル（電話番号）。\n2: 複数列 CSV ファイル。\n3: MaxCompute テーブル。\n4: アルゴリズム。"
      },
      "AllowedValues": [
        0,
        1,
        2,
        3,
        4
      ],
      "Required": true
    },
    "Name": {
      "Type": "String",
      "Description": {
        "ja": "ユーザーグループの名前。"
      },
      "Required": true
    }
  },
  "Resources": {
    "ExtensionResource": {
      "Type": "ALIYUN::PAIPlugin::Group",
      "Properties": {
        "PhoneNumber": {
          "Ref": "PhoneNumber"
        },
        "Text": {
          "Ref": "Text"
        },
        "Source": {
          "Ref": "Source"
        },
        "Name": {
          "Ref": "Name"
        }
      }
    }
  },
  "Outputs": {
    "CreatedTime": {
      "Description": "ユーザーグループの作成時間。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "CreatedTime"
        ]
      }
    },
    "Amount": {
      "Description": "ユーザーグループの数。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "Amount"
        ]
      }
    },
    "Id": {
      "Description": "ユーザーグループの ID。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "Id"
        ]
      }
    },
    "Name": {
      "Description": "ユーザーグループの名前。",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionResource",
          "Name"
        ]
      }
    }
  }
}