Skip to main content

environment_tags

Expands all tag keys and values for environments in a region

Overview

Nameenvironment_tags
TypeResource
DescriptionResource schema for AWS::MWAA::Environment
Idaws.mwaa.environment_tags

Fields

NameDatatypeDescription
namestringCustomer-defined identifier for the environment, unique per customer region.
arnstringARN for the MWAA environment.
webserver_urlstringUrl endpoint for the environment's Airflow UI.
execution_role_arnstringIAM role to be used by tasks.
kms_keystringThe 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.
airflow_versionstringVersion of airflow to deploy to the environment.
source_bucket_arnstringARN for the AWS S3 bucket to use as the source of DAGs and plugins for the environment.
dag_s3_pathstringRepresents an S3 prefix relative to the root of an S3 bucket.
plugins_s3_pathstringRepresents an S3 prefix relative to the root of an S3 bucket.
plugins_s3_object_versionstringRepresents an version ID for an S3 object.
requirements_s3_pathstringRepresents an S3 prefix relative to the root of an S3 bucket.
requirements_s3_object_versionstringRepresents an version ID for an S3 object.
startup_script_s3_pathstringRepresents an S3 prefix relative to the root of an S3 bucket.
startup_script_s3_object_versionstringRepresents an version ID for an S3 object.
airflow_configuration_optionsobjectKey/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"
environment_classstringTemplated configuration for airflow processes and backing infrastructure.
max_workersintegerMaximum worker compute units.
min_workersintegerMinimum worker compute units.
max_webserversintegerMaximum webserver compute units.
min_webserversintegerMinimum webserver compute units.
schedulersintegerScheduler compute units.
network_configurationobjectConfigures the network resources of the environment.
logging_configurationobjectLogging configuration for the environment.
weekly_maintenance_window_startstringStart time for the weekly maintenance window.
webserver_access_modestringChoice for mode of webserver access including over public internet or via private VPC endpoint.
endpoint_managementstringDefines whether the VPC endpoints configured for the environment are created, and managed, by the customer or by Amazon MWAA.
celery_executor_queuestringThe celery executor queue associated with the environment.
database_vpc_endpoint_servicestringThe database VPC endpoint service name.
webserver_vpc_endpoint_servicestringThe webserver VPC endpoint service name, applicable if private webserver access mode selected.
tag_keystringTag key.
tag_valuestringTag value.
regionstringAWS region.

Methods

NameAccessible byRequired Params
list_resourcesSELECTregion

SELECT examples

Expands tags for all environments in a region.

SELECT
region,
name,
arn,
webserver_url,
execution_role_arn,
kms_key,
airflow_version,
source_bucket_arn,
dag_s3_path,
plugins_s3_path,
plugins_s3_object_version,
requirements_s3_path,
requirements_s3_object_version,
startup_script_s3_path,
startup_script_s3_object_version,
airflow_configuration_options,
environment_class,
max_workers,
min_workers,
max_webservers,
min_webservers,
schedulers,
network_configuration,
logging_configuration,
weekly_maintenance_window_start,
webserver_access_mode,
endpoint_management,
celery_executor_queue,
database_vpc_endpoint_service,
webserver_vpc_endpoint_service,
tag_key,
tag_value
FROM aws.mwaa.environment_tags
WHERE region = 'us-east-1';

Permissions

For permissions required to operate on the environment_tags resource, see environments