AWS Fundamentals Logo
AWS Fundamentals
L1 ConstructAWS::EVS::Environment

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.

Import

import { CfnEnvironment } from 'aws-cdk-lib/aws-evs';

Or use the module namespace:

import * as evs from 'aws-cdk-lib/aws-evs';
// evs.CfnEnvironment

Properties

Configuration passed to the constructor as CfnEnvironmentProps.

connectivityInfoRequired
IResolvable | ConnectivityInfoProperty

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.

licenseInfoRequired
IResolvable | LicenseInfoProperty

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.

serviceAccessSubnetIdRequired
string

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.

siteIdRequired
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.

termsAcceptedRequired
boolean | IResolvable

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.

vcfHostnamesRequired
IResolvable | VcfHostnamesProperty

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.

vcfVersionRequired
string

The VCF version of the environment.

vpcIdRequired
string

The VPC associated with the environment.

environmentNameOptional
string

The name of the environment.

hostsOptional
IResolvable | IResolvable | HostInfoForCreateProperty[]

Required for environment resource creation.

initialVlansOptional
IResolvable | InitialVlansProperty

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

kmsKeyIdOptional
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.

serviceAccessSecurityGroupsOptional
IResolvable | ServiceAccessSecurityGroupsProperty

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.

tagsOptional
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.

CloudFormation Resource

This L1 construct maps directly to the following CloudFormation resource type.

AWS::EVS::EnvironmentView in CloudFormation Explorer

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Facts

LevelL1 (CloudFormation)
Moduleaws-evs
CFN TypeAWS::EVS::Environment
Properties14

Explore This Service

External Links