Class: Aws::Amplify::Types::CreateBranchRequest

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

Overview

The request structure for the create branch request.

See Also:

Constant Summary collapse

SENSITIVE = 
[:basic_auth_credentials, :build_spec]

Instance Attribute Summary collapse

Instance Attribute Details

#app_id ⇒ String

The unique ID for an Amplify app.

Returns:

  • (String) 


1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
 
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 1023

class CreateBranchRequest < Struct.new(
  :app_id,
  :branch_name,
  :description,
  :stage,
  :framework,
  :enable_notification,
  :enable_auto_build,
  :environment_variables,
  :basic_auth_credentials,
  :enable_basic_auth,
  :enable_performance_mode,
  :tags,
  :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:



1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
 
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 1023

class CreateBranchRequest < Struct.new(
  :app_id,
  :branch_name,
  :description,
  :stage,
  :framework,
  :enable_notification,
  :enable_auto_build,
  :environment_variables,
  :basic_auth_credentials,
  :enable_basic_auth,
  :enable_performance_mode,
  :tags,
  :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) 


1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
 
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 1023

class CreateBranchRequest < Struct.new(
  :app_id,
  :branch_name,
  :description,
  :stage,
  :framework,
  :enable_notification,
  :enable_auto_build,
  :environment_variables,
  :basic_auth_credentials,
  :enable_basic_auth,
  :enable_performance_mode,
  :tags,
  :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) 


1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
 
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 1023

class CreateBranchRequest < Struct.new(
  :app_id,
  :branch_name,
  :description,
  :stage,
  :framework,
  :enable_notification,
  :enable_auto_build,
  :environment_variables,
  :basic_auth_credentials,
  :enable_basic_auth,
  :enable_performance_mode,
  :tags,
  :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 for the branch.

Returns:

  • (String) 


1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
 
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 1023

class CreateBranchRequest < Struct.new(
  :app_id,
  :branch_name,
  :description,
  :stage,
  :framework,
  :enable_notification,
  :enable_auto_build,
  :environment_variables,
  :basic_auth_credentials,
  :enable_basic_auth,
  :enable_performance_mode,
  :tags,
  :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) 


1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
 
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 1023

class CreateBranchRequest < Struct.new(
  :app_id,
  :branch_name,
  :description,
  :stage,
  :framework,
  :enable_notification,
  :enable_auto_build,
  :environment_variables,
  :basic_auth_credentials,
  :enable_basic_auth,
  :enable_performance_mode,
  :tags,
  :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) 


1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
 
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 1023

class CreateBranchRequest < Struct.new(
  :app_id,
  :branch_name,
  :description,
  :stage,
  :framework,
  :enable_notification,
  :enable_auto_build,
  :environment_variables,
  :basic_auth_credentials,
  :enable_basic_auth,
  :enable_performance_mode,
  :tags,
  :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) 


1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
 
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 1023

class CreateBranchRequest < Struct.new(
  :app_id,
  :branch_name,
  :description,
  :stage,
  :framework,
  :enable_notification,
  :enable_auto_build,
  :environment_variables,
  :basic_auth_credentials,
  :enable_basic_auth,
  :enable_performance_mode,
  :tags,
  :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) 


1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
 
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 1023

class CreateBranchRequest < Struct.new(
  :app_id,
  :branch_name,
  :description,
  :stage,
  :framework,
  :enable_notification,
  :enable_auto_build,
  :environment_variables,
  :basic_auth_credentials,
  :enable_basic_auth,
  :enable_performance_mode,
  :tags,
  :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) 


1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
 
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 1023

class CreateBranchRequest < Struct.new(
  :app_id,
  :branch_name,
  :description,
  :stage,
  :framework,
  :enable_notification,
  :enable_auto_build,
  :environment_variables,
  :basic_auth_credentials,
  :enable_basic_auth,
  :enable_performance_mode,
  :tags,
  :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) 


1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
 
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 1023

class CreateBranchRequest < Struct.new(
  :app_id,
  :branch_name,
  :description,
  :stage,
  :framework,
  :enable_notification,
  :enable_auto_build,
  :environment_variables,
  :basic_auth_credentials,
  :enable_basic_auth,
  :enable_performance_mode,
  :tags,
  :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) 


1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
 
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 1023

class CreateBranchRequest < Struct.new(
  :app_id,
  :branch_name,
  :description,
  :stage,
  :framework,
  :enable_notification,
  :enable_auto_build,
  :environment_variables,
  :basic_auth_credentials,
  :enable_basic_auth,
  :enable_performance_mode,
  :tags,
  :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) 


1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
 
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 1023

class CreateBranchRequest < Struct.new(
  :app_id,
  :branch_name,
  :description,
  :stage,
  :framework,
  :enable_notification,
  :enable_auto_build,
  :environment_variables,
  :basic_auth_credentials,
  :enable_basic_auth,
  :enable_performance_mode,
  :tags,
  :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) 


1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
 
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 1023

class CreateBranchRequest < Struct.new(
  :app_id,
  :branch_name,
  :description,
  :stage,
  :framework,
  :enable_notification,
  :enable_auto_build,
  :environment_variables,
  :basic_auth_credentials,
  :enable_basic_auth,
  :enable_performance_mode,
  :tags,
  :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>) 


1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
 
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 1023

class CreateBranchRequest < Struct.new(
  :app_id,
  :branch_name,
  :description,
  :stage,
  :framework,
  :enable_notification,
  :enable_auto_build,
  :environment_variables,
  :basic_auth_credentials,
  :enable_basic_auth,
  :enable_performance_mode,
  :tags,
  :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) 


1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
 
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 1023

class CreateBranchRequest < Struct.new(
  :app_id,
  :branch_name,
  :description,
  :stage,
  :framework,
  :enable_notification,
  :enable_auto_build,
  :environment_variables,
  :basic_auth_credentials,
  :enable_basic_auth,
  :enable_performance_mode,
  :tags,
  :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) 


1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
 
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 1023

class CreateBranchRequest < Struct.new(
  :app_id,
  :branch_name,
  :description,
  :stage,
  :framework,
  :enable_notification,
  :enable_auto_build,
  :environment_variables,
  :basic_auth_credentials,
  :enable_basic_auth,
  :enable_performance_mode,
  :tags,
  :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) 


1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
 
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 1023

class CreateBranchRequest < Struct.new(
  :app_id,
  :branch_name,
  :description,
  :stage,
  :framework,
  :enable_notification,
  :enable_auto_build,
  :environment_variables,
  :basic_auth_credentials,
  :enable_basic_auth,
  :enable_performance_mode,
  :tags,
  :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

#tags ⇒ Hash<String,String>

The tag for the branch.

Returns:

  • (Hash<String,String>) 


1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
 
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 1023

class CreateBranchRequest < Struct.new(
  :app_id,
  :branch_name,
  :description,
  :stage,
  :framework,
  :enable_notification,
  :enable_auto_build,
  :environment_variables,
  :basic_auth_credentials,
  :enable_basic_auth,
  :enable_performance_mode,
  :tags,
  :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) 


1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
 
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 1023

class CreateBranchRequest < Struct.new(
  :app_id,
  :branch_name,
  :description,
  :stage,
  :framework,
  :enable_notification,
  :enable_auto_build,
  :environment_variables,
  :basic_auth_credentials,
  :enable_basic_auth,
  :enable_performance_mode,
  :tags,
  :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