Class: Aws::Amplify::Types::UpdateBranchRequest

Inherits:

Struct

• Object
• Struct
• Aws::Amplify::Types::UpdateBranchRequest

Defined in:

gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb

Overview

The request structure for the update branch request.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:basic_auth_credentials, :build_spec]

Instance Attribute Summary

• #app_id ⇒ String

  The unique ID for an Amplify app.

• #backend ⇒ Types::Backend

  The backend for a Branch of an Amplify app.

• #backend_environment_arn ⇒ String

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

• #basic_auth_credentials ⇒ String

  The basic authorization credentials for the branch.

• #branch_name ⇒ String

  The name of the branch.

• #build_spec ⇒ String

  The build specification (build spec) for the branch.

• #compute_role_arn ⇒ String

  The Amazon Resource Name (ARN) of the IAM role to assign to a branch of an SSR app.

• #description ⇒ String

  The description for the branch.

• #display_name ⇒ String

  The display name for a branch.

• #enable_auto_build ⇒ Boolean

  Enables auto building for the branch.

• #enable_basic_auth ⇒ Boolean

  Enables basic authorization for the branch.

• #enable_notification ⇒ Boolean

  Enables notifications for the branch.

• #enable_performance_mode ⇒ Boolean

  Enables performance mode for the branch.

• #enable_pull_request_preview ⇒ Boolean

  Enables pull request previews for this branch.

• #enable_skew_protection ⇒ Boolean

  Specifies whether the skew protection feature is enabled for the branch.

• #environment_variables ⇒ Hash<String,String>

  The environment variables for the branch.

• #framework ⇒ String

  The framework for the branch.

• #pull_request_environment_name ⇒ String

  The Amplify environment name for the pull request.

• #stage ⇒ String

  Describes the current stage for the branch.

• #ttl ⇒ String

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

Instance Attribute Details

#app_id ⇒ String

The unique ID for an Amplify app.

Returns:

• (String)

# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 3100

class UpdateBranchRequest < Struct.new(
  :app_id,
  :branch_name,
  :description,
  :framework,
  :stage,
  :enable_notification,
  :enable_auto_build,
  :enable_skew_protection,
  :environment_variables,
  :basic_auth_credentials,
  :enable_basic_auth,
  :enable_performance_mode,
  :build_spec,
  :ttl,
  :display_name,
  :enable_pull_request_preview,
  :pull_request_environment_name,
  :backend_environment_arn,
  :backend,
  :compute_role_arn)
  SENSITIVE = [:basic_auth_credentials, :build_spec]
  include Aws::Structure
end

#backend ⇒ Types::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:

• (Types::Backend)

# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 3100

class UpdateBranchRequest < Struct.new(
  :app_id,
  :branch_name,
  :description,
  :framework,
  :stage,
  :enable_notification,
  :enable_auto_build,
  :enable_skew_protection,
  :environment_variables,
  :basic_auth_credentials,
  :enable_basic_auth,
  :enable_performance_mode,
  :build_spec,
  :ttl,
  :display_name,
  :enable_pull_request_preview,
  :pull_request_environment_name,
  :backend_environment_arn,
  :backend,
  :compute_role_arn)
  SENSITIVE = [:basic_auth_credentials, :build_spec]
  include Aws::Structure
end

#backend_environment_arn ⇒ String

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:

• (String)

# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 3100

class UpdateBranchRequest < Struct.new(
  :app_id,
  :branch_name,
  :description,
  :framework,
  :stage,
  :enable_notification,
  :enable_auto_build,
  :enable_skew_protection,
  :environment_variables,
  :basic_auth_credentials,
  :enable_basic_auth,
  :enable_performance_mode,
  :build_spec,
  :ttl,
  :display_name,
  :enable_pull_request_preview,
  :pull_request_environment_name,
  :backend_environment_arn,
  :backend,
  :compute_role_arn)
  SENSITIVE = [:basic_auth_credentials, :build_spec]
  include Aws::Structure
end

#basic_auth_credentials ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 3100

