volcenginecc v0.0.2, Oct 11 25

volcenginecc v0.0.2 published on Saturday, Oct 11, 2025 by Volcengine

volcenginecc.ecs.Image

volcenginecc v0.0.2 published on Saturday, Oct 11, 2025 by Volcengine

Example Usage

Example coming soon!

Example coming soon!

Example coming soon!

Example coming soon!

Example coming soon!

resources:
  imageDemo:
    type: volcenginecc:ecs:Image
    name: ImageDemo
    properties:
      bootMode: UEFI
      description: ImageDemo Example
      imageName: image-demo
      instanceId: i-ydzhj1el8gr9cxxdnxxxx
      kernel: Linux
      licenseType: BYOL
      osName: CentOS
      osType: Linux
      platform: CentOS
      platformVersion: '8.3'
      projectName: default
      sharePermissions:
        - 2000000***
      tags:
        - key: env
          value: test

Create Image Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new Image(name: string, args: ImageArgs, opts?: CustomResourceOptions);

@overload
def Image(resource_name: str,
          args: ImageArgs,
          opts: Optional[ResourceOptions] = None)

@overload
def Image(resource_name: str,
          opts: Optional[ResourceOptions] = None,
          image_name: Optional[str] = None,
          os_name: Optional[str] = None,
          platform: Optional[str] = None,
          instance_id: Optional[str] = None,
          kernel: Optional[str] = None,
          license_type: Optional[str] = None,
          description: Optional[str] = None,
          os_type: Optional[str] = None,
          detection_results: Optional[ImageDetectionResultsArgs] = None,
          platform_version: Optional[str] = None,
          project_name: Optional[str] = None,
          share_permissions: Optional[Sequence[str]] = None,
          snapshot_group_id: Optional[str] = None,
          snapshot_id: Optional[str] = None,
          tags: Optional[Sequence[ImageTagArgs]] = None)

func NewImage(ctx *Context, name string, args ImageArgs, opts ...ResourceOption) (*Image, error)

public Image(string name, ImageArgs args, CustomResourceOptions? opts = null)

public Image(String name, ImageArgs args)
public Image(String name, ImageArgs args, CustomResourceOptions options)

type: volcenginecc:ecs:Image
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name string: The unique name of the resource.
args ImageArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
args ImageArgs: The arguments to resource properties.
opts ResourceOptions: Bag of options to control resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args ImageArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args ImageArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args ImageArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var imageResource = new Volcenginecc.Ecs.Image("imageResource", new()
{
    ImageName = "string",
    OsName = "string",
    Platform = "string",
    InstanceId = "string",
    Kernel = "string",
    LicenseType = "string",
    Description = "string",
    OsType = "string",
    DetectionResults = new Volcenginecc.Ecs.Inputs.ImageDetectionResultsArgs
    {
        DetectionStatus = "string",
        Items = new[]
        {
            new Volcenginecc.Ecs.Inputs.ImageDetectionResultsItemArgs
            {
                Name = "string",
                Result = "string",
                RiskCode = "string",
                RiskLevel = "string",
            },
        },
    },
    PlatformVersion = "string",
    ProjectName = "string",
    SharePermissions = new[]
    {
        "string",
    },
    SnapshotGroupId = "string",
    SnapshotId = "string",
    Tags = new[]
    {
        new Volcenginecc.Ecs.Inputs.ImageTagArgs
        {
            Key = "string",
            Value = "string",
        },
    },
});

example, err := ecs.NewImage(ctx, "imageResource", &ecs.ImageArgs{
	ImageName:   pulumi.String("string"),
	OsName:      pulumi.String("string"),
	Platform:    pulumi.String("string"),
	InstanceId:  pulumi.String("string"),
	Kernel:      pulumi.String("string"),
	LicenseType: pulumi.String("string"),
	Description: pulumi.String("string"),
	OsType:      pulumi.String("string"),
	DetectionResults: &ecs.ImageDetectionResultsArgs{
		DetectionStatus: pulumi.String("string"),
		Items: ecs.ImageDetectionResultsItemArray{
			&ecs.ImageDetectionResultsItemArgs{
				Name:      pulumi.String("string"),
				Result:    pulumi.String("string"),
				RiskCode:  pulumi.String("string"),
				RiskLevel: pulumi.String("string"),
			},
		},
	},
	PlatformVersion: pulumi.String("string"),
	ProjectName:     pulumi.String("string"),
	SharePermissions: pulumi.StringArray{
		pulumi.String("string"),
	},
	SnapshotGroupId: pulumi.String("string"),
	SnapshotId:      pulumi.String("string"),
	Tags: ecs.ImageTagArray{
		&ecs.ImageTagArgs{
			Key:   pulumi.String("string"),
			Value: pulumi.String("string"),
		},
	},
})

var imageResource = new Image("imageResource", ImageArgs.builder()
    .imageName("string")
    .osName("string")
    .platform("string")
    .instanceId("string")
    .kernel("string")
    .licenseType("string")
    .description("string")
    .osType("string")
    .detectionResults(ImageDetectionResultsArgs.builder()
        .detectionStatus("string")
        .items(ImageDetectionResultsItemArgs.builder()
            .name("string")
            .result("string")
            .riskCode("string")
            .riskLevel("string")
            .build())
        .build())
    .platformVersion("string")
    .projectName("string")
    .sharePermissions("string")
    .snapshotGroupId("string")
    .snapshotId("string")
    .tags(ImageTagArgs.builder()
        .key("string")
        .value("string")
        .build())
    .build());

