compute

This provider is a derived work of the Terraform Provider distributed under MPL 2.0. If you encounter a bug or missing feature, first check the pulumi/pulumi-gcp repo; however, if that doesn’t turn up anything, please consult the source terraform-providers/terraform-provider-google repo.

class pulumi_gcp.compute.Address(resource_name, opts=None, address=None, address_type=None, description=None, labels=None, name=None, network_tier=None, project=None, region=None, subnetwork=None, __props__=None, __name__=None, __opts__=None)

Represents an Address resource.

Each virtual machine instance has an ephemeral internal IP address and, optionally, an external IP address. To communicate between instances on the same network, you can use an instance’s internal IP address. To communicate with the Internet and instances outside of the same network, you must specify the instance’s external IP address.

Internal IP addresses are ephemeral and only belong to an instance for the lifetime of the instance; if the instance is deleted and recreated, the instance is assigned a new internal IP address, either by Compute Engine or by you. External IP addresses can be either ephemeral or static.

To get more information about Address, see:

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • address (pulumi.Input[str]) – The IP of the created resource.

  • project (pulumi.Input[str]) – The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

address = None

The IP of the created resource.

project = None

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

The URI of the created resource.

static get(resource_name, id, opts=None, address=None, address_type=None, creation_timestamp=None, description=None, label_fingerprint=None, labels=None, name=None, network_tier=None, project=None, region=None, self_link=None, subnetwork=None, users=None)

Get an existing Address resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • address (pulumi.Input[str]) – The IP of the created resource.

  • project (pulumi.Input[str]) – The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

  • self_link (pulumi.Input[str]) – The URI of the created resource.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_gcp.compute.AttachedDisk(resource_name, opts=None, device_name=None, disk=None, instance=None, mode=None, project=None, zone=None, __props__=None, __name__=None, __opts__=None)

Create a AttachedDisk resource with the given unique name, props, and options.

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

static get(resource_name, id, opts=None, device_name=None, disk=None, instance=None, mode=None, project=None, zone=None)

Get an existing AttachedDisk resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_gcp.compute.Autoscalar(resource_name, opts=None, autoscaling_policy=None, description=None, name=None, project=None, target=None, zone=None, __props__=None, __name__=None, __opts__=None)

Represents an Autoscaler resource.

Autoscalers allow you to automatically scale virtual machine instances in managed instance groups according to an autoscaling policy that you define.

To get more information about Autoscaler, see:

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

The autoscaling_policy object supports the following:

  • cooldownPeriod (pulumi.Input[float])

  • cpuUtilization (pulumi.Input[dict])

    • target (pulumi.Input[float])

  • loadBalancingUtilization (pulumi.Input[dict])

    • target (pulumi.Input[float])

  • maxReplicas (pulumi.Input[float])

  • metrics (pulumi.Input[list])

    • filter (pulumi.Input[str])

    • name (pulumi.Input[str])

    • singleInstanceAssignment (pulumi.Input[float])

    • target (pulumi.Input[float])

    • type (pulumi.Input[str])

  • minReplicas (pulumi.Input[float])

The URI of the created resource.

static get(resource_name, id, opts=None, autoscaling_policy=None, creation_timestamp=None, description=None, name=None, project=None, self_link=None, target=None, zone=None)

Get an existing Autoscalar resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • self_link (pulumi.Input[str]) – The URI of the created resource.

The autoscaling_policy object supports the following:

  • cooldownPeriod (pulumi.Input[float])

  • cpuUtilization (pulumi.Input[dict])

    • target (pulumi.Input[float])

  • loadBalancingUtilization (pulumi.Input[dict])

    • target (pulumi.Input[float])

  • maxReplicas (pulumi.Input[float])

  • metrics (pulumi.Input[list])

    • filter (pulumi.Input[str])

    • name (pulumi.Input[str])

    • singleInstanceAssignment (pulumi.Input[float])

    • target (pulumi.Input[float])

    • type (pulumi.Input[str])

  • minReplicas (pulumi.Input[float])

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_gcp.compute.AwaitableGetAddressResult(address=None, name=None, project=None, region=None, self_link=None, status=None, id=None)
class pulumi_gcp.compute.AwaitableGetBackendServiceResult(affinity_cookie_ttl_sec=None, backends=None, cdn_policies=None, connection_draining_timeout_sec=None, creation_timestamp=None, custom_request_headers=None, description=None, enable_cdn=None, fingerprint=None, health_checks=None, iaps=None, load_balancing_scheme=None, name=None, port_name=None, project=None, protocol=None, security_policy=None, self_link=None, session_affinity=None, timeout_sec=None, id=None)
class pulumi_gcp.compute.AwaitableGetCertificateResult(certificate=None, certificate_id=None, creation_timestamp=None, description=None, name=None, name_prefix=None, private_key=None, project=None, self_link=None, id=None)
class pulumi_gcp.compute.AwaitableGetDefaultServiceAccountResult(display_name=None, email=None, name=None, project=None, unique_id=None, id=None)
class pulumi_gcp.compute.AwaitableGetForwardingRuleResult(backend_service=None, description=None, ip_address=None, ip_protocol=None, load_balancing_scheme=None, name=None, network=None, port_range=None, ports=None, project=None, region=None, self_link=None, subnetwork=None, target=None, id=None)
class pulumi_gcp.compute.AwaitableGetGlobalAddressResult(address=None, name=None, project=None, self_link=None, status=None, id=None)
class pulumi_gcp.compute.AwaitableGetImageResult(archive_size_bytes=None, creation_timestamp=None, description=None, disk_size_gb=None, family=None, image_encryption_key_sha256=None, image_id=None, label_fingerprint=None, labels=None, licenses=None, name=None, project=None, self_link=None, source_disk=None, source_disk_encryption_key_sha256=None, source_disk_id=None, source_image_id=None, status=None, id=None)
class pulumi_gcp.compute.AwaitableGetInstanceGroupResult(description=None, instances=None, name=None, named_ports=None, network=None, project=None, self_link=None, size=None, zone=None, id=None)
class pulumi_gcp.compute.AwaitableGetInstanceResult(allow_stopping_for_update=None, attached_disks=None, boot_disks=None, can_ip_forward=None, cpu_platform=None, deletion_protection=None, description=None, disks=None, guest_accelerators=None, hostname=None, instance_id=None, label_fingerprint=None, labels=None, machine_type=None, metadata=None, metadata_fingerprint=None, metadata_startup_script=None, min_cpu_platform=None, name=None, network_interfaces=None, project=None, schedulings=None, scratch_disks=None, self_link=None, service_accounts=None, shielded_instance_configs=None, tags=None, tags_fingerprint=None, zone=None, id=None)
class pulumi_gcp.compute.AwaitableGetLBIPRangesResult(http_ssl_tcp_internals=None, networks=None, id=None)
class pulumi_gcp.compute.AwaitableGetNetblockIPRangesResult(cidr_blocks=None, cidr_blocks_ipv4s=None, cidr_blocks_ipv6s=None, id=None)
class pulumi_gcp.compute.AwaitableGetNetworkResult(description=None, gateway_ipv4=None, name=None, project=None, self_link=None, subnetworks_self_links=None, id=None)
class pulumi_gcp.compute.AwaitableGetNodeTypesResult(names=None, project=None, zone=None, id=None)
class pulumi_gcp.compute.AwaitableGetRegionInstanceGroupResult(instances=None, name=None, project=None, region=None, self_link=None, size=None, id=None)
class pulumi_gcp.compute.AwaitableGetRegionsResult(names=None, project=None, status=None, id=None)
class pulumi_gcp.compute.AwaitableGetSSLPolicyResult(creation_timestamp=None, custom_features=None, description=None, enabled_features=None, fingerprint=None, min_tls_version=None, name=None, profile=None, project=None, self_link=None, id=None)
class pulumi_gcp.compute.AwaitableGetSubnetworkResult(description=None, gateway_address=None, ip_cidr_range=None, name=None, network=None, private_ip_google_access=None, project=None, region=None, secondary_ip_ranges=None, self_link=None, id=None)
class pulumi_gcp.compute.AwaitableGetVPNGatewayResult(description=None, name=None, network=None, project=None, region=None, self_link=None, id=None)
class pulumi_gcp.compute.AwaitableGetZonesResult(names=None, project=None, region=None, status=None, id=None)
class pulumi_gcp.compute.BackendBucket(resource_name, opts=None, bucket_name=None, cdn_policy=None, description=None, enable_cdn=None, name=None, project=None, __props__=None, __name__=None, __opts__=None)

Backend buckets allow you to use Google Cloud Storage buckets with HTTP(S) load balancing.

An HTTP(S) load balancer can direct traffic to specified URLs to a backend bucket rather than a backend service. It can send requests for static content to a Cloud Storage bucket and requests for dynamic content a virtual machine instance.

To get more information about BackendBucket, see:

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • project (pulumi.Input[str]) – The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

The cdn_policy object supports the following:

  • signedUrlCacheMaxAgeSec (pulumi.Input[float])

project = None

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

The URI of the created resource.

static get(resource_name, id, opts=None, bucket_name=None, cdn_policy=None, creation_timestamp=None, description=None, enable_cdn=None, name=None, project=None, self_link=None)

Get an existing BackendBucket resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • project (pulumi.Input[str]) – The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

  • self_link (pulumi.Input[str]) – The URI of the created resource.

The cdn_policy object supports the following:

  • signedUrlCacheMaxAgeSec (pulumi.Input[float])

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_gcp.compute.BackendBucketSignedUrlKey(resource_name, opts=None, backend_bucket=None, key_value=None, name=None, project=None, __props__=None, __name__=None, __opts__=None)

A key for signing Cloud CDN signed URLs for BackendBuckets.

To get more information about BackendBucketSignedUrlKey, see:

Warning: All arguments including the key’s value will be stored in the raw state as plain-text. Read more about sensitive data in state. Because the API does not return the sensitive key value, we cannot confirm or reverse changes to a key outside of this provider.

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • project (pulumi.Input[str]) – The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

project = None

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

static get(resource_name, id, opts=None, backend_bucket=None, key_value=None, name=None, project=None)

Get an existing BackendBucketSignedUrlKey resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • project (pulumi.Input[str]) – The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_gcp.compute.BackendService(resource_name, opts=None, affinity_cookie_ttl_sec=None, backends=None, cdn_policy=None, connection_draining_timeout_sec=None, custom_request_headers=None, description=None, enable_cdn=None, health_checks=None, iap=None, load_balancing_scheme=None, name=None, port_name=None, project=None, protocol=None, security_policy=None, session_affinity=None, timeout_sec=None, __props__=None, __name__=None, __opts__=None)

A Backend Service defines a group of virtual machines that will serve traffic for load balancing. This resource is a global backend service, appropriate for external load balancing or self-managed internal load balancing. For managed internal load balancing, use a regional backend service instead.

Currently self-managed internal load balancing is only available in beta.

To get more information about BackendService, see:

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • project (pulumi.Input[str]) – The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

The backends object supports the following:

  • balancingMode (pulumi.Input[str])

  • capacityScaler (pulumi.Input[float])

  • description (pulumi.Input[str])

  • group (pulumi.Input[str])

  • maxConnections (pulumi.Input[float])

  • maxConnectionsPerEndpoint (pulumi.Input[float])

  • maxConnectionsPerInstance (pulumi.Input[float])

  • maxRate (pulumi.Input[float])

  • maxRatePerEndpoint (pulumi.Input[float])

  • maxRatePerInstance (pulumi.Input[float])

  • maxUtilization (pulumi.Input[float])

The cdn_policy object supports the following:

  • cacheKeyPolicy (pulumi.Input[dict])

    • includeHost (pulumi.Input[bool])

    • includeProtocol (pulumi.Input[bool])

    • includeQueryString (pulumi.Input[bool])

    • queryStringBlacklists (pulumi.Input[list])

    • queryStringWhitelists (pulumi.Input[list])

  • signedUrlCacheMaxAgeSec (pulumi.Input[float])

The iap object supports the following:

  • oauth2ClientId (pulumi.Input[str])

  • oauth2ClientSecret (pulumi.Input[str])

  • oauth2ClientSecretSha256 (pulumi.Input[str])

project = None

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

The URI of the created resource.

static get(resource_name, id, opts=None, affinity_cookie_ttl_sec=None, backends=None, cdn_policy=None, connection_draining_timeout_sec=None, creation_timestamp=None, custom_request_headers=None, description=None, enable_cdn=None, fingerprint=None, health_checks=None, iap=None, load_balancing_scheme=None, name=None, port_name=None, project=None, protocol=None, security_policy=None, self_link=None, session_affinity=None, timeout_sec=None)

Get an existing BackendService resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • project (pulumi.Input[str]) – The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

  • self_link (pulumi.Input[str]) – The URI of the created resource.

The backends object supports the following:

  • balancingMode (pulumi.Input[str])

  • capacityScaler (pulumi.Input[float])

  • description (pulumi.Input[str])

  • group (pulumi.Input[str])

  • maxConnections (pulumi.Input[float])

  • maxConnectionsPerEndpoint (pulumi.Input[float])

  • maxConnectionsPerInstance (pulumi.Input[float])

  • maxRate (pulumi.Input[float])

  • maxRatePerEndpoint (pulumi.Input[float])

  • maxRatePerInstance (pulumi.Input[float])

  • maxUtilization (pulumi.Input[float])

The cdn_policy object supports the following:

  • cacheKeyPolicy (pulumi.Input[dict])

    • includeHost (pulumi.Input[bool])

    • includeProtocol (pulumi.Input[bool])

    • includeQueryString (pulumi.Input[bool])

    • queryStringBlacklists (pulumi.Input[list])

    • queryStringWhitelists (pulumi.Input[list])

  • signedUrlCacheMaxAgeSec (pulumi.Input[float])

The iap object supports the following:

  • oauth2ClientId (pulumi.Input[str])

  • oauth2ClientSecret (pulumi.Input[str])

  • oauth2ClientSecretSha256 (pulumi.Input[str])

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_gcp.compute.BackendServiceSignedUrlKey(resource_name, opts=None, backend_service=None, key_value=None, name=None, project=None, __props__=None, __name__=None, __opts__=None)

A key for signing Cloud CDN signed URLs for Backend Services.

To get more information about BackendServiceSignedUrlKey, see:

Warning: All arguments including the key’s value will be stored in the raw state as plain-text. Read more about sensitive data in state. Because the API does not return the sensitive key value, we cannot confirm or reverse changes to a key outside of this provider.

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • project (pulumi.Input[str]) – The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

project = None

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

static get(resource_name, id, opts=None, backend_service=None, key_value=None, name=None, project=None)

Get an existing BackendServiceSignedUrlKey resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • project (pulumi.Input[str]) – The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_gcp.compute.Disk(resource_name, opts=None, description=None, disk_encryption_key=None, image=None, labels=None, name=None, physical_block_size_bytes=None, project=None, resource_policies=None, size=None, snapshot=None, source_image_encryption_key=None, source_snapshot_encryption_key=None, type=None, zone=None, __props__=None, __name__=None, __opts__=None)

Persistent disks are durable storage devices that function similarly to the physical disks in a desktop or a server. Compute Engine manages the hardware behind these devices to ensure data redundancy and optimize performance for you. Persistent disks are available as either standard hard disk drives (HDD) or solid-state drives (SSD).

Persistent disks are located independently from your virtual machine instances, so you can detach or move persistent disks to keep your data even after you delete your instances. Persistent disk performance scales automatically with size, so you can resize your existing persistent disks or add more persistent disks to an instance to meet your performance and storage space requirements.

Add a persistent disk to your instance when you need reliable and affordable storage with consistent performance characteristics.

To get more information about Disk, see:

Warning: All arguments including the disk encryption key will be stored in the raw state as plain-text. Read more about sensitive data in state.

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • project (pulumi.Input[str]) – The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

The disk_encryption_key object supports the following:

  • kmsKeySelfLink (pulumi.Input[str])

  • rawKey (pulumi.Input[str])

  • sha256 (pulumi.Input[str])

The source_image_encryption_key object supports the following:

  • kmsKeySelfLink (pulumi.Input[str])

  • rawKey (pulumi.Input[str])

  • sha256 (pulumi.Input[str])

The source_snapshot_encryption_key object supports the following:

  • kmsKeySelfLink (pulumi.Input[str])

  • rawKey (pulumi.Input[str])

  • sha256 (pulumi.Input[str])

project = None

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

The URI of the created resource.

static get(resource_name, id, opts=None, creation_timestamp=None, description=None, disk_encryption_key=None, image=None, label_fingerprint=None, labels=None, last_attach_timestamp=None, last_detach_timestamp=None, name=None, physical_block_size_bytes=None, project=None, resource_policies=None, self_link=None, size=None, snapshot=None, source_image_encryption_key=None, source_image_id=None, source_snapshot_encryption_key=None, source_snapshot_id=None, type=None, users=None, zone=None)

Get an existing Disk resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • project (pulumi.Input[str]) – The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

  • self_link (pulumi.Input[str]) – The URI of the created resource.

The disk_encryption_key object supports the following:

  • kmsKeySelfLink (pulumi.Input[str])

  • rawKey (pulumi.Input[str])

  • sha256 (pulumi.Input[str])

The source_image_encryption_key object supports the following:

  • kmsKeySelfLink (pulumi.Input[str])

  • rawKey (pulumi.Input[str])

  • sha256 (pulumi.Input[str])

The source_snapshot_encryption_key object supports the following:

  • kmsKeySelfLink (pulumi.Input[str])

  • rawKey (pulumi.Input[str])

  • sha256 (pulumi.Input[str])

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_gcp.compute.ExternalVpnGateway(resource_name, opts=None, description=None, interfaces=None, name=None, project=None, redundancy_type=None, __props__=None, __name__=None, __opts__=None)

Represents a VPN gateway managed outside of GCP.

To get more information about ExternalVpnGateway, see:

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • project (pulumi.Input[str]) – The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

The interfaces object supports the following:

  • id (pulumi.Input[float])

  • ip_address (pulumi.Input[str])

project = None

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

static get(resource_name, id, opts=None, description=None, interfaces=None, name=None, project=None, redundancy_type=None, self_link=None)

Get an existing ExternalVpnGateway resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • project (pulumi.Input[str]) – The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

The interfaces object supports the following:

  • id (pulumi.Input[float])

  • ip_address (pulumi.Input[str])

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_gcp.compute.Firewall(resource_name, opts=None, allows=None, denies=None, description=None, destination_ranges=None, direction=None, disabled=None, enable_logging=None, name=None, network=None, priority=None, project=None, source_ranges=None, source_service_accounts=None, source_tags=None, target_service_accounts=None, target_tags=None, __props__=None, __name__=None, __opts__=None)

Each network has its own firewall controlling access to and from the instances.

All traffic to instances, even from other instances, is blocked by the firewall unless firewall rules are created to allow it.

The default network has automatically created firewall rules that are shown in default firewall rules. No manually created network has automatically created firewall rules except for a default “allow” rule for outgoing traffic and a default “deny” for incoming traffic. For all networks except the default network, you must create any firewall rules you need.

To get more information about Firewall, see:

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • project (pulumi.Input[str]) – The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

The allows object supports the following:

  • ports (pulumi.Input[list])

  • protocol (pulumi.Input[str])

The denies object supports the following:

  • ports (pulumi.Input[list])

  • protocol (pulumi.Input[str])

project = None

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

The URI of the created resource.

static get(resource_name, id, opts=None, allows=None, creation_timestamp=None, denies=None, description=None, destination_ranges=None, direction=None, disabled=None, enable_logging=None, name=None, network=None, priority=None, project=None, self_link=None, source_ranges=None, source_service_accounts=None, source_tags=None, target_service_accounts=None, target_tags=None)

Get an existing Firewall resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • project (pulumi.Input[str]) – The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

  • self_link (pulumi.Input[str]) – The URI of the created resource.

The allows object supports the following:

  • ports (pulumi.Input[list])

  • protocol (pulumi.Input[str])

The denies object supports the following:

  • ports (pulumi.Input[list])

  • protocol (pulumi.Input[str])

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_gcp.compute.ForwardingRule(resource_name, opts=None, all_ports=None, backend_service=None, description=None, ip_address=None, ip_protocol=None, ip_version=None, labels=None, load_balancing_scheme=None, name=None, network=None, network_tier=None, port_range=None, ports=None, project=None, region=None, service_label=None, subnetwork=None, target=None, __props__=None, __name__=None, __opts__=None)

A ForwardingRule resource. A ForwardingRule resource specifies which pool of target virtual machines to forward a packet to if it matches the given [IPAddress, IPProtocol, portRange] tuple.

To get more information about ForwardingRule, see:

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • project (pulumi.Input[str]) – The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

project = None

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

The URI of the created resource.

static get(resource_name, id, opts=None, all_ports=None, backend_service=None, creation_timestamp=None, description=None, ip_address=None, ip_protocol=None, ip_version=None, label_fingerprint=None, labels=None, load_balancing_scheme=None, name=None, network=None, network_tier=None, port_range=None, ports=None, project=None, region=None, self_link=None, service_label=None, service_name=None, subnetwork=None, target=None)

Get an existing ForwardingRule resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • project (pulumi.Input[str]) – The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

  • self_link (pulumi.Input[str]) – The URI of the created resource.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_gcp.compute.GetAddressResult(address=None, name=None, project=None, region=None, self_link=None, status=None, id=None)

A collection of values returned by getAddress.

address = None

The IP of the created resource.

The URI of the created resource.

status = None

Indicates if the address is used. Possible values are: RESERVED or IN_USE.

id = None

id is the provider-assigned unique ID for this managed resource.

class pulumi_gcp.compute.GetBackendServiceResult(affinity_cookie_ttl_sec=None, backends=None, cdn_policies=None, connection_draining_timeout_sec=None, creation_timestamp=None, custom_request_headers=None, description=None, enable_cdn=None, fingerprint=None, health_checks=None, iaps=None, load_balancing_scheme=None, name=None, port_name=None, project=None, protocol=None, security_policy=None, self_link=None, session_affinity=None, timeout_sec=None, id=None)

A collection of values returned by getBackendService.

backends = None

The set of backends that serve this Backend Service.

connection_draining_timeout_sec = None

Time for which instance will be drained (not accept new connections, but still work to finish started ones).

description = None

Textual description for the Backend Service.

enable_cdn = None

Whether or not Cloud CDN is enabled on the Backend Service.

fingerprint = None

The fingerprint of the Backend Service.

health_checks = None

The set of HTTP/HTTPS health checks used by the Backend Service.

port_name = None

The name of a service that has been added to an instance group in this backend.

protocol = None

The protocol for incoming requests.

The URI of the Backend Service.

session_affinity = None

The Backend Service session stickyness configuration.

timeout_sec = None

The number of seconds to wait for a backend to respond to a request before considering the request failed.

id = None

id is the provider-assigned unique ID for this managed resource.

class pulumi_gcp.compute.GetCertificateResult(certificate=None, certificate_id=None, creation_timestamp=None, description=None, name=None, name_prefix=None, private_key=None, project=None, self_link=None, id=None)

A collection of values returned by getCertificate.

id = None

id is the provider-assigned unique ID for this managed resource.

class pulumi_gcp.compute.GetDefaultServiceAccountResult(display_name=None, email=None, name=None, project=None, unique_id=None, id=None)

A collection of values returned by getDefaultServiceAccount.

display_name = None

The display name for the service account.

email = None

Email address of the default service account used by VMs running in this project

name = None

The fully-qualified name of the service account.

unique_id = None

The unique id of the service account.

id = None

id is the provider-assigned unique ID for this managed resource.

class pulumi_gcp.compute.GetForwardingRuleResult(backend_service=None, description=None, ip_address=None, ip_protocol=None, load_balancing_scheme=None, name=None, network=None, port_range=None, ports=None, project=None, region=None, self_link=None, subnetwork=None, target=None, id=None)

A collection of values returned by getForwardingRule.

backend_service = None

Backend service, if this forwarding rule has one.

description = None

Description of this forwarding rule.

ip_address = None

IP address of this forwarding rule.

ip_protocol = None

IP protocol of this forwarding rule.

load_balancing_scheme = None

Type of load balancing of this forwarding rule.

network = None

Network of this forwarding rule.

port_range = None

Port range, if this forwarding rule has one.

ports = None

List of ports to use for internal load balancing, if this forwarding rule has any.

region = None

Region of this forwarding rule.

The URI of the resource.

subnetwork = None

Subnetwork of this forwarding rule.

target = None

URL of the target pool, if this forwarding rule has one.

id = None

id is the provider-assigned unique ID for this managed resource.

class pulumi_gcp.compute.GetGlobalAddressResult(address=None, name=None, project=None, self_link=None, status=None, id=None)

A collection of values returned by getGlobalAddress.

address = None

The IP of the created resource.

The URI of the created resource.

status = None

Indicates if the address is used. Possible values are: RESERVED or IN_USE.

id = None

id is the provider-assigned unique ID for this managed resource.

class pulumi_gcp.compute.GetImageResult(archive_size_bytes=None, creation_timestamp=None, description=None, disk_size_gb=None, family=None, image_encryption_key_sha256=None, image_id=None, label_fingerprint=None, labels=None, licenses=None, name=None, project=None, self_link=None, source_disk=None, source_disk_encryption_key_sha256=None, source_disk_id=None, source_image_id=None, status=None, id=None)

A collection of values returned by getImage.

archive_size_bytes = None

The size of the image tar.gz archive stored in Google Cloud Storage in bytes.

creation_timestamp = None

The creation timestamp in RFC3339 text format.

description = None

An optional description of this image.

disk_size_gb = None

The size of the image when restored onto a persistent disk in gigabytes.

family = None

The family name of the image.

image_encryption_key_sha256 = None

The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this image.

image_id = None

The unique identifier for the image.

label_fingerprint = None

A fingerprint for the labels being applied to this image.

labels = None

A map of labels applied to this image.

licenses = None

A list of applicable license URI.

name = None

The name of the image.

The URI of the image.

source_disk = None

The URL of the source disk used to create this image.

source_disk_encryption_key_sha256 = None

The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this image.

source_disk_id = None

The ID value of the disk used to create this image.

source_image_id = None

The ID value of the image used to create this image.

status = None

The status of the image. Possible values are FAILED, PENDING, or READY.

id = None

id is the provider-assigned unique ID for this managed resource.

class pulumi_gcp.compute.GetInstanceGroupResult(description=None, instances=None, name=None, named_ports=None, network=None, project=None, self_link=None, size=None, zone=None, id=None)

A collection of values returned by getInstanceGroup.

description = None

Textual description of the instance group.

instances = None

List of instances in the group.

named_ports = None

List of named ports in the group.

network = None

The URL of the network the instance group is in.

The URI of the resource.

size = None

The number of instances in the group.

id = None

id is the provider-assigned unique ID for this managed resource.

class pulumi_gcp.compute.GetInstanceResult(allow_stopping_for_update=None, attached_disks=None, boot_disks=None, can_ip_forward=None, cpu_platform=None, deletion_protection=None, description=None, disks=None, guest_accelerators=None, hostname=None, instance_id=None, label_fingerprint=None, labels=None, machine_type=None, metadata=None, metadata_fingerprint=None, metadata_startup_script=None, min_cpu_platform=None, name=None, network_interfaces=None, project=None, schedulings=None, scratch_disks=None, self_link=None, service_accounts=None, shielded_instance_configs=None, tags=None, tags_fingerprint=None, zone=None, id=None)

A collection of values returned by getInstance.

attached_disks = None

List of disks attached to the instance. Structure is documented below.

boot_disks = None

The boot disk for the instance. Structure is documented below.

can_ip_forward = None

Whether sending and receiving of packets with non-matching source or destination IPs is allowed.

cpu_platform = None

The CPU platform used by this instance.

deletion_protection = None

Whether deletion protection is enabled on this instance.

description = None

A brief description of the resource.

guest_accelerators = None

List of the type and count of accelerator cards attached to the instance. Structure is documented below.

instance_id = None

The server-assigned unique identifier of this instance.

label_fingerprint = None

The unique fingerprint of the labels.

labels = None

A set of key/value label pairs assigned to the instance.

machine_type = None

The machine type to create.

metadata = None

Metadata key/value pairs made available within the instance.

metadata_fingerprint = None

The unique fingerprint of the metadata.

min_cpu_platform = None

The minimum CPU platform specified for the VM instance.

network_interfaces = None

The networks attached to the instance. Structure is documented below.

schedulings = None

The scheduling strategy being used by the instance.

scratch_disks = None

The scratch disks attached to the instance. Structure is documented below.

The URI of the created resource.

service_accounts = None

The service account to attach to the instance. Structure is documented below.

shielded_instance_configs = None

The shielded vm config being used by the instance. Structure is documented below.

tags = None

The list of tags attached to the instance.

tags_fingerprint = None

The unique fingerprint of the tags.

id = None

id is the provider-assigned unique ID for this managed resource.

class pulumi_gcp.compute.GetLBIPRangesResult(http_ssl_tcp_internals=None, networks=None, id=None)

A collection of values returned by getLBIPRanges.

http_ssl_tcp_internals = None

The IP ranges used for health checks when HTTP(S), SSL proxy, TCP proxy, and Internal load balancing is used

networks = None

The IP ranges used for health checks when Network load balancing is used

id = None

id is the provider-assigned unique ID for this managed resource.

class pulumi_gcp.compute.GetNetblockIPRangesResult(cidr_blocks=None, cidr_blocks_ipv4s=None, cidr_blocks_ipv6s=None, id=None)

A collection of values returned by getNetblockIPRanges.

cidr_blocks = None

Retrieve list of all CIDR blocks.

cidr_blocks_ipv4s = None

Retrieve list of the IP4 CIDR blocks

cidr_blocks_ipv6s = None

Retrieve list of the IP6 CIDR blocks.

id = None

id is the provider-assigned unique ID for this managed resource.

class pulumi_gcp.compute.GetNetworkResult(description=None, gateway_ipv4=None, name=None, project=None, self_link=None, subnetworks_self_links=None, id=None)

A collection of values returned by getNetwork.

description = None

Description of this network.

gateway_ipv4 = None

The IP address of the gateway.

The URI of the resource.

the list of subnetworks which belong to the network

id = None

id is the provider-assigned unique ID for this managed resource.

class pulumi_gcp.compute.GetNodeTypesResult(names=None, project=None, zone=None, id=None)

A collection of values returned by getNodeTypes.

names = None

A list of node types available in the given zone and project.

id = None

id is the provider-assigned unique ID for this managed resource.

class pulumi_gcp.compute.GetRegionInstanceGroupResult(instances=None, name=None, project=None, region=None, self_link=None, size=None, id=None)

A collection of values returned by getRegionInstanceGroup.

instances = None

List of instances in the group, as a list of resources, each containing:

name = None

String port name

size = None

The number of instances in the group.

id = None

id is the provider-assigned unique ID for this managed resource.

class pulumi_gcp.compute.GetRegionsResult(names=None, project=None, status=None, id=None)

A collection of values returned by getRegions.

names = None

A list of regions available in the given project

id = None

id is the provider-assigned unique ID for this managed resource.

class pulumi_gcp.compute.GetSSLPolicyResult(creation_timestamp=None, custom_features=None, description=None, enabled_features=None, fingerprint=None, min_tls_version=None, name=None, profile=None, project=None, self_link=None, id=None)

A collection of values returned by getSSLPolicy.

custom_features = None

If the profile is CUSTOM, these are the custom encryption ciphers supported by the profile. If the profile is not CUSTOM, this attribute will be empty.

description = None

Description of this SSL Policy.

enabled_features = None

The set of enabled encryption ciphers as a result of the policy config

fingerprint = None

Fingerprint of this resource.

min_tls_version = None

The minimum supported TLS version of this policy.

profile = None

The Google-curated or custom profile used by this policy.

The URI of the created resource.

id = None

id is the provider-assigned unique ID for this managed resource.

class pulumi_gcp.compute.GetSubnetworkResult(description=None, gateway_address=None, ip_cidr_range=None, name=None, network=None, private_ip_google_access=None, project=None, region=None, secondary_ip_ranges=None, self_link=None, id=None)

A collection of values returned by getSubnetwork.

description = None

Description of this subnetwork.

gateway_address = None

The IP address of the gateway.

ip_cidr_range = None

The range of IP addresses belonging to this subnetwork secondary range.

network = None

The network name or resource link to the parent network of this subnetwork.

private_ip_google_access = None

Whether the VMs in this subnet can access Google services without assigned external IP addresses.

secondary_ip_ranges = None

An array of configurations for secondary IP ranges for VM instances contained in this subnetwork. Structure is documented below.

id = None

id is the provider-assigned unique ID for this managed resource.

class pulumi_gcp.compute.GetVPNGatewayResult(description=None, name=None, network=None, project=None, region=None, self_link=None, id=None)

A collection of values returned by getVPNGateway.

description = None

Description of this VPN gateway.

network = None

The network of this VPN gateway.

region = None

Region of this VPN gateway.

The URI of the resource.

id = None

id is the provider-assigned unique ID for this managed resource.

class pulumi_gcp.compute.GetZonesResult(names=None, project=None, region=None, status=None, id=None)

A collection of values returned by getZones.

names = None

A list of zones available in the given region

id = None

id is the provider-assigned unique ID for this managed resource.

class pulumi_gcp.compute.GlobalAddress(resource_name, opts=None, address=None, address_type=None, description=None, ip_version=None, labels=None, name=None, network=None, prefix_length=None, project=None, purpose=None, __props__=None, __name__=None, __opts__=None)

Represents a Global Address resource. Global addresses are used for HTTP(S) load balancing.

To get more information about GlobalAddress, see:

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • project (pulumi.Input[str]) – The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

project = None

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

The URI of the created resource.

static get(resource_name, id, opts=None, address=None, address_type=None, creation_timestamp=None, description=None, ip_version=None, label_fingerprint=None, labels=None, name=None, network=None, prefix_length=None, project=None, purpose=None, self_link=None)

Get an existing GlobalAddress resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • project (pulumi.Input[str]) – The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

  • self_link (pulumi.Input[str]) – The URI of the created resource.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_gcp.compute.GlobalForwardingRule(resource_name, opts=None, description=None, ip_address=None, ip_protocol=None, ip_version=None, labels=None, load_balancing_scheme=None, name=None, network=None, port_range=None, project=None, target=None, __props__=None, __name__=None, __opts__=None)

Represents a GlobalForwardingRule resource. Global forwarding rules are used to forward traffic to the correct load balancer for HTTP load balancing. Global forwarding rules can only be used for HTTP load balancing.

For more information, see https://cloud.google.com/compute/docs/load-balancing/http/

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • project (pulumi.Input[str]) – The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

project = None

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

The URI of the created resource.

static get(resource_name, id, opts=None, description=None, ip_address=None, ip_protocol=None, ip_version=None, label_fingerprint=None, labels=None, load_balancing_scheme=None, name=None, network=None, port_range=None, project=None, self_link=None, target=None)

Get an existing GlobalForwardingRule resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • project (pulumi.Input[str]) – The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

  • self_link (pulumi.Input[str]) – The URI of the created resource.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_gcp.compute.HaVpnGateway(resource_name, opts=None, description=None, name=None, network=None, project=None, region=None, __props__=None, __name__=None, __opts__=None)

Represents a VPN gateway running in GCP. This virtual device is managed by Google, but used only by you. This type of VPN Gateway allows for the creation of VPN solutions with higher availability than classic Target VPN Gateways.

To get more information about HaVpnGateway, see:

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • project (pulumi.Input[str]) – The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

project = None

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

The URI of the created resource.

static get(resource_name, id, opts=None, description=None, name=None, network=None, project=None, region=None, self_link=None, vpn_interfaces=None)

Get an existing HaVpnGateway resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • project (pulumi.Input[str]) – The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

  • self_link (pulumi.Input[str]) – The URI of the created resource.

The vpn_interfaces object supports the following:

  • id (pulumi.Input[float])

  • ip_address (pulumi.Input[str])

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_gcp.compute.HealthCheck(resource_name, opts=None, check_interval_sec=None, description=None, healthy_threshold=None, http_health_check=None, https_health_check=None, name=None, project=None, ssl_health_check=None, tcp_health_check=None, timeout_sec=None, unhealthy_threshold=None, __props__=None, __name__=None, __opts__=None)

Health Checks determine whether instances are responsive and able to do work. They are an important part of a comprehensive load balancing configuration, as they enable monitoring instances behind load balancers.

Health Checks poll instances at a specified interval. Instances that do not respond successfully to some number of probes in a row are marked as unhealthy. No new connections are sent to unhealthy instances, though existing connections will continue. The health check will continue to poll unhealthy instances. If an instance later responds successfully to some number of consecutive probes, it is marked healthy again and can receive new connections.

To get more information about HealthCheck, see:

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • project (pulumi.Input[str]) – The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

The http_health_check object supports the following:

  • host (pulumi.Input[str])

  • port (pulumi.Input[float])

  • port_name (pulumi.Input[str])

  • portSpecification (pulumi.Input[str])

  • proxy_header (pulumi.Input[str])

  • request_path (pulumi.Input[str])

  • response (pulumi.Input[str])

The https_health_check object supports the following:

  • host (pulumi.Input[str])

  • port (pulumi.Input[float])

  • port_name (pulumi.Input[str])

  • portSpecification (pulumi.Input[str])

  • proxy_header (pulumi.Input[str])

  • request_path (pulumi.Input[str])

  • response (pulumi.Input[str])

The ssl_health_check object supports the following:

  • port (pulumi.Input[float])

  • port_name (pulumi.Input[str])

  • portSpecification (pulumi.Input[str])

  • proxy_header (pulumi.Input[str])

  • request (pulumi.Input[str])

  • response (pulumi.Input[str])

The tcp_health_check object supports the following:

  • port (pulumi.Input[float])

  • port_name (pulumi.Input[str])

  • portSpecification (pulumi.Input[str])

  • proxy_header (pulumi.Input[str])

  • request (pulumi.Input[str])

  • response (pulumi.Input[str])

project = None

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

The URI of the created resource.

static get(resource_name, id, opts=None, check_interval_sec=None, creation_timestamp=None, description=None, healthy_threshold=None, http_health_check=None, https_health_check=None, name=None, project=None, self_link=None, ssl_health_check=None, tcp_health_check=None, timeout_sec=None, type=None, unhealthy_threshold=None)

Get an existing HealthCheck resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • project (pulumi.Input[str]) – The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

  • self_link (pulumi.Input[str]) – The URI of the created resource.

The http_health_check object supports the following:

  • host (pulumi.Input[str])

  • port (pulumi.Input[float])

  • port_name (pulumi.Input[str])

  • portSpecification (pulumi.Input[str])

  • proxy_header (pulumi.Input[str])

  • request_path (pulumi.Input[str])

  • response (pulumi.Input[str])

The https_health_check object supports the following:

  • host (pulumi.Input[str])

  • port (pulumi.Input[float])

  • port_name (pulumi.Input[str])

  • portSpecification (pulumi.Input[str])

  • proxy_header (pulumi.Input[str])

  • request_path (pulumi.Input[str])

  • response (pulumi.Input[str])

The ssl_health_check object supports the following:

  • port (pulumi.Input[float])

  • port_name (pulumi.Input[str])

  • portSpecification (pulumi.Input[str])

  • proxy_header (pulumi.Input[str])

  • request (pulumi.Input[str])

  • response (pulumi.Input[str])

The tcp_health_check object supports the following:

  • port (pulumi.Input[float])

  • port_name (pulumi.Input[str])

  • portSpecification (pulumi.Input[str])

  • proxy_header (pulumi.Input[str])

  • request (pulumi.Input[str])

  • response (pulumi.Input[str])

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_gcp.compute.HttpHealthCheck(resource_name, opts=None, check_interval_sec=None, description=None, healthy_threshold=None, host=None, name=None, port=None, project=None, request_path=None, timeout_sec=None, unhealthy_threshold=None, __props__=None, __name__=None, __opts__=None)

An HttpHealthCheck resource. This resource defines a template for how individual VMs should be checked for health, via HTTP.

Note: compute.HttpHealthCheck is a legacy health check. The newer compute.HealthCheck should be preferred for all uses except Network Load Balancers which still require the legacy version.

To get more information about HttpHealthCheck, see:

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • project (pulumi.Input[str]) – The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

project = None

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

The URI of the created resource.

static get(resource_name, id, opts=None, check_interval_sec=None, creation_timestamp=None, description=None, healthy_threshold=None, host=None, name=None, port=None, project=None, request_path=None, self_link=None, timeout_sec=None, unhealthy_threshold=None)

Get an existing HttpHealthCheck resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • project (pulumi.Input[str]) – The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

  • self_link (pulumi.Input[str]) – The URI of the created resource.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_gcp.compute.HttpsHealthCheck(resource_name, opts=None, check_interval_sec=None, description=None, healthy_threshold=None, host=None, name=None, port=None, project=None, request_path=None, timeout_sec=None, unhealthy_threshold=None, __props__=None, __name__=None, __opts__=None)

An HttpsHealthCheck resource. This resource defines a template for how individual VMs should be checked for health, via HTTPS.

Note: compute.HttpsHealthCheck is a legacy health check. The newer compute.HealthCheck should be preferred for all uses except Network Load Balancers which still require the legacy version.

To get more information about HttpsHealthCheck, see:

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • project (pulumi.Input[str]) – The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

project = None

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

The URI of the created resource.

static get(resource_name, id, opts=None, check_interval_sec=None, creation_timestamp=None, description=None, healthy_threshold=None, host=None, name=None, port=None, project=None, request_path=None, self_link=None, timeout_sec=None, unhealthy_threshold=None)

Get an existing HttpsHealthCheck resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • project (pulumi.Input[str]) – The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

  • self_link (pulumi.Input[str]) – The URI of the created resource.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_gcp.compute.Image(resource_name, opts=None, description=None, disk_size_gb=None, family=None, labels=None, licenses=None, name=None, project=None, raw_disk=None, source_disk=None, __props__=None, __name__=None, __opts__=None)

Represents an Image resource.

Google Compute Engine uses operating system images to create the root persistent disks for your instances. You specify an image when you create an instance. Images contain a boot loader, an operating system, and a root file system. Linux operating system images are also capable of running containers on Compute Engine.

Images can be either public or custom.

Public images are provided and maintained by Google, open-source communities, and third-party vendors. By default, all projects have access to these images and can use them to create instances. Custom images are available only to your project. You can create a custom image from root persistent disks and other images. Then, use the custom image to create an instance.

To get more information about Image, see:

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • project (pulumi.Input[str]) – The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

The raw_disk object supports the following:

  • containerType (pulumi.Input[str])

  • sha1 (pulumi.Input[str])

  • source (pulumi.Input[str])

project = None

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

The URI of the created resource.

static get(resource_name, id, opts=None, archive_size_bytes=None, creation_timestamp=None, description=None, disk_size_gb=None, family=None, label_fingerprint=None, labels=None, licenses=None, name=None, project=None, raw_disk=None, self_link=None, source_disk=None)

Get an existing Image resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • project (pulumi.Input[str]) – The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

  • self_link (pulumi.Input[str]) – The URI of the created resource.

The raw_disk object supports the following:

  • containerType (pulumi.Input[str])

  • sha1 (pulumi.Input[str])

  • source (pulumi.Input[str])

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_gcp.compute.Instance(resource_name, opts=None, allow_stopping_for_update=None, attached_disks=None, boot_disk=None, can_ip_forward=None, deletion_protection=None, description=None, guest_accelerators=None, hostname=None, labels=None, machine_type=None, metadata=None, metadata_startup_script=None, min_cpu_platform=None, name=None, network_interfaces=None, project=None, scheduling=None, scratch_disks=None, service_account=None, shielded_instance_config=None, tags=None, zone=None, __props__=None, __name__=None, __opts__=None)

Manages a VM instance resource within GCE. For more information see the official documentation and API.

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • allow_stopping_for_update (pulumi.Input[bool]) – If true, allows this provider to stop the instance to update its properties. If you try to update a property that requires stopping the instance without setting this field, the update will fail.

  • attached_disks (pulumi.Input[list]) – Additional disks to attach to the instance. Can be repeated multiple times for multiple disks. Structure is documented below.

  • boot_disk (pulumi.Input[dict]) – The boot disk for the instance. Structure is documented below.

  • can_ip_forward (pulumi.Input[bool]) – Whether to allow sending and receiving of packets with non-matching source or destination IPs. This defaults to false.

  • deletion_protection (pulumi.Input[bool]) – Enable deletion protection on this instance. Defaults to false. Note: you must disable deletion protection before removing the resource, or the instance cannot be deleted and the deployment will not complete successfully.

  • description (pulumi.Input[str]) – A brief description of this resource.

  • guest_accelerators (pulumi.Input[list]) – List of the type and count of accelerator cards attached to the instance. Structure documented below. Note: GPU accelerators can only be used with on_host_maintenance option set to TERMINATE.

  • hostname (pulumi.Input[str]) – A custom hostname for the instance. Must be a fully qualified DNS name and RFC-1035-valid. Valid format is a series of labels 1-63 characters long matching the regular expression a-z, concatenated with periods. The entire hostname must not exceed 253 characters. Changing this forces a new resource to be created.

  • labels (pulumi.Input[dict]) – A set of key/value label pairs to assign to the instance.

  • machine_type (pulumi.Input[str]) – The machine type to create.

  • metadata (pulumi.Input[dict]) – Metadata key/value pairs to make available from within the instance. Ssh keys attached in the Cloud Console will be removed. Add them to your config in order to keep them attached to your instance.

  • metadata_startup_script (pulumi.Input[str]) – An alternative to using the startup-script metadata key, except this one forces the instance to be recreated (thus re-running the script) if it is changed. This replaces the startup-script metadata key on the created instance and thus the two mechanisms are not allowed to be used simultaneously.

  • min_cpu_platform (pulumi.Input[str]) – Specifies a minimum CPU platform for the VM instance. Applicable values are the friendly names of CPU platforms, such as Intel Haswell or Intel Skylake. See the complete list here. Note: allow_stopping_for_update must be set to true in order to update this field.

  • name (pulumi.Input[str]) – A unique name for the resource, required by GCE. Changing this forces a new resource to be created.

  • network_interfaces (pulumi.Input[list]) – Networks to attach to the instance. This can be specified multiple times. Structure is documented below.

  • project (pulumi.Input[str]) – The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

  • scheduling (pulumi.Input[dict]) – The scheduling strategy to use. More details about this configuration option are detailed below.

  • scratch_disks (pulumi.Input[list]) – Scratch disks to attach to the instance. This can be specified multiple times for multiple scratch disks. Structure is documented below.

  • service_account (pulumi.Input[dict]) – Service account to attach to the instance. Structure is documented below. Note: allow_stopping_for_update must be set to true in order to update this field.

  • shielded_instance_config (pulumi.Input[dict]) –

    Enable Shielded VM on this instance. Shielded VM provides verifiable integrity to prevent against malware and rootkits. Defaults to disabled. Structure is documented below. Note: shielded_instance_config can only be used with boot images with shielded vm support. See the complete list here.

  • tags (pulumi.Input[list]) – A list of tags to attach to the instance.

  • zone (pulumi.Input[str]) – The zone that the machine should be created in.

