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

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

Overview

The branch for an Amplify app, which maps to a third-party repository branch.

Constant Summary collapse

SENSITIVE =
[:basic_auth_credentials]

Instance Attribute Summary collapse

Instance Attribute Details

#active_job_idString

The ID of the active job for a branch of an Amplify app.

Returns:

  • (String)


425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 425

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,
  :enable_performance_mode,
  :thumbnail_url,
  :basic_auth_credentials,
  :build_spec,
  :ttl,
  :associated_resources,
  :enable_pull_request_preview,
  :pull_request_environment_name,
  :destination_branch,
  :source_branch,
  :backend_environment_arn)
  SENSITIVE = [:basic_auth_credentials]
  include Aws::Structure
end

#associated_resourcesArray<String>

A list of custom resources that are linked to this branch.

Returns:

  • (Array<String>)


425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 425

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,
  :enable_performance_mode,
  :thumbnail_url,
  :basic_auth_credentials,
  :build_spec,
  :ttl,
  :associated_resources,
  :enable_pull_request_preview,
  :pull_request_environment_name,
  :destination_branch,
  :source_branch,
  :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)


425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 425

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,
  :enable_performance_mode,
  :thumbnail_url,
  :basic_auth_credentials,
  :build_spec,
  :ttl,
  :associated_resources,
  :enable_pull_request_preview,
  :pull_request_environment_name,
  :destination_branch,
  :source_branch,
  :backend_environment_arn)
  SENSITIVE = [:basic_auth_credentials]
  include Aws::Structure
end

#basic_auth_credentialsString

The basic authorization credentials for a branch of an Amplify app.

Returns:

  • (String)


425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 425

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,
  :enable_performance_mode,
  :thumbnail_url,
  :basic_auth_credentials,
  :build_spec,
  :ttl,
  :associated_resources,
  :enable_pull_request_preview,
  :pull_request_environment_name,
  :destination_branch,
  :source_branch,
  :backend_environment_arn)
  SENSITIVE = [:basic_auth_credentials]
  include Aws::Structure
end

#branch_arnString

The Amazon Resource Name (ARN) for a branch that is part of an Amplify app.

Returns:

  • (String)


425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 425

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,
  :enable_performance_mode,
  :thumbnail_url,
  :basic_auth_credentials,
  :build_spec,
  :ttl,
  :associated_resources,
  :enable_pull_request_preview,
  :pull_request_environment_name,
  :destination_branch,
  :source_branch,
  :backend_environment_arn)
  SENSITIVE = [:basic_auth_credentials]
  include Aws::Structure
end

#branch_nameString

The name for the branch that is part of an Amplify app.

Returns:

  • (String)


425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 425

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,
  :enable_performance_mode,
  :thumbnail_url,
  :basic_auth_credentials,
  :build_spec,
  :ttl,
  :associated_resources,
  :enable_pull_request_preview,
  :pull_request_environment_name,
  :destination_branch,
  :source_branch,
  :backend_environment_arn)
  SENSITIVE = [:basic_auth_credentials]
  include Aws::Structure
end

#build_specString

The build specification (build spec) content for the branch of an Amplify app.

Returns:

  • (String)


425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 425

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,
  :enable_performance_mode,
  :thumbnail_url,
  :basic_auth_credentials,
  :build_spec,
  :ttl,
  :associated_resources,
  :enable_pull_request_preview,
  :pull_request_environment_name,
  :destination_branch,
  :source_branch,
  :backend_environment_arn)
  SENSITIVE = [:basic_auth_credentials]
  include Aws::Structure
end

#create_timeTime

The creation date and time for a branch that is part of an Amplify app.

Returns:

  • (Time)


425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 425

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,
  :enable_performance_mode,
  :thumbnail_url,
  :basic_auth_credentials,
  :build_spec,
  :ttl,
  :associated_resources,
  :enable_pull_request_preview,
  :pull_request_environment_name,
  :destination_branch,
  :source_branch,
  :backend_environment_arn)
  SENSITIVE = [:basic_auth_credentials]
  include Aws::Structure
end

#custom_domainsArray<String>

The custom domains for a branch of an Amplify app.

Returns:

  • (Array<String>)


