AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Calls the AmazonMWAA CreateEnvironment API operation.

Syntax

New-MWAAEnvironment
-AirflowConfigurationOption <Hashtable>
-AirflowVersion <String>
-DagS3Path <String>
-DagProcessingLogs_Enabled <Boolean>
-SchedulerLogs_Enabled <Boolean>
-TaskLogs_Enabled <Boolean>
-WebserverLogs_Enabled <Boolean>
-WorkerLogs_Enabled <Boolean>
-EndpointManagement <EndpointManagement>
-EnvironmentClass <String>
-ExecutionRoleArn <String>
-KmsKey <String>
-DagProcessingLogs_LogLevel <LoggingLevel>
-SchedulerLogs_LogLevel <LoggingLevel>
-TaskLogs_LogLevel <LoggingLevel>
-WebserverLogs_LogLevel <LoggingLevel>
-WorkerLogs_LogLevel <LoggingLevel>
-MaxWebserver <Int32>
-MaxWorker <Int32>
-MinWebserver <Int32>
-MinWorker <Int32>
-Name <String>
-PluginsS3ObjectVersion <String>
-PluginsS3Path <String>
-RequirementsS3ObjectVersion <String>
-RequirementsS3Path <String>
-Scheduler <Int32>
-NetworkConfiguration_SecurityGroupId <String[]>
-SourceBucketArn <String>
-StartupScriptS3ObjectVersion <String>
-StartupScriptS3Path <String>
-NetworkConfiguration_SubnetId <String[]>
-Tag <Hashtable>
-WebserverAccessMode <WebserverAccessMode>
-WeeklyMaintenanceWindowStart <String>
-Select <String>
-Force <SwitchParameter>
-ClientConfig <AmazonMWAAConfig>

Description

Creates an Amazon Managed Workflows for Apache Airflow (Amazon MWAA) environment.

Parameters

-AirflowConfigurationOption <Hashtable>
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. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAirflowConfigurationOptions
-AirflowVersion <String>
The Apache Airflow version for your environment. If no value is specified, it defaults to the latest version. For more information, see Apache Airflow versions on Amazon Managed Workflows for Apache Airflow (Amazon MWAA).Valid 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, 2.10.1, and 2.10.3.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClientConfig <AmazonMWAAConfig>
Amazon.PowerShell.Cmdlets.MWAA.AmazonMWAAClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DagProcessingLogs_Enabled <Boolean>
Indicates whether to enable the Apache Airflow log type (e.g. DagProcessingLogs).
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesLoggingConfiguration_DagProcessingLogs_Enabled
-DagProcessingLogs_LogLevel <LoggingLevel>
Defines the Apache Airflow log level (e.g. INFO) to send to CloudWatch Logs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesLoggingConfiguration_DagProcessingLogs_LogLevel
-DagS3Path <String>
The relative path to the DAGs folder on your Amazon S3 bucket. For example, dags. For more information, see Adding or updating DAGs.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-EndpointManagement <EndpointManagement>
Defines whether the VPC endpoints configured for the environment are created, and managed, by the customer or by Amazon MWAA. If set to SERVICE, Amazon MWAA will create and manage the required VPC endpoints in your VPC. If set to CUSTOMER, you must create, and manage, the VPC endpoints for your VPC. If you choose to create an environment in a shared VPC, you must set this value to CUSTOMER. In a shared VPC deployment, the environment will remain in PENDING status until you create the VPC endpoints. If you do not take action to create the endpoints within 72 hours, the status will change to CREATE_FAILED. You can delete the failed environment and create a new one.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-EnvironmentClass <String>
The environment class type. Valid values: mw1.micro, mw1.small, mw1.medium, mw1.large, mw1.xlarge, and mw1.2xlarge. For more information, see Amazon MWAA environment class.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ExecutionRoleArn <String>
The Amazon Resource Name (ARN) of the execution role for your environment. An execution role is an Amazon Web Services Identity and Access Management (IAM) role that grants MWAA permission to access Amazon Web Services services and resources used by your environment. For example, arn:aws:iam::123456789:role/my-execution-role. For more information, see Amazon MWAA Execution role.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-Force <SwitchParameter>
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-KmsKey <String>
The Amazon Web Services Key Management Service (KMS) key to encrypt the data in your environment. You can use an Amazon Web Services owned CMK, or a Customer managed CMK (advanced). For more information, see Create an Amazon MWAA environment.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-MaxWebserver <Int32>
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: For environments larger than mw1.micro, accepts values from 2 to 5. Defaults to 2 for all environment sizes except mw1.micro, which defaults to 1.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesMaxWebservers
-MaxWorker <Int32>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesMaxWorkers
-MinWebserver <Int32>
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: For environments larger than mw1.micro, accepts values from 2 to 5. Defaults to 2 for all environment sizes except mw1.micro, which defaults to 1.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesMinWebservers
-MinWorker <Int32>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesMinWorkers
-Name <String>
The name of the Amazon MWAA environment. For example, MyMWAAEnvironment.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkConfiguration_SecurityGroupId <String[]>
A list of security group IDs. For more information, see Security in your VPC on Amazon MWAA. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesNetworkConfiguration_SecurityGroupIds
-NetworkConfiguration_SubnetId <String[]>
A list of subnet IDs. For more information, see About networking on Amazon MWAA. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesNetworkConfiguration_SubnetIds
-PluginsS3ObjectVersion <String>
The version of the plugins.zip file on your Amazon S3 bucket. You must specify a version each time a plugins.zip file is updated. For more information, see How S3 Versioning works.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PluginsS3Path <String>
The relative path to the plugins.zip file on your Amazon S3 bucket. For example, plugins.zip. If specified, then the plugins.zip version is required. For more information, see Installing custom plugins.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-RequirementsS3ObjectVersion <String>
The version of the requirements.txt file on your Amazon S3 bucket. You must specify a version each time a requirements.txt file is updated. For more information, see How S3 Versioning works.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-RequirementsS3Path <String>
The relative path to the requirements.txt file on your Amazon S3 bucket. For example, requirements.txt. If specified, then a version is required. For more information, see Installing Python dependencies.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Scheduler <Int32>
The number of Apache Airflow schedulers to run in your environment. Valid values:
  • v2 - For environments larger than mw1.micro, accepts values from 2 to 5. Defaults to 2 for all environment sizes except mw1.micro, which defaults to 1.
  • v1 - Accepts 1.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSchedulers
-SchedulerLogs_Enabled <Boolean>
Indicates whether to enable the Apache Airflow log type (e.g. DagProcessingLogs).
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesLoggingConfiguration_SchedulerLogs_Enabled
-SchedulerLogs_LogLevel <LoggingLevel>
Defines the Apache Airflow log level (e.g. INFO) to send to CloudWatch Logs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesLoggingConfiguration_SchedulerLogs_LogLevel
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is 'Arn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.MWAA.Model.CreateEnvironmentResponse). Specifying the name of a property of type Amazon.MWAA.Model.CreateEnvironmentResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SourceBucketArn <String>
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. For more information, see Create an Amazon S3 bucket for Amazon MWAA.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-StartupScriptS3ObjectVersion <String>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-StartupScriptS3Path <String>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Tag <Hashtable>
The key-value tag pairs you want to associate to your environment. For example, "Environment": "Staging". For more information, see Tagging Amazon Web Services resources. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTags
-TaskLogs_Enabled <Boolean>
Indicates whether to enable the Apache Airflow log type (e.g. DagProcessingLogs).
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesLoggingConfiguration_TaskLogs_Enabled
-TaskLogs_LogLevel <LoggingLevel>
Defines the Apache Airflow log level (e.g. INFO) to send to CloudWatch Logs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesLoggingConfiguration_TaskLogs_LogLevel
-WebserverAccessMode <WebserverAccessMode>
Defines the access mode for the Apache Airflow web server. For more information, see Apache Airflow access modes.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-WebserverLogs_Enabled <Boolean>
Indicates whether to enable the Apache Airflow log type (e.g. DagProcessingLogs).
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesLoggingConfiguration_WebserverLogs_Enabled
-WebserverLogs_LogLevel <LoggingLevel>
Defines the Apache Airflow log level (e.g. INFO) to send to CloudWatch Logs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesLoggingConfiguration_WebserverLogs_LogLevel
-WeeklyMaintenanceWindowStart <String>
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: DAY:HH:MM. For example: TUE:03:30. You can specify a start time in 30 minute increments only.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-WorkerLogs_Enabled <Boolean>
Indicates whether to enable the Apache Airflow log type (e.g. DagProcessingLogs).
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesLoggingConfiguration_WorkerLogs_Enabled
-WorkerLogs_LogLevel <LoggingLevel>
Defines the Apache Airflow log level (e.g. INFO) to send to CloudWatch Logs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesLoggingConfiguration_WorkerLogs_LogLevel

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAK
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-EndpointUrl <String>
The endpoint to make the call against.Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-ProfileLocation <String>
Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials.If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAWSProfilesLocation, ProfilesLocation
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStoredCredentials, AWSProfileName
-Region <Object>
The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRegionToCall
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSK, SecretAccessKey
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesST

Outputs

System.String or Amazon.MWAA.Model.CreateEnvironmentResponse
This cmdlet returns a System.String object. The service call response (type Amazon.MWAA.Model.CreateEnvironmentResponse) can be returned by specifying '-Select *'.
AWS Tools for PowerShell User Guide

Supported Version

AWS Tools for PowerShell: 2.x.y.z