interface CfnEnvironmentProps
| Language | Type name |
|---|---|
 .NET | Amazon.CDK.AWS.M2.CfnEnvironmentProps |
 Go | github.com/aws/aws-cdk-go/awscdk/v2/awsm2#CfnEnvironmentProps |
 Java | software.amazon.awscdk.services.m2.CfnEnvironmentProps |
 Python | aws_cdk.aws_m2.CfnEnvironmentProps |
 TypeScript | aws-cdk-lib » aws_m2 » CfnEnvironmentProps |
Properties for defining a CfnEnvironment.
See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-m2-environment.html
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_m2 as m2 } from 'aws-cdk-lib';
const cfnEnvironmentProps: m2.CfnEnvironmentProps = {
engineType: 'engineType',
instanceType: 'instanceType',
name: 'name',
// the properties below are optional
description: 'description',
engineVersion: 'engineVersion',
highAvailabilityConfig: {
desiredCapacity: 123,
},
kmsKeyId: 'kmsKeyId',
networkType: 'networkType',
preferredMaintenanceWindow: 'preferredMaintenanceWindow',
publiclyAccessible: false,
securityGroupIds: ['securityGroupIds'],
storageConfigurations: [{
efs: {
fileSystemId: 'fileSystemId',
mountPoint: 'mountPoint',
},
fsx: {
fileSystemId: 'fileSystemId',
mountPoint: 'mountPoint',
},
}],
subnetIds: ['subnetIds'],
tags: {
tagsKey: 'tags',
},
};
Properties
| Name | Type | Description |
|---|---|---|
| engine | string | The target platform for the runtime environment. |
| instance | string | The instance type of the runtime environment. |
| name | string | The name of the runtime environment. |
| description? | string | The description of the runtime environment. |
| engine | string | The version of the runtime engine. |
| high | IResolvable | High | > AWS Mainframe Modernization Service (Managed Runtime Environment experience) will no longer be open to new customers starting on November 7, 2025. |
| kms | string | The identifier of a customer managed key. |
| network | string | The network type supported by the runtime environment. |
| preferred | string | Configures the maintenance window that you want for the runtime environment. |
| publicly | boolean | IResolvable | Specifies whether the runtime environment is publicly accessible. |
| security | string[] | The list of security groups for the VPC associated with this runtime environment. |
| storage | IResolvable | (IResolvable | Storage)[] | > AWS Mainframe Modernization Service (Managed Runtime Environment experience) will no longer be open to new customers starting on November 7, 2025. |
| subnet | string[] | The list of subnets associated with the VPC for this runtime environment. |
| tags? | { [string]: string } | An array of key-value pairs to apply to this resource. |
engineType
Type:
string
The target platform for the runtime environment.
instanceType
Type:
string
The instance type of the runtime environment.
name
Type:
string
The name of the runtime environment.
description?
Type:
string
(optional)
The description of the runtime environment.
engineVersion?
Type:
string
(optional)
The version of the runtime engine.
highAvailabilityConfig?
Type:
IResolvable | High
(optional)
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 .
Defines the details of a high availability configuration.
kmsKeyId?
Type:
string
(optional)
The identifier of a customer managed key.
networkType?
Type:
string
(optional)
The network type supported by the runtime environment.
preferredMaintenanceWindow?
Type:
string
(optional)
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.
publiclyAccessible?
Type:
boolean | IResolvable
(optional)
Specifies whether the runtime environment is publicly accessible.
securityGroupIds?
Type:
string[]
(optional)
The list of security groups for the VPC associated with this runtime environment.
storageConfigurations?
Type:
IResolvable | (IResolvable | Storage)[]
(optional)
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 .
Defines the storage configuration for a runtime environment.
subnetIds?
Type:
string[]
(optional)
The list of subnets associated with the VPC for this runtime environment.
tags?
Type:
{ [string]: string }
(optional)
An array of key-value pairs to apply to this resource.
For more information, see Tag .