CfnEnvironmentProps (software.amazon.awscdk:aws-cdk-lib 2.42.1 API)

All Superinterfaces:: software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:: CfnEnvironmentProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:41.000Z")
 @Stability(value=Stable)
public interface CfnEnvironmentProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a `CfnEnvironment`.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.mwaa.*;
 Object airflowConfigurationOptions;
 Object tags;
 CfnEnvironmentProps cfnEnvironmentProps = CfnEnvironmentProps.builder()
         .name("name")
         // the properties below are optional
         .airflowConfigurationOptions(airflowConfigurationOptions)
         .airflowVersion("airflowVersion")
         .dagS3Path("dagS3Path")
         .environmentClass("environmentClass")
         .executionRoleArn("executionRoleArn")
         .kmsKey("kmsKey")
         .loggingConfiguration(LoggingConfigurationProperty.builder()
                 .dagProcessingLogs(ModuleLoggingConfigurationProperty.builder()
                         .cloudWatchLogGroupArn("cloudWatchLogGroupArn")
                         .enabled(false)
                         .logLevel("logLevel")
                         .build())
                 .schedulerLogs(ModuleLoggingConfigurationProperty.builder()
                         .cloudWatchLogGroupArn("cloudWatchLogGroupArn")
                         .enabled(false)
                         .logLevel("logLevel")
                         .build())
                 .taskLogs(ModuleLoggingConfigurationProperty.builder()
                         .cloudWatchLogGroupArn("cloudWatchLogGroupArn")
                         .enabled(false)
                         .logLevel("logLevel")
                         .build())
                 .webserverLogs(ModuleLoggingConfigurationProperty.builder()
                         .cloudWatchLogGroupArn("cloudWatchLogGroupArn")
                         .enabled(false)
                         .logLevel("logLevel")
                         .build())
                 .workerLogs(ModuleLoggingConfigurationProperty.builder()
                         .cloudWatchLogGroupArn("cloudWatchLogGroupArn")
                         .enabled(false)
                         .logLevel("logLevel")
                         .build())
                 .build())
         .maxWorkers(123)
         .minWorkers(123)
         .networkConfiguration(NetworkConfigurationProperty.builder()
                 .securityGroupIds(List.of("securityGroupIds"))
                 .subnetIds(List.of("subnetIds"))
                 .build())
         .pluginsS3ObjectVersion("pluginsS3ObjectVersion")
         .pluginsS3Path("pluginsS3Path")
         .requirementsS3ObjectVersion("requirementsS3ObjectVersion")
         .requirementsS3Path("requirementsS3Path")
         .schedulers(123)
         .sourceBucketArn("sourceBucketArn")
         .tags(tags)
         .webserverAccessMode("webserverAccessMode")
         .weeklyMaintenanceWindowStart("weeklyMaintenanceWindowStart")
         .build();

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static class`	`CfnEnvironmentProps.Builder` A builder for `CfnEnvironmentProps`
`static class`	`CfnEnvironmentProps.Jsii$Proxy` An implementation for `CfnEnvironmentProps`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`static CfnEnvironmentProps.Builder`	`builder()`
`default Object`	`getAirflowConfigurationOptions()` A list of key-value pairs containing the Airflow configuration options for your environment.
`default String`	`getAirflowVersion()` The version of Apache Airflow to use for the environment.
`default String`	`getDagS3Path()` The relative path to the DAGs folder on your Amazon S3 bucket.
`default String`	`getEnvironmentClass()` The environment class type.
`default String`	`getExecutionRoleArn()` The Amazon Resource Name (ARN) of the execution role in IAM that allows MWAA to access AWS resources in your environment.
`default String`	`getKmsKey()` The AWS Key Management Service (KMS) key to encrypt and decrypt the data in your environment.
`default Object`	`getLoggingConfiguration()` The Apache Airflow logs being sent to CloudWatch Logs: `DagProcessingLogs` , `SchedulerLogs` , `TaskLogs` , `WebserverLogs` , `WorkerLogs` .
`default Number`	`getMaxWorkers()` The maximum number of workers that you want to run in your environment.
`default Number`	`getMinWorkers()` The minimum number of workers that you want to run in your environment.
`String`	`getName()` The name of your Amazon MWAA environment.
`default Object`	`getNetworkConfiguration()` The VPC networking components used to secure and enable network traffic between the AWS resources for your environment.
`default String`	`getPluginsS3ObjectVersion()` The version of the plugins.zip file on your Amazon S3 bucket.
`default String`	`getPluginsS3Path()` The relative path to the `plugins.zip` file on your Amazon S3 bucket.
`default String`	`getRequirementsS3ObjectVersion()` The version of the requirements.txt file on your Amazon S3 bucket.
`default String`	`getRequirementsS3Path()` The relative path to the `requirements.txt` file on your Amazon S3 bucket.
`default Number`	`getSchedulers()` The number of schedulers that you want to run in your environment.
`default String`	`getSourceBucketArn()` The Amazon Resource Name (ARN) of the Amazon S3 bucket where your DAG code and supporting files are stored.
`default Object`	`getTags()` The key-value tag pairs associated to your environment.
`default String`	`getWebserverAccessMode()` The Apache Airflow Web server access mode.
`default String`	`getWeeklyMaintenanceWindowStart()` The day and time of the week to start weekly maintenance updates of your environment in the following format: `DAY:HH:MM` .

Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson

- Method Detail
  - getName
```
@Stability(value=Stable)
 @NotNull
String getName()
```
    The name of your Amazon MWAA environment.
  - getAirflowConfigurationOptions
```
@Stability(value=Stable)
 @Nullable
default Object getAirflowConfigurationOptions()
```
    A list of key-value pairs containing the Airflow configuration options for your environment.
    For example, core.default_timezone: utc . To learn more, see Apache Airflow configuration options .
  - getAirflowVersion
```
@Stability(value=Stable)
 @Nullable
default String getAirflowVersion()
```
    The version of Apache Airflow to use for the environment.
    If no value is specified, defaults to the latest version. Valid values: 2.0.2 , 1.10.12 .
  - getDagS3Path
```
@Stability(value=Stable)
 @Nullable
default String getDagS3Path()
```
    The relative path to the DAGs folder on your Amazon S3 bucket.
    For example, dags . To learn more, see Adding or updating DAGs .
  - getEnvironmentClass
```
@Stability(value=Stable)
 @Nullable
default String getEnvironmentClass()
```
    The environment class type.
    Valid values: mw1.small , mw1.medium , mw1.large . To learn more, see Amazon MWAA environment class .
  - getExecutionRoleArn
```
@Stability(value=Stable)
 @Nullable
default String getExecutionRoleArn()
```
    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 .
  - getKmsKey
```
@Stability(value=Stable)
 @Nullable
default String getKmsKey()
```
    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).
  - getLoggingConfiguration
```
@Stability(value=Stable)
 @Nullable
default Object getLoggingConfiguration()
```
    The Apache Airflow logs being sent to CloudWatch Logs: `DagProcessingLogs` , `SchedulerLogs` , `TaskLogs` , `WebserverLogs` , `WorkerLogs` .
  - getMaxWorkers
```
@Stability(value=Stable)
 @Nullable
default Number getMaxWorkers()
```
    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 .
  - getMinWorkers
```
@Stability(value=Stable)
 @Nullable
default Number getMinWorkers()
```
    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 .
  - getNetworkConfiguration
```
@Stability(value=Stable)
 @Nullable
default Object getNetworkConfiguration()
```
    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 .
  - getPluginsS3ObjectVersion
```
@Stability(value=Stable)
 @Nullable
default String getPluginsS3ObjectVersion()
```
    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) .
  - getPluginsS3Path
```
@Stability(value=Stable)
 @Nullable
default String getPluginsS3Path()
```
    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) .
  - getRequirementsS3ObjectVersion
```
@Stability(value=Stable)
 @Nullable
default String getRequirementsS3ObjectVersion()
```
    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) .
  - getRequirementsS3Path
```
@Stability(value=Stable)
 @Nullable
default String getRequirementsS3Path()
```
    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) .
  - getSchedulers
```
@Stability(value=Stable)
 @Nullable
default Number getSchedulers()
```
    The number of schedulers that you want to run in your environment. Valid values:.
    - v2.0.2 - Accepts between 2 to 5. Defaults to 2.
    - v1.10.12 - Accepts 1.
  - getSourceBucketArn
```
@Stability(value=Stable)
 @Nullable
default String getSourceBucketArn()
```
    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 .
  - getTags
```
@Stability(value=Stable)
 @Nullable
default Object getTags()
```
    The key-value tag pairs associated to your environment.
    For example, "Environment": "Staging" . To learn more, see Tagging .
  - getWebserverAccessMode
```
@Stability(value=Stable)
 @Nullable
default String getWebserverAccessMode()
```
    The Apache Airflow *Web server* access mode.
    To learn more, see Apache Airflow access modes . Valid values: PRIVATE_ONLY or PUBLIC_ONLY .
  - getWeeklyMaintenanceWindowStart
```
@Stability(value=Stable)
 @Nullable
default String getWeeklyMaintenanceWindowStart()
```
    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)
  - builder
```
@Stability(value=Stable)
static CfnEnvironmentProps.Builder builder()
```
    Returns:
    
    a CfnEnvironmentProps.Builder of CfnEnvironmentProps

Interface CfnEnvironmentProps

Nested Class Summary

Method Summary

Methods inherited from interface software.amazon.jsii.JsiiSerializable

Method Detail

getName

getAirflowConfigurationOptions

getAirflowVersion

getDagS3Path

getEnvironmentClass

getExecutionRoleArn

getKmsKey

getLoggingConfiguration

getMaxWorkers

getMinWorkers

getNetworkConfiguration

getPluginsS3ObjectVersion

getPluginsS3Path

getRequirementsS3ObjectVersion

getRequirementsS3Path

getSchedulers

getSourceBucketArn

getTags

getWebserverAccessMode

getWeeklyMaintenanceWindowStart

builder