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

Inherits:

Struct

• Object
• Struct
• Aws::Amplify::Types::Branch

Includes:

Structure

Defined in:

lib/aws-sdk-amplify/types.rb

Overview

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

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:basic_auth_credentials, :build_spec]

Instance Attribute Summary

• #active_job_id ⇒ String

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

• #associated_resources ⇒ Array<String>

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

• #backend ⇒ Types::Backend

  Describes the backend associated with an Amplify ‘Branch`.

• #backend_environment_arn ⇒ String

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

• #basic_auth_credentials ⇒ String

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

• #branch_arn ⇒ String

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

• #branch_name ⇒ String

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

• #build_spec ⇒ String

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

• #create_time ⇒ Time

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

• #custom_domains ⇒ Array<String>

  The custom domains for a branch of an Amplify app.

• #description ⇒ String

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

• #destination_branch ⇒ String

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

• #display_name ⇒ String

  The display name for the branch.

• #enable_auto_build ⇒ Boolean

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

• #enable_basic_auth ⇒ Boolean

  Enables basic authorization for a branch of an Amplify app.

• #enable_notification ⇒ Boolean

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

• #enable_performance_mode ⇒ Boolean

  Enables performance mode for the branch.

• #enable_pull_request_preview ⇒ Boolean

  Enables pull request previews for the branch.

• #environment_variables ⇒ Hash<String,String>

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

• #framework ⇒ String

  The framework for a branch of an Amplify app.

• #pull_request_environment_name ⇒ String

  The Amplify environment name for the pull request.

• #source_branch ⇒ String

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

• #stage ⇒ String

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

• #tags ⇒ Hash<String,String>

  The tag for the branch of an Amplify app.

• #thumbnail_url ⇒ String

  The thumbnail URL for the branch of an Amplify app.

• #total_number_of_jobs ⇒ String

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

• #ttl ⇒ String

  The content Time to Live (TTL) for the website in seconds.

• #update_time ⇒ Time

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

Instance Attribute Details

#active_job_id ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-amplify/types.rb', line 479

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,
  :backend)
  SENSITIVE = [:basic_auth_credentials, :build_spec]
  include Aws::Structure
end

#associated_resources ⇒ Array<String>

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

Returns:

• (Array<String>)

# File 'lib/aws-sdk-amplify/types.rb', line 479

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,
  :backend)
  SENSITIVE = [:basic_auth_credentials, :build_spec]
  include Aws::Structure
end

#backend ⇒ Types::Backend

Describes the backend associated with an Amplify ‘Branch`.

This property 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:

• (Types::Backend)

# File 'lib/aws-sdk-amplify/types.rb', line 479

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,
  :backend)
  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 an Amplify app.

This property is available to Amplify Gen 1 apps only. When you deploy an application with Amplify Gen 2, you provision the app’s backend infrastructure using Typescript code.

Returns:

• (String)

# File 'lib/aws-sdk-amplify/types.rb', line 479

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,
  :backend)
  SENSITIVE = [:basic_auth_credentials, :build_spec]
  include Aws::Structure
end

#basic_auth_credentials ⇒ String

