Class: Aws::MWAA::Types::CreateEnvironmentInput

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-mwaa/lib/aws-sdk-mwaa/types.rb

Overview

Note:

When making an API call, you may pass CreateEnvironmentInput data as a hash:

{
  airflow_configuration_options: {
    "ConfigKey" => "ConfigValue",
  },
  airflow_version: "AirflowVersion",
  dag_s3_path: "RelativePath", # required
  environment_class: "EnvironmentClass",
  execution_role_arn: "IamRoleArn", # required
  kms_key: "KmsKey",
  logging_configuration: {
    dag_processing_logs: {
      enabled: false, # required
      log_level: "CRITICAL", # required, accepts CRITICAL, ERROR, WARNING, INFO, DEBUG
    },
    scheduler_logs: {
      enabled: false, # required
      log_level: "CRITICAL", # required, accepts CRITICAL, ERROR, WARNING, INFO, DEBUG
    },
    task_logs: {
      enabled: false, # required
      log_level: "CRITICAL", # required, accepts CRITICAL, ERROR, WARNING, INFO, DEBUG
    },
    webserver_logs: {
      enabled: false, # required
      log_level: "CRITICAL", # required, accepts CRITICAL, ERROR, WARNING, INFO, DEBUG
    },
    worker_logs: {
      enabled: false, # required
      log_level: "CRITICAL", # required, accepts CRITICAL, ERROR, WARNING, INFO, DEBUG
    },
  },
  max_workers: 1,
  min_workers: 1,
  name: "EnvironmentName", # required
  network_configuration: { # required
    security_group_ids: ["SecurityGroupId"],
    subnet_ids: ["SubnetId"],
  },
  plugins_s3_object_version: "S3ObjectVersion",
  plugins_s3_path: "RelativePath",
  requirements_s3_object_version: "S3ObjectVersion",
  requirements_s3_path: "RelativePath",
  schedulers: 1,
  source_bucket_arn: "S3BucketArn", # required
  tags: {
    "TagKey" => "TagValue",
  },
  webserver_access_mode: "PRIVATE_ONLY", # accepts PRIVATE_ONLY, PUBLIC_ONLY
  weekly_maintenance_window_start: "WeeklyMaintenanceWindowStart",
}

This section contains the Amazon Managed Workflows for Apache Airflow (MWAA) API reference documentation to create an environment. For more information, see Get started with Amazon Managed Workflows for Apache Airflow.

Constant Summary collapse

SENSITIVE =
[:airflow_configuration_options]

Instance Attribute Summary collapse

Instance Attribute Details

#airflow_configuration_optionsHash<String,String>

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.

Returns:

  • (Hash<String,String>)


316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
# File 'gems/aws-sdk-mwaa/lib/aws-sdk-mwaa/types.rb', line 316

class CreateEnvironmentInput < Struct.new(
  :airflow_configuration_options,
  :airflow_version,
  :dag_s3_path,
  :environment_class,
  :execution_role_arn,
  :kms_key,
  :logging_configuration,
  :max_workers,
  :min_workers,
  :name,
  :network_configuration,
  :plugins_s3_object_version,
  :plugins_s3_path,
  :requirements_s3_object_version,
  :requirements_s3_path,
  :schedulers,
  :source_bucket_arn,
  :tags,
  :webserver_access_mode,
  :weekly_maintenance_window_start)
  SENSITIVE = [:airflow_configuration_options]
  include Aws::Structure
end

#airflow_versionString

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.

Returns:

  • (String)


316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
# File 'gems/aws-sdk-mwaa/lib/aws-sdk-mwaa/types.rb', line 316

class CreateEnvironmentInput < Struct.new(
  :airflow_configuration_options,
  :airflow_version,
  :dag_s3_path,
  :environment_class,
  :execution_role_arn,
  :kms_key,
  :logging_configuration,
  :max_workers,
  :min_workers,
  :name,
  :network_configuration,
  :plugins_s3_object_version,
  :plugins_s3_path,
  :requirements_s3_object_version,
  :requirements_s3_path,
  :schedulers,
  :source_bucket_arn,
  :tags,
  :webserver_access_mode,
  :weekly_maintenance_window_start)
  SENSITIVE = [:airflow_configuration_options]
  include Aws::Structure
