AWS Fundamentals Logo
AWS Fundamentals
L1 ConstructAWS::M2::Environment

CfnEnvironment

Specifies a runtime environment for a given runtime engine.

Import

import { CfnEnvironment } from 'aws-cdk-lib/aws-m2';

Or use the module namespace:

import * as m2 from 'aws-cdk-lib/aws-m2';
// m2.CfnEnvironment

Properties

Configuration passed to the constructor as CfnEnvironmentProps.

engineTypeRequired
string

The target platform for the runtime environment.

instanceTypeRequired
string

The instance type of the runtime environment.

nameRequired
string

The name of the runtime environment.

descriptionOptional
string

The description of the runtime environment.

engineVersionOptional
string

The version of the runtime engine.

highAvailabilityConfigOptional
IResolvable | HighAvailabilityConfigProperty

> AWS Mainframe Modernization Service (Managed Runtime Environment experience) will no longer be open to new customers starting on November 7, 2025. If you would like to use the service, please sign up prior to November 7, 2025. For capabilities similar to AWS Mainframe Modernization Service (Managed Runtime Environment experience) explore AWS Mainframe Modernization Service (Self-Managed Experience). Existing customers can continue to use the service as normal. For more information, see [AWS Mainframe Modernization availability change](https://docs.aws.amazon.com/m2/latest/userguide/mainframe-modernization-availability-change.html) . Defines the details of a high availability configuration.

kmsKeyIdOptional
string

The identifier of a customer managed key.

networkTypeOptional
string

The network type supported by the runtime environment.

preferredMaintenanceWindowOptional
string

Configures the maintenance window that you want for the runtime environment. The maintenance window must have the format `ddd:hh24:mi-ddd:hh24:mi` and must be less than 24 hours. The following two examples are valid maintenance windows: `sun:23:45-mon:00:15` or `sat:01:00-sat:03:00` . If you do not provide a value, a random system-generated value will be assigned.

publiclyAccessibleOptional
boolean | IResolvable

Specifies whether the runtime environment is publicly accessible.

securityGroupIdsOptional
string[]

The list of security groups for the VPC associated with this runtime environment.

storageConfigurationsOptional
IResolvable | IResolvable | StorageConfigurationProperty[]

> AWS Mainframe Modernization Service (Managed Runtime Environment experience) will no longer be open to new customers starting on November 7, 2025. If you would like to use the service, please sign up prior to November 7, 2025. For capabilities similar to AWS Mainframe Modernization Service (Managed Runtime Environment experience) explore AWS Mainframe Modernization Service (Self-Managed Experience). Existing customers can continue to use the service as normal. For more information, see [AWS Mainframe Modernization availability change](https://docs.aws.amazon.com/m2/latest/userguide/mainframe-modernization-availability-change.html) . Defines the storage configuration for a runtime environment.

subnetIdsOptional
string[]

The list of subnets associated with the VPC for this runtime environment.

tagsOptional
{ [key: string]: string }

An array of key-value pairs to apply to this resource. For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) .

CloudFormation Resource

This L1 construct maps directly to the following CloudFormation resource type.

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Facts

LevelL1 (CloudFormation)
Moduleaws-m2
CFN TypeAWS::M2::Environment
Properties14

Related Constructs

External Links