An Amplify App in AWS represents a fully managed service for building, deploying, and hosting full-stack web and mobile applications. It provides a central resource that manages app environments, backend services, and continuous deployment from source code repositories.

aws.amplify_app

Fields

TitleIDTypeData TypeDescription
_keycorestring
account_idcorestring
app_arncorestringThe Amazon Resource Name (ARN) of the Amplify app.
app_idcorestringThe unique ID of the Amplify app.
auto_branch_creation_configcorejsonDescribes the automated branch creation configuration for the Amplify app.
auto_branch_creation_patternscorearray<string>Describes the automated branch creation glob patterns for the Amplify app.
basic_auth_credentialscorestringThe basic authorization credentials for branches for the Amplify app. You must base64-encode the authorization credentials and provide them in the format user:password.
build_speccorestringDescribes the content of the build specification (build spec) for the Amplify app.
cache_configcorejsonThe cache configuration for the Amplify app. If you don't specify the cache configuration type, Amplify uses the default AMPLIFY_MANAGED setting.
compute_role_arncorestringThe 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 Amazon Web Services 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.
create_timecoretimestampA timestamp of when Amplify created the application.
custom_headerscorestringDescribes the custom HTTP headers for the Amplify app.
custom_rulescorejsonDescribes the custom redirect and rewrite rules for the Amplify app.
default_domaincorestringThe default domain for the Amplify app.
descriptioncorestringThe description for the Amplify app.
enable_auto_branch_creationcoreboolEnables automated branch creation for the Amplify app.
enable_basic_authcoreboolEnables basic authorization for the Amplify app's branches.
enable_branch_auto_buildcoreboolEnables the auto-building of branches for the Amplify app.
enable_branch_auto_deletioncoreboolAutomatically disconnect a branch in the Amplify console when you delete a branch from your Git repository.
environment_variablescorehstoreThe 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_arncorestringThe Amazon Resource Name (ARN) of the IAM service role for the Amplify app.
namecorestringThe name for the Amplify app.
platformcorestringThe 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 14 or later, you must use the platform type WEB_COMPUTE.
production_branchcorejsonDescribes the information about a production branch of the Amplify app.
repositorycorestringThe Git repository for the Amplify app.
repository_clone_methodcorestringThis is for internal use. The Amplify service uses this parameter to specify the authentication protocol to use to access the Git repository for an Amplify app. Amplify specifies TOKEN for a GitHub repository, SIGV4 for an Amazon Web Services CodeCommit repository, and SSH for GitLab and Bitbucket repositories.
tagscorehstore
update_timecoretimestampA timestamp of when Amplify updated the application.
waf_configurationcorejsonDescribes the Firewall configuration for the Amplify app. Firewall support enables you to protect your hosted applications with a direct integration with WAF.
webhook_create_timecoretimestampA timestamp of when Amplify created the webhook in your Git repository.