end

#dag_s3_pathString

The relative path to the DAGs folder on your Amazon S3 bucket. For example, dags. To learn more, see Adding or updating DAGs.

Returns:

  • (String)


316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
# File 'gems/aws-sdk-mwaa/lib/aws-sdk-mwaa/types.rb', line 316

class CreateEnvironmentInput < Struct.new(
  :airflow_configuration_options,
  :airflow_version,
  :dag_s3_path,
  :environment_class,
  :execution_role_arn,
  :kms_key,
  :logging_configuration,
  :max_workers,
  :min_workers,
  :name,
  :network_configuration,
  :plugins_s3_object_version,
  :plugins_s3_path,
  :requirements_s3_object_version,
  :requirements_s3_path,
  :schedulers,
  :source_bucket_arn,
  :tags,
  :webserver_access_mode,
  :weekly_maintenance_window_start)
  SENSITIVE = [:airflow_configuration_options]
  include Aws::Structure
end

#environment_classString

The environment class type. Valid values: mw1.small, mw1.medium, mw1.large. To learn more, see Amazon MWAA environment class.

Returns:

  • (String)


316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
# File 'gems/aws-sdk-mwaa/lib/aws-sdk-mwaa/types.rb', line 316

class CreateEnvironmentInput < Struct.new(
  :airflow_configuration_options,
  :airflow_version,
  :dag_s3_path,
  :environment_class,
  :execution_role_arn,
  :kms_key,
  :logging_configuration,
  :max_workers,
  :min_workers,
  :name,
  :network_configuration,
  :plugins_s3_object_version,
  :plugins_s3_path,
  :requirements_s3_object_version,
  :requirements_s3_path,
  :schedulers,
  :source_bucket_arn,
  :tags,
  :webserver_access_mode,
  :weekly_maintenance_window_start)
  SENSITIVE = [:airflow_configuration_options]
  include Aws::Structure
end

#execution_role_arnString

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.

Returns:

  • (String)


316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
# File 'gems/aws-sdk-mwaa/lib/aws-sdk-mwaa/types.rb', line 316

class CreateEnvironmentInput < Struct.new(
  :airflow_configuration_options,
  :airflow_version,
  :dag_s3_path,
  :environment_class,
  :execution_role_arn,
  :kms_key,
  :logging_configuration,
  :max_workers,
  :min_workers,
  :name,
  :network_configuration,
  :plugins_s3_object_version,
  :plugins_s3_path,
  :requirements_s3_object_version,
  :requirements_s3_path,
  :schedulers,
  :source_bucket_arn,
  :tags,
  :webserver_access_mode,
  :weekly_maintenance_window_start)
  SENSITIVE = [:airflow_configuration_options]
  include Aws::Structure
end

#kms_keyString

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.

Returns:

  • (String)


316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
# File 'gems/aws-sdk-mwaa/lib/aws-sdk-mwaa/types.rb', line 316

class CreateEnvironmentInput < Struct.new(
  :airflow_configuration_options,
  :airflow_version,
  :dag_s3_path,
  :environment_class,
  :execution_role_arn,
  :kms_key,
  :logging_configuration,
  :max_workers,
  :min_workers,
  :name,
  :network_configuration,
  :plugins_s3_object_version,
  :plugins_s3_path,
  :requirements_s3_object_version,
  :requirements_s3_path,
  :schedulers,
  :source_bucket_arn,
  :tags,
  :webserver_access_mode,
  :weekly_maintenance_window_start)
  SENSITIVE = [:airflow_configuration_options]
  include Aws::Structure
end

#logging_configurationTypes::LoggingConfigurationInput

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



