Type object
Schema URL https://catalog.lintel.tools/schemas/schemastore/serverless-framework-configuration/_shared/latest--aws-mwaa-environment.json
Parent schema serverless-framework-configuration
Type: object

Properties

Name string | Aws_CF_FunctionString required

Customer-defined identifier for the environment, unique per customer region.

ExecutionRoleArn string | Aws_CF_FunctionString

IAM role to be used by tasks.

KmsKey string | Aws_CF_FunctionString

The identifier of the AWS Key Management Service (AWS KMS) customer master key (CMK) to use for MWAA data encryption.

You can specify the CMK using any of the following:

Key ID. For example, key/1234abcd-12ab-34cd-56ef-1234567890ab.

Key alias. For example, alias/ExampleAlias.

Key ARN. For example, arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef.

Alias ARN. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.

AWS authenticates the CMK asynchronously. Therefore, if you specify an ID, alias, or ARN that is not valid, the action can appear to complete, but eventually fails.
AirflowVersion string | Aws_CF_FunctionString

Version of airflow to deploy to the environment.

SourceBucketArn string | Aws_CF_FunctionString

ARN for the AWS S3 bucket to use as the source of DAGs and plugins for the environment.

DagS3Path string | Aws_CF_FunctionString

Represents an S3 prefix relative to the root of an S3 bucket.

PluginsS3Path string | Aws_CF_FunctionString

Represents an S3 prefix relative to the root of an S3 bucket.

PluginsS3ObjectVersion string | Aws_CF_FunctionString

Represents an version ID for an S3 object.

RequirementsS3Path string | Aws_CF_FunctionString

Represents an S3 prefix relative to the root of an S3 bucket.

RequirementsS3ObjectVersion string | Aws_CF_FunctionString

Represents an version ID for an S3 object.

StartupScriptS3Path string | Aws_CF_FunctionString

Represents an S3 prefix relative to the root of an S3 bucket.

StartupScriptS3ObjectVersion string | Aws_CF_FunctionString

Represents an version ID for an S3 object.

AirflowConfigurationOptions object

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"
EnvironmentClass string | Aws_CF_FunctionString

Templated configuration for airflow processes and backing infrastructure.

MaxWorkers integer

Maximum worker compute units.

min=1
MinWorkers integer

Minimum worker compute units.

min=1
Schedulers integer

Scheduler compute units.

min=1
NetworkConfiguration object

Configures the network resources of the environment.

2 nested properties
SubnetIds SubnetId[]

A list of subnets to use for the environment. These must be private subnets, in the same VPC, in two different availability zones.

minItems=2maxItems=2
SecurityGroupIds SecurityGroupId[]

A list of security groups to use for the environment.

minItems=1maxItems=5
LoggingConfiguration object

Logging configuration for the environment.

5 nested properties
DagProcessingLogs object

Logging configuration for a specific airflow component.

3 nested properties
Enabled boolean
LogLevel string | Aws_CF_FunctionString
CloudWatchLogGroupArn string | Aws_CF_FunctionString
SchedulerLogs object

Logging configuration for a specific airflow component.

3 nested properties
Enabled boolean
LogLevel string | Aws_CF_FunctionString
CloudWatchLogGroupArn string | Aws_CF_FunctionString
WebserverLogs object

Logging configuration for a specific airflow component.

3 nested properties
Enabled boolean
LogLevel string | Aws_CF_FunctionString
CloudWatchLogGroupArn string | Aws_CF_FunctionString
WorkerLogs object

Logging configuration for a specific airflow component.

3 nested properties
Enabled boolean
LogLevel string | Aws_CF_FunctionString
CloudWatchLogGroupArn string | Aws_CF_FunctionString
TaskLogs object

Logging configuration for a specific airflow component.

3 nested properties
Enabled boolean
LogLevel string | Aws_CF_FunctionString
CloudWatchLogGroupArn string | Aws_CF_FunctionString
WeeklyMaintenanceWindowStart string | Aws_CF_FunctionString

Start time for the weekly maintenance window.

Tags object

A map of tags for the environment.

WebserverAccessMode string | Aws_CF_FunctionString

Choice for mode of webserver access including over public internet or via private VPC endpoint.

Definitions

EnvironmentName string | Aws_CF_FunctionString

Customer-defined identifier for the environment, unique per customer region.

EnvironmentStatus string | Aws_CF_FunctionString

The status of the environment.

UpdateStatus string | Aws_CF_FunctionString
UpdateError object

The error associated with an update request.

ErrorCode string | Aws_CF_FunctionString

The error code associated with an error.

ErrorMessage string | Aws_CF_FunctionString

Error message describing a failed operation.

AirflowArn string | Aws_CF_FunctionString
EnvironmentArn string | Aws_CF_FunctionString

ARN for the MWAA environment.

S3BucketArn string | Aws_CF_FunctionString

ARN for the AWS S3 bucket to use as the source of DAGs and plugins for the environment.

CreatedAt string | Aws_CF_FunctionString

When the environment resource was created.

UpdateCreatedAt string | Aws_CF_FunctionString

When the update request was created.

WebserverUrl string | Aws_CF_FunctionString

Url endpoint for the environment's Airflow UI.

