Module types/output

namespace accesscontextmanager

namespace appengine

namespace artifactregistry

namespace bigquery

namespace bigtable

namespace billing

namespace binaryauthorization

namespace cloudbuild

namespace cloudfunctions

namespace cloudrun

namespace cloudscheduler

namespace cloudtasks

namespace composer

namespace compute

namespace container

namespace containeranalysis

namespace datafusion

namespace dataproc

namespace datastore

namespace deploymentmanager

namespace diagflow

namespace dns

namespace endpoints

namespace filestore

namespace firestore

namespace folder

namespace gameservices

namespace healthcare

namespace iam

namespace iap

namespace identityplatform

namespace iot

namespace kms

namespace logging

namespace ml

namespace monitoring

namespace organizations

namespace projects

namespace pubsub

namespace runtimeconfig

namespace secretmanager

namespace serviceAccount

namespace servicedirectory

namespace sourcerepo

namespace spanner

namespace sql

namespace storage

namespace tpu

namespace accesscontextmanager

interface AccessLevelBasic

interface AccessLevelBasic

property combiningFunction

combiningFunction?: undefined | string;

How the conditions list should be combined to determine if a request is granted this AccessLevel. If AND is used, each Condition in conditions must be satisfied for the AccessLevel to be applied. If OR is used, at least one Condition in conditions must be satisfied for the AccessLevel to be applied.

property conditions

conditions: AccessLevelBasicCondition[];

A set of requirements for the AccessLevel to be granted. Structure is documented below.

interface AccessLevelBasicCondition

interface AccessLevelBasicCondition

property devicePolicy

devicePolicy?: outputs.accesscontextmanager.AccessLevelBasicConditionDevicePolicy;

Device specific restrictions, all restrictions must hold for the Condition to be true. If not specified, all devices are allowed. Structure is documented below.

property ipSubnetworks

ipSubnetworks?: string[];

A list of CIDR block IP subnetwork specification. May be IPv4 or IPv6. Note that for a CIDR IP address block, the specified IP address portion must be properly truncated (i.e. all the host bits must be zero) or the input is considered malformed. For example, “192.0.2.0/24” is accepted but “192.0.2.1/24” is not. Similarly, for IPv6, “2001:db8::/32” is accepted whereas “2001:db8::1/32” is not. The originating IP of a request must be in one of the listed subnets in order for this Condition to be true. If empty, all IP addresses are allowed.

property members

members?: string[];

An allowed list of members (users, service accounts). Using groups is not supported yet. The signed-in user originating the request must be a part of one of the provided members. If not specified, a request may come from any user (logged in/not logged in, not present in any groups, etc.). Formats: user:{emailid}, serviceAccount:{emailid}

property negate

negate?: undefined | false | true;

Whether to negate the Condition. If true, the Condition becomes a NAND over its non-empty fields, each field must be false for the Condition overall to be satisfied. Defaults to false.

property regions

regions?: string[];

The request must originate from one of the provided countries/regions. Format: A valid ISO 3166-1 alpha-2 code.

property requiredAccessLevels

requiredAccessLevels?: string[];

A list of other access levels defined in the same Policy, referenced by resource name. Referencing an AccessLevel which does not exist is an error. All access levels listed must be granted for the Condition to be true. Format: accessPolicies/{policy_id}/accessLevels/{short_name}

interface AccessLevelBasicConditionDevicePolicy

interface AccessLevelBasicConditionDevicePolicy

property allowedDeviceManagementLevels

allowedDeviceManagementLevels?: string[];

A list of allowed device management levels. An empty list allows all management levels.

property allowedEncryptionStatuses

allowedEncryptionStatuses?: string[];

A list of allowed encryptions statuses. An empty list allows all statuses.

property osConstraints

osConstraints?: AccessLevelBasicConditionDevicePolicyOsConstraint[];

A list of allowed OS versions. An empty list allows all types and all versions. Structure is documented below.

property requireAdminApproval

requireAdminApproval?: undefined | false | true;

Whether the device needs to be approved by the customer admin.

property requireCorpOwned

requireCorpOwned?: undefined | false | true;

Whether the device needs to be corp owned.

property requireScreenLock

requireScreenLock?: undefined | false | true;

Whether or not screenlock is required for the DevicePolicy to be true. Defaults to false.

interface AccessLevelBasicConditionDevicePolicyOsConstraint

interface AccessLevelBasicConditionDevicePolicyOsConstraint

property minimumVersion

minimumVersion?: undefined | string;

The minimum allowed OS version. If not set, any version of this OS satisfies the constraint. Format: “major.minor.patch” such as “10.5.301”, “9.2.1”.

property osType

osType: string;

The operating system type of the device.

interface ServicePerimeterSpec

interface ServicePerimeterSpec

property accessLevels

accessLevels?: string[];

A list of AccessLevel resource names that allow resources within the ServicePerimeter to be accessed from the internet. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel is a syntax error. If no AccessLevel names are listed, resources within the perimeter can only be accessed via GCP calls with request origins within the perimeter. For Service Perimeter Bridge, must be empty. Format: accessPolicies/{policy_id}/accessLevels/{access_level_name}

property resources

resources?: string[];

A list of GCP resources that are inside of the service perimeter. Currently only projects are allowed. Format: projects/{project_number}

property restrictedServices

restrictedServices?: string[];

GCP services that are subject to the Service Perimeter restrictions. Must contain a list of services. For example, if storage.googleapis.com is specified, access to the storage buckets inside the perimeter must meet the perimeter’s access restrictions.

property vpcAccessibleServices

vpcAccessibleServices?: outputs.accesscontextmanager.ServicePerimeterSpecVpcAccessibleServices;

Specifies how APIs are allowed to communicate within the Service Perimeter. Structure is documented below.

interface ServicePerimeterSpecVpcAccessibleServices

interface ServicePerimeterSpecVpcAccessibleServices

property allowedServices

allowedServices?: string[];

The list of APIs usable within the Service Perimeter. Must be empty unless enableRestriction is True.

property enableRestriction

enableRestriction?: undefined | false | true;

Whether to restrict API calls within the Service Perimeter to the list of APIs specified in ‘allowedServices’.

interface ServicePerimeterStatus

interface ServicePerimeterStatus

property accessLevels

accessLevels?: string[];

A list of AccessLevel resource names that allow resources within the ServicePerimeter to be accessed from the internet. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel is a syntax error. If no AccessLevel names are listed, resources within the perimeter can only be accessed via GCP calls with request origins within the perimeter. For Service Perimeter Bridge, must be empty. Format: accessPolicies/{policy_id}/accessLevels/{access_level_name}

property resources

resources?: string[];

A list of GCP resources that are inside of the service perimeter. Currently only projects are allowed. Format: projects/{project_number}

property restrictedServices

restrictedServices?: string[];

GCP services that are subject to the Service Perimeter restrictions. Must contain a list of services. For example, if storage.googleapis.com is specified, access to the storage buckets inside the perimeter must meet the perimeter’s access restrictions.

property vpcAccessibleServices

vpcAccessibleServices?: outputs.accesscontextmanager.ServicePerimeterStatusVpcAccessibleServices;

Specifies how APIs are allowed to communicate within the Service Perimeter. Structure is documented below.

interface ServicePerimeterStatusVpcAccessibleServices

interface ServicePerimeterStatusVpcAccessibleServices

property allowedServices

allowedServices?: string[];

The list of APIs usable within the Service Perimeter. Must be empty unless enableRestriction is True.

property enableRestriction

enableRestriction?: undefined | false | true;

Whether to restrict API calls within the Service Perimeter to the list of APIs specified in ‘allowedServices’.

namespace appengine

interface ApplicationFeatureSettings

interface ApplicationFeatureSettings

property splitHealthChecks

splitHealthChecks: boolean;

Set to false to use the legacy health check instead of the readiness and liveness checks.

interface ApplicationIap

interface ApplicationIap

property enabled

enabled?: undefined | false | true;

property oauth2ClientId

oauth2ClientId: string;

OAuth2 client ID to use for the authentication flow.

property oauth2ClientSecret

oauth2ClientSecret: string;

OAuth2 client secret to use for the authentication flow. The SHA-256 hash of the value is returned in the oauth2ClientSecretSha256 field.

property oauth2ClientSecretSha256

oauth2ClientSecretSha256: string;

Hex-encoded SHA-256 hash of the client secret.

interface ApplicationUrlDispatchRule

interface ApplicationUrlDispatchRule

property domain

domain: string;

property path

path: string;

property service

service: string;

interface ApplicationUrlDispatchRulesDispatchRule

interface ApplicationUrlDispatchRulesDispatchRule

property domain

domain?: undefined | string;

Domain name to match against. The wildcard “” is supported if specified before a period: “.“. Defaults to matching all domains: “*“.

property path

path: string;

Pathname within the host. Must start with a “/”. A single “*” can be included at the end of the path. The sum of the lengths of the domain and path may not exceed 100 characters.

property service

service: string;

Pathname within the host. Must start with a “/”. A single “*” can be included at the end of the path. The sum of the lengths of the domain and path may not exceed 100 characters.

interface DomainMappingResourceRecord

interface DomainMappingResourceRecord

property name

name?: undefined | string;

property rrdata

rrdata?: undefined | string;

property type

type?: undefined | string;

interface DomainMappingSslSettings

interface DomainMappingSslSettings

property certificateId

certificateId: string;

ID of the AuthorizedCertificate resource configuring SSL for the application. Clearing this field will remove SSL support. By default, a managed certificate is automatically created for every domain mapping. To omit SSL support or to configure SSL manually, specify SslManagementType.MANUAL on a CREATE or UPDATE request. You must be authorized to administer the AuthorizedCertificate resource to manually map it to a DomainMapping resource. Example: 12345.

property pendingManagedCertificateId

pendingManagedCertificateId: string;

- ID of the managed AuthorizedCertificate resource currently being provisioned, if applicable. Until the new managed certificate has been successfully provisioned, the previous SSL state will be preserved. Once the provisioning process completes, the certificateId field will reflect the new managed certificate and this field will be left empty. To remove SSL support while there is still a pending managed certificate, clear the certificateId field with an update request.

property sslManagementType

sslManagementType: string;

SSL management type for this domain. If AUTOMATIC, a managed certificate is automatically provisioned. If MANUAL, certificateId must be manually specified in order to configure SSL for this domain.

interface EngineSplitTrafficSplit

interface EngineSplitTrafficSplit

property allocations

allocations: {[key: string]: string};

Mapping from version IDs within the service to fractional (0.000, 1] allocations of traffic for that version. Each version can be specified only once, but some versions in the service may not have any traffic allocation. Services that have traffic allocated cannot be deleted until either the service is deleted or their traffic allocation is removed. Allocations must sum to 1. Up to two decimal place precision is supported for IP-based splits and up to three decimal places is supported for cookie-based splits.

property shardBy

shardBy?: undefined | string;

Mechanism used to determine which version a request is sent to. The traffic selection algorithm will be stable for either type until allocations are changed.

interface FlexibleAppVersionApiConfig

interface FlexibleAppVersionApiConfig

property authFailAction

authFailAction?: undefined | string;

Action to take when users access resources that require authentication.

property login

login?: undefined | string;

Level of login required to access this resource.

property script

script: string;

Path to the script from the application root directory.

property securityLevel

securityLevel?: undefined | string;

Security (HTTPS) enforcement for this URL.

property url

url?: undefined | string;

URL to serve the endpoint at.

interface FlexibleAppVersionAutomaticScaling

interface FlexibleAppVersionAutomaticScaling

property coolDownPeriod

coolDownPeriod?: undefined | string;

The time period that the Autoscaler should wait before it starts collecting information from a new instance. This prevents the autoscaler from collecting information when the instance is initializing, during which the collected usage would not be reliable. Default: 120s

property cpuUtilization

cpuUtilization: FlexibleAppVersionAutomaticScalingCpuUtilization;

Target scaling by CPU usage. Structure is documented below.

property diskUtilization

diskUtilization?: outputs.appengine.FlexibleAppVersionAutomaticScalingDiskUtilization;

Target scaling by disk usage. Structure is documented below.

property maxConcurrentRequests

maxConcurrentRequests: number;

Number of concurrent requests an automatic scaling instance can accept before the scheduler spawns a new instance. Defaults to a runtime-specific value.

property maxIdleInstances

maxIdleInstances?: undefined | number;

Maximum number of idle instances that should be maintained for this version.

property maxPendingLatency

maxPendingLatency?: undefined | string;

Maximum amount of time that a request should wait in the pending queue before starting a new instance to handle it.

property maxTotalInstances

maxTotalInstances?: undefined | number;

Maximum number of instances that should be started to handle requests for this version. Default: 20

property minIdleInstances

minIdleInstances?: undefined | number;

Minimum number of idle instances that should be maintained for this version. Only applicable for the default version of a service.

property minPendingLatency

minPendingLatency?: undefined | string;

Minimum amount of time a request should wait in the pending queue before starting a new instance to handle it.

property minTotalInstances

minTotalInstances?: undefined | number;

Minimum number of running instances that should be maintained for this version. Default: 2

property networkUtilization

networkUtilization?: outputs.appengine.FlexibleAppVersionAutomaticScalingNetworkUtilization;

Target scaling by network usage. Structure is documented below.

property requestUtilization

requestUtilization?: outputs.appengine.FlexibleAppVersionAutomaticScalingRequestUtilization;

Target scaling by request utilization. Structure is documented below.

interface FlexibleAppVersionAutomaticScalingCpuUtilization

interface FlexibleAppVersionAutomaticScalingCpuUtilization

property aggregationWindowLength

aggregationWindowLength?: undefined | string;

Period of time over which CPU utilization is calculated.

property targetUtilization

targetUtilization: number;

Target CPU utilization ratio to maintain when scaling. Must be between 0 and 1.

interface FlexibleAppVersionAutomaticScalingDiskUtilization

interface FlexibleAppVersionAutomaticScalingDiskUtilization

property targetReadBytesPerSecond

targetReadBytesPerSecond?: undefined | number;

Target bytes read per second.

property targetReadOpsPerSecond

targetReadOpsPerSecond?: undefined | number;

Target ops read per seconds.

property targetWriteBytesPerSecond

targetWriteBytesPerSecond?: undefined | number;

Target bytes written per second.

property targetWriteOpsPerSecond

targetWriteOpsPerSecond?: undefined | number;

Target ops written per second.

interface FlexibleAppVersionAutomaticScalingNetworkUtilization

interface FlexibleAppVersionAutomaticScalingNetworkUtilization

property targetReceivedBytesPerSecond

targetReceivedBytesPerSecond?: undefined | number;

Target bytes received per second.

property targetReceivedPacketsPerSecond

targetReceivedPacketsPerSecond?: undefined | number;

Target packets received per second.

property targetSentBytesPerSecond

targetSentBytesPerSecond?: undefined | number;

Target bytes sent per second.

property targetSentPacketsPerSecond

targetSentPacketsPerSecond?: undefined | number;

Target packets sent per second.

interface FlexibleAppVersionAutomaticScalingRequestUtilization

interface FlexibleAppVersionAutomaticScalingRequestUtilization

property targetConcurrentRequests

targetConcurrentRequests?: undefined | number;

Target number of concurrent requests.

property targetRequestCountPerSecond

targetRequestCountPerSecond?: undefined | string;

Target requests per second.

interface FlexibleAppVersionDeployment

interface FlexibleAppVersionDeployment

property cloudBuildOptions

cloudBuildOptions?: outputs.appengine.FlexibleAppVersionDeploymentCloudBuildOptions;

Options for the build operations performed as a part of the version deployment. Only applicable when creating a version using source code directly. Structure is documented below.

property container

container?: outputs.appengine.FlexibleAppVersionDeploymentContainer;

The Docker image for the container that runs the version. Structure is documented below.

property files

files?: FlexibleAppVersionDeploymentFile[];

Manifest of the files stored in Google Cloud Storage that are included as part of this version. All files must be readable using the credentials supplied with this call. Structure is documented below.

property zip

zip?: outputs.appengine.FlexibleAppVersionDeploymentZip;

Zip File Structure is documented below.

interface FlexibleAppVersionDeploymentCloudBuildOptions

interface FlexibleAppVersionDeploymentCloudBuildOptions

property appYamlPath

appYamlPath: string;

Path to the yaml file used in deployment, used to determine runtime configuration details.

property cloudBuildTimeout

cloudBuildTimeout?: undefined | string;

The Cloud Build timeout used as part of any dependent builds performed by version creation. Defaults to 10 minutes. A duration in seconds with up to nine fractional digits, terminated by ’s’. Example: “3.5s”.

interface FlexibleAppVersionDeploymentContainer

interface FlexibleAppVersionDeploymentContainer

property image

image: string;

URI to the hosted container image in Google Container Registry. The URI must be fully qualified and include a tag or digest. Examples: “gcr.io/my-project/image:tag” or “gcr.io/my-project/image@digest”

interface FlexibleAppVersionDeploymentFile

interface FlexibleAppVersionDeploymentFile

property name

name: string;

Full Serverless VPC Access Connector name e.g. /projects/my-project/locations/us-central1/connectors/c1.

property sha1Sum

sha1Sum?: undefined | string;

SHA1 checksum of the file

property sourceUrl

sourceUrl: string;

Source URL

interface FlexibleAppVersionDeploymentZip

interface FlexibleAppVersionDeploymentZip

property filesCount

filesCount?: undefined | number;

files count

property sourceUrl

sourceUrl: string;

Source URL

interface FlexibleAppVersionEndpointsApiService

interface FlexibleAppVersionEndpointsApiService

property configId

configId?: undefined | string;

Endpoints service configuration ID as specified by the Service Management API. For example “2016-09-19r1”. By default, the rollout strategy for Endpoints is “FIXED”. This means that Endpoints starts up with a particular configuration ID. When a new configuration is rolled out, Endpoints must be given the new configuration ID. The configId field is used to give the configuration ID and is required in this case. Endpoints also has a rollout strategy called “MANAGED”. When using this, Endpoints fetches the latest configuration and does not need the configuration ID. In this case, configId must be omitted.

property disableTraceSampling

disableTraceSampling?: undefined | false | true;

Enable or disable trace sampling. By default, this is set to false for enabled.

property name

name: string;

Full Serverless VPC Access Connector name e.g. /projects/my-project/locations/us-central1/connectors/c1.

property rolloutStrategy

rolloutStrategy?: undefined | string;

Endpoints rollout strategy. If FIXED, configId must be specified. If MANAGED, configId must be omitted.

interface FlexibleAppVersionEntrypoint

interface FlexibleAppVersionEntrypoint

property shell

shell: string;

The format should be a shell command that can be fed to bash -c.

interface FlexibleAppVersionLivenessCheck

interface FlexibleAppVersionLivenessCheck

property checkInterval

checkInterval?: undefined | string;

Interval between health checks.

property failureThreshold

failureThreshold?: undefined | number;

Number of consecutive failed checks required before considering the VM unhealthy. Default: 4.

property host

host?: undefined | string;

Host header to send when performing a HTTP Readiness check. Example: “myapp.appspot.com”

property initialDelay

initialDelay?: undefined | string;

The initial delay before starting to execute the checks. Default: “300s”

property path

path: string;

The request path.

property successThreshold

successThreshold?: undefined | number;

Number of consecutive successful checks required before considering the VM healthy. Default: 2.

property timeout

timeout?: undefined | string;

Time before the check is considered failed. Default: “4s”

interface FlexibleAppVersionManualScaling

interface FlexibleAppVersionManualScaling

property instances

instances: number;

Number of instances to assign to the service at the start. Note: When managing the number of instances at runtime through the App Engine Admin API or the (now deprecated) Python 2 Modules API set_num_instances() you must use lifecycle.ignore_changes = ["manualScaling"[0].instances] to prevent drift detection.

interface FlexibleAppVersionNetwork

interface FlexibleAppVersionNetwork

property forwardedPorts

forwardedPorts?: string[];

List of ports, or port pairs, to forward from the virtual machine to the application container.

property instanceTag

instanceTag?: undefined | string;

Tag to apply to the instance during creation.

property name

name: string;

Full Serverless VPC Access Connector name e.g. /projects/my-project/locations/us-central1/connectors/c1.

property sessionAffinity

sessionAffinity?: undefined | false | true;

Enable session affinity.

property subnetwork

subnetwork?: undefined | string;

Google Cloud Platform sub-network where the virtual machines are created. Specify the short name, not the resource path. If the network that the instance is being created in is a Legacy network, then the IP address is allocated from the IPv4Range. If the network that the instance is being created in is an auto Subnet Mode Network, then only network name should be specified (not the subnetworkName) and the IP address is created from the IPCidrRange of the subnetwork that exists in that zone for that network. If the network that the instance is being created in is a custom Subnet Mode Network, then the subnetworkName must be specified and the IP address is created from the IPCidrRange of the subnetwork. If specified, the subnetwork must exist in the same region as the App Engine flexible environment application.

interface FlexibleAppVersionReadinessCheck

interface FlexibleAppVersionReadinessCheck

property appStartTimeout

appStartTimeout?: undefined | string;

A maximum time limit on application initialization, measured from moment the application successfully replies to a healthcheck until it is ready to serve traffic. Default: “300s”

property checkInterval

checkInterval?: undefined | string;

Interval between health checks.

property failureThreshold

failureThreshold?: undefined | number;

Number of consecutive failed checks required before considering the VM unhealthy. Default: 4.

property host

host?: undefined | string;

Host header to send when performing a HTTP Readiness check. Example: “myapp.appspot.com”

property path

path: string;

The request path.

property successThreshold

successThreshold?: undefined | number;

Number of consecutive successful checks required before considering the VM healthy. Default: 2.

property timeout

timeout?: undefined | string;

Time before the check is considered failed. Default: “4s”

interface FlexibleAppVersionResources

interface FlexibleAppVersionResources

property cpu

cpu?: undefined | number;

Number of CPU cores needed.

property diskGb

diskGb?: undefined | number;

Disk size (GB) needed.

property memoryGb

memoryGb?: undefined | number;

Memory (GB) needed.

property volumes

volumes?: FlexibleAppVersionResourcesVolume[];

List of ports, or port pairs, to forward from the virtual machine to the application container. Structure is documented below.

interface FlexibleAppVersionResourcesVolume

interface FlexibleAppVersionResourcesVolume

property name

name: string;

Full Serverless VPC Access Connector name e.g. /projects/my-project/locations/us-central1/connectors/c1.

property sizeGb

sizeGb: number;

Volume size in gigabytes.

property volumeType

volumeType: string;

Underlying volume type, e.g. ‘tmpfs’.

interface FlexibleAppVersionVpcAccessConnector

interface FlexibleAppVersionVpcAccessConnector

property name

name: string;

Full Serverless VPC Access Connector name e.g. /projects/my-project/locations/us-central1/connectors/c1.

interface StandardAppVersionAutomaticScaling

interface StandardAppVersionAutomaticScaling

property maxConcurrentRequests

maxConcurrentRequests?: undefined | number;

Number of concurrent requests an automatic scaling instance can accept before the scheduler spawns a new instance. Defaults to a runtime-specific value.

property maxIdleInstances

maxIdleInstances?: undefined | number;

Maximum number of idle instances that should be maintained for this version.

property maxPendingLatency

maxPendingLatency?: undefined | string;

Maximum amount of time that a request should wait in the pending queue before starting a new instance to handle it. A duration in seconds with up to nine fractional digits, terminated by ’s’. Example: “3.5s”.

property minIdleInstances

minIdleInstances?: undefined | number;

Minimum number of idle instances that should be maintained for this version. Only applicable for the default version of a service.

property minPendingLatency

minPendingLatency?: undefined | string;

Minimum amount of time a request should wait in the pending queue before starting a new instance to handle it. A duration in seconds with up to nine fractional digits, terminated by ’s’. Example: “3.5s”.

property standardSchedulerSettings

standardSchedulerSettings?: outputs.appengine.StandardAppVersionAutomaticScalingStandardSchedulerSettings;

Scheduler settings for standard environment. Structure is documented below.

interface StandardAppVersionAutomaticScalingStandardSchedulerSettings

interface StandardAppVersionAutomaticScalingStandardSchedulerSettings

property maxInstances

maxInstances?: undefined | number;

Maximum number of instances to create for this version. Must be in the range [1.0, 200.0].

property minInstances

minInstances?: undefined | number;

Minimum number of instances to run for this version. Set to zero to disable minInstances configuration.

property targetCpuUtilization

targetCpuUtilization?: undefined | number;

Target CPU utilization ratio to maintain when scaling. Should be a value in the range [0.50, 0.95], zero, or a negative value.

property targetThroughputUtilization

targetThroughputUtilization?: undefined | number;

Target throughput utilization ratio to maintain when scaling. Should be a value in the range [0.50, 0.95], zero, or a negative value.

interface StandardAppVersionBasicScaling

interface StandardAppVersionBasicScaling

property idleTimeout

idleTimeout?: undefined | string;

Duration of time after the last request that an instance must wait before the instance is shut down. A duration in seconds with up to nine fractional digits, terminated by ’s’. Example: “3.5s”. Defaults to 900s.

property maxInstances

maxInstances: number;

Maximum number of instances to create for this version. Must be in the range [1.0, 200.0].

interface StandardAppVersionDeployment

interface StandardAppVersionDeployment

property files

files?: StandardAppVersionDeploymentFile[];

Manifest of the files stored in Google Cloud Storage that are included as part of this version. All files must be readable using the credentials supplied with this call. Structure is documented below.

property zip

zip?: outputs.appengine.StandardAppVersionDeploymentZip;

Zip File Structure is documented below.

interface StandardAppVersionDeploymentFile

interface StandardAppVersionDeploymentFile

property name

name: string;

Name of the library. Example “django”.

property sha1Sum

sha1Sum?: undefined | string;

SHA1 checksum of the file

property sourceUrl

sourceUrl: string;

Source URL

interface StandardAppVersionDeploymentZip

interface StandardAppVersionDeploymentZip

property filesCount

filesCount?: undefined | number;

files count

property sourceUrl

sourceUrl: string;

Source URL

interface StandardAppVersionEntrypoint

interface StandardAppVersionEntrypoint

property shell

shell: string;

The format should be a shell command that can be fed to bash -c.

interface StandardAppVersionHandler

interface StandardAppVersionHandler

property authFailAction

authFailAction?: undefined | string;

Actions to take when the user is not logged in.

property login

login?: undefined | string;

Methods to restrict access to a URL based on login status.

property redirectHttpResponseCode

redirectHttpResponseCode?: undefined | string;

30x code to use when performing redirects for the secure field.

property script

