@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class Environment extends Object implements Serializable, Cloneable, StructuredPojo
Describes an Amazon Managed Workflows for Apache Airflow (MWAA) environment.
Constructor and Description |
---|
Environment() |
Modifier and Type | Method and Description |
---|---|
Environment |
addAirflowConfigurationOptionsEntry(String key,
String value)
Add a single AirflowConfigurationOptions entry
|
Environment |
addTagsEntry(String key,
String value)
Add a single Tags entry
|
Environment |
clearAirflowConfigurationOptionsEntries()
Removes all the entries added into AirflowConfigurationOptions.
|
Environment |
clearTagsEntries()
Removes all the entries added into Tags.
|
Environment |
clone() |
boolean |
equals(Object obj) |
Map<String,String> |
getAirflowConfigurationOptions()
A list of key-value pairs containing the Apache Airflow configuration options attached to your environment.
|
String |
getAirflowVersion()
The Apache Airflow version on your environment.
|
String |
getArn()
The Amazon Resource Name (ARN) of the Amazon MWAA environment.
|
String |
getCeleryExecutorQueue()
The queue ARN for the environment's Celery
Executor.
|
Date |
getCreatedAt()
The day and time the environment was created.
|
String |
getDagS3Path()
The relative path to the DAGs folder in your Amazon S3 bucket.
|
String |
getDatabaseVpcEndpointService()
The VPC endpoint for the environment's Amazon RDS database.
|
String |
getEndpointManagement()
Defines whether the VPC endpoints configured for the environment are created, and managed, by the customer or by
Amazon MWAA.
|
String |
getEnvironmentClass()
The environment class type.
|
String |
getExecutionRoleArn()
The Amazon Resource Name (ARN) of the execution role in IAM that allows MWAA to access Amazon Web Services
resources in your environment.
|
String |
getKmsKey()
The KMS encryption key used to encrypt the data in your environment.
|
LastUpdate |
getLastUpdate()
The status of the last update on the environment.
|
LoggingConfiguration |
getLoggingConfiguration()
The Apache Airflow logs published to CloudWatch Logs.
|
Integer |
getMaxWebservers()
The maximum number of web servers that you want to run in your environment.
|
Integer |
getMaxWorkers()
The maximum number of workers that run in your environment.
|
Integer |
getMinWebservers()
The minimum number of web servers that you want to run in your environment.
|
Integer |
getMinWorkers()
The minimum number of workers that run in your environment.
|
String |
getName()
The name of the Amazon MWAA environment.
|
NetworkConfiguration |
getNetworkConfiguration()
Describes the VPC networking components used to secure and enable network traffic between the Amazon Web Services
resources for your environment.
|
String |
getPluginsS3ObjectVersion()
The version of the
plugins.zip file in your Amazon S3 bucket. |
String |
getPluginsS3Path()
The relative path to the file in your Amazon S3 bucket.
|
String |
getRequirementsS3ObjectVersion()
The version of the
requirements.txt file on your Amazon S3 bucket. |
String |
getRequirementsS3Path()
The relative path to the
requirements.txt file in your Amazon S3 bucket. |
Integer |
getSchedulers()
The number of Apache Airflow schedulers that run in your Amazon MWAA environment.
|
String |
getServiceRoleArn()
The Amazon Resource Name (ARN) for the service-linked role of the environment.
|
String |
getSourceBucketArn()
The Amazon Resource Name (ARN) of the Amazon S3 bucket where your DAG code and supporting files are stored.
|
String |
getStartupScriptS3ObjectVersion()
The version of the startup shell script in your Amazon S3 bucket.
|
String |
getStartupScriptS3Path()
The relative path to the startup shell script in your Amazon S3 bucket.
|
String |
getStatus()
The status of the Amazon MWAA environment.
|
Map<String,String> |
getTags()
The key-value tag pairs associated to your environment.
|
String |
getWebserverAccessMode()
The Apache Airflow web server access mode.
|
String |
getWebserverUrl()
The Apache Airflow web server host name for the Amazon MWAA environment.
|
String |
getWebserverVpcEndpointService()
The VPC endpoint for the environment's web server.
|
String |
getWeeklyMaintenanceWindowStart()
The day and time of the week in Coordinated Universal Time (UTC) 24-hour standard time that weekly maintenance
updates are scheduled.
|
int |
hashCode() |
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
void |
setAirflowConfigurationOptions(Map<String,String> airflowConfigurationOptions)
A list of key-value pairs containing the Apache Airflow configuration options attached to your environment.
|
void |
setAirflowVersion(String airflowVersion)
The Apache Airflow version on your environment.
|
void |
setArn(String arn)
The Amazon Resource Name (ARN) of the Amazon MWAA environment.
|
void |
setCeleryExecutorQueue(String celeryExecutorQueue)
The queue ARN for the environment's Celery
Executor.
|
void |
setCreatedAt(Date createdAt)
The day and time the environment was created.
|
void |
setDagS3Path(String dagS3Path)
The relative path to the DAGs folder in your Amazon S3 bucket.
|
void |
setDatabaseVpcEndpointService(String databaseVpcEndpointService)
The VPC endpoint for the environment's Amazon RDS database.
|
void |
setEndpointManagement(String endpointManagement)
Defines whether the VPC endpoints configured for the environment are created, and managed, by the customer or by
Amazon MWAA.
|
void |
setEnvironmentClass(String environmentClass)
The environment class type.
|
void |
setExecutionRoleArn(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.
|
void |
setKmsKey(String kmsKey)
The KMS encryption key used to encrypt the data in your environment.
|
void |
setLastUpdate(LastUpdate lastUpdate)
The status of the last update on the environment.
|
void |
setLoggingConfiguration(LoggingConfiguration loggingConfiguration)
The Apache Airflow logs published to CloudWatch Logs.
|
void |
setMaxWebservers(Integer maxWebservers)
The maximum number of web servers that you want to run in your environment.
|
void |
setMaxWorkers(Integer maxWorkers)
The maximum number of workers that run in your environment.
|
void |
setMinWebservers(Integer minWebservers)
The minimum number of web servers that you want to run in your environment.
|
void |
setMinWorkers(Integer minWorkers)
The minimum number of workers that run in your environment.
|
void |
setName(String name)
The name of the Amazon MWAA environment.
|
void |
setNetworkConfiguration(NetworkConfiguration networkConfiguration)
Describes the VPC networking components used to secure and enable network traffic between the Amazon Web Services
resources for your environment.
|
void |
setPluginsS3ObjectVersion(String pluginsS3ObjectVersion)
The version of the
plugins.zip file in your Amazon S3 bucket. |
void |
setPluginsS3Path(String pluginsS3Path)
The relative path to the file in your Amazon S3 bucket.
|
void |
setRequirementsS3ObjectVersion(String requirementsS3ObjectVersion)
The version of the
requirements.txt file on your Amazon S3 bucket. |
void |
setRequirementsS3Path(String requirementsS3Path)
The relative path to the
requirements.txt file in your Amazon S3 bucket. |
void |
setSchedulers(Integer schedulers)
The number of Apache Airflow schedulers that run in your Amazon MWAA environment.
|
void |
setServiceRoleArn(String serviceRoleArn)
The Amazon Resource Name (ARN) for the service-linked role of the environment.
|
void |
setSourceBucketArn(String sourceBucketArn)
The Amazon Resource Name (ARN) of the Amazon S3 bucket where your DAG code and supporting files are stored.
|
void |
setStartupScriptS3ObjectVersion(String startupScriptS3ObjectVersion)
The version of the startup shell script in your Amazon S3 bucket.
|
void |
setStartupScriptS3Path(String startupScriptS3Path)
The relative path to the startup shell script in your Amazon S3 bucket.
|
void |
setStatus(String status)
The status of the Amazon MWAA environment.
|
void |
setTags(Map<String,String> tags)
The key-value tag pairs associated to your environment.
|
void |
setWebserverAccessMode(String webserverAccessMode)
The Apache Airflow web server access mode.
|
void |
setWebserverUrl(String webserverUrl)
The Apache Airflow web server host name for the Amazon MWAA environment.
|
void |
setWebserverVpcEndpointService(String webserverVpcEndpointService)
The VPC endpoint for the environment's web server.
|
void |
setWeeklyMaintenanceWindowStart(String weeklyMaintenanceWindowStart)
The day and time of the week in Coordinated Universal Time (UTC) 24-hour standard time that weekly maintenance
updates are scheduled.
|
String |
toString()
Returns a string representation of this object.
|
Environment |
withAirflowConfigurationOptions(Map<String,String> airflowConfigurationOptions)
A list of key-value pairs containing the Apache Airflow configuration options attached to your environment.
|
Environment |
withAirflowVersion(String airflowVersion)
The Apache Airflow version on your environment.
|
Environment |
withArn(String arn)
The Amazon Resource Name (ARN) of the Amazon MWAA environment.
|
Environment |
withCeleryExecutorQueue(String celeryExecutorQueue)
The queue ARN for the environment's Celery
Executor.
|
Environment |
withCreatedAt(Date createdAt)
The day and time the environment was created.
|
Environment |
withDagS3Path(String dagS3Path)
The relative path to the DAGs folder in your Amazon S3 bucket.
|
Environment |
withDatabaseVpcEndpointService(String databaseVpcEndpointService)
The VPC endpoint for the environment's Amazon RDS database.
|
Environment |
withEndpointManagement(EndpointManagement endpointManagement)
Defines whether the VPC endpoints configured for the environment are created, and managed, by the customer or by
Amazon MWAA.
|
Environment |
withEndpointManagement(String endpointManagement)
Defines whether the VPC endpoints configured for the environment are created, and managed, by the customer or by
Amazon MWAA.
|
Environment |
withEnvironmentClass(String environmentClass)
The environment class type.
|
Environment |
withExecutionRoleArn(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.
|
Environment |
withKmsKey(String kmsKey)
The KMS encryption key used to encrypt the data in your environment.
|
Environment |
withLastUpdate(LastUpdate lastUpdate)
The status of the last update on the environment.
|
Environment |
withLoggingConfiguration(LoggingConfiguration loggingConfiguration)
The Apache Airflow logs published to CloudWatch Logs.
|
Environment |
withMaxWebservers(Integer maxWebservers)
The maximum number of web servers that you want to run in your environment.
|
Environment |
withMaxWorkers(Integer maxWorkers)
The maximum number of workers that run in your environment.
|
Environment |
withMinWebservers(Integer minWebservers)
The minimum number of web servers that you want to run in your environment.
|
Environment |
withMinWorkers(Integer minWorkers)
The minimum number of workers that run in your environment.
|
Environment |
withName(String name)
The name of the Amazon MWAA environment.
|
Environment |
withNetworkConfiguration(NetworkConfiguration networkConfiguration)
Describes the VPC networking components used to secure and enable network traffic between the Amazon Web Services
resources for your environment.
|
Environment |
withPluginsS3ObjectVersion(String pluginsS3ObjectVersion)
The version of the
plugins.zip file in your Amazon S3 bucket. |
Environment |
withPluginsS3Path(String pluginsS3Path)
The relative path to the file in your Amazon S3 bucket.
|
Environment |
withRequirementsS3ObjectVersion(String requirementsS3ObjectVersion)
The version of the
requirements.txt file on your Amazon S3 bucket. |
Environment |
withRequirementsS3Path(String requirementsS3Path)
The relative path to the
requirements.txt file in your Amazon S3 bucket. |
Environment |
withSchedulers(Integer schedulers)
The number of Apache Airflow schedulers that run in your Amazon MWAA environment.
|
Environment |
withServiceRoleArn(String serviceRoleArn)
The Amazon Resource Name (ARN) for the service-linked role of the environment.
|
Environment |
withSourceBucketArn(String sourceBucketArn)
The Amazon Resource Name (ARN) of the Amazon S3 bucket where your DAG code and supporting files are stored.
|
Environment |
withStartupScriptS3ObjectVersion(String startupScriptS3ObjectVersion)
The version of the startup shell script in your Amazon S3 bucket.
|
Environment |
withStartupScriptS3Path(String startupScriptS3Path)
The relative path to the startup shell script in your Amazon S3 bucket.
|
Environment |
withStatus(EnvironmentStatus status)
The status of the Amazon MWAA environment.
|
Environment |
withStatus(String status)
The status of the Amazon MWAA environment.
|
Environment |
withTags(Map<String,String> tags)
The key-value tag pairs associated to your environment.
|
Environment |
withWebserverAccessMode(String webserverAccessMode)
The Apache Airflow web server access mode.
|
Environment |
withWebserverAccessMode(WebserverAccessMode webserverAccessMode)
The Apache Airflow web server access mode.
|
Environment |
withWebserverUrl(String webserverUrl)
The Apache Airflow web server host name for the Amazon MWAA environment.
|
Environment |
withWebserverVpcEndpointService(String webserverVpcEndpointService)
The VPC endpoint for the environment's web server.
|
Environment |
withWeeklyMaintenanceWindowStart(String weeklyMaintenanceWindowStart)
The day and time of the week in Coordinated Universal Time (UTC) 24-hour standard time that weekly maintenance
updates are scheduled.
|
public void setName(String name)
The name of the Amazon MWAA environment. For example, MyMWAAEnvironment
.
name
- The name of the Amazon MWAA environment. For example, MyMWAAEnvironment
.public String getName()
The name of the Amazon MWAA environment. For example, MyMWAAEnvironment
.
MyMWAAEnvironment
.public Environment withName(String name)
The name of the Amazon MWAA environment. For example, MyMWAAEnvironment
.
name
- The name of the Amazon MWAA environment. For example, MyMWAAEnvironment
.public void setStatus(String 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.
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.
EnvironmentStatus
public String getStatus()
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.
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.
EnvironmentStatus
public Environment withStatus(String 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.
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.
EnvironmentStatus
public Environment withStatus(EnvironmentStatus 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.
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.
EnvironmentStatus
public void setArn(String arn)
The Amazon Resource Name (ARN) of the Amazon MWAA environment.
arn
- The Amazon Resource Name (ARN) of the Amazon MWAA environment.public String getArn()
The Amazon Resource Name (ARN) of the Amazon MWAA environment.
public Environment withArn(String arn)
The Amazon Resource Name (ARN) of the Amazon MWAA environment.
arn
- The Amazon Resource Name (ARN) of the Amazon MWAA environment.public void setCreatedAt(Date createdAt)
The day and time the environment was created.
createdAt
- The day and time the environment was created.public Date getCreatedAt()
The day and time the environment was created.
public Environment withCreatedAt(Date createdAt)
The day and time the environment was created.
createdAt
- The day and time the environment was created.public void setWebserverUrl(String webserverUrl)
The Apache Airflow web server host name for the Amazon MWAA environment. For more information, see Accessing the Apache Airflow UI.
webserverUrl
- The Apache Airflow web server host name for the Amazon MWAA environment. For more information, see
Accessing the Apache
Airflow UI.public String getWebserverUrl()
The Apache Airflow web server host name for the Amazon MWAA environment. For more information, see Accessing the Apache Airflow UI.
public Environment withWebserverUrl(String webserverUrl)
The Apache Airflow web server host name for the Amazon MWAA environment. For more information, see Accessing the Apache Airflow UI.
webserverUrl
- The Apache Airflow web server host name for the Amazon MWAA environment. For more information, see
Accessing the Apache
Airflow UI.public void setExecutionRoleArn(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. For example, arn:aws:iam::123456789:role/my-execution-role
. For more
information, see Amazon MWAA
Execution role.
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.public String getExecutionRoleArn()
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.
arn:aws:iam::123456789:role/my-execution-role
. For more information, see Amazon MWAA Execution
role.public Environment withExecutionRoleArn(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. For example, arn:aws:iam::123456789:role/my-execution-role
. For more
information, see Amazon MWAA
Execution role.
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.public void setServiceRoleArn(String serviceRoleArn)
The Amazon Resource Name (ARN) for the service-linked role of the environment. For more information, see Amazon MWAA Service-linked role.
serviceRoleArn
- The Amazon Resource Name (ARN) for the service-linked role of the environment. For more information, see
Amazon MWAA Service-linked
role.public String getServiceRoleArn()
The Amazon Resource Name (ARN) for the service-linked role of the environment. For more information, see Amazon MWAA Service-linked role.
public Environment withServiceRoleArn(String serviceRoleArn)
The Amazon Resource Name (ARN) for the service-linked role of the environment. For more information, see Amazon MWAA Service-linked role.
serviceRoleArn
- The Amazon Resource Name (ARN) for the service-linked role of the environment. For more information, see
Amazon MWAA Service-linked
role.public void setKmsKey(String kmsKey)
The KMS encryption key used to encrypt the data in your environment.
kmsKey
- The KMS encryption key used to encrypt the data in your environment.public String getKmsKey()
The KMS encryption key used to encrypt the data in your environment.
public Environment withKmsKey(String kmsKey)
The KMS encryption key used to encrypt the data in your environment.
kmsKey
- The KMS encryption key used to encrypt the data in your environment.public void setAirflowVersion(String 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
.
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
.
public String getAirflowVersion()
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
.
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
.
public Environment withAirflowVersion(String 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
.
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
.
public void setSourceBucketArn(String 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.
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.public String getSourceBucketArn()
The Amazon Resource Name (ARN) of the Amazon S3 bucket where your DAG code and supporting files are stored. For
example, arn:aws:s3:::my-airflow-bucket-unique-name
. For more information, see Create an Amazon S3 bucket for
Amazon MWAA.
arn:aws:s3:::my-airflow-bucket-unique-name
. For more information, see
Create an Amazon S3
bucket for Amazon MWAA.public Environment withSourceBucketArn(String 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.
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.public void setDagS3Path(String 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.
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.public String getDagS3Path()
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.
s3://mwaa-environment/dags
. For more information, see Adding or updating
DAGs.public Environment withDagS3Path(String 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.
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.public void setPluginsS3Path(String 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.
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.public String getPluginsS3Path()
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.
s3://mwaa-environment/plugins.zip
. For more information, see Installing
custom plugins.public Environment withPluginsS3Path(String 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.
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.public void setPluginsS3ObjectVersion(String 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.
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.
public String getPluginsS3ObjectVersion()
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.
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.
public Environment withPluginsS3ObjectVersion(String 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.
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.
public void setRequirementsS3Path(String 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.
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.public String getRequirementsS3Path()
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.
requirements.txt
file in your Amazon S3 bucket. For example,
s3://mwaa-environment/requirements.txt
. For more information, see Installing Python
dependencies.public Environment withRequirementsS3Path(String 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.
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.public void setRequirementsS3ObjectVersion(String 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.
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.
public String getRequirementsS3ObjectVersion()
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.
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.
public Environment withRequirementsS3ObjectVersion(String 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.
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.
public void setStartupScriptS3Path(String 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.
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.
public String getStartupScriptS3Path()
The relative path to the startup shell script in your Amazon S3 bucket. For example,
s3://mwaa-environment/startup.sh
.
Amazon MWAA runs the script as your environment starts, and before running the Apache Airflow process. You can use this script to install dependencies, modify Apache Airflow configuration options, and set environment variables. For more information, see Using a startup script.
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.
public Environment withStartupScriptS3Path(String 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.
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.
public void setStartupScriptS3ObjectVersion(String 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.
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.
public String getStartupScriptS3ObjectVersion()
The version of the startup shell script in your Amazon S3 bucket. You must specify the version ID that Amazon S3 assigns to the file.
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.
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.
public Environment withStartupScriptS3ObjectVersion(String 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.
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.
public Map<String,String> getAirflowConfigurationOptions()
A list of key-value pairs containing the Apache Airflow configuration options attached to your environment. For more information, see Apache Airflow configuration options.
public void setAirflowConfigurationOptions(Map<String,String> 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.
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.public Environment withAirflowConfigurationOptions(Map<String,String> 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.
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.public Environment addAirflowConfigurationOptionsEntry(String key, String value)
public Environment clearAirflowConfigurationOptionsEntries()
public void setEnvironmentClass(String environmentClass)
The environment class type. Valid values: mw1.small
, mw1.medium
, mw1.large
, mw1.xlarge
, and mw1.2xlarge
. For more information, see Amazon MWAA environment
class.
environmentClass
- The environment class type. Valid values: mw1.small
, mw1.medium
,
mw1.large
, mw1.xlarge
, and mw1.2xlarge
. For more information, see
Amazon MWAA environment
class.public String getEnvironmentClass()
The environment class type. Valid values: mw1.small
, mw1.medium
, mw1.large
, mw1.xlarge
, and mw1.2xlarge
. For more information, see Amazon MWAA environment
class.
mw1.small
, mw1.medium
,
mw1.large
, mw1.xlarge
, and mw1.2xlarge
. For more information, see
Amazon MWAA
environment class.public Environment withEnvironmentClass(String environmentClass)
The environment class type. Valid values: mw1.small
, mw1.medium
, mw1.large
, mw1.xlarge
, and mw1.2xlarge
. For more information, see Amazon MWAA environment
class.
environmentClass
- The environment class type. Valid values: mw1.small
, mw1.medium
,
mw1.large
, mw1.xlarge
, and mw1.2xlarge
. For more information, see
Amazon MWAA environment
class.public void setMaxWorkers(Integer maxWorkers)
The maximum number of workers that run in your environment. For example, 20
.
maxWorkers
- The maximum number of workers that run in your environment. For example, 20
.public Integer getMaxWorkers()
The maximum number of workers that run in your environment. For example, 20
.
20
.public Environment withMaxWorkers(Integer maxWorkers)
The maximum number of workers that run in your environment. For example, 20
.
maxWorkers
- The maximum number of workers that run in your environment. For example, 20
.public void setNetworkConfiguration(NetworkConfiguration 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.
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.public NetworkConfiguration getNetworkConfiguration()
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.
public Environment withNetworkConfiguration(NetworkConfiguration 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.
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.public void setLoggingConfiguration(LoggingConfiguration loggingConfiguration)
The Apache Airflow logs published to CloudWatch Logs.
loggingConfiguration
- The Apache Airflow logs published to CloudWatch Logs.public LoggingConfiguration getLoggingConfiguration()
The Apache Airflow logs published to CloudWatch Logs.
public Environment withLoggingConfiguration(LoggingConfiguration loggingConfiguration)
The Apache Airflow logs published to CloudWatch Logs.
loggingConfiguration
- The Apache Airflow logs published to CloudWatch Logs.public void setLastUpdate(LastUpdate lastUpdate)
The status of the last update on the environment.
lastUpdate
- The status of the last update on the environment.public LastUpdate getLastUpdate()
The status of the last update on the environment.
public Environment withLastUpdate(LastUpdate lastUpdate)
The status of the last update on the environment.
lastUpdate
- The status of the last update on the environment.public void setWeeklyMaintenanceWindowStart(String 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
.
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
.public String getWeeklyMaintenanceWindowStart()
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
.
TUE:03:30
.public Environment withWeeklyMaintenanceWindowStart(String 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
.
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
.public Map<String,String> getTags()
The key-value tag pairs associated to your environment. For example, "Environment": "Staging"
. For
more information, see Tagging Amazon Web
Services resources.
"Environment": "Staging"
. For more information, see Tagging Amazon Web Services
resources.public void setTags(Map<String,String> tags)
The key-value tag pairs associated to your environment. For example, "Environment": "Staging"
. For
more information, see Tagging Amazon Web
Services resources.
tags
- The key-value tag pairs associated to your environment. For example, "Environment": "Staging"
. For more information, see Tagging Amazon Web Services
resources.public Environment withTags(Map<String,String> tags)
The key-value tag pairs associated to your environment. For example, "Environment": "Staging"
. For
more information, see Tagging Amazon Web
Services resources.
tags
- The key-value tag pairs associated to your environment. For example, "Environment": "Staging"
. For more information, see Tagging Amazon Web Services
resources.public Environment addTagsEntry(String key, String value)
public Environment clearTagsEntries()
public void setWebserverAccessMode(String webserverAccessMode)
The Apache Airflow web server access mode. For more information, see Apache Airflow access modes.
webserverAccessMode
- The Apache Airflow web server access mode. For more information, see Apache Airflow access
modes.WebserverAccessMode
public String getWebserverAccessMode()
The Apache Airflow web server access mode. For more information, see Apache Airflow access modes.
WebserverAccessMode
public Environment withWebserverAccessMode(String webserverAccessMode)
The Apache Airflow web server access mode. For more information, see Apache Airflow access modes.
webserverAccessMode
- The Apache Airflow web server access mode. For more information, see Apache Airflow access
modes.WebserverAccessMode
public Environment withWebserverAccessMode(WebserverAccessMode webserverAccessMode)
The Apache Airflow web server access mode. For more information, see Apache Airflow access modes.
webserverAccessMode
- The Apache Airflow web server access mode. For more information, see Apache Airflow access
modes.WebserverAccessMode
public void setMinWorkers(Integer minWorkers)
The minimum number of workers that run in your environment. For example, 2
.
minWorkers
- The minimum number of workers that run in your environment. For example, 2
.public Integer getMinWorkers()
The minimum number of workers that run in your environment. For example, 2
.
2
.public Environment withMinWorkers(Integer minWorkers)
The minimum number of workers that run in your environment. For example, 2
.
minWorkers
- The minimum number of workers that run in your environment. For example, 2
.public void setSchedulers(Integer schedulers)
The number of Apache Airflow schedulers that run in your Amazon MWAA environment.
schedulers
- The number of Apache Airflow schedulers that run in your Amazon MWAA environment.public Integer getSchedulers()
The number of Apache Airflow schedulers that run in your Amazon MWAA environment.
public Environment withSchedulers(Integer schedulers)
The number of Apache Airflow schedulers that run in your Amazon MWAA environment.
schedulers
- The number of Apache Airflow schedulers that run in your Amazon MWAA environment.public void setWebserverVpcEndpointService(String webserverVpcEndpointService)
The VPC endpoint for the environment's web server.
webserverVpcEndpointService
- The VPC endpoint for the environment's web server.public String getWebserverVpcEndpointService()
The VPC endpoint for the environment's web server.
public Environment withWebserverVpcEndpointService(String webserverVpcEndpointService)
The VPC endpoint for the environment's web server.
webserverVpcEndpointService
- The VPC endpoint for the environment's web server.public void setDatabaseVpcEndpointService(String databaseVpcEndpointService)
The VPC endpoint for the environment's Amazon RDS database.
databaseVpcEndpointService
- The VPC endpoint for the environment's Amazon RDS database.public String getDatabaseVpcEndpointService()
The VPC endpoint for the environment's Amazon RDS database.
public Environment withDatabaseVpcEndpointService(String databaseVpcEndpointService)
The VPC endpoint for the environment's Amazon RDS database.
databaseVpcEndpointService
- The VPC endpoint for the environment's Amazon RDS database.public void setCeleryExecutorQueue(String 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.
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.public String getCeleryExecutorQueue()
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.
public Environment withCeleryExecutorQueue(String 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.
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.public void setEndpointManagement(String 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 to CUSTOMER
, you must create, and manage, the VPC endpoints in 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 to CUSTOMER
, you must create, and manage, the VPC endpoints in
your VPC.EndpointManagement
public String getEndpointManagement()
Defines whether the VPC endpoints configured for the environment are created, and managed, by the customer or by
Amazon MWAA. If set to SERVICE
, Amazon MWAA will create and manage the required VPC endpoints in
your VPC. If set to CUSTOMER
, you must create, and manage, the VPC endpoints in your VPC.
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.EndpointManagement
public Environment withEndpointManagement(String 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 to CUSTOMER
, you must create, and manage, the VPC endpoints in 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 to CUSTOMER
, you must create, and manage, the VPC endpoints in
your VPC.EndpointManagement
public Environment withEndpointManagement(EndpointManagement 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 to CUSTOMER
, you must create, and manage, the VPC endpoints in 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 to CUSTOMER
, you must create, and manage, the VPC endpoints in
your VPC.EndpointManagement
public void setMinWebservers(Integer 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 in MinxWebserers
.
Valid values: Accepts between 2
and 5
. Defaults to 2
.
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 in MinxWebserers
.
Valid values: Accepts between 2
and 5
. Defaults to 2
.
public Integer getMinWebservers()
The minimum number of web servers that you want to run in your environment. Amazon MWAA scales the number of
Apache Airflow web servers up to the number you specify for MaxWebservers
when you interact with
your Apache Airflow environment using Apache Airflow REST API, or the Apache Airflow CLI. As the
transaction-per-second rate, and the network load, decrease, Amazon MWAA disposes of the additional web servers,
and scales down to the number set in MinxWebserers
.
Valid values: Accepts between 2
and 5
. Defaults to 2
.
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: Accepts between 2
and 5
. Defaults to 2
.
public Environment withMinWebservers(Integer 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 in MinxWebserers
.
Valid values: Accepts between 2
and 5
. Defaults to 2
.
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 in MinxWebserers
.
Valid values: Accepts between 2
and 5
. Defaults to 2
.
public void setMaxWebservers(Integer 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 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: Accepts between 2
and 5
. Defaults to 2
.
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 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: Accepts between 2
and 5
. Defaults to 2
.
public Integer getMaxWebservers()
The maximum number of web servers that you want to run in your environment. Amazon MWAA scales the number of
Apache Airflow web servers up to the number you specify for MaxWebservers
when you interact with
your Apache Airflow environment using Apache Airflow REST API, or the Apache Airflow CLI. For example, in
scenarios where your workload requires network calls to the Apache Airflow REST API with a high
transaction-per-second (TPS) rate, Amazon MWAA will increase the number of web servers up to the number set 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: Accepts between 2
and 5
. Defaults to 2
.
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: Accepts between 2
and 5
. Defaults to 2
.
public Environment withMaxWebservers(Integer 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 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: Accepts between 2
and 5
. Defaults to 2
.
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 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: Accepts between 2
and 5
. Defaults to 2
.
public String toString()
toString
in class Object
Object.toString()
public Environment clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.