aws-cdk-lib.aws_evs.CfnEnvironment

CfnEnvironment L1 construct

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.

Construct›CfnElement›CfnRefElement›CfnResource›CfnEnvironment

implements

• IInspectable,
• ITaggableV2,
• IEnvironmentAware,
• IEnvironmentRef,
• 2 more

  • IConstruct,
  • IDependable

CloudFormation

AWS::EVS::Environment

Source

Generated code

Type last changed

v2.262.0 · 22 Jul 2026

Example

// 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',
  },
});

from aws_cdk import CfnTag
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_evs as evs

cfn_environment = evs.CfnEnvironment(self, "MyCfnEnvironment",
    service_access_subnet_id="serviceAccessSubnetId",
    terms_accepted=False,
    vcf_version="vcfVersion",
    vpc_id="vpcId",

    # the properties below are optional
    connectivity_info=evs.CfnEnvironment.ConnectivityInfoProperty(
        private_route_server_peerings=["privateRouteServerPeerings"]
    ),
    environment_name="environmentName",
    hosts=[evs.CfnEnvironment.HostInfoForCreateProperty(
        host_name="hostName",
        instance_type="instanceType",
        key_name="keyName",

        # the properties below are optional
        dedicated_host_id="dedicatedHostId",
        placement_group_id="placementGroupId"
    )],
    initial_vlans=evs.CfnEnvironment.InitialVlansProperty(
        edge_v_tep=evs.CfnEnvironment.InitialVlanInfoProperty(
            cidr="cidr"
        ),
        expansion_vlan1=evs.CfnEnvironment.InitialVlanInfoProperty(
            cidr="cidr"
        ),
        expansion_vlan2=evs.CfnEnvironment.InitialVlanInfoProperty(
            cidr="cidr"
        ),
        hcx=evs.CfnEnvironment.InitialVlanInfoProperty(
            cidr="cidr"
        ),
        nsx_up_link=evs.CfnEnvironment.InitialVlanInfoProperty(
            cidr="cidr"
        ),
        vmk_management=evs.CfnEnvironment.InitialVlanInfoProperty(
            cidr="cidr"
        ),
        vm_management=evs.CfnEnvironment.InitialVlanInfoProperty(
            cidr="cidr"
        ),
        v_motion=evs.CfnEnvironment.InitialVlanInfoProperty(
            cidr="cidr"
        ),
        v_san=evs.CfnEnvironment.InitialVlanInfoProperty(
            cidr="cidr"
        ),
        v_tep=evs.CfnEnvironment.InitialVlanInfoProperty(
            cidr="cidr"
        ),

        # the properties below are optional
        hcx_network_acl_id="hcxNetworkAclId",
        is_hcx_public=False
    ),
    kms_key_id="kmsKeyId",
    license_info=evs.CfnEnvironment.LicenseInfoProperty(
        solution_key="solutionKey",
        vsan_key="vsanKey"
    ),
    service_access_security_groups=evs.CfnEnvironment.ServiceAccessSecurityGroupsProperty(
        security_groups=["securityGroups"]
    ),
    site_id="siteId",
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    vcf_hostnames=evs.CfnEnvironment.VcfHostnamesProperty(
        cloud_builder="cloudBuilder",
        nsx="nsx",
        nsx_edge1="nsxEdge1",
        nsx_edge2="nsxEdge2",
        nsx_manager1="nsxManager1",
        nsx_manager2="nsxManager2",
        nsx_manager3="nsxManager3",
        sddc_manager="sddcManager",
        v_center="vCenter"
    )
)

// 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.*;

CfnEnvironment cfnEnvironment = CfnEnvironment.Builder.create(this, "MyCfnEnvironment")
        .serviceAccessSubnetId("serviceAccessSubnetId")
        .termsAccepted(false)
        .vcfVersion("vcfVersion")
        .vpcId("vpcId")

        // the properties below are optional
        .connectivityInfo(ConnectivityInfoProperty.builder()
                .privateRouteServerPeerings(List.of("privateRouteServerPeerings"))
                .build())
        .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")
        .licenseInfo(LicenseInfoProperty.builder()
                .solutionKey("solutionKey")
                .vsanKey("vsanKey")
                .build())
        .serviceAccessSecurityGroups(ServiceAccessSecurityGroupsProperty.builder()
                .securityGroups(List.of("securityGroups"))
                .build())
        .siteId("siteId")
        .tags(List.of(CfnTag.builder()
                .key("key")
                .value("value")
                .build()))
        .vcfHostnames(VcfHostnamesProperty.builder()
                .cloudBuilder("cloudBuilder")
                .nsx("nsx")
                .nsxEdge1("nsxEdge1")
                .nsxEdge2("nsxEdge2")
                .nsxManager1("nsxManager1")
                .nsxManager2("nsxManager2")
                .nsxManager3("nsxManager3")
                .sddcManager("sddcManager")
                .vCenter("vCenter")
                .build())
        .build();

// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.EVS;

var cfnEnvironment = new CfnEnvironment(this, "MyCfnEnvironment", new CfnEnvironmentProps {
    ServiceAccessSubnetId = "serviceAccessSubnetId",
    TermsAccepted = false,
    VcfVersion = "vcfVersion",
    VpcId = "vpcId",

    // the properties below are optional
    ConnectivityInfo = new ConnectivityInfoProperty {
        PrivateRouteServerPeerings = new [] { "privateRouteServerPeerings" }
    },
    EnvironmentName = "environmentName",
    Hosts = new [] { new HostInfoForCreateProperty {
        HostName = "hostName",
        InstanceType = "instanceType",
        KeyName = "keyName",

        // the properties below are optional
        DedicatedHostId = "dedicatedHostId",
        PlacementGroupId = "placementGroupId"
    } },
    InitialVlans = new InitialVlansProperty {
        EdgeVTep = new InitialVlanInfoProperty {
            Cidr = "cidr"
        },
        ExpansionVlan1 = new InitialVlanInfoProperty {
            Cidr = "cidr"
        },
        ExpansionVlan2 = new InitialVlanInfoProperty {
            Cidr = "cidr"
        },
        Hcx = new InitialVlanInfoProperty {
            Cidr = "cidr"
        },
        NsxUpLink = new InitialVlanInfoProperty {
            Cidr = "cidr"
        },
        VmkManagement = new InitialVlanInfoProperty {
            Cidr = "cidr"
        },
        VmManagement = new InitialVlanInfoProperty {
            Cidr = "cidr"
        },
        VMotion = new InitialVlanInfoProperty {
            Cidr = "cidr"
        },
        VSan = new InitialVlanInfoProperty {
            Cidr = "cidr"
        },
        VTep = new InitialVlanInfoProperty {
            Cidr = "cidr"
        },

        // the properties below are optional
        HcxNetworkAclId = "hcxNetworkAclId",
        IsHcxPublic = false
    },
    KmsKeyId = "kmsKeyId",
    LicenseInfo = new LicenseInfoProperty {
        SolutionKey = "solutionKey",
        VsanKey = "vsanKey"
    },
    ServiceAccessSecurityGroups = new ServiceAccessSecurityGroupsProperty {
        SecurityGroups = new [] { "securityGroups" }
    },
    SiteId = "siteId",
    Tags = new [] { new CfnTag {
        Key = "key",
        Value = "value"
    } },
    VcfHostnames = new VcfHostnamesProperty {
        CloudBuilder = "cloudBuilder",
        Nsx = "nsx",
        NsxEdge1 = "nsxEdge1",
        NsxEdge2 = "nsxEdge2",
        NsxManager1 = "nsxManager1",
        NsxManager2 = "nsxManager2",
        NsxManager3 = "nsxManager3",
        SddcManager = "sddcManager",
        VCenter = "vCenter"
    }
});

// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

cfnEnvironment := awscdk.Aws_evs.NewCfnEnvironment(this, jsii.String("MyCfnEnvironment"), &CfnEnvironmentProps{
	ServiceAccessSubnetId: jsii.String("serviceAccessSubnetId"),
	TermsAccepted: jsii.Boolean(false),
	VcfVersion: jsii.String("vcfVersion"),
	VpcId: jsii.String("vpcId"),

	// the properties below are optional
	ConnectivityInfo: &ConnectivityInfoProperty{
		PrivateRouteServerPeerings: []*string{
			jsii.String("privateRouteServerPeerings"),
		},
	},
	EnvironmentName: jsii.String("environmentName"),
	Hosts: []interface{}{
		&HostInfoForCreateProperty{
			HostName: jsii.String("hostName"),
			InstanceType: jsii.String("instanceType"),
			KeyName: jsii.String("keyName"),

			// the properties below are optional
			DedicatedHostId: jsii.String("dedicatedHostId"),
			PlacementGroupId: jsii.String("placementGroupId"),
		},
	},
	InitialVlans: &InitialVlansProperty{
		EdgeVTep: &InitialVlanInfoProperty{
			Cidr: jsii.String("cidr"),
		},
		ExpansionVlan1: &InitialVlanInfoProperty{
			Cidr: jsii.String("cidr"),
		},
		ExpansionVlan2: &InitialVlanInfoProperty{
			Cidr: jsii.String("cidr"),
		},
		Hcx: &InitialVlanInfoProperty{
			Cidr: jsii.String("cidr"),
		},
		NsxUpLink: &InitialVlanInfoProperty{
			Cidr: jsii.String("cidr"),
		},
		VmkManagement: &InitialVlanInfoProperty{
			Cidr: jsii.String("cidr"),
		},
		VmManagement: &InitialVlanInfoProperty{
			Cidr: jsii.String("cidr"),
		},
		VMotion: &InitialVlanInfoProperty{
			Cidr: jsii.String("cidr"),
		},
		VSan: &InitialVlanInfoProperty{
			Cidr: jsii.String("cidr"),
		},
		VTep: &InitialVlanInfoProperty{
			Cidr: jsii.String("cidr"),
		},

		// the properties below are optional
		HcxNetworkAclId: jsii.String("hcxNetworkAclId"),
		IsHcxPublic: jsii.Boolean(false),
	},
	KmsKeyId: jsii.String("kmsKeyId"),
	LicenseInfo: &LicenseInfoProperty{
		SolutionKey: jsii.String("solutionKey"),
		VsanKey: jsii.String("vsanKey"),
	},
	ServiceAccessSecurityGroups: &ServiceAccessSecurityGroupsProperty{
		SecurityGroups: []*string{
			jsii.String("securityGroups"),
		},
	},
	SiteId: jsii.String("siteId"),
	Tags: []CfnTag{
		&CfnTag{
			Key: jsii.String("key"),
			Value: jsii.String("value"),
		},
	},
	VcfHostnames: &VcfHostnamesProperty{
		CloudBuilder: jsii.String("cloudBuilder"),
		Nsx: jsii.String("nsx"),
		NsxEdge1: jsii.String("nsxEdge1"),
		NsxEdge2: jsii.String("nsxEdge2"),
		NsxManager1: jsii.String("nsxManager1"),
		NsxManager2: jsii.String("nsxManager2"),
		NsxManager3: jsii.String("nsxManager3"),
		SddcManager: jsii.String("sddcManager"),
		VCenter: jsii.String("vCenter"),
	},
})

Initializer

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

CfnEnvironment(scope: Construct, id: str, props: CfnEnvironmentProps)

new CfnEnvironment(Construct scope, String id, CfnEnvironmentProps props)

new CfnEnvironment(Construct scope, string id, CfnEnvironmentProps props)

NewCfnEnvironment(Scope Construct, Id *string, Props CfnEnvironmentProps)

Construct Props

connectivityInfo?optionalIResolvable | CfnEnvironment.ConnectivityInfoPropertyconnectivity_info?optionaltyping.Union[IResolvable, ConnectivityInfoProperty]connectivityInfo?optionalIResolvableConnectivityInfo?optionalIResolvableConnectivityInfo?optionalinterface{}#

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?optionalstringenvironment_name?optionalstrenvironmentName?optionalStringEnvironmentName?optionalstringEnvironmentName?optional*string#

The name of the environment.

hosts?optionalIResolvable | IResolvable | CfnEnvironment.HostInfoForCreateProperty[]hosts?optionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, HostInfoForCreateProperty]]]hosts?optionalIResolvableHosts?optionalIResolvableHosts?optionalinterface{}#

Required for environment resource creation.

initialVlans?optionalIResolvable | CfnEnvironment.InitialVlansPropertyinitial_vlans?optionaltyping.Union[IResolvable, InitialVlansProperty]initialVlans?optionalIResolvableInitialVlans?optionalIResolvableInitialVlans?optionalinterface{}#

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

kmsKeyId?optionalstringkms_key_id?optionalstrkmsKeyId?optionalStringKmsKeyId?optionalstringKmsKeyId?optional*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?optionalIResolvable | CfnEnvironment.LicenseInfoPropertylicense_info?optionaltyping.Union[IResolvable, LicenseInfoProperty]licenseInfo?optionalIResolvableLicenseInfo?optionalIResolvableLicenseInfo?optionalinterface{}#

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?optionalIResolvable | CfnEnvironment.ServiceAccessSecurityGroupsPropertyservice_access_security_groups?optionaltyping.Union[IResolvable, ServiceAccessSecurityGroupsProperty]serviceAccessSecurityGroups?optionalIResolvableServiceAccessSecurityGroups?optionalIResolvableServiceAccessSecurityGroups?optionalinterface{}#

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.

siteId?optionalstringsite_id?optionalstrsiteId?optionalStringSiteId?optionalstringSiteId?optional*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?optionalCfnTag[]tags?optionaltyping.List[CfnTag]tags?optionalList<CfnTag>Tags?optionalCfnTag[]Tags?optional*[]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.

vcfHostnames?optionalIResolvable | CfnEnvironment.VcfHostnamesPropertyvcf_hostnames?optionaltyping.Union[IResolvable, VcfHostnamesProperty]vcfHostnames?optionalIResolvableVcfHostnames?optionalIResolvableVcfHostnames?optionalinterface{}#

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.

Properties

attrChecksIResolvableattr_checksIResolvableattrChecksIResolvableAttrChecksIResolvableAttrChecksIResolvable#

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" } ] }

attrCreatedAtstringattr_created_atstrattrCreatedAtStringAttrCreatedAtstringAttrCreatedAt*string#

The date and time that the environment was created.

For example: 1749081600.000 .

attrCredentialsIResolvableattr_credentialsIResolvableattrCredentialsIResolvableAttrCredentialsIResolvableAttrCredentialsIResolvable#

The VCF credentials that are stored as Amazon EVS managed secrets in AWS Secrets Manager.

notes

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" } ] }

attrEnvironmentArnstringattr_environment_arnstrattrEnvironmentArnStringAttrEnvironmentArnstringAttrEnvironmentArn*string#

The Amazon Resource Name (ARN) that is associated with the environment.

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

attrEnvironmentIdstringattr_environment_idstrattrEnvironmentIdStringAttrEnvironmentIdstringAttrEnvironmentId*string#

The unique ID for the environment.

For example: env-1234567890 .

attrEnvironmentStatestringattr_environment_statestrattrEnvironmentStateStringAttrEnvironmentStatestringAttrEnvironmentState*string#

The state of an environment.

For example: CREATED .

attrModifiedAtstringattr_modified_atstrattrModifiedAtStringAttrModifiedAtstringAttrModifiedAt*string#

The date and time that the environment was modified.

For example: 1749081600.000 .

attrStateDetailsstringattr_state_detailsstrattrStateDetailsStringAttrStateDetailsstringAttrStateDetails*string#

A detailed description of the `environmentState` of an environment.

For example: Environment successfully created .

cdkTagManagerTagManagercdk_tag_managerTagManagercdkTagManagerTagManagerCdkTagManagerTagManagerCdkTagManagerTagManager#

Tag Manager which manages the tags for this resource.

CFN_RESOURCE_TYPE_NAMEstringcfn_resource_type_namestrCFN_RESOURCE_TYPE_NAMEStringCFN_RESOURCE_TYPE_NAMEstringCFN_RESOURCE_TYPE_NAME*stringstatic#

The CloudFormation resource type name for this resource class.

cfnOptionsICfnResourceOptionscfn_optionsICfnResourceOptionscfnOptionsICfnResourceOptionsCfnOptionsICfnResourceOptionsCfnOptionsICfnResourceOptions#

Options for this resource, such as condition, update policy etc.

cfnResourceTypestringcfn_resource_typestrcfnResourceTypeStringCfnResourceTypestringCfnResourceType*string#

AWS resource type.

connectivityInfo?may be undefinedIResolvable | CfnEnvironment.ConnectivityInfoPropertyconnectivity_info?may be undefinedtyping.Union[IResolvable, ConnectivityInfoProperty]connectivityInfo?may be undefinedIResolvableConnectivityInfo?may be undefinedIResolvableConnectivityInfo?may be undefinedinterface{}#

The connectivity configuration for the environment.