image_resource = volcenginecc.ecs.Image("imageResource",
    image_name="string",
    os_name="string",
    platform="string",
    instance_id="string",
    kernel="string",
    license_type="string",
    description="string",
    os_type="string",
    detection_results={
        "detection_status": "string",
        "items": [{
            "name": "string",
            "result": "string",
            "risk_code": "string",
            "risk_level": "string",
        }],
    },
    platform_version="string",
    project_name="string",
    share_permissions=["string"],
    snapshot_group_id="string",
    snapshot_id="string",
    tags=[{
        "key": "string",
        "value": "string",
    }])

const imageResource = new volcenginecc.ecs.Image("imageResource", {
    imageName: "string",
    osName: "string",
    platform: "string",
    instanceId: "string",
    kernel: "string",
    licenseType: "string",
    description: "string",
    osType: "string",
    detectionResults: {
        detectionStatus: "string",
        items: [{
            name: "string",
            result: "string",
            riskCode: "string",
            riskLevel: "string",
        }],
    },
    platformVersion: "string",
    projectName: "string",
    sharePermissions: ["string"],
    snapshotGroupId: "string",
    snapshotId: "string",
    tags: [{
        key: "string",
        value: "string",
    }],
});

type: volcenginecc:ecs:Image
properties:
    description: string
    detectionResults:
        detectionStatus: string
        items:
            - name: string
              result: string
              riskCode: string
              riskLevel: string
    imageName: string
    instanceId: string
    kernel: string
    licenseType: string
    osName: string
    osType: string
    platform: string
    platformVersion: string
    projectName: string
    sharePermissions:
        - string
    snapshotGroupId: string
    snapshotId: string
    tags:
        - key: string
          value: string

Image Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The Image resource accepts the following input properties:

ImageName string: 镜像名称。必须以字母、汉字开头。只能包含中文、字母、数字、下划线“_”、中划线“-”、英文句号“.”。长度限制为1 ~ 128个字符。
Description string: 镜像描述。必须以字母、汉字开头。只能包含中文、字母、数字、下划线“_”、中划线“-”、等号“=”、英文逗号“,”、英文句号“.”、中文逗号“，”、中文句号“。”和空格。长度限制为0～255个字符。不填默认为空。
DetectionResults Volcengine.ImageDetectionResults: 镜像的检测结果。
InstanceId string: 实例ID。本参数与SnapshotId、SnapshotGroupId参数，三选一必填。
Kernel string: 镜像的内核版本。
LicenseType string: 镜像许可证类型。VolcanoEngine：默认，根据您设置的platform，采用火山引擎官方渠道的许可证。BYOL：自带许可证（BYOL）。
OsName string: 镜像操作系统的名称。
OsType string: 操作系统类型。
Platform string: 镜像操作系统的发行版本。可以选择CentOS、Debian、veLinux、Windows Server、Fedora、OpenSUSE、Ubuntu。
PlatformVersion string: 镜像的发行版本。
ProjectName string: 资源所属项目。调用接口账号若仅拥有部分项目权限时必须传入有权限的项目信息。
SharePermissions List<string>: 镜像共享的账户
SnapshotGroupId string: 快照一致性组ID，表示使用快照一致性组创建自定义镜像。本参数与SnapshotId、InstanceId参数，三选一必填。
SnapshotId string: 系统盘快照ID，表示使用系统盘快照创建自定义镜像。本参数与InstanceId、SnapshotGroupId参数，三选一必填。
Tags List<Volcengine.ImageTag>

ImageName string: 镜像名称。必须以字母、汉字开头。只能包含中文、字母、数字、下划线“_”、中划线“-”、英文句号“.”。长度限制为1 ~ 128个字符。
Description string: 镜像描述。必须以字母、汉字开头。只能包含中文、字母、数字、下划线“_”、中划线“-”、等号“=”、英文逗号“,”、英文句号“.”、中文逗号“，”、中文句号“。”和空格。长度限制为0～255个字符。不填默认为空。
DetectionResults ImageDetectionResultsArgs: 镜像的检测结果。
InstanceId string: 实例ID。本参数与SnapshotId、SnapshotGroupId参数，三选一必填。
Kernel string: 镜像的内核版本。
LicenseType string: 镜像许可证类型。VolcanoEngine：默认，根据您设置的platform，采用火山引擎官方渠道的许可证。BYOL：自带许可证（BYOL）。
OsName string: 镜像操作系统的名称。
OsType string: 操作系统类型。
Platform string: 镜像操作系统的发行版本。可以选择CentOS、Debian、veLinux、Windows Server、Fedora、OpenSUSE、Ubuntu。
PlatformVersion string: 镜像的发行版本。
ProjectName string: 资源所属项目。调用接口账号若仅拥有部分项目权限时必须传入有权限的项目信息。
SharePermissions []string: 镜像共享的账户
SnapshotGroupId string: 快照一致性组ID，表示使用快照一致性组创建自定义镜像。本参数与SnapshotId、InstanceId参数，三选一必填。
SnapshotId string: 系统盘快照ID，表示使用系统盘快照创建自定义镜像。本参数与InstanceId、SnapshotGroupId参数，三选一必填。
Tags []ImageTagArgs

imageName String: 镜像名称。必须以字母、汉字开头。只能包含中文、字母、数字、下划线“_”、中划线“-”、英文句号“.”。长度限制为1 ~ 128个字符。
description String: 镜像描述。必须以字母、汉字开头。只能包含中文、字母、数字、下划线“_”、中划线“-”、等号“=”、英文逗号“,”、英文句号“.”、中文逗号“，”、中文句号“。”和空格。长度限制为0～255个字符。不填默认为空。
detectionResults ImageDetectionResults: 镜像的检测结果。
instanceId String: 实例ID。本参数与SnapshotId、SnapshotGroupId参数，三选一必填。
kernel String: 镜像的内核版本。
licenseType String: 镜像许可证类型。VolcanoEngine：默认，根据您设置的platform，采用火山引擎官方渠道的许可证。BYOL：自带许可证（BYOL）。
osName String: 镜像操作系统的名称。
osType String: 操作系统类型。
platform String: 镜像操作系统的发行版本。可以选择CentOS、Debian、veLinux、Windows Server、Fedora、OpenSUSE、Ubuntu。
platformVersion String: 镜像的发行版本。
projectName String: 资源所属项目。调用接口账号若仅拥有部分项目权限时必须传入有权限的项目信息。
sharePermissions List<String>: 镜像共享的账户
snapshotGroupId String: 快照一致性组ID，表示使用快照一致性组创建自定义镜像。本参数与SnapshotId、InstanceId参数，三选一必填。
snapshotId String: 系统盘快照ID，表示使用系统盘快照创建自定义镜像。本参数与InstanceId、SnapshotGroupId参数，三选一必填。
tags List<ImageTag>

