Class: Aws::MWAA::Types::Environment

Inherits:

Struct

Object
Struct
Aws::MWAA::Types::Environment

show all

Defined in:: gems/aws-sdk-mwaa/lib/aws-sdk-mwaa/types.rb

Overview

Describes an Amazon Managed Workflows for Apache Airflow (MWAA) environment.

Constant Summary collapse

SENSITIVE =

[:airflow_configuration_options]

Instance Attribute Summary collapse

#airflow_configuration_options ⇒ Hash<String,String>
A list of key-value pairs containing the Apache Airflow configuration options attached to your environment.
#airflow_version ⇒ String
The Apache Airflow version on your environment.
#arn ⇒ String
The Amazon Resource Name (ARN) of the Amazon MWAA environment.
#celery_executor_queue ⇒ String
The queue ARN for the environment's [Celery Executor][1].
#created_at ⇒ Time
The day and time the environment was created.
#dag_s3_path ⇒ String
The relative path to the DAGs folder in your Amazon S3 bucket.
#database_vpc_endpoint_service ⇒ String
The VPC endpoint for the environment's Amazon RDS database.
#endpoint_management ⇒ String
Defines whether the VPC endpoints configured for the environment are created, and managed, by the customer or by Amazon MWAA.
#environment_class ⇒ String
The environment class type.
#execution_role_arn ⇒ String
The Amazon Resource Name (ARN) of the execution role in IAM that allows MWAA to access Amazon Web Services resources in your environment.
#kms_key ⇒ String
The KMS encryption key used to encrypt the data in your environment.
#last_update ⇒ Types::LastUpdate
The status of the last update on the environment.
#logging_configuration ⇒ Types::LoggingConfiguration
The Apache Airflow logs published to CloudWatch Logs.
#max_workers ⇒ Integer
The maximum number of workers that run in your environment.
#min_workers ⇒ Integer
The minimum number of workers that run in your environment.
#name ⇒ String
The name of the Amazon MWAA environment.
#network_configuration ⇒ Types::NetworkConfiguration
Describes the VPC networking components used to secure and enable network traffic between the Amazon Web Services resources for your environment.
#plugins_s3_object_version ⇒ String
The version of the plugins.zip file in your Amazon S3 bucket.
#plugins_s3_path ⇒ String
The relative path to the file in your Amazon S3 bucket.
#requirements_s3_object_version ⇒ String
The version of the requirements.txt file on your Amazon S3 bucket.
#requirements_s3_path ⇒ String
The relative path to the requirements.txt file in your Amazon S3 bucket.
#schedulers ⇒ Integer
The number of Apache Airflow schedulers that run in your Amazon MWAA environment.
#service_role_arn ⇒ String
The Amazon Resource Name (ARN) for the service-linked role of the environment.
#source_bucket_arn ⇒ String
The Amazon Resource Name (ARN) of the Amazon S3 bucket where your DAG code and supporting files are stored.
#startup_script_s3_object_version ⇒ String
The version of the startup shell script in your Amazon S3 bucket.
#startup_script_s3_path ⇒ String
The relative path to the startup shell script in your Amazon S3 bucket.
#status ⇒ String
The status of the Amazon MWAA environment.
#tags ⇒ Hash<String,String>
The key-value tag pairs associated to your environment.
#webserver_access_mode ⇒ String
The Apache Airflow web server access mode.
#webserver_url ⇒ String
The Apache Airflow web server host name for the Amazon MWAA environment.
#webserver_vpc_endpoint_service ⇒ String
The VPC endpoint for the environment's web server.
#weekly_maintenance_window_start ⇒ String
The day and time of the week in Coordinated Universal Time (UTC) 24-hour standard time that weekly maintenance updates are scheduled.

Instance Attribute Details

#airflow_configuration_options ⇒ `Hash<String,String>`

A list of key-value pairs containing the Apache Airflow configuration options attached to your environment. For more information, see Apache Airflow configuration options.

Returns:

(Hash<String,String>)

# File 'gems/aws-sdk-mwaa/lib/aws-sdk-mwaa/types.rb', line 782

class Environment < Struct.new(
  :airflow_configuration_options,
  :airflow_version,
  :arn,
  :celery_executor_queue,
  :created_at,
  :dag_s3_path,
  :database_vpc_endpoint_service,
  :endpoint_management,
  :environment_class,
  :execution_role_arn,
  :kms_key,
  :last_update,
  :logging_configuration,
  :max_workers,
  :min_workers,
  :name,
  :network_configuration,
  :plugins_s3_object_version,
  :plugins_s3_path,
  :requirements_s3_object_version,
  :requirements_s3_path,
  :schedulers,
  :service_role_arn,
  :source_bucket_arn,
  :startup_script_s3_object_version,
  :startup_script_s3_path,
  :status,
  :tags,
  :webserver_access_mode,
  :webserver_url,
  :webserver_vpc_endpoint_service,
  :weekly_maintenance_window_start)
  SENSITIVE = [:airflow_configuration_options]
  include Aws::Structure
end

#airflow_version ⇒ `String`

The Apache Airflow version on your environment.

Valid values: 1.10.12, 2.0.2, 2.2.2, 2.4.3, 2.5.1, 2.6.3, 2.7.2.

Returns:

(String)

# File 'gems/aws-sdk-mwaa/lib/aws-sdk-mwaa/types.rb', line 782

class Environment < Struct.new(
  :airflow_configuration_options,
  :airflow_version,
  :arn,
  :celery_executor_queue,
  :created_at,
  :dag_s3_path,
  :database_vpc_endpoint_service,
  :endpoint_management,
  :environment_class,
  :execution_role_arn,
  :kms_key,
  :last_update,
  :logging_configuration,
  :max_workers,
  :min_workers,
  :name,
  :network_configuration,
  :plugins_s3_object_version,
  :plugins_s3_path,
  :requirements_s3_object_version,
  :requirements_s3_path,
  :schedulers,
  :service_role_arn,
  :source_bucket_arn,
  :startup_script_s3_object_version,
  :startup_script_s3_path,
  :status,
  :tags,
  :webserver_access_mode,
  :webserver_url,
  :webserver_vpc_endpoint_service,
  :weekly_maintenance_window_start)
  SENSITIVE = [:airflow_configuration_options]
  include Aws::Structure
