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