AWS CDK Reference

Appearance

v2.274.0

CfnEnvironment L1 construct ​

The AWS::MWAA::Environment resource creates an Amazon Managed Workflows for Apache Airflow (MWAA) environment.

CloudFormation
AWS::MWAA::Environment
Source
Generated code
Type last changed
v2.252.0 · 30 Apr 2026

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_mwaa as mwaa } from 'aws-cdk-lib';

declare const airflowConfigurationOptions: any;
declare const tags: any;
const cfnEnvironment = new mwaa.CfnEnvironment(this, 'MyCfnEnvironment', {
  name: 'name',

  // the properties below are optional
  airflowConfigurationOptions: airflowConfigurationOptions,
  airflowVersion: 'airflowVersion',
  dagS3Path: 'dagS3Path',
  endpointManagement: 'endpointManagement',
  environmentClass: 'environmentClass',
  executionRoleArn: 'executionRoleArn',
  kmsKey: 'kmsKey',
  loggingConfiguration: {
    dagProcessingLogs: {
      cloudWatchLogGroupArn: 'cloudWatchLogGroupArn',
      enabled: false,
      logLevel: 'logLevel',
    },
    schedulerLogs: {
      cloudWatchLogGroupArn: 'cloudWatchLogGroupArn',
      enabled: false,
      logLevel: 'logLevel',
    },
    taskLogs: {
      cloudWatchLogGroupArn: 'cloudWatchLogGroupArn',
      enabled: false,
      logLevel: 'logLevel',
    },
    webserverLogs: {
      cloudWatchLogGroupArn: 'cloudWatchLogGroupArn',
      enabled: false,
      logLevel: 'logLevel',
    },
    workerLogs: {
      cloudWatchLogGroupArn: 'cloudWatchLogGroupArn',
      enabled: false,
      logLevel: 'logLevel',
    },
  },
  maxWebservers: 123,
  maxWorkers: 123,
  minWebservers: 123,
  minWorkers: 123,
  networkConfiguration: {
    securityGroupIds: ['securityGroupIds'],
    subnetIds: ['subnetIds'],
  },
  pluginsS3ObjectVersion: 'pluginsS3ObjectVersion',
  pluginsS3Path: 'pluginsS3Path',
  requirementsS3ObjectVersion: 'requirementsS3ObjectVersion',
  requirementsS3Path: 'requirementsS3Path',
  schedulers: 123,
  sourceBucketArn: 'sourceBucketArn',
  startupScriptS3ObjectVersion: 'startupScriptS3ObjectVersion',
  startupScriptS3Path: 'startupScriptS3Path',
  tags: tags,
  webserverAccessMode: 'webserverAccessMode',
  weeklyMaintenanceWindowStart: 'weeklyMaintenanceWindowStart',
  workerReplacementStrategy: 'workerReplacementStrategy',
});
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_mwaa as mwaa

# airflow_configuration_options: Any
# tags: Any

