Class Environment
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<Environment.Builder,
Environment>
Describes an Amazon Managed Workflows for Apache Airflow (MWAA) environment.
- See Also:
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionA list of key-value pairs containing the Apache Airflow configuration options attached to your environment.final String
The Apache Airflow version on your environment.final String
arn()
The Amazon Resource Name (ARN) of the Amazon MWAA environment.static Environment.Builder
builder()
final String
The queue ARN for the environment's Celery Executor.final Instant
The day and time the environment was created.final String
The relative path to the DAGs folder in your Amazon S3 bucket.final String
The VPC endpoint for the environment's Amazon RDS database.final EndpointManagement
Defines whether the VPC endpoints configured for the environment are created, and managed, by the customer or by Amazon MWAA.final String
Defines whether the VPC endpoints configured for the environment are created, and managed, by the customer or by Amazon MWAA.final String
The environment class type.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final String
The Amazon Resource Name (ARN) of the execution role in IAM that allows MWAA to access Amazon Web Services resources in your environment.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final boolean
For responses, this returns true if the service returned a value for the AirflowConfigurationOptions property.final int
hashCode()
final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.final String
kmsKey()
The KMS encryption key used to encrypt the data in your environment.final LastUpdate
The status of the last update on the environment.final LoggingConfiguration
The Apache Airflow logs published to CloudWatch Logs.final Integer
The maximum number of web servers that you want to run in your environment.final Integer
The maximum number of workers that run in your environment.final Integer
The minimum number of web servers that you want to run in your environment.final Integer
The minimum number of workers that run in your environment.final String
name()
The name of the Amazon MWAA environment.final NetworkConfiguration
Describes the VPC networking components used to secure and enable network traffic between the Amazon Web Services resources for your environment.final String
The version of theplugins.zip
file in your Amazon S3 bucket.final String
The relative path to the file in your Amazon S3 bucket.final String
The version of therequirements.txt
file on your Amazon S3 bucket.final String
The relative path to therequirements.txt
file in your Amazon S3 bucket.final Integer
The number of Apache Airflow schedulers that run in your Amazon MWAA environment.static Class
<? extends Environment.Builder> final String
The Amazon Resource Name (ARN) for the service-linked role of the environment.final String
The Amazon Resource Name (ARN) of the Amazon S3 bucket where your DAG code and supporting files are stored.final String
The version of the startup shell script in your Amazon S3 bucket.final String
The relative path to the startup shell script in your Amazon S3 bucket.final EnvironmentStatus
status()
The status of the Amazon MWAA environment.final String
The status of the Amazon MWAA environment.tags()
The key-value tag pairs associated to your environment.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final WebserverAccessMode
The Apache Airflow web server access mode.final String
The Apache Airflow web server access mode.final String
The Apache Airflow web server host name for the Amazon MWAA environment.final String
The VPC endpoint for the environment's web server.final String
The day and time of the week in Coordinated Universal Time (UTC) 24-hour standard time that weekly maintenance updates are scheduled.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
name
The name of the Amazon MWAA environment. For example,
MyMWAAEnvironment
.- Returns:
- The name of the Amazon MWAA environment. For example,
MyMWAAEnvironment
.
-
status
The status of the Amazon MWAA environment.
Valid values:
-
CREATING
- Indicates the request to create the environment is in progress. -
CREATING_SNAPSHOT
- Indicates the request to update environment details, or upgrade the environment version, is in progress and Amazon MWAA is creating a storage volume snapshot of the Amazon RDS database cluster associated with the environment. A database snapshot is a backup created at a specific point in time. Amazon MWAA uses snapshots to recover environment metadata if the process to update or upgrade an environment fails. -
CREATE_FAILED
- Indicates the request to create the environment failed, and the environment could not be created. -
AVAILABLE
- Indicates the request was successful and the environment is ready to use. -
PENDING
- Indicates the request was successful, but the process to create the environment is paused until you create the required VPC endpoints in your VPC. After you create the VPC endpoints, the process resumes. -
UPDATING
- Indicates the request to update the environment is in progress. -
ROLLING_BACK
- Indicates the request to update environment details, or upgrade the environment version, failed and Amazon MWAA is restoring the environment using the latest storage volume snapshot. -
DELETING
- Indicates the request to delete the environment is in progress. -
DELETED
- Indicates the request to delete the environment is complete, and the environment has been deleted. -
UNAVAILABLE
- Indicates the request failed, but the environment did not return to its previous state and is not stable. -
UPDATE_FAILED
- Indicates the request to update the environment failed, and the environment was restored to its previous state successfully and is ready to use. -
MAINTENANCE
- Indicates that the environment is undergoing maintenance. Depending on the type of work Amazon MWAA is performing, your environment might become unavailable during this process. After all operations are done, your environment will return to its status prior to mainteneace operations.
We recommend reviewing our troubleshooting guide for a list of common errors and their solutions. For more information, see Amazon MWAA troubleshooting.
If the service returns an enum value that is not available in the current SDK version,
status
will returnEnvironmentStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- The status of the Amazon MWAA environment.
Valid values:
-
CREATING
- Indicates the request to create the environment is in progress. -
CREATING_SNAPSHOT
- Indicates the request to update environment details, or upgrade the environment version, is in progress and Amazon MWAA is creating a storage volume snapshot of the Amazon RDS database cluster associated with the environment. A database snapshot is a backup created at a specific point in time. Amazon MWAA uses snapshots to recover environment metadata if the process to update or upgrade an environment fails. -
CREATE_FAILED
- Indicates the request to create the environment failed, and the environment could not be created. -
AVAILABLE
- Indicates the request was successful and the environment is ready to use. -
PENDING
- Indicates the request was successful, but the process to create the environment is paused until you create the required VPC endpoints in your VPC. After you create the VPC endpoints, the process resumes. -
UPDATING
- Indicates the request to update the environment is in progress. -
ROLLING_BACK
- Indicates the request to update environment details, or upgrade the environment version, failed and Amazon MWAA is restoring the environment using the latest storage volume snapshot. -
DELETING
- Indicates the request to delete the environment is in progress. -
DELETED
- Indicates the request to delete the environment is complete, and the environment has been deleted. -
UNAVAILABLE
- Indicates the request failed, but the environment did not return to its previous state and is not stable. -
UPDATE_FAILED
- Indicates the request to update the environment failed, and the environment was restored to its previous state successfully and is ready to use. -
MAINTENANCE
- Indicates that the environment is undergoing maintenance. Depending on the type of work Amazon MWAA is performing, your environment might become unavailable during this process. After all operations are done, your environment will return to its status prior to mainteneace operations.
We recommend reviewing our troubleshooting guide for a list of common errors and their solutions. For more information, see Amazon MWAA troubleshooting.
-
- See Also:
-
-
statusAsString
The status of the Amazon MWAA environment.
Valid values:
-
CREATING
- Indicates the request to create the environment is in progress. -
CREATING_SNAPSHOT
- Indicates the request to update environment details, or upgrade the environment version, is in progress and Amazon MWAA is creating a storage volume snapshot of the Amazon RDS database cluster associated with the environment. A database snapshot is a backup created at a specific point in time. Amazon MWAA uses snapshots to recover environment metadata if the process to update or upgrade an environment fails. -
CREATE_FAILED
- Indicates the request to create the environment failed, and the environment could not be created. -
AVAILABLE
- Indicates the request was successful and the environment is ready to use. -
PENDING
- Indicates the request was successful, but the process to create the environment is paused until you create the required VPC endpoints in your VPC. After you create the VPC endpoints, the process resumes. -
UPDATING
- Indicates the request to update the environment is in progress. -
ROLLING_BACK
- Indicates the request to update environment details, or upgrade the environment version, failed and Amazon MWAA is restoring the environment using the latest storage volume snapshot. -
DELETING
- Indicates the request to delete the environment is in progress. -
DELETED
- Indicates the request to delete the environment is complete, and the environment has been deleted. -
UNAVAILABLE
- Indicates the request failed, but the environment did not return to its previous state and is not stable. -
UPDATE_FAILED
- Indicates the request to update the environment failed, and the environment was restored to its previous state successfully and is ready to use. -
MAINTENANCE
- Indicates that the environment is undergoing maintenance. Depending on the type of work Amazon MWAA is performing, your environment might become unavailable during this process. After all operations are done, your environment will return to its status prior to mainteneace operations.
We recommend reviewing our troubleshooting guide for a list of common errors and their solutions. For more information, see Amazon MWAA troubleshooting.
If the service returns an enum value that is not available in the current SDK version,
status
will returnEnvironmentStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- The status of the Amazon MWAA environment.
Valid values:
-
CREATING
- Indicates the request to create the environment is in progress. -
CREATING_SNAPSHOT
- Indicates the request to update environment details, or upgrade the environment version, is in progress and Amazon MWAA is creating a storage volume snapshot of the Amazon RDS database cluster associated with the environment. A database snapshot is a backup created at a specific point in time. Amazon MWAA uses snapshots to recover environment metadata if the process to update or upgrade an environment fails. -
CREATE_FAILED
- Indicates the request to create the environment failed, and the environment could not be created. -
AVAILABLE
- Indicates the request was successful and the environment is ready to use. -
PENDING
- Indicates the request was successful, but the process to create the environment is paused until you create the required VPC endpoints in your VPC. After you create the VPC endpoints, the process resumes. -
UPDATING
- Indicates the request to update the environment is in progress. -
ROLLING_BACK
- Indicates the request to update environment details, or upgrade the environment version, failed and Amazon MWAA is restoring the environment using the latest storage volume snapshot. -
DELETING
- Indicates the request to delete the environment is in progress. -
DELETED
- Indicates the request to delete the environment is complete, and the environment has been deleted. -
UNAVAILABLE
- Indicates the request failed, but the environment did not return to its previous state and is not stable. -
UPDATE_FAILED
- Indicates the request to update the environment failed, and the environment was restored to its previous state successfully and is ready to use. -
MAINTENANCE
- Indicates that the environment is undergoing maintenance. Depending on the type of work Amazon MWAA is performing, your environment might become unavailable during this process. After all operations are done, your environment will return to its status prior to mainteneace operations.
We recommend reviewing our troubleshooting guide for a list of common errors and their solutions. For more information, see Amazon MWAA troubleshooting.
-
- See Also:
-
-
arn
The Amazon Resource Name (ARN) of the Amazon MWAA environment.
- Returns:
- The Amazon Resource Name (ARN) of the Amazon MWAA environment.
-
createdAt
The day and time the environment was created.
- Returns:
- The day and time the environment was created.
-
webserverUrl
The Apache Airflow web server host name for the Amazon MWAA environment. For more information, see Accessing the Apache Airflow UI.
- Returns:
- The Apache Airflow web server host name for the Amazon MWAA environment. For more information, see Accessing the Apache Airflow UI.
-
executionRoleArn
The Amazon Resource Name (ARN) of the execution role in IAM that allows MWAA to access Amazon Web Services resources in your environment. For example,
arn:aws:iam::123456789:role/my-execution-role
. For more information, see Amazon MWAA Execution role.- Returns:
- The Amazon Resource Name (ARN) of the execution role in IAM that allows MWAA to access Amazon Web
Services resources in your environment. For example,
arn:aws:iam::123456789:role/my-execution-role
. For more information, see Amazon MWAA Execution role.
-
serviceRoleArn
The Amazon Resource Name (ARN) for the service-linked role of the environment. For more information, see Amazon MWAA Service-linked role.
- Returns:
- The Amazon Resource Name (ARN) for the service-linked role of the environment. For more information, see Amazon MWAA Service-linked role.
-
kmsKey
The KMS encryption key used to encrypt the data in your environment.
- Returns:
- The KMS encryption key used to encrypt the data in your environment.
-
airflowVersion
The Apache Airflow version on your environment.
Valid 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
.- Returns:
- The Apache Airflow version on your environment.
Valid 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
.
-
sourceBucketArn
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
. For more information, see Create an Amazon S3 bucket for Amazon MWAA.- Returns:
- 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
. For more information, see Create an Amazon S3 bucket for Amazon MWAA.
-
dagS3Path
The relative path to the DAGs folder in your Amazon S3 bucket. For example,
s3://mwaa-environment/dags
. For more information, see Adding or updating DAGs.- Returns:
- The relative path to the DAGs folder in your Amazon S3 bucket. For example,
s3://mwaa-environment/dags
. For more information, see Adding or updating DAGs.
-
pluginsS3Path
The relative path to the file in your Amazon S3 bucket. For example,
s3://mwaa-environment/plugins.zip
. For more information, see Installing custom plugins.- Returns:
- The relative path to the file in your Amazon S3 bucket. For example,
s3://mwaa-environment/plugins.zip
. For more information, see Installing custom plugins.
-
pluginsS3ObjectVersion
The version of the
plugins.zip
file in your Amazon S3 bucket. You must specify the version ID that Amazon S3 assigns to the file.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 Installing custom plugins.
- Returns:
- The version of the
plugins.zip
file in your Amazon S3 bucket. You must specify the version ID that Amazon S3 assigns to the file.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 Installing custom plugins.
-
requirementsS3Path
The relative path to the
requirements.txt
file in your Amazon S3 bucket. For example,s3://mwaa-environment/requirements.txt
. For more information, see Installing Python dependencies.- Returns:
- The relative path to the
requirements.txt
file in your Amazon S3 bucket. For example,s3://mwaa-environment/requirements.txt
. For more information, see Installing Python dependencies.
-
requirementsS3ObjectVersion
The version of the
requirements.txt
file on your Amazon S3 bucket. You must specify the version ID that Amazon S3 assigns to the file.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 Installing Python dependencies.
- Returns:
- The version of the
requirements.txt
file on your Amazon S3 bucket. You must specify the version ID that Amazon S3 assigns to the file.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 Installing Python dependencies.
-
startupScriptS3Path
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:
- 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.
-
startupScriptS3ObjectVersion
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.
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:
- 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.
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.
-
hasAirflowConfigurationOptions
public final boolean hasAirflowConfigurationOptions()For responses, this returns true if the service returned a value for the AirflowConfigurationOptions property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
airflowConfigurationOptions
A list of key-value pairs containing the Apache Airflow configuration options attached to your environment. For more information, see Apache Airflow configuration options.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasAirflowConfigurationOptions()
method.- Returns:
- A list of key-value pairs containing the Apache Airflow configuration options attached to your environment. For more information, see Apache Airflow configuration options.
-
environmentClass
The environment class type. Valid values:
mw1.small
,mw1.medium
,mw1.large
,mw1.xlarge
, andmw1.2xlarge
. For more information, see Amazon MWAA environment class.- Returns:
- The environment class type. Valid values:
mw1.small
,mw1.medium
,mw1.large
,mw1.xlarge
, andmw1.2xlarge
. For more information, see Amazon MWAA environment class.
-
maxWorkers
The maximum number of workers that run in your environment. For example,
20
.- Returns:
- The maximum number of workers that run in your environment. For example,
20
.
-
networkConfiguration
Describes the VPC networking components used to secure and enable network traffic between the Amazon Web Services resources for your environment. For more information, see About networking on Amazon MWAA.
- Returns:
- Describes the VPC networking components used to secure and enable network traffic between the Amazon Web Services resources for your environment. For more information, see About networking on Amazon MWAA.
-
loggingConfiguration
The Apache Airflow logs published to CloudWatch Logs.
- Returns:
- The Apache Airflow logs published to CloudWatch Logs.
-
lastUpdate
The status of the last update on the environment.
- Returns:
- The status of the last update on the environment.
-
weeklyMaintenanceWindowStart
The day and time of the week in Coordinated Universal Time (UTC) 24-hour standard time that weekly maintenance updates are scheduled. For example:
TUE:03:30
.- Returns:
- The day and time of the week in Coordinated Universal Time (UTC) 24-hour standard time that weekly
maintenance updates are scheduled. For example:
TUE:03:30
.
-
hasTags
public final boolean hasTags()For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
tags
The key-value tag pairs associated to your environment. For example,
"Environment": "Staging"
. For more information, see Tagging Amazon Web Services resources.Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasTags()
method.- Returns:
- The key-value tag pairs associated to your environment. For example,
"Environment": "Staging"
. For more information, see Tagging Amazon Web Services resources.
-
webserverAccessMode
The Apache Airflow web server access mode. For more information, see Apache Airflow access modes.
If the service returns an enum value that is not available in the current SDK version,
webserverAccessMode
will returnWebserverAccessMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromwebserverAccessModeAsString()
.- Returns:
- The Apache Airflow web server access mode. For more information, see Apache Airflow access modes.
- See Also:
-
webserverAccessModeAsString
The Apache Airflow web server access mode. For more information, see Apache Airflow access modes.
If the service returns an enum value that is not available in the current SDK version,
webserverAccessMode
will returnWebserverAccessMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromwebserverAccessModeAsString()
.- Returns:
- The Apache Airflow web server access mode. For more information, see Apache Airflow access modes.
- See Also:
-
minWorkers
The minimum number of workers that run in your environment. For example,
2
.- Returns:
- The minimum number of workers that run in your environment. For example,
2
.
-
schedulers
The number of Apache Airflow schedulers that run in your Amazon MWAA environment.
- Returns:
- The number of Apache Airflow schedulers that run in your Amazon MWAA environment.
-
webserverVpcEndpointService
The VPC endpoint for the environment's web server.
- Returns:
- The VPC endpoint for the environment's web server.
-
databaseVpcEndpointService
The VPC endpoint for the environment's Amazon RDS database.
- Returns:
- The VPC endpoint for the environment's Amazon RDS database.
-
celeryExecutorQueue
The queue ARN for the environment's Celery Executor. Amazon MWAA uses a Celery Executor to distribute tasks across multiple workers. When you create an environment in a shared VPC, you must provide access to the Celery Executor queue from your VPC.
- Returns:
- The queue ARN for the environment's Celery Executor. Amazon MWAA uses a Celery Executor to distribute tasks across multiple workers. When you create an environment in a shared VPC, you must provide access to the Celery Executor queue from your VPC.
-
endpointManagement
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.If the service returns an enum value that is not available in the current SDK version,
endpointManagement
will returnEndpointManagement.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromendpointManagementAsString()
.- Returns:
- 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:
-
endpointManagementAsString
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.If the service returns an enum value that is not available in the current SDK version,
endpointManagement
will returnEndpointManagement.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromendpointManagementAsString()
.- Returns:
- 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:
-
minWebservers
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
.- Returns:
- 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
.
-
maxWebservers
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
.- Returns:
- 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
.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<Environment.Builder,
Environment> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
-
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
-
getValueForField
-
sdkFields
-