class UpdateBranchRequest < Struct.new(
  :app_id,
  :branch_name,
  :description,
  :framework,
  :stage,
  :enable_notification,
  :enable_auto_build,
  :enable_skew_protection,
  :environment_variables,
  :basic_auth_credentials,
  :enable_basic_auth,
  :enable_performance_mode,
  :build_spec,
  :ttl,
  :display_name,
  :enable_pull_request_preview,
  :pull_request_environment_name,
  :backend_environment_arn,
  :backend,
  :compute_role_arn)
  SENSITIVE = [:basic_auth_credentials, :build_spec]
  include Aws::Structure
end

#branch_name ⇒ String

The name of the branch.

Returns:

• (String)

# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 3100

class UpdateBranchRequest < Struct.new(
  :app_id,
  :branch_name,
  :description,
  :framework,
  :stage,
  :enable_notification,
  :enable_auto_build,
  :enable_skew_protection,
  :environment_variables,
  :basic_auth_credentials,
  :enable_basic_auth,
  :enable_performance_mode,
  :build_spec,
  :ttl,
  :display_name,
  :enable_pull_request_preview,
  :pull_request_environment_name,
  :backend_environment_arn,
  :backend,
  :compute_role_arn)
  SENSITIVE = [:basic_auth_credentials, :build_spec]
  include Aws::Structure
end

#build_spec ⇒ String

The build specification (build spec) for the branch.

Returns:

• (String)

# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 3100

class UpdateBranchRequest < Struct.new(
  :app_id,
  :branch_name,
  :description,
  :framework,
  :stage,
  :enable_notification,
  :enable_auto_build,
  :enable_skew_protection,
  :environment_variables,
  :basic_auth_credentials,
  :enable_basic_auth,
  :enable_performance_mode,
  :build_spec,
  :ttl,
  :display_name,
  :enable_pull_request_preview,
  :pull_request_environment_name,
  :backend_environment_arn,
  :backend,
  :compute_role_arn)
  SENSITIVE = [:basic_auth_credentials, :build_spec]
  include Aws::Structure
end

#compute_role_arn ⇒ String

The Amazon Resource Name (ARN) of the IAM role to assign to a branch of an SSR app. The SSR Compute role allows the Amplify Hosting compute service to securely access specific Amazon Web Services resources based on the role's permissions. For more information about the SSR Compute role, see Adding an SSR Compute role in the Amplify User Guide.

Returns:

• (String)

# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 3100

class UpdateBranchRequest < Struct.new(
  :app_id,
  :branch_name,
  :description,
  :framework,
  :stage,
  :enable_notification,
  :enable_auto_build,
  :enable_skew_protection,
  :environment_variables,
  :basic_auth_credentials,
  :enable_basic_auth,
  :enable_performance_mode,
  :build_spec,
  :ttl,
  :display_name,
  :enable_pull_request_preview,
  :pull_request_environment_name,
  :backend_environment_arn,
  :backend,
  :compute_role_arn)
  SENSITIVE = [:basic_auth_credentials, :build_spec]
  include Aws::Structure
end

#description ⇒ String

The description for the branch.

Returns:

• (String)

# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 3100

class UpdateBranchRequest < Struct.new(
  :app_id,
  :branch_name,
  :description,
  :framework,
  :stage,
  :enable_notification,
  :enable_auto_build,
  :enable_skew_protection,
  :environment_variables,
  :basic_auth_credentials,
  :enable_basic_auth,
  :enable_performance_mode,
  :build_spec,
  :ttl,
  :display_name,
  :enable_pull_request_preview,
  :pull_request_environment_name,
  :backend_environment_arn,
  :backend,
  :compute_role_arn)
  SENSITIVE = [:basic_auth_credentials, :build_spec]
  include Aws::Structure
end

#display_name ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 3100

class UpdateBranchRequest < Struct.new(
  :app_id,
  :branch_name,
  :description,
  :framework,
  :stage,
  :enable_notification,
  :enable_auto_build,
  :enable_skew_protection,
  :environment_variables,
  :basic_auth_credentials,
  :enable_basic_auth,
  :enable_performance_mode,
  :build_spec,
  :ttl,
  :display_name,
  :enable_pull_request_preview,
  :pull_request_environment_name,
  :backend_environment_arn,
  :backend,
  :compute_role_arn)
  SENSITIVE = [:basic_auth_credentials, :build_spec]
  include Aws::Structure