imageName string: 镜像名称。必须以字母、汉字开头。只能包含中文、字母、数字、下划线“_”、中划线“-”、英文句号“.”。长度限制为1 ~ 128个字符。
description string: 镜像描述。必须以字母、汉字开头。只能包含中文、字母、数字、下划线“_”、中划线“-”、等号“=”、英文逗号“,”、英文句号“.”、中文逗号“，”、中文句号“。”和空格。长度限制为0～255个字符。不填默认为空。
detectionResults ImageDetectionResults: 镜像的检测结果。
instanceId string: 实例ID。本参数与SnapshotId、SnapshotGroupId参数，三选一必填。
kernel string: 镜像的内核版本。
licenseType string: 镜像许可证类型。VolcanoEngine：默认，根据您设置的platform，采用火山引擎官方渠道的许可证。BYOL：自带许可证（BYOL）。
osName string: 镜像操作系统的名称。
osType string: 操作系统类型。
platform string: 镜像操作系统的发行版本。可以选择CentOS、Debian、veLinux、Windows Server、Fedora、OpenSUSE、Ubuntu。
platformVersion string: 镜像的发行版本。
projectName string: 资源所属项目。调用接口账号若仅拥有部分项目权限时必须传入有权限的项目信息。
sharePermissions string[]: 镜像共享的账户
snapshotGroupId string: 快照一致性组ID，表示使用快照一致性组创建自定义镜像。本参数与SnapshotId、InstanceId参数，三选一必填。
snapshotId string: 系统盘快照ID，表示使用系统盘快照创建自定义镜像。本参数与InstanceId、SnapshotGroupId参数，三选一必填。
tags ImageTag[]

image_name str: 镜像名称。必须以字母、汉字开头。只能包含中文、字母、数字、下划线“_”、中划线“-”、英文句号“.”。长度限制为1 ~ 128个字符。
description str: 镜像描述。必须以字母、汉字开头。只能包含中文、字母、数字、下划线“_”、中划线“-”、等号“=”、英文逗号“,”、英文句号“.”、中文逗号“，”、中文句号“。”和空格。长度限制为0～255个字符。不填默认为空。
detection_results ImageDetectionResultsArgs: 镜像的检测结果。
instance_id str: 实例ID。本参数与SnapshotId、SnapshotGroupId参数，三选一必填。
kernel str: 镜像的内核版本。
license_type str: 镜像许可证类型。VolcanoEngine：默认，根据您设置的platform，采用火山引擎官方渠道的许可证。BYOL：自带许可证（BYOL）。
os_name str: 镜像操作系统的名称。
os_type str: 操作系统类型。
platform str: 镜像操作系统的发行版本。可以选择CentOS、Debian、veLinux、Windows Server、Fedora、OpenSUSE、Ubuntu。
platform_version str: 镜像的发行版本。
project_name str: 资源所属项目。调用接口账号若仅拥有部分项目权限时必须传入有权限的项目信息。
share_permissions Sequence[str]: 镜像共享的账户
snapshot_group_id str: 快照一致性组ID，表示使用快照一致性组创建自定义镜像。本参数与SnapshotId、InstanceId参数，三选一必填。
snapshot_id str: 系统盘快照ID，表示使用系统盘快照创建自定义镜像。本参数与InstanceId、SnapshotGroupId参数，三选一必填。
tags Sequence[ImageTagArgs]

imageName String: 镜像名称。必须以字母、汉字开头。只能包含中文、字母、数字、下划线“_”、中划线“-”、英文句号“.”。长度限制为1 ~ 128个字符。
description String: 镜像描述。必须以字母、汉字开头。只能包含中文、字母、数字、下划线“_”、中划线“-”、等号“=”、英文逗号“,”、英文句号“.”、中文逗号“，”、中文句号“。”和空格。长度限制为0～255个字符。不填默认为空。
detectionResults Property Map: 镜像的检测结果。
instanceId String: 实例ID。本参数与SnapshotId、SnapshotGroupId参数，三选一必填。
kernel String: 镜像的内核版本。
licenseType String: 镜像许可证类型。VolcanoEngine：默认，根据您设置的platform，采用火山引擎官方渠道的许可证。BYOL：自带许可证（BYOL）。
osName String: 镜像操作系统的名称。
osType String: 操作系统类型。
platform String: 镜像操作系统的发行版本。可以选择CentOS、Debian、veLinux、Windows Server、Fedora、OpenSUSE、Ubuntu。
platformVersion String: 镜像的发行版本。
projectName String: 资源所属项目。调用接口账号若仅拥有部分项目权限时必须传入有权限的项目信息。
sharePermissions List<String>: 镜像共享的账户
snapshotGroupId String: 快照一致性组ID，表示使用快照一致性组创建自定义镜像。本参数与SnapshotId、InstanceId参数，三选一必填。
snapshotId String: 系统盘快照ID，表示使用系统盘快照创建自定义镜像。本参数与InstanceId、SnapshotGroupId参数，三选一必填。
tags List<Property Map>

Outputs