end

#arn ⇒ `String`

The Amazon Resource Name (ARN) of the Amazon MWAA environment.

Returns:

(String)

# File 'gems/aws-sdk-mwaa/lib/aws-sdk-mwaa/types.rb', line 782

class Environment < Struct.new(
  :airflow_configuration_options,
  :airflow_version,
  :arn,
  :celery_executor_queue,
  :created_at,
  :dag_s3_path,
  :database_vpc_endpoint_service,
  :endpoint_management,
  :environment_class,
  :execution_role_arn,
  :kms_key,
  :last_update,
  :logging_configuration,
  :max_workers,
  :min_workers,
  :name,
  :network_configuration,
  :plugins_s3_object_version,
  :plugins_s3_path,
  :requirements_s3_object_version,
  :requirements_s3_path,
  :schedulers,
  :service_role_arn,
  :source_bucket_arn,
  :startup_script_s3_object_version,
  :startup_script_s3_path,
  :status,
  :tags,
  :webserver_access_mode,
  :webserver_url,
  :webserver_vpc_endpoint_service,
  :weekly_maintenance_window_start)
  SENSITIVE = [:airflow_configuration_options]
  include Aws::Structure
end

#celery_executor_queue ⇒ `String`

The queue ARN for the environment's Celery Executor. Amazon MWAA uses a Celery Executor to distribute tasks across multiple workers. When you create an environment in a shared VPC, you must provide access to the Celery Executor queue from your VPC.

Returns:

(String)

# File 'gems/aws-sdk-mwaa/lib/aws-sdk-mwaa/types.rb', line 782

class Environment < Struct.new(
  :airflow_configuration_options,
  :airflow_version,
  :arn,
  :celery_executor_queue,
  :created_at,
  :dag_s3_path,
  :database_vpc_endpoint_service,
  :endpoint_management,
  :environment_class,
  :execution_role_arn,
  :kms_key,
  :last_update,
  :logging_configuration,
  :max_workers,
  :min_workers,
  :name,
  :network_configuration,
  :plugins_s3_object_version,
  :plugins_s3_path,
  :requirements_s3_object_version,
  :requirements_s3_path,
  :schedulers,
  :service_role_arn,
  :source_bucket_arn,
  :startup_script_s3_object_version,
  :startup_script_s3_path,
  :status,
  :tags,
  :webserver_access_mode,
  :webserver_url,
  :webserver_vpc_endpoint_service,
  :weekly_maintenance_window_start)
  SENSITIVE = [:airflow_configuration_options]
  include Aws::Structure
end

#created_at ⇒ `Time`

The day and time the environment was created.

Returns:

(Time)

# File 'gems/aws-sdk-mwaa/lib/aws-sdk-mwaa/types.rb', line 782

class Environment < Struct.new(
  :airflow_configuration_options,
  :airflow_version,
  :arn,
  :celery_executor_queue,
  :created_at,
  :dag_s3_path,
  :database_vpc_endpoint_service,
  :endpoint_management,
  :environment_class,
  :execution_role_arn,
  :kms_key,
  :last_update,
  :logging_configuration,
  :max_workers,
  :min_workers,
  :name,
  :network_configuration,
  :plugins_s3_object_version,
  :plugins_s3_path,
  :requirements_s3_object_version,
  :requirements_s3_path,
  :schedulers,
  :service_role_arn,
  :source_bucket_arn,
  :startup_script_s3_object_version,
  :startup_script_s3_path,
  :status,
  :tags,
  :webserver_access_mode,
  :webserver_url,
  :webserver_vpc_endpoint_service,
  :weekly_maintenance_window_start)
  SENSITIVE = [:airflow_configuration_options]
  include Aws::Structure
end

#dag_s3_path ⇒ `String`

The relative path to the DAGs folder in your Amazon S3 bucket. For example, s3://mwaa-environment/dags. For more information, see Adding or updating DAGs.

Returns:

(String)

# File 'gems/aws-sdk-mwaa/lib/aws-sdk-mwaa/types.rb', line 782

class Environment < Struct.new(
  :airflow_configuration_options,
  :airflow_version,
  :arn,
  :celery_executor_queue,
  :created_at,
  :dag_s3_path,
  :database_vpc_endpoint_service,
  :endpoint_management,
  :environment_class,
  :execution_role_arn,
  :kms_key,
  :last_update,
  :logging_configuration,
  :max_workers,
  :min_workers,
  :name,
  :network_configuration,
  :plugins_s3_object_version,
  :plugins_s3_path,
  :requirements_s3_object_version,
  :requirements_s3_path,
  :schedulers,
  :service_role_arn,
  :source_bucket_arn,
  :startup_script_s3_object_version,
  :startup_script_s3_path,
  :status,
  :tags,
  :webserver_access_mode,
  :webserver_url,
  :webserver_vpc_endpoint_service,
  :weekly_maintenance_window_start)
  SENSITIVE = [:airflow_configuration_options]
  include Aws::Structure
end

#database_vpc_endpoint_service ⇒ `String`

The VPC endpoint for the environment's Amazon RDS database.

Returns:

(String)

# File 'gems/aws-sdk-mwaa/lib/aws-sdk-mwaa/types.rb', line 782

class Environment < Struct.new(
  :airflow_configuration_options,
  :airflow_version,
  :arn,
  :celery_executor_queue,
  :created_at,
  :dag_s3_path,
  :database_vpc_endpoint_service,
  :endpoint_management,
  :environment_class,
  :execution_role_arn,
  :kms_key,
  :last_update,
  :logging_configuration,
  :max_workers,
  :min_workers,
  :name,
  :network_configuration,
  :plugins_s3_object_version,
  :plugins_s3_path,
  :requirements_s3_object_version,
  :requirements_s3_path,
  :schedulers,
  :service_role_arn,
  :source_bucket_arn,
  :startup_script_s3_object_version,
  :startup_script_s3_path,
  :status,
  :tags,
  :webserver_access_mode,
  :webserver_url,
  :webserver_vpc_endpoint_service,
  :weekly_maintenance_window_start)
  SENSITIVE = [:airflow_configuration_options]
  include Aws::Structure
