EnvironmentArgs class
The set of arguments for Environment. The set of arguments for Environment.
Constructors
-
EnvironmentArgs({Input<
Map< ? airflowConfigurationOptions, Input<String, String> ?>String?> ? airflowVersion, required Input<String> dagS3Path, Input<String?> ? endpointManagement, Input<String?> ? environmentClass, required Input<String> executionRoleArn, Input<String?> ? kmsKey, Input<EnvironmentLoggingConfiguration?> ? loggingConfiguration, Input<int?> ? maxWebservers, Input<int?> ? maxWorkers, Input<int?> ? minWebservers, Input<int?> ? minWorkers, Input<String?> ? name, required Input<EnvironmentNetworkConfiguration> networkConfiguration, Input<String?> ? pluginsS3ObjectVersion, Input<String?> ? pluginsS3Path, Input<String?> ? region, Input<String?> ? requirementsS3ObjectVersion, Input<String?> ? requirementsS3Path, Input<int?> ? schedulers, required Input<String> sourceBucketArn, Input<String?> ? startupScriptS3ObjectVersion, Input<String?> ? startupScriptS3Path, Input<Map< ? tags, Input<String, String> ?>String?> ? webserverAccessMode, Input<String?> ? weeklyMaintenanceWindowStart, Input<String?> ? workerReplacementStrategy}) -
Creates a new EnvironmentArgs.
airflowConfigurationOptionsTheairflowConfigurationOptionsparameter specifies airflow override options. Check the Official documentation for all possible configuration options.airflowVersionAirflow version of your environment, will be set by default to the latest version that MWAA supports.dagS3PathThe relative path to the DAG folder on your Amazon S3 storage bucket. For example, dags. For more information, see Importing DAGs on Amazon MWAA.endpointManagementDefines whether the VPC endpoints configured for the environment are created and managed by the customer or by AWS. If set toSERVICE, Amazon MWAA will create and manage the required VPC endpoints in your VPC. If set toCUSTOMER, you must create, and manage, the VPC endpoints for your VPC. Defaults toSERVICEif not set.environmentClassEnvironment class for the cluster. Possible options aremw1.micro,mw1.small,mw1.medium,mw1.large. Will be set by default tomw1.small. Please check the AWS Pricing for more information about the environment classes.executionRoleArnARN of the task execution role that the Amazon MWAA and its environment can assume. Check the official AWS documentation for the detailed role specification.kmsKeyARN of your KMS key that you want to use for encryption. Will be set to the ARN of the managed KMS keyaws/airflowby default. Please check the Official Documentation for more information.loggingConfigurationThe Apache Airflow logs you want to send to Amazon CloudWatch Logs. SeeloggingConfigurationBlock for details.maxWebserversThe maximum number of web servers that you want to run in your environment. Value need to be between2and5ifenvironmentClassis notmw1.micro,1otherwise.maxWorkersThe maximum number of workers that can be automatically scaled up. Value need to be between1and25. Will be10by default.minWebserversThe minimum number of web servers that you want to run in your environment. Value need to be between2and5ifenvironmentClassis notmw1.micro,1otherwise.minWorkersThe minimum number of workers that you want to run in your environment. Will be1by default.nameThe name of the Apache Airflow EnvironmentnetworkConfigurationSpecifies the network configuration for your Apache Airflow Environment. This includes two private subnets as well as security groups for the Airflow environment. Each subnet requires internet connection, otherwise the deployment will fail. SeenetworkConfigurationBlock for details.pluginsS3ObjectVersionThe plugins.zip file version you want to use.pluginsS3PathThe relative path to the plugins.zip file on your Amazon S3 storage bucket. For example, plugins.zip. If a relative path is provided in the request, then pluginsS3ObjectVersion is required. For more information, see Importing DAGs on Amazon MWAA.regionRegion where this resource will be managed. Defaults to the Region set in the provider configuration.requirementsS3ObjectVersionThe requirements.txt file version you want to use.requirementsS3PathThe relative path to the requirements.txt file on your Amazon S3 storage bucket. For example, requirements.txt. If a relative path is provided in the request, then requirementsS3ObjectVersion is required. For more information, see Importing DAGs on Amazon MWAA.schedulersThe number of schedulers that you want to run in your environment. v2.0.2 and above accepts2-5, default2. v1.10.12 accepts1.sourceBucketArnARN of your Amazon S3 storage bucket. For example, arn:aws:s3:::airflow-mybucketname.startupScriptS3ObjectVersionThe version of the startup shell script you want to use. You must specify the version ID that Amazon S3 assigns to the file every time you update the script.startupScriptS3PathThe relative path to the script hosted in your bucket. The script runs as your environment starts before starting the Apache Airflow process. Use this script to install dependencies, modify configuration options, and set environment variables. See Using a startup script. Supported for environment versions 2.x and later.tagsA map of resource tags to associate with the resource. If configured with a providerdefaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.webserverAccessModeSpecifies whether the webserver should be accessible over the internet or via your specified VPC. Possible options:PRIVATE_ONLY(default),PUBLIC_ONLYandPUBLIC_AND_PRIVATE.weeklyMaintenanceWindowStartSpecifies the start date for the weekly maintenance window.workerReplacementStrategyWorker replacement strategy. Valid values:FORCED,GRACEFUL.const -
EnvironmentArgs.fromMap(Map<
String, dynamic> map) -
factory
Properties
-
airflowConfigurationOptions
→ Input<
Map< ?String, String> ?> -
The
airflowConfigurationOptionsparameter specifies airflow override options. Check the Official documentation for all possible configuration options.final -
airflowVersion
→ Input<
String?> ? -
Airflow version of your environment, will be set by default to the latest version that MWAA supports.
final
-
dagS3Path
→ Input<
String> -
The relative path to the DAG folder on your Amazon S3 storage bucket. For example, dags. For more information, see Importing DAGs on Amazon MWAA.
final
-
endpointManagement
→ Input<
String?> ? -
Defines whether the VPC endpoints configured for the environment are created and managed by the customer or by AWS. If set to
SERVICE, Amazon MWAA will create and manage the required VPC endpoints in your VPC. If set toCUSTOMER, you must create, and manage, the VPC endpoints for your VPC. Defaults toSERVICEif not set.final -
environmentClass
→ Input<
String?> ? -
Environment class for the cluster. Possible options are
mw1.micro,mw1.small,mw1.medium,mw1.large. Will be set by default tomw1.small. Please check the AWS Pricing for more information about the environment classes.final -
executionRoleArn
→ Input<
String> -
ARN of the task execution role that the Amazon MWAA and its environment can assume. Check the official AWS documentation for the detailed role specification.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
-
kmsKey
→ Input<
String?> ? -
ARN of your KMS key that you want to use for encryption. Will be set to the ARN of the managed KMS key
aws/airflowby default. Please check the Official Documentation for more information.final -
loggingConfiguration
→ Input<
EnvironmentLoggingConfiguration?> ? -
The Apache Airflow logs you want to send to Amazon CloudWatch Logs. See
loggingConfigurationBlock for details.final -
maxWebservers
→ Input<
int?> ? -
The maximum number of web servers that you want to run in your environment. Value need to be between
2and5ifenvironmentClassis notmw1.micro,1otherwise.final -
maxWorkers
→ Input<
int?> ? -
The maximum number of workers that can be automatically scaled up. Value need to be between
1and25. Will be10by default.final -
minWebservers
→ Input<
int?> ? -
The minimum number of web servers that you want to run in your environment. Value need to be between
2and5ifenvironmentClassis notmw1.micro,1otherwise.final -
minWorkers
→ Input<
int?> ? -
The minimum number of workers that you want to run in your environment. Will be
1by default.final -
name
→ Input<
String?> ? -
The name of the Apache Airflow Environment
final
-
networkConfiguration
→ Input<
EnvironmentNetworkConfiguration> -
Specifies the network configuration for your Apache Airflow Environment. This includes two private subnets as well as security groups for the Airflow environment. Each subnet requires internet connection, otherwise the deployment will fail. See
networkConfigurationBlock for details.final -
pluginsS3ObjectVersion
→ Input<
String?> ? -
The plugins.zip file version you want to use.
final
-
pluginsS3Path
→ Input<
String?> ? -
The relative path to the plugins.zip file on your Amazon S3 storage bucket. For example, plugins.zip. If a relative path is provided in the request, then pluginsS3ObjectVersion is required. For more information, see Importing DAGs on Amazon MWAA.
final
-
region
→ Input<
String?> ? -
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
final
-
requirementsS3ObjectVersion
→ Input<
String?> ? -
The requirements.txt file version you want to use.
final
-
requirementsS3Path
→ Input<
String?> ? -
The relative path to the requirements.txt file on your Amazon S3 storage bucket. For example, requirements.txt. If a relative path is provided in the request, then requirementsS3ObjectVersion is required. For more information, see Importing DAGs on Amazon MWAA.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
schedulers
→ Input<
int?> ? -
The number of schedulers that you want to run in your environment. v2.0.2 and above accepts
2-5, default2. v1.10.12 accepts1.final -
sourceBucketArn
→ Input<
String> -
ARN of your Amazon S3 storage bucket. For example, arn:aws:s3:::airflow-mybucketname.
final
-
startupScriptS3ObjectVersion
→ Input<
String?> ? -
The version of the startup shell script you want to use. You must specify the version ID that Amazon S3 assigns to the file every time you update the script.
final
-
startupScriptS3Path
→ Input<
String?> ? -
The relative path to the script hosted in your bucket. The script runs as your environment starts before starting the Apache Airflow process. Use this script to install dependencies, modify configuration options, and set environment variables. See Using a startup script. Supported for environment versions 2.x and later.
final
-
A map of resource tags to associate with the resource. If configured with a provider
defaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.final -
webserverAccessMode
→ Input<
String?> ? -
Specifies whether the webserver should be accessible over the internet or via your specified VPC. Possible options:
PRIVATE_ONLY(default),PUBLIC_ONLYandPUBLIC_AND_PRIVATE.final -
weeklyMaintenanceWindowStart
→ Input<
String?> ? -
Specifies the start date for the weekly maintenance window.
final
-
workerReplacementStrategy
→ Input<
String?> ? -
Worker replacement strategy. Valid values:
FORCED,GRACEFUL.final
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toMap(
) → Map< String, dynamic> -
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited