Google Native

Pulumi Official
Package maintained by Pulumi
v0.23.0 published on Thursday, Aug 11, 2022 by Pulumi

CloneJob

Initiates a Clone of a specific migrating VM. Auto-naming is currently not supported for this resource. Note - this resource’s API doesn’t support deletion. When deleted, the resource will persist on Google Cloud even though it will be deleted from Pulumi state.

Create a CloneJob Resource

new CloneJob(name: string, args: CloneJobArgs, opts?: CustomResourceOptions);
@overload
def CloneJob(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             clone_job_id: Optional[str] = None,
             location: Optional[str] = None,
             migrating_vm_id: Optional[str] = None,
             project: Optional[str] = None,
             request_id: Optional[str] = None,
             source_id: Optional[str] = None)
@overload
def CloneJob(resource_name: str,
             args: CloneJobArgs,
             opts: Optional[ResourceOptions] = None)
func NewCloneJob(ctx *Context, name string, args CloneJobArgs, opts ...ResourceOption) (*CloneJob, error)
public CloneJob(string name, CloneJobArgs args, CustomResourceOptions? opts = null)
public CloneJob(String name, CloneJobArgs args)
public CloneJob(String name, CloneJobArgs args, CustomResourceOptions options)
type: google-native:vmmigration/v1:CloneJob
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string
The unique name of the resource.
args CloneJobArgs
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 CloneJobArgs
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 CloneJobArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args CloneJobArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args CloneJobArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

CloneJob Resource Properties

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

Inputs

The CloneJob resource accepts the following input properties:

CloneJobId string

Required. The clone job identifier.

MigratingVmId string
SourceId string
Location string
Project string
RequestId string

A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and t he request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

CloneJobId string

Required. The clone job identifier.

MigratingVmId string
SourceId string
Location string
Project string
RequestId string

A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and t he request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

cloneJobId String

Required. The clone job identifier.

migratingVmId String
sourceId String
location String
project String
requestId String

A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and t he request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

cloneJobId string

Required. The clone job identifier.

migratingVmId string
sourceId string
location string
project string
requestId string

A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and t he request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

clone_job_id str

Required. The clone job identifier.

migrating_vm_id str
source_id str
location str
project str
request_id str

A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and t he request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

cloneJobId String

Required. The clone job identifier.

migratingVmId String
sourceId String
location String
project String
requestId String

A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and t he request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Outputs

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

ComputeEngineTargetDetails Pulumi.GoogleNative.VMMigration.V1.Outputs.ComputeEngineTargetDetailsResponse

Details of the target VM in Compute Engine.

CreateTime string

The time the clone job was created (as an API call, not when it was actually created in the target).

EndTime string

The time the clone job was ended.

Error Pulumi.GoogleNative.VMMigration.V1.Outputs.StatusResponse

Provides details for the errors that led to the Clone Job's state.

Id string

The provider-assigned unique ID for this managed resource.

Name string

The name of the clone.

State string

State of the clone job.

StateTime string

The time the state was last updated.

ComputeEngineTargetDetails ComputeEngineTargetDetailsResponse

Details of the target VM in Compute Engine.

CreateTime string

The time the clone job was created (as an API call, not when it was actually created in the target).

EndTime string

The time the clone job was ended.

Error StatusResponse

Provides details for the errors that led to the Clone Job's state.

Id string

The provider-assigned unique ID for this managed resource.

Name string

The name of the clone.

State string

State of the clone job.

StateTime string

The time the state was last updated.

computeEngineTargetDetails ComputeEngineTargetDetailsResponse

Details of the target VM in Compute Engine.

createTime String

The time the clone job was created (as an API call, not when it was actually created in the target).

endTime String

The time the clone job was ended.

error StatusResponse

Provides details for the errors that led to the Clone Job's state.

id String

The provider-assigned unique ID for this managed resource.

name String

The name of the clone.

state String

State of the clone job.

stateTime String

The time the state was last updated.

computeEngineTargetDetails ComputeEngineTargetDetailsResponse

Details of the target VM in Compute Engine.

createTime string

The time the clone job was created (as an API call, not when it was actually created in the target).