316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
# File 'gems/aws-sdk-mwaa/lib/aws-sdk-mwaa/types.rb', line 316

class CreateEnvironmentInput < Struct.new(
  :airflow_configuration_options,
  :airflow_version,
  :dag_s3_path,
  :environment_class,
  :execution_role_arn,
  :kms_key,
  :logging_configuration,
  :max_workers,
  :min_workers,
  :name,
  :network_configuration,
  :plugins_s3_object_version,
  :plugins_s3_path,
  :requirements_s3_object_version,
  :requirements_s3_path,
  :schedulers,
  :source_bucket_arn,
  :tags,
  :webserver_access_mode,
  :weekly_maintenance_window_start)
  SENSITIVE = [:airflow_configuration_options]
  include Aws::Structure
end

#max_workersInteger

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.

Returns:

  • (Integer)


316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
# File 'gems/aws-sdk-mwaa/lib/aws-sdk-mwaa/types.rb', line 316

class CreateEnvironmentInput < Struct.new(
  :airflow_configuration_options,
  :airflow_version,
  :dag_s3_path,
  :environment_class,
  :execution_role_arn,
  :kms_key,
  :logging_configuration,
  :max_workers,
  :min_workers,
  :name,
  :network_configuration,
  :plugins_s3_object_version,
  :plugins_s3_path,
  :requirements_s3_object_version,
  :requirements_s3_path,
  :schedulers,
  :source_bucket_arn,
  :tags,
  :webserver_access_mode,
  :weekly_maintenance_window_start)
  SENSITIVE = [:airflow_configuration_options]
  include Aws::Structure
end

#min_workersInteger

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.

Returns:

  • (Integer)


316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
# File 'gems/aws-sdk-mwaa/lib/aws-sdk-mwaa/types.rb', line 316

class CreateEnvironmentInput < Struct.new(
  :airflow_configuration_options,
  :airflow_version,
  :dag_s3_path,
  :environment_class,
  :execution_role_arn,
  :kms_key,
  :logging_configuration,
  :max_workers,
  :min_workers,
  :name,
  :network_configuration,
  :plugins_s3_object_version,
  :plugins_s3_path,
  :requirements_s3_object_version,
  :requirements_s3_path,
  :schedulers,
  :source_bucket_arn,
  :tags,
  :webserver_access_mode,
  :weekly_maintenance_window_start)
  SENSITIVE = [:airflow_configuration_options]
  include Aws::Structure
end

#nameString

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

Returns:

  • (String)


316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
# File 'gems/aws-sdk-mwaa/lib/aws-sdk-mwaa/types.rb', line 316

class CreateEnvironmentInput < Struct.new(
  :airflow_configuration_options,
  :airflow_version,
  :dag_s3_path,
  :environment_class,
  :execution_role_arn,
  :kms_key,
  :logging_configuration,
  :max_workers,
  :min_workers,
  :name,
  :network_configuration,
  :plugins_s3_object_version,
  :plugins_s3_path,
  :requirements_s3_object_version,
  :requirements_s3_path,
  :schedulers,
  :source_bucket_arn,
  :tags,
  :webserver_access_mode,
  :weekly_maintenance_window_start)
  SENSITIVE = [:airflow_configuration_options]
  include Aws::Structure
end

#network_configurationTypes::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.



316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
# File 'gems/aws-sdk-mwaa/lib/aws-sdk-mwaa/types.rb', line 316

class CreateEnvironmentInput < Struct.new(
  :airflow_configuration_options,
  :airflow_version,
  :dag_s3_path,
  :environment_class,
  :execution_role_arn,
  :kms_key,
  :logging_configuration,
  :max_workers,
  :min_workers,
  :name,
  :network_configuration,
  :plugins_s3_object_version,
  :plugins_s3_path,
  :requirements_s3_object_version,
  :requirements_s3_path,
  :schedulers,
  :source_bucket_arn,
  :tags,
  :webserver_access_mode,
  :weekly_maintenance_window_start)
  SENSITIVE = [:airflow_configuration_options]
  include Aws::Structure