end

#enable_auto_build ⇒ Boolean

Enables auto building for the branch.

Returns:

• (Boolean)

# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 3100

class UpdateBranchRequest < Struct.new(
  :app_id,
  :branch_name,
  :description,
  :framework,
  :stage,
  :enable_notification,
  :enable_auto_build,
  :enable_skew_protection,
  :environment_variables,
  :basic_auth_credentials,
  :enable_basic_auth,
  :enable_performance_mode,
  :build_spec,
  :ttl,
  :display_name,
  :enable_pull_request_preview,
  :pull_request_environment_name,
  :backend_environment_arn,
  :backend,
  :compute_role_arn)
  SENSITIVE = [:basic_auth_credentials, :build_spec]
  include Aws::Structure
end

#enable_basic_auth ⇒ Boolean

Enables basic authorization for the branch.

Returns:

• (Boolean)

# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 3100

class UpdateBranchRequest < Struct.new(
  :app_id,
  :branch_name,
  :description,
  :framework,
  :stage,
  :enable_notification,
  :enable_auto_build,
  :enable_skew_protection,
  :environment_variables,
  :basic_auth_credentials,
  :enable_basic_auth,
  :enable_performance_mode,
  :build_spec,
  :ttl,
  :display_name,
  :enable_pull_request_preview,
  :pull_request_environment_name,
  :backend_environment_arn,
  :backend,
  :compute_role_arn)
  SENSITIVE = [:basic_auth_credentials, :build_spec]
  include Aws::Structure
end

#enable_notification ⇒ Boolean

Enables notifications for the branch.

Returns:

• (Boolean)

# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 3100

class UpdateBranchRequest < Struct.new(
  :app_id,
  :branch_name,
  :description,
  :framework,
  :stage,
  :enable_notification,
  :enable_auto_build,
  :enable_skew_protection,
  :environment_variables,
  :basic_auth_credentials,
  :enable_basic_auth,
  :enable_performance_mode,
  :build_spec,
  :ttl,
  :display_name,
  :enable_pull_request_preview,
  :pull_request_environment_name,
  :backend_environment_arn,
  :backend,
  :compute_role_arn)
  SENSITIVE = [:basic_auth_credentials, :build_spec]
  include Aws::Structure
end

#enable_performance_mode ⇒ Boolean

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:

• (Boolean)

# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 3100

class UpdateBranchRequest < Struct.new(
  :app_id,
  :branch_name,
  :description,
  :framework,
  :stage,
  :enable_notification,
  :enable_auto_build,
  :enable_skew_protection,
  :environment_variables,
  :basic_auth_credentials,
  :enable_basic_auth,
  :enable_performance_mode,
  :build_spec,
  :ttl,
  :display_name,
  :enable_pull_request_preview,
  :pull_request_environment_name,
  :backend_environment_arn,
  :backend,
  :compute_role_arn)
  SENSITIVE = [:basic_auth_credentials, :build_spec]
  include Aws::Structure
end

#enable_pull_request_preview ⇒ Boolean

Enables pull request previews for this branch.

Returns:

• (Boolean)

# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 3100

class UpdateBranchRequest < Struct.new(
  :app_id,
  :branch_name,
  :description,
  :framework,
  :stage,
  :enable_notification,
  :enable_auto_build,
  :enable_skew_protection,
  :environment_variables,
  :basic_auth_credentials,
  :enable_basic_auth,
  :enable_performance_mode,
  :build_spec,
  :ttl,
  :display_name,
  :enable_pull_request_preview,
  :pull_request_environment_name,
  :backend_environment_arn,
  :backend,
  :compute_role_arn)
  SENSITIVE = [:basic_auth_credentials, :build_spec]
  include Aws::Structure
end

#enable_skew_protection ⇒ Boolean

Specifies whether the skew protection feature is enabled for the branch.

Deployment skew protection is available to Amplify applications to eliminate version skew issues between client and servers in web applications. When you apply skew protection to a branch, you can ensure that your clients always interact with the correct version of server-side assets, regardless of when a deployment occurs. For more information about skew protection, see Skew protection for Amplify deployments in the Amplify User Guide.

Returns:

• (Boolean)

# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 3100

