Module 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.

Resources

Others

Resources

Resource Application

class Application extends CustomResource

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.

This content is derived from https://github.com/terraform-providers/terraform-provider-google/blob/master/website/docs/r/app_engine_application.html.markdown.

constructor

new Application(name: string, args: ApplicationArgs, opts?: pulumi.CustomResourceOptions)

Create a Application resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ApplicationState, opts?: pulumi.CustomResourceOptions): Application

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Application

Returns true if the given object is an instance of Application. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property appId

public appId: pulumi.Output<string>;

Identifier of the app, usually {PROJECT_ID}

property authDomain

public authDomain: pulumi.Output<string>;

The domain to authenticate users with when using App Engine’s User API.

property codeBucket

public codeBucket: pulumi.Output<string>;

The GCS bucket code is being stored in for this app.

property defaultBucket

public defaultBucket: pulumi.Output<string>;

The GCS bucket content is being stored in for this app.

property defaultHostname

public defaultHostname: pulumi.Output<string>;

The default hostname for this app.

property featureSettings

public featureSettings: pulumi.Output<ApplicationFeatureSettings>;

A block of optional settings to configure specific App Engine features:

property gcrDomain

public gcrDomain: pulumi.Output<string>;

The GCR domain used for storing managed Docker images for this app.

property iap

public iap: pulumi.Output<ApplicationIap | undefined>;

Settings for enabling Cloud Identity Aware Proxy

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property locationId

public locationId: pulumi.Output<string>;

The location to serve the app from.

property name

public name: pulumi.Output<string>;

Unique name of the app, usually apps/{PROJECT_ID}

property project

public project: pulumi.Output<string>;

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.

property servingStatus

public servingStatus: pulumi.Output<string>;

The serving status of the app.

property urlDispatchRules

public urlDispatchRules: pulumi.Output<ApplicationUrlDispatchRule[]>;

A list of dispatch rule blocks. Each block has a domain, path, and service field.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource ApplicationUrlDispatchRules

class ApplicationUrlDispatchRules extends CustomResource

This content is derived from https://github.com/terraform-providers/terraform-provider-google/blob/master/website/docs/r/app_engine_application_url_dispatch_rules.html.markdown.

constructor

new ApplicationUrlDispatchRules(name: string, args: ApplicationUrlDispatchRulesArgs, opts?: pulumi.CustomResourceOptions)

Create a ApplicationUrlDispatchRules resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ApplicationUrlDispatchRulesState, opts?: pulumi.CustomResourceOptions): ApplicationUrlDispatchRules

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is ApplicationUrlDispatchRules

Returns true if the given object is an instance of ApplicationUrlDispatchRules. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property dispatchRules

public dispatchRules: pulumi.Output<ApplicationUrlDispatchRulesDispatchRule[]>;

Rules to match an HTTP request and dispatch that request to a service.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property project

public project: pulumi.Output<string>;

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource DomainMapping

class DomainMapping extends CustomResource

This content is derived from https://github.com/terraform-providers/terraform-provider-google/blob/master/website/docs/r/app_engine_domain_mapping.html.markdown.

constructor

new DomainMapping(name: string, args: DomainMappingArgs, opts?: pulumi.CustomResourceOptions)

Create a DomainMapping resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: DomainMappingState, opts?: pulumi.CustomResourceOptions): DomainMapping

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is DomainMapping

Returns true if the given object is an instance of DomainMapping. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property domainName

public domainName: pulumi.Output<string>;

Relative name of the domain serving the application. Example: example.com.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property name

public name: pulumi.Output<string>;

Full path to the DomainMapping resource in the API. Example: apps/myapp/domainMapping/example.com.

property overrideStrategy

public overrideStrategy: pulumi.Output<string | undefined>;

Whether the domain creation should override any existing mappings for this domain. By default, overrides are rejected.

property project

public project: pulumi.Output<string>;

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

property resourceRecords

public resourceRecords: pulumi.Output<DomainMappingResourceRecord[]>;

The resource records required to configure this domain mapping. These records must be added to the domain’s DNS configuration in order to serve the application via this domain mapping.

property sslSettings

public sslSettings: pulumi.Output<DomainMappingSslSettings | undefined>;

SSL configuration for this domain. If unconfigured, this domain will not serve with SSL.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource FirewallRule

class FirewallRule extends CustomResource

