class CfnEnvironment (construct)

Language	Type name
.NET	`Amazon.CDK.AWS.MWAA.CfnEnvironment`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsmwaa#CfnEnvironment`
Java	`software.amazon.awscdk.services.mwaa.CfnEnvironment`
Python	`aws_cdk.aws_mwaa.CfnEnvironment`
TypeScript	`aws-cdk-lib` » `aws_mwaa` » `CfnEnvironment`

Implements IConstruct, IDependable, IInspectable, ITaggable

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

Example

// 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',
});

Initializer

new CfnEnvironment(scope: Construct, id: string, props: CfnEnvironmentProps)

Parameters

scope Construct — Scope in which this resource is defined.
id string — Construct identifier for this resource (unique in its scope).
props CfnEnvironmentProps — Resource properties.

Construct Props

Name	Type	Description
name	`string`	The name of your Amazon MWAA environment.
airflowConfigurationOptions?	`any`	A list of key-value pairs containing the Airflow configuration options for your environment.
airflowVersion?	`string`	The version of Apache Airflow to use for the environment.
dagS3Path?	`string`	The relative path to the DAGs folder on your Amazon S3 bucket.
endpointManagement?	`string`	Defines whether the VPC endpoints configured for the environment are created, and managed, by the customer or by Amazon MWAA.
environmentClass?	`string`	The environment class type.
executionRoleArn?	`string`	The Amazon Resource Name (ARN) of the execution role in IAM that allows MWAA to access AWS resources in your environment.
kmsKey?	`string`	The AWS Key Management Service (KMS) key to encrypt and decrypt the data in your environment.
loggingConfiguration?	`IResolvable` `\|` `LoggingConfigurationProperty`	The Apache Airflow logs being sent to CloudWatch Logs: `DagProcessingLogs` , `SchedulerLogs` , `TaskLogs` , `WebserverLogs` , `WorkerLogs` .
maxWebservers?	`number`	The maximum number of web servers that you want to run in your environment.
maxWorkers?	`number`	The maximum number of workers that you want to run in your environment.
minWebservers?	`number`	The minimum number of web servers that you want to run in your environment.
minWorkers?	`number`	The minimum number of workers that you want to run in your environment.
networkConfiguration?	`IResolvable` `\|` `NetworkConfigurationProperty`	The VPC networking components used to secure and enable network traffic between the AWS resources for your environment.
pluginsS3ObjectVersion?	`string`	The version of the plugins.zip file on your Amazon S3 bucket. To learn more, see Installing custom plugins .
pluginsS3Path?	`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 .
requirementsS3ObjectVersion?	`string`	The version of the requirements.txt file on your Amazon S3 bucket. To learn more, see Installing Python dependencies .
requirementsS3Path?	`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 .
schedulers?	`number`	The number of schedulers that you want to run in your environment. Valid values:.
sourceBucketArn?	`string`	The Amazon Resource Name (ARN) of the Amazon S3 bucket where your DAG code and supporting files are stored.
startupScriptS3ObjectVersion?	`string`	The version of the startup shell script in your Amazon S3 bucket.
startupScriptS3Path?	`string`	The relative path to the startup shell script in your Amazon S3 bucket. For example, `s3://mwaa-environment/startup.sh` .
tags?	`any`	The key-value tag pairs associated to your environment. For example, `"Environment": "Staging"` . To learn more, see Tagging .
webserverAccessMode?	`string`	The Apache Airflow Web server access mode.
weeklyMaintenanceWindowStart?	`string`	The day and time of the week to start weekly maintenance updates of your environment in the following format: `DAY:HH:MM` .

name

Type: string

The name of your Amazon MWAA environment.

airflowConfigurationOptions?

Type: any (optional)

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 .

airflowVersion?

Type: string (optional)

The version of Apache Airflow to use for the environment.

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 : 1.10.12 | 2.0.2 | 2.2.2 | 2.4.3 | 2.5.1 | 2.6.3 | 2.7.2 | 2.8.1 | 2.9.2 (latest)

dagS3Path?

Type: string (optional)

The relative path to the DAGs folder on your Amazon S3 bucket.

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

endpointManagement?

Type: string (optional)

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.

environmentClass?

Type: string (optional)

The environment class type.

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

executionRoleArn?

Type: string (optional)

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 .

kmsKey?

Type: string (optional)

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).

loggingConfiguration?

Type: IResolvable | LoggingConfigurationProperty (optional)

The Apache Airflow logs being sent to CloudWatch Logs: DagProcessingLogs , SchedulerLogs , TaskLogs , WebserverLogs , WorkerLogs .

maxWebservers?

Type: number (optional)

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 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: Accepts between 2 and 5 . Defaults to 2 .

maxWorkers?

Type: number (optional)

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 .

minWebservers?

Type: number (optional)

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 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: Accepts between 2 and 5 . Defaults to 2 .

minWorkers?

Type: number (optional)

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 .

networkConfiguration?

Type: IResolvable | NetworkConfigurationProperty (optional)

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 .

pluginsS3ObjectVersion?

Type: string (optional)

The version of the plugins.zip file on your Amazon S3 bucket. To learn more, see Installing custom plugins .

pluginsS3Path?

Type: string (optional)

The relative path to the plugins.zip file on your Amazon S3 bucket. For example, plugins.zip . To learn more, see Installing custom plugins .

requirementsS3ObjectVersion?

Type: string (optional)

The version of the requirements.txt file on your Amazon S3 bucket. To learn more, see Installing Python dependencies .

requirementsS3Path?

Type: string (optional)

The relative path to the requirements.txt file on your Amazon S3 bucket. For example, requirements.txt . To learn more, see Installing Python dependencies .

schedulers?

Type: number (optional)

The number of schedulers that you want to run in your environment. Valid values:.

v2 - Accepts between 2 to 5. Defaults to 2.
v1 - Accepts 1.

sourceBucketArn?

Type: string (optional)

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 .

startupScriptS3ObjectVersion?

Type: string (optional)

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 .

startupScriptS3Path?

Type: string (optional)

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 .

tags?

Type: any (optional)

The key-value tag pairs associated to your environment. For example, "Environment": "Staging" . To learn more, see Tagging .

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

webserverAccessMode?

Type: string (optional)

The Apache Airflow Web server access mode.

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

weeklyMaintenanceWindowStart?

Type: string (optional)

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)

Properties

Name	Type	Description
attrArn	`string`	The ARN for the Amazon MWAA environment.
attrCeleryExecutorQueue	`string`	The queue ARN for the environment's Celery Executor . 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.
attrDatabaseVpcEndpointService	`string`	The VPC endpoint for the environment's Amazon RDS database.
attrLoggingConfigurationDagProcessingLogsCloudWatchLogGroupArn	`string`	The ARN for the CloudWatch Logs group where the Apache Airflow DAG processing logs are published.
attrLoggingConfigurationSchedulerLogsCloudWatchLogGroupArn	`string`	The ARN for the CloudWatch Logs group where the Apache Airflow Scheduler logs are published.
attrLoggingConfigurationTaskLogsCloudWatchLogGroupArn	`string`	The ARN for the CloudWatch Logs group where the Apache Airflow task logs are published.
attrLoggingConfigurationWebserverLogsCloudWatchLogGroupArn	`string`	The ARN for the CloudWatch Logs group where the Apache Airflow Web server logs are published.
attrLoggingConfigurationWorkerLogsCloudWatchLogGroupArn	`string`	The ARN for the CloudWatch Logs group where the Apache Airflow Worker logs are published.
attrWebserverUrl	`string`	The URL of your Apache Airflow UI.
attrWebserverVpcEndpointService	`string`	The VPC endpoint for the environment's web server.
cfnOptions	`ICfnResourceOptions`	Options for this resource, such as condition, update policy etc.
cfnProperties	`{ [string]: any }`
cfnResourceType	`string`	AWS resource type.
creationStack	`string[]`
logicalId	`string`	The logical ID for this CloudFormation stack element.
name	`string`	The name of your Amazon MWAA environment.
node	`Node`	The tree node.
ref	`string`	Return a string that will be resolved to a CloudFormation `{ Ref }` for this element.
stack	`Stack`	The stack in which this element is defined.
tags	`TagManager`	Tag Manager which manages the tags for this resource.
airflowConfigurationOptions?	`any`	A list of key-value pairs containing the Airflow configuration options for your environment.
airflowVersion?	`string`	The version of Apache Airflow to use for the environment.
dagS3Path?	`string`	The relative path to the DAGs folder on your Amazon S3 bucket.
endpointManagement?	`string`	Defines whether the VPC endpoints configured for the environment are created, and managed, by the customer or by Amazon MWAA.
environmentClass?	`string`	The environment class type.
executionRoleArn?	`string`	The Amazon Resource Name (ARN) of the execution role in IAM that allows MWAA to access AWS resources in your environment.
kmsKey?	`string`	The AWS Key Management Service (KMS) key to encrypt and decrypt the data in your environment.
loggingConfiguration?	`IResolvable` `\|` `LoggingConfigurationProperty`	The Apache Airflow logs being sent to CloudWatch Logs: `DagProcessingLogs` , `SchedulerLogs` , `TaskLogs` , `WebserverLogs` , `WorkerLogs` .
maxWebservers?	`number`	The maximum number of web servers that you want to run in your environment.
maxWorkers?	`number`	The maximum number of workers that you want to run in your environment.
minWebservers?	`number`	The minimum number of web servers that you want to run in your environment.
minWorkers?	`number`	The minimum number of workers that you want to run in your environment.
networkConfiguration?	`IResolvable` `\|` `NetworkConfigurationProperty`	The VPC networking components used to secure and enable network traffic between the AWS resources for your environment.
pluginsS3ObjectVersion?	`string`	The version of the plugins.zip file on your Amazon S3 bucket. To learn more, see Installing custom plugins .
pluginsS3Path?	`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 .
requirementsS3ObjectVersion?	`string`	The version of the requirements.txt file on your Amazon S3 bucket. To learn more, see Installing Python dependencies .
requirementsS3Path?	`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 .
schedulers?	`number`	The number of schedulers that you want to run in your environment.
sourceBucketArn?	`string`	The Amazon Resource Name (ARN) of the Amazon S3 bucket where your DAG code and supporting files are stored.
startupScriptS3ObjectVersion?	`string`	The version of the startup shell script in your Amazon S3 bucket.
startupScriptS3Path?	`string`	The relative path to the startup shell script in your Amazon S3 bucket.
tagsRaw?	`any`	The key-value tag pairs associated to your environment.
webserverAccessMode?	`string`	The Apache Airflow Web server access mode.
weeklyMaintenanceWindowStart?	`string`	The day and time of the week to start weekly maintenance updates of your environment in the following format: `DAY:HH:MM` .
static CFN_RESOURCE_TYPE_NAME	`string`	The CloudFormation resource type name for this resource class.

attrArn

Type: string

The ARN for the Amazon MWAA environment.

attrCeleryExecutorQueue

Type: string

The queue ARN for the environment's Celery Executor . 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.

attrDatabaseVpcEndpointService

Type: string

The VPC endpoint for the environment's Amazon RDS database.

attrLoggingConfigurationDagProcessingLogsCloudWatchLogGroupArn

Type: string

The ARN for the CloudWatch Logs group where the Apache Airflow DAG processing logs are published.

attrLoggingConfigurationSchedulerLogsCloudWatchLogGroupArn

Type: string

The ARN for the CloudWatch Logs group where the Apache Airflow Scheduler logs are published.

attrLoggingConfigurationTaskLogsCloudWatchLogGroupArn

Type: string

The ARN for the CloudWatch Logs group where the Apache Airflow task logs are published.

attrLoggingConfigurationWebserverLogsCloudWatchLogGroupArn

Type: string

The ARN for the CloudWatch Logs group where the Apache Airflow Web server logs are published.

attrLoggingConfigurationWorkerLogsCloudWatchLogGroupArn

Type: string

The ARN for the CloudWatch Logs group where the Apache Airflow Worker logs are published.

attrWebserverUrl

Type: string

The URL of your Apache Airflow UI.

attrWebserverVpcEndpointService

Type: string

The VPC endpoint for the environment's web server.

cfnOptions

Type: ICfnResourceOptions

Options for this resource, such as condition, update policy etc.

cfnProperties

Type: { [string]: any }

cfnResourceType

Type: string

AWS resource type.

creationStack

Type: string[]

logicalId

Type: string

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).

name

Type: string

The name of your Amazon MWAA environment.

node

Type: Node

The tree node.

ref

Type: string

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 }).

stack

Type: Stack

The stack in which this element is defined.

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

airflowConfigurationOptions?

Type: any (optional)

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

airflowVersion?

Type: string (optional)

The version of Apache Airflow to use for the environment.

dagS3Path?

Type: string (optional)

The relative path to the DAGs folder on your Amazon S3 bucket.

endpointManagement?

Type: string (optional)

Defines whether the VPC endpoints configured for the environment are created, and managed, by the customer or by Amazon MWAA.

environmentClass?

Type: string (optional)

The environment class type.

executionRoleArn?

Type: string (optional)

The Amazon Resource Name (ARN) of the execution role in IAM that allows MWAA to access AWS resources in your environment.

kmsKey?

Type: string (optional)

The AWS Key Management Service (KMS) key to encrypt and decrypt the data in your environment.

loggingConfiguration?

Type: IResolvable | LoggingConfigurationProperty (optional)

The Apache Airflow logs being sent to CloudWatch Logs: DagProcessingLogs , SchedulerLogs , TaskLogs , WebserverLogs , WorkerLogs .

maxWebservers?

Type: number (optional)

The maximum number of web servers that you want to run in your environment.

maxWorkers?

Type: number (optional)

The maximum number of workers that you want to run in your environment.

minWebservers?

Type: number (optional)

The minimum number of web servers that you want to run in your environment.

minWorkers?

Type: number (optional)

The minimum number of workers that you want to run in your environment.

networkConfiguration?

Type: IResolvable | NetworkConfigurationProperty (optional)

The VPC networking components used to secure and enable network traffic between the AWS resources for your environment.

pluginsS3ObjectVersion?

Type: string (optional)

The version of the plugins.zip file on your Amazon S3 bucket. To learn more, see Installing custom plugins .

pluginsS3Path?

Type: string (optional)

The relative path to the plugins.zip file on your Amazon S3 bucket. For example, plugins.zip . To learn more, see Installing custom plugins .

requirementsS3ObjectVersion?

Type: string (optional)

The version of the requirements.txt file on your Amazon S3 bucket. To learn more, see Installing Python dependencies .

requirementsS3Path?

Type: string (optional)

The relative path to the requirements.txt file on your Amazon S3 bucket. For example, requirements.txt . To learn more, see Installing Python dependencies .

schedulers?

Type: number (optional)

The number of schedulers that you want to run in your environment.

Valid values:.

sourceBucketArn?

Type: string (optional)

The Amazon Resource Name (ARN) of the Amazon S3 bucket where your DAG code and supporting files are stored.

startupScriptS3ObjectVersion?

Type: string (optional)

The version of the startup shell script in your Amazon S3 bucket.

startupScriptS3Path?

Type: string (optional)

The relative path to the startup shell script in your Amazon S3 bucket.

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

tagsRaw?

Type: any (optional)

The key-value tag pairs associated to your environment.

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

webserverAccessMode?

Type: string (optional)

The Apache Airflow Web server access mode.

weeklyMaintenanceWindowStart?

Type: string (optional)

The day and time of the week to start weekly maintenance updates of your environment in the following format: DAY:HH:MM .

static CFN_RESOURCE_TYPE_NAME

Type: string

The CloudFormation resource type name for this resource class.

Methods

Name	Description
addDeletionOverride(path)	Syntactic sugar for `addOverride(path, undefined)`.
addDependency(target)	Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addDependsOn(target)⚠️	Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addMetadata(key, value)	Add a value to the CloudFormation Resource Metadata.
addOverride(path, value)	Adds an override to the synthesized CloudFormation resource.
addPropertyDeletionOverride(propertyPath)	Adds an override that deletes the value of a property from the resource definition.
addPropertyOverride(propertyPath, value)	Adds an override to a resource property.
applyRemovalPolicy(policy?, options?)	Sets the deletion policy of the resource based on the removal policy specified.
getAtt(attributeName, typeHint?)	Returns a token for an runtime attribute of this resource.
getMetadata(key)	Retrieve a value value from the CloudFormation Resource Metadata.
inspect(inspector)	Examines the CloudFormation resource and discloses attributes.
obtainDependencies()	Retrieves an array of resources this resource depends on.
obtainResourceDependencies()	Get a shallow copy of dependencies between this resource and other resources in the same stack.
overrideLogicalId(newLogicalId)	Overrides the auto-generated logical ID with a specific ID.
removeDependency(target)	Indicates that this resource no longer depends on another resource.
replaceDependency(target, newTarget)	Replaces one dependency with another.
toString()	Returns a string representation of this construct.
protected renderProperties(props)

addDeletionOverride(path)

public addDeletionOverride(path: string): void

Parameters

path string — The path of the value to delete.

Syntactic sugar for addOverride(path, undefined).

addDependency(target)

public addDependency(target: CfnResource): void

Parameters

target CfnResource

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

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

addDependsOn(target)⚠️

public addDependsOn(target: CfnResource): void

⚠️ Deprecated: use addDependency

Parameters

target CfnResource

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

addMetadata(key, value)

public addMetadata(key: string, value: any): void

Parameters

key string
value any

Add a value to the CloudFormation Resource Metadata.

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)

addOverride(path, value)

public addOverride(path: string, value: any): void

Parameters

path string — - The path of the property, you can use dot notation to override values in complex types.
value any — - The value.

Adds an override to the synthesized CloudFormation resource.

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,

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

would add the overrides

"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.

addPropertyDeletionOverride(propertyPath)

public addPropertyDeletionOverride(propertyPath: string): void

Parameters

propertyPath string — The path to the property.

Adds an override that deletes the value of a property from the resource definition.

addPropertyOverride(propertyPath, value)

public addPropertyOverride(propertyPath: string, value: any): void

Parameters

propertyPath string — The path of the property.
value any — The value.

Adds an override to a resource property.

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

applyRemovalPolicy(policy?, options?)

public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void

Parameters

policy RemovalPolicy
options RemovalPolicyOptions

Sets the deletion policy of the resource based on the removal policy specified.

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:

getAtt(attributeName, typeHint?)

public getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference

Parameters

attributeName string — The name of the attribute.
typeHint ResolutionTypeHint

Returns

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.

getMetadata(key)

public getMetadata(key: string): any

Parameters

key string

Returns

any

Retrieve a value value from the CloudFormation Resource Metadata.

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)

inspect(inspector)

public inspect(inspector: TreeInspector): void

Parameters

inspector TreeInspector — tree inspector to collect and process attributes.

Examines the CloudFormation resource and discloses attributes.

obtainDependencies()

public obtainDependencies(): Stack &#124; CfnResource[]

Returns

Stack | CfnResource[]

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

obtainResourceDependencies()

public obtainResourceDependencies(): CfnResource[]

Returns

CfnResource[]

Get a shallow copy of dependencies between this resource and other resources in the same stack.

overrideLogicalId(newLogicalId)

public overrideLogicalId(newLogicalId: string): void

Parameters

newLogicalId string — The new logical ID to use for this stack element.

Overrides the auto-generated logical ID with a specific ID.

removeDependency(target)

public removeDependency(target: CfnResource): void

Parameters

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, newTarget)

public replaceDependency(target: CfnResource, newTarget: CfnResource): void

Parameters

target CfnResource — The dependency to replace.
newTarget CfnResource — The new dependency to add.

Replaces one dependency with another.

toString()

public toString(): string

Returns

string

Returns a string representation of this construct.

protected renderProperties(props)

protected renderProperties(props: { [string]: any }): { [string]: any }

Parameters

props { [string]: any }

Returns

{ [string]: any }