DATASOURCE::AppFlow::UserAuthConfigs

DATASOURCE::AppFlow::UserAuthConfigs类型用于获取用户凭据管理信息。

语法

{
  "Type": "DATASOURCE::AppFlow::UserAuthConfigs",
  "Properties": {
    "ConnectorId": String,
    "AuthConfigNames": List,
    "RefreshOptions": String
  }
}

属性

属性名称

类型

必须

允许更新

描述

约束

ConnectorId

String

连接器ID。

AuthConfigNames

List

凭证名称列表。

最多支持配置20组名称。

RefreshOptions

String

当资源栈更新时,数据源资源的刷新策略。

有效值:

  • Never(默认值):更新堆栈时,从不刷新数据源资源。

  • Always:更新堆栈时,始终刷新数据源资源。

返回值

Fn::GetAtt

  • AuthConfigs:凭证详情列表。

  • AuthConfigIds:凭证Id列表。

示例

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  AuthConfigNames:
    AssociationPropertyMetadata:
      Parameter:
        Type: String
        Description:
          en: The name of the config.
        Required: true
    AssociationProperty: List[Parameter]
    Type: Json
    Description:
      en: The names of the config.
    Required: false
    MinLength: 1
    MaxLength: 20
  ConnectorId:
    Type: String
    Description:
      en: The id of connector.
    Required: true
  RefreshOptions:
    Type: String
    Description:
      en: |-
        The refresh strategy for the datasource resource when the stack is updated. Valid values:
        - Never: Never refresh the datasource resource when the stack is updated.
        - Always: Always refresh the datasource resource when the stack is updated.
        Default is Never.
    AllowedValues:
      - Always
      - Never
    Required: false
    Default: Never
Resources:
  UserAuthConfigs:
    Type: DATASOURCE::AppFlow::UserAuthConfigs
    Properties:
      AuthConfigNames:
        Ref: AuthConfigNames
      ConnectorId:
        Ref: ConnectorId
      RefreshOptions:
        Ref: RefreshOptions
Outputs:
  AuthConfigs:
    Description: The list of auth configs
    Value:
      Fn::GetAtt:
        - UserAuthConfigs
        - AuthConfigs
  AuthConfigIds:
    Description: The list of auth config ids.
    Value:
      Fn::GetAtt:
        - UserAuthConfigs
        - AuthConfigIds
{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "AuthConfigNames": {
      "AssociationPropertyMetadata": {
        "Parameter": {
          "Type": "String",
          "Description": {
            "en": "The name of the config."
          },
          "Required": true
        }
      },
      "AssociationProperty": "List[Parameter]",
      "Type": "Json",
      "Description": {
        "en": "The names of the config."
      },
      "Required": false,
      "MinLength": 1,
      "MaxLength": 20
    },
    "ConnectorId": {
      "Type": "String",
      "Description": {
        "en": "The id of connector."
      },
      "Required": true
    },
    "RefreshOptions": {
      "Type": "String",
      "Description": {
        "en": "The refresh strategy for the datasource resource when the stack is updated. Valid values:\n- Never: Never refresh the datasource resource when the stack is updated.\n- Always: Always refresh the datasource resource when the stack is updated.\nDefault is Never."
      },
      "AllowedValues": [
        "Always",
        "Never"
      ],
      "Required": false,
      "Default": "Never"
    }
  },
  "Resources": {
    "UserAuthConfigs": {
      "Type": "DATASOURCE::AppFlow::UserAuthConfigs",
      "Properties": {
        "AuthConfigNames": {
          "Ref": "AuthConfigNames"
        },
        "ConnectorId": {
          "Ref": "ConnectorId"
        },
        "RefreshOptions": {
          "Ref": "RefreshOptions"
        }
      }
    }
  },
  "Outputs": {
    "AuthConfigs": {
      "Description": "The list of auth configs",
      "Value": {
        "Fn::GetAtt": [
          "UserAuthConfigs",
          "AuthConfigs"
        ]
      }
    },
    "AuthConfigIds": {
      "Description": "The list of auth config ids.",
      "Value": {
        "Fn::GetAtt": [
          "UserAuthConfigs",
          "AuthConfigIds"
        ]
      }
    }
  }
}