Struct aws_sdk_mwaa::operation::create_environment::CreateEnvironmentInput

#[non_exhaustive]
pub struct CreateEnvironmentInput {

    pub name: Option<String>,
    pub execution_role_arn: Option<String>,
    pub source_bucket_arn: Option<String>,
    pub dag_s3_path: Option<String>,
    pub network_configuration: Option<NetworkConfiguration>,
    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 kms_key: Option<String>,
    pub airflow_version: Option<String>,
    pub logging_configuration: Option<LoggingConfigurationInput>,
    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>,
}

This section contains the Amazon Managed Workflows for Apache Airflow (MWAA) API reference documentation to create an environment. For more information, see Get started with Amazon Managed Workflows for Apache Airflow.

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.

execution_role_arn: Option<String>

The Amazon Resource Name (ARN) of the execution role for your environment. An execution role is an Amazon Web Services Identity and Access Management (IAM) role that grants MWAA permission to access Amazon Web Services services and resources used by your environment. For example, arn:aws:iam::123456789:role/my-execution-role. For more information, see Amazon MWAA Execution role.

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 on your Amazon S3 bucket. For example, dags. For more information, see Adding or updating DAGs.

network_configuration: Option<NetworkConfiguration>

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.

plugins_s3_path: Option<String>

The relative path to the plugins.zip file on your Amazon S3 bucket. For example, plugins.zip. If specified, then the plugins.zip version is required. For more information, see Installing custom plugins.

plugins_s3_object_version: Option<String>

The version of the plugins.zip file on your Amazon S3 bucket. You must specify a version each time a plugins.zip file is updated. For more information, see How S3 Versioning works.

requirements_s3_path: Option<String>

The relative path to the requirements.txt file on your Amazon S3 bucket. For example, requirements.txt. If specified, then a version is required. 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 a version each time a requirements.txt file is updated. For more information, see How S3 Versioning works.

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 every time you update the 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.

airflow_configuration_options: Option<HashMap<String, String>>

A list of key-value pairs containing the Apache Airflow configuration options you want to attach 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 you want to run in your environment. MWAA scales the number of Apache Airflow workers up to the number you specify in the MaxWorkers field. For example, 20. When there are no more tasks running, and no more in the queue, MWAA disposes of the extra workers leaving the one worker that is included with your environment, or the number you specify in MinWorkers.

kms_key: Option<String>

The Amazon Web Services Key Management Service (KMS) key to encrypt the data in your environment. You can use an Amazon Web Services owned CMK, or a Customer managed CMK (advanced). For more information, see Create an Amazon MWAA environment.

airflow_version: Option<String>

The Apache Airflow version for your environment. If no value is specified, it defaults to the latest version. Valid values: 1.10.12, 2.0.2, 2.2.2, 2.4.3, and 2.5.1. For more information, see Apache Airflow versions on Amazon Managed Workflows for Apache Airflow (MWAA).

logging_configuration: Option<LoggingConfigurationInput>

Defines the Apache Airflow logs to send to CloudWatch Logs.

weekly_maintenance_window_start: Option<String>

The day and time of the week in Coordinated Universal Time (UTC) 24-hour standard time to start weekly maintenance updates of your environment in the following format: DAY:HH:MM. For example: TUE:03:30. You can specify a start time in 30 minute increments only.

tags: Option<HashMap<String, String>>

The key-value tag pairs you want to associate 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 you want to run in your environment. MWAA scales the number of Apache Airflow workers up to the number you specify in the MaxWorkers field. When there are no more tasks running, and no more in the queue, MWAA disposes of the extra workers leaving the worker count you specify in the MinWorkers field. For example, 2.

schedulers: Option<i32>

The number of Apache Airflow schedulers to run in your environment. Valid values:

• v2 - Accepts between 2 to 5. Defaults to 2.

• v1 - Accepts 1.

Implementations

impl CreateEnvironmentInput

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

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

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

The Amazon Resource Name (ARN) of the execution role for your environment. An execution role is an Amazon Web Services Identity and Access Management (IAM) role that grants MWAA permission to access Amazon Web Services services and resources used by your environment. For example, arn:aws:iam::123456789:role/my-execution-role. For more information, see Amazon MWAA Execution role.

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 on your Amazon S3 bucket. For example, dags. For more information, see Adding or updating DAGs.

pub fn network_configuration(&self) -> Option<&NetworkConfiguration>

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 plugins_s3_path(&self) -> Option<&str>

The relative path to the plugins.zip file on your Amazon S3 bucket. For example, plugins.zip. If specified, then the plugins.zip version is required. For more information, see Installing custom plugins.

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

The version of the plugins.zip file on your Amazon S3 bucket. You must specify a version each time a plugins.zip file is updated. For more information, see How S3 Versioning works.

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

The relative path to the requirements.txt file on your Amazon S3 bucket. For example, requirements.txt. If specified, then a version is required. 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 a version each time a requirements.txt file is updated. For more information, see How S3 Versioning works.

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 every time you update the 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.

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

A list of key-value pairs containing the Apache Airflow configuration options you want to attach 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 you want to run in your environment. MWAA scales the number of Apache Airflow workers up to the number you specify in the MaxWorkers field. For example, 20. When there are no more tasks running, and no more in the queue, MWAA disposes of the extra workers leaving the one worker that is included with your environment, or the number you specify in MinWorkers.

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

The Amazon Web Services Key Management Service (KMS) key to encrypt the data in your environment. You can use an Amazon Web Services owned CMK, or a Customer managed CMK (advanced). For more information, see Create an Amazon MWAA environment.

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

The Apache Airflow version for your environment. If no value is specified, it defaults to the latest version. Valid values: 1.10.12, 2.0.2, 2.2.2, 2.4.3, and 2.5.1. For more information, see Apache Airflow versions on Amazon Managed Workflows for Apache Airflow (MWAA).

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

Defines the Apache Airflow logs to send to CloudWatch Logs.

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 to start weekly maintenance updates of your environment in the following format: DAY:HH:MM. For example: TUE:03:30. You can specify a start time in 30 minute increments only.

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

The key-value tag pairs you want to associate 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 you want to run in your environment. MWAA scales the number of Apache Airflow workers up to the number you specify in the MaxWorkers field. When there are no more tasks running, and no more in the queue, MWAA disposes of the extra workers leaving the worker count you specify in the MinWorkers field. For example, 2.

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

The number of Apache Airflow schedulers to run in your environment. Valid values:

• v2 - Accepts between 2 to 5. Defaults to 2.

• v1 - Accepts 1.

impl CreateEnvironmentInput

pub fn builder() -> CreateEnvironmentInputBuilder

Creates a new builder-style object to manufacture CreateEnvironmentInput.

Trait Implementations

impl Clone for CreateEnvironmentInput

fn clone(&self) -> CreateEnvironmentInput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CreateEnvironmentInput

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

Formats the value using the given formatter.

impl PartialEq<CreateEnvironmentInput> for CreateEnvironmentInput

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