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
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",
}
The request structure for the update branch request.
Constant Summary collapse
- SENSITIVE =
[:basic_auth_credentials, :build_spec]
Instance Attribute Summary collapse
-
#app_id ⇒ String
The unique ID for an Amplify app.
-
#backend_environment_arn ⇒ String
The Amazon Resource Name (ARN) for a backend environment that is part of an Amplify app.
-
#basic_auth_credentials ⇒ String
The basic authorization credentials for the branch.
-
#branch_name ⇒ String
The name for the branch.
-
#build_spec ⇒ String
The build specification (build spec) for the branch.
-
#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.
-
#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.
3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 3107 3108 3109 |
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 3089 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_arn ⇒ String
The Amazon Resource Name (ARN) for a backend environment that is part of an Amplify app.
3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 3107 3108 3109 |
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 3089 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_credentials ⇒ String
The basic authorization credentials for the branch. You must
base64-encode the authorization credentials and provide them in the
format user:password
.
3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 3107 3108 3109 |
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 3089 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_name ⇒ String
The name for the branch.
3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 3107 3108 3109 |
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 3089 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_spec ⇒ String
The build specification (build spec) for the branch.
3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 3107 3108 3109 |
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 3089 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 |
#description ⇒ String
The description for the branch.
3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 3107 3108 3109 |
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 3089 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_name ⇒ String
The display name for a branch. This is used as the default domain prefix.
3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 3107 3108 3109 |
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 3089 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_build ⇒ Boolean
Enables auto building for the branch.
3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 3107 3108 3109 |
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 3089 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_auth ⇒ Boolean
Enables basic authorization for the branch.
3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 3107 3108 3109 |
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 3089 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_notification ⇒ Boolean
Enables notifications for the branch.
3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 3107 3108 3109 |
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 3089 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_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.
3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 3107 3108 3109 |
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 3089 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_preview ⇒ Boolean
Enables pull request previews for this branch.
3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 3107 3108 3109 |
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 3089 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_variables ⇒ Hash<String,String>
The environment variables for the branch.
3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 3107 3108 3109 |
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 3089 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 |
#framework ⇒ String
The framework for the branch.
3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 3107 3108 3109 |
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 3089 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_name ⇒ String
The Amplify environment name for the pull request.
3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 3107 3108 3109 |
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 3089 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 |
#stage ⇒ String
Describes the current stage for the branch.
3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 3107 3108 3109 |
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 3089 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 |
#ttl ⇒ String
The content Time to Live (TTL) for the website in seconds.
3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 3107 3108 3109 |
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 3089 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 |