AWS::Amplify::Branch - AWS CloudFormation
AWS 文档中描述的 AWS 服务或功能可能因区域而异。要查看适用于中国区域的差异,请参阅中国的 AWS 服务入门

AWS::Amplify::Branch

AWS::Amplify::Branch 资源在应用程序内创建新的分支。

语法

要在 AWS CloudFormation 模板中声明此实体,请使用以下语法:

JSON

{ "Type" : "AWS::Amplify::Branch", "Properties" : { "AppId" : String, "BasicAuthConfig" : BasicAuthConfig, "BranchName" : String, "BuildSpec" : String, "Description" : String, "EnableAutoBuild" : Boolean, "EnablePullRequestPreview" : Boolean, "EnvironmentVariables" : [ EnvironmentVariable, ... ], "PullRequestEnvironmentName" : String, "Stage" : String, "Tags" : [ Tag, ... ] } }

YAML

Type: AWS::Amplify::Branch Properties: AppId: String BasicAuthConfig: BasicAuthConfig BranchName: String BuildSpec: String Description: String EnableAutoBuild: Boolean EnablePullRequestPreview: Boolean EnvironmentVariables: - EnvironmentVariable PullRequestEnvironmentName: String Stage: String Tags: - Tag

属性

AppId

Amplify 应用程序的唯一 ID。

必需:是

类型:字符串

Update requires: Replacement

BasicAuthConfig

Amplify 应用程序的分支的基本授权凭证。

必需:否

类型BasicAuthConfig

Update requires: No interruption

BranchName

分支的名称。

必需:是

类型:字符串

Update requires: Replacement

BuildSpec

分支的构建规范(构建规范)。

必需:否

类型:字符串

Update requires: No interruption

Description

分支的描述。

必需:否

类型:字符串

Update requires: No interruption

EnableAutoBuild

启用分支的自动构建功能。

必需:否

类型:布尔值

Update requires: No interruption

EnablePullRequestPreview

设置 Amplify 控制台是否为针对该分支发出的每个拉取请求创建预览。如果启用该属性,在打开每个拉取请求后,Amplify 控制台将应用程序部署到唯一的预览 URL 中。在将拉取请求合并到生产或集成分支之前,开发和 QA 团队可以使用该预览对其进行测试。

为了为预览提供后端支持,Amplify 控制台自动预置一个临时后端环境,在关闭拉取请求时,它将删除该环境。如果要为预览指定专用的后端环境,请使用 PullRequestEnvironmentName 属性。

有关更多信息,请参阅 AWS Amplify 控制台用户指南 中的 Web 预览

必需:否

类型:布尔值

Update requires: No interruption

EnvironmentVariables

分支的环境变量。

必需:否

类型EnvironmentVariable 的列表

Update requires: No interruption

PullRequestEnvironmentName

如果为该分支启用了拉取请求预览,您可以使用该属性为预览指定专用的后端环境。例如,您可以指定一个名为 prodtestdev 并使用 Amplify CLI 初始化且映射到该分支的环境。

要启用拉取请求预览,请将 EnablePullRequestPreview 属性设置为 true

如果未指定环境,Amplify 控制台将自动预置一个临时后端环境,以便为每个预览提供后端支持。在关闭拉取请求时,Amplify 控制台将删除该环境。

有关创建后端环境的更多信息,请参阅 AWS Amplify 控制台用户指南 中的功能分支部署和团队工作流

必需:否

类型:字符串

Update requires: No interruption

Stage

描述分支的当前阶段。

必需:否

类型:字符串

Update requires: No interruption

Tags

分支的标签。

必需:否

类型Tag 的列表

Update requires: No interruption

返回值

Fn::GetAtt

Arn

Amplify 应用程序中的分支的 ARN。

BranchName

Amplify 应用程序中的分支的名称。