All input properties are implicitly available as output properties. Additionally, the Image resource produces the following output properties:

Architecture string: 镜像的架构类型。可以选择amd64（x86计算）、arm64（ARM计算）类型。
BootMode string: 镜像的启动模式。可以选择BIOS、UEFI类型。
CreatedAt string: 镜像创建时间
Id string: The provider-assigned unique ID for this managed resource.
ImageId string: 镜像ID。
ImageOwnerId string: 镜像所属的账号ID。
IsInstallRunCommandAgent bool: 镜像中是否安装了云助手Agent。
IsLts bool: 公共镜像是否长期维护。
IsSupportCloudInit bool: 镜像是否支持Cloud-init。
ShareStatus string: 镜像共享状态。HasShared：自定义镜像已被共享给其他用户。当自定义镜像未被共享或使用公共镜像时，ShareStatus返回为空。
Size int: 镜像大小，单位为GiB。
Snapshots List<Volcengine.ImageSnapshot>
Status string: 镜像的状态。
UpdatedAt string: 镜像更新时间
VirtualSize double: 镜像大小，单位为Byte。
Visibility string: 镜像的可见性。public：公共镜像。private：私有镜像。shared：共享镜像。

Architecture string: 镜像的架构类型。可以选择amd64（x86计算）、arm64（ARM计算）类型。
BootMode string: 镜像的启动模式。可以选择BIOS、UEFI类型。
CreatedAt string: 镜像创建时间
Id string: The provider-assigned unique ID for this managed resource.
ImageId string: 镜像ID。
ImageOwnerId string: 镜像所属的账号ID。
IsInstallRunCommandAgent bool: 镜像中是否安装了云助手Agent。
IsLts bool: 公共镜像是否长期维护。
IsSupportCloudInit bool: 镜像是否支持Cloud-init。
ShareStatus string: 镜像共享状态。HasShared：自定义镜像已被共享给其他用户。当自定义镜像未被共享或使用公共镜像时，ShareStatus返回为空。
Size int: 镜像大小，单位为GiB。
Snapshots []ImageSnapshot
Status string: 镜像的状态。
UpdatedAt string: 镜像更新时间
VirtualSize float64: 镜像大小，单位为Byte。
Visibility string: 镜像的可见性。public：公共镜像。private：私有镜像。shared：共享镜像。

architecture String: 镜像的架构类型。可以选择amd64（x86计算）、arm64（ARM计算）类型。
bootMode String: 镜像的启动模式。可以选择BIOS、UEFI类型。
createdAt String: 镜像创建时间
id String: The provider-assigned unique ID for this managed resource.
imageId String: 镜像ID。
imageOwnerId String: 镜像所属的账号ID。
isInstallRunCommandAgent Boolean: 镜像中是否安装了云助手Agent。
isLts Boolean: 公共镜像是否长期维护。
isSupportCloudInit Boolean: 镜像是否支持Cloud-init。
shareStatus String: 镜像共享状态。HasShared：自定义镜像已被共享给其他用户。当自定义镜像未被共享或使用公共镜像时，ShareStatus返回为空。
size Integer: 镜像大小，单位为GiB。
snapshots List<ImageSnapshot>
status String: 镜像的状态。
updatedAt String: 镜像更新时间
virtualSize Double: 镜像大小，单位为Byte。
visibility String: 镜像的可见性。public：公共镜像。private：私有镜像。shared：共享镜像。

architecture string: 镜像的架构类型。可以选择amd64（x86计算）、arm64（ARM计算）类型。
bootMode string: 镜像的启动模式。可以选择BIOS、UEFI类型。
createdAt string: 镜像创建时间
id string: The provider-assigned unique ID for this managed resource.
imageId string: 镜像ID。
imageOwnerId string: 镜像所属的账号ID。
isInstallRunCommandAgent boolean: 镜像中是否安装了云助手Agent。
isLts boolean: 公共镜像是否长期维护。
isSupportCloudInit boolean: 镜像是否支持Cloud-init。
shareStatus string: 镜像共享状态。HasShared：自定义镜像已被共享给其他用户。当自定义镜像未被共享或使用公共镜像时，ShareStatus返回为空。
size number: 镜像大小，单位为GiB。
snapshots ImageSnapshot[]
status string: 镜像的状态。
updatedAt string: 镜像更新时间
virtualSize number: 镜像大小，单位为Byte。
visibility string: 镜像的可见性。public：公共镜像。private：私有镜像。shared：共享镜像。

architecture str: 镜像的架构类型。可以选择amd64（x86计算）、arm64（ARM计算）类型。
boot_mode str: 镜像的启动模式。可以选择BIOS、UEFI类型。
created_at str: 镜像创建时间
id str: The provider-assigned unique ID for this managed resource.
image_id str: 镜像ID。
image_owner_id str: 镜像所属的账号ID。
is_install_run_command_agent bool: 镜像中是否安装了云助手Agent。
is_lts bool: 公共镜像是否长期维护。
is_support_cloud_init bool: 镜像是否支持Cloud-init。
share_status str: 镜像共享状态。HasShared：自定义镜像已被共享给其他用户。当自定义镜像未被共享或使用公共镜像时，ShareStatus返回为空。
size int: 镜像大小，单位为GiB。
snapshots Sequence[ImageSnapshot]
status str: 镜像的状态。
updated_at str: 镜像更新时间
virtual_size float: 镜像大小，单位为Byte。
visibility str: 镜像的可见性。public：公共镜像。private：私有镜像。shared：共享镜像。

