Template

• Implements: ITemplate

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

Initializers

import com.aliyun.ros.cdk.agentrun.Template;
Template.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .templateName(java.lang.String)
    .templateName(IResolvable)
//  .allowAnonymousManage(java.lang.Boolean)
//  .allowAnonymousManage(IResolvable)
//  .armsConfiguration(IResolvable)
//  .armsConfiguration(ArmsConfigurationProperty)
//  .containerConfiguration(IResolvable)
//  .containerConfiguration(ContainerConfigurationProperty)
//  .cpu(java.lang.Number)
//  .cpu(IResolvable)
//  .credentialConfiguration(IResolvable)
//  .credentialConfiguration(CredentialConfigurationProperty)
//  .description(java.lang.String)
//  .description(IResolvable)
//  .diskSize(java.lang.Number)
//  .diskSize(IResolvable)
//  .enableAgent(java.lang.Boolean)
//  .enableAgent(IResolvable)
//  .environmentVariables(IResolvable)
//  .environmentVariables(java.util.Map<java.lang.String, java.lang.Object>)
//  .executionRoleArn(java.lang.String)
//  .executionRoleArn(IResolvable)
//  .logConfiguration(IResolvable)
//  .logConfiguration(LogConfigurationProperty)
//  .memory(java.lang.Number)
//  .memory(IResolvable)
//  .nasConfig(IResolvable)
//  .nasConfig(NasConfigProperty)
//  .networkConfiguration(IResolvable)
//  .networkConfiguration(NetworkConfigurationProperty)
//  .ossConfiguration(IResolvable)
//  .ossConfiguration(java.util.List<IResolvable)
//  .ossConfiguration(OssConfigurationProperty>)
//  .sandboxIdleTimeoutInSeconds(java.lang.Number)
//  .sandboxIdleTimeoutInSeconds(IResolvable)
//  .templateConfiguration(IResolvable)
//  .templateConfiguration(java.util.Map<java.lang.String, java.lang.Object>)
//  .templateType(java.lang.String)
//  .templateType(IResolvable)
//  .workspaceId(java.lang.String)
//  .workspaceId(IResolvable)
    .build();

scope^Required

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

id^Required

• Type: java.lang.String

enableResourcePropertyConstraint^Optional

• Type: java.lang.Boolean

templateName^Required

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

Property templateName: The name of the template.

allowAnonymousManage^Optional

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

Property allowAnonymousManage: Whether to allow anonymous management.

armsConfiguration^Optional

• Type: com.aliyun.ros.cdk.core.IResolvable OR ArmsConfigurationProperty

Property armsConfiguration: The ARMS configuration.

containerConfiguration^Optional

• Type: com.aliyun.ros.cdk.core.IResolvable OR ContainerConfigurationProperty

Property containerConfiguration: The container configuration.

Only images based on Browser/Code Interpreter base images are allowed.

cpu^Optional

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

Property cpu: The CPU resource configuration (unit: cores).

credentialConfiguration^Optional

• Type: com.aliyun.ros.cdk.core.IResolvable OR CredentialConfigurationProperty

Property credentialConfiguration: The credential configuration.

description^Optional

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

Property description: The description of the template.

diskSize^Optional

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

Property diskSize: The disk size (unit: MB).

enableAgent^Optional

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

Property enableAgent: Whether to enable the sandbox agent.

environmentVariables^Optional

• Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.Map

Property environmentVariables: The environment variables.

executionRoleArn^Optional

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

Property executionRoleArn: The execution role ARN.

logConfiguration^Optional

• Type: com.aliyun.ros.cdk.core.IResolvable OR LogConfigurationProperty

Property logConfiguration: The log configuration.

memory^Optional

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

Property memory: The memory resource configuration (unit: MB).

nasConfig^Optional

• Type: com.aliyun.ros.cdk.core.IResolvable OR NasConfigProperty

Property nasConfig: The NAS configuration.

networkConfiguration^Optional

• Type: com.aliyun.ros.cdk.core.IResolvable OR NetworkConfigurationProperty

Property networkConfiguration: The network configuration.

ossConfiguration^Optional

• Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.ListOssConfigurationProperty>

Property ossConfiguration: The OSS configuration.

sandboxIdleTimeoutInSeconds^Optional

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

Property sandboxIdleTimeoutInSeconds: The sandbox idle timeout in seconds.

templateConfiguration^Optional

• Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.Map

Property templateConfiguration: The template configuration (flexible object structure, varies by templateType).

templateType^Optional

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

Property templateType: The type of the template.

workspaceId^Optional

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

Property workspaceId: The workspace ID.

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.agentrun.Template;
Template.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

attrTemplateArn^Required

public java.lang.Object getAttrTemplateArn();

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

Attribute TemplateArn: The ARN of the template.

attrTemplateId^Required

public java.lang.Object getAttrTemplateId();

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

Attribute TemplateId: The ID of the template.

attrTemplateName^Required

public java.lang.Object getAttrTemplateName();

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

Attribute TemplateName: The name of the template.

props^Required

public TemplateProps getProps();

• Type: TemplateProps

Structs