The attached_disks object supports the following:

  • device_name (pulumi.Input[str])

  • diskEncryptionKeyRaw (pulumi.Input[str])

  • diskEncryptionKeySha256 (pulumi.Input[str])

  • kmsKeySelfLink (pulumi.Input[str])

  • mode (pulumi.Input[str])

  • source (pulumi.Input[str])

The boot_disk object supports the following:

  • autoDelete (pulumi.Input[bool])

  • device_name (pulumi.Input[str])

  • diskEncryptionKeyRaw (pulumi.Input[str])

  • diskEncryptionKeySha256 (pulumi.Input[str])

  • initializeParams (pulumi.Input[dict])

    • image (pulumi.Input[str])

    • labels (pulumi.Input[dict]) - A set of key/value label pairs to assign to the instance.

    • size (pulumi.Input[float])

    • type (pulumi.Input[str])

  • kmsKeySelfLink (pulumi.Input[str])

  • source (pulumi.Input[str])

The guest_accelerators object supports the following:

  • count (pulumi.Input[float])

  • type (pulumi.Input[str])

The network_interfaces object supports the following:

  • accessConfigs (pulumi.Input[list])

    • natIp (pulumi.Input[str])

    • network_tier (pulumi.Input[str])

    • publicPtrDomainName (pulumi.Input[str])

  • aliasIpRanges (pulumi.Input[list])

    • ip_cidr_range (pulumi.Input[str])

    • subnetworkRangeName (pulumi.Input[str])

  • name (pulumi.Input[str]) - A unique name for the resource, required by GCE. Changing this forces a new resource to be created.

  • network (pulumi.Input[str])

  • networkIp (pulumi.Input[str])

  • subnetwork (pulumi.Input[str])

  • subnetworkProject (pulumi.Input[str])

The scheduling object supports the following:

  • automaticRestart (pulumi.Input[bool])

  • nodeAffinities (pulumi.Input[list])

    • key (pulumi.Input[str])

    • operator (pulumi.Input[str])

    • values (pulumi.Input[list])

  • onHostMaintenance (pulumi.Input[str])

  • preemptible (pulumi.Input[bool])

The scratch_disks object supports the following:

  • interface (pulumi.Input[str])

The service_account object supports the following:

  • email (pulumi.Input[str])

  • scopes (pulumi.Input[list])

The shielded_instance_config object supports the following:

  • enableIntegrityMonitoring (pulumi.Input[bool])

  • enableSecureBoot (pulumi.Input[bool])

  • enableVtpm (pulumi.Input[bool])

allow_stopping_for_update = None

If true, allows this provider to stop the instance to update its properties. If you try to update a property that requires stopping the instance without setting this field, the update will fail.

attached_disks = None

Additional disks to attach to the instance. Can be repeated multiple times for multiple disks. Structure is documented below.

  • device_name (str)

  • diskEncryptionKeyRaw (str)

  • diskEncryptionKeySha256 (str)

  • kmsKeySelfLink (str)

  • mode (str)

  • source (str)

boot_disk = None

The boot disk for the instance. Structure is documented below.

  • autoDelete (bool)

  • device_name (str)

  • diskEncryptionKeyRaw (str)

  • diskEncryptionKeySha256 (str)

  • initializeParams (dict)

    • image (str)

    • labels (dict) - A set of key/value label pairs to assign to the instance.

    • size (float)

    • type (str)

  • kmsKeySelfLink (str)

  • source (str)

can_ip_forward = None

Whether to allow sending and receiving of packets with non-matching source or destination IPs. This defaults to false.

cpu_platform = None

The CPU platform used by this instance.

deletion_protection = None

Enable deletion protection on this instance. Defaults to false. Note: you must disable deletion protection before removing the resource, or the instance cannot be deleted and the deployment will not complete successfully.

description = None

A brief description of this resource.

guest_accelerators = None

List of the type and count of accelerator cards attached to the instance. Structure documented below. Note: GPU accelerators can only be used with on_host_maintenance option set to TERMINATE.

  • count (float)

  • type (str)

hostname = None

A custom hostname for the instance. Must be a fully qualified DNS name and RFC-1035-valid. Valid format is a series of labels 1-63 characters long matching the regular expression a-z, concatenated with periods. The entire hostname must not exceed 253 characters. Changing this forces a new resource to be created.

instance_id = None

The server-assigned unique identifier of this instance.

label_fingerprint = None

The unique fingerprint of the labels.

labels = None

A set of key/value label pairs to assign to the instance.

machine_type = None

The machine type to create.

metadata = None

Metadata key/value pairs to make available from within the instance. Ssh keys attached in the Cloud Console will be removed. Add them to your config in order to keep them attached to your instance.

metadata_fingerprint = None

The unique fingerprint of the metadata.

metadata_startup_script = None

An alternative to using the startup-script metadata key, except this one forces the instance to be recreated (thus re-running the script) if it is changed. This replaces the startup-script metadata key on the created instance and thus the two mechanisms are not allowed to be used simultaneously.

min_cpu_platform = None

Specifies a minimum CPU platform for the VM instance. Applicable values are the friendly names of CPU platforms, such as Intel Haswell or Intel Skylake. See the complete list here. Note: allow_stopping_for_update must be set to true in order to update this field.

name = None

A unique name for the resource, required by GCE. Changing this forces a new resource to be created.

network_interfaces = None

Networks to attach to the instance. This can be specified multiple times. Structure is documented below.

  • accessConfigs (list)

    • natIp (str)

    • network_tier (str)

    • publicPtrDomainName (str)

  • aliasIpRanges (list)

    • ip_cidr_range (str)

    • subnetworkRangeName (str)

  • name (str) - A unique name for the resource, required by GCE. Changing this forces a new resource to be created.

  • network (str)

  • networkIp (str)

  • subnetwork (str)

  • subnetworkProject (str)

project = None

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

scheduling = None

The scheduling strategy to use. More details about this configuration option are detailed below.

  • automaticRestart (bool)

  • nodeAffinities (list)

    • key (str)

    • operator (str)

    • values (list)

  • onHostMaintenance (str)

  • preemptible (bool)

scratch_disks = None

Scratch disks to attach to the instance. This can be specified multiple times for multiple scratch disks. Structure is documented below.

  • interface (str)

The URI of the created resource.

service_account = None

Service account to attach to the instance. Structure is documented below. Note: allow_stopping_for_update must be set to true in order to update this field.

  • email (str)

  • scopes (list)

shielded_instance_config = None

Enable Shielded VM on this instance. Shielded VM provides verifiable integrity to prevent against malware and rootkits. Defaults to disabled. Structure is documented below. Note: shielded_instance_config can only be used with boot images with shielded vm support. See the complete list here.

  • enableIntegrityMonitoring (bool)

  • enableSecureBoot (bool)

  • enableVtpm (bool)

tags = None

A list of tags to attach to the instance.

tags_fingerprint = None

The unique fingerprint of the tags.

zone = None

The zone that the machine should be created in.

static get(resource_name, id, opts=None, allow_stopping_for_update=None, attached_disks=None, boot_disk=None, can_ip_forward=None, cpu_platform=None, deletion_protection=None, description=None, guest_accelerators=None, hostname=None, instance_id=None, label_fingerprint=None, labels=None, machine_type=None, metadata=None, metadata_fingerprint=None, metadata_startup_script=None, min_cpu_platform=None, name=None, network_interfaces=None, project=None, scheduling=None, scratch_disks=None, self_link=None, service_account=None, shielded_instance_config=None, tags=None, tags_fingerprint=None, zone=None)

Get an existing Instance resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • allow_stopping_for_update (pulumi.Input[bool]) – If true, allows this provider to stop the instance to update its properties. If you try to update a property that requires stopping the instance without setting this field, the update will fail.

  • attached_disks (pulumi.Input[list]) – Additional disks to attach to the instance. Can be repeated multiple times for multiple disks. Structure is documented below.

  • boot_disk (pulumi.Input[dict]) – The boot disk for the instance. Structure is documented below.

  • can_ip_forward (pulumi.Input[bool]) – Whether to allow sending and receiving of packets with non-matching source or destination IPs. This defaults to false.

  • cpu_platform (pulumi.Input[str]) – The CPU platform used by this instance.

  • deletion_protection (pulumi.Input[bool]) – Enable deletion protection on this instance. Defaults to false. Note: you must disable deletion protection before removing the resource, or the instance cannot be deleted and the deployment will not complete successfully.

  • description (pulumi.Input[str]) – A brief description of this resource.

  • guest_accelerators (pulumi.Input[list]) – List of the type and count of accelerator cards attached to the instance. Structure documented below. Note: GPU accelerators can only be used with on_host_maintenance option set to TERMINATE.

  • hostname (pulumi.Input[str]) – A custom hostname for the instance. Must be a fully qualified DNS name and RFC-1035-valid. Valid format is a series of labels 1-63 characters long matching the regular expression a-z, concatenated with periods. The entire hostname must not exceed 253 characters. Changing this forces a new resource to be created.

  • instance_id (pulumi.Input[str]) – The server-assigned unique identifier of this instance.

  • label_fingerprint (pulumi.Input[str]) – The unique fingerprint of the labels.

  • labels (pulumi.Input[dict]) – A set of key/value label pairs to assign to the instance.

  • machine_type (pulumi.Input[str]) – The machine type to create.

  • metadata (pulumi.Input[dict]) – Metadata key/value pairs to make available from within the instance. Ssh keys attached in the Cloud Console will be removed. Add them to your config in order to keep them attached to your instance.

  • metadata_fingerprint (pulumi.Input[str]) – The unique fingerprint of the metadata.

  • metadata_startup_script (pulumi.Input[str]) – An alternative to using the startup-script metadata key, except this one forces the instance to be recreated (thus re-running the script) if it is changed. This replaces the startup-script metadata key on the created instance and thus the two mechanisms are not allowed to be used simultaneously.

  • min_cpu_platform (pulumi.Input[str]) –

    Specifies a minimum CPU platform for the VM instance. Applicable values are the friendly names of CPU platforms, such as Intel Haswell or Intel Skylake. See the complete list here. Note: allow_stopping_for_update must be set to true in order to update this field.

  • name (pulumi.Input[str]) – A unique name for the resource, required by GCE. Changing this forces a new resource to be created.

  • network_interfaces (pulumi.Input[list]) – Networks to attach to the instance. This can be specified multiple times. Structure is documented below.

  • project (pulumi.Input[str]) – The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

  • scheduling (pulumi.Input[dict]) – The scheduling strategy to use. More details about this configuration option are detailed below.

  • scratch_disks (pulumi.Input[list]) – Scratch disks to attach to the instance. This can be specified multiple times for multiple scratch disks. Structure is documented below.

  • self_link (pulumi.Input[str]) – The URI of the created resource.

  • service_account (pulumi.Input[dict]) – Service account to attach to the instance. Structure is documented below. Note: allow_stopping_for_update must be set to true in order to update this field.

  • shielded_instance_config (pulumi.Input[dict]) –

    Enable Shielded VM on this instance. Shielded VM provides verifiable integrity to prevent against malware and rootkits. Defaults to disabled. Structure is documented below. Note: shielded_instance_config can only be used with boot images with shielded vm support. See the complete list here.

  • tags (pulumi.Input[list]) – A list of tags to attach to the instance.

  • tags_fingerprint (pulumi.Input[str]) – The unique fingerprint of the tags.

  • zone (pulumi.Input[str]) – The zone that the machine should be created in.

The attached_disks object supports the following:

  • device_name (pulumi.Input[str])

  • diskEncryptionKeyRaw (pulumi.Input[str])

  • diskEncryptionKeySha256 (pulumi.Input[str])

  • kmsKeySelfLink (pulumi.Input[str])

  • mode (pulumi.Input[str])

  • source (pulumi.Input[str])

The boot_disk object supports the following:

  • autoDelete (pulumi.Input[bool])

  • device_name (pulumi.Input[str])

  • diskEncryptionKeyRaw (pulumi.Input[str])

  • diskEncryptionKeySha256 (pulumi.Input[str])

  • initializeParams (pulumi.Input[dict])

    • image (pulumi.Input[str])

    • labels (pulumi.Input[dict]) - A set of key/value label pairs to assign to the instance.

    • size (pulumi.Input[float])

    • type (pulumi.Input[str])

  • kmsKeySelfLink (pulumi.Input[str])

  • source (pulumi.Input[str])

The guest_accelerators object supports the following:

  • count (pulumi.Input[float])

  • type (pulumi.Input[str])

The network_interfaces object supports the following:

  • accessConfigs (pulumi.Input[list])

    • natIp (pulumi.Input[str])

    • network_tier (pulumi.Input[str])

    • publicPtrDomainName (pulumi.Input[str])

  • aliasIpRanges (pulumi.Input[list])

    • ip_cidr_range (pulumi.Input[str])

    • subnetworkRangeName (pulumi.Input[str])

  • name (pulumi.Input[str]) - A unique name for the resource, required by GCE. Changing this forces a new resource to be created.

  • network (pulumi.Input[str])

  • networkIp (pulumi.Input[str])

  • subnetwork (pulumi.Input[str])

  • subnetworkProject (pulumi.Input[str])

The scheduling object supports the following:

  • automaticRestart (pulumi.Input[bool])

  • nodeAffinities (pulumi.Input[list])

    • key (pulumi.Input[str])

    • operator (pulumi.Input[str])

    • values (pulumi.Input[list])

  • onHostMaintenance (pulumi.Input[str])

  • preemptible (pulumi.Input[bool])

The scratch_disks object supports the following:

  • interface (pulumi.Input[str])

The service_account object supports the following:

  • email (pulumi.Input[str])

  • scopes (pulumi.Input[list])

The shielded_instance_config object supports the following:

  • enableIntegrityMonitoring (pulumi.Input[bool])

  • enableSecureBoot (pulumi.Input[bool])

  • enableVtpm (pulumi.Input[bool])

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_gcp.compute.InstanceFromTemplate(resource_name, opts=None, allow_stopping_for_update=None, attached_disks=None, boot_disk=None, can_ip_forward=None, deletion_protection=None, description=None, guest_accelerators=None, hostname=None, labels=None, machine_type=None, metadata=None, metadata_startup_script=None, min_cpu_platform=None, name=None, network_interfaces=None, project=None, scheduling=None, scratch_disks=None, service_account=None, shielded_instance_config=None, source_instance_template=None, tags=None, zone=None, __props__=None, __name__=None, __opts__=None)

Manages a VM instance resource within GCE. For more information see the official documentation and API.

This resource is specifically to create a compute instance from a given source_instance_template. To create an instance without a template, use the compute.Instance resource.

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • name (pulumi.Input[str]) – A unique name for the resource, required by GCE. Changing this forces a new resource to be created.

  • source_instance_template (pulumi.Input[str]) – Name or self link of an instance template to create the instance based on.

  • zone (pulumi.Input[str]) – The zone that the machine should be created in. If not set, the provider zone is used.

The attached_disks object supports the following:

  • device_name (pulumi.Input[str])

  • diskEncryptionKeyRaw (pulumi.Input[str])

  • diskEncryptionKeySha256 (pulumi.Input[str])

  • kmsKeySelfLink (pulumi.Input[str])

  • mode (pulumi.Input[str])

  • source (pulumi.Input[str])

The boot_disk object supports the following:

  • autoDelete (pulumi.Input[bool])

  • device_name (pulumi.Input[str])

  • diskEncryptionKeyRaw (pulumi.Input[str])

  • diskEncryptionKeySha256 (pulumi.Input[str])

  • initializeParams (pulumi.Input[dict])

    • image (pulumi.Input[str])

    • labels (pulumi.Input[dict])

    • size (pulumi.Input[float])

    • type (pulumi.Input[str])

  • kmsKeySelfLink (pulumi.Input[str])

  • source (pulumi.Input[str])

The guest_accelerators object supports the following:

  • count (pulumi.Input[float])

  • type (pulumi.Input[str])

The network_interfaces object supports the following:

  • accessConfigs (pulumi.Input[list])

    • natIp (pulumi.Input[str])

    • network_tier (pulumi.Input[str])

    • publicPtrDomainName (pulumi.Input[str])

  • aliasIpRanges (pulumi.Input[list])

    • ip_cidr_range (pulumi.Input[str])

    • subnetworkRangeName (pulumi.Input[str])

  • name (pulumi.Input[str]) - A unique name for the resource, required by GCE. Changing this forces a new resource to be created.

  • network (pulumi.Input[str])

  • networkIp (pulumi.Input[str])

  • subnetwork (pulumi.Input[str])

  • subnetworkProject (pulumi.Input[str])

The scheduling object supports the following:

  • automaticRestart (pulumi.Input[bool])

  • nodeAffinities (pulumi.Input[list])

    • key (pulumi.Input[str])

    • operator (pulumi.Input[str])

    • values (pulumi.Input[list])

  • onHostMaintenance (pulumi.Input[str])

  • preemptible (pulumi.Input[bool])

The scratch_disks object supports the following:

  • interface (pulumi.Input[str])

The service_account object supports the following:

  • email (pulumi.Input[str])

  • scopes (pulumi.Input[list])

The shielded_instance_config object supports the following:

  • enableIntegrityMonitoring (pulumi.Input[bool])

  • enableSecureBoot (pulumi.Input[bool])

  • enableVtpm (pulumi.Input[bool])

name = None

A unique name for the resource, required by GCE. Changing this forces a new resource to be created.

source_instance_template = None

Name or self link of an instance template to create the instance based on.

zone = None

The zone that the machine should be created in. If not set, the provider zone is used.

static get(resource_name, id, opts=None, allow_stopping_for_update=None, attached_disks=None, boot_disk=None, can_ip_forward=None, cpu_platform=None, deletion_protection=None, description=None, guest_accelerators=None, hostname=None, instance_id=None, label_fingerprint=None, labels=None, machine_type=None, metadata=None, metadata_fingerprint=None, metadata_startup_script=None, min_cpu_platform=None, name=None, network_interfaces=None, project=None, scheduling=None, scratch_disks=None, self_link=None, service_account=None, shielded_instance_config=None, source_instance_template=None, tags=None, tags_fingerprint=None, zone=None)

Get an existing InstanceFromTemplate resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • name (pulumi.Input[str]) – A unique name for the resource, required by GCE. Changing this forces a new resource to be created.

  • source_instance_template (pulumi.Input[str]) – Name or self link of an instance template to create the instance based on.

  • zone (pulumi.Input[str]) – The zone that the machine should be created in. If not set, the provider zone is used.

The attached_disks object supports the following:

  • device_name (pulumi.Input[str])

  • diskEncryptionKeyRaw (pulumi.Input[str])

  • diskEncryptionKeySha256 (pulumi.Input[str])

  • kmsKeySelfLink (pulumi.Input[str])

  • mode (pulumi.Input[str])

  • source (pulumi.Input[str])

The boot_disk object supports the following:

  • autoDelete (pulumi.Input[bool])

  • device_name (pulumi.Input[str])

  • diskEncryptionKeyRaw (pulumi.Input[str])

  • diskEncryptionKeySha256 (pulumi.Input[str])

  • initializeParams (pulumi.Input[dict])

    • image (pulumi.Input[str])

    • labels (pulumi.Input[dict])

    • size (pulumi.Input[float])

    • type (pulumi.Input[str])

  • kmsKeySelfLink (pulumi.Input[str])

  • source (pulumi.Input[str])

The guest_accelerators object supports the following:

  • count (pulumi.Input[float])

  • type (pulumi.Input[str])

The network_interfaces object supports the following:

  • accessConfigs (pulumi.Input[list])

    • natIp (pulumi.Input[str])

    • network_tier (pulumi.Input[str])

    • publicPtrDomainName (pulumi.Input[str])

  • aliasIpRanges (pulumi.Input[list])

    • ip_cidr_range (pulumi.Input[str])

    • subnetworkRangeName (pulumi.Input[str])

  • name (pulumi.Input[str]) - A unique name for the resource, required by GCE. Changing this forces a new resource to be created.

  • network (pulumi.Input[str])

  • networkIp (pulumi.Input[str])

  • subnetwork (pulumi.Input[str])

  • subnetworkProject (pulumi.Input[str])

The scheduling object supports the following:

  • automaticRestart (pulumi.Input[bool])

  • nodeAffinities (pulumi.Input[list])

    • key (pulumi.Input[str])

    • operator (pulumi.Input[str])

    • values (pulumi.Input[list])

  • onHostMaintenance (pulumi.Input[str])

  • preemptible (pulumi.Input[bool])

The scratch_disks object supports the following:

  • interface (pulumi.Input[str])

The service_account object supports the following:

  • email (pulumi.Input[str])

  • scopes (pulumi.Input[list])

The shielded_instance_config object supports the following:

  • enableIntegrityMonitoring (pulumi.Input[bool])

  • enableSecureBoot (pulumi.Input[bool])

  • enableVtpm (pulumi.Input[bool])

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_gcp.compute.InstanceGroup(resource_name, opts=None, description=None, instances=None, name=None, named_ports=None, network=None, project=None, zone=None, __props__=None, __name__=None, __opts__=None)

Creates a group of dissimilar Compute Engine virtual machine instances. For more information, see the official documentation and API

Recreating an instance group that’s in use by another resource will give a resourceInUseByAnotherResource error.

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • description (pulumi.Input[str]) – An optional textual description of the instance group.

  • instances (pulumi.Input[list]) – List of instances in the group. They should be given as self_link URLs. When adding instances they must all be in the same network and zone as the instance group.

  • name (pulumi.Input[str]) – The name of the instance group. Must be 1-63 characters long and comply with RFC1035. Supported characters include lowercase letters, numbers, and hyphens.

  • named_ports (pulumi.Input[list]) – The named port configuration. See the section below for details on configuration.

  • network (pulumi.Input[str]) – The URL of the network the instance group is in. If this is different from the network where the instances are in, the creation fails. Defaults to the network where the instances are in (if neither network nor instances is specified, this field will be blank).

  • project (pulumi.Input[str]) – The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

  • zone (pulumi.Input[str]) – The zone that this instance group should be created in.

The named_ports object supports the following:

  • name (pulumi.Input[str]) - The name of the instance group. Must be 1-63 characters long and comply with RFC1035. Supported characters include lowercase letters, numbers, and hyphens.

  • port (pulumi.Input[float])

description = None

An optional textual description of the instance group.

instances = None

List of instances in the group. They should be given as self_link URLs. When adding instances they must all be in the same network and zone as the instance group.

name = None

The name of the instance group. Must be 1-63 characters long and comply with RFC1035. Supported characters include lowercase letters, numbers, and hyphens.

named_ports = None

The named port configuration. See the section below for details on configuration.

  • name (str) - The name of the instance group. Must be 1-63 characters long and comply with RFC1035. Supported characters include lowercase letters, numbers, and hyphens.

  • port (float)

network = None

The URL of the network the instance group is in. If this is different from the network where the instances are in, the creation fails. Defaults to the network where the instances are in (if neither network nor instances is specified, this field will be blank).

project = None

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

The URI of the created resource.

size = None

The number of instances in the group.

zone = None

The zone that this instance group should be created in.

