Class: AWSCDK::MWAA::CfnEnvironmentProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
mwaa/cfn_environment_props.rb

Overview

Properties for defining a CfnEnvironment.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name:, airflow_configuration_options: nil, airflow_version: nil, dag_s3_path: nil, endpoint_management: nil, environment_class: nil, execution_role_arn: nil, kms_key: nil, logging_configuration: nil, max_webservers: nil, max_workers: nil, min_webservers: nil, min_workers: nil, network_configuration: nil, plugins_s3_object_version: nil, plugins_s3_path: nil, requirements_s3_object_version: nil, requirements_s3_path: nil, schedulers: nil, source_bucket_arn: nil, startup_script_s3_object_version: nil, startup_script_s3_path: nil, tags: nil, webserver_access_mode: nil, weekly_maintenance_window_start: nil, worker_replacement_strategy: nil) ⇒ CfnEnvironmentProps

Returns a new instance of CfnEnvironmentProps.

Parameters:

  • name (String) —

    The name of your Amazon MWAA environment.

  • airflow_configuration_options (Object, nil) (defaults to: nil) —

    A list of key-value pairs containing the Airflow configuration options for your environment.

  • airflow_version (String, nil) (defaults to: nil) —

    The version of Apache Airflow to use for the environment.

  • dag_s3_path (String, nil) (defaults to: nil) —

    The relative path to the DAGs folder on your Amazon S3 bucket.

  • endpoint_management (String, nil) (defaults to: nil) —

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

  • environment_class (String, nil) (defaults to: nil) —

    The environment class type.

  • execution_role_arn (String, AWSCDK::Interfaces::AWSIAM::IRoleRef, nil) (defaults to: nil) —

    The Amazon Resource Name (ARN) of the execution role in IAM that allows MWAA to access AWS resources in your environment.

  • kms_key (String, AWSCDK::Interfaces::AWSKMS::IKeyRef, nil) (defaults to: nil) —

    The AWS Key Management Service (KMS) key to encrypt and decrypt the data in your environment.

  • logging_configuration (AWSCDK::IResolvable, AWSCDK::MWAA::CfnEnvironment::LoggingConfigurationProperty, nil) (defaults to: nil) —

    The Apache Airflow logs being sent to CloudWatch Logs: DagProcessingLogs , SchedulerLogs , TaskLogs , WebserverLogs , WorkerLogs .

  • max_webservers (Numeric, nil) (defaults to: nil) —

    The maximum number of web servers that you want to run in your environment.

  • max_workers (Numeric, nil) (defaults to: nil) —

    The maximum number of workers that you want to run in your environment.

  • min_webservers (Numeric, nil) (defaults to: nil) —

    The minimum number of web servers that you want to run in your environment.

  • min_workers (Numeric, nil) (defaults to: nil) —

    The minimum number of workers that you want to run in your environment.

  • network_configuration (AWSCDK::IResolvable, AWSCDK::MWAA::CfnEnvironment::NetworkConfigurationProperty, nil) (defaults to: nil) —

    The VPC networking components used to secure and enable network traffic between the AWS resources for your environment.

  • plugins_s3_object_version (String, nil) (defaults to: nil) —

    The version of the plugins.zip file on your Amazon S3 bucket. To learn more, see Installing custom plugins .

  • plugins_s3_path (String, nil) (defaults to: nil) —

    The relative path to the plugins.zip file on your Amazon S3 bucket. For example, plugins.zip . To learn more, see Installing custom plugins .

  • requirements_s3_object_version (String, nil) (defaults to: nil) —

    The version of the requirements.txt file on your Amazon S3 bucket. To learn more, see Installing Python dependencies .

  • requirements_s3_path (String, nil) (defaults to: nil) —

    The relative path to the requirements.txt file on your Amazon S3 bucket. For example, requirements.txt . To learn more, see Installing Python dependencies .

  • schedulers (Numeric, nil) (defaults to: nil) —

    The number of schedulers that you want to run in your environment. Valid values:.

  • source_bucket_arn (String, AWSCDK::Interfaces::AWSS3::IBucketRef, nil) (defaults to: nil) —

    The Amazon Resource Name (ARN) of the Amazon S3 bucket where your DAG code and supporting files are stored.

  • startup_script_s3_object_version (String, nil) (defaults to: nil) —

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

  • startup_script_s3_path (String, nil) (defaults to: nil) —

    The relative path to the startup shell script in your Amazon S3 bucket. For example, s3://mwaa-environment/startup.sh .

  • tags (Object, nil) (defaults to: nil) —

    The key-value tag pairs associated to your environment. For example, "Environment": "Staging" . To learn more, see Tagging .

  • webserver_access_mode (String, nil) (defaults to: nil) —

    The Apache Airflow Web server access mode.

  • weekly_maintenance_window_start (String, nil) (defaults to: nil) —

    The day and time of the week to start weekly maintenance updates of your environment in the following format: DAY:HH:MM .

  • worker_replacement_strategy (String, nil) (defaults to: nil) —

    The worker replacement strategy to use when updating the environment.



