Image
- Implements: IImage
This class encapsulates and extends the ROS resource type ALIYUN::CloudPhone::Image.
Initializers
import com.aliyun.ros.cdk.cloudphone.Image;
Image.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
.instanceId(java.lang.String)
.instanceId(IResolvable)
// .description(java.lang.String)
// .description(IResolvable)
// .imageName(java.lang.String)
// .imageName(IResolvable)
.build();
| Name | Type | Description |
|---|---|---|
scope | com.aliyun.ros.cdk.core.Construct | No description. |
id | java.lang.String | No description. |
enableResourcePropertyConstraint | java.lang.Boolean | No description. |
instanceId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property instanceId: The ID of the mobile phone instance. |
description | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property description: The image description. |
imageName | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property imageName: The image name. |
scopeRequired
- Type: com.aliyun.ros.cdk.core.Construct
idRequired
- Type: java.lang.String
enableResourcePropertyConstraintOptional
- Type: java.lang.Boolean
instanceIdRequired
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property instanceId: The ID of the mobile phone instance.
descriptionOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property description: The image description.
The description must be 2 to 256 characters in length. It cannot start with http:// or https://.
imageNameOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property imageName: The image name.
The name must be 2 to 128 characters in length. It can contain letters, digits, colons (:), underscores (_), and hyphens (-). The name must start with a letter but cannot start with http:// or https://.
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 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.
- Type: com.aliyun.ros.cdk.core.ISynthesisSession
The synthesis session.
addCondition
public void addCondition(RosCondition condition)
- Type: com.aliyun.ros.cdk.core.RosCondition
addCount
public void addCount(java.lang.Number OR IResolvable count)
- Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable
addDependency
public void addDependency(Resource resource)
- Type: com.aliyun.ros.cdk.core.Resource
addResourceDesc
public void addResourceDesc(java.lang.String desc)
- Type: java.lang.String
applyRemovalPolicy
public void applyRemovalPolicy(RemovalPolicy policy)
- 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)
- Type: java.lang.String
setMetadata
public void setMetadata(java.lang.String key, java.lang.Object value)
- Type: java.lang.String
- Type: java.lang.Object
Static Functions
| Name | Description |
|---|---|
isConstruct | Return whether the given object is a Construct. |
isConstruct
import com.aliyun.ros.cdk.cloudphone.Image;
Image.isConstruct(java.lang.Object x)
Return whether the given object is a Construct.
- Type: java.lang.Object
Properties
| Name | Type | Description |
|---|---|---|
node | com.aliyun.ros.cdk.core.ConstructNode | The construct tree node associated with this construct. |
env | com.aliyun.ros.cdk.core.IResourceEnvironment | The environment this resource belongs to. |
ref | java.lang.String | No description. |
stack | com.aliyun.ros.cdk.core.Stack | The stack in which this resource is defined. |
resource | com.aliyun.ros.cdk.core.RosResource | No description. |
attrCreateTime | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute CreateTime: The time when the image was created. |
attrDescription | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute Description: The image description. |
attrImageCategory | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute ImageCategory: The image type. |
attrImageId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute ImageId: The image ID. |
attrImageName | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute ImageName: The image name. |
attrIsSelfShared | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute IsSelfShared: Indicates whether the image is shared with other Alibaba Cloud accounts. |
attrOsName | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute OsName: The display name of the OS in Chinese. |
attrOsNameEn | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute OsNameEn: The display name of the OS in English. |
attrOsType | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute OsType: The image OS. |
attrPlatform | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute Platform: The OS distribution. |
attrProgress | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute Progress: The progress of image creation. |
attrUsage | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute Usage: Whether the image is already running in the cloud phone instance. |
props | ImageProps | No description. |
nodeRequired
public ConstructNode getNode();
- Type: com.aliyun.ros.cdk.core.ConstructNode
The construct tree node associated with this construct.
envRequired
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.
refRequired
public java.lang.String getRef();
- Type: java.lang.String
stackRequired
public Stack getStack();
- Type: com.aliyun.ros.cdk.core.Stack
The stack in which this resource is defined.
resourceOptional
public RosResource getResource();
- Type: com.aliyun.ros.cdk.core.RosResource
attrCreateTimeRequired
public java.lang.Object getAttrCreateTime();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute CreateTime: The time when the image was created.
The time follows the ISO 8601 standard.
attrDescriptionRequired
public java.lang.Object getAttrDescription();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute Description: The image description.
attrImageCategoryRequired
public java.lang.Object getAttrImageCategory();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute ImageCategory: The image type.
attrImageIdRequired
public java.lang.Object getAttrImageId();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute ImageId: The image ID.
attrImageNameRequired
public java.lang.Object getAttrImageName();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute ImageName: The image name.
attrIsSelfSharedRequired
public java.lang.Object getAttrIsSelfShared();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute IsSelfShared: Indicates whether the image is shared with other Alibaba Cloud accounts.
attrOsNameRequired
public java.lang.Object getAttrOsName();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute OsName: The display name of the OS in Chinese.
attrOsNameEnRequired
public java.lang.Object getAttrOsNameEn();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute OsNameEn: The display name of the OS in English.
attrOsTypeRequired
public java.lang.Object getAttrOsType();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute OsType: The image OS.
attrPlatformRequired
public java.lang.Object getAttrPlatform();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute Platform: The OS distribution.
attrProgressRequired
public java.lang.Object getAttrProgress();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute Progress: The progress of image creation.
attrUsageRequired
public java.lang.Object getAttrUsage();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute Usage: Whether the image is already running in the cloud phone instance.
propsRequired
public ImageProps getProps();
- Type: ImageProps