Image
- Implements: @alicloud/ros-cdk-cloudphone.datasource.IImage
This class encapsulates and extends the ROS resource type DATASOURCE::CloudPhone::Image.
Initializers
import { datasource } from '@alicloud/ros-cdk-cloudphone'
new datasource.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
- Type: ImageProps
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. |
fetchCondition | No description. |
fetchDependency | No description. |
fetchResourceDesc | 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.
- Type: @alicloud/ros-cdk-core.ISynthesisSession
The synthesis session.
addCondition
public addCondition(condition: RosCondition): void
- Type: @alicloud/ros-cdk-core.RosCondition
addCount
public addCount(count: number | IResolvable): void
- Type: number | @alicloud/ros-cdk-core.IResolvable
addDependency
public addDependency(resource: Resource): void
- Type: @alicloud/ros-cdk-core.Resource
addResourceDesc
public addResourceDesc(desc: string): void
- Type: string
applyRemovalPolicy
public applyRemovalPolicy(policy: RemovalPolicy): void
- Type: @alicloud/ros-cdk-core.RemovalPolicy
fetchCondition
public fetchCondition(): RosCondition
fetchDependency
public fetchDependency(): string[]
fetchResourceDesc
public fetchResourceDesc(): string
getAtt
public getAtt(name: string): IResolvable
- Type: string
setMetadata
public setMetadata(key: string, value: any): void
- Type: string
- Type: any
Static Functions
| Name | Description |
|---|---|
isConstruct | Return whether the given object is a Construct. |
isConstruct
import { datasource } from '@alicloud/ros-cdk-cloudphone'
datasource.Image.isConstruct(x: any)
Return whether the given object is a Construct.
- Type: any
Properties
| Name | Type | Description |
|---|---|---|
node | @alicloud/ros-cdk-core.ConstructNode | The construct tree node associated with this construct. |
env | @alicloud/ros-cdk-core.IResourceEnvironment | The environment this resource belongs to. |
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 | string | @alicloud/ros-cdk-core.IResolvable | Attribute CreateTime: Image creation time, in ISO 8601 format. |
attrDescription | string | @alicloud/ros-cdk-core.IResolvable | Attribute Description: Image description. |
attrImageCategory | string | @alicloud/ros-cdk-core.IResolvable | Attribute ImageCategory: Image type. |
attrImageId | string | @alicloud/ros-cdk-core.IResolvable | Attribute ImageId: Image ID. |
attrImageName | string | @alicloud/ros-cdk-core.IResolvable | Attribute ImageName: The name of the mirror image. |
attrIsSelfShared | string | @alicloud/ros-cdk-core.IResolvable | Attribute IsSelfShared: Whether the image has been shared with other users. |
attrOsName | string | @alicloud/ros-cdk-core.IResolvable | Attribute OsName: The Chinese display name of the operating system. |
attrOsNameEn | string | @alicloud/ros-cdk-core.IResolvable | Attribute OsNameEn: The English display name of the operating system. |
attrOsType | string | @alicloud/ros-cdk-core.IResolvable | Attribute OsType: Operating system type. |
attrPlatform | string | @alicloud/ros-cdk-core.IResolvable | Attribute Platform: Operating system distribution. |
attrProgress | string | @alicloud/ros-cdk-core.IResolvable | Attribute Progress: The progress of mirror image production. |
attrStatus | string | @alicloud/ros-cdk-core.IResolvable | Attribute Status: Image state. |
attrUsage | string | @alicloud/ros-cdk-core.IResolvable | Attribute Usage: Whether the image is already running in the cloud phone instance. |
props | ImageProps | No description. |
nodeRequired
public readonly node: ConstructNode;
- Type: @alicloud/ros-cdk-core.ConstructNode
The construct tree node associated with this construct.
envRequired
public readonly env: IResourceEnvironment;
- Type: @alicloud/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.
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: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute CreateTime: Image creation time, in ISO 8601 format.
attrDescriptionRequired
public readonly attrDescription: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute Description: Image description.
attrImageCategoryRequired
public readonly attrImageCategory: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute ImageCategory: Image type.
attrImageIdRequired
public readonly attrImageId: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute ImageId: Image ID.
attrImageNameRequired
public readonly attrImageName: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute ImageName: The name of the mirror image.
attrIsSelfSharedRequired
public readonly attrIsSelfShared: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute IsSelfShared: Whether the image has been shared with other users.
attrOsNameRequired
public readonly attrOsName: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute OsName: The Chinese display name of the operating system.
attrOsNameEnRequired
public readonly attrOsNameEn: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute OsNameEn: The English display name of the operating system.
attrOsTypeRequired
public readonly attrOsType: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute OsType: Operating system type.
attrPlatformRequired
public readonly attrPlatform: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute Platform: Operating system distribution.
attrProgressRequired
public readonly attrProgress: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute Progress: The progress of mirror image production.
attrStatusRequired
public readonly attrStatus: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute Status: Image state.
attrUsageRequired
public readonly attrUsage: string | IResolvable;
- Type: string | @alicloud/ros-cdk-core.IResolvable
Attribute Usage: Whether the image is already running in the cloud phone instance.
propsRequired
public readonly props: ImageProps;
- Type: ImageProps