ImageCache
- Implements: IImageCache
This class encapsulates and extends the ROS resource type ALIYUN::ECI::ImageCache.
Initializers
import com.aliyun.ros.cdk.eci.ImageCache;
ImageCache.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
.image(IResolvable)
.image(java.util.List<java.lang.String)
.image(IResolvable>)
.imageCacheName(java.lang.String)
.imageCacheName(IResolvable)
.securityGroupId(java.lang.String)
.securityGroupId(IResolvable)
.vSwitchId(java.lang.String)
.vSwitchId(IResolvable)
// .acrRegistryInfo(IResolvable)
// .acrRegistryInfo(java.util.List<IResolvable)
// .acrRegistryInfo(AcrRegistryInfoProperty>)
// .autoMatchImageCache(java.lang.Boolean)
// .autoMatchImageCache(IResolvable)
// .eipInstanceId(java.lang.String)
// .eipInstanceId(IResolvable)
// .imageCacheSize(java.lang.Number)
// .imageCacheSize(IResolvable)
// .imageRegistryCredential(IResolvable)
// .imageRegistryCredential(java.util.List<java.lang.String)
// .imageRegistryCredential(IResolvable>)
// .resourceGroupId(java.lang.String)
// .resourceGroupId(IResolvable)
// .retentionDays(java.lang.Number)
// .retentionDays(IResolvable)
// .zoneId(java.lang.String)
// .zoneId(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. |
image | com.aliyun.ros.cdk.core.IResolvable OR java.util.List | Property image: The container images used to create the image cache. |
imageCacheName | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property imageCacheName: Image cache name. |
securityGroupId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property securityGroupId: Security group ID. |
vSwitchId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property vSwitchId: The ID of the vSwitch. |
acrRegistryInfo | com.aliyun.ros.cdk.core.IResolvable OR java.util.List | Property acrRegistryInfo: The information about the ACR instance. |
autoMatchImageCache | java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable | Property autoMatchImageCache: Specifies whether to enable reuse of image cache layers. |
eipInstanceId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property eipInstanceId: If you want to pull the public network image, you need to configure the public network ip or configure the switch NAT gateway. |
imageCacheSize | java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable | Property imageCacheSize: The size of the image cache. |
imageRegistryCredential | com.aliyun.ros.cdk.core.IResolvable OR java.util.List | Property imageRegistryCredential: The credentials of the image repository. |
resourceGroupId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property resourceGroupId: Resource group id. |
retentionDays | java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable | Property retentionDays: The retention period of the image cache. |
zoneId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property zoneId: The zone ID of the image cache. |
scopeRequired
- Type: com.aliyun.ros.cdk.core.Construct
idRequired
- Type: java.lang.String
enableResourcePropertyConstraintOptional
- Type: java.lang.Boolean
imageRequired
- Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.List
Property image: The container images used to create the image cache.
imageCacheNameRequired
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property imageCacheName: Image cache name.
securityGroupIdRequired
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property securityGroupId: Security group ID.
vSwitchIdRequired
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property vSwitchId: The ID of the vSwitch.
You can specify up to 10 vSwitch IDs, separated by commas (,). For example, vsw-*,vsw-*.
acrRegistryInfoOptional
- Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.List
AcrRegistryInfoProperty>
Property acrRegistryInfo: The information about the ACR instance.
autoMatchImageCacheOptional
- Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable
Property autoMatchImageCache: Specifies whether to enable reuse of image cache layers.
If you enable this feature, and the image cache that you want to createand an existing image cache contain duplicate image layers, the system reuses the duplicate image layers to create the new image cache. This accelerates the creation of the image cache. Valid values: true: enables reuse of image cache layers. false: disables reuse of image cache layers. Default value: false.
eipInstanceIdOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property eipInstanceId: If you want to pull the public network image, you need to configure the public network ip or configure the switch NAT gateway.
imageCacheSizeOptional
- Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable
Property imageCacheSize: The size of the image cache.
Unit: GiB. Default value: 20.
imageRegistryCredentialOptional
- Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.List
Property imageRegistryCredential: The credentials of the image repository.
resourceGroupIdOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property resourceGroupId: Resource group id.
retentionDaysOptional
- Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable
Property retentionDays: The retention period of the image cache.
Unit: days. When the retention period ends, the image cache expires and is deleted. By default, image caches never expire. Note: The image caches that fail to be created are only retained for one day.
zoneIdOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property zoneId: The zone ID of the image cache.
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.eci.ImageCache;
ImageCache.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. |
attrImageCacheId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute ImageCacheId: The ID of the image cache. |
props | ImageCacheProps | 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
attrImageCacheIdRequired
public java.lang.Object getAttrImageCacheId();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute ImageCacheId: The ID of the image cache.
propsRequired
public ImageCacheProps getProps();
- Type: ImageCacheProps