DATASOURCE::FNF::Schedules is used to query time-based schedules.

Syntax

{
  "Type": "DATASOURCE::FNF::Schedules",
  "Properties": {
    "FlowName": String
  }
}

Properties

PropertyTypeRequiredEditableDescriptionConstraint
FlowNameStringYesYesThe name of the flow that is associated with the time-based schedule. The name is unique in a region and cannot be changed after the time-based schedule is created. The name must meet the following requirements:
  • It can contain letters, digits, underscores (_), and hyphens (-).
  • The name must start with a letter or an underscore (_).
  • It is case-sensitive.
  • It must be 1 to 128 characters in length.

Return values

Fn::GetAtt

  • Schedules: details of the time-based schedules.
  • ScheduleNames: the names of the time-based schedules.
PropertyTypeDescriptionConstraint
ScheduleNamesListThe names of the time-based schedules. None.
SchedulesListDetails of the time-based schedules. None.
StatusBooleanIndicates whether the time-based schedule feature is enabled. Valid values:
  • true
  • false
ScheduleIdStringThe ID of the time-based schedule. None.
DescriptionStringThe description of the time-based schedule. None.
PayloadStringThe payload of the time-based schedule. None.
CronExpressionStringThe CRON expression. None.
ScheduleNameStringThe name of the time-based schedule. None.
LastModifiedTimeStringThe time when the time-based schedule was last modified. None.
CreateTimeStringThe time when the time-based schedule was created. None.

Examples

  • YAML format

    ROSTemplateFormatVersion: '2015-09-01'
    Parameters:
    Resources:
      ExtensionDataSource:
        Properties:
          FlowName: Test
        Type: DATASOURCE::FNF::Schedules
    Outputs:
      ScheduleNames:
        Description: The list of schedule names.
        Value:
          Fn::GetAtt:
          - ExtensionDataSource
          - ScheduleNames
      Schedules:
        Description: The queried time-based schedules.
        Value:
          Fn::GetAtt:
          - ExtensionDataSource
          - Schedules
  • JSON format

    {
      "ROSTemplateFormatVersion": "2015-09-01",
      "Parameters": {
      },
      "Resources": {
        "ExtensionDataSource": {
          "Type": "DATASOURCE::FNF::Schedules",
          "Properties": {
            "FlowName": "Test"
          }
        }
      },
      "Outputs": {
        "Schedules": {
          "Description": "The queried time-based schedules.",
          "Value": {
            "Fn::GetAtt": [
              "ExtensionDataSource",
              "Schedules"
            ]
          }
        },
        "ScheduleNames": {
          "Description": "The list of schedule names.",
          "Value": {
            "Fn::GetAtt": [
              "ExtensionDataSource",
              "ScheduleNames"
            ]
          }
        }
      }
    }