BranchOptions

class aws_cdk.aws_amplify.BranchOptions(*, auto_build=None, basic_auth=None, branch_name=None, build_spec=None, description=None, environment_variables=None, pull_request_environment_name=None, pull_request_preview=None, stage=None)

Bases: object

(experimental) Options to add a branch to an application.

Parameters
  • auto_build (Optional[bool]) – (experimental) Whether to enable auto building for the branch. Default: true

  • basic_auth (Optional[BasicAuth]) – (experimental) The Basic Auth configuration. Use this to set password protection for the branch Default: - no password protection

  • branch_name (Optional[str]) – (experimental) The name of the branch. Default: - the construct’s id

  • build_spec (Optional[BuildSpec]) – (experimental) BuildSpec for the branch. Default: - no build spec

  • description (Optional[str]) – (experimental) A description for the branch. Default: - no description

  • environment_variables (Optional[Mapping[str, str]]) – (experimental) Environment variables for the branch. All environment variables that you add are encrypted to prevent rogue access so you can use them to store secret information. Default: - application environment variables

  • pull_request_environment_name (Optional[str]) – (experimental) The dedicated backend environment for the pull request previews. Default: - automatically provision a temporary backend

  • pull_request_preview (Optional[bool]) – (experimental) Whether to enable pull request preview for the branch. Default: true

  • stage (Optional[str]) – (experimental) Stage for the branch. Default: - no stage

Stability

experimental

Attributes

auto_build

(experimental) Whether to enable auto building for the branch.

Default

true

Stability

experimental

Return type

Optional[bool]

basic_auth

(experimental) The Basic Auth configuration.

Use this to set password protection for the branch

Default
  • no password protection

Stability

experimental

Return type

Optional[BasicAuth]

branch_name

(experimental) The name of the branch.

Default
  • the construct’s id

Stability

experimental

Return type

Optional[str]

build_spec

(experimental) BuildSpec for the branch.

Default
  • no build spec

See

https://docs.aws.amazon.com/amplify/latest/userguide/build-settings.html

Stability

experimental

Return type

Optional[BuildSpec]

description

(experimental) A description for the branch.

Default
  • no description

Stability

experimental

Return type

Optional[str]

environment_variables

(experimental) Environment variables for the branch.

All environment variables that you add are encrypted to prevent rogue access so you can use them to store secret information.

Default
  • application environment variables

Stability

experimental

Return type

Optional[Mapping[str, str]]

pull_request_environment_name

(experimental) The dedicated backend environment for the pull request previews.

Default
  • automatically provision a temporary backend

Stability

experimental

Return type

Optional[str]

pull_request_preview

(experimental) Whether to enable pull request preview for the branch.

Default

true

Stability

experimental

Return type

Optional[bool]

stage

(experimental) Stage for the branch.

Default
  • no stage

Stability

experimental

Return type

Optional[str]