Skip to content

Image

This class encapsulates and extends the ROS resource type ALIYUN::CloudPhone::Image, which is used to create a custom image for an Elastic Cloud Phone (ECP) instance.

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.

scopeRequired

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

idRequired

  • Type: string

propsRequired

enableResourcePropertyConstraintOptional

  • 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.

sessionRequired

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

The synthesis session.

addCondition 

public addCondition(condition: RosCondition): void

conditionRequired

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

addCount 

public addCount(count: number | IResolvable): void

countRequired

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

addDependency 

public addDependency(resource: Resource): void

resourceRequired

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

addResourceDesc 

public addResourceDesc(desc: string): void

descRequired

  • Type: string

applyRemovalPolicy 

public applyRemovalPolicy(policy: RemovalPolicy): void

policyRequired

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

getAtt 

public getAtt(name: string): IResolvable

nameRequired

  • Type: string

setMetadata 

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

keyRequired

  • Type: string

valueRequired

  • 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.

xRequired

  • 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.

nodeRequired 

public readonly node: ConstructNode;
  • Type: @alicloud/ros-cdk-core.ConstructNode

The construct tree node associated with this construct.

refRequired 

public readonly ref: string;
  • Type: string

stackRequired 

public readonly stack: Stack;
  • Type: @alicloud/ros-cdk-core.Stack

The stack in which this resource is defined.

resourceOptional 

public readonly resource: RosResource;
  • Type: @alicloud/ros-cdk-core.RosResource

attrCreateTimeRequired 

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.

attrDescriptionRequired 

public readonly attrDescription: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute Description: The image description.

attrImageCategoryRequired 

public readonly attrImageCategory: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute ImageCategory: The image type.

attrImageIdRequired 

public readonly attrImageId: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute ImageId: The image ID.

attrImageNameRequired 

public readonly attrImageName: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute ImageName: The image name.

attrIsSelfSharedRequired 

public readonly attrIsSelfShared: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

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

attrOsNameRequired 

public readonly attrOsName: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

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

attrOsNameEnRequired 

public readonly attrOsNameEn: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

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

attrOsTypeRequired 

public readonly attrOsType: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute OsType: The image OS.

attrPlatformRequired 

public readonly attrPlatform: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute Platform: The OS distribution.

attrProgressRequired 

public readonly attrProgress: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute Progress: The progress of image creation.

attrUsageRequired 

public readonly attrUsage: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

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