libZSservicesZSamazonka-mwaaZSamazonka-mwaa
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.MwAA.UpdateEnvironment

Description

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

Synopsis

Creating a Request

data UpdateEnvironment Source #

See: newUpdateEnvironment smart constructor.

Constructors

UpdateEnvironment' 

Fields

Instances

Instances details
Eq UpdateEnvironment Source # 
Instance details

Defined in Amazonka.MwAA.UpdateEnvironment

Show UpdateEnvironment Source # 
Instance details

Defined in Amazonka.MwAA.UpdateEnvironment

Generic UpdateEnvironment Source # 
Instance details

Defined in Amazonka.MwAA.UpdateEnvironment

Associated Types

type Rep UpdateEnvironment :: Type -> Type #

NFData UpdateEnvironment Source # 
Instance details

Defined in Amazonka.MwAA.UpdateEnvironment

Methods

rnf :: UpdateEnvironment -> () #

Hashable UpdateEnvironment Source # 
Instance details

Defined in Amazonka.MwAA.UpdateEnvironment

ToJSON UpdateEnvironment Source # 
Instance details

Defined in Amazonka.MwAA.UpdateEnvironment

AWSRequest UpdateEnvironment Source # 
Instance details

Defined in Amazonka.MwAA.UpdateEnvironment

Associated Types

type AWSResponse UpdateEnvironment #

ToHeaders UpdateEnvironment Source # 
Instance details

Defined in Amazonka.MwAA.UpdateEnvironment

ToPath UpdateEnvironment Source # 
Instance details

Defined in Amazonka.MwAA.UpdateEnvironment

ToQuery UpdateEnvironment Source # 
Instance details

Defined in Amazonka.MwAA.UpdateEnvironment

type Rep UpdateEnvironment Source # 
Instance details

Defined in Amazonka.MwAA.UpdateEnvironment