class UpdateBranchRequest < Struct.new(
  :app_id,
  :branch_name,
  :description,
  :framework,
  :stage,
  :enable_notification,
  :enable_auto_build,
  :enable_skew_protection,
  :environment_variables,
  :basic_auth_credentials,
  :enable_basic_auth,
  :enable_performance_mode,
  :build_spec,
  :ttl,
  :display_name,
  :enable_pull_request_preview,
  :pull_request_environment_name,
  :backend_environment_arn,
  :backend,
  :compute_role_arn)
  SENSITIVE = [:basic_auth_credentials, :build_spec]
  include Aws::Structure
end

#environment_variables ⇒ Hash<String,String>

The environment variables for the branch.

Returns:

• (Hash<String,String>)

# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 3100

class UpdateBranchRequest < Struct.new(
  :app_id,
  :branch_name,
  :description,
  :framework,
  :stage,
  :enable_notification,
  :enable_auto_build,
  :enable_skew_protection,
  :environment_variables,
  :basic_auth_credentials,
  :enable_basic_auth,
  :enable_performance_mode,
  :build_spec,
  :ttl,
  :display_name,
  :enable_pull_request_preview,
  :pull_request_environment_name,
  :backend_environment_arn,
  :backend,
  :compute_role_arn)
  SENSITIVE = [:basic_auth_credentials, :build_spec]
  include Aws::Structure
end

#framework ⇒ String

The framework for the branch.

Returns:

• (String)

# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 3100

class UpdateBranchRequest < Struct.new(
  :app_id,
  :branch_name,
  :description,
  :framework,
  :stage,
  :enable_notification,
  :enable_auto_build,
  :enable_skew_protection,
  :environment_variables,
  :basic_auth_credentials,
  :enable_basic_auth,
  :enable_performance_mode,
  :build_spec,
  :ttl,
  :display_name,
  :enable_pull_request_preview,
  :pull_request_environment_name,
  :backend_environment_arn,
  :backend,
  :compute_role_arn)
  SENSITIVE = [:basic_auth_credentials, :build_spec]
  include Aws::Structure
end

#pull_request_environment_name ⇒ String

The Amplify environment name for the pull request.

Returns:

• (String)

# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 3100

class UpdateBranchRequest < Struct.new(
  :app_id,
  :branch_name,
  :description,
  :framework,
  :stage,
  :enable_notification,
  :enable_auto_build,
  :enable_skew_protection,
  :environment_variables,
  :basic_auth_credentials,
  :enable_basic_auth,
  :enable_performance_mode,
  :build_spec,
  :ttl,
  :display_name,
  :enable_pull_request_preview,
  :pull_request_environment_name,
  :backend_environment_arn,
  :backend,
  :compute_role_arn)
  SENSITIVE = [:basic_auth_credentials, :build_spec]
  include Aws::Structure
end

#stage ⇒ String

Describes the current stage for the branch.

Returns:

• (String)

# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 3100

class UpdateBranchRequest < Struct.new(
  :app_id,
  :branch_name,
  :description,
  :framework,
  :stage,
  :enable_notification,
  :enable_auto_build,
  :enable_skew_protection,
  :environment_variables,
  :basic_auth_credentials,
  :enable_basic_auth,
  :enable_performance_mode,
  :build_spec,
  :ttl,
  :display_name,
  :enable_pull_request_preview,
  :pull_request_environment_name,
  :backend_environment_arn,
  :backend,
  :compute_role_arn)
  SENSITIVE = [:basic_auth_credentials, :build_spec]
  include Aws::Structure
end

#ttl ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 3100

class UpdateBranchRequest < Struct.new(
  :app_id,
  :branch_name,
  :description,
  :framework,
  :stage,
  :enable_notification,
  :enable_auto_build,
  :enable_skew_protection,
  :environment_variables,
  :basic_auth_credentials,
  :enable_basic_auth,
  :enable_performance_mode,
  :build_spec,
  :ttl,
  :display_name,
  :enable_pull_request_preview,
  :pull_request_environment_name,
  :backend_environment_arn,
  :backend,
  :compute_role_arn)
  SENSITIVE = [:basic_auth_credentials, :build_spec]
  include Aws::Structure
end