AutoBranchCreation

class aws_cdk.aws_amplify.AutoBranchCreation(*, auto_build=None, basic_auth=None, build_spec=None, environment_variables=None, patterns=None, pull_request_environment_name=None, pull_request_preview=None, stage=None)

Bases: object

(experimental) Auto branch creation configuration.

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

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

  • build_spec (Optional[BuildSpec]) – (experimental) Build spec for the auto created branch. Default: - application build spec

  • environment_variables (Optional[Mapping[str, str]]) – (experimental) Environment variables for the auto created 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

  • patterns (Optional[Sequence[str]]) – (experimental) Automated branch creation glob patterns. Default: - all repository branches

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

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

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

Stability:

experimental

ExampleMetadata:

infused

Example:

amplify_app = amplify.App(self, "MyApp",
    source_code_provider=amplify.GitHubSourceCodeProvider(
        owner="<user>",
        repository="<repo>",
        oauth_token=SecretValue.secrets_manager("my-github-token")
    ),
    auto_branch_creation=amplify.AutoBranchCreation( # Automatically connect branches that match a pattern set
        patterns=["feature/*", "test/*"]),
    auto_branch_deletion=True
)

Attributes

auto_build

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

Default:

true

Stability:

experimental

basic_auth

(experimental) The Basic Auth configuration.

Use this to set password protection for the auto created branch.

Default:
  • no password protection

Stability:

experimental

build_spec

(experimental) Build spec for the auto created branch.

Default:
  • application build spec

Stability:

experimental

environment_variables

(experimental) Environment variables for the auto created 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

patterns

(experimental) Automated branch creation glob patterns.

Default:
  • all repository branches

Stability:

experimental

pull_request_environment_name

(experimental) The dedicated backend environment for the pull request previews of the auto created branch.

Default:
  • automatically provision a temporary backend

Stability:

experimental

pull_request_preview

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

Default:

true

Stability:

experimental

stage

(experimental) Stage for the auto created branch.

Default:
  • no stage

Stability:

experimental