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

Class: Aws::Amplify::Types::Branch

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

Overview

Branch for an Amplify App, which maps to a 3rd party repository branch.

Instance Attribute Summary collapse

Instance Attribute Details

#active_job_idString

Id of the active job for a branch, part of an Amplify App.

Returns:

  • (String)


285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 285

class Branch < Struct.new(
  :branch_arn,
  :branch_name,
  :description,
  :tags,
  :stage,
  :display_name,
  :enable_notification,
  :create_time,
  :update_time,
  :environment_variables,
  :enable_auto_build,
  :custom_domains,
  :framework,
  :active_job_id,
  :total_number_of_jobs,
  :enable_basic_auth,
  :thumbnail_url,
  :basic_auth_credentials,
  :build_spec,
  :ttl,
  :associated_resources)
  include Aws::Structure
end

#associated_resourcesArray<String>

List of custom resources that are linked to this branch.

Returns:

  • (Array<String>)


285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 285

class Branch < Struct.new(
  :branch_arn,
  :branch_name,
  :description,
  :tags,
  :stage,
  :display_name,
  :enable_notification,
  :create_time,
  :update_time,
  :environment_variables,
  :enable_auto_build,
  :custom_domains,
  :framework,
  :active_job_id,
  :total_number_of_jobs,
  :enable_basic_auth,
  :thumbnail_url,
  :basic_auth_credentials,
  :build_spec,
  :ttl,
  :associated_resources)
  include Aws::Structure
end

#basic_auth_credentialsString

Basic Authorization credentials for a branch, part of an Amplify App.

Returns:

  • (String)


285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 285

class Branch < Struct.new(
  :branch_arn,
  :branch_name,
  :description,
  :tags,
  :stage,
  :display_name,
  :enable_notification,
  :create_time,
  :update_time,
  :environment_variables,
  :enable_auto_build,
  :custom_domains,
  :framework,
  :active_job_id,
  :total_number_of_jobs,
  :enable_basic_auth,
  :thumbnail_url,
  :basic_auth_credentials,
  :build_spec,
  :ttl,
  :associated_resources)
  include Aws::Structure
end

#branch_arnString

ARN for a branch, part of an Amplify App.

Returns:

  • (String)


285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 285

class Branch < Struct.new(
  :branch_arn,
  :branch_name,
  :description,
  :tags,
  :stage,
  :display_name,
  :enable_notification,
  :create_time,
  :update_time,
  :environment_variables,
  :enable_auto_build,
  :custom_domains,
  :framework,
  :active_job_id,
  :total_number_of_jobs,
  :enable_basic_auth,
  :thumbnail_url,
  :basic_auth_credentials,
  :build_spec,
  :ttl,
  :associated_resources)
  include Aws::Structure
end

#branch_nameString

Name for a branch, part of an Amplify App.

Returns:

  • (String)


285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 285

class Branch < Struct.new(
  :branch_arn,
  :branch_name,
  :description,
  :tags,
  :stage,
  :display_name,
  :enable_notification,
  :create_time,
  :update_time,
  :environment_variables,
  :enable_auto_build,
  :custom_domains,
  :framework,
  :active_job_id,
  :total_number_of_jobs,
  :enable_basic_auth,
  :thumbnail_url,
  :basic_auth_credentials,
  :build_spec,
  :ttl,
  :associated_resources)
  include Aws::Structure
end

#build_specString

BuildSpec content for branch for Amplify App.

Returns:

  • (String)


285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 285

class Branch < Struct.new(
  :branch_arn,
  :branch_name,
  :description,
  :tags,
  :stage,
  :display_name,
  :enable_notification,
  :create_time,
  :update_time,
  :environment_variables,
  :enable_auto_build,
  :custom_domains,
  :framework,
  :active_job_id,
  :total_number_of_jobs,
  :enable_basic_auth,
  :thumbnail_url,
  :basic_auth_credentials,
  :build_spec,
  :ttl,
  :associated_resources)
  include Aws::Structure
end

#create_timeTime

Creation date and time for a branch, part of an Amplify App.

Returns:

  • (Time)


285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 285

class Branch < Struct.new(
  :branch_arn,
  :branch_name,
  :description,
  :tags,
  :stage,
  :display_name,
  :enable_notification,
  :create_time,
  :update_time,
  :environment_variables,
  :enable_auto_build,
  :custom_domains,
  :framework,
  :active_job_id,
  :total_number_of_jobs,
  :enable_basic_auth,
  :thumbnail_url,
  :basic_auth_credentials,
  :build_spec,
  :ttl,
  :associated_resources)
  include Aws::Structure
