AWS.Tools.MWAA.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.MWAA</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.MWAA.AddMWAAResourceTagCmdlet"> <summary> Associates key-value tag pairs to your Amazon Managed Workflows for Apache Airflow (MWAA) environment. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MWAA.AddMWAAResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the Amazon MWAA environment. For example, <c>arn:aws:airflow:us-east-1:123456789012:environment/MyMWAAEnvironment</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MWAA.AddMWAAResourceTagCmdlet.Tag"> <summary> <para> <para>The key-value tag pairs you want to associate to your environment. For example, <c>"Environment": "Staging"</c>. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services resources</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MWAA.AddMWAAResourceTagCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.MWAA.Model.TagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MWAA.AddMWAAResourceTagCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceArn parameter. The -PassThru parameter is deprecated, use -Select '^ResourceArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MWAA.AddMWAAResourceTagCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.MWAA.GetMWAAEnvironmentCmdlet"> <summary> Describes an Amazon Managed Workflows for Apache Airflow (MWAA) environment. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MWAA.GetMWAAEnvironmentCmdlet.Name"> <summary> <para> <para>The name of the Amazon MWAA environment. For example, <c>MyMWAAEnvironment</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MWAA.GetMWAAEnvironmentCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Environment'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.MWAA.Model.GetEnvironmentResponse). Specifying the name of a property of type Amazon.MWAA.Model.GetEnvironmentResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MWAA.GetMWAAEnvironmentCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Name parameter. The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.MWAA.GetMWAAEnvironmentListCmdlet"> <summary> Lists the Amazon Managed Workflows for Apache Airflow (MWAA) environments.<br/><br/>This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MWAA.GetMWAAEnvironmentListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to retrieve per page. For example, <c>5</c> environments per page.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MWAA.GetMWAAEnvironmentListCmdlet.NextToken"> <summary> <para> <para>Retrieves the next page of the results.</para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MWAA.GetMWAAEnvironmentListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Environments'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.MWAA.Model.ListEnvironmentsResponse). Specifying the name of a property of type Amazon.MWAA.Model.ListEnvironmentsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MWAA.GetMWAAEnvironmentListCmdlet.NoAutoIteration"> <summary> By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.MWAA.GetMWAAResourceTagCmdlet"> <summary> Lists the key-value tag pairs associated to the Amazon Managed Workflows for Apache Airflow (MWAA) environment. For example, <c>"Environment": "Staging"</c>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MWAA.GetMWAAResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the Amazon MWAA environment. For example, <c>arn:aws:airflow:us-east-1:123456789012:environment/MyMWAAEnvironment</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MWAA.GetMWAAResourceTagCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Tags'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.MWAA.Model.ListTagsForResourceResponse). Specifying the name of a property of type Amazon.MWAA.Model.ListTagsForResourceResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MWAA.GetMWAAResourceTagCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceArn parameter. The -PassThru parameter is deprecated, use -Select '^ResourceArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.MWAA.NewMWAACliTokenCmdlet"> <summary> Creates a CLI token for the Airflow CLI. To learn more, see <a href="https://docs.aws.amazon.com/mwaa/latest/userguide/call-mwaa-apis-cli.html">Creating an Apache Airflow CLI token</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MWAA.NewMWAACliTokenCmdlet.Name"> <summary> <para> <para>The name of the Amazon MWAA environment. For example, <c>MyMWAAEnvironment</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MWAA.NewMWAACliTokenCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.MWAA.Model.CreateCliTokenResponse). Specifying the name of a property of type Amazon.MWAA.Model.CreateCliTokenResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MWAA.NewMWAACliTokenCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Name parameter. The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MWAA.NewMWAACliTokenCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.MWAA.NewMWAAEnvironmentCmdlet"> <summary> Creates an Amazon Managed Workflows for Apache Airflow (MWAA) environment. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MWAA.NewMWAAEnvironmentCmdlet.AirflowConfigurationOption"> <summary> <para> <para>A list of key-value pairs containing the Apache Airflow configuration options you want to attach to your environment. For more information, see <a href="https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-env-variables.html">Apache Airflow configuration options</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MWAA.NewMWAAEnvironmentCmdlet.AirflowVersion"> <summary> <para> <para>The Apache Airflow version for your environment. If no value is specified, it defaults to the latest version. For more information, see <a href="https://docs.aws.amazon.com/mwaa/latest/userguide/airflow-versions.html">Apache Airflow versions on Amazon Managed Workflows for Apache Airflow (MWAA)</a>.</para><para>Valid values: <c>1.10.12</c>, <c>2.0.2</c>, <c>2.2.2</c>, <c>2.4.3</c>, <c>2.5.1</c>, <c>2.6.3</c>, <c>2.7.2</c><c>2.8.1</c></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MWAA.NewMWAAEnvironmentCmdlet.DagS3Path"> <summary> <para> <para>The relative path to the DAGs folder on your Amazon S3 bucket. For example, <c>dags</c>. For more information, see <a href="https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-dag-folder.html">Adding or updating DAGs</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MWAA.NewMWAAEnvironmentCmdlet.DagProcessingLogs_Enabled"> <summary> <para> <para>Indicates whether to enable the Apache Airflow log type (e.g. <c>DagProcessingLogs</c>).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MWAA.NewMWAAEnvironmentCmdlet.SchedulerLogs_Enabled"> <summary> <para> <para>Indicates whether to enable the Apache Airflow log type (e.g. <c>DagProcessingLogs</c>).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MWAA.NewMWAAEnvironmentCmdlet.TaskLogs_Enabled"> <summary> <para> <para>Indicates whether to enable the Apache Airflow log type (e.g. <c>DagProcessingLogs</c>).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MWAA.NewMWAAEnvironmentCmdlet.WebserverLogs_Enabled"> <summary> <para> <para>Indicates whether to enable the Apache Airflow log type (e.g. <c>DagProcessingLogs</c>).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MWAA.NewMWAAEnvironmentCmdlet.WorkerLogs_Enabled"> <summary> <para> <para>Indicates whether to enable the Apache Airflow log type (e.g. <c>DagProcessingLogs</c>).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MWAA.NewMWAAEnvironmentCmdlet.EndpointManagement"> <summary> <para> <para>Defines whether the VPC endpoints configured for the environment are created, and managed, by the customer or by Amazon MWAA. If set to <c>SERVICE</c>, Amazon MWAA will create and manage the required VPC endpoints in your VPC. If set to <c>CUSTOMER</c>, 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 <c>CUSTOMER</c>. In a shared VPC deployment, the environment will remain in <c>PENDING</c> 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 <c>CREATE_FAILED</c>. You can delete the failed environment and create a new one.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MWAA.NewMWAAEnvironmentCmdlet.EnvironmentClass"> <summary> <para> <para>The environment class type. Valid values: <c>mw1.small</c>, <c>mw1.medium</c>, <c>mw1.large</c>. For more information, see <a href="https://docs.aws.amazon.com/mwaa/latest/userguide/environment-class.html">Amazon MWAA environment class</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MWAA.NewMWAAEnvironmentCmdlet.ExecutionRoleArn"> <summary> <para> <para>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, <c>arn:aws:iam::123456789:role/my-execution-role</c>. For more information, see <a href="https://docs.aws.amazon.com/mwaa/latest/userguide/mwaa-create-role.html">Amazon MWAA Execution role</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MWAA.NewMWAAEnvironmentCmdlet.KmsKey"> <summary> <para> <para>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 <a href="https://docs.aws.amazon.com/mwaa/latest/userguide/create-environment.html">Create an Amazon MWAA environment</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MWAA.NewMWAAEnvironmentCmdlet.DagProcessingLogs_LogLevel"> <summary> <para> <para>Defines the Apache Airflow log level (e.g. <c>INFO</c>) to send to CloudWatch Logs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MWAA.NewMWAAEnvironmentCmdlet.SchedulerLogs_LogLevel"> <summary> <para> <para>Defines the Apache Airflow log level (e.g. <c>INFO</c>) to send to CloudWatch Logs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MWAA.NewMWAAEnvironmentCmdlet.TaskLogs_LogLevel"> <summary> <para> <para>Defines the Apache Airflow log level (e.g. <c>INFO</c>) to send to CloudWatch Logs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MWAA.NewMWAAEnvironmentCmdlet.WebserverLogs_LogLevel"> <summary> <para> <para>Defines the Apache Airflow log level (e.g. <c>INFO</c>) to send to CloudWatch Logs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MWAA.NewMWAAEnvironmentCmdlet.WorkerLogs_LogLevel"> <summary> <para> <para>Defines the Apache Airflow log level (e.g. <c>INFO</c>) to send to CloudWatch Logs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MWAA.NewMWAAEnvironmentCmdlet.MaxWorker"> <summary> <para> <para>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 <c>MaxWorkers</c> field. For example, <c>20</c>. 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 <c>MinWorkers</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MWAA.NewMWAAEnvironmentCmdlet.MinWorker"> <summary> <para> <para>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 <c>MaxWorkers</c> 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 <c>MinWorkers</c> field. For example, <c>2</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MWAA.NewMWAAEnvironmentCmdlet.Name"> <summary> <para> <para>The name of the Amazon MWAA environment. For example, <c>MyMWAAEnvironment</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MWAA.NewMWAAEnvironmentCmdlet.PluginsS3ObjectVersion"> <summary> <para> <para>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 <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/versioning-workflows.html">How S3 Versioning works</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MWAA.NewMWAAEnvironmentCmdlet.PluginsS3Path"> <summary> <para> <para>The relative path to the <c>plugins.zip</c> file on your Amazon S3 bucket. For example, <c>plugins.zip</c>. If specified, then the <c>plugins.zip</c> version is required. For more information, see <a href="https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-dag-import-plugins.html">Installing custom plugins</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MWAA.NewMWAAEnvironmentCmdlet.RequirementsS3ObjectVersion"> <summary> <para> <para>The version of the <c>requirements.txt</c> file on your Amazon S3 bucket. You must specify a version each time a requirements.txt file is updated. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/versioning-workflows.html">How S3 Versioning works</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MWAA.NewMWAAEnvironmentCmdlet.RequirementsS3Path"> <summary> <para> <para>The relative path to the <c>requirements.txt</c> file on your Amazon S3 bucket. For example, <c>requirements.txt</c>. If specified, then a version is required. For more information, see <a href="https://docs.aws.amazon.com/mwaa/latest/userguide/working-dags-dependencies.html">Installing Python dependencies</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MWAA.NewMWAAEnvironmentCmdlet.Scheduler"> <summary> <para> <para>The number of Apache Airflow schedulers to run in your environment. Valid values:</para><ul><li><para>v2 - Accepts between 2 to 5. Defaults to 2.</para></li><li><para>v1 - Accepts 1.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MWAA.NewMWAAEnvironmentCmdlet.NetworkConfiguration_SecurityGroupId"> <summary> <para> <para>A list of security group IDs. For more information, see <a href="https://docs.aws.amazon.com/mwaa/latest/userguide/vpc-security.html">Security in your VPC on Amazon MWAA</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MWAA.NewMWAAEnvironmentCmdlet.SourceBucketArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the Amazon S3 bucket where your DAG code and supporting files are stored. For example, <c>arn:aws:s3:::my-airflow-bucket-unique-name</c>. For more information, see <a href="https://docs.aws.amazon.com/mwaa/latest/userguide/mwaa-s3-bucket.html">Create an Amazon S3 bucket for Amazon MWAA</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MWAA.NewMWAAEnvironmentCmdlet.StartupScriptS3ObjectVersion"> <summary> <para> <para>The version of the startup shell script in your Amazon S3 bucket. You must specify the <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/versioning-workflows.html">version ID</a> that Amazon S3 assigns to the file every time you update the script. </para><para> 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: </para><para><c>3sL4kqtJlcpXroDTDmJ+rmSpXd3dIbrHY+MTRCxf3vjVBH40Nr8X8gdRQBpUMLUo</c></para><para> For more information, see <a href="https://docs.aws.amazon.com/mwaa/latest/userguide/using-startup-script.html">Using a startup script</a>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MWAA.NewMWAAEnvironmentCmdlet.StartupScriptS3Path"> <summary> <para> <para>The relative path to the startup shell script in your Amazon S3 bucket. For example, <c>s3://mwaa-environment/startup.sh</c>.</para><para> 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 <a href="https://docs.aws.amazon.com/mwaa/latest/userguide/using-startup-script.html">Using a startup script</a>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MWAA.NewMWAAEnvironmentCmdlet.NetworkConfiguration_SubnetId"> <summary> <para> <para>A list of subnet IDs. For more information, see <a href="https://docs.aws.amazon.com/mwaa/latest/userguide/networking-about.html">About networking on Amazon MWAA</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MWAA.NewMWAAEnvironmentCmdlet.Tag"> <summary> <para> <para>The key-value tag pairs you want to associate to your environment. For example, <c>"Environment": "Staging"</c>. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services resources</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MWAA.NewMWAAEnvironmentCmdlet.WebserverAccessMode"> <summary> <para> <para>Defines the access mode for the Apache Airflow <i>web server</i>. For more information, see <a href="https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-networking.html">Apache Airflow access modes</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MWAA.NewMWAAEnvironmentCmdlet.WeeklyMaintenanceWindowStart"> <summary> <para> <para>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: <c>DAY:HH:MM</c>. For example: <c>TUE:03:30</c>. You can specify a start time in 30 minute increments only.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MWAA.NewMWAAEnvironmentCmdlet.Select"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MWAA.NewMWAAEnvironmentCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.MWAA.NewMWAAWebLoginTokenCmdlet"> <summary> Creates a web login token for the Airflow Web UI. To learn more, see <a href="https://docs.aws.amazon.com/mwaa/latest/userguide/call-mwaa-apis-web.html">Creating an Apache Airflow web login token</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MWAA.NewMWAAWebLoginTokenCmdlet.Name"> <summary> <para> <para>The name of the Amazon MWAA environment. For example, <c>MyMWAAEnvironment</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MWAA.NewMWAAWebLoginTokenCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.MWAA.Model.CreateWebLoginTokenResponse). Specifying the name of a property of type Amazon.MWAA.Model.CreateWebLoginTokenResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MWAA.NewMWAAWebLoginTokenCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Name parameter. The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MWAA.NewMWAAWebLoginTokenCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.MWAA.PublishMWAAMetricCmdlet"> <summary> <b>Internal only</b>. Publishes environment health metrics to Amazon CloudWatch.<br/><br/>This operation is deprecated. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MWAA.PublishMWAAMetricCmdlet.EnvironmentName"> <summary> <para> <para><b>Internal only</b>. The name of the environment.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MWAA.PublishMWAAMetricCmdlet.MetricData"> <summary> <para> <para><b>Internal only</b>. Publishes metrics to Amazon CloudWatch. To learn more about the metrics published to Amazon CloudWatch, see <a href="https://docs.aws.amazon.com/mwaa/latest/userguide/cw-metrics.html">Amazon MWAA performance metrics in Amazon CloudWatch</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MWAA.PublishMWAAMetricCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.MWAA.Model.PublishMetricsResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MWAA.PublishMWAAMetricCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the EnvironmentName parameter. The -PassThru parameter is deprecated, use -Select '^EnvironmentName' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MWAA.PublishMWAAMetricCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.MWAA.RemoveMWAAEnvironmentCmdlet"> <summary> Deletes an Amazon Managed Workflows for Apache Airflow (MWAA) environment. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MWAA.RemoveMWAAEnvironmentCmdlet.Name"> <summary> <para> <para>The name of the Amazon MWAA environment. For example, <c>MyMWAAEnvironment</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MWAA.RemoveMWAAEnvironmentCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.MWAA.Model.DeleteEnvironmentResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MWAA.RemoveMWAAEnvironmentCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Name parameter. The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MWAA.RemoveMWAAEnvironmentCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.MWAA.RemoveMWAAResourceTagCmdlet"> <summary> Removes key-value tag pairs associated to your Amazon Managed Workflows for Apache Airflow (MWAA) environment. For example, <c>"Environment": "Staging"</c>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MWAA.RemoveMWAAResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the Amazon MWAA environment. For example, <c>arn:aws:airflow:us-east-1:123456789012:environment/MyMWAAEnvironment</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MWAA.RemoveMWAAResourceTagCmdlet.TagKey"> <summary> <para> <para>The key-value tag pair you want to remove. For example, <c>"Environment": "Staging"</c>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MWAA.RemoveMWAAResourceTagCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.MWAA.Model.UntagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MWAA.RemoveMWAAResourceTagCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceArn parameter. The -PassThru parameter is deprecated, use -Select '^ResourceArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MWAA.RemoveMWAAResourceTagCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.MWAA.UpdateMWAAEnvironmentCmdlet"> <summary> Updates an Amazon Managed Workflows for Apache Airflow (MWAA) environment. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MWAA.UpdateMWAAEnvironmentCmdlet.AirflowConfigurationOption"> <summary> <para> <para>A list of key-value pairs containing the Apache Airflow configuration options you want to attach to your environment. For more information, see <a href="https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-env-variables.html">Apache Airflow configuration options</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MWAA.UpdateMWAAEnvironmentCmdlet.AirflowVersion"> <summary> <para> <para>The Apache Airflow version for your environment. To upgrade your environment, specify a newer version of Apache Airflow supported by Amazon MWAA.</para><para>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 <a href="https://docs.aws.amazon.com/mwaa/latest/userguide/upgrading-environment.html">Upgrading an Amazon MWAA environment</a>.</para><para>Valid values: <c>1.10.12</c>, <c>2.0.2</c>, <c>2.2.2</c>, <c>2.4.3</c>, <c>2.5.1</c>, <c>2.6.3</c>, <c>2.7.2</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MWAA.UpdateMWAAEnvironmentCmdlet.DagS3Path"> <summary> <para> <para>The relative path to the DAGs folder on your Amazon S3 bucket. For example, <c>dags</c>. For more information, see <a href="https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-dag-folder.html">Adding or updating DAGs</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MWAA.UpdateMWAAEnvironmentCmdlet.DagProcessingLogs_Enabled"> <summary> <para> <para>Indicates whether to enable the Apache Airflow log type (e.g. <c>DagProcessingLogs</c>).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MWAA.UpdateMWAAEnvironmentCmdlet.SchedulerLogs_Enabled"> <summary> <para> <para>Indicates whether to enable the Apache Airflow log type (e.g. <c>DagProcessingLogs</c>).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MWAA.UpdateMWAAEnvironmentCmdlet.TaskLogs_Enabled"> <summary> <para> <para>Indicates whether to enable the Apache Airflow log type (e.g. <c>DagProcessingLogs</c>).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MWAA.UpdateMWAAEnvironmentCmdlet.WebserverLogs_Enabled"> <summary> <para> <para>Indicates whether to enable the Apache Airflow log type (e.g. <c>DagProcessingLogs</c>).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MWAA.UpdateMWAAEnvironmentCmdlet.WorkerLogs_Enabled"> <summary> <para> <para>Indicates whether to enable the Apache Airflow log type (e.g. <c>DagProcessingLogs</c>).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MWAA.UpdateMWAAEnvironmentCmdlet.EnvironmentClass"> <summary> <para> <para>The environment class type. Valid values: <c>mw1.small</c>, <c>mw1.medium</c>, <c>mw1.large</c>. For more information, see <a href="https://docs.aws.amazon.com/mwaa/latest/userguide/environment-class.html">Amazon MWAA environment class</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MWAA.UpdateMWAAEnvironmentCmdlet.ExecutionRoleArn"> <summary> <para> <para>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, <c>arn:aws:iam::123456789:role/my-execution-role</c>. For more information, see <a href="https://docs.aws.amazon.com/mwaa/latest/userguide/mwaa-create-role.html">Amazon MWAA Execution role</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MWAA.UpdateMWAAEnvironmentCmdlet.DagProcessingLogs_LogLevel"> <summary> <para> <para>Defines the Apache Airflow log level (e.g. <c>INFO</c>) to send to CloudWatch Logs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MWAA.UpdateMWAAEnvironmentCmdlet.SchedulerLogs_LogLevel"> <summary> <para> <para>Defines the Apache Airflow log level (e.g. <c>INFO</c>) to send to CloudWatch Logs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MWAA.UpdateMWAAEnvironmentCmdlet.TaskLogs_LogLevel"> <summary> <para> <para>Defines the Apache Airflow log level (e.g. <c>INFO</c>) to send to CloudWatch Logs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MWAA.UpdateMWAAEnvironmentCmdlet.WebserverLogs_LogLevel"> <summary> <para> <para>Defines the Apache Airflow log level (e.g. <c>INFO</c>) to send to CloudWatch Logs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MWAA.UpdateMWAAEnvironmentCmdlet.WorkerLogs_LogLevel"> <summary> <para> <para>Defines the Apache Airflow log level (e.g. <c>INFO</c>) to send to CloudWatch Logs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MWAA.UpdateMWAAEnvironmentCmdlet.MaxWorker"> <summary> <para> <para>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 <c>MaxWorkers</c> field. For example, <c>20</c>. 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 <c>MinWorkers</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MWAA.UpdateMWAAEnvironmentCmdlet.MinWorker"> <summary> <para> <para>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 <c>MaxWorkers</c> 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 <c>MinWorkers</c> field. For example, <c>2</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MWAA.UpdateMWAAEnvironmentCmdlet.Name"> <summary> <para> <para>The name of your Amazon MWAA environment. For example, <c>MyMWAAEnvironment</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MWAA.UpdateMWAAEnvironmentCmdlet.PluginsS3ObjectVersion"> <summary> <para> <para>The version of the plugins.zip file on your Amazon S3 bucket. You must specify a version each time a <c>plugins.zip</c> file is updated. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/versioning-workflows.html">How S3 Versioning works</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MWAA.UpdateMWAAEnvironmentCmdlet.PluginsS3Path"> <summary> <para> <para>The relative path to the <c>plugins.zip</c> file on your Amazon S3 bucket. For example, <c>plugins.zip</c>. If specified, then the plugins.zip version is required. For more information, see <a href="https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-dag-import-plugins.html">Installing custom plugins</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MWAA.UpdateMWAAEnvironmentCmdlet.RequirementsS3ObjectVersion"> <summary> <para> <para>The version of the requirements.txt file on your Amazon S3 bucket. You must specify a version each time a <c>requirements.txt</c> file is updated. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/versioning-workflows.html">How S3 Versioning works</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MWAA.UpdateMWAAEnvironmentCmdlet.RequirementsS3Path"> <summary> <para> <para>The relative path to the <c>requirements.txt</c> file on your Amazon S3 bucket. For example, <c>requirements.txt</c>. If specified, then a file version is required. For more information, see <a href="https://docs.aws.amazon.com/mwaa/latest/userguide/working-dags-dependencies.html">Installing Python dependencies</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MWAA.UpdateMWAAEnvironmentCmdlet.Scheduler"> <summary> <para> <para>The number of Apache Airflow schedulers to run in your Amazon MWAA environment.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MWAA.UpdateMWAAEnvironmentCmdlet.NetworkConfiguration_SecurityGroupId"> <summary> <para> <para>A list of security group IDs. A security group must be attached to the same VPC as the subnets. For more information, see <a href="https://docs.aws.amazon.com/mwaa/latest/userguide/vpc-security.html">Security in your VPC on Amazon MWAA</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MWAA.UpdateMWAAEnvironmentCmdlet.SourceBucketArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the Amazon S3 bucket where your DAG code and supporting files are stored. For example, <c>arn:aws:s3:::my-airflow-bucket-unique-name</c>. For more information, see <a href="https://docs.aws.amazon.com/mwaa/latest/userguide/mwaa-s3-bucket.html">Create an Amazon S3 bucket for Amazon MWAA</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MWAA.UpdateMWAAEnvironmentCmdlet.StartupScriptS3ObjectVersion"> <summary> <para> <para> The version of the startup shell script in your Amazon S3 bucket. You must specify the <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/versioning-workflows.html">version ID</a> that Amazon S3 assigns to the file every time you update the script. </para><para> 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: </para><para><c>3sL4kqtJlcpXroDTDmJ+rmSpXd3dIbrHY+MTRCxf3vjVBH40Nr8X8gdRQBpUMLUo</c></para><para> For more information, see <a href="https://docs.aws.amazon.com/mwaa/latest/userguide/using-startup-script.html">Using a startup script</a>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MWAA.UpdateMWAAEnvironmentCmdlet.StartupScriptS3Path"> <summary> <para> <para>The relative path to the startup shell script in your Amazon S3 bucket. For example, <c>s3://mwaa-environment/startup.sh</c>.</para><para> 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 <a href="https://docs.aws.amazon.com/mwaa/latest/userguide/using-startup-script.html">Using a startup script</a>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MWAA.UpdateMWAAEnvironmentCmdlet.WebserverAccessMode"> <summary> <para> <para>The Apache Airflow <i>Web server</i> access mode. For more information, see <a href="https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-networking.html">Apache Airflow access modes</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MWAA.UpdateMWAAEnvironmentCmdlet.WeeklyMaintenanceWindowStart"> <summary> <para> <para>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: <c>DAY:HH:MM</c>. For example: <c>TUE:03:30</c>. You can specify a start time in 30 minute increments only.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MWAA.UpdateMWAAEnvironmentCmdlet.Select"> <summary> 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.UpdateEnvironmentResponse). Specifying the name of a property of type Amazon.MWAA.Model.UpdateEnvironmentResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MWAA.UpdateMWAAEnvironmentCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Name parameter. The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MWAA.UpdateMWAAEnvironmentCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> </members> </doc> |