CopyImage
- Implements: ICopyImage
This class encapsulates and extends the ROS resource type ALIYUN::ECS::CopyImage.
Initializers
import com.aliyun.ros.cdk.ecs.CopyImage;
CopyImage.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
.destinationRegionId(java.lang.String)
.destinationRegionId(IResolvable)
.imageId(java.lang.String)
.imageId(IResolvable)
// .allowCopyInSameRegion(java.lang.Boolean)
// .allowCopyInSameRegion(IResolvable)
// .destinationDescription(java.lang.String)
// .destinationDescription(IResolvable)
// .destinationImageName(java.lang.String)
// .destinationImageName(IResolvable)
// .encrypted(java.lang.Boolean)
// .encrypted(IResolvable)
// .kmsKeyId(java.lang.String)
// .kmsKeyId(IResolvable)
// .resourceGroupId(java.lang.String)
// .resourceGroupId(IResolvable)
// .sourceRegionId(java.lang.String)
// .sourceRegionId(IResolvable)
// .tag(IResolvable)
// .tag(java.util.List<IResolvable)
// .tag(RosTag>)
.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. |
destinationRegionId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property destinationRegionId: ID of the region to where the destination custom image belongs. |
imageId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property imageId: ID of the source custom image. |
allowCopyInSameRegion | java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable | Property allowCopyInSameRegion: Whether to allow copying images in the same region. |
destinationDescription | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property destinationDescription: The description of the destination custom image.It cannot begin with http:\/\/ or https:\/\/. Default value: null. |
destinationImageName | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property destinationImageName: Name of the destination custom image.The name is a string of 2 to 128 characters. It must begin with an English or a Chinese character. It can contain A-Z, a-z, Chinese characters, numbers, periods (.), colons (:), underscores (_), and hyphens (-). Default value: null. |
encrypted | java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable | Property encrypted: Whether to encrypt the image. |
kmsKeyId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property kmsKeyId: The ID of the key used to encrypt the image. |
resourceGroupId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property resourceGroupId: The ID of the resource group to which the image copy belongs. |
sourceRegionId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property sourceRegionId: ID of the region to where the source image belongs. |
tag | com.aliyun.ros.cdk.core.IResolvable OR java.util.List | Property tag:. |
scopeRequired
- Type: com.aliyun.ros.cdk.core.Construct
idRequired
- Type: java.lang.String
enableResourcePropertyConstraintOptional
- Type: java.lang.Boolean
destinationRegionIdRequired
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property destinationRegionId: ID of the region to where the destination custom image belongs.
imageIdRequired
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property imageId: ID of the source custom image.
allowCopyInSameRegionOptional
- Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable
Property allowCopyInSameRegion: Whether to allow copying images in the same region.
If set to true, the image will not be copied, the source image id will be returned, and the original image will not be deleted.
destinationDescriptionOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property destinationDescription: The description of the destination custom image.It cannot begin with http:\/\/ or https:\/\/. Default value: null.
destinationImageNameOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property destinationImageName: Name of the destination custom image.The name is a string of 2 to 128 characters. It must begin with an English or a Chinese character. It can contain A-Z, a-z, Chinese characters, numbers, periods (.), colons (:), underscores (_), and hyphens (-). Default value: null.
encryptedOptional
- Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable
Property encrypted: Whether to encrypt the image.
kmsKeyIdOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property kmsKeyId: The ID of the key used to encrypt the image.
resourceGroupIdOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property resourceGroupId: The ID of the resource group to which the image copy belongs.
If not provided, the image copy belongs to the default resource group.
sourceRegionIdOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property sourceRegionId: ID of the region to where the source image belongs.
Default is current region ID.
tagOptional
- Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.List
Property tag:.
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.ecs.CopyImage;
CopyImage.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. |
attrDestinationRegionId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute DestinationRegionId: ID of the region to where the destination custom image belongs. |
attrImageId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute ImageId: ID of the source custom image. |
attrSourceRegionId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute SourceRegionId: ID of the region to where the source image belongs. |
props | CopyImageProps | 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
attrDestinationRegionIdRequired
public java.lang.Object getAttrDestinationRegionId();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute DestinationRegionId: ID of the region to where the destination custom image belongs.
attrImageIdRequired
public java.lang.Object getAttrImageId();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute ImageId: ID of the source custom image.
attrSourceRegionIdRequired
public java.lang.Object getAttrSourceRegionId();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute SourceRegionId: ID of the region to where the source image belongs.
propsRequired
public CopyImageProps getProps();
- Type: CopyImageProps