AWS CDK Reference

Appearance

v2.274.0

CfnEnvironmentProps Struct ​

Properties for defining a CfnEnvironment.

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 cfnEnvironmentProps: evs.CfnEnvironmentProps = {
  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',
  },
};

Properties ​

connectivityInfoIResolvable | CfnEnvironment.ConnectivityInfoPropertyconnectivity_infotyping.Union[IResolvable, ConnectivityInfoProperty]connectivityInfoIResolvableConnectivityInfoIResolvableConnectivityInfointerface{}#
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.

environmentNamestringenvironment_namestrenvironmentNameStringEnvironmentNamestringEnvironmentName*string#
The name of the environment.
hostsIResolvable | IResolvable | CfnEnvironment.HostInfoForCreateProperty[]hoststyping.Union[IResolvable, typing.List[typing.Union[IResolvable, HostInfoForCreateProperty]]]hostsIResolvableHostsIResolvableHostsinterface{}#
Required for environment resource creation.
initialVlansIResolvable | CfnEnvironment.InitialVlansPropertyinitial_vlanstyping.Union[IResolvable, InitialVlansProperty]initialVlansIResolvableInitialVlansIResolvableInitialVlansinterface{}#
> Amazon EVS is in public preview release and is subject to change.
notes

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.

kmsKeyIdstringkms_key_idstrkmsKeyIdStringKmsKeyIdstringKmsKeyId*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.

licenseInfoIResolvable | CfnEnvironment.LicenseInfoPropertylicense_infotyping.Union[IResolvable, LicenseInfoProperty]licenseInfoIResolvableLicenseInfoIResolvableLicenseInfointerface{}#
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.

serviceAccessSecurityGroupsIResolvable | CfnEnvironment.ServiceAccessSecurityGroupsPropertyservice_access_security_groupstyping.Union[IResolvable, ServiceAccessSecurityGroupsProperty]serviceAccessSecurityGroupsIResolvableServiceAccessSecurityGroupsIResolvableServiceAccessSecurityGroupsinterface{}#
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.

serviceAccessSubnetIdstringservice_access_subnet_idstrserviceAccessSubnetIdStringServiceAccessSubnetIdstringServiceAccessSubnetId*stringrequired#
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.

siteIdstringsite_idstrsiteIdStringSiteIdstringSiteId*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.

tagsCfnTag[]tagstyping.List[CfnTag]tagsList<CfnTag>TagsCfnTag[]Tags*[]CfnTag#
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.

termsAcceptedboolean | IResolvableterms_acceptedtyping.Union[bool, IResolvable]termsAcceptedBooleanTermsAcceptedboolTermsAcceptedinterface{}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.

vcfHostnamesIResolvable | CfnEnvironment.VcfHostnamesPropertyvcf_hostnamestyping.Union[IResolvable, VcfHostnamesProperty]vcfHostnamesIResolvableVcfHostnamesIResolvableVcfHostnamesinterface{}#
The DNS hostnames to be used by the VCF management appliances in your environment.
notes

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.

vcfVersionstringvcf_versionstrvcfVersionStringVcfVersionstringVcfVersion*stringrequired#
The VCF version of the environment.
vpcIdstringvpc_idstrvpcIdStringVpcIdstringVpcId*stringrequired#
The VPC associated with the environment.