1. Packages
  2. AWS Native
  3. API Docs
  4. mwaa
  5. Environment

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.101.0 published on Thursday, Apr 11, 2024 by Pulumi

aws-native.mwaa.Environment

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.101.0 published on Thursday, Apr 11, 2024 by Pulumi

    Resource schema for AWS::MWAA::Environment

    Create Environment Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Environment(name: string, args?: EnvironmentArgs, opts?: CustomResourceOptions);
    @overload
    def Environment(resource_name: str,
                    args: Optional[EnvironmentArgs] = None,
                    opts: Optional[ResourceOptions] = None)
    
    @overload
    def Environment(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    airflow_configuration_options: Optional[Any] = None,
                    airflow_version: Optional[str] = None,
                    dag_s3_path: Optional[str] = None,
                    endpoint_management: Optional[EnvironmentEndpointManagement] = None,
                    environment_class: Optional[str] = None,
                    execution_role_arn: Optional[str] = None,
                    kms_key: Optional[str] = None,
                    logging_configuration: Optional[EnvironmentLoggingConfigurationArgs] = None,
                    max_workers: Optional[int] = None,
                    min_workers: Optional[int] = None,
                    name: Optional[str] = None,
                    network_configuration: Optional[EnvironmentNetworkConfigurationArgs] = None,
                    plugins_s3_object_version: Optional[str] = None,
                    plugins_s3_path: Optional[str] = None,
                    requirements_s3_object_version: Optional[str] = None,
                    requirements_s3_path: Optional[str] = None,
                    schedulers: Optional[int] = None,
                    source_bucket_arn: Optional[str] = None,
                    startup_script_s3_object_version: Optional[str] = None,
                    startup_script_s3_path: Optional[str] = None,
                    tags: Optional[Any] = None,
                    webserver_access_mode: Optional[EnvironmentWebserverAccessMode] = None,
                    weekly_maintenance_window_start: Optional[str] = None)
    func NewEnvironment(ctx *Context, name string, args *EnvironmentArgs, opts ...ResourceOption) (*Environment, error)
    public Environment(string name, EnvironmentArgs? args = null, CustomResourceOptions? opts = null)
    public Environment(String name, EnvironmentArgs args)
    public Environment(String name, EnvironmentArgs args, CustomResourceOptions options)
    
    type: aws-native:mwaa:Environment
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args EnvironmentArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args EnvironmentArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args EnvironmentArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args EnvironmentArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args EnvironmentArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    const exampleenvironmentResourceResourceFromMwaa = new aws_native.mwaa.Environment("exampleenvironmentResourceResourceFromMwaa", {
        airflowConfigurationOptions: "any",
        airflowVersion: "string",
        dagS3Path: "string",
        endpointManagement: aws_native.mwaa.EnvironmentEndpointManagement.Customer,
        environmentClass: "string",
        executionRoleArn: "string",
        kmsKey: "string",
        loggingConfiguration: {
            dagProcessingLogs: {
                cloudWatchLogGroupArn: "string",
                enabled: false,
                logLevel: aws_native.mwaa.EnvironmentLoggingLevel.Critical,
            },
            schedulerLogs: {
                cloudWatchLogGroupArn: "string",
                enabled: false,
                logLevel: aws_native.mwaa.EnvironmentLoggingLevel.Critical,
            },
            taskLogs: {
                cloudWatchLogGroupArn: "string",
                enabled: false,
                logLevel: aws_native.mwaa.EnvironmentLoggingLevel.Critical,
            },
            webserverLogs: {
                cloudWatchLogGroupArn: "string",
                enabled: false,
                logLevel: aws_native.mwaa.EnvironmentLoggingLevel.Critical,
            },
            workerLogs: {
                cloudWatchLogGroupArn: "string",
                enabled: false,
                logLevel: aws_native.mwaa.EnvironmentLoggingLevel.Critical,
            },
        },
        maxWorkers: 0,
        minWorkers: 0,
        name: "string",
        networkConfiguration: {
            securityGroupIds: ["string"],
            subnetIds: ["string"],
        },
        pluginsS3ObjectVersion: "string",
        pluginsS3Path: "string",
        requirementsS3ObjectVersion: "string",
        requirementsS3Path: "string",
        schedulers: 0,
        sourceBucketArn: "string",
        startupScriptS3ObjectVersion: "string",
        startupScriptS3Path: "string",
        tags: "any",
        webserverAccessMode: aws_native.mwaa.EnvironmentWebserverAccessMode.PrivateOnly,
        weeklyMaintenanceWindowStart: "string",
    });
    
    Coming soon!
    

    Environment Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The Environment resource accepts the following input properties:

    AirflowConfigurationOptions object

    Key/value pairs representing Airflow configuration variables. Keys are prefixed by their section:

    [core]
    dags_folder={AIRFLOW_HOME}/dags
    

    Would be represented as

    "core.dags_folder": "{AIRFLOW_HOME}/dags"

    Search the CloudFormation User Guide for AWS::MWAA::Environment for more information about the expected schema for this property.

    AirflowVersion string
    DagS3Path string
    EndpointManagement Pulumi.AwsNative.Mwaa.EnvironmentEndpointManagement
    EnvironmentClass string
    ExecutionRoleArn string
    KmsKey string
    LoggingConfiguration Pulumi.AwsNative.Mwaa.Inputs.EnvironmentLoggingConfiguration
    MaxWorkers int
    MinWorkers int
    Name string
    NetworkConfiguration Pulumi.AwsNative.Mwaa.Inputs.EnvironmentNetworkConfiguration
    PluginsS3ObjectVersion string
    PluginsS3Path string
    RequirementsS3ObjectVersion string
    RequirementsS3Path string
    Schedulers int
    SourceBucketArn string
    StartupScriptS3ObjectVersion string
    StartupScriptS3Path string
    Tags object

    A map of tags for the environment.

    Search the CloudFormation User Guide for AWS::MWAA::Environment for more information about the expected schema for this property.

    WebserverAccessMode Pulumi.AwsNative.Mwaa.EnvironmentWebserverAccessMode
    WeeklyMaintenanceWindowStart string
    AirflowConfigurationOptions interface{}

    Key/value pairs representing Airflow configuration variables. Keys are prefixed by their section:

    [core]
    dags_folder={AIRFLOW_HOME}/dags
    

    Would be represented as

    "core.dags_folder": "{AIRFLOW_HOME}/dags"

    Search the CloudFormation User Guide for AWS::MWAA::Environment for more information about the expected schema for this property.

    AirflowVersion string
    DagS3Path string
    EndpointManagement EnvironmentEndpointManagement
    EnvironmentClass string
    ExecutionRoleArn string
    KmsKey string
    LoggingConfiguration EnvironmentLoggingConfigurationArgs
    MaxWorkers int
    MinWorkers int
    Name string
    NetworkConfiguration EnvironmentNetworkConfigurationArgs
    PluginsS3ObjectVersion string
    PluginsS3Path string
    RequirementsS3ObjectVersion string
    RequirementsS3Path string
    Schedulers int
    SourceBucketArn string
    StartupScriptS3ObjectVersion string
    StartupScriptS3Path string
    Tags interface{}

    A map of tags for the environment.

    Search the CloudFormation User Guide for AWS::MWAA::Environment for more information about the expected schema for this property.

    WebserverAccessMode EnvironmentWebserverAccessMode
    WeeklyMaintenanceWindowStart string
    airflowConfigurationOptions Object

    Key/value pairs representing Airflow configuration variables. Keys are prefixed by their section:

    [core]
    dags_folder={AIRFLOW_HOME}/dags
    

    Would be represented as

    "core.dags_folder": "{AIRFLOW_HOME}/dags"

    Search the CloudFormation User Guide for AWS::MWAA::Environment for more information about the expected schema for this property.

    airflowVersion String
    dagS3Path String
    endpointManagement EnvironmentEndpointManagement
    environmentClass String
    executionRoleArn String
    kmsKey String
    loggingConfiguration EnvironmentLoggingConfiguration
    maxWorkers Integer
    minWorkers Integer
    name String
    networkConfiguration EnvironmentNetworkConfiguration
    pluginsS3ObjectVersion String
    pluginsS3Path String
    requirementsS3ObjectVersion String
    requirementsS3Path String
    schedulers Integer
    sourceBucketArn String
    startupScriptS3ObjectVersion String
    startupScriptS3Path String
    tags Object

    A map of tags for the environment.

    Search the CloudFormation User Guide for AWS::MWAA::Environment for more information about the expected schema for this property.

    webserverAccessMode EnvironmentWebserverAccessMode
    weeklyMaintenanceWindowStart String
    airflowConfigurationOptions any

    Key/value pairs representing Airflow configuration variables. Keys are prefixed by their section:

    [core]
    dags_folder={AIRFLOW_HOME}/dags
    

    Would be represented as

    "core.dags_folder": "{AIRFLOW_HOME}/dags"

    Search the CloudFormation User Guide for AWS::MWAA::Environment for more information about the expected schema for this property.

    airflowVersion string
    dagS3Path string
    endpointManagement EnvironmentEndpointManagement
    environmentClass string
    executionRoleArn string
    kmsKey string
    loggingConfiguration EnvironmentLoggingConfiguration
    maxWorkers number
    minWorkers number
    name string
    networkConfiguration EnvironmentNetworkConfiguration
    pluginsS3ObjectVersion string
    pluginsS3Path string
    requirementsS3ObjectVersion string
    requirementsS3Path string
    schedulers number
    sourceBucketArn string
    startupScriptS3ObjectVersion string
    startupScriptS3Path string
    tags any

    A map of tags for the environment.

    Search the CloudFormation User Guide for AWS::MWAA::Environment for more information about the expected schema for this property.

    webserverAccessMode EnvironmentWebserverAccessMode
    weeklyMaintenanceWindowStart string
    airflow_configuration_options Any

    Key/value pairs representing Airflow configuration variables. Keys are prefixed by their section:

    [core]
    dags_folder={AIRFLOW_HOME}/dags
    

    Would be represented as

    "core.dags_folder": "{AIRFLOW_HOME}/dags"

    Search the CloudFormation User Guide for AWS::MWAA::Environment for more information about the expected schema for this property.

    airflow_version str
    dag_s3_path str
    endpoint_management EnvironmentEndpointManagement
    environment_class str
    execution_role_arn str
    kms_key str
    logging_configuration EnvironmentLoggingConfigurationArgs
    max_workers int
    min_workers int
    name str
    network_configuration EnvironmentNetworkConfigurationArgs
    plugins_s3_object_version str
    plugins_s3_path str
    requirements_s3_object_version str
    requirements_s3_path str
    schedulers int
    source_bucket_arn str
    startup_script_s3_object_version str
    startup_script_s3_path str
    tags Any

    A map of tags for the environment.

    Search the CloudFormation User Guide for AWS::MWAA::Environment for more information about the expected schema for this property.

    webserver_access_mode EnvironmentWebserverAccessMode
    weekly_maintenance_window_start str
    airflowConfigurationOptions Any

    Key/value pairs representing Airflow configuration variables. Keys are prefixed by their section:

    [core]
    dags_folder={AIRFLOW_HOME}/dags
    

    Would be represented as

    "core.dags_folder": "{AIRFLOW_HOME}/dags"

    Search the CloudFormation User Guide for AWS::MWAA::Environment for more information about the expected schema for this property.

    airflowVersion String
    dagS3Path String
    endpointManagement "CUSTOMER" | "SERVICE"
    environmentClass String
    executionRoleArn String
    kmsKey String
    loggingConfiguration Property Map
    maxWorkers Number
    minWorkers Number
    name String
    networkConfiguration Property Map
    pluginsS3ObjectVersion String
    pluginsS3Path String
    requirementsS3ObjectVersion String
    requirementsS3Path String
    schedulers Number
    sourceBucketArn String
    startupScriptS3ObjectVersion String
    startupScriptS3Path String
    tags Any

    A map of tags for the environment.

    Search the CloudFormation User Guide for AWS::MWAA::Environment for more information about the expected schema for this property.

    webserverAccessMode "PRIVATE_ONLY" | "PUBLIC_ONLY"
    weeklyMaintenanceWindowStart String

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Environment resource produces the following output properties:

    Arn string
    CeleryExecutorQueue string
    DatabaseVpcEndpointService string
    Id string
    The provider-assigned unique ID for this managed resource.
    WebserverUrl string
    WebserverVpcEndpointService string
    Arn string
    CeleryExecutorQueue string
    DatabaseVpcEndpointService string
    Id string
    The provider-assigned unique ID for this managed resource.
    WebserverUrl string
    WebserverVpcEndpointService string
    arn String
    celeryExecutorQueue String
    databaseVpcEndpointService String
    id String
    The provider-assigned unique ID for this managed resource.
    webserverUrl String
    webserverVpcEndpointService String
    arn string
    celeryExecutorQueue string
    databaseVpcEndpointService string
    id string
    The provider-assigned unique ID for this managed resource.
    webserverUrl string
    webserverVpcEndpointService string
    arn str
    celery_executor_queue str
    database_vpc_endpoint_service str
    id str
    The provider-assigned unique ID for this managed resource.
    webserver_url str
    webserver_vpc_endpoint_service str
    arn String
    celeryExecutorQueue String
    databaseVpcEndpointService String
    id String
    The provider-assigned unique ID for this managed resource.
    webserverUrl String
    webserverVpcEndpointService String

    Supporting Types

    EnvironmentEndpointManagement, EnvironmentEndpointManagementArgs

    Customer
    CUSTOMER
    Service
    SERVICE
    EnvironmentEndpointManagementCustomer
    CUSTOMER
    EnvironmentEndpointManagementService
    SERVICE
    Customer
    CUSTOMER
    Service
    SERVICE
    Customer
    CUSTOMER
    Service
    SERVICE
    CUSTOMER
    CUSTOMER
    SERVICE
    SERVICE
    "CUSTOMER"
    CUSTOMER
    "SERVICE"
    SERVICE

    EnvironmentLoggingConfiguration, EnvironmentLoggingConfigurationArgs

    EnvironmentLoggingLevel, EnvironmentLoggingLevelArgs

    Critical
    CRITICAL
    Error
    ERROR
    Warning
    WARNING
    Info
    INFO
    Debug
    DEBUG
    EnvironmentLoggingLevelCritical
    CRITICAL
    EnvironmentLoggingLevelError
    ERROR
    EnvironmentLoggingLevelWarning
    WARNING
    EnvironmentLoggingLevelInfo
    INFO
    EnvironmentLoggingLevelDebug
    DEBUG
    Critical
    CRITICAL
    Error
    ERROR
    Warning
    WARNING
    Info
    INFO
    Debug
    DEBUG
    Critical
    CRITICAL
    Error
    ERROR
    Warning
    WARNING
    Info
    INFO
    Debug
    DEBUG
    CRITICAL
    CRITICAL
    ERROR
    ERROR
    WARNING
    WARNING
    INFO
    INFO
    DEBUG
    DEBUG
    "CRITICAL"
    CRITICAL
    "ERROR"
    ERROR
    "WARNING"
    WARNING
    "INFO"
    INFO
    "DEBUG"
    DEBUG

    EnvironmentModuleLoggingConfiguration, EnvironmentModuleLoggingConfigurationArgs

    EnvironmentNetworkConfiguration, EnvironmentNetworkConfigurationArgs

    SecurityGroupIds List<string>
    A list of security groups to use for the environment.
    SubnetIds List<string>
    A list of subnets to use for the environment. These must be private subnets, in the same VPC, in two different availability zones.
    SecurityGroupIds []string
    A list of security groups to use for the environment.
    SubnetIds []string
    A list of subnets to use for the environment. These must be private subnets, in the same VPC, in two different availability zones.
    securityGroupIds List<String>
    A list of security groups to use for the environment.
    subnetIds List<String>
    A list of subnets to use for the environment. These must be private subnets, in the same VPC, in two different availability zones.
    securityGroupIds string[]
    A list of security groups to use for the environment.
    subnetIds string[]
    A list of subnets to use for the environment. These must be private subnets, in the same VPC, in two different availability zones.
    security_group_ids Sequence[str]
    A list of security groups to use for the environment.
    subnet_ids Sequence[str]
    A list of subnets to use for the environment. These must be private subnets, in the same VPC, in two different availability zones.
    securityGroupIds List<String>
    A list of security groups to use for the environment.
    subnetIds List<String>
    A list of subnets to use for the environment. These must be private subnets, in the same VPC, in two different availability zones.

    EnvironmentWebserverAccessMode, EnvironmentWebserverAccessModeArgs

    PrivateOnly
    PRIVATE_ONLY
    PublicOnly
    PUBLIC_ONLY
    EnvironmentWebserverAccessModePrivateOnly
    PRIVATE_ONLY
    EnvironmentWebserverAccessModePublicOnly
    PUBLIC_ONLY
    PrivateOnly
    PRIVATE_ONLY
    PublicOnly
    PUBLIC_ONLY
    PrivateOnly
    PRIVATE_ONLY
    PublicOnly
    PUBLIC_ONLY
    PRIVATE_ONLY
    PRIVATE_ONLY
    PUBLIC_ONLY
    PUBLIC_ONLY
    "PRIVATE_ONLY"
    PRIVATE_ONLY
    "PUBLIC_ONLY"
    PUBLIC_ONLY

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.101.0 published on Thursday, Apr 11, 2024 by Pulumi