architecture String: 镜像的架构类型。可以选择amd64（x86计算）、arm64（ARM计算）类型。
bootMode String: 镜像的启动模式。可以选择BIOS、UEFI类型。
createdAt String: 镜像创建时间
id String: The provider-assigned unique ID for this managed resource.
imageId String: 镜像ID。
imageOwnerId String: 镜像所属的账号ID。
isInstallRunCommandAgent Boolean: 镜像中是否安装了云助手Agent。
isLts Boolean: 公共镜像是否长期维护。
isSupportCloudInit Boolean: 镜像是否支持Cloud-init。
shareStatus String: 镜像共享状态。HasShared：自定义镜像已被共享给其他用户。当自定义镜像未被共享或使用公共镜像时，ShareStatus返回为空。
size Number: 镜像大小，单位为GiB。
snapshots List<Property Map>
status String: 镜像的状态。
updatedAt String: 镜像更新时间
virtualSize Number: 镜像大小，单位为Byte。
visibility String: 镜像的可见性。public：公共镜像。private：私有镜像。shared：共享镜像。

Look up Existing Image Resource

Get an existing Image resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: ImageState, opts?: CustomResourceOptions): Image

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        architecture: Optional[str] = None,
        boot_mode: Optional[str] = None,
        created_at: Optional[str] = None,
        description: Optional[str] = None,
        detection_results: Optional[ImageDetectionResultsArgs] = None,
        image_id: Optional[str] = None,
        image_name: Optional[str] = None,
        image_owner_id: Optional[str] = None,
        instance_id: Optional[str] = None,
        is_install_run_command_agent: Optional[bool] = None,
        is_lts: Optional[bool] = None,
        is_support_cloud_init: Optional[bool] = None,
        kernel: Optional[str] = None,
        license_type: Optional[str] = None,
        os_name: Optional[str] = None,
        os_type: Optional[str] = None,
        platform: Optional[str] = None,
        platform_version: Optional[str] = None,
        project_name: Optional[str] = None,
        share_permissions: Optional[Sequence[str]] = None,
        share_status: Optional[str] = None,
        size: Optional[int] = None,
        snapshot_group_id: Optional[str] = None,
        snapshot_id: Optional[str] = None,
        snapshots: Optional[Sequence[ImageSnapshotArgs]] = None,
        status: Optional[str] = None,
        tags: Optional[Sequence[ImageTagArgs]] = None,
        updated_at: Optional[str] = None,
        virtual_size: Optional[float] = None,
        visibility: Optional[str] = None) -> Image

func GetImage(ctx *Context, name string, id IDInput, state *ImageState, opts ...ResourceOption) (*Image, error)

public static Image Get(string name, Input<string> id, ImageState? state, CustomResourceOptions? opts = null)

public static Image get(String name, Output<String> id, ImageState state, CustomResourceOptions options)

resources:  _:    type: volcenginecc:ecs:Image    get:      id: ${id}

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

Architecture string: 镜像的架构类型。可以选择amd64（x86计算）、arm64（ARM计算）类型。
BootMode string: 镜像的启动模式。可以选择BIOS、UEFI类型。
CreatedAt string: 镜像创建时间
Description string: 镜像描述。必须以字母、汉字开头。只能包含中文、字母、数字、下划线“_”、中划线“-”、等号“=”、英文逗号“,”、英文句号“.”、中文逗号“，”、中文句号“。”和空格。长度限制为0～255个字符。不填默认为空。
DetectionResults Volcengine.ImageDetectionResults: 镜像的检测结果。
ImageId string: 镜像ID。
ImageName string: 镜像名称。必须以字母、汉字开头。只能包含中文、字母、数字、下划线“_”、中划线“-”、英文句号“.”。长度限制为1 ~ 128个字符。
ImageOwnerId string: 镜像所属的账号ID。
InstanceId string: 实例ID。本参数与SnapshotId、SnapshotGroupId参数，三选一必填。
IsInstallRunCommandAgent bool: 镜像中是否安装了云助手Agent。
IsLts bool: 公共镜像是否长期维护。
IsSupportCloudInit bool: 镜像是否支持Cloud-init。
Kernel string: 镜像的内核版本。
LicenseType string: 镜像许可证类型。VolcanoEngine：默认，根据您设置的platform，采用火山引擎官方渠道的许可证。BYOL：自带许可证（BYOL）。
OsName string: 镜像操作系统的名称。
OsType string: 操作系统类型。
Platform string: 镜像操作系统的发行版本。可以选择CentOS、Debian、veLinux、Windows Server、Fedora、OpenSUSE、Ubuntu。
PlatformVersion string: 镜像的发行版本。
ProjectName string: 资源所属项目。调用接口账号若仅拥有部分项目权限时必须传入有权限的项目信息。
SharePermissions List<string>: 镜像共享的账户
ShareStatus string: 镜像共享状态。HasShared：自定义镜像已被共享给其他用户。当自定义镜像未被共享或使用公共镜像时，ShareStatus返回为空。
Size int: 镜像大小，单位为GiB。
SnapshotGroupId string: 快照一致性组ID，表示使用快照一致性组创建自定义镜像。本参数与SnapshotId、InstanceId参数，三选一必填。
SnapshotId string: 系统盘快照ID，表示使用系统盘快照创建自定义镜像。本参数与InstanceId、SnapshotGroupId参数，三选一必填。
Snapshots List<Volcengine.ImageSnapshot>
Status string: 镜像的状态。
Tags List<Volcengine.ImageTag>
UpdatedAt string: 镜像更新时间
VirtualSize double: 镜像大小，单位为Byte。
Visibility string: 镜像的可见性。public：公共镜像。private：私有镜像。shared：共享镜像。

