Skip to content

Template

This class encapsulates and extends the ROS resource type ALIYUN::PAIPlugin::Template.

Initializers

import com.aliyun.ros.cdk.paiplugin.Template;
Template.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .content(java.lang.String)
    .content(IResolvable)
    .description(java.lang.String)
    .description(IResolvable)
    .name(java.lang.String)
    .name(IResolvable)
    .type(java.lang.Number)
    .type(IResolvable)
//  .signature(java.lang.String)
//  .signature(IResolvable)
//  .signatureId(java.lang.String)
//  .signatureId(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.
content java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property content: The content of the template.
description java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property description: For the template content, please keep the total word count within 70 words.
name java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property name: The name of the template.
type java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property type: The type of the template.
signature java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property signature: The name of the Signature, You must select either Signature or SignatureId, but not both.
signatureId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property signatureId: The ID of the Signature, You must select either Signature or SignatureId, but not both.

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.


descriptionRequired

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

Property description: For the template content, please keep the total word count within 70 words.

The excess will be charged as long text messages. Each text message is recorded as 67 words.


nameRequired

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

Property name: The name of the template.


typeRequired

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

Property type: The type of the template.

The following values are supported: 0: Verification code. 1: SMS notification. 2: Promotional SMS.


signatureOptional

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

Property signature: The name of the Signature, You must select either Signature or SignatureId, but not both.


signatureIdOptional

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

Property signatureId: The ID of the Signature, You must select either Signature or SignatureId, but not both.


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.paiplugin.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.
attrCreatedTime com.aliyun.ros.cdk.core.IResolvable Attribute CreatedTime: The creation time of the Signature.
attrDescription com.aliyun.ros.cdk.core.IResolvable Attribute Description: Application instructions.
attrId com.aliyun.ros.cdk.core.IResolvable Attribute Id: The ID of the Signature.
attrName com.aliyun.ros.cdk.core.IResolvable Attribute Name: The name of the Signature.
attrReason com.aliyun.ros.cdk.core.IResolvable Attribute Reason: Review recommendations.

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

attrCreatedTimeRequired

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

Attribute CreatedTime: The creation time of the Signature.


attrDescriptionRequired

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

Attribute Description: Application instructions.


attrIdRequired

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

Attribute Id: The ID of the Signature.


attrNameRequired

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

Attribute Name: The name of the Signature.


attrReasonRequired

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

Attribute Reason: Review recommendations.