Image
- Implements: IImage
This class encapsulates and extends the ROS resource type ALIYUN::ENS::Image.
Initializers
import com.aliyun.ros.cdk.ens.Image;
Image.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
.imageName(java.lang.String)
.imageName(IResolvable)
// .deleteAfterImageUpload(java.lang.Boolean)
// .deleteAfterImageUpload(IResolvable)
// .instanceId(java.lang.String)
// .instanceId(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. |
imageName | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property imageName: The name of the image. |
deleteAfterImageUpload | java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable | Property deleteAfterImageUpload: Whether the instance is automatically released after the image is packaged and uploaded successfully, only the build machine is supported. |
instanceId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property instanceId: The ID of the instance corresponding to the image. |
scopeRequired
- Type: com.aliyun.ros.cdk.core.Construct
idRequired
- Type: java.lang.String
enableResourcePropertyConstraintOptional
- Type: java.lang.Boolean
imageNameRequired
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property imageName: The name of the image.
The name must be 2 to 128 characters in length. The name can contain letters, digits, colons (:), underscores (), and hyphens (-). It must start with a letter but cannot start with http:// or https://. The name can contain letters, digits, colons (:), underscores (), and hyphens (-).
deleteAfterImageUploadOptional
- Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable
Property deleteAfterImageUpload: Whether the instance is automatically released after the image is packaged and uploaded successfully, only the build machine is supported.
Optional values: true: When the instance is released, the image is released together with the instance. false: When the instance is released, the image is retained and is not released together with the instance. Empty means false by default.
instanceIdOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property instanceId: The ID of the instance corresponding to the image.
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.ens.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. |
attrArchitecture | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute Architecture: The image architecture. |
attrComputeType | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute ComputeType: Computing type. |
attrCreateTime | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute CreateTime: The image creation time. |
attrImageId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute ImageId: The ID of the image. |
attrImageName | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute ImageName: The name of the image. |
attrImageOwnerAlias | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute ImageOwnerAlias: The source of the image. |
attrImageSize | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute ImageSize: The size of the image. |
attrInstanceId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute InstanceId: The ID of the instance corresponding to the image. |
attrOsVersion | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute OsVersion: The operating system version. |
attrPlatform | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute Platform: The type of operating system used by the image. |
attrSnapshotId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute SnapshotId: The ID of the snapshot corresponding to the image. |
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
attrArchitectureRequired
public java.lang.Object getAttrArchitecture();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute Architecture: The image architecture.
Valid values: i386 x86_64
attrComputeTypeRequired
public java.lang.Object getAttrComputeType();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute ComputeType: Computing type.
ens_vm/ens: x86 computing. bare_metal: x86 bare machine or x86 bare metal. arm_vm: ARM computing. arm_bare_metal: ARM bare machine or ARM bare metal. pcfarm: heterogeneous computing.
attrCreateTimeRequired
public java.lang.Object getAttrCreateTime();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute CreateTime: The image creation time.
The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.
attrImageIdRequired
public java.lang.Object getAttrImageId();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute ImageId: The ID of the image.
attrImageNameRequired
public java.lang.Object getAttrImageName();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute ImageName: The name of the image.
attrImageOwnerAliasRequired
public java.lang.Object getAttrImageOwnerAlias();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute ImageOwnerAlias: The source of the image.
Valid values: system: public images self: your custom images
attrImageSizeRequired
public java.lang.Object getAttrImageSize();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute ImageSize: The size of the image.
Unit: GiB.
attrInstanceIdRequired
public java.lang.Object getAttrInstanceId();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute InstanceId: The ID of the instance corresponding to the image.
attrOsVersionRequired
public java.lang.Object getAttrOsVersion();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute OsVersion: The operating system version.
attrPlatformRequired
public java.lang.Object getAttrPlatform();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute Platform: The type of operating system used by the image.
centos ubuntu alios debian rhel windows
attrSnapshotIdRequired
public java.lang.Object getAttrSnapshotId();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute SnapshotId: The ID of the snapshot corresponding to the image.
propsRequired
public ImageProps getProps();
- Type: ImageProps