Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Creates an Amazon Managed Workflows for Apache Airflow (MWAA) environment.
Synopsis
- data CreateEnvironment = CreateEnvironment' {
- airflowConfigurationOptions :: Maybe (Sensitive (HashMap Text (Sensitive Text)))
- airflowVersion :: Maybe Text
- environmentClass :: Maybe Text
- kmsKey :: Maybe Text
- loggingConfiguration :: Maybe LoggingConfigurationInput
- maxWorkers :: Maybe Natural
- minWorkers :: Maybe Natural
- pluginsS3ObjectVersion :: Maybe Text
- pluginsS3Path :: Maybe Text
- requirementsS3ObjectVersion :: Maybe Text
- requirementsS3Path :: Maybe Text
- schedulers :: Maybe Int
- tags :: Maybe (HashMap Text Text)
- webserverAccessMode :: Maybe WebserverAccessMode
- weeklyMaintenanceWindowStart :: Maybe Text
- dagS3Path :: Text
- executionRoleArn :: Text
- name :: Text
- networkConfiguration :: NetworkConfiguration
- sourceBucketArn :: Text
- newCreateEnvironment :: Text -> Text -> Text -> NetworkConfiguration -> Text -> CreateEnvironment
- createEnvironment_airflowConfigurationOptions :: Lens' CreateEnvironment (Maybe (HashMap Text Text))
- createEnvironment_airflowVersion :: Lens' CreateEnvironment (Maybe Text)
- createEnvironment_environmentClass :: Lens' CreateEnvironment (Maybe Text)
- createEnvironment_kmsKey :: Lens' CreateEnvironment (Maybe Text)
- createEnvironment_loggingConfiguration :: Lens' CreateEnvironment (Maybe LoggingConfigurationInput)
- createEnvironment_maxWorkers :: Lens' CreateEnvironment (Maybe Natural)
- createEnvironment_minWorkers :: Lens' CreateEnvironment (Maybe Natural)
- createEnvironment_pluginsS3ObjectVersion :: Lens' CreateEnvironment (Maybe Text)
- createEnvironment_pluginsS3Path :: Lens' CreateEnvironment (Maybe Text)
- createEnvironment_requirementsS3ObjectVersion :: Lens' CreateEnvironment (Maybe Text)
- createEnvironment_requirementsS3Path :: Lens' CreateEnvironment (Maybe Text)
- createEnvironment_schedulers :: Lens' CreateEnvironment (Maybe Int)
- createEnvironment_tags :: Lens' CreateEnvironment (Maybe (HashMap Text Text))
- createEnvironment_webserverAccessMode :: Lens' CreateEnvironment (Maybe WebserverAccessMode)
- createEnvironment_weeklyMaintenanceWindowStart :: Lens' CreateEnvironment (Maybe Text)
- createEnvironment_dagS3Path :: Lens' CreateEnvironment Text
- createEnvironment_executionRoleArn :: Lens' CreateEnvironment Text
- createEnvironment_name :: Lens' CreateEnvironment Text
- createEnvironment_networkConfiguration :: Lens' CreateEnvironment NetworkConfiguration
- createEnvironment_sourceBucketArn :: Lens' CreateEnvironment Text
- data CreateEnvironmentResponse = CreateEnvironmentResponse' {
- arn :: Maybe Text
- httpStatus :: Int
- newCreateEnvironmentResponse :: Int -> CreateEnvironmentResponse
- createEnvironmentResponse_arn :: Lens' CreateEnvironmentResponse (Maybe Text)
- createEnvironmentResponse_httpStatus :: Lens' CreateEnvironmentResponse Int
Creating a Request
data CreateEnvironment Source #
This section contains the Amazon Managed Workflows for Apache Airflow (MWAA) API reference documentation to create an environment. For more information, see Get started with Amazon Managed Workflows for Apache Airflow.
See: newCreateEnvironment
smart constructor.
CreateEnvironment' | |
|
Instances
:: Text | |
-> Text | |
-> Text | |
-> NetworkConfiguration | |
-> Text | |
-> CreateEnvironment |
Create a value of CreateEnvironment
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:
CreateEnvironment
, createEnvironment_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.
CreateEnvironment
, createEnvironment_airflowVersion
- The Apache Airflow version for your environment. If no value is
specified, it defaults to the latest version. Valid values: 1.10.12
,
2.0.2
, 2.2.2
, and 2.4.3
. For more information, see
Apache Airflow versions on Amazon Managed Workflows for Apache Airflow (MWAA).
CreateEnvironment
, createEnvironment_environmentClass
- The environment class type. Valid values: mw1.small
, mw1.medium
,
mw1.large
. To learn more, see
Amazon MWAA environment class.
CreateEnvironment
, createEnvironment_kmsKey
- 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). To learn more, see
Create an Amazon MWAA environment.
CreateEnvironment
, createEnvironment_loggingConfiguration
- Defines the Apache Airflow logs to send to CloudWatch Logs.
CreateEnvironment
, createEnvironment_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
.
CreateEnvironment
, createEnvironment_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
.
CreateEnvironment
, createEnvironment_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.
CreateEnvironment
, createEnvironment_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.
CreateEnvironment
, createEnvironment_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.
CreateEnvironment
, createEnvironment_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.
CreateEnvironment
, createEnvironment_schedulers
- The number of Apache Airflow schedulers to run in your environment.
Valid values:
- v2 - Accepts between 2 to 5. Defaults to 2.
- v1 - Accepts 1.
CreateEnvironment
, createEnvironment_tags
- The key-value tag pairs you want to associate to your environment. For
example, "Environment": "Staging"
. To learn more, see
Tagging Amazon Web Services resources.
CreateEnvironment
, createEnvironment_webserverAccessMode
- The Apache Airflow Web server access mode. To learn more, see
Apache Airflow access modes.
CreateEnvironment
, createEnvironment_weeklyMaintenanceWindowStart
- The day and time of the week in Coordinated Universal Time (UTC) 24-hour
standard time to start weekly maintenance updates of your environment in
the following format: DAY:HH:MM
. For example: TUE:03:30
. You can
specify a start time in 30 minute increments only.
CreateEnvironment
, createEnvironment_dagS3Path
- The relative path to the DAGs folder on your Amazon S3 bucket. For
example, dags
. To learn more, see
Adding or updating DAGs.
CreateEnvironment
, createEnvironment_executionRoleArn
- The Amazon Resource Name (ARN) of the execution role for your
environment. An execution role is an Amazon Web Services Identity and
Access Management (IAM) role that grants MWAA permission to access
Amazon Web Services services and resources used by your environment. For
example, arn:aws:iam::123456789:role/my-execution-role
. To learn
more, see
Amazon MWAA Execution role.
CreateEnvironment
, createEnvironment_name
- The name of the Amazon MWAA environment. For example,
MyMWAAEnvironment
.
CreateEnvironment
, createEnvironment_networkConfiguration
- The VPC networking components used to secure and enable network traffic
between the Amazon Web Services resources for your environment. To learn
more, see
About networking on Amazon MWAA.
CreateEnvironment
, createEnvironment_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.
Request Lenses
createEnvironment_airflowConfigurationOptions :: Lens' CreateEnvironment (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.
createEnvironment_airflowVersion :: Lens' CreateEnvironment (Maybe Text) Source #
The Apache Airflow version for your environment. If no value is
specified, it defaults to the latest version. Valid values: 1.10.12
,
2.0.2
, 2.2.2
, and 2.4.3
. For more information, see
Apache Airflow versions on Amazon Managed Workflows for Apache Airflow (MWAA).
createEnvironment_environmentClass :: Lens' CreateEnvironment (Maybe Text) Source #
The environment class type. Valid values: mw1.small
, mw1.medium
,
mw1.large
. To learn more, see
Amazon MWAA environment class.
createEnvironment_kmsKey :: Lens' CreateEnvironment (Maybe Text) Source #
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). To learn more, see Create an Amazon MWAA environment.
createEnvironment_loggingConfiguration :: Lens' CreateEnvironment (Maybe LoggingConfigurationInput) Source #
Defines the Apache Airflow logs to send to CloudWatch Logs.
createEnvironment_maxWorkers :: Lens' CreateEnvironment (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
.
createEnvironment_minWorkers :: Lens' CreateEnvironment (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
.
createEnvironment_pluginsS3ObjectVersion :: Lens' CreateEnvironment (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.
createEnvironment_pluginsS3Path :: Lens' CreateEnvironment (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.
createEnvironment_requirementsS3ObjectVersion :: Lens' CreateEnvironment (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.
createEnvironment_requirementsS3Path :: Lens' CreateEnvironment (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.
createEnvironment_schedulers :: Lens' CreateEnvironment (Maybe Int) Source #
The number of Apache Airflow schedulers to run in your environment. Valid values:
- v2 - Accepts between 2 to 5. Defaults to 2.
- v1 - Accepts 1.
createEnvironment_tags :: Lens' CreateEnvironment (Maybe (HashMap Text Text)) Source #
The key-value tag pairs you want to associate to your environment. For
example, "Environment": "Staging"
. To learn more, see
Tagging Amazon Web Services resources.
createEnvironment_webserverAccessMode :: Lens' CreateEnvironment (Maybe WebserverAccessMode) Source #
The Apache Airflow Web server access mode. To learn more, see Apache Airflow access modes.
createEnvironment_weeklyMaintenanceWindowStart :: Lens' CreateEnvironment (Maybe Text) Source #
The day and time of the week in Coordinated Universal Time (UTC) 24-hour
standard time to start weekly maintenance updates of your environment in
the following format: DAY:HH:MM
. For example: TUE:03:30
. You can
specify a start time in 30 minute increments only.
createEnvironment_dagS3Path :: Lens' CreateEnvironment 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.
createEnvironment_executionRoleArn :: Lens' CreateEnvironment Text Source #
The Amazon Resource Name (ARN) of the execution role for your
environment. An execution role is an Amazon Web Services Identity and
Access Management (IAM) role that grants MWAA permission to access
Amazon Web Services services and resources used by your environment. For
example, arn:aws:iam::123456789:role/my-execution-role
. To learn
more, see
Amazon MWAA Execution role.
createEnvironment_name :: Lens' CreateEnvironment Text Source #
The name of the Amazon MWAA environment. For example,
MyMWAAEnvironment
.
createEnvironment_networkConfiguration :: Lens' CreateEnvironment NetworkConfiguration Source #
The VPC networking components used to secure and enable network traffic between the Amazon Web Services resources for your environment. To learn more, see About networking on Amazon MWAA.
createEnvironment_sourceBucketArn :: Lens' CreateEnvironment 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.
Destructuring the Response
data CreateEnvironmentResponse Source #
See: newCreateEnvironmentResponse
smart constructor.
CreateEnvironmentResponse' | |
|
Instances
newCreateEnvironmentResponse Source #
Create a value of CreateEnvironmentResponse
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:
CreateEnvironmentResponse
, createEnvironmentResponse_arn
- The Amazon Resource Name (ARN) returned in the response for the
environment.
$sel:httpStatus:CreateEnvironmentResponse'
, createEnvironmentResponse_httpStatus
- The response's http status code.
Response Lenses
createEnvironmentResponse_arn :: Lens' CreateEnvironmentResponse (Maybe Text) Source #
The Amazon Resource Name (ARN) returned in the response for the environment.
createEnvironmentResponse_httpStatus :: Lens' CreateEnvironmentResponse Int Source #
The response's http status code.