com.pulumi.awsnative.mwaa.kotlin.EnvironmentArgs.kt Maven / Gradle / Ivy
@file:Suppress("NAME_SHADOWING", "DEPRECATION")
package com.pulumi.awsnative.mwaa.kotlin
import com.pulumi.awsnative.mwaa.EnvironmentArgs.builder
import com.pulumi.awsnative.mwaa.kotlin.enums.EnvironmentEndpointManagement
import com.pulumi.awsnative.mwaa.kotlin.enums.EnvironmentWebserverAccessMode
import com.pulumi.awsnative.mwaa.kotlin.inputs.EnvironmentLoggingConfigurationArgs
import com.pulumi.awsnative.mwaa.kotlin.inputs.EnvironmentLoggingConfigurationArgsBuilder
import com.pulumi.awsnative.mwaa.kotlin.inputs.EnvironmentNetworkConfigurationArgs
import com.pulumi.awsnative.mwaa.kotlin.inputs.EnvironmentNetworkConfigurationArgsBuilder
import com.pulumi.core.Output
import com.pulumi.core.Output.of
import com.pulumi.kotlin.ConvertibleToJava
import com.pulumi.kotlin.PulumiTagMarker
import com.pulumi.kotlin.applySuspend
import kotlin.Any
import kotlin.Int
import kotlin.String
import kotlin.Suppress
import kotlin.Unit
import kotlin.jvm.JvmName
/**
* Resource schema for AWS::MWAA::Environment
* @property airflowConfigurationOptions Key/value pairs representing Airflow configuration variables.
* Keys are prefixed by their section:
* [core]
* dags_folder={AIRFLOW_HOME}/dags
* Would be represented as
* "core.dags_folder": "{AIRFLOW_HOME}/dags"
* Search the [CloudFormation User Guide](https://docs.aws.amazon.com/cloudformation/) for `AWS::MWAA::Environment` for more information about the expected schema for this property.
* @property airflowVersion The version of Apache Airflow to use for the environment. If no value is specified, defaults to the latest version.
* If you specify a newer version number for an existing environment, the version update requires some service interruption before taking effect.
* *Allowed Values* : `1.10.12` | `2.0.2` | `2.2.2` | `2.4.3` | `2.5.1` | `2.6.3` | `2.7.2` | `2.8.1` | `2.9.2` (latest)
* @property dagS3Path The relative path to the DAGs folder on your Amazon S3 bucket. For example, `dags` . To learn more, see [Adding or updating DAGs](https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-dag-folder.html) .
* @property endpointManagement Defines whether the VPC endpoints configured for the environment are created, and managed, by the customer or by Amazon MWAA. If set to `SERVICE` , Amazon MWAA will create and manage the required VPC endpoints in your VPC. If set to `CUSTOMER` , you must create, and manage, the VPC endpoints in your VPC.
* @property environmentClass The environment class type. Valid values: `mw1.small` , `mw1.medium` , `mw1.large` . To learn more, see [Amazon MWAA environment class](https://docs.aws.amazon.com/mwaa/latest/userguide/environment-class.html) .
* @property 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](https://docs.aws.amazon.com/mwaa/latest/userguide/mwaa-create-role.html) .
* @property kmsKey The AWS Key Management Service (KMS) key to encrypt and decrypt the data in your environment. You can use an AWS KMS key managed by MWAA, or a customer-managed KMS key (advanced).
* @property loggingConfiguration The Apache Airflow logs being sent to CloudWatch Logs: `DagProcessingLogs` , `SchedulerLogs` , `TaskLogs` , `WebserverLogs` , `WorkerLogs` .
* @property maxWebservers The maximum number of web servers that you want to run in your environment. Amazon MWAA scales the number of Apache Airflow web servers up to the number you specify for `MaxWebservers` when you interact with your Apache Airflow environment using Apache Airflow REST API, or the Apache Airflow CLI. For example, in scenarios where your workload requires network calls to the Apache Airflow REST API with a high transaction-per-second (TPS) rate, Amazon MWAA will increase the number of web servers up to the number set in `MaxWebserers` . As TPS rates decrease Amazon MWAA disposes of the additional web servers, and scales down to the number set in `MinxWebserers` .
* Valid values: Accepts between `2` and `5` . Defaults to `2` .
* @property 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` .
* @property minWebservers The minimum number of web servers that you want to run in your environment. Amazon MWAA scales the number of Apache Airflow web servers up to the number you specify for `MaxWebservers` when you interact with your Apache Airflow environment using Apache Airflow REST API, or the Apache Airflow CLI. As the transaction-per-second rate, and the network load, decrease, Amazon MWAA disposes of the additional web servers, and scales down to the number set in `MinxWebserers` .
* Valid values: Accepts between `2` and `5` . Defaults to `2` .
* @property 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` .
* @property name The name of your Amazon MWAA environment.
* @property 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](https://docs.aws.amazon.com/mwaa/latest/userguide/networking-about.html) .
* @property pluginsS3ObjectVersion The version of the plugins.zip file on your Amazon S3 bucket. To learn more, see [Installing custom plugins](https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-dag-import-plugins.html) .
* @property pluginsS3Path The relative path to the `plugins.zip` file on your Amazon S3 bucket. For example, `plugins.zip` . To learn more, see [Installing custom plugins](https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-dag-import-plugins.html) .
* @property requirementsS3ObjectVersion The version of the requirements.txt file on your Amazon S3 bucket. To learn more, see [Installing Python dependencies](https://docs.aws.amazon.com/mwaa/latest/userguide/working-dags-dependencies.html) .
* @property requirementsS3Path The relative path to the `requirements.txt` file on your Amazon S3 bucket. For example, `requirements.txt` . To learn more, see [Installing Python dependencies](https://docs.aws.amazon.com/mwaa/latest/userguide/working-dags-dependencies.html) .
* @property schedulers The number of schedulers that you want to run in your environment. Valid values:
* - *v2* - Accepts between 2 to 5. Defaults to 2.
* - *v1* - Accepts 1.
* @property 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](https://docs.aws.amazon.com/mwaa/latest/userguide/mwaa-s3-bucket.html) .
* @property startupScriptS3ObjectVersion The version of the startup shell script in your Amazon S3 bucket. You must specify the [version ID](https://docs.aws.amazon.com/AmazonS3/latest/userguide/versioning-workflows.html) that Amazon S3 assigns to the file every time you update the script.
* Version IDs are Unicode, UTF-8 encoded, URL-ready, opaque strings that are no more than 1,024 bytes long. The following is an example:
* `3sL4kqtJlcpXroDTDmJ+rmSpXd3dIbrHY+MTRCxf3vjVBH40Nr8X8gdRQBpUMLUo`
* For more information, see [Using a startup script](https://docs.aws.amazon.com/mwaa/latest/userguide/using-startup-script.html) .
* @property startupScriptS3Path The relative path to the startup shell script in your Amazon S3 bucket. For example, `s3://mwaa-environment/startup.sh` .
* Amazon MWAA runs the script as your environment starts, and before running the Apache Airflow process. You can use this script to install dependencies, modify Apache Airflow configuration options, and set environment variables. For more information, see [Using a startup script](https://docs.aws.amazon.com/mwaa/latest/userguide/using-startup-script.html) .
* @property tags A map of tags for the environment.
* Search the [CloudFormation User Guide](https://docs.aws.amazon.com/cloudformation/) for `AWS::MWAA::Environment` for more information about the expected schema for this property.
* @property webserverAccessMode The Apache Airflow *Web server* access mode. To learn more, see [Apache Airflow access modes](https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-networking.html) . Valid values: `PRIVATE_ONLY` or `PUBLIC_ONLY` .
* @property 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)
*/
public data class EnvironmentArgs(
public val airflowConfigurationOptions: Output? = null,
public val airflowVersion: Output? = null,
public val dagS3Path: Output? = null,
public val endpointManagement: Output? = null,
public val environmentClass: Output? = null,
public val executionRoleArn: Output? = null,
public val kmsKey: Output? = null,
public val loggingConfiguration: Output? = null,
public val maxWebservers: Output? = null,
public val maxWorkers: Output? = null,
public val minWebservers: Output? = null,
public val minWorkers: Output? = null,
public val name: Output? = null,
public val networkConfiguration: Output? = null,
public val pluginsS3ObjectVersion: Output? = null,
public val pluginsS3Path: Output? = null,
public val requirementsS3ObjectVersion: Output? = null,
public val requirementsS3Path: Output? = null,
public val schedulers: Output? = null,
public val sourceBucketArn: Output? = null,
public val startupScriptS3ObjectVersion: Output? = null,
public val startupScriptS3Path: Output? = null,
public val tags: Output? = null,
public val webserverAccessMode: Output? = null,
public val weeklyMaintenanceWindowStart: Output? = null,
) : ConvertibleToJava {
override fun toJava(): com.pulumi.awsnative.mwaa.EnvironmentArgs =
com.pulumi.awsnative.mwaa.EnvironmentArgs.builder()
.airflowConfigurationOptions(airflowConfigurationOptions?.applyValue({ args0 -> args0 }))
.airflowVersion(airflowVersion?.applyValue({ args0 -> args0 }))
.dagS3Path(dagS3Path?.applyValue({ args0 -> args0 }))
.endpointManagement(
endpointManagement?.applyValue({ args0 ->
args0.let({ args0 ->
args0.toJava()
})
}),
)
.environmentClass(environmentClass?.applyValue({ args0 -> args0 }))
.executionRoleArn(executionRoleArn?.applyValue({ args0 -> args0 }))
.kmsKey(kmsKey?.applyValue({ args0 -> args0 }))
.loggingConfiguration(
loggingConfiguration?.applyValue({ args0 ->
args0.let({ args0 ->
args0.toJava()
})
}),
)
.maxWebservers(maxWebservers?.applyValue({ args0 -> args0 }))
.maxWorkers(maxWorkers?.applyValue({ args0 -> args0 }))
.minWebservers(minWebservers?.applyValue({ args0 -> args0 }))
.minWorkers(minWorkers?.applyValue({ args0 -> args0 }))
.name(name?.applyValue({ args0 -> args0 }))
.networkConfiguration(
networkConfiguration?.applyValue({ args0 ->
args0.let({ args0 ->
args0.toJava()
})
}),
)
.pluginsS3ObjectVersion(pluginsS3ObjectVersion?.applyValue({ args0 -> args0 }))
.pluginsS3Path(pluginsS3Path?.applyValue({ args0 -> args0 }))
.requirementsS3ObjectVersion(requirementsS3ObjectVersion?.applyValue({ args0 -> args0 }))
.requirementsS3Path(requirementsS3Path?.applyValue({ args0 -> args0 }))
.schedulers(schedulers?.applyValue({ args0 -> args0 }))
.sourceBucketArn(sourceBucketArn?.applyValue({ args0 -> args0 }))
.startupScriptS3ObjectVersion(startupScriptS3ObjectVersion?.applyValue({ args0 -> args0 }))
.startupScriptS3Path(startupScriptS3Path?.applyValue({ args0 -> args0 }))
.tags(tags?.applyValue({ args0 -> args0 }))
.webserverAccessMode(
webserverAccessMode?.applyValue({ args0 ->
args0.let({ args0 ->
args0.toJava()
})
}),
)
.weeklyMaintenanceWindowStart(weeklyMaintenanceWindowStart?.applyValue({ args0 -> args0 })).build()
}
/**
* Builder for [EnvironmentArgs].
*/
@PulumiTagMarker
public class EnvironmentArgsBuilder internal constructor() {
private var airflowConfigurationOptions: Output? = null
private var airflowVersion: Output? = null
private var dagS3Path: Output? = null
private var endpointManagement: Output? = null
private var environmentClass: Output? = null
private var executionRoleArn: Output? = null
private var kmsKey: Output? = null
private var loggingConfiguration: Output? = null
private var maxWebservers: Output? = null
private var maxWorkers: Output? = null
private var minWebservers: Output? = null
private var minWorkers: Output? = null
private var name: Output? = null
private var networkConfiguration: Output? = null
private var pluginsS3ObjectVersion: Output? = null
private var pluginsS3Path: Output? = null
private var requirementsS3ObjectVersion: Output? = null
private var requirementsS3Path: Output? = null
private var schedulers: Output? = null
private var sourceBucketArn: Output? = null
private var startupScriptS3ObjectVersion: Output? = null
private var startupScriptS3Path: Output? = null
private var tags: Output? = null
private var webserverAccessMode: Output? = null
private var weeklyMaintenanceWindowStart: Output? = null
/**
* @param value Key/value pairs representing Airflow configuration variables.
* Keys are prefixed by their section:
* [core]
* dags_folder={AIRFLOW_HOME}/dags
* Would be represented as
* "core.dags_folder": "{AIRFLOW_HOME}/dags"
* Search the [CloudFormation User Guide](https://docs.aws.amazon.com/cloudformation/) for `AWS::MWAA::Environment` for more information about the expected schema for this property.
*/
@JvmName("aumjmagxunqpvycf")
public suspend fun airflowConfigurationOptions(`value`: Output) {
this.airflowConfigurationOptions = value
}
/**
* @param value The version of Apache Airflow to use for the environment. If no value is specified, defaults to the latest version.
* If you specify a newer version number for an existing environment, the version update requires some service interruption before taking effect.
* *Allowed Values* : `1.10.12` | `2.0.2` | `2.2.2` | `2.4.3` | `2.5.1` | `2.6.3` | `2.7.2` | `2.8.1` | `2.9.2` (latest)
*/
@JvmName("stewcnsdubqjvpcv")
public suspend fun airflowVersion(`value`: Output) {
this.airflowVersion = value
}
/**
* @param value The relative path to the DAGs folder on your Amazon S3 bucket. For example, `dags` . To learn more, see [Adding or updating DAGs](https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-dag-folder.html) .
*/
@JvmName("ptgawiyrgfhomiwu")
public suspend fun dagS3Path(`value`: Output) {
this.dagS3Path = value
}
/**
* @param value Defines whether the VPC endpoints configured for the environment are created, and managed, by the customer or by Amazon MWAA. If set to `SERVICE` , Amazon MWAA will create and manage the required VPC endpoints in your VPC. If set to `CUSTOMER` , you must create, and manage, the VPC endpoints in your VPC.
*/
@JvmName("gispvwyoirccktgr")
public suspend fun endpointManagement(`value`: Output) {
this.endpointManagement = value
}
/**
* @param value The environment class type. Valid values: `mw1.small` , `mw1.medium` , `mw1.large` . To learn more, see [Amazon MWAA environment class](https://docs.aws.amazon.com/mwaa/latest/userguide/environment-class.html) .
*/
@JvmName("qqrwuevrwejwixdd")
public suspend fun environmentClass(`value`: Output) {
this.environmentClass = value
}
/**
* @param value 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](https://docs.aws.amazon.com/mwaa/latest/userguide/mwaa-create-role.html) .
*/
@JvmName("hlorpjhefyxfmsnr")
public suspend fun executionRoleArn(`value`: Output) {
this.executionRoleArn = value
}
/**
* @param value The AWS Key Management Service (KMS) key to encrypt and decrypt the data in your environment. You can use an AWS KMS key managed by MWAA, or a customer-managed KMS key (advanced).
*/
@JvmName("iiyibrymneieimcm")
public suspend fun kmsKey(`value`: Output) {
this.kmsKey = value
}
/**
* @param value The Apache Airflow logs being sent to CloudWatch Logs: `DagProcessingLogs` , `SchedulerLogs` , `TaskLogs` , `WebserverLogs` , `WorkerLogs` .
*/
@JvmName("uvidqifvwqpahnof")
public suspend fun loggingConfiguration(`value`: Output) {
this.loggingConfiguration = value
}
/**
* @param value The maximum number of web servers that you want to run in your environment. Amazon MWAA scales the number of Apache Airflow web servers up to the number you specify for `MaxWebservers` when you interact with your Apache Airflow environment using Apache Airflow REST API, or the Apache Airflow CLI. For example, in scenarios where your workload requires network calls to the Apache Airflow REST API with a high transaction-per-second (TPS) rate, Amazon MWAA will increase the number of web servers up to the number set in `MaxWebserers` . As TPS rates decrease Amazon MWAA disposes of the additional web servers, and scales down to the number set in `MinxWebserers` .
* Valid values: Accepts between `2` and `5` . Defaults to `2` .
*/
@JvmName("rbxkddldwhlprymn")
public suspend fun maxWebservers(`value`: Output) {
this.maxWebservers = value
}
/**
* @param value 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` .
*/
@JvmName("akwsgvxctrlelipu")
public suspend fun maxWorkers(`value`: Output) {
this.maxWorkers = value
}
/**
* @param value The minimum number of web servers that you want to run in your environment. Amazon MWAA scales the number of Apache Airflow web servers up to the number you specify for `MaxWebservers` when you interact with your Apache Airflow environment using Apache Airflow REST API, or the Apache Airflow CLI. As the transaction-per-second rate, and the network load, decrease, Amazon MWAA disposes of the additional web servers, and scales down to the number set in `MinxWebserers` .
* Valid values: Accepts between `2` and `5` . Defaults to `2` .
*/
@JvmName("wktvctixaubsiimc")
public suspend fun minWebservers(`value`: Output) {
this.minWebservers = value
}
/**
* @param value 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` .
*/
@JvmName("bdhcctxcqwkgdbhm")
public suspend fun minWorkers(`value`: Output) {
this.minWorkers = value
}
/**
* @param value The name of your Amazon MWAA environment.
*/
@JvmName("qnxekhdfxcotvvga")
public suspend fun name(`value`: Output) {
this.name = value
}
/**
* @param value 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](https://docs.aws.amazon.com/mwaa/latest/userguide/networking-about.html) .
*/
@JvmName("mgnprfdjliwbfjet")
public suspend fun networkConfiguration(`value`: Output) {
this.networkConfiguration = value
}
/**
* @param value The version of the plugins.zip file on your Amazon S3 bucket. To learn more, see [Installing custom plugins](https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-dag-import-plugins.html) .
*/
@JvmName("dsoxwasvkdhucxhm")
public suspend fun pluginsS3ObjectVersion(`value`: Output) {
this.pluginsS3ObjectVersion = value
}
/**
* @param value The relative path to the `plugins.zip` file on your Amazon S3 bucket. For example, `plugins.zip` . To learn more, see [Installing custom plugins](https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-dag-import-plugins.html) .
*/
@JvmName("mtyxbyegpkemgxpp")
public suspend fun pluginsS3Path(`value`: Output) {
this.pluginsS3Path = value
}
/**
* @param value The version of the requirements.txt file on your Amazon S3 bucket. To learn more, see [Installing Python dependencies](https://docs.aws.amazon.com/mwaa/latest/userguide/working-dags-dependencies.html) .
*/
@JvmName("abrbvmgujasswupv")
public suspend fun requirementsS3ObjectVersion(`value`: Output) {
this.requirementsS3ObjectVersion = value
}
/**
* @param value The relative path to the `requirements.txt` file on your Amazon S3 bucket. For example, `requirements.txt` . To learn more, see [Installing Python dependencies](https://docs.aws.amazon.com/mwaa/latest/userguide/working-dags-dependencies.html) .
*/
@JvmName("pcpbbgsjelemfpyy")
public suspend fun requirementsS3Path(`value`: Output) {
this.requirementsS3Path = value
}
/**
* @param value The number of schedulers that you want to run in your environment. Valid values:
* - *v2* - Accepts between 2 to 5. Defaults to 2.
* - *v1* - Accepts 1.
*/
@JvmName("ovilixvxnkvidmju")
public suspend fun schedulers(`value`: Output) {
this.schedulers = value
}
/**
* @param value 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](https://docs.aws.amazon.com/mwaa/latest/userguide/mwaa-s3-bucket.html) .
*/
@JvmName("eaeeifptjswvdmet")
public suspend fun sourceBucketArn(`value`: Output) {
this.sourceBucketArn = value
}
/**
* @param value The version of the startup shell script in your Amazon S3 bucket. You must specify the [version ID](https://docs.aws.amazon.com/AmazonS3/latest/userguide/versioning-workflows.html) that Amazon S3 assigns to the file every time you update the script.
* Version IDs are Unicode, UTF-8 encoded, URL-ready, opaque strings that are no more than 1,024 bytes long. The following is an example:
* `3sL4kqtJlcpXroDTDmJ+rmSpXd3dIbrHY+MTRCxf3vjVBH40Nr8X8gdRQBpUMLUo`
* For more information, see [Using a startup script](https://docs.aws.amazon.com/mwaa/latest/userguide/using-startup-script.html) .
*/
@JvmName("qovdlswdhwhnpwkx")
public suspend fun startupScriptS3ObjectVersion(`value`: Output) {
this.startupScriptS3ObjectVersion = value
}
/**
* @param value The relative path to the startup shell script in your Amazon S3 bucket. For example, `s3://mwaa-environment/startup.sh` .
* Amazon MWAA runs the script as your environment starts, and before running the Apache Airflow process. You can use this script to install dependencies, modify Apache Airflow configuration options, and set environment variables. For more information, see [Using a startup script](https://docs.aws.amazon.com/mwaa/latest/userguide/using-startup-script.html) .
*/
@JvmName("wlahbugdhfkiwgdg")
public suspend fun startupScriptS3Path(`value`: Output) {
this.startupScriptS3Path = value
}
/**
* @param value A map of tags for the environment.
* Search the [CloudFormation User Guide](https://docs.aws.amazon.com/cloudformation/) for `AWS::MWAA::Environment` for more information about the expected schema for this property.
*/
@JvmName("xuuwngijvnxpsdly")
public suspend fun tags(`value`: Output) {
this.tags = value
}
/**
* @param value The Apache Airflow *Web server* access mode. To learn more, see [Apache Airflow access modes](https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-networking.html) . Valid values: `PRIVATE_ONLY` or `PUBLIC_ONLY` .
*/
@JvmName("vlatpjdfjehqgfym")
public suspend fun webserverAccessMode(`value`: Output) {
this.webserverAccessMode = value
}
/**
* @param value 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)
*/
@JvmName("daasbkulguvhvpqu")
public suspend fun weeklyMaintenanceWindowStart(`value`: Output) {
this.weeklyMaintenanceWindowStart = value
}
/**
* @param value Key/value pairs representing Airflow configuration variables.
* Keys are prefixed by their section:
* [core]
* dags_folder={AIRFLOW_HOME}/dags
* Would be represented as
* "core.dags_folder": "{AIRFLOW_HOME}/dags"
* Search the [CloudFormation User Guide](https://docs.aws.amazon.com/cloudformation/) for `AWS::MWAA::Environment` for more information about the expected schema for this property.
*/
@JvmName("tyjhprnbmkkijgld")
public suspend fun airflowConfigurationOptions(`value`: Any?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.airflowConfigurationOptions = mapped
}
/**
* @param value The version of Apache Airflow to use for the environment. If no value is specified, defaults to the latest version.
* If you specify a newer version number for an existing environment, the version update requires some service interruption before taking effect.
* *Allowed Values* : `1.10.12` | `2.0.2` | `2.2.2` | `2.4.3` | `2.5.1` | `2.6.3` | `2.7.2` | `2.8.1` | `2.9.2` (latest)
*/
@JvmName("nmoncppsrfovagau")
public suspend fun airflowVersion(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.airflowVersion = mapped
}
/**
* @param value The relative path to the DAGs folder on your Amazon S3 bucket. For example, `dags` . To learn more, see [Adding or updating DAGs](https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-dag-folder.html) .
*/
@JvmName("bcrjdmcrlijtbfvw")
public suspend fun dagS3Path(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.dagS3Path = mapped
}
/**
* @param value Defines whether the VPC endpoints configured for the environment are created, and managed, by the customer or by Amazon MWAA. If set to `SERVICE` , Amazon MWAA will create and manage the required VPC endpoints in your VPC. If set to `CUSTOMER` , you must create, and manage, the VPC endpoints in your VPC.
*/
@JvmName("xgrjdvuxqmxgdabx")
public suspend fun endpointManagement(`value`: EnvironmentEndpointManagement?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.endpointManagement = mapped
}
/**
* @param value The environment class type. Valid values: `mw1.small` , `mw1.medium` , `mw1.large` . To learn more, see [Amazon MWAA environment class](https://docs.aws.amazon.com/mwaa/latest/userguide/environment-class.html) .
*/
@JvmName("eetwnpykqlugakif")
public suspend fun environmentClass(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.environmentClass = mapped
}
/**
* @param value 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](https://docs.aws.amazon.com/mwaa/latest/userguide/mwaa-create-role.html) .
*/
@JvmName("okjbqhrmaqloexic")
public suspend fun executionRoleArn(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.executionRoleArn = mapped
}
/**
* @param value The AWS Key Management Service (KMS) key to encrypt and decrypt the data in your environment. You can use an AWS KMS key managed by MWAA, or a customer-managed KMS key (advanced).
*/
@JvmName("svxaowwjxkmanvtj")
public suspend fun kmsKey(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.kmsKey = mapped
}
/**
* @param value The Apache Airflow logs being sent to CloudWatch Logs: `DagProcessingLogs` , `SchedulerLogs` , `TaskLogs` , `WebserverLogs` , `WorkerLogs` .
*/
@JvmName("amaashtflqiupefn")
public suspend fun loggingConfiguration(`value`: EnvironmentLoggingConfigurationArgs?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.loggingConfiguration = mapped
}
/**
* @param argument The Apache Airflow logs being sent to CloudWatch Logs: `DagProcessingLogs` , `SchedulerLogs` , `TaskLogs` , `WebserverLogs` , `WorkerLogs` .
*/
@JvmName("vhguixewrqskyjsg")
public suspend fun loggingConfiguration(argument: suspend EnvironmentLoggingConfigurationArgsBuilder.() -> Unit) {
val toBeMapped = EnvironmentLoggingConfigurationArgsBuilder().applySuspend { argument() }.build()
val mapped = of(toBeMapped)
this.loggingConfiguration = mapped
}
/**
* @param value The maximum number of web servers that you want to run in your environment. Amazon MWAA scales the number of Apache Airflow web servers up to the number you specify for `MaxWebservers` when you interact with your Apache Airflow environment using Apache Airflow REST API, or the Apache Airflow CLI. For example, in scenarios where your workload requires network calls to the Apache Airflow REST API with a high transaction-per-second (TPS) rate, Amazon MWAA will increase the number of web servers up to the number set in `MaxWebserers` . As TPS rates decrease Amazon MWAA disposes of the additional web servers, and scales down to the number set in `MinxWebserers` .
* Valid values: Accepts between `2` and `5` . Defaults to `2` .
*/
@JvmName("csqbetkaabkwkdum")
public suspend fun maxWebservers(`value`: Int?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.maxWebservers = mapped
}
/**
* @param value 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` .
*/
@JvmName("ylgmnbtxigsgdtat")
public suspend fun maxWorkers(`value`: Int?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.maxWorkers = mapped
}
/**
* @param value The minimum number of web servers that you want to run in your environment. Amazon MWAA scales the number of Apache Airflow web servers up to the number you specify for `MaxWebservers` when you interact with your Apache Airflow environment using Apache Airflow REST API, or the Apache Airflow CLI. As the transaction-per-second rate, and the network load, decrease, Amazon MWAA disposes of the additional web servers, and scales down to the number set in `MinxWebserers` .
* Valid values: Accepts between `2` and `5` . Defaults to `2` .
*/
@JvmName("cesxnotmjncbjwrf")
public suspend fun minWebservers(`value`: Int?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.minWebservers = mapped
}
/**
* @param value 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` .
*/
@JvmName("xujrktlkskhngxml")
public suspend fun minWorkers(`value`: Int?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.minWorkers = mapped
}
/**
* @param value The name of your Amazon MWAA environment.
*/
@JvmName("tbynbknkxophlswm")
public suspend fun name(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.name = mapped
}
/**
* @param value 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](https://docs.aws.amazon.com/mwaa/latest/userguide/networking-about.html) .
*/
@JvmName("clefquiycaxwamux")
public suspend fun networkConfiguration(`value`: EnvironmentNetworkConfigurationArgs?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.networkConfiguration = mapped
}
/**
* @param argument 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](https://docs.aws.amazon.com/mwaa/latest/userguide/networking-about.html) .
*/
@JvmName("noaolscyidekelmn")
public suspend fun networkConfiguration(argument: suspend EnvironmentNetworkConfigurationArgsBuilder.() -> Unit) {
val toBeMapped = EnvironmentNetworkConfigurationArgsBuilder().applySuspend { argument() }.build()
val mapped = of(toBeMapped)
this.networkConfiguration = mapped
}
/**
* @param value The version of the plugins.zip file on your Amazon S3 bucket. To learn more, see [Installing custom plugins](https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-dag-import-plugins.html) .
*/
@JvmName("glbavmouvpabkjsv")
public suspend fun pluginsS3ObjectVersion(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.pluginsS3ObjectVersion = mapped
}
/**
* @param value The relative path to the `plugins.zip` file on your Amazon S3 bucket. For example, `plugins.zip` . To learn more, see [Installing custom plugins](https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-dag-import-plugins.html) .
*/
@JvmName("xetlxxvuqfitnrlj")
public suspend fun pluginsS3Path(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.pluginsS3Path = mapped
}
/**
* @param value The version of the requirements.txt file on your Amazon S3 bucket. To learn more, see [Installing Python dependencies](https://docs.aws.amazon.com/mwaa/latest/userguide/working-dags-dependencies.html) .
*/
@JvmName("bpdcymlnvfufhytb")
public suspend fun requirementsS3ObjectVersion(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.requirementsS3ObjectVersion = mapped
}
/**
* @param value The relative path to the `requirements.txt` file on your Amazon S3 bucket. For example, `requirements.txt` . To learn more, see [Installing Python dependencies](https://docs.aws.amazon.com/mwaa/latest/userguide/working-dags-dependencies.html) .
*/
@JvmName("bgnukdqoflpondpv")
public suspend fun requirementsS3Path(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.requirementsS3Path = mapped
}
/**
* @param value The number of schedulers that you want to run in your environment. Valid values:
* - *v2* - Accepts between 2 to 5. Defaults to 2.
* - *v1* - Accepts 1.
*/
@JvmName("hibhogkppkhcabat")
public suspend fun schedulers(`value`: Int?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.schedulers = mapped
}
/**
* @param value 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](https://docs.aws.amazon.com/mwaa/latest/userguide/mwaa-s3-bucket.html) .
*/
@JvmName("davxdjbtlholrkcd")
public suspend fun sourceBucketArn(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.sourceBucketArn = mapped
}
/**
* @param value The version of the startup shell script in your Amazon S3 bucket. You must specify the [version ID](https://docs.aws.amazon.com/AmazonS3/latest/userguide/versioning-workflows.html) that Amazon S3 assigns to the file every time you update the script.
* Version IDs are Unicode, UTF-8 encoded, URL-ready, opaque strings that are no more than 1,024 bytes long. The following is an example:
* `3sL4kqtJlcpXroDTDmJ+rmSpXd3dIbrHY+MTRCxf3vjVBH40Nr8X8gdRQBpUMLUo`
* For more information, see [Using a startup script](https://docs.aws.amazon.com/mwaa/latest/userguide/using-startup-script.html) .
*/
@JvmName("tumvvcaejorubjtp")
public suspend fun startupScriptS3ObjectVersion(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.startupScriptS3ObjectVersion = mapped
}
/**
* @param value The relative path to the startup shell script in your Amazon S3 bucket. For example, `s3://mwaa-environment/startup.sh` .
* Amazon MWAA runs the script as your environment starts, and before running the Apache Airflow process. You can use this script to install dependencies, modify Apache Airflow configuration options, and set environment variables. For more information, see [Using a startup script](https://docs.aws.amazon.com/mwaa/latest/userguide/using-startup-script.html) .
*/
@JvmName("ssmwqollbybocahk")
public suspend fun startupScriptS3Path(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.startupScriptS3Path = mapped
}
/**
* @param value A map of tags for the environment.
* Search the [CloudFormation User Guide](https://docs.aws.amazon.com/cloudformation/) for `AWS::MWAA::Environment` for more information about the expected schema for this property.
*/
@JvmName("iyybbruukhjsqhld")
public suspend fun tags(`value`: Any?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.tags = mapped
}
/**
* @param value The Apache Airflow *Web server* access mode. To learn more, see [Apache Airflow access modes](https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-networking.html) . Valid values: `PRIVATE_ONLY` or `PUBLIC_ONLY` .
*/
@JvmName("glepyfbewyfsumww")
public suspend fun webserverAccessMode(`value`: EnvironmentWebserverAccessMode?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.webserverAccessMode = mapped
}
/**
* @param value 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)
*/
@JvmName("phvrhhtiwayiourx")
public suspend fun weeklyMaintenanceWindowStart(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.weeklyMaintenanceWindowStart = mapped
}
internal fun build(): EnvironmentArgs = EnvironmentArgs(
airflowConfigurationOptions = airflowConfigurationOptions,
airflowVersion = airflowVersion,
dagS3Path = dagS3Path,
endpointManagement = endpointManagement,
environmentClass = environmentClass,
executionRoleArn = executionRoleArn,
kmsKey = kmsKey,
loggingConfiguration = loggingConfiguration,
maxWebservers = maxWebservers,
maxWorkers = maxWorkers,
minWebservers = minWebservers,
minWorkers = minWorkers,
name = name,
networkConfiguration = networkConfiguration,
pluginsS3ObjectVersion = pluginsS3ObjectVersion,
pluginsS3Path = pluginsS3Path,
requirementsS3ObjectVersion = requirementsS3ObjectVersion,
requirementsS3Path = requirementsS3Path,
schedulers = schedulers,
sourceBucketArn = sourceBucketArn,
startupScriptS3ObjectVersion = startupScriptS3ObjectVersion,
startupScriptS3Path = startupScriptS3Path,
tags = tags,
webserverAccessMode = webserverAccessMode,
weeklyMaintenanceWindowStart = weeklyMaintenanceWindowStart,
)
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy