---
title: Getting Started with Datadog
description: Datadog, the leading service for cloud-scale monitoring.
breadcrumbs: Docs > Infrastructure > Datadog Resource Catalog
---

# gcp_appengine_version{% #gcp_appengine_version %}

## `ancestors`{% #ancestors %}

**Type**: `UNORDERED_LIST_STRING`

## `api_config`{% #api_config %}

**Type**: `STRUCT`**Provider name**: `apiConfig`**Description**: Serving configuration for Google Cloud Endpoints ([https://cloud.google.com/endpoints).Only](https://cloud.google.com/endpoints%29.Only) returned in GET requests if view=FULL is set.

- `auth_fail_action`**Type**: `STRING`**Provider name**: `authFailAction`**Description**: Action to take when users access resources that require authentication. Defaults to redirect.**Possible values**:
  - `AUTH_FAIL_ACTION_UNSPECIFIED` - Not specified. AUTH_FAIL_ACTION_REDIRECT is assumed.
  - `AUTH_FAIL_ACTION_REDIRECT` - Redirects user to 'accounts.google.com'. The user is redirected back to the application URL after signing in or creating an account.
  - `AUTH_FAIL_ACTION_UNAUTHORIZED` - Rejects request with a 401 HTTP status code and an error message.
- `login`**Type**: `STRING`**Provider name**: `login`**Description**: Level of login required to access this resource. Defaults to optional.**Possible values**:
  - `LOGIN_UNSPECIFIED` - Not specified. LOGIN_OPTIONAL is assumed.
  - `LOGIN_OPTIONAL` - Does not require that the user is signed in.
  - `LOGIN_ADMIN` - If the user is not signed in, the auth_fail_action is taken. In addition, if the user is not an administrator for the application, they are given an error message regardless of auth_fail_action. If the user is an administrator, the handler proceeds.
  - `LOGIN_REQUIRED` - If the user has signed in, the handler proceeds normally. Otherwise, the auth_fail_action is taken.
- `script`**Type**: `STRING`**Provider name**: `script`**Description**: Path to the script from the application root directory.
- `security_level`**Type**: `STRING`**Provider name**: `securityLevel`**Description**: Security (HTTPS) enforcement for this URL.**Possible values**:
  - `SECURE_UNSPECIFIED` - Not specified.
  - `SECURE_DEFAULT` - Both HTTP and HTTPS requests with URLs that match the handler succeed without redirects. The application can examine the request to determine which protocol was used, and respond accordingly.
  - `SECURE_NEVER` - Requests for a URL that match this handler that use HTTPS are automatically redirected to the HTTP equivalent URL.
  - `SECURE_OPTIONAL` - Both HTTP and HTTPS requests with URLs that match the handler succeed without redirects. The application can examine the request to determine which protocol was used and respond accordingly.
  - `SECURE_ALWAYS` - Requests for a URL that match this handler that do not use HTTPS are automatically redirected to the HTTPS URL with the same path. Query parameters are reserved for the redirect.
- `url`**Type**: `STRING`**Provider name**: `url`**Description**: URL to serve the endpoint at.

## `app_engine_apis`{% #app_engine_apis %}

**Type**: `BOOLEAN`**Provider name**: `appEngineApis`**Description**: Allows App Engine second generation runtimes to access the legacy bundled services.

## `automatic_scaling`{% #automatic_scaling %}

**Type**: `STRUCT`**Provider name**: `automaticScaling`**Description**: Automatic scaling is based on request rate, response latencies, and other application metrics. Instances are dynamically created and destroyed as needed in order to handle traffic.

- `cool_down_period`**Type**: `STRING`**Provider name**: `coolDownPeriod`**Description**: The time period that the Autoscaler ([https://cloud.google.com/compute/docs/autoscaler/](https://cloud.google.com/compute/docs/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. Only applicable in the App Engine flexible environment.
- `cpu_utilization`**Type**: `STRUCT`**Provider name**: `cpuUtilization`**Description**: Target scaling by CPU usage.
  - `aggregation_window_length`**Type**: `STRING`**Provider name**: `aggregationWindowLength`**Description**: Period of time over which CPU utilization is calculated.
  - `target_utilization`**Type**: `DOUBLE`**Provider name**: `targetUtilization`**Description**: Target CPU utilization ratio to maintain when scaling. Must be between 0 and 1.
- `disk_utilization`**Type**: `STRUCT`**Provider name**: `diskUtilization`**Description**: Target scaling by disk usage.
  - `target_read_bytes_per_second`**Type**: `INT32`**Provider name**: `targetReadBytesPerSecond`**Description**: Target bytes read per second.
  - `target_read_ops_per_second`**Type**: `INT32`**Provider name**: `targetReadOpsPerSecond`**Description**: Target ops read per seconds.
  - `target_write_bytes_per_second`**Type**: `INT32`**Provider name**: `targetWriteBytesPerSecond`**Description**: Target bytes written per second.
  - `target_write_ops_per_second`**Type**: `INT32`**Provider name**: `targetWriteOpsPerSecond`**Description**: Target ops written per second.
- `max_concurrent_requests`**Type**: `INT32`**Provider name**: `maxConcurrentRequests`**Description**: Number of concurrent requests an automatic scaling instance can accept before the scheduler spawns a new instance.Defaults to a runtime-specific value.
- `max_idle_instances`**Type**: `INT32`**Provider name**: `maxIdleInstances`**Description**: Maximum number of idle instances that should be maintained for this version.
- `max_pending_latency`**Type**: `STRING`**Provider name**: `maxPendingLatency`**Description**: Maximum amount of time that a request should wait in the pending queue before starting a new instance to handle it.
- `max_total_instances`**Type**: `INT32`**Provider name**: `maxTotalInstances`**Description**: Maximum number of instances that should be started to handle requests for this version.
- `min_idle_instances`**Type**: `INT32`**Provider name**: `minIdleInstances`**Description**: Minimum number of idle instances that should be maintained for this version. Only applicable for the default version of a service.
- `min_pending_latency`**Type**: `STRING`**Provider name**: `minPendingLatency`**Description**: Minimum amount of time a request should wait in the pending queue before starting a new instance to handle it.
- `min_total_instances`**Type**: `INT32`**Provider name**: `minTotalInstances`**Description**: Minimum number of running instances that should be maintained for this version.
- `network_utilization`**Type**: `STRUCT`**Provider name**: `networkUtilization`**Description**: Target scaling by network usage.
  - `target_received_bytes_per_second`**Type**: `INT32`**Provider name**: `targetReceivedBytesPerSecond`**Description**: Target bytes received per second.
  - `target_received_packets_per_second`**Type**: `INT32`**Provider name**: `targetReceivedPacketsPerSecond`**Description**: Target packets received per second.
  - `target_sent_bytes_per_second`**Type**: `INT32`**Provider name**: `targetSentBytesPerSecond`**Description**: Target bytes sent per second.
  - `target_sent_packets_per_second`**Type**: `INT32`**Provider name**: `targetSentPacketsPerSecond`**Description**: Target packets sent per second.
- `request_utilization`**Type**: `STRUCT`**Provider name**: `requestUtilization`**Description**: Target scaling by request utilization.
  - `target_concurrent_requests`**Type**: `INT32`**Provider name**: `targetConcurrentRequests`**Description**: Target number of concurrent requests.
  - `target_request_count_per_second`**Type**: `INT32`**Provider name**: `targetRequestCountPerSecond`**Description**: Target requests per second.
- `standard_scheduler_settings`**Type**: `STRUCT`**Provider name**: `standardSchedulerSettings`**Description**: Scheduler settings for standard environment.
  - `max_instances`**Type**: `INT32`**Provider name**: `maxInstances`**Description**: Maximum number of instances to run for this version. Set to 2147483647 to disable max_instances configuration.
  - `min_instances`**Type**: `INT32`**Provider name**: `minInstances`**Description**: Minimum number of instances to run for this version. Set to zero to disable min_instances configuration.
  - `target_cpu_utilization`**Type**: `DOUBLE`**Provider name**: `targetCpuUtilization`**Description**: Target CPU utilization ratio to maintain when scaling.
  - `target_throughput_utilization`**Type**: `DOUBLE`**Provider name**: `targetThroughputUtilization`**Description**: Target throughput utilization ratio to maintain when scaling

## `basic_scaling`{% #basic_scaling %}

**Type**: `STRUCT`**Provider name**: `basicScaling`**Description**: A service with basic scaling will create an instance when the application receives a request. The instance will be turned down when the app becomes idle. Basic scaling is ideal for work that is intermittent or driven by user activity.

- `idle_timeout`**Type**: `STRING`**Provider name**: `idleTimeout`**Description**: Duration of time after the last request that an instance must wait before the instance is shut down.
- `max_instances`**Type**: `INT32`**Provider name**: `maxInstances`**Description**: Maximum number of instances to create for this version.

## `create_time`{% #create_time %}

**Type**: `TIMESTAMP`**Provider name**: `createTime`**Description**: Time that this version was created.@OutputOnly

## `created_by`{% #created_by %}

**Type**: `STRING`**Provider name**: `createdBy`**Description**: Output only. Email address of the user who created this version.@OutputOnly

## `default_expiration`{% #default_expiration %}

**Type**: `STRING`**Provider name**: `defaultExpiration`**Description**: Duration that static files should be cached by web proxies and browsers. Only applicable if the corresponding StaticFilesHandler ([https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#StaticFilesHandler](https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#StaticFilesHandler)) does not specify its own expiration time.Only returned in GET requests if view=FULL is set.

## `deployment`{% #deployment %}

**Type**: `STRUCT`**Provider name**: `deployment`**Description**: Code and application artifacts that make up this version.Only returned in GET requests if view=FULL is set.

- `cloud_build_options`**Type**: `STRUCT`**Provider name**: `cloudBuildOptions`**Description**: Options for any Google Cloud Build builds created as a part of this deployment.These options will only be used if a new build is created, such as when deploying to the App Engine flexible environment using files or zip.
  - `app_yaml_path`**Type**: `STRING`**Provider name**: `appYamlPath`**Description**: Path to the yaml file used in deployment, used to determine runtime configuration details.Required for flexible environment builds.See [https://cloud.google.com/appengine/docs/standard/python/config/appref](https://cloud.google.com/appengine/docs/standard/python/config/appref) for more details.
  - `cloud_build_timeout`**Type**: `STRING`**Provider name**: `cloudBuildTimeout`**Description**: The Cloud Build timeout used as part of any dependent builds performed by version creation. Defaults to 10 minutes.
- `container`**Type**: `STRUCT`**Provider name**: `container`**Description**: The Docker image for the container that runs the version. Only applicable for instances running in the App Engine flexible environment.
  - `image`**Type**: `STRING`**Provider name**: `image`**Description**: 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"
- `zip`**Type**: `STRUCT`**Provider name**: `zip`**Description**: The zip file for this deployment, if this is a zip deployment.
  - `files_count`**Type**: `INT32`**Provider name**: `filesCount`**Description**: An estimate of the number of files in a zip for a zip deployment. If set, must be greater than or equal to the actual number of files. Used for optimizing performance; if not provided, deployment may be slow.
  - `source_url`**Type**: `STRING`**Provider name**: `sourceUrl`**Description**: URL of the zip file to deploy from. Must be a URL to a resource in Google Cloud Storage in the form 'http(s)://storage.googleapis.com//'.

## `disk_usage_bytes`{% #disk_usage_bytes %}

**Type**: `INT64`**Provider name**: `diskUsageBytes`**Description**: Output only. Total size in bytes of all the files that are included in this version and currently hosted on the App Engine disk.@OutputOnly

## `endpoints_api_service`{% #endpoints_api_service %}

**Type**: `STRUCT`**Provider name**: `endpointsApiService`**Description**: Cloud Endpoints configuration.If endpoints_api_service is set, the Cloud Endpoints Extensible Service Proxy will be provided to serve the API implemented by the app.

- `config_id`**Type**: `STRING`**Provider name**: `configId`**Description**: Endpoints service configuration ID as specified by the Service Management API. For example "2016-09-19r1".By default, the rollout strategy for Endpoints is RolloutStrategy.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 config_id field is used to give the configuration ID and is required in this case.Endpoints also has a rollout strategy called RolloutStrategy.MANAGED. When using this, Endpoints fetches the latest configuration and does not need the configuration ID. In this case, config_id must be omitted.
- `disable_trace_sampling`**Type**: `BOOLEAN`**Provider name**: `disableTraceSampling`**Description**: Enable or disable trace sampling. By default, this is set to false for enabled.
- `name`**Type**: `STRING`**Provider name**: `name`**Description**: Endpoints service name which is the name of the "service" resource in the Service Management API. For example "myapi.endpoints.myproject.cloud.goog"
- `rollout_strategy`**Type**: `STRING`**Provider name**: `rolloutStrategy`**Description**: Endpoints rollout strategy. If FIXED, config_id must be specified. If MANAGED, config_id must be omitted.**Possible values**:
  - `UNSPECIFIED_ROLLOUT_STRATEGY` - Not specified. Defaults to FIXED.
  - `FIXED` - Endpoints service configuration ID will be fixed to the configuration ID specified by config_id.
  - `MANAGED` - Endpoints service configuration ID will be updated with each rollout.

## `entrypoint`{% #entrypoint %}

**Type**: `STRUCT`**Provider name**: `entrypoint`**Description**: The entrypoint for the application.

- `shell`**Type**: `STRING`**Provider name**: `shell`**Description**: The format should be a shell command that can be fed to bash -c.

## `env`{% #env %}

**Type**: `STRING`**Provider name**: `env`**Description**: App Engine execution environment for this version.Defaults to standard.

## `error_handlers`{% #error_handlers %}

**Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `errorHandlers`**Description**: Custom static error pages. Limited to 10KB per page.Only returned in GET requests if view=FULL is set.

- `error_code`**Type**: `STRING`**Provider name**: `errorCode`**Description**: Error condition this handler applies to.**Possible values**:
  - `ERROR_CODE_UNSPECIFIED` - Not specified. ERROR_CODE_DEFAULT is assumed.
  - `ERROR_CODE_DEFAULT` - All other error types.
  - `ERROR_CODE_OVER_QUOTA` - Application has exceeded a resource quota.
  - `ERROR_CODE_DOS_API_DENIAL` - Client blocked by the application's Denial of Service protection configuration.
  - `ERROR_CODE_TIMEOUT` - Deadline reached before the application responds.
- `mime_type`**Type**: `STRING`**Provider name**: `mimeType`**Description**: MIME type of file. Defaults to text/html.
- `static_file`**Type**: `STRING`**Provider name**: `staticFile`**Description**: Static file content to be served for this error.

## `flexible_runtime_settings`{% #flexible_runtime_settings %}

**Type**: `STRUCT`**Provider name**: `flexibleRuntimeSettings`**Description**: Settings for App Engine flexible runtimes.

- `operating_system`**Type**: `STRING`**Provider name**: `operatingSystem`**Description**: The operating system of the application runtime.
- `runtime_version`**Type**: `STRING`**Provider name**: `runtimeVersion`**Description**: The runtime version of an App Engine flexible application.

## `handlers`{% #handlers %}

**Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `handlers`**Description**: An ordered list of URL-matching patterns that should be applied to incoming requests. The first matching URL handles the request and other request handlers are not attempted.Only returned in GET requests if view=FULL is set.

- `api_endpoint`**Type**: `STRUCT`**Provider name**: `apiEndpoint`**Description**: Uses API Endpoints to handle requests.
  - `script_path`**Type**: `STRING`**Provider name**: `scriptPath`**Description**: Path to the script from the application root directory.
- `auth_fail_action`**Type**: `STRING`**Provider name**: `authFailAction`**Description**: Action to take when users access resources that require authentication. Defaults to redirect.**Possible values**:
  - `AUTH_FAIL_ACTION_UNSPECIFIED` - Not specified. AUTH_FAIL_ACTION_REDIRECT is assumed.
  - `AUTH_FAIL_ACTION_REDIRECT` - Redirects user to 'accounts.google.com'. The user is redirected back to the application URL after signing in or creating an account.
  - `AUTH_FAIL_ACTION_UNAUTHORIZED` - Rejects request with a 401 HTTP status code and an error message.
- `login`**Type**: `STRING`**Provider name**: `login`**Description**: Level of login required to access this resource. Not supported for Node.js in the App Engine standard environment.**Possible values**:
  - `LOGIN_UNSPECIFIED` - Not specified. LOGIN_OPTIONAL is assumed.
  - `LOGIN_OPTIONAL` - Does not require that the user is signed in.
  - `LOGIN_ADMIN` - If the user is not signed in, the auth_fail_action is taken. In addition, if the user is not an administrator for the application, they are given an error message regardless of auth_fail_action. If the user is an administrator, the handler proceeds.
  - `LOGIN_REQUIRED` - If the user has signed in, the handler proceeds normally. Otherwise, the auth_fail_action is taken.
- `redirect_http_response_code`**Type**: `STRING`**Provider name**: `redirectHttpResponseCode`**Description**: 30x code to use when performing redirects for the secure field. Defaults to 302.**Possible values**:
  - `REDIRECT_HTTP_RESPONSE_CODE_UNSPECIFIED` - Not specified. 302 is assumed.
  - `REDIRECT_HTTP_RESPONSE_CODE_301` - 301 Moved Permanently code.
  - `REDIRECT_HTTP_RESPONSE_CODE_302` - 302 Moved Temporarily code.
  - `REDIRECT_HTTP_RESPONSE_CODE_303` - 303 See Other code.
  - `REDIRECT_HTTP_RESPONSE_CODE_307` - 307 Temporary Redirect code.
- `script`**Type**: `STRUCT`**Provider name**: `script`**Description**: 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".
  - `script_path`**Type**: `STRING`**Provider name**: `scriptPath`**Description**: Path to the script from the application root directory.
- `security_level`**Type**: `STRING`**Provider name**: `securityLevel`**Description**: Security (HTTPS) enforcement for this URL.**Possible values**:
  - `SECURE_UNSPECIFIED` - Not specified.
  - `SECURE_DEFAULT` - Both HTTP and HTTPS requests with URLs that match the handler succeed without redirects. The application can examine the request to determine which protocol was used, and respond accordingly.
  - `SECURE_NEVER` - Requests for a URL that match this handler that use HTTPS are automatically redirected to the HTTP equivalent URL.
  - `SECURE_OPTIONAL` - Both HTTP and HTTPS requests with URLs that match the handler succeed without redirects. The application can examine the request to determine which protocol was used and respond accordingly.
  - `SECURE_ALWAYS` - Requests for a URL that match this handler that do not use HTTPS are automatically redirected to the HTTPS URL with the same path. Query parameters are reserved for the redirect.
- `static_files`**Type**: `STRUCT`**Provider name**: `staticFiles`**Description**: Returns the contents of a file, such as an image, as the response.
  - `application_readable`**Type**: `BOOLEAN`**Provider name**: `applicationReadable`**Description**: 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.
  - `expiration`**Type**: `STRING`**Provider name**: `expiration`**Description**: Time a static file served by this handler should be cached by web proxies and browsers.
  - `mime_type`**Type**: `STRING`**Provider name**: `mimeType`**Description**: 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.
  - `path`**Type**: `STRING`**Provider name**: `path`**Description**: 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.
  - `require_matching_file`**Type**: `BOOLEAN`**Provider name**: `requireMatchingFile`**Description**: Whether this handler should match the request if the file referenced by the handler does not exist.
  - `upload_path_regex`**Type**: `STRING`**Provider name**: `uploadPathRegex`**Description**: Regular expression that matches the file paths for all files that should be referenced by this handler.
- `url_regex`**Type**: `STRING`**Provider name**: `urlRegex`**Description**: 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.

## `health_check`{% #health_check %}

**Type**: `STRUCT`**Provider name**: `healthCheck`**Description**: Configures health checking for instances. Unhealthy instances are stopped and replaced with new instances. Only applicable in the App Engine flexible environment.

- `check_interval`**Type**: `STRING`**Provider name**: `checkInterval`**Description**: Interval between health checks.
- `disable_health_check`**Type**: `BOOLEAN`**Provider name**: `disableHealthCheck`**Description**: Whether to explicitly disable health checks for this instance.
- `healthy_threshold`**Type**: `INT32`**Provider name**: `healthyThreshold`**Description**: Number of consecutive successful health checks required before receiving traffic.
- `host`**Type**: `STRING`**Provider name**: `host`**Description**: Host header to send when performing an HTTP health check. Example: "myapp.appspot.com"
- `restart_threshold`**Type**: `INT32`**Provider name**: `restartThreshold`**Description**: Number of consecutive failed health checks required before an instance is restarted.
- `timeout`**Type**: `STRING`**Provider name**: `timeout`**Description**: Time before the health check is considered failed.
- `unhealthy_threshold`**Type**: `INT32`**Provider name**: `unhealthyThreshold`**Description**: Number of consecutive failed health checks required before removing traffic.

## `id`{% #id %}

**Type**: `STRING`**Provider name**: `id`**Description**: Relative name of the version within the service. Example: v1. Version names can contain only lowercase letters, numbers, or hyphens. Reserved names: "default", "latest", and any name with the prefix "ah-".

## `inbound_services`{% #inbound_services %}

**Type**: `UNORDERED_LIST_STRING`**Provider name**: `inboundServices`**Description**: Before an application can receive email or XMPP messages, the application must be configured to enable the service.

## `instance_class`{% #instance_class %}

**Type**: `STRING`**Provider name**: `instanceClass`**Description**: Instance class that is used to run this version. Valid values are: AutomaticScaling: F1, F2, F4, F4_1G ManualScaling or BasicScaling: B1, B2, B4, B8, B4_1GDefaults to F1 for AutomaticScaling and B1 for ManualScaling or BasicScaling.

## `labels`{% #labels %}

**Type**: `UNORDERED_LIST_STRING`

## `libraries`{% #libraries %}

**Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `libraries`**Description**: Configuration for third-party Python runtime libraries that are required by the application.Only returned in GET requests if view=FULL is set.

- `name`**Type**: `STRING`**Provider name**: `name`**Description**: Name of the library. Example: "django".
- `version`**Type**: `STRING`**Provider name**: `version`**Description**: Version of the library to select, or "latest".

## `liveness_check`{% #liveness_check %}

**Type**: `STRUCT`**Provider name**: `livenessCheck`**Description**: Configures liveness health checking for instances. Unhealthy instances are stopped and replaced with new instances

- `check_interval`**Type**: `STRING`**Provider name**: `checkInterval`**Description**: Interval between health checks.
- `failure_threshold`**Type**: `INT32`**Provider name**: `failureThreshold`**Description**: Number of consecutive failed checks required before considering the VM unhealthy.
- `host`**Type**: `STRING`**Provider name**: `host`**Description**: Host header to send when performing a HTTP Liveness check. Example: "myapp.appspot.com"
- `initial_delay`**Type**: `STRING`**Provider name**: `initialDelay`**Description**: The initial delay before starting to execute the checks.
- `path`**Type**: `STRING`**Provider name**: `path`**Description**: The request path.
- `success_threshold`**Type**: `INT32`**Provider name**: `successThreshold`**Description**: Number of consecutive successful checks required before considering the VM healthy.
- `timeout`**Type**: `STRING`**Provider name**: `timeout`**Description**: Time before the check is considered failed.

## `manual_scaling`{% #manual_scaling %}

**Type**: `STRUCT`**Provider name**: `manualScaling`**Description**: A service with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time. Manually scaled versions are sometimes referred to as "backends".

- `instances`**Type**: `INT32`**Provider name**: `instances`**Description**: Number of instances to assign to the service at the start. This number can later be altered by using the Modules API ([https://cloud.google.com/appengine/docs/python/modules/functions](https://cloud.google.com/appengine/docs/python/modules/functions)) set_num_instances() function.

## `name`{% #name %}

**Type**: `STRING`**Provider name**: `name`**Description**: Output only. Full path to the Version resource in the API. Example: apps/myapp/services/default/versions/v1.@OutputOnly

## `network`{% #network %}

**Type**: `STRUCT`**Provider name**: `network`**Description**: Extra network settings. Only applicable in the App Engine flexible environment.

- `forwarded_ports`**Type**: `UNORDERED_LIST_STRING`**Provider name**: `forwardedPorts`**Description**: List of ports, or port pairs, to forward from the virtual machine to the application container. Only applicable in the App Engine flexible environment.
- `instance_ip_mode`**Type**: `STRING`**Provider name**: `instanceIpMode`**Description**: The IP mode for instances. Only applicable in the App Engine flexible environment.**Possible values**:
  - `INSTANCE_IP_MODE_UNSPECIFIED` - Unspecified is treated as EXTERNAL.
  - `EXTERNAL` - Instances are created with both internal and external IP addresses.
  - `INTERNAL` - Instances are created with internal IP addresses only.
- `instance_tag`**Type**: `STRING`**Provider name**: `instanceTag`**Description**: Tag to apply to the instance during creation. Only applicable in the App Engine flexible environment.
- `name`**Type**: `STRING`**Provider name**: `name`**Description**: Google Compute Engine network where the virtual machines are created. Specify the short name, not the resource path.Defaults to default.
- `session_affinity`**Type**: `BOOLEAN`**Provider name**: `sessionAffinity`**Description**: Enable session affinity. Only applicable in the App Engine flexible environment.
- `subnetwork_name`**Type**: `STRING`**Provider name**: `subnetworkName`**Description**: Google Cloud Platform sub-network where the virtual machines are created. Specify the short name, not the resource path.If a subnetwork name is specified, a network name will also be required unless it is for the default network. 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 subnetwork_name) 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 subnetwork_name 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.

## `nobuild_files_regex`{% #nobuild_files_regex %}

**Type**: `STRING`**Provider name**: `nobuildFilesRegex`**Description**: Files that match this pattern will not be built into this version. Only applicable for Go runtimes.Only returned in GET requests if view=FULL is set.

## `organization_id`{% #organization_id %}

**Type**: `STRING`

## `parent`{% #parent %}

**Type**: `STRING`

## `project_id`{% #project_id %}

**Type**: `STRING`

## `project_number`{% #project_number %}

**Type**: `STRING`

## `readiness_check`{% #readiness_check %}

**Type**: `STRUCT`**Provider name**: `readinessCheck`**Description**: Configures readiness health checking for instances. Unhealthy instances are not put into the backend traffic rotation.

- `app_start_timeout`**Type**: `STRING`**Provider name**: `appStartTimeout`**Description**: A maximum time limit on application initialization, measured from moment the application successfully replies to a healthcheck until it is ready to serve traffic.
- `check_interval`**Type**: `STRING`**Provider name**: `checkInterval`**Description**: Interval between health checks.
- `failure_threshold`**Type**: `INT32`**Provider name**: `failureThreshold`**Description**: Number of consecutive failed checks required before removing traffic.
- `host`**Type**: `STRING`**Provider name**: `host`**Description**: Host header to send when performing a HTTP Readiness check. Example: "myapp.appspot.com"
- `path`**Type**: `STRING`**Provider name**: `path`**Description**: The request path.
- `success_threshold`**Type**: `INT32`**Provider name**: `successThreshold`**Description**: Number of consecutive successful checks required before receiving traffic.
- `timeout`**Type**: `STRING`**Provider name**: `timeout`**Description**: Time before the check is considered failed.

## `region_id`{% #region_id %}

**Type**: `STRING`

## `resource_name`{% #resource_name %}

**Type**: `STRING`

## `resources`{% #resources %}

**Type**: `STRUCT`**Provider name**: `resources`**Description**: Machine resources for this version. Only applicable in the App Engine flexible environment.

- `cpu`**Type**: `DOUBLE`**Provider name**: `cpu`**Description**: Number of CPU cores needed.
- `disk_gb`**Type**: `DOUBLE`**Provider name**: `diskGb`**Description**: Disk size (GB) needed.
- `kms_key_reference`**Type**: `STRING`**Provider name**: `kmsKeyReference`**Description**: The name of the encryption key that is stored in Google Cloud KMS. Only should be used by Cloud Composer to encrypt the vm disk
- `memory_gb`**Type**: `DOUBLE`**Provider name**: `memoryGb`**Description**: Memory (GB) needed.
- `volumes`**Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `volumes`**Description**: User specified volumes.
  - `name`**Type**: `STRING`**Provider name**: `name`**Description**: Unique name for the volume.
  - `size_gb`**Type**: `DOUBLE`**Provider name**: `sizeGb`**Description**: Volume size in gigabytes.
  - `volume_type`**Type**: `STRING`**Provider name**: `volumeType`**Description**: Underlying volume type, e.g. 'tmpfs'.

## `runtime`{% #runtime %}

**Type**: `STRING`**Provider name**: `runtime`**Description**: Desired runtime. Example: python27.

## `runtime_api_version`{% #runtime_api_version %}

**Type**: `STRING`**Provider name**: `runtimeApiVersion`**Description**: The version of the API in the given runtime environment. Please see the app.yaml reference for valid values at [https://cloud.google.com/appengine/docs/standard//config/appref](https://cloud.google.com/appengine/docs/standard//config/appref)

## `runtime_channel`{% #runtime_channel %}

**Type**: `STRING`**Provider name**: `runtimeChannel`**Description**: The channel of the runtime to use. Only available for some runtimes. Defaults to the default channel.

## `runtime_main_executable_path`{% #runtime_main_executable_path %}

**Type**: `STRING`**Provider name**: `runtimeMainExecutablePath`**Description**: The path or name of the app's main executable.

## `service_account`{% #service_account %}

**Type**: `STRING`**Provider name**: `serviceAccount`**Description**: The identity that the deployed version will run as. Admin API will use the App Engine Appspot service account as default if this field is neither provided in app.yaml file nor through CLI flag.

## `serving_status`{% #serving_status %}

**Type**: `STRING`**Provider name**: `servingStatus`**Description**: Current serving status of this version. Only the versions with a SERVING status create instances and can be billed.SERVING_STATUS_UNSPECIFIED is an invalid value. Defaults to SERVING.**Possible values**:

- `SERVING_STATUS_UNSPECIFIED` - Not specified.
- `SERVING` - Currently serving. Instances are created according to the scaling settings of the version.
- `STOPPED` - Disabled. No instances will be created and the scaling settings are ignored until the state of the version changes to SERVING.

## `tags`{% #tags %}

**Type**: `UNORDERED_LIST_STRING`

## `threadsafe`{% #threadsafe %}

**Type**: `BOOLEAN`**Provider name**: `threadsafe`**Description**: Whether multiple requests can be dispatched to this version at once.

## `version_url`{% #version_url %}

**Type**: `STRING`**Provider name**: `versionUrl`**Description**: Output only. Serving URL for this version. Example: "[https://myversion-dot-myservice-dot-myapp.appspot.com](https://myversion-dot-myservice-dot-myapp.appspot.com)"@OutputOnly

## `vm`{% #vm %}

**Type**: `BOOLEAN`**Provider name**: `vm`**Description**: Whether to deploy this version in a container on a virtual machine.

## `vpc_access_connector`{% #vpc_access_connector %}

**Type**: `STRUCT`**Provider name**: `vpcAccessConnector`**Description**: Enables VPC connectivity for standard apps.

- `egress_setting`**Type**: `STRING`**Provider name**: `egressSetting`**Description**: The egress setting for the connector, controlling what traffic is diverted through it.**Possible values**:
  - `EGRESS_SETTING_UNSPECIFIED`
  - `ALL_TRAFFIC` - Force the use of VPC Access for all egress traffic from the function.
  - `PRIVATE_IP_RANGES` - Use the VPC Access Connector for private IP space from RFC1918.
- `name`**Type**: `STRING`**Provider name**: `name`**Description**: Full Serverless VPC Access Connector name e.g. projects/my-project/locations/us-central1/connectors/c1.

## `zone_id`{% #zone_id %}

**Type**: `STRING`

## `zones`{% #zones %}

**Type**: `UNORDERED_LIST_STRING`**Provider name**: `zones`**Description**: The Google Compute Engine zones that are supported by this version in the App Engine flexible environment. Deprecated.