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. |
scope
Required
- Type: com.aliyun.ros.cdk.core.Construct
id
Required
- Type: java.lang.String
enableResourcePropertyConstraint
Optional
- Type: java.lang.Boolean
content
Required
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property content: The content of the template.
description
Required
- 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.
name
Required
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property name: The name of the template.
type
Required
- 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.
signature
Optional
- 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.
signatureId
Optional
- 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.
- Type: com.aliyun.ros.cdk.core.ISynthesisSession
The synthesis session.
addCondition
public void addCondition(RosCondition condition)
- Type: com.aliyun.ros.cdk.core.RosCondition
addCount
public void addCount(java.lang.Number OR IResolvable count)
- Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable
addDependency
public void addDependency(Resource resource)
- Type: com.aliyun.ros.cdk.core.Resource
addResourceDesc
public void addResourceDesc(java.lang.String desc)
- Type: java.lang.String
applyRemovalPolicy
public void applyRemovalPolicy(RemovalPolicy policy)
- Type: com.aliyun.ros.cdk.core.RemovalPolicy
getAtt
public IResolvable getAtt(java.lang.String name)
- Type: java.lang.String
setMetadata
public void setMetadata(java.lang.String key, java.lang.Object value)
- Type: java.lang.String
- 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.
- 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. |
node
Required
public ConstructNode getNode();
- Type: com.aliyun.ros.cdk.core.ConstructNode
The construct tree node associated with this construct.
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
attrCreatedTime
Required
public IResolvable getAttrCreatedTime();
- Type: com.aliyun.ros.cdk.core.IResolvable
Attribute CreatedTime: The creation time of the Signature.
attrDescription
Required
public IResolvable getAttrDescription();
- Type: com.aliyun.ros.cdk.core.IResolvable
Attribute Description: Application instructions.
attrId
Required
public IResolvable getAttrId();
- Type: com.aliyun.ros.cdk.core.IResolvable
Attribute Id: The ID of the Signature.
attrName
Required
public IResolvable getAttrName();
- Type: com.aliyun.ros.cdk.core.IResolvable
Attribute Name: The name of the Signature.
attrReason
Required
public IResolvable getAttrReason();
- Type: com.aliyun.ros.cdk.core.IResolvable
Attribute Reason: Review recommendations.