Template

• Implements: ITemplate

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

Initializers

import ros_cdk_agentrun
ros_cdk_agentrun.Template(
  scope: Construct,
  id: str,
  template_name: typing.Union[str, IResolvable],
  allow_anonymous_manage: typing.Union[bool, IResolvable] = None,
  arms_configuration: typing.Union[IResolvable, ArmsConfigurationProperty] = None,
  container_configuration: typing.Union[IResolvable, ContainerConfigurationProperty] = None,
  cpu: typing.Union[typing.Union[int, float], IResolvable] = None,
  credential_configuration: typing.Union[IResolvable, CredentialConfigurationProperty] = None,
  description: typing.Union[str, IResolvable] = None,
  disk_size: typing.Union[typing.Union[int, float], IResolvable] = None,
  enable_agent: typing.Union[bool, IResolvable] = None,
  environment_variables: typing.Union[IResolvable, typing.Mapping[typing.Any]] = None,
  execution_role_arn: typing.Union[str, IResolvable] = None,
  log_configuration: typing.Union[IResolvable, LogConfigurationProperty] = None,
  memory: typing.Union[typing.Union[int, float], IResolvable] = None,
  nas_config: typing.Union[IResolvable, NasConfigProperty] = None,
  network_configuration: typing.Union[IResolvable, NetworkConfigurationProperty] = None,
  oss_configuration: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, OssConfigurationProperty]]] = None,
  sandbox_idle_timeout_in_seconds: typing.Union[typing.Union[int, float], IResolvable] = None,
  template_configuration: typing.Union[IResolvable, typing.Mapping[typing.Any]] = None,
  template_type: typing.Union[str, IResolvable] = None,
  workspace_id: typing.Union[str, IResolvable] = None,
  enable_resource_property_constraint: bool = None
)

scope^Required

• Type: ros_cdk_core.Construct

id^Required

• Type: str

template_name^Required

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property templateName: The name of the template.

allow_anonymous_manage^Optional

• Type: typing.Union[bool, ros_cdk_core.IResolvable]

Property allowAnonymousManage: Whether to allow anonymous management.

arms_configuration^Optional

• Type: typing.Union[ros_cdk_core.IResolvable, ArmsConfigurationProperty]

Property armsConfiguration: The ARMS configuration.

container_configuration^Optional

• Type: typing.Union[ros_cdk_core.IResolvable, ContainerConfigurationProperty]

Property containerConfiguration: The container configuration.

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

cpu^Optional

• Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

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

credential_configuration^Optional

• Type: typing.Union[ros_cdk_core.IResolvable, CredentialConfigurationProperty]

Property credentialConfiguration: The credential configuration.

description^Optional

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property description: The description of the template.

disk_size^Optional

• Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

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

enable_agent^Optional

• Type: typing.Union[bool, ros_cdk_core.IResolvable]

Property enableAgent: Whether to enable the sandbox agent.

environment_variables^Optional

• Type: typing.Union[ros_cdk_core.IResolvable, typing.Mapping[typing.Any]]

Property environmentVariables: The environment variables.

execution_role_arn^Optional

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property executionRoleArn: The execution role ARN.

log_configuration^Optional

• Type: typing.Union[ros_cdk_core.IResolvable, LogConfigurationProperty]

Property logConfiguration: The log configuration.

memory^Optional

• Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

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

nas_config^Optional

• Type: typing.Union[ros_cdk_core.IResolvable, NasConfigProperty]

Property nasConfig: The NAS configuration.

network_configuration^Optional

• Type: typing.Union[ros_cdk_core.IResolvable, NetworkConfigurationProperty]

Property networkConfiguration: The network configuration.

oss_configuration^Optional

• Type: typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, OssConfigurationProperty]]]

Property ossConfiguration: The OSS configuration.

sandbox_idle_timeout_in_seconds^Optional

• Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

Property sandboxIdleTimeoutInSeconds: The sandbox idle timeout in seconds.

template_configuration^Optional

• Type: typing.Union[ros_cdk_core.IResolvable, typing.Mapping[typing.Any]]

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

template_type^Optional

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property templateType: The type of the template.

workspace_id^Optional

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property workspaceId: The workspace ID.

enable_resource_property_constraint^Optional

• Type: bool

Methods

to_string

def to_string() -> str

Returns a string representation of this construct.

synthesize

def synthesize(
  session: ISynthesisSession
) -> None

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: ros_cdk_core.ISynthesisSession

The synthesis session.

add_condition

def add_condition(
  condition: RosCondition
) -> None

condition^Required

• Type: ros_cdk_core.RosCondition

add_count

def add_count(
  count: typing.Union[typing.Union[int, float], IResolvable]
) -> None

count^Required

• Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

add_dependency

def add_dependency(
  resource: Resource
) -> None

resource^Required

• Type: ros_cdk_core.Resource

add_resource_desc

def add_resource_desc(
  desc: str
) -> None

desc^Required

• Type: str

apply_removal_policy

def apply_removal_policy(
  policy: RemovalPolicy
) -> None

policy^Required

• Type: ros_cdk_core.RemovalPolicy

fetch_condition

def fetch_condition() -> RosCondition

fetch_dependency

def fetch_dependency() -> typing.List[str]

fetch_resource_desc

def fetch_resource_desc() -> str

get_att

def get_att(
  name: str
) -> IResolvable

name^Required

• Type: str

set_metadata

def set_metadata(
  key: str,
  value: typing.Any
) -> None

key^Required

• Type: str

value^Required

• Type: typing.Any

Static Functions

is_construct

import ros_cdk_agentrun
ros_cdk_agentrun.Template.is_construct(
  x: typing.Any
)

Return whether the given object is a Construct.

x^Required

• Type: typing.Any

Properties

node^Required

node: ConstructNode

• Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

env^Required

env: IResourceEnvironment

• Type: 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

ref: str

• Type: str

stack^Required

stack: Stack

• Type: ros_cdk_core.Stack

The stack in which this resource is defined.

resource^Optional

resource: RosResource

• Type: ros_cdk_core.RosResource

attr_template_arn^Required

attr_template_arn: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute TemplateArn: The ARN of the template.

attr_template_id^Required

attr_template_id: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute TemplateId: The ID of the template.

attr_template_name^Required

attr_template_name: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute TemplateName: The name of the template.

props^Required

props: TemplateProps

• Type: TemplateProps

Structs