creationStackstring[]creation_stacktyping.List[str]creationStackList<String>CreationStackstring[]CreationStack*[]*string#

envResourceEnvironmentenvResourceEnvironmentenvResourceEnvironmentEnvResourceEnvironmentEnvResourceEnvironment#

environmentName?may be undefinedstringenvironment_name?may be undefinedstrenvironmentName?may be undefinedStringEnvironmentName?may be undefinedstringEnvironmentName?may be undefined*string#

The name of the environment.

environmentRefEnvironmentReferenceenvironment_refEnvironmentReferenceenvironmentRefEnvironmentReferenceEnvironmentRefEnvironmentReferenceEnvironmentRefEnvironmentReference#

A reference to a Environment resource.

hosts?may be undefinedIResolvable | IResolvable | CfnEnvironment.HostInfoForCreateProperty[]hosts?may be undefinedtyping.Union[IResolvable, typing.List[typing.Union[IResolvable, HostInfoForCreateProperty]]]hosts?may be undefinedIResolvableHosts?may be undefinedIResolvableHosts?may be undefinedinterface{}#

Required for environment resource creation.

initialVlans?may be undefinedIResolvable | CfnEnvironment.InitialVlansPropertyinitial_vlans?may be undefinedtyping.Union[IResolvable, InitialVlansProperty]initialVlans?may be undefinedIResolvableInitialVlans?may be undefinedIResolvableInitialVlans?may be undefinedinterface{}#

> Amazon EVS is in public preview release and is subject to change.

kmsKeyId?may be undefinedstringkms_key_id?may be undefinedstrkmsKeyId?may be undefinedStringKmsKeyId?may be undefinedstringKmsKeyId?may be undefined*string#

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

licenseInfo?may be undefinedIResolvable | CfnEnvironment.LicenseInfoPropertylicense_info?may be undefinedtyping.Union[IResolvable, LicenseInfoProperty]licenseInfo?may be undefinedIResolvableLicenseInfo?may be undefinedIResolvableLicenseInfo?may be undefinedinterface{}#

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

logicalIdstringlogical_idstrlogicalIdStringLogicalIdstringLogicalId*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).

nodeNodenodeNodenodeNodeNodeNodeNodeNode#

The tree node.

refstringrefstrrefStringRefstringRef*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?may be undefinedIResolvable | CfnEnvironment.ServiceAccessSecurityGroupsPropertyservice_access_security_groups?may be undefinedtyping.Union[IResolvable, ServiceAccessSecurityGroupsProperty]serviceAccessSecurityGroups?may be undefinedIResolvableServiceAccessSecurityGroups?may be undefinedIResolvableServiceAccessSecurityGroups?may be undefinedinterface{}#

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

serviceAccessSubnetIdstringservice_access_subnet_idstrserviceAccessSubnetIdStringServiceAccessSubnetIdstringServiceAccessSubnetId*string#

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

siteId?may be undefinedstringsite_id?may be undefinedstrsiteId?may be undefinedStringSiteId?may be undefinedstringSiteId?may be undefined*string#

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

stackStackstackStackstackStackStackStackStackStack#

The stack in which this element is defined.

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

tags?may be undefinedCfnTag[]tags?may be undefinedtyping.List[CfnTag]tags?may be undefinedList<CfnTag>Tags?may be undefinedCfnTag[]Tags?may be undefined*[]CfnTag#

Metadata that assists with categorization and organization.

termsAcceptedboolean | IResolvableterms_acceptedtyping.Union[bool, IResolvable]termsAcceptedBooleanTermsAcceptedboolTermsAcceptedinterface{}#

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?may be undefinedIResolvable | CfnEnvironment.VcfHostnamesPropertyvcf_hostnames?may be undefinedtyping.Union[IResolvable, VcfHostnamesProperty]vcfHostnames?may be undefinedIResolvableVcfHostnames?may be undefinedIResolvableVcfHostnames?may be undefinedinterface{}#

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

vcfVersionstringvcf_versionstrvcfVersionStringVcfVersionstringVcfVersion*string#

The VCF version of the environment.

vpcIdstringvpc_idstrvpcIdStringVpcIdstringVpcId*string#

The VPC associated with the environment.

Methods

addDeletionOverride(path: string): voiddef add_deletion_override(self, path: str) -> Nonepublic void addDeletionOverride(String path)public void AddDeletionOverride(string path)func AddDeletionOverride(Path *string)#