Architecture string: 镜像的架构类型。可以选择amd64（x86计算）、arm64（ARM计算）类型。
BootMode string: 镜像的启动模式。可以选择BIOS、UEFI类型。
CreatedAt string: 镜像创建时间
Description string: 镜像描述。必须以字母、汉字开头。只能包含中文、字母、数字、下划线“_”、中划线“-”、等号“=”、英文逗号“,”、英文句号“.”、中文逗号“，”、中文句号“。”和空格。长度限制为0～255个字符。不填默认为空。
DetectionResults ImageDetectionResultsArgs: 镜像的检测结果。
ImageId string: 镜像ID。
ImageName string: 镜像名称。必须以字母、汉字开头。只能包含中文、字母、数字、下划线“_”、中划线“-”、英文句号“.”。长度限制为1 ~ 128个字符。
ImageOwnerId string: 镜像所属的账号ID。
InstanceId string: 实例ID。本参数与SnapshotId、SnapshotGroupId参数，三选一必填。
IsInstallRunCommandAgent bool: 镜像中是否安装了云助手Agent。
IsLts bool: 公共镜像是否长期维护。
IsSupportCloudInit bool: 镜像是否支持Cloud-init。
Kernel string: 镜像的内核版本。
LicenseType string: 镜像许可证类型。VolcanoEngine：默认，根据您设置的platform，采用火山引擎官方渠道的许可证。BYOL：自带许可证（BYOL）。
OsName string: 镜像操作系统的名称。
OsType string: 操作系统类型。
Platform string: 镜像操作系统的发行版本。可以选择CentOS、Debian、veLinux、Windows Server、Fedora、OpenSUSE、Ubuntu。
PlatformVersion string: 镜像的发行版本。
ProjectName string: 资源所属项目。调用接口账号若仅拥有部分项目权限时必须传入有权限的项目信息。
SharePermissions []string: 镜像共享的账户
ShareStatus string: 镜像共享状态。HasShared：自定义镜像已被共享给其他用户。当自定义镜像未被共享或使用公共镜像时，ShareStatus返回为空。
Size int: 镜像大小，单位为GiB。
SnapshotGroupId string: 快照一致性组ID，表示使用快照一致性组创建自定义镜像。本参数与SnapshotId、InstanceId参数，三选一必填。
SnapshotId string: 系统盘快照ID，表示使用系统盘快照创建自定义镜像。本参数与InstanceId、SnapshotGroupId参数，三选一必填。
Snapshots []ImageSnapshotArgs
Status string: 镜像的状态。
Tags []ImageTagArgs
UpdatedAt string: 镜像更新时间
VirtualSize float64: 镜像大小，单位为Byte。
Visibility string: 镜像的可见性。public：公共镜像。private：私有镜像。shared：共享镜像。

architecture String: 镜像的架构类型。可以选择amd64（x86计算）、arm64（ARM计算）类型。
bootMode String: 镜像的启动模式。可以选择BIOS、UEFI类型。
createdAt String: 镜像创建时间
description String: 镜像描述。必须以字母、汉字开头。只能包含中文、字母、数字、下划线“_”、中划线“-”、等号“=”、英文逗号“,”、英文句号“.”、中文逗号“，”、中文句号“。”和空格。长度限制为0～255个字符。不填默认为空。
detectionResults ImageDetectionResults: 镜像的检测结果。
imageId String: 镜像ID。
imageName String: 镜像名称。必须以字母、汉字开头。只能包含中文、字母、数字、下划线“_”、中划线“-”、英文句号“.”。长度限制为1 ~ 128个字符。
imageOwnerId String: 镜像所属的账号ID。
instanceId String: 实例ID。本参数与SnapshotId、SnapshotGroupId参数，三选一必填。
isInstallRunCommandAgent Boolean: 镜像中是否安装了云助手Agent。
isLts Boolean: 公共镜像是否长期维护。
isSupportCloudInit Boolean: 镜像是否支持Cloud-init。
kernel String: 镜像的内核版本。
licenseType String: 镜像许可证类型。VolcanoEngine：默认，根据您设置的platform，采用火山引擎官方渠道的许可证。BYOL：自带许可证（BYOL）。
osName String: 镜像操作系统的名称。
osType String: 操作系统类型。
platform String: 镜像操作系统的发行版本。可以选择CentOS、Debian、veLinux、Windows Server、Fedora、OpenSUSE、Ubuntu。
platformVersion String: 镜像的发行版本。
projectName String: 资源所属项目。调用接口账号若仅拥有部分项目权限时必须传入有权限的项目信息。
sharePermissions List<String>: 镜像共享的账户
shareStatus String: 镜像共享状态。HasShared：自定义镜像已被共享给其他用户。当自定义镜像未被共享或使用公共镜像时，ShareStatus返回为空。
size Integer: 镜像大小，单位为GiB。
snapshotGroupId String: 快照一致性组ID，表示使用快照一致性组创建自定义镜像。本参数与SnapshotId、InstanceId参数，三选一必填。
snapshotId String: 系统盘快照ID，表示使用系统盘快照创建自定义镜像。本参数与InstanceId、SnapshotGroupId参数，三选一必填。
snapshots List<ImageSnapshot>
status String: 镜像的状态。
tags List<ImageTag>
updatedAt String: 镜像更新时间
virtualSize Double: 镜像大小，单位为Byte。
visibility String: 镜像的可见性。public：公共镜像。private：私有镜像。shared：共享镜像。

