| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::Amplify::Branch; | ||
| 3 | use Moose; | ||
| 4 | has ActiveJobId => (is => 'ro', isa => 'Str', request_name => 'activeJobId', traits => ['NameInRequest'], required => 1); | ||
| 5 | has AssociatedResources => (is => 'ro', isa => 'ArrayRef[Str|Undef]', request_name => 'associatedResources', traits => ['NameInRequest']); | ||
| 6 | has BackendEnvironmentArn => (is => 'ro', isa => 'Str', request_name => 'backendEnvironmentArn', traits => ['NameInRequest']); | ||
| 7 | has BasicAuthCredentials => (is => 'ro', isa => 'Str', request_name => 'basicAuthCredentials', traits => ['NameInRequest']); | ||
| 8 | has BranchArn => (is => 'ro', isa => 'Str', request_name => 'branchArn', traits => ['NameInRequest'], required => 1); | ||
| 9 | has BranchName => (is => 'ro', isa => 'Str', request_name => 'branchName', traits => ['NameInRequest'], required => 1); | ||
| 10 | has BuildSpec => (is => 'ro', isa => 'Str', request_name => 'buildSpec', traits => ['NameInRequest']); | ||
| 11 | has CreateTime => (is => 'ro', isa => 'Str', request_name => 'createTime', traits => ['NameInRequest'], required => 1); | ||
| 12 | has CustomDomains => (is => 'ro', isa => 'ArrayRef[Str|Undef]', request_name => 'customDomains', traits => ['NameInRequest'], required => 1); | ||
| 13 | has Description => (is => 'ro', isa => 'Str', request_name => 'description', traits => ['NameInRequest'], required => 1); | ||
| 14 | has DestinationBranch => (is => 'ro', isa => 'Str', request_name => 'destinationBranch', traits => ['NameInRequest']); | ||
| 15 | has DisplayName => (is => 'ro', isa => 'Str', request_name => 'displayName', traits => ['NameInRequest'], required => 1); | ||
| 16 | has EnableAutoBuild => (is => 'ro', isa => 'Bool', request_name => 'enableAutoBuild', traits => ['NameInRequest'], required => 1); | ||
| 17 | has EnableBasicAuth => (is => 'ro', isa => 'Bool', request_name => 'enableBasicAuth', traits => ['NameInRequest'], required => 1); | ||
| 18 | has EnableNotification => (is => 'ro', isa => 'Bool', request_name => 'enableNotification', traits => ['NameInRequest'], required => 1); | ||
| 19 | has EnablePerformanceMode => (is => 'ro', isa => 'Bool', request_name => 'enablePerformanceMode', traits => ['NameInRequest']); | ||
| 20 | has EnablePullRequestPreview => (is => 'ro', isa => 'Bool', request_name => 'enablePullRequestPreview', traits => ['NameInRequest'], required => 1); | ||
| 21 | has EnvironmentVariables => (is => 'ro', isa => 'Paws::Amplify::EnvironmentVariables', request_name => 'environmentVariables', traits => ['NameInRequest'], required => 1); | ||
| 22 | has Framework => (is => 'ro', isa => 'Str', request_name => 'framework', traits => ['NameInRequest'], required => 1); | ||
| 23 | has PullRequestEnvironmentName => (is => 'ro', isa => 'Str', request_name => 'pullRequestEnvironmentName', traits => ['NameInRequest']); | ||
| 24 | has SourceBranch => (is => 'ro', isa => 'Str', request_name => 'sourceBranch', traits => ['NameInRequest']); | ||
| 25 | has Stage => (is => 'ro', isa => 'Str', request_name => 'stage', traits => ['NameInRequest'], required => 1); | ||
| 26 | has Tags => (is => 'ro', isa => 'Paws::Amplify::TagMap', request_name => 'tags', traits => ['NameInRequest']); | ||
| 27 | has ThumbnailUrl => (is => 'ro', isa => 'Str', request_name => 'thumbnailUrl', traits => ['NameInRequest']); | ||
| 28 | has TotalNumberOfJobs => (is => 'ro', isa => 'Str', request_name => 'totalNumberOfJobs', traits => ['NameInRequest'], required => 1); | ||
| 29 | has Ttl => (is => 'ro', isa => 'Str', request_name => 'ttl', traits => ['NameInRequest'], required => 1); | ||
| 30 | has UpdateTime => (is => 'ro', isa => 'Str', request_name => 'updateTime', traits => ['NameInRequest'], required => 1); | ||
| 31 | |||
| 32 | 1; | ||
| 33 | |||
| 34 | ### main pod documentation begin ### | ||
| 35 | |||
| 36 | =head1 NAME | ||
| 37 | |||
| 38 | Paws::Amplify::Branch | ||
| 39 | |||
| 40 | =head1 USAGE | ||
| 41 | |||
| 42 | This class represents one of two things: | ||
| 43 | |||
| 44 | =head3 Arguments in a call to a service | ||
| 45 | |||
| 46 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 47 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 48 | |||
| 49 | As an example, if Att1 is expected to be a Paws::Amplify::Branch object: | ||
| 50 | |||
| 51 | $service_obj->Method(Att1 => { ActiveJobId => $value, ..., UpdateTime => $value }); | ||
| 52 | |||
| 53 | =head3 Results returned from an API call | ||
| 54 | |||
| 55 | Use accessors for each attribute. If Att1 is expected to be an Paws::Amplify::Branch object: | ||
| 56 | |||
| 57 | $result = $service_obj->Method(...); | ||
| 58 | $result->Att1->ActiveJobId | ||
| 59 | |||
| 60 | =head1 DESCRIPTION | ||
| 61 | |||
| 62 | The branch for an Amplify app, which maps to a third-party repository | ||
| 63 | branch. | ||
| 64 | |||
| 65 | =head1 ATTRIBUTES | ||
| 66 | |||
| 67 | |||
| 68 | =head2 B<REQUIRED> ActiveJobId => Str | ||
| 69 | |||
| 70 | The ID of the active job for a branch of an Amplify app. | ||
| 71 | |||
| 72 | |||
| 73 | =head2 AssociatedResources => ArrayRef[Str|Undef] | ||
| 74 | |||
| 75 | A list of custom resources that are linked to this branch. | ||
| 76 | |||
| 77 | |||
| 78 | =head2 BackendEnvironmentArn => Str | ||
| 79 | |||
| 80 | The Amazon Resource Name (ARN) for a backend environment that is part | ||
| 81 | of an Amplify app. | ||
| 82 | |||
| 83 | |||
| 84 | =head2 BasicAuthCredentials => Str | ||
| 85 | |||
| 86 | The basic authorization credentials for a branch of an Amplify app. | ||
| 87 | |||
| 88 | |||
| 89 | =head2 B<REQUIRED> BranchArn => Str | ||
| 90 | |||
| 91 | The Amazon Resource Name (ARN) for a branch that is part of an Amplify | ||
| 92 | app. | ||
| 93 | |||
| 94 | |||
| 95 | =head2 B<REQUIRED> BranchName => Str | ||
| 96 | |||
| 97 | The name for the branch that is part of an Amplify app. | ||
| 98 | |||
| 99 | |||
| 100 | =head2 BuildSpec => Str | ||
| 101 | |||
| 102 | The build specification (build spec) content for the branch of an | ||
| 103 | Amplify app. | ||
| 104 | |||
| 105 | |||
| 106 | =head2 B<REQUIRED> CreateTime => Str | ||
| 107 | |||
| 108 | The creation date and time for a branch that is part of an Amplify app. | ||
| 109 | |||
| 110 | |||
| 111 | =head2 B<REQUIRED> CustomDomains => ArrayRef[Str|Undef] | ||
| 112 | |||
| 113 | The custom domains for a branch of an Amplify app. | ||
| 114 | |||
| 115 | |||
| 116 | =head2 B<REQUIRED> Description => Str | ||
| 117 | |||
| 118 | The description for the branch that is part of an Amplify app. | ||
| 119 | |||
| 120 | |||
| 121 | =head2 DestinationBranch => Str | ||
| 122 | |||
| 123 | The destination branch if the branch is a pull request branch. | ||
| 124 | |||
| 125 | |||
| 126 | =head2 B<REQUIRED> DisplayName => Str | ||
| 127 | |||
| 128 | The display name for the branch. This is used as the default domain | ||
| 129 | prefix. | ||
| 130 | |||
| 131 | |||
| 132 | =head2 B<REQUIRED> EnableAutoBuild => Bool | ||
| 133 | |||
| 134 | Enables auto-building on push for a branch of an Amplify app. | ||
| 135 | |||
| 136 | |||
| 137 | =head2 B<REQUIRED> EnableBasicAuth => Bool | ||
| 138 | |||
| 139 | Enables basic authorization for a branch of an Amplify app. | ||
| 140 | |||
| 141 | |||
| 142 | =head2 B<REQUIRED> EnableNotification => Bool | ||
| 143 | |||
| 144 | Enables notifications for a branch that is part of an Amplify app. | ||
| 145 | |||
| 146 | |||
| 147 | =head2 EnablePerformanceMode => Bool | ||
| 148 | |||
| 149 | Enables performance mode for the branch. | ||
| 150 | |||
| 151 | Performance mode optimizes for faster hosting performance by keeping | ||
| 152 | content cached at the edge for a longer interval. When performance mode | ||
| 153 | is enabled, hosting configuration or code changes can take up to 10 | ||
| 154 | minutes to roll out. | ||
| 155 | |||
| 156 | |||
| 157 | =head2 B<REQUIRED> EnablePullRequestPreview => Bool | ||
| 158 | |||
| 159 | Enables pull request previews for the branch. | ||
| 160 | |||
| 161 | |||
| 162 | =head2 B<REQUIRED> EnvironmentVariables => L<Paws::Amplify::EnvironmentVariables> | ||
| 163 | |||
| 164 | The environment variables specific to a branch of an Amplify app. | ||
| 165 | |||
| 166 | |||
| 167 | =head2 B<REQUIRED> Framework => Str | ||
| 168 | |||
| 169 | The framework for a branch of an Amplify app. | ||
| 170 | |||
| 171 | |||
| 172 | =head2 PullRequestEnvironmentName => Str | ||
| 173 | |||
| 174 | The Amplify environment name for the pull request. | ||
| 175 | |||
| 176 | |||
| 177 | =head2 SourceBranch => Str | ||
| 178 | |||
| 179 | The source branch if the branch is a pull request branch. | ||
| 180 | |||
| 181 | |||
| 182 | =head2 B<REQUIRED> Stage => Str | ||
| 183 | |||
| 184 | The current stage for the branch that is part of an Amplify app. | ||
| 185 | |||
| 186 | |||
| 187 | =head2 Tags => L<Paws::Amplify::TagMap> | ||
| 188 | |||
| 189 | The tag for the branch of an Amplify app. | ||
| 190 | |||
| 191 | |||
| 192 | =head2 ThumbnailUrl => Str | ||
| 193 | |||
| 194 | The thumbnail URL for the branch of an Amplify app. | ||
| 195 | |||
| 196 | |||
| 197 | =head2 B<REQUIRED> TotalNumberOfJobs => Str | ||
| 198 | |||
| 199 | The total number of jobs that are part of an Amplify app. | ||
| 200 | |||
| 201 | |||
| 202 | =head2 B<REQUIRED> Ttl => Str | ||
| 203 | |||
| 204 | The content Time to Live (TTL) for the website in seconds. | ||
| 205 | |||
| 206 | |||
| 207 | =head2 B<REQUIRED> UpdateTime => Str | ||
| 208 | |||
| 209 | The last updated date and time for a branch that is part of an Amplify | ||
| 210 | app. | ||
| 211 | |||
| 212 | |||
| 213 | |||
| 214 | =head1 SEE ALSO | ||
| 215 | |||
| 216 | This class forms part of L<Paws>, describing an object used in L<Paws::Amplify> | ||
| 217 | |||
| 218 | =head1 BUGS and CONTRIBUTIONS | ||
| 219 | |||
| 220 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 221 | |||
| 222 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 223 | |||
| 224 | =cut | ||
| 225 |