Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. amplify
  5. getApp

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.amplify.getApp

Explore with Pulumi AI

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native

The AWS::Amplify::App resource creates Apps in the Amplify Console. An App is a collection of branches.

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.

function getApp(args: GetAppArgs, opts?: InvokeOptions): Promise<GetAppResult>
function getAppOutput(args: GetAppOutputArgs, opts?: InvokeOptions): Output<GetAppResult>
Copy
def get_app(arn: Optional[str] = None,
            opts: Optional[InvokeOptions] = None) -> GetAppResult
def get_app_output(arn: Optional[pulumi.Input[str]] = None,
            opts: Optional[InvokeOptions] = None) -> Output[GetAppResult]
Copy
func LookupApp(ctx *Context, args *LookupAppArgs, opts ...InvokeOption) (*LookupAppResult, error)
func LookupAppOutput(ctx *Context, args *LookupAppOutputArgs, opts ...InvokeOption) LookupAppResultOutput
Copy

> 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)
}
Copy
public static CompletableFuture<GetAppResult> getApp(GetAppArgs args, InvokeOptions options)
public static Output<GetAppResult> getApp(GetAppArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: aws-native:amplify:getApp
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Arn This property is required. string
ARN for the Amplify App.
Arn This property is required. string
ARN for the Amplify App.
arn This property is required. String
ARN for the Amplify App.
arn This property is required. string
ARN for the Amplify App.
arn This property is required. str
ARN for the Amplify App.
arn This property is required. String
ARN for the Amplify App.

getApp Result

The following output properties are available:

AppId string
Unique Id for the Amplify App.
AppName string
Name for the Amplify App.
Arn string
ARN for the Amplify App.
BuildSpec string
The build specification (build spec) for an Amplify app.
CacheConfig Pulumi.AwsNative.Amplify.Outputs.AppCacheConfig
The cache configuration for the Amplify app. If you don't specify the cache configuration type , Amplify uses the default AMPLIFY_MANAGED setting.
ComputeRoleArn string
The Amazon Resource Name (ARN) of the IAM role for an SSR app. The Compute role allows the Amplify Hosting compute service to securely access specific AWS resources based on the role's permissions. For more information about the SSR Compute role, see Adding an SSR Compute role in the Amplify User Guide .
CustomHeaders string
The custom HTTP headers for an Amplify app.
CustomRules List<Pulumi.AwsNative.Amplify.Outputs.AppCustomRule>
The custom rewrite and redirect rules for an Amplify app.
DefaultDomain string
Default domain for the Amplify App.
Description string
The description of the Amplify app.
EnableBranchAutoDeletion bool
Automatically disconnect a branch in Amplify Hosting when you delete a branch from your Git repository.
EnvironmentVariables List<Pulumi.AwsNative.Amplify.Outputs.AppEnvironmentVariable>

The environment variables for the Amplify app.

For a list of the environment variables that are accessible to Amplify by default, see Amplify Environment variables in the Amplify Hosting User Guide .

IamServiceRole string
AWS Identity and Access Management ( IAM ) service role for the Amazon Resource Name (ARN) of the Amplify app.
Name string
The name of the Amplify app.
Platform Pulumi.AwsNative.Amplify.AppPlatform

The platform for the Amplify app. For a static app, set the platform type to WEB . For a dynamic server-side rendered (SSR) app, set the platform type to WEB_COMPUTE . For an app requiring Amplify Hosting's original SSR support only, set the platform type to WEB_DYNAMIC .

If you are deploying an SSG only app with Next.js version 14 or later, you must set the platform type to WEB_COMPUTE and set the artifacts baseDirectory to .next in the application's build settings. For an example of the build specification settings, see Amplify build settings for a Next.js 14 SSG application in the Amplify Hosting User Guide .

Repository string
The Git repository for the Amplify app.
Tags List<Pulumi.AwsNative.Outputs.Tag>
The tag for an Amplify app.
AppId string
Unique Id for the Amplify App.
AppName string
Name for the Amplify App.
Arn string
ARN for the Amplify App.
BuildSpec string
The build specification (build spec) for an Amplify app.
CacheConfig AppCacheConfig
The cache configuration for the Amplify app. If you don't specify the cache configuration type , Amplify uses the default AMPLIFY_MANAGED setting.
ComputeRoleArn string
The Amazon Resource Name (ARN) of the IAM role for an SSR app. The Compute role allows the Amplify Hosting compute service to securely access specific AWS resources based on the role's permissions. For more information about the SSR Compute role, see Adding an SSR Compute role in the Amplify User Guide .
CustomHeaders string
The custom HTTP headers for an Amplify app.
CustomRules []AppCustomRule
The custom rewrite and redirect rules for an Amplify app.
DefaultDomain string
Default domain for the Amplify App.
Description string
The description of the Amplify app.
EnableBranchAutoDeletion bool
Automatically disconnect a branch in Amplify Hosting when you delete a branch from your Git repository.
EnvironmentVariables []AppEnvironmentVariable

The environment variables for the Amplify app.

For a list of the environment variables that are accessible to Amplify by default, see Amplify Environment variables in the Amplify Hosting User Guide .

IamServiceRole string
AWS Identity and Access Management ( IAM ) service role for the Amazon Resource Name (ARN) of the Amplify app.
Name string
The name of the Amplify app.
Platform AppPlatform

The platform for the Amplify app. For a static app, set the platform type to WEB . For a dynamic server-side rendered (SSR) app, set the platform type to WEB_COMPUTE . For an app requiring Amplify Hosting's original SSR support only, set the platform type to WEB_DYNAMIC .

If you are deploying an SSG only app with Next.js version 14 or later, you must set the platform type to WEB_COMPUTE and set the artifacts baseDirectory to .next in the application's build settings. For an example of the build specification settings, see Amplify build settings for a Next.js 14 SSG application in the Amplify Hosting User Guide .

Repository string
The Git repository for the Amplify app.
Tags Tag
The tag for an Amplify app.
appId String
Unique Id for the Amplify App.
appName String
Name for the Amplify App.
arn String
ARN for the Amplify App.
buildSpec String
The build specification (build spec) for an Amplify app.
cacheConfig AppCacheConfig
The cache configuration for the Amplify app. If you don't specify the cache configuration type , Amplify uses the default AMPLIFY_MANAGED setting.
computeRoleArn String
The Amazon Resource Name (ARN) of the IAM role for an SSR app. The Compute role allows the Amplify Hosting compute service to securely access specific AWS resources based on the role's permissions. For more information about the SSR Compute role, see Adding an SSR Compute role in the Amplify User Guide .
customHeaders String
The custom HTTP headers for an Amplify app.
customRules List<AppCustomRule>
The custom rewrite and redirect rules for an Amplify app.
defaultDomain String
Default domain for the Amplify App.
description String
The description of the Amplify app.
enableBranchAutoDeletion Boolean
Automatically disconnect a branch in Amplify Hosting when you delete a branch from your Git repository.
environmentVariables List<AppEnvironmentVariable>

The environment variables for the Amplify app.

For a list of the environment variables that are accessible to Amplify by default, see Amplify Environment variables in the Amplify Hosting User Guide .

iamServiceRole String
AWS Identity and Access Management ( IAM ) service role for the Amazon Resource Name (ARN) of the Amplify app.
name String
The name of the Amplify app.
platform AppPlatform

The platform for the Amplify app. For a static app, set the platform type to WEB . For a dynamic server-side rendered (SSR) app, set the platform type to WEB_COMPUTE . For an app requiring Amplify Hosting's original SSR support only, set the platform type to WEB_DYNAMIC .

If you are deploying an SSG only app with Next.js version 14 or later, you must set the platform type to WEB_COMPUTE and set the artifacts baseDirectory to .next in the application's build settings. For an example of the build specification settings, see Amplify build settings for a Next.js 14 SSG application in the Amplify Hosting User Guide .

repository String
The Git repository for the Amplify app.
tags List<Tag>
The tag for an Amplify app.
appId string
Unique Id for the Amplify App.
appName string
Name for the Amplify App.
arn string
ARN for the Amplify App.
buildSpec string
The build specification (build spec) for an Amplify app.
cacheConfig AppCacheConfig
The cache configuration for the Amplify app. If you don't specify the cache configuration type , Amplify uses the default AMPLIFY_MANAGED setting.
computeRoleArn string
The Amazon Resource Name (ARN) of the IAM role for an SSR app. The Compute role allows the Amplify Hosting compute service to securely access specific AWS resources based on the role's permissions. For more information about the SSR Compute role, see Adding an SSR Compute role in the Amplify User Guide .
customHeaders string
The custom HTTP headers for an Amplify app.
customRules AppCustomRule[]
The custom rewrite and redirect rules for an Amplify app.
defaultDomain string
Default domain for the Amplify App.
description string
The description of the Amplify app.
enableBranchAutoDeletion boolean
Automatically disconnect a branch in Amplify Hosting when you delete a branch from your Git repository.
environmentVariables AppEnvironmentVariable[]

The environment variables for the Amplify app.

For a list of the environment variables that are accessible to Amplify by default, see Amplify Environment variables in the Amplify Hosting User Guide .

iamServiceRole string
AWS Identity and Access Management ( IAM ) service role for the Amazon Resource Name (ARN) of the Amplify app.
name string
The name of the Amplify app.
platform AppPlatform

The platform for the Amplify app. For a static app, set the platform type to WEB . For a dynamic server-side rendered (SSR) app, set the platform type to WEB_COMPUTE . For an app requiring Amplify Hosting's original SSR support only, set the platform type to WEB_DYNAMIC .

If you are deploying an SSG only app with Next.js version 14 or later, you must set the platform type to WEB_COMPUTE and set the artifacts baseDirectory to .next in the application's build settings. For an example of the build specification settings, see Amplify build settings for a Next.js 14 SSG application in the Amplify Hosting User Guide .

repository string
The Git repository for the Amplify app.
tags Tag[]
The tag for an Amplify app.
app_id str
Unique Id for the Amplify App.
app_name str
Name for the Amplify App.
arn str
ARN for the Amplify App.
build_spec str
The build specification (build spec) for an Amplify app.
cache_config AppCacheConfig
The cache configuration for the Amplify app. If you don't specify the cache configuration type , Amplify uses the default AMPLIFY_MANAGED setting.
compute_role_arn str
The Amazon Resource Name (ARN) of the IAM role for an SSR app. The Compute role allows the Amplify Hosting compute service to securely access specific AWS resources based on the role's permissions. For more information about the SSR Compute role, see Adding an SSR Compute role in the Amplify User Guide .
custom_headers str
The custom HTTP headers for an Amplify app.
custom_rules Sequence[AppCustomRule]
The custom rewrite and redirect rules for an Amplify app.
default_domain str
Default domain for the Amplify App.
description str
The description of the Amplify app.
enable_branch_auto_deletion bool
Automatically disconnect a branch in Amplify Hosting when you delete a branch from your Git repository.
environment_variables Sequence[AppEnvironmentVariable]

The environment variables for the Amplify app.

For a list of the environment variables that are accessible to Amplify by default, see Amplify Environment variables in the Amplify Hosting User Guide .

iam_service_role str
AWS Identity and Access Management ( IAM ) service role for the Amazon Resource Name (ARN) of the Amplify app.
name str
The name of the Amplify app.
platform AppPlatform

The platform for the Amplify app. For a static app, set the platform type to WEB . For a dynamic server-side rendered (SSR) app, set the platform type to WEB_COMPUTE . For an app requiring Amplify Hosting's original SSR support only, set the platform type to WEB_DYNAMIC .

If you are deploying an SSG only app with Next.js version 14 or later, you must set the platform type to WEB_COMPUTE and set the artifacts baseDirectory to .next in the application's build settings. For an example of the build specification settings, see Amplify build settings for a Next.js 14 SSG application in the Amplify Hosting User Guide .

repository str
The Git repository for the Amplify app.
tags Sequence[root_Tag]
The tag for an Amplify app.
appId String
Unique Id for the Amplify App.
appName String
Name for the Amplify App.
arn String
ARN for the Amplify App.
buildSpec String
The build specification (build spec) for an Amplify app.
cacheConfig Property Map
The cache configuration for the Amplify app. If you don't specify the cache configuration type , Amplify uses the default AMPLIFY_MANAGED setting.
computeRoleArn String
The Amazon Resource Name (ARN) of the IAM role for an SSR app. The Compute role allows the Amplify Hosting compute service to securely access specific AWS resources based on the role's permissions. For more information about the SSR Compute role, see Adding an SSR Compute role in the Amplify User Guide .
customHeaders String
The custom HTTP headers for an Amplify app.
customRules List<Property Map>
The custom rewrite and redirect rules for an Amplify app.
defaultDomain String
Default domain for the Amplify App.
description String
The description of the Amplify app.
enableBranchAutoDeletion Boolean
Automatically disconnect a branch in Amplify Hosting when you delete a branch from your Git repository.
environmentVariables List<Property Map>

The environment variables for the Amplify app.

For a list of the environment variables that are accessible to Amplify by default, see Amplify Environment variables in the Amplify Hosting User Guide .

iamServiceRole String
AWS Identity and Access Management ( IAM ) service role for the Amazon Resource Name (ARN) of the Amplify app.
name String
The name of the Amplify app.
platform "WEB" | "WEB_DYNAMIC" | "WEB_COMPUTE"

The platform for the Amplify app. For a static app, set the platform type to WEB . For a dynamic server-side rendered (SSR) app, set the platform type to WEB_COMPUTE . For an app requiring Amplify Hosting's original SSR support only, set the platform type to WEB_DYNAMIC .

If you are deploying an SSG only app with Next.js version 14 or later, you must set the platform type to WEB_COMPUTE and set the artifacts baseDirectory to .next in the application's build settings. For an example of the build specification settings, see Amplify build settings for a Next.js 14 SSG application in the Amplify Hosting User Guide .

repository String
The Git repository for the Amplify app.
tags List<Property Map>
The tag for an Amplify app.

Supporting Types

AppCacheConfig

Type Pulumi.AwsNative.Amplify.AppCacheConfigType

The type of cache configuration to use for an Amplify app.

The AMPLIFY_MANAGED cache configuration automatically applies an optimized cache configuration for your app based on its platform, routing rules, and rewrite rules. This is the default setting.

The AMPLIFY_MANAGED_NO_COOKIES cache configuration type is the same as AMPLIFY_MANAGED , except that it excludes all cookies from the cache key.

Type AppCacheConfigType

The type of cache configuration to use for an Amplify app.

The AMPLIFY_MANAGED cache configuration automatically applies an optimized cache configuration for your app based on its platform, routing rules, and rewrite rules. This is the default setting.

The AMPLIFY_MANAGED_NO_COOKIES cache configuration type is the same as AMPLIFY_MANAGED , except that it excludes all cookies from the cache key.

type AppCacheConfigType

The type of cache configuration to use for an Amplify app.

The AMPLIFY_MANAGED cache configuration automatically applies an optimized cache configuration for your app based on its platform, routing rules, and rewrite rules. This is the default setting.

The AMPLIFY_MANAGED_NO_COOKIES cache configuration type is the same as AMPLIFY_MANAGED , except that it excludes all cookies from the cache key.

type AppCacheConfigType

The type of cache configuration to use for an Amplify app.

The AMPLIFY_MANAGED cache configuration automatically applies an optimized cache configuration for your app based on its platform, routing rules, and rewrite rules. This is the default setting.

The AMPLIFY_MANAGED_NO_COOKIES cache configuration type is the same as AMPLIFY_MANAGED , except that it excludes all cookies from the cache key.

type AppCacheConfigType

The type of cache configuration to use for an Amplify app.

The AMPLIFY_MANAGED cache configuration automatically applies an optimized cache configuration for your app based on its platform, routing rules, and rewrite rules. This is the default setting.

The AMPLIFY_MANAGED_NO_COOKIES cache configuration type is the same as AMPLIFY_MANAGED , except that it excludes all cookies from the cache key.

type "AMPLIFY_MANAGED" | "AMPLIFY_MANAGED_NO_COOKIES"

The type of cache configuration to use for an Amplify app.

The AMPLIFY_MANAGED cache configuration automatically applies an optimized cache configuration for your app based on its platform, routing rules, and rewrite rules. This is the default setting.

The AMPLIFY_MANAGED_NO_COOKIES cache configuration type is the same as AMPLIFY_MANAGED , except that it excludes all cookies from the cache key.

AppCacheConfigType

AppCustomRule

Source This property is required. string
The source pattern for a URL rewrite or redirect rule.
Target This property is required. string
The target pattern for a URL rewrite or redirect rule.
Condition string
The condition for a URL rewrite or redirect rule, such as a country code.
Status string
The status code for a URL rewrite or redirect rule.

  • 200 - Represents a 200 rewrite rule.
  • 301 - Represents a 301 (moved pemanently) redirect rule. This and all future requests should be directed to the target URL.
  • 302 - Represents a 302 temporary redirect rule.
  • 404 - Represents a 404 redirect rule.
  • 404-200 - Represents a 404 rewrite rule.
Source This property is required. string
The source pattern for a URL rewrite or redirect rule.
Target This property is required. string
The target pattern for a URL rewrite or redirect rule.
Condition string
The condition for a URL rewrite or redirect rule, such as a country code.
Status string
The status code for a URL rewrite or redirect rule.

  • 200 - Represents a 200 rewrite rule.
  • 301 - Represents a 301 (moved pemanently) redirect rule. This and all future requests should be directed to the target URL.
  • 302 - Represents a 302 temporary redirect rule.
  • 404 - Represents a 404 redirect rule.
  • 404-200 - Represents a 404 rewrite rule.
source This property is required. String
The source pattern for a URL rewrite or redirect rule.
target This property is required. String
The target pattern for a URL rewrite or redirect rule.
condition String
The condition for a URL rewrite or redirect rule, such as a country code.
status String
The status code for a URL rewrite or redirect rule.

  • 200 - Represents a 200 rewrite rule.
  • 301 - Represents a 301 (moved pemanently) redirect rule. This and all future requests should be directed to the target URL.
  • 302 - Represents a 302 temporary redirect rule.
  • 404 - Represents a 404 redirect rule.
  • 404-200 - Represents a 404 rewrite rule.
source This property is required. string
The source pattern for a URL rewrite or redirect rule.
target This property is required. string
The target pattern for a URL rewrite or redirect rule.
condition string
The condition for a URL rewrite or redirect rule, such as a country code.
status string
The status code for a URL rewrite or redirect rule.

  • 200 - Represents a 200 rewrite rule.
  • 301 - Represents a 301 (moved pemanently) redirect rule. This and all future requests should be directed to the target URL.
  • 302 - Represents a 302 temporary redirect rule.
  • 404 - Represents a 404 redirect rule.
  • 404-200 - Represents a 404 rewrite rule.
source This property is required. str
The source pattern for a URL rewrite or redirect rule.
target This property is required. str
The target pattern for a URL rewrite or redirect rule.
condition str
The condition for a URL rewrite or redirect rule, such as a country code.
status str
The status code for a URL rewrite or redirect rule.

  • 200 - Represents a 200 rewrite rule.
  • 301 - Represents a 301 (moved pemanently) redirect rule. This and all future requests should be directed to the target URL.
  • 302 - Represents a 302 temporary redirect rule.
  • 404 - Represents a 404 redirect rule.
  • 404-200 - Represents a 404 rewrite rule.
source This property is required. String
The source pattern for a URL rewrite or redirect rule.
target This property is required. String
The target pattern for a URL rewrite or redirect rule.
condition String
The condition for a URL rewrite or redirect rule, such as a country code.
status String
The status code for a URL rewrite or redirect rule.

  • 200 - Represents a 200 rewrite rule.
  • 301 - Represents a 301 (moved pemanently) redirect rule. This and all future requests should be directed to the target URL.
  • 302 - Represents a 302 temporary redirect rule.
  • 404 - Represents a 404 redirect rule.
  • 404-200 - Represents a 404 rewrite rule.

AppEnvironmentVariable

Name This property is required. string
The environment variable name.
Value This property is required. string
The environment variable value.
Name This property is required. string
The environment variable name.
Value This property is required. string
The environment variable value.
name This property is required. String
The environment variable name.
value This property is required. String
The environment variable value.
name This property is required. string
The environment variable name.
value This property is required. string
The environment variable value.
name This property is required. str
The environment variable name.
value This property is required. str
The environment variable value.
name This property is required. String
The environment variable name.
value This property is required. String
The environment variable value.

AppPlatform

Tag

Key This property is required. string
The key name of the tag
Value This property is required. string
The value of the tag
Key This property is required. string
The key name of the tag
Value This property is required. string
The value of the tag
key This property is required. String
The key name of the tag
value This property is required. String
The value of the tag
key This property is required. string
The key name of the tag
value This property is required. string
The value of the tag
key This property is required. str
The key name of the tag
value This property is required. str
The value of the tag
key This property is required. String
The key name of the tag
value This property is required. String
The value of the tag

Package Details

Repository
AWS Native pulumi/pulumi-aws-native
License
Apache-2.0

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native