end

#endpoint_management ⇒ `String`

Defines whether the VPC endpoints configured for the environment are created, and managed, by the customer or by Amazon MWAA. If set to SERVICE, Amazon MWAA will create and manage the required VPC endpoints in your VPC. If set to CUSTOMER, you must create, and manage, the VPC endpoints in your VPC.

Returns:

(String)

# File 'gems/aws-sdk-mwaa/lib/aws-sdk-mwaa/types.rb', line 782

class Environment < Struct.new(
  :airflow_configuration_options,
  :airflow_version,
  :arn,
  :celery_executor_queue,
  :created_at,
  :dag_s3_path,
  :database_vpc_endpoint_service,
  :endpoint_management,
  :environment_class,
  :execution_role_arn,
  :kms_key,
  :last_update,
  :logging_configuration,
  :max_workers,
  :min_workers,
  :name,
  :network_configuration,
  :plugins_s3_object_version,
  :plugins_s3_path,
  :requirements_s3_object_version,
  :requirements_s3_path,
  :schedulers,
  :service_role_arn,
  :source_bucket_arn,
  :startup_script_s3_object_version,
  :startup_script_s3_path,
  :status,
  :tags,
  :webserver_access_mode,
  :webserver_url,
  :webserver_vpc_endpoint_service,
  :weekly_maintenance_window_start)
  SENSITIVE = [:airflow_configuration_options]
  include Aws::Structure
end

#environment_class ⇒ `String`

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

Returns:

(String)

# File 'gems/aws-sdk-mwaa/lib/aws-sdk-mwaa/types.rb', line 782

class Environment < Struct.new(
  :airflow_configuration_options,
  :airflow_version,
  :arn,
  :celery_executor_queue,
  :created_at,
  :dag_s3_path,
  :database_vpc_endpoint_service,
  :endpoint_management,
  :environment_class,
  :execution_role_arn,
  :kms_key,
  :last_update,
  :logging_configuration,
  :max_workers,
  :min_workers,
  :name,
  :network_configuration,
  :plugins_s3_object_version,
  :plugins_s3_path,
  :requirements_s3_object_version,
  :requirements_s3_path,
  :schedulers,
  :service_role_arn,
  :source_bucket_arn,
  :startup_script_s3_object_version,
  :startup_script_s3_path,
  :status,
  :tags,
  :webserver_access_mode,
  :webserver_url,
  :webserver_vpc_endpoint_service,
  :weekly_maintenance_window_start)
  SENSITIVE = [:airflow_configuration_options]
  include Aws::Structure
end

#execution_role_arn ⇒ `String`

The Amazon Resource Name (ARN) of the execution role in IAM that allows MWAA to access Amazon Web Services resources in your environment. For example, arn:aws:iam::123456789:role/my-execution-role. For more information, see Amazon MWAA Execution role.

Returns:

(String)

# File 'gems/aws-sdk-mwaa/lib/aws-sdk-mwaa/types.rb', line 782

class Environment < Struct.new(
  :airflow_configuration_options,
  :airflow_version,
  :arn,
  :celery_executor_queue,
  :created_at,
  :dag_s3_path,
  :database_vpc_endpoint_service,
  :endpoint_management,
  :environment_class,
  :execution_role_arn,
  :kms_key,
  :last_update,
  :logging_configuration,
  :max_workers,
  :min_workers,
  :name,
  :network_configuration,
  :plugins_s3_object_version,
  :plugins_s3_path,
  :requirements_s3_object_version,
  :requirements_s3_path,
  :schedulers,
  :service_role_arn,
  :source_bucket_arn,
  :startup_script_s3_object_version,
  :startup_script_s3_path,
  :status,
  :tags,
  :webserver_access_mode,
  :webserver_url,
  :webserver_vpc_endpoint_service,
  :weekly_maintenance_window_start)
  SENSITIVE = [:airflow_configuration_options]
  include Aws::Structure
end

#kms_key ⇒ `String`

The KMS encryption key used to encrypt the data in your environment.

Returns:

(String)

# File 'gems/aws-sdk-mwaa/lib/aws-sdk-mwaa/types.rb', line 782

class Environment < Struct.new(
  :airflow_configuration_options,
  :airflow_version,
  :arn,
  :celery_executor_queue,
  :created_at,
  :dag_s3_path,
  :database_vpc_endpoint_service,
  :endpoint_management,
  :environment_class,
  :execution_role_arn,
  :kms_key,
  :last_update,
  :logging_configuration,
  :max_workers,
  :min_workers,
  :name,
  :network_configuration,
  :plugins_s3_object_version,
  :plugins_s3_path,
  :requirements_s3_object_version,
  :requirements_s3_path,
  :schedulers,
  :service_role_arn,
  :source_bucket_arn,
  :startup_script_s3_object_version,
  :startup_script_s3_path,
  :status,
  :tags,
  :webserver_access_mode,
  :webserver_url,
  :webserver_vpc_endpoint_service,
  :weekly_maintenance_window_start)
  SENSITIVE = [:airflow_configuration_options]
  include Aws::Structure
end

#last_update ⇒ `Types::LastUpdate`

The status of the last update on the environment.

Returns:

(Types::LastUpdate)

# File 'gems/aws-sdk-mwaa/lib/aws-sdk-mwaa/types.rb', line 782

class Environment < Struct.new(
  :airflow_configuration_options,
  :airflow_version,
  :arn,
  :celery_executor_queue,
  :created_at,
  :dag_s3_path,
  :database_vpc_endpoint_service,
  :endpoint_management,
  :environment_class,
  :execution_role_arn,
  :kms_key,
  :last_update,
  :logging_configuration,
  :max_workers,
  :min_workers,
  :name,
  :network_configuration,
  :plugins_s3_object_version,
  :plugins_s3_path,
  :requirements_s3_object_version,
  :requirements_s3_path,
  :schedulers,
  :service_role_arn,
  :source_bucket_arn,
  :startup_script_s3_object_version,
  :startup_script_s3_path,
  :status,
  :tags,
  :webserver_access_mode,
  :webserver_url,
  :webserver_vpc_endpoint_service,
  :weekly_maintenance_window_start)
  SENSITIVE = [:airflow_configuration_options]
  include Aws::Structure
