class Aws::Amplify::Types::UpdateBranchRequest

The request structure for the update branch request.

@note When making an API call, you may pass UpdateBranchRequest

data as a hash:

    {
      app_id: "AppId", # required
      branch_name: "BranchName", # required
      description: "Description",
      framework: "Framework",
      stage: "PRODUCTION", # accepts PRODUCTION, BETA, DEVELOPMENT, EXPERIMENTAL, PULL_REQUEST
      enable_notification: false,
      enable_auto_build: false,
      environment_variables: {
        "EnvKey" => "EnvValue",
      },
      basic_auth_credentials: "BasicAuthCredentials",
      enable_basic_auth: false,
      enable_performance_mode: false,
      build_spec: "BuildSpec",
      ttl: "TTL",
      display_name: "DisplayName",
      enable_pull_request_preview: false,
      pull_request_environment_name: "PullRequestEnvironmentName",
      backend_environment_arn: "BackendEnvironmentArn",
    }

@!attribute [rw] app_id

The unique ID for an Amplify app.
@return [String]

@!attribute [rw] branch_name

The name for the branch.
@return [String]

@!attribute [rw] description

The description for the branch.
@return [String]

@!attribute [rw] framework

The framework for the branch.
@return [String]

@!attribute [rw] stage

Describes the current stage for the branch.
@return [String]

@!attribute [rw] enable_notification

Enables notifications for the branch.
@return [Boolean]

@!attribute [rw] enable_auto_build

Enables auto building for the branch.
@return [Boolean]

@!attribute [rw] environment_variables

The environment variables for the branch.
@return [Hash<String,String>]

@!attribute [rw] basic_auth_credentials

The basic authorization credentials for the branch.
@return [String]

@!attribute [rw] enable_basic_auth

Enables basic authorization for the branch.
@return [Boolean]

@!attribute [rw] enable_performance_mode

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.
@return [Boolean]

@!attribute [rw] build_spec

The build specification (build spec) for the branch.
@return [String]

@!attribute [rw] ttl

The content Time to Live (TTL) for the website in seconds.
@return [String]

@!attribute [rw] display_name

The display name for a branch. This is used as the default domain
prefix.
@return [String]

@!attribute [rw] enable_pull_request_preview

Enables pull request previews for this branch.
@return [Boolean]

@!attribute [rw] pull_request_environment_name

The Amplify environment name for the pull request.
@return [String]

@!attribute [rw] backend_environment_arn

The Amazon Resource Name (ARN) for a backend environment that is
part of an Amplify app.
@return [String]

@see docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/UpdateBranchRequest AWS API Documentation

Constants

SENSITIVE