aws-cdk-lib.aws_m2.CfnEnvironmentProps

interface CfnEnvironmentProps

LanguageType name
.NETAmazon.CDK.AWS.M2.CfnEnvironmentProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsm2#CfnEnvironmentProps
Javasoftware.amazon.awscdk.services.m2.CfnEnvironmentProps
Pythonaws_cdk.aws_m2.CfnEnvironmentProps
TypeScript aws-cdk-lib » aws_m2 » CfnEnvironmentProps

Properties for defining a CfnEnvironment.

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',
  preferredMaintenanceWindow: 'preferredMaintenanceWindow',
  publiclyAccessible: false,
  securityGroupIds: ['securityGroupIds'],
  storageConfigurations: [{
    efs: {
      fileSystemId: 'fileSystemId',
      mountPoint: 'mountPoint',
    },
    fsx: {
      fileSystemId: 'fileSystemId',
      mountPoint: 'mountPoint',
    },
  }],
  subnetIds: ['subnetIds'],
  tags: {
    tagsKey: 'tags',
  },
};

Properties

NameTypeDescription
engineTypestringThe target platform for the runtime environment.
instanceTypestringThe instance type of the runtime environment.
namestringThe name of the runtime environment.
description?stringThe description of the runtime environment.
engineVersion?stringThe version of the runtime engine.
highAvailabilityConfig?IResolvable | HighAvailabilityConfigPropertyDefines the details of a high availability configuration.
kmsKeyId?stringThe identifier of a customer managed key.
preferredMaintenanceWindow?stringConfigures the maintenance window 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[]Defines the storage configuration for a runtime environment.
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.

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 | HighAvailabilityConfigProperty (optional)

Defines the details of a high availability configuration.


kmsKeyId?

Type: string (optional)

The identifier of a customer managed key.


preferredMaintenanceWindow?

Type: string (optional)

Configures the maintenance window you want for the runtime environment.

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 | StorageConfigurationProperty[] (optional)

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 .