end

#logging_configuration ⇒ `Types::LoggingConfiguration`

The Apache Airflow logs published to CloudWatch Logs.

Returns:

(Types::LoggingConfiguration)

# File 'gems/aws-sdk-mwaa/lib/aws-sdk-mwaa/types.rb', line 782

class Environment < Struct.new(
  :airflow_configuration_options,
  :airflow_version,
  :arn,
  :celery_executor_queue,
  :created_at,
  :dag_s3_path,
  :database_vpc_endpoint_service,
  :endpoint_management,
  :environment_class,
  :execution_role_arn,
  :kms_key,
  :last_update,
  :logging_configuration,
  :max_workers,
  :min_workers,
  :name,
  :network_configuration,
  :plugins_s3_object_version,
  :plugins_s3_path,
  :requirements_s3_object_version,
  :requirements_s3_path,
  :schedulers,
  :service_role_arn,
  :source_bucket_arn,
  :startup_script_s3_object_version,
  :startup_script_s3_path,
  :status,
  :tags,
  :webserver_access_mode,
  :webserver_url,
  :webserver_vpc_endpoint_service,
  :weekly_maintenance_window_start)
  SENSITIVE = [:airflow_configuration_options]
  include Aws::Structure
end

#max_workers ⇒ `Integer`

The maximum number of workers that run in your environment. For example, 20.

Returns:

(Integer)

# File 'gems/aws-sdk-mwaa/lib/aws-sdk-mwaa/types.rb', line 782

class Environment < Struct.new(
  :airflow_configuration_options,
  :airflow_version,
  :arn,
  :celery_executor_queue,
  :created_at,
  :dag_s3_path,
  :database_vpc_endpoint_service,
  :endpoint_management,
  :environment_class,
  :execution_role_arn,
  :kms_key,
  :last_update,
  :logging_configuration,
  :max_workers,
  :min_workers,
  :name,
  :network_configuration,
  :plugins_s3_object_version,
  :plugins_s3_path,
  :requirements_s3_object_version,
  :requirements_s3_path,
  :schedulers,
  :service_role_arn,
  :source_bucket_arn,
  :startup_script_s3_object_version,
  :startup_script_s3_path,
  :status,
  :tags,
  :webserver_access_mode,
  :webserver_url,
  :webserver_vpc_endpoint_service,
  :weekly_maintenance_window_start)
  SENSITIVE = [:airflow_configuration_options]
  include Aws::Structure
end

#min_workers ⇒ `Integer`

The minimum number of workers that run in your environment. For example, 2.

Returns:

(Integer)

# File 'gems/aws-sdk-mwaa/lib/aws-sdk-mwaa/types.rb', line 782

class Environment < Struct.new(
  :airflow_configuration_options,
  :airflow_version,
  :arn,
  :celery_executor_queue,
  :created_at,
  :dag_s3_path,
  :database_vpc_endpoint_service,
  :endpoint_management,
  :environment_class,
  :execution_role_arn,
  :kms_key,
  :last_update,
  :logging_configuration,
  :max_workers,
  :min_workers,
  :name,
  :network_configuration,
  :plugins_s3_object_version,
  :plugins_s3_path,
  :requirements_s3_object_version,
  :requirements_s3_path,
  :schedulers,
  :service_role_arn,
  :source_bucket_arn,
  :startup_script_s3_object_version,
  :startup_script_s3_path,
  :status,
  :tags,
  :webserver_access_mode,
  :webserver_url,
  :webserver_vpc_endpoint_service,
  :weekly_maintenance_window_start)
  SENSITIVE = [:airflow_configuration_options]
  include Aws::Structure
end

#name ⇒ `String`

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

Returns:

(String)

# File 'gems/aws-sdk-mwaa/lib/aws-sdk-mwaa/types.rb', line 782

class Environment < Struct.new(
  :airflow_configuration_options,
  :airflow_version,
  :arn,
  :celery_executor_queue,
  :created_at,
  :dag_s3_path,
  :database_vpc_endpoint_service,
  :endpoint_management,
  :environment_class,
  :execution_role_arn,
  :kms_key,
  :last_update,
  :logging_configuration,
  :max_workers,
  :min_workers,
  :name,
  :network_configuration,
  :plugins_s3_object_version,
  :plugins_s3_path,
  :requirements_s3_object_version,
  :requirements_s3_path,
  :schedulers,
  :service_role_arn,
  :source_bucket_arn,
  :startup_script_s3_object_version,
  :startup_script_s3_path,
  :status,
  :tags,
  :webserver_access_mode,
  :webserver_url,
  :webserver_vpc_endpoint_service,
  :weekly_maintenance_window_start)
  SENSITIVE = [:airflow_configuration_options]
  include Aws::Structure
end

#network_configuration ⇒ `Types::NetworkConfiguration`

Describes the VPC networking components used to secure and enable network traffic between the Amazon Web Services resources for your environment. For more information, see About networking on Amazon MWAA.

Returns:

(Types::NetworkConfiguration)

# File 'gems/aws-sdk-mwaa/lib/aws-sdk-mwaa/types.rb', line 782

class Environment < Struct.new(
  :airflow_configuration_options,
  :airflow_version,
  :arn,
  :celery_executor_queue,
  :created_at,
  :dag_s3_path,
  :database_vpc_endpoint_service,
  :endpoint_management,
  :environment_class,
  :execution_role_arn,
  :kms_key,
  :last_update,
  :logging_configuration,
  :max_workers,
  :min_workers,
  :name,
  :network_configuration,
  :plugins_s3_object_version,
  :plugins_s3_path,
  :requirements_s3_object_version,
  :requirements_s3_path,
  :schedulers,
  :service_role_arn,
  :source_bucket_arn,
  :startup_script_s3_object_version,
  :startup_script_s3_path,
  :status,
  :tags,
  :webserver_access_mode,
  :webserver_url,
  :webserver_vpc_endpoint_service,
  :weekly_maintenance_window_start)
  SENSITIVE = [:airflow_configuration_options]
  include Aws::Structure
