2.233.0

interface CfnEnvironmentMixinProps

LanguageType name
.NETAmazon.CDK.Mixins.Preview.AWS.M2.Mixins.CfnEnvironmentMixinProps
Gogithub.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awsm2/mixins#CfnEnvironmentMixinProps
Javasoftware.amazon.awscdk.mixins.preview.services.m2.mixins.CfnEnvironmentMixinProps
Pythonaws_cdk.mixins_preview.aws_m2.mixins.CfnEnvironmentMixinProps
TypeScript @aws-cdk/mixins-preview » aws_m2 » mixins » CfnEnvironmentMixinProps

Properties for CfnEnvironmentPropsMixin.

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 { mixins as m2_mixins } from '@aws-cdk/mixins-preview/aws-m2';
const cfnEnvironmentMixinProps: m2_mixins.CfnEnvironmentMixinProps = {
  description: 'description',
  engineType: 'engineType',
  engineVersion: 'engineVersion',
  highAvailabilityConfig: {
    desiredCapacity: 123,
  },
  instanceType: 'instanceType',
  kmsKeyId: 'kmsKeyId',
  name: 'name',
  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

NameTypeDescription
description?stringThe description of the runtime environment.
engineType?stringThe target platform for the runtime environment.
engineVersion?stringThe version of the runtime engine.
highAvailabilityConfig?IResolvable | HighAvailabilityConfigProperty> AWS Mainframe Modernization Service (Managed Runtime Environment experience) will no longer be open to new customers starting on November 7, 2025.
instanceType?stringThe instance type of the runtime environment.
kmsKeyId?stringThe identifier of a customer managed key.
name?stringThe name of the runtime environment.
networkType?stringThe network type supported by the runtime environment.
preferredMaintenanceWindow?stringConfigures the maintenance window that you want for the runtime environment.
publiclyAccessible?boolean | IResolvableSpecifies whether the runtime environment is publicly accessible.
securityGroupIds?string[]The list of security groups for the VPC associated with this runtime environment.
storageConfigurations?IResolvable | (IResolvable | StorageConfigurationProperty)[]> AWS Mainframe Modernization Service (Managed Runtime Environment experience) will no longer be open to new customers starting on November 7, 2025.
subnetIds?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.

description?

Type: string (optional)

The description of the runtime environment.

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

engineType?

Type: string (optional)

The target platform for the runtime environment.

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

engineVersion?

Type: string (optional)

The version of the runtime engine.

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

highAvailabilityConfig?

Type: IResolvable | HighAvailabilityConfigProperty (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.

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

instanceType?

Type: string (optional)

The instance type of the runtime environment.

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

kmsKeyId?

Type: string (optional)

The identifier of a customer managed key.

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

name?

Type: string (optional)

The name of the runtime environment.

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

networkType?

Type: string (optional)

The network type supported by the runtime environment.

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

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.

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

publiclyAccessible?

Type: boolean | IResolvable (optional)

Specifies whether the runtime environment is publicly accessible.

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

securityGroupIds?

Type: string[] (optional)

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

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

storageConfigurations?

Type: IResolvable | (IResolvable | StorageConfigurationProperty)[] (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.

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

subnetIds?

Type: string[] (optional)

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

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

tags?

Type: { [string]: string } (optional)

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

For more information, see Tag .

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

← PreviousNext →