static get(resource_name, id, opts=None, description=None, instances=None, name=None, named_ports=None, network=None, project=None, self_link=None, size=None, zone=None)

Get an existing InstanceGroup resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • description (pulumi.Input[str]) – An optional textual description of the instance group.

  • instances (pulumi.Input[list]) – List of instances in the group. They should be given as self_link URLs. When adding instances they must all be in the same network and zone as the instance group.

  • name (pulumi.Input[str]) –

    The name of the instance group. Must be 1-63 characters long and comply with RFC1035. Supported characters include lowercase letters, numbers, and hyphens.

  • named_ports (pulumi.Input[list]) – The named port configuration. See the section below for details on configuration.

  • network (pulumi.Input[str]) – The URL of the network the instance group is in. If this is different from the network where the instances are in, the creation fails. Defaults to the network where the instances are in (if neither network nor instances is specified, this field will be blank).

  • project (pulumi.Input[str]) – The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

  • self_link (pulumi.Input[str]) – The URI of the created resource.

  • size (pulumi.Input[float]) – The number of instances in the group.

  • zone (pulumi.Input[str]) – The zone that this instance group should be created in.

The named_ports object supports the following:

  • name (pulumi.Input[str]) - The name of the instance group. Must be 1-63 characters long and comply with RFC1035. Supported characters include lowercase letters, numbers, and hyphens.

  • port (pulumi.Input[float])

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_gcp.compute.InstanceGroupManager(resource_name, opts=None, auto_healing_policies=None, base_instance_name=None, description=None, name=None, named_ports=None, project=None, target_pools=None, target_size=None, update_policy=None, versions=None, wait_for_instances=None, zone=None, __props__=None, __name__=None, __opts__=None)

The Google Compute Engine Instance Group Manager API creates and manages pools of homogeneous Compute Engine virtual machine instances from a common instance template. For more information, see the official documentation and API

Note: Use compute.RegionInstanceGroupManager to create a regional (multi-zone) instance group manager.

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • auto_healing_policies (pulumi.Input[dict]) –

    ) The autohealing policies for this managed instance group. You can specify only one value. Structure is documented below. For more information, see the official documentation.

  • base_instance_name (pulumi.Input[str]) –

    The base instance name to use for instances in this group. The value must be a valid RFC1035 name. Supported characters are lowercase letters, numbers, and hyphens (-). Instances are named by appending a hyphen and a random four-character string to the base instance name.

  • description (pulumi.Input[str]) – An optional textual description of the instance group manager.

  • name (pulumi.Input[str]) –

    The name of the instance group manager. Must be 1-63 characters long and comply with RFC1035. Supported characters include lowercase letters, numbers, and hyphens.

  • named_ports (pulumi.Input[list]) – The named port configuration. See the section below for details on configuration.

  • project (pulumi.Input[str]) – The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

  • target_pools (pulumi.Input[list]) – The full URL of all target pools to which new instances in the group are added. Updating the target pools attribute does not affect existing instances.

  • target_size (pulumi.Input[float]) – The target number of running instances for this managed instance group. This value should always be explicitly set unless this resource is attached to an autoscaler, in which case it should never be set. Defaults to 0.

  • update_policy (pulumi.Input[dict]) –

    ) The update policy for this managed instance group. Structure is documented below. For more information, see the official documentation and API

- - -
Parameters
  • versions (pulumi.Input[list]) – ) Application versions managed by this instance group. Each version deals with a specific instance template, allowing canary release scenarios. Structure is documented below.

  • wait_for_instances (pulumi.Input[bool]) – Whether to wait for all instances to be created/updated before returning. Note that if this is set to true and the operation does not succeed, this provider will continue trying until it times out.

  • zone (pulumi.Input[str]) – The zone that instances in this group should be created in.

The auto_healing_policies object supports the following:

  • healthCheck (pulumi.Input[str])

  • initialDelaySec (pulumi.Input[float])

The named_ports object supports the following:

  • name (pulumi.Input[str]) - The name of the instance group manager. Must be 1-63 characters long and comply with RFC1035. Supported characters include lowercase letters, numbers, and hyphens.

  • port (pulumi.Input[float])

The update_policy object supports the following:

  • maxSurgeFixed (pulumi.Input[float])

  • maxSurgePercent (pulumi.Input[float])

  • maxUnavailableFixed (pulumi.Input[float])

  • maxUnavailablePercent (pulumi.Input[float])

  • minReadySec (pulumi.Input[float])

  • minimalAction (pulumi.Input[str])

  • type (pulumi.Input[str])

The versions object supports the following:

  • instanceTemplate (pulumi.Input[str]) - ) The full URL to an instance template from which all new instances will be created. This field is only present in the google provider.

  • name (pulumi.Input[str]) - The name of the instance group manager. Must be 1-63 characters long and comply with RFC1035. Supported characters include lowercase letters, numbers, and hyphens.

  • target_size (pulumi.Input[dict]) - The target number of running instances for this managed instance group. This value should always be explicitly set unless this resource is attached to an autoscaler, in which case it should never be set. Defaults to 0.

    • fixed (pulumi.Input[float])

    • percent (pulumi.Input[float])

auto_healing_policies = None

) The autohealing policies for this managed instance group. You can specify only one value. Structure is documented below. For more information, see the official documentation.

  • healthCheck (str)

  • initialDelaySec (float)

base_instance_name = None

The base instance name to use for instances in this group. The value must be a valid RFC1035 name. Supported characters are lowercase letters, numbers, and hyphens (-). Instances are named by appending a hyphen and a random four-character string to the base instance name.

description = None

An optional textual description of the instance group manager.

fingerprint = None

The fingerprint of the instance group manager.

instance_group = None

The full URL of the instance group created by the manager.

name = None

The name of the instance group manager. Must be 1-63 characters long and comply with RFC1035. Supported characters include lowercase letters, numbers, and hyphens.

named_ports = None

The named port configuration. See the section below for details on configuration.

  • name (str) - The name of the instance group manager. Must be 1-63 characters long and comply with RFC1035. Supported characters include lowercase letters, numbers, and hyphens.

  • port (float)

project = None

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

The URL of the created resource.

target_pools = None

The full URL of all target pools to which new instances in the group are added. Updating the target pools attribute does not affect existing instances.

target_size = None

The target number of running instances for this managed instance group. This value should always be explicitly set unless this resource is attached to an autoscaler, in which case it should never be set. Defaults to 0.

update_policy = None

) The update policy for this managed instance group. Structure is documented below. For more information, see the official documentation and API

  • maxSurgeFixed (float)

  • maxSurgePercent (float)

  • maxUnavailableFixed (float)

  • maxUnavailablePercent (float)

  • minReadySec (float)

  • minimalAction (str)

  • type (str)

versions = None

) Application versions managed by this instance group. Each version deals with a specific instance template, allowing canary release scenarios. Structure is documented below.

  • instanceTemplate (str) - ) The full URL to an instance template from which all new instances will be created. This field is only present in the google provider.

  • name (str) - The name of the instance group manager. Must be 1-63 characters long and comply with RFC1035. Supported characters include lowercase letters, numbers, and hyphens.

  • target_size (dict) - The target number of running instances for this managed instance group. This value should always be explicitly set unless this resource is attached to an autoscaler, in which case it should never be set. Defaults to 0.

    • fixed (float)

    • percent (float)

wait_for_instances = None

Whether to wait for all instances to be created/updated before returning. Note that if this is set to true and the operation does not succeed, this provider will continue trying until it times out.

zone = None

The zone that instances in this group should be created in.

static get(resource_name, id, opts=None, auto_healing_policies=None, base_instance_name=None, description=None, fingerprint=None, instance_group=None, name=None, named_ports=None, project=None, self_link=None, target_pools=None, target_size=None, update_policy=None, versions=None, wait_for_instances=None, zone=None)

Get an existing InstanceGroupManager resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • auto_healing_policies (pulumi.Input[dict]) –

    ) The autohealing policies for this managed instance group. You can specify only one value. Structure is documented below. For more information, see the official documentation.

  • base_instance_name (pulumi.Input[str]) –

    The base instance name to use for instances in this group. The value must be a valid RFC1035 name. Supported characters are lowercase letters, numbers, and hyphens (-). Instances are named by appending a hyphen and a random four-character string to the base instance name.

  • description (pulumi.Input[str]) – An optional textual description of the instance group manager.

  • fingerprint (pulumi.Input[str]) – The fingerprint of the instance group manager.

  • instance_group (pulumi.Input[str]) – The full URL of the instance group created by the manager.

  • name (pulumi.Input[str]) –

    The name of the instance group manager. Must be 1-63 characters long and comply with RFC1035. Supported characters include lowercase letters, numbers, and hyphens.

  • named_ports (pulumi.Input[list]) – The named port configuration. See the section below for details on configuration.

  • project (pulumi.Input[str]) – The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

  • self_link (pulumi.Input[str]) – The URL of the created resource.

  • target_pools (pulumi.Input[list]) – The full URL of all target pools to which new instances in the group are added. Updating the target pools attribute does not affect existing instances.

  • target_size (pulumi.Input[float]) – The target number of running instances for this managed instance group. This value should always be explicitly set unless this resource is attached to an autoscaler, in which case it should never be set. Defaults to 0.

  • update_policy (pulumi.Input[dict]) –

    ) The update policy for this managed instance group. Structure is documented below. For more information, see the official documentation and API

- - -
Parameters
  • versions (pulumi.Input[list]) – ) Application versions managed by this instance group. Each version deals with a specific instance template, allowing canary release scenarios. Structure is documented below.

  • wait_for_instances (pulumi.Input[bool]) – Whether to wait for all instances to be created/updated before returning. Note that if this is set to true and the operation does not succeed, this provider will continue trying until it times out.

  • zone (pulumi.Input[str]) – The zone that instances in this group should be created in.

The auto_healing_policies object supports the following:

  • healthCheck (pulumi.Input[str])

  • initialDelaySec (pulumi.Input[float])

The named_ports object supports the following:

  • name (pulumi.Input[str]) - The name of the instance group manager. Must be 1-63 characters long and comply with RFC1035. Supported characters include lowercase letters, numbers, and hyphens.

  • port (pulumi.Input[float])

The update_policy object supports the following:

  • maxSurgeFixed (pulumi.Input[float])

  • maxSurgePercent (pulumi.Input[float])

  • maxUnavailableFixed (pulumi.Input[float])

  • maxUnavailablePercent (pulumi.Input[float])

  • minReadySec (pulumi.Input[float])

  • minimalAction (pulumi.Input[str])

  • type (pulumi.Input[str])

The versions object supports the following:

  • instanceTemplate (pulumi.Input[str]) - ) The full URL to an instance template from which all new instances will be created. This field is only present in the google provider.

  • name (pulumi.Input[str]) - The name of the instance group manager. Must be 1-63 characters long and comply with RFC1035. Supported characters include lowercase letters, numbers, and hyphens.

  • target_size (pulumi.Input[dict]) - The target number of running instances for this managed instance group. This value should always be explicitly set unless this resource is attached to an autoscaler, in which case it should never be set. Defaults to 0.

    • fixed (pulumi.Input[float])

    • percent (pulumi.Input[float])

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_gcp.compute.InstanceIAMBinding(resource_name, opts=None, instance_name=None, members=None, project=None, role=None, zone=None, __props__=None, __name__=None, __opts__=None)

Three different resources help you manage your IAM policy for GCE instance. Each of these resources serves a different use case:

  • compute.InstanceIAMPolicy: Authoritative. Sets the IAM policy for the instance and replaces any existing policy already attached.

  • compute.InstanceIAMBinding: Authoritative for a given role. Updates the IAM policy to grant a role to a list of members. Other roles within the IAM policy for the instance are preserved.

  • compute.InstanceIAMMember: Non-authoritative. Updates the IAM policy to grant a role to a new member. Other members for the role for the instance are preserved.

Note: compute.InstanceIAMPolicy cannot be used in conjunction with compute.InstanceIAMBinding and compute.InstanceIAMMember or they will fight over what your policy should be.

Note: compute.InstanceIAMBinding resources can be used in conjunction with compute.InstanceIAMMember resources only if they do not grant privilege to the same role.

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • instance_name (pulumi.Input[str]) – The name of the instance.

  • project (pulumi.Input[str]) – The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

  • role (pulumi.Input[str]) – The role that should be applied. Only one compute.InstanceIAMBinding can be used per role. Note that custom roles must be of the format [projects|organizations]/{parent-name}/roles/{role-name}.

  • zone (pulumi.Input[str]) – The zone of the instance. If unspecified, this defaults to the zone configured in the provider.

etag = None

(Computed) The etag of the instance’s IAM policy.

instance_name = None

The name of the instance.

project = None

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

role = None

The role that should be applied. Only one compute.InstanceIAMBinding can be used per role. Note that custom roles must be of the format [projects|organizations]/{parent-name}/roles/{role-name}.

zone = None

The zone of the instance. If unspecified, this defaults to the zone configured in the provider.

static get(resource_name, id, opts=None, etag=None, instance_name=None, members=None, project=None, role=None, zone=None)

Get an existing InstanceIAMBinding resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • etag (pulumi.Input[str]) – (Computed) The etag of the instance’s IAM policy.

  • instance_name (pulumi.Input[str]) – The name of the instance.

  • project (pulumi.Input[str]) – The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

  • role (pulumi.Input[str]) – The role that should be applied. Only one compute.InstanceIAMBinding can be used per role. Note that custom roles must be of the format [projects|organizations]/{parent-name}/roles/{role-name}.

  • zone (pulumi.Input[str]) – The zone of the instance. If unspecified, this defaults to the zone configured in the provider.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_gcp.compute.InstanceIAMMember(resource_name, opts=None, instance_name=None, member=None, project=None, role=None, zone=None, __props__=None, __name__=None, __opts__=None)

Three different resources help you manage your IAM policy for GCE instance. Each of these resources serves a different use case:

  • compute.InstanceIAMPolicy: Authoritative. Sets the IAM policy for the instance and replaces any existing policy already attached.

  • compute.InstanceIAMBinding: Authoritative for a given role. Updates the IAM policy to grant a role to a list of members. Other roles within the IAM policy for the instance are preserved.

  • compute.InstanceIAMMember: Non-authoritative. Updates the IAM policy to grant a role to a new member. Other members for the role for the instance are preserved.

Note: compute.InstanceIAMPolicy cannot be used in conjunction with compute.InstanceIAMBinding and compute.InstanceIAMMember or they will fight over what your policy should be.

Note: compute.InstanceIAMBinding resources can be used in conjunction with compute.InstanceIAMMember resources only if they do not grant privilege to the same role.

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • instance_name (pulumi.Input[str]) – The name of the instance.

  • project (pulumi.Input[str]) – The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

  • role (pulumi.Input[str]) – The role that should be applied. Only one compute.InstanceIAMBinding can be used per role. Note that custom roles must be of the format [projects|organizations]/{parent-name}/roles/{role-name}.

  • zone (pulumi.Input[str]) – The zone of the instance. If unspecified, this defaults to the zone configured in the provider.

etag = None

(Computed) The etag of the instance’s IAM policy.

instance_name = None

The name of the instance.

project = None

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

role = None

The role that should be applied. Only one compute.InstanceIAMBinding can be used per role. Note that custom roles must be of the format [projects|organizations]/{parent-name}/roles/{role-name}.

zone = None

The zone of the instance. If unspecified, this defaults to the zone configured in the provider.

static get(resource_name, id, opts=None, etag=None, instance_name=None, member=None, project=None, role=None, zone=None)

Get an existing InstanceIAMMember resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • etag (pulumi.Input[str]) – (Computed) The etag of the instance’s IAM policy.

  • instance_name (pulumi.Input[str]) – The name of the instance.

  • project (pulumi.Input[str]) – The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

  • role (pulumi.Input[str]) – The role that should be applied. Only one compute.InstanceIAMBinding can be used per role. Note that custom roles must be of the format [projects|organizations]/{parent-name}/roles/{role-name}.

  • zone (pulumi.Input[str]) – The zone of the instance. If unspecified, this defaults to the zone configured in the provider.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_gcp.compute.InstanceIAMPolicy(resource_name, opts=None, instance_name=None, policy_data=None, project=None, zone=None, __props__=None, __name__=None, __opts__=None)

Three different resources help you manage your IAM policy for GCE instance. Each of these resources serves a different use case:

  • compute.InstanceIAMPolicy: Authoritative. Sets the IAM policy for the instance and replaces any existing policy already attached.

  • compute.InstanceIAMBinding: Authoritative for a given role. Updates the IAM policy to grant a role to a list of members. Other roles within the IAM policy for the instance are preserved.

  • compute.InstanceIAMMember: Non-authoritative. Updates the IAM policy to grant a role to a new member. Other members for the role for the instance are preserved.

Note: compute.InstanceIAMPolicy cannot be used in conjunction with compute.InstanceIAMBinding and compute.InstanceIAMMember or they will fight over what your policy should be.

Note: compute.InstanceIAMBinding resources can be used in conjunction with compute.InstanceIAMMember resources only if they do not grant privilege to the same role.

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • instance_name (pulumi.Input[str]) – The name of the instance.

  • policy_data (pulumi.Input[str]) – The policy data generated by a organizations.getIAMPolicy data source.

  • project (pulumi.Input[str]) – The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

  • zone (pulumi.Input[str]) – The zone of the instance. If unspecified, this defaults to the zone configured in the provider.

etag = None

(Computed) The etag of the instance’s IAM policy.

instance_name = None

The name of the instance.

policy_data = None

The policy data generated by a organizations.getIAMPolicy data source.

project = None

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

zone = None

The zone of the instance. If unspecified, this defaults to the zone configured in the provider.

static get(resource_name, id, opts=None, etag=None, instance_name=None, policy_data=None, project=None, zone=None)

Get an existing InstanceIAMPolicy resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • etag (pulumi.Input[str]) – (Computed) The etag of the instance’s IAM policy.

  • instance_name (pulumi.Input[str]) – The name of the instance.

  • policy_data (pulumi.Input[str]) – The policy data generated by a organizations.getIAMPolicy data source.

  • project (pulumi.Input[str]) – The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

  • zone (pulumi.Input[str]) – The zone of the instance. If unspecified, this defaults to the zone configured in the provider.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_gcp.compute.InstanceTemplate(resource_name, opts=None, can_ip_forward=None, description=None, disks=None, guest_accelerators=None, instance_description=None, labels=None, machine_type=None, metadata=None, metadata_startup_script=None, min_cpu_platform=None, name=None, name_prefix=None, network_interfaces=None, project=None, region=None, scheduling=None, service_account=None, shielded_instance_config=None, tags=None, __props__=None, __name__=None, __opts__=None)

Manages a VM instance template resource within GCE. For more information see the official documentation and API.

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • can_ip_forward (pulumi.Input[bool]) – Whether to allow sending and receiving of packets with non-matching source or destination IPs. This defaults to false.

  • description (pulumi.Input[str]) – A brief description of this resource.

  • disks (pulumi.Input[list]) – Disks to attach to instances created from this template. This can be specified multiple times for multiple disks. Structure is documented below.

  • guest_accelerators (pulumi.Input[list]) – List of the type and count of accelerator cards attached to the instance. Structure documented below.

  • instance_description (pulumi.Input[str]) – A brief description to use for instances created from this template.

  • labels (pulumi.Input[dict]) – A set of key/value label pairs to assign to instances created from this template,

  • machine_type (pulumi.Input[str]) – The machine type to create.

  • metadata (pulumi.Input[dict]) – Metadata key/value pairs to make available from within instances created from this template.

  • metadata_startup_script (pulumi.Input[str]) – An alternative to using the startup-script metadata key, mostly to match the compute_instance resource. This replaces the startup-script metadata key on the created instance and thus the two mechanisms are not allowed to be used simultaneously.

  • min_cpu_platform (pulumi.Input[str]) –

    Specifies a minimum CPU platform. Applicable values are the friendly names of CPU platforms, such as Intel Haswell or Intel Skylake. See the complete list here.

  • name (pulumi.Input[str]) – The name of the instance template. If you leave this blank, this provider will auto-generate a unique name.

  • name_prefix (pulumi.Input[str]) – Creates a unique name beginning with the specified prefix. Conflicts with name.

  • network_interfaces (pulumi.Input[list]) – Networks to attach to instances created from this template. This can be specified multiple times for multiple networks. Structure is documented below.

  • project (pulumi.Input[str]) – The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

  • region (pulumi.Input[str]) – An instance template is a global resource that is not bound to a zone or a region. However, you can still specify some regional resources in an instance template, which restricts the template to the region where that resource resides. For example, a custom subnetwork resource is tied to a specific region. Defaults to the region of the Provider if no value is given.

  • scheduling (pulumi.Input[dict]) – The scheduling strategy to use. More details about this configuration option are detailed below.

  • service_account (pulumi.Input[dict]) – Service account to attach to the instance. Structure is documented below.

  • shielded_instance_config (pulumi.Input[dict]) –

    Enable Shielded VM on this instance. Shielded VM provides verifiable integrity to prevent against malware and rootkits. Defaults to disabled. Structure is documented below. Note: shielded_instance_config can only be used with boot images with shielded vm support. See the complete list here.

  • tags (pulumi.Input[list]) – Tags to attach to the instance.

The disks object supports the following:

  • autoDelete (pulumi.Input[bool])

  • boot (pulumi.Input[bool])

  • device_name (pulumi.Input[str])

  • disk_encryption_key (pulumi.Input[dict])

    • kmsKeySelfLink (pulumi.Input[str])

  • diskName (pulumi.Input[str])

  • disk_size_gb (pulumi.Input[float])

  • diskType (pulumi.Input[str])

  • interface (pulumi.Input[str])

  • labels (pulumi.Input[dict]) - A set of key/value label pairs to assign to instances created from this template,

  • mode (pulumi.Input[str])

  • source (pulumi.Input[str])

  • sourceImage (pulumi.Input[str])

  • type (pulumi.Input[str])

The guest_accelerators object supports the following:

  • count (pulumi.Input[float])

  • type (pulumi.Input[str])

The network_interfaces object supports the following:

  • accessConfigs (pulumi.Input[list])

    • natIp (pulumi.Input[str])

    • network_tier (pulumi.Input[str])

  • aliasIpRanges (pulumi.Input[list])

    • ip_cidr_range (pulumi.Input[str])

    • subnetworkRangeName (pulumi.Input[str])

  • network (pulumi.Input[str])

  • networkIp (pulumi.Input[str])

  • subnetwork (pulumi.Input[str])

  • subnetworkProject (pulumi.Input[str])

The scheduling object supports the following:

  • automaticRestart (pulumi.Input[bool])

  • nodeAffinities (pulumi.Input[list])

    • key (pulumi.Input[str])

    • operator (pulumi.Input[str])

    • values (pulumi.Input[list])

  • onHostMaintenance (pulumi.Input[str])

  • preemptible (pulumi.Input[bool])

The service_account object supports the following:

  • email (pulumi.Input[str])

  • scopes (pulumi.Input[list])

The shielded_instance_config object supports the following:

  • enableIntegrityMonitoring (pulumi.Input[bool])

  • enableSecureBoot (pulumi.Input[bool])

  • enableVtpm (pulumi.Input[bool])

can_ip_forward = None

Whether to allow sending and receiving of packets with non-matching source or destination IPs. This defaults to false.

description = None

A brief description of this resource.

disks = None

