1. Packages
  2. Tencentcloud Provider
  3. API Docs
  4. CvmImportImage
tencentcloud 1.81.189 published on Wednesday, Apr 30, 2025 by tencentcloudstack

tencentcloud.CvmImportImage

Explore with Pulumi AI

tencentcloud logo
tencentcloud 1.81.189 published on Wednesday, Apr 30, 2025 by tencentcloudstack

    Create CvmImportImage Resource

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

    Constructor syntax

    new CvmImportImage(name: string, args: CvmImportImageArgs, opts?: CustomResourceOptions);
    @overload
    def CvmImportImage(resource_name: str,
                       args: CvmImportImageArgs,
                       opts: Optional[ResourceOptions] = None)
    
    @overload
    def CvmImportImage(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       architecture: Optional[str] = None,
                       image_name: Optional[str] = None,
                       image_url: Optional[str] = None,
                       os_type: Optional[str] = None,
                       os_version: Optional[str] = None,
                       boot_mode: Optional[str] = None,
                       cvm_import_image_id: Optional[str] = None,
                       dry_run: Optional[bool] = None,
                       force: Optional[bool] = None,
                       image_description: Optional[str] = None,
                       license_type: Optional[str] = None,
                       tag_specifications: Optional[Sequence[CvmImportImageTagSpecificationArgs]] = None)
    func NewCvmImportImage(ctx *Context, name string, args CvmImportImageArgs, opts ...ResourceOption) (*CvmImportImage, error)
    public CvmImportImage(string name, CvmImportImageArgs args, CustomResourceOptions? opts = null)
    public CvmImportImage(String name, CvmImportImageArgs args)
    public CvmImportImage(String name, CvmImportImageArgs args, CustomResourceOptions options)
    
    type: tencentcloud:CvmImportImage
    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 CvmImportImageArgs
    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 CvmImportImageArgs
    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 CvmImportImageArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args CvmImportImageArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args CvmImportImageArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

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

    Architecture string
    OS architecture of the image to be imported, x86_64 or i386.
    ImageName string
    Image name.
    ImageUrl string
    Address on COS where the image to be imported is stored.
    OsType string
    OS type of the image to be imported. You can call DescribeImportImageOs to obtain the list of supported operating systems.
    OsVersion string
    OS version of the image to be imported. You can call DescribeImportImageOs to obtain the list of supported operating systems.
    BootMode string
    Boot mode.
    CvmImportImageId string
    DryRun bool
    Dry run to check the parameters without performing the operation.
    Force bool
    Whether to force import the image.
    ImageDescription string
    Image description.
    LicenseType string
    The license type used to activate the OS after importing an image. Valid values: TencentCloud: Tencent Cloud official license BYOL: Bring Your Own License.
    TagSpecifications List<CvmImportImageTagSpecification>
    Tag description list. This parameter is used to bind a tag to a custom image.
    Architecture string
    OS architecture of the image to be imported, x86_64 or i386.
    ImageName string
    Image name.
    ImageUrl string
    Address on COS where the image to be imported is stored.
    OsType string
    OS type of the image to be imported. You can call DescribeImportImageOs to obtain the list of supported operating systems.
    OsVersion string
    OS version of the image to be imported. You can call DescribeImportImageOs to obtain the list of supported operating systems.
    BootMode string
    Boot mode.
    CvmImportImageId string
    DryRun bool
    Dry run to check the parameters without performing the operation.
    Force bool
    Whether to force import the image.
    ImageDescription string
    Image description.
    LicenseType string
    The license type used to activate the OS after importing an image. Valid values: TencentCloud: Tencent Cloud official license BYOL: Bring Your Own License.
    TagSpecifications []CvmImportImageTagSpecificationArgs
    Tag description list. This parameter is used to bind a tag to a custom image.
    architecture String
    OS architecture of the image to be imported, x86_64 or i386.
    imageName String
    Image name.
    imageUrl String
    Address on COS where the image to be imported is stored.
    osType String
    OS type of the image to be imported. You can call DescribeImportImageOs to obtain the list of supported operating systems.
    osVersion String
    OS version of the image to be imported. You can call DescribeImportImageOs to obtain the list of supported operating systems.
    bootMode String
    Boot mode.
    cvmImportImageId String
    dryRun Boolean
    Dry run to check the parameters without performing the operation.
    force Boolean
    Whether to force import the image.
    imageDescription String
    Image description.
    licenseType String
    The license type used to activate the OS after importing an image. Valid values: TencentCloud: Tencent Cloud official license BYOL: Bring Your Own License.
    tagSpecifications List<CvmImportImageTagSpecification>
    Tag description list. This parameter is used to bind a tag to a custom image.
    architecture string
    OS architecture of the image to be imported, x86_64 or i386.
    imageName string
    Image name.
    imageUrl string
    Address on COS where the image to be imported is stored.
    osType string
    OS type of the image to be imported. You can call DescribeImportImageOs to obtain the list of supported operating systems.
    osVersion string
    OS version of the image to be imported. You can call DescribeImportImageOs to obtain the list of supported operating systems.
    bootMode string
    Boot mode.
    cvmImportImageId string
    dryRun boolean
    Dry run to check the parameters without performing the operation.
    force boolean
    Whether to force import the image.
    imageDescription string
    Image description.
    licenseType string
    The license type used to activate the OS after importing an image. Valid values: TencentCloud: Tencent Cloud official license BYOL: Bring Your Own License.
    tagSpecifications CvmImportImageTagSpecification[]
    Tag description list. This parameter is used to bind a tag to a custom image.
    architecture str
    OS architecture of the image to be imported, x86_64 or i386.
    image_name str
    Image name.
    image_url str
    Address on COS where the image to be imported is stored.
    os_type str
    OS type of the image to be imported. You can call DescribeImportImageOs to obtain the list of supported operating systems.
    os_version str
    OS version of the image to be imported. You can call DescribeImportImageOs to obtain the list of supported operating systems.
    boot_mode str
    Boot mode.
    cvm_import_image_id str
    dry_run bool
    Dry run to check the parameters without performing the operation.
    force bool
    Whether to force import the image.
    image_description str
    Image description.
    license_type str
    The license type used to activate the OS after importing an image. Valid values: TencentCloud: Tencent Cloud official license BYOL: Bring Your Own License.
    tag_specifications Sequence[CvmImportImageTagSpecificationArgs]
    Tag description list. This parameter is used to bind a tag to a custom image.
    architecture String
    OS architecture of the image to be imported, x86_64 or i386.
    imageName String
    Image name.
    imageUrl String
    Address on COS where the image to be imported is stored.
    osType String
    OS type of the image to be imported. You can call DescribeImportImageOs to obtain the list of supported operating systems.
    osVersion String
    OS version of the image to be imported. You can call DescribeImportImageOs to obtain the list of supported operating systems.
    bootMode String
    Boot mode.
    cvmImportImageId String
    dryRun Boolean
    Dry run to check the parameters without performing the operation.
    force Boolean
    Whether to force import the image.
    imageDescription String
    Image description.
    licenseType String
    The license type used to activate the OS after importing an image. Valid values: TencentCloud: Tencent Cloud official license BYOL: Bring Your Own License.
    tagSpecifications List<Property Map>
    Tag description list. This parameter is used to bind a tag to a custom image.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the CvmImportImage 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 CvmImportImage Resource

    Get an existing CvmImportImage 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?: CvmImportImageState, opts?: CustomResourceOptions): CvmImportImage
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            architecture: Optional[str] = None,
            boot_mode: Optional[str] = None,
            cvm_import_image_id: Optional[str] = None,
            dry_run: Optional[bool] = None,
            force: Optional[bool] = None,
            image_description: Optional[str] = None,
            image_name: Optional[str] = None,
            image_url: Optional[str] = None,
            license_type: Optional[str] = None,
            os_type: Optional[str] = None,
            os_version: Optional[str] = None,
            tag_specifications: Optional[Sequence[CvmImportImageTagSpecificationArgs]] = None) -> CvmImportImage
    func GetCvmImportImage(ctx *Context, name string, id IDInput, state *CvmImportImageState, opts ...ResourceOption) (*CvmImportImage, error)
    public static CvmImportImage Get(string name, Input<string> id, CvmImportImageState? state, CustomResourceOptions? opts = null)
    public static CvmImportImage get(String name, Output<String> id, CvmImportImageState state, CustomResourceOptions options)
    resources:  _:    type: tencentcloud:CvmImportImage    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
    OS architecture of the image to be imported, x86_64 or i386.
    BootMode string
    Boot mode.
    CvmImportImageId string
    DryRun bool
    Dry run to check the parameters without performing the operation.
    Force bool
    Whether to force import the image.
    ImageDescription string
    Image description.
    ImageName string
    Image name.
    ImageUrl string
    Address on COS where the image to be imported is stored.
    LicenseType string
    The license type used to activate the OS after importing an image. Valid values: TencentCloud: Tencent Cloud official license BYOL: Bring Your Own License.
    OsType string
    OS type of the image to be imported. You can call DescribeImportImageOs to obtain the list of supported operating systems.
    OsVersion string
    OS version of the image to be imported. You can call DescribeImportImageOs to obtain the list of supported operating systems.
    TagSpecifications List<CvmImportImageTagSpecification>
    Tag description list. This parameter is used to bind a tag to a custom image.
    Architecture string
    OS architecture of the image to be imported, x86_64 or i386.
    BootMode string
    Boot mode.
    CvmImportImageId string
    DryRun bool
    Dry run to check the parameters without performing the operation.
    Force bool
    Whether to force import the image.
    ImageDescription string
    Image description.
    ImageName string
    Image name.
    ImageUrl string
    Address on COS where the image to be imported is stored.
    LicenseType string
    The license type used to activate the OS after importing an image. Valid values: TencentCloud: Tencent Cloud official license BYOL: Bring Your Own License.
    OsType string
    OS type of the image to be imported. You can call DescribeImportImageOs to obtain the list of supported operating systems.
    OsVersion string
    OS version of the image to be imported. You can call DescribeImportImageOs to obtain the list of supported operating systems.
    TagSpecifications []CvmImportImageTagSpecificationArgs
    Tag description list. This parameter is used to bind a tag to a custom image.
    architecture String
    OS architecture of the image to be imported, x86_64 or i386.
    bootMode String
    Boot mode.
    cvmImportImageId String
    dryRun Boolean
    Dry run to check the parameters without performing the operation.
    force Boolean
    Whether to force import the image.
    imageDescription String
    Image description.
    imageName String
    Image name.
    imageUrl String
    Address on COS where the image to be imported is stored.
    licenseType String
    The license type used to activate the OS after importing an image. Valid values: TencentCloud: Tencent Cloud official license BYOL: Bring Your Own License.
    osType String
    OS type of the image to be imported. You can call DescribeImportImageOs to obtain the list of supported operating systems.
    osVersion String
    OS version of the image to be imported. You can call DescribeImportImageOs to obtain the list of supported operating systems.
    tagSpecifications List<CvmImportImageTagSpecification>
    Tag description list. This parameter is used to bind a tag to a custom image.
    architecture string
    OS architecture of the image to be imported, x86_64 or i386.
    bootMode string
    Boot mode.
    cvmImportImageId string
    dryRun boolean
    Dry run to check the parameters without performing the operation.
    force boolean
    Whether to force import the image.
    imageDescription string
    Image description.
    imageName string
    Image name.
    imageUrl string
    Address on COS where the image to be imported is stored.
    licenseType string
    The license type used to activate the OS after importing an image. Valid values: TencentCloud: Tencent Cloud official license BYOL: Bring Your Own License.
    osType string
    OS type of the image to be imported. You can call DescribeImportImageOs to obtain the list of supported operating systems.
    osVersion string
    OS version of the image to be imported. You can call DescribeImportImageOs to obtain the list of supported operating systems.
    tagSpecifications CvmImportImageTagSpecification[]
    Tag description list. This parameter is used to bind a tag to a custom image.
    architecture str
    OS architecture of the image to be imported, x86_64 or i386.
    boot_mode str
    Boot mode.
    cvm_import_image_id str
    dry_run bool
    Dry run to check the parameters without performing the operation.
    force bool
    Whether to force import the image.
    image_description str
    Image description.
    image_name str
    Image name.
    image_url str
    Address on COS where the image to be imported is stored.
    license_type str
    The license type used to activate the OS after importing an image. Valid values: TencentCloud: Tencent Cloud official license BYOL: Bring Your Own License.
    os_type str
    OS type of the image to be imported. You can call DescribeImportImageOs to obtain the list of supported operating systems.
    os_version str
    OS version of the image to be imported. You can call DescribeImportImageOs to obtain the list of supported operating systems.
    tag_specifications Sequence[CvmImportImageTagSpecificationArgs]
    Tag description list. This parameter is used to bind a tag to a custom image.
    architecture String
    OS architecture of the image to be imported, x86_64 or i386.
    bootMode String
    Boot mode.
    cvmImportImageId String
    dryRun Boolean
    Dry run to check the parameters without performing the operation.
    force Boolean
    Whether to force import the image.
    imageDescription String
    Image description.
    imageName String
    Image name.
    imageUrl String
    Address on COS where the image to be imported is stored.
    licenseType String
    The license type used to activate the OS after importing an image. Valid values: TencentCloud: Tencent Cloud official license BYOL: Bring Your Own License.
    osType String
    OS type of the image to be imported. You can call DescribeImportImageOs to obtain the list of supported operating systems.
    osVersion String
    OS version of the image to be imported. You can call DescribeImportImageOs to obtain the list of supported operating systems.
    tagSpecifications List<Property Map>
    Tag description list. This parameter is used to bind a tag to a custom image.

    Supporting Types

    CvmImportImageTagSpecification, CvmImportImageTagSpecificationArgs

    ResourceType string
    Resource type. Valid values: instance (CVM), host (CDH), image (for image), and keypair (for key). Note: This field may return null, indicating that no valid values can be obtained.
    Tags List<CvmImportImageTagSpecificationTag>
    Tag pairs Note: This field may return null, indicating that no valid values can be obtained.
    ResourceType string
    Resource type. Valid values: instance (CVM), host (CDH), image (for image), and keypair (for key). Note: This field may return null, indicating that no valid values can be obtained.
    Tags []CvmImportImageTagSpecificationTag
    Tag pairs Note: This field may return null, indicating that no valid values can be obtained.
    resourceType String
    Resource type. Valid values: instance (CVM), host (CDH), image (for image), and keypair (for key). Note: This field may return null, indicating that no valid values can be obtained.
    tags List<CvmImportImageTagSpecificationTag>
    Tag pairs Note: This field may return null, indicating that no valid values can be obtained.
    resourceType string
    Resource type. Valid values: instance (CVM), host (CDH), image (for image), and keypair (for key). Note: This field may return null, indicating that no valid values can be obtained.
    tags CvmImportImageTagSpecificationTag[]
    Tag pairs Note: This field may return null, indicating that no valid values can be obtained.
    resource_type str
    Resource type. Valid values: instance (CVM), host (CDH), image (for image), and keypair (for key). Note: This field may return null, indicating that no valid values can be obtained.
    tags Sequence[CvmImportImageTagSpecificationTag]
    Tag pairs Note: This field may return null, indicating that no valid values can be obtained.
    resourceType String
    Resource type. Valid values: instance (CVM), host (CDH), image (for image), and keypair (for key). Note: This field may return null, indicating that no valid values can be obtained.
    tags List<Property Map>
    Tag pairs Note: This field may return null, indicating that no valid values can be obtained.

    CvmImportImageTagSpecificationTag, CvmImportImageTagSpecificationTagArgs

    Key string
    Tag key.
    Value string
    Tag value.
    Key string
    Tag key.
    Value string
    Tag value.
    key String
    Tag key.
    value String
    Tag value.
    key string
    Tag key.
    value string
    Tag value.
    key str
    Tag key.
    value str
    Tag value.
    key String
    Tag key.
    value String
    Tag value.

    Package Details

    Repository
    tencentcloud tencentcloudstack/terraform-provider-tencentcloud
    License
    Notes
    This Pulumi package is based on the tencentcloud Terraform Provider.
    tencentcloud logo
    tencentcloud 1.81.189 published on Wednesday, Apr 30, 2025 by tencentcloudstack