endTime string

The time the clone job was ended.

error StatusResponse

Provides details for the errors that led to the Clone Job's state.

id string

The provider-assigned unique ID for this managed resource.

name string

The name of the clone.

state string

State of the clone job.

stateTime string

The time the state was last updated.

compute_engine_target_details ComputeEngineTargetDetailsResponse

Details of the target VM in Compute Engine.

create_time str

The time the clone job was created (as an API call, not when it was actually created in the target).

end_time str

The time the clone job was ended.

error StatusResponse

Provides details for the errors that led to the Clone Job's state.

id str

The provider-assigned unique ID for this managed resource.

name str

The name of the clone.

state str

State of the clone job.

state_time str

The time the state was last updated.

computeEngineTargetDetails Property Map

Details of the target VM in Compute Engine.

createTime String

The time the clone job was created (as an API call, not when it was actually created in the target).

endTime String

The time the clone job was ended.

error Property Map

Provides details for the errors that led to the Clone Job's state.

id String

The provider-assigned unique ID for this managed resource.

name String

The name of the clone.

state String

State of the clone job.

stateTime String

The time the state was last updated.

Supporting Types

AppliedLicenseResponse

OsLicense string

The OS license returned from the adaptation module's report.

Type string

The license type that was used in OS adaptation.

OsLicense string

The OS license returned from the adaptation module's report.

Type string

The license type that was used in OS adaptation.

osLicense String

The OS license returned from the adaptation module's report.

type String

The license type that was used in OS adaptation.

osLicense string

The OS license returned from the adaptation module's report.

type string

The license type that was used in OS adaptation.

os_license str

The OS license returned from the adaptation module's report.

type str

The license type that was used in OS adaptation.

osLicense String

The OS license returned from the adaptation module's report.

type String

The license type that was used in OS adaptation.

ComputeEngineTargetDetailsResponse

AdditionalLicenses List<string>

Additional licenses to assign to the VM.

AppliedLicense Pulumi.GoogleNative.VMMigration.V1.Inputs.AppliedLicenseResponse

The OS license returned from the adaptation module report.

BootOption string

The VM Boot Option, as set in the source vm.

ComputeScheduling Pulumi.GoogleNative.VMMigration.V1.Inputs.ComputeSchedulingResponse

Compute instance scheduling information (if empty default is used).

DiskType string

The disk type to use in the VM.

Hostname string

The hostname to assign to the VM.

Labels Dictionary<string, string>

A map of labels to associate with the VM.

LicenseType string

The license type to use in OS adaptation.

MachineType string

The machine type to create the VM with.

MachineTypeSeries string

The machine type series to create the VM with.

Metadata Dictionary<string, string>

The metadata key/value pairs to assign to the VM.

NetworkInterfaces List<Pulumi.GoogleNative.VMMigration.V1.Inputs.NetworkInterfaceResponse>

List of NICs connected to this VM.

NetworkTags List<string>

A map of network tags to associate with the VM.

Project string

The GCP target project ID or project name.

SecureBoot bool

Defines whether the instance has Secure Boot enabled. This can be set to true only if the vm boot option is EFI.

ServiceAccount string

The service account to associate the VM with.

VmName string

The name of the VM to create.

Zone string

The zone in which to create the VM.

AdditionalLicenses []string

Additional licenses to assign to the VM.

AppliedLicense AppliedLicenseResponse

The OS license returned from the adaptation module report.

BootOption string

The VM Boot Option, as set in the source vm.

ComputeScheduling ComputeSchedulingResponse

Compute instance scheduling information (if empty default is used).

DiskType string

The disk type to use in the VM.

Hostname string

The hostname to assign to the VM.

Labels map[string]string

A map of labels to associate with the VM.

LicenseType string

The license type to use in OS adaptation.

MachineType string

The machine type to create the VM with.

MachineTypeSeries string

The machine type series to create the VM with.

Metadata map[string]string

The metadata key/value pairs to assign to the VM.

NetworkInterfaces []NetworkInterfaceResponse

List of NICs connected to this VM.

NetworkTags []string

A map of network tags to associate with the VM.

Project string

