FlexibleAppVersion
Flexible App Version resource to create a new version of flexible GAE Application. Based on Google Compute Engine, the App Engine flexible environment automatically scales your app up and down while also balancing the load. Learn about the differences between the standard environment and the flexible environment at https://cloud.google.com/appengine/docs/the-appengine-environments.
Note: The App Engine flexible environment service account uses the member ID
service-[YOUR_PROJECT_NUMBER]@gae-api-prod.google.com.iam.gserviceaccount.comIt should have the App Engine Flexible Environment Service Agent role, which will be applied when theappengineflex.googleapis.comservice is enabled.
To get more information about FlexibleAppVersion, see:
- API documentation
- How-to Guides
Create a FlexibleAppVersion Resource
new FlexibleAppVersion(name: string, args: FlexibleAppVersionArgs, opts?: CustomResourceOptions);def FlexibleAppVersion(resource_name, opts=None, api_config=None, automatic_scaling=None, beta_settings=None, default_expiration=None, delete_service_on_destroy=None, deployment=None, endpoints_api_service=None, entrypoint=None, env_variables=None, handlers=None, inbound_services=None, instance_class=None, liveness_check=None, manual_scaling=None, network=None, nobuild_files_regex=None, noop_on_destroy=None, project=None, readiness_check=None, resources=None, runtime=None, runtime_api_version=None, runtime_channel=None, runtime_main_executable_path=None, service=None, serving_status=None, version_id=None, vpc_access_connector=None, __props__=None);func NewFlexibleAppVersion(ctx *Context, name string, args FlexibleAppVersionArgs, opts ...ResourceOption) (*FlexibleAppVersion, error)public FlexibleAppVersion(string name, FlexibleAppVersionArgs args, CustomResourceOptions? opts = null)- name string
- The unique name of the resource.
- args FlexibleAppVersionArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- opts ResourceOptions
- A bag of options that control this resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args FlexibleAppVersionArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args FlexibleAppVersionArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
FlexibleAppVersion Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.
Inputs
The FlexibleAppVersion resource accepts the following input properties:
- Liveness
Check FlexibleApp Version Liveness Check Args Health checking configuration for VM instances. Unhealthy instances are killed and replaced with new instances. Structure is documented below.
- Readiness
Check FlexibleApp Version Readiness Check Args Configures readiness health checking for instances. Unhealthy instances are not put into the backend traffic rotation. Structure is documented below.
- Runtime string
Desired runtime. Example python27.
- Service string
AppEngine service resource
- Api
Config FlexibleApp Version Api Config Args Serving configuration for Google Cloud Endpoints. Structure is documented below.
- Automatic
Scaling FlexibleApp Version Automatic Scaling Args Automatic scaling is based on request rate, response latencies, and other application metrics. Structure is documented below.
- Beta
Settings Dictionary<string, string> Metadata settings that are supplied to this version to enable beta runtime features.
- Default
Expiration string Duration that static files should be cached by web proxies and browsers. Only applicable if the corresponding StaticFilesHandler does not specify its own expiration time.
- Delete
Service boolOn Destroy If set to
true, the service will be deleted if it is the last version.- Deployment
Flexible
App Version Deployment Args Code and application artifacts that make up this version. Structure is documented below.
- Endpoints
Api FlexibleService App Version Endpoints Api Service Args Code and application artifacts that make up this version. Structure is documented below.
- Entrypoint
Flexible
App Version Entrypoint Args The entrypoint for the application. Structure is documented below.
- Env
Variables Dictionary<string, string> Environment variables available to the application. As these are not returned in the API request, the provider will not detect any changes made outside of the config.
- Handlers
List<Flexible
App Version Handler Args> 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. Structure is documented below.
- Inbound
Services List<string> Before an application can receive email or XMPP messages, the application must be configured to enable the service.
- Instance
Class string Instance class that is used to run this version. Valid values are AutomaticScaling: F1, F2, F4, F4_1G ManualScaling: B1, B2, B4, B8, B4_1G Defaults to F1 for AutomaticScaling and B1 for ManualScaling.
- Manual
Scaling FlexibleApp Version Manual Scaling Args A service with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time. Structure is documented below.
- Network
Flexible
App Version Network Args Extra network settings Structure is documented below.
- Nobuild
Files stringRegex Files that match this pattern will not be built into this version. Only applicable for Go runtimes.
- Noop
On boolDestroy If set to
true, the application version will not be deleted.- Project string
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- Resources
Flexible
App Version Resources Args Machine resources for a version. Structure is documented below.
- Runtime
Api stringVersion 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
- Runtime
Channel string The channel of the runtime to use. Only available for some runtimes.
- Runtime
Main stringExecutable Path The path or name of the app’s main executable.
- Serving
Status string Current serving status of this version. Only the versions with a SERVING status create instances and can be billed.
- Version
Id string Relative name of the version within the service. For example,
v1. Version names can contain only lowercase letters, numbers, or hyphens. Reserved names,“default”, “latest”, and any name with the prefix “ah-”.- Vpc
Access FlexibleConnector App Version Vpc Access Connector Args Enables VPC connectivity for standard apps. Structure is documented below.
- Liveness
Check FlexibleApp Version Liveness Check Health checking configuration for VM instances. Unhealthy instances are killed and replaced with new instances. Structure is documented below.
- Readiness
Check FlexibleApp Version Readiness Check Configures readiness health checking for instances. Unhealthy instances are not put into the backend traffic rotation. Structure is documented below.
- Runtime string
Desired runtime. Example python27.
- Service string
AppEngine service resource
- Api
Config FlexibleApp Version Api Config Serving configuration for Google Cloud Endpoints. Structure is documented below.
- Automatic
Scaling FlexibleApp Version Automatic Scaling Automatic scaling is based on request rate, response latencies, and other application metrics. Structure is documented below.
- Beta
Settings map[string]string Metadata settings that are supplied to this version to enable beta runtime features.
- Default
Expiration string Duration that static files should be cached by web proxies and browsers. Only applicable if the corresponding StaticFilesHandler does not specify its own expiration time.
- Delete
Service boolOn Destroy If set to
true, the service will be deleted if it is the last version.- Deployment
Flexible
App Version Deployment Code and application artifacts that make up this version. Structure is documented below.
- Endpoints
Api FlexibleService App Version Endpoints Api Service Code and application artifacts that make up this version. Structure is documented below.
- Entrypoint
Flexible
App Version Entrypoint The entrypoint for the application. Structure is documented below.
- Env
Variables map[string]string Environment variables available to the application. As these are not returned in the API request, the provider will not detect any changes made outside of the config.
- Handlers
[]Flexible
App Version Handler 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. Structure is documented below.
- Inbound
Services []string Before an application can receive email or XMPP messages, the application must be configured to enable the service.
- Instance
Class string Instance class that is used to run this version. Valid values are AutomaticScaling: F1, F2, F4, F4_1G ManualScaling: B1, B2, B4, B8, B4_1G Defaults to F1 for AutomaticScaling and B1 for ManualScaling.
- Manual
Scaling FlexibleApp Version Manual Scaling A service with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time. Structure is documented below.
- Network
Flexible
App Version Network Extra network settings Structure is documented below.
- Nobuild
Files stringRegex Files that match this pattern will not be built into this version. Only applicable for Go runtimes.
- Noop
On boolDestroy If set to
true, the application version will not be deleted.- Project string
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- Resources
Flexible
App Version Resources Machine resources for a version. Structure is documented below.
- Runtime
Api stringVersion 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
- Runtime
Channel string The channel of the runtime to use. Only available for some runtimes.
- Runtime
Main stringExecutable Path The path or name of the app’s main executable.
- Serving
Status string Current serving status of this version. Only the versions with a SERVING status create instances and can be billed.
- Version
Id string Relative name of the version within the service. For example,
v1. Version names can contain only lowercase letters, numbers, or hyphens. Reserved names,“default”, “latest”, and any name with the prefix “ah-”.- Vpc
Access FlexibleConnector App Version Vpc Access Connector Enables VPC connectivity for standard apps. Structure is documented below.
- liveness
Check FlexibleApp Version Liveness Check Health checking configuration for VM instances. Unhealthy instances are killed and replaced with new instances. Structure is documented below.
- readiness
Check FlexibleApp Version Readiness Check Configures readiness health checking for instances. Unhealthy instances are not put into the backend traffic rotation. Structure is documented below.
- runtime string
Desired runtime. Example python27.
- service string
AppEngine service resource
- api
Config FlexibleApp Version Api Config Serving configuration for Google Cloud Endpoints. Structure is documented below.
- automatic
Scaling FlexibleApp Version Automatic Scaling Automatic scaling is based on request rate, response latencies, and other application metrics. Structure is documented below.
- beta
Settings {[key: string]: string} Metadata settings that are supplied to this version to enable beta runtime features.
- default
Expiration string Duration that static files should be cached by web proxies and browsers. Only applicable if the corresponding StaticFilesHandler does not specify its own expiration time.
- delete
Service booleanOn Destroy If set to
true, the service will be deleted if it is the last version.- deployment
Flexible
App Version Deployment Code and application artifacts that make up this version. Structure is documented below.
- endpoints
Api FlexibleService App Version Endpoints Api Service Code and application artifacts that make up this version. Structure is documented below.
- entrypoint
Flexible
App Version Entrypoint The entrypoint for the application. Structure is documented below.
- env
Variables {[key: string]: string} Environment variables available to the application. As these are not returned in the API request, the provider will not detect any changes made outside of the config.
- handlers
Flexible
App Version Handler[] 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. Structure is documented below.
- inbound
Services string[] Before an application can receive email or XMPP messages, the application must be configured to enable the service.
- instance
Class string Instance class that is used to run this version. Valid values are AutomaticScaling: F1, F2, F4, F4_1G ManualScaling: B1, B2, B4, B8, B4_1G Defaults to F1 for AutomaticScaling and B1 for ManualScaling.
- manual
Scaling FlexibleApp Version Manual Scaling A service with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time. Structure is documented below.
- network
Flexible
App Version Network Extra network settings Structure is documented below.
- nobuild
Files stringRegex Files that match this pattern will not be built into this version. Only applicable for Go runtimes.
- noop
On booleanDestroy If set to
true, the application version will not be deleted.- project string
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- resources
Flexible
App Version Resources Machine resources for a version. Structure is documented below.
- runtime
Api stringVersion 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
- runtime
Channel string The channel of the runtime to use. Only available for some runtimes.
- runtime
Main stringExecutable Path The path or name of the app’s main executable.
- serving
Status string Current serving status of this version. Only the versions with a SERVING status create instances and can be billed.
- version
Id string Relative name of the version within the service. For example,
v1. Version names can contain only lowercase letters, numbers, or hyphens. Reserved names,“default”, “latest”, and any name with the prefix “ah-”.- vpc
Access FlexibleConnector App Version Vpc Access Connector Enables VPC connectivity for standard apps. Structure is documented below.
- liveness_
check Dict[FlexibleApp Version Liveness Check] Health checking configuration for VM instances. Unhealthy instances are killed and replaced with new instances. Structure is documented below.
- readiness_
check Dict[FlexibleApp Version Readiness Check] Configures readiness health checking for instances. Unhealthy instances are not put into the backend traffic rotation. Structure is documented below.
- runtime str
Desired runtime. Example python27.
- service str
AppEngine service resource
- api_
config Dict[FlexibleApp Version Api Config] Serving configuration for Google Cloud Endpoints. Structure is documented below.
- automatic_
scaling Dict[FlexibleApp Version Automatic Scaling] Automatic scaling is based on request rate, response latencies, and other application metrics. Structure is documented below.
- beta_
settings Dict[str, str] Metadata settings that are supplied to this version to enable beta runtime features.
- default_
expiration str Duration that static files should be cached by web proxies and browsers. Only applicable if the corresponding StaticFilesHandler does not specify its own expiration time.
- delete_
service_ boolon_ destroy If set to
true, the service will be deleted if it is the last version.- deployment
Dict[Flexible
App Version Deployment] Code and application artifacts that make up this version. Structure is documented below.
- endpoints_
api_ Dict[Flexibleservice App Version Endpoints Api Service] Code and application artifacts that make up this version. Structure is documented below.
- entrypoint
Dict[Flexible
App Version Entrypoint] The entrypoint for the application. Structure is documented below.
- env_
variables Dict[str, str] Environment variables available to the application. As these are not returned in the API request, the provider will not detect any changes made outside of the config.
- handlers
List[Flexible
App Version Handler] 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. Structure is documented below.
- inbound_
services List[str] Before an application can receive email or XMPP messages, the application must be configured to enable the service.
- instance_
class str Instance class that is used to run this version. Valid values are AutomaticScaling: F1, F2, F4, F4_1G ManualScaling: B1, B2, B4, B8, B4_1G Defaults to F1 for AutomaticScaling and B1 for ManualScaling.
- manual_
scaling Dict[FlexibleApp Version Manual Scaling] A service with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time. Structure is documented below.
- network
Dict[Flexible
App Version Network] Extra network settings Structure is documented below.
- nobuild_
files_ strregex Files that match this pattern will not be built into this version. Only applicable for Go runtimes.
- noop_
on_ booldestroy If set to
true, the application version will not be deleted.- project str
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- resources
Dict[Flexible
App Version Resources] Machine resources for a version. Structure is documented below.
- runtime_
api_ strversion 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
- runtime_
channel str The channel of the runtime to use. Only available for some runtimes.
- runtime_
main_ strexecutable_ path The path or name of the app’s main executable.
- serving_
status str Current serving status of this version. Only the versions with a SERVING status create instances and can be billed.
- version_
id str Relative name of the version within the service. For example,
v1. Version names can contain only lowercase letters, numbers, or hyphens. Reserved names,“default”, “latest”, and any name with the prefix “ah-”.- vpc_
access_ Dict[Flexibleconnector App Version Vpc Access Connector] Enables VPC connectivity for standard apps. Structure is documented below.
Outputs
All input properties are implicitly available as output properties. Additionally, the FlexibleAppVersion resource produces the following output properties:
Look up an Existing FlexibleAppVersion Resource
Get an existing FlexibleAppVersion resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: FlexibleAppVersionState, opts?: CustomResourceOptions): FlexibleAppVersionstatic get(resource_name, id, opts=None, api_config=None, automatic_scaling=None, beta_settings=None, default_expiration=None, delete_service_on_destroy=None, deployment=None, endpoints_api_service=None, entrypoint=None, env_variables=None, handlers=None, inbound_services=None, instance_class=None, liveness_check=None, manual_scaling=None, name=None, network=None, nobuild_files_regex=None, noop_on_destroy=None, project=None, readiness_check=None, resources=None, runtime=None, runtime_api_version=None, runtime_channel=None, runtime_main_executable_path=None, service=None, serving_status=None, version_id=None, vpc_access_connector=None, __props__=None);func GetFlexibleAppVersion(ctx *Context, name string, id IDInput, state *FlexibleAppVersionState, opts ...ResourceOption) (*FlexibleAppVersion, error)public static FlexibleAppVersion Get(string name, Input<string> id, FlexibleAppVersionState? state, CustomResourceOptions? opts = null)- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
The following state arguments are supported:
- Api
Config FlexibleApp Version Api Config Args Serving configuration for Google Cloud Endpoints. Structure is documented below.
- Automatic
Scaling FlexibleApp Version Automatic Scaling Args Automatic scaling is based on request rate, response latencies, and other application metrics. Structure is documented below.
- Beta
Settings Dictionary<string, string> Metadata settings that are supplied to this version to enable beta runtime features.
- Default
Expiration string Duration that static files should be cached by web proxies and browsers. Only applicable if the corresponding StaticFilesHandler does not specify its own expiration time.
- Delete
Service boolOn Destroy If set to
true, the service will be deleted if it is the last version.- Deployment
Flexible
App Version Deployment Args Code and application artifacts that make up this version. Structure is documented below.
- Endpoints
Api FlexibleService App Version Endpoints Api Service Args Code and application artifacts that make up this version. Structure is documented below.
- Entrypoint
Flexible
App Version Entrypoint Args The entrypoint for the application. Structure is documented below.
- Env
Variables Dictionary<string, string> Environment variables available to the application. As these are not returned in the API request, the provider will not detect any changes made outside of the config.
- Handlers
List<Flexible
App Version Handler Args> 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. Structure is documented below.
- Inbound
Services List<string> Before an application can receive email or XMPP messages, the application must be configured to enable the service.
- Instance
Class string Instance class that is used to run this version. Valid values are AutomaticScaling: F1, F2, F4, F4_1G ManualScaling: B1, B2, B4, B8, B4_1G Defaults to F1 for AutomaticScaling and B1 for ManualScaling.
- Liveness
Check FlexibleApp Version Liveness Check Args Health checking configuration for VM instances. Unhealthy instances are killed and replaced with new instances. Structure is documented below.
- Manual
Scaling FlexibleApp Version Manual Scaling Args A service with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time. Structure is documented below.
- Name string
Full Serverless VPC Access Connector name e.g. /projects/my-project/locations/us-central1/connectors/c1.
- Network
Flexible
App Version Network Args Extra network settings Structure is documented below.
- Nobuild
Files stringRegex Files that match this pattern will not be built into this version. Only applicable for Go runtimes.
- Noop
On boolDestroy If set to
true, the application version will not be deleted.- Project string
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- Readiness
Check FlexibleApp Version Readiness Check Args Configures readiness health checking for instances. Unhealthy instances are not put into the backend traffic rotation. Structure is documented below.
- Resources
Flexible
App Version Resources Args Machine resources for a version. Structure is documented below.
- Runtime string
Desired runtime. Example python27.
- Runtime
Api stringVersion 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
- Runtime
Channel string The channel of the runtime to use. Only available for some runtimes.
- Runtime
Main stringExecutable Path The path or name of the app’s main executable.
- Service string
AppEngine service resource
- Serving
Status string Current serving status of this version. Only the versions with a SERVING status create instances and can be billed.
- Version
Id string Relative name of the version within the service. For example,
v1. Version names can contain only lowercase letters, numbers, or hyphens. Reserved names,“default”, “latest”, and any name with the prefix “ah-”.- Vpc
Access FlexibleConnector App Version Vpc Access Connector Args Enables VPC connectivity for standard apps. Structure is documented below.
- Api
Config FlexibleApp Version Api Config Serving configuration for Google Cloud Endpoints. Structure is documented below.
- Automatic
Scaling FlexibleApp Version Automatic Scaling Automatic scaling is based on request rate, response latencies, and other application metrics. Structure is documented below.
- Beta
Settings map[string]string Metadata settings that are supplied to this version to enable beta runtime features.
- Default
Expiration string Duration that static files should be cached by web proxies and browsers. Only applicable if the corresponding StaticFilesHandler does not specify its own expiration time.
- Delete
Service boolOn Destroy If set to
true, the service will be deleted if it is the last version.- Deployment
Flexible
App Version Deployment Code and application artifacts that make up this version. Structure is documented below.
- Endpoints
Api FlexibleService App Version Endpoints Api Service Code and application artifacts that make up this version. Structure is documented below.
- Entrypoint
Flexible
App Version Entrypoint The entrypoint for the application. Structure is documented below.
- Env
Variables map[string]string Environment variables available to the application. As these are not returned in the API request, the provider will not detect any changes made outside of the config.
- Handlers
[]Flexible
App Version Handler 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. Structure is documented below.
- Inbound
Services []string Before an application can receive email or XMPP messages, the application must be configured to enable the service.
- Instance
Class string Instance class that is used to run this version. Valid values are AutomaticScaling: F1, F2, F4, F4_1G ManualScaling: B1, B2, B4, B8, B4_1G Defaults to F1 for AutomaticScaling and B1 for ManualScaling.
- Liveness
Check FlexibleApp Version Liveness Check Health checking configuration for VM instances. Unhealthy instances are killed and replaced with new instances. Structure is documented below.
- Manual
Scaling FlexibleApp Version Manual Scaling A service with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time. Structure is documented below.
- Name string
Full Serverless VPC Access Connector name e.g. /projects/my-project/locations/us-central1/connectors/c1.
- Network
Flexible
App Version Network Extra network settings Structure is documented below.
- Nobuild
Files stringRegex Files that match this pattern will not be built into this version. Only applicable for Go runtimes.
- Noop
On boolDestroy If set to
true, the application version will not be deleted.- Project string
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- Readiness
Check FlexibleApp Version Readiness Check Configures readiness health checking for instances. Unhealthy instances are not put into the backend traffic rotation. Structure is documented below.
- Resources
Flexible
App Version Resources Machine resources for a version. Structure is documented below.
- Runtime string
Desired runtime. Example python27.
- Runtime
Api stringVersion 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
- Runtime
Channel string The channel of the runtime to use. Only available for some runtimes.
- Runtime
Main stringExecutable Path The path or name of the app’s main executable.
- Service string
AppEngine service resource
- Serving
Status string Current serving status of this version. Only the versions with a SERVING status create instances and can be billed.
- Version
Id string Relative name of the version within the service. For example,
v1. Version names can contain only lowercase letters, numbers, or hyphens. Reserved names,“default”, “latest”, and any name with the prefix “ah-”.- Vpc
Access FlexibleConnector App Version Vpc Access Connector Enables VPC connectivity for standard apps. Structure is documented below.
- api
Config FlexibleApp Version Api Config Serving configuration for Google Cloud Endpoints. Structure is documented below.
- automatic
Scaling FlexibleApp Version Automatic Scaling Automatic scaling is based on request rate, response latencies, and other application metrics. Structure is documented below.
- beta
Settings {[key: string]: string} Metadata settings that are supplied to this version to enable beta runtime features.
- default
Expiration string Duration that static files should be cached by web proxies and browsers. Only applicable if the corresponding StaticFilesHandler does not specify its own expiration time.
- delete
Service booleanOn Destroy If set to
true, the service will be deleted if it is the last version.- deployment
Flexible
App Version Deployment Code and application artifacts that make up this version. Structure is documented below.
- endpoints
Api FlexibleService App Version Endpoints Api Service Code and application artifacts that make up this version. Structure is documented below.
- entrypoint
Flexible
App Version Entrypoint The entrypoint for the application. Structure is documented below.
- env
Variables {[key: string]: string} Environment variables available to the application. As these are not returned in the API request, the provider will not detect any changes made outside of the config.
- handlers
Flexible
App Version Handler[] 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. Structure is documented below.
- inbound
Services string[] Before an application can receive email or XMPP messages, the application must be configured to enable the service.
- instance
Class string Instance class that is used to run this version. Valid values are AutomaticScaling: F1, F2, F4, F4_1G ManualScaling: B1, B2, B4, B8, B4_1G Defaults to F1 for AutomaticScaling and B1 for ManualScaling.
- liveness
Check FlexibleApp Version Liveness Check Health checking configuration for VM instances. Unhealthy instances are killed and replaced with new instances. Structure is documented below.
- manual
Scaling FlexibleApp Version Manual Scaling A service with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time. Structure is documented below.
- name string
Full Serverless VPC Access Connector name e.g. /projects/my-project/locations/us-central1/connectors/c1.
- network
Flexible
App Version Network Extra network settings Structure is documented below.
- nobuild
Files stringRegex Files that match this pattern will not be built into this version. Only applicable for Go runtimes.
- noop
On booleanDestroy If set to
true, the application version will not be deleted.- project string
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- readiness
Check FlexibleApp Version Readiness Check Configures readiness health checking for instances. Unhealthy instances are not put into the backend traffic rotation. Structure is documented below.
- resources
Flexible
App Version Resources Machine resources for a version. Structure is documented below.
- runtime string
Desired runtime. Example python27.
- runtime
Api stringVersion 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
- runtime
Channel string The channel of the runtime to use. Only available for some runtimes.
- runtime
Main stringExecutable Path The path or name of the app’s main executable.
- service string
AppEngine service resource
- serving
Status string Current serving status of this version. Only the versions with a SERVING status create instances and can be billed.
- version
Id string Relative name of the version within the service. For example,
v1. Version names can contain only lowercase letters, numbers, or hyphens. Reserved names,“default”, “latest”, and any name with the prefix “ah-”.- vpc
Access FlexibleConnector App Version Vpc Access Connector Enables VPC connectivity for standard apps. Structure is documented below.
- api_
config Dict[FlexibleApp Version Api Config] Serving configuration for Google Cloud Endpoints. Structure is documented below.
- automatic_
scaling Dict[FlexibleApp Version Automatic Scaling] Automatic scaling is based on request rate, response latencies, and other application metrics. Structure is documented below.
- beta_
settings Dict[str, str] Metadata settings that are supplied to this version to enable beta runtime features.
- default_
expiration str Duration that static files should be cached by web proxies and browsers. Only applicable if the corresponding StaticFilesHandler does not specify its own expiration time.
- delete_
service_ boolon_ destroy If set to
true, the service will be deleted if it is the last version.- deployment
Dict[Flexible
App Version Deployment] Code and application artifacts that make up this version. Structure is documented below.
- endpoints_
api_ Dict[Flexibleservice App Version Endpoints Api Service] Code and application artifacts that make up this version. Structure is documented below.
- entrypoint
Dict[Flexible
App Version Entrypoint] The entrypoint for the application. Structure is documented below.
- env_
variables Dict[str, str] Environment variables available to the application. As these are not returned in the API request, the provider will not detect any changes made outside of the config.
- handlers
List[Flexible
App Version Handler] 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. Structure is documented below.
- inbound_
services List[str] Before an application can receive email or XMPP messages, the application must be configured to enable the service.
- instance_
class str Instance class that is used to run this version. Valid values are AutomaticScaling: F1, F2, F4, F4_1G ManualScaling: B1, B2, B4, B8, B4_1G Defaults to F1 for AutomaticScaling and B1 for ManualScaling.
- liveness_
check Dict[FlexibleApp Version Liveness Check] Health checking configuration for VM instances. Unhealthy instances are killed and replaced with new instances. Structure is documented below.
- manual_
scaling Dict[FlexibleApp Version Manual Scaling] A service with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time. Structure is documented below.
- name str
Full Serverless VPC Access Connector name e.g. /projects/my-project/locations/us-central1/connectors/c1.
- network
Dict[Flexible
App Version Network] Extra network settings Structure is documented below.
- nobuild_
files_ strregex Files that match this pattern will not be built into this version. Only applicable for Go runtimes.
- noop_
on_ booldestroy If set to
true, the application version will not be deleted.- project str
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- readiness_
check Dict[FlexibleApp Version Readiness Check] Configures readiness health checking for instances. Unhealthy instances are not put into the backend traffic rotation. Structure is documented below.
- resources
Dict[Flexible
App Version Resources] Machine resources for a version. Structure is documented below.
- runtime str
Desired runtime. Example python27.
- runtime_
api_ strversion 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
- runtime_
channel str The channel of the runtime to use. Only available for some runtimes.
- runtime_
main_ strexecutable_ path The path or name of the app’s main executable.
- service str
AppEngine service resource
- serving_
status str Current serving status of this version. Only the versions with a SERVING status create instances and can be billed.
- version_
id str Relative name of the version within the service. For example,
v1. Version names can contain only lowercase letters, numbers, or hyphens. Reserved names,“default”, “latest”, and any name with the prefix “ah-”.- vpc_
access_ Dict[Flexibleconnector App Version Vpc Access Connector] Enables VPC connectivity for standard apps. Structure is documented below.
Supporting Types
FlexibleAppVersionApiConfig
- Script string
Path to the script from the application root directory.
- Auth
Fail stringAction Action to take when users access resources that require authentication.
- Login string
Level of login required to access this resource.
- Security
Level string Security (HTTPS) enforcement for this URL.
- Url string
URL to serve the endpoint at.
- Script string
Path to the script from the application root directory.
- Auth
Fail stringAction Action to take when users access resources that require authentication.
- Login string
Level of login required to access this resource.
- Security
Level string Security (HTTPS) enforcement for this URL.
- Url string
URL to serve the endpoint at.
- script string
Path to the script from the application root directory.
- auth
Fail stringAction Action to take when users access resources that require authentication.
- login string
Level of login required to access this resource.
- security
Level string Security (HTTPS) enforcement for this URL.
- url string
URL to serve the endpoint at.
- script str
Path to the script from the application root directory.
- auth
Fail strAction Action to take when users access resources that require authentication.
- login str
Level of login required to access this resource.
- security
Level str Security (HTTPS) enforcement for this URL.
- url str
URL to serve the endpoint at.
FlexibleAppVersionAutomaticScaling
- Cpu
Utilization FlexibleApp Version Automatic Scaling Cpu Utilization Args Target scaling by CPU usage. Structure is documented below.
- Cool
Down stringPeriod 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
- Disk
Utilization FlexibleApp Version Automatic Scaling Disk Utilization Args Target scaling by disk usage. Structure is documented below.
- Max
Concurrent intRequests 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 intInstances Maximum number of idle instances that should be maintained for this version.
- Max
Pending stringLatency Maximum amount of time that a request should wait in the pending queue before starting a new instance to handle it.
- Max
Total intInstances Maximum number of instances that should be started to handle requests for this version. Default: 20
- Min
Idle intInstances Minimum number of idle instances that should be maintained for this version. Only applicable for the default version of a service.
- Min
Pending stringLatency Minimum amount of time a request should wait in the pending queue before starting a new instance to handle it.
- Min
Total intInstances Minimum number of running instances that should be maintained for this version. Default: 2
- Network
Utilization FlexibleApp Version Automatic Scaling Network Utilization Args Target scaling by network usage. Structure is documented below.
- Request
Utilization FlexibleApp Version Automatic Scaling Request Utilization Args Target scaling by request utilization. Structure is documented below.
- Cpu
Utilization FlexibleApp Version Automatic Scaling Cpu Utilization Target scaling by CPU usage. Structure is documented below.
- Cool
Down stringPeriod 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
- Disk
Utilization FlexibleApp Version Automatic Scaling Disk Utilization Target scaling by disk usage. Structure is documented below.
- Max
Concurrent intRequests 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 intInstances Maximum number of idle instances that should be maintained for this version.
- Max
Pending stringLatency Maximum amount of time that a request should wait in the pending queue before starting a new instance to handle it.
- Max
Total intInstances Maximum number of instances that should be started to handle requests for this version. Default: 20
- Min
Idle intInstances Minimum number of idle instances that should be maintained for this version. Only applicable for the default version of a service.
- Min
Pending stringLatency Minimum amount of time a request should wait in the pending queue before starting a new instance to handle it.
- Min
Total intInstances Minimum number of running instances that should be maintained for this version. Default: 2
- Network
Utilization FlexibleApp Version Automatic Scaling Network Utilization Target scaling by network usage. Structure is documented below.
- Request
Utilization FlexibleApp Version Automatic Scaling Request Utilization Target scaling by request utilization. Structure is documented below.
- cpu
Utilization FlexibleApp Version Automatic Scaling Cpu Utilization Target scaling by CPU usage. Structure is documented below.
- cool
Down stringPeriod 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
- disk
Utilization FlexibleApp Version Automatic Scaling Disk Utilization Target scaling by disk usage. Structure is documented below.
- max
Concurrent numberRequests 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 numberInstances Maximum number of idle instances that should be maintained for this version.
- max
Pending stringLatency Maximum amount of time that a request should wait in the pending queue before starting a new instance to handle it.
- max
Total numberInstances Maximum number of instances that should be started to handle requests for this version. Default: 20
- min
Idle numberInstances Minimum number of idle instances that should be maintained for this version. Only applicable for the default version of a service.
- min
Pending stringLatency Minimum amount of time a request should wait in the pending queue before starting a new instance to handle it.
- min
Total numberInstances Minimum number of running instances that should be maintained for this version. Default: 2
- network
Utilization FlexibleApp Version Automatic Scaling Network Utilization Target scaling by network usage. Structure is documented below.
- request
Utilization FlexibleApp Version Automatic Scaling Request Utilization Target scaling by request utilization. Structure is documented below.
- cpu
Utilization Dict[FlexibleApp Version Automatic Scaling Cpu Utilization] Target scaling by CPU usage. Structure is documented below.
- cool
Down strPeriod 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
- disk
Utilization Dict[FlexibleApp Version Automatic Scaling Disk Utilization] Target scaling by disk usage. Structure is documented below.
- max
Concurrent floatRequests 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 floatInstances Maximum number of idle instances that should be maintained for this version.
- max
Pending strLatency Maximum amount of time that a request should wait in the pending queue before starting a new instance to handle it.
- max
Total floatInstances Maximum number of instances that should be started to handle requests for this version. Default: 20
- min
Idle floatInstances Minimum number of idle instances that should be maintained for this version. Only applicable for the default version of a service.
- min
Pending strLatency Minimum amount of time a request should wait in the pending queue before starting a new instance to handle it.
- min
Total floatInstances Minimum number of running instances that should be maintained for this version. Default: 2
- network
Utilization Dict[FlexibleApp Version Automatic Scaling Network Utilization] Target scaling by network usage. Structure is documented below.
- request
Utilization Dict[FlexibleApp Version Automatic Scaling Request Utilization] Target scaling by request utilization. Structure is documented below.
FlexibleAppVersionAutomaticScalingCpuUtilization
- Target
Utilization double Target CPU utilization ratio to maintain when scaling. Must be between 0 and 1.
- Aggregation
Window stringLength Period of time over which CPU utilization is calculated.
- Target
Utilization float64 Target CPU utilization ratio to maintain when scaling. Must be between 0 and 1.
- Aggregation
Window stringLength Period of time over which CPU utilization is calculated.
- target
Utilization number Target CPU utilization ratio to maintain when scaling. Must be between 0 and 1.
- aggregation
Window stringLength Period of time over which CPU utilization is calculated.
- target
Utilization float Target CPU utilization ratio to maintain when scaling. Must be between 0 and 1.
- aggregation
Window strLength Period of time over which CPU utilization is calculated.
FlexibleAppVersionAutomaticScalingDiskUtilization
- Target
Read intBytes Per Second Target bytes read per second.
- Target
Read intOps Per Second Target ops read per seconds.
- Target
Write intBytes Per Second Target bytes written per second.
- Target
Write intOps Per Second Target ops written per second.
- Target
Read intBytes Per Second Target bytes read per second.
- Target
Read intOps Per Second Target ops read per seconds.
- Target
Write intBytes Per Second Target bytes written per second.
- Target
Write intOps Per Second Target ops written per second.
- target
Read numberBytes Per Second Target bytes read per second.
- target
Read numberOps Per Second Target ops read per seconds.
- target
Write numberBytes Per Second Target bytes written per second.
- target
Write numberOps Per Second Target ops written per second.
- target
Read floatBytes Per Second Target bytes read per second.
- target
Read floatOps Per Second Target ops read per seconds.
- target
Write floatBytes Per Second Target bytes written per second.
- target
Write floatOps Per Second Target ops written per second.
FlexibleAppVersionAutomaticScalingNetworkUtilization
- Target
Received intBytes Per Second Target bytes received per second.
- Target
Received intPackets Per Second Target packets received per second.
- Target
Sent intBytes Per Second Target bytes sent per second.
- Target
Sent intPackets Per Second Target packets sent per second.
- Target
Received intBytes Per Second Target bytes received per second.
- Target
Received intPackets Per Second Target packets received per second.
- Target
Sent intBytes Per Second Target bytes sent per second.
- Target
Sent intPackets Per Second Target packets sent per second.
- target
Received numberBytes Per Second Target bytes received per second.
- target
Received numberPackets Per Second Target packets received per second.
- target
Sent numberBytes Per Second Target bytes sent per second.
- target
Sent numberPackets Per Second Target packets sent per second.
- target
Received floatBytes Per Second Target bytes received per second.
- target
Received floatPackets Per Second Target packets received per second.
- target
Sent floatBytes Per Second Target bytes sent per second.
- target
Sent floatPackets Per Second Target packets sent per second.
FlexibleAppVersionAutomaticScalingRequestUtilization
- Target
Concurrent doubleRequests Target number of concurrent requests.
- Target
Request stringCount Per Second Target requests per second.
- Target
Concurrent float64Requests Target number of concurrent requests.
- Target
Request stringCount Per Second Target requests per second.
- target
Concurrent numberRequests Target number of concurrent requests.
- target
Request stringCount Per Second Target requests per second.
- target
Concurrent floatRequests Target number of concurrent requests.
- target
Request strCount Per Second Target requests per second.
FlexibleAppVersionDeployment
- Cloud
Build FlexibleOptions App Version Deployment Cloud Build Options Args 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.
- Container
Flexible
App Version Deployment Container Args The Docker image for the container that runs the version. Structure is documented below.
- Files
List<Flexible
App Version Deployment File Args> 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.
- Zip
Flexible
App Version Deployment Zip Args Zip File Structure is documented below.
- Cloud
Build FlexibleOptions App Version Deployment Cloud Build Options 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.
- Container
Flexible
App Version Deployment Container The Docker image for the container that runs the version. Structure is documented below.
- Files
[]Flexible
App Version Deployment File 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.
- Zip
Flexible
App Version Deployment Zip Zip File Structure is documented below.
- cloud
Build FlexibleOptions App Version Deployment Cloud Build Options 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.
- container
Flexible
App Version Deployment Container The Docker image for the container that runs the version. Structure is documented below.
- files
Flexible
App Version Deployment File[] 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.
- zip
Flexible
App Version Deployment Zip Zip File Structure is documented below.
- cloud
Build Dict[FlexibleOptions App Version Deployment Cloud Build Options] 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.
- container
Dict[Flexible
App Version Deployment Container] The Docker image for the container that runs the version. Structure is documented below.
- files
List[Flexible
App Version Deployment File] 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.
- zip
Dict[Flexible
App Version Deployment Zip] Zip File Structure is documented below.
FlexibleAppVersionDeploymentCloudBuildOptions
- App
Yaml stringPath Path to the yaml file used in deployment, used to determine runtime configuration details.
- Cloud
Build stringTimeout 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”.
- App
Yaml stringPath Path to the yaml file used in deployment, used to determine runtime configuration details.
- Cloud
Build stringTimeout 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”.
- app
Yaml stringPath Path to the yaml file used in deployment, used to determine runtime configuration details.
- cloud
Build stringTimeout 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”.
- app
Yaml strPath Path to the yaml file used in deployment, used to determine runtime configuration details.
- cloud
Build strTimeout 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”.
FlexibleAppVersionDeploymentContainer
FlexibleAppVersionDeploymentFile
FlexibleAppVersionDeploymentZip
- Source
Url string Source URL
- Files
Count int files count
- Source
Url string Source URL
- Files
Count int files count
- source
Url string Source URL
- files
Count number files count
- source
Url str Source URL
- files
Count float files count
FlexibleAppVersionEndpointsApiService
- Name string
Full Serverless VPC Access Connector name e.g. /projects/my-project/locations/us-central1/connectors/c1.
- Config
Id 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.
- Disable
Trace boolSampling Enable or disable trace sampling. By default, this is set to false for enabled.
- Rollout
Strategy string Endpoints rollout strategy. If FIXED, configId must be specified. If MANAGED, configId must be omitted.
- Name string
Full Serverless VPC Access Connector name e.g. /projects/my-project/locations/us-central1/connectors/c1.
- Config
Id 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.
- Disable
Trace boolSampling Enable or disable trace sampling. By default, this is set to false for enabled.
- Rollout
Strategy string Endpoints rollout strategy. If FIXED, configId must be specified. If MANAGED, configId must be omitted.
- name string
Full Serverless VPC Access Connector name e.g. /projects/my-project/locations/us-central1/connectors/c1.
- config
Id 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.
- disable
Trace booleanSampling Enable or disable trace sampling. By default, this is set to false for enabled.
- rollout
Strategy string Endpoints rollout strategy. If FIXED, configId must be specified. If MANAGED, configId must be omitted.
- name str
Full Serverless VPC Access Connector name e.g. /projects/my-project/locations/us-central1/connectors/c1.
- config_
id str 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.
- disable
Trace boolSampling Enable or disable trace sampling. By default, this is set to false for enabled.
- rollout
Strategy str Endpoints rollout strategy. If FIXED, configId must be specified. If MANAGED, configId must be omitted.
FlexibleAppVersionEntrypoint
FlexibleAppVersionHandler
- Auth
Fail stringAction Action to take when users access resources that require authentication.
- Login string
Level of login required to access this resource.
- Redirect
Http stringResponse Code 30x code to use when performing redirects for the secure field.
- Script
Flexible
App Version Handler Script Args Path to the script from the application root directory.
- Security
Level string Security (HTTPS) enforcement for this URL.
- Static
Files FlexibleApp Version Handler Static Files Args 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.
- Url
Regex 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.
- Auth
Fail stringAction Action to take when users access resources that require authentication.
- Login string
Level of login required to access this resource.
- Redirect
Http stringResponse Code 30x code to use when performing redirects for the secure field.
- Script
Flexible
App Version Handler Script Path to the script from the application root directory.
- Security
Level string Security (HTTPS) enforcement for this URL.
- Static
Files FlexibleApp Version Handler Static Files 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.
- Url
Regex 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.
- auth
Fail stringAction Action to take when users access resources that require authentication.
- login string
Level of login required to access this resource.
- redirect
Http stringResponse Code 30x code to use when performing redirects for the secure field.
- script
Flexible
App Version Handler Script Path to the script from the application root directory.
- security
Level string Security (HTTPS) enforcement for this URL.
- static
Files FlexibleApp Version Handler Static Files 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.
- url
Regex 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.
- auth
Fail strAction Action to take when users access resources that require authentication.
- login str
Level of login required to access this resource.
- redirect
Http strResponse Code 30x code to use when performing redirects for the secure field.
- script
Dict[Flexible
App Version Handler Script] Path to the script from the application root directory.
- security
Level str Security (HTTPS) enforcement for this URL.
- static
Files Dict[FlexibleApp Version Handler Static Files] 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.
- url
Regex str 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.
FlexibleAppVersionHandlerScript
- Script
Path string Path to the script from the application root directory.
- Script
Path string Path to the script from the application root directory.
- script
Path string Path to the script from the application root directory.
- script
Path str Path to the script from the application root directory.
FlexibleAppVersionHandlerStaticFiles
- Application
Readable bool 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 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”. Default is ‘0s’
- Http
Headers Dictionary<string, string> HTTP headers to use for all responses from these URLs. An object containing a list of “key:value” value pairs.“.
- Mime
Type 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.
- Path 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.
- Require
Matching boolFile Whether this handler should match the request if the file referenced by the handler does not exist.
- Upload
Path stringRegex Regular expression that matches the file paths for all files that should be referenced by this handler.
- Application
Readable bool 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 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”. Default is ‘0s’
- Http
Headers map[string]string HTTP headers to use for all responses from these URLs. An object containing a list of “key:value” value pairs.“.
- Mime
Type 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.
- Path 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.
- Require
Matching boolFile Whether this handler should match the request if the file referenced by the handler does not exist.
- Upload
Path stringRegex Regular expression that matches the file paths for all files that should be referenced by this handler.
- application
Readable boolean 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 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”. Default is ‘0s’
- http
Headers {[key: string]: string} HTTP headers to use for all responses from these URLs. An object containing a list of “key:value” value pairs.“.
- mime
Type 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.
- path 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.
- require
Matching booleanFile Whether this handler should match the request if the file referenced by the handler does not exist.
- upload
Path stringRegex Regular expression that matches the file paths for all files that should be referenced by this handler.
- application
Readable bool 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 str
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”. Default is ‘0s’
- http
Headers Dict[str, str] HTTP headers to use for all responses from these URLs. An object containing a list of “key:value” value pairs.“.
- mime
Type str 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 str
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 boolFile Whether this handler should match the request if the file referenced by the handler does not exist.
- upload
Path strRegex Regular expression that matches the file paths for all files that should be referenced by this handler.
FlexibleAppVersionLivenessCheck
- Path 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.
- Check
Interval string Interval between health checks.
- Failure
Threshold double Number of consecutive failed checks required before considering the VM unhealthy. Default: 4.
- Host string
Host header to send when performing a HTTP Readiness check. Example: “myapp.appspot.com”
- Initial
Delay string The initial delay before starting to execute the checks. Default: “300s”
- Success
Threshold double Number of consecutive successful checks required before considering the VM healthy. Default: 2.
- Timeout string
Time before the check is considered failed. Default: “4s”
- Path 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.
- Check
Interval string Interval between health checks.
- Failure
Threshold float64 Number of consecutive failed checks required before considering the VM unhealthy. Default: 4.
- Host string
Host header to send when performing a HTTP Readiness check. Example: “myapp.appspot.com”
- Initial
Delay string The initial delay before starting to execute the checks. Default: “300s”
- Success
Threshold float64 Number of consecutive successful checks required before considering the VM healthy. Default: 2.
- Timeout string
Time before the check is considered failed. Default: “4s”
- path 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.
- check
Interval string Interval between health checks.
- failure
Threshold number Number of consecutive failed checks required before considering the VM unhealthy. Default: 4.
- host string
Host header to send when performing a HTTP Readiness check. Example: “myapp.appspot.com”
- initial
Delay string The initial delay before starting to execute the checks. Default: “300s”
- success
Threshold number Number of consecutive successful checks required before considering the VM healthy. Default: 2.
- timeout string
Time before the check is considered failed. Default: “4s”
- path str
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.
- check
Interval str Interval between health checks.
- failure
Threshold float Number of consecutive failed checks required before considering the VM unhealthy. Default: 4.
- host str
Host header to send when performing a HTTP Readiness check. Example: “myapp.appspot.com”
- initial
Delay str The initial delay before starting to execute the checks. Default: “300s”
- success
Threshold float Number of consecutive successful checks required before considering the VM healthy. Default: 2.
- timeout str
Time before the check is considered failed. Default: “4s”
FlexibleAppVersionManualScaling
- Instances int
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 = ["manual_scaling"[0].instances]to prevent drift detection.
- Instances int
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 = ["manual_scaling"[0].instances]to prevent drift detection.
- 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 = ["manual_scaling"[0].instances]to prevent drift detection.
- instances float
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 = ["manual_scaling"[0].instances]to prevent drift detection.
FlexibleAppVersionNetwork
- Name string
Full Serverless VPC Access Connector name e.g. /projects/my-project/locations/us-central1/connectors/c1.
- Forwarded
Ports List<string> List of ports, or port pairs, to forward from the virtual machine to the application container.
- Instance
Tag string Tag to apply to the instance during creation.
- Session
Affinity bool Enable session affinity.
- Subnetwork 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.
- Name string
Full Serverless VPC Access Connector name e.g. /projects/my-project/locations/us-central1/connectors/c1.
- Forwarded
Ports []string List of ports, or port pairs, to forward from the virtual machine to the application container.
- Instance
Tag string Tag to apply to the instance during creation.
- Session
Affinity bool Enable session affinity.
- Subnetwork 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.
- name string
Full Serverless VPC Access Connector name e.g. /projects/my-project/locations/us-central1/connectors/c1.
- forwarded
Ports string[] List of ports, or port pairs, to forward from the virtual machine to the application container.
- instance
Tag string Tag to apply to the instance during creation.
- session
Affinity boolean Enable session affinity.
- subnetwork 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.
- name str
Full Serverless VPC Access Connector name e.g. /projects/my-project/locations/us-central1/connectors/c1.
- forwarded
Ports List[str] List of ports, or port pairs, to forward from the virtual machine to the application container.
- instance
Tag str Tag to apply to the instance during creation.
- session_
affinity bool Enable session affinity.
- subnetwork str
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.
FlexibleAppVersionReadinessCheck
- Path 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.
- App
Start stringTimeout 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”
- Check
Interval string Interval between health checks.
- Failure
Threshold double Number of consecutive failed checks required before considering the VM unhealthy. Default: 4.
- Host string
Host header to send when performing a HTTP Readiness check. Example: “myapp.appspot.com”
- Success
Threshold double Number of consecutive successful checks required before considering the VM healthy. Default: 2.
- Timeout string
Time before the check is considered failed. Default: “4s”
- Path 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.
- App
Start stringTimeout 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”
- Check
Interval string Interval between health checks.
- Failure
Threshold float64 Number of consecutive failed checks required before considering the VM unhealthy. Default: 4.
- Host string
Host header to send when performing a HTTP Readiness check. Example: “myapp.appspot.com”
- Success
Threshold float64 Number of consecutive successful checks required before considering the VM healthy. Default: 2.
- Timeout string
Time before the check is considered failed. Default: “4s”
- path 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.
- app
Start stringTimeout 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”
- check
Interval string Interval between health checks.
- failure
Threshold number Number of consecutive failed checks required before considering the VM unhealthy. Default: 4.
- host string
Host header to send when performing a HTTP Readiness check. Example: “myapp.appspot.com”
- success
Threshold number Number of consecutive successful checks required before considering the VM healthy. Default: 2.
- timeout string
Time before the check is considered failed. Default: “4s”
- path str
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.
- app
Start strTimeout 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”
- check
Interval str Interval between health checks.
- failure
Threshold float Number of consecutive failed checks required before considering the VM unhealthy. Default: 4.
- host str
Host header to send when performing a HTTP Readiness check. Example: “myapp.appspot.com”
- success
Threshold float Number of consecutive successful checks required before considering the VM healthy. Default: 2.
- timeout str
Time before the check is considered failed. Default: “4s”
FlexibleAppVersionResources
FlexibleAppVersionResourcesVolume
FlexibleAppVersionVpcAccessConnector
Package Details
- Repository
- https://github.com/pulumi/pulumi-gcp
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
google-betaTerraform Provider.