DATASOURCE::OOS::Template - Resource Orchestration Service

The DATASOURCE::OOS::Template type is used to query the details of a single template.

Syntax

{
  "Type": "DATASOURCE::OOS::Template",
  "Properties": {
    "TemplateName": String,
    "RefreshOptions": String,
    "TemplateVersion": String
  }
}

Properties

Property name	Type	Required	Editable	Description	Constraint
TemplateName	String	Yes	Yes	The name of the template.	None
RefreshOptions	String	No	Yes	The data source resources refresh mode when the stack is updated.	Valid values: Never (default): never refresh data source resources when the stack is updated. Always: always refresh data source resources when the stack is updated.
TemplateVersion	String	No	Yes	The version of the template.	Format: "v"+number. Value range: v1-v200.

Return values

Fn::GetAtt

Description: The description of the template.
CreatedBy: The creator of the template.
ResourceGroupId: The ID of the resource group.
TemplateFormat: The format of the template. Valid values: JSON/YAML.
UpdatedDate: The time when the template was last updated.
TemplateType: The type of the template. Valid values: Automation/State/Package.
Hash: The SHA-256 value of the template content.
UpdatedBy: The user who last updated the template.
HasTrigger: Specifies whether to query the template that is configured with a trigger.
Content: The content of the template.
CreatedDate: Specifies to query the template that is created at or before the specified time. The value must be in the YYYY-MM-DDThh:mm:ss formatZ.
Tags: The tag keys and values. The number of key-value pairs ranges from 1 to 20. Example: {"k1":"k2","k2":"v2"}.
TemplateId: The ID of the template.
ShareType: The share type of the template. Valid values: Public/Private.

Example

YAML

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  TemplateName:
    Type: String
    Description:
      en: The name of the template.
    Required: true
Resources:
  ExtensionDataSource:
    Type: DATASOURCE::OOS::Template
    Properties:
      TemplateName:
        Ref: TemplateName
Outputs:
  Description:
    Description: The description of the template.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - Description
  CreatedBy:
    Description: The creator of the template.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - CreatedBy
  ResourceGroupId:
    Description: The ID of the resource group.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - ResourceGroupId
  TemplateFormat:
    Description: |-
      The format of the template. Valid values:
      JSON
      YAML
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - TemplateFormat
  UpdatedDate:
    Description: The time when the template was last updated.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - UpdatedDate
  TemplateType:
    Description: |-
      The type of the template. Valid values:
      Automation: the template for automated tasks.
      State: the template for configuration inventories.
      Package: the template for software packages.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - TemplateType
  Hash:
    Description: The SHA-256 value of the template content.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - Hash
  UpdatedBy:
    Description: The user who last updated the template.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - UpdatedBy
  HasTrigger:
    Description: Specifies whether to query the template that is configured with a trigger.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - HasTrigger
  Content:
    Description: The content of the template.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - Content
  CreatedDate:
    Description: Specifies to query the template that is created at or before the specified time. The value must be in the YYYY-MM-DDThh:mm:ssZ format.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - CreatedDate
  Tags:
    Description: 'The tag keys and values. The number of key-value pairs ranges from 1 to 20. Example: {"k1":"k2","k2":"v2"}'
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - Tags
  TemplateId:
    Description: The ID of the template.
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - TemplateId
  ShareType:
    Description: |-
      The share type of the template. Valid values:
      Public
      Private
    Value:
      Fn::GetAtt:
        - ExtensionDataSource
        - ShareType

JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "TemplateName": {
      "Type": "String",
      "Description": {
        "en": "The name of the template."
      },
      "Required": true
    }
  },
  "Resources": {
    "ExtensionDataSource": {
      "Type": "DATASOURCE::OOS::Template",
      "Properties": {
        "TemplateName": {
          "Ref": "TemplateName"
        }
      }
    }
  },
  "Outputs": {
    "Description": {
      "Description": "The description of the template.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Description"
        ]
      }
    },
    "CreatedBy": {
      "Description": "The creator of the template.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "CreatedBy"
        ]
      }
    },
    "ResourceGroupId": {
      "Description": "The ID of the resource group.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ResourceGroupId"
        ]
      }
    },
    "TemplateFormat": {
      "Description": "The format of the template. Valid values:\nJSON\nYAML",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "TemplateFormat"
        ]
      }
    },
    "UpdatedDate": {
      "Description": "The time when the template was last updated.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "UpdatedDate"
        ]
      }
    },
    "TemplateType": {
      "Description": "The type of the template. Valid values:\nAutomation: the template for automated tasks.\nState: the template for configuration inventories.\nPackage: the template for software packages.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "TemplateType"
        ]
      }
    },
    "Hash": {
      "Description": "The SHA-256 value of the template content.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Hash"
        ]
      }
    },
    "UpdatedBy": {
      "Description": "The user who last updated the template.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "UpdatedBy"
        ]
      }
    },
    "HasTrigger": {
      "Description": "Specifies whether to query the template that is configured with a trigger.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "HasTrigger"
        ]
      }
    },
    "Content": {
      "Description": "The content of the template.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Content"
        ]
      }
    },
    "CreatedDate": {
      "Description": "Specifies to query the template that is created at or before the specified time.The value must be in the YYYY-MM-DDThh:mm::ssZ format.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "CreatedDate"
        ]
      }
    },
    "Tags": {
      "Description": "The tag keys and values. The number of key-value pairs ranges from 1 to 20. Example: {\"k1\":\"k2\",\"k2\":\"v2\"}",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "Tags"
        ]
      }
    },
    "TemplateId": {
      "Description": "The ID of the template.",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "TemplateId"
        ]
      }
    },
    "ShareType": {
      "Description": "The share type of the template. Valid values:\nPublic\nPrivate",
      "Value": {
        "Fn::GetAtt": [
          "ExtensionDataSource",
          "ShareType"
        ]
      }
    }
  }
}