CfnBranchProps

class aws_cdk.aws_amplify.CfnBranchProps(*, app_id, branch_name, basic_auth_config=None, build_spec=None, description=None, enable_auto_build=None, enable_pull_request_preview=None, environment_variables=None, pull_request_environment_name=None, stage=None, tags=None)

Bases: object

__init__(*, app_id, branch_name, basic_auth_config=None, build_spec=None, description=None, enable_auto_build=None, enable_pull_request_preview=None, environment_variables=None, pull_request_environment_name=None, stage=None, tags=None)

Properties for defining a AWS::Amplify::Branch.

Parameters
  • app_id (str) – AWS::Amplify::Branch.AppId.

  • branch_name (str) – AWS::Amplify::Branch.BranchName.

  • basic_auth_config (Union[BasicAuthConfigProperty, None, IResolvable]) – AWS::Amplify::Branch.BasicAuthConfig.

  • build_spec (Optional[str]) – AWS::Amplify::Branch.BuildSpec.

  • description (Optional[str]) – AWS::Amplify::Branch.Description.

  • enable_auto_build (Union[bool, None, IResolvable]) – AWS::Amplify::Branch.EnableAutoBuild.

  • enable_pull_request_preview (Union[bool, None, IResolvable]) – AWS::Amplify::Branch.EnablePullRequestPreview.

  • environment_variables (Union[IResolvable, None, List[Union[IResolvable, EnvironmentVariableProperty]]]) – AWS::Amplify::Branch.EnvironmentVariables.

  • pull_request_environment_name (Optional[str]) – AWS::Amplify::Branch.PullRequestEnvironmentName.

  • stage (Optional[str]) – AWS::Amplify::Branch.Stage.

  • tags (Optional[List[CfnTag]]) – AWS::Amplify::Branch.Tags.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-branch.html

Attributes

app_id

AWS::Amplify::Branch.AppId.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-branch.html#cfn-amplify-branch-appid

Return type

str

basic_auth_config

AWS::Amplify::Branch.BasicAuthConfig.

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

Return type

Union[BasicAuthConfigProperty, None, IResolvable]

branch_name

AWS::Amplify::Branch.BranchName.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-branch.html#cfn-amplify-branch-branchname

Return type

str

build_spec

AWS::Amplify::Branch.BuildSpec.

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

Return type

Optional[str]

description

AWS::Amplify::Branch.Description.

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

Return type

Optional[str]

enable_auto_build

AWS::Amplify::Branch.EnableAutoBuild.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-branch.html#cfn-amplify-branch-enableautobuild

Return type

Union[bool, None, IResolvable]

enable_pull_request_preview

AWS::Amplify::Branch.EnablePullRequestPreview.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-branch.html#cfn-amplify-branch-enablepullrequestpreview

Return type

Union[bool, None, IResolvable]

environment_variables

AWS::Amplify::Branch.EnvironmentVariables.

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

Return type

Union[IResolvable, None, List[Union[IResolvable, EnvironmentVariableProperty]]]

pull_request_environment_name

AWS::Amplify::Branch.PullRequestEnvironmentName.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-branch.html#cfn-amplify-branch-pullrequestenvironmentname

Return type

Optional[str]

stage

AWS::Amplify::Branch.Stage.

see :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-amplify-branch.html#cfn-amplify-branch-stage

Return type

Optional[str]

tags

AWS::Amplify::Branch.Tags.

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

Return type

Optional[List[CfnTag]]