Skip to content

AutoBranchCreationConfig

Source code in docs_src/capo_amplify/types/auto_branch_creation_config.py
class AutoBranchCreationConfig(TypedDict, closed=True):
    stage: NotRequired["capo_amplify.types.stage.Stage"]
    """<p>Describes the current stage for the autocreated branch. </p>"""
    framework: NotRequired["capo_amplify.types.framework.Framework"]
    """<p>The framework for the autocreated branch. </p>"""
    enable_auto_build: NotRequired[
        "capo_amplify.types.enable_auto_build.EnableAutoBuild"
    ]
    """<p>Enables auto building for the autocreated branch. </p>"""
    environment_variables: NotRequired[
        "capo_amplify.types.environment_variables.EnvironmentVariables"
    ]
    """<p>The environment variables for the autocreated branch. </p>"""
    basic_auth_credentials: NotRequired[
        "capo_amplify.types.basic_auth_credentials.BasicAuthCredentials"
    ]
    """<p>The basic authorization credentials for the autocreated branch. You must base64-encode the authorization credentials and provide them in the format <code>user:password</code>.</p>"""
    enable_basic_auth: NotRequired[
        "capo_amplify.types.enable_basic_auth.EnableBasicAuth"
    ]
    """<p>Enables basic authorization for the autocreated branch. </p>"""
    enable_performance_mode: NotRequired[
        "capo_amplify.types.enable_performance_mode.EnablePerformanceMode"
    ]
    """<p>Enables performance mode for the branch.</p> <p>Performance mode optimizes for faster hosting performance by keeping content cached at the edge for a longer interval. When performance mode is enabled, hosting configuration or code changes can take up to 10 minutes to roll out. </p>"""
    build_spec: NotRequired["capo_amplify.types.build_spec.BuildSpec"]
    """<p>The build specification (build spec) for the autocreated branch. </p>"""
    enable_pull_request_preview: NotRequired[
        "capo_amplify.types.enable_pull_request_preview.EnablePullRequestPreview"
    ]
    """<p>Enables pull request previews for the autocreated branch. </p>"""
    pull_request_environment_name: NotRequired[
        "capo_amplify.types.pull_request_environment_name.PullRequestEnvironmentName"
    ]
    """<p>The Amplify environment name for the pull request. </p>"""

basic_auth_credentials instance-attribute

basic_auth_credentials: NotRequired[BasicAuthCredentials]

The basic authorization credentials for the autocreated branch. You must base64-encode the authorization credentials and provide them in the format user:password.

build_spec instance-attribute

build_spec: NotRequired[BuildSpec]

The build specification (build spec) for the autocreated branch.

enable_auto_build instance-attribute

enable_auto_build: NotRequired[EnableAutoBuild]

Enables auto building for the autocreated branch.

enable_basic_auth instance-attribute

enable_basic_auth: NotRequired[EnableBasicAuth]

Enables basic authorization for the autocreated branch.

enable_performance_mode instance-attribute

enable_performance_mode: NotRequired[EnablePerformanceMode]

Enables performance mode for the branch.

Performance mode optimizes for faster hosting performance by keeping content cached at the edge for a longer interval. When performance mode is enabled, hosting configuration or code changes can take up to 10 minutes to roll out.

enable_pull_request_preview instance-attribute

enable_pull_request_preview: NotRequired[EnablePullRequestPreview]

Enables pull request previews for the autocreated branch.

environment_variables instance-attribute

environment_variables: NotRequired[EnvironmentVariables]

The environment variables for the autocreated branch.

framework instance-attribute

framework: NotRequired[Framework]

The framework for the autocreated branch.

pull_request_environment_name instance-attribute

pull_request_environment_name: NotRequired[PullRequestEnvironmentName]

The Amplify environment name for the pull request.

stage instance-attribute

stage: NotRequired[Stage]

Describes the current stage for the autocreated branch.