Disks to attach to instances created from this template. This can be specified multiple times for multiple disks. Structure is documented below.

  • autoDelete (bool)

  • boot (bool)

  • device_name (str)

  • disk_encryption_key (dict)

    • kmsKeySelfLink (str)

  • diskName (str)

  • disk_size_gb (float)

  • diskType (str)

  • interface (str)

  • labels (dict) - A set of key/value label pairs to assign to instances created from this template,

  • mode (str)

  • source (str)

  • sourceImage (str)

  • type (str)

guest_accelerators = None

List of the type and count of accelerator cards attached to the instance. Structure documented below.

  • count (float)

  • type (str)

instance_description = None

A brief description to use for instances created from this template.

labels = None

A set of key/value label pairs to assign to instances created from this template,

machine_type = None

The machine type to create.

metadata = None

Metadata key/value pairs to make available from within instances created from this template.

metadata_fingerprint = None

The unique fingerprint of the metadata.

metadata_startup_script = None

An alternative to using the startup-script metadata key, mostly to match the compute_instance resource. This replaces the startup-script metadata key on the created instance and thus the two mechanisms are not allowed to be used simultaneously.

min_cpu_platform = None

Specifies a minimum CPU platform. Applicable values are the friendly names of CPU platforms, such as Intel Haswell or Intel Skylake. See the complete list here.

name = None

The name of the instance template. If you leave this blank, this provider will auto-generate a unique name.

name_prefix = None

Creates a unique name beginning with the specified prefix. Conflicts with name.

network_interfaces = None

Networks to attach to instances created from this template. This can be specified multiple times for multiple networks. Structure is documented below.

  • accessConfigs (list)

    • natIp (str)

    • network_tier (str)

  • aliasIpRanges (list)

    • ip_cidr_range (str)

    • subnetworkRangeName (str)

  • network (str)

  • networkIp (str)

  • subnetwork (str)

  • subnetworkProject (str)

project = None

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

region = None

An instance template is a global resource that is not bound to a zone or a region. However, you can still specify some regional resources in an instance template, which restricts the template to the region where that resource resides. For example, a custom subnetwork resource is tied to a specific region. Defaults to the region of the Provider if no value is given.

scheduling = None

The scheduling strategy to use. More details about this configuration option are detailed below.

  • automaticRestart (bool)

  • nodeAffinities (list)

    • key (str)

    • operator (str)

    • values (list)

  • onHostMaintenance (str)

  • preemptible (bool)

The URI of the created resource.

service_account = None

Service account to attach to the instance. Structure is documented below.

  • email (str)

  • scopes (list)

shielded_instance_config = None

Enable Shielded VM on this instance. Shielded VM provides verifiable integrity to prevent against malware and rootkits. Defaults to disabled. Structure is documented below. Note: shielded_instance_config can only be used with boot images with shielded vm support. See the complete list here.

  • enableIntegrityMonitoring (bool)

  • enableSecureBoot (bool)

  • enableVtpm (bool)

tags = None

Tags to attach to the instance.

tags_fingerprint = None

The unique fingerprint of the tags.

static get(resource_name, id, opts=None, can_ip_forward=None, description=None, disks=None, guest_accelerators=None, instance_description=None, labels=None, machine_type=None, metadata=None, metadata_fingerprint=None, metadata_startup_script=None, min_cpu_platform=None, name=None, name_prefix=None, network_interfaces=None, project=None, region=None, scheduling=None, self_link=None, service_account=None, shielded_instance_config=None, tags=None, tags_fingerprint=None)

Get an existing InstanceTemplate resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • can_ip_forward (pulumi.Input[bool]) – Whether to allow sending and receiving of packets with non-matching source or destination IPs. This defaults to false.

  • description (pulumi.Input[str]) – A brief description of this resource.

  • disks (pulumi.Input[list]) – Disks to attach to instances created from this template. This can be specified multiple times for multiple disks. Structure is documented below.

  • guest_accelerators (pulumi.Input[list]) – List of the type and count of accelerator cards attached to the instance. Structure documented below.

  • instance_description (pulumi.Input[str]) – A brief description to use for instances created from this template.

  • labels (pulumi.Input[dict]) – A set of key/value label pairs to assign to instances created from this template,

  • machine_type (pulumi.Input[str]) – The machine type to create.

  • metadata (pulumi.Input[dict]) – Metadata key/value pairs to make available from within instances created from this template.

  • metadata_fingerprint (pulumi.Input[str]) – The unique fingerprint of the metadata.

  • metadata_startup_script (pulumi.Input[str]) – An alternative to using the startup-script metadata key, mostly to match the compute_instance resource. This replaces the startup-script metadata key on the created instance and thus the two mechanisms are not allowed to be used simultaneously.

  • min_cpu_platform (pulumi.Input[str]) –

    Specifies a minimum CPU platform. Applicable values are the friendly names of CPU platforms, such as Intel Haswell or Intel Skylake. See the complete list here.

  • name (pulumi.Input[str]) – The name of the instance template. If you leave this blank, this provider will auto-generate a unique name.

  • name_prefix (pulumi.Input[str]) – Creates a unique name beginning with the specified prefix. Conflicts with name.

  • network_interfaces (pulumi.Input[list]) – Networks to attach to instances created from this template. This can be specified multiple times for multiple networks. Structure is documented below.

  • project (pulumi.Input[str]) – The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

  • region (pulumi.Input[str]) – An instance template is a global resource that is not bound to a zone or a region. However, you can still specify some regional resources in an instance template, which restricts the template to the region where that resource resides. For example, a custom subnetwork resource is tied to a specific region. Defaults to the region of the Provider if no value is given.

  • scheduling (pulumi.Input[dict]) – The scheduling strategy to use. More details about this configuration option are detailed below.

  • self_link (pulumi.Input[str]) – The URI of the created resource.

  • service_account (pulumi.Input[dict]) – Service account to attach to the instance. Structure is documented below.

  • shielded_instance_config (pulumi.Input[dict]) –

    Enable Shielded VM on this instance. Shielded VM provides verifiable integrity to prevent against malware and rootkits. Defaults to disabled. Structure is documented below. Note: shielded_instance_config can only be used with boot images with shielded vm support. See the complete list here.

  • tags (pulumi.Input[list]) – Tags to attach to the instance.

  • tags_fingerprint (pulumi.Input[str]) – The unique fingerprint of the tags.

The disks object supports the following:

  • autoDelete (pulumi.Input[bool])

  • boot (pulumi.Input[bool])

  • device_name (pulumi.Input[str])

  • disk_encryption_key (pulumi.Input[dict])

    • kmsKeySelfLink (pulumi.Input[str])

  • diskName (pulumi.Input[str])

  • disk_size_gb (pulumi.Input[float])

  • diskType (pulumi.Input[str])

  • interface (pulumi.Input[str])

  • labels (pulumi.Input[dict]) - A set of key/value label pairs to assign to instances created from this template,

  • mode (pulumi.Input[str])

  • source (pulumi.Input[str])

  • sourceImage (pulumi.Input[str])

  • type (pulumi.Input[str])

The guest_accelerators object supports the following:

  • count (pulumi.Input[float])

  • type (pulumi.Input[str])

The network_interfaces object supports the following:

  • accessConfigs (pulumi.Input[list])

    • natIp (pulumi.Input[str])

    • network_tier (pulumi.Input[str])

  • aliasIpRanges (pulumi.Input[list])

    • ip_cidr_range (pulumi.Input[str])

    • subnetworkRangeName (pulumi.Input[str])

  • network (pulumi.Input[str])

  • networkIp (pulumi.Input[str])

  • subnetwork (pulumi.Input[str])

  • subnetworkProject (pulumi.Input[str])

The scheduling object supports the following:

  • automaticRestart (pulumi.Input[bool])

  • nodeAffinities (pulumi.Input[list])

    • key (pulumi.Input[str])

    • operator (pulumi.Input[str])

    • values (pulumi.Input[list])

  • onHostMaintenance (pulumi.Input[str])

  • preemptible (pulumi.Input[bool])

The service_account object supports the following:

  • email (pulumi.Input[str])

  • scopes (pulumi.Input[list])

The shielded_instance_config object supports the following:

  • enableIntegrityMonitoring (pulumi.Input[bool])

  • enableSecureBoot (pulumi.Input[bool])

  • enableVtpm (pulumi.Input[bool])

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_gcp.compute.InterconnectAttachment(resource_name, opts=None, candidate_subnets=None, description=None, edge_availability_domain=None, interconnect=None, name=None, project=None, region=None, router=None, type=None, vlan_tag8021q=None, __props__=None, __name__=None, __opts__=None)

Represents an InterconnectAttachment (VLAN attachment) resource. For more information, see Creating VLAN Attachments.

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • project (pulumi.Input[str]) – The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

project = None

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

The URI of the created resource.

static get(resource_name, id, opts=None, candidate_subnets=None, cloud_router_ip_address=None, creation_timestamp=None, customer_router_ip_address=None, description=None, edge_availability_domain=None, google_reference_id=None, interconnect=None, name=None, pairing_key=None, partner_asn=None, private_interconnect_info=None, project=None, region=None, router=None, self_link=None, state=None, type=None, vlan_tag8021q=None)

Get an existing InterconnectAttachment resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • project (pulumi.Input[str]) – The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

  • self_link (pulumi.Input[str]) – The URI of the created resource.

The private_interconnect_info object supports the following:

  • tag8021q (pulumi.Input[float])

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_gcp.compute.MangedSslCertificate(resource_name, opts=None, certificate_id=None, description=None, managed=None, name=None, project=None, type=None, __props__=None, __name__=None, __opts__=None)

An SslCertificate resource, used for HTTPS load balancing. This resource represents a certificate for which the certificate secrets are created and managed by Google.

For a resource where you provide the key, see the SSL Certificate resource.

To get more information about ManagedSslCertificate, see:

Warning: This resource should be used with extreme caution! Provisioning an SSL certificate is complex. Ensure that you understand the lifecycle of a certificate before attempting complex tasks like cert rotation automatically. This resource will “return” as soon as the certificate object is created, but post-creation the certificate object will go through a “provisioning” process. The provisioning process can complete only when the domain name for which the certificate is created points to a target pool which, itself, points at the certificate. Depending on your DNS provider, this may take some time, and migrating from self-managed certificates to Google-managed certificates may entail some downtime while the certificate provisions.

In conclusion: Be extremely cautious.

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • project (pulumi.Input[str]) – The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

The managed object supports the following:

  • domains (pulumi.Input[str])

project = None

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

The URI of the created resource.

static get(resource_name, id, opts=None, certificate_id=None, creation_timestamp=None, description=None, expire_time=None, managed=None, name=None, project=None, self_link=None, subject_alternative_names=None, type=None)

Get an existing MangedSslCertificate resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • project (pulumi.Input[str]) – The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

  • self_link (pulumi.Input[str]) – The URI of the created resource.

The managed object supports the following:

  • domains (pulumi.Input[str])

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_gcp.compute.Network(resource_name, opts=None, auto_create_subnetworks=None, delete_default_routes_on_create=None, description=None, ipv4_range=None, name=None, project=None, routing_mode=None, __props__=None, __name__=None, __opts__=None)

Manages a VPC network or legacy network resource on GCP.

To get more information about Network, see:

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • project (pulumi.Input[str]) – The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

project = None

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

The URI of the created resource.

static get(resource_name, id, opts=None, auto_create_subnetworks=None, delete_default_routes_on_create=None, description=None, gateway_ipv4=None, ipv4_range=None, name=None, project=None, routing_mode=None, self_link=None)

Get an existing Network resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • project (pulumi.Input[str]) – The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

  • self_link (pulumi.Input[str]) – The URI of the created resource.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_gcp.compute.NetworkEndpoint(resource_name, opts=None, instance=None, ip_address=None, network_endpoint_group=None, port=None, project=None, zone=None, __props__=None, __name__=None, __opts__=None)

A Network endpoint represents a IP address and port combination that is part of a specific network endpoint group (NEG). NEGs are zonals collection of these endpoints for GCP resources within a single subnet. NOTE: Network endpoints cannot be created outside of a network endpoint group.

To get more information about NetworkEndpoint, see:

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • project (pulumi.Input[str]) – The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

project = None

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

static get(resource_name, id, opts=None, instance=None, ip_address=None, network_endpoint_group=None, port=None, project=None, zone=None)

Get an existing NetworkEndpoint resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • project (pulumi.Input[str]) – The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_gcp.compute.NetworkEndpointGroup(resource_name, opts=None, default_port=None, description=None, name=None, network=None, network_endpoint_type=None, project=None, subnetwork=None, zone=None, __props__=None, __name__=None, __opts__=None)

Network endpoint groups (NEGs) are zonal resources that represent collections of IP address and port combinations for GCP resources within a single subnet. Each IP address and port combination is called a network endpoint.

Network endpoint groups can be used as backends in backend services for HTTP(S), TCP proxy, and SSL proxy load balancers. You cannot use NEGs as a backend with internal load balancers. Because NEG backends allow you to specify IP addresses and ports, you can distribute traffic in a granular fashion among applications or containers running within VM instances.

To get more information about NetworkEndpointGroup, see:

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • project (pulumi.Input[str]) – The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

project = None

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

The URI of the created resource.

static get(resource_name, id, opts=None, default_port=None, description=None, name=None, network=None, network_endpoint_type=None, project=None, self_link=None, size=None, subnetwork=None, zone=None)

Get an existing NetworkEndpointGroup resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • project (pulumi.Input[str]) – The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

  • self_link (pulumi.Input[str]) – The URI of the created resource.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_gcp.compute.NetworkPeering(resource_name, opts=None, auto_create_routes=None, export_custom_routes=None, import_custom_routes=None, name=None, network=None, peer_network=None, __props__=None, __name__=None, __opts__=None)

Manages a network peering within GCE. For more information see the official documentation and API.

Note: Both network must create a peering with each other for the peering to be functional.

Note: Subnets IP ranges across peered VPC networks cannot overlap.

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • auto_create_routes (pulumi.Input[bool]) – If set to true, the routes between the two networks will be created and managed automatically. Defaults to true.

  • name (pulumi.Input[str]) – Name of the peering.

  • network (pulumi.Input[str]) – Resource link of the network to add a peering to.

  • peer_network (pulumi.Input[str]) – Resource link of the peer network.

auto_create_routes = None

If set to true, the routes between the two networks will be created and managed automatically. Defaults to true.

name = None

Name of the peering.

network = None

Resource link of the network to add a peering to.

peer_network = None

Resource link of the peer network.

state = None

State for the peering.

state_details = None

Details about the current state of the peering.

static get(resource_name, id, opts=None, auto_create_routes=None, export_custom_routes=None, import_custom_routes=None, name=None, network=None, peer_network=None, state=None, state_details=None)

Get an existing NetworkPeering resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • auto_create_routes (pulumi.Input[bool]) – If set to true, the routes between the two networks will be created and managed automatically. Defaults to true.

  • name (pulumi.Input[str]) – Name of the peering.

  • network (pulumi.Input[str]) – Resource link of the network to add a peering to.

  • peer_network (pulumi.Input[str]) – Resource link of the peer network.

  • state (pulumi.Input[str]) – State for the peering.

  • state_details (pulumi.Input[str]) – Details about the current state of the peering.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_gcp.compute.NodeGroup(resource_name, opts=None, description=None, name=None, node_template=None, project=None, size=None, zone=None, __props__=None, __name__=None, __opts__=None)

Represents a NodeGroup resource to manage a group of sole-tenant nodes.

To get more information about NodeGroup, see:

Warning: Due to limitations of the API, this provider cannot update the number of nodes in a node group and changes to node group size either through config or through external changes will cause this provider to delete and recreate the node group.

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • project (pulumi.Input[str]) – The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

project = None

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

The URI of the created resource.

static get(resource_name, id, opts=None, creation_timestamp=None, description=None, name=None, node_template=None, project=None, self_link=None, size=None, zone=None)

Get an existing NodeGroup resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • project (pulumi.Input[str]) – The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

  • self_link (pulumi.Input[str]) – The URI of the created resource.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_gcp.compute.NodeTemplate(resource_name, opts=None, description=None, name=None, node_affinity_labels=None, node_type=None, node_type_flexibility=None, project=None, region=None, server_binding=None, __props__=None, __name__=None, __opts__=None)

Represents a NodeTemplate resource. Node templates specify properties for creating sole-tenant nodes, such as node type, vCPU and memory requirments, node affinity labels, and region.

To get more information about NodeTemplate, see:

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • project (pulumi.Input[str]) – The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

The node_type_flexibility object supports the following:

  • cpus (pulumi.Input[str])

  • localSsd (pulumi.Input[str])

  • memory (pulumi.Input[str])

The server_binding object supports the following:

  • type (pulumi.Input[str])

project = None

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

The URI of the created resource.

static get(resource_name, id, opts=None, creation_timestamp=None, description=None, name=None, node_affinity_labels=None, node_type=None, node_type_flexibility=None, project=None, region=None, self_link=None, server_binding=None)

Get an existing NodeTemplate resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • project (pulumi.Input[str]) – The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

  • self_link (pulumi.Input[str]) – The URI of the created resource.

The node_type_flexibility object supports the following:

  • cpus (pulumi.Input[str])

  • localSsd (pulumi.Input[str])

  • memory (pulumi.Input[str])

The server_binding object supports the following:

  • type (pulumi.Input[str])

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_gcp.compute.ProjectDefaultNetworkTier(resource_name, opts=None, network_tier=None, project=None, __props__=None, __name__=None, __opts__=None)

Configures the Google Compute Engine Default Network Tier for a project.

For more information, see, the Project API documentation.

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • network_tier (pulumi.Input[str]) – The default network tier to be configured for the project. This field can take the following values: PREMIUM or STANDARD.

  • project (pulumi.Input[str]) – The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

network_tier = None

The default network tier to be configured for the project. This field can take the following values: PREMIUM or STANDARD.

project = None

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

static get(resource_name, id, opts=None, network_tier=None, project=None)

Get an existing ProjectDefaultNetworkTier resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • network_tier (pulumi.Input[str]) – The default network tier to be configured for the project. This field can take the following values: PREMIUM or STANDARD.

  • project (pulumi.Input[str]) – The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_gcp.compute.ProjectMetadata(resource_name, opts=None, metadata=None, project=None, __props__=None, __name__=None, __opts__=None)

Authoritatively manages metadata common to all instances for a project in GCE. For more information see the official documentation and API.

Note: This resource manages all project-level metadata including project-level ssh keys. Keys unset in config but set on the server will be removed. If you want to manage only single key/value pairs within the project metadata rather than the entire set, then use google_compute_project_metadata_item.

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • metadata (pulumi.Input[dict]) – A series of key value pairs.

  • project (pulumi.Input[str]) – The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

metadata = None

A series of key value pairs.

project = None

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

static get(resource_name, id, opts=None, metadata=None, project=None)

Get an existing ProjectMetadata resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • metadata (pulumi.Input[dict]) – A series of key value pairs.

  • project (pulumi.Input[str]) – The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_gcp.compute.ProjectMetadataItem(resource_name, opts=None, key=None, project=None, value=None, __props__=None, __name__=None, __opts__=None)

Manages a single key/value pair on metadata common to all instances for a project in GCE. Using compute.ProjectMetadataItem lets you manage a single key/value setting with this provider rather than the entire project metadata map.

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • key (pulumi.Input[str]) – The metadata key to set.

  • project (pulumi.Input[str]) – The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

  • value (pulumi.Input[str]) – The value to set for the given metadata key.

key = None

The metadata key to set.

project = None

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

value = None

The value to set for the given metadata key.

static get(resource_name, id, opts=None, key=None, project=None, value=None)

Get an existing ProjectMetadataItem resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • key (pulumi.Input[str]) – The metadata key to set.

  • project (pulumi.Input[str]) – The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

  • value (pulumi.Input[str]) – The value to set for the given metadata key.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_gcp.compute.RegionAutoscaler(resource_name, opts=None, autoscaling_policy=None, description=None, name=None, project=None, region=None, target=None, __props__=None, __name__=None, __opts__=None)

Represents an Autoscaler resource.

Autoscalers allow you to automatically scale virtual machine instances in managed instance groups according to an autoscaling policy that you define.

To get more information about RegionAutoscaler, see:

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

The autoscaling_policy object supports the following:

  • cooldownPeriod (pulumi.Input[float])

  • cpuUtilization (pulumi.Input[dict])

    • target (pulumi.Input[float])

  • loadBalancingUtilization (pulumi.Input[dict])

    • target (pulumi.Input[float])

  • maxReplicas (pulumi.Input[float])

  • metrics (pulumi.Input[list])

    • filter (pulumi.Input[str])

    • name (pulumi.Input[str])

    • singleInstanceAssignment (pulumi.Input[float])

    • target (pulumi.Input[float])

    • type (pulumi.Input[str])

  • minReplicas (pulumi.Input[float])

The URI of the created resource.

static get(resource_name, id, opts=None, autoscaling_policy=None, creation_timestamp=None, description=None, name=None, project=None, region=None, self_link=None, target=None)

Get an existing RegionAutoscaler resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • self_link (pulumi.Input[str]) – The URI of the created resource.

The autoscaling_policy object supports the following:

  • cooldownPeriod (pulumi.Input[float])

  • cpuUtilization (pulumi.Input[dict])

    • target (pulumi.Input[float])

  • loadBalancingUtilization (pulumi.Input[dict])

    • target (pulumi.Input[float])

  • maxReplicas (pulumi.Input[float])

  • metrics (pulumi.Input[list])

    • filter (pulumi.Input[str])

    • name (pulumi.Input[str])

    • singleInstanceAssignment (pulumi.Input[float])

    • target (pulumi.Input[float])

    • type (pulumi.Input[str])

  • minReplicas (pulumi.Input[float])

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_gcp.compute.RegionBackendService(resource_name, opts=None, backends=None, connection_draining_timeout_sec=None, description=None, failover_policy=None, health_checks=None, load_balancing_scheme=None, name=None, project=None, protocol=None, region=None, session_affinity=None, timeout_sec=None, __props__=None, __name__=None, __opts__=None)

A Region Backend Service defines a regionally-scoped group of virtual machines that will serve traffic for load balancing.

Region backend services can only be used when using internal load balancing. For external load balancing, use a global backend service instead.

To get more information about RegionBackendService, see:

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • project (pulumi.Input[str]) – The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

The backends object supports the following:

  • description (pulumi.Input[str])

  • failover (pulumi.Input[bool])

  • group (pulumi.Input[str])

The failover_policy object supports the following:

  • disableConnectionDrainOnFailover (pulumi.Input[bool])

  • dropTrafficIfUnhealthy (pulumi.Input[bool])

  • failover_ratio (pulumi.Input[float])

project = None

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

The URI of the created resource.

static get(resource_name, id, opts=None, backends=None, connection_draining_timeout_sec=None, description=None, failover_policy=None, fingerprint=None, health_checks=None, load_balancing_scheme=None, name=None, project=None, protocol=None, region=None, self_link=None, session_affinity=None, timeout_sec=None)

Get an existing RegionBackendService resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • project (pulumi.Input[str]) – The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

  • self_link (pulumi.Input[str]) – The URI of the created resource.

The backends object supports the following:

  • description (pulumi.Input[str])

  • failover (pulumi.Input[bool])

  • group (pulumi.Input[str])

The failover_policy object supports the following:

  • disableConnectionDrainOnFailover (pulumi.Input[bool])

  • dropTrafficIfUnhealthy (pulumi.Input[bool])

  • failover_ratio (pulumi.Input[float])

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_gcp.compute.RegionDisk(resource_name, opts=None, description=None, disk_encryption_key=None, labels=None, name=None, physical_block_size_bytes=None, project=None, region=None, replica_zones=None, size=None, snapshot=None, source_snapshot_encryption_key=None, type=None, __props__=None, __name__=None, __opts__=None)

