Class Environment

    • Method Detail

      • hasAirflowConfigurationOptions

        public final boolean hasAirflowConfigurationOptions()
        For responses, this returns true if the service returned a value for the AirflowConfigurationOptions property. This DOES NOT check that the value is non-empty (for which, you should check the 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.
      • airflowConfigurationOptions

        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.

        Returns:
        A list of key-value pairs containing the Apache Airflow configuration options attached to your environment. For more information, see Apache Airflow configuration options.
      • airflowVersion

        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, 2.5.1, 2.6.3, 2.7.2.

        Returns:
        The Apache Airflow version on your environment.

        Valid values: 1.10.12, 2.0.2, 2.2.2, 2.4.3, 2.5.1, 2.6.3, 2.7.2.

      • arn

        public final String arn()

        The Amazon Resource Name (ARN) of the Amazon MWAA environment.

        Returns:
        The Amazon Resource Name (ARN) of the Amazon MWAA environment.
      • celeryExecutorQueue

        public final 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.

        Returns:
        The queue ARN for the environment's Celery Executor. Amazon MWAA uses a Celery Executor to distribute tasks across multiple workers. When you create an environment in a shared VPC, you must provide access to the Celery Executor queue from your VPC.
      • createdAt

        public final Instant createdAt()

        The day and time the environment was created.

        Returns:
        The day and time the environment was created.
      • dagS3Path

        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.

        Returns:
        The relative path to the DAGs folder in your Amazon S3 bucket. For example, s3://mwaa-environment/dags. For more information, see Adding or updating DAGs.
      • databaseVpcEndpointService

        public final String databaseVpcEndpointService()

        The VPC endpoint for the environment's Amazon RDS database.

        Returns:
        The VPC endpoint for the environment's Amazon RDS database.
      • endpointManagement

        public final 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.

        If the service returns an enum value that is not available in the current SDK version, endpointManagement will return EndpointManagement.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from endpointManagementAsString().

        Returns:
        Defines whether the VPC endpoints configured for the environment are created, and managed, by the customer or by Amazon MWAA. If set to SERVICE, Amazon MWAA will create and manage the required VPC endpoints in your VPC. If set to CUSTOMER, you must create, and manage, the VPC endpoints in your VPC.
        See Also:
        EndpointManagement
      • endpointManagementAsString

        public final String endpointManagementAsString()

        Defines whether the VPC endpoints configured for the environment are created, and managed, by the customer or by Amazon MWAA. If set to SERVICE, Amazon MWAA will create and manage the required VPC endpoints in your VPC. If set to CUSTOMER, you must create, and manage, the VPC endpoints in your VPC.

        If the service returns an enum value that is not available in the current SDK version, endpointManagement will return EndpointManagement.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from endpointManagementAsString().

        Returns:
        Defines whether the VPC endpoints configured for the environment are created, and managed, by the customer or by Amazon MWAA. If set to SERVICE, Amazon MWAA will create and manage the required VPC endpoints in your VPC. If set to CUSTOMER, you must create, and manage, the VPC endpoints in your VPC.
        See Also:
        EndpointManagement
      • environmentClass

        public final String environmentClass()

        The environment class type. Valid values: mw1.small, mw1.medium, mw1.large . For more information, see Amazon MWAA environment class.

        Returns:
        The environment class type. Valid values: mw1.small, mw1.medium, mw1.large. For more information, see Amazon MWAA environment class.
      • executionRoleArn

        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.

        Returns:
        The Amazon Resource Name (ARN) of the execution role in IAM that allows MWAA to access Amazon Web Services resources in your environment. For example, arn:aws:iam::123456789:role/my-execution-role. For more information, see Amazon MWAA Execution role.
      • kmsKey

        public final String kmsKey()

        The KMS encryption key used to encrypt the data in your environment.

        Returns:
        The KMS encryption key used to encrypt the data in your environment.
      • lastUpdate

        public final LastUpdate lastUpdate()

        The status of the last update on the environment.

        Returns:
        The status of the last update on the environment.
      • loggingConfiguration

        public final LoggingConfiguration loggingConfiguration()

        The Apache Airflow logs published to CloudWatch Logs.

        Returns:
        The Apache Airflow logs published to CloudWatch Logs.
      • maxWorkers

        public final Integer maxWorkers()

        The maximum number of workers that run in your environment. For example, 20.

        Returns:
        The maximum number of workers that run in your environment. For example, 20.
      • minWorkers

        public final Integer minWorkers()

        The minimum number of workers that run in your environment. For example, 2.

        Returns:
        The minimum number of workers that run in your environment. For example, 2.
      • name

        public final String name()

        The name of the Amazon MWAA environment. For example, MyMWAAEnvironment.

        Returns:
        The name of the Amazon MWAA environment. For example, MyMWAAEnvironment.
      • networkConfiguration

        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.

        Returns:
        Describes the VPC networking components used to secure and enable network traffic between the Amazon Web Services resources for your environment. For more information, see About networking on Amazon MWAA.
      • pluginsS3ObjectVersion

        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.

        Returns:
        The version of the plugins.zip file in your Amazon S3 bucket. You must specify the version ID that Amazon S3 assigns to the file.

        Version IDs are Unicode, UTF-8 encoded, URL-ready, opaque strings that are no more than 1,024 bytes long. The following is an example:

        3sL4kqtJlcpXroDTDmJ+rmSpXd3dIbrHY+MTRCxf3vjVBH40Nr8X8gdRQBpUMLUo

        For more information, see Installing custom plugins.

      • pluginsS3Path

        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.

        Returns:
        The relative path to the file in your Amazon S3 bucket. For example, s3://mwaa-environment/plugins.zip. For more information, see Installing custom plugins.
      • requirementsS3ObjectVersion

        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.

        Returns:
        The version of the requirements.txt file on your Amazon S3 bucket. You must specify the version ID that Amazon S3 assigns to the file.

        Version IDs are Unicode, UTF-8 encoded, URL-ready, opaque strings that are no more than 1,024 bytes long. The following is an example:

        3sL4kqtJlcpXroDTDmJ+rmSpXd3dIbrHY+MTRCxf3vjVBH40Nr8X8gdRQBpUMLUo

        For more information, see Installing Python dependencies.

      • requirementsS3Path

        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.

        Returns:
        The relative path to the requirements.txt file in your Amazon S3 bucket. For example, s3://mwaa-environment/requirements.txt. For more information, see Installing Python dependencies.
      • schedulers

        public final Integer schedulers()

        The number of Apache Airflow schedulers that run in your Amazon MWAA environment.

        Returns:
        The number of Apache Airflow schedulers that run in your Amazon MWAA environment.
      • serviceRoleArn

        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.

        Returns:
        The Amazon Resource Name (ARN) for the service-linked role of the environment. For more information, see Amazon MWAA Service-linked role.
      • sourceBucketArn

        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.

        Returns:
        The Amazon Resource Name (ARN) of the Amazon S3 bucket where your DAG code and supporting files are stored. For example, arn:aws:s3:::my-airflow-bucket-unique-name. For more information, see Create an Amazon S3 bucket for Amazon MWAA.
      • startupScriptS3ObjectVersion

        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.

        Returns:
        The version of the startup shell script in your Amazon S3 bucket. You must specify the version ID that Amazon S3 assigns to the file.

        Version IDs are Unicode, UTF-8 encoded, URL-ready, opaque strings that are no more than 1,024 bytes long. The following is an example:

        3sL4kqtJlcpXroDTDmJ+rmSpXd3dIbrHY+MTRCxf3vjVBH40Nr8X8gdRQBpUMLUo

        For more information, see Using a startup script.

      • startupScriptS3Path

        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.

        Returns:
        The relative path to the startup shell script in your Amazon S3 bucket. For example, s3://mwaa-environment/startup.sh.

        Amazon MWAA runs the script as your environment starts, and before running the Apache Airflow process. You can use this script to install dependencies, modify Apache Airflow configuration options, and set environment variables. For more information, see Using a startup script.

      • status

        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.

        • PENDING - Indicates the request was successful, but the process to create the environment is paused until you create the required VPC endpoints in your VPC. After you create the VPC endpoints, the process resumes.

        • UPDATING - Indicates the request to update the environment is in progress.

        • ROLLING_BACK - Indicates the request to update environment details, or upgrade the environment version, failed and Amazon MWAA is restoring the environment using the latest storage volume snapshot.

        • DELETING - Indicates the request to delete the environment is in progress.

        • DELETED - Indicates the request to delete the environment is complete, and the environment has been deleted.

        • UNAVAILABLE - Indicates the request failed, but the environment did not return to its previous state and is not stable.

        • UPDATE_FAILED - Indicates the request to update the environment failed, and the environment was restored to its previous state successfully and is ready to use.

        • MAINTENANCE - Indicates that the environment is undergoing maintenance. Depending on the type of work Amazon MWAA is performing, your environment might become unavailable during this process. After all operations are done, your environment will return to its status prior to mainteneace operations.

        We recommend reviewing our troubleshooting guide for a list of common errors and their solutions. For more information, see Amazon MWAA troubleshooting.

        If the service returns an enum value that is not available in the current SDK version, status will return EnvironmentStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

        Returns:
        The status of the Amazon MWAA environment.

        Valid values:

        • CREATING - Indicates the request to create the environment is in progress.

        • CREATING_SNAPSHOT - Indicates the request to update environment details, or upgrade the environment version, is in progress and Amazon MWAA is creating a storage volume snapshot of the Amazon RDS database cluster associated with the environment. A database snapshot is a backup created at a specific point in time. Amazon MWAA uses snapshots to recover environment metadata if the process to update or upgrade an environment fails.

        • CREATE_FAILED - Indicates the request to create the environment failed, and the environment could not be created.

        • AVAILABLE - Indicates the request was successful and the environment is ready to use.

        • PENDING - Indicates the request was successful, but the process to create the environment is paused until you create the required VPC endpoints in your VPC. After you create the VPC endpoints, the process resumes.

        • UPDATING - Indicates the request to update the environment is in progress.

        • ROLLING_BACK - Indicates the request to update environment details, or upgrade the environment version, failed and Amazon MWAA is restoring the environment using the latest storage volume snapshot.

        • DELETING - Indicates the request to delete the environment is in progress.

        • DELETED - Indicates the request to delete the environment is complete, and the environment has been deleted.

        • UNAVAILABLE - Indicates the request failed, but the environment did not return to its previous state and is not stable.

        • UPDATE_FAILED - Indicates the request to update the environment failed, and the environment was restored to its previous state successfully and is ready to use.

        • MAINTENANCE - Indicates that the environment is undergoing maintenance. Depending on the type of work Amazon MWAA is performing, your environment might become unavailable during this process. After all operations are done, your environment will return to its status prior to mainteneace operations.

        We recommend reviewing our troubleshooting guide for a list of common errors and their solutions. For more information, see Amazon MWAA troubleshooting.

        See Also:
        EnvironmentStatus
      • statusAsString

        public 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.

        • PENDING - Indicates the request was successful, but the process to create the environment is paused until you create the required VPC endpoints in your VPC. After you create the VPC endpoints, the process resumes.

        • UPDATING - Indicates the request to update the environment is in progress.

        • ROLLING_BACK - Indicates the request to update environment details, or upgrade the environment version, failed and Amazon MWAA is restoring the environment using the latest storage volume snapshot.

        • DELETING - Indicates the request to delete the environment is in progress.

        • DELETED - Indicates the request to delete the environment is complete, and the environment has been deleted.

        • UNAVAILABLE - Indicates the request failed, but the environment did not return to its previous state and is not stable.

        • UPDATE_FAILED - Indicates the request to update the environment failed, and the environment was restored to its previous state successfully and is ready to use.

        • MAINTENANCE - Indicates that the environment is undergoing maintenance. Depending on the type of work Amazon MWAA is performing, your environment might become unavailable during this process. After all operations are done, your environment will return to its status prior to mainteneace operations.

        We recommend reviewing our troubleshooting guide for a list of common errors and their solutions. For more information, see Amazon MWAA troubleshooting.

        If the service returns an enum value that is not available in the current SDK version, status will return EnvironmentStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

        Returns:
        The status of the Amazon MWAA environment.

        Valid values:

        • CREATING - Indicates the request to create the environment is in progress.

        • CREATING_SNAPSHOT - Indicates the request to update environment details, or upgrade the environment version, is in progress and Amazon MWAA is creating a storage volume snapshot of the Amazon RDS database cluster associated with the environment. A database snapshot is a backup created at a specific point in time. Amazon MWAA uses snapshots to recover environment metadata if the process to update or upgrade an environment fails.

        • CREATE_FAILED - Indicates the request to create the environment failed, and the environment could not be created.

        • AVAILABLE - Indicates the request was successful and the environment is ready to use.

        • PENDING - Indicates the request was successful, but the process to create the environment is paused until you create the required VPC endpoints in your VPC. After you create the VPC endpoints, the process resumes.

        • UPDATING - Indicates the request to update the environment is in progress.

        • ROLLING_BACK - Indicates the request to update environment details, or upgrade the environment version, failed and Amazon MWAA is restoring the environment using the latest storage volume snapshot.

        • DELETING - Indicates the request to delete the environment is in progress.

        • DELETED - Indicates the request to delete the environment is complete, and the environment has been deleted.

        • UNAVAILABLE - Indicates the request failed, but the environment did not return to its previous state and is not stable.

        • UPDATE_FAILED - Indicates the request to update the environment failed, and the environment was restored to its previous state successfully and is ready to use.

        • MAINTENANCE - Indicates that the environment is undergoing maintenance. Depending on the type of work Amazon MWAA is performing, your environment might become unavailable during this process. After all operations are done, your environment will return to its status prior to mainteneace operations.

        We recommend reviewing our troubleshooting guide for a list of common errors and their solutions. For more information, see Amazon MWAA troubleshooting.

        See Also:
        EnvironmentStatus
      • hasTags

        public final boolean hasTags()
        For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the 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.
      • tags

        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.

        Returns:
        The key-value tag pairs associated to your environment. For example, "Environment": "Staging". For more information, see Tagging Amazon Web Services resources.
      • webserverVpcEndpointService

        public final String webserverVpcEndpointService()

        The VPC endpoint for the environment's web server.

        Returns:
        The VPC endpoint for the environment's web server.
      • weeklyMaintenanceWindowStart

        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.

        Returns:
        The day and time of the week in Coordinated Universal Time (UTC) 24-hour standard time that weekly maintenance updates are scheduled. For example: TUE:03:30.
      • hashCode

        public final int hashCode()
        Overrides:
        hashCode in class Object
      • equals

        public final boolean equals​(Object obj)
        Overrides:
        equals in class Object
      • toString

        public final String toString()
        Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
        Overrides:
        toString in class Object
      • getValueForField

        public final <T> Optional<T> getValueForField​(String fieldName,
                                                      Class<T> clazz)