architecture string: 镜像的架构类型。可以选择amd64（x86计算）、arm64（ARM计算）类型。
bootMode string: 镜像的启动模式。可以选择BIOS、UEFI类型。
createdAt string: 镜像创建时间
description string: 镜像描述。必须以字母、汉字开头。只能包含中文、字母、数字、下划线“_”、中划线“-”、等号“=”、英文逗号“,”、英文句号“.”、中文逗号“，”、中文句号“。”和空格。长度限制为0～255个字符。不填默认为空。
detectionResults ImageDetectionResults: 镜像的检测结果。
imageId string: 镜像ID。
imageName string: 镜像名称。必须以字母、汉字开头。只能包含中文、字母、数字、下划线“_”、中划线“-”、英文句号“.”。长度限制为1 ~ 128个字符。
imageOwnerId string: 镜像所属的账号ID。
instanceId string: 实例ID。本参数与SnapshotId、SnapshotGroupId参数，三选一必填。
isInstallRunCommandAgent boolean: 镜像中是否安装了云助手Agent。
isLts boolean: 公共镜像是否长期维护。
isSupportCloudInit boolean: 镜像是否支持Cloud-init。
kernel string: 镜像的内核版本。
licenseType string: 镜像许可证类型。VolcanoEngine：默认，根据您设置的platform，采用火山引擎官方渠道的许可证。BYOL：自带许可证（BYOL）。
osName string: 镜像操作系统的名称。
osType string: 操作系统类型。
platform string: 镜像操作系统的发行版本。可以选择CentOS、Debian、veLinux、Windows Server、Fedora、OpenSUSE、Ubuntu。
platformVersion string: 镜像的发行版本。
projectName string: 资源所属项目。调用接口账号若仅拥有部分项目权限时必须传入有权限的项目信息。
sharePermissions string[]: 镜像共享的账户
shareStatus string: 镜像共享状态。HasShared：自定义镜像已被共享给其他用户。当自定义镜像未被共享或使用公共镜像时，ShareStatus返回为空。
size number: 镜像大小，单位为GiB。
snapshotGroupId string: 快照一致性组ID，表示使用快照一致性组创建自定义镜像。本参数与SnapshotId、InstanceId参数，三选一必填。
snapshotId string: 系统盘快照ID，表示使用系统盘快照创建自定义镜像。本参数与InstanceId、SnapshotGroupId参数，三选一必填。
snapshots ImageSnapshot[]
status string: 镜像的状态。
tags ImageTag[]
updatedAt string: 镜像更新时间
virtualSize number: 镜像大小，单位为Byte。
visibility string: 镜像的可见性。public：公共镜像。private：私有镜像。shared：共享镜像。

architecture str: 镜像的架构类型。可以选择amd64（x86计算）、arm64（ARM计算）类型。
boot_mode str: 镜像的启动模式。可以选择BIOS、UEFI类型。
created_at str: 镜像创建时间
description str: 镜像描述。必须以字母、汉字开头。只能包含中文、字母、数字、下划线“_”、中划线“-”、等号“=”、英文逗号“,”、英文句号“.”、中文逗号“，”、中文句号“。”和空格。长度限制为0～255个字符。不填默认为空。
detection_results ImageDetectionResultsArgs: 镜像的检测结果。
image_id str: 镜像ID。
image_name str: 镜像名称。必须以字母、汉字开头。只能包含中文、字母、数字、下划线“_”、中划线“-”、英文句号“.”。长度限制为1 ~ 128个字符。
image_owner_id str: 镜像所属的账号ID。
instance_id str: 实例ID。本参数与SnapshotId、SnapshotGroupId参数，三选一必填。
is_install_run_command_agent bool: 镜像中是否安装了云助手Agent。
is_lts bool: 公共镜像是否长期维护。
is_support_cloud_init bool: 镜像是否支持Cloud-init。
kernel str: 镜像的内核版本。
license_type str: 镜像许可证类型。VolcanoEngine：默认，根据您设置的platform，采用火山引擎官方渠道的许可证。BYOL：自带许可证（BYOL）。
os_name str: 镜像操作系统的名称。
os_type str: 操作系统类型。
platform str: 镜像操作系统的发行版本。可以选择CentOS、Debian、veLinux、Windows Server、Fedora、OpenSUSE、Ubuntu。
platform_version str: 镜像的发行版本。
project_name str: 资源所属项目。调用接口账号若仅拥有部分项目权限时必须传入有权限的项目信息。
share_permissions Sequence[str]: 镜像共享的账户
share_status str: 镜像共享状态。HasShared：自定义镜像已被共享给其他用户。当自定义镜像未被共享或使用公共镜像时，ShareStatus返回为空。
size int: 镜像大小，单位为GiB。
snapshot_group_id str: 快照一致性组ID，表示使用快照一致性组创建自定义镜像。本参数与SnapshotId、InstanceId参数，三选一必填。
snapshot_id str: 系统盘快照ID，表示使用系统盘快照创建自定义镜像。本参数与InstanceId、SnapshotGroupId参数，三选一必填。
snapshots Sequence[ImageSnapshotArgs]
status str: 镜像的状态。
tags Sequence[ImageTagArgs]
updated_at str: 镜像更新时间
virtual_size float: 镜像大小，单位为Byte。
visibility str: 镜像的可见性。public：公共镜像。private：私有镜像。shared：共享镜像。