end

#plugins_s3_object_version ⇒ `String`

The version of the plugins.zip file in your Amazon S3 bucket. You must specify the version ID that Amazon S3 assigns to the file.

Version IDs are Unicode, UTF-8 encoded, URL-ready, opaque strings that are no more than 1,024 bytes long. The following is an example:

3sL4kqtJlcpXroDTDmJ+rmSpXd3dIbrHY+MTRCxf3vjVBH40Nr8X8gdRQBpUMLUo

For more information, see Installing custom plugins.

Returns:

(String)

# File 'gems/aws-sdk-mwaa/lib/aws-sdk-mwaa/types.rb', line 782

class Environment < Struct.new(
  :airflow_configuration_options,
  :airflow_version,
  :arn,
  :celery_executor_queue,
  :created_at,
  :dag_s3_path,
  :database_vpc_endpoint_service,
  :endpoint_management,
  :environment_class,
  :execution_role_arn,
  :kms_key,
  :last_update,
  :logging_configuration,
  :max_workers,
  :min_workers,
  :name,
  :network_configuration,
  :plugins_s3_object_version,
  :plugins_s3_path,
  :requirements_s3_object_version,
  :requirements_s3_path,
  :schedulers,
  :service_role_arn,
  :source_bucket_arn,
  :startup_script_s3_object_version,
  :startup_script_s3_path,
  :status,
  :tags,
  :webserver_access_mode,
  :webserver_url,
  :webserver_vpc_endpoint_service,
  :weekly_maintenance_window_start)
  SENSITIVE = [:airflow_configuration_options]
  include Aws::Structure
end

#plugins_s3_path ⇒ `String`

The relative path to the file in your Amazon S3 bucket. For example, s3://mwaa-environment/plugins.zip. For more information, see Installing custom plugins.

Returns:

(String)

# File 'gems/aws-sdk-mwaa/lib/aws-sdk-mwaa/types.rb', line 782

class Environment < Struct.new(
  :airflow_configuration_options,
  :airflow_version,
  :arn,
  :celery_executor_queue,
  :created_at,
  :dag_s3_path,
  :database_vpc_endpoint_service,
  :endpoint_management,
  :environment_class,
  :execution_role_arn,
  :kms_key,
  :last_update,
  :logging_configuration,
  :max_workers,
  :min_workers,
  :name,
  :network_configuration,
  :plugins_s3_object_version,
  :plugins_s3_path,
  :requirements_s3_object_version,
  :requirements_s3_path,
  :schedulers,
  :service_role_arn,
  :source_bucket_arn,
  :startup_script_s3_object_version,
  :startup_script_s3_path,
  :status,
  :tags,
  :webserver_access_mode,
  :webserver_url,
  :webserver_vpc_endpoint_service,
  :weekly_maintenance_window_start)
  SENSITIVE = [:airflow_configuration_options]
  include Aws::Structure
end

#requirements_s3_object_version ⇒ `String`

The version of the requirements.txt file on your Amazon S3 bucket. You must specify the version ID that Amazon S3 assigns to the file.

Version IDs are Unicode, UTF-8 encoded, URL-ready, opaque strings that are no more than 1,024 bytes long. The following is an example:

3sL4kqtJlcpXroDTDmJ+rmSpXd3dIbrHY+MTRCxf3vjVBH40Nr8X8gdRQBpUMLUo

For more information, see Installing Python dependencies.

Returns:

(String)

# File 'gems/aws-sdk-mwaa/lib/aws-sdk-mwaa/types.rb', line 782

class Environment < Struct.new(
  :airflow_configuration_options,
  :airflow_version,
  :arn,
  :celery_executor_queue,
  :created_at,
  :dag_s3_path,
  :database_vpc_endpoint_service,
  :endpoint_management,
  :environment_class,
  :execution_role_arn,
  :kms_key,
  :last_update,
  :logging_configuration,
  :max_workers,
  :min_workers,
  :name,
  :network_configuration,
  :plugins_s3_object_version,
  :plugins_s3_path,
  :requirements_s3_object_version,
  :requirements_s3_path,
  :schedulers,
  :service_role_arn,
  :source_bucket_arn,
  :startup_script_s3_object_version,
  :startup_script_s3_path,
  :status,
  :tags,
  :webserver_access_mode,
  :webserver_url,
  :webserver_vpc_endpoint_service,
  :weekly_maintenance_window_start)
  SENSITIVE = [:airflow_configuration_options]
  include Aws::Structure
end

#requirements_s3_path ⇒ `String`

The relative path to the requirements.txt file in your Amazon S3 bucket. For example, s3://mwaa-environment/requirements.txt. For more information, see Installing Python dependencies.

Returns:

(String)

# File 'gems/aws-sdk-mwaa/lib/aws-sdk-mwaa/types.rb', line 782

class Environment < Struct.new(
  :airflow_configuration_options,
  :airflow_version,
  :arn,
  :celery_executor_queue,
  :created_at,
  :dag_s3_path,
  :database_vpc_endpoint_service,
  :endpoint_management,
  :environment_class,
  :execution_role_arn,
  :kms_key,
  :last_update,
  :logging_configuration,
  :max_workers,
  :min_workers,
  :name,
  :network_configuration,
  :plugins_s3_object_version,
  :plugins_s3_path,
  :requirements_s3_object_version,
  :requirements_s3_path,
  :schedulers,
  :service_role_arn,
  :source_bucket_arn,
  :startup_script_s3_object_version,
  :startup_script_s3_path,
  :status,
  :tags,
  :webserver_access_mode,
  :webserver_url,
  :webserver_vpc_endpoint_service,
  :weekly_maintenance_window_start)
  SENSITIVE = [:airflow_configuration_options]
  include Aws::Structure
end

#schedulers ⇒ `Integer`

The number of Apache Airflow schedulers that run in your Amazon MWAA environment.

