CfnEnvironmentPropsMixin

class aws_cdk.mixins_preview.aws_evs.mixins.CfnEnvironmentPropsMixin(props, *, strategy=None)

Bases: Mixin

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

You cannot use the ``dedicatedHostId`` and ``placementGroupId`` parameters together in the same ``CreateEnvironment`` action. This results in a ``ValidationException`` response.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evs-environment.html
CloudformationResource:: AWS::EVS::Environment
Mixin:: true
ExampleMetadata:: fixture=_generated

Example:

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

cfn_environment_props_mixin = evs_mixins.CfnEnvironmentPropsMixin(evs_mixins.CfnEnvironmentMixinProps(
    connectivity_info=evs_mixins.CfnEnvironmentPropsMixin.ConnectivityInfoProperty(
        private_route_server_peerings=["privateRouteServerPeerings"]
    ),
    environment_name="environmentName",
    hosts=[evs_mixins.CfnEnvironmentPropsMixin.HostInfoForCreateProperty(
        dedicated_host_id="dedicatedHostId",
        host_name="hostName",
        instance_type="instanceType",
        key_name="keyName",
        placement_group_id="placementGroupId"
    )],
    initial_vlans=evs_mixins.CfnEnvironmentPropsMixin.InitialVlansProperty(
        edge_vTep=evs_mixins.CfnEnvironmentPropsMixin.InitialVlanInfoProperty(
            cidr="cidr"
        ),
        expansion_vlan1=evs_mixins.CfnEnvironmentPropsMixin.InitialVlanInfoProperty(
            cidr="cidr"
        ),
        expansion_vlan2=evs_mixins.CfnEnvironmentPropsMixin.InitialVlanInfoProperty(
            cidr="cidr"
        ),
        hcx=evs_mixins.CfnEnvironmentPropsMixin.InitialVlanInfoProperty(
            cidr="cidr"
        ),
        hcx_network_acl_id="hcxNetworkAclId",
        is_hcx_public=False,
        nsx_up_link=evs_mixins.CfnEnvironmentPropsMixin.InitialVlanInfoProperty(
            cidr="cidr"
        ),
        vmk_management=evs_mixins.CfnEnvironmentPropsMixin.InitialVlanInfoProperty(
            cidr="cidr"
        ),
        vm_management=evs_mixins.CfnEnvironmentPropsMixin.InitialVlanInfoProperty(
            cidr="cidr"
        ),
        v_motion=evs_mixins.CfnEnvironmentPropsMixin.InitialVlanInfoProperty(
            cidr="cidr"
        ),
        v_san=evs_mixins.CfnEnvironmentPropsMixin.InitialVlanInfoProperty(
            cidr="cidr"
        ),
        v_tep=evs_mixins.CfnEnvironmentPropsMixin.InitialVlanInfoProperty(
            cidr="cidr"
        )
    ),
    kms_key_id="kmsKeyId",
    license_info=evs_mixins.CfnEnvironmentPropsMixin.LicenseInfoProperty(
        solution_key="solutionKey",
        vsan_key="vsanKey"
    ),
    service_access_security_groups=evs_mixins.CfnEnvironmentPropsMixin.ServiceAccessSecurityGroupsProperty(
        security_groups=["securityGroups"]
    ),
    service_access_subnet_id="serviceAccessSubnetId",
    site_id="siteId",
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    terms_accepted=False,
    vcf_hostnames=evs_mixins.CfnEnvironmentPropsMixin.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"
    ),
    vcf_version="vcfVersion",
    vpc_id="vpcId"
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

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

Parameters:

props (Union[CfnEnvironmentMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['connectivityInfo', 'environmentName', 'hosts', 'initialVlans', 'kmsKeyId', 'licenseInfo', 'serviceAccessSecurityGroups', 'serviceAccessSubnetId', 'siteId', 'tags', 'termsAccepted', 'vcfHostnames', 'vcfVersion', 'vpcId']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.
Stability:: experimental

CheckProperty

class CfnEnvironmentPropsMixin.CheckProperty(*, impaired_since=None, result=None, type=None)

Bases: object

A check on the environment to identify environment health and validate VMware VCF licensing compliance.

Parameters:

impaired_since (Optional[str]) – The time when environment health began to be impaired.
result (Optional[str]) – The check result.
type (Optional[str]) – The check type. Amazon EVS performs the following checks. - KEY_REUSE : checks that the VCF license key is not used by another Amazon EVS environment. This check fails if a used license is added to the environment. - KEY_COVERAGE : checks that your VCF license key allocates sufficient vCPU cores for all deployed hosts. The check fails when any assigned hosts in the EVS environment are not covered by license keys, or when any unassigned hosts cannot be covered by available vCPU cores in keys. - REACHABILITY : checks that the Amazon EVS control plane has a persistent connection to SDDC Manager. If Amazon EVS cannot reach the environment, this check fails. - HOST_COUNT : Checks that your environment has a minimum of 4 hosts, which is a requirement for VCF 5.2.1. If this check fails, you will need to add hosts so that your environment meets this minimum requirement. Amazon EVS only supports environments with 4-16 hosts.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evs-environment-check.html

ExampleMetadata:

fixture=_generated

Example:

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

check_property = evs_mixins.CfnEnvironmentPropsMixin.CheckProperty(
    impaired_since="impairedSince",
    result="result",
    type="type"
)

Attributes

impaired_since

The time when environment health began to be impaired.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evs-environment-check.html#cfn-evs-environment-check-impairedsince

result

The check result.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evs-environment-check.html#cfn-evs-environment-check-result

type

The check type. Amazon EVS performs the following checks.

KEY_REUSE : checks that the VCF license key is not used by another Amazon EVS environment. This check fails if a used license is added to the environment.
KEY_COVERAGE : checks that your VCF license key allocates sufficient vCPU cores for all deployed hosts. The check fails when any assigned hosts in the EVS environment are not covered by license keys, or when any unassigned hosts cannot be covered by available vCPU cores in keys.
REACHABILITY : checks that the Amazon EVS control plane has a persistent connection to SDDC Manager. If Amazon EVS cannot reach the environment, this check fails.
HOST_COUNT : Checks that your environment has a minimum of 4 hosts, which is a requirement for VCF 5.2.1.

If this check fails, you will need to add hosts so that your environment meets this minimum requirement. Amazon EVS only supports environments with 4-16 hosts.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evs-environment-check.html#cfn-evs-environment-check-type

ConnectivityInfoProperty

class CfnEnvironmentPropsMixin.ConnectivityInfoProperty(*, private_route_server_peerings=None)

Bases: object

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.

Parameters:: private_route_server_peerings (Optional[Sequence[str]]) – The unique IDs for private route server peers.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evs-environment-connectivityinfo.html
ExampleMetadata:: fixture=_generated

Example:

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

connectivity_info_property = evs_mixins.CfnEnvironmentPropsMixin.ConnectivityInfoProperty(
    private_route_server_peerings=["privateRouteServerPeerings"]
)

Attributes

private_route_server_peerings

The unique IDs for private route server peers.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evs-environment-connectivityinfo.html#cfn-evs-environment-connectivityinfo-privaterouteserverpeerings

HostInfoForCreateProperty

class CfnEnvironmentPropsMixin.HostInfoForCreateProperty(*, dedicated_host_id=None, host_name=None, instance_type=None, key_name=None, placement_group_id=None)

Bases: object

An object that represents a host.

You cannot use dedicatedHostId and placementGroupId together in the same HostInfoForCreate object. This results in a ValidationException response.

Parameters:

dedicated_host_id (Optional[str]) – The unique ID of the Amazon EC2 Dedicated Host.
host_name (Optional[str]) – The DNS hostname of the host. DNS hostnames for hosts must be unique across Amazon EVS environments and within VCF.
instance_type (Optional[str]) – The EC2 instance type that represents the host.
key_name (Optional[str]) – The name of the SSH key that is used to access the host.
placement_group_id (Optional[str]) – The unique ID of the placement group where the host is placed.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evs-environment-hostinfoforcreate.html

ExampleMetadata:

fixture=_generated

Example:

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

host_info_for_create_property = evs_mixins.CfnEnvironmentPropsMixin.HostInfoForCreateProperty(
    dedicated_host_id="dedicatedHostId",
    host_name="hostName",
    instance_type="instanceType",
    key_name="keyName",
    placement_group_id="placementGroupId"
)

Attributes

dedicated_host_id

The unique ID of the Amazon EC2 Dedicated Host.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evs-environment-hostinfoforcreate.html#cfn-evs-environment-hostinfoforcreate-dedicatedhostid

host_name

The DNS hostname of the host.

DNS hostnames for hosts must be unique across Amazon EVS environments and within VCF.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evs-environment-hostinfoforcreate.html#cfn-evs-environment-hostinfoforcreate-hostname

instance_type

The EC2 instance type that represents the host.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evs-environment-hostinfoforcreate.html#cfn-evs-environment-hostinfoforcreate-instancetype

key_name

The name of the SSH key that is used to access the host.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evs-environment-hostinfoforcreate.html#cfn-evs-environment-hostinfoforcreate-keyname

placement_group_id

The unique ID of the placement group where the host is placed.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evs-environment-hostinfoforcreate.html#cfn-evs-environment-hostinfoforcreate-placementgroupid

InitialVlanInfoProperty

class CfnEnvironmentPropsMixin.InitialVlanInfoProperty(*, cidr=None)

Bases: object

An object that represents an initial VLAN subnet for the Amazon EVS environment.

Amazon EVS creates initial VLAN subnets when you first create the environment. Amazon EVS creates the following 10 VLAN subnets: host management VLAN, vMotion VLAN, vSAN VLAN, VTEP VLAN, Edge VTEP VLAN, Management VM VLAN, HCX uplink VLAN, NSX uplink VLAN, expansion VLAN 1, expansion VLAN 2. .. epigraph:

For each Amazon EVS VLAN subnet, you must specify a non-overlapping CIDR block. Amazon EVS VLAN subnets have a minimum CIDR block size of /28 and a maximum size of /24.

Parameters:: cidr (Optional[str]) – The CIDR block that you provide to create an Amazon EVS VLAN subnet. 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.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evs-environment-initialvlaninfo.html
ExampleMetadata:: fixture=_generated

Example:

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

initial_vlan_info_property = evs_mixins.CfnEnvironmentPropsMixin.InitialVlanInfoProperty(
    cidr="cidr"
)

Attributes

cidr

The CIDR block that you provide to create an Amazon EVS VLAN subnet.

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.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evs-environment-initialvlaninfo.html#cfn-evs-environment-initialvlaninfo-cidr

InitialVlansProperty

class CfnEnvironmentPropsMixin.InitialVlansProperty(*, edge_v_tep=None, expansion_vlan1=None, expansion_vlan2=None, hcx=None, hcx_network_acl_id=None, is_hcx_public=None, nsx_up_link=None, vmk_management=None, vm_management=None, v_motion=None, v_san=None, v_tep=None)

Bases: object

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.

Parameters:

edge_v_tep (Union[IResolvable, InitialVlanInfoProperty, Dict[str, Any], None]) – The edge VTEP VLAN subnet. This VLAN subnet manages traffic flowing between the internal network and external networks, including internet access and other site connections.
expansion_vlan1 (Union[IResolvable, InitialVlanInfoProperty, Dict[str, Any], None]) – An additional VLAN subnet that can be used to extend VCF capabilities once configured. For example, you can configure an expansion VLAN subnet to use NSX Federation for centralized management and synchronization of multiple NSX deployments across different locations.
expansion_vlan2 (Union[IResolvable, InitialVlanInfoProperty, Dict[str, Any], None]) – An additional VLAN subnet that can be used to extend VCF capabilities once configured. For example, you can configure an expansion VLAN subnet to use NSX Federation for centralized management and synchronization of multiple NSX deployments across different locations.
hcx (Union[IResolvable, InitialVlanInfoProperty, Dict[str, Any], None]) – The HCX VLAN subnet. This VLAN subnet allows the HCX Interconnnect (IX) and HCX Network Extension (NE) to reach their peers and enable HCX Service Mesh creation. If you plan to use a public HCX VLAN subnet, the following requirements must be met: - Must have a /28 netmask and be allocated from the IPAM public pool. Required for HCX internet access configuration. - The HCX public VLAN CIDR block must be added to the VPC as a secondary CIDR block. - Must have at least two Elastic IP addresses to be allocated from the public IPAM pool for HCX components.
hcx_network_acl_id (Optional[str]) – A unique ID for a network access control list that the HCX VLAN uses. Required when isHcxPublic is set to true .
is_hcx_public (Union[bool, IResolvable, None]) – Determines if the HCX VLAN that Amazon EVS provisions is public or private.
nsx_up_link (Union[IResolvable, InitialVlanInfoProperty, Dict[str, Any], None]) – The NSX uplink VLAN subnet. This VLAN subnet allows connectivity to the NSX overlay network.
vmk_management (Union[IResolvable, InitialVlanInfoProperty, Dict[str, Any], None]) – The host VMkernel management VLAN subnet. This VLAN subnet carries traffic for managing ESXi hosts and communicating with VMware vCenter Server.
vm_management (Union[IResolvable, InitialVlanInfoProperty, Dict[str, Any], None]) – The VM management VLAN subnet. This VLAN subnet carries traffic for vSphere virtual machines.
v_motion (Union[IResolvable, InitialVlanInfoProperty, Dict[str, Any], None]) – The vMotion VLAN subnet. This VLAN subnet carries traffic for vSphere vMotion.
v_san (Union[IResolvable, InitialVlanInfoProperty, Dict[str, Any], None]) – The vSAN VLAN subnet. This VLAN subnet carries the communication between ESXi hosts to implement a vSAN shared storage pool.
v_tep (Union[IResolvable, InitialVlanInfoProperty, Dict[str, Any], None]) – The VTEP VLAN subnet. This VLAN subnet handles internal network traffic between virtual machines within a VCF instance.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evs-environment-initialvlans.html

ExampleMetadata:

fixture=_generated

Example:

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

initial_vlans_property = evs_mixins.CfnEnvironmentPropsMixin.InitialVlansProperty(
    edge_vTep=evs_mixins.CfnEnvironmentPropsMixin.InitialVlanInfoProperty(
        cidr="cidr"
    ),
    expansion_vlan1=evs_mixins.CfnEnvironmentPropsMixin.InitialVlanInfoProperty(
        cidr="cidr"
    ),
    expansion_vlan2=evs_mixins.CfnEnvironmentPropsMixin.InitialVlanInfoProperty(
        cidr="cidr"
    ),
    hcx=evs_mixins.CfnEnvironmentPropsMixin.InitialVlanInfoProperty(
        cidr="cidr"
    ),
    hcx_network_acl_id="hcxNetworkAclId",
    is_hcx_public=False,
    nsx_up_link=evs_mixins.CfnEnvironmentPropsMixin.InitialVlanInfoProperty(
        cidr="cidr"
    ),
    vmk_management=evs_mixins.CfnEnvironmentPropsMixin.InitialVlanInfoProperty(
        cidr="cidr"
    ),
    vm_management=evs_mixins.CfnEnvironmentPropsMixin.InitialVlanInfoProperty(
        cidr="cidr"
    ),
    v_motion=evs_mixins.CfnEnvironmentPropsMixin.InitialVlanInfoProperty(
        cidr="cidr"
    ),
    v_san=evs_mixins.CfnEnvironmentPropsMixin.InitialVlanInfoProperty(
        cidr="cidr"
    ),
    v_tep=evs_mixins.CfnEnvironmentPropsMixin.InitialVlanInfoProperty(
        cidr="cidr"
    )
)

Attributes

edge_v_tep

The edge VTEP VLAN subnet.

This VLAN subnet manages traffic flowing between the internal network and external networks, including internet access and other site connections.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evs-environment-initialvlans.html#cfn-evs-environment-initialvlans-edgevtep

expansion_vlan1

An additional VLAN subnet that can be used to extend VCF capabilities once configured.

For example, you can configure an expansion VLAN subnet to use NSX Federation for centralized management and synchronization of multiple NSX deployments across different locations.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evs-environment-initialvlans.html#cfn-evs-environment-initialvlans-expansionvlan1

expansion_vlan2

An additional VLAN subnet that can be used to extend VCF capabilities once configured.

For example, you can configure an expansion VLAN subnet to use NSX Federation for centralized management and synchronization of multiple NSX deployments across different locations.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evs-environment-initialvlans.html#cfn-evs-environment-initialvlans-expansionvlan2

hcx

The HCX VLAN subnet.

This VLAN subnet allows the HCX Interconnnect (IX) and HCX Network Extension (NE) to reach their peers and enable HCX Service Mesh creation.

If you plan to use a public HCX VLAN subnet, the following requirements must be met:

Must have a /28 netmask and be allocated from the IPAM public pool. Required for HCX internet access configuration.
The HCX public VLAN CIDR block must be added to the VPC as a secondary CIDR block.
Must have at least two Elastic IP addresses to be allocated from the public IPAM pool for HCX components.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evs-environment-initialvlans.html#cfn-evs-environment-initialvlans-hcx

hcx_network_acl_id

A unique ID for a network access control list that the HCX VLAN uses.

Required when isHcxPublic is set to true .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evs-environment-initialvlans.html#cfn-evs-environment-initialvlans-hcxnetworkaclid

is_hcx_public

Determines if the HCX VLAN that Amazon EVS provisions is public or private.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evs-environment-initialvlans.html#cfn-evs-environment-initialvlans-ishcxpublic

nsx_up_link

The NSX uplink VLAN subnet.

This VLAN subnet allows connectivity to the NSX overlay network.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evs-environment-initialvlans.html#cfn-evs-environment-initialvlans-nsxuplink

v_motion

The vMotion VLAN subnet.

This VLAN subnet carries traffic for vSphere vMotion.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evs-environment-initialvlans.html#cfn-evs-environment-initialvlans-vmotion

v_san

The vSAN VLAN subnet.

This VLAN subnet carries the communication between ESXi hosts to implement a vSAN shared storage pool.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evs-environment-initialvlans.html#cfn-evs-environment-initialvlans-vsan

v_tep

The VTEP VLAN subnet.

This VLAN subnet handles internal network traffic between virtual machines within a VCF instance.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evs-environment-initialvlans.html#cfn-evs-environment-initialvlans-vtep

vm_management

The VM management VLAN subnet.

This VLAN subnet carries traffic for vSphere virtual machines.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evs-environment-initialvlans.html#cfn-evs-environment-initialvlans-vmmanagement

vmk_management

The host VMkernel management VLAN subnet.

This VLAN subnet carries traffic for managing ESXi hosts and communicating with VMware vCenter Server.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evs-environment-initialvlans.html#cfn-evs-environment-initialvlans-vmkmanagement

LicenseInfoProperty

class CfnEnvironmentPropsMixin.LicenseInfoProperty(*, solution_key=None, vsan_key=None)

Bases: object

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.

Parameters:

solution_key (Optional[str]) – The VCF solution key. This license unlocks VMware VCF product features, including vSphere, NSX, SDDC Manager, and vCenter Server. The VCF solution key must cover a minimum of 256 cores.
vsan_key (Optional[str]) – The VSAN license key. This license unlocks vSAN features. The vSAN license key must provide at least 110 TiB of vSAN capacity.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evs-environment-licenseinfo.html

ExampleMetadata:

fixture=_generated

Example:

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

license_info_property = evs_mixins.CfnEnvironmentPropsMixin.LicenseInfoProperty(
    solution_key="solutionKey",
    vsan_key="vsanKey"
)

Attributes

solution_key

The VCF solution key.

This license unlocks VMware VCF product features, including vSphere, NSX, SDDC Manager, and vCenter Server. The VCF solution key must cover a minimum of 256 cores.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evs-environment-licenseinfo.html#cfn-evs-environment-licenseinfo-solutionkey

vsan_key

The VSAN license key.

This license unlocks vSAN features. The vSAN license key must provide at least 110 TiB of vSAN capacity.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evs-environment-licenseinfo.html#cfn-evs-environment-licenseinfo-vsankey

SecretProperty

class CfnEnvironmentPropsMixin.SecretProperty(*, secret_arn=None)

Bases: object

A managed secret that contains the credentials for installing vCenter Server, NSX, and SDDC Manager.

During environment creation, the Amazon EVS control plane uses AWS Secrets Manager to create, encrypt, validate, and store secrets. If you choose to delete your environment, Amazon EVS also deletes the secrets that are associated with your environment. Amazon EVS does not provide managed rotation of secrets. We recommend that you rotate secrets regularly to ensure that secrets are not long-lived.

Parameters:: secret_arn (Optional[str]) – The Amazon Resource Name (ARN) of the secret.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evs-environment-secret.html
ExampleMetadata:: fixture=_generated

Example:

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

secret_property = evs_mixins.CfnEnvironmentPropsMixin.SecretProperty(
    secret_arn="secretArn"
)

Attributes

secret_arn

The Amazon Resource Name (ARN) of the secret.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evs-environment-secret.html#cfn-evs-environment-secret-secretarn

ServiceAccessSecurityGroupsProperty

class CfnEnvironmentPropsMixin.ServiceAccessSecurityGroupsProperty(*, security_groups=None)

Bases: object

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

If a security group is not specified, Amazon EVS uses the default security group in your account for service access.

Parameters:: security_groups (Optional[Sequence[str]]) – The security groups that allow service access.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evs-environment-serviceaccesssecuritygroups.html
ExampleMetadata:: fixture=_generated

Example:

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

service_access_security_groups_property = evs_mixins.CfnEnvironmentPropsMixin.ServiceAccessSecurityGroupsProperty(
    security_groups=["securityGroups"]
)

Attributes

security_groups

The security groups that allow service access.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evs-environment-serviceaccesssecuritygroups.html#cfn-evs-environment-serviceaccesssecuritygroups-securitygroups

VcfHostnamesProperty

class CfnEnvironmentPropsMixin.VcfHostnamesProperty(*, cloud_builder=None, nsx=None, nsx_edge1=None, nsx_edge2=None, nsx_manager1=None, nsx_manager2=None, nsx_manager3=None, sddc_manager=None, v_center=None)

Bases: object

The DNS hostnames that Amazon EVS uses to install VMware vCenter Server, NSX, SDDC Manager, and Cloud Builder.

Each hostname must be unique, and resolve to a domain name that you’ve registered in your DNS service of choice. Hostnames cannot be changed.

VMware VCF requires the deployment of two NSX Edge nodes, and three NSX Manager virtual machines.

Parameters:

cloud_builder (Optional[str]) – The hostname for VMware Cloud Builder.
nsx (Optional[str]) – The VMware NSX hostname.
nsx_edge1 (Optional[str]) – The hostname for the first NSX Edge node.
nsx_edge2 (Optional[str]) – The hostname for the second NSX Edge node.
nsx_manager1 (Optional[str]) – The hostname for the first VMware NSX Manager virtual machine (VM).
nsx_manager2 (Optional[str]) – The hostname for the second VMware NSX Manager virtual machine (VM).
nsx_manager3 (Optional[str]) – The hostname for the third VMware NSX Manager virtual machine (VM).
sddc_manager (Optional[str]) – The hostname for SDDC Manager.
v_center (Optional[str]) – The VMware vCenter hostname.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evs-environment-vcfhostnames.html

ExampleMetadata:

fixture=_generated

Example:

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

vcf_hostnames_property = evs_mixins.CfnEnvironmentPropsMixin.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"
)