architecture String: 镜像的架构类型。可以选择amd64（x86计算）、arm64（ARM计算）类型。
bootMode String: 镜像的启动模式。可以选择BIOS、UEFI类型。
createdAt String: 镜像创建时间
description String: 镜像描述。必须以字母、汉字开头。只能包含中文、字母、数字、下划线“_”、中划线“-”、等号“=”、英文逗号“,”、英文句号“.”、中文逗号“，”、中文句号“。”和空格。长度限制为0～255个字符。不填默认为空。
detectionResults Property Map: 镜像的检测结果。
imageId String: 镜像ID。
imageName String: 镜像名称。必须以字母、汉字开头。只能包含中文、字母、数字、下划线“_”、中划线“-”、英文句号“.”。长度限制为1 ~ 128个字符。
imageOwnerId String: 镜像所属的账号ID。
instanceId String: 实例ID。本参数与SnapshotId、SnapshotGroupId参数，三选一必填。
isInstallRunCommandAgent Boolean: 镜像中是否安装了云助手Agent。
isLts Boolean: 公共镜像是否长期维护。
isSupportCloudInit Boolean: 镜像是否支持Cloud-init。
kernel String: 镜像的内核版本。
licenseType String: 镜像许可证类型。VolcanoEngine：默认，根据您设置的platform，采用火山引擎官方渠道的许可证。BYOL：自带许可证（BYOL）。
osName String: 镜像操作系统的名称。
osType String: 操作系统类型。
platform String: 镜像操作系统的发行版本。可以选择CentOS、Debian、veLinux、Windows Server、Fedora、OpenSUSE、Ubuntu。
platformVersion String: 镜像的发行版本。
projectName String: 资源所属项目。调用接口账号若仅拥有部分项目权限时必须传入有权限的项目信息。
sharePermissions List<String>: 镜像共享的账户
shareStatus String: 镜像共享状态。HasShared：自定义镜像已被共享给其他用户。当自定义镜像未被共享或使用公共镜像时，ShareStatus返回为空。
size Number: 镜像大小，单位为GiB。
snapshotGroupId String: 快照一致性组ID，表示使用快照一致性组创建自定义镜像。本参数与SnapshotId、InstanceId参数，三选一必填。
snapshotId String: 系统盘快照ID，表示使用系统盘快照创建自定义镜像。本参数与InstanceId、SnapshotGroupId参数，三选一必填。
snapshots List<Property Map>
status String: 镜像的状态。
tags List<Property Map>
updatedAt String: 镜像更新时间
virtualSize Number: 镜像大小，单位为Byte。
visibility String: 镜像的可见性。public：公共镜像。private：私有镜像。shared：共享镜像。

Supporting Types

ImageDetectionResults, ImageDetectionResultsArgs

DetectionStatus string: 检测状态。可以选择Finished（已完成）、Processing（处理中）类型。
Items List<Volcengine.ImageDetectionResultsItem>

DetectionStatus string: 检测状态。可以选择Finished（已完成）、Processing（处理中）类型。
Items []ImageDetectionResultsItem

detectionStatus String: 检测状态。可以选择Finished（已完成）、Processing（处理中）类型。
items List<ImageDetectionResultsItem>

detectionStatus string: 检测状态。可以选择Finished（已完成）、Processing（处理中）类型。
items ImageDetectionResultsItem[]

detection_status str: 检测状态。可以选择Finished（已完成）、Processing（处理中）类型。
items Sequence[ImageDetectionResultsItem]

detectionStatus String: 检测状态。可以选择Finished（已完成）、Processing（处理中）类型。
items List<Property Map>

ImageDetectionResultsItem, ImageDetectionResultsItemArgs

Name string: 检测项名称。
Result string: 该检测项对应结果。
RiskCode string: 风险描述码。
RiskLevel string: 风险等级。若该参数返回值为空，表示无风险。

Name string: 检测项名称。
Result string: 该检测项对应结果。
RiskCode string: 风险描述码。
RiskLevel string: 风险等级。若该参数返回值为空，表示无风险。

name String: 检测项名称。
result String: 该检测项对应结果。
riskCode String: 风险描述码。
riskLevel String: 风险等级。若该参数返回值为空，表示无风险。

name string: 检测项名称。
result string: 该检测项对应结果。
riskCode string: 风险描述码。
riskLevel string: 风险等级。若该参数返回值为空，表示无风险。

name str: 检测项名称。
result str: 该检测项对应结果。
risk_code str: 风险描述码。
risk_level str: 风险等级。若该参数返回值为空，表示无风险。

name String: 检测项名称。
result String: 该检测项对应结果。
riskCode String: 风险描述码。
riskLevel String: 风险等级。若该参数返回值为空，表示无风险。

ImageSnapshot, ImageSnapshotArgs

Size int: 快照大小。单位为GiB。
SnapshotId string: 快照ID。
VolumeKind string: 云盘种类。system：系统盘。data：数据盘。

Size int: 快照大小。单位为GiB。
SnapshotId string: 快照ID。
VolumeKind string: 云盘种类。system：系统盘。data：数据盘。

size Integer: 快照大小。单位为GiB。
snapshotId String: 快照ID。
volumeKind String: 云盘种类。system：系统盘。data：数据盘。

size number: 快照大小。单位为GiB。
snapshotId string: 快照ID。
volumeKind string: 云盘种类。system：系统盘。data：数据盘。

size int: 快照大小。单位为GiB。
snapshot_id str: 快照ID。
volume_kind str: 云盘种类。system：系统盘。data：数据盘。

size Number: 快照大小。单位为GiB。
snapshotId String: 快照ID。
volumeKind String: 云盘种类。system：系统盘。data：数据盘。

ImageTag, ImageTagArgs

Key string: 镜像标签的标签键。
Value string: 镜像标签的值。

Key string: 镜像标签的标签键。
Value string: 镜像标签的值。

key String: 镜像标签的标签键。
value String: 镜像标签的值。

key string: 镜像标签的标签键。
value string: 镜像标签的值。

key str: 镜像标签的标签键。
value str: 镜像标签的值。

key String: 镜像标签的标签键。
value String: 镜像标签的值。

Import

$ pulumi import volcenginecc:ecs/image:Image example "image_id"

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository: volcenginecc volcengine/pulumi-volcenginecc
License: MPL-2.0
Notes: This Pulumi package is based on the volcenginecc Terraform Provider.

volcenginecc v0.0.2 published on Saturday, Oct 11, 2025 by Volcengine

volcengine/pulumi-volcenginecc

volcenginecc.ecs.Image

On this page

On this page

Example Usage

Create Image Resource

Constructor syntax

Parameters

Constructor example

Image Resource Properties

Inputs

Outputs

Look up Existing Image Resource

Supporting Types

ImageDetectionResults, ImageDetectionResultsArgs

ImageDetectionResultsItem, ImageDetectionResultsItemArgs

ImageSnapshot, ImageSnapshotArgs

ImageTag, ImageTagArgs

Import

Package Details

On this page

On this page