NAME

Paws::MWAA::CreateEnvironment - Arguments for method CreateEnvironment on Paws::MWAA

DESCRIPTION

This class represents the parameters used for calling the method CreateEnvironment on the AmazonMWAA service. Use the attributes of this class as arguments to method CreateEnvironment.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateEnvironment.

SYNOPSIS

my $airflow = Paws->service('MWAA');
my $CreateEnvironmentOutput = $airflow->CreateEnvironment(
  DagS3Path            => 'MyRelativePath',
  ExecutionRoleArn     => 'MyIamRoleArn',
  Name                 => 'MyEnvironmentName',
  NetworkConfiguration => {
    SecurityGroupIds => [
      'MySecurityGroupId', ...    # min: 1, max: 1024
    ],    # min: 1, max: 5; OPTIONAL
    SubnetIds => [
      'MySubnetId', ...    # min: 1, max: 1024
    ],    # min: 2, max: 2; OPTIONAL
  },
  SourceBucketArn             => 'MyS3BucketArn',
  AirflowConfigurationOptions => {
    'MyConfigKey' =>
      'MyConfigValue',    # key: min: 1, max: 64, value: min: 1, max: 256
  },    # OPTIONAL
  AirflowVersion       => 'MyAirflowVersion',      # OPTIONAL
  EnvironmentClass     => 'MyEnvironmentClass',    # OPTIONAL
  KmsKey               => 'MyKmsKey',              # OPTIONAL
  LoggingConfiguration => {
    DagProcessingLogs => {
      Enabled  => 1,
      LogLevel =>
        'CRITICAL',    # values: CRITICAL, ERROR, WARNING, INFO, DEBUG

    },    # OPTIONAL
    SchedulerLogs => {
      Enabled  => 1,
      LogLevel =>
        'CRITICAL',    # values: CRITICAL, ERROR, WARNING, INFO, DEBUG

    },    # OPTIONAL
    TaskLogs => {
      Enabled  => 1,
      LogLevel =>
        'CRITICAL',    # values: CRITICAL, ERROR, WARNING, INFO, DEBUG

    },    # OPTIONAL
    WebserverLogs => {
      Enabled  => 1,
      LogLevel =>
        'CRITICAL',    # values: CRITICAL, ERROR, WARNING, INFO, DEBUG

    },    # OPTIONAL
    WorkerLogs => {
      Enabled  => 1,
      LogLevel =>
        'CRITICAL',    # values: CRITICAL, ERROR, WARNING, INFO, DEBUG

    },    # OPTIONAL
  },    # OPTIONAL
  MaxWorkers                  => 1,                      # OPTIONAL
  MinWorkers                  => 1,                      # OPTIONAL
  PluginsS3ObjectVersion      => 'MyS3ObjectVersion',    # OPTIONAL
  PluginsS3Path               => 'MyRelativePath',       # OPTIONAL
  RequirementsS3ObjectVersion => 'MyS3ObjectVersion',    # OPTIONAL
  RequirementsS3Path          => 'MyRelativePath',       # OPTIONAL
  Schedulers                  => 1,                      # OPTIONAL
  Tags                        => {
    'MyTagKey' =>
      'MyTagValue',    # key: min: 1, max: 128, value: min: 1, max: 256
  },    # OPTIONAL
  WebserverAccessMode          => 'PRIVATE_ONLY',    # OPTIONAL
  WeeklyMaintenanceWindowStart =>
    'MyWeeklyMaintenanceWindowStart',                # OPTIONAL
);

# Results:
my $Arn = $CreateEnvironmentOutput->Arn;

# Returns a L<Paws::MWAA::CreateEnvironmentOutput> object.

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. For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/airflow/CreateEnvironment

ATTRIBUTES

AirflowConfigurationOptions => Paws::MWAA::SyntheticCreateEnvironmentInputAirflowConfigurationOptions

A list of key-value pairs containing the Apache Airflow configuration options you want to attach to your environment. To learn more, see Apache Airflow configuration options (https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-env-variables.html).

AirflowVersion => Str

The Apache Airflow version for your environment. For example, v1.10.12. If no value is specified, defaults to the latest version. Valid values: v1.10.12.

REQUIRED DagS3Path => Str

The relative path to the DAGs folder on your Amazon S3 bucket. For example, dags. To learn more, see Adding or updating DAGs (https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-dag-folder.html).

EnvironmentClass => Str

