Package software.amazon.awscdk.services.amplify

Interface CfnAppProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnAppProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-15T10:24:53.703Z")
@Stability(Stable)
public interface CfnAppProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnApp.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.amplify.*;
 CfnAppProps cfnAppProps = CfnAppProps.builder()
         .name("name")
         // the properties below are optional
         .accessToken("accessToken")
         .autoBranchCreationConfig(AutoBranchCreationConfigProperty.builder()
                 .autoBranchCreationPatterns(List.of("autoBranchCreationPatterns"))
                 .basicAuthConfig(BasicAuthConfigProperty.builder()
                         .enableBasicAuth(false)
                         .password("password")
                         .username("username")
                         .build())
                 .buildSpec("buildSpec")
                 .enableAutoBranchCreation(false)
                 .enableAutoBuild(false)
                 .enablePerformanceMode(false)
                 .enablePullRequestPreview(false)
                 .environmentVariables(List.of(EnvironmentVariableProperty.builder()
                         .name("name")
                         .value("value")
                         .build()))
                 .framework("framework")
                 .pullRequestEnvironmentName("pullRequestEnvironmentName")
                 .stage("stage")
                 .build())
         .basicAuthConfig(BasicAuthConfigProperty.builder()
                 .enableBasicAuth(false)
                 .password("password")
                 .username("username")
                 .build())
         .buildSpec("buildSpec")
         .cacheConfig(CacheConfigProperty.builder()
                 .type("type")
                 .build())
         .customHeaders("customHeaders")
         .customRules(List.of(CustomRuleProperty.builder()
                 .source("source")
                 .target("target")
                 // the properties below are optional
                 .condition("condition")
                 .status("status")
                 .build()))
         .description("description")
         .enableBranchAutoDeletion(false)
         .environmentVariables(List.of(EnvironmentVariableProperty.builder()
                 .name("name")
                 .value("value")
                 .build()))
         .iamServiceRole("iamServiceRole")
         .oauthToken("oauthToken")
         .platform("platform")
         .repository("repository")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-app.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnAppProps.Builder	A builder for CfnAppProps
static final class	CfnAppProps.Jsii$Proxy	An implementation for CfnAppProps

Method Summary

Modifier and Type	Method	Description
static CfnAppProps.Builder	builder()
default String	getAccessToken()	The personal access token for a GitHub repository for an Amplify app.
default Object	getAutoBranchCreationConfig()	Sets the configuration for your automatic branch creation.
default Object	getBasicAuthConfig()	The credentials for basic authorization for an Amplify app.
default String	getBuildSpec()	The build specification (build spec) for an Amplify app.
default Object	getCacheConfig()	The cache configuration for the Amplify app.
default String	getCustomHeaders()	The custom HTTP headers for an Amplify app.
default Object	getCustomRules()	The custom rewrite and redirect rules for an Amplify app.
default String	getDescription()	The description of the Amplify app.
default Object	getEnableBranchAutoDeletion()	Automatically disconnect a branch in Amplify Hosting when you delete a branch from your Git repository.
default Object	getEnvironmentVariables()	The environment variables for the Amplify app.
default String	getIamServiceRole()	AWS Identity and Access Management ( IAM ) service role for the Amazon Resource Name (ARN) of the Amplify app.
String	getName()	The name of the Amplify app.
default String	getOauthToken()	The OAuth token for a third-party source control system for an Amplify app.
default String	getPlatform()	The platform for the Amplify app.
default String	getRepository()	The Git repository for the Amplify app.
default List<CfnTag>	getTags()	The tag for an Amplify app.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getName

@Stability(Stable)
@NotNull
String getName()

The name of the Amplify app.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-app.html#cfn-amplify-app-name

getAccessToken

@Stability(Stable)
@Nullable
default String getAccessToken()

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.

Use AccessToken for GitHub repositories only. To authorize access to a repository provider such as Bitbucket or CodeCommit, use OauthToken .

You must specify either AccessToken or OauthToken when you create a new app.

Existing Amplify apps deployed from a GitHub repository using OAuth continue to work with CI/CD. However, we strongly recommend that you migrate these apps to use the GitHub App. For more information, see Migrating an existing OAuth app to the Amplify GitHub App in the Amplify User Guide .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-app.html#cfn-amplify-app-accesstoken

getAutoBranchCreationConfig

@Stability(Stable)
@Nullable
default Object getAutoBranchCreationConfig()

Sets the configuration for your automatic branch creation.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-app.html#cfn-amplify-app-autobranchcreationconfig

getBasicAuthConfig

@Stability(Stable)
@Nullable
default Object getBasicAuthConfig()

The credentials for basic authorization for an Amplify app.

You must base64-encode the authorization credentials and provide them in the format user:password .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-app.html#cfn-amplify-app-basicauthconfig

getBuildSpec

@Stability(Stable)
@Nullable
default String getBuildSpec()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-app.html#cfn-amplify-app-buildspec

getCacheConfig

@Stability(Stable)
@Nullable
default Object getCacheConfig()

The cache configuration for the Amplify app.

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-app.html#cfn-amplify-app-cacheconfig

getCustomHeaders

@Stability(Stable)
@Nullable
default String getCustomHeaders()

The custom HTTP headers for an Amplify app.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-app.html#cfn-amplify-app-customheaders

getCustomRules

@Stability(Stable)
@Nullable
default Object getCustomRules()

The custom rewrite and redirect rules for an Amplify app.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-app.html#cfn-amplify-app-customrules

getDescription

@Stability(Stable)
@Nullable
default String getDescription()

The description of the Amplify app.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-app.html#cfn-amplify-app-description

getEnableBranchAutoDeletion

@Stability(Stable)
@Nullable
default Object getEnableBranchAutoDeletion()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-app.html#cfn-amplify-app-enablebranchautodeletion

getEnvironmentVariables

@Stability(Stable)
@Nullable
default Object getEnvironmentVariables()

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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-app.html#cfn-amplify-app-environmentvariables

getIamServiceRole

@Stability(Stable)
@Nullable
default String getIamServiceRole()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-app.html#cfn-amplify-app-iamservicerole

getOauthToken

@Stability(Stable)
@Nullable
default String getOauthToken()

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.

Use OauthToken for repository providers other than GitHub, such as Bitbucket or CodeCommit. To authorize access to GitHub as your repository provider, use AccessToken .

You must specify either OauthToken or AccessToken when you create a new app.

Existing Amplify apps deployed from a GitHub repository using OAuth continue to work with CI/CD. However, we strongly recommend that you migrate these apps to use the GitHub App. For more information, see Migrating an existing OAuth app to the Amplify GitHub App in the Amplify User Guide .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-app.html#cfn-amplify-app-oauthtoken

getPlatform

@Stability(Stable)
@Nullable
default String getPlatform()

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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-app.html#cfn-amplify-app-platform

getRepository

@Stability(Stable)
@Nullable
default String getRepository()

The Git repository for the Amplify app.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-app.html#cfn-amplify-app-repository

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

The tag for an Amplify app.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-app.html#cfn-amplify-app-tags

builder

@Stability(Stable)
static CfnAppProps.Builder builder()

Returns:

a CfnAppProps.Builder of CfnAppProps