- Navigation Guide
@aws-sdk/client-mwaa
UpdateEnvironmentCommandInput Interface
Members
Name | Type | Details |
---|---|---|
Name Required | string | undefined | The name of your Amazon MWAA environment. For example, |
AirflowConfigurationOptions | Record<string, string> | undefined | A list of key-value pairs containing the Apache Airflow configuration options you want to attach to your environment. For more information, see Apache Airflow configuration options . |
AirflowVersion | string | undefined | The Apache Airflow version for your environment. To upgrade your environment, specify a newer version of Apache Airflow supported by Amazon MWAA. Before you upgrade an environment, make sure your requirements, DAGs, plugins, and other resources used in your workflows are compatible with the new Apache Airflow version. For more information about updating your resources, see Upgrading an Amazon MWAA environment . Valid values: |
DagS3Path | string | undefined | The relative path to the DAGs folder on your Amazon S3 bucket. For example, |
EnvironmentClass | string | undefined | The environment class type. Valid values: |
ExecutionRoleArn | string | undefined | 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, |
LoggingConfiguration | LoggingConfigurationInput | undefined | The Apache Airflow log types to send to CloudWatch Logs. |
MaxWebservers | number | undefined | 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 Valid values: For environments larger than mw1.micro, accepts values from |
MaxWorkers | number | undefined | 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 |
MinWebservers | number | undefined | 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 Valid values: For environments larger than mw1.micro, accepts values from |
MinWorkers | number | undefined | 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 |
NetworkConfiguration | UpdateNetworkConfigurationInput | undefined | 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 . |
PluginsS3ObjectVersion | string | undefined | The version of the plugins.zip file on your Amazon S3 bucket. You must specify a version each time a |
PluginsS3Path | string | undefined | The relative path to the |
RequirementsS3ObjectVersion | string | undefined | The version of the requirements.txt file on your Amazon S3 bucket. You must specify a version each time a |
RequirementsS3Path | string | undefined | The relative path to the |
Schedulers | number | undefined | The number of Apache Airflow schedulers to run in your Amazon MWAA environment. |
SourceBucketArn | string | undefined | The Amazon Resource Name (ARN) of the Amazon S3 bucket where your DAG code and supporting files are stored. For example, |
StartupScriptS3ObjectVersion | string | undefined | 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: For more information, see Using a startup script . |
StartupScriptS3Path | string | undefined | The relative path to the startup shell script in your Amazon S3 bucket. For example, 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 . |
WebserverAccessMode | WebserverAccessMode | undefined | The Apache Airflow Web server access mode. For more information, see Apache Airflow access modes . |
WeeklyMaintenanceWindowStart | string | undefined | The day and time of the week in Coordinated Universal Time (UTC) 24-hour standard time to start weekly maintenance updates of your environment in the following format: |
Full Signature
export interface UpdateEnvironmentCommandInput extends UpdateEnvironmentInput