script?: outputs.appengine.StandardAppVersionHandlerScript;

Executes a script to handle the requests that match this URL pattern. Only the auto value is supported for Node.js in the App Engine standard environment, for example “script:” “auto”. Structure is documented below.

property securityLevel

securityLevel?: undefined | string;

Security (HTTPS) enforcement for this URL.

property staticFiles

staticFiles?: outputs.appengine.StandardAppVersionHandlerStaticFiles;

Files served directly to the user for a given URL, such as images, CSS stylesheets, or JavaScript source files. Static file handlers describe which files in the application directory are static files, and which URLs serve them. Structure is documented below.

property urlRegex

urlRegex?: undefined | string;

URL prefix. Uses regular expression syntax, which means regexp special characters must be escaped, but should not contain groupings. All URLs that begin with this prefix are handled by this handler, using the portion of the URL after the prefix as part of the file path.

interface StandardAppVersionHandlerScript

interface StandardAppVersionHandlerScript

property scriptPath

scriptPath: string;

Path to the script from the application root directory.

interface StandardAppVersionHandlerStaticFiles

interface StandardAppVersionHandlerStaticFiles

property applicationReadable

applicationReadable?: undefined | false | true;

Whether files should also be uploaded as code data. By default, files declared in static file handlers are uploaded as static data and are only served to end users; they cannot be read by the application. If enabled, uploads are charged against both your code and static data storage resource quotas.

property expiration

expiration?: undefined | string;

Time a static file served by this handler should be cached by web proxies and browsers. A duration in seconds with up to nine fractional digits, terminated by ’s’. Example “3.5s”.

property httpHeaders

httpHeaders?: undefined | {[key: string]: string};

HTTP headers to use for all responses from these URLs. An object containing a list of “key:value” value pairs.“.

property mimeType

mimeType?: undefined | string;

MIME type used to serve all files served by this handler. Defaults to file-specific MIME types, which are derived from each file’s filename extension.

property path

path?: undefined | string;

Path to the static files matched by the URL pattern, from the application root directory. The path can refer to text matched in groupings in the URL pattern.

property requireMatchingFile

requireMatchingFile?: undefined | false | true;

Whether this handler should match the request if the file referenced by the handler does not exist.

property uploadPathRegex

uploadPathRegex?: undefined | string;

Regular expression that matches the file paths for all files that should be referenced by this handler.

interface StandardAppVersionLibrary

interface StandardAppVersionLibrary

property name

name?: undefined | string;

Name of the library. Example “django”.

property version

version?: undefined | string;

Version of the library to select, or “latest”.

interface StandardAppVersionManualScaling

interface StandardAppVersionManualScaling

property instances

instances: number;

Number of instances to assign to the service at the start. Note: When managing the number of instances at runtime through the App Engine Admin API or the (now deprecated) Python 2 Modules API set_num_instances() you must use lifecycle.ignore_changes = ["manualScaling"[0].instances] to prevent drift detection.

namespace artifactregistry

interface RepositoryIamBindingCondition

interface RepositoryIamBindingCondition

property description

description?: undefined | string;

property expression

expression: string;

property title

title: string;

interface RepositoryIamMemberCondition

interface RepositoryIamMemberCondition

property description

description?: undefined | string;

property expression

expression: string;

property title

title: string;

namespace bigquery

interface AppProfileSingleClusterRouting

interface AppProfileSingleClusterRouting

property allowTransactionalWrites

allowTransactionalWrites?: undefined | false | true;

If true, CheckAndMutateRow and ReadModifyWriteRow requests are allowed by this app profile. It is unsafe to send these requests to the same table/row/column in multiple clusters.

property clusterId

clusterId: string;

The cluster to which read/write requests should be routed.

interface ConnectionCloudSql

interface ConnectionCloudSql

property database

database: string;

Database name.

property instanceId

instanceId: string;

Cloud SQL instance ID in the form project:location:instance.

property type

type: string;

Type of the Cloud SQL database.

interface DatasetAccess

interface DatasetAccess

property domain

domain?: undefined | string;

A domain to grant access to. Any users signed in with the domain specified will be granted the specified access

property groupByEmail

groupByEmail?: undefined | string;

An email address of a Google Group to grant access to.

property role

role?: undefined | string;

Describes the rights granted to the user specified by the other member of the access object. Primitive, Predefined and custom roles are supported. Predefined roles that have equivalent primitive roles are swapped by the API to their Primitive counterparts. See official docs.

property specialGroup

specialGroup?: undefined | string;

A special group to grant access to. Possible values include:

property userByEmail

userByEmail?: undefined | string;

An email address of a user to grant access to. For example: fred@example.com

property view

view?: outputs.bigquery.DatasetAccessView;

A view from a different dataset to grant access to. Queries executed against that view will have read access to tables in this dataset. The role field is not required when this field is set. If that view is updated by any user, access to the view needs to be granted again via an update operation. Structure is documented below.

interface DatasetAccessView

interface DatasetAccessView

property datasetId

datasetId: string;

The ID of the dataset containing this table.

property projectId

projectId: string;

The ID of the project containing this table.

property tableId

tableId: string;

The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.

interface DatasetDefaultEncryptionConfiguration

interface DatasetDefaultEncryptionConfiguration

property kmsKeyName

kmsKeyName: string;

Describes the Cloud KMS encryption key that will be used to protect destination BigQuery table. The BigQuery Service Account associated with your project requires access to this encryption key.

interface JobCopy

interface JobCopy

property createDisposition

createDisposition?: undefined | string;

Specifies whether the job is allowed to create new tables. The following values are supported: CREATE_IF_NEEDED: If the table does not exist, BigQuery creates the table. CREATE_NEVER: The table must already exist. If it does not, a ‘notFound’ error is returned in the job result. Creation, truncation and append actions occur as one atomic update upon job completion

property destinationEncryptionConfiguration

destinationEncryptionConfiguration?: outputs.bigquery.JobCopyDestinationEncryptionConfiguration;

Custom encryption configuration (e.g., Cloud KMS keys) Structure is documented below.

property destinationTable

destinationTable?: outputs.bigquery.JobCopyDestinationTable;

The destination table. Structure is documented below.

property sourceTables

sourceTables: JobCopySourceTable[];

Source tables to copy. Structure is documented below.

property writeDisposition

writeDisposition?: undefined | string;

Specifies the action that occurs if the destination table already exists. The following values are supported: WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the table data and uses the schema from the query result. WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. WRITE_EMPTY: If the table already exists and contains data, a ‘duplicate’ error is returned in the job result. Each action is atomic and only occurs if BigQuery is able to complete the job successfully. Creation, truncation and append actions occur as one atomic update upon job completion.

interface JobCopyDestinationEncryptionConfiguration

interface JobCopyDestinationEncryptionConfiguration

property kmsKeyName

kmsKeyName: string;

Describes the Cloud KMS encryption key that will be used to protect destination BigQuery table. The BigQuery Service Account associated with your project requires access to this encryption key.

interface JobCopyDestinationTable

interface JobCopyDestinationTable

property datasetId

datasetId: string;

The ID of the dataset containing this model.

property projectId

projectId: string;

The ID of the project containing this model.

property tableId

tableId: string;

The table. Can be specified {{table_id}} if projectId and datasetId are also set, or of the form projects/{{project}}/datasets/{{dataset_id}}/tables/{{table_id}} if not.

interface JobCopySourceTable

interface JobCopySourceTable

property datasetId

datasetId: string;

The ID of the dataset containing this model.

property projectId

projectId: string;

The ID of the project containing this model.

property tableId

tableId: string;

The table. Can be specified {{table_id}} if projectId and datasetId are also set, or of the form projects/{{project}}/datasets/{{dataset_id}}/tables/{{table_id}} if not.

interface JobExtract

interface JobExtract

property compression

compression?: undefined | string;

The compression type to use for exported files. Possible values include GZIP, DEFLATE, SNAPPY, and NONE. The default value is NONE. DEFLATE and SNAPPY are only supported for Avro.

property destinationFormat

destinationFormat: string;

The exported file format. Possible values include CSV, NEWLINE_DELIMITED_JSON and AVRO for tables and SAVED_MODEL for models. The default value for tables is CSV. Tables with nested or repeated fields cannot be exported as CSV. The default value for models is SAVED_MODEL.

property destinationUris

destinationUris: string[];

A list of fully-qualified Google Cloud Storage URIs where the extracted table should be written.

property fieldDelimiter

fieldDelimiter: string;

When extracting data in CSV format, this defines the delimiter to use between fields in the exported data. Default is ‘,’

property printHeader

printHeader?: undefined | false | true;

Whether to print out a header row in the results. Default is true.

property sourceModel

sourceModel?: outputs.bigquery.JobExtractSourceModel;

A reference to the model being exported. Structure is documented below.

property sourceTable

sourceTable?: outputs.bigquery.JobExtractSourceTable;

A reference to the table being exported. Structure is documented below.

property useAvroLogicalTypes

useAvroLogicalTypes?: undefined | false | true;

Whether to use logical types when extracting to AVRO format.

interface JobExtractSourceModel

interface JobExtractSourceModel

property datasetId

datasetId: string;

The ID of the dataset containing this model.

property modelId

modelId: string;

The ID of the model.

property projectId

projectId: string;

The ID of the project containing this model.

interface JobExtractSourceTable

interface JobExtractSourceTable

property datasetId

datasetId: string;

The ID of the dataset containing this model.

property projectId

projectId: string;

The ID of the project containing this model.

property tableId

tableId: string;

The table. Can be specified {{table_id}} if projectId and datasetId are also set, or of the form projects/{{project}}/datasets/{{dataset_id}}/tables/{{table_id}} if not.

interface JobLoad

interface JobLoad

property allowJaggedRows

allowJaggedRows?: undefined | false | true;

Accept rows that are missing trailing optional columns. The missing values are treated as nulls. If false, records with missing trailing columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. Only applicable to CSV, ignored for other formats.

property allowQuotedNewlines

allowQuotedNewlines?: undefined | false | true;

Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false.

property autodetect

autodetect?: undefined | false | true;

Indicates if we should automatically infer the options and schema for CSV and JSON sources.

property createDisposition

createDisposition?: undefined | string;

Specifies whether the job is allowed to create new tables. The following values are supported: CREATE_IF_NEEDED: If the table does not exist, BigQuery creates the table. CREATE_NEVER: The table must already exist. If it does not, a ‘notFound’ error is returned in the job result. Creation, truncation and append actions occur as one atomic update upon job completion

property destinationEncryptionConfiguration

destinationEncryptionConfiguration?: outputs.bigquery.JobLoadDestinationEncryptionConfiguration;

Custom encryption configuration (e.g., Cloud KMS keys) Structure is documented below.

property destinationTable

destinationTable: JobLoadDestinationTable;

The destination table. Structure is documented below.

property encoding

encoding?: undefined | string;

The character encoding of the data. The supported values are UTF-8 or ISO-8859-1. The default value is UTF-8. BigQuery decodes the data after the raw, binary data has been split using the values of the quote and fieldDelimiter properties.

property fieldDelimiter

fieldDelimiter: string;

When extracting data in CSV format, this defines the delimiter to use between fields in the exported data. Default is ‘,’

property ignoreUnknownValues

ignoreUnknownValues?: undefined | false | true;

Indicates if BigQuery should allow extra values that are not represented in the table schema. If true, the extra values are ignored. If false, records with extra columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. The sourceFormat property determines what BigQuery treats as an extra value: CSV: Trailing columns JSON: Named values that don’t match any column names

property maxBadRecords

maxBadRecords?: undefined | number;

The maximum number of bad records that BigQuery can ignore when running the job. If the number of bad records exceeds this value, an invalid error is returned in the job result. The default value is 0, which requires that all records are valid.

property nullMarker

nullMarker?: undefined | string;

Specifies a string that represents a null value in a CSV file. The default value is the empty string. If you set this property to a custom value, BigQuery throws an error if an empty string is present for all data types except for STRING and BYTE. For STRING and BYTE columns, BigQuery interprets the empty string as an empty value.

property projectionFields

projectionFields?: string[];

If sourceFormat is set to “DATASTORE_BACKUP”, indicates which entity properties to load into BigQuery from a Cloud Datastore backup. Property names are case sensitive and must be top-level properties. If no properties are specified, BigQuery loads all properties. If any named property isn’t found in the Cloud Datastore backup, an invalid error is returned in the job result.

property quote

quote: string;

The value that is used to quote data sections in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. The default value is a double-quote (‘“’). If your data does not contain quoted sections, set the property value to an empty string. If your data contains quoted newline characters, you must also set the allowQuotedNewlines property to true.

property schemaUpdateOptions

schemaUpdateOptions?: string[];

Allows the schema of the destination table to be updated as a side effect of the load job if a schema is autodetected or supplied in the job configuration. Schema update options are supported in two cases: when writeDisposition is WRITE_APPEND; when writeDisposition is WRITE_TRUNCATE and the destination table is a partition of a table, specified by partition decorators. For normal tables, WRITE_TRUNCATE will always overwrite the schema. One or more of the following values are specified: ALLOW_FIELD_ADDITION: allow adding a nullable field to the schema. ALLOW_FIELD_RELAXATION: allow relaxing a required field in the original schema to nullable.

property skipLeadingRows

skipLeadingRows?: undefined | number;

The number of rows at the top of a CSV file that BigQuery will skip when loading the data. The default value is 0. This property is useful if you have header rows in the file that should be skipped. When autodetect is on, the behavior is the following: skipLeadingRows unspecified - Autodetect tries to detect headers in the first row. If they are not detected, the row is read as data. Otherwise data is read starting from the second row. skipLeadingRows is 0 - Instructs autodetect that there are no headers and data should be read starting from the first row. skipLeadingRows = N > 0 - Autodetect skips N-1 rows and tries to detect headers in row N. If headers are not detected, row N is just skipped. Otherwise row N is used to extract column names for the detected schema.

property sourceFormat

sourceFormat?: undefined | string;

The format of the data files. For CSV files, specify “CSV”. For datastore backups, specify “DATASTORE_BACKUP”. For newline-delimited JSON, specify “NEWLINE_DELIMITED_JSON”. For Avro, specify “AVRO”. For parquet, specify “PARQUET”. For orc, specify “ORC”. The default value is CSV.

property sourceUris

sourceUris: string[];

The fully-qualified URIs that point to your data in Google Cloud. For Google Cloud Storage URIs: Each URI can contain one ‘’ wildcard character and it must come after the ‘bucket’ name. Size limits related to load jobs apply to external data sources. For Google Cloud Bigtable URIs: Exactly one URI can be specified and it has be a fully specified and valid HTTPS URL for a Google Cloud Bigtable table. For Google Cloud Datastore backups: Exactly one URI can be specified. Also, the ‘’ wildcard character is not allowed.

property timePartitioning

timePartitioning?: outputs.bigquery.JobLoadTimePartitioning;

Time-based partitioning specification for the destination table. Structure is documented below.

property writeDisposition

writeDisposition?: undefined | string;

Specifies the action that occurs if the destination table already exists. The following values are supported: WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the table data and uses the schema from the query result. WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. WRITE_EMPTY: If the table already exists and contains data, a ‘duplicate’ error is returned in the job result. Each action is atomic and only occurs if BigQuery is able to complete the job successfully. Creation, truncation and append actions occur as one atomic update upon job completion.

interface JobLoadDestinationEncryptionConfiguration

interface JobLoadDestinationEncryptionConfiguration

property kmsKeyName

kmsKeyName: string;

Describes the Cloud KMS encryption key that will be used to protect destination BigQuery table. The BigQuery Service Account associated with your project requires access to this encryption key.

interface JobLoadDestinationTable

interface JobLoadDestinationTable

property datasetId

datasetId: string;

The ID of the dataset containing this model.

property projectId

projectId: string;

The ID of the project containing this model.

property tableId

tableId: string;

The table. Can be specified {{table_id}} if projectId and datasetId are also set, or of the form projects/{{project}}/datasets/{{dataset_id}}/tables/{{table_id}} if not.

interface JobLoadTimePartitioning

interface JobLoadTimePartitioning

property expirationMs

expirationMs?: undefined | string;

Number of milliseconds for which to keep the storage for a partition. A wrapper is used here because 0 is an invalid value.

property field

field?: undefined | string;

If not set, the table is partitioned by pseudo column ‘_PARTITIONTIME’; if set, the table is partitioned by this field. The field must be a top-level TIMESTAMP or DATE field. Its mode must be NULLABLE or REQUIRED. A wrapper is used here because an empty string is an invalid value.

property type

type: string;

The only type supported is DAY, which will generate one partition per day. Providing an empty string used to cause an error, but in OnePlatform the field will be treated as unset.

interface JobQuery

interface JobQuery

property allowLargeResults

allowLargeResults?: undefined | false | true;

If true and query uses legacy SQL dialect, allows the query to produce arbitrarily large result tables at a slight cost in performance. Requires destinationTable to be set. For standard SQL queries, this flag is ignored and large results are always allowed. However, you must still set destinationTable when result size exceeds the allowed maximum response size.

property createDisposition

createDisposition?: undefined | string;

Specifies whether the job is allowed to create new tables. The following values are supported: CREATE_IF_NEEDED: If the table does not exist, BigQuery creates the table. CREATE_NEVER: The table must already exist. If it does not, a ‘notFound’ error is returned in the job result. Creation, truncation and append actions occur as one atomic update upon job completion

property defaultDataset

defaultDataset?: outputs.bigquery.JobQueryDefaultDataset;

Specifies the default dataset to use for unqualified table names in the query. Note that this does not alter behavior of unqualified dataset names. Structure is documented below.

property destinationEncryptionConfiguration

destinationEncryptionConfiguration?: outputs.bigquery.JobQueryDestinationEncryptionConfiguration;

Custom encryption configuration (e.g., Cloud KMS keys) Structure is documented below.

property destinationTable

destinationTable?: outputs.bigquery.JobQueryDestinationTable;

The destination table. Structure is documented below.

property flattenResults

flattenResults?: undefined | false | true;

If true and query uses legacy SQL dialect, flattens all nested and repeated fields in the query results. allowLargeResults must be true if this is set to false. For standard SQL queries, this flag is ignored and results are never flattened.

property maximumBillingTier

maximumBillingTier?: undefined | number;

Limits the billing tier for this job. Queries that have resource usage beyond this tier will fail (without incurring a charge). If unspecified, this will be set to your project default.

property maximumBytesBilled

maximumBytesBilled?: undefined | string;

Limits the bytes billed for this job. Queries that will have bytes billed beyond this limit will fail (without incurring a charge). If unspecified, this will be set to your project default.

property parameterMode

parameterMode?: undefined | string;

Standard SQL only. Set to POSITIONAL to use positional (?) query parameters or to NAMED to use named (@myparam) query parameters in this query.

property priority

priority?: undefined | string;

Specifies a priority for the query.

property query

query: string;

Configures a query job. Structure is documented below.

property schemaUpdateOptions

schemaUpdateOptions?: string[];

Allows the schema of the destination table to be updated as a side effect of the load job if a schema is autodetected or supplied in the job configuration. Schema update options are supported in two cases: when writeDisposition is WRITE_APPEND; when writeDisposition is WRITE_TRUNCATE and the destination table is a partition of a table, specified by partition decorators. For normal tables, WRITE_TRUNCATE will always overwrite the schema. One or more of the following values are specified: ALLOW_FIELD_ADDITION: allow adding a nullable field to the schema. ALLOW_FIELD_RELAXATION: allow relaxing a required field in the original schema to nullable.

property scriptOptions

scriptOptions?: outputs.bigquery.JobQueryScriptOptions;

Options controlling the execution of scripts. Structure is documented below.

property useLegacySql

useLegacySql?: undefined | false | true;

Specifies whether to use BigQuery’s legacy SQL dialect for this query. The default value is true. If set to false, the query will use BigQuery’s standard SQL.

property useQueryCache

useQueryCache?: undefined | false | true;

Whether to look for the result in the query cache. The query cache is a best-effort cache that will be flushed whenever tables in the query are modified. Moreover, the query cache is only available when a query does not have a destination table specified. The default value is true.

property userDefinedFunctionResources

userDefinedFunctionResources?: JobQueryUserDefinedFunctionResource[];

Describes user-defined function resources used in the query. Structure is documented below.

property writeDisposition

writeDisposition?: undefined | string;

Specifies the action that occurs if the destination table already exists. The following values are supported: WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the table data and uses the schema from the query result. WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. WRITE_EMPTY: If the table already exists and contains data, a ‘duplicate’ error is returned in the job result. Each action is atomic and only occurs if BigQuery is able to complete the job successfully. Creation, truncation and append actions occur as one atomic update upon job completion.

interface JobQueryDefaultDataset

interface JobQueryDefaultDataset

property datasetId

datasetId: string;

The ID of the dataset containing this model.

property projectId

projectId: string;

The ID of the project containing this model.

interface JobQueryDestinationEncryptionConfiguration

interface JobQueryDestinationEncryptionConfiguration

property kmsKeyName

kmsKeyName: string;

Describes the Cloud KMS encryption key that will be used to protect destination BigQuery table. The BigQuery Service Account associated with your project requires access to this encryption key.

interface JobQueryDestinationTable

interface JobQueryDestinationTable

property datasetId

datasetId: string;

The ID of the dataset containing this model.

property projectId

projectId: string;

The ID of the project containing this model.

property tableId

tableId: string;

The table. Can be specified {{table_id}} if projectId and datasetId are also set, or of the form projects/{{project}}/datasets/{{dataset_id}}/tables/{{table_id}} if not.

interface JobQueryScriptOptions

interface JobQueryScriptOptions

property keyResultStatement

keyResultStatement?: undefined | string;

Determines which statement in the script represents the “key result”, used to populate the schema and query results of the script job.

property statementByteBudget

statementByteBudget?: undefined | string;

Limit on the number of bytes billed per statement. Exceeding this budget results in an error.

property statementTimeoutMs

statementTimeoutMs?: undefined | string;

Timeout period for each statement in a script.

interface JobQueryUserDefinedFunctionResource

interface JobQueryUserDefinedFunctionResource

property inlineCode

inlineCode?: undefined | string;

An inline resource that contains code for a user-defined function (UDF). Providing a inline code resource is equivalent to providing a URI for a file containing the same code.

property resourceUri

resourceUri?: undefined | string;

