Struct aws_sdk_mwaa::types::builders::EnvironmentBuilder

#[non_exhaustive]
pub struct EnvironmentBuilder { /* private fields */ }

A builder for Environment.

Implementations

impl EnvironmentBuilder

pub fn name(self, input: impl Into<String>) -> Self

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

pub fn set_name(self, input: Option<String>) -> Self

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

pub fn get_name(&self) -> &Option<String>

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

pub fn status(self, input: EnvironmentStatus) -> Self

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.

pub fn set_status(self, input: Option<EnvironmentStatus>) -> Self

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.

pub fn get_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.

• 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, input: impl Into<String>) -> Self

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

pub fn set_arn(self, input: Option<String>) -> Self

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

pub fn get_arn(&self) -> &Option<String>

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

pub fn created_at(self, input: DateTime) -> Self

The day and time the environment was created.

pub fn set_created_at(self, input: Option<DateTime>) -> Self

The day and time the environment was created.

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

The day and time the environment was created.

pub fn webserver_url(self, input: impl Into<String>) -> Self

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

pub fn set_webserver_url(self, input: Option<String>) -> Self

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

pub fn get_webserver_url(&self) -> &Option<String>

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, input: impl Into<String>) -> Self

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 set_execution_role_arn(self, input: Option<String>) -> Self

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 get_execution_role_arn(&self) -> &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.

pub fn service_role_arn(self, input: impl Into<String>) -> Self

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

pub fn set_service_role_arn(self, input: Option<String>) -> Self

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

pub fn get_service_role_arn(&self) -> &Option<String>

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, input: impl Into<String>) -> Self

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

pub fn set_kms_key(self, input: Option<String>) -> Self

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

pub fn get_kms_key(&self) -> &Option<String>

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

pub fn airflow_version(self, input: impl Into<String>) -> Self

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.

pub fn set_airflow_version(self, input: Option<String>) -> Self

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.

pub fn get_airflow_version(&self) -> &Option<String>

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.

pub fn source_bucket_arn(self, input: impl Into<String>) -> Self

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 set_source_bucket_arn(self, input: Option<String>) -> Self

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 get_source_bucket_arn(&self) -> &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.

pub fn dag_s3_path(self, input: impl Into<String>) -> Self

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 set_dag_s3_path(self, input: Option<String>) -> Self

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 get_dag_s3_path(&self) -> &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.

pub fn plugins_s3_path(self, input: impl Into<String>) -> Self

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 set_plugins_s3_path(self, input: Option<String>) -> Self

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 get_plugins_s3_path(&self) -> &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.

pub fn plugins_s3_object_version(self, input: impl Into<String>) -> Self

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 set_plugins_s3_object_version(self, input: Option<String>) -> Self

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 get_plugins_s3_object_version(&self) -> &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.

pub fn requirements_s3_path(self, input: impl Into<String>) -> Self

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 set_requirements_s3_path(self, input: Option<String>) -> Self

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 get_requirements_s3_path(&self) -> &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.

pub fn requirements_s3_object_version(self, input: impl Into<String>) -> Self

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 set_requirements_s3_object_version(self, input: Option<String>) -> Self

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 get_requirements_s3_object_version(&self) -> &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.

pub fn startup_script_s3_path(self, input: impl Into<String>) -> Self

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 set_startup_script_s3_path(self, input: Option<String>) -> Self

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 get_startup_script_s3_path(&self) -> &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.

pub fn startup_script_s3_object_version(self, input: impl Into<String>) -> Self

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 set_startup_script_s3_object_version(self, input: Option<String>) -> Self

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 get_startup_script_s3_object_version(&self) -> &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.

pub fn airflow_configuration_options( self, k: impl Into<String>, v: impl Into<String> ) -> Self

Adds a key-value pair to airflow_configuration_options.

To override the contents of this collection use set_airflow_configuration_options.

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 set_airflow_configuration_options( self, input: Option<HashMap<String, String>> ) -> Self

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 get_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, input: impl Into<String>) -> Self

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

pub fn set_environment_class(self, input: Option<String>) -> Self

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

pub fn get_environment_class(&self) -> &Option<String>

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, input: i32) -> Self

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

pub fn set_max_workers(self, input: Option<i32>) -> Self

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

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

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

pub fn network_configuration(self, input: NetworkConfiguration) -> Self

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 set_network_configuration( self, input: Option<NetworkConfiguration> ) -> Self

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 get_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, input: LoggingConfiguration) -> Self

The Apache Airflow logs published to CloudWatch Logs.

pub fn set_logging_configuration( self, input: Option<LoggingConfiguration> ) -> Self

The Apache Airflow logs published to CloudWatch Logs.

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

The Apache Airflow logs published to CloudWatch Logs.

pub fn last_update(self, input: LastUpdate) -> Self

The status of the last update on the environment.

pub fn set_last_update(self, input: Option<LastUpdate>) -> Self

The status of the last update on the environment.

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

The status of the last update on the environment.

pub fn weekly_maintenance_window_start(self, input: impl Into<String>) -> Self

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 set_weekly_maintenance_window_start(self, input: Option<String>) -> Self

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 get_weekly_maintenance_window_start(&self) -> &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.

pub fn tags(self, k: impl Into<String>, v: impl Into<String>) -> Self

Adds a key-value pair to tags.

To override the contents of this collection use set_tags.

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

pub fn set_tags(self, input: Option<HashMap<String, String>>) -> Self

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

pub fn get_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, input: WebserverAccessMode) -> Self

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

pub fn set_webserver_access_mode( self, input: Option<WebserverAccessMode> ) -> Self

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

pub fn get_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, input: i32) -> Self

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

pub fn set_min_workers(self, input: Option<i32>) -> Self

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

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

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

pub fn schedulers(self, input: i32) -> Self

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

pub fn set_schedulers(self, input: Option<i32>) -> Self

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

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

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

pub fn build(self) -> Environment

Consumes the builder and constructs a Environment.

Trait Implementations

impl Clone for EnvironmentBuilder

fn clone(&self) -> EnvironmentBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for EnvironmentBuilder

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

Formats the value using the given formatter.

impl Default for EnvironmentBuilder

fn default() -> EnvironmentBuilder

Returns the “default value” for a type.

impl PartialEq<EnvironmentBuilder> for EnvironmentBuilder

fn eq(&self, other: &EnvironmentBuilder) -> 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 EnvironmentBuilder