You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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,
  build_spec: "BuildSpec",
  ttl: "TTL",
  display_name: "DisplayName",
  enable_pull_request_preview: false,
  pull_request_environment_name: "PullRequestEnvironmentName",
  backend_environment_arn: "BackendEnvironmentArn",
}

Request structure for update branch request.

Instance Attribute Summary collapse

Instance Attribute Details

#app_idString

Unique Id for an Amplify App.

Returns:

  • (String)


2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 2746

class UpdateBranchRequest < Struct.new(
  :app_id,
  :branch_name,
  :description,
  :framework,
  :stage,
  :enable_notification,
  :enable_auto_build,
  :environment_variables,
  :basic_auth_credentials,
  :enable_basic_auth,
  :build_spec,
  :ttl,
  :display_name,
  :enable_pull_request_preview,
  :pull_request_environment_name,
  :backend_environment_arn)
  include Aws::Structure
end

#backend_environment_arnString

ARN for a Backend Environment, part of an Amplify App.

Returns:

  • (String)


2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 2746

class UpdateBranchRequest < Struct.new(
  :app_id,
  :branch_name,
  :description,
  :framework,
  :stage,
  :enable_notification,
  :enable_auto_build,
  :environment_variables,
  :basic_auth_credentials,
  :enable_basic_auth,
  :build_spec,
  :ttl,
  :display_name,
  :enable_pull_request_preview,
  :pull_request_environment_name,
  :backend_environment_arn)
  include Aws::Structure
end

#basic_auth_credentialsString

Basic Authorization credentials for the branch.

Returns:

  • (String)


2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 2746

class UpdateBranchRequest < Struct.new(
  :app_id,
  :branch_name,
  :description,
  :framework,
  :stage,
  :enable_notification,
  :enable_auto_build,
  :environment_variables,
  :basic_auth_credentials,
  :enable_basic_auth,
  :build_spec,
  :ttl,
  :display_name,
  :enable_pull_request_preview,
  :pull_request_environment_name,
  :backend_environment_arn)
  include Aws::Structure
end

#branch_nameString

Name for the branch.

Returns:

  • (String)


2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 2746

class UpdateBranchRequest < Struct.new(
  :app_id,
  :branch_name,
  :description,
  :framework,
  :stage,
  :enable_notification,
  :enable_auto_build,
  :environment_variables,
  :basic_auth_credentials,
  :enable_basic_auth,
  :build_spec,
  :ttl,
  :display_name,
  :enable_pull_request_preview,
  :pull_request_environment_name,
  :backend_environment_arn)
  include Aws::Structure
end

#build_specString

BuildSpec for the branch.

Returns:

  • (String)


2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 2746

class UpdateBranchRequest < Struct.new(
  :app_id,
  :branch_name,
  :description,
  :framework,
  :stage,
  :enable_notification,
  :enable_auto_build,
  :environment_variables,
  :basic_auth_credentials,
  :enable_basic_auth,
  :build_spec,
  :ttl,
  :display_name,
  :enable_pull_request_preview,
  :pull_request_environment_name,
  :backend_environment_arn)
  include Aws::Structure
end

#descriptionString

Description for the branch.

Returns:

  • (String)


2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 2746

class UpdateBranchRequest < Struct.new(
  :app_id,
  :branch_name,
  :description,
  :framework,
  :stage,
  :enable_notification,
  :enable_auto_build,
  :environment_variables,
  :basic_auth_credentials,
  :enable_basic_auth,
  :build_spec,
  :ttl,
  :display_name,
  :enable_pull_request_preview,
  :pull_request_environment_name,
  :backend_environment_arn)
  include Aws::Structure
end

#display_nameString

Display name for a branch, will use as the default domain prefix.

Returns:

  • (String)


2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 2746

class UpdateBranchRequest < Struct.new(
  :app_id,
  :branch_name,
  :description,
  :framework,
  :stage,
  :enable_notification,
  :enable_auto_build,
  :environment_variables,
  :basic_auth_credentials,
  :enable_basic_auth,
  :build_spec,
  :ttl,
  :display_name,
  :enable_pull_request_preview,
  :pull_request_environment_name,
  :backend_environment_arn)
  include Aws::Structure
end

#enable_auto_buildBoolean

Enables auto building for the branch.

Returns:

  • (Boolean)


2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 2746

class UpdateBranchRequest < Struct.new(
  :app_id,
  :branch_name,
  :description,
  :framework,
  :stage,
  :enable_notification,
  :enable_auto_build,
  :environment_variables,
  :basic_auth_credentials,
  :enable_basic_auth,
  :build_spec,
  :ttl,
  :display_name,
  :enable_pull_request_preview,
  :pull_request_environment_name,
  :backend_environment_arn)
  include Aws::Structure
