class Aws::Amplify::Types::Branch

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

@!attribute [rw] branch_arn

The Amazon Resource Name (ARN) for a branch that is part of an
Amplify app.
@return [String]

@!attribute [rw] branch_name

The name for the branch that is part of an Amplify app.
@return [String]

@!attribute [rw] description

The description for the branch that is part of an Amplify app.
@return [String]

@!attribute [rw] tags

The tag for the branch of an Amplify app.
@return [Hash<String,String>]

@!attribute [rw] stage

The current stage for the branch that is part of an Amplify app.
@return [String]

@!attribute [rw] display_name

The display name for the branch. This is used as the default domain
prefix.
@return [String]

@!attribute [rw] enable_notification

Enables notifications for a branch that is part of an Amplify app.
@return [Boolean]

@!attribute [rw] create_time

The creation date and time for a branch that is part of an Amplify
app.
@return [Time]

@!attribute [rw] update_time

The last updated date and time for a branch that is part of an
Amplify app.
@return [Time]

@!attribute [rw] environment_variables

The environment variables specific to a branch of an Amplify app.
@return [Hash<String,String>]

@!attribute [rw] enable_auto_build

Enables auto-building on push for a branch of an Amplify app.
@return [Boolean]

@!attribute [rw] custom_domains

The custom domains for a branch of an Amplify app.
@return [Array<String>]

@!attribute [rw] framework

The framework for a branch of an Amplify app.
@return [String]

@!attribute [rw] active_job_id

The ID of the active job for a branch of an Amplify app.
@return [String]

@!attribute [rw] total_number_of_jobs

The total number of jobs that are part of an Amplify app.
@return [String]

@!attribute [rw] enable_basic_auth

Enables basic authorization for a branch of an Amplify app.
@return [Boolean]

@!attribute [rw] enable_performance_mode

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.
@return [Boolean]

@!attribute [rw] thumbnail_url

The thumbnail URL for the branch of an Amplify app.
@return [String]

@!attribute [rw] basic_auth_credentials

The basic authorization credentials for a branch of an Amplify app.
@return [String]

@!attribute [rw] build_spec

The build specification (build spec) content for the branch of an
Amplify app.
@return [String]

@!attribute [rw] ttl

The content Time to Live (TTL) for the website in seconds.
@return [String]

@!attribute [rw] associated_resources

A list of custom resources that are linked to this branch.
@return [Array<String>]

@!attribute [rw] enable_pull_request_preview

Enables pull request previews for the branch.
@return [Boolean]

@!attribute [rw] pull_request_environment_name

The Amplify environment name for the pull request.
@return [String]

@!attribute [rw] destination_branch

The destination branch if the branch is a pull request branch.
@return [String]

@!attribute [rw] source_branch

The source branch if the branch is a pull request branch.
@return [String]

@!attribute [rw] backend_environment_arn

The Amazon Resource Name (ARN) for a backend environment that is
part of an Amplify app.
@return [String]

@see docs.aws.amazon.com/goto/WebAPI/amplify-2017-07-25/Branch AWS API Documentation

Constants

SENSITIVE