Package software.amazon.awscdk.cfnpropertymixins.services.mwaa

Class CfnEnvironmentMixinProps.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.cfnpropertymixins.services.mwaa.CfnEnvironmentMixinProps.Jsii$Proxy

All Implemented Interfaces:

CfnEnvironmentMixinProps, software.amazon.jsii.JsiiSerializable

Enclosing interface:

CfnEnvironmentMixinProps

@Stability(Stable)
@Internal
public static final class CfnEnvironmentMixinProps.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements CfnEnvironmentMixinProps

An implementation for CfnEnvironmentMixinProps

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.cfnpropertymixins.services.mwaa.CfnEnvironmentMixinProps

CfnEnvironmentMixinProps.Builder, CfnEnvironmentMixinProps.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Jsii$Proxy(CfnEnvironmentMixinProps.Builder builder)	Constructor that initializes the object based on literal property values passed by the CfnEnvironmentMixinProps.Builder.
protected	Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)	Constructor that initializes the object based on values retrieved from the JsiiObject.

Method Summary

Modifier and Type	Method	Description
com.fasterxml.jackson.databind.JsonNode	$jsii$toJson()
final boolean	equals(Object o)
final Object	getAirflowConfigurationOptions()	A list of key-value pairs containing the Airflow configuration options for your environment.
final String	getAirflowVersion()	The version of Apache Airflow to use for the environment.
final String	getDagS3Path()	The relative path to the DAGs folder on your Amazon S3 bucket.
final String	getEndpointManagement()	Defines whether the VPC endpoints configured for the environment are created, and managed, by the customer or by Amazon MWAA.
final String	getEnvironmentClass()	The environment class type.
final Object	getExecutionRoleArn()	The Amazon Resource Name (ARN) of the execution role in IAM that allows MWAA to access AWS resources in your environment.
final Object	getKmsKey()	The AWS Key Management Service (KMS) key to encrypt and decrypt the data in your environment.
final Object	getLoggingConfiguration()	The Apache Airflow logs being sent to CloudWatch Logs: DagProcessingLogs , SchedulerLogs , TaskLogs , WebserverLogs , WorkerLogs .
final Number	getMaxWebservers()	The maximum number of web servers that you want to run in your environment.
final Number	getMaxWorkers()	The maximum number of workers that you want to run in your environment.
final Number	getMinWebservers()	The minimum number of web servers that you want to run in your environment.
final Number	getMinWorkers()	The minimum number of workers that you want to run in your environment.
final String	getName()	The name of your Amazon MWAA environment.
final Object	getNetworkConfiguration()	The VPC networking components used to secure and enable network traffic between the AWS resources for your environment.
final String	getPluginsS3ObjectVersion()	The version of the plugins.zip file on your Amazon S3 bucket.
final String	getPluginsS3Path()	The relative path to the plugins.zip file on your Amazon S3 bucket.
final String	getRequirementsS3ObjectVersion()	The version of the requirements.txt file on your Amazon S3 bucket.
final String	getRequirementsS3Path()	The relative path to the requirements.txt file on your Amazon S3 bucket.
final Number	getSchedulers()	The number of schedulers that you want to run in your environment.
final Object	getSourceBucketArn()	The Amazon Resource Name (ARN) of the Amazon S3 bucket where your DAG code and supporting files are stored.
final String	getStartupScriptS3ObjectVersion()	The version of the startup shell script in your Amazon S3 bucket.
final String	getStartupScriptS3Path()	The relative path to the startup shell script in your Amazon S3 bucket.
final Object	getTags()	The key-value tag pairs associated to your environment.
final String	getWebserverAccessMode()	The Apache Airflow Web server access mode.
final String	getWeeklyMaintenanceWindowStart()	The day and time of the week to start weekly maintenance updates of your environment in the following format: DAY:HH:MM .
final String	getWorkerReplacementStrategy()	The worker replacement strategy to use when updating the environment.
final int	hashCode()

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Jsii$Proxy

protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Constructor that initializes the object based on values retrieved from the JsiiObject.

Parameters:

objRef - Reference to the JSII managed object.

Jsii$Proxy

protected Jsii$Proxy(CfnEnvironmentMixinProps.Builder builder)

Constructor that initializes the object based on literal property values passed by the CfnEnvironmentMixinProps.Builder.

Method Details

getAirflowConfigurationOptions

public final Object getAirflowConfigurationOptions()

Description copied from interface: CfnEnvironmentMixinProps

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 .

Specified by:

getAirflowConfigurationOptions in interface CfnEnvironmentMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaa-environment.html#cfn-mwaa-environment-airflowconfigurationoptions

getAirflowVersion

public final String getAirflowVersion()

Description copied from interface: CfnEnvironmentMixinProps

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)

Specified by:

getAirflowVersion in interface CfnEnvironmentMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaa-environment.html#cfn-mwaa-environment-airflowversion

getDagS3Path

public final String getDagS3Path()

Description copied from interface: CfnEnvironmentMixinProps

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

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

Specified by:

getDagS3Path in interface CfnEnvironmentMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaa-environment.html#cfn-mwaa-environment-dags3path

getEndpointManagement

public final String getEndpointManagement()

Description copied from interface: CfnEnvironmentMixinProps

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.

Specified by:

getEndpointManagement in interface CfnEnvironmentMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaa-environment.html#cfn-mwaa-environment-endpointmanagement

getEnvironmentClass

public final String getEnvironmentClass()

Description copied from interface: CfnEnvironmentMixinProps

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 .

Specified by:

getEnvironmentClass in interface CfnEnvironmentMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaa-environment.html#cfn-mwaa-environment-environmentclass

getExecutionRoleArn

public final Object getExecutionRoleArn()

Description copied from interface: CfnEnvironmentMixinProps

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 union: either String or IRoleRef

Specified by:

getExecutionRoleArn in interface CfnEnvironmentMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaa-environment.html#cfn-mwaa-environment-executionrolearn

getKmsKey

public final Object getKmsKey()

Description copied from interface: CfnEnvironmentMixinProps

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 union: either String or IKeyRef

Specified by:

getKmsKey in interface CfnEnvironmentMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaa-environment.html#cfn-mwaa-environment-kmskey

getLoggingConfiguration

public final Object getLoggingConfiguration()

Description copied from interface: CfnEnvironmentMixinProps

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

Returns union: either IResolvable or CfnEnvironmentPropsMixin.LoggingConfigurationProperty

Specified by:

getLoggingConfiguration in interface CfnEnvironmentMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaa-environment.html#cfn-mwaa-environment-loggingconfiguration

getMaxWebservers

public final Number getMaxWebservers()

Description copied from interface: CfnEnvironmentMixinProps

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 .

Specified by:

getMaxWebservers in interface CfnEnvironmentMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaa-environment.html#cfn-mwaa-environment-maxwebservers

getMaxWorkers

public final Number getMaxWorkers()

Description copied from interface: CfnEnvironmentMixinProps

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 .

Specified by:

getMaxWorkers in interface CfnEnvironmentMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaa-environment.html#cfn-mwaa-environment-maxworkers

getMinWebservers

public final Number getMinWebservers()

Description copied from interface: CfnEnvironmentMixinProps

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 .

Specified by:

getMinWebservers in interface CfnEnvironmentMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaa-environment.html#cfn-mwaa-environment-minwebservers

getMinWorkers

public final Number getMinWorkers()

Description copied from interface: CfnEnvironmentMixinProps

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 .

Specified by:

getMinWorkers in interface CfnEnvironmentMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaa-environment.html#cfn-mwaa-environment-minworkers

getName

public final String getName()

Description copied from interface: CfnEnvironmentMixinProps

The name of your Amazon MWAA environment.

Specified by:

getName in interface CfnEnvironmentMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaa-environment.html#cfn-mwaa-environment-name

getNetworkConfiguration

public final Object getNetworkConfiguration()