425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 425

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,
  :enable_performance_mode,
  :thumbnail_url,
  :basic_auth_credentials,
  :build_spec,
  :ttl,
  :associated_resources,
  :enable_pull_request_preview,
  :pull_request_environment_name,
  :destination_branch,
  :source_branch,
  :backend_environment_arn)
  SENSITIVE = [:basic_auth_credentials]
  include Aws::Structure
end

#descriptionString

The description for the branch that is part of an Amplify app.

Returns:

  • (String)


425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 425

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,
  :enable_performance_mode,
  :thumbnail_url,
  :basic_auth_credentials,
  :build_spec,
  :ttl,
  :associated_resources,
  :enable_pull_request_preview,
  :pull_request_environment_name,
  :destination_branch,
  :source_branch,
  :backend_environment_arn)
  SENSITIVE = [:basic_auth_credentials]
  include Aws::Structure
end

#destination_branchString

The destination branch if the branch is a pull request branch.

Returns:

  • (String)


425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 425

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,
  :enable_performance_mode,
  :thumbnail_url,
  :basic_auth_credentials,
  :build_spec,
  :ttl,
  :associated_resources,
  :enable_pull_request_preview,
  :pull_request_environment_name,
  :destination_branch,
  :source_branch,
  :backend_environment_arn)
  SENSITIVE = [:basic_auth_credentials]
  include Aws::Structure
end

#display_nameString

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

Returns:

  • (String)


425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 425

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,
  :enable_performance_mode,
  :thumbnail_url,
  :basic_auth_credentials,
  :build_spec,
  :ttl,
  :associated_resources,
  :enable_pull_request_preview,
  :pull_request_environment_name,
  :destination_branch,
  :source_branch,
  :backend_environment_arn)
  SENSITIVE = [:basic_auth_credentials]
  include Aws::Structure
end

#enable_auto_buildBoolean

Enables auto-building on push for a branch of an Amplify app.

Returns:

  • (Boolean)


425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 425

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,
  :enable_performance_mode,
  :thumbnail_url,
  :basic_auth_credentials,
  :build_spec,
  :ttl,
  :associated_resources,
  :enable_pull_request_preview,
  :pull_request_environment_name,
  :destination_branch,
  :source_branch,
  :backend_environment_arn)
  SENSITIVE = [:basic_auth_credentials]
  include Aws::Structure
end

#enable_basic_authBoolean

Enables basic authorization for a branch of an Amplify app.

Returns:

  • (Boolean)


425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 425

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,
  :enable_performance_mode,
  :thumbnail_url,
  :basic_auth_credentials,
  :build_spec,
  :ttl,
  :associated_resources,
  :enable_pull_request_preview,
  :pull_request_environment_name,
  :destination_branch,
  :source_branch,
  :backend_environment_arn)
  SENSITIVE = [:basic_auth_credentials]
  include Aws::Structure
end

#enable_notificationBoolean

Enables notifications for a branch that is part of an Amplify app.

Returns:

  • (Boolean)


425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 425

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,
  :enable_performance_mode,
  :thumbnail_url,
  :basic_auth_credentials,
  :build_spec,
  :ttl,
  :associated_resources,
  :enable_pull_request_preview,
  :pull_request_environment_name,
  :destination_branch,
  :source_branch,
  :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)


425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 425

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,
  :enable_performance_mode,
  :thumbnail_url,
  :basic_auth_credentials,
  :build_spec,
  :ttl,
  :associated_resources,
  :enable_pull_request_preview,
  :pull_request_environment_name,
  :destination_branch,
  :source_branch,
  :backend_environment_arn)
  SENSITIVE = [:basic_auth_credentials]
  include Aws::Structure
end

#enable_pull_request_previewBoolean

Enables pull request previews for the branch.

Returns:

  • (Boolean)


425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 425

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,
  :enable_performance_mode,
  :thumbnail_url,
  :basic_auth_credentials,
  :build_spec,
  :ttl,
  :associated_resources,
  :enable_pull_request_preview,
  :pull_request_environment_name,
  :destination_branch,
  :source_branch,
  :backend_environment_arn)
  SENSITIVE = [:basic_auth_credentials]
  include Aws::Structure
end

#environment_variablesHash<String,String>

The environment variables specific to a branch of an Amplify app.

Returns:

  • (Hash<String,String>)


425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 425

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,
  :enable_performance_mode,
  :thumbnail_url,
  :basic_auth_credentials,
  :build_spec,
  :ttl,
  :associated_resources,
  :enable_pull_request_preview,
  :pull_request_environment_name,
  :destination_branch,
  :source_branch,
  :backend_environment_arn)
  SENSITIVE = [:basic_auth_credentials]
  include Aws::Structure
