AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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:

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)

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

#associated_resourcesArray<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_arnString

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_credentialsString

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_arnString

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_nameString

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_specString

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_timeTime

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_domainsArray<String>

The custom domains for a branch of an Amplify app.

Returns:

  • (Array<String>)

    The custom domains for a branch of an Amplify app.

#descriptionString

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_branchString

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_nameString

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

Returns:

  • (String)

    The display name for the branch.

#enable_auto_buildBoolean

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_authBoolean

Enables basic authorization for a branch of an Amplify app.

Returns:

  • (Boolean)

    Enables basic authorization for a branch of an Amplify app.

#enable_notificationBoolean

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_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)

    Enables performance mode for the branch.

#enable_pull_request_previewBoolean

Enables pull request previews for the branch.

Returns:

  • (Boolean)

    Enables pull request previews for the branch.

#environment_variablesHash<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.

#frameworkString

The framework for a branch of an Amplify app.

Returns:

  • (String)

    The framework for a branch of an Amplify app.

#pull_request_environment_nameString

The Amplify environment name for the pull request.

Returns:

  • (String)

    The Amplify environment name for the pull request.

#source_branchString

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

Returns:

  • (String)

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

#stageString

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.

#tagsHash<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_urlString

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_jobsString

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.

#ttlString

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_timeTime

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.