Returns:

(Integer)

# File 'gems/aws-sdk-mwaa/lib/aws-sdk-mwaa/types.rb', line 782

class Environment < Struct.new(
  :airflow_configuration_options,
  :airflow_version,
  :arn,
  :celery_executor_queue,
  :created_at,
  :dag_s3_path,
  :database_vpc_endpoint_service,
  :endpoint_management,
  :environment_class,
  :execution_role_arn,
  :kms_key,
  :last_update,
  :logging_configuration,
  :max_workers,
  :min_workers,
  :name,
  :network_configuration,
  :plugins_s3_object_version,
  :plugins_s3_path,
  :requirements_s3_object_version,
  :requirements_s3_path,
  :schedulers,
  :service_role_arn,
  :source_bucket_arn,
  :startup_script_s3_object_version,
  :startup_script_s3_path,
  :status,
  :tags,
  :webserver_access_mode,
  :webserver_url,
  :webserver_vpc_endpoint_service,
  :weekly_maintenance_window_start)
  SENSITIVE = [:airflow_configuration_options]
  include Aws::Structure
end

#service_role_arn ⇒ `String`

The Amazon Resource Name (ARN) for the service-linked role of the environment. For more information, see Amazon MWAA Service-linked role.

Returns:

(String)

# File 'gems/aws-sdk-mwaa/lib/aws-sdk-mwaa/types.rb', line 782

class Environment < Struct.new(
  :airflow_configuration_options,
  :airflow_version,
  :arn,
  :celery_executor_queue,
  :created_at,
  :dag_s3_path,
  :database_vpc_endpoint_service,
  :endpoint_management,
  :environment_class,
  :execution_role_arn,
  :kms_key,
  :last_update,
  :logging_configuration,
  :max_workers,
  :min_workers,
  :name,
  :network_configuration,
  :plugins_s3_object_version,
  :plugins_s3_path,
  :requirements_s3_object_version,
  :requirements_s3_path,
  :schedulers,
  :service_role_arn,
  :source_bucket_arn,
  :startup_script_s3_object_version,
  :startup_script_s3_path,
  :status,
  :tags,
  :webserver_access_mode,
  :webserver_url,
  :webserver_vpc_endpoint_service,
  :weekly_maintenance_window_start)
  SENSITIVE = [:airflow_configuration_options]
  include Aws::Structure
end

#source_bucket_arn ⇒ `String`

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. For more information, see Create an Amazon S3 bucket for Amazon MWAA.

Returns:

(String)

# File 'gems/aws-sdk-mwaa/lib/aws-sdk-mwaa/types.rb', line 782

class Environment < Struct.new(
  :airflow_configuration_options,
  :airflow_version,
  :arn,
  :celery_executor_queue,
  :created_at,
  :dag_s3_path,
  :database_vpc_endpoint_service,
  :endpoint_management,
  :environment_class,
  :execution_role_arn,
  :kms_key,
  :last_update,
  :logging_configuration,
  :max_workers,
  :min_workers,
  :name,
  :network_configuration,
  :plugins_s3_object_version,
  :plugins_s3_path,
  :requirements_s3_object_version,
  :requirements_s3_path,
  :schedulers,
  :service_role_arn,
  :source_bucket_arn,
  :startup_script_s3_object_version,
  :startup_script_s3_path,
  :status,
  :tags,
  :webserver_access_mode,
  :webserver_url,
  :webserver_vpc_endpoint_service,
  :weekly_maintenance_window_start)
  SENSITIVE = [:airflow_configuration_options]
  include Aws::Structure
end

#startup_script_s3_object_version ⇒ `String`

The version of the startup shell script in your Amazon S3 bucket. You must specify the version ID that Amazon S3 assigns to the file.

Version IDs are Unicode, UTF-8 encoded, URL-ready, opaque strings that are no more than 1,024 bytes long. The following is an example:

3sL4kqtJlcpXroDTDmJ+rmSpXd3dIbrHY+MTRCxf3vjVBH40Nr8X8gdRQBpUMLUo

For more information, see Using a startup script.

Returns:

(String)

# File 'gems/aws-sdk-mwaa/lib/aws-sdk-mwaa/types.rb', line 782

class Environment < Struct.new(
  :airflow_configuration_options,
  :airflow_version,
  :arn,
  :celery_executor_queue,
  :created_at,
  :dag_s3_path,
  :database_vpc_endpoint_service,
  :endpoint_management,
  :environment_class,
  :execution_role_arn,
  :kms_key,
  :last_update,
  :logging_configuration,
  :max_workers,
  :min_workers,
  :name,
  :network_configuration,
  :plugins_s3_object_version,
  :plugins_s3_path,
  :requirements_s3_object_version,
  :requirements_s3_path,
  :schedulers,
  :service_role_arn,
  :source_bucket_arn,
  :startup_script_s3_object_version,
  :startup_script_s3_path,
  :status,
  :tags,
  :webserver_access_mode,
  :webserver_url,
  :webserver_vpc_endpoint_service,
  :weekly_maintenance_window_start)
  SENSITIVE = [:airflow_configuration_options]
  include Aws::Structure
end

#startup_script_s3_path ⇒ `String`

The relative path to the startup shell script in your Amazon S3 bucket. For example, s3://mwaa-environment/startup.sh.

Amazon MWAA runs the script as your environment starts, and before running the Apache Airflow process. You can use this script to install dependencies, modify Apache Airflow configuration options, and set environment variables. For more information, see Using a startup script.

Returns:

(String)

# File 'gems/aws-sdk-mwaa/lib/aws-sdk-mwaa/types.rb', line 782

class Environment < Struct.new(
  :airflow_configuration_options,
  :airflow_version,
  :arn,
  :celery_executor_queue,
  :created_at,
  :dag_s3_path,
  :database_vpc_endpoint_service,
  :endpoint_management,
  :environment_class,
  :execution_role_arn,
  :kms_key,
  :last_update,
  :logging_configuration,
  :max_workers,
  :min_workers,
  :name,
  :network_configuration,
  :plugins_s3_object_version,
  :plugins_s3_path,
  :requirements_s3_object_version,
  :requirements_s3_path,
  :schedulers,
  :service_role_arn,
  :source_bucket_arn,
  :startup_script_s3_object_version,
  :startup_script_s3_path,
  :status,
  :tags,
  :webserver_access_mode,
  :webserver_url,
  :webserver_vpc_endpoint_service,
  :weekly_maintenance_window_start)
  SENSITIVE = [:airflow_configuration_options]
  include Aws::Structure
