Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Alibaba Cloud Provider
  3. API Docs
  4. ecs
  5. ImageCopy
Alibaba Cloud v3.75.0 published on Friday, Mar 7, 2025 by Pulumi
pulumi/pulumi-alicloud

alicloud.ecs.ImageCopy

Explore with Pulumi AI

Alibaba Cloud v3.75.0 published on Friday, Mar 7, 2025 by Pulumi
pulumi/pulumi-alicloud

Copies a custom image from one region to another. You can use copied images to perform operations in the target region, such as creating instances (RunInstances) and replacing system disks (ReplaceSystemDisk).

NOTE: You can only copy the custom image when it is in the Available state.

NOTE: You can only copy the image belonging to your Alibaba Cloud account. Images cannot be copied from one account to another.

NOTE: If the copying is not completed, you cannot call DeleteImage to delete the image but you can call CancelCopyImage to cancel the copying.

NOTE: Available in 1.66.0+.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as alicloud from "@pulumi/alicloud";

const _default = alicloud.getZones({
    availableResourceCreation: "Instance",
});
const defaultGetInstanceTypes = alicloud.ecs.getInstanceTypes({
    instanceTypeFamily: "ecs.sn1ne",
});
const defaultGetImages = alicloud.ecs.getImages({
    nameRegex: "^ubuntu_18.*64",
    owners: "system",
});
const defaultNetwork = new alicloud.vpc.Network("default", {
    vpcName: "terraform-example",
    cidrBlock: "172.17.3.0/24",
});
const defaultSwitch = new alicloud.vpc.Switch("default", {
    vswitchName: "terraform-example",
    cidrBlock: "172.17.3.0/24",
    vpcId: defaultNetwork.id,
    zoneId: _default.then(_default => _default.zones?.[0]?.id),
});
const defaultSecurityGroup = new alicloud.ecs.SecurityGroup("default", {
    name: "terraform-example",
    vpcId: defaultNetwork.id,
});
const defaultInstance = new alicloud.ecs.Instance("default", {
    availabilityZone: _default.then(_default => _default.zones?.[0]?.id),
    instanceName: "terraform-example",
    securityGroups: [defaultSecurityGroup.id],
    vswitchId: defaultSwitch.id,
    instanceType: defaultGetInstanceTypes.then(defaultGetInstanceTypes => defaultGetInstanceTypes.ids?.[0]),
    imageId: defaultGetImages.then(defaultGetImages => defaultGetImages.ids?.[0]),
    internetMaxBandwidthOut: 10,
});
const defaultImage = new alicloud.ecs.Image("default", {
    instanceId: defaultInstance.id,
    imageName: "terraform-example",
    description: "terraform-example",
});
const defaultImageCopy = new alicloud.ecs.ImageCopy("default", {
    sourceImageId: defaultImage.id,
    sourceRegionId: "cn-hangzhou",
    imageName: "terraform-example",
    description: "terraform-example",
    tags: {
        FinanceDept: "FinanceDeptJoshua",
    },
});
Copy
import pulumi
import pulumi_alicloud as alicloud

default = alicloud.get_zones(available_resource_creation="Instance")
default_get_instance_types = alicloud.ecs.get_instance_types(instance_type_family="ecs.sn1ne")
default_get_images = alicloud.ecs.get_images(name_regex="^ubuntu_18.*64",
    owners="system")
default_network = alicloud.vpc.Network("default",
    vpc_name="terraform-example",
    cidr_block="172.17.3.0/24")
default_switch = alicloud.vpc.Switch("default",
    vswitch_name="terraform-example",
    cidr_block="172.17.3.0/24",
    vpc_id=default_network.id,
    zone_id=default.zones[0].id)
default_security_group = alicloud.ecs.SecurityGroup("default",
    name="terraform-example",
    vpc_id=default_network.id)
default_instance = alicloud.ecs.Instance("default",
    availability_zone=default.zones[0].id,
    instance_name="terraform-example",
    security_groups=[default_security_group.id],
    vswitch_id=default_switch.id,
    instance_type=default_get_instance_types.ids[0],
    image_id=default_get_images.ids[0],
    internet_max_bandwidth_out=10)
default_image = alicloud.ecs.Image("default",
    instance_id=default_instance.id,
    image_name="terraform-example",
    description="terraform-example")
default_image_copy = alicloud.ecs.ImageCopy("default",
    source_image_id=default_image.id,
    source_region_id="cn-hangzhou",
    image_name="terraform-example",
    description="terraform-example",
    tags={
        "FinanceDept": "FinanceDeptJoshua",
    })
