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

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

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

Returned by:

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#active_job_id ⇒ String

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

Returns:

  • (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.

Returns:

  • (Array<String>) —

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

#backend_environment_arn ⇒ String

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

Returns:

  • (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.

Returns:

  • (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.

Returns:

  • (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.

Returns:

  • (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.

Returns:

  • (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.

Returns:

  • (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.

Returns:

  • (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.

Returns:

  • (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.

Returns:

  • (String) —

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

#display_name ⇒ String

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

Returns:

  • (String) —

    The display name for the branch.

#enable_auto_build ⇒ Boolean

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

Returns:

  • (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.

Returns:

  • (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.

Returns:

  • (Boolean) —

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

#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) —

    Enables performance mode for the branch.

#enable_pull_request_preview ⇒ Boolean

Enables pull request previews for the branch.

Returns:

  • (Boolean) —

    Enables pull request previews for the branch.

#environment_variables ⇒ Hash<String,String>

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

Returns:

  • (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.

Returns:

  • (String) —

    The framework for a branch of an Amplify app.

#pull_request_environment_name ⇒ String

The Amplify environment name for the pull request.

Returns:

  • (String) —

    The Amplify environment name for the pull request.

#source_branch ⇒ String

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

Returns:

  • (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.

Possible values:

  • PRODUCTION
  • BETA
  • DEVELOPMENT
  • EXPERIMENTAL
  • PULL_REQUEST

Returns:

  • (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.

Returns:

  • (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.

Returns:

  • (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.

Returns:

  • (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.

Returns:

  • (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.

Returns:

  • (Time) —

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