The GCP target project ID or project name.

SecureBoot bool

Defines whether the instance has Secure Boot enabled. This can be set to true only if the vm boot option is EFI.

ServiceAccount string

The service account to associate the VM with.

VmName string

The name of the VM to create.

Zone string

The zone in which to create the VM.

additionalLicenses List<String>

Additional licenses to assign to the VM.

appliedLicense AppliedLicenseResponse

The OS license returned from the adaptation module report.

bootOption String

The VM Boot Option, as set in the source vm.

computeScheduling ComputeSchedulingResponse

Compute instance scheduling information (if empty default is used).

diskType String

The disk type to use in the VM.

hostname String

The hostname to assign to the VM.

labels Map<String,String>

A map of labels to associate with the VM.

licenseType String

The license type to use in OS adaptation.

machineType String

The machine type to create the VM with.

machineTypeSeries String

The machine type series to create the VM with.

metadata Map<String,String>

The metadata key/value pairs to assign to the VM.

networkInterfaces List<NetworkInterfaceResponse>

List of NICs connected to this VM.

networkTags List<String>

A map of network tags to associate with the VM.

project String

The GCP target project ID or project name.

secureBoot Boolean

Defines whether the instance has Secure Boot enabled. This can be set to true only if the vm boot option is EFI.

serviceAccount String

The service account to associate the VM with.

vmName String

The name of the VM to create.

zone String

The zone in which to create the VM.

additionalLicenses string[]

Additional licenses to assign to the VM.

appliedLicense AppliedLicenseResponse

The OS license returned from the adaptation module report.

bootOption string

The VM Boot Option, as set in the source vm.

computeScheduling ComputeSchedulingResponse

Compute instance scheduling information (if empty default is used).

diskType string

The disk type to use in the VM.

hostname string

The hostname to assign to the VM.

labels {[key: string]: string}

A map of labels to associate with the VM.

licenseType string

The license type to use in OS adaptation.

machineType string

The machine type to create the VM with.

machineTypeSeries string

The machine type series to create the VM with.

metadata {[key: string]: string}

The metadata key/value pairs to assign to the VM.

networkInterfaces NetworkInterfaceResponse[]

List of NICs connected to this VM.

networkTags string[]

A map of network tags to associate with the VM.

project string

The GCP target project ID or project name.

secureBoot boolean

Defines whether the instance has Secure Boot enabled. This can be set to true only if the vm boot option is EFI.

serviceAccount string

The service account to associate the VM with.

vmName string

The name of the VM to create.

zone string

The zone in which to create the VM.

additional_licenses Sequence[str]

Additional licenses to assign to the VM.

applied_license AppliedLicenseResponse

The OS license returned from the adaptation module report.

boot_option str

The VM Boot Option, as set in the source vm.

compute_scheduling ComputeSchedulingResponse

Compute instance scheduling information (if empty default is used).

disk_type str

The disk type to use in the VM.

hostname str

The hostname to assign to the VM.

labels Mapping[str, str]

A map of labels to associate with the VM.

license_type str

The license type to use in OS adaptation.

machine_type str

The machine type to create the VM with.

machine_type_series str

The machine type series to create the VM with.

metadata Mapping[str, str]

The metadata key/value pairs to assign to the VM.

network_interfaces Sequence[NetworkInterfaceResponse]

List of NICs connected to this VM.

network_tags Sequence[str]

A map of network tags to associate with the VM.

project str

The GCP target project ID or project name.

secure_boot bool

Defines whether the instance has Secure Boot enabled. This can be set to true only if the vm boot option is EFI.

service_account str

The service account to associate the VM with.

vm_name str

The name of the VM to create.

zone str

The zone in which to create the VM.

additionalLicenses List<String>

Additional licenses to assign to the VM.

appliedLicense Property Map

The OS license returned from the adaptation module report.

bootOption String

The VM Boot Option, as set in the source vm.

computeScheduling Property Map

Compute instance scheduling information (if empty default is used).

diskType String

The disk type to use in the VM.

hostname String

The hostname to assign to the VM.

labels Map<String>

A map of labels to associate with the VM.

licenseType String

