Interface CfnEnvironmentProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnEnvironmentProps.Jsii$Proxy
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()) .maxWebservers(123) .maxWorkers(123) .minWebservers(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 ClassesModifier and TypeInterfaceDescriptionstatic final class
A builder forCfnEnvironmentProps
static final class
An implementation forCfnEnvironmentProps
-
Method Summary
Modifier and TypeMethodDescriptionstatic CfnEnvironmentProps.Builder
builder()
default Object
A list of key-value pairs containing the Airflow configuration options for your environment.default String
The version of Apache Airflow to use for the environment.default String
The relative path to the DAGs folder on your Amazon S3 bucket.default String
Defines whether the VPC endpoints configured for the environment are created, and managed, by the customer or by Amazon MWAA.default String
The environment class type.default String
The Amazon Resource Name (ARN) of the execution role in IAM that allows MWAA to access AWS resources in your environment.default String
The AWS Key Management Service (KMS) key to encrypt and decrypt the data in your environment.default Object
The Apache Airflow logs being sent to CloudWatch Logs:DagProcessingLogs
,SchedulerLogs
,TaskLogs
,WebserverLogs
,WorkerLogs
.default Number
The maximum number of web servers that you want to run in your environment.default Number
The maximum number of workers that you want to run in your environment.default Number
The minimum number of web servers that you want to run in your environment.default Number
The minimum number of workers that you want to run in your environment.getName()
The name of your Amazon MWAA environment.default Object
The VPC networking components used to secure and enable network traffic between the AWS resources for your environment.default String
The version of the plugins.zip file on your Amazon S3 bucket.default String
The relative path to theplugins.zip
file on your Amazon S3 bucket.default String
The version of the requirements.txt file on your Amazon S3 bucket.default String
The relative path to therequirements.txt
file on your Amazon S3 bucket.default Number
The number of schedulers that you want to run in your environment.default String
The Amazon Resource Name (ARN) of the Amazon S3 bucket where your DAG code and supporting files are stored.default String
The version of the startup shell script in your Amazon S3 bucket.default String
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
The Apache Airflow Web server access mode.default String
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
The name of your Amazon MWAA environment.- See Also:
-
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:
-
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
|2.8.1
|2.9.2
(latest)- See Also:
-
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:
-
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 toCUSTOMER
, you must create, and manage, the VPC endpoints in your VPC.- See Also:
-
getEnvironmentClass
The environment class type.Valid values:
mw1.small
,mw1.medium
,mw1.large
. To learn more, see Amazon MWAA environment class .- See Also:
-
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:
-
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:
-
getLoggingConfiguration
The Apache Airflow logs being sent to CloudWatch Logs:DagProcessingLogs
,SchedulerLogs
,TaskLogs
,WebserverLogs
,WorkerLogs
.- See Also:
-
getMaxWebservers
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 inMaxWebserers
. As TPS rates decrease Amazon MWAA disposes of the additional web servers, and scales down to the number set inMinxWebserers
.Valid values: Accepts between
2
and5
. Defaults to2
.- See Also:
-
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 inMinWorkers
.- See Also:
-
getMinWebservers
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 inMinxWebserers
.Valid values: Accepts between
2
and5
. Defaults to2
.- See Also:
-
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 theMinWorkers
field. For example,2
.- See Also:
-
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:
-
getPluginsS3ObjectVersion
The version of the plugins.zip file on your Amazon S3 bucket. To learn more, see Installing custom plugins .- See Also:
-
getPluginsS3Path
The relative path to theplugins.zip
file on your Amazon S3 bucket. For example,plugins.zip
. To learn more, see Installing custom plugins .- See Also:
-
getRequirementsS3ObjectVersion
The version of the requirements.txt file on your Amazon S3 bucket. To learn more, see Installing Python dependencies .- See Also:
-
getRequirementsS3Path
The relative path to therequirements.txt
file on your Amazon S3 bucket. For example,requirements.txt
. To learn more, see Installing Python dependencies .- See Also:
-
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:
-
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:
-
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:
-
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:
-
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:
-
getWebserverAccessMode
The Apache Airflow Web server access mode.To learn more, see Apache Airflow access modes . Valid values:
PRIVATE_ONLY
orPUBLIC_ONLY
.- See Also:
-
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:
-
builder
- Returns:
- a
CfnEnvironmentProps.Builder
ofCfnEnvironmentProps
-