Persistent disks are durable storage devices that function similarly to the physical disks in a desktop or a server. Compute Engine manages the hardware behind these devices to ensure data redundancy and optimize performance for you. Persistent disks are available as either standard hard disk drives (HDD) or solid-state drives (SSD).

Persistent disks are located independently from your virtual machine instances, so you can detach or move persistent disks to keep your data even after you delete your instances. Persistent disk performance scales automatically with size, so you can resize your existing persistent disks or add more persistent disks to an instance to meet your performance and storage space requirements.

Add a persistent disk to your instance when you need reliable and affordable storage with consistent performance characteristics.

To get more information about RegionDisk, see:

Warning: All arguments including the disk encryption key will be stored in the raw state as plain-text. Read more about sensitive data in state.

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • project (pulumi.Input[str]) – The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

The disk_encryption_key object supports the following:

  • kmsKeyName (pulumi.Input[str])

  • rawKey (pulumi.Input[str])

  • sha256 (pulumi.Input[str])

The source_snapshot_encryption_key object supports the following:

  • kmsKeyName (pulumi.Input[str])

  • rawKey (pulumi.Input[str])

  • sha256 (pulumi.Input[str])

project = None

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

The URI of the created resource.

static get(resource_name, id, opts=None, creation_timestamp=None, description=None, disk_encryption_key=None, label_fingerprint=None, labels=None, last_attach_timestamp=None, last_detach_timestamp=None, name=None, physical_block_size_bytes=None, project=None, region=None, replica_zones=None, self_link=None, size=None, snapshot=None, source_snapshot_encryption_key=None, source_snapshot_id=None, type=None, users=None)

Get an existing RegionDisk resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • project (pulumi.Input[str]) – The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

  • self_link (pulumi.Input[str]) – The URI of the created resource.

The disk_encryption_key object supports the following:

  • kmsKeyName (pulumi.Input[str])

  • rawKey (pulumi.Input[str])

  • sha256 (pulumi.Input[str])

The source_snapshot_encryption_key object supports the following:

  • kmsKeyName (pulumi.Input[str])

  • rawKey (pulumi.Input[str])

  • sha256 (pulumi.Input[str])

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_gcp.compute.RegionInstanceGroupManager(resource_name, opts=None, auto_healing_policies=None, base_instance_name=None, description=None, distribution_policy_zones=None, name=None, named_ports=None, project=None, region=None, target_pools=None, target_size=None, update_policy=None, versions=None, wait_for_instances=None, __props__=None, __name__=None, __opts__=None)

The Google Compute Engine Regional Instance Group Manager API creates and manages pools of homogeneous Compute Engine virtual machine instances from a common instance template. For more information, see the official documentation and API

Note: Use compute.InstanceGroupManager to create a single-zone instance group manager.

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • auto_healing_policies (pulumi.Input[dict]) –

    ) The autohealing policies for this managed instance group. You can specify only one value. Structure is documented below. For more information, see the official documentation.

  • base_instance_name (pulumi.Input[str]) –

    The base instance name to use for instances in this group. The value must be a valid RFC1035 name. Supported characters are lowercase letters, numbers, and hyphens (-). Instances are named by appending a hyphen and a random four-character string to the base instance name.

  • description (pulumi.Input[str]) – An optional textual description of the instance group manager.

  • distribution_policy_zones (pulumi.Input[list]) –

    The distribution policy for this managed instance group. You can specify one or more values. For more information, see the official documentation.

- - -
Parameters
  • name (pulumi.Input[str]) –

    The name of the instance group manager. Must be 1-63 characters long and comply with RFC1035. Supported characters include lowercase letters, numbers, and hyphens.

  • named_ports (pulumi.Input[list]) – The named port configuration. See the section below for details on configuration.

  • project (pulumi.Input[str]) – The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

  • region (pulumi.Input[str]) – The region where the managed instance group resides.

  • target_pools (pulumi.Input[list]) – The full URL of all target pools to which new instances in the group are added. Updating the target pools attribute does not affect existing instances.

  • target_size (pulumi.Input[float]) – The target number of running instances for this managed instance group. This value should always be explicitly set unless this resource is attached to an autoscaler, in which case it should never be set. Defaults to 0.

  • update_policy (pulumi.Input[dict]) –

    ) The update policy for this managed instance group. Structure is documented below. For more information, see the official documentation and API

  • versions (pulumi.Input[list]) – ) Application versions managed by this instance group. Each version deals with a specific instance template, allowing canary release scenarios. Structure is documented below.

  • wait_for_instances (pulumi.Input[bool]) – Whether to wait for all instances to be created/updated before returning. Note that if this is set to true and the operation does not succeed, this provider will continue trying until it times out.

The auto_healing_policies object supports the following:

  • healthCheck (pulumi.Input[str])

  • initialDelaySec (pulumi.Input[float])

The named_ports object supports the following:

  • name (pulumi.Input[str]) - The name of the instance group manager. Must be 1-63 characters long and comply with RFC1035. Supported characters include lowercase letters, numbers, and hyphens.

  • port (pulumi.Input[float])

The update_policy object supports the following:

  • maxSurgeFixed (pulumi.Input[float])

  • maxSurgePercent (pulumi.Input[float])

  • maxUnavailableFixed (pulumi.Input[float])

  • maxUnavailablePercent (pulumi.Input[float])

  • minReadySec (pulumi.Input[float])

  • minimalAction (pulumi.Input[str])

  • type (pulumi.Input[str])

The versions object supports the following:

  • instanceTemplate (pulumi.Input[str]) - ) The full URL to an instance template from which all new instances will be created. This field is only present in the google provider.

  • name (pulumi.Input[str]) - The name of the instance group manager. Must be 1-63 characters long and comply with RFC1035. Supported characters include lowercase letters, numbers, and hyphens.

  • target_size (pulumi.Input[dict]) - The target number of running instances for this managed instance group. This value should always be explicitly set unless this resource is attached to an autoscaler, in which case it should never be set. Defaults to 0.

    • fixed (pulumi.Input[float])

    • percent (pulumi.Input[float])

auto_healing_policies = None

) The autohealing policies for this managed instance group. You can specify only one value. Structure is documented below. For more information, see the official documentation.

  • healthCheck (str)

  • initialDelaySec (float)

base_instance_name = None

The base instance name to use for instances in this group. The value must be a valid RFC1035 name. Supported characters are lowercase letters, numbers, and hyphens (-). Instances are named by appending a hyphen and a random four-character string to the base instance name.

description = None

An optional textual description of the instance group manager.

distribution_policy_zones = None

The distribution policy for this managed instance group. You can specify one or more values. For more information, see the official documentation.

fingerprint = None

The fingerprint of the instance group manager.

instance_group = None

The full URL of the instance group created by the manager.

name = None

The name of the instance group manager. Must be 1-63 characters long and comply with RFC1035. Supported characters include lowercase letters, numbers, and hyphens.

named_ports = None

The named port configuration. See the section below for details on configuration.

  • name (str) - The name of the instance group manager. Must be 1-63 characters long and comply with RFC1035. Supported characters include lowercase letters, numbers, and hyphens.

  • port (float)

project = None

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

region = None

The region where the managed instance group resides.

The URL of the created resource.

target_pools = None

The full URL of all target pools to which new instances in the group are added. Updating the target pools attribute does not affect existing instances.

target_size = None

The target number of running instances for this managed instance group. This value should always be explicitly set unless this resource is attached to an autoscaler, in which case it should never be set. Defaults to 0.

update_policy = None

) The update policy for this managed instance group. Structure is documented below. For more information, see the official documentation and API

  • maxSurgeFixed (float)

  • maxSurgePercent (float)

  • maxUnavailableFixed (float)

  • maxUnavailablePercent (float)

  • minReadySec (float)

  • minimalAction (str)

  • type (str)

versions = None

) Application versions managed by this instance group. Each version deals with a specific instance template, allowing canary release scenarios. Structure is documented below.

  • instanceTemplate (str) - ) The full URL to an instance template from which all new instances will be created. This field is only present in the google provider.

  • name (str) - The name of the instance group manager. Must be 1-63 characters long and comply with RFC1035. Supported characters include lowercase letters, numbers, and hyphens.

  • target_size (dict) - The target number of running instances for this managed instance group. This value should always be explicitly set unless this resource is attached to an autoscaler, in which case it should never be set. Defaults to 0.

    • fixed (float)

    • percent (float)

wait_for_instances = None

Whether to wait for all instances to be created/updated before returning. Note that if this is set to true and the operation does not succeed, this provider will continue trying until it times out.

static get(resource_name, id, opts=None, auto_healing_policies=None, base_instance_name=None, description=None, distribution_policy_zones=None, fingerprint=None, instance_group=None, name=None, named_ports=None, project=None, region=None, self_link=None, target_pools=None, target_size=None, update_policy=None, versions=None, wait_for_instances=None)

Get an existing RegionInstanceGroupManager resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • auto_healing_policies (pulumi.Input[dict]) –

    ) The autohealing policies for this managed instance group. You can specify only one value. Structure is documented below. For more information, see the official documentation.

  • base_instance_name (pulumi.Input[str]) –

    The base instance name to use for instances in this group. The value must be a valid RFC1035 name. Supported characters are lowercase letters, numbers, and hyphens (-). Instances are named by appending a hyphen and a random four-character string to the base instance name.

  • description (pulumi.Input[str]) – An optional textual description of the instance group manager.

  • distribution_policy_zones (pulumi.Input[list]) –

    The distribution policy for this managed instance group. You can specify one or more values. For more information, see the official documentation.

- - -
Parameters
  • fingerprint (pulumi.Input[str]) – The fingerprint of the instance group manager.

  • instance_group (pulumi.Input[str]) – The full URL of the instance group created by the manager.

  • name (pulumi.Input[str]) –

    The name of the instance group manager. Must be 1-63 characters long and comply with RFC1035. Supported characters include lowercase letters, numbers, and hyphens.

  • named_ports (pulumi.Input[list]) – The named port configuration. See the section below for details on configuration.

  • project (pulumi.Input[str]) – The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

  • region (pulumi.Input[str]) – The region where the managed instance group resides.

  • self_link (pulumi.Input[str]) – The URL of the created resource.

  • target_pools (pulumi.Input[list]) – The full URL of all target pools to which new instances in the group are added. Updating the target pools attribute does not affect existing instances.

  • target_size (pulumi.Input[float]) – The target number of running instances for this managed instance group. This value should always be explicitly set unless this resource is attached to an autoscaler, in which case it should never be set. Defaults to 0.

  • update_policy (pulumi.Input[dict]) –

    ) The update policy for this managed instance group. Structure is documented below. For more information, see the official documentation and API

  • versions (pulumi.Input[list]) – ) Application versions managed by this instance group. Each version deals with a specific instance template, allowing canary release scenarios. Structure is documented below.

  • wait_for_instances (pulumi.Input[bool]) – Whether to wait for all instances to be created/updated before returning. Note that if this is set to true and the operation does not succeed, this provider will continue trying until it times out.

The auto_healing_policies object supports the following:

  • healthCheck (pulumi.Input[str])

  • initialDelaySec (pulumi.Input[float])

The named_ports object supports the following:

  • name (pulumi.Input[str]) - The name of the instance group manager. Must be 1-63 characters long and comply with RFC1035. Supported characters include lowercase letters, numbers, and hyphens.

  • port (pulumi.Input[float])

The update_policy object supports the following:

  • maxSurgeFixed (pulumi.Input[float])

  • maxSurgePercent (pulumi.Input[float])

  • maxUnavailableFixed (pulumi.Input[float])

  • maxUnavailablePercent (pulumi.Input[float])

  • minReadySec (pulumi.Input[float])

  • minimalAction (pulumi.Input[str])

  • type (pulumi.Input[str])

The versions object supports the following:

  • instanceTemplate (pulumi.Input[str]) - ) The full URL to an instance template from which all new instances will be created. This field is only present in the google provider.

  • name (pulumi.Input[str]) - The name of the instance group manager. Must be 1-63 characters long and comply with RFC1035. Supported characters include lowercase letters, numbers, and hyphens.

  • target_size (pulumi.Input[dict]) - The target number of running instances for this managed instance group. This value should always be explicitly set unless this resource is attached to an autoscaler, in which case it should never be set. Defaults to 0.

    • fixed (pulumi.Input[float])

    • percent (pulumi.Input[float])

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_gcp.compute.ResourcePolicy(resource_name, opts=None, name=None, project=None, region=None, snapshot_schedule_policy=None, __props__=None, __name__=None, __opts__=None)

A policy that can be attached to a resource to specify or schedule actions on that resource.

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • project (pulumi.Input[str]) – The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

The snapshot_schedule_policy object supports the following:

  • retentionPolicy (pulumi.Input[dict])

    • maxRetentionDays (pulumi.Input[float])

    • onSourceDiskDelete (pulumi.Input[str])

  • schedule (pulumi.Input[dict])

    • dailySchedule (pulumi.Input[dict])

      • daysInCycle (pulumi.Input[float])

      • startTime (pulumi.Input[str])

    • hourlySchedule (pulumi.Input[dict])

      • hoursInCycle (pulumi.Input[float])

      • startTime (pulumi.Input[str])

    • weeklySchedule (pulumi.Input[dict])

      • dayOfWeeks (pulumi.Input[list])

        • day (pulumi.Input[str])

        • startTime (pulumi.Input[str])

  • snapshotProperties (pulumi.Input[dict])

    • guestFlush (pulumi.Input[bool])

    • labels (pulumi.Input[dict])

    • storageLocations (pulumi.Input[str])

project = None

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

static get(resource_name, id, opts=None, name=None, project=None, region=None, self_link=None, snapshot_schedule_policy=None)

Get an existing ResourcePolicy resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • project (pulumi.Input[str]) – The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

The snapshot_schedule_policy object supports the following:

  • retentionPolicy (pulumi.Input[dict])

    • maxRetentionDays (pulumi.Input[float])

    • onSourceDiskDelete (pulumi.Input[str])

  • schedule (pulumi.Input[dict])

    • dailySchedule (pulumi.Input[dict])

      • daysInCycle (pulumi.Input[float])

      • startTime (pulumi.Input[str])

    • hourlySchedule (pulumi.Input[dict])

      • hoursInCycle (pulumi.Input[float])

      • startTime (pulumi.Input[str])

    • weeklySchedule (pulumi.Input[dict])

      • dayOfWeeks (pulumi.Input[list])

        • day (pulumi.Input[str])

        • startTime (pulumi.Input[str])

  • snapshotProperties (pulumi.Input[dict])

    • guestFlush (pulumi.Input[bool])

    • labels (pulumi.Input[dict])

    • storageLocations (pulumi.Input[str])

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_gcp.compute.Route(resource_name, opts=None, description=None, dest_range=None, name=None, network=None, next_hop_gateway=None, next_hop_instance=None, next_hop_instance_zone=None, next_hop_ip=None, next_hop_vpn_tunnel=None, priority=None, project=None, tags=None, __props__=None, __name__=None, __opts__=None)

Represents a Route resource.

A route is a rule that specifies how certain packets should be handled by the virtual network. Routes are associated with virtual machines by tag, and the set of routes for a particular virtual machine is called its routing table. For each packet leaving a virtual machine, the system searches that virtual machine’s routing table for a single best matching route.

Routes match packets by destination IP address, preferring smaller or more specific ranges over larger ones. If there is a tie, the system selects the route with the smallest priority value. If there is still a tie, it uses the layer three and four packet headers to select just one of the remaining matching routes. The packet is then forwarded as specified by the next_hop field of the winning route – either to another virtual machine destination, a virtual machine gateway or a Compute Engine-operated gateway. Packets that do not match any route in the sending virtual machine’s routing table will be dropped.

A Route resource must have exactly one specification of either nextHopGateway, nextHopInstance, nextHopIp, or nextHopVpnTunnel.

To get more information about Route, see:

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • next_hop_instance_zone (pulumi.Input[str]) – (Optional when next_hop_instance is specified) The zone of the instance specified in next_hop_instance. Omit if next_hop_instance is specified as a URL.

  • project (pulumi.Input[str]) – The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

next_hop_instance_zone = None

(Optional when next_hop_instance is specified) The zone of the instance specified in next_hop_instance. Omit if next_hop_instance is specified as a URL.

project = None

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

The URI of the created resource.

static get(resource_name, id, opts=None, description=None, dest_range=None, name=None, network=None, next_hop_gateway=None, next_hop_instance=None, next_hop_instance_zone=None, next_hop_ip=None, next_hop_network=None, next_hop_vpn_tunnel=None, priority=None, project=None, self_link=None, tags=None)

Get an existing Route resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • next_hop_instance_zone (pulumi.Input[str]) – (Optional when next_hop_instance is specified) The zone of the instance specified in next_hop_instance. Omit if next_hop_instance is specified as a URL.

  • project (pulumi.Input[str]) – The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

  • self_link (pulumi.Input[str]) – The URI of the created resource.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_gcp.compute.Router(resource_name, opts=None, bgp=None, description=None, name=None, network=None, project=None, region=None, __props__=None, __name__=None, __opts__=None)

Represents a Router resource.

To get more information about Router, see:

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • project (pulumi.Input[str]) – The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

The bgp object supports the following:

  • advertiseMode (pulumi.Input[str])

  • advertisedGroups (pulumi.Input[list])

  • advertisedIpRanges (pulumi.Input[list])

    • description (pulumi.Input[str])

    • range (pulumi.Input[str])

  • asn (pulumi.Input[float])

project = None

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

The URI of the created resource.

static get(resource_name, id, opts=None, bgp=None, creation_timestamp=None, description=None, name=None, network=None, project=None, region=None, self_link=None)

Get an existing Router resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • project (pulumi.Input[str]) – The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

  • self_link (pulumi.Input[str]) – The URI of the created resource.

The bgp object supports the following:

  • advertiseMode (pulumi.Input[str])

  • advertisedGroups (pulumi.Input[list])

  • advertisedIpRanges (pulumi.Input[list])

    • description (pulumi.Input[str])

    • range (pulumi.Input[str])

  • asn (pulumi.Input[float])

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_gcp.compute.RouterInterface(resource_name, opts=None, interconnect_attachment=None, ip_range=None, name=None, project=None, region=None, router=None, vpn_tunnel=None, __props__=None, __name__=None, __opts__=None)

Manages a Cloud Router interface. For more information see the official documentation and API.

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • interconnect_attachment (pulumi.Input[str]) – The name or resource link to the VLAN interconnect for this interface. Changing this forces a new interface to be created. Only one of vpn_tunnel and interconnect_attachment can be specified.

  • ip_range (pulumi.Input[str]) – IP address and range of the interface. The IP range must be in the RFC3927 link-local IP space. Changing this forces a new interface to be created.

  • name (pulumi.Input[str]) – A unique name for the interface, required by GCE. Changing this forces a new interface to be created.

  • project (pulumi.Input[str]) – The ID of the project in which this interface’s router belongs. If it is not provided, the provider project is used. Changing this forces a new interface to be created.

  • region (pulumi.Input[str]) – The region this interface’s router sits in. If not specified, the project region will be used. Changing this forces a new interface to be created.

  • router (pulumi.Input[str]) – The name of the router this interface will be attached to. Changing this forces a new interface to be created.

  • vpn_tunnel (pulumi.Input[str]) – The name or resource link to the VPN tunnel this interface will be linked to. Changing this forces a new interface to be created. Only one of vpn_tunnel and interconnect_attachment can be specified.

interconnect_attachment = None

The name or resource link to the VLAN interconnect for this interface. Changing this forces a new interface to be created. Only one of vpn_tunnel and interconnect_attachment can be specified.

ip_range = None

IP address and range of the interface. The IP range must be in the RFC3927 link-local IP space. Changing this forces a new interface to be created.

name = None

A unique name for the interface, required by GCE. Changing this forces a new interface to be created.

project = None

The ID of the project in which this interface’s router belongs. If it is not provided, the provider project is used. Changing this forces a new interface to be created.

region = None

The region this interface’s router sits in. If not specified, the project region will be used. Changing this forces a new interface to be created.

router = None

The name of the router this interface will be attached to. Changing this forces a new interface to be created.

vpn_tunnel = None

The name or resource link to the VPN tunnel this interface will be linked to. Changing this forces a new interface to be created. Only one of vpn_tunnel and interconnect_attachment can be specified.

static get(resource_name, id, opts=None, interconnect_attachment=None, ip_range=None, name=None, project=None, region=None, router=None, vpn_tunnel=None)

Get an existing RouterInterface resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • interconnect_attachment (pulumi.Input[str]) – The name or resource link to the VLAN interconnect for this interface. Changing this forces a new interface to be created. Only one of vpn_tunnel and interconnect_attachment can be specified.

  • ip_range (pulumi.Input[str]) – IP address and range of the interface. The IP range must be in the RFC3927 link-local IP space. Changing this forces a new interface to be created.

  • name (pulumi.Input[str]) – A unique name for the interface, required by GCE. Changing this forces a new interface to be created.

  • project (pulumi.Input[str]) – The ID of the project in which this interface’s router belongs. If it is not provided, the provider project is used. Changing this forces a new interface to be created.

  • region (pulumi.Input[str]) – The region this interface’s router sits in. If not specified, the project region will be used. Changing this forces a new interface to be created.

  • router (pulumi.Input[str]) – The name of the router this interface will be attached to. Changing this forces a new interface to be created.

  • vpn_tunnel (pulumi.Input[str]) – The name or resource link to the VPN tunnel this interface will be linked to. Changing this forces a new interface to be created. Only one of vpn_tunnel and interconnect_attachment can be specified.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_gcp.compute.RouterNat(resource_name, opts=None, icmp_idle_timeout_sec=None, log_config=None, min_ports_per_vm=None, name=None, nat_ip_allocate_option=None, nat_ips=None, project=None, region=None, router=None, source_subnetwork_ip_ranges_to_nat=None, subnetworks=None, tcp_established_idle_timeout_sec=None, tcp_transitory_idle_timeout_sec=None, udp_idle_timeout_sec=None, __props__=None, __name__=None, __opts__=None)