This content is derived from https://github.com/terraform-providers/terraform-provider-google/blob/master/website/docs/r/app_engine_firewall_rule.html.markdown.

constructor

new FirewallRule(name: string, args: FirewallRuleArgs, opts?: pulumi.CustomResourceOptions)

Create a FirewallRule resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: FirewallRuleState, opts?: pulumi.CustomResourceOptions): FirewallRule

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is FirewallRule

Returns true if the given object is an instance of FirewallRule. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property action

public action: pulumi.Output<string>;

The action to take if this rule matches.

property description

public description: pulumi.Output<string | undefined>;

An optional string description of this rule.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property priority

public priority: pulumi.Output<number | undefined>;

A positive integer that defines the order of rule evaluation. Rules with the lowest priority are evaluated first. A default rule at priority Int32.MaxValue matches all IPv4 and IPv6 traffic when no previous rule matches. Only the action of this rule can be modified by the user.

property project

public project: pulumi.Output<string>;

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

property sourceRange

public sourceRange: pulumi.Output<string>;

IP address or range, defined using CIDR notation, of requests that this rule applies to.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource StandardAppVersion

class StandardAppVersion extends CustomResource

This content is derived from https://github.com/terraform-providers/terraform-provider-google/blob/master/website/docs/r/app_engine_standard_app_version.html.markdown.

constructor

new StandardAppVersion(name: string, args: StandardAppVersionArgs, opts?: pulumi.CustomResourceOptions)

Create a StandardAppVersion resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: StandardAppVersionState, opts?: pulumi.CustomResourceOptions): StandardAppVersion

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is StandardAppVersion

Returns true if the given object is an instance of StandardAppVersion. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property deleteServiceOnDestroy

public deleteServiceOnDestroy: pulumi.Output<boolean | undefined>;

If set to true, the service will be deleted if it is the last version.

property deployment

public deployment: pulumi.Output<StandardAppVersionDeployment | undefined>;

Code and application artifacts that make up this version.

property entrypoint

public entrypoint: pulumi.Output<StandardAppVersionEntrypoint | undefined>;

The entrypoint for the application.

property envVariables

public envVariables: pulumi.Output<{[key: string]: string} | undefined>;

Environment variables available to the application.

property handlers

public handlers: pulumi.Output<StandardAppVersionHandler[] | undefined>;

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.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property instanceClass

public instanceClass: pulumi.Output<string | undefined>;

Instance class that is used to run this version. Valid values are AutomaticScaling F1, F2, F4, F4_1G (Only AutomaticScaling is supported at the moment)

property libraries

public libraries: pulumi.Output<StandardAppVersionLibrary[] | undefined>;

Configuration for third-party Python runtime libraries that are required by the application.

property name

public name: pulumi.Output<string>;

Full path to the Version resource in the API. Example, “v1”.

property noopOnDestroy

public noopOnDestroy: pulumi.Output<boolean | undefined>;

If set to true, the application version will not be deleted.

property project

public project: pulumi.Output<string>;

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

property runtime

public runtime: pulumi.Output<string>;

Desired runtime. Example python27.

property runtimeApiVersion

public runtimeApiVersion: pulumi.Output<string | undefined>;

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

property service

public service: pulumi.Output<string | undefined>;

AppEngine service resource

property threadsafe

public threadsafe: pulumi.Output<boolean | undefined>;

Whether multiple requests can be dispatched to this version at once.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property versionId

public versionId: pulumi.Output<string | undefined>;

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-”.

Others

interface ApplicationArgs

interface ApplicationArgs

The set of arguments for constructing a Application resource.

property authDomain

authDomain?: pulumi.Input<string>;

The domain to authenticate users with when using App Engine’s User API.

property featureSettings

featureSettings?: pulumi.Input<ApplicationFeatureSettings>;

A block of optional settings to configure specific App Engine features:

property iap

iap?: pulumi.Input<ApplicationIap>;

Settings for enabling Cloud Identity Aware Proxy

property locationId

locationId: pulumi.Input<string>;

The location to serve the app from.

property project

project?: pulumi.Input<string>;

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.

property servingStatus

servingStatus?: pulumi.Input<string>;

The serving status of the app.

interface ApplicationState

interface ApplicationState

Input properties used for looking up and filtering Application resources.

property appId

appId?: pulumi.Input<string>;

Identifier of the app, usually {PROJECT_ID}

property authDomain

