Skip to content

Template

This class encapsulates and extends the ROS resource type ALIYUN::OOS::Template, which is used to create a template.

Initializers 

import com.aliyun.ros.cdk.oos.Template;
Template.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .content(java.lang.String)
    .content(IResolvable)
    .templateName(java.lang.String)
    .templateName(IResolvable)
//  .resourceGroupId(java.lang.String)
//  .resourceGroupId(IResolvable)
//  .tags(java.util.Map<java.lang.String, java.lang.Object>)
    .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.
content java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property content: The content of the template.
templateName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property templateName: The name of the template.
resourceGroupId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property resourceGroupId: Resource group id.
tags java.util.Map Property tags: Tag value and the key mapping, the label of the key number can be up to 20.

scopeRequired

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

idRequired

  • Type: java.lang.String

enableResourcePropertyConstraintOptional

  • Type: java.lang.Boolean

contentRequired

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

Property content: The content of the template.

The template must be in the JSON or YAML format. Maximum size: 64 KB.

templateNameRequired

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

Property templateName: The name of the template.

The template name can be up to 200 characters in length. The name can contain letters, digits, hyphens (-), and underscores (_). It cannot start with ALIYUN, ACS, ALIBABA, or ALICLOUD.

resourceGroupIdOptional

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

Property resourceGroupId: Resource group id.

tagsOptional

  • Type: java.util.Map

Property tags: Tag value and the key mapping, the label of the key number can be up to 20.

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

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.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.
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.
attrExecutionPolicy com.aliyun.ros.cdk.core.IResolvable Attribute ExecutionPolicy: Execution Policy.
attrTemplateId com.aliyun.ros.cdk.core.IResolvable Attribute TemplateId: Template ID.
attrTemplateName com.aliyun.ros.cdk.core.IResolvable Attribute TemplateName: Template Name.

nodeRequired 

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

The construct tree node associated with this construct.

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

attrExecutionPolicyRequired 

public IResolvable getAttrExecutionPolicy();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute ExecutionPolicy: Execution Policy.

attrTemplateIdRequired 

public IResolvable getAttrTemplateId();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute TemplateId: Template ID.

attrTemplateNameRequired 

public IResolvable getAttrTemplateName();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute TemplateName: Template Name.

Structs