Skip to content

TemplatesProps

Properties for defining a Templates.

See https://www.alibabacloud.com/help/ros/developer-reference/datasource-oos-templates

Initializer

import { datasource } from '@alicloud/ros-cdk-oos'
const templatesProps: datasource.TemplatesProps = { ... }

Properties

Name Type Description
category string | @alicloud/ros-cdk-core.IResolvable Property category: The type of the template.
createdBy string | @alicloud/ros-cdk-core.IResolvable Property createdBy: The creator of the template.
createdDateAfter string | @alicloud/ros-cdk-core.IResolvable Property createdDateAfter: Specifies to query the template that is created at or later than the specified time.The value must be in the YYYY-MM-DDThh:mm:ssZ format.
createdDateBefore string | @alicloud/ros-cdk-core.IResolvable Property createdDateBefore: 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.
hasTrigger boolean | @alicloud/ros-cdk-core.IResolvable Property hasTrigger: Specifies whether to query the template that is configured with a trigger.
isExample boolean | @alicloud/ros-cdk-core.IResolvable Property isExample: Specifies whether the template is an example template.
isFavorite boolean | @alicloud/ros-cdk-core.IResolvable Property isFavorite: Specifies whether the template is added to favorites.
refreshOptions string | @alicloud/ros-cdk-core.IResolvable Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated.
resourceGroupId string | @alicloud/ros-cdk-core.IResolvable Property resourceGroupId: The ID of the resource group.
shareType string | @alicloud/ros-cdk-core.IResolvable Property shareType: The share type of the template.
sortField string | @alicloud/ros-cdk-core.IResolvable Property sortField: The field that is used to sort the templates to be queried.
sortOrder string | @alicloud/ros-cdk-core.IResolvable Property sortOrder: The order in which you want to sort the results.
tags {[ key: string ]: any} Property tags: The tag keys and values.
templateFormat string | @alicloud/ros-cdk-core.IResolvable Property templateFormat: The format of the template.
templateName string | @alicloud/ros-cdk-core.IResolvable Property templateName: The name of the template.
templateType string | @alicloud/ros-cdk-core.IResolvable Property templateType: The type of the template.

categoryOptional

public readonly category: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property category: The type of the template.

Valid values include TimerTrigger, EventTrigger, AlarmTrigger, and Other.


createdByOptional

public readonly createdBy: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property createdBy: The creator of the template.


createdDateAfterOptional

public readonly createdDateAfter: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property createdDateAfter: Specifies to query the template that is created at or later than the specified time.The value must be in the YYYY-MM-DDThh:mm:ssZ format.


createdDateBeforeOptional

public readonly createdDateBefore: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property createdDateBefore: 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.


hasTriggerOptional

public readonly hasTrigger: boolean | IResolvable;
  • Type: boolean | @alicloud/ros-cdk-core.IResolvable

Property hasTrigger: Specifies whether to query the template that is configured with a trigger.


isExampleOptional

public readonly isExample: boolean | IResolvable;
  • Type: boolean | @alicloud/ros-cdk-core.IResolvable

Property isExample: Specifies whether the template is an example template.


isFavoriteOptional

public readonly isFavorite: boolean | IResolvable;
  • Type: boolean | @alicloud/ros-cdk-core.IResolvable

Property isFavorite: Specifies whether the template is added to favorites.


refreshOptionsOptional

public readonly refreshOptions: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property refreshOptions: 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.


resourceGroupIdOptional

public readonly resourceGroupId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property resourceGroupId: The ID of the resource group.


shareTypeOptional

public readonly shareType: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property shareType: The share type of the template.

Valid values: Public Private


sortFieldOptional

public readonly sortField: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property sortField: The field that is used to sort the templates to be queried.

Valid values: TotalExecutionCount (default): The system sorts the returned templates based on the total number of times that the templates are used. Popularity: The system sorts the returned templates based on the popularity of the templates. TemplateName: The system sorts the returned templates based on the names of the templates. CreatedDate: The system sorts the returned templates based on the points in time when the templates are created. UpdatedDate: The system sorts the returned templates based on the points in time when the templates are updated.


sortOrderOptional

public readonly sortOrder: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property sortOrder: The order in which you want to sort the results.

Valid values: Ascending: ascending order. Descending: descending order. This is the default value.


tagsOptional

public readonly tags: {[ key: string ]: any};
  • Type: {[ key: string ]: any}

Property tags: The tag keys and values.

The number of key-value pairs ranges from 1 to 20. Example: {"k1":"k2","k2":"v2"}


templateFormatOptional

public readonly templateFormat: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property templateFormat: The format of the template.

Valid values: JSON YAML


templateNameOptional

public readonly templateName: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property templateName: The name of the template.


templateTypeOptional

public readonly templateType: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property templateType: 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.


Protocols