end

#custom_domainsArray<String>

Custom domains for a branch, part of an Amplify App.

Returns:

  • (Array<String>)


285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 285

class Branch < Struct.new(
  :branch_arn,
  :branch_name,
  :description,
  :tags,
  :stage,
  :display_name,
  :enable_notification,
  :create_time,
  :update_time,
  :environment_variables,
  :enable_auto_build,
  :custom_domains,
  :framework,
  :active_job_id,
  :total_number_of_jobs,
  :enable_basic_auth,
  :thumbnail_url,
  :basic_auth_credentials,
  :build_spec,
  :ttl,
  :associated_resources)
  include Aws::Structure
end

#descriptionString

Description for a branch, part of an Amplify App.

Returns:

  • (String)


285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 285

class Branch < Struct.new(
  :branch_arn,
  :branch_name,
  :description,
  :tags,
  :stage,
  :display_name,
  :enable_notification,
  :create_time,
  :update_time,
  :environment_variables,
  :enable_auto_build,
  :custom_domains,
  :framework,
  :active_job_id,
  :total_number_of_jobs,
  :enable_basic_auth,
  :thumbnail_url,
  :basic_auth_credentials,
  :build_spec,
  :ttl,
  :associated_resources)
  include Aws::Structure
end

#display_nameString

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

Returns:

  • (String)


285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 285

class Branch < Struct.new(
  :branch_arn,
  :branch_name,
  :description,
  :tags,
  :stage,
  :display_name,
  :enable_notification,
  :create_time,
  :update_time,
  :environment_variables,
  :enable_auto_build,
  :custom_domains,
  :framework,
  :active_job_id,
  :total_number_of_jobs,
  :enable_basic_auth,
  :thumbnail_url,
  :basic_auth_credentials,
  :build_spec,
  :ttl,
  :associated_resources)
  include Aws::Structure
end

#enable_auto_buildBoolean

Enables auto-building on push for a branch, part of an Amplify App.

Returns:

  • (Boolean)


285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 285

class Branch < Struct.new(
  :branch_arn,
  :branch_name,
  :description,
  :tags,
  :stage,
  :display_name,
  :enable_notification,
  :create_time,
  :update_time,
  :environment_variables,
  :enable_auto_build,
  :custom_domains,
  :framework,
  :active_job_id,
  :total_number_of_jobs,
  :enable_basic_auth,
  :thumbnail_url,
  :basic_auth_credentials,
  :build_spec,
  :ttl,
  :associated_resources)
  include Aws::Structure
end

#enable_basic_authBoolean

Enables Basic Authorization for a branch, part of an Amplify App.

Returns:

  • (Boolean)


285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 285

class Branch < Struct.new(
  :branch_arn,
  :branch_name,
  :description,
  :tags,
  :stage,
  :display_name,
  :enable_notification,
  :create_time,
  :update_time,
  :environment_variables,
  :enable_auto_build,
  :custom_domains,
  :framework,
  :active_job_id,
  :total_number_of_jobs,
  :enable_basic_auth,
  :thumbnail_url,
  :basic_auth_credentials,
  :build_spec,
  :ttl,
  :associated_resources)
  include Aws::Structure
end

#enable_notificationBoolean

Enables notifications for a branch, part of an Amplify App.

Returns:

  • (Boolean)


285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 285

class Branch < Struct.new(
  :branch_arn,
  :branch_name,
  :description,
  :tags,
  :stage,
  :display_name,
  :enable_notification,
  :create_time,
  :update_time,
  :environment_variables,
  :enable_auto_build,
  :custom_domains,
  :framework,
  :active_job_id,
  :total_number_of_jobs,
  :enable_basic_auth,
  :thumbnail_url,
  :basic_auth_credentials,
  :build_spec,
  :ttl,
  :associated_resources)
  include Aws::Structure
end

#environment_variablesHash<String,String>

Environment Variables specific to a branch, part of an Amplify App.

Returns:

  • (Hash<String,String>)


285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 285

class Branch < Struct.new(
  :branch_arn,
  :branch_name,
  :description,
  :tags,
  :stage,
  :display_name,
  :enable_notification,
  :create_time,
  :update_time,
  :environment_variables,
  :enable_auto_build,
  :custom_domains,
  :framework,
  :active_job_id,
  :total_number_of_jobs,
  :enable_basic_auth,
  :thumbnail_url,
  :basic_auth_credentials,
  :build_spec,
  :ttl,
  :associated_resources)
  include Aws::Structure
