GetEnvironmentResult

data class GetEnvironmentResult(val airflowConfigurationOptions: Any? = null, val airflowVersion: String? = null, val arn: String? = null, val celeryExecutorQueue: String? = null, val dagS3Path: String? = null, val databaseVpcEndpointService: String? = null, val environmentClass: String? = null, val executionRoleArn: String? = null, val loggingConfiguration: EnvironmentLoggingConfiguration? = null, val maxWebservers: Int? = null, val maxWorkers: Int? = null, val minWebservers: Int? = null, val minWorkers: Int? = null, val networkConfiguration: EnvironmentNetworkConfiguration? = null, val pluginsS3ObjectVersion: String? = null, val pluginsS3Path: String? = null, val requirementsS3ObjectVersion: String? = null, val requirementsS3Path: String? = null, val schedulers: Int? = null, val sourceBucketArn: String? = null, val startupScriptS3ObjectVersion: String? = null, val startupScriptS3Path: String? = null, val tags: Any? = null, val webserverAccessMode: EnvironmentWebserverAccessMode? = null, val webserverUrl: String? = null, val webserverVpcEndpointService: String? = null, val weeklyMaintenanceWindowStart: String? = null)

Constructors

Link copied to clipboard
constructor(airflowConfigurationOptions: Any? = null, airflowVersion: String? = null, arn: String? = null, celeryExecutorQueue: String? = null, dagS3Path: String? = null, databaseVpcEndpointService: String? = null, environmentClass: String? = null, executionRoleArn: String? = null, loggingConfiguration: EnvironmentLoggingConfiguration? = null, maxWebservers: Int? = null, maxWorkers: Int? = null, minWebservers: Int? = null, minWorkers: Int? = null, networkConfiguration: EnvironmentNetworkConfiguration? = null, pluginsS3ObjectVersion: String? = null, pluginsS3Path: String? = null, requirementsS3ObjectVersion: String? = null, requirementsS3Path: String? = null, schedulers: Int? = null, sourceBucketArn: String? = null, startupScriptS3ObjectVersion: String? = null, startupScriptS3Path: String? = null, tags: Any? = null, webserverAccessMode: EnvironmentWebserverAccessMode? = null, webserverUrl: String? = null, webserverVpcEndpointService: String? = null, weeklyMaintenanceWindowStart: String? = null)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard

Key/value pairs representing Airflow configuration variables. Keys are prefixed by their section: core dags_folder={AIRFLOW_HOME}/dags Would be represented as "core.dags_folder": "{AIRFLOW_HOME}/dags" Search the CloudFormation User Guide for AWS::MWAA::Environment for more information about the expected schema for this property.

Link copied to clipboard
val airflowVersion: String? = null

The version of Apache Airflow to use for the environment. If no value is specified, defaults to the latest version. If you specify a newer version number for an existing environment, the version update requires some service interruption before taking effect. Allowed Values : 1.10.12 | 2.0.2 | 2.2.2 | 2.4.3 | 2.5.1 | 2.6.3 | 2.7.2 | 2.8.1 | 2.9.2 (latest)

Link copied to clipboard
val arn: String? = null

The ARN for the Amazon MWAA environment.

Link copied to clipboard

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.

Link copied to clipboard
val dagS3Path: String? = null

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

The Apache Airflow logs being sent to CloudWatch Logs: DagProcessingLogs , SchedulerLogs , TaskLogs , WebserverLogs , WorkerLogs .

Link copied to clipboard
val maxWebservers: Int? = null

The maximum number of web servers that you want to run in your environment. Amazon MWAA scales the number of Apache Airflow web servers up to the number you specify for MaxWebservers when you interact with your Apache Airflow environment using Apache Airflow REST API, or the Apache Airflow CLI. For example, in scenarios where your workload requires network calls to the Apache Airflow REST API with a high transaction-per-second (TPS) rate, Amazon MWAA will increase the number of web servers up to the number set in MaxWebserers . As TPS rates decrease Amazon MWAA disposes of the additional web servers, and scales down to the number set in MinxWebserers . Valid values: Accepts between 2 and 5 . Defaults to 2 .

Link copied to clipboard
val maxWorkers: Int? = null

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 .

Link copied to clipboard
val minWebservers: Int? = null

The minimum number of web servers that you want to run in your environment. Amazon MWAA scales the number of Apache Airflow web servers up to the number you specify for MaxWebservers when you interact with your Apache Airflow environment using Apache Airflow REST API, or the Apache Airflow CLI. As the transaction-per-second rate, and the network load, decrease, Amazon MWAA disposes of the additional web servers, and scales down to the number set in MinxWebserers . Valid values: Accepts between 2 and 5 . Defaults to 2 .

Link copied to clipboard
val minWorkers: Int? = null

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 .

Link copied to clipboard

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 .

Link copied to clipboard

The version of the plugins.zip file on your Amazon S3 bucket. To learn more, see Installing custom plugins .

Link copied to clipboard
val pluginsS3Path: String? = null

The relative path to the plugins.zip file on your Amazon S3 bucket. For example, plugins.zip . To learn more, see Installing custom plugins .

Link copied to clipboard

The version of the requirements.txt file on your Amazon S3 bucket. To learn more, see Installing Python dependencies .

Link copied to clipboard

The relative path to the requirements.txt file on your Amazon S3 bucket. For example, requirements.txt . To learn more, see Installing Python dependencies .

Link copied to clipboard
val schedulers: Int? = null

The number of schedulers that you want to run in your environment. Valid values:

Link copied to clipboard
val sourceBucketArn: String? = null

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 .

Link copied to clipboard

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 every time you update the script. 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 .

Link copied to clipboard

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 .

Link copied to clipboard
val tags: Any? = null

A map of tags for the environment. Search the CloudFormation User Guide for AWS::MWAA::Environment for more information about the expected schema for this property.

Link copied to clipboard

The Apache Airflow Web server access mode. To learn more, see Apache Airflow access modes . Valid values: PRIVATE_ONLY or PUBLIC_ONLY .

Link copied to clipboard
val webserverUrl: String? = null

The URL of your Apache Airflow UI.

Link copied to clipboard

The VPC endpoint for the environment's web server.

Link copied to clipboard

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: