DATASOURCE::AppFlow::UserAuthConfigs - Resource Orchestration Service

DATASOURCE::AppFlow::UserAuthConfigs is used to query the configurations of user credentials.

Syntax

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

Properties

Property	Type	Required	Editable	Description	Constraint
ConnectorId	String	Yes	No	The ID of the connector.	None.
AuthConfigNames	List	No	No	The names of the credentials.	You can specify up to 20 names.
RefreshOptions	String	No	Yes	The refresh policy for data source resources when the stack is updated.	Valid values: Never (default): does not refresh data source resources when the stack is updated. Always: refreshes data source resources when the stack is updated.

Return values

Fn::GetAtt

AuthConfigs: the configurations of the credentials.
AuthConfigIds: the IDs of the credentials.

Examples

YAML

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

JSON

{
  "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"
        ]
      }
    }
  }
}