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

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

Overview

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",
}

The request structure for the update branch request.

Constant Summary collapse

SENSITIVE =
[:basic_auth_credentials]

Instance Attribute Summary collapse

Instance Attribute Details

#app_idString

The unique ID for an Amplify app.

Returns:

  • (String)


2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 2989

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]
  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)


2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 2989

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]
  include Aws::Structure
end

#basic_auth_credentialsString

The basic authorization credentials for the branch.

Returns:

  • (String)


2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 2989

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]
  include Aws::Structure
end

#branch_nameString

The name for the branch.

Returns:

  • (String)


2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 2989

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]
  include Aws::Structure
end

#build_specString

The build specification (build spec) for the branch.

Returns:

  • (String)


2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 2989

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]
  include Aws::Structure
end

#descriptionString

The description for the branch.

Returns:

  • (String)


2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 2989

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]
  include Aws::Structure
end

#display_nameString

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

Returns:

  • (String)


2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 2989

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]
  include Aws::Structure
end

#enable_auto_buildBoolean

Enables auto building for the branch.

Returns:

  • (Boolean)


2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 2989

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]
  include Aws::Structure
end

#enable_basic_authBoolean

Enables basic authorization for the branch.

Returns:

  • (Boolean)


2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 2989

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]
  include Aws::Structure
end

#enable_notificationBoolean

Enables notifications for the branch.

Returns:

  • (Boolean)


2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 2989

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]
  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)


2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 2989

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]
  include Aws::Structure
end

#enable_pull_request_previewBoolean

Enables pull request previews for this branch.

Returns:

  • (Boolean)


2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 2989

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]
  include Aws::Structure
end

#environment_variablesHash<String,String>

The environment variables for the branch.

Returns:

  • (Hash<String,String>)


2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 2989

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]
  include Aws::Structure
end

#frameworkString

The framework for the branch.

Returns:

  • (String)


2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 2989

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]
  include Aws::Structure
end

#pull_request_environment_nameString

The Amplify environment name for the pull request.

Returns:

  • (String)


2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 2989

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]
  include Aws::Structure
end

#stageString

Describes the current stage for the branch.

Returns:

  • (String)


2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 2989

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]
  include Aws::Structure
end

#ttlString

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

Returns:

  • (String)


2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 2989

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]
  include Aws::Structure
end