ImageCache

This class encapsulates and extends the ROS resource type ALIYUN::ECI::ImageCache, which is used to create an image cache.

Initializers

import ros_cdk_eci
ros_cdk_eci.ImageCache(
  scope: Construct,
  id: str,
  image: typing.Union[IResolvable, typing.List[typing.Union[str, IResolvable]]],
  image_cache_name: typing.Union[str, IResolvable],
  security_group_id: typing.Union[str, IResolvable],
  v_switch_id: typing.Union[str, IResolvable],
  acr_registry_info: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, AcrRegistryInfoProperty]]] = None,
  auto_match_image_cache: typing.Union[bool, IResolvable] = None,
  eip_instance_id: typing.Union[str, IResolvable] = None,
  image_cache_size: typing.Union[typing.Union[int, float], IResolvable] = None,
  image_registry_credential: typing.Union[IResolvable, typing.List[typing.Union[str, IResolvable]]] = None,
  resource_group_id: typing.Union[str, IResolvable] = None,
  retention_days: typing.Union[typing.Union[int, float], IResolvable] = None,
  zone_id: typing.Union[str, IResolvable] = None,
  enable_resource_property_constraint: bool = None
)

Name	Type	Description
scope	ros_cdk_core.Construct	No description.
id	str	No description.
image	typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[str, ros_cdk_core.IResolvable]]]	Property image: The image list to be cached.
image_cache_name	typing.Union[str, ros_cdk_core.IResolvable]	Property imageCacheName: Image cache name.
security_group_id	typing.Union[str, ros_cdk_core.IResolvable]	Property securityGroupId: Security group ID.
v_switch_id	typing.Union[str, ros_cdk_core.IResolvable]	Property vSwitchId: VSwitch ID.
acr_registry_info	typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, AcrRegistryInfoProperty]]]	Property acrRegistryInfo: Enterprise Edition access credential configuration information.
auto_match_image_cache	typing.Union[bool, ros_cdk_core.IResolvable]	Property autoMatchImageCache: Specifies whether to enable reuse of image cache layers.
eip_instance_id	typing.Union[str, 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.
image_cache_size	typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]	Property imageCacheSize: The size of the image cache.
image_registry_credential	typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[str, ros_cdk_core.IResolvable]]]	Property imageRegistryCredential: Private image password.
resource_group_id	typing.Union[str, ros_cdk_core.IResolvable]	Property resourceGroupId: Resource group id.
retention_days	typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]	Property retentionDays: The retention period of the image cache.
zone_id	typing.Union[str, ros_cdk_core.IResolvable]	Property zoneId: The zone ID of the image cache.
enable_resource_property_constraint	bool	No description.

---

scope^Required

• Type: ros_cdk_core.Construct

---

id^Required

• Type: str

---

image^Required

• Type: typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[str, ros_cdk_core.IResolvable]]]

Property image: The image list to be cached.

---

image_cache_name^Required

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property imageCacheName: Image cache name.

---

security_group_id^Required

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property securityGroupId: Security group ID.

---

v_switch_id^Required

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property vSwitchId: VSwitch ID.

---

acr_registry_info^Optional

• Type: typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[ros_cdk_core.IResolvable, AcrRegistryInfoProperty]]]

Property acrRegistryInfo: Enterprise Edition access credential configuration information.

---

auto_match_image_cache^Optional

• Type: typing.Union[bool, 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.

---

eip_instance_id^Optional

• Type: typing.Union[str, 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.

---

image_cache_size^Optional

• Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

Property imageCacheSize: The size of the image cache.

Unit: GiB. Default value: 20.

---

image_registry_credential^Optional

• Type: typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[str, ros_cdk_core.IResolvable]]]

Property imageRegistryCredential: Private image password.

Alibaba Cloud ACR image can be left blank.

---

resource_group_id^Optional

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property resourceGroupId: Resource group id.

---

retention_days^Optional

• Type: typing.Union[typing.Union[int, float], 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.

---

zone_id^Optional

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property zoneId: The zone ID of the image cache.

---

enable_resource_property_constraint^Optional

• Type: bool

---

Methods

Name	Description
to_string	Returns a string representation of this construct.
synthesize	Allows this construct to emit artifacts into the cloud assembly during synthesis.
add_condition	No description.
add_count	No description.
add_dependency	No description.
add_resource_desc	No description.
apply_removal_policy	No description.
get_att	No description.
set_metadata	No description.

---

to_string

def to_string() -> str

Returns a string representation of this construct.

synthesize

def synthesize(
  session: ISynthesisSession
) -> None

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.

session^Required

• Type: ros_cdk_core.ISynthesisSession

The synthesis session.

---

add_condition

def add_condition(
  condition: RosCondition
) -> None

condition^Required

• Type: ros_cdk_core.RosCondition

---

add_count

def add_count(
  count: typing.Union[typing.Union[int, float], IResolvable]
) -> None

count^Required

• Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

---

add_dependency

def add_dependency(
  resource: Resource
) -> None

resource^Required

• Type: ros_cdk_core.Resource

---

add_resource_desc

def add_resource_desc(
  desc: str
) -> None

desc^Required

• Type: str

---

apply_removal_policy

def apply_removal_policy(
  policy: RemovalPolicy
) -> None

policy^Required

• Type: ros_cdk_core.RemovalPolicy

---

get_att

def get_att(
  name: str
) -> IResolvable

name^Required

• Type: str

---

set_metadata

def set_metadata(
  key: str,
  value: typing.Any
) -> None

key^Required

• Type: str

---

value^Required

• Type: typing.Any

---

Static Functions

Name	Description
is_construct	Return whether the given object is a Construct.

---

is_construct

import ros_cdk_eci
ros_cdk_eci.ImageCache.is_construct(
  x: typing.Any
)

Return whether the given object is a Construct.

x^Required

• Type: typing.Any

---

Properties

Name	Type	Description
node	ros_cdk_core.ConstructNode	The construct tree node associated with this construct.
ref	str	No description.
stack	ros_cdk_core.Stack	The stack in which this resource is defined.
resource	ros_cdk_core.RosResource	No description.
attr_image_cache_id	ros_cdk_core.IResolvable	Attribute ImageCacheId: The ID of the image cache.

---

node^Required

node: ConstructNode

• Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

---

ref^Required

ref: str

• Type: str

---

stack^Required

stack: Stack

• Type: ros_cdk_core.Stack

The stack in which this resource is defined.

---

resource^Optional

resource: RosResource

• Type: ros_cdk_core.RosResource

---

attr_image_cache_id^Required

attr_image_cache_id: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute ImageCacheId: The ID of the image cache.

---