CfnEnvironmentPropsMixin

class aws_cdk.mixins_preview.aws_m2.mixins.CfnEnvironmentPropsMixin(props, *, strategy=None)

Bases: Mixin

Specifies a runtime environment for a given runtime engine.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-m2-environment.html
CloudformationResource:: AWS::M2::Environment
Mixin:: true
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.mixins_preview import mixins
from aws_cdk.mixins_preview.aws_m2 import mixins as m2_mixins

cfn_environment_props_mixin = m2_mixins.CfnEnvironmentPropsMixin(m2_mixins.CfnEnvironmentMixinProps(
    description="description",
    engine_type="engineType",
    engine_version="engineVersion",
    high_availability_config=m2_mixins.CfnEnvironmentPropsMixin.HighAvailabilityConfigProperty(
        desired_capacity=123
    ),
    instance_type="instanceType",
    kms_key_id="kmsKeyId",
    name="name",
    network_type="networkType",
    preferred_maintenance_window="preferredMaintenanceWindow",
    publicly_accessible=False,
    security_group_ids=["securityGroupIds"],
    storage_configurations=[m2_mixins.CfnEnvironmentPropsMixin.StorageConfigurationProperty(
        efs=m2_mixins.CfnEnvironmentPropsMixin.EfsStorageConfigurationProperty(
            file_system_id="fileSystemId",
            mount_point="mountPoint"
        ),
        fsx=m2_mixins.CfnEnvironmentPropsMixin.FsxStorageConfigurationProperty(
            file_system_id="fileSystemId",
            mount_point="mountPoint"
        )
    )],
    subnet_ids=["subnetIds"],
    tags={
        "tags_key": "tags"
    }
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::M2::Environment.

Parameters:

props (Union[CfnEnvironmentMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['description', 'engineType', 'engineVersion', 'highAvailabilityConfig', 'instanceType', 'kmsKeyId', 'name', 'networkType', 'preferredMaintenanceWindow', 'publiclyAccessible', 'securityGroupIds', 'storageConfigurations', 'subnetIds', 'tags']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.
Stability:: experimental

EfsStorageConfigurationProperty

class CfnEnvironmentPropsMixin.EfsStorageConfigurationProperty(*, file_system_id=None, mount_point=None)

Bases: object

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 an Amazon EFS file system.

Attributes

file_system_id

The file system identifier.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-m2-environment-efsstorageconfiguration.html#cfn-m2-environment-efsstorageconfiguration-filesystemid

mount_point

The mount point for the file system.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-m2-environment-efsstorageconfiguration.html#cfn-m2-environment-efsstorageconfiguration-mountpoint

FsxStorageConfigurationProperty

class CfnEnvironmentPropsMixin.FsxStorageConfigurationProperty(*, file_system_id=None, mount_point=None)

Bases: object

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 an Amazon FSx file system.

Attributes

file_system_id

The file system identifier.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-m2-environment-fsxstorageconfiguration.html#cfn-m2-environment-fsxstorageconfiguration-filesystemid

mount_point

The mount point for the file system.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-m2-environment-fsxstorageconfiguration.html#cfn-m2-environment-fsxstorageconfiguration-mountpoint

HighAvailabilityConfigProperty

class CfnEnvironmentPropsMixin.HighAvailabilityConfigProperty(*, desired_capacity=None)

Bases: object

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.

Attributes

desired_capacity

The number of instances in a high availability configuration.

The minimum possible value is 1 and the maximum is 100.

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

StorageConfigurationProperty

class CfnEnvironmentPropsMixin.StorageConfigurationProperty(*, efs=None, fsx=None)

Bases: object

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.

Attributes

efs

Defines the storage configuration for an Amazon EFS file system.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-m2-environment-storageconfiguration.html#cfn-m2-environment-storageconfiguration-efs

fsx

Defines the storage configuration for an Amazon FSx file system.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-m2-environment-storageconfiguration.html#cfn-m2-environment-storageconfiguration-fsx