35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'mwaa/cfn_environment_props.rb', line 35

def initialize(name:, airflow_configuration_options: nil, airflow_version: nil, dag_s3_path: nil, endpoint_management: nil, environment_class: nil, execution_role_arn: nil, kms_key: nil, logging_configuration: nil, max_webservers: nil, max_workers: nil, min_webservers: nil, min_workers: nil, network_configuration: nil, plugins_s3_object_version: nil, plugins_s3_path: nil, requirements_s3_object_version: nil, requirements_s3_path: nil, schedulers: nil, source_bucket_arn: nil, startup_script_s3_object_version: nil, startup_script_s3_path: nil, tags: nil, webserver_access_mode: nil, weekly_maintenance_window_start: nil, worker_replacement_strategy: nil)
  @name = name
  Jsii::Type.check_type(@name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name")
  @airflow_configuration_options = airflow_configuration_options
  Jsii::Type.check_type(@airflow_configuration_options, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "airflowConfigurationOptions") unless @airflow_configuration_options.nil?
  @airflow_version = airflow_version
  Jsii::Type.check_type(@airflow_version, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "airflowVersion") unless @airflow_version.nil?
  @dag_s3_path = dag_s3_path
  Jsii::Type.check_type(@dag_s3_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "dagS3Path") unless @dag_s3_path.nil?
  @endpoint_management = endpoint_management
  Jsii::Type.check_type(@endpoint_management, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "endpointManagement") unless @endpoint_management.nil?
  @environment_class = environment_class
  Jsii::Type.check_type(@environment_class, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "environmentClass") unless @environment_class.nil?
  @execution_role_arn = execution_role_arn
  Jsii::Type.check_type(@execution_role_arn, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoic3RyaW5nIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19pYW0uSVJvbGVSZWYifV19fQ==")), "executionRoleArn") unless @execution_role_arn.nil?
  @kms_key = kms_key
  Jsii::Type.check_type(@kms_key, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoic3RyaW5nIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19rbXMuSUtleVJlZiJ9XX19")), "kmsKey") unless @kms_key.nil?
  @logging_configuration = logging_configuration.is_a?(Hash) ? ::AWSCDK::MWAA::CfnEnvironment::LoggingConfigurationProperty.new(**logging_configuration.transform_keys(&:to_sym)) : logging_configuration
  Jsii::Type.check_type(@logging_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19td2FhLkNmbkVudmlyb25tZW50LkxvZ2dpbmdDb25maWd1cmF0aW9uUHJvcGVydHkifV19fQ==")), "loggingConfiguration") unless @logging_configuration.nil?
  @max_webservers = max_webservers
  Jsii::Type.check_type(@max_webservers, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "maxWebservers") unless @max_webservers.nil?
  @max_workers = max_workers
  Jsii::Type.check_type(@max_workers, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "maxWorkers") unless @max_workers.nil?
  @min_webservers = min_webservers
  Jsii::Type.check_type(@min_webservers, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "minWebservers") unless @min_webservers.nil?
  @min_workers = min_workers
  Jsii::Type.check_type(@min_workers, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "minWorkers") unless @min_workers.nil?
  @network_configuration = network_configuration.is_a?(Hash) ? ::AWSCDK::MWAA::CfnEnvironment::NetworkConfigurationProperty.new(**network_configuration.transform_keys(&:to_sym)) : network_configuration
  Jsii::Type.check_type(@network_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19td2FhLkNmbkVudmlyb25tZW50Lk5ldHdvcmtDb25maWd1cmF0aW9uUHJvcGVydHkifV19fQ==")), "networkConfiguration") unless @network_configuration.nil?
  @plugins_s3_object_version = plugins_s3_object_version
  Jsii::Type.check_type(@plugins_s3_object_version, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "pluginsS3ObjectVersion") unless @plugins_s3_object_version.nil?
  @plugins_s3_path = plugins_s3_path
  Jsii::Type.check_type(@plugins_s3_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "pluginsS3Path") unless @plugins_s3_path.nil?
  @requirements_s3_object_version = requirements_s3_object_version
  Jsii::Type.check_type(@requirements_s3_object_version, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "requirementsS3ObjectVersion") unless @requirements_s3_object_version.nil?
  @requirements_s3_path = requirements_s3_path
  Jsii::Type.check_type(@requirements_s3_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "requirementsS3Path") unless @requirements_s3_path.nil?
  @schedulers = schedulers
  Jsii::Type.check_type(@schedulers, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "schedulers") unless @schedulers.nil?
  @source_bucket_arn = source_bucket_arn
  Jsii::Type.check_type(@source_bucket_arn, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoic3RyaW5nIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19zMy5JQnVja2V0UmVmIn1dfX0=")), "sourceBucketArn") unless @source_bucket_arn.nil?
  @startup_script_s3_object_version = startup_script_s3_object_version
  Jsii::Type.check_type(@startup_script_s3_object_version, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "startupScriptS3ObjectVersion") unless @startup_script_s3_object_version.nil?
  @startup_script_s3_path = startup_script_s3_path
  Jsii::Type.check_type(@startup_script_s3_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "startupScriptS3Path") unless @startup_script_s3_path.nil?
  @tags = tags
  Jsii::Type.check_type(@tags, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "tags") unless @tags.nil?
  @webserver_access_mode = webserver_access_mode
  Jsii::Type.check_type(@webserver_access_mode, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "webserverAccessMode") unless @webserver_access_mode.nil?
  @weekly_maintenance_window_start = weekly_maintenance_window_start
  Jsii::Type.check_type(@weekly_maintenance_window_start, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "weeklyMaintenanceWindowStart") unless @weekly_maintenance_window_start.nil?
  @worker_replacement_strategy = worker_replacement_strategy
  Jsii::Type.check_type(@worker_replacement_strategy, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "workerReplacementStrategy") unless @worker_replacement_strategy.nil?
end

Instance Attribute Details

#airflow_configuration_options ⇒ Object? (readonly)

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 .

Returns:

  • (Object, nil)

See Also:



101
102
103
 
# File 'mwaa/cfn_environment_props.rb', line 101

def airflow_configuration_options
  @airflow_configuration_options
end

#airflow_version ⇒ String? (readonly)

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 : 2.7.2 | 2.8.1 | 2.9.2 | 2.10.1 | 2.10.3 | 3.0.6 (latest)

Returns:

  • (String, nil)

See Also:



112
113
114
 
# File 'mwaa/cfn_environment_props.rb', line 112

def airflow_version
  @airflow_version
end

#dag_s3_path ⇒ String? (readonly)

The relative path to the DAGs folder on your Amazon S3 bucket.

For example, dags . To learn more, see Adding or updating DAGs .

Returns:

  • (String, nil)

See Also:



119
120
121
 
# File 'mwaa/cfn_environment_props.rb', line 119

def dag_s3_path
  @dag_s3_path
end

#endpoint_management ⇒ String? (readonly)

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.

Returns:

  • (String, nil)

See Also:



126
127
128
 
# File 'mwaa/cfn_environment_props.rb', line 126

def endpoint_management
  @endpoint_management
end

#environment_class ⇒ String? (readonly)

The environment class type.

Valid values: mw1.micro , mw1.small , mw1.medium , mw1.large , mw1.1large , and mw1.2large . To learn more, see Amazon MWAA environment class .

Returns:

  • (String, nil)

See Also:



133
134
135
 
# File 'mwaa/cfn_environment_props.rb', line 133

def environment_class
  @environment_class
end

#execution_role_arn ⇒ String, ... (readonly)

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 .

Returns:

See Also:



140
141
142
 
# File 'mwaa/cfn_environment_props.rb', line 140

def execution_role_arn
  @execution_role_arn
end

#kms_key ⇒ String, ... (readonly)

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).

Returns:

See Also:



147
148
149
 
# File 'mwaa/cfn_environment_props.rb', line 147

def kms_key
  @kms_key
end

#logging_configuration ⇒ AWSCDK::IResolvable, ... (readonly)

The Apache Airflow logs being sent to CloudWatch Logs: DagProcessingLogs , SchedulerLogs , TaskLogs , WebserverLogs , WorkerLogs .

Returns:

See Also:



152
153
154
 
# File 'mwaa/cfn_environment_props.rb', line 152

def logging_configuration
  @logging_configuration
end

#max_webservers ⇒ Numeric? (readonly)

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: For environments larger than mw1.micro, accepts values from 2 to 5 . Defaults to 2 for all environment sizes except mw1.micro, which defaults to 1 .

Returns:

  • (Numeric, nil)

See Also:



161
162
163
 
# File 'mwaa/cfn_environment_props.rb', line 161

def max_webservers
  @max_webservers
end

#max_workers ⇒ Numeric? (readonly)

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 .

Returns:

  • (Numeric, nil)

See Also:



168
169
170
 
# File 'mwaa/cfn_environment_props.rb', line 168

def max_workers
  @max_workers
end

#min_webservers ⇒ Numeric? (readonly)

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: For environments larger than mw1.micro, accepts values from 2 to 5 . Defaults to 2 for all environment sizes except mw1.micro, which defaults to 1 .

Returns:

  • (Numeric, nil)

See Also:



177
178
179
 
# File 'mwaa/cfn_environment_props.rb', line 177

def min_webservers
  @min_webservers
end

#min_workers ⇒ Numeric? (readonly)

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 .

Returns:

  • (Numeric, nil)

See Also:



184
185
186
 
# File 'mwaa/cfn_environment_props.rb', line 184

def min_workers
  @min_workers
end

#name ⇒ String (readonly)

The name of your Amazon MWAA environment.

Returns:

  • (String)

See Also:



94
95
96
 
# File 'mwaa/cfn_environment_props.rb', line 94

def name
  @name
end

#network_configuration ⇒ AWSCDK::IResolvable, ... (readonly)

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 .

Returns:

See Also:



191
192
193
 
# File 'mwaa/cfn_environment_props.rb', line 191

def network_configuration
  @network_configuration
end

#plugins_s3_object_version ⇒ String? (readonly)

The version of the plugins.zip file on your Amazon S3 bucket. To learn more, see Installing custom plugins .

Returns:

  • (String, nil)

See Also:



196
197
198
 
# File 'mwaa/cfn_environment_props.rb', line 196

def plugins_s3_object_version
  @plugins_s3_object_version
end

#plugins_s3_path ⇒ String? (readonly)

The relative path to the plugins.zip file on your Amazon S3 bucket. For example, plugins.zip . To learn more, see Installing custom plugins .

Returns:

  • (String, nil)

See Also:



201
202
203
 
# File 'mwaa/cfn_environment_props.rb', line 201

def plugins_s3_path
  @plugins_s3_path
end

#requirements_s3_object_version ⇒ String? (readonly)

The version of the requirements.txt file on your Amazon S3 bucket. To learn more, see Installing Python dependencies .

Returns:

  • (String, nil)

See Also:



206
207
208
 
# File 'mwaa/cfn_environment_props.rb', line 206

def requirements_s3_object_version
  @requirements_s3_object_version
end

#requirements_s3_path ⇒ String? (readonly)

The relative path to the requirements.txt file on your Amazon S3 bucket. For example, requirements.txt . To learn more, see Installing Python dependencies .

Returns:

  • (String, nil)

See Also:



211
212
213
 
# File 'mwaa/cfn_environment_props.rb', line 211

def requirements_s3_path
  @requirements_s3_path
end

#schedulers ⇒ Numeric? (readonly)

The number of schedulers that you want to run in your environment. Valid values:.

  • v2 - For environments larger than mw1.micro, accepts values from 2 to 5. Defaults to 2 for all environment sizes except mw1.micro, which defaults to 1.
  • v1 - Accepts 1.

Returns:

  • (Numeric, nil)

See Also:



219
220
221
 
# File 'mwaa/cfn_environment_props.rb', line 219

def schedulers
  @schedulers
end

#source_bucket_arn ⇒ String, ... (readonly)

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 .

Returns:

See Also:



226
227
228
 
# File 'mwaa/cfn_environment_props.rb', line 226

def source_bucket_arn
  @source_bucket_arn
end

#startup_script_s3_object_version ⇒ String? (readonly)

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 .

Returns:

  • (String, nil)

See Also:



239
240
241
 
# File 'mwaa/cfn_environment_props.rb', line 239

def startup_script_s3_object_version
  @startup_script_s3_object_version
end

#startup_script_s3_path ⇒ String? (readonly)

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 .

Returns:

  • (String, nil)

See Also:



246
247
248
 
# File 'mwaa/cfn_environment_props.rb', line 246

def startup_script_s3_path
  @startup_script_s3_path
end

#tags ⇒ Object? (readonly)

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.

Returns:

  • (Object, nil)

See Also:



253
254
255
 
# File 'mwaa/cfn_environment_props.rb', line 253

def tags
  @tags
end

#webserver_access_mode ⇒ String? (readonly)

The Apache Airflow Web server access mode.

To learn more, see Apache Airflow access modes . Valid values: PRIVATE_ONLY or PUBLIC_ONLY .

Returns:

  • (String, nil)

See Also:



260
261
262
 
# File 'mwaa/cfn_environment_props.rb', line 260

def webserver_access_mode
  @webserver_access_mode
end

#weekly_maintenance_window_start ⇒ String? (readonly)

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)

Returns:

  • (String, nil)

See Also:



269
270
271
 
# File 'mwaa/cfn_environment_props.rb', line 269

def weekly_maintenance_window_start
  @weekly_maintenance_window_start
end

#worker_replacement_strategy ⇒ String? (readonly)

The worker replacement strategy to use when updating the environment.

Valid values: FORCED, GRACEFUL. FORCED means Apache Airflow workers will be stopped and replaced without waiting for tasks to complete before an update. GRACEFUL means Apache Airflow workers will be able to complete running tasks for up to 12 hours during an update before being stopped and replaced.

Returns:

  • (String, nil)

See Also:



276
277
278
 
# File 'mwaa/cfn_environment_props.rb', line 276

def worker_replacement_strategy
  @worker_replacement_strategy
end

Class Method Details

.jsii_properties ⇒ Object 



278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
 
# File 'mwaa/cfn_environment_props.rb', line 278

def self.jsii_properties
  {
    :name => "name",
    :airflow_configuration_options => "airflowConfigurationOptions",
    :airflow_version => "airflowVersion",
    :dag_s3_path => "dagS3Path",
    :endpoint_management => "endpointManagement",
    :environment_class => "environmentClass",
    :execution_role_arn => "executionRoleArn",
    :kms_key => "kmsKey",
    :logging_configuration => "loggingConfiguration",
    :max_webservers => "maxWebservers",
    :max_workers => "maxWorkers",
    :min_webservers => "minWebservers",
    :min_workers => "minWorkers",
    :network_configuration => "networkConfiguration",
    :plugins_s3_object_version => "pluginsS3ObjectVersion",
    :plugins_s3_path => "pluginsS3Path",
    :requirements_s3_object_version => "requirementsS3ObjectVersion",
    :requirements_s3_path => "requirementsS3Path",
    :schedulers => "schedulers",
    :source_bucket_arn => "sourceBucketArn",
    :startup_script_s3_object_version => "startupScriptS3ObjectVersion",
    :startup_script_s3_path => "startupScriptS3Path",
    :tags => "tags",
    :webserver_access_mode => "webserverAccessMode",
    :weekly_maintenance_window_start => "weeklyMaintenanceWindowStart",
    :worker_replacement_strategy => "workerReplacementStrategy",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
 
# File 'mwaa/cfn_environment_props.rb', line 309

def to_jsii
  result = {}
  result.merge!({
    "name" => @name,
    "airflowConfigurationOptions" => @airflow_configuration_options,
    "airflowVersion" => @airflow_version,
    "dagS3Path" => @dag_s3_path,
    "endpointManagement" => @endpoint_management,
    "environmentClass" => @environment_class,
    "executionRoleArn" => @execution_role_arn,
    "kmsKey" => @kms_key,
    "loggingConfiguration" => @logging_configuration,
    "maxWebservers" => @max_webservers,
    "maxWorkers" => @max_workers,
    "minWebservers" => @min_webservers,
    "minWorkers" => @min_workers,
    "networkConfiguration" => @network_configuration,
    "pluginsS3ObjectVersion" => @plugins_s3_object_version,
    "pluginsS3Path" => @plugins_s3_path,
    "requirementsS3ObjectVersion" => @requirements_s3_object_version,
    "requirementsS3Path" => @requirements_s3_path,
    "schedulers" => @schedulers,
    "sourceBucketArn" => @source_bucket_arn,
    "startupScriptS3ObjectVersion" => @startup_script_s3_object_version,
    "startupScriptS3Path" => @startup_script_s3_path,
    "tags" => @tags,
    "webserverAccessMode" => @webserver_access_mode,
    "weeklyMaintenanceWindowStart" => @weekly_maintenance_window_start,
    "workerReplacementStrategy" => @worker_replacement_strategy,
  })
  result.compact
end