# CfnEnvironment

Creates an Amazon EVS environment that runs VCF software, such as SDDC Manager, NSX Manager, and vCenter Server.

During environment creation, Amazon EVS performs validations on DNS settings, provisions VLAN subnets and hosts, and deploys the supplied version of VCF.

It can take several hours to create an environment. After the deployment completes, you can configure VCF in the vSphere user interface according to your needs.

> You cannot use the `dedicatedHostId` and `placementGroupId` parameters together in the same `CreateEnvironment` action. This results in a `ValidationException` response.

Extends: Construct › CfnElement › CfnRefElement › CfnResource › CfnEnvironment
Implements: IInspectable, ITaggableV2, IEnvironmentAware, IEnvironmentRef, IConstruct, IDependable

- CloudFormation: [`AWS::EVS::Environment`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-resource-evs-environment.html)
- Source: Generated code
- Type last changed: v2.262.0 · 22 Jul 2026

## Example

```ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_evs as evs } from 'aws-cdk-lib';
const cfnEnvironment = new evs.CfnEnvironment(this, 'MyCfnEnvironment', {
  serviceAccessSubnetId: 'serviceAccessSubnetId',
  termsAccepted: false,
  vcfVersion: 'vcfVersion',
  vpcId: 'vpcId',

  // the properties below are optional
  connectivityInfo: {
    privateRouteServerPeerings: ['privateRouteServerPeerings'],
  },
  environmentName: 'environmentName',
  hosts: [{
    hostName: 'hostName',
    instanceType: 'instanceType',
    keyName: 'keyName',

    // the properties below are optional
    dedicatedHostId: 'dedicatedHostId',
    placementGroupId: 'placementGroupId',
  }],
  initialVlans: {
    edgeVTep: {
      cidr: 'cidr',
    },
    expansionVlan1: {
      cidr: 'cidr',
    },
    expansionVlan2: {
      cidr: 'cidr',
    },
    hcx: {
      cidr: 'cidr',
    },
    nsxUpLink: {
      cidr: 'cidr',
    },
    vmkManagement: {
      cidr: 'cidr',
    },
    vmManagement: {
      cidr: 'cidr',
    },
    vMotion: {
      cidr: 'cidr',
    },
    vSan: {
      cidr: 'cidr',
    },
    vTep: {
      cidr: 'cidr',
    },

    // the properties below are optional
    hcxNetworkAclId: 'hcxNetworkAclId',
    isHcxPublic: false,
  },
  kmsKeyId: 'kmsKeyId',
  licenseInfo: {
    solutionKey: 'solutionKey',
    vsanKey: 'vsanKey',
  },
  serviceAccessSecurityGroups: {
    securityGroups: ['securityGroups'],
  },
  siteId: 'siteId',
  tags: [{
    key: 'key',
    value: 'value',
  }],
  vcfHostnames: {
    cloudBuilder: 'cloudBuilder',
    nsx: 'nsx',
    nsxEdge1: 'nsxEdge1',
    nsxEdge2: 'nsxEdge2',
    nsxManager1: 'nsxManager1',
    nsxManager2: 'nsxManager2',
    nsxManager3: 'nsxManager3',
    sddcManager: 'sddcManager',
    vCenter: 'vCenter',
  },
});
```

## Initializer

```ts
new CfnEnvironment(scope: Construct, id: string, props: CfnEnvironmentProps)
```

## Construct Props

- `connectivityInfo`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnEnvironment.ConnectivityInfoProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_evs.CfnEnvironment.ConnectivityInfoProperty.html) — The connectivity configuration for the environment.

  Amazon EVS requires that you specify two route server peer IDs. During environment creation, the route server endpoints peer with the NSX uplink VLAN for connectivity to the NSX overlay network.

- `environmentName`: string — The name of the environment.

- `hosts`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnEnvironment.HostInfoForCreateProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_evs.CfnEnvironment.HostInfoForCreateProperty.html)[] — Required for environment resource creation.

- `initialVlans`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnEnvironment.InitialVlansProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_evs.CfnEnvironment.InitialVlansProperty.html) — > Amazon EVS is in public preview release and is subject to change.

  The initial VLAN subnets for the environment. Amazon EVS VLAN subnets have a minimum CIDR block size of /28 and a maximum size of /24. Amazon EVS VLAN subnet CIDR blocks must not overlap with other subnets in the VPC.

  Required for environment resource creation.

- `kmsKeyId`: string — The AWS KMS key ID that AWS Secrets Manager uses to encrypt secrets that are associated with the environment.

  These secrets contain the VCF credentials that are needed to install vCenter Server, NSX, and SDDC Manager.

  By default, Amazon EVS use the AWS Secrets Manager managed key `aws/secretsmanager` . You can also specify a customer managed key.

- `licenseInfo`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnEnvironment.LicenseInfoProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_evs.CfnEnvironment.LicenseInfoProperty.html) — The license information that Amazon EVS requires to create an environment.

  Amazon EVS requires two license keys: a VCF solution key and a vSAN license key. The VCF solution key must cover a minimum of 256 cores. The vSAN license key must provide at least 110 TiB of vSAN capacity.

- `serviceAccessSecurityGroups`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnEnvironment.ServiceAccessSecurityGroupsProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_evs.CfnEnvironment.ServiceAccessSecurityGroupsProperty.html) — The security groups that allow traffic between the Amazon EVS control plane and your VPC for service access.

  If a security group is not specified, Amazon EVS uses the default security group in your account for service access.

- `serviceAccessSubnetId`: string (required) — The subnet that is used to establish connectivity between the Amazon EVS control plane and VPC.

  Amazon EVS uses this subnet to perform validations and create the environment.

- `siteId`: string — The Broadcom Site ID that is associated with your Amazon EVS environment.

  Amazon EVS uses the Broadcom Site ID that you provide to meet Broadcom VCF license usage reporting requirements for Amazon EVS.

- `tags`: [CfnTag](/cdk/api/v2/docs/aws-cdk-lib.CfnTag.html)[] — Metadata that assists with categorization and organization.

  Each tag consists of a key and an optional value. You define both. Tags don't propagate to any other cluster or AWS resources.

- `termsAccepted`: boolean | [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) (required) — Customer confirmation that the customer has purchased and will continue to maintain the required number of VCF software licenses to cover all physical processor cores in the Amazon EVS environment.

  Information about your VCF software in Amazon EVS will be shared with Broadcom to verify license compliance. Amazon EVS does not validate license keys. To validate license keys, visit the Broadcom support portal.

- `vcfHostnames`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnEnvironment.VcfHostnamesProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_evs.CfnEnvironment.VcfHostnamesProperty.html) — The DNS hostnames to be used by the VCF management appliances in your environment.

  For environment creation to be successful, each hostname entry must resolve to a domain name that you've registered in your DNS service of choice and configured in the DHCP option set of your VPC. DNS hostnames cannot be changed after environment creation has started.

- `vcfVersion`: string (required) — The VCF version of the environment.

- `vpcId`: string (required) — The VPC associated with the environment.

## Properties

- `attrChecks`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) — A check on the environment to identify instance health and VMware VCF licensing issues. For example:.

  `{ "checks": [ { "type": "KEY_REUSE", "result": "PASSED" }, { "type": "KEY_COVERAGE", "result": "PASSED" }, { "type": "REACHABILITY", "result": "PASSED" }, { "type": "HOST_COUNT", "result": "PASSED" } ] }`

- `attrCreatedAt`: string — The date and time that the environment was created.

  For example: `1749081600.000` .

