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

Builder

Properties

The personal access token for a GitHub repository for an Amplify app. The personal access token is used to authorize access to a GitHub repository using the Amplify GitHub App. The token is not stored.

autoBranchCreationConfig

var autoBranchCreationConfig: AutoBranchCreationConfig?

The automated branch creation configuration for an Amplify app.

autoBranchCreationPatterns

var autoBranchCreationPatterns: List<String>?

The automated branch creation glob patterns for an Amplify app.

basicAuthCredentials

var basicAuthCredentials: String?

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

buildSpec

var buildSpec: String?

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

cacheConfig

var cacheConfig: CacheConfig?

The cache configuration for the Amplify app.

computeRoleArn

var computeRoleArn: String?

The Amazon Resource Name (ARN) of the IAM role to assign to an SSR app. The SSR 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.

customHeaders

var customHeaders: String?

The custom HTTP headers for an Amplify app.

customRules

var customRules: List<CustomRule>?

The custom rewrite and redirect rules for an Amplify app.

description

var description: String?

The description of the Amplify app.

enableAutoBranchCreation

var enableAutoBranchCreation: Boolean?

Enables automated branch creation for an Amplify app.

enableBasicAuth

var enableBasicAuth: Boolean?

Enables basic authorization for an Amplify app. This will apply to all branches that are part of this app.

enableBranchAutoBuild

var enableBranchAutoBuild: Boolean?

Enables the auto building of branches for an Amplify app.

enableBranchAutoDeletion

var enableBranchAutoDeletion: Boolean?

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

environmentVariables

var environmentVariables: Map<String, String>?

The environment variables map for an Amplify app.

iamServiceRoleArn

var iamServiceRoleArn: String?

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

jobConfig

var jobConfig: JobConfig?

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

name

var name: String?

The name of the Amplify app.

oauthToken

var oauthToken: String?

The OAuth token for a third-party source control system for an Amplify app. The OAuth token is used to create a webhook and a read-only deploy key using SSH cloning. The OAuth token is not stored.

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.

repository

var repository: String?

The Git repository for the Amplify app.

Functions

autoBranchCreationConfig

fun autoBranchCreationConfig(block: AutoBranchCreationConfig.Builder.() -> Unit)

construct an aws.sdk.kotlin.services.amplify.model.AutoBranchCreationConfig inside the given block

cacheConfig

fun cacheConfig(block: CacheConfig.Builder.() -> Unit)

construct an aws.sdk.kotlin.services.amplify.model.CacheConfig inside the given block

jobConfig

fun jobConfig(block: JobConfig.Builder.() -> Unit)

construct an aws.sdk.kotlin.services.amplify.model.JobConfig inside the given block