Syntactic sugar for `addOverride(path, undefined)`.

1 parameter

Parameters

• pathpathpathpathPath — The path of the value to delete.

addDependency(target: CfnResource): voiddef add_dependency(self, target: CfnResource) -> Nonepublic void addDependency(CfnResource target)public void AddDependency(CfnResource target)func AddDependency(Target CfnResource)deprecated#

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): voiddef add_depends_on(self, target: CfnResource) -> Nonepublic void addDependsOn(CfnResource target)public void AddDependsOn(CfnResource target)func AddDependsOn(Target CfnResource)deprecated#

Use `addResourceDependency` instead.

notes

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): voiddef add_metadata(self, key: str, value: Any) -> Nonepublic void addMetadata(String key, Object value)public void AddMetadata(string key, object value)func AddMetadata(Key *string, Value interface{})#

Add a value to the CloudFormation Resource Metadata.

addOverride(path: string, value: any): voiddef add_override(self, path: str, value: Any) -> Nonepublic void addOverride(String path, Object value)public void AddOverride(string path, object value)func AddOverride(Path *string, Value interface{})#

Adds an override to the synthesized CloudFormation resource.

notes · 2 parameters

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,

cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');

would add the overrides

"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

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

addPropertyDeletionOverride(propertyPath: string): voiddef add_property_deletion_override(self, property_path: str) -> Nonepublic void addPropertyDeletionOverride(String propertyPath)public void AddPropertyDeletionOverride(string propertyPath)func AddPropertyDeletionOverride(PropertyPath *string)#

Adds an override that deletes the value of a property from the resource definition.

1 parameter

Parameters

• propertyPathproperty_pathpropertyPathpropertyPathPropertyPath — The path to the property.

addPropertyOverride(propertyPath: string, value: any): voiddef add_property_override(self, property_path: str, value: Any) -> Nonepublic void addPropertyOverride(String propertyPath, Object value)public void AddPropertyOverride(string propertyPath, object value)func AddPropertyOverride(PropertyPath *string, Value interface{})#

Adds an override to a resource property.

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

2 parameters

Parameters

• propertyPathproperty_pathpropertyPathpropertyPathPropertyPath — The path of the property.
• valuevaluevaluevalueValue — The value.

addResourceDependency(target: CfnResource, reason?: string): voiddef add_resource_dependency(self, target: CfnResource, reason: typing.Optional[str] = None) -> Nonepublic void addResourceDependency(CfnResource target, String reason)public void AddResourceDependency(CfnResource target, string? reason = null)func AddResourceDependency(Target CfnResource, Reason *string)#

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

notes

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): voiddef apply_cross_stack_reference_strength(self, strength: ReferenceStrength) -> Nonepublic void applyCrossStackReferenceStrength(ReferenceStrength strength)public void ApplyCrossStackReferenceStrength(ReferenceStrength strength)func ApplyCrossStackReferenceStrength(Strength ReferenceStrength)#

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.

1 parameter

Parameters

• strengthstrengthstrengthstrengthStrength — - The reference strength to use for this resource.

applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): voiddef apply_removal_policy(self, policy: typing.Optional[RemovalPolicy] = None, options: typing.Optional[RemovalPolicyOptions] = None) -> Nonepublic void applyRemovalPolicy(RemovalPolicy policy, RemovalPolicyOptions options)public void ApplyRemovalPolicy(RemovalPolicy? policy = null, RemovalPolicyOptions? options = null)func ApplyRemovalPolicy(Policy RemovalPolicy, Options RemovalPolicyOptions)#

Sets the deletion policy of the resource based on the removal policy specified.

notes

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@staticmethod def arn_for_environment(resource: IEnvironmentRef) -> strpublic static String arnForEnvironment(IEnvironmentRef resource)public static string ArnForEnvironment(IEnvironmentRef resource)func ArnForEnvironment(Resource IEnvironmentRef) *stringstatic#

cfnPropertyName(cdkPropertyName: string): stringdef cfn_property_name(self, cdk_property_name: str) -> strpublic String cfnPropertyName(String cdkPropertyName)public string CfnPropertyName(string cdkPropertyName)func CfnPropertyName(CdkPropertyName *string) *string#

getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Referencedef get_att(self, attribute_name: str, type_hint: typing.Optional[ResolutionTypeHint] = None) -> Referencepublic Reference getAtt(String attributeName, ResolutionTypeHint typeHint)public Reference GetAtt(string attributeName, ResolutionTypeHint? typeHint = null)func 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.

1 parameter

Parameters

• attributeNameattribute_nameattributeNameattributeNameAttributeName — The name of the attribute.

getMetadata(key: string): anydef get_metadata(self, key: str) -> Anypublic Object getMetadata(String key)public object GetMetadata(string key)func GetMetadata(Key *string) interface{}#

Retrieve a value value from the CloudFormation Resource Metadata.

inspect(inspector: TreeInspector): voiddef inspect(self, inspector: TreeInspector) -> Nonepublic void inspect(TreeInspector inspector)public void Inspect(TreeInspector inspector)func Inspect(Inspector TreeInspector)#

Examines the CloudFormation resource and discloses attributes.

1 parameter

Parameters

• inspectorinspectorinspectorinspectorInspector — tree inspector to collect and process attributes.

isCfnElement(x: any): boolean@staticmethod def is_cfn_element(x: Any) -> boolpublic static Boolean isCfnElement(Object x)public static bool IsCfnElement(object x)func IsCfnElement(X interface{}) *boolstatic#

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

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

isCfnEnvironment(x: any): boolean@staticmethod def is_cfn_environment(x: Any) -> boolpublic static Boolean isCfnEnvironment(Object x)public static bool IsCfnEnvironment(object x)func IsCfnEnvironment(X interface{}) *boolstatic#

Checks whether the given object is a CfnEnvironment.

isCfnResource(x: any): boolean@staticmethod def is_cfn_resource(x: Any) -> boolpublic static Boolean isCfnResource(Object x)public static bool IsCfnResource(object x)func IsCfnResource(X interface{}) *boolstatic#

Check whether the given object is a CfnResource.

isConstruct(x: any): boolean@staticmethod def is_construct(x: Any) -> boolpublic static Boolean isConstruct(Object x)public static bool IsConstruct(object x)func IsConstruct(X interface{}) *boolstatic#

Checks if `x` is a construct.

notes · 1 parameter · returns

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

• xxxxX — Any object.

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

obtainDependencies(): Stack | CfnResource[]def obtain_dependencies(self, ) -> typing.List[typing.Union[Stack, CfnResource]]public List<Stack> obtainDependencies()public Stack[] ObtainDependencies()func ObtainDependencies() *[]interface{}#

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): voiddef override_logical_id(self, new_logical_id: str) -> Nonepublic void overrideLogicalId(String newLogicalId)public void OverrideLogicalId(string newLogicalId)func OverrideLogicalId(NewLogicalId *string)#

Overrides the auto-generated logical ID with a specific ID.

1 parameter

Parameters

• newLogicalIdnew_logical_idnewLogicalIdnewLogicalIdNewLogicalId — The new logical ID to use for this stack element.

removeDependency(target: CfnResource): voiddef remove_dependency(self, target: CfnResource) -> Nonepublic void removeDependency(CfnResource target)public void RemoveDependency(CfnResource target)func RemoveDependency(Target CfnResource)deprecated#

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): voiddef remove_resource_dependency(self, target: CfnResource) -> Nonepublic void removeResourceDependency(CfnResource target)public void RemoveResourceDependency(CfnResource target)func RemoveResourceDependency(Target CfnResource)#

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): voiddef replace_dependency(self, target: CfnResource, new_target: CfnResource) -> Nonepublic void replaceDependency(CfnResource target, CfnResource newTarget)public void ReplaceDependency(CfnResource target, CfnResource newTarget)func ReplaceDependency(Target CfnResource, NewTarget CfnResource)#

Replaces one dependency with another.

2 parameters

Parameters

• targettargettargettargetTarget — The dependency to replace.
• newTargetnew_targetnewTargetnewTargetNewTarget — The new dependency to add.

toString(): stringdef to_string(self, ) -> strpublic String toString()public string ToString()func ToString() *string#

Returns a string representation of this construct.

returns

Returns: a string representation of this resource

with(...mixins: IMixin[]): IConstructdef with(self, mixins: IMixin) -> IConstructpublic IConstruct with(IMixin mixins)public IConstruct With(IMixin mixins)func 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.