Interface Environment.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<Environment.Builder,
,Environment> SdkBuilder<Environment.Builder,
,Environment> SdkPojo
- Enclosing class:
Environment
-
Method Summary
Modifier and TypeMethodDescriptionairflowConfigurationOptions
(Map<String, String> airflowConfigurationOptions) A list of key-value pairs containing the Apache Airflow configuration options attached to your environment.airflowVersion
(String airflowVersion) The Apache Airflow version on your environment.The Amazon Resource Name (ARN) of the Amazon MWAA environment.celeryExecutorQueue
(String celeryExecutorQueue) The queue ARN for the environment's Celery Executor.The day and time the environment was created.The relative path to the DAGs folder in your Amazon S3 bucket.databaseVpcEndpointService
(String databaseVpcEndpointService) The VPC endpoint for the environment's Amazon RDS database.endpointManagement
(String endpointManagement) Defines whether the VPC endpoints configured for the environment are created, and managed, by the customer or by Amazon MWAA.endpointManagement
(EndpointManagement endpointManagement) Defines whether the VPC endpoints configured for the environment are created, and managed, by the customer or by Amazon MWAA.environmentClass
(String environmentClass) The environment class type.executionRoleArn
(String executionRoleArn) The Amazon Resource Name (ARN) of the execution role in IAM that allows MWAA to access Amazon Web Services resources in your environment.The KMS encryption key used to encrypt the data in your environment.default Environment.Builder
lastUpdate
(Consumer<LastUpdate.Builder> lastUpdate) The status of the last update on the environment.lastUpdate
(LastUpdate lastUpdate) The status of the last update on the environment.default Environment.Builder
loggingConfiguration
(Consumer<LoggingConfiguration.Builder> loggingConfiguration) The Apache Airflow logs published to CloudWatch Logs.loggingConfiguration
(LoggingConfiguration loggingConfiguration) The Apache Airflow logs published to CloudWatch Logs.maxWorkers
(Integer maxWorkers) The maximum number of workers that run in your environment.minWorkers
(Integer minWorkers) The minimum number of workers that run in your environment.The name of the Amazon MWAA environment.default Environment.Builder
networkConfiguration
(Consumer<NetworkConfiguration.Builder> networkConfiguration) Describes the VPC networking components used to secure and enable network traffic between the Amazon Web Services resources for your environment.networkConfiguration
(NetworkConfiguration networkConfiguration) Describes the VPC networking components used to secure and enable network traffic between the Amazon Web Services resources for your environment.pluginsS3ObjectVersion
(String pluginsS3ObjectVersion) The version of theplugins.zip
file in your Amazon S3 bucket.pluginsS3Path
(String pluginsS3Path) The relative path to the file in your Amazon S3 bucket.requirementsS3ObjectVersion
(String requirementsS3ObjectVersion) The version of therequirements.txt
file on your Amazon S3 bucket.requirementsS3Path
(String requirementsS3Path) The relative path to therequirements.txt
file in your Amazon S3 bucket.schedulers
(Integer schedulers) The number of Apache Airflow schedulers that run in your Amazon MWAA environment.serviceRoleArn
(String serviceRoleArn) The Amazon Resource Name (ARN) for the service-linked role of the environment.sourceBucketArn
(String sourceBucketArn) The Amazon Resource Name (ARN) of the Amazon S3 bucket where your DAG code and supporting files are stored.startupScriptS3ObjectVersion
(String startupScriptS3ObjectVersion) The version of the startup shell script in your Amazon S3 bucket.startupScriptS3Path
(String startupScriptS3Path) The relative path to the startup shell script in your Amazon S3 bucket.The status of the Amazon MWAA environment.status
(EnvironmentStatus status) The status of the Amazon MWAA environment.The key-value tag pairs associated to your environment.webserverAccessMode
(String webserverAccessMode) The Apache Airflow web server access mode.webserverAccessMode
(WebserverAccessMode webserverAccessMode) The Apache Airflow web server access mode.webserverUrl
(String webserverUrl) The Apache Airflow web server host name for the Amazon MWAA environment.webserverVpcEndpointService
(String webserverVpcEndpointService) The VPC endpoint for the environment's web server.weeklyMaintenanceWindowStart
(String weeklyMaintenanceWindowStart) 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.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
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.
- Parameters:
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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
.- Parameters:
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
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
arn
The Amazon Resource Name (ARN) of the Amazon MWAA environment.
- Parameters:
arn
- The Amazon Resource Name (ARN) of the Amazon MWAA environment.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- Parameters:
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:
- Returns a reference to this object so that method calls can be chained together.
-
createdAt
The day and time the environment was created.
- Parameters:
createdAt
- The day and time the environment was created.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.- Parameters:
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:
- Returns a reference to this object so that method calls can be chained together.
-
databaseVpcEndpointService
The VPC endpoint for the environment's Amazon RDS database.
- Parameters:
databaseVpcEndpointService
- The VPC endpoint for the environment's Amazon RDS database.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.- Parameters:
endpointManagement
- Defines whether the VPC endpoints configured for the environment are created, and managed, by the customer or by Amazon MWAA. If set toSERVICE
, 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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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.- Parameters:
endpointManagement
- Defines whether the VPC endpoints configured for the environment are created, and managed, by the customer or by Amazon MWAA. If set toSERVICE
, 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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
environmentClass
The environment class type. Valid values:
mw1.small
,mw1.medium
,mw1.large
. For more information, see Amazon MWAA environment class.- Parameters:
environmentClass
- The environment class type. Valid values:mw1.small
,mw1.medium
,mw1.large
. For more information, see Amazon MWAA environment class.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.- Parameters:
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:
- Returns a reference to this object so that method calls can be chained together.
-
kmsKey
The KMS encryption key used to encrypt the data in your environment.
- Parameters:
kmsKey
- The KMS encryption key used to encrypt the data in your environment.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
lastUpdate
The status of the last update on the environment.
- Parameters:
lastUpdate
- The status of the last update on the environment.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
lastUpdate
The status of the last update on the environment.
This is a convenience method that creates an instance of theLastUpdate.Builder
avoiding the need to create one manually viaLastUpdate.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tolastUpdate(LastUpdate)
.- Parameters:
lastUpdate
- a consumer that will call methods onLastUpdate.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
loggingConfiguration
The Apache Airflow logs published to CloudWatch Logs.
- Parameters:
loggingConfiguration
- The Apache Airflow logs published to CloudWatch Logs.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
loggingConfiguration
default Environment.Builder loggingConfiguration(Consumer<LoggingConfiguration.Builder> loggingConfiguration) The Apache Airflow logs published to CloudWatch Logs.
This is a convenience method that creates an instance of theLoggingConfiguration.Builder
avoiding the need to create one manually viaLoggingConfiguration.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tologgingConfiguration(LoggingConfiguration)
.- Parameters:
loggingConfiguration
- a consumer that will call methods onLoggingConfiguration.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
maxWorkers
The maximum number of workers that run in your environment. For example,
20
.- Parameters:
maxWorkers
- The maximum number of workers that run in your environment. For example,20
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
minWorkers
The minimum number of workers that run in your environment. For example,
2
.- Parameters:
minWorkers
- The minimum number of workers that run in your environment. For example,2
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
name
The name of the Amazon MWAA environment. For example,
MyMWAAEnvironment
.- Parameters:
name
- The name of the Amazon MWAA environment. For example,MyMWAAEnvironment
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- Parameters:
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:
- Returns a reference to this object so that method calls can be chained together.
-
networkConfiguration
default Environment.Builder networkConfiguration(Consumer<NetworkConfiguration.Builder> 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.
This is a convenience method that creates an instance of theNetworkConfiguration.Builder
avoiding the need to create one manually viaNetworkConfiguration.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tonetworkConfiguration(NetworkConfiguration)
.- Parameters:
networkConfiguration
- a consumer that will call methods onNetworkConfiguration.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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.
- Parameters:
pluginsS3ObjectVersion
- The version of theplugins.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:
- Returns a reference to this object so that method calls can be chained together.
-
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.- Parameters:
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:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- Parameters:
requirementsS3ObjectVersion
- The version of therequirements.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:
- Returns a reference to this object so that method calls can be chained together.
-
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.- Parameters:
requirementsS3Path
- The relative path to therequirements.txt
file in your Amazon S3 bucket. For example,s3://mwaa-environment/requirements.txt
. For more information, see Installing Python dependencies.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
schedulers
The number of Apache Airflow schedulers that run in your Amazon MWAA environment.
- Parameters:
schedulers
- The number of Apache Airflow schedulers that run in your Amazon MWAA environment.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
serviceRoleArn
The Amazon Resource Name (ARN) for the service-linked role of the environment. For more information, see Amazon MWAA Service-linked role.
- Parameters:
serviceRoleArn
- The Amazon Resource Name (ARN) for the service-linked role of the environment. For more information, see Amazon MWAA Service-linked role.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.- Parameters:
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:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- Parameters:
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:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- Parameters:
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:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- Parameters:
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.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
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.
- Parameters:
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.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
tags
The key-value tag pairs associated to your environment. For example,
"Environment": "Staging"
. For more information, see Tagging Amazon Web Services resources.- Parameters:
tags
- The key-value tag pairs associated to your environment. For example,"Environment": "Staging"
. For more information, see Tagging Amazon Web Services resources.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
webserverAccessMode
The Apache Airflow web server access mode. For more information, see Apache Airflow access modes.
- Parameters:
webserverAccessMode
- The Apache Airflow web server access mode. For more information, see Apache Airflow access modes.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
webserverAccessMode
The Apache Airflow web server access mode. For more information, see Apache Airflow access modes.
- Parameters:
webserverAccessMode
- The Apache Airflow web server access mode. For more information, see Apache Airflow access modes.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
webserverUrl
The Apache Airflow web server host name for the Amazon MWAA environment. For more information, see Accessing the Apache Airflow UI.
- Parameters:
webserverUrl
- The Apache Airflow web server host name for the Amazon MWAA environment. For more information, see Accessing the Apache Airflow UI.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
webserverVpcEndpointService
The VPC endpoint for the environment's web server.
- Parameters:
webserverVpcEndpointService
- The VPC endpoint for the environment's web server.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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
.- Parameters:
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:
- Returns a reference to this object so that method calls can be chained together.
-