end

#enable_basic_authBoolean

Enables Basic Auth for the branch.

Returns:

  • (Boolean)


2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 2746

class UpdateBranchRequest < Struct.new(
  :app_id,
  :branch_name,
  :description,
  :framework,
  :stage,
  :enable_notification,
  :enable_auto_build,
  :environment_variables,
  :basic_auth_credentials,
  :enable_basic_auth,
  :build_spec,
  :ttl,
  :display_name,
  :enable_pull_request_preview,
  :pull_request_environment_name,
  :backend_environment_arn)
  include Aws::Structure
end

#enable_notificationBoolean

Enables notifications for the branch.

Returns:

  • (Boolean)


2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 2746

class UpdateBranchRequest < Struct.new(
  :app_id,
  :branch_name,
  :description,
  :framework,
  :stage,
  :enable_notification,
  :enable_auto_build,
  :environment_variables,
  :basic_auth_credentials,
  :enable_basic_auth,
  :build_spec,
  :ttl,
  :display_name,
  :enable_pull_request_preview,
  :pull_request_environment_name,
  :backend_environment_arn)
  include Aws::Structure
end

#enable_pull_request_previewBoolean

Enables Pull Request Preview for this branch.

Returns:

  • (Boolean)


2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 2746

class UpdateBranchRequest < Struct.new(
  :app_id,
  :branch_name,
  :description,
  :framework,
  :stage,
  :enable_notification,
  :enable_auto_build,
  :environment_variables,
  :basic_auth_credentials,
  :enable_basic_auth,
  :build_spec,
  :ttl,
  :display_name,
  :enable_pull_request_preview,
  :pull_request_environment_name,
  :backend_environment_arn)
  include Aws::Structure
end

#environment_variablesHash<String,String>

Environment Variables for the branch.

Returns:

  • (Hash<String,String>)


2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 2746

class UpdateBranchRequest < Struct.new(
  :app_id,
  :branch_name,
  :description,
  :framework,
  :stage,
  :enable_notification,
  :enable_auto_build,
  :environment_variables,
  :basic_auth_credentials,
  :enable_basic_auth,
  :build_spec,
  :ttl,
  :display_name,
  :enable_pull_request_preview,
  :pull_request_environment_name,
  :backend_environment_arn)
  include Aws::Structure
end

#frameworkString

Framework for the branch.

Returns:

  • (String)


2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 2746

class UpdateBranchRequest < Struct.new(
  :app_id,
  :branch_name,
  :description,
  :framework,
  :stage,
  :enable_notification,
  :enable_auto_build,
  :environment_variables,
  :basic_auth_credentials,
  :enable_basic_auth,
  :build_spec,
  :ttl,
  :display_name,
  :enable_pull_request_preview,
  :pull_request_environment_name,
  :backend_environment_arn)
  include Aws::Structure
end

#pull_request_environment_nameString

The Amplify Environment name for the pull request.

Returns:

  • (String)


2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 2746

class UpdateBranchRequest < Struct.new(
  :app_id,
  :branch_name,
  :description,
  :framework,
  :stage,
  :enable_notification,
  :enable_auto_build,
  :environment_variables,
  :basic_auth_credentials,
  :enable_basic_auth,
  :build_spec,
  :ttl,
  :display_name,
  :enable_pull_request_preview,
  :pull_request_environment_name,
  :backend_environment_arn)
  include Aws::Structure
end

#stageString

Stage for the branch.

Returns:

  • (String)


2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 2746

class UpdateBranchRequest < Struct.new(
  :app_id,
  :branch_name,
  :description,
  :framework,
  :stage,
  :enable_notification,
  :enable_auto_build,
  :environment_variables,
  :basic_auth_credentials,
  :enable_basic_auth,
  :build_spec,
  :ttl,
  :display_name,
  :enable_pull_request_preview,
  :pull_request_environment_name,
  :backend_environment_arn)
  include Aws::Structure
end

#ttlString

The content TTL for the website in seconds.

Returns:

  • (String)


2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 2746

class UpdateBranchRequest < Struct.new(
  :app_id,
  :branch_name,
  :description,
  :framework,
  :stage,
  :enable_notification,
  :enable_auto_build,
  :environment_variables,
  :basic_auth_credentials,
  :enable_basic_auth,
  :build_spec,
  :ttl,
  :display_name,
  :enable_pull_request_preview,
  :pull_request_environment_name,
  :backend_environment_arn)
  include Aws::Structure
end