end

#plugins_s3_object_versionString

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.

Returns:

  • (String)


316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
# File 'gems/aws-sdk-mwaa/lib/aws-sdk-mwaa/types.rb', line 316

class CreateEnvironmentInput < Struct.new(
  :airflow_configuration_options,
  :airflow_version,
  :dag_s3_path,
  :environment_class,
  :execution_role_arn,
  :kms_key,
  :logging_configuration,
  :max_workers,
  :min_workers,
  :name,
  :network_configuration,
  :plugins_s3_object_version,
  :plugins_s3_path,
  :requirements_s3_object_version,
  :requirements_s3_path,
  :schedulers,
  :source_bucket_arn,
  :tags,
  :webserver_access_mode,
  :weekly_maintenance_window_start)
  SENSITIVE = [:airflow_configuration_options]
  include Aws::Structure
end

#plugins_s3_pathString

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.

Returns:

  • (String)


316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
# File 'gems/aws-sdk-mwaa/lib/aws-sdk-mwaa/types.rb', line 316

class CreateEnvironmentInput < Struct.new(
  :airflow_configuration_options,
  :airflow_version,
  :dag_s3_path,
  :environment_class,
  :execution_role_arn,
  :kms_key,
  :logging_configuration,
  :max_workers,
  :min_workers,
  :name,
  :network_configuration,
  :plugins_s3_object_version,
  :plugins_s3_path,
  :requirements_s3_object_version,
  :requirements_s3_path,
  :schedulers,
  :source_bucket_arn,
  :tags,
  :webserver_access_mode,
  :weekly_maintenance_window_start)
  SENSITIVE = [:airflow_configuration_options]
  include Aws::Structure
end

#requirements_s3_object_versionString

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.

Returns:

  • (String)


316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
# File 'gems/aws-sdk-mwaa/lib/aws-sdk-mwaa/types.rb', line 316

class CreateEnvironmentInput < Struct.new(
  :airflow_configuration_options,
  :airflow_version,
  :dag_s3_path,
  :environment_class,
  :execution_role_arn,
  :kms_key,
  :logging_configuration,
  :max_workers,
  :min_workers,
  :name,
  :network_configuration,
  :plugins_s3_object_version,
  :plugins_s3_path,
  :requirements_s3_object_version,
  :requirements_s3_path,
  :schedulers,
  :source_bucket_arn,
  :tags,
  :webserver_access_mode,
  :weekly_maintenance_window_start)
  SENSITIVE = [:airflow_configuration_options]
  include Aws::Structure
end

#requirements_s3_pathString

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.

Returns:

  • (String)


316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
# File 'gems/aws-sdk-mwaa/lib/aws-sdk-mwaa/types.rb', line 316

class CreateEnvironmentInput < Struct.new(
  :airflow_configuration_options,
  :airflow_version,
  :dag_s3_path,
  :environment_class,
  :execution_role_arn,
  :kms_key,
  :logging_configuration,
  :max_workers,
  :min_workers,
  :name,
  :network_configuration,
  :plugins_s3_object_version,
  :plugins_s3_path,
  :requirements_s3_object_version,
  :requirements_s3_path,
  :schedulers,
  :source_bucket_arn,
  :tags,
  :webserver_access_mode,
  :weekly_maintenance_window_start)
  SENSITIVE = [:airflow_configuration_options]
  include Aws::Structure
end

#schedulersInteger

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

Returns:

  • (Integer)


316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
# File 'gems/aws-sdk-mwaa/lib/aws-sdk-mwaa/types.rb', line 316

