Package software.amazon.awssdk.services.amplify.model

Interface UpdateBranchRequest.Builder

    • Method Detail

      • appId

        UpdateBranchRequest.Builder appId​(String appId)

        The unique ID for an Amplify app.

        Parameters:
        appId - The unique ID for an Amplify app.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • branchName

        UpdateBranchRequest.Builder branchName​(String branchName)

        The name of the branch.

        Parameters:
        branchName - The name of the branch.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • description

        UpdateBranchRequest.Builder description​(String description)

        The description for the branch.

        Parameters:
        description - The description for the branch.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • framework

        UpdateBranchRequest.Builder framework​(String framework)

        The framework for the branch.

        Parameters:
        framework - The framework for the branch.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • stage

        UpdateBranchRequest.Builder stage​(String stage)

        Describes the current stage for the branch.

        Parameters:
        stage - Describes the current stage for the branch.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        Stage, Stage

      • stage

        UpdateBranchRequest.Builder stage​(Stage stage)

        Describes the current stage for the branch.

        Parameters:
        stage - Describes the current stage for the branch.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        Stage, Stage

      • enableNotification

        UpdateBranchRequest.Builder enableNotification​(Boolean enableNotification)

        Enables notifications for the branch.

        Parameters:
        enableNotification - Enables notifications for the branch.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • enableAutoBuild

        UpdateBranchRequest.Builder enableAutoBuild​(Boolean enableAutoBuild)

        Enables auto building for the branch.

        Parameters:
        enableAutoBuild - Enables auto building for the branch.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • environmentVariables

        UpdateBranchRequest.Builder environmentVariables​(Map<String,​String> environmentVariables)

        The environment variables for the branch.

        Parameters:
        environmentVariables - The environment variables for the branch.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • basicAuthCredentials

        UpdateBranchRequest.Builder basicAuthCredentials​(String basicAuthCredentials)

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

        Parameters:
        basicAuthCredentials - The basic authorization credentials for the branch. You must base64-encode the authorization credentials and provide them in the format user:password.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • enableBasicAuth

        UpdateBranchRequest.Builder enableBasicAuth​(Boolean enableBasicAuth)

        Enables basic authorization for the branch.

        Parameters:
        enableBasicAuth - Enables basic authorization for the branch.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • enablePerformanceMode

        UpdateBranchRequest.Builder enablePerformanceMode​(Boolean 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.

        Parameters:
        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.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • buildSpec

        UpdateBranchRequest.Builder buildSpec​(String buildSpec)

        The build specification (build spec) for the branch.

        Parameters:
        buildSpec - The build specification (build spec) for the branch.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • ttl

        UpdateBranchRequest.Builder ttl​(String ttl)

        The content Time to Live (TTL) for the website in seconds.

        Parameters:
        ttl - The content Time to Live (TTL) for the website in seconds.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • displayName

        UpdateBranchRequest.Builder displayName​(String displayName)

        The display name for a branch. This is used as the default domain prefix.

        Parameters:
        displayName - The display name for a branch. This is used as the default domain prefix.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • enablePullRequestPreview

        UpdateBranchRequest.Builder enablePullRequestPreview​(Boolean enablePullRequestPreview)

        Enables pull request previews for this branch.

        Parameters:
        enablePullRequestPreview - Enables pull request previews for this branch.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • pullRequestEnvironmentName

        UpdateBranchRequest.Builder pullRequestEnvironmentName​(String pullRequestEnvironmentName)

        The Amplify environment name for the pull request.

        Parameters:
        pullRequestEnvironmentName - The Amplify environment name for the pull request.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • backendEnvironmentArn

        UpdateBranchRequest.Builder backendEnvironmentArn​(String backendEnvironmentArn)

        The Amazon Resource Name (ARN) for a backend environment that is part of a Gen 1 Amplify app.

        This field is available to Amplify Gen 1 apps only where the backend is created using Amplify Studio or the Amplify command line interface (CLI).

        Parameters:
        backendEnvironmentArn - The Amazon Resource Name (ARN) for a backend environment that is part of a Gen 1 Amplify app.

        This field is available to Amplify Gen 1 apps only where the backend is created using Amplify Studio or the Amplify command line interface (CLI).

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • backend

        UpdateBranchRequest.Builder backend​(Backend backend)

        The backend for a Branch of an Amplify app. Use for a backend created from an CloudFormation stack.

        This field is available to Amplify Gen 2 apps only. When you deploy an application with Amplify Gen 2, you provision the app's backend infrastructure using Typescript code.

        Parameters:
        backend - The backend for a Branch of an Amplify app. Use for a backend created from an CloudFormation stack.

        This field is available to Amplify Gen 2 apps only. When you deploy an application with Amplify Gen 2, you provision the app's backend infrastructure using Typescript code.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • backend

        default UpdateBranchRequest.Builder backend​(Consumer<Backend.Builder> backend)

        The backend for a Branch of an Amplify app. Use for a backend created from an CloudFormation stack.

        This field is available to Amplify Gen 2 apps only. When you deploy an application with Amplify Gen 2, you provision the app's backend infrastructure using Typescript code.

        This is a convenience method that creates an instance of the Backend.Builder avoiding the need to create one manually via Backend.builder().

        When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to backend(Backend).

        Parameters:
        backend - a consumer that will call methods on Backend.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        backend(Backend)