ALIYUN::RAM::Application リソースタイプ - ROS

ALIYUN::RAM::Application は、アプリケーションを作成するために使用されます。

構文

{
  "Type": "ALIYUN::RAM::Application",
  "Properties": {
    "PredefinedScopes": List,
    "SecretRequired": Boolean,
    "DisplayName": String,
    "IsMultiTenant": Boolean,
    "AccessTokenValidity": Integer,
    "RedirectUris": List,
    "RefreshTokenValidity": Integer,
    "AppType": String,
    "AppName": String,
    "RequiredScopes": List
  }
}

プロパティ

プロパティ	タイプ	必須	編集可能	説明	制約
PredefinedScopes	List	いいえ	はい	アプリケーションの権限範囲。	権限範囲の有効な値と説明については、「概要」をご参照ください。 ListPredefinedScopes 操作を呼び出して、さまざまな種類のアプリケーションでサポートされている権限範囲をクエリすることもできます。複数の権限範囲を指定する場合は、セミコロン（;）で区切ります。
SecretRequired	Boolean	いいえ	はい	シークレットが必要かどうかを指定します。	有効な値： true false 説明 WebApp タイプおよび ServerApp タイプのアプリケーションの場合、このプロパティは強制的に true に設定され、変更できません。 NativeApp タイプのアプリケーションの場合、このプロパティは true または false に設定できます。このプロパティを空のままにすると、デフォルト値は false になります。ほとんどの場合、NativeApp タイプのアプリケーションは信頼されていない環境で実行され、アプリケーションのシークレットは保護されない可能性があります。したがって、特に指定のない限り、このプロパティを true に設定しないことをお勧めします。詳細については、「ネイティブアプリケーションから Alibaba Cloud API にアクセスする」をご参照ください。
DisplayName	String	はい	はい	アプリケーションの表示名。	表示名は最大 24 文字まで入力できます。
IsMultiTenant	Boolean	いいえ	はい	アプリケーションを他の Alibaba Cloud アカウントを使用してインストールできるかどうかを指定します。	有効な値： true: NativeApp タイプおよび ServerApp タイプのアプリケーションでこのプロパティを空のままにすると、デフォルト値は true になります。 false: WebApp タイプのアプリケーションでこのプロパティを空のままにすると、デフォルト値は false になります。
AccessTokenValidity	Integer	いいえ	はい	アクセストークンの有効期間。	有効な値：900 ～ 10800 。単位：秒。デフォルト値：3600。
RedirectUris	List	いいえ	はい	コールバック URL 。	なし
RefreshTokenValidity	Integer	いいえ	はい	更新されたトークンの有効期間。	有効な値：7200 ～ 31536000 。単位：秒。デフォルト値： NativeApp タイプおよび ServerApp タイプのアプリケーションでこのプロパティを空のままにすると、デフォルト値は 2592000 になります。値 2592000 は、更新されたトークンの有効期間が 30 日であることを指定します。 WebApp タイプのアプリケーションでこのプロパティを空のままにすると、デフォルト値は 7776000 になります。値 7776000 は、更新されたトークンの有効期間が 90 日であることを指定します。
AppType	String	はい	いいえ	アプリケーションタイプ。	有効な値： WebApp: Web アプリケーション。 NativeApp: デスクトップ OS やモバイル OS など、OS 上で実行されるネイティブアプリケーション。 ServerApp: ユーザーが手動でログインしなくても Alibaba Cloud サービスにアクセスできるアプリケーション。System for Cross-domain Identity Management（SCIM）プロトコルに基づいてユーザー情報を同期するアプリケーションのみがサポートされています。
AppName	String	はい	いいえ	アプリケーション名。	名前は最大 64 文字で、文字、数字、ピリオド（.）、アンダースコア（_）、ハイフン（-）を含めることができます。
RequiredScopes	List	いいえ	はい	必要な権限。	`RequiredScopes` プロパティを使用して、1 つ以上の権限を指定できます。このプロパティを指定すると、必要な権限が自動的に選択され、ユーザーがアプリケーションに権限を付与したときに取り消すことができなくなります。説明このプロパティは、`RequiredScopes` で指定された権限が、`PredefinedScopes` で指定された権限範囲に含まれている場合にのみ有効になります。

戻り値

Fn::GetAtt

AppId: アプリケーション ID 。
AppName: アプリケーション名。

例

YAML フォーマット

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  DisplayName:
    Type: String
    MaxLength: 24
    Default: myapp
  AppType:
    Type: String
    Description: |-
      アプリケーションのタイプ。有効な値：
      - **WebApp**: ブラウザと対話する Web アプリケーション。
      - **NativeApp**: デスクトップ オペレーティング システムやモバイル オペレーティング システムなど、オペレーティング システム上で実行されるネイティブ アプリケーション。
      - **ServerApp**: ユーザーが手動でログインしなくても Alibaba Cloud サービスにアクセスできるアプリケーション。ユーザー プロビジョニングは、System for Cross-Domain Identity Management（SCIM）プロトコルに基づいて自動化されます。
    Default: WebApp
  AppName:
    Type: String
    Description: アプリケーションの名前。名前は最大 64 文字まで入力できます。名前には、文字、数字、ピリオド（.）、アンダースコア（_）、ハイフン（-）を含めることができます。
    AllowedPattern: ^[-_.a-zA-Z0-9]{1,64}$
    Default: myapp
Resources:
  Application:
    Type: ALIYUN::RAM::Application
    Properties:
      DisplayName:
        Ref: DisplayName
      AppType:
        Ref: AppType
      AppName:
        Ref: AppName
Outputs:
  AppId:
    Description: アプリケーションの ID 。
    Value:
      Fn::GetAtt:
        - Application
        - AppId
  AppName:
    Description: アプリケーションの名前。
    Value:
      Fn::GetAtt:
        - Application
        - AppName

JSON フォーマット

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "DisplayName": {
      "Type": "String",
      "MaxLength": 24,
      "Default": "myapp"
    },
    "AppType": {
      "Type": "String",
      "Description": "アプリケーションのタイプ。有効な値：\n- **WebApp**: ブラウザと対話する Web アプリケーション。\n- **NativeApp**: デスクトップ オペレーティング システムやモバイル オペレーティング システムなど、オペレーティング システム上で実行されるネイティブ アプリケーション。\n- **ServerApp**: ユーザーが手動でログインしなくても Alibaba Cloud サービスにアクセスできるアプリケーション。ユーザー プロビジョニングは、System for Cross-Domain Identity Management（SCIM）プロトコルに基づいて自動化されます。",
      "Default": "WebApp"
    },
    "AppName": {
      "Type": "String",
      "Description": "アプリケーションの名前。名前は最大 64 文字まで入力できます。名前には、文字、数字、ピリオド（.）、アンダースコア（_）、ハイフン（-）を含めることができます。",
      "AllowedPattern": "^[-_.a-zA-Z0-9]{1,64}$",
      "Default": "myapp"
    }
  },
  "Resources": {
    "Application": {
      "Type": "ALIYUN::RAM::Application",
      "Properties": {
        "DisplayName": {
          "Ref": "DisplayName"
        },
        "AppType": {
          "Ref": "AppType"
        },
        "AppName": {
          "Ref": "AppName"
        }
      }
    }
  },
  "Outputs": {
    "AppId": {
      "Description": "アプリケーションの ID 。",
      "Value": {
        "Fn::GetAtt": [
          "Application",
          "AppId"
        ]
      }
    },
    "AppName": {
      "Description": "アプリケーションの名前。",
      "Value": {
        "Fn::GetAtt": [
          "Application",
          "AppName"
        ]
      }
    }
  }
}