class CreateEnvironmentInput < Struct.new(
  :airflow_configuration_options,
  :airflow_version,
  :dag_s3_path,
  :environment_class,
  :execution_role_arn,
  :kms_key,
  :logging_configuration,
  :max_workers,
  :min_workers,
  :name,
  :network_configuration,
  :plugins_s3_object_version,
  :plugins_s3_path,
  :requirements_s3_object_version,
  :requirements_s3_path,
  :schedulers,
  :source_bucket_arn,
  :tags,
  :webserver_access_mode,
  :weekly_maintenance_window_start)
  SENSITIVE = [:airflow_configuration_options]
  include Aws::Structure
end

#source_bucket_arnString

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.

Returns:

  • (String)


316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
# File 'gems/aws-sdk-mwaa/lib/aws-sdk-mwaa/types.rb', line 316

class CreateEnvironmentInput < Struct.new(
  :airflow_configuration_options,
  :airflow_version,
  :dag_s3_path,
  :environment_class,
  :execution_role_arn,
  :kms_key,
  :logging_configuration,
  :max_workers,
  :min_workers,
  :name,
  :network_configuration,
  :plugins_s3_object_version,
  :plugins_s3_path,
  :requirements_s3_object_version,
  :requirements_s3_path,
  :schedulers,
  :source_bucket_arn,
  :tags,
  :webserver_access_mode,
  :weekly_maintenance_window_start)
  SENSITIVE = [:airflow_configuration_options]
  include Aws::Structure
end

#tagsHash<String,String>

The key-value tag pairs you want to associate to your environment. For example, "Environment": "Staging". To learn more, see Tagging AWS resources.

Returns:

  • (Hash<String,String>)


316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
# File 'gems/aws-sdk-mwaa/lib/aws-sdk-mwaa/types.rb', line 316

class CreateEnvironmentInput < Struct.new(
  :airflow_configuration_options,
  :airflow_version,
  :dag_s3_path,
  :environment_class,
  :execution_role_arn,
  :kms_key,
  :logging_configuration,
  :max_workers,
  :min_workers,
  :name,
  :network_configuration,
  :plugins_s3_object_version,
  :plugins_s3_path,
  :requirements_s3_object_version,
  :requirements_s3_path,
  :schedulers,
  :source_bucket_arn,
  :tags,
  :webserver_access_mode,
  :weekly_maintenance_window_start)
  SENSITIVE = [:airflow_configuration_options]
  include Aws::Structure
end

#webserver_access_modeString

The Apache Airflow Web server access mode. To learn more, see Apache Airflow access modes.

Returns:

  • (String)


316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
# File 'gems/aws-sdk-mwaa/lib/aws-sdk-mwaa/types.rb', line 316

class CreateEnvironmentInput < Struct.new(
  :airflow_configuration_options,
  :airflow_version,
  :dag_s3_path,
  :environment_class,
  :execution_role_arn,
  :kms_key,
  :logging_configuration,
  :max_workers,
  :min_workers,
  :name,
  :network_configuration,
  :plugins_s3_object_version,
  :plugins_s3_path,
  :requirements_s3_object_version,
  :requirements_s3_path,
  :schedulers,
  :source_bucket_arn,
  :tags,
  :webserver_access_mode,
  :weekly_maintenance_window_start)
  SENSITIVE = [:airflow_configuration_options]
  include Aws::Structure
end

#weekly_maintenance_window_startString

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)

^

Returns:

  • (String)


316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
# File 'gems/aws-sdk-mwaa/lib/aws-sdk-mwaa/types.rb', line 316

class CreateEnvironmentInput < Struct.new(
  :airflow_configuration_options,
  :airflow_version,
  :dag_s3_path,
  :environment_class,
  :execution_role_arn,
  :kms_key,
  :logging_configuration,
  :max_workers,
  :min_workers,
  :name,
  :network_configuration,
  :plugins_s3_object_version,
  :plugins_s3_path,
  :requirements_s3_object_version,
  :requirements_s3_path,
  :schedulers,
  :source_bucket_arn,
  :tags,
  :webserver_access_mode,
  :weekly_maintenance_window_start)
  SENSITIVE = [:airflow_configuration_options]
  include Aws::Structure
end