amplify/aws.sdk.kotlin.services.amplify.model/App/Builder

Builder

class Builder

Properties

appArn

var appArn: String?

The Amazon Resource Name (ARN) of the Amplify app.

appId

var appId: String?

The unique ID of the Amplify app.

autoBranchCreationConfig

var autoBranchCreationConfig: AutoBranchCreationConfig?

Describes the automated branch creation configuration for the Amplify app.

autoBranchCreationPatterns

var autoBranchCreationPatterns: List<String>?

Describes the automated branch creation glob patterns for the Amplify app.

basicAuthCredentials

var basicAuthCredentials: String?

The basic authorization credentials for branches for the Amplify app. You must base64-encode the authorization credentials and provide them in the format user:password.

buildSpec

var buildSpec: String?

Describes the content of the build specification (build spec) for the Amplify app.

cacheConfig

var cacheConfig: CacheConfig?

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

computeRoleArn

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

createTime

var createTime: Instant?

A timestamp of when Amplify created the application.

customHeaders

var customHeaders: String?

Describes the custom HTTP headers for the Amplify app.

customRules

var customRules: List<CustomRule>?

Describes the custom redirect and rewrite rules for the Amplify app.

defaultDomain

var defaultDomain: String?

The default domain for the Amplify app.

description

var description: String?

The description for the Amplify app.

enableAutoBranchCreation

var enableAutoBranchCreation: Boolean?

Enables automated branch creation for the Amplify app.

enableBasicAuth

var enableBasicAuth: Boolean?

Enables basic authorization for the Amplify app's branches.

enableBranchAutoBuild

var enableBranchAutoBuild: Boolean?

Enables the auto-building of branches for the Amplify app.

enableBranchAutoDeletion

var enableBranchAutoDeletion: Boolean?

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

environmentVariables

var environmentVariables: Map<String, String>?

The environment variables for the Amplify app.

iamServiceRoleArn

var iamServiceRoleArn: String?

The Amazon Resource Name (ARN) of the IAM service role for the Amplify app.

jobConfig

var jobConfig: JobConfig?

The configuration details that apply to the jobs for an Amplify app.

name

var name: String?

The name for the Amplify app.

platform

var platform: Platform?

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.

productionBranch

var productionBranch: ProductionBranch?

Describes the information about a production branch of the Amplify app.

repository

var repository: String?

The Git repository for the Amplify app.

repositoryCloneMethod

var repositoryCloneMethod: RepositoryCloneMethod?

This is for internal use.