Package software.amazon.awscdk.cfnpropertymixins.services.evs

Class CfnEnvironmentPropsMixin

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.Mixin

software.amazon.awscdk.cfnpropertymixins.services.evs.CfnEnvironmentPropsMixin

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable, software.constructs.IMixin

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-03-11T13:19:59.421Z")
@Stability(Stable)
public class CfnEnvironmentPropsMixin
extends Mixin
implements software.constructs.IMixin

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.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.evs.*;
 import software.amazon.awscdk.*;
 IMergeStrategy mergeStrategy;
 CfnEnvironmentPropsMixin cfnEnvironmentPropsMixin = CfnEnvironmentPropsMixin.Builder.create(CfnEnvironmentMixinProps.builder()
         .connectivityInfo(ConnectivityInfoProperty.builder()
                 .privateRouteServerPeerings(List.of("privateRouteServerPeerings"))
                 .build())
         .environmentName("environmentName")
         .hosts(List.of(HostInfoForCreateProperty.builder()
                 .dedicatedHostId("dedicatedHostId")
                 .hostName("hostName")
                 .instanceType("instanceType")
                 .keyName("keyName")
                 .placementGroupId("placementGroupId")
                 .build()))
         .initialVlans(InitialVlansProperty.builder()
                 .edgeVTep(InitialVlanInfoProperty.builder()
                         .cidr("cidr")
                         .build())
                 .expansionVlan1(InitialVlanInfoProperty.builder()
                         .cidr("cidr")
                         .build())
                 .expansionVlan2(InitialVlanInfoProperty.builder()
                         .cidr("cidr")
                         .build())
                 .hcx(InitialVlanInfoProperty.builder()
                         .cidr("cidr")
                         .build())
                 .hcxNetworkAclId("hcxNetworkAclId")
                 .isHcxPublic(false)
                 .nsxUpLink(InitialVlanInfoProperty.builder()
                         .cidr("cidr")
                         .build())
                 .vmkManagement(InitialVlanInfoProperty.builder()
                         .cidr("cidr")
                         .build())
                 .vmManagement(InitialVlanInfoProperty.builder()
                         .cidr("cidr")
                         .build())
                 .vMotion(InitialVlanInfoProperty.builder()
                         .cidr("cidr")
                         .build())
                 .vSan(InitialVlanInfoProperty.builder()
                         .cidr("cidr")
                         .build())
                 .vTep(InitialVlanInfoProperty.builder()
                         .cidr("cidr")
                         .build())
                 .build())
         .kmsKeyId("kmsKeyId")
         .licenseInfo(LicenseInfoProperty.builder()
                 .solutionKey("solutionKey")
                 .vsanKey("vsanKey")
                 .build())
         .serviceAccessSecurityGroups(ServiceAccessSecurityGroupsProperty.builder()
                 .securityGroups(List.of("securityGroups"))
                 .build())
         .serviceAccessSubnetId("serviceAccessSubnetId")
         .siteId("siteId")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .termsAccepted(false)
         .vcfHostnames(VcfHostnamesProperty.builder()
                 .cloudBuilder("cloudBuilder")
                 .nsx("nsx")
                 .nsxEdge1("nsxEdge1")
                 .nsxEdge2("nsxEdge2")
                 .nsxManager1("nsxManager1")
                 .nsxManager2("nsxManager2")
                 .nsxManager3("nsxManager3")
                 .sddcManager("sddcManager")
                 .vCenter("vCenter")
                 .build())
         .vcfVersion("vcfVersion")
         .vpcId("vpcId")
         .build())
 .strategy(mergeStrategy)
 .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evs-environment.html

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	CfnEnvironmentPropsMixin.Builder	A fluent builder for CfnEnvironmentPropsMixin.
static interface	CfnEnvironmentPropsMixin.CheckProperty	A check on the environment to identify environment health and validate VMware VCF licensing compliance.
static interface	CfnEnvironmentPropsMixin.ConnectivityInfoProperty	The connectivity configuration for the environment.
static interface	CfnEnvironmentPropsMixin.HostInfoForCreateProperty	An object that represents a host.
static interface	CfnEnvironmentPropsMixin.InitialVlanInfoProperty	An object that represents an initial VLAN subnet for the Amazon EVS environment.
static interface	CfnEnvironmentPropsMixin.InitialVlansProperty	The initial VLAN subnets for the environment.
static interface	CfnEnvironmentPropsMixin.LicenseInfoProperty	The license information that Amazon EVS requires to create an environment.
static interface	CfnEnvironmentPropsMixin.SecretProperty	A managed secret that contains the credentials for installing vCenter Server, NSX, and SDDC Manager.
static interface	CfnEnvironmentPropsMixin.ServiceAccessSecurityGroupsProperty	The security groups that allow traffic between the Amazon EVS control plane and your VPC for Amazon EVS service access.
static interface	CfnEnvironmentPropsMixin.VcfHostnamesProperty	The DNS hostnames that Amazon EVS uses to install VMware vCenter Server, NSX, SDDC Manager, and Cloud Builder.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IMixin

software.constructs.IMixin.Jsii$Default, software.constructs.IMixin.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
protected static final List<String>	CFN_PROPERTY_KEYS

Constructor Summary

Constructors

Modifier	Constructor	Description
	CfnEnvironmentPropsMixin(CfnEnvironmentMixinProps props)	Create a mixin to apply properties to AWS::EVS::Environment.
	CfnEnvironmentPropsMixin(CfnEnvironmentMixinProps props, CfnPropertyMixinOptions options)	Create a mixin to apply properties to AWS::EVS::Environment.
protected	CfnEnvironmentPropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnEnvironmentPropsMixin(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method	Description
void	applyTo(software.constructs.IConstruct construct)	Apply the mixin properties to the construct.
protected CfnEnvironmentMixinProps	getProps()
protected IMergeStrategy	getStrategy()
Boolean	supports(software.constructs.IConstruct construct)	Check if this mixin supports the given construct.

Methods inherited from class software.amazon.awscdk.Mixin

isMixin

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_PROPERTY_KEYS

@Stability(Stable)
protected static final List<String> CFN_PROPERTY_KEYS

Constructor Details

CfnEnvironmentPropsMixin

protected CfnEnvironmentPropsMixin(software.amazon.jsii.JsiiObjectRef objRef)

CfnEnvironmentPropsMixin

protected CfnEnvironmentPropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnEnvironmentPropsMixin

@Stability(Stable)
public CfnEnvironmentPropsMixin(@NotNull
 CfnEnvironmentMixinProps props,
 @Nullable
 CfnPropertyMixinOptions options)

Create a mixin to apply properties to AWS::EVS::Environment.

Parameters:

props - L1 properties to apply. This parameter is required.

options - Mixin options.

CfnEnvironmentPropsMixin

@Stability(Stable)
public CfnEnvironmentPropsMixin(@NotNull
 CfnEnvironmentMixinProps props)

Create a mixin to apply properties to AWS::EVS::Environment.

Parameters:

props - L1 properties to apply. This parameter is required.

Method Details

applyTo

@Stability(Stable)
public void applyTo(@NotNull
 software.constructs.IConstruct construct)

Apply the mixin properties to the construct.

Specified by:

applyTo in interface software.constructs.IMixin

Specified by:

applyTo in class Mixin

Parameters:

construct - This parameter is required.

supports

@Stability(Stable)
@NotNull
public Boolean supports(@NotNull
 software.constructs.IConstruct construct)

Check if this mixin supports the given construct.

Specified by:

supports in interface software.constructs.IMixin

Overrides:

supports in class Mixin

Parameters:

construct - This parameter is required.

getProps

@Stability(Stable)
@NotNull
protected CfnEnvironmentMixinProps getProps()

getStrategy

@Stability(Stable)
@NotNull
protected IMergeStrategy getStrategy()