Copy
package main

import (
	"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud"
	"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/ecs"
	"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/vpc"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_default, err := alicloud.GetZones(ctx, &alicloud.GetZonesArgs{
			AvailableResourceCreation: pulumi.StringRef("Instance"),
		}, nil)
		if err != nil {
			return err
		}
		defaultGetInstanceTypes, err := ecs.GetInstanceTypes(ctx, &ecs.GetInstanceTypesArgs{
			InstanceTypeFamily: pulumi.StringRef("ecs.sn1ne"),
		}, nil)
		if err != nil {
			return err
		}
		defaultGetImages, err := ecs.GetImages(ctx, &ecs.GetImagesArgs{
			NameRegex: pulumi.StringRef("^ubuntu_18.*64"),
			Owners:    pulumi.StringRef("system"),
		}, nil)
		if err != nil {
			return err
		}
		defaultNetwork, err := vpc.NewNetwork(ctx, "default", &vpc.NetworkArgs{
			VpcName:   pulumi.String("terraform-example"),
			CidrBlock: pulumi.String("172.17.3.0/24"),
		})
		if err != nil {
			return err
		}
		defaultSwitch, err := vpc.NewSwitch(ctx, "default", &vpc.SwitchArgs{
			VswitchName: pulumi.String("terraform-example"),
			CidrBlock:   pulumi.String("172.17.3.0/24"),
			VpcId:       defaultNetwork.ID(),
			ZoneId:      pulumi.String(_default.Zones[0].Id),
		})
		if err != nil {
			return err
		}
		defaultSecurityGroup, err := ecs.NewSecurityGroup(ctx, "default", &ecs.SecurityGroupArgs{
			Name:  pulumi.String("terraform-example"),
			VpcId: defaultNetwork.ID(),
		})
		if err != nil {
			return err
		}
		defaultInstance, err := ecs.NewInstance(ctx, "default", &ecs.InstanceArgs{
			AvailabilityZone: pulumi.String(_default.Zones[0].Id),
			InstanceName:     pulumi.String("terraform-example"),
			SecurityGroups: pulumi.StringArray{
				defaultSecurityGroup.ID(),
			},
			VswitchId:               defaultSwitch.ID(),
			InstanceType:            pulumi.String(defaultGetInstanceTypes.Ids[0]),
			ImageId:                 pulumi.String(defaultGetImages.Ids[0]),
			InternetMaxBandwidthOut: pulumi.Int(10),
		})
		if err != nil {
			return err
		}
		defaultImage, err := ecs.NewImage(ctx, "default", &ecs.ImageArgs{
			InstanceId:  defaultInstance.ID(),
			ImageName:   pulumi.String("terraform-example"),
			Description: pulumi.String("terraform-example"),
		})
		if err != nil {
			return err
		}
		_, err = ecs.NewImageCopy(ctx, "default", &ecs.ImageCopyArgs{
			SourceImageId:  defaultImage.ID(),
			SourceRegionId: pulumi.String("cn-hangzhou"),
			ImageName:      pulumi.String("terraform-example"),
			Description:    pulumi.String("terraform-example"),
			Tags: pulumi.StringMap{
				"FinanceDept": pulumi.String("FinanceDeptJoshua"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AliCloud = Pulumi.AliCloud;

return await Deployment.RunAsync(() => 
{
    var @default = AliCloud.GetZones.Invoke(new()
    {
        AvailableResourceCreation = "Instance",
    });

    var defaultGetInstanceTypes = AliCloud.Ecs.GetInstanceTypes.Invoke(new()
    {
        InstanceTypeFamily = "ecs.sn1ne",
    });

    var defaultGetImages = AliCloud.Ecs.GetImages.Invoke(new()
    {
        NameRegex = "^ubuntu_18.*64",
        Owners = "system",
    });

    var defaultNetwork = new AliCloud.Vpc.Network("default", new()
    {
        VpcName = "terraform-example",
        CidrBlock = "172.17.3.0/24",
    });

    var defaultSwitch = new AliCloud.Vpc.Switch("default", new()
    {
        VswitchName = "terraform-example",
        CidrBlock = "172.17.3.0/24",
        VpcId = defaultNetwork.Id,
        ZoneId = @default.Apply(@default => @default.Apply(getZonesResult => getZonesResult.Zones[0]?.Id)),
    });

    var defaultSecurityGroup = new AliCloud.Ecs.SecurityGroup("default", new()
    {
        Name = "terraform-example",
        VpcId = defaultNetwork.Id,
    });

    var defaultInstance = new AliCloud.Ecs.Instance("default", new()
    {
        AvailabilityZone = @default.Apply(@default => @default.Apply(getZonesResult => getZonesResult.Zones[0]?.Id)),
        InstanceName = "terraform-example",
        SecurityGroups = new[]
        {
            defaultSecurityGroup.Id,
        },
        VswitchId = defaultSwitch.Id,
        InstanceType = defaultGetInstanceTypes.Apply(getInstanceTypesResult => getInstanceTypesResult.Ids[0]),
        ImageId = defaultGetImages.Apply(getImagesResult => getImagesResult.Ids[0]),
        InternetMaxBandwidthOut = 10,
    });

    var defaultImage = new AliCloud.Ecs.Image("default", new()
    {
        InstanceId = defaultInstance.Id,
        ImageName = "terraform-example",
        Description = "terraform-example",
    });

    var defaultImageCopy = new AliCloud.Ecs.ImageCopy("default", new()
    {
        SourceImageId = defaultImage.Id,
        SourceRegionId = "cn-hangzhou",
        ImageName = "terraform-example",
        Description = "terraform-example",
        Tags = 
        {
            { "FinanceDept", "FinanceDeptJoshua" },
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.alicloud.AlicloudFunctions;
import com.pulumi.alicloud.inputs.GetZonesArgs;
import com.pulumi.alicloud.ecs.EcsFunctions;
import com.pulumi.alicloud.ecs.inputs.GetInstanceTypesArgs;
import com.pulumi.alicloud.ecs.inputs.GetImagesArgs;
import com.pulumi.alicloud.vpc.Network;
import com.pulumi.alicloud.vpc.NetworkArgs;
import com.pulumi.alicloud.vpc.Switch;
import com.pulumi.alicloud.vpc.SwitchArgs;
import com.pulumi.alicloud.ecs.SecurityGroup;
import com.pulumi.alicloud.ecs.SecurityGroupArgs;
import com.pulumi.alicloud.ecs.Instance;
import com.pulumi.alicloud.ecs.InstanceArgs;
import com.pulumi.alicloud.ecs.Image;
import com.pulumi.alicloud.ecs.ImageArgs;
import com.pulumi.alicloud.ecs.ImageCopy;
import com.pulumi.alicloud.ecs.ImageCopyArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var default = AlicloudFunctions.getZones(GetZonesArgs.builder()
            .availableResourceCreation("Instance")
            .build());

        final var defaultGetInstanceTypes = EcsFunctions.getInstanceTypes(GetInstanceTypesArgs.builder()
            .instanceTypeFamily("ecs.sn1ne")
            .build());

        final var defaultGetImages = EcsFunctions.getImages(GetImagesArgs.builder()
            .nameRegex("^ubuntu_18.*64")
            .owners("system")
            .build());

        var defaultNetwork = new Network("defaultNetwork", NetworkArgs.builder()
            .vpcName("terraform-example")
            .cidrBlock("172.17.3.0/24")
            .build());

        var defaultSwitch = new Switch("defaultSwitch", SwitchArgs.builder()
            .vswitchName("terraform-example")
            .cidrBlock("172.17.3.0/24")
            .vpcId(defaultNetwork.id())
            .zoneId(default_.zones()[0].id())
            .build());

        var defaultSecurityGroup = new SecurityGroup("defaultSecurityGroup", SecurityGroupArgs.builder()
            .name("terraform-example")
            .vpcId(defaultNetwork.id())
            .build());

        var defaultInstance = new Instance("defaultInstance", InstanceArgs.builder()
            .availabilityZone(default_.zones()[0].id())
            .instanceName("terraform-example")
            .securityGroups(defaultSecurityGroup.id())
            .vswitchId(defaultSwitch.id())
            .instanceType(defaultGetInstanceTypes.applyValue(getInstanceTypesResult -> getInstanceTypesResult.ids()[0]))
            .imageId(defaultGetImages.applyValue(getImagesResult -> getImagesResult.ids()[0]))
            .internetMaxBandwidthOut(10)
            .build());

        var defaultImage = new Image("defaultImage", ImageArgs.builder()
            .instanceId(defaultInstance.id())
            .imageName("terraform-example")
            .description("terraform-example")
            .build());

        var defaultImageCopy = new ImageCopy("defaultImageCopy", ImageCopyArgs.builder()
            .sourceImageId(defaultImage.id())
            .sourceRegionId("cn-hangzhou")
            .imageName("terraform-example")
            .description("terraform-example")
            .tags(Map.of("FinanceDept", "FinanceDeptJoshua"))
            .build());

    }
}
Copy
resources:
  defaultNetwork:
    type: alicloud:vpc:Network
    name: default
    properties:
      vpcName: terraform-example
      cidrBlock: 172.17.3.0/24
  defaultSwitch:
    type: alicloud:vpc:Switch
    name: default
    properties:
      vswitchName: terraform-example
      cidrBlock: 172.17.3.0/24
      vpcId: ${defaultNetwork.id}
      zoneId: ${default.zones[0].id}
  defaultSecurityGroup:
    type: alicloud:ecs:SecurityGroup
    name: default
    properties:
      name: terraform-example
      vpcId: ${defaultNetwork.id}
  defaultInstance:
    type: alicloud:ecs:Instance
    name: default
    properties:
      availabilityZone: ${default.zones[0].id}
      instanceName: terraform-example
      securityGroups:
        - ${defaultSecurityGroup.id}
      vswitchId: ${defaultSwitch.id}
      instanceType: ${defaultGetInstanceTypes.ids[0]}
      imageId: ${defaultGetImages.ids[0]}
      internetMaxBandwidthOut: 10
  defaultImage:
    type: alicloud:ecs:Image
    name: default
    properties:
      instanceId: ${defaultInstance.id}
      imageName: terraform-example
      description: terraform-example
  defaultImageCopy:
    type: alicloud:ecs:ImageCopy
    name: default
    properties:
      sourceImageId: ${defaultImage.id}
      sourceRegionId: cn-hangzhou
      imageName: terraform-example
      description: terraform-example
      tags:
        FinanceDept: FinanceDeptJoshua
variables:
  default:
    fn::invoke:
      function: alicloud:getZones
      arguments:
        availableResourceCreation: Instance
  defaultGetInstanceTypes:
    fn::invoke:
      function: alicloud:ecs:getInstanceTypes
      arguments:
        instanceTypeFamily: ecs.sn1ne
  defaultGetImages:
    fn::invoke:
      function: alicloud:ecs:getImages
      arguments:
        nameRegex: ^ubuntu_18.*64
        owners: system
Copy

Attributes Reference0

The following attributes are exported:

  • id - ID of the image.

Create ImageCopy Resource

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

Constructor syntax

new ImageCopy(name: string, args: ImageCopyArgs, opts?: CustomResourceOptions);
@overload
def ImageCopy(resource_name: str,
              args: ImageCopyArgs,
              opts: Optional[ResourceOptions] = None)

@overload
def ImageCopy(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              source_image_id: Optional[str] = None,
              source_region_id: Optional[str] = None,
              delete_auto_snapshot: Optional[bool] = None,
              description: Optional[str] = None,
              encrypted: Optional[bool] = None,
              force: Optional[bool] = None,
              image_name: Optional[str] = None,
              kms_key_id: Optional[str] = None,
              name: Optional[str] = None,
              tags: Optional[Mapping[str, str]] = None)
func NewImageCopy(ctx *Context, name string, args ImageCopyArgs, opts ...ResourceOption) (*ImageCopy, error)
public ImageCopy(string name, ImageCopyArgs args, CustomResourceOptions? opts = null)
public ImageCopy(String name, ImageCopyArgs args)
public ImageCopy(String name, ImageCopyArgs args, CustomResourceOptions options)

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

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. ImageCopyArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. ImageCopyArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. ImageCopyArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. ImageCopyArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. ImageCopyArgs
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 imageCopyResource = new AliCloud.Ecs.ImageCopy("imageCopyResource", new()
{
    SourceImageId = "string",
    SourceRegionId = "string",
    DeleteAutoSnapshot = false,
    Description = "string",
    Encrypted = false,
    Force = false,
    ImageName = "string",
    KmsKeyId = "string",
    Tags = 
    {
        { "string", "string" },
    },
});
Copy
example, err := ecs.NewImageCopy(ctx, "imageCopyResource", &ecs.ImageCopyArgs{
	SourceImageId:      pulumi.String("string"),
	SourceRegionId:     pulumi.String("string"),
	DeleteAutoSnapshot: pulumi.Bool(false),
	Description:        pulumi.String("string"),
	Encrypted:          pulumi.Bool(false),
	Force:              pulumi.Bool(false),
	ImageName:          pulumi.String("string"),
	KmsKeyId:           pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})
Copy
var imageCopyResource = new ImageCopy("imageCopyResource", ImageCopyArgs.builder()
    .sourceImageId("string")
    .sourceRegionId("string")
    .deleteAutoSnapshot(false)
    .description("string")
    .encrypted(false)
    .force(false)
    .imageName("string")
    .kmsKeyId("string")
    .tags(Map.of("string", "string"))
    .build());
Copy
image_copy_resource = alicloud.ecs.ImageCopy("imageCopyResource",
    source_image_id="string",
    source_region_id="string",
    delete_auto_snapshot=False,
    description="string",
    encrypted=False,
    force=False,
    image_name="string",
    kms_key_id="string",
    tags={
        "string": "string",
    })
Copy
const imageCopyResource = new alicloud.ecs.ImageCopy("imageCopyResource", {
    sourceImageId: "string",
    sourceRegionId: "string",
    deleteAutoSnapshot: false,
    description: "string",
    encrypted: false,
    force: false,
    imageName: "string",
    kmsKeyId: "string",
    tags: {
        string: "string",
    },
});
Copy
type: alicloud:ecs:ImageCopy
properties:
    deleteAutoSnapshot: false
    description: string
    encrypted: false
    force: false
    imageName: string
    kmsKeyId: string
    sourceImageId: string
    sourceRegionId: string
    tags:
        string: string
Copy

ImageCopy 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 ImageCopy resource accepts the following input properties:

SourceImageId
This property is required.
Changes to this property will trigger replacement.
string
The source image ID.
SourceRegionId
This property is required.
Changes to this property will trigger replacement.
string
The ID of the region to which the source custom image belongs. You can call DescribeRegions to view the latest regions of Alibaba Cloud.
DeleteAutoSnapshot bool
Description string
The description of the image. It must be 2 to 256 characters in length and must not start with http:// or https://. Default value: null.
Encrypted Changes to this property will trigger replacement. bool
Indicates whether to encrypt the image.
Force bool
Indicates whether to force delete the custom image, Default is false.

  • true：Force deletes the custom image, regardless of whether the image is currently being used by other instances.
  • false：Verifies that the image is not currently in use by any other instances before deleting the image.
ImageName string
The image name. It must be 2 to 128 characters in length, and must begin with a letter or Chinese character (beginning with http:// or https:// is not allowed). It can contain digits, colons (:), underscores (_), or hyphens (-). Default value: null.
KmsKeyId Changes to this property will trigger replacement. string
Key ID used to encrypt the image.
Name string

Deprecated: Attribute 'name' has been deprecated from version 1.69.0. Use image_name instead.

Tags Dictionary<string, string>
The tag value of an image. The value of N ranges from 1 to 20.
SourceImageId
This property is required.
Changes to this property will trigger replacement.
string
The source image ID.
SourceRegionId
This property is required.
Changes to this property will trigger replacement.
string
The ID of the region to which the source custom image belongs. You can call DescribeRegions to view the latest regions of Alibaba Cloud.
DeleteAutoSnapshot bool
Description string
The description of the image. It must be 2 to 256 characters in length and must not start with http:// or https://. Default value: null.
Encrypted Changes to this property will trigger replacement. bool
Indicates whether to encrypt the image.
Force bool
Indicates whether to force delete the custom image, Default is false.

  • true：Force deletes the custom image, regardless of whether the image is currently being used by other instances.
  • false：Verifies that the image is not currently in use by any other instances before deleting the image.
ImageName string
The image name. It must be 2 to 128 characters in length, and must begin with a letter or Chinese character (beginning with http:// or https:// is not allowed). It can contain digits, colons (:), underscores (_), or hyphens (-). Default value: null.
KmsKeyId Changes to this property will trigger replacement. string
Key ID used to encrypt the image.
Name string

Deprecated: Attribute 'name' has been deprecated from version 1.69.0. Use image_name instead.

Tags map[string]string
The tag value of an image. The value of N ranges from 1 to 20.
sourceImageId
This property is required.
Changes to this property will trigger replacement.
String
The source image ID.
sourceRegionId
This property is required.
Changes to this property will trigger replacement.
String
The ID of the region to which the source custom image belongs. You can call DescribeRegions to view the latest regions of Alibaba Cloud.
deleteAutoSnapshot Boolean
description String
The description of the image. It must be 2 to 256 characters in length and must not start with http:// or https://. Default value: null.
encrypted Changes to this property will trigger replacement. Boolean
Indicates whether to encrypt the image.
force Boolean
Indicates whether to force delete the custom image, Default is false.

  • true：Force deletes the custom image, regardless of whether the image is currently being used by other instances.
  • false：Verifies that the image is not currently in use by any other instances before deleting the image.
imageName String
The image name. It must be 2 to 128 characters in length, and must begin with a letter or Chinese character (beginning with http:// or https:// is not allowed). It can contain digits, colons (:), underscores (_), or hyphens (-). Default value: null.
kmsKeyId Changes to this property will trigger replacement. String
Key ID used to encrypt the image.
name String

Deprecated: Attribute 'name' has been deprecated from version 1.69.0. Use image_name instead.

tags Map<String,String>
The tag value of an image. The value of N ranges from 1 to 20.
sourceImageId
This property is required.
Changes to this property will trigger replacement.
string
The source image ID.
sourceRegionId
This property is required.
Changes to this property will trigger replacement.
string
The ID of the region to which the source custom image belongs. You can call DescribeRegions to view the latest regions of Alibaba Cloud.
deleteAutoSnapshot boolean
description string
The description of the image. It must be 2 to 256 characters in length and must not start with http:// or https://. Default value: null.
encrypted Changes to this property will trigger replacement. boolean
Indicates whether to encrypt the image.
force boolean
Indicates whether to force delete the custom image, Default is false.

  • true：Force deletes the custom image, regardless of whether the image is currently being used by other instances.
  • false：Verifies that the image is not currently in use by any other instances before deleting the image.
imageName string
The image name. It must be 2 to 128 characters in length, and must begin with a letter or Chinese character (beginning with http:// or https:// is not allowed). It can contain digits, colons (:), underscores (_), or hyphens (-). Default value: null.
kmsKeyId Changes to this property will trigger replacement. string
Key ID used to encrypt the image.
name string

Deprecated: Attribute 'name' has been deprecated from version 1.69.0. Use image_name instead.

tags {[key: string]: string}
The tag value of an image. The value of N ranges from 1 to 20.
source_image_id
This property is required.
Changes to this property will trigger replacement.
str
The source image ID.
source_region_id
This property is required.
Changes to this property will trigger replacement.
str
The ID of the region to which the source custom image belongs. You can call DescribeRegions to view the latest regions of Alibaba Cloud.
delete_auto_snapshot bool
description str
The description of the image. It must be 2 to 256 characters in length and must not start with http:// or https://. Default value: null.
encrypted Changes to this property will trigger replacement. bool
Indicates whether to encrypt the image.
force bool
Indicates whether to force delete the custom image, Default is false.

  • true：Force deletes the custom image, regardless of whether the image is currently being used by other instances.
  • false：Verifies that the image is not currently in use by any other instances before deleting the image.
image_name str
The image name. It must be 2 to 128 characters in length, and must begin with a letter or Chinese character (beginning with http:// or https:// is not allowed). It can contain digits, colons (:), underscores (_), or hyphens (-). Default value: null.
kms_key_id Changes to this property will trigger replacement. str
Key ID used to encrypt the image.
name str

Deprecated: Attribute 'name' has been deprecated from version 1.69.0. Use image_name instead.

tags Mapping[str, str]
The tag value of an image. The value of N ranges from 1 to 20.
sourceImageId
This property is required.
Changes to this property will trigger replacement.
String
The source image ID.
sourceRegionId
This property is required.
Changes to this property will trigger replacement.
String
The ID of the region to which the source custom image belongs. You can call DescribeRegions to view the latest regions of Alibaba Cloud.
deleteAutoSnapshot Boolean
description String
The description of the image. It must be 2 to 256 characters in length and must not start with http:// or https://. Default value: null.
encrypted Changes to this property will trigger replacement. Boolean
Indicates whether to encrypt the image.
force Boolean
Indicates whether to force delete the custom image, Default is false.

  • true：Force deletes the custom image, regardless of whether the image is currently being used by other instances.
  • false：Verifies that the image is not currently in use by any other instances before deleting the image.
imageName String
The image name. It must be 2 to 128 characters in length, and must begin with a letter or Chinese character (beginning with http:// or https:// is not allowed). It can contain digits, colons (:), underscores (_), or hyphens (-). Default value: null.
kmsKeyId Changes to this property will trigger replacement. String
Key ID used to encrypt the image.
name String

Deprecated: Attribute 'name' has been deprecated from version 1.69.0. Use image_name instead.

tags Map<String>
The tag value of an image. The value of N ranges from 1 to 20.

Outputs

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

Id string
The provider-assigned unique ID for this managed resource.
Id string
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.
id string
The provider-assigned unique ID for this managed resource.
id str
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.

Look up Existing ImageCopy Resource

Get an existing ImageCopy 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?: ImageCopyState, opts?: CustomResourceOptions): ImageCopy
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        delete_auto_snapshot: Optional[bool] = None,
        description: Optional[str] = None,
        encrypted: Optional[bool] = None,
        force: Optional[bool] = None,
        image_name: Optional[str] = None,
        kms_key_id: Optional[str] = None,
        name: Optional[str] = None,
        source_image_id: Optional[str] = None,
        source_region_id: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None) -> ImageCopy
func GetImageCopy(ctx *Context, name string, id IDInput, state *ImageCopyState, opts ...ResourceOption) (*ImageCopy, error)
public static ImageCopy Get(string name, Input<string> id, ImageCopyState? state, CustomResourceOptions? opts = null)
public static ImageCopy get(String name, Output<String> id, ImageCopyState state, CustomResourceOptions options)
resources:  _:    type: alicloud:ecs:ImageCopy    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
DeleteAutoSnapshot bool
Description string
The description of the image. It must be 2 to 256 characters in length and must not start with http:// or https://. Default value: null.
Encrypted Changes to this property will trigger replacement. bool
Indicates whether to encrypt the image.
Force bool
Indicates whether to force delete the custom image, Default is false.

  • true：Force deletes the custom image, regardless of whether the image is currently being used by other instances.
  • false：Verifies that the image is not currently in use by any other instances before deleting the image.
ImageName string
The image name. It must be 2 to 128 characters in length, and must begin with a letter or Chinese character (beginning with http:// or https:// is not allowed). It can contain digits, colons (:), underscores (_), or hyphens (-). Default value: null.
KmsKeyId Changes to this property will trigger replacement. string
Key ID used to encrypt the image.
Name string

Deprecated: Attribute 'name' has been deprecated from version 1.69.0. Use image_name instead.

SourceImageId Changes to this property will trigger replacement. string
The source image ID.
SourceRegionId Changes to this property will trigger replacement. string
The ID of the region to which the source custom image belongs. You can call DescribeRegions to view the latest regions of Alibaba Cloud.
Tags Dictionary<string, string>
The tag value of an image. The value of N ranges from 1 to 20.
DeleteAutoSnapshot bool
Description string
The description of the image. It must be 2 to 256 characters in length and must not start with http:// or https://. Default value: null.
Encrypted Changes to this property will trigger replacement. bool
Indicates whether to encrypt the image.
Force bool
Indicates whether to force delete the custom image, Default is false.

  • true：Force deletes the custom image, regardless of whether the image is currently being used by other instances.
  • false：Verifies that the image is not currently in use by any other instances before deleting the image.
ImageName string
The image name. It must be 2 to 128 characters in length, and must begin with a letter or Chinese character (beginning with http:// or https:// is not allowed). It can contain digits, colons (:), underscores (_), or hyphens (-). Default value: null.
KmsKeyId Changes to this property will trigger replacement. string
Key ID used to encrypt the image.
Name string

Deprecated: Attribute 'name' has been deprecated from version 1.69.0. Use image_name instead.

SourceImageId Changes to this property will trigger replacement. string
The source image ID.
SourceRegionId Changes to this property will trigger replacement. string
The ID of the region to which the source custom image belongs. You can call DescribeRegions to view the latest regions of Alibaba Cloud.
Tags map[string]string
The tag value of an image. The value of N ranges from 1 to 20.
deleteAutoSnapshot Boolean
description String
The description of the image. It must be 2 to 256 characters in length and must not start with http:// or https://. Default value: null.
encrypted Changes to this property will trigger replacement. Boolean
Indicates whether to encrypt the image.
force Boolean
Indicates whether to force delete the custom image, Default is false.

  • true：Force deletes the custom image, regardless of whether the image is currently being used by other instances.
  • false：Verifies that the image is not currently in use by any other instances before deleting the image.
imageName String
The image name. It must be 2 to 128 characters in length, and must begin with a letter or Chinese character (beginning with http:// or https:// is not allowed). It can contain digits, colons (:), underscores (_), or hyphens (-). Default value: null.
kmsKeyId Changes to this property will trigger replacement. String
Key ID used to encrypt the image.
name String

Deprecated: Attribute 'name' has been deprecated from version 1.69.0. Use image_name instead.

sourceImageId Changes to this property will trigger replacement. String
The source image ID.
sourceRegionId Changes to this property will trigger replacement. String
The ID of the region to which the source custom image belongs. You can call DescribeRegions to view the latest regions of Alibaba Cloud.
tags Map<String,String>
The tag value of an image. The value of N ranges from 1 to 20.
deleteAutoSnapshot boolean
description string
The description of the image. It must be 2 to 256 characters in length and must not start with http:// or https://. Default value: null.
encrypted Changes to this property will trigger replacement. boolean
Indicates whether to encrypt the image.
force boolean
Indicates whether to force delete the custom image, Default is false.

  • true：Force deletes the custom image, regardless of whether the image is currently being used by other instances.
  • false：Verifies that the image is not currently in use by any other instances before deleting the image.
imageName string
The image name. It must be 2 to 128 characters in length, and must begin with a letter or Chinese character (beginning with http:// or https:// is not allowed). It can contain digits, colons (:), underscores (_), or hyphens (-). Default value: null.
kmsKeyId Changes to this property will trigger replacement. string
Key ID used to encrypt the image.
name string

Deprecated: Attribute 'name' has been deprecated from version 1.69.0. Use image_name instead.

sourceImageId Changes to this property will trigger replacement. string
The source image ID.
sourceRegionId Changes to this property will trigger replacement. string
The ID of the region to which the source custom image belongs. You can call DescribeRegions to view the latest regions of Alibaba Cloud.
tags {[key: string]: string}
The tag value of an image. The value of N ranges from 1 to 20.
delete_auto_snapshot bool
description str
The description of the image. It must be 2 to 256 characters in length and must not start with http:// or https://. Default value: null.
encrypted Changes to this property will trigger replacement. bool
Indicates whether to encrypt the image.
force bool
Indicates whether to force delete the custom image, Default is false.

  • true：Force deletes the custom image, regardless of whether the image is currently being used by other instances.
  • false：Verifies that the image is not currently in use by any other instances before deleting the image.
image_name str
The image name. It must be 2 to 128 characters in length, and must begin with a letter or Chinese character (beginning with http:// or https:// is not allowed). It can contain digits, colons (:), underscores (_), or hyphens (-). Default value: null.
kms_key_id Changes to this property will trigger replacement. str
Key ID used to encrypt the image.
name str

Deprecated: Attribute 'name' has been deprecated from version 1.69.0. Use image_name instead.

source_image_id Changes to this property will trigger replacement. str
The source image ID.
source_region_id Changes to this property will trigger replacement. str
The ID of the region to which the source custom image belongs. You can call DescribeRegions to view the latest regions of Alibaba Cloud.
tags Mapping[str, str]
The tag value of an image. The value of N ranges from 1 to 20.
deleteAutoSnapshot Boolean
description String
The description of the image. It must be 2 to 256 characters in length and must not start with http:// or https://. Default value: null.
encrypted Changes to this property will trigger replacement. Boolean
Indicates whether to encrypt the image.
force Boolean
Indicates whether to force delete the custom image, Default is false.

  • true：Force deletes the custom image, regardless of whether the image is currently being used by other instances.
  • false：Verifies that the image is not currently in use by any other instances before deleting the image.
imageName String
The image name. It must be 2 to 128 characters in length, and must begin with a letter or Chinese character (beginning with http:// or https:// is not allowed). It can contain digits, colons (:), underscores (_), or hyphens (-). Default value: null.
kmsKeyId Changes to this property will trigger replacement. String
Key ID used to encrypt the image.
name String

Deprecated: Attribute 'name' has been deprecated from version 1.69.0. Use image_name instead.

sourceImageId Changes to this property will trigger replacement. String
The source image ID.
sourceRegionId Changes to this property will trigger replacement. String
The ID of the region to which the source custom image belongs. You can call DescribeRegions to view the latest regions of Alibaba Cloud.
tags Map<String>
The tag value of an image. The value of N ranges from 1 to 20.

Import

image can be imported using the id, e.g.

$ pulumi import alicloud:ecs/imageCopy:ImageCopy default m-uf66871ape***yg1q***
Copy

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

Package Details

Repository
Alibaba Cloud pulumi/pulumi-alicloud
License
Apache-2.0
Notes
This Pulumi package is based on the alicloud Terraform Provider.
Alibaba Cloud v3.75.0 published on Friday, Mar 7, 2025 by Pulumi
pulumi/pulumi-alicloud