authDomain?: pulumi.Input<string>;

The domain to authenticate users with when using App Engine’s User API.

property codeBucket

codeBucket?: pulumi.Input<string>;

The GCS bucket code is being stored in for this app.

property defaultBucket

defaultBucket?: pulumi.Input<string>;

The GCS bucket content is being stored in for this app.

property defaultHostname

defaultHostname?: pulumi.Input<string>;

The default hostname for this app.

property featureSettings

featureSettings?: pulumi.Input<ApplicationFeatureSettings>;

A block of optional settings to configure specific App Engine features:

property gcrDomain

gcrDomain?: pulumi.Input<string>;

The GCR domain used for storing managed Docker images for this app.

property iap

iap?: pulumi.Input<ApplicationIap>;

Settings for enabling Cloud Identity Aware Proxy

property locationId

locationId?: pulumi.Input<string>;

The location to serve the app from.

property name

name?: pulumi.Input<string>;

Unique name of the app, usually apps/{PROJECT_ID}

property project

project?: pulumi.Input<string>;

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.

property servingStatus

servingStatus?: pulumi.Input<string>;

The serving status of the app.

property urlDispatchRules

urlDispatchRules?: pulumi.Input<pulumi.Input<ApplicationUrlDispatchRule>[]>;

A list of dispatch rule blocks. Each block has a domain, path, and service field.

interface ApplicationUrlDispatchRulesArgs

interface ApplicationUrlDispatchRulesArgs

The set of arguments for constructing a ApplicationUrlDispatchRules resource.

property dispatchRules

dispatchRules: pulumi.Input<pulumi.Input<ApplicationUrlDispatchRulesDispatchRule>[]>;

Rules to match an HTTP request and dispatch that request to a service.

property project

project?: pulumi.Input<string>;

interface ApplicationUrlDispatchRulesState

interface ApplicationUrlDispatchRulesState

Input properties used for looking up and filtering ApplicationUrlDispatchRules resources.

property dispatchRules

dispatchRules?: pulumi.Input<pulumi.Input<ApplicationUrlDispatchRulesDispatchRule>[]>;

Rules to match an HTTP request and dispatch that request to a service.

property project

project?: pulumi.Input<string>;

interface DomainMappingArgs

interface DomainMappingArgs

The set of arguments for constructing a DomainMapping resource.

property domainName

domainName: pulumi.Input<string>;

Relative name of the domain serving the application. Example: example.com.

property overrideStrategy

overrideStrategy?: pulumi.Input<string>;

Whether the domain creation should override any existing mappings for this domain. By default, overrides are rejected.

property project

project?: pulumi.Input<string>;

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

property sslSettings

sslSettings?: pulumi.Input<DomainMappingSslSettings>;

SSL configuration for this domain. If unconfigured, this domain will not serve with SSL.

interface DomainMappingState

interface DomainMappingState

Input properties used for looking up and filtering DomainMapping resources.

property domainName

domainName?: pulumi.Input<string>;

Relative name of the domain serving the application. Example: example.com.

property name

name?: pulumi.Input<string>;

Full path to the DomainMapping resource in the API. Example: apps/myapp/domainMapping/example.com.

property overrideStrategy

overrideStrategy?: pulumi.Input<string>;

Whether the domain creation should override any existing mappings for this domain. By default, overrides are rejected.

property project

project?: pulumi.Input<string>;

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

property resourceRecords

resourceRecords?: pulumi.Input<pulumi.Input<DomainMappingResourceRecord>[]>;

The resource records required to configure this domain mapping. These records must be added to the domain’s DNS configuration in order to serve the application via this domain mapping.

property sslSettings

sslSettings?: pulumi.Input<DomainMappingSslSettings>;

SSL configuration for this domain. If unconfigured, this domain will not serve with SSL.

interface FirewallRuleArgs

interface FirewallRuleArgs

The set of arguments for constructing a FirewallRule resource.

property action

action: pulumi.Input<string>;

The action to take if this rule matches.

property description

description?: pulumi.Input<string>;

An optional string description of this rule.

property priority

priority?: pulumi.Input<number>;

A positive integer that defines the order of rule evaluation. Rules with the lowest priority are evaluated first. A default rule at priority Int32.MaxValue matches all IPv4 and IPv6 traffic when no previous rule matches. Only the action of this rule can be modified by the user.

property project

project?: pulumi.Input<string>;

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

