« blib/lib/Paws/MWAA/UntagResourceOutput.pm
↑ Summary
blib/lib/Paws/MWAA/UpdateEnvironmentOutput.pm »
| 1 | |||
| 2 | package Paws::MWAA::UpdateEnvironment; | ||
| 3 | use Moose; | ||
| 4 | has AirflowConfigurationOptions => (is => 'ro', isa => 'Paws::MWAA::SyntheticUpdateEnvironmentInputAirflowConfigurationOptions'); | ||
| 5 | has AirflowVersion => (is => 'ro', isa => 'Str'); | ||
| 6 | has DagS3Path => (is => 'ro', isa => 'Str'); | ||
| 7 | has EnvironmentClass => (is => 'ro', isa => 'Str'); | ||
| 8 | has ExecutionRoleArn => (is => 'ro', isa => 'Str'); | ||
| 9 | has LoggingConfiguration => (is => 'ro', isa => 'Paws::MWAA::LoggingConfigurationInput'); | ||
| 10 | has MaxWorkers => (is => 'ro', isa => 'Int'); | ||
| 11 | has MinWorkers => (is => 'ro', isa => 'Int'); | ||
| 12 | has Name => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'Name', required => 1); | ||
| 13 | has NetworkConfiguration => (is => 'ro', isa => 'Paws::MWAA::UpdateNetworkConfigurationInput'); | ||
| 14 | has PluginsS3ObjectVersion => (is => 'ro', isa => 'Str'); | ||
| 15 | has PluginsS3Path => (is => 'ro', isa => 'Str'); | ||
| 16 | has RequirementsS3ObjectVersion => (is => 'ro', isa => 'Str'); | ||
| 17 | has RequirementsS3Path => (is => 'ro', isa => 'Str'); | ||
| 18 | has Schedulers => (is => 'ro', isa => 'Int'); | ||
| 19 | has SourceBucketArn => (is => 'ro', isa => 'Str'); | ||
| 20 | has WebserverAccessMode => (is => 'ro', isa => 'Str'); | ||
| 21 | has WeeklyMaintenanceWindowStart => (is => 'ro', isa => 'Str'); | ||
| 22 | |||
| 23 | use MooseX::ClassAttribute; | ||
| 24 | |||
| 25 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'UpdateEnvironment'); | ||
| 26 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/environments/{Name}'); | ||
| 27 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'PATCH'); | ||
| 28 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::MWAA::UpdateEnvironmentOutput'); | ||
| 29 | 1; | ||
| 30 | |||
| 31 | ### main pod documentation begin ### | ||
| 32 | |||
| 33 | =head1 NAME | ||
| 34 | |||
| 35 | Paws::MWAA::UpdateEnvironment - Arguments for method UpdateEnvironment on L<Paws::MWAA> | ||
| 36 | |||
| 37 | =head1 DESCRIPTION | ||
| 38 | |||
| 39 | This class represents the parameters used for calling the method UpdateEnvironment on the | ||
| 40 | L<AmazonMWAA|Paws::MWAA> service. Use the attributes of this class | ||
| 41 | as arguments to method UpdateEnvironment. | ||
| 42 | |||
| 43 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to UpdateEnvironment. | ||
| 44 | |||
| 45 | =head1 SYNOPSIS | ||
| 46 | |||
| 47 | my $airflow = Paws->service('MWAA'); | ||
| 48 | my $UpdateEnvironmentOutput = $airflow->UpdateEnvironment( | ||
| 49 | Name => 'MyEnvironmentName', | ||
| 50 | AirflowConfigurationOptions => { | ||
| 51 | 'MyConfigKey' => | ||
| 52 | 'MyConfigValue', # key: min: 1, max: 64, value: min: 1, max: 256 | ||
| 53 | }, # OPTIONAL | ||
| 54 | AirflowVersion => 'MyAirflowVersion', # OPTIONAL | ||
| 55 | DagS3Path => 'MyRelativePath', # OPTIONAL | ||
| 56 | EnvironmentClass => 'MyEnvironmentClass', # OPTIONAL | ||
| 57 | ExecutionRoleArn => 'MyIamRoleArn', # OPTIONAL | ||
| 58 | LoggingConfiguration => { | ||
| 59 | DagProcessingLogs => { | ||
| 60 | Enabled => 1, | ||
| 61 | LogLevel => | ||
| 62 | 'CRITICAL', # values: CRITICAL, ERROR, WARNING, INFO, DEBUG | ||
| 63 | |||
| 64 | }, # OPTIONAL | ||
| 65 | SchedulerLogs => { | ||
| 66 | Enabled => 1, | ||
| 67 | LogLevel => | ||
| 68 | 'CRITICAL', # values: CRITICAL, ERROR, WARNING, INFO, DEBUG | ||
| 69 | |||
| 70 | }, # OPTIONAL | ||
| 71 | TaskLogs => { | ||
| 72 | Enabled => 1, | ||
| 73 | LogLevel => | ||
| 74 | 'CRITICAL', # values: CRITICAL, ERROR, WARNING, INFO, DEBUG | ||
| 75 | |||
| 76 | }, # OPTIONAL | ||
| 77 | WebserverLogs => { | ||
| 78 | Enabled => 1, | ||
| 79 | LogLevel => | ||
| 80 | 'CRITICAL', # values: CRITICAL, ERROR, WARNING, INFO, DEBUG | ||
| 81 | |||
| 82 | }, # OPTIONAL | ||
| 83 | WorkerLogs => { | ||
| 84 | Enabled => 1, | ||
| 85 | LogLevel => | ||
| 86 | 'CRITICAL', # values: CRITICAL, ERROR, WARNING, INFO, DEBUG | ||
| 87 | |||
| 88 | }, # OPTIONAL | ||
| 89 | }, # OPTIONAL | ||
| 90 | MaxWorkers => 1, # OPTIONAL | ||
| 91 | MinWorkers => 1, # OPTIONAL | ||
| 92 | NetworkConfiguration => { | ||
| 93 | SecurityGroupIds => [ | ||
| 94 | 'MySecurityGroupId', ... # min: 1, max: 1024 | ||
| 95 | ], # min: 1, max: 5 | ||
| 96 | |||
| 97 | }, # OPTIONAL | ||
| 98 | PluginsS3ObjectVersion => 'MyS3ObjectVersion', # OPTIONAL | ||
| 99 | PluginsS3Path => 'MyRelativePath', # OPTIONAL | ||
| 100 | RequirementsS3ObjectVersion => 'MyS3ObjectVersion', # OPTIONAL | ||
| 101 | RequirementsS3Path => 'MyRelativePath', # OPTIONAL | ||
| 102 | Schedulers => 1, # OPTIONAL | ||
| 103 | SourceBucketArn => 'MyS3BucketArn', # OPTIONAL | ||
| 104 | WebserverAccessMode => 'PRIVATE_ONLY', # OPTIONAL | ||
| 105 | WeeklyMaintenanceWindowStart => | ||
| 106 | 'MyWeeklyMaintenanceWindowStart', # OPTIONAL | ||
| 107 | ); | ||
| 108 | |||
| 109 | # Results: | ||
| 110 | my $Arn = $UpdateEnvironmentOutput->Arn; | ||
| 111 | |||
| 112 | # Returns a L<Paws::MWAA::UpdateEnvironmentOutput> object. | ||
| 113 | |||
| 114 | 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. | ||
| 115 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/airflow/UpdateEnvironment> | ||
| 116 | |||
| 117 | =head1 ATTRIBUTES | ||
| 118 | |||
| 119 | |||
| 120 | =head2 AirflowConfigurationOptions => L<Paws::MWAA::SyntheticUpdateEnvironmentInputAirflowConfigurationOptions> | ||
| 121 | |||
| 122 | A list of key-value pairs containing the Apache Airflow configuration | ||
| 123 | options you want to attach to your environment. To learn more, see | ||
| 124 | Apache Airflow configuration options | ||
| 125 | (https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-env-variables.html). | ||
| 126 | |||
| 127 | |||
| 128 | |||
| 129 | =head2 AirflowVersion => Str | ||
| 130 | |||
| 131 | The Apache Airflow version for your environment. For example, | ||
| 132 | C<v1.10.12>. If no value is specified, defaults to the latest version. | ||
| 133 | Valid values: C<v1.10.12>. | ||
| 134 | |||
| 135 | |||
| 136 | |||
| 137 | =head2 DagS3Path => Str | ||
| 138 | |||
| 139 | The relative path to the DAGs folder on your Amazon S3 bucket. For | ||
| 140 | example, C<dags>. To learn more, see Adding or updating DAGs | ||
| 141 | (https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-dag-folder.html). | ||
| 142 | |||
| 143 | |||
| 144 | |||
| 145 | =head2 EnvironmentClass => Str | ||
| 146 | |||
| 147 | The environment class type. Valid values: C<mw1.small>, C<mw1.medium>, | ||
| 148 | C<mw1.large>. To learn more, see Amazon MWAA environment class | ||
| 149 | (https://docs.aws.amazon.com/mwaa/latest/userguide/environment-class.html). | ||
| 150 | |||
| 151 | |||
| 152 | |||
| 153 | =head2 ExecutionRoleArn => Str | ||
| 154 | |||
| 155 | The Amazon Resource Name (ARN) of the execution role in IAM that allows | ||
| 156 | MWAA to access AWS resources in your environment. For example, | ||
| 157 | C<arn:aws:iam::123456789:role/my-execution-role>. To learn more, see | ||
| 158 | Amazon MWAA Execution role | ||
| 159 | (https://docs.aws.amazon.com/mwaa/latest/userguide/mwaa-create-role.html). | ||
| 160 | |||
| 161 | |||
| 162 | |||
| 163 | =head2 LoggingConfiguration => L<Paws::MWAA::LoggingConfigurationInput> | ||
| 164 | |||
| 165 | Defines the Apache Airflow logs to send to CloudWatch Logs: | ||
| 166 | C<DagProcessingLogs>, C<SchedulerLogs>, C<TaskLogs>, C<WebserverLogs>, | ||
| 167 | C<WorkerLogs>. | ||
| 168 | |||
| 169 | |||
| 170 | |||
| 171 | =head2 MaxWorkers => Int | ||
| 172 | |||
| 173 | The maximum number of workers that you want to run in your environment. | ||
| 174 | MWAA scales the number of Apache Airflow workers up to the number you | ||
| 175 | specify in the C<MaxWorkers> field. For example, C<20>. When there are | ||
| 176 | no more tasks running, and no more in the queue, MWAA disposes of the | ||
| 177 | extra workers leaving the one worker that is included with your | ||
| 178 | environment, or the number you specify in C<MinWorkers>. | ||
| 179 | |||
| 180 | |||
| 181 | |||
| 182 | =head2 MinWorkers => Int | ||
| 183 | |||
| 184 | The minimum number of workers that you want to run in your environment. | ||
| 185 | MWAA scales the number of Apache Airflow workers up to the number you | ||
| 186 | specify in the C<MaxWorkers> field. When there are no more tasks | ||
| 187 | running, and no more in the queue, MWAA disposes of the extra workers | ||
| 188 | leaving the worker count you specify in the C<MinWorkers> field. For | ||
| 189 | example, C<2>. | ||
| 190 | |||
| 191 | |||
| 192 | |||
| 193 | =head2 B<REQUIRED> Name => Str | ||
| 194 | |||
| 195 | The name of your Amazon MWAA environment. For example, | ||
| 196 | C<MyMWAAEnvironment>. | ||
| 197 | |||
| 198 | |||
| 199 | |||
| 200 | =head2 NetworkConfiguration => L<Paws::MWAA::UpdateNetworkConfigurationInput> | ||
| 201 | |||
| 202 | The VPC networking components used to secure and enable network traffic | ||
| 203 | between the AWS resources for your environment. To learn more, see | ||
| 204 | About networking on Amazon MWAA | ||
| 205 | (https://docs.aws.amazon.com/mwaa/latest/userguide/networking-about.html). | ||
| 206 | |||
| 207 | |||
| 208 | |||
| 209 | =head2 PluginsS3ObjectVersion => Str | ||
| 210 | |||
| 211 | The version of the plugins.zip file on your Amazon S3 bucket. A version | ||
| 212 | must be specified each time a plugins.zip file is updated. To learn | ||
| 213 | more, see How S3 Versioning works | ||
| 214 | (https://docs.aws.amazon.com/AmazonS3/latest/userguide/versioning-workflows.html). | ||
| 215 | |||
| 216 | |||
| 217 | |||
| 218 | =head2 PluginsS3Path => Str | ||
| 219 | |||
| 220 | The relative path to the C<plugins.zip> file on your Amazon S3 bucket. | ||
| 221 | For example, C<plugins.zip>. If specified, then the plugins.zip version | ||
| 222 | is required. To learn more, see Installing custom plugins | ||
| 223 | (https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-dag-import-plugins.html). | ||
| 224 | |||
| 225 | |||
| 226 | |||
| 227 | =head2 RequirementsS3ObjectVersion => Str | ||
| 228 | |||
| 229 | The version of the requirements.txt file on your Amazon S3 bucket. A | ||
| 230 | version must be specified each time a requirements.txt file is updated. | ||
| 231 | To learn more, see How S3 Versioning works | ||
| 232 | (https://docs.aws.amazon.com/AmazonS3/latest/userguide/versioning-workflows.html). | ||
| 233 | |||
| 234 | |||
| 235 | |||
| 236 | =head2 RequirementsS3Path => Str | ||
| 237 | |||
| 238 | The relative path to the C<requirements.txt> file on your Amazon S3 | ||
| 239 | bucket. For example, C<requirements.txt>. If specified, then a file | ||
| 240 | version is required. To learn more, see Installing Python dependencies | ||
| 241 | (https://docs.aws.amazon.com/mwaa/latest/userguide/working-dags-dependencies.html). | ||
| 242 | |||
| 243 | |||
| 244 | |||
| 245 | =head2 Schedulers => Int | ||
| 246 | |||
| 247 | The number of Apache Airflow schedulers to run in your Amazon MWAA | ||
| 248 | environment. | ||
| 249 | |||
| 250 | |||
| 251 | |||
| 252 | =head2 SourceBucketArn => Str | ||
| 253 | |||
| 254 | The Amazon Resource Name (ARN) of the Amazon S3 bucket where your DAG | ||
| 255 | code and supporting files are stored. For example, | ||
| 256 | C<arn:aws:s3:::my-airflow-bucket-unique-name>. To learn more, see | ||
| 257 | Create an Amazon S3 bucket for Amazon MWAA | ||
| 258 | (https://docs.aws.amazon.com/mwaa/latest/userguide/mwaa-s3-bucket.html). | ||
| 259 | |||
| 260 | |||
| 261 | |||
| 262 | =head2 WebserverAccessMode => Str | ||
| 263 | |||
| 264 | The Apache Airflow I<Web server> access mode. To learn more, see Apache | ||
| 265 | Airflow access modes | ||
| 266 | (https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-networking.html). | ||
| 267 | |||
| 268 | Valid values are: C<"PRIVATE_ONLY">, C<"PUBLIC_ONLY"> | ||
| 269 | |||
| 270 | =head2 WeeklyMaintenanceWindowStart => Str | ||
| 271 | |||
| 272 | The day and time of the week to start weekly maintenance updates of | ||
| 273 | your environment in the following format: C<DAY:HH:MM>. For example: | ||
| 274 | C<TUE:03:30>. You can specify a start time in 30 minute increments | ||
| 275 | only. Supported input includes the following: | ||
| 276 | |||
| 277 | =over | ||
| 278 | |||
| 279 | =item * | ||
| 280 | |||
| 281 | MON|TUE|WED|THU|FRI|SAT|SUN:([01]\\d|2[0-3]):(00|30) | ||
| 282 | |||
| 283 | =back | ||
| 284 | |||
| 285 | |||
| 286 | |||
| 287 | |||
| 288 | |||
| 289 | =head1 SEE ALSO | ||
| 290 | |||
| 291 | This class forms part of L<Paws>, documenting arguments for method UpdateEnvironment 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 |