GetAppResult

data class GetAppResult(val appId: String? = null, val appName: String? = null, val arn: String? = null, val buildSpec: String? = null, val cacheConfig: AppCacheConfig? = null, val computeRoleArn: String? = null, val customHeaders: String? = null, val customRules: List<AppCustomRule>? = null, val defaultDomain: String? = null, val description: String? = null, val enableBranchAutoDeletion: Boolean? = null, val environmentVariables: List<AppEnvironmentVariable>? = null, val iamServiceRole: String? = null, val name: String? = null, val platform: AppPlatform? = null, val repository: String? = null, val tags: List<Tag>? = null)

Constructors

Link copied to clipboard
constructor(appId: String? = null, appName: String? = null, arn: String? = null, buildSpec: String? = null, cacheConfig: AppCacheConfig? = null, computeRoleArn: String? = null, customHeaders: String? = null, customRules: List<AppCustomRule>? = null, defaultDomain: String? = null, description: String? = null, enableBranchAutoDeletion: Boolean? = null, environmentVariables: List<AppEnvironmentVariable>? = null, iamServiceRole: String? = null, name: String? = null, platform: AppPlatform? = null, repository: String? = null, tags: List<Tag>? = null)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard
val appId: String? = null

Unique Id for the Amplify App.

Link copied to clipboard
val appName: String? = null

Name for the Amplify App.

Link copied to clipboard
val arn: String? = null

ARN for the Amplify App.

Link copied to clipboard
val buildSpec: String? = null

The build specification (build spec) for an Amplify app.

Link copied to clipboard

The cache configuration for the Amplify app. If you don't specify the cache configuration type , Amplify uses the default AMPLIFY_MANAGED setting.

Link copied to clipboard
val computeRoleArn: String? = null

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 .

Link copied to clipboard
val customHeaders: String? = null

The custom HTTP headers for an Amplify app.

Link copied to clipboard

The custom rewrite and redirect rules for an Amplify app.

Link copied to clipboard
val defaultDomain: String? = null

Default domain for the Amplify App.

Link copied to clipboard
val description: String? = null

The description of the Amplify app.

Link copied to clipboard

Automatically disconnect a branch in Amplify Hosting when you delete a branch from your Git repository.

Link copied to clipboard

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 .

Link copied to clipboard
val iamServiceRole: String? = null

AWS Identity and Access Management ( IAM ) service role for the Amazon Resource Name (ARN) of the Amplify app.

Link copied to clipboard
val name: String? = null

The name of the Amplify app.

Link copied to clipboard
val platform: AppPlatform? = null

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 .

Link copied to clipboard
val repository: String? = null

The Git repository for the Amplify app.

Link copied to clipboard
val tags: List<Tag>? = null

The tag for an Amplify app.