end

#status ⇒ `String`

The status of the Amazon MWAA environment.

Valid values:

CREATING - Indicates the request to create the environment is in progress.
CREATING_SNAPSHOT - Indicates the request to update environment details, or upgrade the environment version, is in progress and Amazon MWAA is creating a storage volume snapshot of the Amazon RDS database cluster associated with the environment. A database snapshot is a backup created at a specific point in time. Amazon MWAA uses snapshots to recover environment metadata if the process to update or upgrade an environment fails.
CREATE_FAILED - Indicates the request to create the environment failed, and the environment could not be created.
AVAILABLE - Indicates the request was successful and the environment is ready to use.
PENDING - Indicates the request was successful, but the process to create the environment is paused until you create the required VPC endpoints in your VPC. After you create the VPC endpoints, the process resumes.
UPDATING - Indicates the request to update the environment is in progress.
ROLLING_BACK - Indicates the request to update environment details, or upgrade the environment version, failed and Amazon MWAA is restoring the environment using the latest storage volume snapshot.
DELETING - Indicates the request to delete the environment is in progress.
DELETED - Indicates the request to delete the environment is complete, and the environment has been deleted.
UNAVAILABLE - Indicates the request failed, but the environment did not return to its previous state and is not stable.
UPDATE_FAILED - Indicates the request to update the environment failed, and the environment was restored to its previous state successfully and is ready to use.
MAINTENANCE - Indicates that the environment is undergoing maintenance. Depending on the type of work Amazon MWAA is performing, your environment might become unavailable during this process. After all operations are done, your environment will return to its status prior to mainteneace operations.

We recommend reviewing our troubleshooting guide for a list of common errors and their solutions. For more information, see Amazon MWAA troubleshooting.

Returns:

(String)

# File 'gems/aws-sdk-mwaa/lib/aws-sdk-mwaa/types.rb', line 782

class Environment < Struct.new(
  :airflow_configuration_options,
  :airflow_version,
  :arn,
  :celery_executor_queue,
  :created_at,
  :dag_s3_path,
  :database_vpc_endpoint_service,
  :endpoint_management,
  :environment_class,
  :execution_role_arn,
  :kms_key,
  :last_update,
  :logging_configuration,
  :max_workers,
  :min_workers,
  :name,
  :network_configuration,
  :plugins_s3_object_version,
  :plugins_s3_path,
  :requirements_s3_object_version,
  :requirements_s3_path,
  :schedulers,
  :service_role_arn,
  :source_bucket_arn,
  :startup_script_s3_object_version,
  :startup_script_s3_path,
  :status,
  :tags,
  :webserver_access_mode,
  :webserver_url,
  :webserver_vpc_endpoint_service,
  :weekly_maintenance_window_start)
  SENSITIVE = [:airflow_configuration_options]
  include Aws::Structure
end

#tags ⇒ `Hash<String,String>`

The key-value tag pairs associated to your environment. For example, "Environment": "Staging". For more information, see Tagging Amazon Web Services resources.

Returns:

(Hash<String,String>)

# File 'gems/aws-sdk-mwaa/lib/aws-sdk-mwaa/types.rb', line 782

class Environment < Struct.new(
  :airflow_configuration_options,
  :airflow_version,
  :arn,
  :celery_executor_queue,
  :created_at,
  :dag_s3_path,
  :database_vpc_endpoint_service,
  :endpoint_management,
  :environment_class,
  :execution_role_arn,
  :kms_key,
  :last_update,
  :logging_configuration,
  :max_workers,
  :min_workers,
  :name,
  :network_configuration,
  :plugins_s3_object_version,
  :plugins_s3_path,
  :requirements_s3_object_version,
  :requirements_s3_path,
  :schedulers,
  :service_role_arn,
  :source_bucket_arn,
  :startup_script_s3_object_version,
  :startup_script_s3_path,
  :status,
  :tags,
  :webserver_access_mode,
  :webserver_url,
  :webserver_vpc_endpoint_service,
  :weekly_maintenance_window_start)
  SENSITIVE = [:airflow_configuration_options]
  include Aws::Structure
end

#webserver_access_mode ⇒ `String`

The Apache Airflow web server access mode. For more information, see Apache Airflow access modes.

Returns:

(String)

# File 'gems/aws-sdk-mwaa/lib/aws-sdk-mwaa/types.rb', line 782

class Environment < Struct.new(
  :airflow_configuration_options,
  :airflow_version,
  :arn,
  :celery_executor_queue,
  :created_at,
  :dag_s3_path,
  :database_vpc_endpoint_service,
  :endpoint_management,
  :environment_class,
  :execution_role_arn,
  :kms_key,
  :last_update,
  :logging_configuration,
  :max_workers,
  :min_workers,
  :name,
  :network_configuration,
  :plugins_s3_object_version,
  :plugins_s3_path,
  :requirements_s3_object_version,
  :requirements_s3_path,
  :schedulers,
  :service_role_arn,
  :source_bucket_arn,
  :startup_script_s3_object_version,
  :startup_script_s3_path,
  :status,
  :tags,
  :webserver_access_mode,
  :webserver_url,
  :webserver_vpc_endpoint_service,
  :weekly_maintenance_window_start)
  SENSITIVE = [:airflow_configuration_options]
  include Aws::Structure
end

#webserver_url ⇒ `String`

The Apache Airflow web server host name for the Amazon MWAA environment. For more information, see Accessing the Apache Airflow UI.

Returns:

(String)

# File 'gems/aws-sdk-mwaa/lib/aws-sdk-mwaa/types.rb', line 782

