2.233.0

interface CfnEnvironmentMixinProps

LanguageType name
.NETAmazon.CDK.Mixins.Preview.AWS.EVS.Mixins.CfnEnvironmentMixinProps
Gogithub.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awsevs/mixins#CfnEnvironmentMixinProps
Javasoftware.amazon.awscdk.mixins.preview.services.evs.mixins.CfnEnvironmentMixinProps
Pythonaws_cdk.mixins_preview.aws_evs.mixins.CfnEnvironmentMixinProps
TypeScript @aws-cdk/mixins-preview » aws_evs » mixins » CfnEnvironmentMixinProps

Properties for CfnEnvironmentPropsMixin.

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

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { mixins as evs_mixins } from '@aws-cdk/mixins-preview/aws-evs';
const cfnEnvironmentMixinProps: evs_mixins.CfnEnvironmentMixinProps = {
  connectivityInfo: {
    privateRouteServerPeerings: ['privateRouteServerPeerings'],
  },
  environmentName: 'environmentName',
  hosts: [{
    dedicatedHostId: 'dedicatedHostId',
    hostName: 'hostName',
    instanceType: 'instanceType',
    keyName: 'keyName',
    placementGroupId: 'placementGroupId',
  }],
  initialVlans: {
    edgeVTep: {
      cidr: 'cidr',
    },
    expansionVlan1: {
      cidr: 'cidr',
    },
    expansionVlan2: {
      cidr: 'cidr',
    },
    hcx: {
      cidr: 'cidr',
    },
    hcxNetworkAclId: 'hcxNetworkAclId',
    isHcxPublic: false,
    nsxUpLink: {
      cidr: 'cidr',
    },
    vmkManagement: {
      cidr: 'cidr',
    },
    vmManagement: {
      cidr: 'cidr',
    },
    vMotion: {
      cidr: 'cidr',
    },
    vSan: {
      cidr: 'cidr',
    },
    vTep: {
      cidr: 'cidr',
    },
  },
  kmsKeyId: 'kmsKeyId',
  licenseInfo: {
    solutionKey: 'solutionKey',
    vsanKey: 'vsanKey',
  },
  serviceAccessSecurityGroups: {
    securityGroups: ['securityGroups'],
  },
  serviceAccessSubnetId: 'serviceAccessSubnetId',
  siteId: 'siteId',
  tags: [{
    key: 'key',
    value: 'value',
  }],
  termsAccepted: false,
  vcfHostnames: {
    cloudBuilder: 'cloudBuilder',
    nsx: 'nsx',
    nsxEdge1: 'nsxEdge1',
    nsxEdge2: 'nsxEdge2',
    nsxManager1: 'nsxManager1',
    nsxManager2: 'nsxManager2',
    nsxManager3: 'nsxManager3',
    sddcManager: 'sddcManager',
    vCenter: 'vCenter',
  },
  vcfVersion: 'vcfVersion',
  vpcId: 'vpcId',
};

Properties

NameTypeDescription
connectivityInfo?IResolvable | ConnectivityInfoPropertyThe connectivity configuration for the environment.
environmentName?stringThe name of the environment.
hosts?IResolvable | (IResolvable | HostInfoForCreateProperty)[]Required for environment resource creation.
initialVlans?IResolvable | InitialVlansProperty> Amazon EVS is in public preview release and is subject to change.
kmsKeyId?stringThe AWS KMS key ID that AWS Secrets Manager uses to encrypt secrets that are associated with the environment.
licenseInfo?IResolvable | LicenseInfoPropertyThe license information that Amazon EVS requires to create an environment.
serviceAccessSecurityGroups?IResolvable | ServiceAccessSecurityGroupsPropertyThe security groups that allow traffic between the Amazon EVS control plane and your VPC for service access.
serviceAccessSubnetId?stringThe subnet that is used to establish connectivity between the Amazon EVS control plane and VPC.
siteId?stringThe Broadcom Site ID that is associated with your Amazon EVS environment.
tags?CfnTag[]Metadata that assists with categorization and organization.
termsAccepted?boolean | IResolvableCustomer 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?IResolvable | VcfHostnamesPropertyThe DNS hostnames to be used by the VCF management appliances in your environment.
vcfVersion?stringThe VCF version of the environment.
vpcId?stringThe VPC associated with the environment.

connectivityInfo?

Type: IResolvable | ConnectivityInfoProperty (optional)

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.

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

environmentName?

Type: string (optional)

The name of the environment.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evs-environment.html#cfn-evs-environment-environmentname

hosts?

Type: IResolvable | (IResolvable | HostInfoForCreateProperty)[] (optional)

Required for environment resource creation.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evs-environment.html#cfn-evs-environment-hosts

initialVlans?

Type: IResolvable | InitialVlansProperty (optional)

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.

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

kmsKeyId?

Type: string (optional)

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

licenseInfo?

Type: IResolvable | LicenseInfoProperty (optional)

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.

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

serviceAccessSecurityGroups?

Type: IResolvable | ServiceAccessSecurityGroupsProperty (optional)

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.

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

serviceAccessSubnetId?

Type: string (optional)

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

siteId?

Type: string (optional)

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

tags?

Type: CfnTag[] (optional)

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

termsAccepted?

Type: boolean | IResolvable (optional)

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.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evs-environment.html#cfn-evs-environment-termsaccepted

vcfHostnames?

Type: IResolvable | VcfHostnamesProperty (optional)

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.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evs-environment.html#cfn-evs-environment-vcfhostnames

vcfVersion?

Type: string (optional)

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

vpcId?

Type: string (optional)

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

← PreviousNext →