Image

This class encapsulates and extends the ROS resource type ALIYUN::CloudPhone::Image, which is used to create a custom image for a cloud phone.

Initializers

import { Image } from '@alicloud/ros-cdk-cloudphone'
new Image(scope: Construct, id: string, props: ImageProps, enableResourcePropertyConstraint?: boolean)

Name	Type	Description
scope	@alicloud/ros-cdk-core.Construct	No description.
id	string	No description.
props	ImageProps	No description.
enableResourcePropertyConstraint	boolean	No description.

---

scope^Required

• Type: @alicloud/ros-cdk-core.Construct

---

id^Required

• Type: string

---

props^Required

• Type: ImageProps

---

enableResourcePropertyConstraint^Optional

• Type: boolean

---

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 toString(): string

Returns a string representation of this construct.

synthesize

public synthesize(session: ISynthesisSession): void

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: @alicloud/ros-cdk-core.ISynthesisSession

The synthesis session.

---

addCondition

public addCondition(condition: RosCondition): void

condition^Required

• Type: @alicloud/ros-cdk-core.RosCondition

---

addCount

public addCount(count: number | IResolvable): void

count^Required

• Type: number | @alicloud/ros-cdk-core.IResolvable

---

addDependency

public addDependency(resource: Resource): void

resource^Required

• Type: @alicloud/ros-cdk-core.Resource

---

addResourceDesc

public addResourceDesc(desc: string): void

desc^Required

• Type: string

---

applyRemovalPolicy

public applyRemovalPolicy(policy: RemovalPolicy): void

policy^Required

• Type: @alicloud/ros-cdk-core.RemovalPolicy

---

getAtt

public getAtt(name: string): IResolvable

name^Required

• Type: string

---

setMetadata

public setMetadata(key: string, value: any): void

key^Required

• Type: string

---

value^Required

• Type: any

---

Static Functions

Name	Description
isConstruct	Return whether the given object is a Construct.

---

isConstruct

import { Image } from '@alicloud/ros-cdk-cloudphone'
Image.isConstruct(x: any)

Return whether the given object is a Construct.

x^Required

• Type: any

---

Properties

Name	Type	Description
node	@alicloud/ros-cdk-core.ConstructNode	The construct tree node associated with this construct.
ref	string	No description.
stack	@alicloud/ros-cdk-core.Stack	The stack in which this resource is defined.
resource	@alicloud/ros-cdk-core.RosResource	No description.
attrCreateTime	@alicloud/ros-cdk-core.IResolvable	Attribute CreateTime: The time when the image was created.
attrDescription	@alicloud/ros-cdk-core.IResolvable	Attribute Description: The image description.
attrImageCategory	@alicloud/ros-cdk-core.IResolvable	Attribute ImageCategory: The image type.
attrImageId	@alicloud/ros-cdk-core.IResolvable	Attribute ImageId: The image ID.
attrImageName	@alicloud/ros-cdk-core.IResolvable	Attribute ImageName: The image name.
attrIsSelfShared	@alicloud/ros-cdk-core.IResolvable	Attribute IsSelfShared: Indicates whether the image is shared with other Alibaba Cloud accounts.
attrOsName	@alicloud/ros-cdk-core.IResolvable	Attribute OsName: The display name of the OS in Chinese.
attrOsNameEn	@alicloud/ros-cdk-core.IResolvable	Attribute OsNameEn: The display name of the OS in English.
attrOsType	@alicloud/ros-cdk-core.IResolvable	Attribute OsType: The image OS.
attrPlatform	@alicloud/ros-cdk-core.IResolvable	Attribute Platform: The OS distribution.
attrProgress	@alicloud/ros-cdk-core.IResolvable	Attribute Progress: The progress of image creation.
attrUsage	@alicloud/ros-cdk-core.IResolvable	Attribute Usage: Whether the image is already running in the cloud phone instance.

---

node^Required

public readonly node: ConstructNode;

• Type: @alicloud/ros-cdk-core.ConstructNode

The construct tree node associated with this construct.

---

ref^Required

public readonly ref: string;

• Type: string

---

stack^Required

public readonly stack: Stack;

• Type: @alicloud/ros-cdk-core.Stack

The stack in which this resource is defined.

---

resource^Optional

public readonly resource: RosResource;

• Type: @alicloud/ros-cdk-core.RosResource

---

attrCreateTime^Required

public readonly attrCreateTime: IResolvable;

• Type: @alicloud/ros-cdk-core.IResolvable

Attribute CreateTime: The time when the image was created.

The time follows the ISO 8601 standard.

---

attrDescription^Required

public readonly attrDescription: IResolvable;

• Type: @alicloud/ros-cdk-core.IResolvable

Attribute Description: The image description.

---

attrImageCategory^Required

public readonly attrImageCategory: IResolvable;

• Type: @alicloud/ros-cdk-core.IResolvable

Attribute ImageCategory: The image type.

---

attrImageId^Required

public readonly attrImageId: IResolvable;

• Type: @alicloud/ros-cdk-core.IResolvable

Attribute ImageId: The image ID.

---

attrImageName^Required

public readonly attrImageName: IResolvable;

• Type: @alicloud/ros-cdk-core.IResolvable

Attribute ImageName: The image name.

---

attrIsSelfShared^Required

public readonly attrIsSelfShared: IResolvable;

• Type: @alicloud/ros-cdk-core.IResolvable

Attribute IsSelfShared: Indicates whether the image is shared with other Alibaba Cloud accounts.

---

attrOsName^Required

public readonly attrOsName: IResolvable;

• Type: @alicloud/ros-cdk-core.IResolvable

Attribute OsName: The display name of the OS in Chinese.

---

attrOsNameEn^Required

public readonly attrOsNameEn: IResolvable;

• Type: @alicloud/ros-cdk-core.IResolvable

Attribute OsNameEn: The display name of the OS in English.

---

attrOsType^Required

public readonly attrOsType: IResolvable;

• Type: @alicloud/ros-cdk-core.IResolvable

Attribute OsType: The image OS.

---

attrPlatform^Required

public readonly attrPlatform: IResolvable;

• Type: @alicloud/ros-cdk-core.IResolvable

Attribute Platform: The OS distribution.

---

attrProgress^Required

public readonly attrProgress: IResolvable;

• Type: @alicloud/ros-cdk-core.IResolvable

Attribute Progress: The progress of image creation.

---

attrUsage^Required

public readonly attrUsage: IResolvable;

• Type: @alicloud/ros-cdk-core.IResolvable

Attribute Usage: Whether the image is already running in the cloud phone instance.

---