- `attrCredentials`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) — The VCF credentials that are stored as Amazon EVS managed secrets in AWS Secrets Manager.

  Amazon EVS stores credentials that are needed to install vCenter Server, NSX, and SDDC Manager. For example:

  `{ [ { "secretArn": "arn:aws:secretsmanager:us-east-1:000000000000:secret:evs!env-1234567890_vCenterAdmin-MnTMEi" }, { "secretArn": "arn:aws:secretsmanager:us-east-1:000000000000:secret:evs!env-1234567890_vCenterRoot-87VyCF" }, { "secretArn": "arn:aws:secretsmanager:us-east-1:000000000000:secret:evs!env-1234567890_NSXRoot-SR3k43" }, { "secretArn": "arn:aws:secretsmanager:us-east-1:000000000000:secret:evs!env-1234567890_NSXAdmin-L5LUiD" }, { "secretArn": "arn:aws:secretsmanager:us-east-1:000000000000:secret:evs!env-1234567890_NSXAudit-Q2oW46" }, { "secretArn": "arn:aws:secretsmanager:us-east-1:000000000000:secret:evs!env-1234567890_SDDCManagerRoot-bFulOq" }, { "secretArn": "arn:aws:secretsmanager:us-east-1:000000000000:secret:evs!env-1234567890_SDDCManagerVCF-Ec3gES" }, { "secretArn": "arn:aws:secretsmanager:us-east-1:000000000000:secret:evs!env-1234567890_SDDCManagerAdmin-JMTAAb" } ] }`

- `attrEnvironmentArn`: string — The Amazon Resource Name (ARN) that is associated with the environment.

  For example: `arn:aws:evs:us-east-1:000000000000:environment/env-1234567890` .

- `attrEnvironmentId`: string — The unique ID for the environment.

  For example: `env-1234567890` .

- `attrEnvironmentState`: string — The state of an environment.

  For example: `CREATED` .

- `attrModifiedAt`: string — The date and time that the environment was modified.

  For example: `1749081600.000` .

- `attrStateDetails`: string — A detailed description of the `environmentState` of an environment.

  For example: `Environment successfully created` .

- `cdkTagManager`: [TagManager](/cdk/api/v2/docs/aws-cdk-lib.TagManager.html) — Tag Manager which manages the tags for this resource.

- `CFN_RESOURCE_TYPE_NAME`: string (static) — The CloudFormation resource type name for this resource class.

- `cfnOptions`: [ICfnResourceOptions](/cdk/api/v2/docs/aws-cdk-lib.ICfnResourceOptions.html) — Options for this resource, such as condition, update policy etc.

- `cfnResourceType`: string — AWS resource type.

- `connectivityInfo`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnEnvironment.ConnectivityInfoProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_evs.CfnEnvironment.ConnectivityInfoProperty.html) — The connectivity configuration for the environment.

- `creationStack`: string[]

- `env`: [ResourceEnvironment](/cdk/api/v2/docs/aws-cdk-lib.interfaces.ResourceEnvironment.html)

- `environmentName`: string — The name of the environment.

- `environmentRef`: [EnvironmentReference](/cdk/api/v2/docs/aws-cdk-lib.interfaces.aws_evs.EnvironmentReference.html) — A reference to a Environment resource.

- `hosts`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnEnvironment.HostInfoForCreateProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_evs.CfnEnvironment.HostInfoForCreateProperty.html)[] — Required for environment resource creation.

- `initialVlans`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnEnvironment.InitialVlansProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_evs.CfnEnvironment.InitialVlansProperty.html) — > Amazon EVS is in public preview release and is subject to change.

- `kmsKeyId`: string — The AWS KMS key ID that AWS Secrets Manager uses to encrypt secrets that are associated with the environment.

- `licenseInfo`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnEnvironment.LicenseInfoProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_evs.CfnEnvironment.LicenseInfoProperty.html) — The license information that Amazon EVS requires to create an environment.

- `logicalId`: string — The logical ID for this CloudFormation stack element.

  The logical ID of the element
  is calculated from the path of the resource node in the construct tree.

  To override this value, use `overrideLogicalId(newLogicalId)`.

- `node`: [Node](/cdk/api/v2/docs/constructs.Node.html) — The tree node.