property sourceRange

sourceRange: pulumi.Input<string>;

IP address or range, defined using CIDR notation, of requests that this rule applies to.

interface FirewallRuleState

interface FirewallRuleState

Input properties used for looking up and filtering FirewallRule resources.

property action

action?: pulumi.Input<string>;

The action to take if this rule matches.

property description

description?: pulumi.Input<string>;

An optional string description of this rule.

property priority

priority?: pulumi.Input<number>;

A positive integer that defines the order of rule evaluation. Rules with the lowest priority are evaluated first. A default rule at priority Int32.MaxValue matches all IPv4 and IPv6 traffic when no previous rule matches. Only the action of this rule can be modified by the user.

property project

project?: pulumi.Input<string>;

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

property sourceRange

sourceRange?: pulumi.Input<string>;

IP address or range, defined using CIDR notation, of requests that this rule applies to.

interface StandardAppVersionArgs

interface StandardAppVersionArgs

The set of arguments for constructing a StandardAppVersion resource.

property deleteServiceOnDestroy

deleteServiceOnDestroy?: pulumi.Input<boolean>;

If set to true, the service will be deleted if it is the last version.

property deployment

deployment?: pulumi.Input<StandardAppVersionDeployment>;

Code and application artifacts that make up this version.

property entrypoint

entrypoint?: pulumi.Input<StandardAppVersionEntrypoint>;

The entrypoint for the application.

property envVariables

envVariables?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;

Environment variables available to the application.

property handlers

handlers?: pulumi.Input<pulumi.Input<StandardAppVersionHandler>[]>;

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.

property instanceClass

instanceClass?: pulumi.Input<string>;

Instance class that is used to run this version. Valid values are AutomaticScaling F1, F2, F4, F4_1G (Only AutomaticScaling is supported at the moment)

property libraries

libraries?: pulumi.Input<pulumi.Input<StandardAppVersionLibrary>[]>;

Configuration for third-party Python runtime libraries that are required by the application.

property noopOnDestroy

noopOnDestroy?: pulumi.Input<boolean>;

If set to true, the application version will not be deleted.

property project

project?: pulumi.Input<string>;

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

property runtime

runtime: pulumi.Input<string>;

Desired runtime. Example python27.

property runtimeApiVersion

runtimeApiVersion?: pulumi.Input<string>;

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

property service

service?: pulumi.Input<string>;

AppEngine service resource

property threadsafe

threadsafe?: pulumi.Input<boolean>;

Whether multiple requests can be dispatched to this version at once.

property versionId

versionId?: pulumi.Input<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-”.

interface StandardAppVersionState

interface StandardAppVersionState

Input properties used for looking up and filtering StandardAppVersion resources.

property deleteServiceOnDestroy

deleteServiceOnDestroy?: pulumi.Input<boolean>;

If set to true, the service will be deleted if it is the last version.

property deployment

deployment?: pulumi.Input<StandardAppVersionDeployment>;

Code and application artifacts that make up this version.

property entrypoint

entrypoint?: pulumi.Input<StandardAppVersionEntrypoint>;

The entrypoint for the application.

property envVariables

envVariables?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;

Environment variables available to the application.

property handlers

handlers?: pulumi.Input<pulumi.Input<StandardAppVersionHandler>[]>;

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.

property instanceClass

instanceClass?: pulumi.Input<string>;

Instance class that is used to run this version. Valid values are AutomaticScaling F1, F2, F4, F4_1G (Only AutomaticScaling is supported at the moment)

property libraries

libraries?: pulumi.Input<pulumi.Input<StandardAppVersionLibrary>[]>;

Configuration for third-party Python runtime libraries that are required by the application.

property name

name?: pulumi.Input<string>;

Full path to the Version resource in the API. Example, “v1”.

property noopOnDestroy

noopOnDestroy?: pulumi.Input<boolean>;

If set to true, the application version will not be deleted.

property project

project?: pulumi.Input<string>;

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

property runtime

runtime?: pulumi.Input<string>;

Desired runtime. Example python27.

property runtimeApiVersion

runtimeApiVersion?: pulumi.Input<string>;

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

property service

service?: pulumi.Input<string>;

AppEngine service resource

property threadsafe

threadsafe?: pulumi.Input<boolean>;

Whether multiple requests can be dispatched to this version at once.

property versionId

versionId?: pulumi.Input<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-”.