Google Cloud Native v0.32.0, Nov 29 23

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi

google-native.appengine/v1.getApp

Explore with Pulumi AI

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi

Using getApp

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

TypeScript
Python
Go
C#
Java
YAML

function getApp(args: GetAppArgs, opts?: InvokeOptions): Promise<GetAppResult>
function getAppOutput(args: GetAppOutputArgs, opts?: InvokeOptions): Output<GetAppResult>

def get_app(app_id: Optional[str] = None,
            include_extra_data: Optional[str] = None,
            opts: Optional[InvokeOptions] = None) -> GetAppResult
def get_app_output(app_id: Optional[pulumi.Input[str]] = None,
            include_extra_data: Optional[pulumi.Input[str]] = None,
            opts: Optional[InvokeOptions] = None) -> Output[GetAppResult]

func LookupApp(ctx *Context, args *LookupAppArgs, opts ...InvokeOption) (*LookupAppResult, error)
func LookupAppOutput(ctx *Context, args *LookupAppOutputArgs, opts ...InvokeOption) LookupAppResultOutput

> Note: This function is named LookupApp in the Go SDK.

public static class GetApp 
{
    public static Task<GetAppResult> InvokeAsync(GetAppArgs args, InvokeOptions? opts = null)
    public static Output<GetAppResult> Invoke(GetAppInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetAppResult> getApp(GetAppArgs args, InvokeOptions options)
public static Output<GetAppResult> getApp(GetAppArgs args, InvokeOptions options)

fn::invoke:
  function: google-native:appengine/v1:getApp
  arguments:
    # arguments dictionary

The following arguments are supported:

AppId string
IncludeExtraData string

AppId string
IncludeExtraData string

appId String
includeExtraData String

appId string
includeExtraData string

app_id str
include_extra_data str

appId String
includeExtraData String

getApp Result

The following output properties are available:

AuthDomain string: Google Apps authentication domain that controls which users can access this application.Defaults to open access for any Google Account.
CodeBucket string: Google Cloud Storage bucket that can be used for storing files associated with this application. This bucket is associated with the application and can be used by the gcloud deployment commands.
DatabaseType string: The type of the Cloud Firestore or Cloud Datastore database associated with this application.
DefaultBucket string: Google Cloud Storage bucket that can be used by this application to store content.
DefaultCookieExpiration string: Cookie expiration policy for this application.
DefaultHostname string: Hostname used to reach this application, as resolved by App Engine.
DispatchRules List<Pulumi.GoogleNative.AppEngine.V1.Outputs.UrlDispatchRuleResponse>: HTTP path dispatch rules for requests to the application that do not explicitly target a service or version. Rules are order-dependent. Up to 20 dispatch rules can be supported.
FeatureSettings Pulumi.GoogleNative.AppEngine.V1.Outputs.FeatureSettingsResponse: The feature specific settings to be used in the application.
GcrDomain string: The Google Container Registry domain used for storing managed build docker images for this application.
GeneratedCustomerMetadata Dictionary<string, string>: Additional Google Generated Customer Metadata, this field won't be provided by default and can be requested by setting the IncludeExtraData field in GetApplicationRequest
Iap Pulumi.GoogleNative.AppEngine.V1.Outputs.IdentityAwareProxyResponse
Location string: Location from which this application runs. Application instances run out of the data centers in the specified location, which is also where all of the application's end user content is stored.Defaults to us-central.View the list of supported locations (https://cloud.google.com/appengine/docs/locations).
Name string: Full path to the Application resource in the API. Example: apps/myapp.
ServiceAccount string: The service account associated with the application. This is the app-level default identity. If no identity provided during create version, Admin API will fallback to this one.
ServingStatus string: Serving status of this application.

AuthDomain string: Google Apps authentication domain that controls which users can access this application.Defaults to open access for any Google Account.
CodeBucket string: Google Cloud Storage bucket that can be used for storing files associated with this application. This bucket is associated with the application and can be used by the gcloud deployment commands.
DatabaseType string: The type of the Cloud Firestore or Cloud Datastore database associated with this application.
DefaultBucket string: Google Cloud Storage bucket that can be used by this application to store content.
DefaultCookieExpiration string: Cookie expiration policy for this application.
DefaultHostname string: Hostname used to reach this application, as resolved by App Engine.
DispatchRules []UrlDispatchRuleResponse: HTTP path dispatch rules for requests to the application that do not explicitly target a service or version. Rules are order-dependent. Up to 20 dispatch rules can be supported.
FeatureSettings FeatureSettingsResponse: The feature specific settings to be used in the application.
GcrDomain string: The Google Container Registry domain used for storing managed build docker images for this application.
GeneratedCustomerMetadata map[string]string: Additional Google Generated Customer Metadata, this field won't be provided by default and can be requested by setting the IncludeExtraData field in GetApplicationRequest
Iap IdentityAwareProxyResponse
Location string: Location from which this application runs. Application instances run out of the data centers in the specified location, which is also where all of the application's end user content is stored.Defaults to us-central.View the list of supported locations (https://cloud.google.com/appengine/docs/locations).
Name string: Full path to the Application resource in the API. Example: apps/myapp.
ServiceAccount string: The service account associated with the application. This is the app-level default identity. If no identity provided during create version, Admin API will fallback to this one.
ServingStatus string: Serving status of this application.

authDomain String: Google Apps authentication domain that controls which users can access this application.Defaults to open access for any Google Account.
codeBucket String: Google Cloud Storage bucket that can be used for storing files associated with this application. This bucket is associated with the application and can be used by the gcloud deployment commands.
databaseType String: The type of the Cloud Firestore or Cloud Datastore database associated with this application.
defaultBucket String: Google Cloud Storage bucket that can be used by this application to store content.
defaultCookieExpiration String: Cookie expiration policy for this application.
defaultHostname String: Hostname used to reach this application, as resolved by App Engine.
dispatchRules List<UrlDispatchRuleResponse>: HTTP path dispatch rules for requests to the application that do not explicitly target a service or version. Rules are order-dependent. Up to 20 dispatch rules can be supported.
featureSettings FeatureSettingsResponse: The feature specific settings to be used in the application.
gcrDomain String: The Google Container Registry domain used for storing managed build docker images for this application.
generatedCustomerMetadata Map<String,String>: Additional Google Generated Customer Metadata, this field won't be provided by default and can be requested by setting the IncludeExtraData field in GetApplicationRequest
iap IdentityAwareProxyResponse
location String: Location from which this application runs. Application instances run out of the data centers in the specified location, which is also where all of the application's end user content is stored.Defaults to us-central.View the list of supported locations (https://cloud.google.com/appengine/docs/locations).
name String: Full path to the Application resource in the API. Example: apps/myapp.
serviceAccount String: The service account associated with the application. This is the app-level default identity. If no identity provided during create version, Admin API will fallback to this one.
servingStatus String: Serving status of this application.

authDomain string: Google Apps authentication domain that controls which users can access this application.Defaults to open access for any Google Account.
codeBucket string: Google Cloud Storage bucket that can be used for storing files associated with this application. This bucket is associated with the application and can be used by the gcloud deployment commands.
databaseType string: The type of the Cloud Firestore or Cloud Datastore database associated with this application.
defaultBucket string: Google Cloud Storage bucket that can be used by this application to store content.
defaultCookieExpiration string: Cookie expiration policy for this application.
defaultHostname string: Hostname used to reach this application, as resolved by App Engine.
dispatchRules UrlDispatchRuleResponse[]: HTTP path dispatch rules for requests to the application that do not explicitly target a service or version. Rules are order-dependent. Up to 20 dispatch rules can be supported.
featureSettings FeatureSettingsResponse: The feature specific settings to be used in the application.
gcrDomain string: The Google Container Registry domain used for storing managed build docker images for this application.
generatedCustomerMetadata {[key: string]: string}: Additional Google Generated Customer Metadata, this field won't be provided by default and can be requested by setting the IncludeExtraData field in GetApplicationRequest
iap IdentityAwareProxyResponse
location string: Location from which this application runs. Application instances run out of the data centers in the specified location, which is also where all of the application's end user content is stored.Defaults to us-central.View the list of supported locations (https://cloud.google.com/appengine/docs/locations).
name string: Full path to the Application resource in the API. Example: apps/myapp.
serviceAccount string: The service account associated with the application. This is the app-level default identity. If no identity provided during create version, Admin API will fallback to this one.
servingStatus string: Serving status of this application.

auth_domain str: Google Apps authentication domain that controls which users can access this application.Defaults to open access for any Google Account.
code_bucket str: Google Cloud Storage bucket that can be used for storing files associated with this application. This bucket is associated with the application and can be used by the gcloud deployment commands.
database_type str: The type of the Cloud Firestore or Cloud Datastore database associated with this application.
default_bucket str: Google Cloud Storage bucket that can be used by this application to store content.
default_cookie_expiration str: Cookie expiration policy for this application.
default_hostname str: Hostname used to reach this application, as resolved by App Engine.
dispatch_rules Sequence[UrlDispatchRuleResponse]: HTTP path dispatch rules for requests to the application that do not explicitly target a service or version. Rules are order-dependent. Up to 20 dispatch rules can be supported.
feature_settings FeatureSettingsResponse: The feature specific settings to be used in the application.
gcr_domain str: The Google Container Registry domain used for storing managed build docker images for this application.
generated_customer_metadata Mapping[str, str]: Additional Google Generated Customer Metadata, this field won't be provided by default and can be requested by setting the IncludeExtraData field in GetApplicationRequest
iap IdentityAwareProxyResponse
location str: Location from which this application runs. Application instances run out of the data centers in the specified location, which is also where all of the application's end user content is stored.Defaults to us-central.View the list of supported locations (https://cloud.google.com/appengine/docs/locations).
name str: Full path to the Application resource in the API. Example: apps/myapp.
service_account str: The service account associated with the application. This is the app-level default identity. If no identity provided during create version, Admin API will fallback to this one.
serving_status str: Serving status of this application.

authDomain String: Google Apps authentication domain that controls which users can access this application.Defaults to open access for any Google Account.
codeBucket String: Google Cloud Storage bucket that can be used for storing files associated with this application. This bucket is associated with the application and can be used by the gcloud deployment commands.
databaseType String: The type of the Cloud Firestore or Cloud Datastore database associated with this application.
defaultBucket String: Google Cloud Storage bucket that can be used by this application to store content.
defaultCookieExpiration String: Cookie expiration policy for this application.
defaultHostname String: Hostname used to reach this application, as resolved by App Engine.
dispatchRules List<Property Map>: HTTP path dispatch rules for requests to the application that do not explicitly target a service or version. Rules are order-dependent. Up to 20 dispatch rules can be supported.
featureSettings Property Map: The feature specific settings to be used in the application.
gcrDomain String: The Google Container Registry domain used for storing managed build docker images for this application.
generatedCustomerMetadata Map<String>: Additional Google Generated Customer Metadata, this field won't be provided by default and can be requested by setting the IncludeExtraData field in GetApplicationRequest
iap Property Map
location String: Location from which this application runs. Application instances run out of the data centers in the specified location, which is also where all of the application's end user content is stored.Defaults to us-central.View the list of supported locations (https://cloud.google.com/appengine/docs/locations).
name String: Full path to the Application resource in the API. Example: apps/myapp.
serviceAccount String: The service account associated with the application. This is the app-level default identity. If no identity provided during create version, Admin API will fallback to this one.
servingStatus String: Serving status of this application.

Supporting Types

FeatureSettingsResponse

SplitHealthChecks bool: Boolean value indicating if split health checks should be used instead of the legacy health checks. At an app.yaml level, this means defaulting to 'readiness_check' and 'liveness_check' values instead of 'health_check' ones. Once the legacy 'health_check' behavior is deprecated, and this value is always true, this setting can be removed.
UseContainerOptimizedOs bool: If true, use Container-Optimized OS (https://cloud.google.com/container-optimized-os/) base image for VMs, rather than a base Debian image.

SplitHealthChecks bool: Boolean value indicating if split health checks should be used instead of the legacy health checks. At an app.yaml level, this means defaulting to 'readiness_check' and 'liveness_check' values instead of 'health_check' ones. Once the legacy 'health_check' behavior is deprecated, and this value is always true, this setting can be removed.
UseContainerOptimizedOs bool: If true, use Container-Optimized OS (https://cloud.google.com/container-optimized-os/) base image for VMs, rather than a base Debian image.

splitHealthChecks Boolean: Boolean value indicating if split health checks should be used instead of the legacy health checks. At an app.yaml level, this means defaulting to 'readiness_check' and 'liveness_check' values instead of 'health_check' ones. Once the legacy 'health_check' behavior is deprecated, and this value is always true, this setting can be removed.
useContainerOptimizedOs Boolean: If true, use Container-Optimized OS (https://cloud.google.com/container-optimized-os/) base image for VMs, rather than a base Debian image.

splitHealthChecks boolean: Boolean value indicating if split health checks should be used instead of the legacy health checks. At an app.yaml level, this means defaulting to 'readiness_check' and 'liveness_check' values instead of 'health_check' ones. Once the legacy 'health_check' behavior is deprecated, and this value is always true, this setting can be removed.
useContainerOptimizedOs boolean: If true, use Container-Optimized OS (https://cloud.google.com/container-optimized-os/) base image for VMs, rather than a base Debian image.

split_health_checks bool: Boolean value indicating if split health checks should be used instead of the legacy health checks. At an app.yaml level, this means defaulting to 'readiness_check' and 'liveness_check' values instead of 'health_check' ones. Once the legacy 'health_check' behavior is deprecated, and this value is always true, this setting can be removed.
use_container_optimized_os bool: If true, use Container-Optimized OS (https://cloud.google.com/container-optimized-os/) base image for VMs, rather than a base Debian image.

splitHealthChecks Boolean: Boolean value indicating if split health checks should be used instead of the legacy health checks. At an app.yaml level, this means defaulting to 'readiness_check' and 'liveness_check' values instead of 'health_check' ones. Once the legacy 'health_check' behavior is deprecated, and this value is always true, this setting can be removed.
useContainerOptimizedOs Boolean: If true, use Container-Optimized OS (https://cloud.google.com/container-optimized-os/) base image for VMs, rather than a base Debian image.

IdentityAwareProxyResponse

Enabled bool: Whether the serving infrastructure will authenticate and authorize all incoming requests.If true, the oauth2_client_id and oauth2_client_secret fields must be non-empty.
Oauth2ClientId string: OAuth2 client ID to use for the authentication flow.
Oauth2ClientSecret string: OAuth2 client secret to use for the authentication flow.For security reasons, this value cannot be retrieved via the API. Instead, the SHA-256 hash of the value is returned in the oauth2_client_secret_sha256 field.@InputOnly
Oauth2ClientSecretSha256 string: Hex-encoded SHA-256 hash of the client secret.

Enabled bool: Whether the serving infrastructure will authenticate and authorize all incoming requests.If true, the oauth2_client_id and oauth2_client_secret fields must be non-empty.
Oauth2ClientId string: OAuth2 client ID to use for the authentication flow.
Oauth2ClientSecret string: OAuth2 client secret to use for the authentication flow.For security reasons, this value cannot be retrieved via the API. Instead, the SHA-256 hash of the value is returned in the oauth2_client_secret_sha256 field.@InputOnly
Oauth2ClientSecretSha256 string: Hex-encoded SHA-256 hash of the client secret.

enabled Boolean: Whether the serving infrastructure will authenticate and authorize all incoming requests.If true, the oauth2_client_id and oauth2_client_secret fields must be non-empty.
oauth2ClientId String: OAuth2 client ID to use for the authentication flow.
oauth2ClientSecret String: OAuth2 client secret to use for the authentication flow.For security reasons, this value cannot be retrieved via the API. Instead, the SHA-256 hash of the value is returned in the oauth2_client_secret_sha256 field.@InputOnly
oauth2ClientSecretSha256 String: Hex-encoded SHA-256 hash of the client secret.

enabled boolean: Whether the serving infrastructure will authenticate and authorize all incoming requests.If true, the oauth2_client_id and oauth2_client_secret fields must be non-empty.
oauth2ClientId string: OAuth2 client ID to use for the authentication flow.
oauth2ClientSecret string: OAuth2 client secret to use for the authentication flow.For security reasons, this value cannot be retrieved via the API. Instead, the SHA-256 hash of the value is returned in the oauth2_client_secret_sha256 field.@InputOnly
oauth2ClientSecretSha256 string: Hex-encoded SHA-256 hash of the client secret.

enabled bool: Whether the serving infrastructure will authenticate and authorize all incoming requests.If true, the oauth2_client_id and oauth2_client_secret fields must be non-empty.
oauth2_client_id str: OAuth2 client ID to use for the authentication flow.
oauth2_client_secret str: OAuth2 client secret to use for the authentication flow.For security reasons, this value cannot be retrieved via the API. Instead, the SHA-256 hash of the value is returned in the oauth2_client_secret_sha256 field.@InputOnly
oauth2_client_secret_sha256 str: Hex-encoded SHA-256 hash of the client secret.

enabled Boolean: Whether the serving infrastructure will authenticate and authorize all incoming requests.If true, the oauth2_client_id and oauth2_client_secret fields must be non-empty.
oauth2ClientId String: OAuth2 client ID to use for the authentication flow.
oauth2ClientSecret String: OAuth2 client secret to use for the authentication flow.For security reasons, this value cannot be retrieved via the API. Instead, the SHA-256 hash of the value is returned in the oauth2_client_secret_sha256 field.@InputOnly
oauth2ClientSecretSha256 String: Hex-encoded SHA-256 hash of the client secret.

UrlDispatchRuleResponse

Domain string: Domain name to match against. The wildcard "" is supported if specified before a period: ".".Defaults to matching all domains: "*".
Path string: Pathname within the host. Must start with a "/". A single "*" can be included at the end of the path.The sum of the lengths of the domain and path may not exceed 100 characters.
Service string: Resource ID of a service in this application that should serve the matched request. The service must already exist. Example: default.

Domain string: Domain name to match against. The wildcard "" is supported if specified before a period: ".".Defaults to matching all domains: "*".
Path string: Pathname within the host. Must start with a "/". A single "*" can be included at the end of the path.The sum of the lengths of the domain and path may not exceed 100 characters.
Service string: Resource ID of a service in this application that should serve the matched request. The service must already exist. Example: default.

domain String: Domain name to match against. The wildcard "" is supported if specified before a period: ".".Defaults to matching all domains: "*".
path String: Pathname within the host. Must start with a "/". A single "*" can be included at the end of the path.The sum of the lengths of the domain and path may not exceed 100 characters.
service String: Resource ID of a service in this application that should serve the matched request. The service must already exist. Example: default.

domain string: Domain name to match against. The wildcard "" is supported if specified before a period: ".".Defaults to matching all domains: "*".
path string: Pathname within the host. Must start with a "/". A single "*" can be included at the end of the path.The sum of the lengths of the domain and path may not exceed 100 characters.
service string: Resource ID of a service in this application that should serve the matched request. The service must already exist. Example: default.

domain str: Domain name to match against. The wildcard "" is supported if specified before a period: ".".Defaults to matching all domains: "*".
path str: Pathname within the host. Must start with a "/". A single "*" can be included at the end of the path.The sum of the lengths of the domain and path may not exceed 100 characters.
service str: Resource ID of a service in this application that should serve the matched request. The service must already exist. Example: default.

domain String: Domain name to match against. The wildcard "" is supported if specified before a period: ".".Defaults to matching all domains: "*".
path String: Pathname within the host. Must start with a "/". A single "*" can be included at the end of the path.The sum of the lengths of the domain and path may not exceed 100 characters.
service String: Resource ID of a service in this application that should serve the matched request. The service must already exist. Example: default.

Package Details

Repository: Google Cloud Native pulumi/pulumi-google-native
License: Apache-2.0

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi

pulumi/pulumi-google-native

google-native.appengine/v1.getApp

On this page

On this page

Using getApp

getApp Result

Supporting Types

FeatureSettingsResponse

IdentityAwareProxyResponse

UrlDispatchRuleResponse

Package Details

On this page

On this page