- `ref`: string — Return a string that will be resolved to a CloudFormation `{ Ref }` for this element.

  If, by any chance, the intrinsic reference of a resource is not a string, you could
  coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`.

- `serviceAccessSecurityGroups`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnEnvironment.ServiceAccessSecurityGroupsProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_evs.CfnEnvironment.ServiceAccessSecurityGroupsProperty.html) — The security groups that allow traffic between the Amazon EVS control plane and your VPC for service access.

- `serviceAccessSubnetId`: string — The subnet that is used to establish connectivity between the Amazon EVS control plane and VPC.

- `siteId`: string — The Broadcom Site ID that is associated with your Amazon EVS environment.

- `stack`: [Stack](/cdk/api/v2/docs/aws-cdk-lib.Stack.html) — The stack in which this element is defined.

  CfnElements must be defined within a stack scope (directly or indirectly).

- `tags`: [CfnTag](/cdk/api/v2/docs/aws-cdk-lib.CfnTag.html)[] — Metadata that assists with categorization and organization.

- `termsAccepted`: boolean | [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) — Customer confirmation that the customer has purchased and will continue to maintain the required number of VCF software licenses to cover all physical processor cores in the Amazon EVS environment.

- `vcfHostnames`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnEnvironment.VcfHostnamesProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_evs.CfnEnvironment.VcfHostnamesProperty.html) — The DNS hostnames to be used by the VCF management appliances in your environment.

- `vcfVersion`: string — The VCF version of the environment.

- `vpcId`: string — The VPC associated with the environment.

## Methods

- `addDeletionOverride(path: string): void` — Syntactic sugar for `addOverride(path, undefined)`.

  **Parameters**

  - `path` — The path of the value to delete.

- `addDependency(target: CfnResource): void` — Use `addResourceDependency` instead.

  This method has been renamed to `addResourceDependency` to more clearly
  set it apart from `construct.node.addDependency`. See the documentation
  of that function for more details.

- `addDependsOn(target: CfnResource): void` — Use `addResourceDependency` instead.

  This can be used for resources across stacks (or nested stack) boundaries
  and the dependency will automatically be transferred to the relevant scope.

  This method has been renamed to `addResourceDependency`, which makes it
  more clear that this method operates at a different level from the
  construct-level `construct.node.addDependency()` mechanism.

- `addMetadata(key: string, value: any): void` — Add a value to the CloudFormation Resource Metadata.

- `addOverride(path: string, value: any): void` — Adds an override to the synthesized CloudFormation resource.

  To add a
  property override, either use `addPropertyOverride` or prefix `path` with
  "Properties." (i.e. `Properties.TopicName`).

  If the override is nested, separate each nested level using a dot (.) in the path parameter.
  If there is an array as part of the nesting, specify the index in the path.

  To include a literal `.` in the property name, prefix with a `\`. In most
  programming languages you will need to write this as `"\\."` because the
  `\` itself will need to be escaped.

  For example,
  ```typescript
  cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
  cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
  ```
  would add the overrides
  ```json
  "Properties": {
    "GlobalSecondaryIndexes": [
      {
        "Projection": {
          "NonKeyAttributes": [ "myattribute" ]
          ...
        }
        ...
      },
      {
        "ProjectionType": "INCLUDE"
        ...
      },
    ]
    ...
  }
  ```

  The `value` argument to `addOverride` will not be processed or translated
  in any way. Pass raw JSON values in here with the correct capitalization
  for CloudFormation. If you pass CDK classes or structs, they will be
  rendered with lowercased key names, and CloudFormation will reject the
  template.

  **Parameters**

  - `path` — - The path of the property, you can use dot notation to override values in complex types.
  - `value` — - The value.

- `addPropertyDeletionOverride(propertyPath: string): void` — Adds an override that deletes the value of a property from the resource definition.

  **Parameters**

  - `propertyPath` — The path to the property.

- `addPropertyOverride(propertyPath: string, value: any): void` — Adds an override to a resource property.

  Syntactic sugar for `addOverride("Properties.<...>", value)`.

  **Parameters**

  - `propertyPath` — The path of the property.
  - `value` — The value.

- `addResourceDependency(target: CfnResource, reason?: string): void` — Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

  This can be used for resources across stacks (or nested stack) boundaries
  and the dependency will automatically be transferred to the relevant scope.

  This method only adds dependencies between L1 resources. If you are
  looking for a generic construct-to-construct dependency mechanism that works
  for all constructs including L2s, use `construct.node.addDependency` instead.

- `applyCrossStackReferenceStrength(strength: ReferenceStrength): void` — Sets the cross-stack reference strength for this resource.

  When set, any cross-stack reference to this resource will use the specified
  strength instead of the global default from the consuming stack's context.

  **Parameters**

  - `strength` — - The reference strength to use for this resource.

- `applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void` — Sets the deletion policy of the resource based on the removal policy specified.

  The Removal Policy controls what happens to this resource when it stops
  being managed by CloudFormation, either because you've removed it from the
  CDK application or because you've made a change that requires the resource
  to be replaced.

  The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
  account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some
  cases, a snapshot can be taken of the resource prior to deletion
  (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy
  can be found in the following link:

- `arnForEnvironment(resource: IEnvironmentRef): string` (static)

- `cfnPropertyName(cdkPropertyName: string): string`

- `getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference` — Returns a token for an runtime attribute of this resource.

  Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility
  in case there is no generated attribute.

  **Parameters**

  - `attributeName` — The name of the attribute.

- `getMetadata(key: string): any` — Retrieve a value value from the CloudFormation Resource Metadata.

- `inspect(inspector: TreeInspector): void` — Examines the CloudFormation resource and discloses attributes.

  **Parameters**

  - `inspector` — tree inspector to collect and process attributes.

- `isCfnElement(x: any): boolean` (static) — Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

  Uses duck-typing instead of `instanceof` to allow stack elements from different
  versions of this library to be included in the same stack.

  **Returns:** The construct as a stack element or undefined if it is not a stack element.

- `isCfnEnvironment(x: any): boolean` (static) — Checks whether the given object is a CfnEnvironment.

- `isCfnResource(x: any): boolean` (static) — Check whether the given object is a CfnResource.

- `isConstruct(x: any): boolean` (static) — Checks if `x` is a construct.

  Use this method instead of `instanceof` to properly detect `Construct`
  instances, even when the construct library is symlinked.

  Explanation: in JavaScript, multiple copies of the `constructs` library on
  disk are seen as independent, completely different libraries. As a
  consequence, the class `Construct` in each copy of the `constructs` library
  is seen as a different class, and an instance of one class will not test as
  `instanceof` the other class. `npm install` will not create installations
  like this, but users may manually symlink construct libraries together or
  use a monorepo tool: in those cases, multiple copies of the `constructs`
  library can be accidentally installed, and `instanceof` will behave
  unpredictably. It is safest to avoid using `instanceof`, and using
  this type-testing method instead.

  **Parameters**

  - `x` — Any object.

  **Returns:** true if `x` is an object created from a class which extends `Construct`.

- `obtainDependencies(): Stack | CfnResource[]` — Retrieves an array of resources and stacks this resource depends on.

  For resources depended on directly, returns the `CfnResource` object. For
  dependencies on other stacks, returns the `Stack` object. The order of the
  array is not guaranteed.

- `overrideLogicalId(newLogicalId: string): void` — Overrides the auto-generated logical ID with a specific ID.

  **Parameters**

  - `newLogicalId` — The new logical ID to use for this stack element.

- `removeDependency(target: CfnResource): void` — Use `removeResourceDependency` instead

  This can be used for resources across stacks (including nested stacks)
  and the dependency will automatically be removed from the relevant scope.

- `removeResourceDependency(target: CfnResource): void` — Indicates that this resource no longer depends on another resource.

  This can be used for resources across stacks (including nested stacks)
  and the dependency will automatically be removed from the relevant scope.

- `replaceDependency(target: CfnResource, newTarget: CfnResource): void` — Replaces one dependency with another.

  **Parameters**

  - `target` — The dependency to replace.
  - `newTarget` — The new dependency to add.

- `toString(): string` — Returns a string representation of this construct.

  **Returns:** a string representation of this resource

- `with(...mixins: IMixin[]): IConstruct` — Applies one or more mixins to this construct.

  Mixins are applied in order. The list of constructs is captured at the
  start of the call, so constructs added by a mixin will not be visited.
  Use multiple `with()` calls if subsequent mixins should apply to added
  constructs.