The environment class type. Valid values: mw1.small, mw1.medium, mw1.large. To learn more, see Amazon MWAA environment class (https://docs.aws.amazon.com/mwaa/latest/userguide/environment-class.html).

REQUIRED ExecutionRoleArn => Str

The Amazon Resource Name (ARN) of the execution role for your environment. An execution role is an AWS Identity and Access Management (IAM) role that grants MWAA permission to access AWS services and resources used by your environment. For example, arn:aws:iam::123456789:role/my-execution-role. To learn more, see Amazon MWAA Execution role (https://docs.aws.amazon.com/mwaa/latest/userguide/mwaa-create-role.html).

KmsKey => Str

The AWS Key Management Service (KMS) key to encrypt the data in your environment. You can use an AWS owned CMK, or a Customer managed CMK (advanced). To learn more, see Get started with Amazon Managed Workflows for Apache Airflow (https://docs.aws.amazon.com/mwaa/latest/userguide/get-started.html).

LoggingConfiguration => Paws::MWAA::LoggingConfigurationInput

Defines the Apache Airflow logs to send to CloudWatch Logs: DagProcessingLogs, SchedulerLogs, TaskLogs, WebserverLogs, WorkerLogs.

MaxWorkers => Int

The maximum number of workers that you want to run in your environment. MWAA scales the number of Apache Airflow workers up to the number you specify in the MaxWorkers field. For example, 20. When there are no more tasks running, and no more in the queue, MWAA disposes of the extra workers leaving the one worker that is included with your environment, or the number you specify in MinWorkers.

MinWorkers => Int

The minimum number of workers that you want to run in your environment. MWAA scales the number of Apache Airflow workers up to the number you specify in the MaxWorkers field. When there are no more tasks running, and no more in the queue, MWAA disposes of the extra workers leaving the worker count you specify in the MinWorkers field. For example, 2.

REQUIRED Name => Str

The name of the Amazon MWAA environment. For example, MyMWAAEnvironment.

REQUIRED NetworkConfiguration => Paws::MWAA::NetworkConfiguration

The VPC networking components used to secure and enable network traffic between the AWS resources for your environment. To learn more, see About networking on Amazon MWAA (https://docs.aws.amazon.com/mwaa/latest/userguide/networking-about.html).

PluginsS3ObjectVersion => Str

The version of the plugins.zip file on your Amazon S3 bucket. A version must be specified each time a plugins.zip file is updated. To learn more, see How S3 Versioning works (https://docs.aws.amazon.com/AmazonS3/latest/userguide/versioning-workflows.html).

PluginsS3Path => Str

The relative path to the plugins.zip file on your Amazon S3 bucket. For example, plugins.zip. If specified, then the plugins.zip version is required. To learn more, see Installing custom plugins (https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-dag-import-plugins.html).

RequirementsS3ObjectVersion => Str

The version of the requirements.txt file on your Amazon S3 bucket. A version must be specified each time a requirements.txt file is updated. To learn more, see How S3 Versioning works (https://docs.aws.amazon.com/AmazonS3/latest/userguide/versioning-workflows.html).

RequirementsS3Path => Str

The relative path to the requirements.txt file on your Amazon S3 bucket. For example, requirements.txt. If specified, then a file version is required. To learn more, see Installing Python dependencies (https://docs.aws.amazon.com/mwaa/latest/userguide/working-dags-dependencies.html).

Schedulers => Int

The number of Apache Airflow schedulers to run in your environment.

REQUIRED SourceBucketArn => Str

The Amazon Resource Name (ARN) of the Amazon S3 bucket where your DAG code and supporting files are stored. For example, arn:aws:s3:::my-airflow-bucket-unique-name. To learn more, see Create an Amazon S3 bucket for Amazon MWAA (https://docs.aws.amazon.com/mwaa/latest/userguide/mwaa-s3-bucket.html).

Tags => Paws::MWAA::TagMap

The key-value tag pairs you want to associate to your environment. For example, "Environment": "Staging". To learn more, see Tagging AWS resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html).

WebserverAccessMode => Str

The Apache Airflow Web server access mode. To learn more, see Apache Airflow access modes (https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-networking.html).

Valid values are: "PRIVATE_ONLY", "PUBLIC_ONLY"

WeeklyMaintenanceWindowStart => Str

The day and time of the week to start weekly maintenance updates of your environment in the following format: DAY:HH:MM. For example: TUE:03:30. You can specify a start time in 30 minute increments only. Supported input includes the following:

  • MON|TUE|WED|THU|FRI|SAT|SUN:([01]\\d|2[0-3]):(00|30)

SEE ALSO

This class forms part of Paws, documenting arguments for method CreateEnvironment in Paws::MWAA

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues