The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.

NAME

Paws::Amplify::UpdateBranch - Arguments for method UpdateBranch on Paws::Amplify

DESCRIPTION

This class represents the parameters used for calling the method UpdateBranch on the AWS Amplify service. Use the attributes of this class as arguments to method UpdateBranch.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to UpdateBranch.

SYNOPSIS

    my $amplify = Paws->service('Amplify');
    my $UpdateBranchResult = $amplify->UpdateBranch(
      AppId                    => 'MyAppId',
      BranchName               => 'MyBranchName',
      BackendEnvironmentArn    => 'MyBackendEnvironmentArn',    # OPTIONAL
      BasicAuthCredentials     => 'MyBasicAuthCredentials',     # OPTIONAL
      BuildSpec                => 'MyBuildSpec',                # OPTIONAL
      Description              => 'MyDescription',              # OPTIONAL
      DisplayName              => 'MyDisplayName',              # OPTIONAL
      EnableAutoBuild          => 1,                            # OPTIONAL
      EnableBasicAuth          => 1,                            # OPTIONAL
      EnableNotification       => 1,                            # OPTIONAL
      EnablePerformanceMode    => 1,                            # OPTIONAL
      EnablePullRequestPreview => 1,                            # OPTIONAL
      EnvironmentVariables     => {
        'MyEnvKey' => 'MyEnvValue',    # key: max: 255, value: max: 1000
      },    # OPTIONAL
      Framework                  => 'MyFramework',                    # OPTIONAL
      PullRequestEnvironmentName => 'MyPullRequestEnvironmentName',   # OPTIONAL
      Stage                      => 'PRODUCTION',                     # OPTIONAL
      Ttl                        => 'MyTTL',                          # OPTIONAL
    );

    # Results:
    my $Branch = $UpdateBranchResult->Branch;

    # Returns a L<Paws::Amplify::UpdateBranchResult> object.

Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/amplify/UpdateBranch

ATTRIBUTES

REQUIRED AppId => Str

The unique ID for an Amplify app.

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 the branch.

REQUIRED BranchName => Str

The name for the branch.

BuildSpec => Str

The build specification (build spec) for the branch.

Description => Str

The description for the branch.

DisplayName => Str

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

EnableAutoBuild => Bool

Enables auto building for the branch.

EnableBasicAuth => Bool

Enables basic authorization for the branch.

EnableNotification => Bool

Enables notifications for the branch.

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.

EnablePullRequestPreview => Bool

Enables pull request previews for this branch.

EnvironmentVariables => Paws::Amplify::EnvironmentVariables

The environment variables for the branch.

Framework => Str

The framework for the branch.

PullRequestEnvironmentName => Str

The Amplify environment name for the pull request.

Stage => Str

Describes the current stage for the branch.

Valid values are: "PRODUCTION", "BETA", "DEVELOPMENT", "EXPERIMENTAL", "PULL_REQUEST"

Ttl => Str

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

SEE ALSO

This class forms part of Paws, documenting arguments for method UpdateBranch 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