Class: Aws::Amplify::Types::AutoBranchCreationConfig

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

Overview

Describes the automated branch creation configuration.

See Also:

Constant Summary collapse

SENSITIVE = 
[:basic_auth_credentials, :build_spec]

Instance Attribute Summary collapse

Instance Attribute Details

#basic_auth_credentials ⇒ String

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

Returns:

  • (String) 


233
234
235
236
237
238
239
240
241
242
243
244
245
246
 
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 233

class AutoBranchCreationConfig < Struct.new(
  :stage,
  :framework,
  :enable_auto_build,
  :environment_variables,
  :basic_auth_credentials,
  :enable_basic_auth,
  :enable_performance_mode,
  :build_spec,
  :enable_pull_request_preview,
  :pull_request_environment_name)
  SENSITIVE = [:basic_auth_credentials, :build_spec]
  include Aws::Structure
end

#build_spec ⇒ String

The build specification (build spec) for the autocreated branch.

Returns:

  • (String) 


233
234
235
236
237
238
239
240
241
242
243
244
245
246
 
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 233

class AutoBranchCreationConfig < Struct.new(
  :stage,
  :framework,
  :enable_auto_build,
  :environment_variables,
  :basic_auth_credentials,
  :enable_basic_auth,
  :enable_performance_mode,
  :build_spec,
  :enable_pull_request_preview,
  :pull_request_environment_name)
  SENSITIVE = [:basic_auth_credentials, :build_spec]
  include Aws::Structure
end

#enable_auto_build ⇒ Boolean

Enables auto building for the autocreated branch.

Returns:

  • (Boolean) 


233
234
235
236
237
238
239
240
241
242
243
244
245
246
 
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 233

class AutoBranchCreationConfig < Struct.new(
  :stage,
  :framework,
  :enable_auto_build,
  :environment_variables,
  :basic_auth_credentials,
  :enable_basic_auth,
  :enable_performance_mode,
  :build_spec,
  :enable_pull_request_preview,
  :pull_request_environment_name)
  SENSITIVE = [:basic_auth_credentials, :build_spec]
  include Aws::Structure
end

#enable_basic_auth ⇒ Boolean

Enables basic authorization for the autocreated branch.

Returns:

  • (Boolean) 


233
234
235
236
237
238
239
240
241
242
243
244
245
246
 
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 233

class AutoBranchCreationConfig < Struct.new(
  :stage,
  :framework,
  :enable_auto_build,
  :environment_variables,
  :basic_auth_credentials,
  :enable_basic_auth,
  :enable_performance_mode,
  :build_spec,
  :enable_pull_request_preview,
  :pull_request_environment_name)
  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) 


233
234
235
236
237
238
239
240
241
242
243
244
245
246
 
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 233

class AutoBranchCreationConfig < Struct.new(
  :stage,
  :framework,
  :enable_auto_build,
  :environment_variables,
  :basic_auth_credentials,
  :enable_basic_auth,
  :enable_performance_mode,
  :build_spec,
  :enable_pull_request_preview,
  :pull_request_environment_name)
  SENSITIVE = [:basic_auth_credentials, :build_spec]
  include Aws::Structure
end

#enable_pull_request_preview ⇒ Boolean

Enables pull request previews for the autocreated branch.

Returns:

  • (Boolean) 


233
234
235
236
237
238
239
240
241
242
243
244
245
246
 
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 233

class AutoBranchCreationConfig < Struct.new(
  :stage,
  :framework,
  :enable_auto_build,
  :environment_variables,
  :basic_auth_credentials,
  :enable_basic_auth,
  :enable_performance_mode,
  :build_spec,
  :enable_pull_request_preview,
  :pull_request_environment_name)
  SENSITIVE = [:basic_auth_credentials, :build_spec]
  include Aws::Structure
end

#environment_variables ⇒ Hash<String,String>

The environment variables for the autocreated branch.

Returns:

  • (Hash<String,String>) 


233
234
235
236
237
238
239
240
241
242
243
244
245
246
 
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 233

class AutoBranchCreationConfig < Struct.new(
  :stage,
  :framework,
  :enable_auto_build,
  :environment_variables,
  :basic_auth_credentials,
  :enable_basic_auth,
  :enable_performance_mode,
  :build_spec,
  :enable_pull_request_preview,
  :pull_request_environment_name)
  SENSITIVE = [:basic_auth_credentials, :build_spec]
  include Aws::Structure
end

#framework ⇒ String

The framework for the autocreated branch.

Returns:

  • (String) 


233
234
235
236
237
238
239
240
241
242
243
244
245
246
 
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 233

class AutoBranchCreationConfig < Struct.new(
  :stage,
  :framework,
  :enable_auto_build,
  :environment_variables,
  :basic_auth_credentials,
  :enable_basic_auth,
  :enable_performance_mode,
  :build_spec,
  :enable_pull_request_preview,
  :pull_request_environment_name)
  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) 


233
234
235
236
237
238
239
240
241
242
243
244
245
246
 
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 233

class AutoBranchCreationConfig < Struct.new(
  :stage,
  :framework,
  :enable_auto_build,
  :environment_variables,
  :basic_auth_credentials,
  :enable_basic_auth,
  :enable_performance_mode,
  :build_spec,
  :enable_pull_request_preview,
  :pull_request_environment_name)
  SENSITIVE = [:basic_auth_credentials, :build_spec]
  include Aws::Structure
end

#stage ⇒ String

Describes the current stage for the autocreated branch.

Returns:

  • (String) 


233
234
235
236
237
238
239
240
241
242
243
244
245
246
 
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 233

class AutoBranchCreationConfig < Struct.new(
  :stage,
  :framework,
  :enable_auto_build,
  :environment_variables,
  :basic_auth_credentials,
  :enable_basic_auth,
  :enable_performance_mode,
  :build_spec,
  :enable_pull_request_preview,
  :pull_request_environment_name)
  SENSITIVE = [:basic_auth_credentials, :build_spec]
  include Aws::Structure
end