@Generated(value="software.amazon.awssdk:codegen") public final class Environment extends Object implements SdkPojo, Serializable, ToCopyableBuilder<Environment.Builder,Environment>
Describes an Amazon Managed Workflows for Apache Airflow (MWAA) environment.
| Modifier and Type | Class and Description |
|---|---|
static interface |
Environment.Builder |
| Modifier and Type | Method and Description |
|---|---|
Map<String,String> |
airflowConfigurationOptions()
A list of key-value pairs containing the Apache Airflow configuration options attached to your environment.
|
String |
airflowVersion()
The Apache Airflow version on your environment.
|
String |
arn()
The Amazon Resource Name (ARN) of the Amazon MWAA environment.
|
static Environment.Builder |
builder() |
Instant |
createdAt()
The day and time the environment was created.
|
String |
dagS3Path()
The relative path to the DAGs folder in your Amazon S3 bucket.
|
String |
environmentClass()
The environment class type.
|
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj) |
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.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
boolean |
hasAirflowConfigurationOptions()
For responses, this returns true if the service returned a value for the AirflowConfigurationOptions property.
|
int |
hashCode() |
boolean |
hasTags()
For responses, this returns true if the service returned a value for the Tags property.
|
String |
kmsKey()
The Amazon Web Services Key Management Service (KMS) encryption key used to encrypt the data in your environment.
|
LastUpdate |
lastUpdate()
The status of the last update on the environment.
|
LoggingConfiguration |
loggingConfiguration()
The Apache Airflow logs published to CloudWatch Logs.
|
Integer |
maxWorkers()
The maximum number of workers that run in your environment.
|
Integer |
minWorkers()
The minimum number of workers that run in your environment.
|
String |
name()
The name of the Amazon MWAA environment.
|
NetworkConfiguration |
networkConfiguration()
Describes the VPC networking components used to secure and enable network traffic between the Amazon Web Services
resources for your environment.
|
String |
pluginsS3ObjectVersion()
The version of the
plugins.zip file in your Amazon S3 bucket. |
String |
pluginsS3Path()
The relative path to the file in your Amazon S3 bucket.
|
String |
requirementsS3ObjectVersion()
The version of the
requirements.txt file on your Amazon S3 bucket. |
String |
requirementsS3Path()
The relative path to the
requirements.txt file in your Amazon S3 bucket. |
Integer |
schedulers()
The number of Apache Airflow schedulers that run in your Amazon MWAA environment.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends Environment.Builder> |
serializableBuilderClass() |
String |
serviceRoleArn()
The Amazon Resource Name (ARN) for the service-linked role of the environment.
|
String |
sourceBucketArn()
The Amazon Resource Name (ARN) of the Amazon S3 bucket where your DAG code and supporting files are stored.
|
String |
startupScriptS3ObjectVersion()
The version of the startup shell script in your Amazon S3 bucket.
|
String |
startupScriptS3Path()
The relative path to the startup shell script in your Amazon S3 bucket.
|
EnvironmentStatus |
status()
The status of the Amazon MWAA environment.
|
String |
statusAsString()
The status of the Amazon MWAA environment.
|
Map<String,String> |
tags()
The key-value tag pairs associated to your environment.
|
Environment.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
WebserverAccessMode |
webserverAccessMode()
The Apache Airflow Web server access mode.
|
String |
webserverAccessModeAsString()
The Apache Airflow Web server access mode.
|
String |
webserverUrl()
The Apache Airflow Web server host name for the Amazon MWAA environment.
|
String |
weeklyMaintenanceWindowStart()
The day and time of the week in Coordinated Universal Time (UTC) 24-hour standard time that weekly maintenance
updates are scheduled.
|
clone, finalize, getClass, notify, notifyAll, wait, wait, waitcopypublic final boolean hasAirflowConfigurationOptions()
isEmpty() method on the
property). This is useful because the SDK will never return a null collection or map, but you may need to
differentiate between the service returning nothing (or null) and the service returning an empty collection or
map. For requests, this returns true if a value for the property was specified in the request builder, and false
if a value was not specified.public final 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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasAirflowConfigurationOptions() method.
public final String airflowVersion()
The Apache Airflow version on your environment. Valid values: 1.10.12, 2.0.2,
2.2.2, 2.4.3, and 2.5.1.
1.10.12, 2.0.2,
2.2.2, 2.4.3, and 2.5.1.public final String arn()
The Amazon Resource Name (ARN) of the Amazon MWAA environment.
public final Instant createdAt()
The day and time the environment was created.
public final 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.
s3://mwaa-environment/dags. For more information, see Adding or updating
DAGs.public final String environmentClass()
The environment class type. Valid values: mw1.small, mw1.medium, mw1.large
. For more information, see Amazon MWAA environment
class.
mw1.small, mw1.medium,
mw1.large. For more information, see Amazon MWAA environment
class.public final 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.
arn:aws:iam::123456789:role/my-execution-role. For more information, see Amazon MWAA Execution
role.public final String kmsKey()
The Amazon Web Services Key Management Service (KMS) encryption key used to encrypt the data in your environment.
public final LastUpdate lastUpdate()
The status of the last update on the environment.
public final LoggingConfiguration loggingConfiguration()
The Apache Airflow logs published to CloudWatch Logs.
public final Integer maxWorkers()
The maximum number of workers that run in your environment. For example, 20.
20.public final Integer minWorkers()
The minimum number of workers that run in your environment. For example, 2.
2.public final String name()
The name of the Amazon MWAA environment. For example, MyMWAAEnvironment.
MyMWAAEnvironment.public final 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.
public final 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.
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 final 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.
s3://mwaa-environment/plugins.zip. For more information, see Installing
custom plugins.public final 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.
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 final 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.
requirements.txt file in your Amazon S3 bucket. For example,
s3://mwaa-environment/requirements.txt. For more information, see Installing Python
dependencies.public final Integer schedulers()
The number of Apache Airflow schedulers that run in your Amazon MWAA environment.
public final String serviceRoleArn()
The Amazon Resource Name (ARN) for the service-linked role of the environment. For more information, see Amazon MWAA Service-linked role.
public final 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.
arn:aws:s3:::my-airflow-bucket-unique-name. For more information, see
Create an Amazon S3
bucket for Amazon MWAA.public final 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.
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 final 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.
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 final 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.
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 was unable to rollback and is not in
a stable state.
UPDATE_FAILED - Indicates the request to update the environment failed, and the environment has
rolled back successfully and is ready to use.
We recommend reviewing our troubleshooting guide for a list of common errors and their solutions. For more information, see Amazon MWAA troubleshooting.
If the service returns an enum value that is not available in the current SDK version, status will
return EnvironmentStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from
statusAsString().
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.
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 was unable to rollback and
is not in a stable state.
UPDATE_FAILED - Indicates the request to update the environment failed, and the environment
has rolled back successfully and is ready to use.
We recommend reviewing our troubleshooting guide for a list of common errors and their solutions. For more information, see Amazon MWAA troubleshooting.
EnvironmentStatuspublic final String statusAsString()
The status of the Amazon MWAA environment. Valid values:
CREATING - Indicates the request to create the environment is in progress.
CREATING_SNAPSHOT - Indicates the request to update environment details, or upgrade the environment
version, is in progress and Amazon MWAA is creating a storage volume snapshot of the Amazon RDS database cluster
associated with the environment. A database snapshot is a backup created at a specific point in time. Amazon MWAA
uses snapshots to recover environment metadata if the process to update or upgrade an environment fails.
CREATE_FAILED - Indicates the request to create the environment failed, and the environment could
not be created.
AVAILABLE - Indicates the request was successful and the environment is ready to use.
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 was unable to rollback and is not in
a stable state.
UPDATE_FAILED - Indicates the request to update the environment failed, and the environment has
rolled back successfully and is ready to use.
We recommend reviewing our troubleshooting guide for a list of common errors and their solutions. For more information, see Amazon MWAA troubleshooting.
If the service returns an enum value that is not available in the current SDK version, status will
return EnvironmentStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from
statusAsString().
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.
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 was unable to rollback and
is not in a stable state.
UPDATE_FAILED - Indicates the request to update the environment failed, and the environment
has rolled back successfully and is ready to use.
We recommend reviewing our troubleshooting guide for a list of common errors and their solutions. For more information, see Amazon MWAA troubleshooting.
EnvironmentStatuspublic final boolean hasTags()
isEmpty() method on the property). This is useful
because the SDK will never return a null collection or map, but you may need to differentiate between the service
returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true
if a value for the property was specified in the request builder, and false if a value was not specified.public final 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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasTags() method.
"Environment": "Staging". For more information, see Tagging Amazon Web Services
resources.public final WebserverAccessMode webserverAccessMode()
The Apache Airflow Web server access mode. For more information, see Apache Airflow access modes.
If the service returns an enum value that is not available in the current SDK version,
webserverAccessMode will return WebserverAccessMode.UNKNOWN_TO_SDK_VERSION. The raw value
returned by the service is available from webserverAccessModeAsString().
WebserverAccessModepublic final String webserverAccessModeAsString()
The Apache Airflow Web server access mode. For more information, see Apache Airflow access modes.
If the service returns an enum value that is not available in the current SDK version,
webserverAccessMode will return WebserverAccessMode.UNKNOWN_TO_SDK_VERSION. The raw value
returned by the service is available from webserverAccessModeAsString().
WebserverAccessModepublic final String webserverUrl()
The Apache Airflow Web server host name for the Amazon MWAA environment. For more information, see Accessing the Apache Airflow UI.
public final 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.
TUE:03:30.public Environment.Builder toBuilder()
toBuilder in interface ToCopyableBuilder<Environment.Builder,Environment>public static Environment.Builder builder()
public static Class<? extends Environment.Builder> serializableBuilderClass()
public final boolean equalsBySdkFields(Object obj)
equalsBySdkFields in interface SdkPojopublic final String toString()
Copyright © 2023. All rights reserved.