Skip to content

Template

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

This class encapsulates and extends the ROS resource type DATASOURCE::OOS::Template.

Initializers

import com.aliyun.ros.cdk.oos.datasource.Template;
Template.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .templateName(java.lang.String)
    .templateName(IResolvable)
//  .refreshOptions(java.lang.String)
//  .refreshOptions(IResolvable)
//  .templateVersion(java.lang.String)
//  .templateVersion(IResolvable)
    .build();
Name Type Description
scope com.aliyun.ros.cdk.core.Construct No description.
id java.lang.String No description.
enableResourcePropertyConstraint java.lang.Boolean No description.
templateName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property templateName: The name of the template.
refreshOptions java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated.
templateVersion java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property templateVersion: The version of the template.

scopeRequired

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

idRequired

  • Type: java.lang.String

enableResourcePropertyConstraintOptional

  • Type: java.lang.Boolean

templateNameRequired

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

Property templateName: The name of the template.


refreshOptionsOptional

  • 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.

templateVersionOptional

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

Property templateVersion: The version of the template.

The default value is the latest version of the template.Format: "v" + number. Value range: v1-v200.


Methods

Name Description
toString Returns a string representation of this construct.
synthesize Allows this construct to emit artifacts into the cloud assembly during synthesis.
addCondition No description.
addCount No description.
addDependency No description.
addResourceDesc No description.
applyRemovalPolicy No description.
fetchCondition No description.
fetchDependency No description.
fetchResourceDesc No description.
getAtt No description.
setMetadata No description.

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.

sessionRequired

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

The synthesis session.


addCondition

public void addCondition(RosCondition condition)

conditionRequired

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

addCount

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

countRequired

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

addDependency

public void addDependency(Resource resource)

resourceRequired

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

addResourceDesc

public void addResourceDesc(java.lang.String desc)

descRequired

  • Type: java.lang.String

applyRemovalPolicy

public void applyRemovalPolicy(RemovalPolicy policy)

policyRequired

  • 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)

nameRequired

  • Type: java.lang.String

setMetadata

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

keyRequired

  • Type: java.lang.String

valueRequired

  • Type: java.lang.Object

Static Functions

Name Description
isConstruct Return whether the given object is a Construct.

isConstruct

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

Return whether the given object is a Construct.

xRequired

  • Type: java.lang.Object

Properties

Name Type Description
node com.aliyun.ros.cdk.core.ConstructNode The construct tree node associated with this construct.
env com.aliyun.ros.cdk.core.IResourceEnvironment The environment this resource belongs to.
ref java.lang.String No description.
stack com.aliyun.ros.cdk.core.Stack The stack in which this resource is defined.
resource com.aliyun.ros.cdk.core.RosResource No description.
attrContent java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute Content: The content of the template.
attrCreatedBy java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute CreatedBy: The creator of the template.
attrCreatedDate java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute 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::ssZ format.
attrDescription java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute Description: The description of the template.
attrHash java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute Hash: The SHA-256 value of the template content.
attrHasTrigger java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute HasTrigger: Specifies whether to query the template that is configured with a trigger.
attrResourceGroupId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute ResourceGroupId: The ID of the resource group.
attrShareType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute ShareType: The share type of the template.
attrTags java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute Tags: The tag keys and values.
attrTemplateFormat java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute TemplateFormat: The format of the template.
attrTemplateId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute TemplateId: The ID of the template.
attrTemplateType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute TemplateType: The type of the template.
attrUpdatedBy java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute UpdatedBy: The user who last updated the template.
attrUpdatedDate java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute UpdatedDate: The time when the template was last updated.
props TemplateProps No description.

nodeRequired

public ConstructNode getNode();
  • Type: com.aliyun.ros.cdk.core.ConstructNode

The construct tree node associated with this construct.


envRequired

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.


refRequired

public java.lang.String getRef();
  • Type: java.lang.String

stackRequired

public Stack getStack();
  • Type: com.aliyun.ros.cdk.core.Stack

The stack in which this resource is defined.


resourceOptional

public RosResource getResource();
  • Type: com.aliyun.ros.cdk.core.RosResource

attrContentRequired

public java.lang.Object getAttrContent();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute Content: The content of the template.


attrCreatedByRequired

public java.lang.Object getAttrCreatedBy();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute CreatedBy: The creator of the template.


attrCreatedDateRequired

public java.lang.Object getAttrCreatedDate();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute 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::ssZ format.


attrDescriptionRequired

public java.lang.Object getAttrDescription();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute Description: The description of the template.


attrHashRequired

public java.lang.Object getAttrHash();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute Hash: The SHA-256 value of the template content.


attrHasTriggerRequired

public java.lang.Object getAttrHasTrigger();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute HasTrigger: Specifies whether to query the template that is configured with a trigger.


attrResourceGroupIdRequired

public java.lang.Object getAttrResourceGroupId();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute ResourceGroupId: The ID of the resource group.


attrShareTypeRequired

public java.lang.Object getAttrShareType();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute ShareType: The share type of the template.

Valid values: Public Private


attrTagsRequired

public java.lang.Object getAttrTags();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute Tags: The tag keys and values.

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


attrTemplateFormatRequired

public java.lang.Object getAttrTemplateFormat();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute TemplateFormat: The format of the template.

Valid values: JSON YAML


attrTemplateIdRequired

public java.lang.Object getAttrTemplateId();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute TemplateId: The ID of the template.


attrTemplateTypeRequired

public java.lang.Object getAttrTemplateType();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute 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.


attrUpdatedByRequired

public java.lang.Object getAttrUpdatedBy();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute UpdatedBy: The user who last updated the template.


attrUpdatedDateRequired

public java.lang.Object getAttrUpdatedDate();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute UpdatedDate: The time when the template was last updated.


propsRequired

public TemplateProps getProps();