All Superinterfaces:: software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:: CfnEnvironmentProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)", date="2025-10-24T13:34:39.038Z") @Stability(Stable) public interface CfnEnvironmentProps extends software.amazon.jsii.JsiiSerializable

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 software.amazon.awscdk.services.evs.*;
 CfnEnvironmentProps cfnEnvironmentProps = CfnEnvironmentProps.builder()
         .connectivityInfo(ConnectivityInfoProperty.builder()
                 .privateRouteServerPeerings(List.of("privateRouteServerPeerings"))
                 .build())
         .licenseInfo(LicenseInfoProperty.builder()
                 .solutionKey("solutionKey")
                 .vsanKey("vsanKey")
                 .build())
         .serviceAccessSubnetId("serviceAccessSubnetId")
         .siteId("siteId")
         .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")
         // the properties below are optional
         .environmentName("environmentName")
         .hosts(List.of(HostInfoForCreateProperty.builder()
                 .hostName("hostName")
                 .instanceType("instanceType")
                 .keyName("keyName")
                 // the properties below are optional
                 .dedicatedHostId("dedicatedHostId")
                 .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())
                 .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())
                 // the properties below are optional
                 .hcxNetworkAclId("hcxNetworkAclId")
                 .isHcxPublic(false)
                 .build())
         .kmsKeyId("kmsKeyId")
         .serviceAccessSecurityGroups(ServiceAccessSecurityGroupsProperty.builder()
                 .securityGroups(List.of("securityGroups"))
                 .build())
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();

See Also:

Nested Class Summary

Nested Classes

Modifier and Type

Interface

Description

static final class

CfnEnvironmentProps.Builder

A builder for CfnEnvironmentProps

static final class

CfnEnvironmentProps.Jsii$Proxy

An implementation for CfnEnvironmentProps
Method Summary

Modifier and Type

Method

Description

static CfnEnvironmentProps.Builder

builder()

Object

getConnectivityInfo()

The connectivity configuration for the environment.

default String

getEnvironmentName()

The name of the environment.

default Object

getHosts()

Required for environment resource creation.

default Object

getInitialVlans()

default String

getKmsKeyId()

The AWS KMS key ID that AWS Secrets Manager uses to encrypt secrets that are associated with the environment.

Object

getLicenseInfo()

The license information that Amazon EVS requires to create an environment.

default Object

getServiceAccessSecurityGroups()

The security groups that allow traffic between the Amazon EVS control plane and your VPC for service access.

String

getServiceAccessSubnetId()

The subnet that is used to establish connectivity between the Amazon EVS control plane and VPC.

String

getSiteId()

The Broadcom Site ID that is associated with your Amazon EVS environment.

default List<CfnTag>

getTags()

Metadata that assists with categorization and organization.

Object

getTermsAccepted()

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.

Object

getVcfHostnames()

The DNS hostnames to be used by the VCF management appliances in your environment.

String

getVcfVersion()

The VCF version of the environment.

String

getVpcId()

The VPC associated with the environment.

Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson

Method Details
- getConnectivityInfo
  
  @Stability(Stable) @NotNull Object getConnectivityInfo()
  
  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.
  Returns union: either IResolvable or CfnEnvironment.ConnectivityInfoProperty
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evs-environment.html#cfn-evs-environment-connectivityinfo
- getLicenseInfo
  
  @Stability(Stable) @NotNull Object getLicenseInfo()
  
  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.
  Returns union: either IResolvable or CfnEnvironment.LicenseInfoProperty
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evs-environment.html#cfn-evs-environment-licenseinfo
- getServiceAccessSubnetId
  
  @Stability(Stable) @NotNull String getServiceAccessSubnetId()
  
  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.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evs-environment.html#cfn-evs-environment-serviceaccesssubnetid
- getSiteId
  
  @Stability(Stable) @NotNull String getSiteId()
  
  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.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evs-environment.html#cfn-evs-environment-siteid
- getTermsAccepted
  
  @Stability(Stable) @NotNull Object getTermsAccepted()
  
  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.
  Returns union: either Boolean or IResolvable
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evs-environment.html#cfn-evs-environment-termsaccepted
- getVcfHostnames
  
  @Stability(Stable) @NotNull Object getVcfHostnames()
  
  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.
  Returns union: either IResolvable or CfnEnvironment.VcfHostnamesProperty
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evs-environment.html#cfn-evs-environment-vcfhostnames
- getVcfVersion
  
  @Stability(Stable) @NotNull String getVcfVersion()
  
  The VCF version of the environment.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evs-environment.html#cfn-evs-environment-vcfversion
- getVpcId
  
  @Stability(Stable) @NotNull String getVpcId()
  
  The VPC associated with the environment.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evs-environment.html#cfn-evs-environment-vpcid
- getEnvironmentName
  
  @Stability(Stable) @Nullable default String getEnvironmentName()
  
  The name of the environment.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evs-environment.html#cfn-evs-environment-environmentname
- getHosts
  
  @Stability(Stable) @Nullable default Object getHosts()
  
  Required for environment resource creation.
  Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnEnvironment.HostInfoForCreateProperty>
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evs-environment.html#cfn-evs-environment-hosts
- getInitialVlans
  
  @Stability(Stable) @Nullable default Object getInitialVlans()
  
  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.
  Returns union: either IResolvable or CfnEnvironment.InitialVlansProperty
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evs-environment.html#cfn-evs-environment-initialvlans
- getKmsKeyId
  
  @Stability(Stable) @Nullable default String getKmsKeyId()
  
  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.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evs-environment.html#cfn-evs-environment-kmskeyid
- getServiceAccessSecurityGroups
  
  @Stability(Stable) @Nullable default Object getServiceAccessSecurityGroups()
  
  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.
  Returns union: either IResolvable or CfnEnvironment.ServiceAccessSecurityGroupsProperty
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evs-environment.html#cfn-evs-environment-serviceaccesssecuritygroups
- getTags
  
  @Stability(Stable) @Nullable default List<CfnTag> getTags()
  
  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.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evs-environment.html#cfn-evs-environment-tags
- builder
  
  @Stability(Stable) static CfnEnvironmentProps.Builder builder()
  
  Returns:
  
  a CfnEnvironmentProps.Builder of CfnEnvironmentProps

Interface CfnEnvironmentProps

Nested Class Summary

Method Summary

Methods inherited from interface software.amazon.jsii.JsiiSerializable

Method Details

getConnectivityInfo

getLicenseInfo

getServiceAccessSubnetId

getSiteId

getTermsAccepted

getVcfHostnames

getVcfVersion

getVpcId

getEnvironmentName

getHosts

getInitialVlans

getKmsKeyId

getServiceAccessSecurityGroups

getTags

builder