type Rep UpdateEnvironment = D1 ('MetaData "UpdateEnvironment" "Amazonka.MwAA.UpdateEnvironment" "libZSservicesZSamazonka-mwaaZSamazonka-mwaa" 'False) (C1 ('MetaCons "UpdateEnvironment'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "schedulers") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "minWorkers") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))) :*: (S1 ('MetaSel ('Just "pluginsS3Path") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "webserverAccessMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe WebserverAccessMode)))) :*: ((S1 ('MetaSel ('Just "airflowVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "weeklyMaintenanceWindowStart") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "executionRoleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "requirementsS3ObjectVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "sourceBucketArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))) :*: (((S1 ('MetaSel ('Just "dagS3Path") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "pluginsS3ObjectVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "airflowConfigurationOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive (HashMap Text Text)))) :*: S1 ('MetaSel ('Just "loggingConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LoggingConfigurationInput)))) :*: ((S1 ('MetaSel ('Just "environmentClass") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "networkConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe UpdateNetworkConfigurationInput))) :*: (S1 ('MetaSel ('Just "requirementsS3Path") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "maxWorkers") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))))
type AWSResponse UpdateEnvironment Source # 
Instance details

Defined in Amazonka.MwAA.UpdateEnvironment

newUpdateEnvironment Source #

Create a value of UpdateEnvironment with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:schedulers:UpdateEnvironment', updateEnvironment_schedulers - The number of Apache Airflow schedulers to run in your Amazon MWAA environment.

$sel:minWorkers:UpdateEnvironment', updateEnvironment_minWorkers - 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.

$sel:pluginsS3Path:UpdateEnvironment', updateEnvironment_pluginsS3Path - 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. To learn more, see Installing custom plugins.

$sel:webserverAccessMode:UpdateEnvironment', updateEnvironment_webserverAccessMode - The Apache Airflow Web server access mode. To learn more, see Apache Airflow access modes.

$sel:airflowVersion:UpdateEnvironment', updateEnvironment_airflowVersion - The Apache Airflow version for your environment. For example, v1.10.12. If no value is specified, defaults to the latest version. Valid values: v1.10.12.

$sel:weeklyMaintenanceWindowStart:UpdateEnvironment', updateEnvironment_weeklyMaintenanceWindowStart - The day and time of the week 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. Supported input includes the following:

  • MON|TUE|WED|THU|FRI|SAT|SUN:([01]\\d|2[0-3]):(00|30)

$sel:executionRoleArn:UpdateEnvironment', updateEnvironment_executionRoleArn - The Amazon Resource Name (ARN) of the execution role in IAM that allows MWAA to access AWS resources in your environment. For example, arn:aws:iam::123456789:role/my-execution-role. To learn more, see Amazon MWAA Execution role.

$sel:requirementsS3ObjectVersion:UpdateEnvironment', updateEnvironment_requirementsS3ObjectVersion - 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 How S3 Versioning works.

$sel:sourceBucketArn:UpdateEnvironment', updateEnvironment_sourceBucketArn - 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. To learn more, see Create an Amazon S3 bucket for Amazon MWAA.

$sel:dagS3Path:UpdateEnvironment', updateEnvironment_dagS3Path - The relative path to the DAGs folder on your Amazon S3 bucket. For example, dags. To learn more, see Adding or updating DAGs.

$sel:pluginsS3ObjectVersion:UpdateEnvironment', updateEnvironment_pluginsS3ObjectVersion - 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 How S3 Versioning works.

$sel:airflowConfigurationOptions:UpdateEnvironment', updateEnvironment_airflowConfigurationOptions - A list of key-value pairs containing the Apache Airflow configuration options you want to attach to your environment. To learn more, see Apache Airflow configuration options.

$sel:loggingConfiguration:UpdateEnvironment', updateEnvironment_loggingConfiguration - Defines the Apache Airflow logs to send to CloudWatch Logs: DagProcessingLogs, SchedulerLogs, TaskLogs, WebserverLogs, WorkerLogs.

$sel:environmentClass:UpdateEnvironment', updateEnvironment_environmentClass - The environment class type. Valid values: mw1.small, mw1.medium, mw1.large. To learn more, see Amazon MWAA environment class.

$sel:networkConfiguration:UpdateEnvironment', updateEnvironment_networkConfiguration - The VPC networking components used to secure and enable network traffic between the AWS resources for your environment. To learn more, see About networking on Amazon MWAA.

$sel:requirementsS3Path:UpdateEnvironment', updateEnvironment_requirementsS3Path - The relative path to the requirements.txt file on your Amazon S3 bucket. For example, requirements.txt. If specified, then a file version is required. To learn more, see Installing Python dependencies.

$sel:maxWorkers:UpdateEnvironment', updateEnvironment_maxWorkers - 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.

$sel:name:UpdateEnvironment', updateEnvironment_name - The name of your Amazon MWAA environment. For example, MyMWAAEnvironment.

Request Lenses

updateEnvironment_schedulers :: Lens' UpdateEnvironment (Maybe Int) Source #

The number of Apache Airflow schedulers to run in your Amazon MWAA environment.

updateEnvironment_minWorkers :: Lens' UpdateEnvironment (Maybe Natural) Source #

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.

updateEnvironment_pluginsS3Path :: Lens' UpdateEnvironment (Maybe Text) Source #

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. To learn more, see Installing custom plugins.

updateEnvironment_airflowVersion :: Lens' UpdateEnvironment (Maybe Text) Source #

The Apache Airflow version for your environment. For example, v1.10.12. If no value is specified, defaults to the latest version. Valid values: v1.10.12.

updateEnvironment_weeklyMaintenanceWindowStart :: Lens' UpdateEnvironment (Maybe Text) Source #

The day and time of the week 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. Supported input includes the following:

  • MON|TUE|WED|THU|FRI|SAT|SUN:([01]\\d|2[0-3]):(00|30)

updateEnvironment_executionRoleArn :: Lens' UpdateEnvironment (Maybe Text) Source #

The Amazon Resource Name (ARN) of the execution role in IAM that allows MWAA to access AWS resources in your environment. For example, arn:aws:iam::123456789:role/my-execution-role. To learn more, see Amazon MWAA Execution role.

updateEnvironment_requirementsS3ObjectVersion :: Lens' UpdateEnvironment (Maybe Text) Source #

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 How S3 Versioning works.

updateEnvironment_sourceBucketArn :: Lens' UpdateEnvironment (Maybe Text) Source #

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. To learn more, see Create an Amazon S3 bucket for Amazon MWAA.

updateEnvironment_dagS3Path :: Lens' UpdateEnvironment (Maybe Text) Source #

The relative path to the DAGs folder on your Amazon S3 bucket. For example, dags. To learn more, see Adding or updating DAGs.

updateEnvironment_pluginsS3ObjectVersion :: Lens' UpdateEnvironment (Maybe Text) Source #

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 How S3 Versioning works.

updateEnvironment_airflowConfigurationOptions :: Lens' UpdateEnvironment (Maybe (HashMap Text Text)) Source #

A list of key-value pairs containing the Apache Airflow configuration options you want to attach to your environment. To learn more, see Apache Airflow configuration options.

updateEnvironment_loggingConfiguration :: Lens' UpdateEnvironment (Maybe LoggingConfigurationInput) Source #

Defines the Apache Airflow logs to send to CloudWatch Logs: DagProcessingLogs, SchedulerLogs, TaskLogs, WebserverLogs, WorkerLogs.

updateEnvironment_environmentClass :: Lens' UpdateEnvironment (Maybe Text) Source #

The environment class type. Valid values: mw1.small, mw1.medium, mw1.large. To learn more, see Amazon MWAA environment class.

updateEnvironment_networkConfiguration :: Lens' UpdateEnvironment (Maybe UpdateNetworkConfigurationInput) Source #

The VPC networking components used to secure and enable network traffic between the AWS resources for your environment. To learn more, see About networking on Amazon MWAA.

updateEnvironment_requirementsS3Path :: Lens' UpdateEnvironment (Maybe Text) Source #

The relative path to the requirements.txt file on your Amazon S3 bucket. For example, requirements.txt. If specified, then a file version is required. To learn more, see Installing Python dependencies.

updateEnvironment_maxWorkers :: Lens' UpdateEnvironment (Maybe Natural) Source #

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.

updateEnvironment_name :: Lens' UpdateEnvironment Text Source #

The name of your Amazon MWAA environment. For example, MyMWAAEnvironment.

Destructuring the Response

data UpdateEnvironmentResponse Source #

See: newUpdateEnvironmentResponse smart constructor.

Constructors

UpdateEnvironmentResponse' 

Fields

  • arn :: Maybe Text

    The Amazon Resource Name (ARN) of the Amazon MWAA environment. For example, arn:aws:airflow:us-east-1:123456789012:environment/MyMWAAEnvironment.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Eq UpdateEnvironmentResponse Source # 
Instance details

Defined in Amazonka.MwAA.UpdateEnvironment

Read UpdateEnvironmentResponse Source # 
Instance details

Defined in Amazonka.MwAA.UpdateEnvironment

Show UpdateEnvironmentResponse Source # 
Instance details

Defined in Amazonka.MwAA.UpdateEnvironment

Generic UpdateEnvironmentResponse Source # 
Instance details

Defined in Amazonka.MwAA.UpdateEnvironment

Associated Types

type Rep UpdateEnvironmentResponse :: Type -> Type #

NFData UpdateEnvironmentResponse Source # 
Instance details

Defined in Amazonka.MwAA.UpdateEnvironment

type Rep UpdateEnvironmentResponse Source # 
Instance details

Defined in Amazonka.MwAA.UpdateEnvironment

type Rep UpdateEnvironmentResponse = D1 ('MetaData "UpdateEnvironmentResponse" "Amazonka.MwAA.UpdateEnvironment" "libZSservicesZSamazonka-mwaaZSamazonka-mwaa" 'False) (C1 ('MetaCons "UpdateEnvironmentResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newUpdateEnvironmentResponse Source #

Create a value of UpdateEnvironmentResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:arn:UpdateEnvironmentResponse', updateEnvironmentResponse_arn - The Amazon Resource Name (ARN) of the Amazon MWAA environment. For example, arn:aws:airflow:us-east-1:123456789012:environment/MyMWAAEnvironment.

$sel:httpStatus:UpdateEnvironmentResponse', updateEnvironmentResponse_httpStatus - The response's http status code.

Response Lenses

updateEnvironmentResponse_arn :: Lens' UpdateEnvironmentResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the Amazon MWAA environment. For example, arn:aws:airflow:us-east-1:123456789012:environment/MyMWAAEnvironment.