A code resource to load from a Google Cloud Storage URI (gs://bucket/path).

interface TableEncryptionConfiguration

interface TableEncryptionConfiguration

property kmsKeyName

kmsKeyName: string;

The self link or full name of a key which should be used to encrypt this table. Note that the default bigquery service account will need to have encrypt/decrypt permissions on this key - you may want to see the gcp.bigquery.getDefaultServiceAccount datasource and the gcp.kms.CryptoKeyIAMBinding resource.

interface TableExternalDataConfiguration

interface TableExternalDataConfiguration

property autodetect

autodetect: boolean;
  • Let BigQuery try to autodetect the schema and format of the table.

property compression

compression?: undefined | string;

The compression type of the data source. Valid values are “NONE” or “GZIP”.

property csvOptions

csvOptions?: outputs.bigquery.TableExternalDataConfigurationCsvOptions;

Additional properties to set if sourceFormat is set to “CSV”. Structure is documented below.

property googleSheetsOptions

googleSheetsOptions?: outputs.bigquery.TableExternalDataConfigurationGoogleSheetsOptions;

Additional options if sourceFormat is set to “GOOGLE_SHEETS”. Structure is documented below.

property ignoreUnknownValues

ignoreUnknownValues?: undefined | false | true;

Indicates if BigQuery should allow extra values that are not represented in the table schema. If true, the extra values are ignored. If false, records with extra columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false.

property maxBadRecords

maxBadRecords?: undefined | number;

The maximum number of bad records that BigQuery can ignore when reading data.

property sourceFormat

sourceFormat: string;

The data format. Supported values are: “CSV”, “GOOGLE_SHEETS”, “NEWLINE_DELIMITED_JSON”, “AVRO”, “PARQUET”, and “DATSTORE_BACKUP”. To use “GOOGLE_SHEETS” the scopes must include “https://www.googleapis.com/auth/drive.readonly".

property sourceUris

sourceUris: string[];

A list of the fully-qualified URIs that point to your data in Google Cloud.

interface TableExternalDataConfigurationCsvOptions

interface TableExternalDataConfigurationCsvOptions

property allowJaggedRows

allowJaggedRows?: undefined | false | true;

Indicates if BigQuery should accept rows that are missing trailing optional columns.

property allowQuotedNewlines

allowQuotedNewlines?: undefined | false | true;

Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false.

property encoding

encoding?: undefined | string;

The character encoding of the data. The supported values are UTF-8 or ISO-8859-1.

property fieldDelimiter

fieldDelimiter?: undefined | string;

The separator for fields in a CSV file.

property quote

quote: string;

The value that is used to quote data sections in a CSV file. If your data does not contain quoted sections, set the property value to an empty string. If your data contains quoted newline characters, you must also set the allowQuotedNewlines property to true. The API-side default is ", specified in the provider escaped as \". Due to limitations with default values, this value is required to be explicitly set.

property skipLeadingRows

skipLeadingRows?: undefined | number;

The number of rows at the top of the sheet that BigQuery will skip when reading the data. At least one of range or skipLeadingRows must be set.

interface TableExternalDataConfigurationGoogleSheetsOptions

interface TableExternalDataConfigurationGoogleSheetsOptions

property range

range?: undefined | string;

Information required to partition based on ranges. Structure is documented below.

property skipLeadingRows

skipLeadingRows?: undefined | number;

The number of rows at the top of the sheet that BigQuery will skip when reading the data. At least one of range or skipLeadingRows must be set.

interface TableRangePartitioning

interface TableRangePartitioning

property field

field: string;

The field used to determine how to create a range-based partition.

property range

range: TableRangePartitioningRange;

Information required to partition based on ranges. Structure is documented below.

interface TableRangePartitioningRange

interface TableRangePartitioningRange

property end

end: number;

End of the range partitioning, exclusive.

property interval

interval: number;

The width of each range within the partition.

property start

start: number;

Start of the range partitioning, inclusive.

interface TableTimePartitioning

interface TableTimePartitioning

property expirationMs

expirationMs?: undefined | number;

Number of milliseconds for which to keep the storage for a partition.

property field

field?: undefined | string;

The field used to determine how to create a range-based partition.

property requirePartitionFilter

requirePartitionFilter?: undefined | false | true;

If set to true, queries over this table require a partition filter that can be used for partition elimination to be specified.

property type

type: string;

The only type supported is DAY, which will generate one partition per day based on data loading time.

interface TableView

interface TableView

property query

query: string;

A query that BigQuery executes when the view is referenced.

property useLegacySql

useLegacySql?: undefined | false | true;

Specifies whether to use BigQuery’s legacy SQL for this view. The default value is true. If set to false, the view will use BigQuery’s standard SQL.

namespace bigtable

interface GCPolicyMaxAge

interface GCPolicyMaxAge

property days

days: number;

Number of days before applying GC policy.

interface GCPolicyMaxVersion

interface GCPolicyMaxVersion

property number

number: number;

Number of version before applying the GC policy.

interface InstanceCluster

interface InstanceCluster

property clusterId

clusterId: string;

The ID of the Cloud Bigtable cluster.

property numNodes

numNodes: number;

The number of nodes in your Cloud Bigtable cluster. Required, with a minimum of 1 for a PRODUCTION instance. Must be left unset for a DEVELOPMENT instance.

property storageType

storageType?: undefined | string;

The storage type to use. One of "SSD" or "HDD". Defaults to "SSD".

property zone

zone: string;

The zone to create the Cloud Bigtable cluster in. Each cluster must have a different zone in the same region. Zones that support Bigtable instances are noted on the Cloud Bigtable locations page.

interface InstanceIamBindingCondition

interface InstanceIamBindingCondition

property description

description?: undefined | string;

property expression

expression: string;

property title

title: string;

interface InstanceIamMemberCondition

interface InstanceIamMemberCondition

property description

description?: undefined | string;

property expression

expression: string;

property title

title: string;

interface TableColumnFamily

interface TableColumnFamily

property family

family: string;

The name of the column family.

namespace billing

interface AccountIamBindingCondition

interface AccountIamBindingCondition

property description

description?: undefined | string;

property expression

expression: string;

property title

title: string;

interface AccountIamMemberCondition

interface AccountIamMemberCondition

property description

description?: undefined | string;

property expression

expression: string;

property title

title: string;

interface BudgetAllUpdatesRule

interface BudgetAllUpdatesRule

property pubsubTopic

pubsubTopic: string;

The name of the Cloud Pub/Sub topic where budget related messages will be published, in the form projects/{project_id}/topics/{topic_id}. Updates are sent at regular intervals to the topic.

property schemaVersion

schemaVersion?: undefined | string;

The schema version of the notification. Only “1.0” is accepted. It represents the JSON schema as defined in https://cloud.google.com/billing/docs/how-to/budgets#notification_format.

interface BudgetAmount

interface BudgetAmount

property specifiedAmount

specifiedAmount: BudgetAmountSpecifiedAmount;

A specified amount to use as the budget. currencyCode is optional. If specified, it must match the currency of the billing account. The currencyCode is provided on output. Structure is documented below.

interface BudgetAmountSpecifiedAmount

interface BudgetAmountSpecifiedAmount

property currencyCode

currencyCode?: undefined | string;

The 3-letter currency code defined in ISO 4217.

property nanos

nanos?: undefined | number;

Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If units is positive, nanos must be positive or zero. If units is zero, nanos can be positive, zero, or negative. If units is negative, nanos must be negative or zero. For example $-1.75 is represented as units=-1 and nanos=-750,000,000.

property units

units?: undefined | string;

The whole units of the amount. For example if currencyCode is “USD”, then 1 unit is one US dollar.

interface BudgetBudgetFilter

interface BudgetBudgetFilter

property creditTypesTreatment

creditTypesTreatment?: undefined | string;

Specifies how credits should be treated when determining spend for threshold calculations.

property projects

projects?: string[];

A set of projects of the form projects/{project_id}, specifying that usage from only this set of projects should be included in the budget. If omitted, the report will include all usage for the billing account, regardless of which project the usage occurred on. Only zero or one project can be specified currently.

property services

services?: string[];

A set of services of the form services/{service_id}, specifying that usage from only this set of services should be included in the budget. If omitted, the report will include usage for all the services. The service names are available through the Catalog API: https://cloud.google.com/billing/v1/how-tos/catalog-api.

interface BudgetThresholdRule

interface BudgetThresholdRule

property spendBasis

spendBasis?: undefined | string;

The type of basis used to determine if spend has passed the threshold.

property thresholdPercent

thresholdPercent: number;

Send an alert when this threshold is exceeded. This is a 1.0-based percentage, so 0.5 = 50%. Must be >= 0.

namespace binaryauthorization

interface AttestorAttestationAuthorityNote

interface AttestorAttestationAuthorityNote

property delegationServiceAccountEmail

delegationServiceAccountEmail: string;

- This field will contain the service account email address that this Attestor will use as the principal when querying Container Analysis. Attestor administrators must grant this service account the IAM role needed to read attestations from the noteReference in Container Analysis (containeranalysis.notes.occurrences.viewer). This email address is fixed for the lifetime of the Attestor, but callers should not make any other assumptions about the service account email; future versions may use an email based on a different naming pattern.

property noteReference

noteReference: string;

The resource name of a ATTESTATION_AUTHORITY Note, created by the user. If the Note is in a different project from the Attestor, it should be specified in the format projects/*/notes/* (or the legacy providers/*/notes/*). This field may not be updated. An attestation by this attestor is stored as a Container Analysis ATTESTATION_AUTHORITY Occurrence that names a container image and that links to this Note.

property publicKeys

publicKeys?: AttestorAttestationAuthorityNotePublicKey[];

Public keys that verify attestations signed by this attestor. This field may be updated. If this field is non-empty, one of the specified public keys must verify that an attestation was signed by this attestor for the image specified in the admission request. If this field is empty, this attestor always returns that no valid attestations exist. Structure is documented below.

interface AttestorAttestationAuthorityNotePublicKey

interface AttestorAttestationAuthorityNotePublicKey

property asciiArmoredPgpPublicKey

asciiArmoredPgpPublicKey?: undefined | string;

ASCII-armored representation of a PGP public key, as the entire output by the command gpg --export --armor foo@example.com (either LF or CRLF line endings). When using this field, id should be left blank. The BinAuthz API handlers will calculate the ID and fill it in automatically. BinAuthz computes this ID as the OpenPGP RFC4880 V4 fingerprint, represented as upper-case hex. If id is provided by the caller, it will be overwritten by the API-calculated ID.

property comment

comment?: undefined | string;

A descriptive comment. This field may be updated.

property id

id: string;

The ID of this public key. Signatures verified by BinAuthz must include the ID of the public key that can be used to verify them, and that ID must match the contents of this field exactly. Additional restrictions on this field can be imposed based on which public key type is encapsulated. See the documentation on publicKey cases below for details.

property pkixPublicKey

pkixPublicKey?: outputs.binaryauthorization.AttestorAttestationAuthorityNotePublicKeyPkixPublicKey;

A raw PKIX SubjectPublicKeyInfo format public key. NOTE: id may be explicitly provided by the caller when using this type of public key, but it MUST be a valid RFC3986 URI. If id is left blank, a default one will be computed based on the digest of the DER encoding of the public key. Structure is documented below.

interface AttestorAttestationAuthorityNotePublicKeyPkixPublicKey

interface AttestorAttestationAuthorityNotePublicKeyPkixPublicKey

property publicKeyPem

publicKeyPem?: undefined | string;

A PEM-encoded public key, as described in https://tools.ietf.org/html/rfc7468#section-13

property signatureAlgorithm

signatureAlgorithm?: undefined | string;

The signature algorithm used to verify a message against a signature using this key. These signature algorithm must match the structure and any object identifiers encoded in publicKeyPem (i.e. this algorithm must match that of the public key).

interface AttestorIamBindingCondition

interface AttestorIamBindingCondition

property description

description?: undefined | string;

property expression

expression: string;

property title

title: string;

interface AttestorIamMemberCondition

interface AttestorIamMemberCondition

property description

description?: undefined | string;

property expression

expression: string;

property title

title: string;

interface PolicyAdmissionWhitelistPattern

interface PolicyAdmissionWhitelistPattern

property namePattern

namePattern: string;

An image name pattern to whitelist, in the form registry/path/to/image. This supports a trailing * as a wildcard, but this is allowed only in text after the registry/ part.

interface PolicyClusterAdmissionRule

interface PolicyClusterAdmissionRule

property cluster

cluster: string;

The identifier for this object. Format specified above.

property enforcementMode

enforcementMode: string;

The action when a pod creation is denied by the admission rule.

property evaluationMode

evaluationMode: string;

How this admission rule will be evaluated.

property requireAttestationsBies

requireAttestationsBies?: string[];

The resource names of the attestors that must attest to a container image. If the attestor is in a different project from the policy, it should be specified in the format projects/*/attestors/*. Each attestor must exist before a policy can reference it. To add an attestor to a policy the principal issuing the policy change request must be able to read the attestor resource. Note: this field must be non-empty when the evaluationMode field specifies REQUIRE_ATTESTATION, otherwise it must be empty.

interface PolicyDefaultAdmissionRule

interface PolicyDefaultAdmissionRule

property enforcementMode

enforcementMode: string;

The action when a pod creation is denied by the admission rule.

property evaluationMode

evaluationMode: string;

How this admission rule will be evaluated.

property requireAttestationsBies

requireAttestationsBies?: string[];

The resource names of the attestors that must attest to a container image. If the attestor is in a different project from the policy, it should be specified in the format projects/*/attestors/*. Each attestor must exist before a policy can reference it. To add an attestor to a policy the principal issuing the policy change request must be able to read the attestor resource. Note: this field must be non-empty when the evaluationMode field specifies REQUIRE_ATTESTATION, otherwise it must be empty.

namespace cloudbuild

interface TriggerBuild

interface TriggerBuild

property images

images?: string[];

A list of images to be pushed upon the successful completion of all build steps. The images are pushed using the builder service account’s credentials. The digests of the pushed images will be stored in the Build resource’s results field. If any of the images fail to be pushed, the build status is marked FAILURE.

property steps

steps: TriggerBuildStep[];

The operations to be performed on the workspace. Structure is documented below.

property tags

tags?: string[];

Tags for annotation of a Build. These are not docker tags.

property timeout

timeout?: undefined | string;

Time limit for executing this build step. If not defined, the step has no time limit and will be allowed to continue to run until either it completes or the build itself times out.

interface TriggerBuildStep

interface TriggerBuildStep

property args

args?: string[];

A list of arguments that will be presented to the step when it is started. If the image used to run the step’s container has an entrypoint, the args are used as arguments to that entrypoint. If the image does not define an entrypoint, the first element in args is used as the entrypoint, and the remainder will be used as arguments.

property dir

dir?: undefined | string;

Working directory to use when running this step’s container. If this value is a relative path, it is relative to the build’s working directory. If this value is absolute, it may be outside the build’s working directory, in which case the contents of the path may not be persisted across build step executions, unless a volume for that path is specified. If the build specifies a RepoSource with dir and a step with a dir, which specifies an absolute path, the RepoSource dir is ignored for the step’s execution.

property entrypoint

entrypoint?: undefined | string;

Entrypoint to be used instead of the build step image’s default entrypoint. If unset, the image’s default entrypoint is used

property envs

envs?: string[];

A list of environment variable definitions to be used when running a step. The elements are of the form “KEY=VALUE” for the environment variable “KEY” being given the value “VALUE”.

property id

id?: undefined | string;

Unique identifier for this build step, used in waitFor to reference this build step as a dependency.

property name

name: string;

Name of the volume to mount. Volume names must be unique per build step and must be valid names for Docker volumes. Each named volume must be used by at least two build steps.

property secretEnvs

secretEnvs?: string[];

A list of environment variables which are encrypted using a Cloud Key Management Service crypto key. These values must be specified in the build’s Secret.

property timeout

timeout?: undefined | string;

Time limit for executing this build step. If not defined, the step has no time limit and will be allowed to continue to run until either it completes or the build itself times out.

property timing

timing?: undefined | string;

Output only. Stores timing information for executing this build step.

property volumes

volumes?: TriggerBuildStepVolume[];

List of volumes to mount into the build step. Each volume is created as an empty volume prior to execution of the build step. Upon completion of the build, volumes and their contents are discarded. Using a named volume in only one step is not valid as it is indicative of a build request with an incorrect configuration. Structure is documented below.

property waitFors

waitFors?: string[];

The ID(s) of the step(s) that this build step depends on. This build step will not start until all the build steps in waitFor have completed successfully. If waitFor is empty, this build step will start when all previous build steps in the Build.Steps list have completed successfully.

interface TriggerBuildStepVolume

interface TriggerBuildStepVolume

property name

name: string;

Name of the volume to mount. Volume names must be unique per build step and must be valid names for Docker volumes. Each named volume must be used by at least two build steps.

property path

path: string;

Path at which to mount the volume. Paths must be absolute and cannot conflict with other volume paths on the same build step or with certain reserved volume paths.

interface TriggerGithub

interface TriggerGithub

property name

name?: undefined | string;

Name of the volume to mount. Volume names must be unique per build step and must be valid names for Docker volumes. Each named volume must be used by at least two build steps.

property owner

owner?: undefined | string;

Owner of the repository. For example: The owner for https://github.com/googlecloudplatform/cloud-builders is “googlecloudplatform”.

property pullRequest

pullRequest?: outputs.cloudbuild.TriggerGithubPullRequest;

filter to match changes in pull requests. Specify only one of pullRequest or push. Structure is documented below.

property push

push?: outputs.cloudbuild.TriggerGithubPush;

filter to match changes in refs, like branches or tags. Specify only one of pullRequest or push. Structure is documented below.

interface TriggerGithubPullRequest

interface TriggerGithubPullRequest

property branch

branch: string;

Regex of branches to match. Specify only one of branch or tag.

property commentControl

commentControl?: undefined | string;

Whether to block builds on a “/gcbrun” comment from a repository owner or collaborator.

interface TriggerGithubPush

interface TriggerGithubPush

property branch

branch?: undefined | string;

Regex of branches to match. Specify only one of branch or tag.

property tag

tag?: undefined | string;

Regex of tags to match. Specify only one of branch or tag.

interface TriggerTriggerTemplate

interface TriggerTriggerTemplate

property branchName

branchName?: undefined | string;

Name of the branch to build. Exactly one a of branch name, tag, or commit SHA must be provided. This field is a regular expression.

property commitSha

commitSha?: undefined | string;

Explicit commit SHA to build. Exactly one of a branch name, tag, or commit SHA must be provided.

property dir

dir?: undefined | string;

Working directory to use when running this step’s container. If this value is a relative path, it is relative to the build’s working directory. If this value is absolute, it may be outside the build’s working directory, in which case the contents of the path may not be persisted across build step executions, unless a volume for that path is specified. If the build specifies a RepoSource with dir and a step with a dir, which specifies an absolute path, the RepoSource dir is ignored for the step’s execution.

property projectId

projectId: string;

ID of the project that owns the Cloud Source Repository. If omitted, the project ID requesting the build is assumed.

property repoName

repoName?: undefined | string;

Name of the Cloud Source Repository. If omitted, the name “default” is assumed.

property tagName

tagName?: undefined | string;

Name of the tag to build. Exactly one of a branch name, tag, or commit SHA must be provided. This field is a regular expression.

namespace cloudfunctions

interface FunctionEventTrigger

interface FunctionEventTrigger

property eventType

eventType: string;

The type of event to observe. For example: "google.storage.object.finalize". See the documentation on calling Cloud Functions for a full reference of accepted triggers.

property failurePolicy

failurePolicy: FunctionEventTriggerFailurePolicy;

Specifies policy for failed executions. Structure is documented below.

property resource

resource: string;

Required. The name or partial URI of the resource from which to observe events. For example, "myBucket" or "projects/my-project/topics/my-topic"

interface FunctionEventTriggerFailurePolicy

interface FunctionEventTriggerFailurePolicy

property retry

retry: boolean;

Whether the function should be retried on failure. Defaults to false.

interface FunctionIamBindingCondition

interface FunctionIamBindingCondition

property description

description?: undefined | string;

property expression

expression: string;

property title

title: string;

interface FunctionIamMemberCondition

interface FunctionIamMemberCondition

property description

description?: undefined | string;

property expression

expression: string;

property title

title: string;

interface FunctionSourceRepository

interface FunctionSourceRepository

property deployedUrl

deployedUrl: string;

property url

url: string;

The URL pointing to the hosted repository where the function is defined. There are supported Cloud Source Repository URLs in the following formats:

interface GetFunctionEventTrigger

interface GetFunctionEventTrigger

property eventType

eventType: string;

The type of event to observe. For example: "google.storage.object.finalize". See the documentation on calling Cloud Functions for a full reference of accepted triggers.

property failurePolicies

failurePolicies: GetFunctionEventTriggerFailurePolicy[];

Policy for failed executions. Structure is documented below.

property resource

resource: string;

The name of the resource whose events are being observed, for example, "myBucket"

interface GetFunctionEventTriggerFailurePolicy

interface GetFunctionEventTriggerFailurePolicy

property retry

retry: boolean;

Whether the function should be retried on failure.

interface GetFunctionSourceRepository

interface GetFunctionSourceRepository

property deployedUrl

deployedUrl: string;

property url

url: string;

namespace cloudrun

interface DomainMappingMetadata

interface DomainMappingMetadata

property annotations

annotations: {[key: string]: string};

Annotations is a key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. More info: http://kubernetes.io/docs/user-guide/annotations

property generation

generation: number;

- A sequence number representing a specific generation of the desired state.

property labels

labels: {[key: string]: string};

Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and routes. More info: http://kubernetes.io/docs/user-guide/labels

property namespace

namespace: string;

In Cloud Run the namespace must be equal to either the project ID or project number.

property resourceVersion

resourceVersion: string;

- An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. They may only be valid for a particular resource or set of resources. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency

selfLink: string;

- SelfLink is a URL representing this object.

property uid

uid: string;

- UID is a unique id generated by the server on successful creation of a resource and is not allowed to change on PUT operations. More info: http://kubernetes.io/docs/user-guide/identifiers#uids

interface DomainMappingSpec

interface DomainMappingSpec

property certificateMode

certificateMode?: undefined | string;

The mode of the certificate.

property forceOverride

forceOverride?: undefined | false | true;

If set, the mapping will override any mapping set before this spec was set. It is recommended that the user leaves this empty to receive an error warning about a potential conflict and only set it once the respective UI has given such a warning.

property routeName

routeName: string;

The name of the Cloud Run Service that this DomainMapping applies to. The route must exist.

interface DomainMappingStatus

interface DomainMappingStatus

property conditions

conditions: DomainMappingStatusCondition[];

property mappedRouteName

mappedRouteName: string;

property observedGeneration

observedGeneration: number;

property resourceRecords

resourceRecords?: DomainMappingStatusResourceRecord[];

interface DomainMappingStatusCondition

interface DomainMappingStatusCondition

property message

message: string;

property reason

reason: string;

property status

status: string;

property type

type: string;

interface DomainMappingStatusResourceRecord

interface DomainMappingStatusResourceRecord

property name

name: string;

Name should be a verified domain

property rrdata

rrdata: string;

property type

type?: undefined | string;

interface IamBindingCondition

interface IamBindingCondition

property description

description?: undefined | string;

property expression

expression: string;

property title

title: string;

interface IamMemberCondition

interface IamMemberCondition

property description

description?: undefined | string;

property expression

expression: string;

property title

title: string;

interface ServiceMetadata

interface ServiceMetadata

property annotations

annotations: {[key: string]: string};

Annotations is a key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. More info: http://kubernetes.io/docs/user-guide/annotations

property generation

generation: number;

- A sequence number representing a specific generation of the desired state.

property labels

labels: {[key: string]: string};

Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and routes. More info: http://kubernetes.io/docs/user-guide/labels

property namespace

namespace: string;

In Cloud Run the namespace must be equal to either the project ID or project number.

property resourceVersion

resourceVersion: string;

- An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. They may only be valid for a particular resource or set of resources. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency

selfLink: string;

- SelfLink is a URL representing this object.

property uid

uid: string;

- UID is a unique id generated by the server on successful creation of a resource and is not allowed to change on PUT operations. More info: http://kubernetes.io/docs/user-guide/identifiers#uids

interface ServiceStatus

interface ServiceStatus

property conditions

conditions: ServiceStatusCondition[];

property latestCreatedRevisionName

latestCreatedRevisionName: string;

property latestReadyRevisionName

latestReadyRevisionName: string;

property observedGeneration

observedGeneration: number;

property url

url: string;

interface ServiceStatusCondition

interface ServiceStatusCondition

property message

message: string;

property reason

reason: string;

property status

status: string;

property type

type: string;

interface ServiceTemplate

interface ServiceTemplate

property metadata

metadata: ServiceTemplateMetadata;

Metadata associated with this Service, including name, namespace, labels, and annotations. Structure is documented below.

property spec

spec: ServiceTemplateSpec;

RevisionSpec holds the desired state of the Revision (from the client). Structure is documented below.

interface ServiceTemplateMetadata

interface ServiceTemplateMetadata

property annotations

annotations: {[key: string]: string};

Annotations is a key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. More info: http://kubernetes.io/docs/user-guide/annotations

property generation

generation: number;

- A sequence number representing a specific generation of the desired state.

property labels

labels?: undefined | {[key: string]: string};

Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and routes. More info: http://kubernetes.io/docs/user-guide/labels

property name

name: string;

Name of the environment variable.

property namespace

namespace: string;

In Cloud Run the namespace must be equal to either the project ID or project number.

property resourceVersion

resourceVersion: string;

- An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. They may only be valid for a particular resource or set of resources. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency

selfLink: string;

- SelfLink is a URL representing this object.

property uid

uid: string;

- UID is a unique id generated by the server on successful creation of a resource and is not allowed to change on PUT operations. More info: http://kubernetes.io/docs/user-guide/identifiers#uids

interface ServiceTemplateSpec

interface ServiceTemplateSpec

property containerConcurrency

containerConcurrency: number;

ContainerConcurrency specifies the maximum allowed in-flight (concurrent) requests per container of the Revision. Values are: - 0 thread-safe, the system should manage the max concurrency. This is the default value. - 1 not-thread-safe. Single concurrency - 2-N thread-safe, max concurrency of N

property containers

containers: ServiceTemplateSpecContainer[];

Container defines the unit of execution for this Revision. In the context of a Revision, we disallow a number of the fields of this Container, including: name, ports, and volumeMounts. The runtime contract is documented here: https://github.com/knative/serving/blob/master/docs/runtime-contract.md Structure is documented below.

property serviceAccountName

serviceAccountName?: undefined | string;

Email address of the IAM service account associated with the revision of the service. The service account represents the identity of the running revision, and determines what permissions the revision has. If not provided, the revision will use the project’s default service account.

property servingState

servingState: string;

- ServingState holds a value describing the state the resources are in for this Revision. It is expected that the system will manipulate this based on routability and load.

interface ServiceTemplateSpecContainer

interface ServiceTemplateSpecContainer

property args

args?: string[];

Arguments to the entrypoint. The docker image’s CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container’s environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell

property commands

commands?: string[];

Entrypoint array. Not executed within a shell. The docker image’s ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container’s environment. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell

property envFroms

envFroms?: ServiceTemplateSpecContainerEnvFrom[];

- (Optional, Deprecated) List of sources to populate environment variables in the container. All invalid keys will be reported as an event when the container is starting. When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by an Env with a duplicate key will take precedence. Structure is documented below.

property envs

envs?: ServiceTemplateSpecContainerEnv[];

List of environment variables to set in the container. Structure is documented below.

property image

image: string;

Docker image name. This is most often a reference to a container located in the container registry, such as gcr.io/cloudrun/hello More info: https://kubernetes.io/docs/concepts/containers/images

property resources

resources: ServiceTemplateSpecContainerResources;

Compute Resources required by this container. Used to set values such as max memory More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources Structure is documented below.

property workingDir

workingDir?: undefined | string;

- (Optional, Deprecated) Container’s working directory. If not specified, the container runtime’s default will be used, which might be configured in the container image.

interface ServiceTemplateSpecContainerEnv

interface ServiceTemplateSpecContainerEnv

property name

name?: undefined | string;

Name of the environment variable.

property value

value?: undefined | string;

Variable references $(VAR_NAME) are expanded using the previous defined environment variables in the container and any route environment variables. If a variable cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded, regardless of whether the variable exists or not. Defaults to “”.

interface ServiceTemplateSpecContainerEnvFrom

interface ServiceTemplateSpecContainerEnvFrom

property configMapRef

configMapRef?: outputs.cloudrun.ServiceTemplateSpecContainerEnvFromConfigMapRef;

The ConfigMap to select from. Structure is documented below.

property prefix

prefix?: undefined | string;

An optional identifier to prepend to each key in the ConfigMap.

property secretRef

secretRef?: outputs.cloudrun.ServiceTemplateSpecContainerEnvFromSecretRef;

The Secret to select from. Structure is documented below.

interface ServiceTemplateSpecContainerEnvFromConfigMapRef

interface ServiceTemplateSpecContainerEnvFromConfigMapRef

property localObjectReference

localObjectReference?: outputs.cloudrun.ServiceTemplateSpecContainerEnvFromConfigMapRefLocalObjectReference;

The Secret to select from. Structure is documented below.

property optional

optional?: undefined | false | true;

Specify whether the Secret must be defined

interface ServiceTemplateSpecContainerEnvFromConfigMapRefLocalObjectReference

interface ServiceTemplateSpecContainerEnvFromConfigMapRefLocalObjectReference

property name

name: string;

Name of the environment variable.

interface ServiceTemplateSpecContainerEnvFromSecretRef

interface ServiceTemplateSpecContainerEnvFromSecretRef

property localObjectReference

localObjectReference?: outputs.cloudrun.ServiceTemplateSpecContainerEnvFromSecretRefLocalObjectReference;

The Secret to select from. Structure is documented below.

property optional

optional?: undefined | false | true;

Specify whether the Secret must be defined

interface ServiceTemplateSpecContainerEnvFromSecretRefLocalObjectReference

interface ServiceTemplateSpecContainerEnvFromSecretRefLocalObjectReference

property name

name: string;

Name of the environment variable.

interface ServiceTemplateSpecContainerResources

interface ServiceTemplateSpecContainerResources

property limits

limits: {[key: string]: string};

Limits describes the maximum amount of compute resources allowed. The values of the map is string form of the ‘quantity’ k8s type: https://github.com/kubernetes/kubernetes/blob/master/staging/src/k8s.io/apimachinery/pkg/api/resource/quantity.go

property requests

requests?: undefined | {[key: string]: string};

Requests describes the minimum amount of compute resources required. If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, otherwise to an implementation-defined value. The values of the map is string form of the ‘quantity’ k8s type: https://github.com/kubernetes/kubernetes/blob/master/staging/src/k8s.io/apimachinery/pkg/api/resource/quantity.go

interface ServiceTraffic

interface ServiceTraffic

property latestRevision

latestRevision?: undefined | false | true;

LatestRevision may be optionally provided to indicate that the latest ready Revision of the Configuration should be used for this traffic target. When provided LatestRevision must be true if RevisionName is empty; it must be false when RevisionName is non-empty.

property percent

percent: number;

Percent specifies percent of the traffic to this Revision or Configuration.

property revisionName

revisionName?: undefined | string;

RevisionName of a specific revision to which to send this portion of traffic.

namespace cloudscheduler

interface JobAppEngineHttpTarget

interface JobAppEngineHttpTarget

property appEngineRouting

appEngineRouting?: outputs.cloudscheduler.JobAppEngineHttpTargetAppEngineRouting;

App Engine Routing setting for the job. Structure is documented below.

property body

body?: undefined | string;

HTTP request body. A request body is allowed only if the HTTP method is POST, PUT, or PATCH. It is an error to set body on a job with an incompatible HttpMethod.

property headers

headers?: undefined | {[key: string]: string};

This map contains the header field names and values. Repeated headers are not supported, but a header value can contain commas.

property httpMethod

httpMethod?: undefined | string;

Which HTTP method to use for the request.

property relativeUri

relativeUri: string;

The relative URI. The relative URL must begin with “/” and must be a valid HTTP relative URL. It can contain a path, query string arguments, and # fragments. If the relative URL is empty, then the root path “/” will be used. No spaces are allowed, and the maximum length allowed is 2083 characters

interface JobAppEngineHttpTargetAppEngineRouting

interface JobAppEngineHttpTargetAppEngineRouting

property instance

instance?: undefined | string;

App instance. By default, the job is sent to an instance which is available when the job is attempted.

property service

service?: undefined | string;

App service. By default, the job is sent to the service which is the default service when the job is attempted.

property version

version?: undefined | string;

App version. By default, the job is sent to the version which is the default version when the job is attempted.

interface JobHttpTarget

interface JobHttpTarget

property body

body?: undefined | string;

HTTP request body. A request body is allowed only if the HTTP method is POST, PUT, or PATCH. It is an error to set body on a job with an incompatible HttpMethod.

property headers

headers?: undefined | {[key: string]: string};

This map contains the header field names and values. Repeated headers are not supported, but a header value can contain commas.

property httpMethod

httpMethod?: undefined | string;

Which HTTP method to use for the request.

property oauthToken

oauthToken?: outputs.cloudscheduler.JobHttpTargetOauthToken;

Contains information needed for generating an OAuth token. This type of authorization should be used when sending requests to a GCP endpoint. Structure is documented below.

property oidcToken

oidcToken?: outputs.cloudscheduler.JobHttpTargetOidcToken;

Contains information needed for generating an OpenID Connect token. This type of authorization should be used when sending requests to third party endpoints or Cloud Run. Structure is documented below.

property uri

uri: string;

The full URI path that the request will be sent to.

interface JobHttpTargetOauthToken

interface JobHttpTargetOauthToken

property scope

scope?: undefined | string;

OAuth scope to be used for generating OAuth access token. If not specified, “https://www.googleapis.com/auth/cloud-platform" will be used.

property serviceAccountEmail

serviceAccountEmail: string;

Service account email to be used for generating OAuth token. The service account must be within the same project as the job.

interface JobHttpTargetOidcToken

interface JobHttpTargetOidcToken

property audience

audience?: undefined | string;

Audience to be used when generating OIDC token. If not specified, the URI specified in target will be used.

property serviceAccountEmail

serviceAccountEmail: string;

Service account email to be used for generating OAuth token. The service account must be within the same project as the job.

interface JobPubsubTarget

interface JobPubsubTarget

property attributes

attributes?: undefined | {[key: string]: string};

Attributes for PubsubMessage. Pubsub message must contain either non-empty data, or at least one attribute.

property data

data?: undefined | string;

The message payload for PubsubMessage. Pubsub message must contain either non-empty data, or at least one attribute.

property topicName

topicName: string;

The full resource name for the Cloud Pub/Sub topic to which messages will be published when a job is delivered. ~>NOTE: The topic name must be in the same format as required by PubSub’s PublishRequest.name, e.g. projects/my-project/topics/my-topic.

interface JobRetryConfig

interface JobRetryConfig

property maxBackoffDuration

maxBackoffDuration: string;

The maximum amount of time to wait before retrying a job after it fails. A duration in seconds with up to nine fractional digits, terminated by ’s’.

property maxDoublings

maxDoublings: number;

The time between retries will double maxDoublings times. A job’s retry interval starts at minBackoffDuration, then doubles maxDoublings times, then increases linearly, and finally retries retries at intervals of maxBackoffDuration up to retryCount times.

property maxRetryDuration

maxRetryDuration: string;

The time limit for retrying a failed job, measured from time when an execution was first attempted. If specified with retryCount, the job will be retried until both limits are reached. A duration in seconds with up to nine fractional digits, terminated by ’s’.

property minBackoffDuration

minBackoffDuration: string;

The minimum amount of time to wait before retrying a job after it fails. A duration in seconds with up to nine fractional digits, terminated by ’s’.

property retryCount

retryCount: number;

The number of attempts that the system will make to run a job using the exponential backoff procedure described by maxDoublings. Values greater than 5 and negative values are not allowed.

namespace cloudtasks

interface QueueAppEngineRoutingOverride

interface QueueAppEngineRoutingOverride

property host

host: string;

- The host that the task is sent to.

property instance

instance?: undefined | string;

App instance. By default, the task is sent to an instance which is available when the task is attempted.

property service

service?: undefined | string;

App service. By default, the task is sent to the service which is the default service when the task is attempted.

property version

version?: undefined | string;

App version. By default, the task is sent to the version which is the default version when the task is attempted.

interface QueueRateLimits

interface QueueRateLimits

property maxBurstSize

maxBurstSize: number;

- The max burst size. Max burst size limits how fast tasks in queue are processed when many tasks are in the queue and the rate is high. This field allows the queue to have a high rate so processing starts shortly after a task is enqueued, but still limits resource usage when many tasks are enqueued in a short period of time.

property maxConcurrentDispatches

maxConcurrentDispatches: number;

The maximum number of concurrent tasks that Cloud Tasks allows to be dispatched for this queue. After this threshold has been reached, Cloud Tasks stops dispatching tasks until the number of concurrent requests decreases.

property maxDispatchesPerSecond

maxDispatchesPerSecond: number;

The maximum rate at which tasks are dispatched from this queue. If unspecified when the queue is created, Cloud Tasks will pick the default.

interface QueueRetryConfig

interface QueueRetryConfig

property maxAttempts

maxAttempts: number;

Number of attempts per task. Cloud Tasks will attempt the task maxAttempts times (that is, if the first attempt fails, then there will be maxAttempts - 1 retries). Must be >= -1. If unspecified when the queue is created, Cloud Tasks will pick the default. -1 indicates unlimited attempts.

property maxBackoff

maxBackoff: string;

A task will be scheduled for retry between minBackoff and maxBackoff duration after it fails, if the queue’s RetryConfig specifies that the task should be retried.

property maxDoublings

maxDoublings: number;

The time between retries will double maxDoublings times. A task’s retry interval starts at minBackoff, then doubles maxDoublings times, then increases linearly, and finally retries retries at intervals of maxBackoff up to maxAttempts times.

property maxRetryDuration

maxRetryDuration: string;

If positive, maxRetryDuration specifies the time limit for retrying a failed task, measured from when the task was first attempted. Once maxRetryDuration time has passed and the task has been attempted maxAttempts times, no further attempts will be made and the task will be deleted. If zero, then the task age is unlimited.

property minBackoff

minBackoff: string;

A task will be scheduled for retry between minBackoff and maxBackoff duration after it fails, if the queue’s RetryConfig specifies that the task should be retried.

namespace composer

interface EnvironmentConfig

interface EnvironmentConfig

property airflowUri

airflowUri: string;

property dagGcsPrefix

dagGcsPrefix: string;

property gkeCluster

gkeCluster: string;

property nodeConfig

nodeConfig: EnvironmentConfigNodeConfig;

The configuration used for the Kubernetes Engine cluster. Structure is documented below.

property nodeCount

nodeCount: number;

The number of nodes in the Kubernetes Engine cluster that will be used to run this environment.

property privateEnvironmentConfig

privateEnvironmentConfig: EnvironmentConfigPrivateEnvironmentConfig;

The configuration used for the Private IP Cloud Composer environment. Structure is documented below.

property softwareConfig

softwareConfig: EnvironmentConfigSoftwareConfig;

The configuration settings for software inside the environment. Structure is documented below.

property webServerNetworkAccessControl

webServerNetworkAccessControl: EnvironmentConfigWebServerNetworkAccessControl;

The network-level access control policy for the Airflow web server. If unspecified, no network-level access restrictions will be applied.

interface EnvironmentConfigNodeConfig

interface EnvironmentConfigNodeConfig

property diskSizeGb

diskSizeGb: number;

The disk size in GB used for node VMs. Minimum size is 20GB. If unspecified, defaults to 100GB. Cannot be updated.

property ipAllocationPolicy

ipAllocationPolicy: EnvironmentConfigNodeConfigIpAllocationPolicy;

Configuration for controlling how IPs are allocated in the GKE cluster. Structure is documented below. Cannot be updated.

property machineType

machineType: string;

The Compute Engine machine type used for cluster instances, specified as a name or relative resource name. For example: “projects/{project}/zones/{zone}/machineTypes/{machineType}”. Must belong to the enclosing environment’s project and region/zone.

property network

network: string;

The Compute Engine network to be used for machine communications, specified as a self-link, relative resource name (e.g. “projects/{project}/global/networks/{network}”), by name.

property oauthScopes

oauthScopes: string[];

The set of Google API scopes to be made available on all node VMs. Cannot be updated. If empty, defaults to ["https://www.googleapis.com/auth/cloud-platform"]

property serviceAccount

serviceAccount: string;

The Google Cloud Platform Service Account to be used by the node VMs. If a service account is not specified, the “default” Compute Engine service account is used. Cannot be updated. If given, note that the service account must have roles/composer.worker for any GCP resources created under the Cloud Composer Environment.

property subnetwork

subnetwork?: undefined | string;

The Compute Engine subnetwork to be used for machine communications, , specified as a self-link, relative resource name (e.g. “projects/{project}/regions/{region}/subnetworks/{subnetwork}”), or by name. If subnetwork is provided, network must also be provided and the subnetwork must belong to the enclosing environment’s project and region.

property tags

tags?: string[];

The list of instance tags applied to all node VMs. Tags are used to identify valid sources or targets for network firewalls. Each tag within the list must comply with RFC1035. Cannot be updated.

property zone

zone: string;

The Compute Engine zone in which to deploy the VMs running the Apache Airflow software, specified as the zone name or relative resource name (e.g. “projects/{project}/zones/{zone}”). Must belong to the enclosing environment’s project and region.

interface EnvironmentConfigNodeConfigIpAllocationPolicy

interface EnvironmentConfigNodeConfigIpAllocationPolicy

property clusterIpv4CidrBlock

clusterIpv4CidrBlock?: undefined | string;

The IP address range used to allocate IP addresses to pods in the cluster. Set to blank to have GKE choose a range with the default size. Set to /netmask (e.g. /14) to have GKE choose a range with a specific netmask. Set to a CIDR notation (e.g. 10.96.0.0/14) from the RFC-1918 private networks (e.g. 10.0.0.0/8, 172.16.0.0/12, 192.168.0.0/16) to pick a specific range to use. Specify either clusterSecondaryRangeName or clusterIpv4CidrBlock but not both.

property clusterSecondaryRangeName

clusterSecondaryRangeName?: undefined | string;

The name of the cluster’s secondary range used to allocate IP addresses to pods. Specify either clusterSecondaryRangeName or clusterIpv4CidrBlock but not both. This field is applicable only when useIpAliases is true.

property servicesIpv4CidrBlock

servicesIpv4CidrBlock?: undefined | string;

The IP address range used to allocate IP addresses in this cluster. Set to blank to have GKE choose a range with the default size. Set to /netmask (e.g. /14) to have GKE choose a range with a specific netmask. Set to a CIDR notation (e.g. 10.96.0.0/14) from the RFC-1918 private networks (e.g. 10.0.0.0/8, 172.16.0.0/12, 192.168.0.0/16) to pick a specific range to use. Specify either servicesSecondaryRangeName or servicesIpv4CidrBlock but not both.

property servicesSecondaryRangeName

servicesSecondaryRangeName?: undefined | string;

The name of the services’ secondary range used to allocate IP addresses to the cluster. Specify either servicesSecondaryRangeName or servicesIpv4CidrBlock but not both. This field is applicable only when useIpAliases is true.

property useIpAliases

useIpAliases: boolean;

Whether or not to enable Alias IPs in the GKE cluster. If true, a VPC-native cluster is created. Defaults to true if the ipAllocationBlock is present in config.

interface EnvironmentConfigPrivateEnvironmentConfig

interface EnvironmentConfigPrivateEnvironmentConfig

property cloudSqlIpv4CidrBlock

cloudSqlIpv4CidrBlock: string;

The CIDR block from which IP range in tenant project will be reserved for Cloud SQL. Needs to be disjoint from webServerIpv4CidrBlock

property enablePrivateEndpoint

enablePrivateEndpoint?: undefined | false | true;

- If true, access to the public endpoint of the GKE cluster is denied.

property masterIpv4CidrBlock

masterIpv4CidrBlock?: undefined | string;

The IP range in CIDR notation to use for the hosted master network. This range is used for assigning internal IP addresses to the cluster master or set of masters and to the internal load balancer virtual IP. This range must not overlap with any other ranges in use within the cluster’s network. If left blank, the default value of ‘172.16.0.0/28’ is used.

property webServerIpv4CidrBlock

webServerIpv4CidrBlock: string;

The CIDR block from which IP range for web server will be reserved. Needs to be disjoint from masterIpv4CidrBlock and cloudSqlIpv4CidrBlock.

interface EnvironmentConfigSoftwareConfig

interface EnvironmentConfigSoftwareConfig

property airflowConfigOverrides

airflowConfigOverrides?: undefined | {[key: string]: string};

- (Optional) Apache Airflow configuration properties to override. Property keys contain the section and property names, separated by a hyphen, for example “core-dags_are_paused_at_creation”.

property envVariables

envVariables?: undefined | {[key: string]: string};

Additional environment variables to provide to the Apache Airflow scheduler, worker, and webserver processes. Environment variable names must match the regular expression [a-zA-Z_][a-zA-Z0-9_]*. They cannot specify Apache Airflow software configuration overrides (they cannot match the regular expression AIRFLOW__[A-Z0-9_]+__[A-Z0-9_]+), and they cannot match any of the following reserved names:

AIRFLOW_HOME
C_FORCE_ROOT
CONTAINER_NAME
DAGS_FOLDER
GCP_PROJECT
GCS_BUCKET
GKE_CLUSTER_NAME
SQL_DATABASE
SQL_INSTANCE
SQL_PASSWORD
SQL_PROJECT
SQL_REGION
SQL_USER

property imageVersion

imageVersion: string;

- The version of the software running in the environment. This encapsulates both the version of Cloud Composer functionality and the version of Apache Airflow. It must match the regular expression composer-[0-9]+\.[0-9]+(\.[0-9]+)?-airflow-[0-9]+\.[0-9]+(\.[0-9]+.*)?. The Cloud Composer portion of the version is a semantic version. The portion of the image version following ‘airflow-’ is an official Apache Airflow repository release name. See documentation for allowed release names.

property pypiPackages

pypiPackages?: undefined | {[key: string]: string};

Custom Python Package Index (PyPI) packages to be installed in the environment. Keys refer to the lowercase package name (e.g. “numpy”). Values are the lowercase extras and version specifier (e.g. “==1.12.0”, “[devel,gcp_api]“, “[devel]>=1.8.2, <1.9.2”). To specify a package without pinning it to a version specifier, use the empty string as the value.

property pythonVersion

pythonVersion: string;

- The major version of Python used to run the Apache Airflow scheduler, worker, and webserver processes. Can be set to ‘2’ or ‘3’. If not specified, the default is ‘2’. Cannot be updated.

interface EnvironmentConfigWebServerNetworkAccessControl

interface EnvironmentConfigWebServerNetworkAccessControl

property allowedIpRanges

allowedIpRanges: EnvironmentConfigWebServerNetworkAccessControlAllowedIpRange[];

- A collection of allowed IP ranges with descriptions. Structure is documented below.

interface EnvironmentConfigWebServerNetworkAccessControlAllowedIpRange

interface EnvironmentConfigWebServerNetworkAccessControlAllowedIpRange

property description

description?: undefined | string;

A description of this ip range.

property value

value: string;

IP address or range, defined using CIDR notation, of requests that this rule applies to. Examples: 192.168.1.1 or 192.168.0.0/16 or 2001:db8::/32 or 2001:0db8:0000:0042:0000:8a2e:0370:7334. IP range prefixes should be properly truncated. For example, 1.2.3.4/24 should be truncated to 1.2.3.0/24. Similarly, for IPv6, 2001:db8::1/32 should be truncated to 2001:db8::/32.

interface GetImageVersionsImageVersion

interface GetImageVersionsImageVersion

property imageVersionId

imageVersionId: string;

The string identifier of the image version, in the form: “composer-x.y.z-airflow-a.b(.c)”

property supportedPythonVersions

supportedPythonVersions: string[];

Supported python versions for this image version

namespace compute

interface AutoscalarAutoscalingPolicy

interface AutoscalarAutoscalingPolicy

property cooldownPeriod

cooldownPeriod?: undefined | number;

The number of seconds that the autoscaler should wait before it starts collecting information from a new instance. This prevents the autoscaler from collecting information when the instance is initializing, during which the collected usage would not be reliable. The default time autoscaler waits is 60 seconds. Virtual machine initialization times might vary because of numerous factors. We recommend that you test how long an instance may take to initialize. To do this, create an instance and time the startup process.

property cpuUtilization

cpuUtilization: AutoscalarAutoscalingPolicyCpuUtilization;

Defines the CPU utilization policy that allows the autoscaler to scale based on the average CPU utilization of a managed instance group. Structure is documented below.

property loadBalancingUtilization

loadBalancingUtilization?: outputs.compute.AutoscalarAutoscalingPolicyLoadBalancingUtilization;

Configuration parameters of autoscaling based on a load balancer. Structure is documented below.

property maxReplicas

maxReplicas: number;

The maximum number of instances that the autoscaler can scale up to. This is required when creating or updating an autoscaler. The maximum number of replicas should not be lower than minimal number of replicas.

property metrics

metrics?: AutoscalarAutoscalingPolicyMetric[];

Configuration parameters of autoscaling based on a custom metric. Structure is documented below.

property minReplicas

minReplicas: number;

The minimum number of replicas that the autoscaler can scale down to. This cannot be less than 0. If not provided, autoscaler will choose a default value depending on maximum number of instances allowed.

interface AutoscalarAutoscalingPolicyCpuUtilization

interface AutoscalarAutoscalingPolicyCpuUtilization

property target

target: number;

Fraction of backend capacity utilization (set in HTTP(s) load balancing configuration) that autoscaler should maintain. Must be a positive float value. If not defined, the default is 0.8.

interface AutoscalarAutoscalingPolicyLoadBalancingUtilization

interface AutoscalarAutoscalingPolicyLoadBalancingUtilization

property target

target: number;

Fraction of backend capacity utilization (set in HTTP(s) load balancing configuration) that autoscaler should maintain. Must be a positive float value. If not defined, the default is 0.8.

interface AutoscalarAutoscalingPolicyMetric

interface AutoscalarAutoscalingPolicyMetric

property filter

filter?: undefined | string;

A filter string to be used as the filter string for a Stackdriver Monitoring TimeSeries.list API call. This filter is used to select a specific TimeSeries for the purpose of autoscaling and to determine whether the metric is exporting per-instance or per-group data. You can only use the AND operator for joining selectors. You can only use direct equality comparison operator (=) without any functions for each selector. You can specify the metric in both the filter string and in the metric field. However, if specified in both places, the metric must be identical. The monitored resource type determines what kind of values are expected for the metric. If it is a gce_instance, the autoscaler expects the metric to include a separate TimeSeries for each instance in a group. In such a case, you cannot filter on resource labels. If the resource type is any other value, the autoscaler expects this metric to contain values that apply to the entire autoscaled instance group and resource label filtering can be performed to point autoscaler at the correct TimeSeries to scale upon. This is called a per-group metric for the purpose of autoscaling. If not specified, the type defaults to gce_instance. You should provide a filter that is selective enough to pick just one TimeSeries for the autoscaled group or for each of the instances (if you are using gceInstance resource type). If multiple TimeSeries are returned upon the query execution, the autoscaler will sum their respective values to obtain its scaling value.

property name

name: string;

The identifier (type) of the Stackdriver Monitoring metric. The metric cannot have negative values. The metric must have a value type of INT64 or DOUBLE.

property singleInstanceAssignment

singleInstanceAssignment?: undefined | number;

If scaling is based on a per-group metric value that represents the total amount of work to be done or resource usage, set this value to an amount assigned for a single instance of the scaled group. The autoscaler will keep the number of instances proportional to the value of this metric, the metric itself should not change value due to group resizing. For example, a good metric to use with the target is pubsub.googleapis.com/subscription/num_undelivered_messages or a custom metric exporting the total number of requests coming to your instances. A bad example would be a metric exporting an average or median latency, since this value can’t include a chunk assignable to a single instance, it could be better used with utilizationTarget instead.

property target

target?: undefined | number;

Fraction of backend capacity utilization (set in HTTP(s) load balancing configuration) that autoscaler should maintain. Must be a positive float value. If not defined, the default is 0.8.

property type

type?: undefined | string;

Defines how target utilization value is expressed for a Stackdriver Monitoring metric.

interface AutoscalerAutoscalingPolicy

interface AutoscalerAutoscalingPolicy

property cooldownPeriod

cooldownPeriod?: undefined | number;

The number of seconds that the autoscaler should wait before it starts collecting information from a new instance. This prevents the autoscaler from collecting information when the instance is initializing, during which the collected usage would not be reliable. The default time autoscaler waits is 60 seconds. Virtual machine initialization times might vary because of numerous factors. We recommend that you test how long an instance may take to initialize. To do this, create an instance and time the startup process.

property cpuUtilization

cpuUtilization: AutoscalerAutoscalingPolicyCpuUtilization;

Defines the CPU utilization policy that allows the autoscaler to scale based on the average CPU utilization of a managed instance group. Structure is documented below.

property loadBalancingUtilization

loadBalancingUtilization?: outputs.compute.AutoscalerAutoscalingPolicyLoadBalancingUtilization;

Configuration parameters of autoscaling based on a load balancer. Structure is documented below.

property maxReplicas

maxReplicas: number;

The maximum number of instances that the autoscaler can scale up to. This is required when creating or updating an autoscaler. The maximum number of replicas should not be lower than minimal number of replicas.

property metrics

metrics?: AutoscalerAutoscalingPolicyMetric[];

Configuration parameters of autoscaling based on a custom metric. Structure is documented below.

property minReplicas

minReplicas: number;

The minimum number of replicas that the autoscaler can scale down to. This cannot be less than 0. If not provided, autoscaler will choose a default value depending on maximum number of instances allowed.

interface AutoscalerAutoscalingPolicyCpuUtilization

interface AutoscalerAutoscalingPolicyCpuUtilization

property target

target: number;

Fraction of backend capacity utilization (set in HTTP(s) load balancing configuration) that autoscaler should maintain. Must be a positive float value. If not defined, the default is 0.8.

interface AutoscalerAutoscalingPolicyLoadBalancingUtilization

interface AutoscalerAutoscalingPolicyLoadBalancingUtilization

property target

target: number;

Fraction of backend capacity utilization (set in HTTP(s) load balancing configuration) that autoscaler should maintain. Must be a positive float value. If not defined, the default is 0.8.

interface AutoscalerAutoscalingPolicyMetric

interface AutoscalerAutoscalingPolicyMetric

property filter

filter?: undefined | string;

A filter string to be used as the filter string for a Stackdriver Monitoring TimeSeries.list API call. This filter is used to select a specific TimeSeries for the purpose of autoscaling and to determine whether the metric is exporting per-instance or per-group data. You can only use the AND operator for joining selectors. You can only use direct equality comparison operator (=) without any functions for each selector. You can specify the metric in both the filter string and in the metric field. However, if specified in both places, the metric must be identical. The monitored resource type determines what kind of values are expected for the metric. If it is a gce_instance, the autoscaler expects the metric to include a separate TimeSeries for each instance in a group. In such a case, you cannot filter on resource labels. If the resource type is any other value, the autoscaler expects this metric to contain values that apply to the entire autoscaled instance group and resource label filtering can be performed to point autoscaler at the correct TimeSeries to scale upon. This is called a per-group metric for the purpose of autoscaling. If not specified, the type defaults to gce_instance. You should provide a filter that is selective enough to pick just one TimeSeries for the autoscaled group or for each of the instances (if you are using gceInstance resource type). If multiple TimeSeries are returned upon the query execution, the autoscaler will sum their respective values to obtain its scaling value.

property name

name: string;

The identifier (type) of the Stackdriver Monitoring metric. The metric cannot have negative values. The metric must have a value type of INT64 or DOUBLE.

property singleInstanceAssignment

singleInstanceAssignment?: undefined | number;

If scaling is based on a per-group metric value that represents the total amount of work to be done or resource usage, set this value to an amount assigned for a single instance of the scaled group. The autoscaler will keep the number of instances proportional to the value of this metric, the metric itself should not change value due to group resizing. For example, a good metric to use with the target is pubsub.googleapis.com/subscription/num_undelivered_messages or a custom metric exporting the total number of requests coming to your instances. A bad example would be a metric exporting an average or median latency, since this value can’t include a chunk assignable to a single instance, it could be better used with utilizationTarget instead.

property target

target?: undefined | number;

Fraction of backend capacity utilization (set in HTTP(s) load balancing configuration) that autoscaler should maintain. Must be a positive float value. If not defined, the default is 0.8.

property type

type?: undefined | string;

Defines how target utilization value is expressed for a Stackdriver Monitoring metric.

interface BackendBucketCdnPolicy

interface BackendBucketCdnPolicy

property signedUrlCacheMaxAgeSec

signedUrlCacheMaxAgeSec: number;

Maximum number of seconds the response to a signed URL request will be considered fresh. After this time period, the response will be revalidated before being served. When serving responses to signed URL requests, Cloud CDN will internally behave as though all responses from this backend had a “Cache-Control: public, max-age=[TTL]” header, regardless of any existing Cache-Control header. The actual headers served in responses will not be altered.

interface BackendServiceBackend

interface BackendServiceBackend

property balancingMode

balancingMode?: undefined | string;

Specifies the balancing mode for this backend. For global HTTP(S) or TCP/SSL load balancing, the default is UTILIZATION. Valid values are UTILIZATION, RATE (for HTTP(S)) and CONNECTION (for TCP/SSL).

property capacityScaler

capacityScaler?: undefined | number;

A multiplier applied to the group’s maximum servicing capacity (based on UTILIZATION, RATE or CONNECTION). Default value is 1, which means the group will serve up to 100% of its configured capacity (depending on balancingMode). A setting of 0 means the group is completely drained, offering 0% of its available Capacity. Valid range is [0.0,1.0].

property description

description?: undefined | string;

An optional description of this resource. Provide this property when you create the resource.

property group

group: string;

The fully-qualified URL of an Instance Group or Network Endpoint Group resource. In case of instance group this defines the list of instances that serve traffic. Member virtual machine instances from each instance group must live in the same zone as the instance group itself. No two backends in a backend service are allowed to use same Instance Group resource. For Network Endpoint Groups this defines list of endpoints. All endpoints of Network Endpoint Group must be hosted on instances located in the same zone as the Network Endpoint Group. Backend services cannot mix Instance Group and Network Endpoint Group backends. Note that you must specify an Instance Group or Network Endpoint Group resource using the fully-qualified URL, rather than a partial URL.

property maxConnections

maxConnections?: undefined | number;

The maximum number of connections to the backend cluster. Defaults to 1024.

property maxConnectionsPerEndpoint

maxConnectionsPerEndpoint?: undefined | number;

The max number of simultaneous connections that a single backend network endpoint can handle. This is used to calculate the capacity of the group. Can be used in either CONNECTION or UTILIZATION balancing modes. For CONNECTION mode, either maxConnections or maxConnectionsPerEndpoint must be set.

property maxConnectionsPerInstance

maxConnectionsPerInstance?: undefined | number;

The max number of simultaneous connections that a single backend instance can handle. This is used to calculate the capacity of the group. Can be used in either CONNECTION or UTILIZATION balancing modes. For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be set.

property maxRate

maxRate?: undefined | number;

The max requests per second (RPS) of the group. Can be used with either RATE or UTILIZATION balancing modes, but required if RATE mode. For RATE mode, either maxRate or one of maxRatePerInstance or maxRatePerEndpoint, as appropriate for group type, must be set.

property maxRatePerEndpoint

maxRatePerEndpoint?: undefined | number;

The max requests per second (RPS) that a single backend network endpoint can handle. This is used to calculate the capacity of the group. Can be used in either balancing mode. For RATE mode, either maxRate or maxRatePerEndpoint must be set.

property maxRatePerInstance

maxRatePerInstance?: undefined | number;

The max requests per second (RPS) that a single backend instance can handle. This is used to calculate the capacity of the group. Can be used in either balancing mode. For RATE mode, either maxRate or maxRatePerInstance must be set.

property maxUtilization

maxUtilization?: undefined | number;

Used when balancingMode is UTILIZATION. This ratio defines the CPU utilization target for the group. The default is 0.8. Valid range is [0.0, 1.0].

interface BackendServiceCdnPolicy

interface BackendServiceCdnPolicy

property cacheKeyPolicy

cacheKeyPolicy?: outputs.compute.BackendServiceCdnPolicyCacheKeyPolicy;

The CacheKeyPolicy for this CdnPolicy. Structure is documented below.

property signedUrlCacheMaxAgeSec

signedUrlCacheMaxAgeSec?: undefined | number;

Maximum number of seconds the response to a signed URL request will be considered fresh, defaults to 1hr (3600s). After this time period, the response will be revalidated before being served. When serving responses to signed URL requests, Cloud CDN will internally behave as though all responses from this backend had a “Cache-Control: public, max-age=[TTL]” header, regardless of any existing Cache-Control header. The actual headers served in responses will not be altered.

interface BackendServiceCdnPolicyCacheKeyPolicy

interface BackendServiceCdnPolicyCacheKeyPolicy

property includeHost

includeHost?: undefined | false | true;

If true requests to different hosts will be cached separately.

property includeProtocol

includeProtocol?: undefined | false | true;

If true, http and https requests will be cached separately.

property includeQueryString

includeQueryString?: undefined | false | true;

If true, include query string parameters in the cache key according to queryStringWhitelist and query_string_blacklist. If neither is set, the entire query string will be included. If false, the query string will be excluded from the cache key entirely.

property queryStringBlacklists

queryStringBlacklists?: string[];

Names of query string parameters to exclude in cache keys. All other parameters will be included. Either specify queryStringWhitelist or query_string_blacklist, not both. ‘&’ and ‘=’ will be percent encoded and not treated as delimiters.

property queryStringWhitelists

queryStringWhitelists?: string[];

Names of query string parameters to include in cache keys. All other parameters will be excluded. Either specify queryStringWhitelist or query_string_blacklist, not both. ‘&’ and ‘=’ will be percent encoded and not treated as delimiters.

interface BackendServiceCircuitBreakers

interface BackendServiceCircuitBreakers

property connectTimeout

connectTimeout?: outputs.compute.BackendServiceCircuitBreakersConnectTimeout;

The timeout for new network connections to hosts. Structure is documented below.

property maxConnections

maxConnections?: undefined | number;

The maximum number of connections to the backend cluster. Defaults to 1024.

property maxPendingRequests

maxPendingRequests?: undefined | number;

The maximum number of pending requests to the backend cluster. Defaults to 1024.

property maxRequests

maxRequests?: undefined | number;

The maximum number of parallel requests to the backend cluster. Defaults to 1024.

property maxRequestsPerConnection

maxRequestsPerConnection?: undefined | number;

Maximum requests for a single backend connection. This parameter is respected by both the HTTP/1.1 and HTTP/2 implementations. If not specified, there is no limit. Setting this parameter to 1 will effectively disable keep alive.

property maxRetries

maxRetries?: undefined | number;

The maximum number of parallel retries to the backend cluster. Defaults to 3.

interface BackendServiceCircuitBreakersConnectTimeout

interface BackendServiceCircuitBreakersConnectTimeout

property nanos

nanos?: undefined | number;

Span of time that’s a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 seconds field and a positive nanos field. Must be from 0 to 999,999,999 inclusive.

property seconds

seconds: number;

Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive.

interface BackendServiceConsistentHash

interface BackendServiceConsistentHash

property httpCookie

httpCookie?: outputs.compute.BackendServiceConsistentHashHttpCookie;

Hash is based on HTTP Cookie. This field describes a HTTP cookie that will be used as the hash key for the consistent hash load balancer. If the cookie is not present, it will be generated. This field is applicable if the sessionAffinity is set to HTTP_COOKIE. Structure is documented below.

property httpHeaderName

httpHeaderName?: undefined | string;

The hash based on the value of the specified header field. This field is applicable if the sessionAffinity is set to HEADER_FIELD.

property minimumRingSize

minimumRingSize?: undefined | number;

The minimum number of virtual nodes to use for the hash ring. Larger ring sizes result in more granular load distributions. If the number of hosts in the load balancing pool is larger than the ring size, each host will be assigned a single virtual node. Defaults to 1024.

interface BackendServiceConsistentHashHttpCookie

interface BackendServiceConsistentHashHttpCookie

property name

name?: undefined | string;

Name of the cookie.

property path

path?: undefined | string;

Path to set for the cookie.

property ttl

ttl?: outputs.compute.BackendServiceConsistentHashHttpCookieTtl;

Lifetime of the cookie. Structure is documented below.

interface BackendServiceConsistentHashHttpCookieTtl

interface BackendServiceConsistentHashHttpCookieTtl

property nanos

nanos?: undefined | number;

Span of time that’s a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 seconds field and a positive nanos field. Must be from 0 to 999,999,999 inclusive.

property seconds

seconds: number;

Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive.

interface BackendServiceIap

interface BackendServiceIap

property oauth2ClientId

oauth2ClientId: string;

OAuth2 Client ID for IAP

property oauth2ClientSecret

oauth2ClientSecret: string;

OAuth2 Client Secret for IAP Note: This property is sensitive and will not be displayed in the plan.

property oauth2ClientSecretSha256

oauth2ClientSecretSha256: string;

- OAuth2 Client Secret SHA-256 for IAP Note: This property is sensitive and will not be displayed in the plan.

interface BackendServiceLogConfig

interface BackendServiceLogConfig

property enable

enable?: undefined | false | true;

Whether to enable logging for the load balancer traffic served by this backend service.

property sampleRate

sampleRate?: undefined | number;

This field can only be specified if logging is enabled for this backend service. The value of the field must be in [0, 1]. This configures the sampling rate of requests to the load balancer where 1.0 means all logged requests are reported and 0.0 means no logged requests are reported. The default value is 1.0.

interface BackendServiceOutlierDetection

interface BackendServiceOutlierDetection

property baseEjectionTime

baseEjectionTime?: outputs.compute.BackendServiceOutlierDetectionBaseEjectionTime;

The base time that a host is ejected for. The real time is equal to the base time multiplied by the number of times the host has been ejected. Defaults to 30000ms or 30s. Structure is documented below.

property consecutiveErrors

consecutiveErrors?: undefined | number;

Number of errors before a host is ejected from the connection pool. When the backend host is accessed over HTTP, a 5xx return code qualifies as an error. Defaults to 5.

property consecutiveGatewayFailure

consecutiveGatewayFailure?: undefined | number;

The number of consecutive gateway failures (502, 503, 504 status or connection errors that are mapped to one of those status codes) before a consecutive gateway failure ejection occurs. Defaults to 5.

property enforcingConsecutiveErrors

enforcingConsecutiveErrors?: undefined | number;

The percentage chance that a host will be actually ejected when an outlier status is detected through consecutive 5xx. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100.

property enforcingConsecutiveGatewayFailure

enforcingConsecutiveGatewayFailure?: undefined | number;

The percentage chance that a host will be actually ejected when an outlier status is detected through consecutive gateway failures. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 0.

property enforcingSuccessRate

enforcingSuccessRate?: undefined | number;

The percentage chance that a host will be actually ejected when an outlier status is detected through success rate statistics. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100.

property interval

interval?: outputs.compute.BackendServiceOutlierDetectionInterval;

Time interval between ejection sweep analysis. This can result in both new ejections as well as hosts being returned to service. Defaults to 10 seconds. Structure is documented below.

property maxEjectionPercent

maxEjectionPercent?: undefined | number;

Maximum percentage of hosts in the load balancing pool for the backend service that can be ejected. Defaults to 10%.

property successRateMinimumHosts

successRateMinimumHosts?: undefined | number;

The number of hosts in a cluster that must have enough request volume to detect success rate outliers. If the number of hosts is less than this setting, outlier detection via success rate statistics is not performed for any host in the cluster. Defaults to 5.

property successRateRequestVolume

successRateRequestVolume?: undefined | number;

The minimum number of total requests that must be collected in one interval (as defined by the interval duration above) to include this host in success rate based outlier detection. If the volume is lower than this setting, outlier detection via success rate statistics is not performed for that host. Defaults to 100.

property successRateStdevFactor

successRateStdevFactor?: undefined | number;

This factor is used to determine the ejection threshold for success rate outlier ejection. The ejection threshold is the difference between the mean success rate, and the product of this factor and the standard deviation of the mean success rate: mean - (stdev * success_rate_stdev_factor). This factor is divided by a thousand to get a double. That is, if the desired factor is 1.9, the runtime value should be 1900. Defaults to 1900.

interface BackendServiceOutlierDetectionBaseEjectionTime

interface BackendServiceOutlierDetectionBaseEjectionTime

property nanos

nanos?: undefined | number;

Span of time that’s a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 seconds field and a positive nanos field. Must be from 0 to 999,999,999 inclusive.

property seconds

seconds: number;

Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive.

interface BackendServiceOutlierDetectionInterval

interface BackendServiceOutlierDetectionInterval

property nanos

nanos?: undefined | number;

Span of time that’s a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 seconds field and a positive nanos field. Must be from 0 to 999,999,999 inclusive.

property seconds

seconds: number;

Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive.

interface DiskDiskEncryptionKey

interface DiskDiskEncryptionKey
kmsKeySelfLink?: undefined | string;

The self link of the encryption key used to encrypt the disk. Also called KmsKeyName in the cloud console. Your project’s Compute Engine System service account (service-{{PROJECT_NUMBER}}@compute-system.iam.gserviceaccount.com) must have roles/cloudkms.cryptoKeyEncrypterDecrypter to use this feature. See https://cloud.google.com/compute/docs/disks/customer-managed-encryption#encrypt_a_new_persistent_disk_with_your_own_keys

property rawKey

rawKey?: undefined | string;

Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

property sha256

sha256: string;

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

interface DiskSourceImageEncryptionKey

interface DiskSourceImageEncryptionKey
kmsKeySelfLink?: undefined | string;

The self link of the encryption key used to encrypt the disk. Also called KmsKeyName in the cloud console. Your project’s Compute Engine System service account (service-{{PROJECT_NUMBER}}@compute-system.iam.gserviceaccount.com) must have roles/cloudkms.cryptoKeyEncrypterDecrypter to use this feature. See https://cloud.google.com/compute/docs/disks/customer-managed-encryption#encrypt_a_new_persistent_disk_with_your_own_keys

property rawKey

rawKey?: undefined | string;

Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

property sha256

sha256: string;

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

interface DiskSourceSnapshotEncryptionKey

interface DiskSourceSnapshotEncryptionKey
kmsKeySelfLink?: undefined | string;

The self link of the encryption key used to encrypt the disk. Also called KmsKeyName in the cloud console. Your project’s Compute Engine System service account (service-{{PROJECT_NUMBER}}@compute-system.iam.gserviceaccount.com) must have roles/cloudkms.cryptoKeyEncrypterDecrypter to use this feature. See https://cloud.google.com/compute/docs/disks/customer-managed-encryption#encrypt_a_new_persistent_disk_with_your_own_keys

property rawKey

rawKey?: undefined | string;

Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

property sha256

sha256: string;

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

interface ExternalVpnGatewayInterface

interface ExternalVpnGatewayInterface

property id

id?: undefined | number;

The numberic ID for this interface. Allowed values are based on the redundancy type of this external VPN gateway * 0 - SINGLE_IP_INTERNALLY_REDUNDANT * 0, 1 - TWO_IPS_REDUNDANCY * 0, 1, 2, 3 - FOUR_IPS_REDUNDANCY

property ipAddress

ipAddress?: undefined | string;

IP address of the interface in the external VPN gateway. Only IPv4 is supported. This IP address can be either from your on-premise gateway or another Cloud provider’s VPN gateway, it cannot be an IP address from Google Compute Engine.

interface FirewallAllow

interface FirewallAllow

property ports

ports?: string[];

An optional list of ports to which this rule applies. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port. Example inputs include: [“22”], [“80”,“443”], and [“12345-12349”].

property protocol

protocol: string;

The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, sctp, ipip), or the IP protocol number.

interface FirewallDeny

interface FirewallDeny

property ports

ports?: string[];

An optional list of ports to which this rule applies. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port. Example inputs include: [“22”], [“80”,“443”], and [“12345-12349”].

property protocol

protocol: string;

The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, sctp, ipip), or the IP protocol number.

interface GetBackendBucketCdnPolicy

interface GetBackendBucketCdnPolicy

property signedUrlCacheMaxAgeSec

signedUrlCacheMaxAgeSec: number;

Maximum number of seconds the response to a signed URL request will be considered fresh. After this time period, the response will be revalidated before being served. When serving responses to signed URL requests, Cloud CDN will internally behave as though all responses from this backend had a “Cache-Control: public, max-age=[TTL]” header, regardless of any existing Cache-Control header. The actual headers served in responses will not be altered.

interface GetBackendServiceBackend

interface GetBackendServiceBackend

property balancingMode

balancingMode: string;

property capacityScaler

capacityScaler: number;

property description

description: string;

Textual description for the Backend Service.

property group

group: string;

property maxConnections

maxConnections: number;

property maxConnectionsPerEndpoint

maxConnectionsPerEndpoint: number;

property maxConnectionsPerInstance

maxConnectionsPerInstance: number;

property maxRate

maxRate: number;

property maxRatePerEndpoint

maxRatePerEndpoint: number;

property maxRatePerInstance

maxRatePerInstance: number;

property maxUtilization

maxUtilization: number;

interface GetBackendServiceCdnPolicy

interface GetBackendServiceCdnPolicy

property cacheKeyPolicies

cacheKeyPolicies: GetBackendServiceCdnPolicyCacheKeyPolicy[];

property signedUrlCacheMaxAgeSec

signedUrlCacheMaxAgeSec: number;

interface GetBackendServiceCdnPolicyCacheKeyPolicy

interface GetBackendServiceCdnPolicyCacheKeyPolicy

property includeHost

includeHost: boolean;

property includeProtocol

includeProtocol: boolean;

property includeQueryString

includeQueryString: boolean;

property queryStringBlacklists

queryStringBlacklists: string[];

property queryStringWhitelists

queryStringWhitelists: string[];

interface GetBackendServiceCircuitBreaker

interface GetBackendServiceCircuitBreaker

property connectTimeouts

connectTimeouts: GetBackendServiceCircuitBreakerConnectTimeout[];

property maxConnections

maxConnections: number;

property maxPendingRequests

maxPendingRequests: number;

property maxRequests

maxRequests: number;

property maxRequestsPerConnection

maxRequestsPerConnection: number;

property maxRetries

maxRetries: number;

interface GetBackendServiceCircuitBreakerConnectTimeout

interface GetBackendServiceCircuitBreakerConnectTimeout

property nanos

nanos: number;

property seconds

seconds: number;

interface GetBackendServiceConsistentHash

interface GetBackendServiceConsistentHash

property httpCookies

httpCookies: GetBackendServiceConsistentHashHttpCooky[];

property httpHeaderName

httpHeaderName: string;

property minimumRingSize

minimumRingSize: number;

interface GetBackendServiceConsistentHashHttpCooky

interface GetBackendServiceConsistentHashHttpCooky

property name

name: string;

The name of the Backend Service.

property path

path: string;

property ttls

ttls: GetBackendServiceConsistentHashHttpCookyTtl[];

interface GetBackendServiceConsistentHashHttpCookyTtl

interface GetBackendServiceConsistentHashHttpCookyTtl

property nanos

nanos: number;

property seconds

seconds: number;

interface GetBackendServiceIap

interface GetBackendServiceIap

property oauth2ClientId

oauth2ClientId: string;

property oauth2ClientSecret

oauth2ClientSecret: string;

property oauth2ClientSecretSha256

oauth2ClientSecretSha256: string;

interface GetBackendServiceLogConfig

interface GetBackendServiceLogConfig

property enable

enable: boolean;

property sampleRate

sampleRate: number;

interface GetBackendServiceOutlierDetection

interface GetBackendServiceOutlierDetection

property baseEjectionTimes

baseEjectionTimes: GetBackendServiceOutlierDetectionBaseEjectionTime[];

property consecutiveErrors

consecutiveErrors: number;

property consecutiveGatewayFailure

consecutiveGatewayFailure: number;

property enforcingConsecutiveErrors

enforcingConsecutiveErrors: number;

property enforcingConsecutiveGatewayFailure

enforcingConsecutiveGatewayFailure: number;

property enforcingSuccessRate

enforcingSuccessRate: number;

property intervals

intervals: GetBackendServiceOutlierDetectionInterval[];

property maxEjectionPercent

maxEjectionPercent: number;

property successRateMinimumHosts

successRateMinimumHosts: number;

property successRateRequestVolume

successRateRequestVolume: number;

property successRateStdevFactor

successRateStdevFactor: number;

interface GetBackendServiceOutlierDetectionBaseEjectionTime

interface GetBackendServiceOutlierDetectionBaseEjectionTime

property nanos

nanos: number;

property seconds

seconds: number;

interface GetBackendServiceOutlierDetectionInterval

interface GetBackendServiceOutlierDetectionInterval

property nanos

nanos: number;

property seconds

seconds: number;

interface GetInstanceAttachedDisk

interface GetInstanceAttachedDisk

property deviceName

deviceName: string;

Name with which the attached disk is accessible under /dev/disk/by-id/

property diskEncryptionKeyRaw

diskEncryptionKeyRaw: string;

property diskEncryptionKeySha256

diskEncryptionKeySha256: string;
kmsKeySelfLink: string;

property mode

mode: string;

Read/write mode for the disk. One of "READ_ONLY" or "READ_WRITE".

property source

source: string;

The name or selfLink of the disk attached to this instance.

interface GetInstanceBootDisk

interface GetInstanceBootDisk

property autoDelete

autoDelete: boolean;

Whether the disk will be auto-deleted when the instance is deleted.

property deviceName

deviceName: string;

Name with which the attached disk is accessible under /dev/disk/by-id/

property diskEncryptionKeyRaw

diskEncryptionKeyRaw: string;

property diskEncryptionKeySha256

diskEncryptionKeySha256: string;

property initializeParams

initializeParams: GetInstanceBootDiskInitializeParam[];

Parameters with which a disk was created alongside the instance. Structure is documented below.

kmsKeySelfLink: string;

property mode

mode: string;

Read/write mode for the disk. One of "READ_ONLY" or "READ_WRITE".

property source

source: string;

The name or selfLink of the disk attached to this instance.

interface GetInstanceBootDiskInitializeParam

interface GetInstanceBootDiskInitializeParam

property image

image: string;

The image from which this disk was initialised.

property labels

labels: {[key: string]: any};

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

property size

size: number;

The size of the image in gigabytes.

property type

type: string;

The accelerator type resource exposed to this instance. E.g. nvidia-tesla-k80.

interface GetInstanceGroupNamedPort

interface GetInstanceGroupNamedPort

property name

name: string;

The name of the instance group. Either name or selfLink must be provided.

property port

port: number;

interface GetInstanceGuestAccelerator

interface GetInstanceGuestAccelerator

property count

count: number;

The number of the guest accelerator cards exposed to this instance.

property type

type: string;

The accelerator type resource exposed to this instance. E.g. nvidia-tesla-k80.

interface GetInstanceNetworkInterface

interface GetInstanceNetworkInterface

property accessConfigs

accessConfigs: GetInstanceNetworkInterfaceAccessConfig[];

Access configurations, i.e. IPs via which this instance can be accessed via the Internet. Structure documented below.

property aliasIpRanges

aliasIpRanges: GetInstanceNetworkInterfaceAliasIpRange[];

An array of alias IP ranges for this network interface. Structure documented below.

property name

name: string;

The name of the instance. One of name or selfLink must be provided.

property network

network: string;

The name or selfLink of the network attached to this interface.

property networkIp

networkIp: string;

The private IP address assigned to the instance.

property subnetwork

subnetwork: string;

The name or selfLink of the subnetwork attached to this interface.

property subnetworkProject

subnetworkProject: string;

The project in which the subnetwork belongs.

interface GetInstanceNetworkInterfaceAccessConfig

interface GetInstanceNetworkInterfaceAccessConfig

property natIp

natIp: string;

The IP address that is be 1:1 mapped to the instance’s network ip.

property networkTier

networkTier: string;

The [networking tier][network-tier] used for configuring this instance. One of PREMIUM or STANDARD.

property publicPtrDomainName

publicPtrDomainName: string;

The DNS domain name for the public PTR record.

interface GetInstanceNetworkInterfaceAliasIpRange

interface GetInstanceNetworkInterfaceAliasIpRange

property ipCidrRange

ipCidrRange: string;

The IP CIDR range represented by this alias IP range.

property subnetworkRangeName

subnetworkRangeName: string;

The subnetwork secondary range name specifying the secondary range from which to allocate the IP CIDR range for this alias IP range.

interface GetInstanceScheduling

interface GetInstanceScheduling

property automaticRestart

automaticRestart: boolean;

Specifies if the instance should be restarted if it was terminated by Compute Engine (not a user).

property nodeAffinities

nodeAffinities: GetInstanceSchedulingNodeAffinity[];

property onHostMaintenance

onHostMaintenance: string;

Describes maintenance behavior for the instance. One of MIGRATE or TERMINATE, for more info, read here

property preemptible

preemptible: boolean;

Whether the instance is preemptible.

interface GetInstanceSchedulingNodeAffinity

interface GetInstanceSchedulingNodeAffinity

property key

key: string;

property operator

operator: string;

property values

values: string[];

interface GetInstanceScratchDisk

interface GetInstanceScratchDisk

property interface

interface: string;

The disk interface used for attaching this disk. One of SCSI or NVME.

interface GetInstanceServiceAccount

interface GetInstanceServiceAccount

property email

email: string;

The service account e-mail address.

property scopes

scopes: string[];

A list of service scopes.

interface GetInstanceShieldedInstanceConfig

interface GetInstanceShieldedInstanceConfig

property enableIntegrityMonitoring

enableIntegrityMonitoring: boolean;

property enableSecureBoot

enableSecureBoot: boolean;

property enableVtpm

enableVtpm: boolean;

interface GetRegionInstanceGroupInstance

interface GetRegionInstanceGroupInstance

property instance

instance: string;

URL to the instance.

property namedPorts

namedPorts: GetRegionInstanceGroupInstanceNamedPort[];

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

property status

status: string;

String description of current state of the instance.

interface GetRegionInstanceGroupInstanceNamedPort

interface GetRegionInstanceGroupInstanceNamedPort

property name

name: string;

The name of the instance group. One of name or selfLink must be provided.

property port

port: number;

Integer port number

interface GetRouterBgp

interface GetRouterBgp

property advertiseMode

advertiseMode: string;

property advertisedGroups

advertisedGroups: string[];

property advertisedIpRanges

advertisedIpRanges: GetRouterBgpAdvertisedIpRange[];

property asn

asn: number;

interface GetRouterBgpAdvertisedIpRange

interface GetRouterBgpAdvertisedIpRange

property description

description: string;

property range

range: string;

interface GetSubnetworkSecondaryIpRange

interface GetSubnetworkSecondaryIpRange

property ipCidrRange

ipCidrRange: string;

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

property rangeName

rangeName: string;

The name associated with this subnetwork secondary range, used when adding an alias IP range to a VM instance.

interface GlobalForwardingRuleMetadataFilter

interface GlobalForwardingRuleMetadataFilter

property filterLabels

filterLabels: GlobalForwardingRuleMetadataFilterFilterLabel[];

The list of label value pairs that must match labels in the provided metadata based on filterMatchCriteria This list must not be empty and can have at the most 64 entries. Structure is documented below.

property filterMatchCriteria

filterMatchCriteria: string;

Specifies how individual filterLabel matches within the list of filterLabels contribute towards the overall metadataFilter match. MATCH_ANY - At least one of the filterLabels must have a matching label in the provided metadata. MATCH_ALL - All filterLabels must have matching labels in the provided metadata.

interface GlobalForwardingRuleMetadataFilterFilterLabel

interface GlobalForwardingRuleMetadataFilterFilterLabel

property name

name: string;

Name of the metadata label. The length must be between 1 and 1024 characters, inclusive.

property value

value: string;

The value that the label must match. The value has a maximum length of 1024 characters.

interface HaVpnGatewayVpnInterface

interface HaVpnGatewayVpnInterface

property id

id?: undefined | number;

an identifier for the resource with format projects/{{project}}/regions/{{region}}/vpnGateways/{{name}}

property ipAddress

ipAddress?: undefined | string;

interface HealthCheckHttp2HealthCheck

interface HealthCheckHttp2HealthCheck

property host

host?: undefined | string;

The value of the host header in the HTTP2 health check request. If left empty (default value), the public IP on behalf of which this health check is performed will be used.

property port

port?: undefined | number;

The TCP port number for the HTTP2 health check request. The default value is 443.

property portName

portName?: undefined | string;

Port name as defined in InstanceGroup#NamedPort#name. If both port and portName are defined, port takes precedence.

property portSpecification

portSpecification?: undefined | string;

Specifies how port is selected for health checking, can be one of the following values: * USE_FIXED_PORT: The port number in port is used for health checking. * USE_NAMED_PORT: The portName is used for health checking. * USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking. If not specified, HTTP2 health check follows behavior specified in port and portName fields.

property proxyHeader

proxyHeader?: undefined | string;

Specifies the type of proxy header to append before sending data to the backend.

property requestPath

requestPath?: undefined | string;

The request path of the HTTP2 health check request. The default value is /.

property response

response?: undefined | string;

The bytes to match against the beginning of the response data. If left empty (the default value), any response will indicate health. The response data can only be ASCII.

interface HealthCheckHttpHealthCheck

interface HealthCheckHttpHealthCheck

property host

host?: undefined | string;

The value of the host header in the HTTP2 health check request. If left empty (default value), the public IP on behalf of which this health check is performed will be used.

property port

port?: undefined | number;

The TCP port number for the HTTP2 health check request. The default value is 443.

property portName

portName?: undefined | string;

Port name as defined in InstanceGroup#NamedPort#name. If both port and portName are defined, port takes precedence.

property portSpecification

portSpecification?: undefined | string;

Specifies how port is selected for health checking, can be one of the following values: * USE_FIXED_PORT: The port number in port is used for health checking. * USE_NAMED_PORT: The portName is used for health checking. * USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking. If not specified, HTTP2 health check follows behavior specified in port and portName fields.

property proxyHeader

proxyHeader?: undefined | string;

Specifies the type of proxy header to append before sending data to the backend.

property requestPath

requestPath?: undefined | string;

The request path of the HTTP2 health check request. The default value is /.

property response

response?: undefined | string;

The bytes to match against the beginning of the response data. If left empty (the default value), any response will indicate health. The response data can only be ASCII.

interface HealthCheckHttpsHealthCheck

interface HealthCheckHttpsHealthCheck

property host

host?: undefined | string;

The value of the host header in the HTTP2 health check request. If left empty (default value), the public IP on behalf of which this health check is performed will be used.

property port

port?: undefined | number;

The TCP port number for the HTTP2 health check request. The default value is 443.

property portName

portName?: undefined | string;

Port name as defined in InstanceGroup#NamedPort#name. If both port and portName are defined, port takes precedence.

property portSpecification

portSpecification?: undefined | string;

Specifies how port is selected for health checking, can be one of the following values: * USE_FIXED_PORT: The port number in port is used for health checking. * USE_NAMED_PORT: The portName is used for health checking. * USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking. If not specified, HTTP2 health check follows behavior specified in port and portName fields.

property proxyHeader

proxyHeader?: undefined | string;

Specifies the type of proxy header to append before sending data to the backend.

property requestPath

requestPath?: undefined | string;

The request path of the HTTP2 health check request. The default value is /.

property response

response?: undefined | string;

The bytes to match against the beginning of the response data. If left empty (the default value), any response will indicate health. The response data can only be ASCII.

interface HealthCheckLogConfig

interface HealthCheckLogConfig

property enable

enable?: undefined | false | true;

Indicates whether or not to export logs. This is false by default, which means no health check logging will be done.

interface HealthCheckSslHealthCheck

interface HealthCheckSslHealthCheck

property port

port?: undefined | number;

The TCP port number for the HTTP2 health check request. The default value is 443.

property portName

portName?: undefined | string;

Port name as defined in InstanceGroup#NamedPort#name. If both port and portName are defined, port takes precedence.

property portSpecification

portSpecification?: undefined | string;

Specifies how port is selected for health checking, can be one of the following values: * USE_FIXED_PORT: The port number in port is used for health checking. * USE_NAMED_PORT: The portName is used for health checking. * USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking. If not specified, HTTP2 health check follows behavior specified in port and portName fields.

property proxyHeader

proxyHeader?: undefined | string;

Specifies the type of proxy header to append before sending data to the backend.

property request

request?: undefined | string;

The application data to send once the SSL connection has been established (default value is empty). If both request and response are empty, the connection establishment alone will indicate health. The request data can only be ASCII.

property response

response?: undefined | string;

The bytes to match against the beginning of the response data. If left empty (the default value), any response will indicate health. The response data can only be ASCII.

interface HealthCheckTcpHealthCheck

interface HealthCheckTcpHealthCheck

property port

port?: undefined | number;

The TCP port number for the HTTP2 health check request. The default value is 443.

property portName

portName?: undefined | string;

Port name as defined in InstanceGroup#NamedPort#name. If both port and portName are defined, port takes precedence.

property portSpecification

portSpecification?: undefined | string;

Specifies how port is selected for health checking, can be one of the following values: * USE_FIXED_PORT: The port number in port is used for health checking. * USE_NAMED_PORT: The portName is used for health checking. * USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking. If not specified, HTTP2 health check follows behavior specified in port and portName fields.

property proxyHeader

proxyHeader?: undefined | string;

Specifies the type of proxy header to append before sending data to the backend.

property request

request?: undefined | string;

The application data to send once the SSL connection has been established (default value is empty). If both request and response are empty, the connection establishment alone will indicate health. The request data can only be ASCII.

property response

response?: undefined | string;

The bytes to match against the beginning of the response data. If left empty (the default value), any response will indicate health. The response data can only be ASCII.

interface ImageGuestOsFeature

interface ImageGuestOsFeature

property type

type: string;

The type of supported feature. Read Enabling guest operating system features to see a list of available options.

interface ImageRawDisk

interface ImageRawDisk

property containerType

containerType?: undefined | string;

The format used to encode and transmit the block device, which should be TAR. This is just a container and transmission format and not a runtime format. Provided by the client when the disk image is created.

property sha1

sha1?: undefined | string;

An optional SHA1 checksum of the disk image before unpackaging. This is provided by the client when the disk image is created.

property source

source: string;

The full Google Cloud Storage URL where disk storage is stored You must provide either this property or the sourceDisk property but not both.

interface InstanceAttachedDisk

interface InstanceAttachedDisk

property deviceName

deviceName: string;

Name with which the attached disk will be accessible under /dev/disk/by-id/google-*

property diskEncryptionKeyRaw

diskEncryptionKeyRaw?: undefined | string;

A 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to encrypt this disk. Only one of kmsKeySelfLink and diskEncryptionKeyRaw may be set.

property diskEncryptionKeySha256

diskEncryptionKeySha256: string;
kmsKeySelfLink: string;

The selfLink of the encryption key that is stored in Google Cloud KMS to encrypt this disk. Only one of kmsKeySelfLink and diskEncryptionKeyRaw may be set.

property mode

mode?: undefined | string;

Either “READ_ONLY” or “READ_WRITE”, defaults to “READ_WRITE” If you have a persistent disk with data that you want to share between multiple instances, detach it from any read-write instances and attach it to one or more instances in read-only mode.

property source

source: string;

The name or selfLink of the disk to attach to this instance.

interface InstanceBootDisk

interface InstanceBootDisk

property autoDelete

autoDelete?: undefined | false | true;

Whether the disk will be auto-deleted when the instance is deleted. Defaults to true.

property deviceName

deviceName: string;

Name with which the attached disk will be accessible under /dev/disk/by-id/google-*

property diskEncryptionKeyRaw

diskEncryptionKeyRaw?: undefined | string;

A 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to encrypt this disk. Only one of kmsKeySelfLink and diskEncryptionKeyRaw may be set.

property diskEncryptionKeySha256

diskEncryptionKeySha256: string;

property initializeParams

initializeParams: InstanceBootDiskInitializeParams;

Parameters for a new disk that will be created alongside the new instance. Either initializeParams or source must be set. Structure is documented below.

kmsKeySelfLink: string;

The selfLink of the encryption key that is stored in Google Cloud KMS to encrypt this disk. Only one of kmsKeySelfLink and diskEncryptionKeyRaw may be set.

property mode

mode?: undefined | string;

Either “READ_ONLY” or “READ_WRITE”, defaults to “READ_WRITE” If you have a persistent disk with data that you want to share between multiple instances, detach it from any read-write instances and attach it to one or more instances in read-only mode.

property source

source: string;

The name or selfLink of the disk to attach to this instance.

interface InstanceBootDiskInitializeParams

interface InstanceBootDiskInitializeParams

property image

image: string;

The image from which to initialize this disk. This can be one of: the image’s selfLink, projects/{project}/global/images/{image}, projects/{project}/global/images/family/{family}, global/images/{image}, global/images/family/{family}, family/{family}, {project}/{family}, {project}/{image}, {family}, or {image}. If referred by family, the images names must include the family name. If they don’t, use the gcp.compute.Image data source. For instance, the image centos-6-v20180104 includes its family name centos-6. These images can be referred by family name here.

property labels

labels: {[key: string]: any};

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

property size

size: number;

The size of the image in gigabytes. If not specified, it will inherit the size of its base image.

property type

type: string;

The accelerator type resource to expose to this instance. E.g. nvidia-tesla-k80.

interface InstanceFromTemplateAttachedDisk

interface InstanceFromTemplateAttachedDisk

property deviceName

deviceName: string;

property diskEncryptionKeyRaw

diskEncryptionKeyRaw: string;

property diskEncryptionKeySha256

diskEncryptionKeySha256: string;
kmsKeySelfLink: string;

property mode

mode: string;

property source

source: string;

interface InstanceFromTemplateBootDisk

interface InstanceFromTemplateBootDisk

property autoDelete

autoDelete: boolean;

property deviceName

deviceName: string;

property diskEncryptionKeyRaw

diskEncryptionKeyRaw: string;

property diskEncryptionKeySha256

diskEncryptionKeySha256: string;

property initializeParams

initializeParams: InstanceFromTemplateBootDiskInitializeParams;
kmsKeySelfLink: string;

property mode

mode: string;

property source

source: string;

interface InstanceFromTemplateBootDiskInitializeParams

interface InstanceFromTemplateBootDiskInitializeParams

property image

image: string;

property labels

labels: {[key: string]: any};

property size

size: number;

property type

type: string;

interface InstanceFromTemplateGuestAccelerator

interface InstanceFromTemplateGuestAccelerator

property count

count: number;

property type

type: string;

interface InstanceFromTemplateNetworkInterface

interface InstanceFromTemplateNetworkInterface

property accessConfigs

accessConfigs: InstanceFromTemplateNetworkInterfaceAccessConfig[];

property aliasIpRanges

aliasIpRanges: InstanceFromTemplateNetworkInterfaceAliasIpRange[];

property name

name: string;

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

property network

network: string;

property networkIp

networkIp: string;

property subnetwork

subnetwork: string;

property subnetworkProject

subnetworkProject: string;

interface InstanceFromTemplateNetworkInterfaceAccessConfig

interface InstanceFromTemplateNetworkInterfaceAccessConfig

property natIp

natIp: string;

property networkTier

networkTier: string;

property publicPtrDomainName

publicPtrDomainName: string;

interface InstanceFromTemplateNetworkInterfaceAliasIpRange

interface InstanceFromTemplateNetworkInterfaceAliasIpRange

property ipCidrRange

ipCidrRange: string;

property subnetworkRangeName

subnetworkRangeName: string;

interface InstanceFromTemplateScheduling

interface InstanceFromTemplateScheduling

property automaticRestart

automaticRestart: boolean;

property nodeAffinities

nodeAffinities: InstanceFromTemplateSchedulingNodeAffinity[];

property onHostMaintenance

onHostMaintenance: string;

property preemptible

preemptible: boolean;

interface InstanceFromTemplateSchedulingNodeAffinity

interface InstanceFromTemplateSchedulingNodeAffinity

property key

key: string;

property operator

operator: string;

property values

values: string[];

interface InstanceFromTemplateScratchDisk

interface InstanceFromTemplateScratchDisk

property interface

interface: string;

interface InstanceFromTemplateServiceAccount

interface InstanceFromTemplateServiceAccount

property email

email: string;

property scopes

scopes: string[];

interface InstanceFromTemplateShieldedInstanceConfig

interface InstanceFromTemplateShieldedInstanceConfig

property enableIntegrityMonitoring

enableIntegrityMonitoring: boolean;

property enableSecureBoot

enableSecureBoot: boolean;

property enableVtpm

enableVtpm: boolean;

interface InstanceGroupManagerAutoHealingPolicies

interface InstanceGroupManagerAutoHealingPolicies

property healthCheck

healthCheck: string;

The health check resource that signals autohealing.

property initialDelaySec

initialDelaySec: number;

The number of seconds that the managed instance group waits before it applies autohealing policies to new instances or recently recreated instances. Between 0 and 3600.

interface InstanceGroupManagerNamedPort

interface InstanceGroupManagerNamedPort

property name

name: string;
  • Version name.

property port

port: number;

The port number.


interface InstanceGroupManagerStatefulDisk

interface InstanceGroupManagerStatefulDisk

property deleteRule

deleteRule?: undefined | string;

, A value that prescribes what should happen to the stateful disk when the VM instance is deleted. The available options are NEVER and ON_PERMANENT_INSTANCE_DELETION. NEVER detatch the disk when the VM is deleted, but not delete the disk. ON_PERMANENT_INSTANCE_DELETION will delete the stateful disk when the VM is permanently deleted from the instance group. The default is NEVER.

property deviceName

deviceName: string;

, The device name of the disk to be attached.

interface InstanceGroupManagerUpdatePolicy

interface InstanceGroupManagerUpdatePolicy

property maxSurgeFixed

maxSurgeFixed: number;

, The maximum number of instances that can be created above the specified targetSize during the update process. Conflicts with maxSurgePercent. If neither is set, defaults to 1

property maxSurgePercent

maxSurgePercent?: undefined | number;

, The maximum number of instances(calculated as percentage) that can be created above the specified targetSize during the update process. Conflicts with maxSurgeFixed.

property maxUnavailableFixed

maxUnavailableFixed: number;

, The maximum number of instances that can be unavailable during the update process. Conflicts with maxUnavailablePercent. If neither is set, defaults to 1

property maxUnavailablePercent

maxUnavailablePercent?: undefined | number;

, The maximum number of instances(calculated as percentage) that can be unavailable during the update process. Conflicts with maxUnavailableFixed.

property minReadySec

minReadySec?: undefined | number;

, Minimum number of seconds to wait for after a newly created instance becomes available. This value must be from range [0, 3600]


property minimalAction

minimalAction: string;
  • Minimal action to be taken on an instance. You can specify either RESTART to restart existing instances or REPLACE to delete and create new instances from the target template. If you specify a RESTART, the Updater will attempt to perform that action only. However, if the Updater determines that the minimal action you specify is not enough to perform the update, it might perform a more disruptive action.

property type

type: string;
  • The type of update process. You can specify either PROACTIVE so that the instance group manager proactively executes actions in order to bring instances to their target versions or OPPORTUNISTIC so that no action is proactively executed but the update will be performed as part of other actions (for example, resizes or recreateInstances calls).

interface InstanceGroupManagerVersion

interface InstanceGroupManagerVersion

property instanceTemplate

instanceTemplate: string;
  • The full URL to an instance template from which all new instances of this version will be created.

property name

name?: undefined | string;
  • Version name.

property targetSize

targetSize?: outputs.compute.InstanceGroupManagerVersionTargetSize;
  • The number of instances calculated as a fixed number or a percentage depending on the settings. Structure is documented below.

interface InstanceGroupManagerVersionTargetSize

interface InstanceGroupManagerVersionTargetSize

property fixed

fixed?: undefined | number;

, The number of instances which are managed for this version. Conflicts with percent.

property percent

percent?: undefined | number;

, The number of instances (calculated as percentage) which are managed for this version. Conflicts with fixed. Note that when using percent, rounding will be in favor of explicitly set targetSize values; a managed instance group with 2 instances and 2 versions, one of which has a target_size.percent of 60 will create 2 instances of that version.

interface InstanceGroupNamedPort

interface InstanceGroupNamedPort

property name

name: string;

The name which the port will be mapped to.

property port

port: number;

The port number to map the name to.

interface InstanceGuestAccelerator

interface InstanceGuestAccelerator

property count

count: number;

The number of the guest accelerator cards exposed to this instance.

property type

type: string;

The accelerator type resource to expose to this instance. E.g. nvidia-tesla-k80.

interface InstanceIAMBindingCondition

interface InstanceIAMBindingCondition

property description

description?: undefined | string;

An optional description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.

property expression

expression: string;

Textual representation of an expression in Common Expression Language syntax.

property title

title: string;

A title for the expression, i.e. a short string describing its purpose.

interface InstanceIAMMemberCondition

interface InstanceIAMMemberCondition

property description

description?: undefined | string;

An optional description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.

property expression

expression: string;

Textual representation of an expression in Common Expression Language syntax.

property title

title: string;

A title for the expression, i.e. a short string describing its purpose.

interface InstanceNetworkInterface

interface InstanceNetworkInterface

property accessConfigs

accessConfigs?: InstanceNetworkInterfaceAccessConfig[];

Access configurations, i.e. IPs via which this instance can be accessed via the Internet. Omit to ensure that the instance is not accessible from the Internet. If omitted, ssh will not work unless this provider can send traffic to the instance’s network (e.g. via tunnel or because it is running on another cloud instance on that network). This block can be repeated multiple times. Structure documented below.

property aliasIpRanges

aliasIpRanges?: InstanceNetworkInterfaceAliasIpRange[];

An array of alias IP ranges for this network interface. Can only be specified for network interfaces on subnet-mode networks. Structure documented below.

property name

name: string;

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

property network

network: string;

The name or selfLink of the network to attach this interface to. Either network or subnetwork must be provided.

property networkIp

networkIp: string;

The private IP address to assign to the instance. If empty, the address will be automatically assigned.

property subnetwork

subnetwork: string;

The name or selfLink of the subnetwork to attach this interface to. The subnetwork must exist in the same region this instance will be created in. Either network or subnetwork must be provided.

property subnetworkProject

subnetworkProject: string;

The project in which the subnetwork belongs. If the subnetwork is a self_link, this field is ignored in favor of the project defined in the subnetwork self_link. If the subnetwork is a name and this field is not provided, the provider project is used.

interface InstanceNetworkInterfaceAccessConfig

interface InstanceNetworkInterfaceAccessConfig

property natIp

natIp: string;

The IP address that will be 1:1 mapped to the instance’s network ip. If not given, one will be generated.

property networkTier

networkTier: string;

The [networking tier][network-tier] used for configuring this instance. This field can take the following values: PREMIUM or STANDARD. If this field is not specified, it is assumed to be PREMIUM.

property publicPtrDomainName

publicPtrDomainName?: undefined | string;

The DNS domain name for the public PTR record. To set this field on an instance, you must be verified as the owner of the domain. See the docs for how to become verified as a domain owner.

interface InstanceNetworkInterfaceAliasIpRange

interface InstanceNetworkInterfaceAliasIpRange

property ipCidrRange

ipCidrRange: string;

The IP CIDR range represented by this alias IP range. This IP CIDR range must belong to the specified subnetwork and cannot contain IP addresses reserved by system or used by other network interfaces. This range may be a single IP address (e.g. 10.2.3.4), a netmask (e.g. /24) or a CIDR format string (e.g. 10.1.2.0/24).

property subnetworkRangeName

subnetworkRangeName?: undefined | string;

The subnetwork secondary range name specifying the secondary range from which to allocate the IP CIDR range for this alias IP range. If left unspecified, the primary range of the subnetwork will be used.

interface InstanceScheduling

interface InstanceScheduling

property automaticRestart

automaticRestart?: undefined | false | true;

Specifies if the instance should be restarted if it was terminated by Compute Engine (not a user). Defaults to true.

property nodeAffinities

nodeAffinities?: InstanceSchedulingNodeAffinity[];

Specifies node affinities or anti-affinities to determine which sole-tenant nodes your instances and managed instance groups will use as host systems. Read more on sole-tenant node creation here. Structure documented below.

property onHostMaintenance

onHostMaintenance: string;

Describes maintenance behavior for the instance. Can be MIGRATE or TERMINATE, for more info, read here.

property preemptible

preemptible?: undefined | false | true;

Specifies if the instance is preemptible. If this field is set to true, then automaticRestart must be set to false. Defaults to false.

interface InstanceSchedulingNodeAffinity

interface InstanceSchedulingNodeAffinity

property key

key: string;

The key for the node affinity label.

property operator

operator: string;

The operator. Can be IN for node-affinities or NOT_IN for anti-affinities.

property values

values: string[];

interface InstanceScratchDisk

interface InstanceScratchDisk

property interface

interface: string;

The disk interface to use for attaching this disk; either SCSI or NVME.

interface InstanceServiceAccount

interface InstanceServiceAccount

property email

email: string;

The service account e-mail address. If not given, the default Google Compute Engine service account is used. Note: allowStoppingForUpdate must be set to true or your instance must have a desiredStatus of TERMINATED in order to update this field.

property scopes

scopes: string[];

A list of service scopes. Both OAuth2 URLs and gcloud short names are supported. To allow full access to all Cloud APIs, use the cloud-platform scope. See a complete list of scopes here. Note: allowStoppingForUpdate must be set to true or your instance must have a desiredStatus of TERMINATED in order to update this field.

interface InstanceShieldedInstanceConfig

interface InstanceShieldedInstanceConfig

property enableIntegrityMonitoring

enableIntegrityMonitoring?: undefined | false | true;

– Compare the most recent boot measurements to the integrity policy baseline and return a pair of pass/fail results depending on whether they match or not. Defaults to true.

property enableSecureBoot

enableSecureBoot?: undefined | false | true;

– Verify the digital signature of all boot components, and halt the boot process if signature verification fails. Defaults to false.

property enableVtpm

enableVtpm?: undefined | false | true;

– Use a virtualized trusted platform module, which is a specialized computer chip you can use to encrypt objects like keys and certificates. Defaults to true.

interface InstanceTemplateDisk

interface InstanceTemplateDisk

property autoDelete

autoDelete?: undefined | false | true;

Whether or not the disk should be auto-deleted. This defaults to true.

property boot

boot: boolean;

Indicates that this is a boot disk.

property deviceName

deviceName: string;

A unique device name that is reflected into the /dev/ tree of a Linux operating system running within the instance. If not specified, the server chooses a default device name to apply to this disk.

property diskEncryptionKey

diskEncryptionKey?: outputs.compute.InstanceTemplateDiskDiskEncryptionKey;

Encrypts or decrypts a disk using a customer-supplied encryption key.

property diskName

diskName?: undefined | string;

Name of the disk. When not provided, this defaults to the name of the instance.

property diskSizeGb

diskSizeGb?: undefined | number;

The size of the image in gigabytes. If not specified, it will inherit the size of its base image. For SCRATCH disks, the size must be exactly 375GB.

property diskType

diskType: string;

The GCE disk type. Can be either "pd-ssd", "local-ssd", or "pd-standard".

property interface

interface: string;

Specifies the disk interface to use for attaching this disk.

property labels

labels?: undefined | {[key: string]: string};

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

property mode

mode: string;

The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If you are attaching or creating a boot disk, this must read-write mode.

property source

source?: undefined | string;

The name (not self_link) of the disk (such as those managed by gcp.compute.Disk) to attach. > Note: Either source or sourceImage is required when creating a new instance except for when creating a local SSD. Check the API docs for details.

property sourceImage

sourceImage: string;

The image from which to initialize this disk. This can be one of: the image’s selfLink, projects/{project}/global/images/{image}, projects/{project}/global/images/family/{family}, global/images/{image}, global/images/family/{family}, family/{family}, {project}/{family}, {project}/{image}, {family}, or {image}. > Note: Either source or sourceImage is required when creating a new instance except for when creating a local SSD. Check the API docs for details.

property type

type: string;

The accelerator type resource to expose to this instance. E.g. nvidia-tesla-k80.

interface InstanceTemplateDiskDiskEncryptionKey

interface InstanceTemplateDiskDiskEncryptionKey
kmsKeySelfLink: string;

The self link of the encryption key that is stored in Google Cloud KMS

interface InstanceTemplateGuestAccelerator

interface InstanceTemplateGuestAccelerator

property count

count: number;

The number of the guest accelerator cards exposed to this instance.

property type

type: string;

The accelerator type resource to expose to this instance. E.g. nvidia-tesla-k80.

interface InstanceTemplateNetworkInterface

interface InstanceTemplateNetworkInterface

property accessConfigs

accessConfigs?: InstanceTemplateNetworkInterfaceAccessConfig[];

Access configurations, i.e. IPs via which this instance can be accessed via the Internet. Omit to ensure that the instance is not accessible from the Internet (this means that ssh provisioners will not work unless you can send traffic to the instance’s network (e.g. via tunnel or because it is running on another cloud instance on that network). This block can be repeated multiple times. Structure documented below.

property aliasIpRanges

aliasIpRanges?: InstanceTemplateNetworkInterfaceAliasIpRange[];

An array of alias IP ranges for this network interface. Can only be specified for network interfaces on subnet-mode networks. Structure documented below.

property name

name: string;

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

property network

network: string;

The name or selfLink of the network to attach this interface to. Use network attribute for Legacy or Auto subnetted networks and subnetwork for custom subnetted networks.

property networkIp

networkIp?: undefined | string;

The private IP address to assign to the instance. If empty, the address will be automatically assigned.

property subnetwork

subnetwork: string;

the name of the subnetwork to attach this interface to. The subnetwork must exist in the same region this instance will be created in. Either network or subnetwork must be provided.

property subnetworkProject

subnetworkProject: string;

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

interface InstanceTemplateNetworkInterfaceAccessConfig

interface InstanceTemplateNetworkInterfaceAccessConfig

property natIp

natIp: string;

The IP address that will be 1:1 mapped to the instance’s network ip. If not given, one will be generated.

property networkTier

networkTier: string;

The [networking tier][network-tier] used for configuring this instance template. This field can take the following values: PREMIUM or STANDARD. If this field is not specified, it is assumed to be PREMIUM.

property publicPtrDomainName

publicPtrDomainName: string;

interface InstanceTemplateNetworkInterfaceAliasIpRange

interface InstanceTemplateNetworkInterfaceAliasIpRange

property ipCidrRange

ipCidrRange: string;

The IP CIDR range represented by this alias IP range. This IP CIDR range must belong to the specified subnetwork and cannot contain IP addresses reserved by system or used by other network interfaces. At the time of writing only a netmask (e.g. /24) may be supplied, with a CIDR format resulting in an API error.

property subnetworkRangeName

subnetworkRangeName?: undefined | string;

The subnetwork secondary range name specifying the secondary range from which to allocate the IP CIDR range for this alias IP range. If left unspecified, the primary range of the subnetwork will be used.

interface InstanceTemplateScheduling

interface InstanceTemplateScheduling

property automaticRestart

automaticRestart?: undefined | false | true;

Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). This defaults to true.

property nodeAffinities

nodeAffinities?: InstanceTemplateSchedulingNodeAffinity[];

Specifies node affinities or anti-affinities to determine which sole-tenant nodes your instances and managed instance groups will use as host systems. Read more on sole-tenant node creation here. Structure documented below.

property onHostMaintenance

onHostMaintenance: string;

Defines the maintenance behavior for this instance.

property preemptible

preemptible?: undefined | false | true;

Allows instance to be preempted. This defaults to false. Read more on this here.

interface InstanceTemplateSchedulingNodeAffinity

interface InstanceTemplateSchedulingNodeAffinity

property key

key: string;

The key for the node affinity label.

property operator

operator: string;

The operator. Can be IN for node-affinities or NOT_IN for anti-affinities.

property values

values: string[];

interface InstanceTemplateServiceAccount

interface InstanceTemplateServiceAccount

property email

email: string;

The service account e-mail address. If not given, the default Google Compute Engine service account is used.

property scopes

scopes: string[];

A list of service scopes. Both OAuth2 URLs and gcloud short names are supported. To allow full access to all Cloud APIs, use the cloud-platform scope. See a complete list of scopes here.

interface InstanceTemplateShieldedInstanceConfig

interface InstanceTemplateShieldedInstanceConfig

property enableIntegrityMonitoring

enableIntegrityMonitoring?: undefined | false | true;

– Compare the most recent boot measurements to the integrity policy baseline and return a pair of pass/fail results depending on whether they match or not. Defaults to true.

property enableSecureBoot

enableSecureBoot?: undefined | false | true;

– Verify the digital signature of all boot components, and halt the boot process if signature verification fails. Defaults to false.

property enableVtpm

enableVtpm?: undefined | false | true;

– Use a virtualized trusted platform module, which is a specialized computer chip you can use to encrypt objects like keys and certificates. Defaults to true.

interface InterconnectAttachmentPrivateInterconnectInfo

interface InterconnectAttachmentPrivateInterconnectInfo

property tag8021q

tag8021q: number;

interface ManagedSslCertificateManaged

interface ManagedSslCertificateManaged

property domains

domains: string[];

Domains for which a managed SSL certificate will be valid. Currently, there can be up to 100 domains in this list.

interface MangedSslCertificateManaged

interface MangedSslCertificateManaged

property domains

domains: string[];

interface NodeGroupAutoscalingPolicy

interface NodeGroupAutoscalingPolicy

property maxNodes

maxNodes: number;

Maximum size of the node group. Set to a value less than or equal to 100 and greater than or equal to min-nodes.

property minNodes

minNodes: number;

Minimum size of the node group. Must be less than or equal to max-nodes. The default value is 0.

property mode

mode: string;

The autoscaling mode. Set to one of the following: - OFF: Disables the autoscaler. - ON: Enables scaling in and scaling out. - ONLY_SCALE_OUT: Enables only scaling out. You must use this mode if your node groups are configured to restart their hosted VMs on minimal servers.

interface NodeTemplateNodeTypeFlexibility

interface NodeTemplateNodeTypeFlexibility

property cpus

cpus?: undefined | string;

Number of virtual CPUs to use.

property localSsd

localSsd: string;

- Use local SSD

property memory

memory?: undefined | string;

Physical memory available to the node, defined in MB.

interface NodeTemplateServerBinding

interface NodeTemplateServerBinding

property type

type: string;

Type of server binding policy. If RESTART_NODE_ON_ANY_SERVER, nodes using this template will restart on any physical server following a maintenance event. If RESTART_NODE_ON_MINIMAL_SERVER, nodes using this template will restart on the same physical server following a maintenance event, instead of being live migrated to or restarted on a new physical server. This option may be useful if you are using software licenses tied to the underlying server characteristics such as physical sockets or cores, to avoid the need for additional licenses when maintenance occurs. However, VMs on such nodes will experience outages while maintenance is applied.

interface PacketMirroringCollectorIlb

interface PacketMirroringCollectorIlb

property url

url: string;

The URL of the instances where this rule should be active.

interface PacketMirroringFilter

interface PacketMirroringFilter

property cidrRanges

cidrRanges?: string[];

IP CIDR ranges that apply as a filter on the source (ingress) or destination (egress) IP in the IP header. Only IPv4 is supported.

property ipProtocols

ipProtocols?: string[];

Protocols that apply as a filter on mirrored traffic.

interface PacketMirroringMirroredResources

interface PacketMirroringMirroredResources

property instances

instances?: PacketMirroringMirroredResourcesInstance[];

All the listed instances will be mirrored. Specify at most 50. Structure is documented below.

property subnetworks

subnetworks?: PacketMirroringMirroredResourcesSubnetwork[];

All instances in one of these subnetworks will be mirrored. Structure is documented below.

property tags

tags?: string[];

All instances with these tags will be mirrored.

interface PacketMirroringMirroredResourcesInstance

interface PacketMirroringMirroredResourcesInstance

property url

url: string;

The URL of the instances where this rule should be active.

interface PacketMirroringMirroredResourcesSubnetwork

interface PacketMirroringMirroredResourcesSubnetwork

property url

url: string;

The URL of the instances where this rule should be active.

interface PacketMirroringNetwork

interface PacketMirroringNetwork

property url

url: string;

The URL of the instances where this rule should be active.

interface PerInstanceConfigPreservedState

interface PerInstanceConfigPreservedState

property disks

disks?: PerInstanceConfigPreservedStateDisk[];

Stateful disks for the instance. Structure is documented below.

property metadata

metadata?: undefined | {[key: string]: string};

Preserved metadata defined for this instance. This is a list of key->value pairs.

interface PerInstanceConfigPreservedStateDisk

interface PerInstanceConfigPreservedStateDisk

property deleteRule

deleteRule?: undefined | string;

A value that prescribes what should happen to the stateful disk when the VM instance is deleted. The available options are NEVER and ON_PERMANENT_INSTANCE_DELETION. NEVER detatch the disk when the VM is deleted, but not delete the disk. ON_PERMANENT_INSTANCE_DELETION will delete the stateful disk when the VM is permanently deleted from the instance group.

property deviceName

deviceName: string;

A unique device name that is reflected into the /dev/ tree of a Linux operating system running within the instance.

property mode

mode?: undefined | string;

The mode of the disk.

property source

source: string;

The URI of an existing persistent disk to attach under the specified device-name in the format projects/project-id/zones/zone/disks/disk-name.

interface RegionAutoscalerAutoscalingPolicy

interface RegionAutoscalerAutoscalingPolicy

property cooldownPeriod

cooldownPeriod?: undefined | number;

The number of seconds that the autoscaler should wait before it starts collecting information from a new instance. This prevents the autoscaler from collecting information when the instance is initializing, during which the collected usage would not be reliable. The default time autoscaler waits is 60 seconds. Virtual machine initialization times might vary because of numerous factors. We recommend that you test how long an instance may take to initialize. To do this, create an instance and time the startup process.

property cpuUtilization

cpuUtilization: RegionAutoscalerAutoscalingPolicyCpuUtilization;

Defines the CPU utilization policy that allows the autoscaler to scale based on the average CPU utilization of a managed instance group. Structure is documented below.

property loadBalancingUtilization

loadBalancingUtilization?: outputs.compute.RegionAutoscalerAutoscalingPolicyLoadBalancingUtilization;

Configuration parameters of autoscaling based on a load balancer. Structure is documented below.

property maxReplicas

maxReplicas: number;

The maximum number of instances that the autoscaler can scale up to. This is required when creating or updating an autoscaler. The maximum number of replicas should not be lower than minimal number of replicas.

property metrics

metrics?: RegionAutoscalerAutoscalingPolicyMetric[];

Configuration parameters of autoscaling based on a custom metric. Structure is documented below.

property minReplicas

minReplicas: number;

The minimum number of replicas that the autoscaler can scale down to. This cannot be less than 0. If not provided, autoscaler will choose a default value depending on maximum number of instances allowed.

interface RegionAutoscalerAutoscalingPolicyCpuUtilization

interface RegionAutoscalerAutoscalingPolicyCpuUtilization

property target

target: number;

Fraction of backend capacity utilization (set in HTTP(s) load balancing configuration) that autoscaler should maintain. Must be a positive float value. If not defined, the default is 0.8.

interface RegionAutoscalerAutoscalingPolicyLoadBalancingUtilization

interface RegionAutoscalerAutoscalingPolicyLoadBalancingUtilization

property target

target: number;

Fraction of backend capacity utilization (set in HTTP(s) load balancing configuration) that autoscaler should maintain. Must be a positive float value. If not defined, the default is 0.8.

interface RegionAutoscalerAutoscalingPolicyMetric

interface RegionAutoscalerAutoscalingPolicyMetric

property filter

filter?: undefined | string;

A filter string to be used as the filter string for a Stackdriver Monitoring TimeSeries.list API call. This filter is used to select a specific TimeSeries for the purpose of autoscaling and to determine whether the metric is exporting per-instance or per-group data. You can only use the AND operator for joining selectors. You can only use direct equality comparison operator (=) without any functions for each selector. You can specify the metric in both the filter string and in the metric field. However, if specified in both places, the metric must be identical. The monitored resource type determines what kind of values are expected for the metric. If it is a gce_instance, the autoscaler expects the metric to include a separate TimeSeries for each instance in a group. In such a case, you cannot filter on resource labels. If the resource type is any other value, the autoscaler expects this metric to contain values that apply to the entire autoscaled instance group and resource label filtering can be performed to point autoscaler at the correct TimeSeries to scale upon. This is called a per-group metric for the purpose of autoscaling. If not specified, the type defaults to gce_instance. You should provide a filter that is selective enough to pick just one TimeSeries for the autoscaled group or for each of the instances (if you are using gceInstance resource type). If multiple TimeSeries are returned upon the query execution, the autoscaler will sum their respective values to obtain its scaling value.

property name

name: string;

The identifier (type) of the Stackdriver Monitoring metric. The metric cannot have negative values. The metric must have a value type of INT64 or DOUBLE.

property singleInstanceAssignment

singleInstanceAssignment?: undefined | number;

If scaling is based on a per-group metric value that represents the total amount of work to be done or resource usage, set this value to an amount assigned for a single instance of the scaled group. The autoscaler will keep the number of instances proportional to the value of this metric, the metric itself should not change value due to group resizing. For example, a good metric to use with the target is pubsub.googleapis.com/subscription/num_undelivered_messages or a custom metric exporting the total number of requests coming to your instances. A bad example would be a metric exporting an average or median latency, since this value can’t include a chunk assignable to a single instance, it could be better used with utilizationTarget instead.

property target

target?: undefined | number;

Fraction of backend capacity utilization (set in HTTP(s) load balancing configuration) that autoscaler should maintain. Must be a positive float value. If not defined, the default is 0.8.

property type

type?: undefined | string;

Defines how target utilization value is expressed for a Stackdriver Monitoring metric.

interface RegionBackendServiceBackend

interface RegionBackendServiceBackend

property balancingMode

balancingMode?: undefined | string;

Specifies the balancing mode for this backend.

property capacityScaler

capacityScaler?: undefined | number;

A multiplier applied to the group’s maximum servicing capacity (based on UTILIZATION, RATE or CONNECTION). ~>NOTE: This field cannot be set for INTERNAL region backend services (default loadBalancingScheme), but is required for non-INTERNAL backend service. The total capacityScaler for all backends must be non-zero. A setting of 0 means the group is completely drained, offering 0% of its available Capacity. Valid range is [0.0,1.0].

property description

description?: undefined | string;

An optional description of this resource. Provide this property when you create the resource.

property failover

failover: boolean;

This field designates whether this is a failover backend. More than one failover backend can be configured for a given RegionBackendService.

property group

group: string;

The fully-qualified URL of an Instance Group or Network Endpoint Group resource. In case of instance group this defines the list of instances that serve traffic. Member virtual machine instances from each instance group must live in the same zone as the instance group itself. No two backends in a backend service are allowed to use same Instance Group resource. For Network Endpoint Groups this defines list of endpoints. All endpoints of Network Endpoint Group must be hosted on instances located in the same zone as the Network Endpoint Group. Backend services cannot mix Instance Group and Network Endpoint Group backends. When the loadBalancingScheme is INTERNAL, only instance groups are supported. Note that you must specify an Instance Group or Network Endpoint Group resource using the fully-qualified URL, rather than a partial URL.

property maxConnections

maxConnections?: undefined | number;

The maximum number of connections to the backend cluster. Defaults to 1024.

property maxConnectionsPerEndpoint

maxConnectionsPerEndpoint?: undefined | number;

The max number of simultaneous connections that a single backend network endpoint can handle. Cannot be set for INTERNAL backend services. This is used to calculate the capacity of the group. Can be used in either CONNECTION or UTILIZATION balancing modes. For CONNECTION mode, either maxConnections or maxConnectionsPerEndpoint must be set.

property maxConnectionsPerInstance

maxConnectionsPerInstance?: undefined | number;

The max number of simultaneous connections that a single backend instance can handle. Cannot be set for INTERNAL backend services. This is used to calculate the capacity of the group. Can be used in either CONNECTION or UTILIZATION balancing modes. For CONNECTION mode, either maxConnections or maxConnectionsPerInstance must be set.

property maxRate

maxRate?: undefined | number;

The max requests per second (RPS) of the group. Cannot be set for INTERNAL backend services. Can be used with either RATE or UTILIZATION balancing modes, but required if RATE mode. Either maxRate or one of maxRatePerInstance or maxRatePerEndpoint, as appropriate for group type, must be set.

property maxRatePerEndpoint

maxRatePerEndpoint?: undefined | number;

The max requests per second (RPS) that a single backend network endpoint can handle. This is used to calculate the capacity of the group. Can be used in either balancing mode. For RATE mode, either maxRate or maxRatePerEndpoint must be set. Cannot be set for INTERNAL backend services.

property maxRatePerInstance

maxRatePerInstance?: undefined | number;

The max requests per second (RPS) that a single backend instance can handle. This is used to calculate the capacity of the group. Can be used in either balancing mode. For RATE mode, either maxRate or maxRatePerInstance must be set. Cannot be set for INTERNAL backend services.

property maxUtilization

maxUtilization?: undefined | number;

Used when balancingMode is UTILIZATION. This ratio defines the CPU utilization target for the group. Valid range is [0.0, 1.0]. Cannot be set for INTERNAL backend services.

interface RegionBackendServiceCircuitBreakers

interface RegionBackendServiceCircuitBreakers

property connectTimeout

connectTimeout?: outputs.compute.RegionBackendServiceCircuitBreakersConnectTimeout;

The timeout for new network connections to hosts. Structure is documented below.

property maxConnections

maxConnections?: undefined | number;

The maximum number of connections to the backend cluster. Defaults to 1024.

property maxPendingRequests

maxPendingRequests?: undefined | number;

The maximum number of pending requests to the backend cluster. Defaults to 1024.

property maxRequests

maxRequests?: undefined | number;

The maximum number of parallel requests to the backend cluster. Defaults to 1024.

property maxRequestsPerConnection

maxRequestsPerConnection?: undefined | number;

Maximum requests for a single backend connection. This parameter is respected by both the HTTP/1.1 and HTTP/2 implementations. If not specified, there is no limit. Setting this parameter to 1 will effectively disable keep alive.

property maxRetries

maxRetries?: undefined | number;

The maximum number of parallel retries to the backend cluster. Defaults to 3.

interface RegionBackendServiceCircuitBreakersConnectTimeout

interface RegionBackendServiceCircuitBreakersConnectTimeout

property nanos

nanos?: undefined | number;

Span of time that’s a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 seconds field and a positive nanos field. Must be from 0 to 999,999,999 inclusive.

property seconds

seconds: number;

Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive.

interface RegionBackendServiceConsistentHash

interface RegionBackendServiceConsistentHash

property httpCookie

httpCookie?: outputs.compute.RegionBackendServiceConsistentHashHttpCookie;

Hash is based on HTTP Cookie. This field describes a HTTP cookie that will be used as the hash key for the consistent hash load balancer. If the cookie is not present, it will be generated. This field is applicable if the sessionAffinity is set to HTTP_COOKIE. Structure is documented below.

property httpHeaderName

httpHeaderName?: undefined | string;

The hash based on the value of the specified header field. This field is applicable if the sessionAffinity is set to HEADER_FIELD.

property minimumRingSize

minimumRingSize?: undefined | number;

The minimum number of virtual nodes to use for the hash ring. Larger ring sizes result in more granular load distributions. If the number of hosts in the load balancing pool is larger than the ring size, each host will be assigned a single virtual node. Defaults to 1024.

interface RegionBackendServiceConsistentHashHttpCookie

interface RegionBackendServiceConsistentHashHttpCookie

property name

name?: undefined | string;

Name of the cookie.

property path

path?: undefined | string;

Path to set for the cookie.

property ttl

ttl?: outputs.compute.RegionBackendServiceConsistentHashHttpCookieTtl;

Lifetime of the cookie. Structure is documented below.

interface RegionBackendServiceConsistentHashHttpCookieTtl

interface RegionBackendServiceConsistentHashHttpCookieTtl

property nanos

nanos?: undefined | number;

Span of time that’s a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 seconds field and a positive nanos field. Must be from 0 to 999,999,999 inclusive.

property seconds

seconds: number;

Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive.

interface RegionBackendServiceFailoverPolicy

interface RegionBackendServiceFailoverPolicy

property disableConnectionDrainOnFailover

disableConnectionDrainOnFailover?: undefined | false | true;

On failover or failback, this field indicates whether connection drain will be honored. Setting this to true has the following effect: connections to the old active pool are not drained. Connections to the new active pool use the timeout of 10 min (currently fixed). Setting to false has the following effect: both old and new connections will have a drain timeout of 10 min. This can be set to true only if the protocol is TCP. The default is false.

property dropTrafficIfUnhealthy

dropTrafficIfUnhealthy?: undefined | false | true;

This option is used only when no healthy VMs are detected in the primary and backup instance groups. When set to true, traffic is dropped. When set to false, new connections are sent across all VMs in the primary group. The default is false.

property failoverRatio

failoverRatio?: undefined | number;

The value of the field must be in [0, 1]. If the ratio of the healthy VMs in the primary backend is at or below this number, traffic arriving at the load-balanced IP will be directed to the failover backend. In case where ‘failoverRatio’ is not set or all the VMs in the backup backend are unhealthy, the traffic will be directed back to the primary backend in the “force” mode, where traffic will be spread to the healthy VMs with the best effort, or to all VMs when no VM is healthy. This field is only used with l4 load balancing.

interface RegionBackendServiceLogConfig

interface RegionBackendServiceLogConfig

property enable

enable?: undefined | false | true;

Whether to enable logging for the load balancer traffic served by this backend service.

property sampleRate

sampleRate?: undefined | number;

This field can only be specified if logging is enabled for this backend service. The value of the field must be in [0, 1]. This configures the sampling rate of requests to the load balancer where 1.0 means all logged requests are reported and 0.0 means no logged requests are reported. The default value is 1.0.

interface RegionBackendServiceOutlierDetection

interface RegionBackendServiceOutlierDetection

property baseEjectionTime

baseEjectionTime?: outputs.compute.RegionBackendServiceOutlierDetectionBaseEjectionTime;

The base time that a host is ejected for. The real time is equal to the base time multiplied by the number of times the host has been ejected. Defaults to 30000ms or 30s. Structure is documented below.

property consecutiveErrors

consecutiveErrors?: undefined | number;

Number of errors before a host is ejected from the connection pool. When the backend host is accessed over HTTP, a 5xx return code qualifies as an error. Defaults to 5.

property consecutiveGatewayFailure

consecutiveGatewayFailure?: undefined | number;

The number of consecutive gateway failures (502, 503, 504 status or connection errors that are mapped to one of those status codes) before a consecutive gateway failure ejection occurs. Defaults to 5.

property enforcingConsecutiveErrors

enforcingConsecutiveErrors?: undefined | number;

The percentage chance that a host will be actually ejected when an outlier status is detected through consecutive 5xx. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100.

property enforcingConsecutiveGatewayFailure

enforcingConsecutiveGatewayFailure?: undefined | number;

The percentage chance that a host will be actually ejected when an outlier status is detected through consecutive gateway failures. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 0.

property enforcingSuccessRate

enforcingSuccessRate?: undefined | number;

The percentage chance that a host will be actually ejected when an outlier status is detected through success rate statistics. This setting can be used to disable ejection or to ramp it up slowly. Defaults to 100.

property interval

interval?: outputs.compute.RegionBackendServiceOutlierDetectionInterval;

Time interval between ejection sweep analysis. This can result in both new ejections as well as hosts being returned to service. Defaults to 10 seconds. Structure is documented below.

property maxEjectionPercent

maxEjectionPercent?: undefined | number;

Maximum percentage of hosts in the load balancing pool for the backend service that can be ejected. Defaults to 10%.

property successRateMinimumHosts

successRateMinimumHosts?: undefined | number;

The number of hosts in a cluster that must have enough request volume to detect success rate outliers. If the number of hosts is less than this setting, outlier detection via success rate statistics is not performed for any host in the cluster. Defaults to 5.

property successRateRequestVolume

successRateRequestVolume?: undefined | number;

The minimum number of total requests that must be collected in one interval (as defined by the interval duration above) to include this host in success rate based outlier detection. If the volume is lower than this setting, outlier detection via success rate statistics is not performed for that host. Defaults to 100.

property successRateStdevFactor

successRateStdevFactor?: undefined | number;

This factor is used to determine the ejection threshold for success rate outlier ejection. The ejection threshold is the difference between the mean success rate, and the product of this factor and the standard deviation of the mean success rate: mean - (stdev * success_rate_stdev_factor). This factor is divided by a thousand to get a double. That is, if the desired factor is 1.9, the runtime value should be 1900. Defaults to 1900.

interface RegionBackendServiceOutlierDetectionBaseEjectionTime

interface RegionBackendServiceOutlierDetectionBaseEjectionTime

property nanos

nanos?: undefined | number;

Span of time that’s a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 seconds field and a positive nanos field. Must be from 0 to 999,999,999 inclusive.

property seconds

seconds: number;

Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive.

interface RegionBackendServiceOutlierDetectionInterval

interface RegionBackendServiceOutlierDetectionInterval

property nanos

nanos?: undefined | number;

Span of time that’s a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 seconds field and a positive nanos field. Must be from 0 to 999,999,999 inclusive.

property seconds

seconds: number;

Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive.

interface RegionDiskDiskEncryptionKey

interface RegionDiskDiskEncryptionKey

property kmsKeyName

kmsKeyName?: undefined | string;

The name of the encryption key that is stored in Google Cloud KMS.

property rawKey

rawKey?: undefined | string;

Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

property sha256

sha256: string;

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

interface RegionDiskSourceSnapshotEncryptionKey

interface RegionDiskSourceSnapshotEncryptionKey

property kmsKeyName

kmsKeyName?: undefined | string;

The name of the encryption key that is stored in Google Cloud KMS.

property rawKey

rawKey?: undefined | string;

Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource.

property sha256

sha256: string;

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

interface RegionHealthCheckHttp2HealthCheck

interface RegionHealthCheckHttp2HealthCheck

property host

host?: undefined | string;

The value of the host header in the HTTP2 health check request. If left empty (default value), the public IP on behalf of which this health check is performed will be used.

property port

port?: undefined | number;

The TCP port number for the HTTP2 health check request. The default value is 443.

property portName

portName?: undefined | string;

Port name as defined in InstanceGroup#NamedPort#name. If both port and portName are defined, port takes precedence.

property portSpecification

portSpecification?: undefined | string;

Specifies how port is selected for health checking, can be one of the following values: * USE_FIXED_PORT: The port number in port is used for health checking. * USE_NAMED_PORT: The portName is used for health checking. * USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking. If not specified, HTTP2 health check follows behavior specified in port and portName fields.

property proxyHeader

proxyHeader?: undefined | string;

Specifies the type of proxy header to append before sending data to the backend.

property requestPath

requestPath?: undefined | string;

The request path of the HTTP2 health check request. The default value is /.

property response

response?: undefined | string;

The bytes to match against the beginning of the response data. If left empty (the default value), any response will indicate health. The response data can only be ASCII.

interface RegionHealthCheckHttpHealthCheck

interface RegionHealthCheckHttpHealthCheck

property host

host?: undefined | string;

The value of the host header in the HTTP2 health check request. If left empty (default value), the public IP on behalf of which this health check is performed will be used.

property port

port?: undefined | number;

The TCP port number for the HTTP2 health check request. The default value is 443.

property portName

portName?: undefined | string;

Port name as defined in InstanceGroup#NamedPort#name. If both port and portName are defined, port takes precedence.

property portSpecification

portSpecification?: undefined | string;

Specifies how port is selected for health checking, can be one of the following values: * USE_FIXED_PORT: The port number in port is used for health checking. * USE_NAMED_PORT: The portName is used for health checking. * USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking. If not specified, HTTP2 health check follows behavior specified in port and portName fields.

property proxyHeader

proxyHeader?: undefined | string;

Specifies the type of proxy header to append before sending data to the backend.

property requestPath

requestPath?: undefined | string;

The request path of the HTTP2 health check request. The default value is /.

property response

response?: undefined | string;

The bytes to match against the beginning of the response data. If left empty (the default value), any response will indicate health. The response data can only be ASCII.

interface RegionHealthCheckHttpsHealthCheck

interface RegionHealthCheckHttpsHealthCheck

property host

host?: undefined | string;

The value of the host header in the HTTP2 health check request. If left empty (default value), the public IP on behalf of which this health check is performed will be used.

property port

port?: undefined | number;

The TCP port number for the HTTP2 health check request. The default value is 443.

property portName

portName?: undefined | string;

Port name as defined in InstanceGroup#NamedPort#name. If both port and portName are defined, port takes precedence.

property portSpecification

portSpecification?: undefined | string;

Specifies how port is selected for health checking, can be one of the following values: * USE_FIXED_PORT: The port number in port is used for health checking. * USE_NAMED_PORT: The portName is used for health checking. * USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking. If not specified, HTTP2 health check follows behavior specified in port and portName fields.

property proxyHeader

proxyHeader?: undefined | string;

Specifies the type of proxy header to append before sending data to the backend.

property requestPath

requestPath?: undefined | string;

The request path of the HTTP2 health check request. The default value is /.

property response

response?: undefined | string;

The bytes to match against the beginning of the response data. If left empty (the default value), any response will indicate health. The response data can only be ASCII.

interface RegionHealthCheckLogConfig

interface RegionHealthCheckLogConfig

property enable

enable?: undefined | false | true;

Indicates whether or not to export logs. This is false by default, which means no health check logging will be done.

interface RegionHealthCheckSslHealthCheck

interface RegionHealthCheckSslHealthCheck

property port

port?: undefined | number;

The TCP port number for the HTTP2 health check request. The default value is 443.

property portName

portName?: undefined | string;

Port name as defined in InstanceGroup#NamedPort#name. If both port and portName are defined, port takes precedence.

property portSpecification

portSpecification?: undefined | string;

Specifies how port is selected for health checking, can be one of the following values: * USE_FIXED_PORT: The port number in port is used for health checking. * USE_NAMED_PORT: The portName is used for health checking. * USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking. If not specified, HTTP2 health check follows behavior specified in port and portName fields.

property proxyHeader

proxyHeader?: undefined | string;

Specifies the type of proxy header to append before sending data to the backend.

property request

request?: undefined | string;

The application data to send once the SSL connection has been established (default value is empty). If both request and response are empty, the connection establishment alone will indicate health. The request data can only be ASCII.

property response

response?: undefined | string;

The bytes to match against the beginning of the response data. If left empty (the default value), any response will indicate health. The response data can only be ASCII.

interface RegionHealthCheckTcpHealthCheck

interface RegionHealthCheckTcpHealthCheck

property port

port?: undefined | number;

The TCP port number for the HTTP2 health check request. The default value is 443.

property portName

portName?: undefined | string;

Port name as defined in InstanceGroup#NamedPort#name. If both port and portName are defined, port takes precedence.

property portSpecification

portSpecification?: undefined | string;

Specifies how port is selected for health checking, can be one of the following values: * USE_FIXED_PORT: The port number in port is used for health checking. * USE_NAMED_PORT: The portName is used for health checking. * USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking. If not specified, HTTP2 health check follows behavior specified in port and portName fields.

property proxyHeader

proxyHeader?: undefined | string;

Specifies the type of proxy header to append before sending data to the backend.

property request

request?: undefined | string;

The application data to send once the SSL connection has been established (default value is empty). If both request and response are empty, the connection establishment alone will indicate health. The request data can only be ASCII.

property response

response?: undefined | string;

The bytes to match against the beginning of the response data. If left empty (the default value), any response will indicate health. The response data can only be ASCII.

interface RegionInstanceGroupManagerAutoHealingPolicies

interface RegionInstanceGroupManagerAutoHealingPolicies

property healthCheck

healthCheck: string;

The health check resource that signals autohealing.

property initialDelaySec

initialDelaySec: number;

The number of seconds that the managed instance group waits before it applies autohealing policies to new instances or recently recreated instances. Between 0 and 3600.

interface RegionInstanceGroupManagerNamedPort

interface RegionInstanceGroupManagerNamedPort

property name

name: string;
  • Version name.

property port

port: number;

The port number.


interface RegionInstanceGroupManagerStatefulDisk

interface RegionInstanceGroupManagerStatefulDisk

property deleteRule

deleteRule?: undefined | string;

, A value that prescribes what should happen to the stateful disk when the VM instance is deleted. The available options are NEVER and ON_PERMANENT_INSTANCE_DELETION. NEVER detatch the disk when the VM is deleted, but not delete the disk. ON_PERMANENT_INSTANCE_DELETION will delete the stateful disk when the VM is permanently deleted from the instance group. The default is NEVER.

property deviceName

deviceName: string;

, The device name of the disk to be attached.

interface RegionInstanceGroupManagerUpdatePolicy

interface RegionInstanceGroupManagerUpdatePolicy

property instanceRedistributionType

instanceRedistributionType?: undefined | string;
  • The instance redistribution policy for regional managed instance groups. Valid values are: "PROACTIVE", "NONE". If PROACTIVE (default), the group attempts to maintain an even distribution of VM instances across zones in the region. If NONE, proactive redistribution is disabled.

property maxSurgeFixed

maxSurgeFixed: number;

, The maximum number of instances that can be created above the specified targetSize during the update process. Conflicts with maxSurgePercent. It has to be either 0 or at least equal to the number of zones. If fixed values are used, at least one of maxUnavailableFixed or maxSurgeFixed must be greater than 0.

property maxSurgePercent

maxSurgePercent?: undefined | number;

, The maximum number of instances(calculated as percentage) that can be created above the specified targetSize during the update process. Conflicts with maxSurgeFixed. Percent value is only allowed for regional managed instance groups with size at least 10.

property maxUnavailableFixed

maxUnavailableFixed: number;

, The maximum number of instances that can be unavailable during the update process. Conflicts with maxUnavailablePercent. It has to be either 0 or at least equal to the number of zones. If fixed values are used, at least one of maxUnavailableFixed or maxSurgeFixed must be greater than 0.

property maxUnavailablePercent

maxUnavailablePercent?: undefined | number;

, The maximum number of instances(calculated as percentage) that can be unavailable during the update process. Conflicts with maxUnavailableFixed. Percent value is only allowed for regional managed instance groups with size at least 10.

property minReadySec

minReadySec?: undefined | number;

, Minimum number of seconds to wait for after a newly created instance becomes available. This value must be from range [0, 3600]


property minimalAction

minimalAction: string;
  • Minimal action to be taken on an instance. You can specify either RESTART to restart existing instances or REPLACE to delete and create new instances from the target template. If you specify a RESTART, the Updater will attempt to perform that action only. However, if the Updater determines that the minimal action you specify is not enough to perform the update, it might perform a more disruptive action.

property type

type: string;
  • The type of update process. You can specify either PROACTIVE so that the instance group manager proactively executes actions in order to bring instances to their target versions or OPPORTUNISTIC so that no action is proactively executed but the update will be performed as part of other actions (for example, resizes or recreateInstances calls).

interface RegionInstanceGroupManagerVersion

interface RegionInstanceGroupManagerVersion

property instanceTemplate

instanceTemplate: string;
  • The full URL to an instance template from which all new instances of this version will be created.

property name

name?: undefined | string;
  • Version name.

property targetSize

targetSize?: outputs.compute.RegionInstanceGroupManagerVersionTargetSize;
  • The number of instances calculated as a fixed number or a percentage depending on the settings. Structure is documented below.

interface RegionInstanceGroupManagerVersionTargetSize

interface RegionInstanceGroupManagerVersionTargetSize

property fixed

fixed?: undefined | number;

, The number of instances which are managed for this version. Conflicts with percent.

property percent

percent?: undefined | number;

, The number of instances (calculated as percentage) which are managed for this version. Conflicts with fixed. Note that when using percent, rounding will be in favor of explicitly set targetSize values; a managed instance group with 2 instances and 2 versions, one of which has a target_size.percent of 60 will create 2 instances of that version.

interface RegionPerInstanceConfigPreservedState

interface RegionPerInstanceConfigPreservedState

property disks

disks?: RegionPerInstanceConfigPreservedStateDisk[];

Stateful disks for the instance. Structure is documented below.

property metadata

metadata?: undefined | {[key: string]: string};

Preserved metadata defined for this instance. This is a list of key->value pairs.

interface RegionPerInstanceConfigPreservedStateDisk

interface RegionPerInstanceConfigPreservedStateDisk

property deleteRule

deleteRule?: undefined | string;

A value that prescribes what should happen to the stateful disk when the VM instance is deleted. The available options are NEVER and ON_PERMANENT_INSTANCE_DELETION. NEVER detatch the disk when the VM is deleted, but not delete the disk. ON_PERMANENT_INSTANCE_DELETION will delete the stateful disk when the VM is permanently deleted from the instance group.

property deviceName

deviceName: string;

A unique device name that is reflected into the /dev/ tree of a Linux operating system running within the instance.

property mode

mode?: undefined | string;

The mode of the disk.

property source

source: string;

The URI of an existing persistent disk to attach under the specified device-name in the format projects/project-id/zones/zone/disks/disk-name.

interface RegionUrlMapDefaultUrlRedirect

interface RegionUrlMapDefaultUrlRedirect

property hostRedirect

hostRedirect?: undefined | string;

The host that will be used in the redirect response instead of the one that was supplied in the request. The value must be between 1 and 255 characters.

property httpsRedirect

httpsRedirect?: undefined | false | true;

If set to true, the URL scheme in the redirected request is set to https. If set to false, the URL scheme of the redirected request will remain the same as that of the request. This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted. The default is set to false.

property pathRedirect

pathRedirect?: undefined | string;

The path that will be used in the redirect response instead of the one that was supplied in the request. pathRedirect cannot be supplied together with prefixRedirect. Supply one alone or neither. If neither is supplied, the path of the original request will be used for the redirect. The value must be between 1 and 1024 characters.

property prefixRedirect

prefixRedirect?: undefined | string;

The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request. prefixRedirect cannot be supplied together with pathRedirect. Supply one alone or neither. If neither is supplied, the path of the original request will be used for the redirect. The value must be between 1 and 1024 characters.

property redirectResponseCode

redirectResponseCode?: undefined | string;

The HTTP Status code to use for this RedirectAction. Supported values are: - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301. - FOUND, which corresponds to 302. - SEE_OTHER which corresponds to 303. - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained. - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

property stripQuery

stripQuery: boolean;

If set to true, any accompanying query portion of the original URL is removed prior to redirecting the request. If set to false, the query portion of the original URL is retained. This field is required to ensure an empty block is not set. The normal default value is false.

interface RegionUrlMapHostRule

interface RegionUrlMapHostRule

property description

description?: undefined | string;

Description of this test case.

property hosts

hosts: string[];

The list of host patterns to match. They must be valid hostnames, except * will match any string of ([a-z0-9-.]*). In that case, * must be the first character and must be followed in the pattern by either - or ..

property pathMatcher

pathMatcher: string;

The name of the PathMatcher to use to match the path portion of the URL if the hostRule matches the URL’s host portion.

interface RegionUrlMapPathMatcher

interface RegionUrlMapPathMatcher

property defaultService

defaultService: string;

A reference to a RegionBackendService resource. This will be used if none of the pathRules defined by this PathMatcher is matched by the URL’s path portion.

property defaultUrlRedirect

defaultUrlRedirect?: outputs.compute.RegionUrlMapPathMatcherDefaultUrlRedirect;

When none of the specified hostRules match, the request is redirected to a URL specified by defaultUrlRedirect. If defaultUrlRedirect is specified, defaultService or defaultRouteAction must not be set. Structure is documented below.

property description

description?: undefined | string;

Description of this test case.

property name

name: string;

The name of the query parameter to match. The query parameter must exist in the request, in the absence of which the request match fails.

property pathRules

pathRules?: RegionUrlMapPathMatcherPathRule[];

The list of path rules. Use this list instead of routeRules when routing based on simple path matching is all that’s required. The order by which path rules are specified does not matter. Matches are always done on the longest-path-first basis. For example: a pathRule with a path /a/b/c/* will match before /a/b/* irrespective of the order in which those paths appear in this list. Within a given pathMatcher, only one of pathRules or routeRules must be set. Structure is documented below.

property routeRules

routeRules?: RegionUrlMapPathMatcherRouteRule[];

The list of ordered HTTP route rules. Use this list instead of pathRules when advanced route matching and routing actions are desired. The order of specifying routeRules matters: the first rule that matches will cause its specified routing action to take effect. Within a given pathMatcher, only one of pathRules or routeRules must be set. routeRules are not supported in UrlMaps intended for External load balancers. Structure is documented below.

interface RegionUrlMapPathMatcherDefaultUrlRedirect

interface RegionUrlMapPathMatcherDefaultUrlRedirect

property hostRedirect

hostRedirect?: undefined | string;

The host that will be used in the redirect response instead of the one that was supplied in the request. The value must be between 1 and 255 characters.

property httpsRedirect

httpsRedirect?: undefined | false | true;

If set to true, the URL scheme in the redirected request is set to https. If set to false, the URL scheme of the redirected request will remain the same as that of the request. This must only be set for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy is not permitted. The default is set to false.

property pathRedirect

pathRedirect?: undefined | string;

The path that will be used in the redirect response instead of the one that was supplied in the request. pathRedirect cannot be supplied together with prefixRedirect. Supply one alone or neither. If neither is supplied, the path of the original request will be used for the redirect. The value must be between 1 and 1024 characters.

property prefixRedirect

prefixRedirect?: undefined | string;

The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, retaining the remaining portion of the URL before redirecting the request. prefixRedirect cannot be supplied together with pathRedirect. Supply one alone or neither. If neither is supplied, the path of the original request will be used for the redirect. The value must be between 1 and 1024 characters.

property redirectResponseCode

redirectResponseCode?: undefined | string;

The HTTP Status code to use for this RedirectAction. Supported values are: - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds to 301. - FOUND, which corresponds to 302. - SEE_OTHER which corresponds to 303. - TEMPORARY_REDIRECT, which corresponds to 307. In this case, the request method will be retained. - PERMANENT_REDIRECT, which corresponds to 308. In this case, the request method will be retained.

property stripQuery

stripQuery: boolean;

If set to true, any accompanying query portion of the original URL is removed prior to redirecting the request. If set to false, the query portion of the original URL is retained. This field is required to ensure an empty block is not set. The normal default value is false.

interface RegionUrlMapPathMatcherPathRule

interface RegionUrlMapPathMatcherPathRule

property paths

paths: string[];

The list of path patterns to match. Each must start with / and the only place a * is allowed is at the end following a /. The string fed to the path matcher does not include any text after the first ? or #, and those chars are not allowed here.

property routeAction

routeAction?: outputs.compute.RegionUrlMapPathMatcherPathRuleRouteAction;

In response to a matching path, the load balancer performs advanced routing actions like URL rewrites, header transformations, etc. prior to forwarding the request to the selected backend. If routeAction specifies any weightedBackendServices, service must not be set. Conversely if service is set, routeAction cannot contain any weightedBackendServices. Only one of routeAction or urlRedirect must be set. Structure is documented below.

property service

service?: undefined | string;

A reference to expected RegionBackendService resource the given URL should be mapped to.

property urlRedirect

urlRedirect?: outputs.compute.RegionUrlMapPathMatcherPathRuleUrlRedirect;

When a path pattern is matched, the request is redirected to a URL specified by urlRedirect. If urlRedirect is specified, service or routeAction must not be set. Structure is documented below.

interface RegionUrlMapPathMatcherPathRuleRouteAction

interface RegionUrlMapPathMatcherPathRuleRouteAction

property corsPolicy

corsPolicy?: outputs.compute.RegionUrlMapPathMatcherPathRuleRouteActionCorsPolicy;

The specification for allowing client side cross-origin requests. Please see W3C Recommendation for Cross Origin Resource Sharing Structure is documented below.

property faultInjectionPolicy

faultInjectionPolicy?: outputs.compute.RegionUrlMapPathMatcherPathRuleRouteActionFaultInjectionPolicy;

The specification for fault injection introduced into traffic to test the resiliency of clients to backend service failure. As part of fault injection, when clients send requests to a backend service, delays can be introduced by Loadbalancer on a percentage of requests before sending those request to the backend service. Similarly requests from clients can be aborted by the Loadbalancer for a percentage of requests. timeout and retryPolicy will be ignored by clients that are configured with a fault_injection_policy. Structure is documented below.

property requestMirrorPolicy

requestMirrorPolicy?: outputs.compute.RegionUrlMapPathMatcherPathRuleRouteActionRequestMirrorPolicy;

Specifies the policy on how requests intended for the route’s backends are shadowed to a separate mirrored backend service. Loadbalancer does not wait for responses from the shadow service. Prior to sending traffic to the shadow service, the host / authority header is suffixed with -shadow. Structure is documented below.

property retryPolicy

retryPolicy?: outputs.compute.RegionUrlMapPathMatcherPathRuleRouteActionRetryPolicy;

Specifies the retry policy associated with this route. Structure is documented below.

property timeout

timeout?: outputs.compute.RegionUrlMapPathMatcherPathRuleRouteActionTimeout;

Specifies the timeout for the selected route. Timeout is computed from the time the request is has been fully processed (i.e. end-of-stream) up until the response has been completely processed. Timeout includes all retries. If not specified, the default value is 15 seconds. Structure is documented below.

property urlRewrite

urlRewrite?: outputs.compute.RegionUrlMapPathMatcherPathRuleRouteActionUrlRewrite;

The spec to modify the URL of the request, prior to forwarding the request to the matched service Structure is documented below.

property weightedBackendServices

weightedBackendServices?: RegionUrlMapPathMatcherPathRuleRouteActionWeightedBackendService[];

A list of weighted backend services to send traffic to when a route match occurs. The weights determine the fraction of traffic that flows to their corresponding backend service. If all traffic needs to go to a single backend service, there must be one weightedBackendService with weight set to a non 0 number. Once a backendService is identified and before forwarding the request to the backend service, advanced routing actions like Url rewrites and header transformations are applied depending on additional settings specified in this HttpRouteAction. Structure is documented below.

interface RegionUrlMapPathMatcherPathRuleRouteActionCorsPolicy

interface RegionUrlMapPathMatcherPathRuleRouteActionCorsPolicy

property allowCredentials

allowCredentials?: undefined | false | true;

In response to a preflight request, setting this to true indicates that the actual request can include user credentials. This translates to the Access- Control-Allow-Credentials header. Defaults to false.

property allowHeaders

allowHeaders?: string[];

Specifies the content for the Access-Control-Allow-Headers header.

property allowMethods

allowMethods?: string[];

Specifies the content for the Access-Control-Allow-Methods header.

property allowOriginRegexes

allowOriginRegexes?: string[];

Specifies the regualar expression patterns that match allowed origins. For regular expression grammar please see en.cppreference.com/w/cpp/regex/ecmascript An origin is allowed if it matches either allowOrigins or allow_origin_regex.

property allowOrigins

allowOrigins?: string[];

Specifies the list of origins that will be allowed to do CORS requests. An origin is allowed if it matches either allowOrigins or allow_origin_regex.

property disabled

disabled: boolean;

If true, specifies the CORS policy is disabled.

property exposeHeaders

exposeHeaders?: string[];

Specifies the content for the Access-Control-Expose-Headers header.

property maxAge

maxAge?: undefined | number;

Specifies how long the results of a preflight request can be cached. This translates to the content for the Access-Control-Max-Age header.

interface RegionUrlMapPathMatcherPathRuleRouteActionFaultInjectionPolicy

interface RegionUrlMapPathMatcherPathRuleRouteActionFaultInjectionPolicy

property abort

abort?: outputs.compute.RegionUrlMapPathMatcherPathRuleRouteActionFaultInjectionPolicyAbort;

The specification for how client requests are aborted as part of fault injection. Structure is documented below.

property delay

delay?: outputs.compute.RegionUrlMapPathMatcherPathRuleRouteActionFaultInjectionPolicyDelay;

The specification for how client requests are delayed as part of fault injection, before being sent to a backend service. Structure is documented below.

interface RegionUrlMapPathMatcherPathRuleRouteActionFaultInjectionPolicyAbort

interface RegionUrlMapPathMatcherPathRuleRouteActionFaultInjectionPolicyAbort

property httpStatus

httpStatus: number;

The HTTP status code used to abort the request. The value must be between 200 and 599 inclusive.

property percentage

percentage: number;

The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection. The value must be between 0.0 and 100.0 inclusive.

interface RegionUrlMapPathMatcherPathRuleRouteActionFaultInjectionPolicyDelay

interface RegionUrlMapPathMatcherPathRuleRouteActionFaultInjectionPolicyDelay

property fixedDelay

fixedDelay: RegionUrlMapPathMatcherPathRuleRouteActionFaultInjectionPolicyDelayFixedDelay;

Specifies the value of the fixed delay interval. Structure is documented below.

property percentage

percentage: number;

The percentage of traffic (connections/operations/requests) on which delay will be introduced as part of fault injection. The value must be between 0.0 and 100.0 inclusive.

interface RegionUrlMapPathMatcherPathRuleRouteActionFaultInjectionPolicyDelayFixedDelay

interface RegionUrlMapPathMatcherPathRuleRouteActionFaultInjectionPolicyDelayFixedDelay

property nanos

nanos?: undefined | number;

Span of time that’s a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 seconds field and a positive nanos field. Must be from 0 to 999,999,999 inclusive.

property seconds

seconds: string;

Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive.

interface RegionUrlMapPathMatcherPathRuleRouteActionRequestMirrorPolicy

interface RegionUrlMapPathMatcherPathRuleRouteActionRequestMirrorPolicy

property backendService

backendService: string;

The default RegionBackendService resource. Before forwarding the request to backendService, the loadbalancer applies any relevant headerActions specified as part of this backendServiceWeight.

interface RegionUrlMapPathMatcherPathRuleRouteActionRetryPolicy

interface RegionUrlMapPathMatcherPathRuleRouteActionRetryPolicy

property numRetries

numRetries?: undefined | number;

Specifies the allowed number retries. This number must be > 0.

property perTryTimeout

perTryTimeout?: outputs.compute.RegionUrlMapPathMatcherPathRuleRouteActionRetryPolicyPerTryTimeout;

Specifies a non-zero timeout per retry attempt. Structure is documented below.

property retryConditions

retryConditions?: string[];

Specifies one or more conditions when this retry rule applies. Valid values are: - 5xx: Loadbalancer will attempt a retry if the backend service responds with any 5xx response code, or if the backend service does not respond at all, example: disconnects, reset, read timeout, connection failure, and refused streams. - gateway-error: Similar to 5xx, but only applies to response codes 502, 503 or 504. - connect-failure: Loadbalancer will retry on failures connecting to backend services, for example due to connection timeouts. - retriable-4xx: Loadbalancer will retry for retriable 4xx response codes. Currently the only retriable error supported is 409. - refused-stream: Loadbalancer will retry if the backend service resets the stream with a REFUSED_STREAM error code. This reset type indicates that it is safe to retry. - cancelled: Loadbalancer will retry if the gRPC status code in the response header is set to cancelled - deadline-exceeded: Loadbalancer will retry if the gRPC status code in the response header is set to deadline-exceeded - resource-exhausted: Loadbalancer will retry if the gRPC status code in the response header is set to resource-exhausted - unavailable: Loadbalancer will retry if the gRPC status code in the response header is set to unavailable

interface RegionUrlMapPathMatcherPathRuleRouteActionRetryPolicyPerTryTimeout

interface RegionUrlMapPathMatcherPathRuleRouteActionRetryPolicyPerTryTimeout

property nanos

nanos?: undefined | number;

Span of time that’s a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 seconds field and a positive nanos field. Must be from 0 to 999,999,999 inclusive.

property seconds

seconds: string;

Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive.

interface RegionUrlMapPathMatcherPathRuleRouteActionTimeout

interface RegionUrlMapPathMatcherPathRuleRouteActionTimeout

property nanos

nanos?: undefined | number;

Span of time that’s a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 seconds field and a positive nanos field. Must be from 0 to 999,999,999 inclusive.

property seconds

seconds: string;

Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive.

interface RegionUrlMapPathMatcherPathRuleRouteActionUrlRewrite

interface RegionUrlMapPathMatcherPathRuleRouteActionUrlRewrite

property hostRewrite

hostRewrite?: undefined | string;

Prior to forwarding the request to the selected service, the request’s host header is replaced with contents of hostRewrite. The value must be between 1 and 255 characters.

property pathPrefixRewrite

pathPrefixRewrite?: undefined | string;

Prior to forwarding the request to the selected backend service, the matching portion of the request’s path is replaced by pathPrefixRewrite. The value must be between 1 and 1024 characters.

interface RegionUrlMapPathMatcherPathRuleRouteActionWeightedBackendService

interface RegionUrlMapPathMatcherPathRuleRouteActionWeightedBackendService

property backendService

backendService: string;

The default RegionBackendService resource. Before forwarding the request to backendService, the loadbalancer applies any relevant headerActions specified as part of this backendServiceWeight.

property headerAction

headerAction?: outputs.compute.RegionUrlMapPathMatcherPathRuleRouteActionWeightedBackendServiceHeaderAction;

Specifies changes to request and response headers that need to take effect for the selected backendService. headerAction specified here take effect before headerAction in the enclosing HttpRouteRule, PathMatcher and UrlMap. Structure is documented below.

property weight

weight: number;

Specifies the fraction of traffic sent to backendService, computed as weight / (sum of all weightedBackendService weights in routeAction) . The selection of a backend service is determined only for new traffic. Once a user’s request has been directed to a backendService, subsequent requests will be sent to the same backendService as determined by the BackendService’s session affinity policy. The value must be between 0 and 1000

interface RegionUrlMapPathMatcherPathRuleRouteActionWeightedBackendServiceHeaderAction

interface RegionUrlMapPathMatcherPathRuleRouteActionWeightedBackendServiceHeaderAction

property requestHeadersToAdds

requestHeadersToAdds?: RegionUrlMapPathMatcherPathRuleRouteActionWeightedBackendServiceHeaderActionRequestHeadersToAdd[];

Headers to add to a matching request prior to forwarding the request to the backe