end

#frameworkString

The framework for a branch of an Amplify app.

Returns:

  • (String)


425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 425

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,
  :enable_performance_mode,
  :thumbnail_url,
  :basic_auth_credentials,
  :build_spec,
  :ttl,
  :associated_resources,
  :enable_pull_request_preview,
  :pull_request_environment_name,
  :destination_branch,
  :source_branch,
  :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)


425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 425

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,
  :enable_performance_mode,
  :thumbnail_url,
  :basic_auth_credentials,
  :build_spec,
  :ttl,
  :associated_resources,
  :enable_pull_request_preview,
  :pull_request_environment_name,
  :destination_branch,
  :source_branch,
  :backend_environment_arn)
  SENSITIVE = [:basic_auth_credentials]
  include Aws::Structure
end

#source_branchString

The source branch if the branch is a pull request branch.

Returns:

  • (String)


425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 425

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,
  :enable_performance_mode,
  :thumbnail_url,
  :basic_auth_credentials,
  :build_spec,
  :ttl,
  :associated_resources,
  :enable_pull_request_preview,
  :pull_request_environment_name,
  :destination_branch,
  :source_branch,
  :backend_environment_arn)
  SENSITIVE = [:basic_auth_credentials]
  include Aws::Structure
end

#stageString

The current stage for the branch that is part of an Amplify app.

Returns:

  • (String)


425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 425

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,
  :enable_performance_mode,
  :thumbnail_url,
  :basic_auth_credentials,
  :build_spec,
  :ttl,
  :associated_resources,
  :enable_pull_request_preview,
  :pull_request_environment_name,
  :destination_branch,
  :source_branch,
  :backend_environment_arn)
  SENSITIVE = [:basic_auth_credentials]
  include Aws::Structure
end

#tagsHash<String,String>

The tag for the branch of an Amplify app.

Returns:

  • (Hash<String,String>)


425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 425

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,
  :enable_performance_mode,
  :thumbnail_url,
  :basic_auth_credentials,
  :build_spec,
  :ttl,
  :associated_resources,
  :enable_pull_request_preview,
  :pull_request_environment_name,
  :destination_branch,
  :source_branch,
  :backend_environment_arn)
  SENSITIVE = [:basic_auth_credentials]
  include Aws::Structure
end

#thumbnail_urlString

The thumbnail URL for the branch of an Amplify app.

Returns:

  • (String)


425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 425

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,
  :enable_performance_mode,
  :thumbnail_url,
  :basic_auth_credentials,
  :build_spec,
  :ttl,
  :associated_resources,
  :enable_pull_request_preview,
  :pull_request_environment_name,
  :destination_branch,
  :source_branch,
  :backend_environment_arn)
  SENSITIVE = [:basic_auth_credentials]
  include Aws::Structure
end

#total_number_of_jobsString

The total number of jobs that are part of an Amplify app.

Returns:

  • (String)


425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 425

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,
  :enable_performance_mode,
  :thumbnail_url,
  :basic_auth_credentials,
  :build_spec,
  :ttl,
  :associated_resources,
  :enable_pull_request_preview,
  :pull_request_environment_name,
  :destination_branch,
  :source_branch,
  :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)


425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 425

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,
  :enable_performance_mode,
  :thumbnail_url,
  :basic_auth_credentials,
  :build_spec,
  :ttl,
  :associated_resources,
  :enable_pull_request_preview,
  :pull_request_environment_name,
  :destination_branch,
  :source_branch,
  :backend_environment_arn)
  SENSITIVE = [:basic_auth_credentials]
  include Aws::Structure
end

#update_timeTime

The last updated date and time for a branch that is part of an Amplify app.

Returns:

  • (Time)


425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
# File 'gems/aws-sdk-amplify/lib/aws-sdk-amplify/types.rb', line 425

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,
  :enable_performance_mode,
  :thumbnail_url,
  :basic_auth_credentials,
  :build_spec,
  :ttl,
  :associated_resources,
  :enable_pull_request_preview,
  :pull_request_environment_name,
  :destination_branch,
  :source_branch,
  :backend_environment_arn)
  SENSITIVE = [:basic_auth_credentials]
  include Aws::Structure
end