Describes the automated branch creation configuration.
Contents
- basicAuthCredentials
-
The basic authorization credentials for the autocreated branch. You must base64-encode the authorization credentials and provide them in the format
user:password.Type: String
Length Constraints: Maximum length of 2000.
Pattern:
(?s).*Required: No
- buildSpec
-
The build specification (build spec) for the autocreated branch.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 25000.
Pattern:
(?s).+Required: No
- enableAutoBuild
-
Enables auto building for the autocreated branch.
Type: Boolean
Required: No
- enableBasicAuth
-
Enables basic authorization for the autocreated branch.
Type: Boolean
Required: No
- enablePerformanceMode
-
Enables performance mode for the branch.
Performance mode optimizes for faster hosting performance by keeping content cached at the edge for a longer interval. When performance mode is enabled, hosting configuration or code changes can take up to 10 minutes to roll out.
Type: Boolean
Required: No
- enablePullRequestPreview
-
Enables pull request previews for the autocreated branch.
Type: Boolean
Required: No
- environmentVariables
-
The environment variables for the autocreated branch.
Type: String to string map
Key Length Constraints: Maximum length of 255.
Key Pattern:
(?s).*Value Length Constraints: Maximum length of 5500.
Value Pattern:
(?s).*Required: No
- framework
-
The framework for the autocreated branch.
Type: String
Length Constraints: Maximum length of 255.
Pattern:
(?s).*Required: No
- pullRequestEnvironmentName
-
The Amplify environment name for the pull request.
Type: String
Length Constraints: Maximum length of 20.
Pattern:
(?s).*Required: No
- stage
-
Describes the current stage for the autocreated branch.
Type: String
Valid Values:
PRODUCTION | BETA | DEVELOPMENT | EXPERIMENTAL | PULL_REQUESTRequired: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
