NAME

Paws::Amplify::Branch

USAGE

This class represents one of two things:

Arguments in a call to a service

Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. Each attribute should be used as a named argument in the calls that expect this type of object.

As an example, if Att1 is expected to be a Paws::Amplify::Branch object:

$service_obj->Method(Att1 => { ActiveJobId => $value, ..., UpdateTime => $value  });

Results returned from an API call

Use accessors for each attribute. If Att1 is expected to be an Paws::Amplify::Branch object:

$result = $service_obj->Method(...);
$result->Att1->ActiveJobId

DESCRIPTION

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

ATTRIBUTES

REQUIRED ActiveJobId => Str

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

AssociatedResources => ArrayRef[Str|Undef]

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

BackendEnvironmentArn => Str

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

BasicAuthCredentials => Str

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

REQUIRED BranchArn => Str

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

REQUIRED BranchName => Str

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

BuildSpec => Str

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

REQUIRED CreateTime => Str

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

REQUIRED CustomDomains => ArrayRef[Str|Undef]

The custom domains for a branch of an Amplify app.

REQUIRED Description => Str

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

DestinationBranch => Str

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

REQUIRED DisplayName => Str

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

REQUIRED EnableAutoBuild => Bool

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

REQUIRED EnableBasicAuth => Bool

Enables basic authorization for a branch of an Amplify app.

REQUIRED EnableNotification => Bool

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

EnablePerformanceMode => Bool

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.

REQUIRED EnablePullRequestPreview => Bool

Enables pull request previews for the branch.

REQUIRED EnvironmentVariables => Paws::Amplify::EnvironmentVariables

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

REQUIRED Framework => Str

The framework for a branch of an Amplify app.

PullRequestEnvironmentName => Str

The Amplify environment name for the pull request.

SourceBranch => Str

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

REQUIRED Stage => Str

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

Tags => Paws::Amplify::TagMap

The tag for the branch of an Amplify app.

ThumbnailUrl => Str

The thumbnail URL for the branch of an Amplify app.

REQUIRED TotalNumberOfJobs => Str

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

REQUIRED Ttl => Str

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

REQUIRED UpdateTime => Str

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

SEE ALSO

This class forms part of Paws, describing an object used in Paws::Amplify

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues