All Superinterfaces:: software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:: CfnEnvironmentProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)", date="2024-05-08T21:35:10.066Z") @Stability(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")
         .endpointManagement("endpointManagement")
         .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")
         .startupScriptS3ObjectVersion("startupScriptS3ObjectVersion")
         .startupScriptS3Path("startupScriptS3Path")
         .tags(tags)
         .webserverAccessMode("webserverAccessMode")
         .weeklyMaintenanceWindowStart("weeklyMaintenanceWindowStart")
         .build();

See Also:

Nested Class Summary

Nested Classes

Modifier and Type

Interface

Description

static final class

CfnEnvironmentProps.Builder

A builder for CfnEnvironmentProps

static final class

CfnEnvironmentProps.Jsii$Proxy

An implementation for CfnEnvironmentProps
Method Summary

Modifier and Type

Method

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

getEndpointManagement()

Defines whether the VPC endpoints configured for the environment are created, and managed, by the customer or by Amazon MWAA.

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 String

getStartupScriptS3ObjectVersion()

The version of the startup shell script in your Amazon S3 bucket.

default String

getStartupScriptS3Path()

The relative path to the startup shell script in your Amazon S3 bucket.

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 Details
- getName
  
  @Stability(Stable) @NotNull String getName()
  
  The name of your Amazon MWAA environment.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaa-environment.html#cfn-mwaa-environment-name
- getAirflowConfigurationOptions
  
  @Stability(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 .
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaa-environment.html#cfn-mwaa-environment-airflowconfigurationoptions
- getAirflowVersion
  
  @Stability(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.
  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 (latest)
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaa-environment.html#cfn-mwaa-environment-airflowversion
- getDagS3Path
  
  @Stability(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 .
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaa-environment.html#cfn-mwaa-environment-dags3path
- getEndpointManagement
  
  @Stability(Stable) @Nullable default String getEndpointManagement()
  
  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.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaa-environment.html#cfn-mwaa-environment-endpointmanagement
- getEnvironmentClass
  
  @Stability(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 .
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaa-environment.html#cfn-mwaa-environment-environmentclass
- getExecutionRoleArn
  
  @Stability(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 .
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaa-environment.html#cfn-mwaa-environment-executionrolearn
- getKmsKey
  
  @Stability(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).
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaa-environment.html#cfn-mwaa-environment-kmskey
- getLoggingConfiguration
  
  @Stability(Stable) @Nullable default Object getLoggingConfiguration()
  
  The Apache Airflow logs being sent to CloudWatch Logs: DagProcessingLogs , SchedulerLogs , TaskLogs , WebserverLogs , WorkerLogs .
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaa-environment.html#cfn-mwaa-environment-loggingconfiguration
- getMaxWorkers
  
  @Stability(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 .
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaa-environment.html#cfn-mwaa-environment-maxworkers
- getMinWorkers
  
  @Stability(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 .
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaa-environment.html#cfn-mwaa-environment-minworkers
- getNetworkConfiguration
  
  @Stability(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 .
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaa-environment.html#cfn-mwaa-environment-networkconfiguration
- getPluginsS3ObjectVersion
  
  @Stability(Stable) @Nullable default String getPluginsS3ObjectVersion()
  
  The version of the plugins.zip file on your Amazon S3 bucket. To learn more, see Installing custom plugins .
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaa-environment.html#cfn-mwaa-environment-pluginss3objectversion
- getPluginsS3Path
  
  @Stability(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 .
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaa-environment.html#cfn-mwaa-environment-pluginss3path
- getRequirementsS3ObjectVersion
  
  @Stability(Stable) @Nullable default String getRequirementsS3ObjectVersion()
  
  The version of the requirements.txt file on your Amazon S3 bucket. To learn more, see Installing Python dependencies .
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaa-environment.html#cfn-mwaa-environment-requirementss3objectversion
- getRequirementsS3Path
  
  @Stability(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 .
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaa-environment.html#cfn-mwaa-environment-requirementss3path
- getSchedulers
  
  @Stability(Stable) @Nullable default Number getSchedulers()
  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.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaa-environment.html#cfn-mwaa-environment-schedulers
- getSourceBucketArn
  
  @Stability(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 .
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaa-environment.html#cfn-mwaa-environment-sourcebucketarn
- getStartupScriptS3ObjectVersion
  
  @Stability(Stable) @Nullable default String getStartupScriptS3ObjectVersion()
  
  The version of the startup shell script in your Amazon S3 bucket.
  You must specify the version ID 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 .
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaa-environment.html#cfn-mwaa-environment-startupscripts3objectversion
- getStartupScriptS3Path
  
  @Stability(Stable) @Nullable default String getStartupScriptS3Path()
  
  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 .
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaa-environment.html#cfn-mwaa-environment-startupscripts3path
- getTags
  
  @Stability(Stable) @Nullable default Object getTags()
  
  The key-value tag pairs associated to your environment. For example, "Environment": "Staging" . To learn more, see Tagging .
  If you specify new tags for an existing environment, the update requires service interruption before taking effect.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaa-environment.html#cfn-mwaa-environment-tags
- getWebserverAccessMode
  
  @Stability(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 .
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaa-environment.html#cfn-mwaa-environment-webserveraccessmode
- getWeeklyMaintenanceWindowStart
  
  @Stability(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)
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaa-environment.html#cfn-mwaa-environment-weeklymaintenancewindowstart
- builder
  
  @Stability(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 Details

getName

getAirflowConfigurationOptions

getAirflowVersion

getDagS3Path

getEndpointManagement

getEnvironmentClass

getExecutionRoleArn

getKmsKey

getLoggingConfiguration

getMaxWorkers

getMinWorkers

getNetworkConfiguration

getPluginsS3ObjectVersion

getPluginsS3Path

getRequirementsS3ObjectVersion

getRequirementsS3Path

getSchedulers

getSourceBucketArn

getStartupScriptS3ObjectVersion

getStartupScriptS3Path

getTags

getWebserverAccessMode

getWeeklyMaintenanceWindowStart

builder