cfn_environment = mwaa.CfnEnvironment(self, "MyCfnEnvironment",
    name="name",

    # the properties below are optional
    airflow_configuration_options=airflow_configuration_options,
    airflow_version="airflowVersion",
    dag_s3_path="dagS3Path",
    endpoint_management="endpointManagement",
    environment_class="environmentClass",
    execution_role_arn="executionRoleArn",
    kms_key="kmsKey",
    logging_configuration=mwaa.CfnEnvironment.LoggingConfigurationProperty(
        dag_processing_logs=mwaa.CfnEnvironment.ModuleLoggingConfigurationProperty(
            cloud_watch_log_group_arn="cloudWatchLogGroupArn",
            enabled=False,
            log_level="logLevel"
        ),
        scheduler_logs=mwaa.CfnEnvironment.ModuleLoggingConfigurationProperty(
            cloud_watch_log_group_arn="cloudWatchLogGroupArn",
            enabled=False,
            log_level="logLevel"
        ),
        task_logs=mwaa.CfnEnvironment.ModuleLoggingConfigurationProperty(
            cloud_watch_log_group_arn="cloudWatchLogGroupArn",
            enabled=False,
            log_level="logLevel"
        ),
        webserver_logs=mwaa.CfnEnvironment.ModuleLoggingConfigurationProperty(
            cloud_watch_log_group_arn="cloudWatchLogGroupArn",
            enabled=False,
            log_level="logLevel"
        ),
        worker_logs=mwaa.CfnEnvironment.ModuleLoggingConfigurationProperty(
            cloud_watch_log_group_arn="cloudWatchLogGroupArn",
            enabled=False,
            log_level="logLevel"
        )
    ),
    max_webservers=123,
    max_workers=123,
    min_webservers=123,
    min_workers=123,
    network_configuration=mwaa.CfnEnvironment.NetworkConfigurationProperty(
        security_group_ids=["securityGroupIds"],
        subnet_ids=["subnetIds"]
    ),
    plugins_s3_object_version="pluginsS3ObjectVersion",
    plugins_s3_path="pluginsS3Path",
    requirements_s3_object_version="requirementsS3ObjectVersion",
    requirements_s3_path="requirementsS3Path",
    schedulers=123,
    source_bucket_arn="sourceBucketArn",
    startup_script_s3_object_version="startupScriptS3ObjectVersion",
    startup_script_s3_path="startupScriptS3Path",
    tags=tags,
    webserver_access_mode="webserverAccessMode",
    weekly_maintenance_window_start="weeklyMaintenanceWindowStart",
    worker_replacement_strategy="workerReplacementStrategy"
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.mwaa.*;

Object airflowConfigurationOptions;
Object tags;

CfnEnvironment cfnEnvironment = CfnEnvironment.Builder.create(this, "MyCfnEnvironment")
        .name("name")

        // the properties below are optional
        .airflowConfigurationOptions(airflowConfigurationOptions)
        .airflowVersion("airflowVersion")
        .dagS3Path("dagS3Path")
        .endpointManagement("endpointManagement")
        .environmentClass("environmentClass")
        .executionRoleArn("executionRoleArn")
        .kmsKey("kmsKey")
        .loggingConfiguration(LoggingConfigurationProperty.builder()
                .dagProcessingLogs(ModuleLoggingConfigurationProperty.builder()
                        .cloudWatchLogGroupArn("cloudWatchLogGroupArn")
                        .enabled(false)
                        .logLevel("logLevel")
                        .build())
                .schedulerLogs(ModuleLoggingConfigurationProperty.builder()
                        .cloudWatchLogGroupArn("cloudWatchLogGroupArn")
                        .enabled(false)
                        .logLevel("logLevel")
                        .build())
                .taskLogs(ModuleLoggingConfigurationProperty.builder()
                        .cloudWatchLogGroupArn("cloudWatchLogGroupArn")
                        .enabled(false)
                        .logLevel("logLevel")
                        .build())
                .webserverLogs(ModuleLoggingConfigurationProperty.builder()
                        .cloudWatchLogGroupArn("cloudWatchLogGroupArn")
                        .enabled(false)
                        .logLevel("logLevel")
                        .build())
                .workerLogs(ModuleLoggingConfigurationProperty.builder()
                        .cloudWatchLogGroupArn("cloudWatchLogGroupArn")
                        .enabled(false)
                        .logLevel("logLevel")
                        .build())
                .build())
        .maxWebservers(123)
        .maxWorkers(123)
        .minWebservers(123)
        .minWorkers(123)
        .networkConfiguration(NetworkConfigurationProperty.builder()
                .securityGroupIds(List.of("securityGroupIds"))
                .subnetIds(List.of("subnetIds"))
                .build())
        .pluginsS3ObjectVersion("pluginsS3ObjectVersion")
        .pluginsS3Path("pluginsS3Path")
        .requirementsS3ObjectVersion("requirementsS3ObjectVersion")
        .requirementsS3Path("requirementsS3Path")
        .schedulers(123)
        .sourceBucketArn("sourceBucketArn")
        .startupScriptS3ObjectVersion("startupScriptS3ObjectVersion")
        .startupScriptS3Path("startupScriptS3Path")
        .tags(tags)
        .webserverAccessMode("webserverAccessMode")
        .weeklyMaintenanceWindowStart("weeklyMaintenanceWindowStart")
        .workerReplacementStrategy("workerReplacementStrategy")
        .build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.MWAA;

var airflowConfigurationOptions;
var tags;

var cfnEnvironment = new CfnEnvironment(this, "MyCfnEnvironment", new CfnEnvironmentProps {
    Name = "name",

    // the properties below are optional
    AirflowConfigurationOptions = airflowConfigurationOptions,
    AirflowVersion = "airflowVersion",
    DagS3Path = "dagS3Path",
    EndpointManagement = "endpointManagement",
    EnvironmentClass = "environmentClass",
    ExecutionRoleArn = "executionRoleArn",
    KmsKey = "kmsKey",
    LoggingConfiguration = new LoggingConfigurationProperty {
        DagProcessingLogs = new ModuleLoggingConfigurationProperty {
            CloudWatchLogGroupArn = "cloudWatchLogGroupArn",
            Enabled = false,
            LogLevel = "logLevel"
        },
        SchedulerLogs = new ModuleLoggingConfigurationProperty {
            CloudWatchLogGroupArn = "cloudWatchLogGroupArn",
            Enabled = false,
            LogLevel = "logLevel"
        },
        TaskLogs = new ModuleLoggingConfigurationProperty {
            CloudWatchLogGroupArn = "cloudWatchLogGroupArn",
            Enabled = false,
            LogLevel = "logLevel"
        },
        WebserverLogs = new ModuleLoggingConfigurationProperty {
            CloudWatchLogGroupArn = "cloudWatchLogGroupArn",
            Enabled = false,
            LogLevel = "logLevel"
        },
        WorkerLogs = new ModuleLoggingConfigurationProperty {
            CloudWatchLogGroupArn = "cloudWatchLogGroupArn",
            Enabled = false,
            LogLevel = "logLevel"
        }
    },
    MaxWebservers = 123,
    MaxWorkers = 123,
    MinWebservers = 123,
    MinWorkers = 123,
    NetworkConfiguration = new NetworkConfigurationProperty {
        SecurityGroupIds = new [] { "securityGroupIds" },
        SubnetIds = new [] { "subnetIds" }
    },
    PluginsS3ObjectVersion = "pluginsS3ObjectVersion",
    PluginsS3Path = "pluginsS3Path",
    RequirementsS3ObjectVersion = "requirementsS3ObjectVersion",
    RequirementsS3Path = "requirementsS3Path",
    Schedulers = 123,
    SourceBucketArn = "sourceBucketArn",
    StartupScriptS3ObjectVersion = "startupScriptS3ObjectVersion",
    StartupScriptS3Path = "startupScriptS3Path",
    Tags = tags,
    WebserverAccessMode = "webserverAccessMode",
    WeeklyMaintenanceWindowStart = "weeklyMaintenanceWindowStart",
    WorkerReplacementStrategy = "workerReplacementStrategy"
});
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

var airflowConfigurationOptions interface{}
var tags interface{}

cfnEnvironment := awscdk.Aws_mwaa.NewCfnEnvironment(this, jsii.String("MyCfnEnvironment"), &CfnEnvironmentProps{
	Name: jsii.String("name"),

	// the properties below are optional
	AirflowConfigurationOptions: airflowConfigurationOptions,
	AirflowVersion: jsii.String("airflowVersion"),
	DagS3Path: jsii.String("dagS3Path"),
	EndpointManagement: jsii.String("endpointManagement"),
	EnvironmentClass: jsii.String("environmentClass"),
	ExecutionRoleArn: jsii.String("executionRoleArn"),
	KmsKey: jsii.String("kmsKey"),
	LoggingConfiguration: &LoggingConfigurationProperty{
		DagProcessingLogs: &ModuleLoggingConfigurationProperty{
			CloudWatchLogGroupArn: jsii.String("cloudWatchLogGroupArn"),
			Enabled: jsii.Boolean(false),
			LogLevel: jsii.String("logLevel"),
		},
		SchedulerLogs: &ModuleLoggingConfigurationProperty{
			CloudWatchLogGroupArn: jsii.String("cloudWatchLogGroupArn"),
			Enabled: jsii.Boolean(false),
			LogLevel: jsii.String("logLevel"),
		},
		TaskLogs: &ModuleLoggingConfigurationProperty{
			CloudWatchLogGroupArn: jsii.String("cloudWatchLogGroupArn"),
			Enabled: jsii.Boolean(false),
			LogLevel: jsii.String("logLevel"),
		},
		WebserverLogs: &ModuleLoggingConfigurationProperty{
			CloudWatchLogGroupArn: jsii.String("cloudWatchLogGroupArn"),
			Enabled: jsii.Boolean(false),
			LogLevel: jsii.String("logLevel"),
		},
		WorkerLogs: &ModuleLoggingConfigurationProperty{
			CloudWatchLogGroupArn: jsii.String("cloudWatchLogGroupArn"),
			Enabled: jsii.Boolean(false),
			LogLevel: jsii.String("logLevel"),
		},
	},
	MaxWebservers: jsii.Number(123),
	MaxWorkers: jsii.Number(123),
	MinWebservers: jsii.Number(123),
	MinWorkers: jsii.Number(123),
	NetworkConfiguration: &NetworkConfigurationProperty{
		SecurityGroupIds: []*string{
			jsii.String("securityGroupIds"),
		},
		SubnetIds: []*string{
			jsii.String("subnetIds"),
		},
	},
	PluginsS3ObjectVersion: jsii.String("pluginsS3ObjectVersion"),
	PluginsS3Path: jsii.String("pluginsS3Path"),
	RequirementsS3ObjectVersion: jsii.String("requirementsS3ObjectVersion"),
	RequirementsS3Path: jsii.String("requirementsS3Path"),
	Schedulers: jsii.Number(123),
	SourceBucketArn: jsii.String("sourceBucketArn"),
	StartupScriptS3ObjectVersion: jsii.String("startupScriptS3ObjectVersion"),
	StartupScriptS3Path: jsii.String("startupScriptS3Path"),
	Tags: tags,
	WebserverAccessMode: jsii.String("webserverAccessMode"),
	WeeklyMaintenanceWindowStart: jsii.String("weeklyMaintenanceWindowStart"),
	WorkerReplacementStrategy: jsii.String("workerReplacementStrategy"),
})

Initializer ​

ts
new CfnEnvironment(scope: Construct, id: string, props: CfnEnvironmentProps)
python
CfnEnvironment(scope: Construct, id: str, props: CfnEnvironmentProps)
java
new CfnEnvironment(Construct scope, String id, CfnEnvironmentProps props)
csharp
new CfnEnvironment(Construct scope, string id, CfnEnvironmentProps props)
go
NewCfnEnvironment(Scope Construct, Id *string, Props CfnEnvironmentProps)

Construct Props ​

airflowConfigurationOptionsoptionalanyairflow_configuration_optionsoptionalAnyairflowConfigurationOptionsoptionalObjectAirflowConfigurationOptionsoptionalobjectAirflowConfigurationOptionsoptionalinterface{}#
A list of key-value pairs containing the Airflow configuration options for your environment.

For example, core.default_timezone: utc . To learn more, see Apache Airflow configuration options .

airflowVersionoptionalstringairflow_versionoptionalstrairflowVersionoptionalStringAirflowVersionoptionalstringAirflowVersionoptional*string#
The version of Apache Airflow to use for the environment.
notes

If no value is specified, defaults to the latest version.

If you specify a newer version number for an existing environment, the version update requires some service interruption before taking effect.

Allowed Values : 2.7.2 | 2.8.1 | 2.9.2 | 2.10.1 | 2.10.3 | 3.0.6 (latest)

dagS3Pathoptionalstringdag_s3_pathoptionalstrdagS3PathoptionalStringDagS3PathoptionalstringDagS3Pathoptional*string#
The relative path to the DAGs folder on your Amazon S3 bucket.

For example, dags . To learn more, see Adding or updating DAGs .

endpointManagementoptionalstringendpoint_managementoptionalstrendpointManagementoptionalStringEndpointManagementoptionalstringEndpointManagementoptional*string#
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.

environmentClassoptionalstringenvironment_classoptionalstrenvironmentClassoptionalStringEnvironmentClassoptionalstringEnvironmentClassoptional*string#
The environment class type.

Valid values: mw1.micro , mw1.small , mw1.medium , mw1.large , mw1.1large , and mw1.2large . To learn more, see Amazon MWAA environment class .

executionRoleArnoptionalstring | IRoleRefexecution_role_arnoptionaltyping.Union[str, IRoleRef]executionRoleArnoptionalStringExecutionRoleArnoptionalstringExecutionRoleArnoptionalinterface{}#
The Amazon Resource Name (ARN) of the execution role in IAM that allows MWAA to access AWS resources in your environment.

For example, arn:aws:iam::123456789:role/my-execution-role . To learn more, see Amazon MWAA Execution role .

kmsKeyoptionalstring | IKeyRefkms_keyoptionaltyping.Union[str, IKeyRef]kmsKeyoptionalStringKmsKeyoptionalstringKmsKeyoptionalinterface{}#
The AWS Key Management Service (KMS) key to encrypt and decrypt the data in your environment.

You can use an AWS KMS key managed by MWAA, or a customer-managed KMS key (advanced).

loggingConfigurationoptionalIResolvable | CfnEnvironment.LoggingConfigurationPropertylogging_configurationoptionaltyping.Union[IResolvable, LoggingConfigurationProperty]loggingConfigurationoptionalIResolvableLoggingConfigurationoptionalIResolvableLoggingConfigurationoptionalinterface{}#
The Apache Airflow logs being sent to CloudWatch Logs: `DagProcessingLogs` , `SchedulerLogs` , `TaskLogs` , `WebserverLogs` , `WorkerLogs` .
maxWebserversoptionalnumbermax_webserversoptionalint | floatmaxWebserversoptionalNumberMaxWebserversoptionaldoubleMaxWebserversoptional*float64#
The maximum number of web servers that you want to run in your environment.
notes

Amazon MWAA scales the number of Apache Airflow web servers up to the number you specify for MaxWebservers 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 MaxWebserers . As TPS rates decrease Amazon MWAA disposes of the additional web servers, and scales down to the number set in MinxWebserers .

Valid values: For environments larger than mw1.micro, accepts values from 2 to 5 . Defaults to 2 for all environment sizes except mw1.micro, which defaults to 1 .

maxWorkersoptionalnumbermax_workersoptionalint | floatmaxWorkersoptionalNumberMaxWorkersoptionaldoubleMaxWorkersoptional*float64#
The maximum number of workers that you want to run in your environment.
notes

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 .

minWebserversoptionalnumbermin_webserversoptionalint | floatminWebserversoptionalNumberMinWebserversoptionaldoubleMinWebserversoptional*float64#
The minimum number of web servers that you want to run in your environment.
notes

Amazon MWAA scales the number of Apache Airflow web servers up to the number you specify for MaxWebservers 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 MinxWebserers .

Valid values: For environments larger than mw1.micro, accepts values from 2 to 5 . Defaults to 2 for all environment sizes except mw1.micro, which defaults to 1 .

minWorkersoptionalnumbermin_workersoptionalint | floatminWorkersoptionalNumberMinWorkersoptionaldoubleMinWorkersoptional*float64#
The minimum number of workers that you want to run in your environment.
notes

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 .

namestringnamestrnameStringNamestringName*stringrequired#
The name of your Amazon MWAA environment.
networkConfigurationoptionalIResolvable | CfnEnvironment.NetworkConfigurationPropertynetwork_configurationoptionaltyping.Union[IResolvable, NetworkConfigurationProperty]networkConfigurationoptionalIResolvableNetworkConfigurationoptionalIResolvableNetworkConfigurationoptionalinterface{}#
The VPC networking components used to secure and enable network traffic between the AWS resources for your environment.

To learn more, see About networking on Amazon MWAA .

pluginsS3ObjectVersionoptionalstringplugins_s3_object_versionoptionalstrpluginsS3ObjectVersionoptionalStringPluginsS3ObjectVersionoptionalstringPluginsS3ObjectVersionoptional*string#
The version of the plugins.zip file on your Amazon S3 bucket. To learn more, see [Installing custom plugins](https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-dag-import-plugins.html) .
pluginsS3Pathoptionalstringplugins_s3_pathoptionalstrpluginsS3PathoptionalStringPluginsS3PathoptionalstringPluginsS3Pathoptional*string#
The relative path to the `plugins.zip` file on your Amazon S3 bucket. For example, `plugins.zip` . To learn more, see [Installing custom plugins](https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-dag-import-plugins.html) .
requirementsS3ObjectVersionoptionalstringrequirements_s3_object_versionoptionalstrrequirementsS3ObjectVersionoptionalStringRequirementsS3ObjectVersionoptionalstringRequirementsS3ObjectVersionoptional*string#
The version of the requirements.txt file on your Amazon S3 bucket. To learn more, see [Installing Python dependencies](https://docs.aws.amazon.com/mwaa/latest/userguide/working-dags-dependencies.html) .
requirementsS3Pathoptionalstringrequirements_s3_pathoptionalstrrequirementsS3PathoptionalStringRequirementsS3PathoptionalstringRequirementsS3Pathoptional*string#
The relative path to the `requirements.txt` file on your Amazon S3 bucket. For example, `requirements.txt` . To learn more, see [Installing Python dependencies](https://docs.aws.amazon.com/mwaa/latest/userguide/working-dags-dependencies.html) .
schedulersoptionalnumberschedulersoptionalint | floatschedulersoptionalNumberSchedulersoptionaldoubleSchedulersoptional*float64#
The number of schedulers that you want to run in your environment. Valid values:.
  • v2 - For environments larger than mw1.micro, accepts values from 2 to 5. Defaults to 2 for all environment sizes except mw1.micro, which defaults to 1.
  • v1 - Accepts 1.
sourceBucketArnoptionalstring | IBucketRefsource_bucket_arnoptionaltyping.Union[str, IBucketRef]sourceBucketArnoptionalStringSourceBucketArnoptionalstringSourceBucketArnoptionalinterface{}#
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 . To learn more, see Create an Amazon S3 bucket for Amazon MWAA .

startupScriptS3ObjectVersionoptionalstringstartup_script_s3_object_versionoptionalstrstartupScriptS3ObjectVersionoptionalStringStartupScriptS3ObjectVersionoptionalstringStartupScriptS3ObjectVersionoptional*string#
The version of the startup shell script in your Amazon S3 bucket.
notes

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 .

startupScriptS3Pathoptionalstringstartup_script_s3_pathoptionalstrstartupScriptS3PathoptionalStringStartupScriptS3PathoptionalstringStartupScriptS3Pathoptional*string#
The relative path to the startup shell script in your Amazon S3 bucket. For example, `s3://mwaa-environment/startup.sh` .
notes

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 .

tagsoptionalanytagsoptionalAnytagsoptionalObjectTagsoptionalobjectTagsoptionalinterface{}#
The key-value tag pairs associated to your environment. For example, `"Environment": "Staging"` . To learn more, see [Tagging](https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) .

If you specify new tags for an existing environment, the update requires service interruption before taking effect.

webserverAccessModeoptionalstringwebserver_access_modeoptionalstrwebserverAccessModeoptionalStringWebserverAccessModeoptionalstringWebserverAccessModeoptional*string#
The Apache Airflow *Web server* access mode.

To learn more, see Apache Airflow access modes . Valid values: PRIVATE_ONLY or PUBLIC_ONLY .

weeklyMaintenanceWindowStartoptionalstringweekly_maintenance_window_startoptionalstrweeklyMaintenanceWindowStartoptionalStringWeeklyMaintenanceWindowStartoptionalstringWeeklyMaintenanceWindowStartoptional*string#
The day and time of the week 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. Supported input includes the following:

  • MON|TUE|WED|THU|FRI|SAT|SUN:([01]\d|2[0-3]):(00|30)
workerReplacementStrategyoptionalstringworker_replacement_strategyoptionalstrworkerReplacementStrategyoptionalStringWorkerReplacementStrategyoptionalstringWorkerReplacementStrategyoptional*string#
The worker replacement strategy to use when updating the environment.
notes

Valid values: FORCED, GRACEFUL. FORCED means Apache Airflow workers will be stopped and replaced without waiting for tasks to complete before an update. GRACEFUL means Apache Airflow workers will be able to complete running tasks for up to 12 hours during an update before being stopped and replaced.

Properties ​

airflowConfigurationOptionsanyairflow_configuration_optionsAnyairflowConfigurationOptionsObjectAirflowConfigurationOptionsobjectAirflowConfigurationOptionsinterface{}required#
A list of key-value pairs containing the Airflow configuration options for your environment.
airflowVersionmay be undefinedstringairflow_versionmay be undefinedstrairflowVersionmay be undefinedStringAirflowVersionmay be undefinedstringAirflowVersionmay be undefined*string#
The version of Apache Airflow to use for the environment.
attrArnstringattr_arnstrattrArnStringAttrArnstringAttrArn*stringrequired#
The ARN for the Amazon MWAA environment.
attrCeleryExecutorQueuestringattr_celery_executor_queuestrattrCeleryExecutorQueueStringAttrCeleryExecutorQueuestringAttrCeleryExecutorQueue*stringrequired#
The queue ARN for the environment's [Celery Executor](https://docs.aws.amazon.com/https://airflow.apache.org/docs/apache-airflow/stable/core-concepts/executor/celery.html) . 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.
attrDatabaseVpcEndpointServicestringattr_database_vpc_endpoint_servicestrattrDatabaseVpcEndpointServiceStringAttrDatabaseVpcEndpointServicestringAttrDatabaseVpcEndpointService*stringrequired#
The VPC endpoint for the environment's Amazon RDS database.
attrLoggingConfigurationDagProcessingLogsCloudWatchLogGroupArnstringattr_logging_configuration_dag_processing_logs_cloud_watch_log_group_arnstrattrLoggingConfigurationDagProcessingLogsCloudWatchLogGroupArnStringAttrLoggingConfigurationDagProcessingLogsCloudWatchLogGroupArnstringAttrLoggingConfigurationDagProcessingLogsCloudWatchLogGroupArn*stringrequired#
The ARN for the CloudWatch Logs group where the Apache Airflow DAG processing logs are published.
attrLoggingConfigurationSchedulerLogsCloudWatchLogGroupArnstringattr_logging_configuration_scheduler_logs_cloud_watch_log_group_arnstrattrLoggingConfigurationSchedulerLogsCloudWatchLogGroupArnStringAttrLoggingConfigurationSchedulerLogsCloudWatchLogGroupArnstringAttrLoggingConfigurationSchedulerLogsCloudWatchLogGroupArn*stringrequired#
The ARN for the CloudWatch Logs group where the Apache Airflow Scheduler logs are published.
attrLoggingConfigurationTaskLogsCloudWatchLogGroupArnstringattr_logging_configuration_task_logs_cloud_watch_log_group_arnstrattrLoggingConfigurationTaskLogsCloudWatchLogGroupArnStringAttrLoggingConfigurationTaskLogsCloudWatchLogGroupArnstringAttrLoggingConfigurationTaskLogsCloudWatchLogGroupArn*stringrequired#
The ARN for the CloudWatch Logs group where the Apache Airflow task logs are published.
attrLoggingConfigurationWebserverLogsCloudWatchLogGroupArnstringattr_logging_configuration_webserver_logs_cloud_watch_log_group_arnstrattrLoggingConfigurationWebserverLogsCloudWatchLogGroupArnStringAttrLoggingConfigurationWebserverLogsCloudWatchLogGroupArnstringAttrLoggingConfigurationWebserverLogsCloudWatchLogGroupArn*stringrequired#
The ARN for the CloudWatch Logs group where the Apache Airflow Web server logs are published.
attrLoggingConfigurationWorkerLogsCloudWatchLogGroupArnstringattr_logging_configuration_worker_logs_cloud_watch_log_group_arnstrattrLoggingConfigurationWorkerLogsCloudWatchLogGroupArnStringAttrLoggingConfigurationWorkerLogsCloudWatchLogGroupArnstringAttrLoggingConfigurationWorkerLogsCloudWatchLogGroupArn*stringrequired#
The ARN for the CloudWatch Logs group where the Apache Airflow Worker logs are published.
attrWebserverUrlstringattr_webserver_urlstrattrWebserverUrlStringAttrWebserverUrlstringAttrWebserverUrl*stringrequired#
The URL of your Apache Airflow UI.
attrWebserverVpcEndpointServicestringattr_webserver_vpc_endpoint_servicestrattrWebserverVpcEndpointServiceStringAttrWebserverVpcEndpointServicestringAttrWebserverVpcEndpointService*stringrequired#
The VPC endpoint for the environment's web server.
CFN_RESOURCE_TYPE_NAMEstringcfn_resource_type_namestrCFN_RESOURCE_TYPE_NAMEStringCFN_RESOURCE_TYPE_NAMEstringCFN_RESOURCE_TYPE_NAME*stringrequiredstatic#
The CloudFormation resource type name for this resource class.
cfnOptionsICfnResourceOptionscfn_optionsICfnResourceOptionscfnOptionsICfnResourceOptionsCfnOptionsICfnResourceOptionsCfnOptionsICfnResourceOptionsrequired#
Options for this resource, such as condition, update policy etc.
cfnResourceTypestringcfn_resource_typestrcfnResourceTypeStringCfnResourceTypestringCfnResourceType*stringrequired#
AWS resource type.
creationStackstring[]creation_stacktyping.List[str]creationStackList<String>CreationStackstring[]CreationStack*[]*stringrequired#
dagS3Pathmay be undefinedstringdag_s3_pathmay be undefinedstrdagS3Pathmay be undefinedStringDagS3Pathmay be undefinedstringDagS3Pathmay be undefined*string#
The relative path to the DAGs folder on your Amazon S3 bucket.
endpointManagementmay be undefinedstringendpoint_managementmay be undefinedstrendpointManagementmay be undefinedStringEndpointManagementmay be undefinedstringEndpointManagementmay be undefined*string#
Defines whether the VPC endpoints configured for the environment are created, and managed, by the customer or by Amazon MWAA.
environmentClassmay be undefinedstringenvironment_classmay be undefinedstrenvironmentClassmay be undefinedStringEnvironmentClassmay be undefinedstringEnvironmentClassmay be undefined*string#
The environment class type.
environmentRefEnvironmentReferenceenvironment_refEnvironmentReferenceenvironmentRefEnvironmentReferenceEnvironmentRefEnvironmentReferenceEnvironmentRefEnvironmentReferencerequired#
A reference to a Environment resource.
executionRoleArnmay be undefinedstringexecution_role_arnmay be undefinedstrexecutionRoleArnmay be undefinedStringExecutionRoleArnmay be undefinedstringExecutionRoleArnmay be undefined*string#
The Amazon Resource Name (ARN) of the execution role in IAM that allows MWAA to access AWS resources in your environment.
kmsKeymay be undefinedstringkms_keymay be undefinedstrkmsKeymay be undefinedStringKmsKeymay be undefinedstringKmsKeymay be undefined*string#
The AWS Key Management Service (KMS) key to encrypt and decrypt the data in your environment.
loggingConfigurationmay be undefinedIResolvable | CfnEnvironment.LoggingConfigurationPropertylogging_configurationmay be undefinedtyping.Union[IResolvable, LoggingConfigurationProperty]loggingConfigurationmay be undefinedIResolvableLoggingConfigurationmay be undefinedIResolvableLoggingConfigurationmay be undefinedinterface{}#
The Apache Airflow logs being sent to CloudWatch Logs: `DagProcessingLogs` , `SchedulerLogs` , `TaskLogs` , `WebserverLogs` , `WorkerLogs` .
logicalIdstringlogical_idstrlogicalIdStringLogicalIdstringLogicalId*stringrequired#
The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

maxWebserversmay be undefinednumbermax_webserversmay be undefinedint | floatmaxWebserversmay be undefinedNumberMaxWebserversmay be undefineddoubleMaxWebserversmay be undefined*float64#
The maximum number of web servers that you want to run in your environment.
maxWorkersmay be undefinednumbermax_workersmay be undefinedint | floatmaxWorkersmay be undefinedNumberMaxWorkersmay be undefineddoubleMaxWorkersmay be undefined*float64#
The maximum number of workers that you want to run in your environment.
minWebserversmay be undefinednumbermin_webserversmay be undefinedint | floatminWebserversmay be undefinedNumberMinWebserversmay be undefineddoubleMinWebserversmay be undefined*float64#
The minimum number of web servers that you want to run in your environment.
minWorkersmay be undefinednumbermin_workersmay be undefinedint | floatminWorkersmay be undefinedNumberMinWorkersmay be undefineddoubleMinWorkersmay be undefined*float64#
The minimum number of workers that you want to run in your environment.
namestringnamestrnameStringNamestringName*stringrequired#
The name of your Amazon MWAA environment.
networkConfigurationmay be undefinedIResolvable | CfnEnvironment.NetworkConfigurationPropertynetwork_configurationmay be undefinedtyping.Union[IResolvable, NetworkConfigurationProperty]networkConfigurationmay be undefinedIResolvableNetworkConfigurationmay be undefinedIResolvableNetworkConfigurationmay be undefinedinterface{}#
The VPC networking components used to secure and enable network traffic between the AWS resources for your environment.
nodeNodenodeNodenodeNodeNodeNodeNodeNoderequired#
The tree node.
pluginsS3ObjectVersionmay be undefinedstringplugins_s3_object_versionmay be undefinedstrpluginsS3ObjectVersionmay be undefinedStringPluginsS3ObjectVersionmay be undefinedstringPluginsS3ObjectVersionmay be undefined*string#
The version of the plugins.zip file on your Amazon S3 bucket. To learn more, see [Installing custom plugins](https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-dag-import-plugins.html) .
pluginsS3Pathmay be undefinedstringplugins_s3_pathmay be undefinedstrpluginsS3Pathmay be undefinedStringPluginsS3Pathmay be undefinedstringPluginsS3Pathmay be undefined*string#
The relative path to the `plugins.zip` file on your Amazon S3 bucket. For example, `plugins.zip` . To learn more, see [Installing custom plugins](https://docs.aws.amazon.com/mwaa/latest/userguide/configuring-dag-import-plugins.html) .
refstringrefstrrefStringRefstringRef*stringrequired#
Return a string that will be resolved to a CloudFormation `{ Ref }` for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

requirementsS3ObjectVersionmay be undefinedstringrequirements_s3_object_versionmay be undefinedstrrequirementsS3ObjectVersionmay be undefinedStringRequirementsS3ObjectVersionmay be undefinedstringRequirementsS3ObjectVersionmay be undefined*string#
The version of the requirements.txt file on your Amazon S3 bucket. To learn more, see [Installing Python dependencies](https://docs.aws.amazon.com/mwaa/latest/userguide/working-dags-dependencies.html) .
requirementsS3Pathmay be undefinedstringrequirements_s3_pathmay be undefinedstrrequirementsS3Pathmay be undefinedStringRequirementsS3Pathmay be undefinedstringRequirementsS3Pathmay be undefined*string#
The relative path to the `requirements.txt` file on your Amazon S3 bucket. For example, `requirements.txt` . To learn more, see [Installing Python dependencies](https://docs.aws.amazon.com/mwaa/latest/userguide/working-dags-dependencies.html) .
schedulersmay be undefinednumberschedulersmay be undefinedint | floatschedulersmay be undefinedNumberSchedulersmay be undefineddoubleSchedulersmay be undefined*float64#
The number of schedulers that you want to run in your environment.

Valid values:.

sourceBucketArnmay be undefinedstringsource_bucket_arnmay be undefinedstrsourceBucketArnmay be undefinedStringSourceBucketArnmay be undefinedstringSourceBucketArnmay be undefined*string#
The Amazon Resource Name (ARN) of the Amazon S3 bucket where your DAG code and supporting files are stored.
stackStackstackStackstackStackStackStackStackStackrequired#
The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

startupScriptS3ObjectVersionmay be undefinedstringstartup_script_s3_object_versionmay be undefinedstrstartupScriptS3ObjectVersionmay be undefinedStringStartupScriptS3ObjectVersionmay be undefinedstringStartupScriptS3ObjectVersionmay be undefined*string#
The version of the startup shell script in your Amazon S3 bucket.
startupScriptS3Pathmay be undefinedstringstartup_script_s3_pathmay be undefinedstrstartupScriptS3Pathmay be undefinedStringStartupScriptS3Pathmay be undefinedstringStartupScriptS3Pathmay be undefined*string#
The relative path to the startup shell script in your Amazon S3 bucket.

For example, s3://mwaa-environment/startup.sh .

tagsTagManagertagsTagManagertagsTagManagerTagsTagManagerTagsTagManagerrequired#
Tag Manager which manages the tags for this resource.
tagsRawanytags_rawAnytagsRawObjectTagsRawobjectTagsRawinterface{}required#
The key-value tag pairs associated to your environment.

For example, "Environment": "Staging" . To learn more, see Tagging .

webserverAccessModemay be undefinedstringwebserver_access_modemay be undefinedstrwebserverAccessModemay be undefinedStringWebserverAccessModemay be undefinedstringWebserverAccessModemay be undefined*string#
The Apache Airflow *Web server* access mode.
weeklyMaintenanceWindowStartmay be undefinedstringweekly_maintenance_window_startmay be undefinedstrweeklyMaintenanceWindowStartmay be undefinedStringWeeklyMaintenanceWindowStartmay be undefinedstringWeeklyMaintenanceWindowStartmay be undefined*string#
The day and time of the week to start weekly maintenance updates of your environment in the following format: `DAY:HH:MM` .
workerReplacementStrategymay be undefinedstringworker_replacement_strategymay be undefinedstrworkerReplacementStrategymay be undefinedStringWorkerReplacementStrategymay be undefinedstringWorkerReplacementStrategymay be undefined*string#
The worker replacement strategy to use when updating the environment.

Methods ​

addDeletionOverride(path: string): voiddef add_deletion_override(self, path: str) -> Nonepublic void addDeletionOverride(String path)public void AddDeletionOverride(string path)func AddDeletionOverride(Path *string)#
Syntactic sugar for `addOverride(path, undefined)`.
1 parameter

Parameters

  • pathpathpathpathPath — The path of the value to delete.
addDependency(target: CfnResource): voiddef add_dependency(self, target: CfnResource) -> Nonepublic void addDependency(CfnResource target)public void AddDependency(CfnResource target)func AddDependency(Target CfnResource)deprecated#
Use `addResourceDependency` instead.

This method has been renamed to addResourceDependency to more clearly set it apart from construct.node.addDependency. See the documentation of that function for more details.

addDependsOn(target: CfnResource): voiddef add_depends_on(self, target: CfnResource) -> Nonepublic void addDependsOn(CfnResource target)public void AddDependsOn(CfnResource target)func AddDependsOn(Target CfnResource)deprecated#
Use `addResourceDependency` instead.
notes

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

This method has been renamed to addResourceDependency, which makes it more clear that this method operates at a different level from the construct-level construct.node.addDependency() mechanism.

addMetadata(key: string, value: any): voiddef add_metadata(self, key: str, value: Any) -> Nonepublic void addMetadata(String key, Object value)public void AddMetadata(string key, object value)func AddMetadata(Key *string, Value interface{})#
Add a value to the CloudFormation Resource Metadata.
addOverride(path: string, value: any): voiddef add_override(self, path: str, value: Any) -> Nonepublic void addOverride(String path, Object value)public void AddOverride(string path, object value)func AddOverride(Path *string, Value interface{})#
Adds an override to the synthesized CloudFormation resource.
notes · 2 parameters

To add a property override, either use addPropertyOverride or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example,

typescript
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');

would add the overrides

json
"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters

  • pathpathpathpathPath — - The path of the property, you can use dot notation to override values in complex types.
  • valuevaluevaluevalueValue — - The value.
addPropertyDeletionOverride(propertyPath: string): voiddef add_property_deletion_override(self, property_path: str) -> Nonepublic void addPropertyDeletionOverride(String propertyPath)public void AddPropertyDeletionOverride(string propertyPath)func AddPropertyDeletionOverride(PropertyPath *string)#
Adds an override that deletes the value of a property from the resource definition.
1 parameter

Parameters

  • propertyPathproperty_pathpropertyPathpropertyPathPropertyPath — The path to the property.
addPropertyOverride(propertyPath: string, value: any): voiddef add_property_override(self, property_path: str, value: Any) -> Nonepublic void addPropertyOverride(String propertyPath, Object value)public void AddPropertyOverride(string propertyPath, object value)func AddPropertyOverride(PropertyPath *string, Value interface{})#
Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

2 parameters

Parameters

  • propertyPathproperty_pathpropertyPathpropertyPathPropertyPath — The path of the property.
  • valuevaluevaluevalueValue — The value.
addResourceDependency(target: CfnResource, reason?: string): voiddef add_resource_dependency(self, target: CfnResource, reason: typing.Optional[str] = None) -> Nonepublic void addResourceDependency(CfnResource target, String reason)public void AddResourceDependency(CfnResource target, string? reason = null)func AddResourceDependency(Target CfnResource, Reason *string)#
Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
notes

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

This method only adds dependencies between L1 resources. If you are looking for a generic construct-to-construct dependency mechanism that works for all constructs including L2s, use construct.node.addDependency instead.

applyCrossStackReferenceStrength(strength: ReferenceStrength): voiddef apply_cross_stack_reference_strength(self, strength: ReferenceStrength) -> Nonepublic void applyCrossStackReferenceStrength(ReferenceStrength strength)public void ApplyCrossStackReferenceStrength(ReferenceStrength strength)func ApplyCrossStackReferenceStrength(Strength ReferenceStrength)#
Sets the cross-stack reference strength for this resource.

When set, any cross-stack reference to this resource will use the specified strength instead of the global default from the consuming stack's context.

1 parameter

Parameters

  • strengthstrengthstrengthstrengthStrength — - The reference strength to use for this resource.
applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): voiddef apply_removal_policy(self, policy: typing.Optional[RemovalPolicy] = None, options: typing.Optional[RemovalPolicyOptions] = None) -> Nonepublic void applyRemovalPolicy(RemovalPolicy policy, RemovalPolicyOptions options)public void ApplyRemovalPolicy(RemovalPolicy? policy = null, RemovalPolicyOptions? options = null)func ApplyRemovalPolicy(Policy RemovalPolicy, Options RemovalPolicyOptions)#
Sets the deletion policy of the resource based on the removal policy specified.
notes

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

arnForEnvironment(resource: IEnvironmentRef): string@staticmethod def arn_for_environment(resource: IEnvironmentRef) -> strpublic static String arnForEnvironment(IEnvironmentRef resource)public static string ArnForEnvironment(IEnvironmentRef resource)func ArnForEnvironment(Resource IEnvironmentRef) *stringstatic#
cfnPropertyName(cdkPropertyName: string): stringdef cfn_property_name(self, cdk_property_name: str) -> strpublic String cfnPropertyName(String cdkPropertyName)public string CfnPropertyName(string cdkPropertyName)func CfnPropertyName(CdkPropertyName *string) *string#
fromEnvironmentArn(scope: Construct, id: string, arn: string): IEnvironmentRef@staticmethod def from_environment_arn(scope: Construct, id: str, arn: str) -> IEnvironmentRefpublic static IEnvironmentRef fromEnvironmentArn(Construct scope, String id, String arn)public static IEnvironmentRef FromEnvironmentArn(Construct scope, string id, string arn)func FromEnvironmentArn(Scope Construct, Id *string, Arn *string) IEnvironmentRefstatic#
Creates a new IEnvironmentRef from an ARN.
fromEnvironmentName(scope: Construct, id: string, environmentName: string): IEnvironmentRef@staticmethod def from_environment_name(scope: Construct, id: str, environment_name: str) -> IEnvironmentRefpublic static IEnvironmentRef fromEnvironmentName(Construct scope, String id, String environmentName)public static IEnvironmentRef FromEnvironmentName(Construct scope, string id, string environmentName)func FromEnvironmentName(Scope Construct, Id *string, EnvironmentName *string) IEnvironmentRefstatic#
Creates a new IEnvironmentRef from a environmentName.
getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Referencedef get_att(self, attribute_name: str, type_hint: typing.Optional[ResolutionTypeHint] = None) -> Referencepublic Reference getAtt(String attributeName, ResolutionTypeHint typeHint)public Reference GetAtt(string attributeName, ResolutionTypeHint? typeHint = null)func GetAtt(AttributeName *string, TypeHint ResolutionTypeHint) Reference#
Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

1 parameter

Parameters

  • attributeNameattribute_nameattributeNameattributeNameAttributeName — The name of the attribute.
getMetadata(key: string): anydef get_metadata(self, key: str) -> Anypublic Object getMetadata(String key)public object GetMetadata(string key)func GetMetadata(Key *string) interface{}#
Retrieve a value value from the CloudFormation Resource Metadata.
inspect(inspector: TreeInspector): voiddef inspect(self, inspector: TreeInspector) -> Nonepublic void inspect(TreeInspector inspector)public void Inspect(TreeInspector inspector)func Inspect(Inspector TreeInspector)#
Examines the CloudFormation resource and discloses attributes.
1 parameter

Parameters

  • inspectorinspectorinspectorinspectorInspector — tree inspector to collect and process attributes.
isCfnElement(x: any): boolean@staticmethod def is_cfn_element(x: Any) -> boolpublic static Boolean isCfnElement(Object x)public static bool IsCfnElement(object x)func IsCfnElement(X interface{}) *boolstatic#
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

returns

Returns: The construct as a stack element or undefined if it is not a stack element.

isCfnEnvironment(x: any): boolean@staticmethod def is_cfn_environment(x: Any) -> boolpublic static Boolean isCfnEnvironment(Object x)public static bool IsCfnEnvironment(object x)func IsCfnEnvironment(X interface{}) *boolstatic#
Checks whether the given object is a CfnEnvironment.
isCfnResource(x: any): boolean@staticmethod def is_cfn_resource(x: Any) -> boolpublic static Boolean isCfnResource(Object x)public static bool IsCfnResource(object x)func IsCfnResource(X interface{}) *boolstatic#
Check whether the given object is a CfnResource.
isConstruct(x: any): boolean@staticmethod def is_construct(x: Any) -> boolpublic static Boolean isConstruct(Object x)public static bool IsConstruct(object x)func IsConstruct(X interface{}) *boolstatic#
Checks if `x` is a construct.
notes · 1 parameter · returns

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

Parameters

  • xxxxX — Any object.

Returns: true if x is an object created from a class which extends Construct.

obtainDependencies(): Stack | CfnResource[]def obtain_dependencies(self, ) -> typing.List[typing.Union[Stack, CfnResource]]public List<Stack> obtainDependencies()public Stack[] ObtainDependencies()func ObtainDependencies() *[]interface{}#
Retrieves an array of resources and stacks this resource depends on.

For resources depended on directly, returns the CfnResource object. For dependencies on other stacks, returns the Stack object. The order of the array is not guaranteed.

overrideLogicalId(newLogicalId: string): voiddef override_logical_id(self, new_logical_id: str) -> Nonepublic void overrideLogicalId(String newLogicalId)public void OverrideLogicalId(string newLogicalId)func OverrideLogicalId(NewLogicalId *string)#
Overrides the auto-generated logical ID with a specific ID.
1 parameter

Parameters

  • newLogicalIdnew_logical_idnewLogicalIdnewLogicalIdNewLogicalId — The new logical ID to use for this stack element.
removeDependency(target: CfnResource): voiddef remove_dependency(self, target: CfnResource) -> Nonepublic void removeDependency(CfnResource target)public void RemoveDependency(CfnResource target)func RemoveDependency(Target CfnResource)deprecated#
Use `removeResourceDependency` instead

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

removeResourceDependency(target: CfnResource): voiddef remove_resource_dependency(self, target: CfnResource) -> Nonepublic void removeResourceDependency(CfnResource target)public void RemoveResourceDependency(CfnResource target)func RemoveResourceDependency(Target CfnResource)#
Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

replaceDependency(target: CfnResource, newTarget: CfnResource): voiddef replace_dependency(self, target: CfnResource, new_target: CfnResource) -> Nonepublic void replaceDependency(CfnResource target, CfnResource newTarget)public void ReplaceDependency(CfnResource target, CfnResource newTarget)func ReplaceDependency(Target CfnResource, NewTarget CfnResource)#
Replaces one dependency with another.
2 parameters

Parameters

  • targettargettargettargetTarget — The dependency to replace.
  • newTargetnew_targetnewTargetnewTargetNewTarget — The new dependency to add.
toString(): stringdef to_string(self, ) -> strpublic String toString()public string ToString()func ToString() *string#
Returns a string representation of this construct.
returns

Returns: a string representation of this resource

with(...mixins: IMixin[]): IConstructdef with(self, mixins: IMixin) -> IConstructpublic IConstruct with(IMixin mixins)public IConstruct With(IMixin mixins)func With(Mixins IMixin) IConstruct#
Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.