Manages a Cloud NAT. For more information see the official documentation and API.

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • icmp_idle_timeout_sec (pulumi.Input[float]) – Timeout (in seconds) for ICMP connections. Defaults to 30s if not set. Changing this forces a new NAT to be created.

  • min_ports_per_vm (pulumi.Input[float]) – Minimum number of ports allocated to a VM from this NAT config. If not set, a default number of ports is allocated to a VM. Changing this forces a new NAT to be created.

  • name (pulumi.Input[str]) – A unique name for Cloud NAT, required by GCE. Changing this forces a new NAT to be created.

  • nat_ip_allocate_option (pulumi.Input[str]) – How external IPs should be allocated for this NAT. Valid values are AUTO_ONLY or MANUAL_ONLY. Changing this forces a new NAT to be created.

  • nat_ips (pulumi.Input[list]) – List of self_links of external IPs. Only valid if nat_ip_allocate_option is set to MANUAL_ONLY. Changing this forces a new NAT to be created.

  • project (pulumi.Input[str]) – The ID of the project in which this NAT’s router belongs. If it is not provided, the provider project is used. Changing this forces a new NAT to be created.

  • region (pulumi.Input[str]) – The region this NAT’s router sits in. If not specified, the project region will be used. Changing this forces a new NAT to be created.

  • router (pulumi.Input[str]) – The name of the router in which this NAT will be configured. Changing this forces a new NAT to be created.

  • source_subnetwork_ip_ranges_to_nat (pulumi.Input[str]) – How NAT should be configured per Subnetwork. Valid values include: ALL_SUBNETWORKS_ALL_IP_RANGES, ALL_SUBNETWORKS_ALL_PRIMARY_IP_RANGES, LIST_OF_SUBNETWORKS. Changing this forces a new NAT to be created.

  • subnetworks (pulumi.Input[list]) – One or more subnetwork NAT configurations. Only used if source_subnetwork_ip_ranges_to_nat is set to LIST_OF_SUBNETWORKS. See the section below for details on configuration.

  • tcp_established_idle_timeout_sec (pulumi.Input[float]) – Timeout (in seconds) for TCP established connections. Defaults to 1200s if not set. Changing this forces a new NAT to be created.

  • tcp_transitory_idle_timeout_sec (pulumi.Input[float]) – Timeout (in seconds) for TCP transitory connections. Defaults to 30s if not set. Changing this forces a new NAT to be created.

  • udp_idle_timeout_sec (pulumi.Input[float]) – Timeout (in seconds) for UDP connections. Defaults to 30s if not set. Changing this forces a new NAT to be created.

The log_config object supports the following:

  • enable (pulumi.Input[bool])

  • filter (pulumi.Input[str])

The subnetworks object supports the following:

  • name (pulumi.Input[str]) - A unique name for Cloud NAT, required by GCE. Changing this forces a new NAT to be created.

  • secondaryIpRangeNames (pulumi.Input[list])

  • sourceIpRangesToNats (pulumi.Input[list])

icmp_idle_timeout_sec = None

Timeout (in seconds) for ICMP connections. Defaults to 30s if not set. Changing this forces a new NAT to be created.

min_ports_per_vm = None

Minimum number of ports allocated to a VM from this NAT config. If not set, a default number of ports is allocated to a VM. Changing this forces a new NAT to be created.

name = None

A unique name for Cloud NAT, required by GCE. Changing this forces a new NAT to be created.

nat_ip_allocate_option = None

How external IPs should be allocated for this NAT. Valid values are AUTO_ONLY or MANUAL_ONLY. Changing this forces a new NAT to be created.

nat_ips = None

List of self_links of external IPs. Only valid if nat_ip_allocate_option is set to MANUAL_ONLY. Changing this forces a new NAT to be created.

project = None

The ID of the project in which this NAT’s router belongs. If it is not provided, the provider project is used. Changing this forces a new NAT to be created.

region = None

The region this NAT’s router sits in. If not specified, the project region will be used. Changing this forces a new NAT to be created.

router = None

The name of the router in which this NAT will be configured. Changing this forces a new NAT to be created.

source_subnetwork_ip_ranges_to_nat = None

How NAT should be configured per Subnetwork. Valid values include: ALL_SUBNETWORKS_ALL_IP_RANGES, ALL_SUBNETWORKS_ALL_PRIMARY_IP_RANGES, LIST_OF_SUBNETWORKS. Changing this forces a new NAT to be created.

subnetworks = None

One or more subnetwork NAT configurations. Only used if source_subnetwork_ip_ranges_to_nat is set to LIST_OF_SUBNETWORKS. See the section below for details on configuration.

  • name (str) - A unique name for Cloud NAT, required by GCE. Changing this forces a new NAT to be created.

  • secondaryIpRangeNames (list)

  • sourceIpRangesToNats (list)

tcp_established_idle_timeout_sec = None

Timeout (in seconds) for TCP established connections. Defaults to 1200s if not set. Changing this forces a new NAT to be created.

tcp_transitory_idle_timeout_sec = None

Timeout (in seconds) for TCP transitory connections. Defaults to 30s if not set. Changing this forces a new NAT to be created.

udp_idle_timeout_sec = None

Timeout (in seconds) for UDP connections. Defaults to 30s if not set. Changing this forces a new NAT to be created.

static get(resource_name, id, opts=None, icmp_idle_timeout_sec=None, log_config=None, min_ports_per_vm=None, name=None, nat_ip_allocate_option=None, nat_ips=None, project=None, region=None, router=None, source_subnetwork_ip_ranges_to_nat=None, subnetworks=None, tcp_established_idle_timeout_sec=None, tcp_transitory_idle_timeout_sec=None, udp_idle_timeout_sec=None)

Get an existing RouterNat resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • icmp_idle_timeout_sec (pulumi.Input[float]) – Timeout (in seconds) for ICMP connections. Defaults to 30s if not set. Changing this forces a new NAT to be created.

  • min_ports_per_vm (pulumi.Input[float]) – Minimum number of ports allocated to a VM from this NAT config. If not set, a default number of ports is allocated to a VM. Changing this forces a new NAT to be created.

  • name (pulumi.Input[str]) – A unique name for Cloud NAT, required by GCE. Changing this forces a new NAT to be created.

  • nat_ip_allocate_option (pulumi.Input[str]) – How external IPs should be allocated for this NAT. Valid values are AUTO_ONLY or MANUAL_ONLY. Changing this forces a new NAT to be created.

  • nat_ips (pulumi.Input[list]) – List of self_links of external IPs. Only valid if nat_ip_allocate_option is set to MANUAL_ONLY. Changing this forces a new NAT to be created.

  • project (pulumi.Input[str]) – The ID of the project in which this NAT’s router belongs. If it is not provided, the provider project is used. Changing this forces a new NAT to be created.

  • region (pulumi.Input[str]) – The region this NAT’s router sits in. If not specified, the project region will be used. Changing this forces a new NAT to be created.

  • router (pulumi.Input[str]) – The name of the router in which this NAT will be configured. Changing this forces a new NAT to be created.

  • source_subnetwork_ip_ranges_to_nat (pulumi.Input[str]) – How NAT should be configured per Subnetwork. Valid values include: ALL_SUBNETWORKS_ALL_IP_RANGES, ALL_SUBNETWORKS_ALL_PRIMARY_IP_RANGES, LIST_OF_SUBNETWORKS. Changing this forces a new NAT to be created.

  • subnetworks (pulumi.Input[list]) – One or more subnetwork NAT configurations. Only used if source_subnetwork_ip_ranges_to_nat is set to LIST_OF_SUBNETWORKS. See the section below for details on configuration.

  • tcp_established_idle_timeout_sec (pulumi.Input[float]) – Timeout (in seconds) for TCP established connections. Defaults to 1200s if not set. Changing this forces a new NAT to be created.

  • tcp_transitory_idle_timeout_sec (pulumi.Input[float]) – Timeout (in seconds) for TCP transitory connections. Defaults to 30s if not set. Changing this forces a new NAT to be created.

  • udp_idle_timeout_sec (pulumi.Input[float]) – Timeout (in seconds) for UDP connections. Defaults to 30s if not set. Changing this forces a new NAT to be created.

The log_config object supports the following:

  • enable (pulumi.Input[bool])

  • filter (pulumi.Input[str])

The subnetworks object supports the following:

  • name (pulumi.Input[str]) - A unique name for Cloud NAT, required by GCE. Changing this forces a new NAT to be created.

  • secondaryIpRangeNames (pulumi.Input[list])

  • sourceIpRangesToNats (pulumi.Input[list])

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_gcp.compute.RouterPeer(resource_name, opts=None, advertised_route_priority=None, interface=None, name=None, peer_asn=None, peer_ip_address=None, project=None, region=None, router=None, __props__=None, __name__=None, __opts__=None)

Manages a Cloud Router BGP peer. For more information see the official documentation and API.

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • advertised_route_priority (pulumi.Input[float]) – The priority of routes advertised to this BGP peer. Changing this forces a new peer to be created.

  • interface (pulumi.Input[str]) – The name of the interface the BGP peer is associated with. Changing this forces a new peer to be created.

  • name (pulumi.Input[str]) – A unique name for BGP peer, required by GCE. Changing this forces a new peer to be created.

  • peer_asn (pulumi.Input[float]) – Peer BGP Autonomous System Number (ASN). Changing this forces a new peer to be created.

  • peer_ip_address (pulumi.Input[str]) – IP address of the BGP interface outside Google Cloud. Changing this forces a new peer to be created.

  • project (pulumi.Input[str]) – The ID of the project in which this peer’s router belongs. If it is not provided, the provider project is used. Changing this forces a new peer to be created.

  • region (pulumi.Input[str]) – The region this peer’s router sits in. If not specified, the project region will be used. Changing this forces a new peer to be created.

  • router (pulumi.Input[str]) – The name of the router in which this BGP peer will be configured. Changing this forces a new peer to be created.

advertised_route_priority = None

The priority of routes advertised to this BGP peer. Changing this forces a new peer to be created.

interface = None

The name of the interface the BGP peer is associated with. Changing this forces a new peer to be created.

ip_address = None

IP address of the interface inside Google Cloud Platform.

name = None

A unique name for BGP peer, required by GCE. Changing this forces a new peer to be created.

peer_asn = None

Peer BGP Autonomous System Number (ASN). Changing this forces a new peer to be created.

peer_ip_address = None

IP address of the BGP interface outside Google Cloud. Changing this forces a new peer to be created.

project = None

The ID of the project in which this peer’s router belongs. If it is not provided, the provider project is used. Changing this forces a new peer to be created.

region = None

The region this peer’s router sits in. If not specified, the project region will be used. Changing this forces a new peer to be created.

router = None

The name of the router in which this BGP peer will be configured. Changing this forces a new peer to be created.

static get(resource_name, id, opts=None, advertised_route_priority=None, interface=None, ip_address=None, name=None, peer_asn=None, peer_ip_address=None, project=None, region=None, router=None)

Get an existing RouterPeer resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • advertised_route_priority (pulumi.Input[float]) – The priority of routes advertised to this BGP peer. Changing this forces a new peer to be created.

  • interface (pulumi.Input[str]) – The name of the interface the BGP peer is associated with. Changing this forces a new peer to be created.

  • ip_address (pulumi.Input[str]) – IP address of the interface inside Google Cloud Platform.

  • name (pulumi.Input[str]) – A unique name for BGP peer, required by GCE. Changing this forces a new peer to be created.

  • peer_asn (pulumi.Input[float]) – Peer BGP Autonomous System Number (ASN). Changing this forces a new peer to be created.

  • peer_ip_address (pulumi.Input[str]) – IP address of the BGP interface outside Google Cloud. Changing this forces a new peer to be created.

  • project (pulumi.Input[str]) – The ID of the project in which this peer’s router belongs. If it is not provided, the provider project is used. Changing this forces a new peer to be created.

  • region (pulumi.Input[str]) – The region this peer’s router sits in. If not specified, the project region will be used. Changing this forces a new peer to be created.

  • router (pulumi.Input[str]) – The name of the router in which this BGP peer will be configured. Changing this forces a new peer to be created.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_gcp.compute.SSLCertificate(resource_name, opts=None, certificate=None, description=None, name=None, name_prefix=None, private_key=None, project=None, __props__=None, __name__=None, __opts__=None)

An SslCertificate resource, used for HTTPS load balancing. This resource provides a mechanism to upload an SSL key and certificate to the load balancer to serve secure connections from the user.

To get more information about SslCertificate, see:

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • name_prefix (pulumi.Input[str]) – Creates a unique name beginning with the specified prefix. Conflicts with name.

  • project (pulumi.Input[str]) – The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

name_prefix = None

Creates a unique name beginning with the specified prefix. Conflicts with name.

project = None

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

The URI of the created resource.

static get(resource_name, id, opts=None, certificate=None, certificate_id=None, creation_timestamp=None, description=None, name=None, name_prefix=None, private_key=None, project=None, self_link=None)

Get an existing SSLCertificate resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • name_prefix (pulumi.Input[str]) – Creates a unique name beginning with the specified prefix. Conflicts with name.

  • project (pulumi.Input[str]) – The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

  • self_link (pulumi.Input[str]) – The URI of the created resource.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_gcp.compute.SSLPolicy(resource_name, opts=None, custom_features=None, description=None, min_tls_version=None, name=None, profile=None, project=None, __props__=None, __name__=None, __opts__=None)

Represents a SSL policy. SSL policies give you the ability to control the features of SSL that your SSL proxy or HTTPS load balancer negotiates.

To get more information about SslPolicy, see:

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • project (pulumi.Input[str]) – The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

project = None

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

The URI of the created resource.

static get(resource_name, id, opts=None, creation_timestamp=None, custom_features=None, description=None, enabled_features=None, fingerprint=None, min_tls_version=None, name=None, profile=None, project=None, self_link=None)

Get an existing SSLPolicy resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • project (pulumi.Input[str]) – The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

  • self_link (pulumi.Input[str]) – The URI of the created resource.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_gcp.compute.SecurityPolicy(resource_name, opts=None, description=None, name=None, project=None, rules=None, __props__=None, __name__=None, __opts__=None)

Create a SecurityPolicy resource with the given unique name, props, and options.

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • description (pulumi.Input[str]) – An optional description of this security policy. Max size is 2048.

  • name (pulumi.Input[str]) – The name of the security policy.

  • project (pulumi.Input[str]) – The project in which the resource belongs. If it is not provided, the provider project is used.

  • rules (pulumi.Input[list]) – The set of rules that belong to this policy. There must always be a default rule (rule with priority 2147483647 and match “*”). If no rules are provided when creating a security policy, a default rule with action “allow” will be added. Structure is documented below.

The rules object supports the following:

  • action (pulumi.Input[str])

  • description (pulumi.Input[str]) - An optional description of this security policy. Max size is 2048.

  • match (pulumi.Input[dict])

    • config (pulumi.Input[dict])

      • srcIpRanges (pulumi.Input[list])

    • versionedExpr (pulumi.Input[str])

  • preview (pulumi.Input[bool])

  • priority (pulumi.Input[float])

description = None

An optional description of this security policy. Max size is 2048.

fingerprint = None

Fingerprint of this resource.

name = None

The name of the security policy.

project = None

The project in which the resource belongs. If it is not provided, the provider project is used.

rules = None

The set of rules that belong to this policy. There must always be a default rule (rule with priority 2147483647 and match “*”). If no rules are provided when creating a security policy, a default rule with action “allow” will be added. Structure is documented below.

  • action (str)

  • description (str) - An optional description of this security policy. Max size is 2048.

  • match (dict)

    • config (dict)

      • srcIpRanges (list)

    • versionedExpr (str)

  • preview (bool)

  • priority (float)

The URI of the created resource.

static get(resource_name, id, opts=None, description=None, fingerprint=None, name=None, project=None, rules=None, self_link=None)

Get an existing SecurityPolicy resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • description (pulumi.Input[str]) – An optional description of this security policy. Max size is 2048.

  • fingerprint (pulumi.Input[str]) – Fingerprint of this resource.

  • name (pulumi.Input[str]) – The name of the security policy.

  • project (pulumi.Input[str]) – The project in which the resource belongs. If it is not provided, the provider project is used.

  • rules (pulumi.Input[list]) – The set of rules that belong to this policy. There must always be a default rule (rule with priority 2147483647 and match “*”). If no rules are provided when creating a security policy, a default rule with action “allow” will be added. Structure is documented below.

  • self_link (pulumi.Input[str]) – The URI of the created resource.

The rules object supports the following:

  • action (pulumi.Input[str])

  • description (pulumi.Input[str]) - An optional description of this security policy. Max size is 2048.

  • match (pulumi.Input[dict])

    • config (pulumi.Input[dict])

      • srcIpRanges (pulumi.Input[list])

    • versionedExpr (pulumi.Input[str])

  • preview (pulumi.Input[bool])

  • priority (pulumi.Input[float])

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_gcp.compute.SecurityScanConfig(resource_name, opts=None, authentication=None, blacklist_patterns=None, display_name=None, export_to_security_command_center=None, max_qps=None, project=None, schedule=None, starting_urls=None, target_platforms=None, user_agent=None, __props__=None, __name__=None, __opts__=None)

A ScanConfig resource contains the configurations to launch a scan.

To get more information about ScanConfig, see:

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • project (pulumi.Input[str]) – The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

The authentication object supports the following:

  • customAccount (pulumi.Input[dict])

    • loginUrl (pulumi.Input[str])

    • password (pulumi.Input[str])

    • username (pulumi.Input[str])

  • googleAccount (pulumi.Input[dict])

    • password (pulumi.Input[str])

    • username (pulumi.Input[str])

The schedule object supports the following:

  • intervalDurationDays (pulumi.Input[float])

  • scheduleTime (pulumi.Input[str])

project = None

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

static get(resource_name, id, opts=None, authentication=None, blacklist_patterns=None, display_name=None, export_to_security_command_center=None, max_qps=None, name=None, project=None, schedule=None, starting_urls=None, target_platforms=None, user_agent=None)

Get an existing SecurityScanConfig resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • project (pulumi.Input[str]) – The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

The authentication object supports the following:

  • customAccount (pulumi.Input[dict])

    • loginUrl (pulumi.Input[str])

    • password (pulumi.Input[str])

    • username (pulumi.Input[str])

  • googleAccount (pulumi.Input[dict])

    • password (pulumi.Input[str])

    • username (pulumi.Input[str])

The schedule object supports the following:

  • intervalDurationDays (pulumi.Input[float])

  • scheduleTime (pulumi.Input[str])

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_gcp.compute.SharedVPCHostProject(resource_name, opts=None, project=None, __props__=None, __name__=None, __opts__=None)

Enables the Google Compute Engine Shared VPC feature for a project, assigning it as a Shared VPC host project.

For more information, see, the Project API documentation, where the Shared VPC feature is referred to by its former name “XPN”.

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • project (pulumi.Input[str]) – The ID of the project that will serve as a Shared VPC host project

project = None

The ID of the project that will serve as a Shared VPC host project

static get(resource_name, id, opts=None, project=None)

Get an existing SharedVPCHostProject resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • project (pulumi.Input[str]) – The ID of the project that will serve as a Shared VPC host project

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_gcp.compute.SharedVPCServiceProject(resource_name, opts=None, host_project=None, service_project=None, __props__=None, __name__=None, __opts__=None)

Enables the Google Compute Engine Shared VPC feature for a project, assigning it as a Shared VPC service project associated with a given host project.

For more information, see, the Project API documentation, where the Shared VPC feature is referred to by its former name “XPN”.

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • host_project (pulumi.Input[str]) – The ID of a host project to associate.

  • service_project (pulumi.Input[str]) – The ID of the project that will serve as a Shared VPC service project.

host_project = None

The ID of a host project to associate.

service_project = None

The ID of the project that will serve as a Shared VPC service project.

static get(resource_name, id, opts=None, host_project=None, service_project=None)

Get an existing SharedVPCServiceProject resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • host_project (pulumi.Input[str]) – The ID of a host project to associate.

  • service_project (pulumi.Input[str]) – The ID of the project that will serve as a Shared VPC service project.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_gcp.compute.Snapshot(resource_name, opts=None, description=None, labels=None, name=None, project=None, snapshot_encryption_key=None, source_disk=None, source_disk_encryption_key=None, zone=None, __props__=None, __name__=None, __opts__=None)

Represents a Persistent Disk Snapshot resource.

Use snapshots to back up data from your persistent disks. Snapshots are different from public images and custom images, which are used primarily to create instances or configure instance templates. Snapshots are useful for periodic backup of the data on your persistent disks. You can create snapshots from persistent disks even while they are attached to running instances.

Snapshots are incremental, so you can create regular snapshots on a persistent disk faster and at a much lower cost than if you regularly created a full image of the disk.

To get more information about Snapshot, see:

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • project (pulumi.Input[str]) – The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

The snapshot_encryption_key object supports the following:

  • rawKey (pulumi.Input[str])

  • sha256 (pulumi.Input[str])

The source_disk_encryption_key object supports the following:

  • rawKey (pulumi.Input[str])

project = None

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

The URI of the created resource.

static get(resource_name, id, opts=None, creation_timestamp=None, description=None, disk_size_gb=None, label_fingerprint=None, labels=None, licenses=None, name=None, project=None, self_link=None, snapshot_encryption_key=None, snapshot_id=None, source_disk=None, source_disk_encryption_key=None, source_disk_link=None, storage_bytes=None, zone=None)

Get an existing Snapshot resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • project (pulumi.Input[str]) – The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

  • self_link (pulumi.Input[str]) – The URI of the created resource.

The snapshot_encryption_key object supports the following:

  • rawKey (pulumi.Input[str])

  • sha256 (pulumi.Input[str])

The source_disk_encryption_key object supports the following:

  • rawKey (pulumi.Input[str])

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_gcp.compute.Subnetwork(resource_name, opts=None, description=None, enable_flow_logs=None, ip_cidr_range=None, log_config=None, name=None, network=None, private_ip_google_access=None, project=None, region=None, secondary_ip_ranges=None, __props__=None, __name__=None, __opts__=None)

A VPC network is a virtual version of the traditional physical networks that exist within and between physical data centers. A VPC network provides connectivity for your Compute Engine virtual machine (VM) instances, Container Engine containers, App Engine Flex services, and other network-related resources.

Each GCP project contains one or more VPC networks. Each VPC network is a global entity spanning all GCP regions. This global VPC network allows VM instances and other resources to communicate with each other via internal, private IP addresses.

Each VPC network is subdivided into subnets, and each subnet is contained within a single region. You can have more than one subnet in a region for a given VPC network. Each subnet has a contiguous private RFC1918 IP space. You create instances, containers, and the like in these subnets. When you create an instance, you must create it in a subnet, and the instance draws its internal IP address from that subnet.

Virtual machine (VM) instances in a VPC network can communicate with instances in all other subnets of the same VPC network, regardless of region, using their RFC1918 private IP addresses. You can isolate portions of the network, even entire subnets, using firewall rules.

To get more information about Subnetwork, see:

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • project (pulumi.Input[str]) – The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

The log_config object supports the following:

  • aggregationInterval (pulumi.Input[str])

  • flowSampling (pulumi.Input[float])

  • metadata (pulumi.Input[str])

The secondary_ip_ranges object supports the following:

  • ip_cidr_range (pulumi.Input[str])

  • rangeName (pulumi.Input[str])

project = None

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

The URI of the created resource.

static get(resource_name, id, opts=None, creation_timestamp=None, description=None, enable_flow_logs=None, fingerprint=None, gateway_address=None, ip_cidr_range=None, log_config=None, name=None, network=None, private_ip_google_access=None, project=None, region=None, secondary_ip_ranges=None, self_link=None)

Get an existing Subnetwork resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • project (pulumi.Input[str]) – The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

  • self_link (pulumi.Input[str]) – The URI of the created resource.

The log_config object supports the following:

  • aggregationInterval (pulumi.Input[str])

  • flowSampling (pulumi.Input[float])

  • metadata (pulumi.Input[str])

The secondary_ip_ranges object supports the following:

  • ip_cidr_range (pulumi.Input[str])

  • rangeName (pulumi.Input[str])

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_gcp.compute.SubnetworkIAMBinding(resource_name, opts=None, members=None, project=None, region=None, role=None, subnetwork=None, __props__=None, __name__=None, __opts__=None)

Create a SubnetworkIAMBinding resource with the given unique name, props, and options.

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • project (pulumi.Input[str]) – The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

  • region (pulumi.Input[str]) – The region of the subnetwork. If unspecified, this defaults to the region configured in the provider.

  • role (pulumi.Input[str]) – The role that should be applied. Only one compute.SubnetworkIAMBinding can be used per role. Note that custom roles must be of the format [projects|organizations]/{parent-name}/roles/{role-name}.

  • subnetwork (pulumi.Input[str]) – The name of the subnetwork.