Description copied from interface: CfnEnvironmentMixinProps

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 union: either IResolvable or CfnEnvironmentPropsMixin.NetworkConfigurationProperty

Specified by:

getNetworkConfiguration in interface CfnEnvironmentMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaa-environment.html#cfn-mwaa-environment-networkconfiguration

getPluginsS3ObjectVersion

public final String getPluginsS3ObjectVersion()

Description copied from interface: CfnEnvironmentMixinProps

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

Specified by:

getPluginsS3ObjectVersion in interface CfnEnvironmentMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaa-environment.html#cfn-mwaa-environment-pluginss3objectversion

getPluginsS3Path

public final String getPluginsS3Path()

Description copied from interface: CfnEnvironmentMixinProps

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

Specified by:

getPluginsS3Path in interface CfnEnvironmentMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaa-environment.html#cfn-mwaa-environment-pluginss3path

getRequirementsS3ObjectVersion

public final String getRequirementsS3ObjectVersion()

Description copied from interface: CfnEnvironmentMixinProps

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

Specified by:

getRequirementsS3ObjectVersion in interface CfnEnvironmentMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaa-environment.html#cfn-mwaa-environment-requirementss3objectversion

getRequirementsS3Path

public final String getRequirementsS3Path()

Description copied from interface: CfnEnvironmentMixinProps

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

Specified by:

getRequirementsS3Path in interface CfnEnvironmentMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaa-environment.html#cfn-mwaa-environment-requirementss3path

getSchedulers

public final Number getSchedulers()

Description copied from interface: CfnEnvironmentMixinProps

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.

Specified by:

getSchedulers in interface CfnEnvironmentMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaa-environment.html#cfn-mwaa-environment-schedulers

getSourceBucketArn

public final Object getSourceBucketArn()

Description copied from interface: CfnEnvironmentMixinProps

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 union: either String or IBucketRef

Specified by:

getSourceBucketArn in interface CfnEnvironmentMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaa-environment.html#cfn-mwaa-environment-sourcebucketarn

getStartupScriptS3ObjectVersion

public final String getStartupScriptS3ObjectVersion()

Description copied from interface: CfnEnvironmentMixinProps

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 .

Specified by:

getStartupScriptS3ObjectVersion in interface CfnEnvironmentMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaa-environment.html#cfn-mwaa-environment-startupscripts3objectversion

getStartupScriptS3Path

public final String getStartupScriptS3Path()

Description copied from interface: CfnEnvironmentMixinProps

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 .

Specified by:

getStartupScriptS3Path in interface CfnEnvironmentMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaa-environment.html#cfn-mwaa-environment-startupscripts3path

getTags

public final Object getTags()

Description copied from interface: CfnEnvironmentMixinProps

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.

Specified by:

getTags in interface CfnEnvironmentMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaa-environment.html#cfn-mwaa-environment-tags

getWebserverAccessMode

public final String getWebserverAccessMode()

Description copied from interface: CfnEnvironmentMixinProps

The Apache Airflow Web server access mode.

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

Specified by:

getWebserverAccessMode in interface CfnEnvironmentMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaa-environment.html#cfn-mwaa-environment-webserveraccessmode

getWeeklyMaintenanceWindowStart

public final String getWeeklyMaintenanceWindowStart()

Description copied from interface: CfnEnvironmentMixinProps

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)

Specified by:

getWeeklyMaintenanceWindowStart in interface CfnEnvironmentMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaa-environment.html#cfn-mwaa-environment-weeklymaintenancewindowstart

getWorkerReplacementStrategy

public final String getWorkerReplacementStrategy()

Description copied from interface: CfnEnvironmentMixinProps

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.

Specified by:

getWorkerReplacementStrategy in interface CfnEnvironmentMixinProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mwaa-environment.html#cfn-mwaa-environment-workerreplacementstrategy

$jsii$toJson

@Internal
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()

Specified by:

$jsii$toJson in interface software.amazon.jsii.JsiiSerializable

equals

public final boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object