Skip to content

Image

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

Initializers 

from ros_cdk_cloudphone import datasource
datasource.Image(
  scope: Construct,
  id: str,
  image_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_id typing.Union[str, ros_cdk_core.IResolvable] Property imageId: Image ID.
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_idRequired

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

Property imageId: Image ID.

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_cloudphone import datasource
datasource.Image.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_create_time ros_cdk_core.IResolvable Attribute CreateTime: Image creation time, in ISO 8601 format.
attr_description ros_cdk_core.IResolvable Attribute Description: Image description.
attr_image_category ros_cdk_core.IResolvable Attribute ImageCategory: Image type.
attr_image_id ros_cdk_core.IResolvable Attribute ImageId: Image ID.
attr_image_name ros_cdk_core.IResolvable Attribute ImageName: The name of the mirror image.
attr_is_self_shared ros_cdk_core.IResolvable Attribute IsSelfShared: Whether the image has been shared with other users.
attr_os_name ros_cdk_core.IResolvable Attribute OsName: The Chinese display name of the operating system.
attr_os_name_en ros_cdk_core.IResolvable Attribute OsNameEn: The English display name of the operating system.
attr_os_type ros_cdk_core.IResolvable Attribute OsType: Operating system type.
attr_platform ros_cdk_core.IResolvable Attribute Platform: Operating system distribution.
attr_progress ros_cdk_core.IResolvable Attribute Progress: The progress of mirror image production.
attr_status ros_cdk_core.IResolvable Attribute Status: Image state.
attr_usage ros_cdk_core.IResolvable Attribute Usage: Whether the image is already running in the cloud phone instance.

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_create_timeRequired 

attr_create_time: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute CreateTime: Image creation time, in ISO 8601 format.

attr_descriptionRequired 

attr_description: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute Description: Image description.

attr_image_categoryRequired 

attr_image_category: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute ImageCategory: Image type.

attr_image_idRequired 

attr_image_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute ImageId: Image ID.

attr_image_nameRequired 

attr_image_name: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute ImageName: The name of the mirror image.

attr_is_self_sharedRequired 

attr_is_self_shared: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute IsSelfShared: Whether the image has been shared with other users.

attr_os_nameRequired 

attr_os_name: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute OsName: The Chinese display name of the operating system.

attr_os_name_enRequired 

attr_os_name_en: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute OsNameEn: The English display name of the operating system.

attr_os_typeRequired 

attr_os_type: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute OsType: Operating system type.

attr_platformRequired 

attr_platform: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute Platform: Operating system distribution.

attr_progressRequired 

attr_progress: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute Progress: The progress of mirror image production.

attr_statusRequired 

attr_status: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute Status: Image state.

attr_usageRequired 

attr_usage: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute Usage: Whether the image is already running in the cloud phone instance.