etag = None

(Computed) The etag of the subnetwork’s IAM policy.

project = None

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

region = None

The region of the subnetwork. If unspecified, this defaults to the region configured in the provider.

role = None

The role that should be applied. Only one compute.SubnetworkIAMBinding can be used per role. Note that custom roles must be of the format [projects|organizations]/{parent-name}/roles/{role-name}.

subnetwork = None

The name of the subnetwork.

static get(resource_name, id, opts=None, etag=None, members=None, project=None, region=None, role=None, subnetwork=None)

Get an existing SubnetworkIAMBinding resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • etag (pulumi.Input[str]) – (Computed) The etag of the subnetwork’s IAM policy.

  • project (pulumi.Input[str]) – The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

  • region (pulumi.Input[str]) – The region of the subnetwork. If unspecified, this defaults to the region configured in the provider.

  • role (pulumi.Input[str]) – The role that should be applied. Only one compute.SubnetworkIAMBinding can be used per role. Note that custom roles must be of the format [projects|organizations]/{parent-name}/roles/{role-name}.

  • subnetwork (pulumi.Input[str]) – The name of the subnetwork.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_gcp.compute.SubnetworkIAMMember(resource_name, opts=None, member=None, project=None, region=None, role=None, subnetwork=None, __props__=None, __name__=None, __opts__=None)

Create a SubnetworkIAMMember resource with the given unique name, props, and options.

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • project (pulumi.Input[str]) – The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

  • region (pulumi.Input[str]) – The region of the subnetwork. If unspecified, this defaults to the region configured in the provider.

  • role (pulumi.Input[str]) – The role that should be applied. Only one compute.SubnetworkIAMBinding can be used per role. Note that custom roles must be of the format [projects|organizations]/{parent-name}/roles/{role-name}.

  • subnetwork (pulumi.Input[str]) – The name of the subnetwork.

etag = None

(Computed) The etag of the subnetwork’s IAM policy.

project = None

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

region = None

The region of the subnetwork. If unspecified, this defaults to the region configured in the provider.

role = None

The role that should be applied. Only one compute.SubnetworkIAMBinding can be used per role. Note that custom roles must be of the format [projects|organizations]/{parent-name}/roles/{role-name}.

subnetwork = None

The name of the subnetwork.

static get(resource_name, id, opts=None, etag=None, member=None, project=None, region=None, role=None, subnetwork=None)

Get an existing SubnetworkIAMMember resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • etag (pulumi.Input[str]) – (Computed) The etag of the subnetwork’s IAM policy.

  • project (pulumi.Input[str]) – The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

  • region (pulumi.Input[str]) – The region of the subnetwork. If unspecified, this defaults to the region configured in the provider.

  • role (pulumi.Input[str]) – The role that should be applied. Only one compute.SubnetworkIAMBinding can be used per role. Note that custom roles must be of the format [projects|organizations]/{parent-name}/roles/{role-name}.

  • subnetwork (pulumi.Input[str]) – The name of the subnetwork.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_gcp.compute.SubnetworkIAMPolicy(resource_name, opts=None, policy_data=None, project=None, region=None, subnetwork=None, __props__=None, __name__=None, __opts__=None)

Create a SubnetworkIAMPolicy resource with the given unique name, props, and options.

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • policy_data (pulumi.Input[str]) – The policy data generated by a organizations.getIAMPolicy data source.

  • project (pulumi.Input[str]) – The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

  • region (pulumi.Input[str]) – The region of the subnetwork. If unspecified, this defaults to the region configured in the provider.

  • subnetwork (pulumi.Input[str]) – The name of the subnetwork.

etag = None

(Computed) The etag of the subnetwork’s IAM policy.

policy_data = None

The policy data generated by a organizations.getIAMPolicy data source.

project = None

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

region = None

The region of the subnetwork. If unspecified, this defaults to the region configured in the provider.

subnetwork = None

The name of the subnetwork.

static get(resource_name, id, opts=None, etag=None, policy_data=None, project=None, region=None, subnetwork=None)

Get an existing SubnetworkIAMPolicy resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • etag (pulumi.Input[str]) – (Computed) The etag of the subnetwork’s IAM policy.

  • policy_data (pulumi.Input[str]) – The policy data generated by a organizations.getIAMPolicy data source.

  • project (pulumi.Input[str]) – The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

  • region (pulumi.Input[str]) – The region of the subnetwork. If unspecified, this defaults to the region configured in the provider.

  • subnetwork (pulumi.Input[str]) – The name of the subnetwork.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_gcp.compute.TargetHttpProxy(resource_name, opts=None, description=None, name=None, project=None, url_map=None, __props__=None, __name__=None, __opts__=None)

Represents a TargetHttpProxy resource, which is used by one or more global forwarding rule to route incoming HTTP requests to a URL map.

To get more information about TargetHttpProxy, see:

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • project (pulumi.Input[str]) – The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

project = None

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

The URI of the created resource.

static get(resource_name, id, opts=None, creation_timestamp=None, description=None, name=None, project=None, proxy_id=None, self_link=None, url_map=None)

Get an existing TargetHttpProxy resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • project (pulumi.Input[str]) – The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

  • self_link (pulumi.Input[str]) – The URI of the created resource.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_gcp.compute.TargetHttpsProxy(resource_name, opts=None, description=None, name=None, project=None, quic_override=None, ssl_certificates=None, ssl_policy=None, url_map=None, __props__=None, __name__=None, __opts__=None)

Represents a TargetHttpsProxy resource, which is used by one or more global forwarding rule to route incoming HTTPS requests to a URL map.

To get more information about TargetHttpsProxy, see:

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • project (pulumi.Input[str]) – The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

project = None

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

The URI of the created resource.

static get(resource_name, id, opts=None, creation_timestamp=None, description=None, name=None, project=None, proxy_id=None, quic_override=None, self_link=None, ssl_certificates=None, ssl_policy=None, url_map=None)

Get an existing TargetHttpsProxy resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • project (pulumi.Input[str]) – The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

  • self_link (pulumi.Input[str]) – The URI of the created resource.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_gcp.compute.TargetInstance(resource_name, opts=None, description=None, instance=None, name=None, nat_policy=None, project=None, zone=None, __props__=None, __name__=None, __opts__=None)

Represents a TargetInstance resource which defines an endpoint instance that terminates traffic of certain protocols. In particular, they are used in Protocol Forwarding, where forwarding rules can send packets to a non-NAT’ed target instance. Each target instance contains a single virtual machine instance that receives and handles traffic from the corresponding forwarding rules.

To get more information about TargetInstance, see:

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • project (pulumi.Input[str]) – The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

project = None

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

The URI of the created resource.

static get(resource_name, id, opts=None, creation_timestamp=None, description=None, instance=None, name=None, nat_policy=None, project=None, self_link=None, zone=None)

Get an existing TargetInstance resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • project (pulumi.Input[str]) – The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

  • self_link (pulumi.Input[str]) – The URI of the created resource.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_gcp.compute.TargetPool(resource_name, opts=None, backup_pool=None, description=None, failover_ratio=None, health_checks=None, instances=None, name=None, project=None, region=None, session_affinity=None, __props__=None, __name__=None, __opts__=None)

Manages a Target Pool within GCE. This is a collection of instances used as target of a network load balancer (Forwarding Rule). For more information see the official documentation and API.

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • backup_pool (pulumi.Input[str]) – URL to the backup target pool. Must also set failover_ratio.

  • description (pulumi.Input[str]) – Textual description field.

  • failover_ratio (pulumi.Input[float]) – Ratio (0 to 1) of failed nodes before using the backup pool (which must also be set).

  • health_checks (pulumi.Input[str]) – List of zero or one health check name or self_link. Only legacy compute.HttpHealthCheck is supported.

  • instances (pulumi.Input[list]) – List of instances in the pool. They can be given as URLs, or in the form of “zone/name”. Note that the instances need not exist at the time of target pool creation, so there is no need to use interpolators to create a dependency on the instances from the target pool.

  • name (pulumi.Input[str]) – A unique name for the resource, required by GCE. Changing this forces a new resource to be created.

  • project (pulumi.Input[str]) – The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

  • region (pulumi.Input[str]) – Where the target pool resides. Defaults to project region.

  • session_affinity (pulumi.Input[str]) – How to distribute load. Options are “NONE” (no affinity). “CLIENT_IP” (hash of the source/dest addresses / ports), and “CLIENT_IP_PROTO” also includes the protocol (default “NONE”).

backup_pool = None

URL to the backup target pool. Must also set failover_ratio.

description = None

Textual description field.

failover_ratio = None

Ratio (0 to 1) of failed nodes before using the backup pool (which must also be set).

health_checks = None

List of zero or one health check name or self_link. Only legacy compute.HttpHealthCheck is supported.

instances = None

List of instances in the pool. They can be given as URLs, or in the form of “zone/name”. Note that the instances need not exist at the time of target pool creation, so there is no need to use interpolators to create a dependency on the instances from the target pool.

name = None

A unique name for the resource, required by GCE. Changing this forces a new resource to be created.

project = None

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

region = None

Where the target pool resides. Defaults to project region.

The URI of the created resource.

session_affinity = None

How to distribute load. Options are “NONE” (no affinity). “CLIENT_IP” (hash of the source/dest addresses / ports), and “CLIENT_IP_PROTO” also includes the protocol (default “NONE”).

static get(resource_name, id, opts=None, backup_pool=None, description=None, failover_ratio=None, health_checks=None, instances=None, name=None, project=None, region=None, self_link=None, session_affinity=None)

Get an existing TargetPool resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • backup_pool (pulumi.Input[str]) – URL to the backup target pool. Must also set failover_ratio.

  • description (pulumi.Input[str]) – Textual description field.

  • failover_ratio (pulumi.Input[float]) – Ratio (0 to 1) of failed nodes before using the backup pool (which must also be set).

  • health_checks (pulumi.Input[str]) – List of zero or one health check name or self_link. Only legacy compute.HttpHealthCheck is supported.

  • instances (pulumi.Input[list]) – List of instances in the pool. They can be given as URLs, or in the form of “zone/name”. Note that the instances need not exist at the time of target pool creation, so there is no need to use interpolators to create a dependency on the instances from the target pool.

  • name (pulumi.Input[str]) – A unique name for the resource, required by GCE. Changing this forces a new resource to be created.

  • project (pulumi.Input[str]) – The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

  • region (pulumi.Input[str]) – Where the target pool resides. Defaults to project region.

  • self_link (pulumi.Input[str]) – The URI of the created resource.

  • session_affinity (pulumi.Input[str]) – How to distribute load. Options are “NONE” (no affinity). “CLIENT_IP” (hash of the source/dest addresses / ports), and “CLIENT_IP_PROTO” also includes the protocol (default “NONE”).

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_gcp.compute.TargetSSLProxy(resource_name, opts=None, backend_service=None, description=None, name=None, project=None, proxy_header=None, ssl_certificates=None, ssl_policy=None, __props__=None, __name__=None, __opts__=None)

Represents a TargetSslProxy resource, which is used by one or more global forwarding rule to route incoming SSL requests to a backend service.

To get more information about TargetSslProxy, see:

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • project (pulumi.Input[str]) – The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

project = None

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

The URI of the created resource.

static get(resource_name, id, opts=None, backend_service=None, creation_timestamp=None, description=None, name=None, project=None, proxy_header=None, proxy_id=None, self_link=None, ssl_certificates=None, ssl_policy=None)

Get an existing TargetSSLProxy resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • project (pulumi.Input[str]) – The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

  • self_link (pulumi.Input[str]) – The URI of the created resource.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_gcp.compute.TargetTCPProxy(resource_name, opts=None, backend_service=None, description=None, name=None, project=None, proxy_header=None, __props__=None, __name__=None, __opts__=None)

Represents a TargetTcpProxy resource, which is used by one or more global forwarding rule to route incoming TCP requests to a Backend service.

To get more information about TargetTcpProxy, see:

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • project (pulumi.Input[str]) – The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

project = None

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

The URI of the created resource.

static get(resource_name, id, opts=None, backend_service=None, creation_timestamp=None, description=None, name=None, project=None, proxy_header=None, proxy_id=None, self_link=None)

Get an existing TargetTCPProxy resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • project (pulumi.Input[str]) – The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

  • self_link (pulumi.Input[str]) – The URI of the created resource.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_gcp.compute.URLMap(resource_name, opts=None, default_service=None, description=None, host_rules=None, name=None, path_matchers=None, project=None, tests=None, __props__=None, __name__=None, __opts__=None)

UrlMaps are used to route requests to a backend service based on rules that you define for the host and path of an incoming URL.

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • project (pulumi.Input[str]) – The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

The host_rules object supports the following:

  • description (pulumi.Input[str])

  • hosts (pulumi.Input[list])

  • pathMatcher (pulumi.Input[str])

The path_matchers object supports the following:

  • default_service (pulumi.Input[str])

  • description (pulumi.Input[str])

  • name (pulumi.Input[str])

  • pathRules (pulumi.Input[list])

    • paths (pulumi.Input[list])

    • service (pulumi.Input[str])

The tests object supports the following:

  • description (pulumi.Input[str])

  • host (pulumi.Input[str])

  • path (pulumi.Input[str])

  • service (pulumi.Input[str])

project = None

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

The URI of the created resource.

static get(resource_name, id, opts=None, creation_timestamp=None, default_service=None, description=None, fingerprint=None, host_rules=None, map_id=None, name=None, path_matchers=None, project=None, self_link=None, tests=None)

Get an existing URLMap resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • project (pulumi.Input[str]) – The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

  • self_link (pulumi.Input[str]) – The URI of the created resource.

The host_rules object supports the following:

  • description (pulumi.Input[str])

  • hosts (pulumi.Input[list])

  • pathMatcher (pulumi.Input[str])

The path_matchers object supports the following:

  • default_service (pulumi.Input[str])

  • description (pulumi.Input[str])

  • name (pulumi.Input[str])

  • pathRules (pulumi.Input[list])

    • paths (pulumi.Input[list])

    • service (pulumi.Input[str])

The tests object supports the following:

  • description (pulumi.Input[str])

  • host (pulumi.Input[str])

  • path (pulumi.Input[str])

  • service (pulumi.Input[str])

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_gcp.compute.VPNGateway(resource_name, opts=None, description=None, name=None, network=None, project=None, region=None, __props__=None, __name__=None, __opts__=None)

Represents a VPN gateway running in GCP. This virtual device is managed by Google, but used only by you.

To get more information about VpnGateway, see:

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • project (pulumi.Input[str]) – The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

project = None

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

The URI of the created resource.

static get(resource_name, id, opts=None, creation_timestamp=None, description=None, name=None, network=None, project=None, region=None, self_link=None)

Get an existing VPNGateway resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • project (pulumi.Input[str]) – The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

  • self_link (pulumi.Input[str]) – The URI of the created resource.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_gcp.compute.VPNTunnel(resource_name, opts=None, description=None, ike_version=None, labels=None, local_traffic_selectors=None, name=None, peer_external_gateway=None, peer_external_gateway_interface=None, peer_gcp_gateway=None, peer_ip=None, project=None, region=None, remote_traffic_selectors=None, router=None, shared_secret=None, target_vpn_gateway=None, vpn_gateway=None, vpn_gateway_interface=None, __props__=None, __name__=None, __opts__=None)

VPN tunnel resource.

To get more information about VpnTunnel, see:

Warning: All arguments including the shared secret will be stored in the raw state as plain-text. Read more about sensitive data in state.

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • project (pulumi.Input[str]) – The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

project = None

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

The URI of the created resource.

static get(resource_name, id, opts=None, creation_timestamp=None, description=None, detailed_status=None, ike_version=None, label_fingerprint=None, labels=None, local_traffic_selectors=None, name=None, peer_external_gateway=None, peer_external_gateway_interface=None, peer_gcp_gateway=None, peer_ip=None, project=None, region=None, remote_traffic_selectors=None, router=None, self_link=None, shared_secret=None, shared_secret_hash=None, target_vpn_gateway=None, vpn_gateway=None, vpn_gateway_interface=None)

Get an existing VPNTunnel resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • project (pulumi.Input[str]) – The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

  • self_link (pulumi.Input[str]) – The URI of the created resource.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

pulumi_gcp.compute.get_address(name=None, project=None, region=None, opts=None)

Get the IP address from a static address. For more information see the official API documentation.

Parameters
  • name (str) – A unique name for the resource, required by GCE.

  • project (str) – The project in which the resource belongs. If it is not provided, the provider project is used.

  • region (str) – The Region in which the created address reside. If it is not provided, the provider region is used.

pulumi_gcp.compute.get_backend_service(name=None, project=None, opts=None)

Provide access to a Backend Service’s attribute. For more information see the official documentation and the API.

Parameters
  • name (str) – The name of the Backend Service.

  • project (str) – The project in which the resource belongs. If it is not provided, the provider project is used.

pulumi_gcp.compute.get_certificate(name=None, project=None, opts=None)

Get info about a Google Compute SSL Certificate from its name.

Parameters
  • name (str) – The name of the certificate.

  • project (str) – The project in which the resource belongs. If it is not provided, the provider project is used.

pulumi_gcp.compute.get_default_service_account(project=None, opts=None)

Use this data source to retrieve default service account for this project

Parameters

project (str) – The project ID. If it is not provided, the provider project is used.

pulumi_gcp.compute.get_forwarding_rule(name=None, project=None, region=None, opts=None)

Get a forwarding rule within GCE from its name.

Parameters
  • name (str) – The name of the forwarding rule.

  • project (str) – The project in which the resource belongs. If it is not provided, the provider project is used.

  • region (str) – The region in which the resource belongs. If it is not provided, the project region is used.

pulumi_gcp.compute.get_global_address(name=None, project=None, opts=None)

Get the IP address from a static address reserved for a Global Forwarding Rule which are only used for HTTP load balancing. For more information see the official API documentation.

Parameters
  • name (str) – A unique name for the resource, required by GCE.

  • project (str) – The project in which the resource belongs. If it is not provided, the provider project is used.

pulumi_gcp.compute.get_image(family=None, name=None, project=None, opts=None)

Get information about a Google Compute Image. Check that your service account has the compute.imageUser role if you want to share custom images from another project. If you want to use [public images][pubimg], do not forget to specify the dedicated project. For more information see the official documentation and its API.

Parameters

project (str) – The project in which the resource belongs. If it is not provided, the provider project is used. If you are using a [public base image][pubimg], be sure to specify the correct Image Project.

pulumi_gcp.compute.get_instance(name=None, project=None, self_link=None, zone=None, opts=None)

Get information about a VM instance resource within GCE. For more information see the official documentation and API.

Parameters
  • name (str) – The name of the instance. One of name or self_link must be provided.

  • project (str) – The ID of the project in which the resource belongs. If self_link is provided, this value is ignored. If neither self_link nor project are provided, the provider project is used.

  • self_link (str) – The self link of the instance. One of name or self_link must be provided.

  • zone (str) – The zone of the instance. If self_link is provided, this value is ignored. If neither self_link nor zone are provided, the provider zone is used.

pulumi_gcp.compute.get_instance_group(name=None, project=None, self_link=None, zone=None, opts=None)

Get a Compute Instance Group within GCE. For more information, see the official documentation and API

Parameters
  • name (str) – The name of the instance group. Either name or self_link must be provided.

  • project (str) – The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

  • self_link (str) – The self link of the instance group. Either name or self_link must be provided.

  • zone (str) – The zone of the instance group. If referencing the instance group by name and zone is not provided, the provider zone is used.

pulumi_gcp.compute.get_lbip_ranges(opts=None)

Use this data source to access IP ranges in your firewall rules.

https://cloud.google.com/compute/docs/load-balancing/health-checks#health_check_source_ips_and_firewall_rules

pulumi_gcp.compute.get_netblock_ip_ranges(opts=None)

Use this data source to get the IP ranges from the sender policy framework (SPF) record of _cloud-netblocks.googleusercontent

https://cloud.google.com/compute/docs/faq#where_can_i_find_product_name_short_ip_ranges

pulumi_gcp.compute.get_network(name=None, project=None, opts=None)

Get a network within GCE from its name.

Parameters
  • name (str) – The name of the network.

  • project (str) – The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

pulumi_gcp.compute.get_node_types(project=None, zone=None, opts=None)

Provides available node types for Compute Engine sole-tenant nodes in a zone for a given project. For more information, see the official documentation and API.

Parameters
  • project (str) – ID of the project to list available node types for. Should match the project the nodes of this type will be deployed to. Defaults to the project that the provider is authenticated with.

  • zone (str) – The zone to list node types for. Should be in zone of intended node groups and region of referencing node template. If zone is not specified, the provider-level zone must be set and is used instead.

pulumi_gcp.compute.get_region_instance_group(name=None, project=None, region=None, self_link=None, opts=None)

Get a Compute Region Instance Group within GCE. For more information, see the official documentation and API.

The most common use of this datasource will be to fetch information about the instances inside regional managed instance groups, for instance:

Parameters
  • name (str) – The name of the instance group. One of name or self_link must be provided.

  • project (str) – The ID of the project in which the resource belongs. If self_link is provided, this value is ignored. If neither self_link nor project are provided, the provider project is used.

  • region (str) – The region in which the resource belongs. If self_link is provided, this value is ignored. If neither self_link nor region are provided, the provider region is used.

  • self_link (str) – The link to the instance group. One of name or self_link must be provided.

pulumi_gcp.compute.get_regions(project=None, status=None, opts=None)

Provides access to available Google Compute regions for a given project. See more about regions and regions in the upstream docs.

Parameters
  • project (str) – Project from which to list available regions. Defaults to project declared in the provider.

  • status (str) – Allows to filter list of regions based on their current status. Status can be either UP or DOWN. Defaults to no filtering (all available regions - both UP and DOWN).

pulumi_gcp.compute.get_ssl_policy(name=None, project=None, opts=None)
Gets an SSL Policy within GCE from its name, for use with Target HTTPS and Target SSL Proxies.

For more information see the official documentation.

Parameters
  • name (str) – The name of the SSL Policy.

  • project (str) – The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

pulumi_gcp.compute.get_subnetwork(name=None, project=None, region=None, self_link=None, opts=None)

Get a subnetwork within GCE from its name and region.

Parameters
  • name (str) – The name of the subnetwork. One of name or self_link must be specified.

  • project (str) – The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

  • region (str) – The region this subnetwork has been created in. If unspecified, this defaults to the region configured in the provider.

  • self_link (str) – The self link of the subnetwork. If self_link is specified, name, project, and region are ignored.

pulumi_gcp.compute.get_vpn_gateway(name=None, project=None, region=None, opts=None)

Get a VPN gateway within GCE from its name.

Parameters
  • name (str) – The name of the VPN gateway.

  • project (str) – The project in which the resource belongs. If it is not provided, the provider project is used.

  • region (str) – The region in which the resource belongs. If it is not provided, the project region is used.

pulumi_gcp.compute.get_zones(project=None, region=None, status=None, opts=None)

Provides access to available Google Compute zones in a region for a given project. See more about regions and zones in the upstream docs.

Parameters
  • project (str) – Project from which to list available zones. Defaults to project declared in the provider.

  • region (str) – Region from which to list available zones. Defaults to region declared in the provider.

  • status (str) – Allows to filter list of zones based on their current status. Status can be either UP or DOWN. Defaults to no filtering (all available zones - both UP and DOWN).