Class InstanceProperties (1.12.0)

Version 1.12.0

• 1.22.0 (latest)
• 1.21.0
• 1.20.1
• 1.19.2
• 1.18.0
• 1.17.0
• 1.16.1
• 1.15.0
• 1.14.1
• 1.13.0
• 1.12.1
• 1.11.0
• 1.10.1
• 1.9.0
• 1.8.0
• 1.7.0
• 1.6.1
• 1.5.2
• 1.4.0
• 1.3.2
• 1.2.0
• 1.1.0
• 1.0.0
• 0.9.0
• 0.8.0
• 0.7.0
• 0.6.0
• 0.5.0
• 0.4.2
• 0.3.0
• 0.2.1
• 0.1.0

InstanceProperties(mapping=None, *, ignore_unknown_fields=False, **kwargs)

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Attributes
Name	Description
advanced_machine_features	google.cloud.compute_v1.types.AdvancedMachineFeatures Controls for advanced machine-related behavior features. Note that for MachineImage, this is not supported yet. This field is a member of oneof_ _advanced_machine_features.
can_ip_forward	bool Enables instances created based on these properties to send packets with source IP addresses other than their own and receive packets with destination IP addresses other than their own. If these instances will be used as an IP gateway or it will be set as the next-hop in a Route resource, specify true. If unsure, leave this set to false. See the Enable IP forwarding documentation for more information. This field is a member of oneof_ _can_ip_forward.
confidential_instance_config	google.cloud.compute_v1.types.ConfidentialInstanceConfig Specifies the Confidential Instance options. Note that for MachineImage, this is not supported yet. This field is a member of oneof_ _confidential_instance_config.
description	str An optional text description for the instances that are created from these properties. This field is a member of oneof_ _description.
disks	MutableSequence[google.cloud.compute_v1.types.AttachedDisk] An array of disks that are associated with the instances that are created from these properties.
guest_accelerators	MutableSequence[google.cloud.compute_v1.types.AcceleratorConfig] A list of guest accelerator cards' type and count to use for instances created from these properties.
key_revocation_action_type	str KeyRevocationActionType of the instance. Supported options are "STOP" and "NONE". The default value is "NONE" if it is not specified. Check the KeyRevocationActionType enum for the list of possible values. This field is a member of oneof_ _key_revocation_action_type.
labels	MutableMapping[str, str] Labels to apply to instances that are created from these properties.
machine_type	str The machine type to use for instances that are created from these properties. This field is a member of oneof_ _machine_type.
metadata	google.cloud.compute_v1.types.Metadata The metadata key/value pairs to assign to instances that are created from these properties. These pairs can consist of custom metadata or predefined keys. See Project and instance metadata for more information. This field is a member of oneof_ _metadata.
min_cpu_platform	str Minimum cpu/platform to be used by instances. The instance may be scheduled on the specified or newer cpu/platform. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: "Intel Haswell" or minCpuPlatform: "Intel Sandy Bridge". For more information, read Specifying a Minimum CPU Platform. This field is a member of oneof_ _min_cpu_platform.
network_interfaces	MutableSequence[google.cloud.compute_v1.types.NetworkInterface] An array of network access configurations for this interface.
network_performance_config	google.cloud.compute_v1.types.NetworkPerformanceConfig Note that for MachineImage, this is not supported yet. This field is a member of oneof_ _network_performance_config.
private_ipv6_google_access	str The private IPv6 google access type for VMs. If not specified, use INHERIT_FROM_SUBNETWORK as default. Note that for MachineImage, this is not supported yet. Check the PrivateIpv6GoogleAccess enum for the list of possible values. This field is a member of oneof_ _private_ipv6_google_access.
reservation_affinity	google.cloud.compute_v1.types.ReservationAffinity Specifies the reservations that instances can consume from. Note that for MachineImage, this is not supported yet. This field is a member of oneof_ _reservation_affinity.
resource_manager_tags	MutableMapping[str, str] Resource manager tags to be bound to the instance. Tag keys and values have the same definition as resource manager tags. Keys must be in the format tagKeys/{tag_key_id}, and values are in the format tagValues/456. The field is ignored (both PUT & PATCH) when empty.
resource_policies	MutableSequence[str] Resource policies (names, not URLs) applied to instances created from these properties. Note that for MachineImage, this is not supported yet.
scheduling	google.cloud.compute_v1.types.Scheduling Specifies the scheduling options for the instances that are created from these properties. This field is a member of oneof_ _scheduling.
service_accounts	MutableSequence[google.cloud.compute_v1.types.ServiceAccount] A list of service accounts with specified scopes. Access tokens for these service accounts are available to the instances that are created from these properties. Use metadata queries to obtain the access tokens for these instances.
shielded_instance_config	google.cloud.compute_v1.types.ShieldedInstanceConfig Note that for MachineImage, this is not supported yet. This field is a member of oneof_ _shielded_instance_config.
tags	google.cloud.compute_v1.types.Tags A list of tags to apply to the instances that are created from these properties. The tags identify valid sources or targets for network firewalls. The setTags method can modify this list of tags. Each tag within the list must comply with RFC1035. This field is a member of oneof_ _tags.

Classes

KeyRevocationActionType

KeyRevocationActionType(value)

KeyRevocationActionType of the instance. Supported options are "STOP" and "NONE". The default value is "NONE" if it is not specified.

Values: UNDEFINED_KEY_REVOCATION_ACTION_TYPE (0): A value indicating that the enum field is not set. KEY_REVOCATION_ACTION_TYPE_UNSPECIFIED (467110106): Default value. This value is unused. NONE (2402104): Indicates user chose no operation. STOP (2555906): Indicates user chose to opt for VM shutdown on key revocation.

LabelsEntry

LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The abstract base class for a message.

Parameters
Name	Description
kwargs	dict Keys and values corresponding to the fields of the message.
mapping	Union[dict, .Message] A dictionary or message to be used to determine the values for this message.
ignore_unknown_fields	Optional(bool) If True, do not raise errors for unknown fields. Only applied if mapping is a mapping type or there are keyword parameters.

PrivateIpv6GoogleAccess

PrivateIpv6GoogleAccess(value)

The private IPv6 google access type for VMs. If not specified, use INHERIT_FROM_SUBNETWORK as default. Note that for MachineImage, this is not supported yet.

Values: UNDEFINED_PRIVATE_IPV6_GOOGLE_ACCESS (0): A value indicating that the enum field is not set. ENABLE_BIDIRECTIONAL_ACCESS_TO_GOOGLE (427975994): Bidirectional private IPv6 access to/from Google services. If specified, the subnetwork who is attached to the instance's default network interface will be assigned an internal IPv6 prefix if it doesn't have before. ENABLE_OUTBOUND_VM_ACCESS_TO_GOOGLE (288210263): Outbound private IPv6 access from VMs in this subnet to Google services. If specified, the subnetwork who is attached to the instance's default network interface will be assigned an internal IPv6 prefix if it doesn't have before. INHERIT_FROM_SUBNETWORK (530256959): Each network interface inherits PrivateIpv6GoogleAccess from its subnetwork.

ResourceManagerTagsEntry

ResourceManagerTagsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The abstract base class for a message.

Parameters
Name	Description
kwargs	dict Keys and values corresponding to the fields of the message.
mapping	Union[dict, .Message] A dictionary or message to be used to determine the values for this message.
ignore_unknown_fields	Optional(bool) If True, do not raise errors for unknown fields. Only applied if mapping is a mapping type or there are keyword parameters.