| 1 | |||
| 2 | package Paws::Amplify::UpdateBranch; | ||
| 3 | use Moose; | ||
| 4 | has AppId => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'appId', required => 1); | ||
| 5 | has BackendEnvironmentArn => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'backendEnvironmentArn'); | ||
| 6 | has BasicAuthCredentials => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'basicAuthCredentials'); | ||
| 7 | has BranchName => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'branchName', required => 1); | ||
| 8 | has BuildSpec => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'buildSpec'); | ||
| 9 | has Description => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'description'); | ||
| 10 | has DisplayName => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'displayName'); | ||
| 11 | has EnableAutoBuild => (is => 'ro', isa => 'Bool', traits => ['NameInRequest'], request_name => 'enableAutoBuild'); | ||
| 12 | has EnableBasicAuth => (is => 'ro', isa => 'Bool', traits => ['NameInRequest'], request_name => 'enableBasicAuth'); | ||
| 13 | has EnableNotification => (is => 'ro', isa => 'Bool', traits => ['NameInRequest'], request_name => 'enableNotification'); | ||
| 14 | has EnablePerformanceMode => (is => 'ro', isa => 'Bool', traits => ['NameInRequest'], request_name => 'enablePerformanceMode'); | ||
| 15 | has EnablePullRequestPreview => (is => 'ro', isa => 'Bool', traits => ['NameInRequest'], request_name => 'enablePullRequestPreview'); | ||
| 16 | has EnvironmentVariables => (is => 'ro', isa => 'Paws::Amplify::EnvironmentVariables', traits => ['NameInRequest'], request_name => 'environmentVariables'); | ||
| 17 | has Framework => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'framework'); | ||
| 18 | has PullRequestEnvironmentName => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'pullRequestEnvironmentName'); | ||
| 19 | has Stage => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'stage'); | ||
| 20 | has Ttl => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'ttl'); | ||
| 21 | |||
| 22 | use MooseX::ClassAttribute; | ||
| 23 | |||
| 24 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'UpdateBranch'); | ||
| 25 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/apps/{appId}/branches/{branchName}'); | ||
| 26 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST'); | ||
| 27 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Amplify::UpdateBranchResult'); | ||
| 28 | 1; | ||
| 29 | |||
| 30 | ### main pod documentation begin ### | ||
| 31 | |||
| 32 | =head1 NAME | ||
| 33 | |||
| 34 | Paws::Amplify::UpdateBranch - Arguments for method UpdateBranch on L<Paws::Amplify> | ||
| 35 | |||
| 36 | =head1 DESCRIPTION | ||
| 37 | |||
| 38 | This class represents the parameters used for calling the method UpdateBranch on the | ||
| 39 | L<AWS Amplify|Paws::Amplify> service. Use the attributes of this class | ||
| 40 | as arguments to method UpdateBranch. | ||
| 41 | |||
| 42 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to UpdateBranch. | ||
| 43 | |||
| 44 | =head1 SYNOPSIS | ||
| 45 | |||
| 46 | my $amplify = Paws->service('Amplify'); | ||
| 47 | my $UpdateBranchResult = $amplify->UpdateBranch( | ||
| 48 | AppId => 'MyAppId', | ||
| 49 | BranchName => 'MyBranchName', | ||
| 50 | BackendEnvironmentArn => 'MyBackendEnvironmentArn', # OPTIONAL | ||
| 51 | BasicAuthCredentials => 'MyBasicAuthCredentials', # OPTIONAL | ||
| 52 | BuildSpec => 'MyBuildSpec', # OPTIONAL | ||
| 53 | Description => 'MyDescription', # OPTIONAL | ||
| 54 | DisplayName => 'MyDisplayName', # OPTIONAL | ||
| 55 | EnableAutoBuild => 1, # OPTIONAL | ||
| 56 | EnableBasicAuth => 1, # OPTIONAL | ||
| 57 | EnableNotification => 1, # OPTIONAL | ||
| 58 | EnablePerformanceMode => 1, # OPTIONAL | ||
| 59 | EnablePullRequestPreview => 1, # OPTIONAL | ||
| 60 | EnvironmentVariables => { | ||
| 61 | 'MyEnvKey' => 'MyEnvValue', # key: max: 255, value: max: 1000 | ||
| 62 | }, # OPTIONAL | ||
| 63 | Framework => 'MyFramework', # OPTIONAL | ||
| 64 | PullRequestEnvironmentName => 'MyPullRequestEnvironmentName', # OPTIONAL | ||
| 65 | Stage => 'PRODUCTION', # OPTIONAL | ||
| 66 | Ttl => 'MyTTL', # OPTIONAL | ||
| 67 | ); | ||
| 68 | |||
| 69 | # Results: | ||
| 70 | my $Branch = $UpdateBranchResult->Branch; | ||
| 71 | |||
| 72 | # Returns a L<Paws::Amplify::UpdateBranchResult> object. | ||
| 73 | |||
| 74 | 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. | ||
| 75 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/amplify/UpdateBranch> | ||
| 76 | |||
| 77 | =head1 ATTRIBUTES | ||
| 78 | |||
| 79 | |||
| 80 | =head2 B<REQUIRED> AppId => Str | ||
| 81 | |||
| 82 | The unique ID for an Amplify app. | ||
| 83 | |||
| 84 | |||
| 85 | |||
| 86 | =head2 BackendEnvironmentArn => Str | ||
| 87 | |||
| 88 | The Amazon Resource Name (ARN) for a backend environment that is part | ||
| 89 | of an Amplify app. | ||
| 90 | |||
| 91 | |||
| 92 | |||
| 93 | =head2 BasicAuthCredentials => Str | ||
| 94 | |||
| 95 | The basic authorization credentials for the branch. | ||
| 96 | |||
| 97 | |||
| 98 | |||
| 99 | =head2 B<REQUIRED> BranchName => Str | ||
| 100 | |||
| 101 | The name for the branch. | ||
| 102 | |||
| 103 | |||
| 104 | |||
| 105 | =head2 BuildSpec => Str | ||
| 106 | |||
| 107 | The build specification (build spec) for the branch. | ||
| 108 | |||
| 109 | |||
| 110 | |||
| 111 | =head2 Description => Str | ||
| 112 | |||
| 113 | The description for the branch. | ||
| 114 | |||
| 115 | |||
| 116 | |||
| 117 | =head2 DisplayName => Str | ||
| 118 | |||
| 119 | The display name for a branch. This is used as the default domain | ||
| 120 | prefix. | ||
| 121 | |||
| 122 | |||
| 123 | |||
| 124 | =head2 EnableAutoBuild => Bool | ||
| 125 | |||
| 126 | Enables auto building for the branch. | ||
| 127 | |||
| 128 | |||
| 129 | |||
| 130 | =head2 EnableBasicAuth => Bool | ||
| 131 | |||
| 132 | Enables basic authorization for the branch. | ||
| 133 | |||
| 134 | |||
| 135 | |||
| 136 | =head2 EnableNotification => Bool | ||
| 137 | |||
| 138 | Enables notifications for the branch. | ||
| 139 | |||
| 140 | |||
| 141 | |||
| 142 | =head2 EnablePerformanceMode => Bool | ||
| 143 | |||
| 144 | Enables performance mode for the branch. | ||
| 145 | |||
| 146 | Performance mode optimizes for faster hosting performance by keeping | ||
| 147 | content cached at the edge for a longer interval. When performance mode | ||
| 148 | is enabled, hosting configuration or code changes can take up to 10 | ||
| 149 | minutes to roll out. | ||
| 150 | |||
| 151 | |||
| 152 | |||
| 153 | =head2 EnablePullRequestPreview => Bool | ||
| 154 | |||
| 155 | Enables pull request previews for this branch. | ||
| 156 | |||
| 157 | |||
| 158 | |||
| 159 | =head2 EnvironmentVariables => L<Paws::Amplify::EnvironmentVariables> | ||
| 160 | |||
| 161 | The environment variables for the branch. | ||
| 162 | |||
| 163 | |||
| 164 | |||
| 165 | =head2 Framework => Str | ||
| 166 | |||
| 167 | The framework for the branch. | ||
| 168 | |||
| 169 | |||
| 170 | |||
| 171 | =head2 PullRequestEnvironmentName => Str | ||
| 172 | |||
| 173 | The Amplify environment name for the pull request. | ||
| 174 | |||
| 175 | |||
| 176 | |||
| 177 | =head2 Stage => Str | ||
| 178 | |||
| 179 | Describes the current stage for the branch. | ||
| 180 | |||
| 181 | Valid values are: C<"PRODUCTION">, C<"BETA">, C<"DEVELOPMENT">, C<"EXPERIMENTAL">, C<"PULL_REQUEST"> | ||
| 182 | |||
| 183 | =head2 Ttl => Str | ||
| 184 | |||
| 185 | The content Time to Live (TTL) for the website in seconds. | ||
| 186 | |||
| 187 | |||
| 188 | |||
| 189 | |||
| 190 | =head1 SEE ALSO | ||
| 191 | |||
| 192 | This class forms part of L<Paws>, documenting arguments for method UpdateBranch in L<Paws::Amplify> | ||
| 193 | |||
| 194 | =head1 BUGS and CONTRIBUTIONS | ||
| 195 | |||
| 196 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 197 | |||
| 198 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 199 | |||
| 200 | =cut | ||
| 201 |