ALIYUN::AppFlow::UserAuthConfig - Resource Orchestration Service

ALIYUN::AppFlow::UserAuthConfig is used to create configurations for a user credential.

Syntax

{
  "Type": "ALIYUN::AppFlow::UserAuthConfig",
  "Properties": {
    "AuthConfig": Map,
    "AuthConfigName": String,
    "ConnectorId": String
  }
}

Properties

Property	Type	Required	Editable	Description	Constraint
AuthConfig	Map	Yes	Yes	The configurations of the credential.	None.
AuthConfigName	String	Yes	Yes	The name of the credential.	None.
ConnectorId	String	Yes	No	The ID of the connector.	None.

Return values

Fn::GetAtt

AuthConfig: the configurations of the credential.
AuthConfigId: the ID of the credential.

Examples

YAML

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  AuthConfig:
    Type: Json
    Description:
      en: AuthConfig
    Required: true
  AuthConfigName:
    Type: String
    Description:
      en: The name of the config.
    Required: true
  ConnectorId:
    Type: String
    Description:
      en: The id of connector.
    Required: true
Resources:
  UserAuthConfig:
    Type: ALIYUN::AppFlow::UserAuthConfig
    Properties:
      AuthConfig:
        Ref: AuthConfig
      AuthConfigName:
        Ref: AuthConfigName
      ConnectorId:
        Ref: ConnectorId
Outputs:
  AuthConfig:
    Description: AuthConfig
    Value:
      Fn::GetAtt:
        - UserAuthConfig
        - AuthConfig
  AuthConfigId:
    Description: The id of the config.
    Value:
      Fn::GetAtt:
        - UserAuthConfig
        - AuthConfigId

JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "AuthConfig": {
      "Type": "Json",
      "Description": {
        "en": "AuthConfig"
      },
      "Required": true
    },
    "AuthConfigName": {
      "Type": "String",
      "Description": {
        "en": "The name of the config."
      },
      "Required": true
    },
    "ConnectorId": {
      "Type": "String",
      "Description": {
        "en": "The id of connector."
      },
      "Required": true
    }
  },
  "Resources": {
    "UserAuthConfig": {
      "Type": "ALIYUN::AppFlow::UserAuthConfig",
      "Properties": {
        "AuthConfig": {
          "Ref": "AuthConfig"
        },
        "AuthConfigName": {
          "Ref": "AuthConfigName"
        },
        "ConnectorId": {
          "Ref": "ConnectorId"
        }
      }
    }
  },
  "Outputs": {
    "AuthConfig": {
      "Description": "AuthConfig",
      "Value": {
        "Fn::GetAtt": [
          "UserAuthConfig",
          "AuthConfig"
        ]
      }
    },
    "AuthConfigId": {
      "Description": "The id of the config.",
      "Value": {
        "Fn::GetAtt": [
          "UserAuthConfig",
          "AuthConfigId"
        ]
      }
    }
  }
}