class Environment < Struct.new(
  :airflow_configuration_options,
  :airflow_version,
  :arn,
  :celery_executor_queue,
  :created_at,
  :dag_s3_path,
  :database_vpc_endpoint_service,
  :endpoint_management,
  :environment_class,
  :execution_role_arn,
  :kms_key,
  :last_update,
  :logging_configuration,
  :max_workers,
  :min_workers,
  :name,
  :network_configuration,
  :plugins_s3_object_version,
  :plugins_s3_path,
  :requirements_s3_object_version,
  :requirements_s3_path,
  :schedulers,
  :service_role_arn,
  :source_bucket_arn,
  :startup_script_s3_object_version,
  :startup_script_s3_path,
  :status,
  :tags,
  :webserver_access_mode,
  :webserver_url,
  :webserver_vpc_endpoint_service,
  :weekly_maintenance_window_start)
  SENSITIVE = [:airflow_configuration_options]
  include Aws::Structure
end

#webserver_vpc_endpoint_service ⇒ `String`

The VPC endpoint for the environment's web server.

Returns:

(String)

# File 'gems/aws-sdk-mwaa/lib/aws-sdk-mwaa/types.rb', line 782

class Environment < Struct.new(
  :airflow_configuration_options,
  :airflow_version,
  :arn,
  :celery_executor_queue,
  :created_at,
  :dag_s3_path,
  :database_vpc_endpoint_service,
  :endpoint_management,
  :environment_class,
  :execution_role_arn,
  :kms_key,
  :last_update,
  :logging_configuration,
  :max_workers,
  :min_workers,
  :name,
  :network_configuration,
  :plugins_s3_object_version,
  :plugins_s3_path,
  :requirements_s3_object_version,
  :requirements_s3_path,
  :schedulers,
  :service_role_arn,
  :source_bucket_arn,
  :startup_script_s3_object_version,
  :startup_script_s3_path,
  :status,
  :tags,
  :webserver_access_mode,
  :webserver_url,
  :webserver_vpc_endpoint_service,
  :weekly_maintenance_window_start)
  SENSITIVE = [:airflow_configuration_options]
  include Aws::Structure
end

#weekly_maintenance_window_start ⇒ `String`

The day and time of the week in Coordinated Universal Time (UTC) 24-hour standard time that weekly maintenance updates are scheduled. For example: TUE:03:30.

Returns:

(String)

# File 'gems/aws-sdk-mwaa/lib/aws-sdk-mwaa/types.rb', line 782

class Environment < Struct.new(
  :airflow_configuration_options,
  :airflow_version,
  :arn,
  :celery_executor_queue,
  :created_at,
  :dag_s3_path,
  :database_vpc_endpoint_service,
  :endpoint_management,
  :environment_class,
  :execution_role_arn,
  :kms_key,
  :last_update,
  :logging_configuration,
  :max_workers,
  :min_workers,
  :name,
  :network_configuration,
  :plugins_s3_object_version,
  :plugins_s3_path,
  :requirements_s3_object_version,
  :requirements_s3_path,
  :schedulers,
  :service_role_arn,
  :source_bucket_arn,
  :startup_script_s3_object_version,
  :startup_script_s3_path,
  :status,
  :tags,
  :webserver_access_mode,
  :webserver_url,
  :webserver_vpc_endpoint_service,
  :weekly_maintenance_window_start)
  SENSITIVE = [:airflow_configuration_options]
  include Aws::Structure
end

Class: Aws::MWAA::Types::Environment

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#airflow_configuration_options ⇒ Hash<String,String>

#airflow_version ⇒ String

#arn ⇒ String

#celery_executor_queue ⇒ String

#created_at ⇒ Time

#dag_s3_path ⇒ String

#database_vpc_endpoint_service ⇒ String

#endpoint_management ⇒ String

#environment_class ⇒ String

#execution_role_arn ⇒ String

#kms_key ⇒ String

#last_update ⇒ Types::LastUpdate

#logging_configuration ⇒ Types::LoggingConfiguration

#max_workers ⇒ Integer

#min_workers ⇒ Integer

#name ⇒ String

#network_configuration ⇒ Types::NetworkConfiguration

#plugins_s3_object_version ⇒ String

#plugins_s3_path ⇒ String

#requirements_s3_object_version ⇒ String

#requirements_s3_path ⇒ String

#schedulers ⇒ Integer

#service_role_arn ⇒ String

#source_bucket_arn ⇒ String

#startup_script_s3_object_version ⇒ String

#startup_script_s3_path ⇒ String

#status ⇒ String

#tags ⇒ Hash<String,String>

#webserver_access_mode ⇒ String

#webserver_url ⇒ String

#webserver_vpc_endpoint_service ⇒ String

#weekly_maintenance_window_start ⇒ String

#airflow_configuration_options ⇒ `Hash<String,String>`

#airflow_version ⇒ `String`

#arn ⇒ `String`

#celery_executor_queue ⇒ `String`

#created_at ⇒ `Time`

#dag_s3_path ⇒ `String`

#database_vpc_endpoint_service ⇒ `String`

#endpoint_management ⇒ `String`

#environment_class ⇒ `String`

#execution_role_arn ⇒ `String`

#kms_key ⇒ `String`

#last_update ⇒ `Types::LastUpdate`

#logging_configuration ⇒ `Types::LoggingConfiguration`

#max_workers ⇒ `Integer`

#min_workers ⇒ `Integer`

#name ⇒ `String`

#network_configuration ⇒ `Types::NetworkConfiguration`

#plugins_s3_object_version ⇒ `String`

#plugins_s3_path ⇒ `String`

#requirements_s3_object_version ⇒ `String`

#requirements_s3_path ⇒ `String`

#schedulers ⇒ `Integer`

#service_role_arn ⇒ `String`

#source_bucket_arn ⇒ `String`

#startup_script_s3_object_version ⇒ `String`

#startup_script_s3_path ⇒ `String`

#status ⇒ `String`

#tags ⇒ `Hash<String,String>`

#webserver_access_mode ⇒ `String`

#webserver_url ⇒ `String`

#webserver_vpc_endpoint_service ⇒ `String`

#weekly_maintenance_window_start ⇒ `String`