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, <code>arn:aws:airflow:us-east-1:123456789012:environment/MyMWAAEnvironment</code>.</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, <code>"Environment": "Staging"</code>. To learn more, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging AWS 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> Retrieves the details of 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, <code>MyMWAAEnvironment</code>.</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, <code>5</code> 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, <code>"Environment": "Staging"</code>. </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, <code>arn:aws:airflow:us-east-1:123456789012:environment/MyMWAAEnvironment</code>.</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> Create a CLI token to use Airflow CLI. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MWAA.NewMWAACliTokenCmdlet.Name"> <summary> <para> <para>Create a CLI token request for a MWAA environment.</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. To learn more, 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. For example, <code>v1.10.12</code>. If no value is specified, defaults to the latest version. Valid values: <code>v1.10.12</code>.</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, <code>dags</code>. To learn more, 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. <code>DagProcessingLogs</code>) in CloudWatch Logs.</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. <code>DagProcessingLogs</code>) in CloudWatch Logs.</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. <code>DagProcessingLogs</code>) in CloudWatch Logs.</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. <code>DagProcessingLogs</code>) in CloudWatch Logs.</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. <code>DagProcessingLogs</code>) in CloudWatch Logs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MWAA.NewMWAAEnvironmentCmdlet.EnvironmentClass"> <summary> <para> <para>The environment class type. Valid values: <code>mw1.small</code>, <code>mw1.medium</code>, <code>mw1.large</code>. To learn more, 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 AWS Identity and Access Management (IAM) role that grants MWAA permission to access AWS services and resources used by your environment. For example, <code>arn:aws:iam::123456789:role/my-execution-role</code>. To learn more, 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 AWS Key Management Service (KMS) key to encrypt the data in your environment. You can use an AWS owned CMK, or a Customer managed CMK (advanced). To learn more, see <a href="https://docs.aws.amazon.com/mwaa/latest/userguide/get-started.html">Get started with Amazon Managed Workflows for Apache Airflow</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MWAA.NewMWAAEnvironmentCmdlet.DagProcessingLogs_LogLevel"> <summary> <para> <para>Defines the Apache Airflow logs to send for the log type (e.g. <code>DagProcessingLogs</code>) to CloudWatch Logs. Valid values: <code>CRITICAL</code>, <code>ERROR</code>, <code>WARNING</code>, <code>INFO</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MWAA.NewMWAAEnvironmentCmdlet.SchedulerLogs_LogLevel"> <summary> <para> <para>Defines the Apache Airflow logs to send for the log type (e.g. <code>DagProcessingLogs</code>) to CloudWatch Logs. Valid values: <code>CRITICAL</code>, <code>ERROR</code>, <code>WARNING</code>, <code>INFO</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MWAA.NewMWAAEnvironmentCmdlet.TaskLogs_LogLevel"> <summary> <para> <para>Defines the Apache Airflow logs to send for the log type (e.g. <code>DagProcessingLogs</code>) to CloudWatch Logs. Valid values: <code>CRITICAL</code>, <code>ERROR</code>, <code>WARNING</code>, <code>INFO</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MWAA.NewMWAAEnvironmentCmdlet.WebserverLogs_LogLevel"> <summary> <para> <para>Defines the Apache Airflow logs to send for the log type (e.g. <code>DagProcessingLogs</code>) to CloudWatch Logs. Valid values: <code>CRITICAL</code>, <code>ERROR</code>, <code>WARNING</code>, <code>INFO</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MWAA.NewMWAAEnvironmentCmdlet.WorkerLogs_LogLevel"> <summary> <para> <para>Defines the Apache Airflow logs to send for the log type (e.g. <code>DagProcessingLogs</code>) to CloudWatch Logs. Valid values: <code>CRITICAL</code>, <code>ERROR</code>, <code>WARNING</code>, <code>INFO</code>.</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 <code>MaxWorkers</code> field. For example, <code>20</code>. 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 <code>MinWorkers</code>.</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 <code>MaxWorkers</code> 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 <code>MinWorkers</code> field. For example, <code>2</code>.</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, <code>MyMWAAEnvironment</code>.</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. A version must be specified each time a plugins.zip file is updated. To learn more, 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 <code>plugins.zip</code> file on your Amazon S3 bucket. For example, <code>plugins.zip</code>. If specified, then the plugins.zip version is required. To learn more, 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 requirements.txt file on your Amazon S3 bucket. A version must be specified each time a requirements.txt file is updated. To learn more, 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 <code>requirements.txt</code> file on your Amazon S3 bucket. For example, <code>requirements.txt</code>. If specified, then a file version is required. To learn more, 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.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MWAA.NewMWAAEnvironmentCmdlet.NetworkConfiguration_SecurityGroupId"> <summary> <para> <para>A list of 1 or more security group IDs. Accepts up to 5 security group IDs. A security group must be attached to the same VPC as the subnets. To learn more, 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, <code>arn:aws:s3:::my-airflow-bucket-unique-name</code>. To learn more, 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.NetworkConfiguration_SubnetId"> <summary> <para> <para>A list of 2 subnet IDs. <b>Required</b> to create an environment. Must be private subnets in two different availability zones. A subnet must be attached to the same VPC as the security group.</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, <code>"Environment": "Staging"</code>. To learn more, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging AWS resources</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MWAA.NewMWAAEnvironmentCmdlet.WebserverAccessMode"> <summary> <para> <para>The Apache Airflow <i>Web server</i> access mode. To learn more, 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 to start weekly maintenance updates of your environment in the following format: <code>DAY:HH:MM</code>. For example: <code>TUE:03:30</code>. You can specify a start time in 30 minute increments only. Supported input includes the following:</para><ul><li><para>MON|TUE|WED|THU|FRI|SAT|SUN:([01]\\d|2[0-3]):(00|30)</para></li></ul> </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> Create a JWT token to be used to login to Airflow Web UI with claims based Authentication. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MWAA.NewMWAAWebLoginTokenCmdlet.Name"> <summary> <para> <para>Create an Airflow Web UI login token request for a MWAA environment.</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> An operation for publishing metrics from the customers to the Ops plane. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MWAA.PublishMWAAMetricCmdlet.EnvironmentName"> <summary> <para> <para>Publishes environment metric data to Amazon CloudWatch.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MWAA.PublishMWAAMetricCmdlet.MetricData"> <summary> <para> <para>Publishes metric data points to Amazon CloudWatch. CloudWatch associates the data points with the specified metrica.</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, <code>MyMWAAEnvironment</code>.</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, <code>"Environment": "Staging"</code>. </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, <code>arn:aws:airflow:us-east-1:123456789012:environment/MyMWAAEnvironment</code>.</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, <code>"Environment": "Staging"</code>. </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. To learn more, 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. For example, <code>v1.10.12</code>. If no value is specified, defaults to the latest version. Valid values: <code>v1.10.12</code>.</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, <code>dags</code>. To learn more, 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. <code>DagProcessingLogs</code>) in CloudWatch Logs.</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. <code>DagProcessingLogs</code>) in CloudWatch Logs.</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. <code>DagProcessingLogs</code>) in CloudWatch Logs.</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. <code>DagProcessingLogs</code>) in CloudWatch Logs.</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. <code>DagProcessingLogs</code>) in CloudWatch Logs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MWAA.UpdateMWAAEnvironmentCmdlet.EnvironmentClass"> <summary> <para> <para>The environment class type. Valid values: <code>mw1.small</code>, <code>mw1.medium</code>, <code>mw1.large</code>. To learn more, 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 AWS resources in your environment. For example, <code>arn:aws:iam::123456789:role/my-execution-role</code>. To learn more, 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 logs to send for the log type (e.g. <code>DagProcessingLogs</code>) to CloudWatch Logs. Valid values: <code>CRITICAL</code>, <code>ERROR</code>, <code>WARNING</code>, <code>INFO</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MWAA.UpdateMWAAEnvironmentCmdlet.SchedulerLogs_LogLevel"> <summary> <para> <para>Defines the Apache Airflow logs to send for the log type (e.g. <code>DagProcessingLogs</code>) to CloudWatch Logs. Valid values: <code>CRITICAL</code>, <code>ERROR</code>, <code>WARNING</code>, <code>INFO</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MWAA.UpdateMWAAEnvironmentCmdlet.TaskLogs_LogLevel"> <summary> <para> <para>Defines the Apache Airflow logs to send for the log type (e.g. <code>DagProcessingLogs</code>) to CloudWatch Logs. Valid values: <code>CRITICAL</code>, <code>ERROR</code>, <code>WARNING</code>, <code>INFO</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MWAA.UpdateMWAAEnvironmentCmdlet.WebserverLogs_LogLevel"> <summary> <para> <para>Defines the Apache Airflow logs to send for the log type (e.g. <code>DagProcessingLogs</code>) to CloudWatch Logs. Valid values: <code>CRITICAL</code>, <code>ERROR</code>, <code>WARNING</code>, <code>INFO</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.MWAA.UpdateMWAAEnvironmentCmdlet.WorkerLogs_LogLevel"> <summary> <para> <para>Defines the Apache Airflow logs to send for the log type (e.g. <code>DagProcessingLogs</code>) to CloudWatch Logs. Valid values: <code>CRITICAL</code>, <code>ERROR</code>, <code>WARNING</code>, <code>INFO</code>.</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 <code>MaxWorkers</code> field. For example, <code>20</code>. 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 <code>MinWorkers</code>.</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 <code>MaxWorkers</code> 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 <code>MinWorkers</code> field. For example, <code>2</code>.</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, <code>MyMWAAEnvironment</code>.</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. A version must be specified each time a plugins.zip file is updated. To learn more, 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 <code>plugins.zip</code> file on your Amazon S3 bucket. For example, <code>plugins.zip</code>. If specified, then the plugins.zip version is required. To learn more, 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. A version must be specified each time a requirements.txt file is updated. To learn more, 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 <code>requirements.txt</code> file on your Amazon S3 bucket. For example, <code>requirements.txt</code>. If specified, then a file version is required. To learn more, 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 1 or more security group IDs. Accepts up to 5 security group IDs. A security group must be attached to the same VPC as the subnets. To learn more, 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, <code>arn:aws:s3:::my-airflow-bucket-unique-name</code>. To learn more, 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.WebserverAccessMode"> <summary> <para> <para>The Apache Airflow <i>Web server</i> access mode. To learn more, 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 to start weekly maintenance updates of your environment in the following format: <code>DAY:HH:MM</code>. For example: <code>TUE:03:30</code>. You can specify a start time in 30 minute increments only. Supported input includes the following:</para><ul><li><para>MON|TUE|WED|THU|FRI|SAT|SUN:([01]\\d|2[0-3]):(00|30)</para></li></ul> </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> |