blib/lib/Paws/MWAA/Environment.pm untested

filter: Statementstmt 0.0% 0 / 29 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 1 Podpod n/a totaltotal 0.0% 0 / 30 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
CRAP 2.0
1 # Generated by default/object.tt
2 package Paws::MWAA::Environment;
3 use Moose;
4 has AirflowConfigurationOptions => (is => 'ro', isa => 'Paws::MWAA::AirflowConfigurationOptions');
5 has AirflowVersion => (is => 'ro', isa => 'Str');
6 has Arn => (is => 'ro', isa => 'Str');
7 has CreatedAt => (is => 'ro', isa => 'Str');
8 has DagS3Path => (is => 'ro', isa => 'Str');
9 has EnvironmentClass => (is => 'ro', isa => 'Str');
10 has ExecutionRoleArn => (is => 'ro', isa => 'Str');
11 has KmsKey => (is => 'ro', isa => 'Str');
12 has LastUpdate => (is => 'ro', isa => 'Paws::MWAA::LastUpdate');
13 has LoggingConfiguration => (is => 'ro', isa => 'Paws::MWAA::LoggingConfiguration');
14 has MaxWorkers => (is => 'ro', isa => 'Int');
15 has MinWorkers => (is => 'ro', isa => 'Int');
16 has Name => (is => 'ro', isa => 'Str');
17 has NetworkConfiguration => (is => 'ro', isa => 'Paws::MWAA::NetworkConfiguration');
18 has PluginsS3ObjectVersion => (is => 'ro', isa => 'Str');
19 has PluginsS3Path => (is => 'ro', isa => 'Str');
20 has RequirementsS3ObjectVersion => (is => 'ro', isa => 'Str');
21 has RequirementsS3Path => (is => 'ro', isa => 'Str');
22 has Schedulers => (is => 'ro', isa => 'Int');
23 has ServiceRoleArn => (is => 'ro', isa => 'Str');
24 has SourceBucketArn => (is => 'ro', isa => 'Str');
25 has Status => (is => 'ro', isa => 'Str');
26 has Tags => (is => 'ro', isa => 'Paws::MWAA::TagMap');
27 has WebserverAccessMode => (is => 'ro', isa => 'Str');
28 has WebserverUrl => (is => 'ro', isa => 'Str');
29 has WeeklyMaintenanceWindowStart => (is => 'ro', isa => 'Str');
30  
31 1;
32  
33 ### main pod documentation begin ###
34  
35 =head1 NAME
36  
37 Paws::MWAA::Environment
38  
39 =head1 USAGE
40  
41 This class represents one of two things:
42  
43 =head3 Arguments in a call to a service
44  
45 Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
46 Each attribute should be used as a named argument in the calls that expect this type of object.
47  
48 As an example, if Att1 is expected to be a Paws::MWAA::Environment object:
49  
50 $service_obj->Method(Att1 => { AirflowConfigurationOptions => $value, ..., WeeklyMaintenanceWindowStart => $value });
51  
52 =head3 Results returned from an API call
53  
54 Use accessors for each attribute. If Att1 is expected to be an Paws::MWAA::Environment object:
55  
56 $result = $service_obj->Method(...);
57 $result->Att1->AirflowConfigurationOptions
58  
59 =head1 DESCRIPTION
60  
61 The Amazon Managed Workflows for Apache Airflow (MWAA) environment.
62  
63 =head1 ATTRIBUTES
64  
65  
66 =head2 AirflowConfigurationOptions => L<Paws::MWAA::AirflowConfigurationOptions>
67  
68 A list of key-value pairs containing the Apache Airflow configuration
69 options attached to your environment. To learn more, see Apache Airflow
70 configuration options
71 (https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-env-variables.html).
72  
73  
74 =head2 AirflowVersion => Str
75  
76 The Apache Airflow version on your environment. For example,
77 C<v1.10.12>.
78  
79  
80 =head2 Arn => Str
81  
82 The Amazon Resource Name (ARN) of the Amazon MWAA environment.
83  
84  
85 =head2 CreatedAt => Str
86  
87 The day and time the environment was created.
88  
89  
90 =head2 DagS3Path => Str
91  
92 The relative path to the DAGs folder on your Amazon S3 bucket. For
93 example, C<dags>. To learn more, see Adding or updating DAGs
94 (https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-dag-folder.html).
95  
96  
97 =head2 EnvironmentClass => Str
98  
99 The environment class type. Valid values: C<mw1.small>, C<mw1.medium>,
100 C<mw1.large>. To learn more, see Amazon MWAA environment class
101 (https://docs.aws.amazon.com/mwaa/latest/userguide/environment-class.html).
102  
103  
104 =head2 ExecutionRoleArn => Str
105  
106 The Amazon Resource Name (ARN) of the execution role in IAM that allows
107 MWAA to access AWS resources in your environment. For example,
108 C<arn:aws:iam::123456789:role/my-execution-role>. To learn more, see
109 Amazon MWAA Execution role
110 (https://docs.aws.amazon.com/mwaa/latest/userguide/mwaa-create-role.html).
111  
112  
113 =head2 KmsKey => Str
114  
115 The Key Management Service (KMS) encryption key used to encrypt the
116 data in your environment.
117  
118  
119 =head2 LastUpdate => L<Paws::MWAA::LastUpdate>
120  
121  
122  
123  
124 =head2 LoggingConfiguration => L<Paws::MWAA::LoggingConfiguration>
125  
126 The Apache Airflow logs being sent to CloudWatch Logs:
127 C<DagProcessingLogs>, C<SchedulerLogs>, C<TaskLogs>, C<WebserverLogs>,
128 C<WorkerLogs>.
129  
130  
131 =head2 MaxWorkers => Int
132  
133 The maximum number of workers that run in your environment. For
134 example, C<20>.
135  
136  
137 =head2 MinWorkers => Int
138  
139 The minimum number of workers that run in your environment. For
140 example, C<2>.
141  
142  
143 =head2 Name => Str
144  
145 The name of the Amazon MWAA environment. For example,
146 C<MyMWAAEnvironment>.
147  
148  
149 =head2 NetworkConfiguration => L<Paws::MWAA::NetworkConfiguration>
150  
151  
152  
153  
154 =head2 PluginsS3ObjectVersion => Str
155  
156 The version of the plugins.zip file on your Amazon S3 bucket. To learn
157 more, see Installing custom plugins
158 (https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-dag-import-plugins.html).
159  
160  
161 =head2 PluginsS3Path => Str
162  
163 The relative path to the C<plugins.zip> file on your Amazon S3 bucket.
164 For example, C<plugins.zip>. To learn more, see Installing custom
165 plugins
166 (https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-dag-import-plugins.html).
167  
168  
169 =head2 RequirementsS3ObjectVersion => Str
170  
171 The version of the requirements.txt file on your Amazon S3 bucket. To
172 learn more, see Installing Python dependencies
173 (https://docs.aws.amazon.com/mwaa/latest/userguide/working-dags-dependencies.html).
174  
175  
176 =head2 RequirementsS3Path => Str
177  
178 The relative path to the C<requirements.txt> file on your Amazon S3
179 bucket. For example, C<requirements.txt>. To learn more, see Installing
180 Python dependencies
181 (https://docs.aws.amazon.com/mwaa/latest/userguide/working-dags-dependencies.html).
182  
183  
184 =head2 Schedulers => Int
185  
186 The number of Apache Airflow schedulers that run in your Amazon MWAA
187 environment.
188  
189  
190 =head2 ServiceRoleArn => Str
191  
192 The Amazon Resource Name (ARN) for the service-linked role of the
193 environment. To learn more, see Amazon MWAA Service-linked role
194 (https://docs.aws.amazon.com/mwaa/latest/userguide/mwaa-slr.html).
195  
196  
197 =head2 SourceBucketArn => Str
198  
199 The Amazon Resource Name (ARN) of the Amazon S3 bucket where your DAG
200 code and supporting files are stored. For example,
201 C<arn:aws:s3:::my-airflow-bucket-unique-name>. To learn more, see
202 Create an Amazon S3 bucket for Amazon MWAA
203 (https://docs.aws.amazon.com/mwaa/latest/userguide/mwaa-s3-bucket.html).
204  
205  
206 =head2 Status => Str
207  
208 The status of the Amazon MWAA environment. Valid values:
209  
210 =over
211  
212 =item *
213  
214 C<CREATING> - Indicates the request to create the environment is in
215 progress.
216  
217 =item *
218  
219 C<CREATE_FAILED> - Indicates the request to create the environment
220 failed, and the environment could not be created.
221  
222 =item *
223  
224 C<AVAILABLE> - Indicates the request was successful and the environment
225 is ready to use.
226  
227 =item *
228  
229 C<UPDATING> - Indicates the request to update the environment is in
230 progress.
231  
232 =item *
233  
234 C<DELETING> - Indicates the request to delete the environment is in
235 progress.
236  
237 =item *
238  
239 C<DELETED> - Indicates the request to delete the environment is
240 complete, and the environment has been deleted.
241  
242 =item *
243  
244 C<UNAVAILABLE> - Indicates the request failed, but the environment was
245 unable to rollback and is not in a stable state.
246  
247 =item *
248  
249 C<UPDATE_FAILED> - Indicates the request to update the environment
250 failed, and the environment has rolled back successfully and is ready
251 to use.
252  
253 =back
254  
255 We recommend reviewing our troubleshooting guide for a list of common
256 errors and their solutions. To learn more, see Amazon MWAA
257 troubleshooting
258 (https://docs.aws.amazon.com/mwaa/latest/userguide/troubleshooting.html).
259  
260  
261 =head2 Tags => L<Paws::MWAA::TagMap>
262  
263 The key-value tag pairs associated to your environment. For example,
264 C<"Environment": "Staging">. To learn more, see Tagging AWS resources
265 (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html).
266  
267  
268 =head2 WebserverAccessMode => Str
269  
270 The Apache Airflow I<Web server> access mode. To learn more, see Apache
271 Airflow access modes
272 (https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-networking.html).
273  
274  
275 =head2 WebserverUrl => Str
276  
277 The Apache Airflow I<Web server> host name for the Amazon MWAA
278 environment. To learn more, see Accessing the Apache Airflow UI
279 (https://docs.aws.amazon.com/mwaa/latest/userguide/access-airflow-ui.html).
280  
281  
282 =head2 WeeklyMaintenanceWindowStart => Str
283  
284 The day and time of the week that weekly maintenance updates are
285 scheduled. For example: C<TUE:03:30>.
286  
287  
288  
289 =head1 SEE ALSO
290  
291 This class forms part of L<Paws>, describing an object used in L<Paws::MWAA>
292  
293 =head1 BUGS and CONTRIBUTIONS
294  
295 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
296  
297 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
298  
299 =cut
300