Image
- Implements: ros_cdk_ens.datasource.IImage
This class encapsulates and extends the ROS resource type DATASOURCE::ENS::Image.
Initializers
from ros_cdk_ens 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: The ID of the image. |
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: The ID of the image.
Fuzzy search is supported.
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. |
fetch_condition | No description. |
fetch_dependency | No description. |
fetch_resource_desc | 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.
- Type: ros_cdk_core.ISynthesisSession
The synthesis session.
add_condition
def add_condition(
condition: RosCondition
) -> None
- Type: ros_cdk_core.RosCondition
add_count
def add_count(
count: typing.Union[typing.Union[int, float], IResolvable]
) -> None
- Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]
add_dependency
def add_dependency(
resource: Resource
) -> None
- Type: ros_cdk_core.Resource
add_resource_desc
def add_resource_desc(
desc: str
) -> None
- Type: str
apply_removal_policy
def apply_removal_policy(
policy: RemovalPolicy
) -> None
- Type: ros_cdk_core.RemovalPolicy
fetch_condition
def fetch_condition() -> RosCondition
fetch_dependency
def fetch_dependency() -> typing.List[str]
fetch_resource_desc
def fetch_resource_desc() -> str
get_att
def get_att(
name: str
) -> IResolvable
- Type: str
set_metadata
def set_metadata(
key: str,
value: typing.Any
) -> None
- Type: str
- Type: typing.Any
Static Functions
| Name | Description |
|---|---|
is_construct | Return whether the given object is a Construct. |
is_construct
from ros_cdk_ens import datasource
datasource.Image.is_construct(
x: typing.Any
)
Return whether the given object is a Construct.
- Type: typing.Any
Properties
| Name | Type | Description |
|---|---|---|
node | ros_cdk_core.ConstructNode | The construct tree node associated with this construct. |
env | ros_cdk_core.IResourceEnvironment | The environment this resource belongs to. |
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_architecture | typing.Union[str, ros_cdk_core.IResolvable] | Attribute Architecture: The image architecture. |
attr_compute_type | typing.Union[str, ros_cdk_core.IResolvable] | Attribute ComputeType: Computing type. |
attr_create_time | typing.Union[str, ros_cdk_core.IResolvable] | Attribute CreateTime: The image creation time. |
attr_image_id | typing.Union[str, ros_cdk_core.IResolvable] | Attribute ImageId: The ID of the image. |
attr_image_name | typing.Union[str, ros_cdk_core.IResolvable] | Attribute ImageName: The name of the image. |
attr_image_owner_alias | typing.Union[str, ros_cdk_core.IResolvable] | Attribute ImageOwnerAlias: The source of the image. |
attr_image_size | typing.Union[str, ros_cdk_core.IResolvable] | Attribute ImageSize: The size of the image. |
attr_instance_id | typing.Union[str, ros_cdk_core.IResolvable] | Attribute InstanceId: The ID of the instance corresponding to the image. |
attr_os_version | typing.Union[str, ros_cdk_core.IResolvable] | Attribute OsVersion: The operating system version. |
attr_platform | typing.Union[str, ros_cdk_core.IResolvable] | Attribute Platform: The type of operating system used by the image. |
attr_snapshot_id | typing.Union[str, ros_cdk_core.IResolvable] | Attribute SnapshotId: The ID of the snapshot corresponding to the image. |
props | ImageProps | No description. |
nodeRequired
node: ConstructNode
- Type: ros_cdk_core.ConstructNode
The construct tree node associated with this construct.
envRequired
env: IResourceEnvironment
- Type: 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
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_architectureRequired
attr_architecture: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute Architecture: The image architecture.
Valid values:
- i386
- x86_64
attr_compute_typeRequired
attr_compute_type: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute ComputeType: Computing type.
ens_vm/ens: x86 computing. bare_metal: x86 bare machine or x86 bare metal. arm_vm: ARM computing. arm_bare_metal: ARM bare machine or ARM bare metal. pcfarm: heterogeneous computing.
attr_create_timeRequired
attr_create_time: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute CreateTime: The image creation time.
The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.
attr_image_idRequired
attr_image_id: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute ImageId: The ID of the image.
attr_image_nameRequired
attr_image_name: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute ImageName: The name of the image.
attr_image_owner_aliasRequired
attr_image_owner_alias: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute ImageOwnerAlias: The source of the image.
Valid values:
- others: a custom image that is shared by other Alibaba Cloud accounts.
- self: your own custom image.
attr_image_sizeRequired
attr_image_size: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute ImageSize: The size of the image.
Unit: GiB.
attr_instance_idRequired
attr_instance_id: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute InstanceId: The ID of the instance corresponding to the image.
attr_os_versionRequired
attr_os_version: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute OsVersion: The operating system version.
attr_platformRequired
attr_platform: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute Platform: The type of operating system used by the image.
Valid values:
- centos
- ubuntu
- alios
- debian
- rhel
- windows
attr_snapshot_idRequired
attr_snapshot_id: typing.Union[str, IResolvable]
- Type: typing.Union[str, ros_cdk_core.IResolvable]
Attribute SnapshotId: The ID of the snapshot corresponding to the image.
propsRequired
props: ImageProps
- Type: ImageProps