Templates

• Implements: com.aliyun.ros.cdk.oos.datasource.ITemplates

This class encapsulates and extends the ROS resource type DATASOURCE::OOS::TemplatesThe , which type is used to query template lists.

Initializers

import com.aliyun.ros.cdk.oos.datasource.Templates;
Templates.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
//  .category(java.lang.String)
//  .category(IResolvable)
//  .createdBy(java.lang.String)
//  .createdBy(IResolvable)
//  .createdDateAfter(java.lang.String)
//  .createdDateAfter(IResolvable)
//  .createdDateBefore(java.lang.String)
//  .createdDateBefore(IResolvable)
//  .hasTrigger(java.lang.Boolean)
//  .hasTrigger(IResolvable)
//  .isExample(java.lang.Boolean)
//  .isExample(IResolvable)
//  .isFavorite(java.lang.Boolean)
//  .isFavorite(IResolvable)
//  .refreshOptions(java.lang.String)
//  .refreshOptions(IResolvable)
//  .resourceGroupId(java.lang.String)
//  .resourceGroupId(IResolvable)
//  .shareType(java.lang.String)
//  .shareType(IResolvable)
//  .sortField(java.lang.String)
//  .sortField(IResolvable)
//  .sortOrder(java.lang.String)
//  .sortOrder(IResolvable)
//  .tags(java.util.Map<java.lang.String, java.lang.Object>)
//  .templateFormat(java.lang.String)
//  .templateFormat(IResolvable)
//  .templateName(java.lang.String)
//  .templateName(IResolvable)
//  .templateType(java.lang.String)
//  .templateType(IResolvable)
    .build();

scope^Required

• Type: com.aliyun.ros.cdk.core.Construct

id^Required

• Type: java.lang.String

enableResourcePropertyConstraint^Optional

• Type: java.lang.Boolean

category^Optional

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property category: The type of the template.

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

createdBy^Optional

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property createdBy: The creator of the template.

createdDateAfter^Optional

• Type: java.lang.String OR com.aliyun.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^Optional

• Type: java.lang.String OR com.aliyun.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^Optional

• Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable

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

isExample^Optional

• Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable

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

isFavorite^Optional

• Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable

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

refreshOptions^Optional

• Type: java.lang.String OR com.aliyun.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.

resourceGroupId^Optional

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property resourceGroupId: The ID of the resource group.

shareType^Optional

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property shareType: The share type of the template.

Valid values: Public Private

sortField^Optional

• Type: java.lang.String OR com.aliyun.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.

sortOrder^Optional

• Type: java.lang.String OR com.aliyun.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.

tags^Optional

• Type: java.util.Map

Property tags: The tag keys and values.

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

templateFormat^Optional

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property templateFormat: The format of the template.

Valid values: JSON YAML

templateName^Optional

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property templateName: The name of the template.

templateType^Optional

• Type: java.lang.String OR com.aliyun.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.

Methods

toString

public java.lang.String toString()

Returns a string representation of this construct.

synthesize

public void synthesize(ISynthesisSession session)

Allows this construct to emit artifacts into the cloud assembly during synthesis.

This method is usually implemented by framework-level constructs such as Stack and Asset as they participate in synthesizing the cloud assembly.

session^Required

• Type: com.aliyun.ros.cdk.core.ISynthesisSession

The synthesis session.

addCondition

public void addCondition(RosCondition condition)

condition^Required

• Type: com.aliyun.ros.cdk.core.RosCondition

addCount

public void addCount(java.lang.Number OR IResolvable count)

count^Required

• Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

addDependency

public void addDependency(Resource resource)

resource^Required

• Type: com.aliyun.ros.cdk.core.Resource

addResourceDesc

public void addResourceDesc(java.lang.String desc)

desc^Required

• Type: java.lang.String

applyRemovalPolicy

public void applyRemovalPolicy(RemovalPolicy policy)

policy^Required

• Type: com.aliyun.ros.cdk.core.RemovalPolicy

fetchCondition

public RosCondition fetchCondition()

fetchDependency

public java.util.List<java.lang.String> fetchDependency()

fetchResourceDesc

public java.lang.String fetchResourceDesc()

getAtt

public IResolvable getAtt(java.lang.String name)

name^Required

• Type: java.lang.String

setMetadata

public void setMetadata(java.lang.String key, java.lang.Object value)

key^Required

• Type: java.lang.String

value^Required

• Type: java.lang.Object

Static Functions

isConstruct

import com.aliyun.ros.cdk.oos.datasource.Templates;
Templates.isConstruct(java.lang.Object x)

Return whether the given object is a Construct.

x^Required

• Type: java.lang.Object

Properties

node^Required

public ConstructNode getNode();

• Type: com.aliyun.ros.cdk.core.ConstructNode

The construct tree node associated with this construct.

env^Required

public IResourceEnvironment getEnv();

• Type: com.aliyun.ros.cdk.core.IResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

ref^Required

public java.lang.String getRef();

• Type: java.lang.String

stack^Required

public Stack getStack();

• Type: com.aliyun.ros.cdk.core.Stack

The stack in which this resource is defined.

resource^Optional

public RosResource getResource();

• Type: com.aliyun.ros.cdk.core.RosResource

attrTemplateNames^Required

public java.lang.Object getAttrTemplateNames();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute TemplateNames: The list of template_names.

attrTemplates^Required

public java.lang.Object getAttrTemplates();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute Templates: The list of templates.

props^Required

public TemplatesProps getProps();

• Type: TemplatesProps

Structs