The basic authorization credentials for a branch of an Amplify app. You must base64-encode the authorization credentials and provide them in the format ‘user:password`.

Returns:

• (String)

# File 'lib/aws-sdk-amplify/types.rb', line 479

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,
  :backend)
  SENSITIVE = [:basic_auth_credentials, :build_spec]
  include Aws::Structure
end

#branch_arn ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-amplify/types.rb', line 479

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,
  :backend)
  SENSITIVE = [:basic_auth_credentials, :build_spec]
  include Aws::Structure
end

#branch_name ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-amplify/types.rb', line 479

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,
  :backend)
  SENSITIVE = [:basic_auth_credentials, :build_spec]
  include Aws::Structure
end

#build_spec ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-amplify/types.rb', line 479

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,
  :backend)
  SENSITIVE = [:basic_auth_credentials, :build_spec]
  include Aws::Structure
end

#create_time ⇒ Time

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

Returns:

• (Time)

# File 'lib/aws-sdk-amplify/types.rb', line 479

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,
  :backend)
  SENSITIVE = [:basic_auth_credentials, :build_spec]
  include Aws::Structure
end

#custom_domains ⇒ Array<String>

The custom domains for a branch of an Amplify app.

Returns:

• (Array<String>)

# File 'lib/aws-sdk-amplify/types.rb', line 479

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,
  :backend)
  SENSITIVE = [:basic_auth_credentials, :build_spec]
  include Aws::Structure
end

#description ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-amplify/types.rb', line 479

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,
  :backend)
  SENSITIVE = [:basic_auth_credentials, :build_spec]
  include Aws::Structure
end

#destination_branch ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-amplify/types.rb', line 479

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,
  :backend)
  SENSITIVE = [:basic_auth_credentials, :build_spec]
  include Aws::Structure
end

#display_name ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-amplify/types.rb', line 479

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,
  :backend)
  SENSITIVE = [:basic_auth_credentials, :build_spec]
  include Aws::Structure
end

#enable_auto_build ⇒ Boolean

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

Returns:

• (Boolean)

# File 'lib/aws-sdk-amplify/types.rb', line 479

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,
  :backend)
  SENSITIVE = [:basic_auth_credentials, :build_spec]
  include Aws::Structure
end

#enable_basic_auth ⇒ Boolean

Enables basic authorization for a branch of an Amplify app.

Returns:

• (Boolean)

# File 'lib/aws-sdk-amplify/types.rb', line 479

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,
  :backend)
  SENSITIVE = [:basic_auth_credentials, :build_spec]
  include Aws::Structure
end

#enable_notification ⇒ Boolean

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

Returns:

• (Boolean)

# File 'lib/aws-sdk-amplify/types.rb', line 479

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,
  :backend)
  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)

# File 'lib/aws-sdk-amplify/types.rb', line 479

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,
  :backend)
  SENSITIVE = [:basic_auth_credentials, :build_spec]
  include Aws::Structure
end

#enable_pull_request_preview ⇒ Boolean

Enables pull request previews for the branch.

Returns:

• (Boolean)

# File 'lib/aws-sdk-amplify/types.rb', line 479

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,
  :backend)
  SENSITIVE = [:basic_auth_credentials, :build_spec]
  include Aws::Structure
end

#environment_variables ⇒ Hash<String,String>

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

Returns:

• (Hash<String,String>)

# File 'lib/aws-sdk-amplify/types.rb', line 479

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,
  :backend)
  SENSITIVE = [:basic_auth_credentials, :build_spec]
  include Aws::Structure
end

#framework ⇒ String

The framework for a branch of an Amplify app.

Returns:

• (String)

# File 'lib/aws-sdk-amplify/types.rb', line 479

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,
  :backend)
  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)

# File 'lib/aws-sdk-amplify/types.rb', line 479

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,
  :backend)
  SENSITIVE = [:basic_auth_credentials, :build_spec]
  include Aws::Structure
end

#source_branch ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-amplify/types.rb', line 479

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,
  :backend)
  SENSITIVE = [:basic_auth_credentials, :build_spec]
  include Aws::Structure
end

#stage ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-amplify/types.rb', line 479

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,
  :backend)
  SENSITIVE = [:basic_auth_credentials, :build_spec]
  include Aws::Structure
end

#tags ⇒ Hash<String,String>

The tag for the branch of an Amplify app.

Returns:

• (Hash<String,String>)

# File 'lib/aws-sdk-amplify/types.rb', line 479

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,
  :backend)
  SENSITIVE = [:basic_auth_credentials, :build_spec]
  include Aws::Structure
end

#thumbnail_url ⇒ String

The thumbnail URL for the branch of an Amplify app.

Returns:

• (String)

# File 'lib/aws-sdk-amplify/types.rb', line 479

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,
  :backend)
  SENSITIVE = [:basic_auth_credentials, :build_spec]
  include Aws::Structure
end

#total_number_of_jobs ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-amplify/types.rb', line 479

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,
  :backend)
  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)

# File 'lib/aws-sdk-amplify/types.rb', line 479

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,
  :backend)
  SENSITIVE = [:basic_auth_credentials, :build_spec]
  include Aws::Structure
end

#update_time ⇒ Time

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

Returns:

• (Time)

# File 'lib/aws-sdk-amplify/types.rb', line 479

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,
  :backend)
  SENSITIVE = [:basic_auth_credentials, :build_spec]
  include Aws::Structure
end