AWS Native v0.54.0, Mar 21 23
AWS Native v0.54.0, Mar 21 23
aws-native.amplify.Branch
The AWS::Amplify::Branch resource creates a new branch within an app.
Create Branch Resource
new Branch(name: string, args: BranchArgs, opts?: CustomResourceOptions);
@overload
def Branch(resource_name: str,
opts: Optional[ResourceOptions] = None,
app_id: Optional[str] = None,
basic_auth_config: Optional[BranchBasicAuthConfigArgs] = None,
branch_name: Optional[str] = None,
build_spec: Optional[str] = None,
description: Optional[str] = None,
enable_auto_build: Optional[bool] = None,
enable_performance_mode: Optional[bool] = None,
enable_pull_request_preview: Optional[bool] = None,
environment_variables: Optional[Sequence[BranchEnvironmentVariableArgs]] = None,
framework: Optional[str] = None,
pull_request_environment_name: Optional[str] = None,
stage: Optional[BranchStage] = None,
tags: Optional[Sequence[BranchTagArgs]] = None)
@overload
def Branch(resource_name: str,
args: BranchArgs,
opts: Optional[ResourceOptions] = None)
func NewBranch(ctx *Context, name string, args BranchArgs, opts ...ResourceOption) (*Branch, error)
public Branch(string name, BranchArgs args, CustomResourceOptions? opts = null)
public Branch(String name, BranchArgs args)
public Branch(String name, BranchArgs args, CustomResourceOptions options)
type: aws-native:amplify:Branch
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args BranchArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args BranchArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args BranchArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args BranchArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args BranchArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Branch Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
The Branch resource accepts the following input properties:
- App
Id string - Basic
Auth Pulumi.Config Aws Native. Amplify. Inputs. Branch Basic Auth Config Args - Branch
Name string - Build
Spec string - Description string
- Enable
Auto boolBuild - Enable
Performance boolMode - Enable
Pull boolRequest Preview - Environment
Variables List<Pulumi.Aws Native. Amplify. Inputs. Branch Environment Variable Args> - Framework string
- Pull
Request stringEnvironment Name - Stage
Pulumi.
Aws Native. Amplify. Branch Stage - List<Pulumi.
Aws Native. Amplify. Inputs. Branch Tag Args>
- App
Id string - Basic
Auth BranchConfig Basic Auth Config Args - Branch
Name string - Build
Spec string - Description string
- Enable
Auto boolBuild - Enable
Performance boolMode - Enable
Pull boolRequest Preview - Environment
Variables []BranchEnvironment Variable Args - Framework string
- Pull
Request stringEnvironment Name - Stage
Branch
Stage - []Branch
Tag Args
- app
Id String - basic
Auth BranchConfig Basic Auth Config Args - branch
Name String - build
Spec String - description String
- enable
Auto BooleanBuild - enable
Performance BooleanMode - enable
Pull BooleanRequest Preview - environment
Variables List<BranchEnvironment Variable Args> - framework String
- pull
Request StringEnvironment Name - stage
Branch
Stage - List<Branch
Tag Args>
- app
Id string - basic
Auth BranchConfig Basic Auth Config Args - branch
Name string - build
Spec string - description string
- enable
Auto booleanBuild - enable
Performance booleanMode - enable
Pull booleanRequest Preview - environment
Variables BranchEnvironment Variable Args[] - framework string
- pull
Request stringEnvironment Name - stage
Branch
Stage - Branch
Tag Args[]
- app_
id str - basic_
auth_ Branchconfig Basic Auth Config Args - branch_
name str - build_
spec str - description str
- enable_
auto_ boolbuild - enable_
performance_ boolmode - enable_
pull_ boolrequest_ preview - environment_
variables Sequence[BranchEnvironment Variable Args] - framework str
- pull_
request_ strenvironment_ name - stage
Branch
Stage - Sequence[Branch
Tag Args]
- app
Id String - basic
Auth Property MapConfig - branch
Name String - build
Spec String - description String
- enable
Auto BooleanBuild - enable
Performance BooleanMode - enable
Pull BooleanRequest Preview - environment
Variables List<Property Map> - framework String
- pull
Request StringEnvironment Name - stage "EXPERIMENTAL" | "BETA" | "PULL_REQUEST" | "PRODUCTION" | "DEVELOPMENT"
- List<Property Map>
Outputs
All input properties are implicitly available as output properties. Additionally, the Branch resource produces the following output properties:
Supporting Types
BranchBasicAuthConfig
- Password string
- Username string
- Enable
Basic boolAuth
- Password string
- Username string
- Enable
Basic boolAuth
- password String
- username String
- enable
Basic BooleanAuth
- password string
- username string
- enable
Basic booleanAuth
- password str
- username str
- enable_
basic_ boolauth
- password String
- username String
- enable
Basic BooleanAuth
BranchEnvironmentVariable
BranchStage
- Experimental
- EXPERIMENTAL
- Beta
- BETA
- Pull
Request - PULL_REQUEST
- Production
- PRODUCTION
- Development
- DEVELOPMENT
- Branch
Stage Experimental - EXPERIMENTAL
- Branch
Stage Beta - BETA
- Branch
Stage Pull Request - PULL_REQUEST
- Branch
Stage Production - PRODUCTION
- Branch
Stage Development - DEVELOPMENT
- Experimental
- EXPERIMENTAL
- Beta
- BETA
- Pull
Request - PULL_REQUEST
- Production
- PRODUCTION
- Development
- DEVELOPMENT
- Experimental
- EXPERIMENTAL
- Beta
- BETA
- Pull
Request - PULL_REQUEST
- Production
- PRODUCTION
- Development
- DEVELOPMENT
- EXPERIMENTAL
- EXPERIMENTAL
- BETA
- BETA
- PULL_REQUEST
- PULL_REQUEST
- PRODUCTION
- PRODUCTION
- DEVELOPMENT
- DEVELOPMENT
- "EXPERIMENTAL"
- EXPERIMENTAL
- "BETA"
- BETA
- "PULL_REQUEST"
- PULL_REQUEST
- "PRODUCTION"
- PRODUCTION
- "DEVELOPMENT"
- DEVELOPMENT
BranchTag
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0