Struct aws_sdk_mwaa::types::Environment

#[non_exhaustive]
pub struct Environment {

    pub name: Option<String>,
    pub status: Option<EnvironmentStatus>,
    pub arn: Option<String>,
    pub created_at: Option<DateTime>,
    pub webserver_url: Option<String>,
    pub execution_role_arn: Option<String>,
    pub service_role_arn: Option<String>,
    pub kms_key: Option<String>,
    pub airflow_version: Option<String>,
    pub source_bucket_arn: Option<String>,
    pub dag_s3_path: Option<String>,
    pub plugins_s3_path: Option<String>,
    pub plugins_s3_object_version: Option<String>,
    pub requirements_s3_path: Option<String>,
    pub requirements_s3_object_version: Option<String>,
    pub startup_script_s3_path: Option<String>,
    pub startup_script_s3_object_version: Option<String>,
    pub airflow_configuration_options: Option<HashMap<String, String>>,
    pub environment_class: Option<String>,
    pub max_workers: Option<i32>,
    pub network_configuration: Option<NetworkConfiguration>,
    pub logging_configuration: Option<LoggingConfiguration>,
    pub last_update: Option<LastUpdate>,
    pub weekly_maintenance_window_start: Option<String>,
    pub tags: Option<HashMap<String, String>>,
    pub webserver_access_mode: Option<WebserverAccessMode>,
    pub min_workers: Option<i32>,
    pub schedulers: Option<i32>,
    pub webserver_vpc_endpoint_service: Option<String>,
    pub database_vpc_endpoint_service: Option<String>,
    pub celery_executor_queue: Option<String>,
    pub endpoint_management: Option<EndpointManagement>,
}

Describes an Amazon Managed Workflows for Apache Airflow (MWAA) environment.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

name: Option<String>

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

status: Option<EnvironmentStatus>

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

arn: Option<String>

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

created_at: Option<DateTime>

The day and time the environment was created.

webserver_url: Option<String>

The Apache Airflow Web server host name for the Amazon MWAA environment. For more information, see Accessing the Apache Airflow UI.

execution_role_arn: Option<String>

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.

service_role_arn: Option<String>

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

kms_key: Option<String>

The Amazon Web Services Key Management Service (KMS) encryption key used to encrypt the data in your environment.

airflow_version: Option<String>

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.

source_bucket_arn: Option<String>

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.

dag_s3_path: Option<String>

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.

plugins_s3_path: Option<String>

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.

plugins_s3_object_version: Option<String>

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.

requirements_s3_path: Option<String>

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_s3_object_version: Option<String>

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.

startup_script_s3_path: Option<String>

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.

startup_script_s3_object_version: Option<String>

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.

airflow_configuration_options: Option<HashMap<String, String>>

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

environment_class: Option<String>

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

max_workers: Option<i32>

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

network_configuration: Option<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.

logging_configuration: Option<LoggingConfiguration>

The Apache Airflow logs published to CloudWatch Logs.

last_update: Option<LastUpdate>

The status of the last update on the environment.

weekly_maintenance_window_start: Option<String>

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.

tags: Option<HashMap<String, String>>

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

webserver_access_mode: Option<WebserverAccessMode>

The Apache Airflow web server access mode. For more information, see Apache Airflow access modes.

min_workers: Option<i32>

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

schedulers: Option<i32>

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

webserver_vpc_endpoint_service: Option<String>

The VPC endpoint for the environment's web server.

database_vpc_endpoint_service: Option<String>

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

celery_executor_queue: Option<String>

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.

endpoint_management: Option<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.

Implementations

impl Environment

pub fn name(&self) -> Option<&str>

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

pub fn status(&self) -> Option<&EnvironmentStatus>

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

pub fn arn(&self) -> Option<&str>

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

pub fn created_at(&self) -> Option<&DateTime>

The day and time the environment was created.

pub fn webserver_url(&self) -> Option<&str>

The Apache Airflow Web server host name for the Amazon MWAA environment. For more information, see Accessing the Apache Airflow UI.

pub fn execution_role_arn(&self) -> Option<&str>

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.

pub fn service_role_arn(&self) -> Option<&str>

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

pub fn kms_key(&self) -> Option<&str>

The Amazon Web Services Key Management Service (KMS) encryption key used to encrypt the data in your environment.

pub fn airflow_version(&self) -> Option<&str>

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.

pub fn source_bucket_arn(&self) -> Option<&str>

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.

pub fn dag_s3_path(&self) -> Option<&str>

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.

pub fn plugins_s3_path(&self) -> Option<&str>

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.

pub fn plugins_s3_object_version(&self) -> Option<&str>

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.

pub fn requirements_s3_path(&self) -> Option<&str>

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.

pub fn requirements_s3_object_version(&self) -> Option<&str>

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.

pub fn startup_script_s3_path(&self) -> Option<&str>

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.

pub fn startup_script_s3_object_version(&self) -> Option<&str>

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.

pub fn airflow_configuration_options(&self) -> Option<&HashMap<String, String>>

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

pub fn environment_class(&self) -> Option<&str>

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

pub fn max_workers(&self) -> Option<i32>

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

pub fn network_configuration(&self) -> Option<&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.

pub fn logging_configuration(&self) -> Option<&LoggingConfiguration>

The Apache Airflow logs published to CloudWatch Logs.

pub fn last_update(&self) -> Option<&LastUpdate>

The status of the last update on the environment.

pub fn weekly_maintenance_window_start(&self) -> Option<&str>

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.

pub fn tags(&self) -> Option<&HashMap<String, String>>

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

pub fn webserver_access_mode(&self) -> Option<&WebserverAccessMode>

The Apache Airflow web server access mode. For more information, see Apache Airflow access modes.

pub fn min_workers(&self) -> Option<i32>

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

pub fn schedulers(&self) -> Option<i32>

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

pub fn webserver_vpc_endpoint_service(&self) -> Option<&str>

The VPC endpoint for the environment's web server.

pub fn database_vpc_endpoint_service(&self) -> Option<&str>

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

pub fn celery_executor_queue(&self) -> Option<&str>

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.

pub fn endpoint_management(&self) -> Option<&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.

impl Environment

pub fn builder() -> EnvironmentBuilder

Creates a new builder-style object to manufacture Environment.

Trait Implementations

impl Clone for Environment

fn clone(&self) -> Environment

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Environment

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for Environment

fn eq(&self, other: &Environment) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Environment