« blib/lib/Paws/Amplify/UntagResourceResponse.pm
↑ Summary
blib/lib/Paws/Amplify/UpdateAppResult.pm »
| 1 | |||
| 2 | package Paws::Amplify::UpdateApp; | ||
| 3 | use Moose; | ||
| 4 | has AccessToken => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'accessToken'); | ||
| 5 | has AppId => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'appId', required => 1); | ||
| 6 | has AutoBranchCreationConfig => (is => 'ro', isa => 'Paws::Amplify::AutoBranchCreationConfig', traits => ['NameInRequest'], request_name => 'autoBranchCreationConfig'); | ||
| 7 | has AutoBranchCreationPatterns => (is => 'ro', isa => 'ArrayRef[Str|Undef]', traits => ['NameInRequest'], request_name => 'autoBranchCreationPatterns'); | ||
| 8 | has BasicAuthCredentials => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'basicAuthCredentials'); | ||
| 9 | has BuildSpec => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'buildSpec'); | ||
| 10 | has CustomHeaders => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'customHeaders'); | ||
| 11 | has CustomRules => (is => 'ro', isa => 'ArrayRef[Paws::Amplify::CustomRule]', traits => ['NameInRequest'], request_name => 'customRules'); | ||
| 12 | has Description => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'description'); | ||
| 13 | has EnableAutoBranchCreation => (is => 'ro', isa => 'Bool', traits => ['NameInRequest'], request_name => 'enableAutoBranchCreation'); | ||
| 14 | has EnableBasicAuth => (is => 'ro', isa => 'Bool', traits => ['NameInRequest'], request_name => 'enableBasicAuth'); | ||
| 15 | has EnableBranchAutoBuild => (is => 'ro', isa => 'Bool', traits => ['NameInRequest'], request_name => 'enableBranchAutoBuild'); | ||
| 16 | has EnableBranchAutoDeletion => (is => 'ro', isa => 'Bool', traits => ['NameInRequest'], request_name => 'enableBranchAutoDeletion'); | ||
| 17 | has EnvironmentVariables => (is => 'ro', isa => 'Paws::Amplify::EnvironmentVariables', traits => ['NameInRequest'], request_name => 'environmentVariables'); | ||
| 18 | has IamServiceRoleArn => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'iamServiceRoleArn'); | ||
| 19 | has Name => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'name'); | ||
| 20 | has OauthToken => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'oauthToken'); | ||
| 21 | has Platform => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'platform'); | ||
| 22 | has Repository => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'repository'); | ||
| 23 | |||
| 24 | use MooseX::ClassAttribute; | ||
| 25 | |||
| 26 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'UpdateApp'); | ||
| 27 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/apps/{appId}'); | ||
| 28 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST'); | ||
| 29 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Amplify::UpdateAppResult'); | ||
| 30 | 1; | ||
| 31 | |||
| 32 | ### main pod documentation begin ### | ||
| 33 | |||
| 34 | =head1 NAME | ||
| 35 | |||
| 36 | Paws::Amplify::UpdateApp - Arguments for method UpdateApp on L<Paws::Amplify> | ||
| 37 | |||
| 38 | =head1 DESCRIPTION | ||
| 39 | |||
| 40 | This class represents the parameters used for calling the method UpdateApp on the | ||
| 41 | L<AWS Amplify|Paws::Amplify> service. Use the attributes of this class | ||
| 42 | as arguments to method UpdateApp. | ||
| 43 | |||
| 44 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to UpdateApp. | ||
| 45 | |||
| 46 | =head1 SYNOPSIS | ||
| 47 | |||
| 48 | my $amplify = Paws->service('Amplify'); | ||
| 49 | my $UpdateAppResult = $amplify->UpdateApp( | ||
| 50 | AppId => 'MyAppId', | ||
| 51 | AccessToken => 'MyAccessToken', # OPTIONAL | ||
| 52 | AutoBranchCreationConfig => { | ||
| 53 | BasicAuthCredentials => 'MyBasicAuthCredentials', # max: 2000; OPTIONAL | ||
| 54 | BuildSpec => 'MyBuildSpec', # min: 1, max: 25000; OPTIONAL | ||
| 55 | EnableAutoBuild => 1, # OPTIONAL | ||
| 56 | EnableBasicAuth => 1, # OPTIONAL | ||
| 57 | EnablePerformanceMode => 1, # OPTIONAL | ||
| 58 | EnablePullRequestPreview => 1, # OPTIONAL | ||
| 59 | EnvironmentVariables => { | ||
| 60 | 'MyEnvKey' => 'MyEnvValue', # key: max: 255, value: max: 1000 | ||
| 61 | }, # OPTIONAL | ||
| 62 | Framework => 'MyFramework', # max: 255; OPTIONAL | ||
| 63 | PullRequestEnvironmentName => | ||
| 64 | 'MyPullRequestEnvironmentName', # max: 20; OPTIONAL | ||
| 65 | Stage => 'PRODUCTION' | ||
| 66 | , # values: PRODUCTION, BETA, DEVELOPMENT, EXPERIMENTAL, PULL_REQUEST; OPTIONAL | ||
| 67 | }, # OPTIONAL | ||
| 68 | AutoBranchCreationPatterns => [ | ||
| 69 | 'MyAutoBranchCreationPattern', ... # min: 1, max: 2048 | ||
| 70 | ], # OPTIONAL | ||
| 71 | BasicAuthCredentials => 'MyBasicAuthCredentials', # OPTIONAL | ||
| 72 | BuildSpec => 'MyBuildSpec', # OPTIONAL | ||
| 73 | CustomHeaders => 'MyCustomHeaders', # OPTIONAL | ||
| 74 | CustomRules => [ | ||
| 75 | { | ||
| 76 | Source => 'MySource', # min: 1, max: 2048 | ||
| 77 | Target => 'MyTarget', # min: 1, max: 2048 | ||
| 78 | Condition => 'MyCondition', # min: 1, max: 2048; OPTIONAL | ||
| 79 | Status => 'MyStatus', # min: 3, max: 7; OPTIONAL | ||
| 80 | }, | ||
| 81 | ... | ||
| 82 | ], # OPTIONAL | ||
| 83 | Description => 'MyDescription', # OPTIONAL | ||
| 84 | EnableAutoBranchCreation => 1, # OPTIONAL | ||
| 85 | EnableBasicAuth => 1, # OPTIONAL | ||
| 86 | EnableBranchAutoBuild => 1, # OPTIONAL | ||
| 87 | EnableBranchAutoDeletion => 1, # OPTIONAL | ||
| 88 | EnvironmentVariables => { | ||
| 89 | 'MyEnvKey' => 'MyEnvValue', # key: max: 255, value: max: 1000 | ||
| 90 | }, # OPTIONAL | ||
| 91 | IamServiceRoleArn => 'MyServiceRoleArn', # OPTIONAL | ||
| 92 | Name => 'MyName', # OPTIONAL | ||
| 93 | OauthToken => 'MyOauthToken', # OPTIONAL | ||
| 94 | Platform => 'WEB', # OPTIONAL | ||
| 95 | Repository => 'MyRepository', # OPTIONAL | ||
| 96 | ); | ||
| 97 | |||
| 98 | # Results: | ||
| 99 | my $App = $UpdateAppResult->App; | ||
| 100 | |||
| 101 | # Returns a L<Paws::Amplify::UpdateAppResult> object. | ||
| 102 | |||
| 103 | 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. | ||
| 104 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/amplify/UpdateApp> | ||
| 105 | |||
| 106 | =head1 ATTRIBUTES | ||
| 107 | |||
| 108 | |||
| 109 | =head2 AccessToken => Str | ||
| 110 | |||
| 111 | The personal access token for a third-party source control system for | ||
| 112 | an Amplify app. The token is used to create webhook and a read-only | ||
| 113 | deploy key. The token is not stored. | ||
| 114 | |||
| 115 | |||
| 116 | |||
| 117 | =head2 B<REQUIRED> AppId => Str | ||
| 118 | |||
| 119 | The unique ID for an Amplify app. | ||
| 120 | |||
| 121 | |||
| 122 | |||
| 123 | =head2 AutoBranchCreationConfig => L<Paws::Amplify::AutoBranchCreationConfig> | ||
| 124 | |||
| 125 | The automated branch creation configuration for an Amplify app. | ||
| 126 | |||
| 127 | |||
| 128 | |||
| 129 | =head2 AutoBranchCreationPatterns => ArrayRef[Str|Undef] | ||
| 130 | |||
| 131 | Describes the automated branch creation glob patterns for an Amplify | ||
| 132 | app. | ||
| 133 | |||
| 134 | |||
| 135 | |||
| 136 | =head2 BasicAuthCredentials => Str | ||
| 137 | |||
| 138 | The basic authorization credentials for an Amplify app. | ||
| 139 | |||
| 140 | |||
| 141 | |||
| 142 | =head2 BuildSpec => Str | ||
| 143 | |||
| 144 | The build specification (build spec) for an Amplify app. | ||
| 145 | |||
| 146 | |||
| 147 | |||
| 148 | =head2 CustomHeaders => Str | ||
| 149 | |||
| 150 | The custom HTTP headers for an Amplify app. | ||
| 151 | |||
| 152 | |||
| 153 | |||
| 154 | =head2 CustomRules => ArrayRef[L<Paws::Amplify::CustomRule>] | ||
| 155 | |||
| 156 | The custom redirect and rewrite rules for an Amplify app. | ||
| 157 | |||
| 158 | |||
| 159 | |||
| 160 | =head2 Description => Str | ||
| 161 | |||
| 162 | The description for an Amplify app. | ||
| 163 | |||
| 164 | |||
| 165 | |||
| 166 | =head2 EnableAutoBranchCreation => Bool | ||
| 167 | |||
| 168 | Enables automated branch creation for an Amplify app. | ||
| 169 | |||
| 170 | |||
| 171 | |||
| 172 | =head2 EnableBasicAuth => Bool | ||
| 173 | |||
| 174 | Enables basic authorization for an Amplify app. | ||
| 175 | |||
| 176 | |||
| 177 | |||
| 178 | =head2 EnableBranchAutoBuild => Bool | ||
| 179 | |||
| 180 | Enables branch auto-building for an Amplify app. | ||
| 181 | |||
| 182 | |||
| 183 | |||
| 184 | =head2 EnableBranchAutoDeletion => Bool | ||
| 185 | |||
| 186 | Automatically disconnects a branch in the Amplify Console when you | ||
| 187 | delete a branch from your Git repository. | ||
| 188 | |||
| 189 | |||
| 190 | |||
| 191 | =head2 EnvironmentVariables => L<Paws::Amplify::EnvironmentVariables> | ||
| 192 | |||
| 193 | The environment variables for an Amplify app. | ||
| 194 | |||
| 195 | |||
| 196 | |||
| 197 | =head2 IamServiceRoleArn => Str | ||
| 198 | |||
| 199 | The AWS Identity and Access Management (IAM) service role for an | ||
| 200 | Amplify app. | ||
| 201 | |||
| 202 | |||
| 203 | |||
| 204 | =head2 Name => Str | ||
| 205 | |||
| 206 | The name for an Amplify app. | ||
| 207 | |||
| 208 | |||
| 209 | |||
| 210 | =head2 OauthToken => Str | ||
| 211 | |||
| 212 | The OAuth token for a third-party source control system for an Amplify | ||
| 213 | app. The token is used to create a webhook and a read-only deploy key. | ||
| 214 | The OAuth token is not stored. | ||
| 215 | |||
| 216 | |||
| 217 | |||
| 218 | =head2 Platform => Str | ||
| 219 | |||
| 220 | The platform for an Amplify app. | ||
| 221 | |||
| 222 | Valid values are: C<"WEB"> | ||
| 223 | |||
| 224 | =head2 Repository => Str | ||
| 225 | |||
| 226 | The name of the repository for an Amplify app | ||
| 227 | |||
| 228 | |||
| 229 | |||
| 230 | |||
| 231 | =head1 SEE ALSO | ||
| 232 | |||
| 233 | This class forms part of L<Paws>, documenting arguments for method UpdateApp in L<Paws::Amplify> | ||
| 234 | |||
| 235 | =head1 BUGS and CONTRIBUTIONS | ||
| 236 | |||
| 237 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 238 | |||
| 239 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 240 | |||
| 241 | =cut | ||
| 242 |