end

#frameworkString

Framework for a branch, part of an Amplify App.

Returns:

  • (String)


285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 285

class Branch < Struct.new(
  :branch_arn,
  :branch_name,
  :description,
  :tags,
  :stage,
  :display_name,
  :enable_notification,
  :create_time,
  :update_time,
  :environment_variables,
  :enable_auto_build,
  :custom_domains,
  :framework,
  :active_job_id,
  :total_number_of_jobs,
  :enable_basic_auth,
  :thumbnail_url,
  :basic_auth_credentials,
  :build_spec,
  :ttl,
  :associated_resources)
  include Aws::Structure
end

#stageString

Stage for a branch, part of an Amplify App.

Returns:

  • (String)


285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 285

class Branch < Struct.new(
  :branch_arn,
  :branch_name,
  :description,
  :tags,
  :stage,
  :display_name,
  :enable_notification,
  :create_time,
  :update_time,
  :environment_variables,
  :enable_auto_build,
  :custom_domains,
  :framework,
  :active_job_id,
  :total_number_of_jobs,
  :enable_basic_auth,
  :thumbnail_url,
  :basic_auth_credentials,
  :build_spec,
  :ttl,
  :associated_resources)
  include Aws::Structure
end

#tagsHash<String,String>

Tag for branch for Amplify App.

Returns:

  • (Hash<String,String>)


285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 285

class Branch < Struct.new(
  :branch_arn,
  :branch_name,
  :description,
  :tags,
  :stage,
  :display_name,
  :enable_notification,
  :create_time,
  :update_time,
  :environment_variables,
  :enable_auto_build,
  :custom_domains,
  :framework,
  :active_job_id,
  :total_number_of_jobs,
  :enable_basic_auth,
  :thumbnail_url,
  :basic_auth_credentials,
  :build_spec,
  :ttl,
  :associated_resources)
  include Aws::Structure
end

#thumbnail_urlString

Thumbnail URL for the branch.

Returns:

  • (String)


285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 285

class Branch < Struct.new(
  :branch_arn,
  :branch_name,
  :description,
  :tags,
  :stage,
  :display_name,
  :enable_notification,
  :create_time,
  :update_time,
  :environment_variables,
  :enable_auto_build,
  :custom_domains,
  :framework,
  :active_job_id,
  :total_number_of_jobs,
  :enable_basic_auth,
  :thumbnail_url,
  :basic_auth_credentials,
  :build_spec,
  :ttl,
  :associated_resources)
  include Aws::Structure
end

#total_number_of_jobsString

Total number of Jobs part of an Amplify App.

Returns:

  • (String)


285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 285

class Branch < Struct.new(
  :branch_arn,
  :branch_name,
  :description,
  :tags,
  :stage,
  :display_name,
  :enable_notification,
  :create_time,
  :update_time,
  :environment_variables,
  :enable_auto_build,
  :custom_domains,
  :framework,
  :active_job_id,
  :total_number_of_jobs,
  :enable_basic_auth,
  :thumbnail_url,
  :basic_auth_credentials,
  :build_spec,
  :ttl,
  :associated_resources)
  include Aws::Structure
end

#ttlString

The content TTL for the website in seconds.

Returns:

  • (String)


285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 285

class Branch < Struct.new(
  :branch_arn,
  :branch_name,
  :description,
  :tags,
  :stage,
  :display_name,
  :enable_notification,
  :create_time,
  :update_time,
  :environment_variables,
  :enable_auto_build,
  :custom_domains,
  :framework,
  :active_job_id,
  :total_number_of_jobs,
  :enable_basic_auth,
  :thumbnail_url,
  :basic_auth_credentials,
  :build_spec,
  :ttl,
  :associated_resources)
  include Aws::Structure
end

#update_timeTime

Last updated date and time for a branch, part of an Amplify App.

Returns:

  • (Time)


285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 285

class Branch < Struct.new(
  :branch_arn,
  :branch_name,
  :description,
  :tags,
  :stage,
  :display_name,
  :enable_notification,
  :create_time,
  :update_time,
  :environment_variables,
  :enable_auto_build,
  :custom_domains,
  :framework,
  :active_job_id,
  :total_number_of_jobs,
  :enable_basic_auth,
  :thumbnail_url,
  :basic_auth_credentials,
  :build_spec,
  :ttl,
  :associated_resources)
  include Aws::Structure
end