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

Interface CreateBranchRequest.Builder

    • Method Detail

      • appId

        CreateBranchRequest.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

        CreateBranchRequest.Builder branchName​(String branchName)

        The name for the branch.

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

      • description

        CreateBranchRequest.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.

      • stage

        CreateBranchRequest.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

        CreateBranchRequest.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

      • framework

        CreateBranchRequest.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.

      • enableNotification

        CreateBranchRequest.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

        CreateBranchRequest.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

        CreateBranchRequest.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

        CreateBranchRequest.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

        CreateBranchRequest.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

        CreateBranchRequest.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.

      • tags

        CreateBranchRequest.Builder tags​(Map<String,​String> tags)

        The tag for the branch.

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

      • buildSpec

        CreateBranchRequest.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

        CreateBranchRequest.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

        CreateBranchRequest.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

        CreateBranchRequest.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

        CreateBranchRequest.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

        CreateBranchRequest.Builder backendEnvironmentArn​(String backendEnvironmentArn)

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

        Parameters:
        backendEnvironmentArn - The Amazon Resource Name (ARN) for a backend environment that is part of an Amplify app.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • backend

        CreateBranchRequest.Builder backend​(Backend backend)

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

        Parameters:
        backend - The backend for a Branch of an Amplify app. Use for a backend created from an CloudFormation stack.
        Returns:
        Returns a reference to this object so that method calls can be chained together.