create_environment ¶

def create_environment(
    self,
    name: "capo_mwaa.types.environment_name.EnvironmentName",
    execution_role_arn: "capo_mwaa.types.iam_role_arn.IamRoleArn",
    source_bucket_arn: "capo_mwaa.types.s3_bucket_arn.S3BucketArn",
    dag_s3_path: "capo_mwaa.types.relative_path.RelativePath",
    network_configuration: "capo_mwaa.types.network_configuration.NetworkConfiguration",
    *,
    config_overrides: Optional[MWAAClientConfig] = None,
    plugins_s3_path: Optional["capo_mwaa.types.relative_path.RelativePath"] = None,
    plugins_s3_object_version: Optional[
        "capo_mwaa.types.s3_object_version.S3ObjectVersion"
    ] = None,
    requirements_s3_path: Optional[
        "capo_mwaa.types.relative_path.RelativePath"
    ] = None,
    requirements_s3_object_version: Optional[
        "capo_mwaa.types.s3_object_version.S3ObjectVersion"
    ] = None,
    startup_script_s3_path: Optional[
        "capo_mwaa.types.relative_path.RelativePath"
    ] = None,
    startup_script_s3_object_version: Optional[
        "capo_mwaa.types.s3_object_version.S3ObjectVersion"
    ] = None,
    airflow_configuration_options: Optional[
        "capo_mwaa.types.airflow_configuration_options.AirflowConfigurationOptions"
    ] = None,
    environment_class: Optional[
        "capo_mwaa.types.environment_class.EnvironmentClass"
    ] = None,
    max_workers: Optional["capo_mwaa.types.max_workers.MaxWorkers"] = None,
    kms_key: Optional["capo_mwaa.types.kms_key.KmsKey"] = None,
    airflow_version: Optional[
        "capo_mwaa.types.airflow_version.AirflowVersion"
    ] = None,
    logging_configuration: Optional[
        "capo_mwaa.types.logging_configuration_input.LoggingConfigurationInput"
    ] = None,
    weekly_maintenance_window_start: Optional[
        "capo_mwaa.types.weekly_maintenance_window_start.WeeklyMaintenanceWindowStart"
    ] = None,
    tags: Optional["capo_mwaa.types.tag_map.TagMap"] = None,
    webserver_access_mode: Optional[
        "capo_mwaa.types.webserver_access_mode.WebserverAccessMode"
    ] = None,
    min_workers: Optional["capo_mwaa.types.min_workers.MinWorkers"] = None,
    schedulers: Optional["capo_mwaa.types.schedulers.Schedulers"] = None,
    endpoint_management: Optional[
        "capo_mwaa.types.endpoint_management.EndpointManagement"
    ] = None,
    min_webservers: Optional["capo_mwaa.types.min_webservers.MinWebservers"] = None,
    max_webservers: Optional["capo_mwaa.types.max_webservers.MaxWebservers"] = None,
) -> "capo_mwaa.types.create_environment_output.CreateEnvironmentOutput":
    """<p>Creates an Amazon Managed Workflows for Apache Airflow (Amazon MWAA) environment.</p>

    Args:
        name: <p>The name of the Amazon MWAA environment. For example, <code>MyMWAAEnvironment</code>.</p>
        execution_role_arn: <p>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, <code>arn:aws:iam::123456789:role/my-execution-role</code>. For more information, refer to <a href="https://docs.aws.amazon.com/mwaa/latest/userguide/mwaa-create-role.html">Amazon MWAA Execution role</a>.</p>
        source_bucket_arn: <p>The Amazon Resource Name (ARN) of the Amazon S3 bucket where your DAG code and supporting files are stored. For example, <code>arn:aws:s3:::my-airflow-bucket-unique-name</code>. For more information, refer to <a href="https://docs.aws.amazon.com/mwaa/latest/userguide/mwaa-s3-bucket.html">Create an Amazon S3 bucket for Amazon MWAA</a>.</p>
        dag_s3_path: <p>The relative path to the DAGs folder on your Amazon S3 bucket. For example, <code>dags</code>. For more information, refer to <a href="https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-dag-folder.html">Adding or updating DAGs</a>.</p>
        network_configuration: <p>The VPC networking components used to secure and enable network traffic between the Amazon Web Services resources for your environment. For more information, refer to <a href="https://docs.aws.amazon.com/mwaa/latest/userguide/networking-about.html">About networking on Amazon MWAA</a>.</p>
        plugins_s3_path: <p>The relative path to the <code>plugins.zip</code> file on your Amazon S3 bucket. For example, <code>plugins.zip</code>. If specified, then the <code>plugins.zip</code> version is required. For more information, refer to <a href="https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-dag-import-plugins.html">Installing custom plugins</a>.</p>
        plugins_s3_object_version: <p>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, refer to <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/versioning-workflows.html">How S3 Versioning works</a>.</p>
        requirements_s3_path: <p>The relative path to the <code>requirements.txt</code> file on your Amazon S3 bucket. For example, <code>requirements.txt</code>. If specified, then a version is required. For more information, refer to <a href="https://docs.aws.amazon.com/mwaa/latest/userguide/working-dags-dependencies.html">Installing Python dependencies</a>.</p>
        requirements_s3_object_version: <p>The version of the <code>requirements.txt</code> file on your Amazon S3 bucket. You must specify a version each time a requirements.txt file is updated. For more information, refer to <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/versioning-workflows.html">How S3 Versioning works</a>.</p>
        startup_script_s3_path: <p>The relative path to the startup shell script in your Amazon S3 bucket. For example, <code>s3://mwaa-environment/startup.sh</code>.</p> <p> 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, refer to <a href="https://docs.aws.amazon.com/mwaa/latest/userguide/using-startup-script.html">Using a startup script</a>. </p>
        startup_script_s3_object_version: <p>The version of the startup shell script in your Amazon S3 bucket. You must specify the <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/versioning-workflows.html">version ID</a> that Amazon S3 assigns to the file every time you update the script. </p> <p> 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: </p> <p> <code>3sL4kqtJlcpXroDTDmJ+rmSpXd3dIbrHY+MTRCxf3vjVBH40Nr8X8gdRQBpUMLUo</code> </p> <p> For more information, refer to <a href="https://docs.aws.amazon.com/mwaa/latest/userguide/using-startup-script.html">Using a startup script</a>. </p>
        airflow_configuration_options: <p>A list of key-value pairs containing the Apache Airflow configuration options you want to attach to your environment. For more information, refer to <a href="https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-env-variables.html">Apache Airflow configuration options</a>.</p>
        environment_class: <p>The environment class type. Valid values: <code>mw1.micro</code>, <code>mw1.small</code>, <code>mw1.medium</code>, <code>mw1.large</code>, <code>mw1.xlarge</code>, and <code>mw1.2xlarge</code>. For more information, refer to <a href="https://docs.aws.amazon.com/mwaa/latest/userguide/environment-class.html">Amazon MWAA environment class</a>.</p>
        max_workers: <p>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 <code>MaxWorkers</code> field. For example, <code>20</code>. 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 <code>MinWorkers</code>.</p>
        kms_key: <p>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, refer to <a href="https://docs.aws.amazon.com/mwaa/latest/userguide/create-environment.html">Create an Amazon MWAA environment</a>.</p>
        airflow_version: <p>The Apache Airflow version for your environment. If no value is specified, it defaults to the latest version. For more information, refer to <a href="https://docs.aws.amazon.com/mwaa/latest/userguide/airflow-versions.html">Apache Airflow versions on Amazon Managed Workflows for Apache Airflow (Amazon MWAA)</a>.</p> <p>Valid values: <code>2.7.2</code>, <code>2.8.1</code>, <code>2.9.2</code>, <code>2.10.1</code>, <code>2.10.3</code>, <code>2.11.0</code>, and <code>3.0.6</code>.</p>
        logging_configuration: <p>Defines the Apache Airflow logs to send to CloudWatch Logs.</p>
        weekly_maintenance_window_start: <p>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: <code>DAY:HH:MM</code>. For example: <code>TUE:03:30</code>. You can specify a start time in 30 minute increments only.</p>
        tags: <p>The key-value tag pairs you want to associate to your environment. For example, <code>"Environment": "Staging"</code>. For more information, refer to <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services resources</a>.</p>
        webserver_access_mode: <p>Defines the access mode for the Apache Airflow <i>web server</i>. For more information, refer to <a href="https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-networking.html">Apache Airflow access modes</a>.</p> <p>If set to <code>PUBLIC_AND_PRIVATE</code>, creates both a public network load balancer (NLB) for browser access and a private VPC endpoint (VPCE) for worker-to-webserver communication. This mode is only available for Apache Airflow version 3.2 and later.</p>
        min_workers: <p>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 <code>MaxWorkers</code> 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 <code>MinWorkers</code> field. For example, <code>2</code>.</p>
        schedulers: <p>The number of Apache Airflow schedulers to run in your environment. Valid values:</p> <ul> <li> <p>v2 - For environments larger than mw1.micro, accepts values from <code>2</code> to <code>5</code>. Defaults to <code>2</code> for all environment sizes except mw1.micro, which defaults to <code>1</code>.</p> </li> <li> <p>v1 - Accepts <code>1</code>.</p> </li> </ul>
        endpoint_management: <p>Defines whether the VPC endpoints configured for the environment are created, and managed, by the customer or by Amazon MWAA. If set to <code>SERVICE</code>, Amazon MWAA will create and manage the required VPC endpoints in your VPC. If set to <code>CUSTOMER</code>, you must create, and manage, the VPC endpoints for your VPC. If you choose to create an environment in a shared VPC, you must set this value to <code>CUSTOMER</code>. In a shared VPC deployment, the environment will remain in <code>PENDING</code> status until you create the VPC endpoints. If you do not take action to create the endpoints within 72 hours, the status will change to <code>CREATE_FAILED</code>. You can delete the failed environment and create a new one.</p>
        min_webservers: <p> The minimum number of web servers that you want to run in your environment. Amazon MWAA scales the number of Apache Airflow web servers up to the number you specify for <code>MaxWebservers</code> when you interact with your Apache Airflow environment using Apache Airflow REST API, or the Apache Airflow CLI. As the transaction-per-second rate, and the network load, decrease, Amazon MWAA disposes of the additional web servers, and scales down to the number set in <code>MinxWebserers</code>. </p> <p>Valid values: For environments larger than mw1.micro, accepts values from <code>2</code> to <code>5</code>. Defaults to <code>2</code> for all environment sizes except mw1.micro, which defaults to <code>1</code>.</p>
        max_webservers: <p> The maximum number of web servers that you want to run in your environment. Amazon MWAA scales the number of Apache Airflow web servers up to the number you specify for <code>MaxWebservers</code> when you interact with your Apache Airflow environment using Apache Airflow REST API, or the Apache Airflow CLI. For example, in scenarios where your workload requires network calls to the Apache Airflow REST API with a high transaction-per-second (TPS) rate, Amazon MWAA will increase the number of web servers up to the number set in <code>MaxWebserers</code>. As TPS rates decrease Amazon MWAA disposes of the additional web servers, and scales down to the number set in <code>MinxWebserers</code>. </p> <p>Valid values: For environments larger than mw1.micro, accepts values from <code>2</code> to <code>5</code>. Defaults to <code>2</code> for all environment sizes except mw1.micro, which defaults to <code>1</code>.</p>

    Raises:
        capo_mwaa.errors.internal_server_exception.InternalServerException: <p>InternalServerException: An internal error has occurred.</p>
        capo_mwaa.errors.service_unavailable_exception.ServiceUnavailableException: <p>ServiceUnavailableException: The service is currently unavailable.</p>
        capo_mwaa.errors.validation_exception.ValidationException: <p>ValidationException: The provided input is not valid.</p>
        capo_mwaa.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_mwaa.types.create_environment_input.CreateEnvironmentInput]",
    ) -> OperationResponse[
        "capo_mwaa.types.create_environment_output.CreateEnvironmentOutput"
    ]:
        import capo_mwaa._operations.amazon_mwaa.create_environment

        output, http_response = (
            capo_mwaa._operations.amazon_mwaa.create_environment.create_environment(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    def _redact_input(
        input_: "capo_mwaa.types.create_environment_input.CreateEnvironmentInput",
    ) -> dict[str, Any]:
        import capo_mwaa.types.create_environment_input

        return capo_mwaa.types.create_environment_input.redact_sensitive(input_)

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("CreateEnvironment", redact_input=_redact_input),
    )
    input_: capo_mwaa.types.create_environment_input.CreateEnvironmentInput = {
        "name": name,
        "execution_role_arn": execution_role_arn,
        "source_bucket_arn": source_bucket_arn,
        "dag_s3_path": dag_s3_path,
        "network_configuration": network_configuration,
    }
    if plugins_s3_path is not None:
        input_["plugins_s3_path"] = plugins_s3_path
    if plugins_s3_object_version is not None:
        input_["plugins_s3_object_version"] = plugins_s3_object_version
    if requirements_s3_path is not None:
        input_["requirements_s3_path"] = requirements_s3_path
    if requirements_s3_object_version is not None:
        input_["requirements_s3_object_version"] = requirements_s3_object_version
    if startup_script_s3_path is not None:
        input_["startup_script_s3_path"] = startup_script_s3_path
    if startup_script_s3_object_version is not None:
        input_["startup_script_s3_object_version"] = (
            startup_script_s3_object_version
        )
    if airflow_configuration_options is not None:
        input_["airflow_configuration_options"] = airflow_configuration_options
    if environment_class is not None:
        input_["environment_class"] = environment_class
    if max_workers is not None:
        input_["max_workers"] = max_workers
    if kms_key is not None:
        input_["kms_key"] = kms_key
    if airflow_version is not None:
        input_["airflow_version"] = airflow_version
    if logging_configuration is not None:
        input_["logging_configuration"] = logging_configuration
    if weekly_maintenance_window_start is not None:
        input_["weekly_maintenance_window_start"] = weekly_maintenance_window_start
    if tags is not None:
        input_["tags"] = tags
    if webserver_access_mode is not None:
        input_["webserver_access_mode"] = webserver_access_mode
    if min_workers is not None:
        input_["min_workers"] = min_workers
    if schedulers is not None:
        input_["schedulers"] = schedulers
    if endpoint_management is not None:
        input_["endpoint_management"] = endpoint_management
    if min_webservers is not None:
        input_["min_webservers"] = min_webservers
    if max_webservers is not None:
        input_["max_webservers"] = max_webservers

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output