appengine¶
This provider is a derived work of the Terraform Provider distributed under MPL 2.0. If you encounter a bug or missing feature, first check the pulumi/pulumi-gcp repo; however, if that doesn’t turn up anything, please consult the source terraform-providers/terraform-provider-google repo.
-
class
pulumi_gcp.appengine.
Application
(resource_name, opts=None, auth_domain=None, feature_settings=None, location_id=None, project=None, serving_status=None, __props__=None, __name__=None, __opts__=None)¶ Allows creation and management of an App Engine application.
- App Engine applications cannot be deleted once they’re created; you have to delete the
entire project to delete the application. This provider will report the application has been successfully deleted; this is a limitation of this provider, and will go away in the future. This provider is not able to delete App Engine applications.
- Parameters
resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
auth_domain (pulumi.Input[str]) – The domain to authenticate users with when using App Engine’s User API.
feature_settings (pulumi.Input[dict]) – A block of optional settings to configure specific App Engine features:
location_id (pulumi.Input[str]) – The location to serve the app from.
project (pulumi.Input[str]) – The project ID to create the application under. ~>NOTE: GCP only accepts project ID, not project number. If you are using number, you may get a “Permission denied” error.
serving_status (pulumi.Input[str]) – The serving status of the app.
The feature_settings object supports the following:
splitHealthChecks
(pulumi.Input[bool]
) - Set to false to use the legacy health check instead of the readiness and liveness checks.
-
app_id
= None¶ Identifier of the app, usually
{PROJECT_ID}
-
auth_domain
= None¶ The domain to authenticate users with when using App Engine’s User API.
-
code_bucket
= None¶ The GCS bucket code is being stored in for this app.
-
default_bucket
= None¶ The GCS bucket content is being stored in for this app.
-
default_hostname
= None¶ The default hostname for this app.
-
feature_settings
= None¶ A block of optional settings to configure specific App Engine features:
splitHealthChecks
(bool
) - Set to false to use the legacy health check instead of the readiness and liveness checks.
-
gcr_domain
= None¶ The GCR domain used for storing managed Docker images for this app.
-
name
= None¶ Unique name of the app, usually
apps/{PROJECT_ID}
-
project
= None¶ The project ID to create the application under. ~>NOTE: GCP only accepts project ID, not project number. If you are using number, you may get a “Permission denied” error.
-
serving_status
= None¶ The serving status of the app.
-
url_dispatch_rules
= None¶ A list of dispatch rule blocks. Each block has a
domain
,path
, andservice
field.domain
(str
)path
(str
)service
(str
)
-
static
get
(resource_name, id, opts=None, app_id=None, auth_domain=None, code_bucket=None, default_bucket=None, default_hostname=None, feature_settings=None, gcr_domain=None, location_id=None, name=None, project=None, serving_status=None, url_dispatch_rules=None)¶ Get an existing Application resource’s state with the given name, id, and optional extra properties used to qualify the lookup.
- Parameters
resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
app_id (pulumi.Input[str]) – Identifier of the app, usually
{PROJECT_ID}
auth_domain (pulumi.Input[str]) – The domain to authenticate users with when using App Engine’s User API.
code_bucket (pulumi.Input[str]) – The GCS bucket code is being stored in for this app.
default_bucket (pulumi.Input[str]) – The GCS bucket content is being stored in for this app.
default_hostname (pulumi.Input[str]) – The default hostname for this app.
feature_settings (pulumi.Input[dict]) – A block of optional settings to configure specific App Engine features:
gcr_domain (pulumi.Input[str]) – The GCR domain used for storing managed Docker images for this app.
location_id (pulumi.Input[str]) –
The location to serve the app from.
name (pulumi.Input[str]) – Unique name of the app, usually
apps/{PROJECT_ID}
project (pulumi.Input[str]) – The project ID to create the application under. ~>NOTE: GCP only accepts project ID, not project number. If you are using number, you may get a “Permission denied” error.
serving_status (pulumi.Input[str]) – The serving status of the app.
url_dispatch_rules (pulumi.Input[list]) – A list of dispatch rule blocks. Each block has a
domain
,path
, andservice
field.
The feature_settings object supports the following:
splitHealthChecks
(pulumi.Input[bool]
) - Set to false to use the legacy health check instead of the readiness and liveness checks.
The url_dispatch_rules object supports the following:
domain
(pulumi.Input[str]
)path
(pulumi.Input[str]
)service
(pulumi.Input[str]
)
-
translate_output_property
(prop)¶ Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.
- Parameters
prop (str) – A property name.
- Returns
A potentially transformed property name.
- Return type
str
-
translate_input_property
(prop)¶ Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.
- Parameters
prop (str) – A property name.
- Returns
A potentially transformed property name.
- Return type
str
-
class
pulumi_gcp.appengine.
ApplicationUrlDispatchRules
(resource_name, opts=None, dispatch_rules=None, project=None, __props__=None, __name__=None, __opts__=None)¶ Create a ApplicationUrlDispatchRules resource with the given unique name, props, and options.
- Parameters
resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
The dispatch_rules object supports the following:
domain
(pulumi.Input[str]
)path
(pulumi.Input[str]
)service
(pulumi.Input[str]
)
-
static
get
(resource_name, id, opts=None, dispatch_rules=None, project=None)¶ Get an existing ApplicationUrlDispatchRules resource’s state with the given name, id, and optional extra properties used to qualify the lookup.
- Parameters
resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
The dispatch_rules object supports the following:
domain
(pulumi.Input[str]
)path
(pulumi.Input[str]
)service
(pulumi.Input[str]
)
-
translate_output_property
(prop)¶ Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.
- Parameters
prop (str) – A property name.
- Returns
A potentially transformed property name.
- Return type
str
-
translate_input_property
(prop)¶ Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.
- Parameters
prop (str) – A property name.
- Returns
A potentially transformed property name.
- Return type
str
-
class
pulumi_gcp.appengine.
DomainMapping
(resource_name, opts=None, domain_name=None, override_strategy=None, project=None, ssl_settings=None, __props__=None, __name__=None, __opts__=None)¶ Create a DomainMapping resource with the given unique name, props, and options.
- Parameters
resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
project (pulumi.Input[str]) – The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
The ssl_settings object supports the following:
certificateId
(pulumi.Input[str]
)pendingManagedCertificateId
(pulumi.Input[str]
)sslManagementType
(pulumi.Input[str]
)
-
project
= None¶ The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
-
static
get
(resource_name, id, opts=None, domain_name=None, name=None, override_strategy=None, project=None, resource_records=None, ssl_settings=None)¶ Get an existing DomainMapping resource’s state with the given name, id, and optional extra properties used to qualify the lookup.
- Parameters
resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
project (pulumi.Input[str]) – The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
The resource_records object supports the following:
name
(pulumi.Input[str]
)rrdata
(pulumi.Input[str]
)type
(pulumi.Input[str]
)
The ssl_settings object supports the following:
certificateId
(pulumi.Input[str]
)pendingManagedCertificateId
(pulumi.Input[str]
)sslManagementType
(pulumi.Input[str]
)
-
translate_output_property
(prop)¶ Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.
- Parameters
prop (str) – A property name.
- Returns
A potentially transformed property name.
- Return type
str
-
translate_input_property
(prop)¶ Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.
- Parameters
prop (str) – A property name.
- Returns
A potentially transformed property name.
- Return type
str
-
class
pulumi_gcp.appengine.
FirewallRule
(resource_name, opts=None, action=None, description=None, priority=None, project=None, source_range=None, __props__=None, __name__=None, __opts__=None)¶ Create a FirewallRule resource with the given unique name, props, and options.
- Parameters
resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
project (pulumi.Input[str]) – The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
-
project
= None¶ The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
-
static
get
(resource_name, id, opts=None, action=None, description=None, priority=None, project=None, source_range=None)¶ Get an existing FirewallRule resource’s state with the given name, id, and optional extra properties used to qualify the lookup.
- Parameters
resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
project (pulumi.Input[str]) – The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
-
translate_output_property
(prop)¶ Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.
- Parameters
prop (str) – A property name.
- Returns
A potentially transformed property name.
- Return type
str
-
translate_input_property
(prop)¶ Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.
- Parameters
prop (str) – A property name.
- Returns
A potentially transformed property name.
- Return type
str
-
class
pulumi_gcp.appengine.
StandardAppVersion
(resource_name, opts=None, delete_service_on_destroy=None, deployment=None, entrypoint=None, env_variables=None, handlers=None, instance_class=None, libraries=None, noop_on_destroy=None, project=None, runtime=None, runtime_api_version=None, service=None, threadsafe=None, version_id=None, __props__=None, __name__=None, __opts__=None)¶ Create a StandardAppVersion resource with the given unique name, props, and options.
- Parameters
resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
delete_service_on_destroy (pulumi.Input[bool]) – If set to
true
, the service will be deleted if it is the last version.noop_on_destroy (pulumi.Input[bool]) – If set to
true
, the application version will not be deleted.project (pulumi.Input[str]) – The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
The deployment object supports the following:
files
(pulumi.Input[list]
)name
(pulumi.Input[str]
)sha1Sum
(pulumi.Input[str]
)sourceUrl
(pulumi.Input[str]
)
zip
(pulumi.Input[dict]
)filesCount
(pulumi.Input[float]
)sourceUrl
(pulumi.Input[str]
)
The entrypoint object supports the following:
shell
(pulumi.Input[str]
)
The handlers object supports the following:
authFailAction
(pulumi.Input[str]
)login
(pulumi.Input[str]
)redirectHttpResponseCode
(pulumi.Input[str]
)script
(pulumi.Input[dict]
)scriptPath
(pulumi.Input[str]
)
securityLevel
(pulumi.Input[str]
)staticFiles
(pulumi.Input[dict]
)applicationReadable
(pulumi.Input[bool]
)expiration
(pulumi.Input[str]
)httpHeaders
(pulumi.Input[dict]
)mimeType
(pulumi.Input[str]
)path
(pulumi.Input[str]
)requireMatchingFile
(pulumi.Input[bool]
)uploadPathRegex
(pulumi.Input[str]
)
urlRegex
(pulumi.Input[str]
)
The libraries object supports the following:
name
(pulumi.Input[str]
)version
(pulumi.Input[str]
)
-
delete_service_on_destroy
= None¶ If set to
true
, the service will be deleted if it is the last version.
-
noop_on_destroy
= None¶ If set to
true
, the application version will not be deleted.
-
project
= None¶ The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
-
static
get
(resource_name, id, opts=None, delete_service_on_destroy=None, deployment=None, entrypoint=None, env_variables=None, handlers=None, instance_class=None, libraries=None, name=None, noop_on_destroy=None, project=None, runtime=None, runtime_api_version=None, service=None, threadsafe=None, version_id=None)¶ Get an existing StandardAppVersion resource’s state with the given name, id, and optional extra properties used to qualify the lookup.
- Parameters
resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
delete_service_on_destroy (pulumi.Input[bool]) – If set to
true
, the service will be deleted if it is the last version.noop_on_destroy (pulumi.Input[bool]) – If set to
true
, the application version will not be deleted.project (pulumi.Input[str]) – The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
The deployment object supports the following:
files
(pulumi.Input[list]
)name
(pulumi.Input[str]
)sha1Sum
(pulumi.Input[str]
)sourceUrl
(pulumi.Input[str]
)
zip
(pulumi.Input[dict]
)filesCount
(pulumi.Input[float]
)sourceUrl
(pulumi.Input[str]
)
The entrypoint object supports the following:
shell
(pulumi.Input[str]
)
The handlers object supports the following:
authFailAction
(pulumi.Input[str]
)login
(pulumi.Input[str]
)redirectHttpResponseCode
(pulumi.Input[str]
)script
(pulumi.Input[dict]
)scriptPath
(pulumi.Input[str]
)
securityLevel
(pulumi.Input[str]
)staticFiles
(pulumi.Input[dict]
)applicationReadable
(pulumi.Input[bool]
)expiration
(pulumi.Input[str]
)httpHeaders
(pulumi.Input[dict]
)mimeType
(pulumi.Input[str]
)path
(pulumi.Input[str]
)requireMatchingFile
(pulumi.Input[bool]
)uploadPathRegex
(pulumi.Input[str]
)
urlRegex
(pulumi.Input[str]
)
The libraries object supports the following:
name
(pulumi.Input[str]
)version
(pulumi.Input[str]
)
-
translate_output_property
(prop)¶ Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.
- Parameters
prop (str) – A property name.
- Returns
A potentially transformed property name.
- Return type
str
-
translate_input_property
(prop)¶ Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.
- Parameters
prop (str) – A property name.
- Returns
A potentially transformed property name.
- Return type
str