Skip to content

ImageCache

This class encapsulates and extends the ROS resource type DATASOURCE::ECI::ImageCache, which is used to query the information about an image cache.

Initializers 

from ros_cdk_eci import datasource
datasource.ImageCache(
  scope: Construct,
  id: str,
  image_cache_id: typing.Union[str, IResolvable],
  refresh_options: 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_cache_id typing.Union[str, ros_cdk_core.IResolvable] Property imageCacheId: ImageCacheId.
refresh_options typing.Union[str, ros_cdk_core.IResolvable] Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated.
enable_resource_property_constraint bool No description.

scopeRequired

  • Type: ros_cdk_core.Construct

idRequired

  • Type: str

image_cache_idRequired

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

Property imageCacheId: ImageCacheId.

refresh_optionsOptional

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

Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated.

Valid values:

  • Never: Never refresh the datasource resource when the stack is updated.
  • Always: Always refresh the datasource resource when the stack is updated. Default is Never.

enable_resource_property_constraintOptional

  • 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.

sessionRequired

  • Type: ros_cdk_core.ISynthesisSession

The synthesis session.

add_condition 

def add_condition(
  condition: RosCondition
) -> None

conditionRequired

  • Type: ros_cdk_core.RosCondition

add_count 

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

countRequired

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

add_dependency 

def add_dependency(
  resource: Resource
) -> None

resourceRequired

  • Type: ros_cdk_core.Resource

add_resource_desc 

def add_resource_desc(
  desc: str
) -> None

descRequired

  • Type: str

apply_removal_policy 

def apply_removal_policy(
  policy: RemovalPolicy
) -> None

policyRequired

  • Type: ros_cdk_core.RemovalPolicy

get_att 

def get_att(
  name: str
) -> IResolvable

nameRequired

  • Type: str

set_metadata 

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

keyRequired

  • Type: str

valueRequired

  • Type: typing.Any

Static Functions

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

is_construct 

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

Return whether the given object is a Construct.

xRequired

  • 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_container_group_id ros_cdk_core.IResolvable Attribute ContainerGroupId: ContainerGroupId.
attr_create_time ros_cdk_core.IResolvable Attribute CreateTime: CreateTime.
attr_elimination_strategy ros_cdk_core.IResolvable Attribute EliminationStrategy: The elimination strategy of the mirror cache.
attr_events ros_cdk_core.IResolvable Attribute Events: Events.
attr_expire_date_time ros_cdk_core.IResolvable Attribute ExpireDateTime: ExpireDateTime.
attr_flash_snapshot_id ros_cdk_core.IResolvable Attribute FlashSnapshotId: FlashSnapshotId.
attr_image_cache_id ros_cdk_core.IResolvable Attribute ImageCacheId: ImageCacheId.
attr_image_cache_name ros_cdk_core.IResolvable Attribute ImageCacheName: ImageCacheName.
attr_image_cache_size ros_cdk_core.IResolvable Attribute ImageCacheSize: ImageCacheSize.
attr_image_cache_tags ros_cdk_core.IResolvable Attribute ImageCacheTags: Tags.
attr_images ros_cdk_core.IResolvable Attribute Images: Images.
attr_progress ros_cdk_core.IResolvable Attribute Progress: Progress.
attr_resource_group_id ros_cdk_core.IResolvable Attribute ResourceGroupId: ResourceGroupId.
attr_snapshot_id ros_cdk_core.IResolvable Attribute SnapshotId: SnapshotId.

nodeRequired 

node: ConstructNode
  • Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

refRequired 

ref: str
  • Type: str

stackRequired 

stack: Stack
  • Type: ros_cdk_core.Stack

The stack in which this resource is defined.

resourceOptional 

resource: RosResource
  • Type: ros_cdk_core.RosResource

attr_container_group_idRequired 

attr_container_group_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute ContainerGroupId: ContainerGroupId.

attr_create_timeRequired 

attr_create_time: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute CreateTime: CreateTime.

attr_elimination_strategyRequired 

attr_elimination_strategy: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute EliminationStrategy: The elimination strategy of the mirror cache.

The default is empty, indicating that it has been kept.

attr_eventsRequired 

attr_events: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute Events: Events.

attr_expire_date_timeRequired 

attr_expire_date_time: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute ExpireDateTime: ExpireDateTime.

attr_flash_snapshot_idRequired 

attr_flash_snapshot_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute FlashSnapshotId: FlashSnapshotId.

attr_image_cache_idRequired 

attr_image_cache_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute ImageCacheId: ImageCacheId.

attr_image_cache_nameRequired 

attr_image_cache_name: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute ImageCacheName: ImageCacheName.

attr_image_cache_sizeRequired 

attr_image_cache_size: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute ImageCacheSize: ImageCacheSize.

attr_image_cache_tagsRequired 

attr_image_cache_tags: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute ImageCacheTags: Tags.

attr_imagesRequired 

attr_images: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute Images: Images.

attr_progressRequired 

attr_progress: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute Progress: Progress.

attr_resource_group_idRequired 

attr_resource_group_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute ResourceGroupId: ResourceGroupId.

attr_snapshot_idRequired 

attr_snapshot_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute SnapshotId: SnapshotId.