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.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:36.018Z")
 @Stability(value=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()))
                 .pullRequestEnvironmentName("pullRequestEnvironmentName")
                 .stage("stage")
                 .build())
         .basicAuthConfig(BasicAuthConfigProperty.builder()
                 .enableBasicAuth(false)
                 .password("password")
                 .username("username")
                 .build())
         .buildSpec("buildSpec")
         .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")
         .repository("repository")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and 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 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 for an Amplify app.
default Object	getEnableBranchAutoDeletion() Automatically disconnect a branch in the Amplify Console when you delete a branch from your Git repository.
default Object	getEnvironmentVariables() The environment variables map for an Amplify app.
default String	getIamServiceRole() The AWS Identity and Access Management (IAM) service role for the Amazon Resource Name (ARN) of the Amplify app.
String	getName() The name for an Amplify app.
default String	getOauthToken() The OAuth token for a third-party source control system for an Amplify app.
default String	getRepository() The repository for an Amplify app.
default List<CfnTag>	getTags() The tag for an Amplify app.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getName

@Stability(value=Stable)
 @NotNull
String getName()

The name for an Amplify app.

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: (?s).+

getAccessToken

@Stability(value=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 .

Length Constraints: Minimum length of 1. Maximum length of 255.

getAutoBranchCreationConfig

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

Sets the configuration for your automatic branch creation.

getBasicAuthConfig

@Stability(value=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 .

getBuildSpec

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

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

Length Constraints: Minimum length of 1. Maximum length of 25000.

Pattern: (?s).+

getCustomHeaders

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

The custom HTTP headers for an Amplify app.

Length Constraints: Minimum length of 0. Maximum length of 25000.

Pattern: (?s).*

getCustomRules

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

The custom rewrite and redirect rules for an Amplify app.

getDescription

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

The description for an Amplify app.

Length Constraints: Maximum length of 1000.

Pattern: (?s).*

getEnableBranchAutoDeletion

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

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

getEnvironmentVariables

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

The environment variables map for an Amplify app.

getIamServiceRole

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

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

Length Constraints: Minimum length of 0. Maximum length of 1000.

Pattern: (?s).*

getOauthToken

@Stability(value=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 .

Length Constraints: Maximum length of 1000.

Pattern: (?s).*

getRepository

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

The repository for an Amplify app.

Pattern: (?s).*

getTags

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

The tag for an Amplify app.

builder

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

Returns:

a CfnAppProps.Builder of CfnAppProps