All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.pulumi.awsnative.mwaa.kotlin.outputs.GetEnvironmentResult.kt Maven / Gradle / Ivy

Go to download

Build cloud applications and infrastructure by combining the safety and reliability of infrastructure as code with the power of the Kotlin programming language.

There is a newer version: 1.11.0.0
Show newest version
@file:Suppress("NAME_SHADOWING", "DEPRECATION")

package com.pulumi.awsnative.mwaa.kotlin.outputs

import com.pulumi.awsnative.mwaa.kotlin.enums.EnvironmentWebserverAccessMode
import kotlin.Any
import kotlin.Int
import kotlin.String
import kotlin.Suppress

/**
 *
 * @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 arn The ARN for the Amazon MWAA environment.
 * @property celeryExecutorQueue The queue ARN for the environment's [Celery Executor](https://docs.aws.amazon.com/https://airflow.apache.org/docs/apache-airflow/stable/core-concepts/executor/celery.html) . Amazon MWAA uses a Celery Executor to distribute tasks across multiple workers. When you create an environment in a shared VPC, you must provide access to the Celery Executor queue from your VPC.
 * @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 databaseVpcEndpointService The VPC endpoint for the environment's Amazon RDS database.
 * @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 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 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 webserverUrl The URL of your Apache Airflow UI.
 * @property webserverVpcEndpointService The VPC endpoint for the environment's web server.
 * @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 GetEnvironmentResult(
    public val airflowConfigurationOptions: Any? = null,
    public val airflowVersion: String? = null,
    public val arn: String? = null,
    public val celeryExecutorQueue: String? = null,
    public val dagS3Path: String? = null,
    public val databaseVpcEndpointService: String? = null,
    public val environmentClass: String? = null,
    public val executionRoleArn: String? = null,
    public val loggingConfiguration: EnvironmentLoggingConfiguration? = null,
    public val maxWebservers: Int? = null,
    public val maxWorkers: Int? = null,
    public val minWebservers: Int? = null,
    public val minWorkers: Int? = null,
    public val networkConfiguration: EnvironmentNetworkConfiguration? = null,
    public val pluginsS3ObjectVersion: String? = null,
    public val pluginsS3Path: String? = null,
    public val requirementsS3ObjectVersion: String? = null,
    public val requirementsS3Path: String? = null,
    public val schedulers: Int? = null,
    public val sourceBucketArn: String? = null,
    public val startupScriptS3ObjectVersion: String? = null,
    public val startupScriptS3Path: String? = null,
    public val tags: Any? = null,
    public val webserverAccessMode: EnvironmentWebserverAccessMode? = null,
    public val webserverUrl: String? = null,
    public val webserverVpcEndpointService: String? = null,
    public val weeklyMaintenanceWindowStart: String? = null,
) {
    public companion object {
        public fun toKotlin(javaType: com.pulumi.awsnative.mwaa.outputs.GetEnvironmentResult): GetEnvironmentResult = GetEnvironmentResult(
            airflowConfigurationOptions = javaType.airflowConfigurationOptions().map({ args0 ->
                args0
            }).orElse(null),
            airflowVersion = javaType.airflowVersion().map({ args0 -> args0 }).orElse(null),
            arn = javaType.arn().map({ args0 -> args0 }).orElse(null),
            celeryExecutorQueue = javaType.celeryExecutorQueue().map({ args0 -> args0 }).orElse(null),
            dagS3Path = javaType.dagS3Path().map({ args0 -> args0 }).orElse(null),
            databaseVpcEndpointService = javaType.databaseVpcEndpointService().map({ args0 ->
                args0
            }).orElse(null),
            environmentClass = javaType.environmentClass().map({ args0 -> args0 }).orElse(null),
            executionRoleArn = javaType.executionRoleArn().map({ args0 -> args0 }).orElse(null),
            loggingConfiguration = javaType.loggingConfiguration().map({ args0 ->
                args0.let({ args0 ->
                    com.pulumi.awsnative.mwaa.kotlin.outputs.EnvironmentLoggingConfiguration.Companion.toKotlin(args0)
                })
            }).orElse(null),
            maxWebservers = javaType.maxWebservers().map({ args0 -> args0 }).orElse(null),
            maxWorkers = javaType.maxWorkers().map({ args0 -> args0 }).orElse(null),
            minWebservers = javaType.minWebservers().map({ args0 -> args0 }).orElse(null),
            minWorkers = javaType.minWorkers().map({ args0 -> args0 }).orElse(null),
            networkConfiguration = javaType.networkConfiguration().map({ args0 ->
                args0.let({ args0 ->
                    com.pulumi.awsnative.mwaa.kotlin.outputs.EnvironmentNetworkConfiguration.Companion.toKotlin(args0)
                })
            }).orElse(null),
            pluginsS3ObjectVersion = javaType.pluginsS3ObjectVersion().map({ args0 -> args0 }).orElse(null),
            pluginsS3Path = javaType.pluginsS3Path().map({ args0 -> args0 }).orElse(null),
            requirementsS3ObjectVersion = javaType.requirementsS3ObjectVersion().map({ args0 ->
                args0
            }).orElse(null),
            requirementsS3Path = javaType.requirementsS3Path().map({ args0 -> args0 }).orElse(null),
            schedulers = javaType.schedulers().map({ args0 -> args0 }).orElse(null),
            sourceBucketArn = javaType.sourceBucketArn().map({ args0 -> args0 }).orElse(null),
            startupScriptS3ObjectVersion = javaType.startupScriptS3ObjectVersion().map({ args0 ->
                args0
            }).orElse(null),
            startupScriptS3Path = javaType.startupScriptS3Path().map({ args0 -> args0 }).orElse(null),
            tags = javaType.tags().map({ args0 -> args0 }).orElse(null),
            webserverAccessMode = javaType.webserverAccessMode().map({ args0 ->
                args0.let({ args0 ->
                    com.pulumi.awsnative.mwaa.kotlin.enums.EnvironmentWebserverAccessMode.Companion.toKotlin(args0)
                })
            }).orElse(null),
            webserverUrl = javaType.webserverUrl().map({ args0 -> args0 }).orElse(null),
            webserverVpcEndpointService = javaType.webserverVpcEndpointService().map({ args0 ->
                args0
            }).orElse(null),
            weeklyMaintenanceWindowStart = javaType.weeklyMaintenanceWindowStart().map({ args0 ->
                args0
            }).orElse(null),
        )
    }
}




© 2015 - 2024 Weber Informatics LLC | Privacy Policy