CfnEnvironmentProps

class aws_cdk.aws_m2.CfnEnvironmentProps(*, engine_type, instance_type, name, description=None, engine_version=None, high_availability_config=None, kms_key_id=None, network_type=None, preferred_maintenance_window=None, publicly_accessible=None, security_group_ids=None, storage_configurations=None, subnet_ids=None, tags=None)

Bases: object

Properties for defining a CfnEnvironment.

Parameters:

engine_type (str) – The target platform for the runtime environment.
instance_type (str) – The instance type of the runtime environment.
name (str) – The name of the runtime environment.
description (Optional[str]) – The description of the runtime environment.
engine_version (Optional[str]) – The version of the runtime engine.
high_availability_config (Union[IResolvable, HighAvailabilityConfigProperty, Dict[str, Any], None]) –

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.
kms_key_id (Optional[str]) – The identifier of a customer managed key.
network_type (Optional[str]) – The network type supported by the runtime environment.
preferred_maintenance_window (Optional[str]) – 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.
publicly_accessible (Union[bool, IResolvable, None]) – Specifies whether the runtime environment is publicly accessible.
security_group_ids (Optional[Sequence[str]]) – The list of security groups for the VPC associated with this runtime environment.
storage_configurations (Union[IResolvable, Sequence[Union[IResolvable, StorageConfigurationProperty, Dict[str, Any]]], None]) –

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.
subnet_ids (Optional[Sequence[str]]) – The list of subnets associated with the VPC for this runtime environment.
tags (Optional[Mapping[str, str]]) – An array of key-value pairs to apply to this resource. For more information, see Tag .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-m2-environment.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_m2 as m2

cfn_environment_props = m2.CfnEnvironmentProps(
    engine_type="engineType",
    instance_type="instanceType",
    name="name",

    # the properties below are optional
    description="description",
    engine_version="engineVersion",
    high_availability_config=m2.CfnEnvironment.HighAvailabilityConfigProperty(
        desired_capacity=123
    ),
    kms_key_id="kmsKeyId",
    network_type="networkType",
    preferred_maintenance_window="preferredMaintenanceWindow",
    publicly_accessible=False,
    security_group_ids=["securityGroupIds"],
    storage_configurations=[m2.CfnEnvironment.StorageConfigurationProperty(
        efs=m2.CfnEnvironment.EfsStorageConfigurationProperty(
            file_system_id="fileSystemId",
            mount_point="mountPoint"
        ),
        fsx=m2.CfnEnvironment.FsxStorageConfigurationProperty(
            file_system_id="fileSystemId",
            mount_point="mountPoint"
        )
    )],
    subnet_ids=["subnetIds"],
    tags={
        "tags_key": "tags"
    }
)

Attributes

description

The description of the runtime environment.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-m2-environment.html#cfn-m2-environment-description

engine_type

The target platform for the runtime environment.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-m2-environment.html#cfn-m2-environment-enginetype

engine_version

The version of the runtime engine.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-m2-environment.html#cfn-m2-environment-engineversion

high_availability_config

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.

see:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-m2-environment.html#cfn-m2-environment-highavailabilityconfig

instance_type

The instance type of the runtime environment.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-m2-environment.html#cfn-m2-environment-instancetype

kms_key_id

The identifier of a customer managed key.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-m2-environment.html#cfn-m2-environment-kmskeyid

name

The name of the runtime environment.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-m2-environment.html#cfn-m2-environment-name

network_type

The network type supported by the runtime environment.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-m2-environment.html#cfn-m2-environment-networktype

preferred_maintenance_window

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.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-m2-environment.html#cfn-m2-environment-preferredmaintenancewindow

publicly_accessible

Specifies whether the runtime environment is publicly accessible.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-m2-environment.html#cfn-m2-environment-publiclyaccessible

security_group_ids

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

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-m2-environment.html#cfn-m2-environment-securitygroupids

storage_configurations

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.

see:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-m2-environment.html#cfn-m2-environment-storageconfigurations

subnet_ids

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

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-m2-environment.html#cfn-m2-environment-subnetids

tags

An array of key-value pairs to apply to this resource.

For more information, see Tag .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-m2-environment.html#cfn-m2-environment-tags