The license type to use in OS adaptation.

machineType String

The machine type to create the VM with.

machineTypeSeries String

The machine type series to create the VM with.

metadata Map<String>

The metadata key/value pairs to assign to the VM.

networkInterfaces List<Property Map>

List of NICs connected to this VM.

networkTags List<String>

A map of network tags to associate with the VM.

project String

The GCP target project ID or project name.

secureBoot Boolean

Defines whether the instance has Secure Boot enabled. This can be set to true only if the vm boot option is EFI.

serviceAccount String

The service account to associate the VM with.

vmName String

The name of the VM to create.

zone String

The zone in which to create the VM.

ComputeSchedulingResponse

MinNodeCpus int

The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node. Ignored if no node_affinites are configured.

NodeAffinities List<Pulumi.GoogleNative.VMMigration.V1.Inputs.SchedulingNodeAffinityResponse>

A set of node affinity and anti-affinity configurations for sole tenant nodes.

OnHostMaintenance string

How the instance should behave when the host machine undergoes maintenance that may temporarily impact instance performance.

RestartType string

Whether the Instance should be automatically restarted whenever it is terminated by Compute Engine (not terminated by user). This configuration is identical to automaticRestart field in Compute Engine create instance under scheduling. It was changed to an enum (instead of a boolean) to match the default value in Compute Engine which is automatic restart.

MinNodeCpus int

The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node. Ignored if no node_affinites are configured.

NodeAffinities []SchedulingNodeAffinityResponse

A set of node affinity and anti-affinity configurations for sole tenant nodes.

OnHostMaintenance string

How the instance should behave when the host machine undergoes maintenance that may temporarily impact instance performance.

RestartType string

Whether the Instance should be automatically restarted whenever it is terminated by Compute Engine (not terminated by user). This configuration is identical to automaticRestart field in Compute Engine create instance under scheduling. It was changed to an enum (instead of a boolean) to match the default value in Compute Engine which is automatic restart.

minNodeCpus Integer

The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node. Ignored if no node_affinites are configured.

nodeAffinities List<SchedulingNodeAffinityResponse>

A set of node affinity and anti-affinity configurations for sole tenant nodes.

onHostMaintenance String

How the instance should behave when the host machine undergoes maintenance that may temporarily impact instance performance.

restartType String

Whether the Instance should be automatically restarted whenever it is terminated by Compute Engine (not terminated by user). This configuration is identical to automaticRestart field in Compute Engine create instance under scheduling. It was changed to an enum (instead of a boolean) to match the default value in Compute Engine which is automatic restart.

minNodeCpus number

The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node. Ignored if no node_affinites are configured.

nodeAffinities SchedulingNodeAffinityResponse[]

A set of node affinity and anti-affinity configurations for sole tenant nodes.

onHostMaintenance string

How the instance should behave when the host machine undergoes maintenance that may temporarily impact instance performance.

restartType string

Whether the Instance should be automatically restarted whenever it is terminated by Compute Engine (not terminated by user). This configuration is identical to automaticRestart field in Compute Engine create instance under scheduling. It was changed to an enum (instead of a boolean) to match the default value in Compute Engine which is automatic restart.

min_node_cpus int

The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node. Ignored if no node_affinites are configured.

node_affinities Sequence[SchedulingNodeAffinityResponse]

A set of node affinity and anti-affinity configurations for sole tenant nodes.

on_host_maintenance str

How the instance should behave when the host machine undergoes maintenance that may temporarily impact instance performance.

restart_type str

Whether the Instance should be automatically restarted whenever it is terminated by Compute Engine (not terminated by user). This configuration is identical to automaticRestart field in Compute Engine create instance under scheduling. It was changed to an enum (instead of a boolean) to match the default value in Compute Engine which is automatic restart.

minNodeCpus Number

The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node. Ignored if no node_affinites are configured.

nodeAffinities List<Property Map>

A set of node affinity and anti-affinity configurations for sole tenant nodes.

onHostMaintenance String

How the instance should behave when the host machine undergoes maintenance that may temporarily impact instance performance.

restartType String