ExecutionRoleArn string | Aws_CF_FunctionString

IAM role to be used by tasks.

ServiceRoleArn string | Aws_CF_FunctionString

IAM role to be used by MWAA to perform AWS API calls on behalf of the customer.

KmsKey string | Aws_CF_FunctionString

The identifier of the AWS Key Management Service (AWS KMS) customer master key (CMK) to use for MWAA data encryption.

You can specify the CMK using any of the following:

Key ID. For example, key/1234abcd-12ab-34cd-56ef-1234567890ab.

Key alias. For example, alias/ExampleAlias.

Key ARN. For example, arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef.

Alias ARN. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.

AWS authenticates the CMK asynchronously. Therefore, if you specify an ID, alias, or ARN that is not valid, the action can appear to complete, but eventually fails.
AirflowVersion string | Aws_CF_FunctionString

Version of airflow to deploy to the environment.

RelativePath string | Aws_CF_FunctionString

Represents an S3 prefix relative to the root of an S3 bucket.

ConfigKey string | Aws_CF_FunctionString
ConfigValue string | Aws_CF_FunctionString
SecurityGroupId string | Aws_CF_FunctionString
SubnetId string | Aws_CF_FunctionString
CloudWatchLogGroupArn string | Aws_CF_FunctionString
LoggingEnabled boolean
LoggingLevel string | Aws_CF_FunctionString
EnvironmentClass string | Aws_CF_FunctionString

Templated configuration for airflow processes and backing infrastructure.

MaxWorkers integer

Maximum worker compute units.

MinWorkers integer

Minimum worker compute units.

Schedulers integer

Scheduler compute units.

NetworkConfiguration object

Configures the network resources of the environment.

SubnetIds SubnetId[]

A list of subnets to use for the environment. These must be private subnets, in the same VPC, in two different availability zones.

minItems=2maxItems=2
SecurityGroupIds SecurityGroupId[]

A list of security groups to use for the environment.

minItems=1maxItems=5
LoggingConfiguration object

Logging configuration for the environment.

DagProcessingLogs object

Logging configuration for a specific airflow component.

3 nested properties
Enabled boolean
LogLevel string | Aws_CF_FunctionString
CloudWatchLogGroupArn string | Aws_CF_FunctionString
SchedulerLogs object

Logging configuration for a specific airflow component.

3 nested properties
Enabled boolean
LogLevel string | Aws_CF_FunctionString
CloudWatchLogGroupArn string | Aws_CF_FunctionString
WebserverLogs object

Logging configuration for a specific airflow component.

3 nested properties
Enabled boolean
LogLevel string | Aws_CF_FunctionString
CloudWatchLogGroupArn string | Aws_CF_FunctionString
WorkerLogs object

Logging configuration for a specific airflow component.

3 nested properties
Enabled boolean
LogLevel string | Aws_CF_FunctionString
CloudWatchLogGroupArn string | Aws_CF_FunctionString
TaskLogs object

Logging configuration for a specific airflow component.

3 nested properties
Enabled boolean
LogLevel string | Aws_CF_FunctionString
CloudWatchLogGroupArn string | Aws_CF_FunctionString
LoggingConfigurationInput object

Configures logging for the environment.

DagProcessingLogs object

Configures airflow component logging for the environment.

2 nested properties
Enabled boolean
LogLevel string | Aws_CF_FunctionString
SchedulerLogs object

Configures airflow component logging for the environment.

2 nested properties
Enabled boolean
LogLevel string | Aws_CF_FunctionString
WebserverLogs object

Configures airflow component logging for the environment.

2 nested properties
Enabled boolean
LogLevel string | Aws_CF_FunctionString
WorkerLogs object

Configures airflow component logging for the environment.

2 nested properties
Enabled boolean
LogLevel string | Aws_CF_FunctionString
TaskLogs object

Configures airflow component logging for the environment.

2 nested properties
Enabled boolean
LogLevel string | Aws_CF_FunctionString
ModuleLoggingConfiguration object

Logging configuration for a specific airflow component.

Enabled boolean
LogLevel string | Aws_CF_FunctionString
CloudWatchLogGroupArn string | Aws_CF_FunctionString
ModuleLoggingConfigurationInput object

Configures airflow component logging for the environment.

Enabled boolean
LogLevel string | Aws_CF_FunctionString
LastUpdate object

Details about the last update performed on the environment.

Status string | Aws_CF_FunctionString
CreatedAt string | Aws_CF_FunctionString

When the update request was created.

Error object

The error associated with an update request.

2 nested properties
ErrorCode string | Aws_CF_FunctionString

The error code associated with an error.

ErrorMessage string | Aws_CF_FunctionString

Error message describing a failed operation.

ErrorCode string | Aws_CF_FunctionString

The error code associated with an error.

ErrorMessage string | Aws_CF_FunctionString

Error message describing a failed operation.

S3ObjectVersion string | Aws_CF_FunctionString

Represents an version ID for an S3 object.

WeeklyMaintenanceWindowStart string | Aws_CF_FunctionString

Start time for the weekly maintenance window.

WebserverAccessMode string | Aws_CF_FunctionString

Choice for mode of webserver access including over public internet or via private VPC endpoint.