vkcs.ComputeInstance
Explore with Pulumi AI
Create ComputeInstance Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new ComputeInstance(name: string, args?: ComputeInstanceArgs, opts?: CustomResourceOptions);
@overload
def ComputeInstance(resource_name: str,
args: Optional[ComputeInstanceArgs] = None,
opts: Optional[ResourceOptions] = None)
@overload
def ComputeInstance(resource_name: str,
opts: Optional[ResourceOptions] = None,
access_ip_v4: Optional[str] = None,
admin_pass: Optional[str] = None,
availability_zone: Optional[str] = None,
block_devices: Optional[Sequence[ComputeInstanceBlockDeviceArgs]] = None,
cloud_monitoring: Optional[ComputeInstanceCloudMonitoringArgs] = None,
compute_instance_id: Optional[str] = None,
config_drive: Optional[bool] = None,
flavor_id: Optional[str] = None,
flavor_name: Optional[str] = None,
force_delete: Optional[bool] = None,
image_id: Optional[str] = None,
image_name: Optional[str] = None,
key_pair: Optional[str] = None,
metadata: Optional[Mapping[str, str]] = None,
name: Optional[str] = None,
network_mode: Optional[str] = None,
networks: Optional[Sequence[ComputeInstanceNetworkArgs]] = None,
personalities: Optional[Sequence[ComputeInstancePersonalityArgs]] = None,
power_state: Optional[str] = None,
region: Optional[str] = None,
scheduler_hints: Optional[Sequence[ComputeInstanceSchedulerHintArgs]] = None,
security_group_ids: Optional[Sequence[str]] = None,
security_groups: Optional[Sequence[str]] = None,
stop_before_destroy: Optional[bool] = None,
tags: Optional[Sequence[str]] = None,
timeouts: Optional[ComputeInstanceTimeoutsArgs] = None,
user_data: Optional[str] = None,
vendor_options: Optional[ComputeInstanceVendorOptionsArgs] = None)
func NewComputeInstance(ctx *Context, name string, args *ComputeInstanceArgs, opts ...ResourceOption) (*ComputeInstance, error)
public ComputeInstance(string name, ComputeInstanceArgs? args = null, CustomResourceOptions? opts = null)
public ComputeInstance(String name, ComputeInstanceArgs args)
public ComputeInstance(String name, ComputeInstanceArgs args, CustomResourceOptions options)
type: vkcs:ComputeInstance
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 ComputeInstanceArgs
- 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 ComputeInstanceArgs
- 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 ComputeInstanceArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args ComputeInstanceArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args ComputeInstanceArgs
- 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 computeInstanceResource = new Vkcs.ComputeInstance("computeInstanceResource", new()
{
AccessIpV4 = "string",
AdminPass = "string",
AvailabilityZone = "string",
BlockDevices = new[]
{
new Vkcs.Inputs.ComputeInstanceBlockDeviceArgs
{
SourceType = "string",
BootIndex = 0,
DeleteOnTermination = false,
DestinationType = "string",
DeviceType = "string",
DiskBus = "string",
GuestFormat = "string",
Uuid = "string",
VolumeSize = 0,
VolumeType = "string",
},
},
CloudMonitoring = new Vkcs.Inputs.ComputeInstanceCloudMonitoringArgs
{
Script = "string",
ServiceUserId = "string",
},
ComputeInstanceId = "string",
ConfigDrive = false,
FlavorId = "string",
FlavorName = "string",
ForceDelete = false,
ImageId = "string",
ImageName = "string",
KeyPair = "string",
Metadata =
{
{ "string", "string" },
},
Name = "string",
NetworkMode = "string",
Networks = new[]
{
new Vkcs.Inputs.ComputeInstanceNetworkArgs
{
AccessNetwork = false,
FixedIpV4 = "string",
Mac = "string",
Name = "string",
Port = "string",
Uuid = "string",
},
},
Personalities = new[]
{
new Vkcs.Inputs.ComputeInstancePersonalityArgs
{
Content = "string",
File = "string",
},
},
PowerState = "string",
Region = "string",
SchedulerHints = new[]
{
new Vkcs.Inputs.ComputeInstanceSchedulerHintArgs
{
Group = "string",
},
},
SecurityGroupIds = new[]
{
"string",
},
StopBeforeDestroy = false,
Tags = new[]
{
"string",
},
Timeouts = new Vkcs.Inputs.ComputeInstanceTimeoutsArgs
{
Create = "string",
Delete = "string",
Update = "string",
},
UserData = "string",
VendorOptions = new Vkcs.Inputs.ComputeInstanceVendorOptionsArgs
{
DetachPortsBeforeDestroy = false,
GetPasswordData = false,
IgnoreResizeConfirmation = false,
},
});
example, err := vkcs.NewComputeInstance(ctx, "computeInstanceResource", &vkcs.ComputeInstanceArgs{
AccessIpV4: pulumi.String("string"),
AdminPass: pulumi.String("string"),
AvailabilityZone: pulumi.String("string"),
BlockDevices: vkcs.ComputeInstanceBlockDeviceArray{
&vkcs.ComputeInstanceBlockDeviceArgs{
SourceType: pulumi.String("string"),
BootIndex: pulumi.Float64(0),
DeleteOnTermination: pulumi.Bool(false),
DestinationType: pulumi.String("string"),
DeviceType: pulumi.String("string"),
DiskBus: pulumi.String("string"),
GuestFormat: pulumi.String("string"),
Uuid: pulumi.String("string"),
VolumeSize: pulumi.Float64(0),
VolumeType: pulumi.String("string"),
},
},
CloudMonitoring: &vkcs.ComputeInstanceCloudMonitoringArgs{
Script: pulumi.String("string"),
ServiceUserId: pulumi.String("string"),
},
ComputeInstanceId: pulumi.String("string"),
ConfigDrive: pulumi.Bool(false),
FlavorId: pulumi.String("string"),
FlavorName: pulumi.String("string"),
ForceDelete: pulumi.Bool(false),
ImageId: pulumi.String("string"),
ImageName: pulumi.String("string"),
KeyPair: pulumi.String("string"),
Metadata: pulumi.StringMap{
"string": pulumi.String("string"),
},
Name: pulumi.String("string"),
NetworkMode: pulumi.String("string"),
Networks: vkcs.ComputeInstanceNetworkArray{
&vkcs.ComputeInstanceNetworkArgs{
AccessNetwork: pulumi.Bool(false),
FixedIpV4: pulumi.String("string"),
Mac: pulumi.String("string"),
Name: pulumi.String("string"),
Port: pulumi.String("string"),
Uuid: pulumi.String("string"),
},
},
Personalities: vkcs.ComputeInstancePersonalityArray{
&vkcs.ComputeInstancePersonalityArgs{
Content: pulumi.String("string"),
File: pulumi.String("string"),
},
},
PowerState: pulumi.String("string"),
Region: pulumi.String("string"),
SchedulerHints: vkcs.ComputeInstanceSchedulerHintArray{
&vkcs.ComputeInstanceSchedulerHintArgs{
Group: pulumi.String("string"),
},
},
SecurityGroupIds: pulumi.StringArray{
pulumi.String("string"),
},
StopBeforeDestroy: pulumi.Bool(false),
Tags: pulumi.StringArray{
pulumi.String("string"),
},
Timeouts: &vkcs.ComputeInstanceTimeoutsArgs{
Create: pulumi.String("string"),
Delete: pulumi.String("string"),
Update: pulumi.String("string"),
},
UserData: pulumi.String("string"),
VendorOptions: &vkcs.ComputeInstanceVendorOptionsArgs{
DetachPortsBeforeDestroy: pulumi.Bool(false),
GetPasswordData: pulumi.Bool(false),
IgnoreResizeConfirmation: pulumi.Bool(false),
},
})
var computeInstanceResource = new ComputeInstance("computeInstanceResource", ComputeInstanceArgs.builder()
.accessIpV4("string")
.adminPass("string")
.availabilityZone("string")
.blockDevices(ComputeInstanceBlockDeviceArgs.builder()
.sourceType("string")
.bootIndex(0.0)
.deleteOnTermination(false)
.destinationType("string")
.deviceType("string")
.diskBus("string")
.guestFormat("string")
.uuid("string")
.volumeSize(0.0)
.volumeType("string")
.build())
.cloudMonitoring(ComputeInstanceCloudMonitoringArgs.builder()
.script("string")
.serviceUserId("string")
.build())
.computeInstanceId("string")
.configDrive(false)
.flavorId("string")
.flavorName("string")
.forceDelete(false)
.imageId("string")
.imageName("string")
.keyPair("string")
.metadata(Map.of("string", "string"))
.name("string")
.networkMode("string")
.networks(ComputeInstanceNetworkArgs.builder()
.accessNetwork(false)
.fixedIpV4("string")
.mac("string")
.name("string")
.port("string")
.uuid("string")
.build())
.personalities(ComputeInstancePersonalityArgs.builder()
.content("string")
.file("string")
.build())
.powerState("string")
.region("string")
.schedulerHints(ComputeInstanceSchedulerHintArgs.builder()
.group("string")
.build())
.securityGroupIds("string")
.stopBeforeDestroy(false)
.tags("string")
.timeouts(ComputeInstanceTimeoutsArgs.builder()
.create("string")
.delete("string")
.update("string")
.build())
.userData("string")
.vendorOptions(ComputeInstanceVendorOptionsArgs.builder()
.detachPortsBeforeDestroy(false)
.getPasswordData(false)
.ignoreResizeConfirmation(false)
.build())
.build());
compute_instance_resource = vkcs.ComputeInstance("computeInstanceResource",
access_ip_v4="string",
admin_pass="string",
availability_zone="string",
block_devices=[{
"source_type": "string",
"boot_index": 0,
"delete_on_termination": False,
"destination_type": "string",
"device_type": "string",
"disk_bus": "string",
"guest_format": "string",
"uuid": "string",
"volume_size": 0,
"volume_type": "string",
}],
cloud_monitoring={
"script": "string",
"service_user_id": "string",
},
compute_instance_id="string",
config_drive=False,
flavor_id="string",
flavor_name="string",
force_delete=False,
image_id="string",
image_name="string",
key_pair="string",
metadata={
"string": "string",
},
name="string",
network_mode="string",
networks=[{
"access_network": False,
"fixed_ip_v4": "string",
"mac": "string",
"name": "string",
"port": "string",
"uuid": "string",
}],
personalities=[{
"content": "string",
"file": "string",
}],
power_state="string",
region="string",
scheduler_hints=[{
"group": "string",
}],
security_group_ids=["string"],
stop_before_destroy=False,
tags=["string"],
timeouts={
"create": "string",
"delete": "string",
"update": "string",
},
user_data="string",
vendor_options={
"detach_ports_before_destroy": False,
"get_password_data": False,
"ignore_resize_confirmation": False,
})
const computeInstanceResource = new vkcs.ComputeInstance("computeInstanceResource", {
accessIpV4: "string",
adminPass: "string",
availabilityZone: "string",
blockDevices: [{
sourceType: "string",
bootIndex: 0,
deleteOnTermination: false,
destinationType: "string",
deviceType: "string",
diskBus: "string",
guestFormat: "string",
uuid: "string",
volumeSize: 0,
volumeType: "string",
}],
cloudMonitoring: {
script: "string",
serviceUserId: "string",
},
computeInstanceId: "string",
configDrive: false,
flavorId: "string",
flavorName: "string",
forceDelete: false,
imageId: "string",
imageName: "string",
keyPair: "string",
metadata: {
string: "string",
},
name: "string",
networkMode: "string",
networks: [{
accessNetwork: false,
fixedIpV4: "string",
mac: "string",
name: "string",
port: "string",
uuid: "string",
}],
personalities: [{
content: "string",
file: "string",
}],
powerState: "string",
region: "string",
schedulerHints: [{
group: "string",
}],
securityGroupIds: ["string"],
stopBeforeDestroy: false,
tags: ["string"],
timeouts: {
create: "string",
"delete": "string",
update: "string",
},
userData: "string",
vendorOptions: {
detachPortsBeforeDestroy: false,
getPasswordData: false,
ignoreResizeConfirmation: false,
},
});
type: vkcs:ComputeInstance
properties:
accessIpV4: string
adminPass: string
availabilityZone: string
blockDevices:
- bootIndex: 0
deleteOnTermination: false
destinationType: string
deviceType: string
diskBus: string
guestFormat: string
sourceType: string
uuid: string
volumeSize: 0
volumeType: string
cloudMonitoring:
script: string
serviceUserId: string
computeInstanceId: string
configDrive: false
flavorId: string
flavorName: string
forceDelete: false
imageId: string
imageName: string
keyPair: string
metadata:
string: string
name: string
networkMode: string
networks:
- accessNetwork: false
fixedIpV4: string
mac: string
name: string
port: string
uuid: string
personalities:
- content: string
file: string
powerState: string
region: string
schedulerHints:
- group: string
securityGroupIds:
- string
stopBeforeDestroy: false
tags:
- string
timeouts:
create: string
delete: string
update: string
userData: string
vendorOptions:
detachPortsBeforeDestroy: false
getPasswordData: false
ignoreResizeConfirmation: false
ComputeInstance 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 ComputeInstance resource accepts the following input properties:
- Access
Ip stringV4 - optional string → The first detected Fixed IPv4 address.
- Admin
Pass string - optional sensitive string → The administrative password to assign to the server. This attribute allows you to set or change a password only on an already created server.
- Availability
Zone string - optional string → The availability zone in which to create the server. Conflicts with
availability_zone_hints
. Changing this creates a new server. - Block
Devices List<ComputeInstance Block Device> - optional → Configuration of block devices. The block_device structure is documented below. Changing this creates a new server. You can specify multiple block devices which will create an instance with multiple disks. This configuration is very flexible, so please see the following reference for more information.
- Cloud
Monitoring ComputeInstance Cloud Monitoring - optional → The settings of the cloud monitoring, it is recommended to set this field with the values of
vkcs.CloudMonitoring
resource fields. Changing this creates a new server.New since v0.9.0. - Compute
Instance stringId - string → ID of the resource.
- Config
Drive bool - optional boolean → Whether to use the config_drive feature to configure the instance. Changing this creates a new server.
- Flavor
Id string - optional string → The flavor ID of the desired flavor for the server. Required if
flavor_name
is empty. Changing this resizes the existing server. - Flavor
Name string - optional string → The name of the desired flavor for the server. Required if
flavor_id
is empty. Changing this resizes the existing server. - Force
Delete bool - optional boolean → Whether to force the compute instance to be forcefully deleted. This is useful for environments that have reclaim / soft deletion enabled.
- Image
Id string - optional string → The image ID of the desired image for the server. Required if
image_name
is empty and not booting from a volume. Do not specify if booting from a volume. Changing this creates a new server. - Image
Name string - optional string → The name of the desired image for the server. Required if
image_id
is empty and not booting from a volume. Do not specify if booting from a volume. Changing this creates a new server. - Key
Pair string - optional string → The name of a key pair to put on the server. The key pair must already be created and associated with the tenant's account. Changing this creates a new server.
- Metadata Dictionary<string, string>
- optional map of string → Metadata key/value pairs to make available from within the instance. Changing this updates the existing server metadata.
- Name string
- required string → A unique name for the resource.
- Network
Mode string - optional string → Special string for
network
option to create the server.network_mode
can be"auto"
or"none"
. Please see the following reference for more information. Conflicts withnetwork
. - Networks
List<Compute
Instance Network> - optional → An array of one or more networks to attach to the instance. The network object structure is documented below. Changing this creates a new server.
- Personalities
List<Compute
Instance Personality> - optional → Customize the personality of an instance by defining one or more files and their contents. The personality structure is described below. Note: 'config_drive' must be enabled.
- Power
State string - optional string → Provide the VM state. Only 'active' and 'shutoff' are supported values. Note: If the initial power_state is the shutoff the VM will be stopped immediately after build and the provisioners like remote-exec or files are not supported.
- Region string
- optional string → The region in which to create the server instance. If omitted, the
region
argument of the provider is used. Changing this creates a new server. - Scheduler
Hints List<ComputeInstance Scheduler Hint> - optional → Provide the Nova scheduler with hints on how the instance should be launched. The available hints are described below.
- Security
Group List<string>Ids - optional set of string → An array of one or more security group ids to associate with the server. Changing this results in adding/removing security groups from the existing server. Note: When attaching the instance to networks using Ports, place the security groups on the Port and not the instance.New since v0.7.3.
- Security
Groups List<string> - optional deprecated set of string → An array of one or more security group names to associate with the server. Changing this results in adding/removing security groups from the existing server. Note: When attaching the instance to networks using Ports, place the security groups on the Port and not the instance. Deprecated Configure
security_group_ids
instead. - Stop
Before boolDestroy - optional boolean → Whether to try stop instance gracefully before destroying it, thus giving chance for guest OS daemons to stop correctly. If instance doesn't stop within timeout, it will be destroyed anyway.
- List<string>
- optional set of string → A set of string tags for the instance. Changing this updates the existing instance tags.
- Timeouts
Compute
Instance Timeouts - User
Data string - optional string → The user data to provide when launching the instance. When cloud_monitoring enabled only #!/bin/bash, #cloud-config, #ps1 user_data formats are supported. Changing this creates a new server.
- Vendor
Options ComputeInstance Vendor Options - optional → Map of additional vendor-specific options. Supported options are described below.
- Access
Ip stringV4 - optional string → The first detected Fixed IPv4 address.
- Admin
Pass string - optional sensitive string → The administrative password to assign to the server. This attribute allows you to set or change a password only on an already created server.
- Availability
Zone string - optional string → The availability zone in which to create the server. Conflicts with
availability_zone_hints
. Changing this creates a new server. - Block
Devices []ComputeInstance Block Device Args - optional → Configuration of block devices. The block_device structure is documented below. Changing this creates a new server. You can specify multiple block devices which will create an instance with multiple disks. This configuration is very flexible, so please see the following reference for more information.
- Cloud
Monitoring ComputeInstance Cloud Monitoring Args - optional → The settings of the cloud monitoring, it is recommended to set this field with the values of
vkcs.CloudMonitoring
resource fields. Changing this creates a new server.New since v0.9.0. - Compute
Instance stringId - string → ID of the resource.
- Config
Drive bool - optional boolean → Whether to use the config_drive feature to configure the instance. Changing this creates a new server.
- Flavor
Id string - optional string → The flavor ID of the desired flavor for the server. Required if
flavor_name
is empty. Changing this resizes the existing server. - Flavor
Name string - optional string → The name of the desired flavor for the server. Required if
flavor_id
is empty. Changing this resizes the existing server. - Force
Delete bool - optional boolean → Whether to force the compute instance to be forcefully deleted. This is useful for environments that have reclaim / soft deletion enabled.
- Image
Id string - optional string → The image ID of the desired image for the server. Required if
image_name
is empty and not booting from a volume. Do not specify if booting from a volume. Changing this creates a new server. - Image
Name string - optional string → The name of the desired image for the server. Required if
image_id
is empty and not booting from a volume. Do not specify if booting from a volume. Changing this creates a new server. - Key
Pair string - optional string → The name of a key pair to put on the server. The key pair must already be created and associated with the tenant's account. Changing this creates a new server.
- Metadata map[string]string
- optional map of string → Metadata key/value pairs to make available from within the instance. Changing this updates the existing server metadata.
- Name string
- required string → A unique name for the resource.
- Network
Mode string - optional string → Special string for
network
option to create the server.network_mode
can be"auto"
or"none"
. Please see the following reference for more information. Conflicts withnetwork
. - Networks
[]Compute
Instance Network Args - optional → An array of one or more networks to attach to the instance. The network object structure is documented below. Changing this creates a new server.
- Personalities
[]Compute
Instance Personality Args - optional → Customize the personality of an instance by defining one or more files and their contents. The personality structure is described below. Note: 'config_drive' must be enabled.
- Power
State string - optional string → Provide the VM state. Only 'active' and 'shutoff' are supported values. Note: If the initial power_state is the shutoff the VM will be stopped immediately after build and the provisioners like remote-exec or files are not supported.
- Region string
- optional string → The region in which to create the server instance. If omitted, the
region
argument of the provider is used. Changing this creates a new server. - Scheduler
Hints []ComputeInstance Scheduler Hint Args - optional → Provide the Nova scheduler with hints on how the instance should be launched. The available hints are described below.
- Security
Group []stringIds - optional set of string → An array of one or more security group ids to associate with the server. Changing this results in adding/removing security groups from the existing server. Note: When attaching the instance to networks using Ports, place the security groups on the Port and not the instance.New since v0.7.3.
- Security
Groups []string - optional deprecated set of string → An array of one or more security group names to associate with the server. Changing this results in adding/removing security groups from the existing server. Note: When attaching the instance to networks using Ports, place the security groups on the Port and not the instance. Deprecated Configure
security_group_ids
instead. - Stop
Before boolDestroy - optional boolean → Whether to try stop instance gracefully before destroying it, thus giving chance for guest OS daemons to stop correctly. If instance doesn't stop within timeout, it will be destroyed anyway.
- []string
- optional set of string → A set of string tags for the instance. Changing this updates the existing instance tags.
- Timeouts
Compute
Instance Timeouts Args - User
Data string - optional string → The user data to provide when launching the instance. When cloud_monitoring enabled only #!/bin/bash, #cloud-config, #ps1 user_data formats are supported. Changing this creates a new server.
- Vendor
Options ComputeInstance Vendor Options Args - optional → Map of additional vendor-specific options. Supported options are described below.
- access
Ip StringV4 - optional string → The first detected Fixed IPv4 address.
- admin
Pass String - optional sensitive string → The administrative password to assign to the server. This attribute allows you to set or change a password only on an already created server.
- availability
Zone String - optional string → The availability zone in which to create the server. Conflicts with
availability_zone_hints
. Changing this creates a new server. - block
Devices List<ComputeInstance Block Device> - optional → Configuration of block devices. The block_device structure is documented below. Changing this creates a new server. You can specify multiple block devices which will create an instance with multiple disks. This configuration is very flexible, so please see the following reference for more information.
- cloud
Monitoring ComputeInstance Cloud Monitoring - optional → The settings of the cloud monitoring, it is recommended to set this field with the values of
vkcs.CloudMonitoring
resource fields. Changing this creates a new server.New since v0.9.0. - compute
Instance StringId - string → ID of the resource.
- config
Drive Boolean - optional boolean → Whether to use the config_drive feature to configure the instance. Changing this creates a new server.
- flavor
Id String - optional string → The flavor ID of the desired flavor for the server. Required if
flavor_name
is empty. Changing this resizes the existing server. - flavor
Name String - optional string → The name of the desired flavor for the server. Required if
flavor_id
is empty. Changing this resizes the existing server. - force
Delete Boolean - optional boolean → Whether to force the compute instance to be forcefully deleted. This is useful for environments that have reclaim / soft deletion enabled.
- image
Id String - optional string → The image ID of the desired image for the server. Required if
image_name
is empty and not booting from a volume. Do not specify if booting from a volume. Changing this creates a new server. - image
Name String - optional string → The name of the desired image for the server. Required if
image_id
is empty and not booting from a volume. Do not specify if booting from a volume. Changing this creates a new server. - key
Pair String - optional string → The name of a key pair to put on the server. The key pair must already be created and associated with the tenant's account. Changing this creates a new server.
- metadata Map<String,String>
- optional map of string → Metadata key/value pairs to make available from within the instance. Changing this updates the existing server metadata.
- name String
- required string → A unique name for the resource.
- network
Mode String - optional string → Special string for
network
option to create the server.network_mode
can be"auto"
or"none"
. Please see the following reference for more information. Conflicts withnetwork
. - networks
List<Compute
Instance Network> - optional → An array of one or more networks to attach to the instance. The network object structure is documented below. Changing this creates a new server.
- personalities
List<Compute
Instance Personality> - optional → Customize the personality of an instance by defining one or more files and their contents. The personality structure is described below. Note: 'config_drive' must be enabled.
- power
State String - optional string → Provide the VM state. Only 'active' and 'shutoff' are supported values. Note: If the initial power_state is the shutoff the VM will be stopped immediately after build and the provisioners like remote-exec or files are not supported.
- region String
- optional string → The region in which to create the server instance. If omitted, the
region
argument of the provider is used. Changing this creates a new server. - scheduler
Hints List<ComputeInstance Scheduler Hint> - optional → Provide the Nova scheduler with hints on how the instance should be launched. The available hints are described below.
- security
Group List<String>Ids - optional set of string → An array of one or more security group ids to associate with the server. Changing this results in adding/removing security groups from the existing server. Note: When attaching the instance to networks using Ports, place the security groups on the Port and not the instance.New since v0.7.3.
- security
Groups List<String> - optional deprecated set of string → An array of one or more security group names to associate with the server. Changing this results in adding/removing security groups from the existing server. Note: When attaching the instance to networks using Ports, place the security groups on the Port and not the instance. Deprecated Configure
security_group_ids
instead. - stop
Before BooleanDestroy - optional boolean → Whether to try stop instance gracefully before destroying it, thus giving chance for guest OS daemons to stop correctly. If instance doesn't stop within timeout, it will be destroyed anyway.
- List<String>
- optional set of string → A set of string tags for the instance. Changing this updates the existing instance tags.
- timeouts
Compute
Instance Timeouts - user
Data String - optional string → The user data to provide when launching the instance. When cloud_monitoring enabled only #!/bin/bash, #cloud-config, #ps1 user_data formats are supported. Changing this creates a new server.
- vendor
Options ComputeInstance Vendor Options - optional → Map of additional vendor-specific options. Supported options are described below.
- access
Ip stringV4 - optional string → The first detected Fixed IPv4 address.
- admin
Pass string - optional sensitive string → The administrative password to assign to the server. This attribute allows you to set or change a password only on an already created server.
- availability
Zone string - optional string → The availability zone in which to create the server. Conflicts with
availability_zone_hints
. Changing this creates a new server. - block
Devices ComputeInstance Block Device[] - optional → Configuration of block devices. The block_device structure is documented below. Changing this creates a new server. You can specify multiple block devices which will create an instance with multiple disks. This configuration is very flexible, so please see the following reference for more information.
- cloud
Monitoring ComputeInstance Cloud Monitoring - optional → The settings of the cloud monitoring, it is recommended to set this field with the values of
vkcs.CloudMonitoring
resource fields. Changing this creates a new server.New since v0.9.0. - compute
Instance stringId - string → ID of the resource.
- config
Drive boolean - optional boolean → Whether to use the config_drive feature to configure the instance. Changing this creates a new server.
- flavor
Id string - optional string → The flavor ID of the desired flavor for the server. Required if
flavor_name
is empty. Changing this resizes the existing server. - flavor
Name string - optional string → The name of the desired flavor for the server. Required if
flavor_id
is empty. Changing this resizes the existing server. - force
Delete boolean - optional boolean → Whether to force the compute instance to be forcefully deleted. This is useful for environments that have reclaim / soft deletion enabled.
- image
Id string - optional string → The image ID of the desired image for the server. Required if
image_name
is empty and not booting from a volume. Do not specify if booting from a volume. Changing this creates a new server. - image
Name string - optional string → The name of the desired image for the server. Required if
image_id
is empty and not booting from a volume. Do not specify if booting from a volume. Changing this creates a new server. - key
Pair string - optional string → The name of a key pair to put on the server. The key pair must already be created and associated with the tenant's account. Changing this creates a new server.
- metadata {[key: string]: string}
- optional map of string → Metadata key/value pairs to make available from within the instance. Changing this updates the existing server metadata.
- name string
- required string → A unique name for the resource.
- network
Mode string - optional string → Special string for
network
option to create the server.network_mode
can be"auto"
or"none"
. Please see the following reference for more information. Conflicts withnetwork
. - networks
Compute
Instance Network[] - optional → An array of one or more networks to attach to the instance. The network object structure is documented below. Changing this creates a new server.
- personalities
Compute
Instance Personality[] - optional → Customize the personality of an instance by defining one or more files and their contents. The personality structure is described below. Note: 'config_drive' must be enabled.
- power
State string - optional string → Provide the VM state. Only 'active' and 'shutoff' are supported values. Note: If the initial power_state is the shutoff the VM will be stopped immediately after build and the provisioners like remote-exec or files are not supported.
- region string
- optional string → The region in which to create the server instance. If omitted, the
region
argument of the provider is used. Changing this creates a new server. - scheduler
Hints ComputeInstance Scheduler Hint[] - optional → Provide the Nova scheduler with hints on how the instance should be launched. The available hints are described below.
- security
Group string[]Ids - optional set of string → An array of one or more security group ids to associate with the server. Changing this results in adding/removing security groups from the existing server. Note: When attaching the instance to networks using Ports, place the security groups on the Port and not the instance.New since v0.7.3.
- security
Groups string[] - optional deprecated set of string → An array of one or more security group names to associate with the server. Changing this results in adding/removing security groups from the existing server. Note: When attaching the instance to networks using Ports, place the security groups on the Port and not the instance. Deprecated Configure
security_group_ids
instead. - stop
Before booleanDestroy - optional boolean → Whether to try stop instance gracefully before destroying it, thus giving chance for guest OS daemons to stop correctly. If instance doesn't stop within timeout, it will be destroyed anyway.
- string[]
- optional set of string → A set of string tags for the instance. Changing this updates the existing instance tags.
- timeouts
Compute
Instance Timeouts - user
Data string - optional string → The user data to provide when launching the instance. When cloud_monitoring enabled only #!/bin/bash, #cloud-config, #ps1 user_data formats are supported. Changing this creates a new server.
- vendor
Options ComputeInstance Vendor Options - optional → Map of additional vendor-specific options. Supported options are described below.
- access_
ip_ strv4 - optional string → The first detected Fixed IPv4 address.
- admin_
pass str - optional sensitive string → The administrative password to assign to the server. This attribute allows you to set or change a password only on an already created server.
- availability_
zone str - optional string → The availability zone in which to create the server. Conflicts with
availability_zone_hints
. Changing this creates a new server. - block_
devices Sequence[ComputeInstance Block Device Args] - optional → Configuration of block devices. The block_device structure is documented below. Changing this creates a new server. You can specify multiple block devices which will create an instance with multiple disks. This configuration is very flexible, so please see the following reference for more information.
- cloud_
monitoring ComputeInstance Cloud Monitoring Args - optional → The settings of the cloud monitoring, it is recommended to set this field with the values of
vkcs.CloudMonitoring
resource fields. Changing this creates a new server.New since v0.9.0. - compute_
instance_ strid - string → ID of the resource.
- config_
drive bool - optional boolean → Whether to use the config_drive feature to configure the instance. Changing this creates a new server.
- flavor_
id str - optional string → The flavor ID of the desired flavor for the server. Required if
flavor_name
is empty. Changing this resizes the existing server. - flavor_
name str - optional string → The name of the desired flavor for the server. Required if
flavor_id
is empty. Changing this resizes the existing server. - force_
delete bool - optional boolean → Whether to force the compute instance to be forcefully deleted. This is useful for environments that have reclaim / soft deletion enabled.
- image_
id str - optional string → The image ID of the desired image for the server. Required if
image_name
is empty and not booting from a volume. Do not specify if booting from a volume. Changing this creates a new server. - image_
name str - optional string → The name of the desired image for the server. Required if
image_id
is empty and not booting from a volume. Do not specify if booting from a volume. Changing this creates a new server. - key_
pair str - optional string → The name of a key pair to put on the server. The key pair must already be created and associated with the tenant's account. Changing this creates a new server.
- metadata Mapping[str, str]
- optional map of string → Metadata key/value pairs to make available from within the instance. Changing this updates the existing server metadata.
- name str
- required string → A unique name for the resource.
- network_
mode str - optional string → Special string for
network
option to create the server.network_mode
can be"auto"
or"none"
. Please see the following reference for more information. Conflicts withnetwork
. - networks
Sequence[Compute
Instance Network Args] - optional → An array of one or more networks to attach to the instance. The network object structure is documented below. Changing this creates a new server.
- personalities
Sequence[Compute
Instance Personality Args] - optional → Customize the personality of an instance by defining one or more files and their contents. The personality structure is described below. Note: 'config_drive' must be enabled.
- power_
state str - optional string → Provide the VM state. Only 'active' and 'shutoff' are supported values. Note: If the initial power_state is the shutoff the VM will be stopped immediately after build and the provisioners like remote-exec or files are not supported.
- region str
- optional string → The region in which to create the server instance. If omitted, the
region
argument of the provider is used. Changing this creates a new server. - scheduler_
hints Sequence[ComputeInstance Scheduler Hint Args] - optional → Provide the Nova scheduler with hints on how the instance should be launched. The available hints are described below.
- security_
group_ Sequence[str]ids - optional set of string → An array of one or more security group ids to associate with the server. Changing this results in adding/removing security groups from the existing server. Note: When attaching the instance to networks using Ports, place the security groups on the Port and not the instance.New since v0.7.3.
- security_
groups Sequence[str] - optional deprecated set of string → An array of one or more security group names to associate with the server. Changing this results in adding/removing security groups from the existing server. Note: When attaching the instance to networks using Ports, place the security groups on the Port and not the instance. Deprecated Configure
security_group_ids
instead. - stop_
before_ booldestroy - optional boolean → Whether to try stop instance gracefully before destroying it, thus giving chance for guest OS daemons to stop correctly. If instance doesn't stop within timeout, it will be destroyed anyway.
- Sequence[str]
- optional set of string → A set of string tags for the instance. Changing this updates the existing instance tags.
- timeouts
Compute
Instance Timeouts Args - user_
data str - optional string → The user data to provide when launching the instance. When cloud_monitoring enabled only #!/bin/bash, #cloud-config, #ps1 user_data formats are supported. Changing this creates a new server.
- vendor_
options ComputeInstance Vendor Options Args - optional → Map of additional vendor-specific options. Supported options are described below.
- access
Ip StringV4 - optional string → The first detected Fixed IPv4 address.
- admin
Pass String - optional sensitive string → The administrative password to assign to the server. This attribute allows you to set or change a password only on an already created server.
- availability
Zone String - optional string → The availability zone in which to create the server. Conflicts with
availability_zone_hints
. Changing this creates a new server. - block
Devices List<Property Map> - optional → Configuration of block devices. The block_device structure is documented below. Changing this creates a new server. You can specify multiple block devices which will create an instance with multiple disks. This configuration is very flexible, so please see the following reference for more information.
- cloud
Monitoring Property Map - optional → The settings of the cloud monitoring, it is recommended to set this field with the values of
vkcs.CloudMonitoring
resource fields. Changing this creates a new server.New since v0.9.0. - compute
Instance StringId - string → ID of the resource.
- config
Drive Boolean - optional boolean → Whether to use the config_drive feature to configure the instance. Changing this creates a new server.
- flavor
Id String - optional string → The flavor ID of the desired flavor for the server. Required if
flavor_name
is empty. Changing this resizes the existing server. - flavor
Name String - optional string → The name of the desired flavor for the server. Required if
flavor_id
is empty. Changing this resizes the existing server. - force
Delete Boolean - optional boolean → Whether to force the compute instance to be forcefully deleted. This is useful for environments that have reclaim / soft deletion enabled.
- image
Id String - optional string → The image ID of the desired image for the server. Required if
image_name
is empty and not booting from a volume. Do not specify if booting from a volume. Changing this creates a new server. - image
Name String - optional string → The name of the desired image for the server. Required if
image_id
is empty and not booting from a volume. Do not specify if booting from a volume. Changing this creates a new server. - key
Pair String - optional string → The name of a key pair to put on the server. The key pair must already be created and associated with the tenant's account. Changing this creates a new server.
- metadata Map<String>
- optional map of string → Metadata key/value pairs to make available from within the instance. Changing this updates the existing server metadata.
- name String
- required string → A unique name for the resource.
- network
Mode String - optional string → Special string for
network
option to create the server.network_mode
can be"auto"
or"none"
. Please see the following reference for more information. Conflicts withnetwork
. - networks List<Property Map>
- optional → An array of one or more networks to attach to the instance. The network object structure is documented below. Changing this creates a new server.
- personalities List<Property Map>
- optional → Customize the personality of an instance by defining one or more files and their contents. The personality structure is described below. Note: 'config_drive' must be enabled.
- power
State String - optional string → Provide the VM state. Only 'active' and 'shutoff' are supported values. Note: If the initial power_state is the shutoff the VM will be stopped immediately after build and the provisioners like remote-exec or files are not supported.
- region String
- optional string → The region in which to create the server instance. If omitted, the
region
argument of the provider is used. Changing this creates a new server. - scheduler
Hints List<Property Map> - optional → Provide the Nova scheduler with hints on how the instance should be launched. The available hints are described below.
- security
Group List<String>Ids - optional set of string → An array of one or more security group ids to associate with the server. Changing this results in adding/removing security groups from the existing server. Note: When attaching the instance to networks using Ports, place the security groups on the Port and not the instance.New since v0.7.3.
- security
Groups List<String> - optional deprecated set of string → An array of one or more security group names to associate with the server. Changing this results in adding/removing security groups from the existing server. Note: When attaching the instance to networks using Ports, place the security groups on the Port and not the instance. Deprecated Configure
security_group_ids
instead. - stop
Before BooleanDestroy - optional boolean → Whether to try stop instance gracefully before destroying it, thus giving chance for guest OS daemons to stop correctly. If instance doesn't stop within timeout, it will be destroyed anyway.
- List<String>
- optional set of string → A set of string tags for the instance. Changing this updates the existing instance tags.
- timeouts Property Map
- user
Data String - optional string → The user data to provide when launching the instance. When cloud_monitoring enabled only #!/bin/bash, #cloud-config, #ps1 user_data formats are supported. Changing this creates a new server.
- vendor
Options Property Map - optional → Map of additional vendor-specific options. Supported options are described below.
Outputs
All input properties are implicitly available as output properties. Additionally, the ComputeInstance resource produces the following output properties:
- All
Metadata Dictionary<string, string> - List<string>
- set of string → The collection of tags assigned on the instance, which have been explicitly and implicitly added.
- Id string
- The provider-assigned unique ID for this managed resource.
- Password
Data string - string → Base-64 encoded encrypted password data for the instance. Use this attribute only for instances running Microsoft Windows. This attribute is only exported if
get_password_data
is true. If you change the password after creating the instance, these changes will not be visible in this field.New since v0.9.3.
- All
Metadata map[string]string - []string
- set of string → The collection of tags assigned on the instance, which have been explicitly and implicitly added.
- Id string
- The provider-assigned unique ID for this managed resource.
- Password
Data string - string → Base-64 encoded encrypted password data for the instance. Use this attribute only for instances running Microsoft Windows. This attribute is only exported if
get_password_data
is true. If you change the password after creating the instance, these changes will not be visible in this field.New since v0.9.3.
- all
Metadata Map<String,String> - List<String>
- set of string → The collection of tags assigned on the instance, which have been explicitly and implicitly added.
- id String
- The provider-assigned unique ID for this managed resource.
- password
Data String - string → Base-64 encoded encrypted password data for the instance. Use this attribute only for instances running Microsoft Windows. This attribute is only exported if
get_password_data
is true. If you change the password after creating the instance, these changes will not be visible in this field.New since v0.9.3.
- all
Metadata {[key: string]: string} - string[]
- set of string → The collection of tags assigned on the instance, which have been explicitly and implicitly added.
- id string
- The provider-assigned unique ID for this managed resource.
- password
Data string - string → Base-64 encoded encrypted password data for the instance. Use this attribute only for instances running Microsoft Windows. This attribute is only exported if
get_password_data
is true. If you change the password after creating the instance, these changes will not be visible in this field.New since v0.9.3.
- all_
metadata Mapping[str, str] - Sequence[str]
- set of string → The collection of tags assigned on the instance, which have been explicitly and implicitly added.
- id str
- The provider-assigned unique ID for this managed resource.
- password_
data str - string → Base-64 encoded encrypted password data for the instance. Use this attribute only for instances running Microsoft Windows. This attribute is only exported if
get_password_data
is true. If you change the password after creating the instance, these changes will not be visible in this field.New since v0.9.3.
- all
Metadata Map<String> - List<String>
- set of string → The collection of tags assigned on the instance, which have been explicitly and implicitly added.
- id String
- The provider-assigned unique ID for this managed resource.
- password
Data String - string → Base-64 encoded encrypted password data for the instance. Use this attribute only for instances running Microsoft Windows. This attribute is only exported if
get_password_data
is true. If you change the password after creating the instance, these changes will not be visible in this field.New since v0.9.3.
Look up Existing ComputeInstance Resource
Get an existing ComputeInstance 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?: ComputeInstanceState, opts?: CustomResourceOptions): ComputeInstance
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
access_ip_v4: Optional[str] = None,
admin_pass: Optional[str] = None,
all_metadata: Optional[Mapping[str, str]] = None,
all_tags: Optional[Sequence[str]] = None,
availability_zone: Optional[str] = None,
block_devices: Optional[Sequence[ComputeInstanceBlockDeviceArgs]] = None,
cloud_monitoring: Optional[ComputeInstanceCloudMonitoringArgs] = None,
compute_instance_id: Optional[str] = None,
config_drive: Optional[bool] = None,
flavor_id: Optional[str] = None,
flavor_name: Optional[str] = None,
force_delete: Optional[bool] = None,
image_id: Optional[str] = None,
image_name: Optional[str] = None,
key_pair: Optional[str] = None,
metadata: Optional[Mapping[str, str]] = None,
name: Optional[str] = None,
network_mode: Optional[str] = None,
networks: Optional[Sequence[ComputeInstanceNetworkArgs]] = None,
password_data: Optional[str] = None,
personalities: Optional[Sequence[ComputeInstancePersonalityArgs]] = None,
power_state: Optional[str] = None,
region: Optional[str] = None,
scheduler_hints: Optional[Sequence[ComputeInstanceSchedulerHintArgs]] = None,
security_group_ids: Optional[Sequence[str]] = None,
security_groups: Optional[Sequence[str]] = None,
stop_before_destroy: Optional[bool] = None,
tags: Optional[Sequence[str]] = None,
timeouts: Optional[ComputeInstanceTimeoutsArgs] = None,
user_data: Optional[str] = None,
vendor_options: Optional[ComputeInstanceVendorOptionsArgs] = None) -> ComputeInstance
func GetComputeInstance(ctx *Context, name string, id IDInput, state *ComputeInstanceState, opts ...ResourceOption) (*ComputeInstance, error)
public static ComputeInstance Get(string name, Input<string> id, ComputeInstanceState? state, CustomResourceOptions? opts = null)
public static ComputeInstance get(String name, Output<String> id, ComputeInstanceState state, CustomResourceOptions options)
resources: _: type: vkcs:ComputeInstance 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.
- Access
Ip stringV4 - optional string → The first detected Fixed IPv4 address.
- Admin
Pass string - optional sensitive string → The administrative password to assign to the server. This attribute allows you to set or change a password only on an already created server.
- All
Metadata Dictionary<string, string> - List<string>
- set of string → The collection of tags assigned on the instance, which have been explicitly and implicitly added.
- Availability
Zone string - optional string → The availability zone in which to create the server. Conflicts with
availability_zone_hints
. Changing this creates a new server. - Block
Devices List<ComputeInstance Block Device> - optional → Configuration of block devices. The block_device structure is documented below. Changing this creates a new server. You can specify multiple block devices which will create an instance with multiple disks. This configuration is very flexible, so please see the following reference for more information.
- Cloud
Monitoring ComputeInstance Cloud Monitoring - optional → The settings of the cloud monitoring, it is recommended to set this field with the values of
vkcs.CloudMonitoring
resource fields. Changing this creates a new server.New since v0.9.0. - Compute
Instance stringId - string → ID of the resource.
- Config
Drive bool - optional boolean → Whether to use the config_drive feature to configure the instance. Changing this creates a new server.
- Flavor
Id string - optional string → The flavor ID of the desired flavor for the server. Required if
flavor_name
is empty. Changing this resizes the existing server. - Flavor
Name string - optional string → The name of the desired flavor for the server. Required if
flavor_id
is empty. Changing this resizes the existing server. - Force
Delete bool - optional boolean → Whether to force the compute instance to be forcefully deleted. This is useful for environments that have reclaim / soft deletion enabled.
- Image
Id string - optional string → The image ID of the desired image for the server. Required if
image_name
is empty and not booting from a volume. Do not specify if booting from a volume. Changing this creates a new server. - Image
Name string - optional string → The name of the desired image for the server. Required if
image_id
is empty and not booting from a volume. Do not specify if booting from a volume. Changing this creates a new server. - Key
Pair string - optional string → The name of a key pair to put on the server. The key pair must already be created and associated with the tenant's account. Changing this creates a new server.
- Metadata Dictionary<string, string>
- optional map of string → Metadata key/value pairs to make available from within the instance. Changing this updates the existing server metadata.
- Name string
- required string → A unique name for the resource.
- Network
Mode string - optional string → Special string for
network
option to create the server.network_mode
can be"auto"
or"none"
. Please see the following reference for more information. Conflicts withnetwork
. - Networks
List<Compute
Instance Network> - optional → An array of one or more networks to attach to the instance. The network object structure is documented below. Changing this creates a new server.
- Password
Data string - string → Base-64 encoded encrypted password data for the instance. Use this attribute only for instances running Microsoft Windows. This attribute is only exported if
get_password_data
is true. If you change the password after creating the instance, these changes will not be visible in this field.New since v0.9.3. - Personalities
List<Compute
Instance Personality> - optional → Customize the personality of an instance by defining one or more files and their contents. The personality structure is described below. Note: 'config_drive' must be enabled.
- Power
State string - optional string → Provide the VM state. Only 'active' and 'shutoff' are supported values. Note: If the initial power_state is the shutoff the VM will be stopped immediately after build and the provisioners like remote-exec or files are not supported.
- Region string
- optional string → The region in which to create the server instance. If omitted, the
region
argument of the provider is used. Changing this creates a new server. - Scheduler
Hints List<ComputeInstance Scheduler Hint> - optional → Provide the Nova scheduler with hints on how the instance should be launched. The available hints are described below.
- Security
Group List<string>Ids - optional set of string → An array of one or more security group ids to associate with the server. Changing this results in adding/removing security groups from the existing server. Note: When attaching the instance to networks using Ports, place the security groups on the Port and not the instance.New since v0.7.3.
- Security
Groups List<string> - optional deprecated set of string → An array of one or more security group names to associate with the server. Changing this results in adding/removing security groups from the existing server. Note: When attaching the instance to networks using Ports, place the security groups on the Port and not the instance. Deprecated Configure
security_group_ids
instead. - Stop
Before boolDestroy - optional boolean → Whether to try stop instance gracefully before destroying it, thus giving chance for guest OS daemons to stop correctly. If instance doesn't stop within timeout, it will be destroyed anyway.
- List<string>
- optional set of string → A set of string tags for the instance. Changing this updates the existing instance tags.
- Timeouts
Compute
Instance Timeouts - User
Data string - optional string → The user data to provide when launching the instance. When cloud_monitoring enabled only #!/bin/bash, #cloud-config, #ps1 user_data formats are supported. Changing this creates a new server.
- Vendor
Options ComputeInstance Vendor Options - optional → Map of additional vendor-specific options. Supported options are described below.
- Access
Ip stringV4 - optional string → The first detected Fixed IPv4 address.
- Admin
Pass string - optional sensitive string → The administrative password to assign to the server. This attribute allows you to set or change a password only on an already created server.
- All
Metadata map[string]string - []string
- set of string → The collection of tags assigned on the instance, which have been explicitly and implicitly added.
- Availability
Zone string - optional string → The availability zone in which to create the server. Conflicts with
availability_zone_hints
. Changing this creates a new server. - Block
Devices []ComputeInstance Block Device Args - optional → Configuration of block devices. The block_device structure is documented below. Changing this creates a new server. You can specify multiple block devices which will create an instance with multiple disks. This configuration is very flexible, so please see the following reference for more information.
- Cloud
Monitoring ComputeInstance Cloud Monitoring Args - optional → The settings of the cloud monitoring, it is recommended to set this field with the values of
vkcs.CloudMonitoring
resource fields. Changing this creates a new server.New since v0.9.0. - Compute
Instance stringId - string → ID of the resource.
- Config
Drive bool - optional boolean → Whether to use the config_drive feature to configure the instance. Changing this creates a new server.
- Flavor
Id string - optional string → The flavor ID of the desired flavor for the server. Required if
flavor_name
is empty. Changing this resizes the existing server. - Flavor
Name string - optional string → The name of the desired flavor for the server. Required if
flavor_id
is empty. Changing this resizes the existing server. - Force
Delete bool - optional boolean → Whether to force the compute instance to be forcefully deleted. This is useful for environments that have reclaim / soft deletion enabled.
- Image
Id string - optional string → The image ID of the desired image for the server. Required if
image_name
is empty and not booting from a volume. Do not specify if booting from a volume. Changing this creates a new server. - Image
Name string - optional string → The name of the desired image for the server. Required if
image_id
is empty and not booting from a volume. Do not specify if booting from a volume. Changing this creates a new server. - Key
Pair string - optional string → The name of a key pair to put on the server. The key pair must already be created and associated with the tenant's account. Changing this creates a new server.
- Metadata map[string]string
- optional map of string → Metadata key/value pairs to make available from within the instance. Changing this updates the existing server metadata.
- Name string
- required string → A unique name for the resource.
- Network
Mode string - optional string → Special string for
network
option to create the server.network_mode
can be"auto"
or"none"
. Please see the following reference for more information. Conflicts withnetwork
. - Networks
[]Compute
Instance Network Args - optional → An array of one or more networks to attach to the instance. The network object structure is documented below. Changing this creates a new server.
- Password
Data string - string → Base-64 encoded encrypted password data for the instance. Use this attribute only for instances running Microsoft Windows. This attribute is only exported if
get_password_data
is true. If you change the password after creating the instance, these changes will not be visible in this field.New since v0.9.3. - Personalities
[]Compute
Instance Personality Args - optional → Customize the personality of an instance by defining one or more files and their contents. The personality structure is described below. Note: 'config_drive' must be enabled.
- Power
State string - optional string → Provide the VM state. Only 'active' and 'shutoff' are supported values. Note: If the initial power_state is the shutoff the VM will be stopped immediately after build and the provisioners like remote-exec or files are not supported.
- Region string
- optional string → The region in which to create the server instance. If omitted, the
region
argument of the provider is used. Changing this creates a new server. - Scheduler
Hints []ComputeInstance Scheduler Hint Args - optional → Provide the Nova scheduler with hints on how the instance should be launched. The available hints are described below.
- Security
Group []stringIds - optional set of string → An array of one or more security group ids to associate with the server. Changing this results in adding/removing security groups from the existing server. Note: When attaching the instance to networks using Ports, place the security groups on the Port and not the instance.New since v0.7.3.
- Security
Groups []string - optional deprecated set of string → An array of one or more security group names to associate with the server. Changing this results in adding/removing security groups from the existing server. Note: When attaching the instance to networks using Ports, place the security groups on the Port and not the instance. Deprecated Configure
security_group_ids
instead. - Stop
Before boolDestroy - optional boolean → Whether to try stop instance gracefully before destroying it, thus giving chance for guest OS daemons to stop correctly. If instance doesn't stop within timeout, it will be destroyed anyway.
- []string
- optional set of string → A set of string tags for the instance. Changing this updates the existing instance tags.
- Timeouts
Compute
Instance Timeouts Args - User
Data string - optional string → The user data to provide when launching the instance. When cloud_monitoring enabled only #!/bin/bash, #cloud-config, #ps1 user_data formats are supported. Changing this creates a new server.
- Vendor
Options ComputeInstance Vendor Options Args - optional → Map of additional vendor-specific options. Supported options are described below.
- access
Ip StringV4 - optional string → The first detected Fixed IPv4 address.
- admin
Pass String - optional sensitive string → The administrative password to assign to the server. This attribute allows you to set or change a password only on an already created server.
- all
Metadata Map<String,String> - List<String>
- set of string → The collection of tags assigned on the instance, which have been explicitly and implicitly added.
- availability
Zone String - optional string → The availability zone in which to create the server. Conflicts with
availability_zone_hints
. Changing this creates a new server. - block
Devices List<ComputeInstance Block Device> - optional → Configuration of block devices. The block_device structure is documented below. Changing this creates a new server. You can specify multiple block devices which will create an instance with multiple disks. This configuration is very flexible, so please see the following reference for more information.
- cloud
Monitoring ComputeInstance Cloud Monitoring - optional → The settings of the cloud monitoring, it is recommended to set this field with the values of
vkcs.CloudMonitoring
resource fields. Changing this creates a new server.New since v0.9.0. - compute
Instance StringId - string → ID of the resource.
- config
Drive Boolean - optional boolean → Whether to use the config_drive feature to configure the instance. Changing this creates a new server.
- flavor
Id String - optional string → The flavor ID of the desired flavor for the server. Required if
flavor_name
is empty. Changing this resizes the existing server. - flavor
Name String - optional string → The name of the desired flavor for the server. Required if
flavor_id
is empty. Changing this resizes the existing server. - force
Delete Boolean - optional boolean → Whether to force the compute instance to be forcefully deleted. This is useful for environments that have reclaim / soft deletion enabled.
- image
Id String - optional string → The image ID of the desired image for the server. Required if
image_name
is empty and not booting from a volume. Do not specify if booting from a volume. Changing this creates a new server. - image
Name String - optional string → The name of the desired image for the server. Required if
image_id
is empty and not booting from a volume. Do not specify if booting from a volume. Changing this creates a new server. - key
Pair String - optional string → The name of a key pair to put on the server. The key pair must already be created and associated with the tenant's account. Changing this creates a new server.
- metadata Map<String,String>
- optional map of string → Metadata key/value pairs to make available from within the instance. Changing this updates the existing server metadata.
- name String
- required string → A unique name for the resource.
- network
Mode String - optional string → Special string for
network
option to create the server.network_mode
can be"auto"
or"none"
. Please see the following reference for more information. Conflicts withnetwork
. - networks
List<Compute
Instance Network> - optional → An array of one or more networks to attach to the instance. The network object structure is documented below. Changing this creates a new server.
- password
Data String - string → Base-64 encoded encrypted password data for the instance. Use this attribute only for instances running Microsoft Windows. This attribute is only exported if
get_password_data
is true. If you change the password after creating the instance, these changes will not be visible in this field.New since v0.9.3. - personalities
List<Compute
Instance Personality> - optional → Customize the personality of an instance by defining one or more files and their contents. The personality structure is described below. Note: 'config_drive' must be enabled.
- power
State String - optional string → Provide the VM state. Only 'active' and 'shutoff' are supported values. Note: If the initial power_state is the shutoff the VM will be stopped immediately after build and the provisioners like remote-exec or files are not supported.
- region String
- optional string → The region in which to create the server instance. If omitted, the
region
argument of the provider is used. Changing this creates a new server. - scheduler
Hints List<ComputeInstance Scheduler Hint> - optional → Provide the Nova scheduler with hints on how the instance should be launched. The available hints are described below.
- security
Group List<String>Ids - optional set of string → An array of one or more security group ids to associate with the server. Changing this results in adding/removing security groups from the existing server. Note: When attaching the instance to networks using Ports, place the security groups on the Port and not the instance.New since v0.7.3.
- security
Groups List<String> - optional deprecated set of string → An array of one or more security group names to associate with the server. Changing this results in adding/removing security groups from the existing server. Note: When attaching the instance to networks using Ports, place the security groups on the Port and not the instance. Deprecated Configure
security_group_ids
instead. - stop
Before BooleanDestroy - optional boolean → Whether to try stop instance gracefully before destroying it, thus giving chance for guest OS daemons to stop correctly. If instance doesn't stop within timeout, it will be destroyed anyway.
- List<String>
- optional set of string → A set of string tags for the instance. Changing this updates the existing instance tags.
- timeouts
Compute
Instance Timeouts - user
Data String - optional string → The user data to provide when launching the instance. When cloud_monitoring enabled only #!/bin/bash, #cloud-config, #ps1 user_data formats are supported. Changing this creates a new server.
- vendor
Options ComputeInstance Vendor Options - optional → Map of additional vendor-specific options. Supported options are described below.
- access
Ip stringV4 - optional string → The first detected Fixed IPv4 address.
- admin
Pass string - optional sensitive string → The administrative password to assign to the server. This attribute allows you to set or change a password only on an already created server.
- all
Metadata {[key: string]: string} - string[]
- set of string → The collection of tags assigned on the instance, which have been explicitly and implicitly added.
- availability
Zone string - optional string → The availability zone in which to create the server. Conflicts with
availability_zone_hints
. Changing this creates a new server. - block
Devices ComputeInstance Block Device[] - optional → Configuration of block devices. The block_device structure is documented below. Changing this creates a new server. You can specify multiple block devices which will create an instance with multiple disks. This configuration is very flexible, so please see the following reference for more information.
- cloud
Monitoring ComputeInstance Cloud Monitoring - optional → The settings of the cloud monitoring, it is recommended to set this field with the values of
vkcs.CloudMonitoring
resource fields. Changing this creates a new server.New since v0.9.0. - compute
Instance stringId - string → ID of the resource.
- config
Drive boolean - optional boolean → Whether to use the config_drive feature to configure the instance. Changing this creates a new server.
- flavor
Id string - optional string → The flavor ID of the desired flavor for the server. Required if
flavor_name
is empty. Changing this resizes the existing server. - flavor
Name string - optional string → The name of the desired flavor for the server. Required if
flavor_id
is empty. Changing this resizes the existing server. - force
Delete boolean - optional boolean → Whether to force the compute instance to be forcefully deleted. This is useful for environments that have reclaim / soft deletion enabled.
- image
Id string - optional string → The image ID of the desired image for the server. Required if
image_name
is empty and not booting from a volume. Do not specify if booting from a volume. Changing this creates a new server. - image
Name string - optional string → The name of the desired image for the server. Required if
image_id
is empty and not booting from a volume. Do not specify if booting from a volume. Changing this creates a new server. - key
Pair string - optional string → The name of a key pair to put on the server. The key pair must already be created and associated with the tenant's account. Changing this creates a new server.
- metadata {[key: string]: string}
- optional map of string → Metadata key/value pairs to make available from within the instance. Changing this updates the existing server metadata.
- name string
- required string → A unique name for the resource.
- network
Mode string - optional string → Special string for
network
option to create the server.network_mode
can be"auto"
or"none"
. Please see the following reference for more information. Conflicts withnetwork
. - networks
Compute
Instance Network[] - optional → An array of one or more networks to attach to the instance. The network object structure is documented below. Changing this creates a new server.
- password
Data string - string → Base-64 encoded encrypted password data for the instance. Use this attribute only for instances running Microsoft Windows. This attribute is only exported if
get_password_data
is true. If you change the password after creating the instance, these changes will not be visible in this field.New since v0.9.3. - personalities
Compute
Instance Personality[] - optional → Customize the personality of an instance by defining one or more files and their contents. The personality structure is described below. Note: 'config_drive' must be enabled.
- power
State string - optional string → Provide the VM state. Only 'active' and 'shutoff' are supported values. Note: If the initial power_state is the shutoff the VM will be stopped immediately after build and the provisioners like remote-exec or files are not supported.
- region string
- optional string → The region in which to create the server instance. If omitted, the
region
argument of the provider is used. Changing this creates a new server. - scheduler
Hints ComputeInstance Scheduler Hint[] - optional → Provide the Nova scheduler with hints on how the instance should be launched. The available hints are described below.
- security
Group string[]Ids - optional set of string → An array of one or more security group ids to associate with the server. Changing this results in adding/removing security groups from the existing server. Note: When attaching the instance to networks using Ports, place the security groups on the Port and not the instance.New since v0.7.3.
- security
Groups string[] - optional deprecated set of string → An array of one or more security group names to associate with the server. Changing this results in adding/removing security groups from the existing server. Note: When attaching the instance to networks using Ports, place the security groups on the Port and not the instance. Deprecated Configure
security_group_ids
instead. - stop
Before booleanDestroy - optional boolean → Whether to try stop instance gracefully before destroying it, thus giving chance for guest OS daemons to stop correctly. If instance doesn't stop within timeout, it will be destroyed anyway.
- string[]
- optional set of string → A set of string tags for the instance. Changing this updates the existing instance tags.
- timeouts
Compute
Instance Timeouts - user
Data string - optional string → The user data to provide when launching the instance. When cloud_monitoring enabled only #!/bin/bash, #cloud-config, #ps1 user_data formats are supported. Changing this creates a new server.
- vendor
Options ComputeInstance Vendor Options - optional → Map of additional vendor-specific options. Supported options are described below.
- access_
ip_ strv4 - optional string → The first detected Fixed IPv4 address.
- admin_
pass str - optional sensitive string → The administrative password to assign to the server. This attribute allows you to set or change a password only on an already created server.
- all_
metadata Mapping[str, str] - Sequence[str]
- set of string → The collection of tags assigned on the instance, which have been explicitly and implicitly added.
- availability_
zone str - optional string → The availability zone in which to create the server. Conflicts with
availability_zone_hints
. Changing this creates a new server. - block_
devices Sequence[ComputeInstance Block Device Args] - optional → Configuration of block devices. The block_device structure is documented below. Changing this creates a new server. You can specify multiple block devices which will create an instance with multiple disks. This configuration is very flexible, so please see the following reference for more information.
- cloud_
monitoring ComputeInstance Cloud Monitoring Args - optional → The settings of the cloud monitoring, it is recommended to set this field with the values of
vkcs.CloudMonitoring
resource fields. Changing this creates a new server.New since v0.9.0. - compute_
instance_ strid - string → ID of the resource.
- config_
drive bool - optional boolean → Whether to use the config_drive feature to configure the instance. Changing this creates a new server.
- flavor_
id str - optional string → The flavor ID of the desired flavor for the server. Required if
flavor_name
is empty. Changing this resizes the existing server. - flavor_
name str - optional string → The name of the desired flavor for the server. Required if
flavor_id
is empty. Changing this resizes the existing server. - force_
delete bool - optional boolean → Whether to force the compute instance to be forcefully deleted. This is useful for environments that have reclaim / soft deletion enabled.
- image_
id str - optional string → The image ID of the desired image for the server. Required if
image_name
is empty and not booting from a volume. Do not specify if booting from a volume. Changing this creates a new server. - image_
name str - optional string → The name of the desired image for the server. Required if
image_id
is empty and not booting from a volume. Do not specify if booting from a volume. Changing this creates a new server. - key_
pair str - optional string → The name of a key pair to put on the server. The key pair must already be created and associated with the tenant's account. Changing this creates a new server.
- metadata Mapping[str, str]
- optional map of string → Metadata key/value pairs to make available from within the instance. Changing this updates the existing server metadata.
- name str
- required string → A unique name for the resource.
- network_
mode str - optional string → Special string for
network
option to create the server.network_mode
can be"auto"
or"none"
. Please see the following reference for more information. Conflicts withnetwork
. - networks
Sequence[Compute
Instance Network Args] - optional → An array of one or more networks to attach to the instance. The network object structure is documented below. Changing this creates a new server.
- password_
data str - string → Base-64 encoded encrypted password data for the instance. Use this attribute only for instances running Microsoft Windows. This attribute is only exported if
get_password_data
is true. If you change the password after creating the instance, these changes will not be visible in this field.New since v0.9.3. - personalities
Sequence[Compute
Instance Personality Args] - optional → Customize the personality of an instance by defining one or more files and their contents. The personality structure is described below. Note: 'config_drive' must be enabled.
- power_
state str - optional string → Provide the VM state. Only 'active' and 'shutoff' are supported values. Note: If the initial power_state is the shutoff the VM will be stopped immediately after build and the provisioners like remote-exec or files are not supported.
- region str
- optional string → The region in which to create the server instance. If omitted, the
region
argument of the provider is used. Changing this creates a new server. - scheduler_
hints Sequence[ComputeInstance Scheduler Hint Args] - optional → Provide the Nova scheduler with hints on how the instance should be launched. The available hints are described below.
- security_
group_ Sequence[str]ids - optional set of string → An array of one or more security group ids to associate with the server. Changing this results in adding/removing security groups from the existing server. Note: When attaching the instance to networks using Ports, place the security groups on the Port and not the instance.New since v0.7.3.
- security_
groups Sequence[str] - optional deprecated set of string → An array of one or more security group names to associate with the server. Changing this results in adding/removing security groups from the existing server. Note: When attaching the instance to networks using Ports, place the security groups on the Port and not the instance. Deprecated Configure
security_group_ids
instead. - stop_
before_ booldestroy - optional boolean → Whether to try stop instance gracefully before destroying it, thus giving chance for guest OS daemons to stop correctly. If instance doesn't stop within timeout, it will be destroyed anyway.
- Sequence[str]
- optional set of string → A set of string tags for the instance. Changing this updates the existing instance tags.
- timeouts
Compute
Instance Timeouts Args - user_
data str - optional string → The user data to provide when launching the instance. When cloud_monitoring enabled only #!/bin/bash, #cloud-config, #ps1 user_data formats are supported. Changing this creates a new server.
- vendor_
options ComputeInstance Vendor Options Args - optional → Map of additional vendor-specific options. Supported options are described below.
- access
Ip StringV4 - optional string → The first detected Fixed IPv4 address.
- admin
Pass String - optional sensitive string → The administrative password to assign to the server. This attribute allows you to set or change a password only on an already created server.
- all
Metadata Map<String> - List<String>
- set of string → The collection of tags assigned on the instance, which have been explicitly and implicitly added.
- availability
Zone String - optional string → The availability zone in which to create the server. Conflicts with
availability_zone_hints
. Changing this creates a new server. - block
Devices List<Property Map> - optional → Configuration of block devices. The block_device structure is documented below. Changing this creates a new server. You can specify multiple block devices which will create an instance with multiple disks. This configuration is very flexible, so please see the following reference for more information.
- cloud
Monitoring Property Map - optional → The settings of the cloud monitoring, it is recommended to set this field with the values of
vkcs.CloudMonitoring
resource fields. Changing this creates a new server.New since v0.9.0. - compute
Instance StringId - string → ID of the resource.
- config
Drive Boolean - optional boolean → Whether to use the config_drive feature to configure the instance. Changing this creates a new server.
- flavor
Id String - optional string → The flavor ID of the desired flavor for the server. Required if
flavor_name
is empty. Changing this resizes the existing server. - flavor
Name String - optional string → The name of the desired flavor for the server. Required if
flavor_id
is empty. Changing this resizes the existing server. - force
Delete Boolean - optional boolean → Whether to force the compute instance to be forcefully deleted. This is useful for environments that have reclaim / soft deletion enabled.
- image
Id String - optional string → The image ID of the desired image for the server. Required if
image_name
is empty and not booting from a volume. Do not specify if booting from a volume. Changing this creates a new server. - image
Name String - optional string → The name of the desired image for the server. Required if
image_id
is empty and not booting from a volume. Do not specify if booting from a volume. Changing this creates a new server. - key
Pair String - optional string → The name of a key pair to put on the server. The key pair must already be created and associated with the tenant's account. Changing this creates a new server.
- metadata Map<String>
- optional map of string → Metadata key/value pairs to make available from within the instance. Changing this updates the existing server metadata.
- name String
- required string → A unique name for the resource.
- network
Mode String - optional string → Special string for
network
option to create the server.network_mode
can be"auto"
or"none"
. Please see the following reference for more information. Conflicts withnetwork
. - networks List<Property Map>
- optional → An array of one or more networks to attach to the instance. The network object structure is documented below. Changing this creates a new server.
- password
Data String - string → Base-64 encoded encrypted password data for the instance. Use this attribute only for instances running Microsoft Windows. This attribute is only exported if
get_password_data
is true. If you change the password after creating the instance, these changes will not be visible in this field.New since v0.9.3. - personalities List<Property Map>
- optional → Customize the personality of an instance by defining one or more files and their contents. The personality structure is described below. Note: 'config_drive' must be enabled.
- power
State String - optional string → Provide the VM state. Only 'active' and 'shutoff' are supported values. Note: If the initial power_state is the shutoff the VM will be stopped immediately after build and the provisioners like remote-exec or files are not supported.
- region String
- optional string → The region in which to create the server instance. If omitted, the
region
argument of the provider is used. Changing this creates a new server. - scheduler
Hints List<Property Map> - optional → Provide the Nova scheduler with hints on how the instance should be launched. The available hints are described below.
- security
Group List<String>Ids - optional set of string → An array of one or more security group ids to associate with the server. Changing this results in adding/removing security groups from the existing server. Note: When attaching the instance to networks using Ports, place the security groups on the Port and not the instance.New since v0.7.3.
- security
Groups List<String> - optional deprecated set of string → An array of one or more security group names to associate with the server. Changing this results in adding/removing security groups from the existing server. Note: When attaching the instance to networks using Ports, place the security groups on the Port and not the instance. Deprecated Configure
security_group_ids
instead. - stop
Before BooleanDestroy - optional boolean → Whether to try stop instance gracefully before destroying it, thus giving chance for guest OS daemons to stop correctly. If instance doesn't stop within timeout, it will be destroyed anyway.
- List<String>
- optional set of string → A set of string tags for the instance. Changing this updates the existing instance tags.
- timeouts Property Map
- user
Data String - optional string → The user data to provide when launching the instance. When cloud_monitoring enabled only #!/bin/bash, #cloud-config, #ps1 user_data formats are supported. Changing this creates a new server.
- vendor
Options Property Map - optional → Map of additional vendor-specific options. Supported options are described below.
Supporting Types
ComputeInstanceBlockDevice, ComputeInstanceBlockDeviceArgs
- Source
Type string - required string → The source type of the device. Must be one of "blank", "image", "volume", or "snapshot". Changing this creates a new server.
- Boot
Index double - optional number → The boot index of the volume. It defaults to 0 if only one
block_device
is specified, and to -1 if more than one is configured. Changing this creates a new server. Note: You must set the boot index to 0 for one of the block devices if more than one is defined. - Delete
On boolTermination - Destination
Type string - optional string → The type that gets created. Possible values are "volume" and "local". Changing this creates a new server.
- Device
Type string - optional string → The low-level device type that will be used. Most common thing is to leave this empty. Changing this creates a new server.
- Disk
Bus string - optional string → The low-level disk bus that will be used. Most common thing is to leave this empty. Changing this creates a new server.
- Guest
Format string - optional string → Specifies the guest server disk file system format, such as
ext2
,ext3
,ext4
,xfs
orswap
. Swap block device mappings have the following restrictions: source_type must be blank and destination_type must be local and only one swap disk per server and the size of the swap disk must be less than or equal to the swap size of the flavor. Changing this creates a new server. - Uuid string
- optional string → The UUID of the image, volume, or snapshot. Optional if
source_type
is set to"blank"
. Changing this creates a new server. - Volume
Size double - optional number → The size of the volume to create (in gigabytes). Required in the following combinations: source=image and destination=volume, source=blank and destination=local, and source=blank and destination=volume. Changing this creates a new server.
- Volume
Type string - optional string → The volume type that will be used. Changing this creates a new server.
- Source
Type string - required string → The source type of the device. Must be one of "blank", "image", "volume", or "snapshot". Changing this creates a new server.
- Boot
Index float64 - optional number → The boot index of the volume. It defaults to 0 if only one
block_device
is specified, and to -1 if more than one is configured. Changing this creates a new server. Note: You must set the boot index to 0 for one of the block devices if more than one is defined. - Delete
On boolTermination - Destination
Type string - optional string → The type that gets created. Possible values are "volume" and "local". Changing this creates a new server.
- Device
Type string - optional string → The low-level device type that will be used. Most common thing is to leave this empty. Changing this creates a new server.
- Disk
Bus string - optional string → The low-level disk bus that will be used. Most common thing is to leave this empty. Changing this creates a new server.
- Guest
Format string - optional string → Specifies the guest server disk file system format, such as
ext2
,ext3
,ext4
,xfs
orswap
. Swap block device mappings have the following restrictions: source_type must be blank and destination_type must be local and only one swap disk per server and the size of the swap disk must be less than or equal to the swap size of the flavor. Changing this creates a new server. - Uuid string
- optional string → The UUID of the image, volume, or snapshot. Optional if
source_type
is set to"blank"
. Changing this creates a new server. - Volume
Size float64 - optional number → The size of the volume to create (in gigabytes). Required in the following combinations: source=image and destination=volume, source=blank and destination=local, and source=blank and destination=volume. Changing this creates a new server.
- Volume
Type string - optional string → The volume type that will be used. Changing this creates a new server.
- source
Type String - required string → The source type of the device. Must be one of "blank", "image", "volume", or "snapshot". Changing this creates a new server.
- boot
Index Double - optional number → The boot index of the volume. It defaults to 0 if only one
block_device
is specified, and to -1 if more than one is configured. Changing this creates a new server. Note: You must set the boot index to 0 for one of the block devices if more than one is defined. - delete
On BooleanTermination - destination
Type String - optional string → The type that gets created. Possible values are "volume" and "local". Changing this creates a new server.
- device
Type String - optional string → The low-level device type that will be used. Most common thing is to leave this empty. Changing this creates a new server.
- disk
Bus String - optional string → The low-level disk bus that will be used. Most common thing is to leave this empty. Changing this creates a new server.
- guest
Format String - optional string → Specifies the guest server disk file system format, such as
ext2
,ext3
,ext4
,xfs
orswap
. Swap block device mappings have the following restrictions: source_type must be blank and destination_type must be local and only one swap disk per server and the size of the swap disk must be less than or equal to the swap size of the flavor. Changing this creates a new server. - uuid String
- optional string → The UUID of the image, volume, or snapshot. Optional if
source_type
is set to"blank"
. Changing this creates a new server. - volume
Size Double - optional number → The size of the volume to create (in gigabytes). Required in the following combinations: source=image and destination=volume, source=blank and destination=local, and source=blank and destination=volume. Changing this creates a new server.
- volume
Type String - optional string → The volume type that will be used. Changing this creates a new server.
- source
Type string - required string → The source type of the device. Must be one of "blank", "image", "volume", or "snapshot". Changing this creates a new server.
- boot
Index number - optional number → The boot index of the volume. It defaults to 0 if only one
block_device
is specified, and to -1 if more than one is configured. Changing this creates a new server. Note: You must set the boot index to 0 for one of the block devices if more than one is defined. - delete
On booleanTermination - destination
Type string - optional string → The type that gets created. Possible values are "volume" and "local". Changing this creates a new server.
- device
Type string - optional string → The low-level device type that will be used. Most common thing is to leave this empty. Changing this creates a new server.
- disk
Bus string - optional string → The low-level disk bus that will be used. Most common thing is to leave this empty. Changing this creates a new server.
- guest
Format string - optional string → Specifies the guest server disk file system format, such as
ext2
,ext3
,ext4
,xfs
orswap
. Swap block device mappings have the following restrictions: source_type must be blank and destination_type must be local and only one swap disk per server and the size of the swap disk must be less than or equal to the swap size of the flavor. Changing this creates a new server. - uuid string
- optional string → The UUID of the image, volume, or snapshot. Optional if
source_type
is set to"blank"
. Changing this creates a new server. - volume
Size number - optional number → The size of the volume to create (in gigabytes). Required in the following combinations: source=image and destination=volume, source=blank and destination=local, and source=blank and destination=volume. Changing this creates a new server.
- volume
Type string - optional string → The volume type that will be used. Changing this creates a new server.
- source_
type str - required string → The source type of the device. Must be one of "blank", "image", "volume", or "snapshot". Changing this creates a new server.
- boot_
index float - optional number → The boot index of the volume. It defaults to 0 if only one
block_device
is specified, and to -1 if more than one is configured. Changing this creates a new server. Note: You must set the boot index to 0 for one of the block devices if more than one is defined. - delete_
on_ booltermination - destination_
type str - optional string → The type that gets created. Possible values are "volume" and "local". Changing this creates a new server.
- device_
type str - optional string → The low-level device type that will be used. Most common thing is to leave this empty. Changing this creates a new server.
- disk_
bus str - optional string → The low-level disk bus that will be used. Most common thing is to leave this empty. Changing this creates a new server.
- guest_
format str - optional string → Specifies the guest server disk file system format, such as
ext2
,ext3
,ext4
,xfs
orswap
. Swap block device mappings have the following restrictions: source_type must be blank and destination_type must be local and only one swap disk per server and the size of the swap disk must be less than or equal to the swap size of the flavor. Changing this creates a new server. - uuid str
- optional string → The UUID of the image, volume, or snapshot. Optional if
source_type
is set to"blank"
. Changing this creates a new server. - volume_
size float - optional number → The size of the volume to create (in gigabytes). Required in the following combinations: source=image and destination=volume, source=blank and destination=local, and source=blank and destination=volume. Changing this creates a new server.
- volume_
type str - optional string → The volume type that will be used. Changing this creates a new server.
- source
Type String - required string → The source type of the device. Must be one of "blank", "image", "volume", or "snapshot". Changing this creates a new server.
- boot
Index Number - optional number → The boot index of the volume. It defaults to 0 if only one
block_device
is specified, and to -1 if more than one is configured. Changing this creates a new server. Note: You must set the boot index to 0 for one of the block devices if more than one is defined. - delete
On BooleanTermination - destination
Type String - optional string → The type that gets created. Possible values are "volume" and "local". Changing this creates a new server.
- device
Type String - optional string → The low-level device type that will be used. Most common thing is to leave this empty. Changing this creates a new server.
- disk
Bus String - optional string → The low-level disk bus that will be used. Most common thing is to leave this empty. Changing this creates a new server.
- guest
Format String - optional string → Specifies the guest server disk file system format, such as
ext2
,ext3
,ext4
,xfs
orswap
. Swap block device mappings have the following restrictions: source_type must be blank and destination_type must be local and only one swap disk per server and the size of the swap disk must be less than or equal to the swap size of the flavor. Changing this creates a new server. - uuid String
- optional string → The UUID of the image, volume, or snapshot. Optional if
source_type
is set to"blank"
. Changing this creates a new server. - volume
Size Number - optional number → The size of the volume to create (in gigabytes). Required in the following combinations: source=image and destination=volume, source=blank and destination=local, and source=blank and destination=volume. Changing this creates a new server.
- volume
Type String - optional string → The volume type that will be used. Changing this creates a new server.
ComputeInstanceCloudMonitoring, ComputeInstanceCloudMonitoringArgs
- Script string
- required sensitive string → The script of the cloud monitoring.
- Service
User stringId - required string → The id of the service monitoring user.
- Script string
- required sensitive string → The script of the cloud monitoring.
- Service
User stringId - required string → The id of the service monitoring user.
- script String
- required sensitive string → The script of the cloud monitoring.
- service
User StringId - required string → The id of the service monitoring user.
- script string
- required sensitive string → The script of the cloud monitoring.
- service
User stringId - required string → The id of the service monitoring user.
- script str
- required sensitive string → The script of the cloud monitoring.
- service_
user_ strid - required string → The id of the service monitoring user.
- script String
- required sensitive string → The script of the cloud monitoring.
- service
User StringId - required string → The id of the service monitoring user.
ComputeInstanceNetwork, ComputeInstanceNetworkArgs
- Access
Network bool - optional boolean → Specifies if this network should be used for provisioning access. Accepts true or false. Defaults to false.
- Fixed
Ip stringV4 - optional string → Specifies a fixed IPv4 address to be used on this network. Changing this creates a new server.
- Mac string
- string → The MAC address of the NIC on that network.
- Name string
- optional string → The human-readable name of the network. Optional if
uuid
orport
is provided. Changing this creates a new server. - Port string
- optional string → The port UUID of a network to attach to the server. Optional if
uuid
orname
is provided. Changing this creates a new server. Note: If port is used, only its security groups will be applied instead of security_groups instance argument. - Uuid string
- optional string → The network UUID to attach to the server. Optional if
port
orname
is provided. Changing this creates a new server.
- Access
Network bool - optional boolean → Specifies if this network should be used for provisioning access. Accepts true or false. Defaults to false.
- Fixed
Ip stringV4 - optional string → Specifies a fixed IPv4 address to be used on this network. Changing this creates a new server.
- Mac string
- string → The MAC address of the NIC on that network.
- Name string
- optional string → The human-readable name of the network. Optional if
uuid
orport
is provided. Changing this creates a new server. - Port string
- optional string → The port UUID of a network to attach to the server. Optional if
uuid
orname
is provided. Changing this creates a new server. Note: If port is used, only its security groups will be applied instead of security_groups instance argument. - Uuid string
- optional string → The network UUID to attach to the server. Optional if
port
orname
is provided. Changing this creates a new server.
- access
Network Boolean - optional boolean → Specifies if this network should be used for provisioning access. Accepts true or false. Defaults to false.
- fixed
Ip StringV4 - optional string → Specifies a fixed IPv4 address to be used on this network. Changing this creates a new server.
- mac String
- string → The MAC address of the NIC on that network.
- name String
- optional string → The human-readable name of the network. Optional if
uuid
orport
is provided. Changing this creates a new server. - port String
- optional string → The port UUID of a network to attach to the server. Optional if
uuid
orname
is provided. Changing this creates a new server. Note: If port is used, only its security groups will be applied instead of security_groups instance argument. - uuid String
- optional string → The network UUID to attach to the server. Optional if
port
orname
is provided. Changing this creates a new server.
- access
Network boolean - optional boolean → Specifies if this network should be used for provisioning access. Accepts true or false. Defaults to false.
- fixed
Ip stringV4 - optional string → Specifies a fixed IPv4 address to be used on this network. Changing this creates a new server.
- mac string
- string → The MAC address of the NIC on that network.
- name string
- optional string → The human-readable name of the network. Optional if
uuid
orport
is provided. Changing this creates a new server. - port string
- optional string → The port UUID of a network to attach to the server. Optional if
uuid
orname
is provided. Changing this creates a new server. Note: If port is used, only its security groups will be applied instead of security_groups instance argument. - uuid string
- optional string → The network UUID to attach to the server. Optional if
port
orname
is provided. Changing this creates a new server.
- access_
network bool - optional boolean → Specifies if this network should be used for provisioning access. Accepts true or false. Defaults to false.
- fixed_
ip_ strv4 - optional string → Specifies a fixed IPv4 address to be used on this network. Changing this creates a new server.
- mac str
- string → The MAC address of the NIC on that network.
- name str
- optional string → The human-readable name of the network. Optional if
uuid
orport
is provided. Changing this creates a new server. - port str
- optional string → The port UUID of a network to attach to the server. Optional if
uuid
orname
is provided. Changing this creates a new server. Note: If port is used, only its security groups will be applied instead of security_groups instance argument. - uuid str
- optional string → The network UUID to attach to the server. Optional if
port
orname
is provided. Changing this creates a new server.
- access
Network Boolean - optional boolean → Specifies if this network should be used for provisioning access. Accepts true or false. Defaults to false.
- fixed
Ip StringV4 - optional string → Specifies a fixed IPv4 address to be used on this network. Changing this creates a new server.
- mac String
- string → The MAC address of the NIC on that network.
- name String
- optional string → The human-readable name of the network. Optional if
uuid
orport
is provided. Changing this creates a new server. - port String
- optional string → The port UUID of a network to attach to the server. Optional if
uuid
orname
is provided. Changing this creates a new server. Note: If port is used, only its security groups will be applied instead of security_groups instance argument. - uuid String
- optional string → The network UUID to attach to the server. Optional if
port
orname
is provided. Changing this creates a new server.
ComputeInstancePersonality, ComputeInstancePersonalityArgs
ComputeInstanceSchedulerHint, ComputeInstanceSchedulerHintArgs
- Group string
- optional string → A UUID of a Server Group. The instance will be placed into that group.
- Group string
- optional string → A UUID of a Server Group. The instance will be placed into that group.
- group String
- optional string → A UUID of a Server Group. The instance will be placed into that group.
- group string
- optional string → A UUID of a Server Group. The instance will be placed into that group.
- group str
- optional string → A UUID of a Server Group. The instance will be placed into that group.
- group String
- optional string → A UUID of a Server Group. The instance will be placed into that group.
ComputeInstanceTimeouts, ComputeInstanceTimeoutsArgs
ComputeInstanceVendorOptions, ComputeInstanceVendorOptionsArgs
- Detach
Ports boolBefore Destroy - optional boolean → Whether to try to detach all attached ports to the vm before destroying it to make sure the port state is correct after the vm destruction. This is helpful when the port is not deleted.
- Get
Password boolData - optional boolean → If true, wait for initial windows admin password to be generated and retrieve it. Use this attribute only for instances running Microsoft Windows. The password data is exported to the
password_data
attribute. The password will be generated only if you specify the instancekey_pair
. The password will be read only once when the instance is created.New since v0.9.3. - Ignore
Resize boolConfirmation - optional boolean → Boolean to control whether to ignore manual confirmation of the instance resizing.
- Detach
Ports boolBefore Destroy - optional boolean → Whether to try to detach all attached ports to the vm before destroying it to make sure the port state is correct after the vm destruction. This is helpful when the port is not deleted.
- Get
Password boolData - optional boolean → If true, wait for initial windows admin password to be generated and retrieve it. Use this attribute only for instances running Microsoft Windows. The password data is exported to the
password_data
attribute. The password will be generated only if you specify the instancekey_pair
. The password will be read only once when the instance is created.New since v0.9.3. - Ignore
Resize boolConfirmation - optional boolean → Boolean to control whether to ignore manual confirmation of the instance resizing.
- detach
Ports BooleanBefore Destroy - optional boolean → Whether to try to detach all attached ports to the vm before destroying it to make sure the port state is correct after the vm destruction. This is helpful when the port is not deleted.
- get
Password BooleanData - optional boolean → If true, wait for initial windows admin password to be generated and retrieve it. Use this attribute only for instances running Microsoft Windows. The password data is exported to the
password_data
attribute. The password will be generated only if you specify the instancekey_pair
. The password will be read only once when the instance is created.New since v0.9.3. - ignore
Resize BooleanConfirmation - optional boolean → Boolean to control whether to ignore manual confirmation of the instance resizing.
- detach
Ports booleanBefore Destroy - optional boolean → Whether to try to detach all attached ports to the vm before destroying it to make sure the port state is correct after the vm destruction. This is helpful when the port is not deleted.
- get
Password booleanData - optional boolean → If true, wait for initial windows admin password to be generated and retrieve it. Use this attribute only for instances running Microsoft Windows. The password data is exported to the
password_data
attribute. The password will be generated only if you specify the instancekey_pair
. The password will be read only once when the instance is created.New since v0.9.3. - ignore
Resize booleanConfirmation - optional boolean → Boolean to control whether to ignore manual confirmation of the instance resizing.
- detach_
ports_ boolbefore_ destroy - optional boolean → Whether to try to detach all attached ports to the vm before destroying it to make sure the port state is correct after the vm destruction. This is helpful when the port is not deleted.
- get_
password_ booldata - optional boolean → If true, wait for initial windows admin password to be generated and retrieve it. Use this attribute only for instances running Microsoft Windows. The password data is exported to the
password_data
attribute. The password will be generated only if you specify the instancekey_pair
. The password will be read only once when the instance is created.New since v0.9.3. - ignore_
resize_ boolconfirmation - optional boolean → Boolean to control whether to ignore manual confirmation of the instance resizing.
- detach
Ports BooleanBefore Destroy - optional boolean → Whether to try to detach all attached ports to the vm before destroying it to make sure the port state is correct after the vm destruction. This is helpful when the port is not deleted.
- get
Password BooleanData - optional boolean → If true, wait for initial windows admin password to be generated and retrieve it. Use this attribute only for instances running Microsoft Windows. The password data is exported to the
password_data
attribute. The password will be generated only if you specify the instancekey_pair
. The password will be read only once when the instance is created.New since v0.9.3. - ignore
Resize BooleanConfirmation - optional boolean → Boolean to control whether to ignore manual confirmation of the instance resizing.
Package Details
- Repository
- vkcs vk-cs/terraform-provider-vkcs
- License
- Notes
- This Pulumi package is based on the
vkcs
Terraform Provider.