Whether the Instance should be automatically restarted whenever it is terminated by Compute Engine (not terminated by user). This configuration is identical to automaticRestart field in Compute Engine create instance under scheduling. It was changed to an enum (instead of a boolean) to match the default value in Compute Engine which is automatic restart.

NetworkInterfaceResponse

ExternalIp string

The external IP to define in the NIC.

InternalIp string

The internal IP to define in the NIC. The formats accepted are: ephemeral \ ipv4 address \ a named address resource full path.

Network string

The network to connect the NIC to.

Subnetwork string

The subnetwork to connect the NIC to.

ExternalIp string

The external IP to define in the NIC.

InternalIp string

The internal IP to define in the NIC. The formats accepted are: ephemeral \ ipv4 address \ a named address resource full path.

Network string

The network to connect the NIC to.

Subnetwork string

The subnetwork to connect the NIC to.

externalIp String

The external IP to define in the NIC.

internalIp String

The internal IP to define in the NIC. The formats accepted are: ephemeral \ ipv4 address \ a named address resource full path.

network String

The network to connect the NIC to.

subnetwork String

The subnetwork to connect the NIC to.

externalIp string

The external IP to define in the NIC.

internalIp string

The internal IP to define in the NIC. The formats accepted are: ephemeral \ ipv4 address \ a named address resource full path.

network string

The network to connect the NIC to.

subnetwork string

The subnetwork to connect the NIC to.

external_ip str

The external IP to define in the NIC.

internal_ip str

The internal IP to define in the NIC. The formats accepted are: ephemeral \ ipv4 address \ a named address resource full path.

network str

The network to connect the NIC to.

subnetwork str

The subnetwork to connect the NIC to.

externalIp String

The external IP to define in the NIC.

internalIp String

The internal IP to define in the NIC. The formats accepted are: ephemeral \ ipv4 address \ a named address resource full path.

network String

The network to connect the NIC to.

subnetwork String

The subnetwork to connect the NIC to.

SchedulingNodeAffinityResponse

Key string

The label key of Node resource to reference.

Operator string

The operator to use for the node resources specified in the values parameter.

Values List<string>

Corresponds to the label values of Node resource.

Key string

The label key of Node resource to reference.

Operator string

The operator to use for the node resources specified in the values parameter.

Values []string

Corresponds to the label values of Node resource.

key String

The label key of Node resource to reference.

operator String

The operator to use for the node resources specified in the values parameter.

values List<String>

Corresponds to the label values of Node resource.

key string

The label key of Node resource to reference.

operator string

The operator to use for the node resources specified in the values parameter.

values string[]

Corresponds to the label values of Node resource.

key str

The label key of Node resource to reference.

operator str

The operator to use for the node resources specified in the values parameter.

values Sequence[str]

Corresponds to the label values of Node resource.

key String

The label key of Node resource to reference.

operator String

The operator to use for the node resources specified in the values parameter.

values List<String>

Corresponds to the label values of Node resource.

StatusResponse

Code int

The status code, which should be an enum value of google.rpc.Code.

Details List<ImmutableDictionary<string, string>>

A list of messages that carry the error details. There is a common set of message types for APIs to use.

Message string

A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.

Code int

The status code, which should be an enum value of google.rpc.Code.

Details []map[string]string

A list of messages that carry the error details. There is a common set of message types for APIs to use.

Message string

A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.

code Integer

The status code, which should be an enum value of google.rpc.Code.

details List<Map<String,String>>

A list of messages that carry the error details. There is a common set of message types for APIs to use.

message String

A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.

code number

The status code, which should be an enum value of google.rpc.Code.

details {[key: string]: string}[]

A list of messages that carry the error details. There is a common set of message types for APIs to use.

message string

A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.

code int

The status code, which should be an enum value of google.rpc.Code.

details Sequence[Mapping[str, str]]

A list of messages that carry the error details. There is a common set of message types for APIs to use.

message str

A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.

code Number

The status code, which should be an enum value of google.rpc.Code.

details List<Map<String>>

A list of messages that carry the error details. There is a common set of message types for APIs to use.

message String

A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.

Package Details

Repository
https://github.com/pulumi/pulumi-google-native
License
Apache-2.0