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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb

Overview

The request structure for the update branch request.

Constant Summary collapse

SENSITIVE =
[:basic_auth_credentials, :build_spec]

Instance Attribute Summary collapse

Instance Attribute Details

#app_idString

The unique ID for an Amplify app.

Returns:

  • (String)


2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 2634

class UpdateBranchRequest < Struct.new(
  :app_id,
  :branch_name,
  :description,
  :framework,
  :stage,
  :enable_notification,
  :enable_auto_build,
  :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)
  SENSITIVE = [:basic_auth_credentials, :build_spec]
  include Aws::Structure
end

#backend_environment_arnString

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

Returns:

  • (String)


2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 2634

class UpdateBranchRequest < Struct.new(
  :app_id,
  :branch_name,
  :description,
  :framework,
  :stage,
  :enable_notification,
  :enable_auto_build,
  :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)
  SENSITIVE = [:basic_auth_credentials, :build_spec]
  include Aws::Structure
end

#basic_auth_credentialsString

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

Returns:

  • (String)


2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 2634

class UpdateBranchRequest < Struct.new(
  :app_id,
  :branch_name,
  :description,
  :framework,
  :stage,
  :enable_notification,
  :enable_auto_build,
  :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)
  SENSITIVE = [:basic_auth_credentials, :build_spec]
  include Aws::Structure
end

#branch_nameString

The name for the branch.

Returns:

  • (String)


2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 2634

class UpdateBranchRequest < Struct.new(
  :app_id,
  :branch_name,
  :description,
  :framework,
  :stage,
  :enable_notification,
  :enable_auto_build,
  :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)
  SENSITIVE = [:basic_auth_credentials, :build_spec]
  include Aws::Structure
end

#build_specString

The build specification (build spec) for the branch.

Returns:

  • (String)


2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 2634

class UpdateBranchRequest < Struct.new(
  :app_id,
  :branch_name,
  :description,
  :framework,
  :stage,
  :enable_notification,
  :enable_auto_build,
  :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)
  SENSITIVE = [:basic_auth_credentials, :build_spec]
  include Aws::Structure
end

#descriptionString

The description for the branch.

Returns:

  • (String)


2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 2634

class UpdateBranchRequest < Struct.new(
  :app_id,
  :branch_name,
  :description,
  :framework,
  :stage,
  :enable_notification,
  :enable_auto_build,
  :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)
  SENSITIVE = [:basic_auth_credentials, :build_spec]
  include Aws::Structure
end

#display_nameString

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

Returns:

  • (String)


2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 2634

class UpdateBranchRequest < Struct.new(
  :app_id,
  :branch_name,
  :description,
  :framework,
  :stage,
  :enable_notification,
  :enable_auto_build,
  :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)
  SENSITIVE = [:basic_auth_credentials, :build_spec]
  include Aws::Structure
end

#enable_auto_buildBoolean

Enables auto building for the branch.

Returns:

  • (Boolean)


2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 2634

class UpdateBranchRequest < Struct.new(
  :app_id,
  :branch_name,
  :description,
  :framework,
  :stage,
  :enable_notification,
  :enable_auto_build,
  :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)
  SENSITIVE = [:basic_auth_credentials, :build_spec]
  include Aws::Structure
end

#enable_basic_authBoolean

Enables basic authorization for the branch.

Returns:

  • (Boolean)


2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 2634

class UpdateBranchRequest < Struct.new(
  :app_id,
  :branch_name,
  :description,
  :framework,
  :stage,
  :enable_notification,
  :enable_auto_build,
  :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)
  SENSITIVE = [:basic_auth_credentials, :build_spec]
  include Aws::Structure
end

#enable_notificationBoolean

Enables notifications for the branch.

Returns:

  • (Boolean)


2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 2634

class UpdateBranchRequest < Struct.new(
  :app_id,
  :branch_name,
  :description,
  :framework,
  :stage,
  :enable_notification,
  :enable_auto_build,
  :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)
  SENSITIVE = [:basic_auth_credentials, :build_spec]
  include Aws::Structure
end

#enable_performance_modeBoolean

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)


2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 2634

class UpdateBranchRequest < Struct.new(
  :app_id,
  :branch_name,
  :description,
  :framework,
  :stage,
  :enable_notification,
  :enable_auto_build,
  :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)
  SENSITIVE = [:basic_auth_credentials, :build_spec]
  include Aws::Structure
end

#enable_pull_request_previewBoolean

Enables pull request previews for this branch.

Returns:

  • (Boolean)


2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 2634

class UpdateBranchRequest < Struct.new(
  :app_id,
  :branch_name,
  :description,
  :framework,
  :stage,
  :enable_notification,
  :enable_auto_build,
  :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)
  SENSITIVE = [:basic_auth_credentials, :build_spec]
  include Aws::Structure
end

#environment_variablesHash<String,String>

The environment variables for the branch.

Returns:

  • (Hash<String,String>)


2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 2634

class UpdateBranchRequest < Struct.new(
  :app_id,
  :branch_name,
  :description,
  :framework,
  :stage,
  :enable_notification,
  :enable_auto_build,
  :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)
  SENSITIVE = [:basic_auth_credentials, :build_spec]
  include Aws::Structure
end

#frameworkString

The framework for the branch.

Returns:

  • (String)


2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 2634

class UpdateBranchRequest < Struct.new(
  :app_id,
  :branch_name,
  :description,
  :framework,
  :stage,
  :enable_notification,
  :enable_auto_build,
  :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)
  SENSITIVE = [:basic_auth_credentials, :build_spec]
  include Aws::Structure
end

#pull_request_environment_nameString

The Amplify environment name for the pull request.

Returns:

  • (String)


2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 2634

class UpdateBranchRequest < Struct.new(
  :app_id,
  :branch_name,
  :description,
  :framework,
  :stage,
  :enable_notification,
  :enable_auto_build,
  :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)
  SENSITIVE = [:basic_auth_credentials, :build_spec]
  include Aws::Structure
end

#stageString

Describes the current stage for the branch.

Returns:

  • (String)


2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 2634

class UpdateBranchRequest < Struct.new(
  :app_id,
  :branch_name,
  :description,
  :framework,
  :stage,
  :enable_notification,
  :enable_auto_build,
  :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)
  SENSITIVE = [:basic_auth_credentials, :build_spec]
  include Aws::Structure
end

#ttlString

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

Returns:

  • (String)


2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 2634

class UpdateBranchRequest < Struct.new(
  :app_id,
  :branch_name,
  :description,
  :framework,
  :stage,
  :enable_notification,
  :enable_auto_build,
  :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)
  SENSITIVE = [:basic_auth_credentials, :build_spec]
  include Aws::Structure
end